Upgrade to PHPStan 2.1 (#2761)

* Upgrade to PHPStan 1.12

* Ensure we don't have phpstan deprecation

* [doc] Set TKey type on Collection

https://github.com/doctrine/collections/blob/2eb07e5953eed811ce1b309a7478a3b236f2273d/src/Collection.php#L29

* Upgrade to phpstan 2

* Run PHPStan on PHP 8.4

* PersistentCollections is not always present

Path "tests/PersistentCollections" is neither a directory, nor a file path, nor a fnmatch pattern.

If the excluded path can sometimes exist, append (?)
to its config entry to mark it as optional. Example:

parameters:
	excludePaths:
		analyseAndScan:
			- tests/PersistentCollections (?)

* Keep type assertions even when type is declared

* Use @param-out for by-reference parameter

phpstan/phpstan#10823

* Set properties to null instead of unset, as property hooks could be used in child classes

* Fix generic types

* Fix property.unusedType on private collection property

* Fix type of $visited parameter set by-reference, changed since we use spl_object_id

* ReflectionProperty::isInitialized() is always available since PHP 8.4

* Ignore missingType.generics on UnitOfWork::$persisters

It should be a class-string-map, but not supported by phpstan

phpstan/phpstan#9521

* Don't check Metadata generic type

* Ignore arguments.count error on method calls with variable name

* Update baseline

* Fix type of Profile::$profileId

* Remove incorrect @throw annotation

* Make Expr constructor final, as it is instanciated with new static

Author: GromNaN

.github/workflows/static-analysis.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "8.2"
+          - "8.4"
 
     steps:
       - name: "Checkout code"

composer.json

@@ -44,8 +44,9 @@
         "doctrine/orm": "^3.2",
         "jmikola/geojson": "^1.0",
         "phpbench/phpbench": "^1.0.0",
-        "phpstan/phpstan": "~1.10.67",
-        "phpstan/phpstan-phpunit": "^1.0",
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-deprecation-rules": "^2.0",
+        "phpstan/phpstan-phpunit": "^2.0",
         "phpunit/phpunit": "^10.4",
         "squizlabs/php_codesniffer": "^3.5",
         "symfony/cache": "^5.4 || ^6.0 || ^7.0"

docs/en/cookbook/lookup-reference.rst

@@ -68,7 +68,7 @@ and a date.
         #[Field(type: 'date_immutable')]
         public DateTimeImmutable $date;
 
-        /** @var Collection<Item> */
+        /** @var Collection<int, Item> */
         #[ReferenceMany(
             targetDocument: Item::class,
             cascade: 'all',
@@ -378,7 +378,7 @@ You need to create a new class to hold the result of the aggregation.
         #[Field(type: 'date_immutable')]
         public DateTimeImmutable $date;
 
-        /** @var Collection<Item> */
+        /** @var Collection<int, Item> */
         #[EmbedMany(targetDocument: Item::class)]
         public Collection $items;
 
@@ -631,7 +631,7 @@ but not the user.
         #[Field(type: 'string')]
         public string $name;
 
-        /** @var Collection<UserOrderResult> */
+        /** @var Collection<int, UserOrderResult> */
         #[EmbedMany(targetDocument: UserOrderResult::class)]
         public Collection $orders;
     }
@@ -645,7 +645,7 @@ but not the user.
         #[Field(type: 'date_immutable')]
         public DateTimeImmutable $date;
 
-        /** @var Collection<Item> */
+        /** @var Collection<int, Item> */
         #[EmbedMany(targetDocument: Item::class)]
         public Collection $items;
     }

docs/en/cookbook/simple-search-engine.rst

@@ -141,7 +141,7 @@ Now you can embed the ``Keyword`` document many times in the ``Product``:
     {
         // ...
 
-        /** @var Collection<Keyword> */
+        /** @var Collection<int, Keyword> */
         #[EmbedMany(targetDocument: Keyword::class)]
         public Collection $keywords;
 

docs/en/reference/aggregation-stage-reference.rst

@@ -381,7 +381,7 @@ pipeline stages. Take the following relationship for example:
 
     class Orders
     {
-        /** @var Collection<Item> */
+        /** @var Collection<int, Item> */
         #[ReferenceMany(
             targetDocument: Item::class,
             cascade: 'all',

docs/en/reference/attributes-reference.rst

@@ -217,7 +217,7 @@ Optional arguments:
 
     class User
     {
-        /** @var Collection<BookTag|SongTag> */
+        /** @var Collection<int, BookTag|SongTag> */
         #[EmbedMany(
             strategy:'set',
             discriminatorField:'type',
@@ -987,7 +987,7 @@ Optional arguments:
 
     class User
     {
-        /** @var Collection<Item> */
+        /** @var Collection<int, Item> */
         #[ReferenceMany(
             strategy: 'set',
             targetDocument: Item::class,

docs/en/reference/bidirectional-references.rst

@@ -23,7 +23,7 @@ and changes are tracked and persisted separately. Here is an example:
     {
         // ...
 
-        /** @var Collection<BlogPost> */
+        /** @var Collection<int, BlogPost> */
         #[ReferenceMany(targetDocument: BlogPost::class)]
         private Collection $posts;
     }
@@ -66,7 +66,7 @@ One to Many
     {
         // ...
 
-        /** @var Collection<BlogPost> */
+        /** @var Collection<int, BlogPost> */
         #[ReferenceMany(targetDocument: BlogPost::class, mappedBy: 'user')]
         private Collection $posts;
     }
@@ -189,11 +189,11 @@ Self-Referencing Many to Many
     {
         // ...
 
-        /** @var Collection<User> */
+        /** @var Collection<int, User> */
         #[ReferenceMany(targetDocument: User::class, mappedBy: 'myFriends')]
         public Collection $friendsWithMe;
 
-        /** @var Collection<User> */
+        /** @var Collection<int, User> */
         #[ReferenceMany(targetDocument: User::class, inversedBy: 'friendsWithMe')]
         public Collection $myFriends;
 

docs/en/reference/complex-references.rst

@@ -35,11 +35,11 @@ querying by the BlogPost's ID.
     {
         // ...
 
-        /** @var Collection<Comment> */
+        /** @var Collection<int, Comment> */
         #[ReferenceMany(targetDocument: Comment::class, mappedBy: 'blogPost')]
         private Collection $comments;
 
-        /** @var Collection<Comment> */
+        /** @var Collection<int, Comment> */
         #[ReferenceMany(
              targetDocument: Comment::class,
              mappedBy: 'blogPost',
@@ -88,7 +88,7 @@ administrators:
 
     class BlogPost
     {
-        /** @var Collection<Comment> */
+        /** @var Collection<int, Comment> */
         #[ReferenceMany(
              targetDocument: Comment::class,
              mappedBy: 'blogPost',
@@ -109,7 +109,7 @@ call on the Comment repository class to populate the reference.
 
     class BlogPost
     {
-        /** @var Collection<Comment> */
+        /** @var Collection<int, Comment> */
         #[ReferenceMany(
              targetDocument: Comment::class,
              mappedBy: 'blogPost',

docs/en/reference/custom-collections.rst

@@ -20,7 +20,7 @@ persistence-related features.
     {
         // ...
 
-        /** @var Collection<Section> */
+        /** @var Collection<int, Section> */
         #[EmbedMany(targetDocument: Section::class)]
         public Collection $sections;
 
@@ -55,7 +55,7 @@ and ensuring that your custom class is initialized in the owning class' construc
     {
         // ...
 
-        /** @var Collection<Section> */
+        /** @var Collection<int, Section> */
         #[EmbedMany(
             collectionClass: SectionCollection::class,
             targetDocument: Section::class,

docs/en/reference/embedded-mapping.rst

@@ -73,7 +73,7 @@ Embed many documents:
         {
             // ...
 
-            /** @var Collection<PhoneNumber> */
+            /** @var Collection<int, PhoneNumber> */
             #[EmbedMany(targetDocument: Phonenumber::class)]
             private Collection $phoneNumbers;
 
@@ -283,7 +283,7 @@ You can achieve this behavior by using the `storeEmptyArray` option for embedded
         {
             // ...
 
-            /** @var Collection<PhoneNumber> */
+            /** @var Collection<int, PhoneNumber> */
             #[EmbedMany(targetDocument: PhoneNumber::class, storeEmptyArray: true)]
             private Collection $phoneNumbers;
             // ...