Add return type hints to phpdoc

doctrine · Oct 13, 2021 · 4bc1274 · 4bc1274
1 parent e62b760
commit 4bc1274
Show file tree

Hide file tree

Showing 36 changed files with 281 additions and 66 deletions.
diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/AbstractBucket.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/AbstractBucket.php
@@ -82,6 +82,11 @@ abstract protected function getExtraPipelineFields(): array;
      */
     abstract protected function getStageName(): string;
 
+    /**
+     * @param array|mixed|string $expression
+     *
+     * @return array|mixed|string
+     */
     private function convertExpression($expression)
     {
         if (is_array($expression)) {

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/GraphLookup.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/GraphLookup.php
@@ -277,6 +277,11 @@ private function fromReference(string $fieldName): self
         return $this;
     }
 
+    /**
+     * @param array|mixed|string $expression
+     *
+     * @return array|mixed|string
+     */
     private function convertExpression($expression)
     {
         if (is_array($expression)) {
@@ -290,12 +295,8 @@ private function convertExpression($expression)
         return Type::convertPHPToDatabaseValue(Expr::convertExpression($expression));
     }
 
-    private function convertTargetFieldName($fieldName)
+    private function convertTargetFieldName(string $fieldName): string
     {
-        if (is_array($fieldName)) {
-            return array_map([$this, 'convertTargetFieldName'], $fieldName);
-        }
-
         if (! $this->targetClass) {
             return $fieldName;
         }

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/ReplaceRoot.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/ReplaceRoot.php
@@ -50,6 +50,11 @@ public function getExpression(): array
         ];
     }
 
+    /**
+     * @param array|string|mixed $expression
+     *
+     * @return array|string|mixed
+     */
     private function convertExpression($expression)
     {
         if (is_array($expression)) {

diff --git a/lib/Doctrine/ODM/MongoDB/Iterator/PrimingIterator.php b/lib/Doctrine/ODM/MongoDB/Iterator/PrimingIterator.php
@@ -61,6 +61,9 @@ public function toArray(): array
         return iterator_to_array($this);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function current()
     {
         $this->primeReferences();
@@ -73,6 +76,9 @@ public function next(): void
         $this->iterator->next();
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function key()
     {
         return $this->iterator->key();

diff --git a/lib/Doctrine/ODM/MongoDB/Mapping/Driver/AnnotationDriver.php b/lib/Doctrine/ODM/MongoDB/Mapping/Driver/AnnotationDriver.php
@@ -35,6 +35,9 @@
  */
 class AnnotationDriver extends AbstractAnnotationDriver
 {
+    /**
+     * {@inheritDoc}
+     */
     public function isTransient($className)
     {
         $classAnnotations = $this->reader->getClassAnnotations(new ReflectionClass($className));

diff --git a/lib/Doctrine/ODM/MongoDB/Mapping/Driver/AttributeReader.php b/lib/Doctrine/ODM/MongoDB/Mapping/Driver/AttributeReader.php
@@ -25,6 +25,9 @@ public function getClassAnnotations(ReflectionClass $class): array
         return $this->convertToAttributeInstances($class->getAttributes());
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function getClassAnnotation(ReflectionClass $class, $annotationName)
     {
         foreach ($this->getClassAnnotations($class) as $annotation) {
@@ -41,6 +44,9 @@ public function getMethodAnnotations(ReflectionMethod $method): array
         return $this->convertToAttributeInstances($method->getAttributes());
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function getMethodAnnotation(ReflectionMethod $method, $annotationName)
     {
         foreach ($this->getMethodAnnotations($method) as $annotation) {
@@ -57,6 +63,9 @@ public function getPropertyAnnotations(ReflectionProperty $property): array
         return $this->convertToAttributeInstances($property->getAttributes());
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function getPropertyAnnotation(ReflectionProperty $property, $annotationName)
     {
         foreach ($this->getPropertyAnnotations($property) as $annotation) {