Increase PHPStan's level

UPGRADE-2.0.md

@@ -30,6 +30,10 @@
 * The `--depth` option in the `odm:query` command was dropped without
   replacement.
 
+## Aggregation builder
+* The `debug` method in `Doctrine\ODM\MongoDB\Aggregation\Stage\Match` was dropped
+  without replacement.
+
 ## Configuration
 
 * The `setDefaultRepositoryClassName` and `getDefaultRepositoryClassName` methods

lib/Doctrine/ODM/MongoDB/Aggregation/Builder.php

@@ -18,6 +18,7 @@
 use function array_map;
 use function array_merge;
 use function array_unshift;
+use function assert;
 use function is_array;
 use function sprintf;
 
@@ -78,7 +79,10 @@ public function __construct(DocumentManager $dm, string $documentName)
      */
     public function addFields() : Stage\AddFields
     {
-        return $this->addStage(new Stage\AddFields($this));
+        $stage = new Stage\AddFields($this);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -95,7 +99,10 @@ public function addFields() : Stage\AddFields
      */
     public function bucket() : Stage\Bucket
     {
-        return $this->addStage(new Stage\Bucket($this, $this->dm, $this->class));
+        $stage = new Stage\Bucket($this, $this->dm, $this->class);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -114,7 +121,10 @@ public function bucket() : Stage\Bucket
      */
     public function bucketAuto() : Stage\BucketAuto
     {
-        return $this->addStage(new Stage\BucketAuto($this, $this->dm, $this->class));
+        $stage = new Stage\BucketAuto($this, $this->dm, $this->class);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -127,7 +137,10 @@ public function bucketAuto() : Stage\BucketAuto
      */
     public function collStats() : Stage\CollStats
     {
-        return $this->addStage(new Stage\CollStats($this));
+        $stage = new Stage\CollStats($this);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -138,7 +151,10 @@ public function collStats() : Stage\CollStats
      */
     public function count(string $fieldName) : Stage\Count
     {
-        return $this->addStage(new Stage\Count($this, $fieldName));
+        $stage = new Stage\Count($this, $fieldName);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -150,6 +166,7 @@ public function execute(array $options = []) : Iterator
         $options = array_merge($options, ['cursor' => true]);
 
         $cursor = $this->collection->aggregate($this->getPipeline(), $options);
+        assert($cursor instanceof Cursor);
 
         return $this->prepareIterator($cursor);
     }
@@ -168,7 +185,10 @@ public function expr() : Expr
      */
     public function facet() : Stage\Facet
     {
-        return $this->addStage(new Stage\Facet($this));
+        $stage = new Stage\Facet($this);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -188,7 +208,10 @@ public function facet() : Stage\Facet
      */
     public function geoNear($x, $y = null) : Stage\GeoNear
     {
-        return $this->addStage(new Stage\GeoNear($this, $x, $y));
+        $stage = new Stage\GeoNear($this, $x, $y);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -243,7 +266,10 @@ public function getStage(int $index) : Stage
      */
     public function graphLookup(string $from) : Stage\GraphLookup
     {
-        return $this->addStage(new Stage\GraphLookup($this, $from, $this->dm, $this->class));
+        $stage = new Stage\GraphLookup($this, $from, $this->dm, $this->class);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -254,7 +280,10 @@ public function graphLookup(string $from) : Stage\GraphLookup
      */
     public function group() : Stage\Group
     {
-        return $this->addStage(new Stage\Group($this));
+        $stage = new Stage\Group($this);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -274,7 +303,10 @@ public function hydrate(string $className) : self
      */
     public function indexStats() : Stage\IndexStats
     {
-        return $this->addStage(new Stage\IndexStats($this));
+        $stage = new Stage\IndexStats($this);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -284,7 +316,10 @@ public function indexStats() : Stage\IndexStats
      */
     public function limit(int $limit) : Stage\Limit
     {
-        return $this->addStage(new Stage\Limit($this, $limit));
+        $stage = new Stage\Limit($this, $limit);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -296,7 +331,10 @@ public function limit(int $limit) : Stage\Limit
      */
     public function lookup(string $from) : Stage\Lookup
     {
-        return $this->addStage(new Stage\Lookup($this, $from, $this->dm, $this->class));
+        $stage = new Stage\Lookup($this, $from, $this->dm, $this->class);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -307,7 +345,10 @@ public function lookup(string $from) : Stage\Lookup
      */
     public function match() : Stage\Match
     {
-        return $this->addStage(new Stage\Match($this));
+        $stage = new Stage\Match($this);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -329,7 +370,10 @@ public function matchExpr() : QueryExpr
      */
     public function out(string $from) : Stage\Out
     {
-        return $this->addStage(new Stage\Out($this, $from, $this->dm));
+        $stage = new Stage\Out($this, $from, $this->dm);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -341,7 +385,10 @@ public function out(string $from) : Stage\Out
      */
     public function project() : Stage\Project
     {
-        return $this->addStage(new Stage\Project($this));
+        $stage = new Stage\Project($this);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -352,7 +399,10 @@ public function project() : Stage\Project
      */
     public function redact() : Stage\Redact
     {
-        return $this->addStage(new Stage\Redact($this));
+        $stage = new Stage\Redact($this);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -368,7 +418,10 @@ public function redact() : Stage\Redact
      */
     public function replaceRoot($expression = null) : Stage\ReplaceRoot
     {
-        return $this->addStage(new Stage\ReplaceRoot($this, $this->dm, $this->class, $expression));
+        $stage = new Stage\ReplaceRoot($this, $this->dm, $this->class, $expression);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -378,7 +431,10 @@ public function replaceRoot($expression = null) : Stage\ReplaceRoot
      */
     public function sample(int $size) : Stage\Sample
     {
-        return $this->addStage(new Stage\Sample($this, $size));
+        $stage = new Stage\Sample($this, $size);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -389,7 +445,10 @@ public function sample(int $size) : Stage\Sample
      */
     public function skip(int $skip) : Stage\Skip
     {
-        return $this->addStage(new Stage\Skip($this, $skip));
+        $stage = new Stage\Skip($this, $skip);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -408,7 +467,10 @@ public function sort($fieldName, $order = null) : Stage\Sort
     {
         $fields = is_array($fieldName) ? $fieldName : [$fieldName => $order];
         // fixme: move to sort stage
-        return $this->addStage(new Stage\Sort($this, $this->getDocumentPersister()->prepareSort($fields)));
+        $stage = new Stage\Sort($this, $this->getDocumentPersister()->prepareSort($fields));
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -419,7 +481,10 @@ public function sort($fieldName, $order = null) : Stage\Sort
      */
     public function sortByCount(string $expression) : Stage\SortByCount
     {
-        return $this->addStage(new Stage\SortByCount($this, $expression, $this->dm, $this->class));
+        $stage = new Stage\SortByCount($this, $expression, $this->dm, $this->class);
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     /**
@@ -432,7 +497,10 @@ public function sortByCount(string $expression) : Stage\SortByCount
     public function unwind(string $fieldName) : Stage\Unwind
     {
         // Fixme: move field name translation to stage
-        return $this->addStage(new Stage\Unwind($this, $this->getDocumentPersister()->prepareFieldName($fieldName)));
+        $stage = new Stage\Unwind($this, $this->getDocumentPersister()->prepareFieldName($fieldName));
+        $this->addStage($stage);
+
+        return $stage;
     }
 
     protected function addStage(Stage $stage) : Stage

lib/Doctrine/ODM/MongoDB/Aggregation/Expr.php

@@ -5,13 +5,15 @@
 namespace Doctrine\ODM\MongoDB\Aggregation;
 
 use BadMethodCallException;
-use Doctrine\Common\Persistence\Mapping\ClassMetadata;
+use Doctrine\Common\Persistence\Mapping\ClassMetadata as ClassMetadataInterface;
 use Doctrine\ODM\MongoDB\DocumentManager;
+use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Doctrine\ODM\MongoDB\Persisters\DocumentPersister;
 use Doctrine\ODM\MongoDB\Types\Type;
 use LogicException;
 use function array_map;
 use function array_merge;
+use function assert;
 use function func_get_args;
 use function is_array;
 use function is_string;
@@ -38,14 +40,15 @@ class Expr
      */
     private $currentField;
 
-    /** @var array */
+    /** @var array|null */
     private $switchBranch;
 
     /**
      * @inheritDoc
      */
-    public function __construct(DocumentManager $dm, ClassMetadata $class)
+    public function __construct(DocumentManager $dm, ClassMetadataInterface $class)
     {
+        assert($class instanceof ClassMetadata);
         $this->dm    = $dm;
         $this->class = $class;
     }
@@ -317,7 +320,9 @@ public function cond($if, $then, $else) : self
     public static function convertExpression($expression)
     {
         if (is_array($expression)) {
-            return array_map(['static', 'convertExpression'], $expression);
+            return array_map(static function ($expression) {
+                return static::convertExpression($expression);
+            }, $expression);
         } elseif ($expression instanceof self) {
             return $expression->getExpression();
         }
@@ -481,7 +486,7 @@ public function expression($value) : self
     public function field(string $fieldName) : self
     {
         $fieldName          = $this->getDocumentPersister()->prepareFieldName($fieldName);
-        $this->currentField = (string) $fieldName;
+        $this->currentField = $fieldName;
 
         return $this;
     }
@@ -1571,7 +1576,7 @@ private function getDocumentPersister() : DocumentPersister
      * If there is a current field, the operator will be set on it; otherwise,
      * the operator is set at the top level of the query.
      *
-     * @param array|self[]|self $expression
+     * @param array|self $expression
      */
     private function operator(string $operator, $expression) : self
     {

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/AbstractBucket.php

@@ -29,10 +29,10 @@ abstract class AbstractBucket extends Stage
     /** @var ClassMetadata */
     private $class;
 
-    /** @var Bucket\BucketOutput|null */
+    /** @var Bucket\AbstractOutput|null */
     protected $output;
 
-    /** @var Expr */
+    /** @var Expr|array */
     protected $groupBy;
 
     public function __construct(Builder $builder, DocumentManager $documentManager, ClassMetadata $class)

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Bucket.php

@@ -4,6 +4,11 @@
 
 namespace Doctrine\ODM\MongoDB\Aggregation\Stage;
 
+use function assert;
+
+/**
+ * @method Bucket groupBy($expression)
+ */
 class Bucket extends AbstractBucket
 {
     /** @var array */
@@ -53,6 +58,7 @@ public function output() : Bucket\BucketOutput
             $this->output = new Bucket\BucketOutput($this->builder, $this);
         }
 
+        assert($this->output instanceof Bucket\BucketOutput);
         return $this->output;
     }