Add iterable types

benchmark/Document/HydrateDocumentBench.php

@@ -17,19 +17,19 @@
  */
 final class HydrateDocumentBench extends BaseBench
 {
-    /** @var array */
+    /** @var array<string, mixed> */
     private static $data;
 
-    /** @var array */
+    /** @var array<string, mixed> */
     private static $embedOneData;
 
-    /** @var array */
+    /** @var array<string, mixed[]> */
     private static $embedManyData;
 
-    /** @var array */
+    /** @var array<string, mixed[]> */
     private static $referenceOneData;
 
-    /** @var array */
+    /** @var array<string, mixed[]> */
     private static $referenceManyData;
 
     /** @var HydratorInterface */

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

@@ -31,8 +31,10 @@ class Lookup extends Stage
 
     private ?string $as = null;
 
+    /** @var array<string, string>|null */
     private ?array $let = null;
 
+    /** @var array<array<string, mixed>>|null */
     private ?array $pipeline = null;
 
     private bool $excludeLocalAndForeignField = false;
@@ -155,6 +157,8 @@ public function foreignField(string $foreignField): self
      *
      * Use the variable expressions to access the fields from
      * the joined collection's documents that are input to the pipeline.
+     *
+     * @param array<string, string> $let
      */
     public function let(array $let): self
     {
@@ -172,6 +176,8 @@ public function let(array $let): self
      * The pipeline cannot directly access the joined document fields.
      * Instead, define variables for the joined document fields using the let option
      * and then reference the variables in the pipeline stages.
+     *
+     * @param array<array<string, mixed>> $pipeline
      */
     public function pipeline(array $pipeline): self
     {

lib/Doctrine/ODM/MongoDB/Iterator/HydratingIterator.php

@@ -21,7 +21,7 @@
  *
  * @template TValue
  * @template TDocument of object
- * @template-implements Iterator<TValue>
+ * @template-implements Iterator<TDocument>
  */
 final class HydratingIterator implements Iterator
 {

phpstan-baseline.neon

@@ -143,12 +143,6 @@ parameters:
             count: 1
             path: tests/Doctrine/ODM/MongoDB/Tests/DocumentRepositoryTest.php
 
-        # 'strategy' offset is defined as nullable, but here there is no check here
-        -
-            message: "#^Offset 'strategy' does not exist on array\\{\\}\\|array\\{type\\?\\: string, fieldName\\: string, name\\: string, isCascadeRemove\\: bool, isCascadePersist\\: bool, isCascadeRefresh\\: bool, isCascadeMerge\\: bool, isCascadeDetach\\: bool, \\.\\.\\.\\}\\.$#"
-            count: 1
-            path: lib/Doctrine/ODM/MongoDB/UnitOfWork.php
-
         # When iterating over SimpleXMLElement, we cannot know the key values
         -
             message: "#^Parameter \\#2 \\$mapping of method Doctrine\\\\ODM\\\\MongoDB\\\\Mapping\\\\Driver\\\\XmlDriver\\:\\:addFieldMapping\\(\\) expects array#"

tests/Doctrine/ODM/MongoDB/Tests/Aggregation/AggregationOperatorsProviderTrait.php

@@ -606,7 +606,9 @@ protected function createExpr(): Expr
     }
 
     /**
-     * @param mixed $args
+     * @param Closure(Expr): mixed[]|mixed[] $args
+     *
+     * @return mixed[]
      */
     protected function resolveArgs($args): array
     {

tests/Doctrine/ODM/MongoDB/Tests/Aggregation/ExprTest.php

@@ -15,7 +15,8 @@ class ExprTest extends BaseTest
     use AggregationOperatorsProviderTrait;
 
     /**
-     * @param array|Closure $args
+     * @param array<string, string>          $expected
+     * @param Closure(Expr): mixed[]|mixed[] $args
      *
      * @dataProvider provideAllOperators
      */
@@ -29,7 +30,8 @@ public function testGenericOperator(array $expected, string $operator, $args): v
     }
 
     /**
-     * @param array|Closure $args
+     * @param array<string, string>          $expected
+     * @param Closure(Expr): mixed[]|mixed[] $args
      *
      * @dataProvider provideAllOperators
      */

tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/GraphLookupTest.php

@@ -148,6 +148,9 @@ public function provideEmployeeAggregations(): array
     }
 
     /**
+     * @param Closure(Builder): GraphLookup $addGraphLookupStage
+     * @param array<string, string>         $expectedFields
+     *
      * @dataProvider provideEmployeeAggregations
      */
     public function testGraphLookupWithEmployees(Closure $addGraphLookupStage, array $expectedFields): void
@@ -218,6 +221,9 @@ public function provideTravellerAggregations(): array
     }
 
     /**
+     * @param Closure(Builder): GraphLookup $addGraphLookupStage
+     * @param array<string, string>         $expectedFields
+     *
      * @dataProvider provideTravellerAggregations
      */
     public function testGraphLookupWithTraveller(Closure $addGraphLookupStage, array $expectedFields): void

tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/GroupTest.php

@@ -17,7 +17,7 @@ class GroupTest extends BaseTest
     use AggregationOperatorsProviderTrait;
 
     /**
-     * @param Closure|array $args
+     * @param Closure(Expr): Expr[]|mixed[] $args
      *
      * @dataProvider provideProxiedExprMethods
      */

tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/MatchStageTest.php

@@ -40,6 +40,8 @@ public function testMatchFromBuilder(): void
     }
 
     /**
+     * @param mixed[] $args
+     *
      * @dataProvider provideProxiedExprMethods
      */
     public function testProxiedExprMethods(string $method, array $args = []): void

tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/OperatorTest.php

@@ -18,7 +18,8 @@ class OperatorTest extends BaseTest
     use AggregationOperatorsProviderTrait;
 
     /**
-     * @param Closure|array $args
+     * @param array<string, mixed>           $expected
+     * @param Closure(Expr): mixed[]|mixed[] $args
      *
      * @dataProvider provideExpressionOperators
      */

tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/ProjectTest.php

@@ -62,6 +62,8 @@ public function provideAccumulators(): array
     }
 
     /**
+     * @param string[] $args
+     *
      * @dataProvider provideProxiedExprMethods
      */
     public function testProxiedExprMethods(string $method, array $args = []): void

tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/SortTest.php

@@ -8,12 +8,16 @@
 use Doctrine\ODM\MongoDB\Tests\Aggregation\AggregationTestTrait;
 use Doctrine\ODM\MongoDB\Tests\BaseTest;
 
+/**
+ * @psalm-import-type SortShape from Sort
+ */
 class SortTest extends BaseTest
 {
     use AggregationTestTrait;
 
     /**
      * @param string|array<string, string> $field
+     * @psalm-param SortShape $expectedSort
      *
      * @dataProvider provideSortOptions
      */
@@ -26,6 +30,7 @@ public function testSortStage(array $expectedSort, $field, ?string $order = null
 
     /**
      * @param string|array<string, string> $field
+     * @psalm-param SortShape $expectedSort
      *
      * @dataProvider provideSortOptions
      */

tests/Doctrine/ODM/MongoDB/Tests/BaseTest.php

@@ -88,6 +88,9 @@ protected function getConfiguration(): Configuration
      * the original assertion checked.
      *
      * @deprecated
+     *
+     * @param mixed[] $subset
+     * @param mixed[] $array
      */
     public static function assertArraySubset(array $subset, array $array, bool $checkForObjectIdentity = false, string $message = ''): void
     {

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

@@ -7,6 +7,7 @@
 use BadMethodCallException;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ODM\MongoDB\DocumentManager;
+use Doctrine\ODM\MongoDB\Event\LifecycleEventArgs;
 use Doctrine\ODM\MongoDB\Event\PostCollectionLoadEventArgs;
 use Doctrine\ODM\MongoDB\Events;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
@@ -224,6 +225,9 @@ class MyEventListener
     /** @psalm-var array<string, list<class-string>> */
     public array $called = [];
 
+    /**
+     * @param array{LifecycleEventArgs} $args
+     */
     public function __call(string $method, array $args): void
     {
         $document                = $args[0]->getDocument();

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

@@ -83,6 +83,7 @@ public function __construct(PreUpdateEventArgsTest $phpunit)
         $this->phpunit = $phpunit;
     }
 
+    /** @param list<class-string> $allowed */
     public function checkOnly(array $allowed): void
     {
         $this->allowed = $allowed;

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

@@ -6,6 +6,7 @@
 
 use Doctrine\Common\EventSubscriber;
 use Doctrine\ODM\MongoDB\APM\CommandLogger;
+use Doctrine\ODM\MongoDB\Event\LifecycleEventArgs;
 use Doctrine\ODM\MongoDB\Events;
 use Doctrine\ODM\MongoDB\LockException;
 use Doctrine\ODM\MongoDB\PersistentCollection\PersistentCollectionInterface;
@@ -160,6 +161,9 @@ public function getSubscribedEvents(): array
         ];
     }
 
+    /**
+     * @param array{LifecycleEventArgs} $args
+     */
     public function __call(string $eventName, array $args): void
     {
         $document = $args[0]->getDocument();

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

@@ -224,6 +224,9 @@ public function testPrepareQueryOrNewObjWithHashIdAndInOperators(array $hashId):
     }
 
     /**
+     * @param array<string, mixed> $expected
+     * @param array<string, mixed> $query
+     *
      * @dataProvider queryProviderForCustomTypeId
      */
     public function testPrepareQueryOrNewObjWithCustomTypedId(array $expected, array $query): void
@@ -503,6 +506,9 @@ public function testPrepareQueryOrNewObjWithDBRefReferenceToTargetDocumentWithHa
     }
 
     /**
+     * @param array<string, mixed> $expected
+     * @param array<string, mixed> $query
+     *
      * @dataProvider queryProviderForComplexRefWithObjectValue
      */
     public function testPrepareQueryOrNewObjWithComplexRefToTargetDocumentFieldWithObjectValue(array $expected, array $query): void

tests/Doctrine/ODM/MongoDB/Tests/Functional/Iterator/CachingIteratorTest.php

@@ -175,13 +175,25 @@ public function rewind(): void
         $this->assertCount(1, $iterator);
     }
 
+    /**
+     * @param T[] $items
+     *
+     * @return Generator<T>
+     *
+     * @template T
+     */
     private function getTraversable(array $items): Generator
     {
         foreach ($items as $item) {
             yield $item;
         }
     }
 
+    /**
+     * @param array<mixed|Exception> $items
+     *
+     * @return Generator<mixed>
+     */
     private function getTraversableThatThrows(array $items): Generator
     {
         foreach ($items as $item) {

tests/Doctrine/ODM/MongoDB/Tests/Functional/Iterator/HydratingIteratorTest.php

@@ -48,6 +48,11 @@ public function testIterationWithEmptySet(): void
         self::assertFalse($iterator->valid());
     }
 
+    /**
+     * @param array<string, mixed>|null $items
+     *
+     * @return Generator<array<string, mixed>>
+     */
     private function getTraversable(?array $items = null): Generator
     {
         if (! is_array($items)) {

tests/Doctrine/ODM/MongoDB/Tests/Functional/Iterator/UnrewindableIteratorTest.php

@@ -120,13 +120,23 @@ public function testToArrayAfterPartialIteration(): void
         $iterator->toArray();
     }
 
+    /**
+     * @param list<mixed> $items
+     *
+     * @return Generator<mixed>
+     */
     private function getTraversable(array $items): Generator
     {
         foreach ($items as $item) {
             yield $item;
         }
     }
 
+    /**
+     * @param array<mixed|Exception> $items
+     *
+     * @return Generator<mixed>
+     */
     private function getTraversableThatThrows(array $items): Generator
     {
         foreach ($items as $item) {

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

@@ -13,6 +13,9 @@
 use MongoDB\Driver\ReadPreference;
 use MongoDB\Driver\WriteConcern;
 
+/**
+ * @psalm-type ReadPreferenceTagShape = array{dc?: string, usage?: string}
+ */
 class ReadPreferenceTest extends BaseTest
 {
     public function setUp(): void
@@ -43,6 +46,8 @@ public function testHintIsNotSetByDefault(): void
     }
 
     /**
+     * @psalm-param ReadPreferenceTagShape[] $tags
+     *
      * @dataProvider provideReadPreferenceHints
      */
     public function testHintIsSetOnQuery(int $readPreference, array $tags = []): void
@@ -100,6 +105,9 @@ public function testDocumentLevelReadPreferenceCanBeOverriddenInQueryBuilder():
         $this->assertReadPreferenceHint(ReadPreference::RP_SECONDARY, $query->getQuery()['readPreference']);
     }
 
+    /**
+     * @psalm-param ReadPreferenceTagShape[] $tags
+     */
     private function assertReadPreferenceHint(int $mode, ReadPreference $readPreference, array $tags = []): void
     {
         self::assertInstanceOf(ReadPreference::class, $readPreference);

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

@@ -134,16 +134,22 @@ class CommentableAction extends Action
     /**
      * @ODM\Field(type="collection") *
      *
-     * @var array
+     * @var string[]
      */
     protected $comments = [];
 
+    /**
+     * @param string[] $comments
+     */
     public function __construct(string $type, array $comments = [])
     {
         parent::__construct($type);
         $this->comments = $comments;
     }
 
+    /**
+     * @return string[]
+     */
     public function getComments(): array
     {
         return $this->comments;