add missing type declarations

benchmark/Document/HydrateDocumentBench.php

@@ -35,7 +35,7 @@ final class HydrateDocumentBench extends BaseBench
     /** @var HydratorInterface */
     private static $hydrator;
 
-    public function init()
+    public function init(): void
     {
         self::$data = [
             '_id' => new ObjectId(),
@@ -83,39 +83,39 @@ public function init()
     /**
      * @Warmup(2)
      */
-    public function benchHydrateDocument()
+    public function benchHydrateDocument(): void
     {
         self::$hydrator->hydrate(new User(), self::$data);
     }
 
     /**
      * @Warmup(2)
      */
-    public function benchHydrateDocumentWithEmbedOne()
+    public function benchHydrateDocumentWithEmbedOne(): void
     {
         self::$hydrator->hydrate(new User(), self::$data + self::$embedOneData);
     }
 
     /**
      * @Warmup(2)
      */
-    public function benchHydrateDocumentWithEmbedMany()
+    public function benchHydrateDocumentWithEmbedMany(): void
     {
         self::$hydrator->hydrate(new User(), self::$data + self::$embedManyData);
     }
 
     /**
      * @Warmup(2)
      */
-    public function benchHydrateDocumentWithReferenceOne()
+    public function benchHydrateDocumentWithReferenceOne(): void
     {
         self::$hydrator->hydrate(new User(), self::$data + self::$referenceOneData);
     }
 
     /**
      * @Warmup(2)
      */
-    public function benchHydrateDocumentWithReferenceMany()
+    public function benchHydrateDocumentWithReferenceMany(): void
     {
         self::$hydrator->hydrate(new User(), self::$data + self::$referenceManyData);
     }

benchmark/Document/LoadDocumentBench.php

@@ -84,15 +84,15 @@ public function benchLoadEmbedMany(): void
     /**
      * @Warmup(2)
      */
-    public function benchLoadReferenceOne()
+    public function benchLoadReferenceOne(): void
     {
         $this->loadDocument()->getAccount()->getName();
     }
 
     /**
      * @Warmup(2)
      */
-    public function benchLoadReferenceMany()
+    public function benchLoadReferenceMany(): void
     {
         $this->loadDocument()->getGroups()->forAll(static function (int $key, Group $group) {
             return $group->getName() !== null;

benchmark/Document/StoreDocumentBench.php

@@ -18,7 +18,7 @@ final class StoreDocumentBench extends BaseBench
     /**
      * @Warmup(2)
      */
-    public function benchStoreDocument()
+    public function benchStoreDocument(): void
     {
         $user = new User();
         $user->setUsername('alcaeus');
@@ -32,7 +32,7 @@ public function benchStoreDocument()
     /**
      * @Warmup(2)
      */
-    public function benchStoreDocumentWithEmbedOne()
+    public function benchStoreDocumentWithEmbedOne(): void
     {
         $address = new Address();
         $address->setAddress('Redacted');
@@ -51,7 +51,7 @@ public function benchStoreDocumentWithEmbedOne()
     /**
      * @Warmup(2)
      */
-    public function benchStoreDocumentWithEmbedMany()
+    public function benchStoreDocumentWithEmbedMany(): void
     {
         $user = new User();
         $user->setUsername('alcaeus');
@@ -67,7 +67,7 @@ public function benchStoreDocumentWithEmbedMany()
     /**
      * @Warmup(2)
      */
-    public function benchStoreDocumentWithReferenceOne()
+    public function benchStoreDocumentWithReferenceOne(): void
     {
         $account = new Account();
         $account->setName('alcaeus');
@@ -85,7 +85,7 @@ public function benchStoreDocumentWithReferenceOne()
     /**
      * @Warmup(2)
      */
-    public function benchStoreDocumentWithReferenceMany()
+    public function benchStoreDocumentWithReferenceMany(): void
     {
         $group1 = new Group('One');
         $group2 = new Group('Two');

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

@@ -43,7 +43,10 @@ class Builder
      */
     private $class;
 
-    /** @var string */
+    /**
+     * @var string
+     * @psalm-var class-string
+     */
     private $hydrationClass;
 
     /**
@@ -61,6 +64,8 @@ class Builder
 
     /**
      * Create a new aggregation builder.
+     *
+     * @psalm-param class-string $documentName
      */
     public function __construct(DocumentManager $dm, string $documentName)
     {

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

@@ -5,6 +5,7 @@
 namespace Doctrine\ODM\MongoDB\Aggregation\Stage\Bucket;
 
 use Doctrine\ODM\MongoDB\Aggregation\Builder;
+use Doctrine\ODM\MongoDB\Aggregation\Expr;
 use Doctrine\ODM\MongoDB\Aggregation\Stage;
 
 use function assert;
@@ -22,6 +23,8 @@ public function __construct(Builder $builder, Stage\BucketAuto $bucket)
     /**
      * An expression to group documents by. To specify a field path, prefix the
      * field name with a dollar sign $ and enclose it in quotes.
+     *
+     * @param array|Expr|string $expression
      */
     public function groupBy($expression): Stage\BucketAuto
     {

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

@@ -147,6 +147,8 @@ public function depthField(string $depthField): self
      *
      * The from collection cannot be sharded and must be in the same database as
      * any other collections used in the operation.
+     *
+     * @psalm-param class-string|string $from
      */
     public function from(string $from): self
     {

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

@@ -27,6 +27,9 @@ class ReplaceRoot extends Operator
     /** @var string|array|Expr|null */
     private $expression;
 
+    /**
+     * @param string|array|Expr|null $expression
+     */
     public function __construct(Builder $builder, DocumentManager $documentManager, ClassMetadata $class, $expression = null)
     {
         parent::__construct($builder);

lib/Doctrine/ODM/MongoDB/DocumentNotFoundException.php

@@ -13,6 +13,9 @@
  */
 final class DocumentNotFoundException extends MongoDBException
 {
+    /**
+     * @param mixed $identifier
+     */
     public static function documentNotFound(string $className, $identifier): self
     {
         return new self(sprintf(

lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php

@@ -591,7 +591,7 @@
      *
      * @see discriminatorField
      *
-     * @var mixed
+     * @psalm-var array<string, class-string>
      */
     public $discriminatorMap = [];
 

lib/Doctrine/ODM/MongoDB/Persisters/DocumentPersister.php

@@ -1549,7 +1549,7 @@ private function getWriteOptions(array $options = []): array
         return $writeOptions;
     }
 
-    private function prepareReference(string $fieldName, $value, array $mapping, bool $inNewObj): array
+    private function prepareReference(string $fieldName, object $value, array $mapping, bool $inNewObj): array
     {
         $reference = $this->dm->createReference($value, $mapping);
         if ($inNewObj || $mapping['storeAs'] === ClassMetadata::REFERENCE_STORE_AS_ID) {

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

@@ -1591,11 +1591,11 @@ public function where($javascript): self
     /**
      * Get Discriminator Values
      *
-     * @param string[] $classNames
+     * @psalm-param class-string[] $classNames
      *
      * @throws InvalidArgumentException If the number of found collections > 1.
      */
-    private function getDiscriminatorValues($classNames): array
+    private function getDiscriminatorValues(array $classNames): array
     {
         $discriminatorValues = [];
         $collections         = [];
@@ -1615,6 +1615,7 @@ private function getDiscriminatorValues($classNames): array
 
     /**
      * @param string[]|string|null $documentName an array of document names or just one.
+     * @psalm-param class-string[]|class-string|null $documentName
      */
     private function setDocumentName($documentName): void
     {

lib/Doctrine/ODM/MongoDB/Query/ReferencePrimer.php

@@ -148,6 +148,7 @@ public function primeReferences(ClassMetadata $class, $documents, string $fieldN
             }
         }
 
+        /** @psalm-var class-string $className */
         foreach ($groupedIds as $className => $ids) {
             $refClass = $this->dm->getClassMetadata($className);
             call_user_func($primer, $this->dm, $refClass, array_values($ids), $hints);

lib/Doctrine/ODM/MongoDB/UnitOfWork.php

@@ -2749,6 +2749,8 @@ public function getOwningDocument(object $document): object
      *
      * @param FieldMapping              $mapping
      * @param array<string, mixed>|null $data
+     *
+     * @psalm-return class-string
      */
     public function getClassNameForAssociation(array $mapping, $data): string
     {
@@ -2806,6 +2808,7 @@ public function getOrCreateDocument(string $className, array $data, array &$hint
         }
 
         if ($discriminatorValue !== null) {
+            /** @psalm-var class-string<T> $className */
             $className =  $class->discriminatorMap[$discriminatorValue] ?? $discriminatorValue;
 
             $class = $this->dm->getClassMetadata($className);

phpstan-baseline.neon

@@ -236,3 +236,17 @@ parameters:
             message: "#^Parameter \\#2 \\$mapping of method Doctrine\\\\ODM\\\\MongoDB\\\\Mapping\\\\Driver\\\\XmlDriver\\:\\:addFieldMapping\\(\\) expects array\\(\\?'type' \\=\\> string, \\?'fieldName' \\=\\> string, \\?'name' \\=\\> string, \\?'strategy' \\=\\> string, \\?'association' \\=\\> int, \\?'id' \\=\\> bool, \\?'collectionClass' \\=\\> class\\-string, \\?'cascade' \\=\\> array\\<int, string\\>\\|string, \\.\\.\\.\\), array\\<int\\|string, \\(array\\<int, string\\>&nonEmpty\\)\\|bool\\|string\\> given\\.$#"
             count: 1
             path: lib/Doctrine/ODM/MongoDB/Mapping/Driver/XmlDriver.php
+
+        # This is handled by a try-catch block
+        -
+            message: "#^Unable to resolve the template type T in call to method Doctrine\\\\ODM\\\\MongoDB\\\\DocumentManager\\:\\:getClassMetadata\\(\\)$#"
+            paths:
+                - lib/Doctrine/ODM/MongoDB/Aggregation/Stage/GraphLookup.php
+                - lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Lookup.php
+                - lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Out.php
+
+        # $this->mapping['targetDocument'] is class-string<T>
+        -
+            message: "#^Unable to resolve the template type T in call to method Doctrine\\\\ODM\\\\MongoDB\\\\DocumentManager\\:\\:getClassMetadata\\(\\)$#"
+            count: 1
+            path: lib/Doctrine/ODM/MongoDB/PersistentCollection.php

phpstan.neon.dist

@@ -15,3 +15,15 @@ parameters:
     - tests/Hydrators/
     - tests/PersistentCollections/
     - tests/Proxies/
+  # To be removed when reaching phpstan level 6
+  checkMissingVarTagTypehint: true
+  checkMissingTypehints: true
+
+# To be removed when reaching phpstan level 6
+rules:
+    - PHPStan\Rules\Constants\MissingClassConstantTypehintRule
+    - PHPStan\Rules\Functions\MissingFunctionParameterTypehintRule
+    - PHPStan\Rules\Functions\MissingFunctionReturnTypehintRule
+    - PHPStan\Rules\Methods\MissingMethodParameterTypehintRule
+    - PHPStan\Rules\Methods\MissingMethodReturnTypehintRule
+    - PHPStan\Rules\Properties\MissingPropertyTypehintRule

tests/Doctrine/ODM/MongoDB/Tests/Events/LifecycleListenersTest.php

@@ -225,7 +225,7 @@ class MyEventListener
     /** @psalm-var array<string, list<class-string>> */
     public $called = [];
 
-    public function __call(string $method, array $args)
+    public function __call(string $method, array $args): void
     {
         $document                = $args[0]->getDocument();
         $className               = get_class($document);

tests/Doctrine/ODM/MongoDB/Tests/Functional/CommitImprovementTest.php

@@ -158,7 +158,7 @@ public function getSubscribedEvents(): array
         ];
     }
 
-    public function __call(string $eventName, array $args)
+    public function __call(string $eventName, array $args): void
     {
         $document = $args[0]->getDocument();
         if (! ($document instanceof User)) {

tests/Doctrine/ODM/MongoDB/Tests/Functional/DocumentPersisterTest.php

@@ -645,6 +645,7 @@ public static function dataProviderTestWriteConcern(): array
 
     /**
      * @param int|string $writeConcern
+     * @psalm-param class-string $class
      *
      * @dataProvider dataProviderTestWriteConcern
      */
@@ -668,6 +669,7 @@ public function testExecuteInsertsRespectsWriteConcern(string $class, $writeConc
 
     /**
      * @param int|string $writeConcern
+     * @psalm-param class-string $class
      *
      * @dataProvider dataProviderTestWriteConcern
      */
@@ -692,6 +694,7 @@ public function testExecuteUpsertsRespectsWriteConcern(string $class, $writeConc
 
     /**
      * @param int|string $writeConcern
+     * @psalm-param class-string $class
      *
      * @dataProvider dataProviderTestWriteConcern
      */

tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/GH560Test.php

@@ -114,7 +114,7 @@ public function getSubscribedEvents(): array
         return $this->events;
     }
 
-    public function __call(string $eventName, array $args)
+    public function __call(string $eventName, array $args): void
     {
         $this->called[] = [$eventName, get_class($args[0]->getDocument())];
     }

tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/MODM83Test.php

@@ -63,7 +63,7 @@ class MODM83EventListener
     /** @var array<string, class-string[]> */
     public $called = [];
 
-    public function __call(string $method, array $args)
+    public function __call(string $method, array $args): void
     {
         $document                = $args[0]->getDocument();
         $className               = get_class($document);

tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/MODM90Test.php

@@ -79,7 +79,7 @@ class MODM90EventListener
     /** @var array<string, class-string[]> */
     public $called = [];
 
-    public function __call(string $method, array $args)
+    public function __call(string $method, array $args): void
     {
         $document                = $args[0]->getDocument();
         $className               = get_class($document);

tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/MODM91Test.php

@@ -55,7 +55,7 @@ class MODM91EventListener
     /** @var array<string, class-string[]>  */
     public $called = [];
 
-    public function __call(string $method, array $args)
+    public function __call(string $method, array $args): void
     {
         $document                = $args[0]->getDocument();
         $className               = get_class($document);

tests/Doctrine/ODM/MongoDB/Tests/Mapping/Symfony/AbstractDriverTest.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\ODM\MongoDB\Tests\Mapping\Symfony;
 
+use Doctrine\Persistence\Mapping\Driver\FileDriver;
 use Doctrine\Persistence\Mapping\MappingException;
 use PHPUnit\Framework\TestCase;
 use RecursiveDirectoryIterator;
@@ -89,7 +90,10 @@ protected function tearDown(): void
         @rmdir($this->dir);
     }
 
-    abstract protected function getFileExtension();
+    abstract protected function getFileExtension(): string;
 
+    /**
+     * @return FileDriver
+     */
     abstract protected function getDriver(array $paths = []);
 }

tests/Doctrine/ODM/MongoDB/Tests/Tools/ResolveTargetDocumentListenerTest.php

@@ -83,6 +83,9 @@ public function testResolveTargetDocumentListenerCanRetrieveTargetDocumentByAbst
 
 interface ResolveTargetInterface
 {
+    /**
+     * @return mixed
+     */
     public function getId();
 }
 

tests/Documents/Ecommerce/ConfigurableProduct.php

@@ -67,7 +67,7 @@ public function setName(string $name): ConfigurableProduct
         return $this;
     }
 
-    /***
+    /**
      * @return Collection<int, Option>|array<Option>
      */
     public function getOptions()