Merge pull request doctrine#2368 from franmomu/add_types_5_2

Finish adding return type declarations to phpdoc
quentint · Oct 23, 2021 · 6cb1e7f · 6cb1e7f
2 parents 60d56b3 + e533f8a
commit 6cb1e7f
Show file tree

Hide file tree

Showing 54 changed files with 55 additions and 269 deletions.
diff --git a/docs/en/reference/metadata-drivers.rst b/docs/en/reference/metadata-drivers.rst
@@ -101,24 +101,15 @@ the ``AbstractFileDriver`` implementation for you to extend from:
 
     class MyMetadataDriver extends AbstractFileDriver
     {
-        /**
-         * {@inheritdoc}
-         */
         protected $_fileExtension = '.dcm.ext';
 
-        /**
-         * {@inheritdoc}
-         */
         public function loadMetadataForClass($className, ClassMetadata $metadata)
         {
             $data = $this->_loadMappingFile($file);
 
             // populate ClassMetadata instance from $data
         }
 
-        /**
-         * {@inheritdoc}
-         */
         protected function _loadMappingFile($file)
         {
             // parse contents of $file and return php data structure

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/AbstractBucket.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/AbstractBucket.php
@@ -57,9 +57,6 @@ public function groupBy($expression): self
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         $stage = [
@@ -82,6 +79,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/AddFields.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/AddFields.php
@@ -9,9 +9,6 @@
  */
 final class AddFields extends Operator
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Bucket/AbstractOutput.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Bucket/AbstractOutput.php
@@ -29,9 +29,6 @@ public function __construct(Builder $builder, Stage\AbstractBucket $bucket)
         $this->expr   = $builder->expr();
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return $this->expr->getExpression();

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/CollStats.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/CollStats.php
@@ -47,9 +47,6 @@ public function showStorageStats(): self
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         $collStats = [];

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Count.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Count.php
@@ -22,9 +22,6 @@ public function __construct(Builder $builder, string $fieldName)
         $this->fieldName = $fieldName;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Facet.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Facet.php
@@ -22,9 +22,6 @@ class Facet extends Stage
     /** @var string */
     private $field;
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/GeoNear.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/GeoNear.php
@@ -52,9 +52,6 @@ public function __construct(Builder $builder, $x, $y = null)
         $this->near($x, $y);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         $geoNear = [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/GraphLookup.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/GraphLookup.php
@@ -177,9 +177,6 @@ public function from(string $from): self
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         $restrictSearchWithMatch = $this->restrictSearchWithMatch->getExpression() ?: (object) [];
@@ -277,6 +274,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 +292,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/GraphLookup/MatchStage.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/GraphLookup/MatchStage.php
@@ -21,9 +21,6 @@ public function __construct(Builder $builder, GraphLookup $graphLookup)
         $this->graphLookup = $graphLookup;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return $this->query->getQuery();

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Group.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Group.php
@@ -15,19 +15,13 @@ class Group extends Operator
     /** @var Expr */
     protected $expr;
 
-    /**
-     * {@inheritdoc}
-     */
     public function __construct(Builder $builder)
     {
         parent::__construct($builder);
 
         $this->expr = $builder->expr();
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/IndexStats.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/IndexStats.php
@@ -12,9 +12,6 @@
  */
 class IndexStats extends Stage
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Limit.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Limit.php
@@ -22,9 +22,6 @@ public function __construct(Builder $builder, int $limit)
         $this->limit = $limit;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Lookup.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Lookup.php
@@ -96,9 +96,6 @@ public function from(string $from): self
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/MatchStage.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/MatchStage.php
@@ -308,9 +308,6 @@ public function geoWithinPolygon($point1, $point2, $point3, ...$points): self
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Out.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Out.php
@@ -27,9 +27,6 @@ public function __construct(Builder $builder, string $collection, DocumentManage
         $this->out($collection);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Project.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Project.php
@@ -13,9 +13,6 @@
  */
 class Project extends Operator
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Redact.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Redact.php
@@ -9,9 +9,6 @@
  */
 class Redact extends Operator
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/ReplaceRoot.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/ReplaceRoot.php
@@ -36,9 +36,6 @@ public function __construct(Builder $builder, DocumentManager $documentManager,
         $this->expression = $expression;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         $expression = $this->expression !== null ? $this->convertExpression($this->expression) : $this->expr->getExpression();
@@ -50,6 +47,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/Aggregation/Stage/Sample.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Sample.php
@@ -22,9 +22,6 @@ public function __construct(Builder $builder, int $size)
         $this->size = $size;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Skip.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Skip.php
@@ -22,9 +22,6 @@ public function __construct(Builder $builder, int $skip)
         $this->skip = $skip;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Sort.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Sort.php
@@ -45,9 +45,6 @@ public function __construct(Builder $builder, $fieldName, $order = null)
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/SortByCount.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/SortByCount.php
@@ -29,9 +29,6 @@ public function __construct(Builder $builder, string $fieldName, DocumentManager
         $this->fieldName   = '$' . $documentPersister->prepareFieldName(substr($fieldName, 1));
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         return [

diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Unwind.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Unwind.php
@@ -28,9 +28,6 @@ public function __construct(Builder $builder, string $fieldName)
         $this->fieldName = $fieldName;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getExpression(): array
     {
         // Fallback behavior for MongoDB < 3.2

diff --git a/lib/Doctrine/ODM/MongoDB/Id/AlnumGenerator.php b/lib/Doctrine/ODM/MongoDB/Id/AlnumGenerator.php
@@ -65,7 +65,6 @@ public function setChars(string $chars): void
         $this->chars = $chars;
     }
 
-    /** @inheritDoc */
     public function generate(DocumentManager $dm, object $document)
     {
         $id    = (string) parent::generate($dm, $document);

diff --git a/lib/Doctrine/ODM/MongoDB/Id/AutoGenerator.php b/lib/Doctrine/ODM/MongoDB/Id/AutoGenerator.php
@@ -12,7 +12,6 @@
  */
 final class AutoGenerator extends AbstractIdGenerator
 {
-    /** @inheritDoc */
     public function generate(DocumentManager $dm, object $document)
     {
         return new ObjectId();

diff --git a/lib/Doctrine/ODM/MongoDB/Id/IncrementGenerator.php b/lib/Doctrine/ODM/MongoDB/Id/IncrementGenerator.php
@@ -51,7 +51,6 @@ public function setStartingId(int $startingId): void
         $this->startingId = $startingId;
     }
 
-    /** @inheritDoc */
     public function generate(DocumentManager $dm, object $document)
     {
         $className = get_class($document);
-Original file line number
+Diff line change
@@ Expand Up @@
             }
         }
-        /**
-         * {@inheritdoc}
-         */
         public function getExpression(): array
         {
             return [
@@ Expand Down @@