Update stubs to be more strict about mixed vs. object

ondrejmirtes · ondrejmirtes · commit e3173175dcda · 2021-07-08T10:41:15.000+02:00
diff --git a/stubs/Collections/ArrayCollection.stub b/stubs/Collections/ArrayCollection.stub
@@ -3,7 +3,7 @@
 namespace Doctrine\Common\Collections;
 
 /**
- * @template TKey
+ * @template TKey of array-key
  * @template T
  * @implements Collection<TKey,T>
  * @implements Selectable<TKey,T>
diff --git a/stubs/DocumentManager.stub b/stubs/DocumentManager.stub
@@ -50,7 +50,7 @@ class DocumentManager implements ObjectManager
 	public function getPartialReference($documentName, $identifier);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param T $entity
 	 * @phpstan-param bool $deep
 	 * @phpstan-return T
diff --git a/stubs/EntityManager.stub b/stubs/EntityManager.stub
@@ -6,7 +6,7 @@ class EntityManager implements EntityManagerInterface
 {
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $entityName
 	 * @phpstan-param mixed  $id
 	 * @phpstan-param integer|null $lockMode
@@ -16,30 +16,30 @@ class EntityManager implements EntityManagerInterface
 	public function find($entityName, $id, $lockMode = null, $lockVersion = null);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param T $entity
 	 * @phpstan-return T
 	 * @deprecated 2.7 This method is being removed from the ORM and won't have any replacement
 	 */
 	public function merge($entity);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $entityName
 	 * @phpstan-return EntityRepository<T>
 	 */
 	public function getRepository($entityName);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $entityName
 	 * @phpstan-param mixed $id
 	 * @phpstan-return T|null
 	 */
 	public function getReference($entityName, $id);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $entityName
 	 * @phpstan-param mixed $identifier
 	 *
@@ -48,7 +48,7 @@ class EntityManager implements EntityManagerInterface
 	public function getPartialReference($entityName, $identifier);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param T $entity
 	 * @phpstan-param bool $deep
 	 * @phpstan-return T
diff --git a/stubs/EntityManagerDecorator.stub b/stubs/EntityManagerDecorator.stub
@@ -9,7 +9,7 @@ class EntityManagerDecorator implements EntityManagerInterface
 {
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $entityName
 	 * @phpstan-param mixed  $id
 	 * @phpstan-param integer|null $lockMode
@@ -19,29 +19,29 @@ class EntityManagerDecorator implements EntityManagerInterface
 	public function find($entityName, $id, $lockMode = null, $lockVersion = null);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param T $entity
 	 * @phpstan-return T
 	 */
 	public function merge($entity);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $entityName
 	 * @phpstan-return EntityRepository<T>
 	 */
 	public function getRepository($entityName);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $entityName
 	 * @phpstan-param mixed $id
 	 * @phpstan-return T|null
 	 */
 	public function getReference($entityName, $id);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $entityName
 	 * @phpstan-param mixed $identifier
 	 *
@@ -50,7 +50,7 @@ class EntityManagerDecorator implements EntityManagerInterface
 	public function getPartialReference($entityName, $identifier);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param T $entity
 	 * @phpstan-param bool $deep
 	 * @phpstan-return T
diff --git a/stubs/EntityManagerInterface.stub b/stubs/EntityManagerInterface.stub
@@ -9,37 +9,37 @@ interface EntityManagerInterface extends ObjectManager
 {
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $className
 	 * @phpstan-param mixed  $id
 	 * @phpstan-return T|null
 	 */
 	public function find($className, $id);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param T $object
 	 * @phpstan-return T
 	 */
 	public function merge($object);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $className
 	 * @phpstan-return ObjectRepository<T>
 	 */
 	public function getRepository($className);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $entityName
 	 * @phpstan-param mixed $id
 	 * @phpstan-return T|null
 	 */
 	public function getReference($entityName, $id);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $entityName
 	 * @phpstan-param mixed $identifier
 	 *
@@ -48,7 +48,7 @@ interface EntityManagerInterface extends ObjectManager
 	public function getPartialReference($entityName, $identifier);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param T $entity
 	 * @phpstan-param bool $deep
 	 * @phpstan-return T
diff --git a/stubs/EntityRepository.stub b/stubs/EntityRepository.stub
@@ -6,7 +6,7 @@ use Doctrine\Common\Collections\Criteria;
 use Doctrine\Persistence\ObjectRepository;
 
 /**
- * @template TEntityClass
+ * @template TEntityClass of object
  * @implements ObjectRepository<TEntityClass>
  */
 class EntityRepository implements ObjectRepository
diff --git a/stubs/ORM/AbstractQuery.stub b/stubs/ORM/AbstractQuery.stub
@@ -8,7 +8,7 @@ abstract class AbstractQuery
 {
 
 	/**
-	 * @param ArrayCollection<mixed, mixed>|array<mixed> $parameters
+	 * @param ArrayCollection<array-key, mixed>|array<mixed> $parameters
 	 * @return static
 	 */
 	public function setParameters($parameters)
diff --git a/stubs/ORM/QueryBuilder.stub b/stubs/ORM/QueryBuilder.stub
@@ -6,7 +6,7 @@ class QueryBuilder
 {
 
 	/**
-	 * @param \Doctrine\Common\Collections\ArrayCollection<mixed, mixed>|array<mixed> $parameters
+	 * @param \Doctrine\Common\Collections\ArrayCollection<array-key, mixed>|array<mixed> $parameters
 	 * @return static
 	 */
 	public function setParameters($parameters)
diff --git a/stubs/Persistence/ManagerRegistry.stub b/stubs/Persistence/ManagerRegistry.stub
@@ -6,7 +6,7 @@ interface ManagerRegistry
 {
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $persistentObject
 	 * @phpstan-param string $persistentManagerName
 	 * @phpstan-return ObjectRepository<T>
diff --git a/stubs/Persistence/ObjectManager.stub b/stubs/Persistence/ObjectManager.stub
@@ -6,22 +6,22 @@ interface ObjectManager
 {
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $className
 	 * @phpstan-param mixed  $id
 	 * @phpstan-return T|null
 	 */
 	public function find($className, $id);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param T $object
 	 * @phpstan-return T
 	 */
 	public function merge($object);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $className
 	 * @phpstan-return ObjectRepository<T>
 	 */
diff --git a/stubs/Persistence/ObjectManagerDecorator.stub b/stubs/Persistence/ObjectManagerDecorator.stub
@@ -6,22 +6,22 @@ class ObjectManagerDecorator
 {
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $className
 	 * @phpstan-param mixed  $id
 	 * @phpstan-return T|null
 	 */
 	public function find($className, $id);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param T $object
 	 * @phpstan-return T
 	 */
 	public function merge($object);
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @phpstan-param class-string<T> $className
 	 * @phpstan-return ObjectRepository<T>
 	 */
diff --git a/stubs/Persistence/ObjectRepository.stub b/stubs/Persistence/ObjectRepository.stub
@@ -3,7 +3,7 @@
 namespace Doctrine\Persistence;
 
 /**
- * @template TEntityClass
+ * @template TEntityClass of object
  */
 interface ObjectRepository
 {
diff --git a/stubs/RepositoryFactory.stub b/stubs/RepositoryFactory.stub
@@ -8,7 +8,7 @@ use Doctrine\ORM\EntityManagerInterface;
 interface RepositoryFactory
 {
     /**
-     * @template TEntityClass
+     * @template TEntityClass of object
      * @phpstan-param class-string<TEntityClass> $entityName
      * @phpstan-return ObjectRepository<TEntityClass>
      */
diff --git a/stubs/ServiceEntityRepository.stub b/stubs/ServiceEntityRepository.stub
@@ -4,8 +4,8 @@ namespace Doctrine\Bundle\DoctrineBundle\Repository;
 use \Doctrine\ORM\EntityRepository;
 
 /**
- * @template TEntityClass
+ * @template TEntityClass of object
  * @template-extends EntityRepository<TEntityClass>
  */
-class ServiceEntityRepository  extends EntityRepository {
+class ServiceEntityRepository extends EntityRepository {
 }
diff --git a/tests/DoctrineIntegration/ORM/data/customRepositoryUsage-7.json b/tests/DoctrineIntegration/ORM/data/customRepositoryUsage-7.json
@@ -0,0 +1,17 @@
+[
+    {
+        "message": "Call to an undefined method object::doSomethingElse().",
+        "line": 46,
+        "ignorable": true
+    },
+    {
+        "message": "Call to an undefined method object::nonexistent().",
+        "line": 47,
+        "ignorable": true
+    },
+    {
+        "message": "Method PHPStan\\DoctrineIntegration\\ORM\\CustomRepositoryUsage\\MyRepository::get() should return PHPStan\\DoctrineIntegration\\ORM\\CustomRepositoryUsage\\MyEntity but returns T of object.",
+        "line": 97,
+        "ignorable": true
+    }
+]
diff --git a/tests/DoctrineIntegration/ORM/data/customRepositoryUsage-8-missing.json b/tests/DoctrineIntegration/ORM/data/customRepositoryUsage-8-missing.json
@@ -3,5 +3,15 @@
         "message": "Call to an undefined method PHPStan\\DoctrineIntegration\\ORM\\CustomRepositoryUsage\\MyEntity::nonexistent().",
         "line": 54,
         "ignorable": true
+    },
+    {
+        "message": "Call to an undefined method object::doSomethingElse().",
+        "line": 46,
+        "ignorable": true
+    },
+    {
+        "message": "Call to an undefined method object::nonexistent().",
+        "line": 47,
+        "ignorable": true
     }
 ]
diff --git a/tests/DoctrineIntegration/ORM/data/customRepositoryUsage-8.json b/tests/DoctrineIntegration/ORM/data/customRepositoryUsage-8.json
@@ -1,4 +1,14 @@
 [
+    {
+        "message": "Cannot call method doSomethingElse() on object|null.",
+        "line": 46,
+        "ignorable": true
+    },
+    {
+        "message": "Cannot call method nonexistent() on object|null.",
+        "line": 47,
+        "ignorable": true
+    },
     {
         "message": "Cannot call method doSomethingElse() on PHPStan\\DoctrineIntegration\\ORM\\CustomRepositoryUsage\\MyEntity|null.",
         "line": 53,
diff --git a/tests/DoctrineIntegration/ORM/data/customRepositoryUsage.php b/tests/DoctrineIntegration/ORM/data/customRepositoryUsage.php
@@ -81,7 +81,7 @@ public function doSomethingElse(): void
 }
 
 /**
- * @template T
+ * @template T of object
  * @extends EntityRepository<T>
  */
 class MyRepository extends EntityRepository
diff --git a/tests/DoctrineIntegration/ORM/data/entityRepositoryDynamicReturn-0.json b/tests/DoctrineIntegration/ORM/data/entityRepositoryDynamicReturn-0.json
@@ -10,7 +10,7 @@
         "ignorable": true
     },
     {
-        "message": "Method Doctrine\\ORM\\EntityRepository<mixed>::createQueryBuilder() invoked with 0 parameters, 1-2 required.",
+        "message": "Method Doctrine\\ORM\\EntityRepository<object>::createQueryBuilder() invoked with 0 parameters, 1-2 required.",
         "line": 239,
         "ignorable": true
     },
diff --git a/tests/DoctrineIntegration/ORM/data/entityRepositoryDynamicReturn-7.json b/tests/DoctrineIntegration/ORM/data/entityRepositoryDynamicReturn-7.json

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ abstract class AbstractQuery`
`8`	`8`	`{`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * @param ArrayCollection<mixed, mixed>\|array<mixed> $parameters`
	`11`	`+ * @param ArrayCollection<array-key, mixed>\|array<mixed> $parameters`
`12`	`12`	`* @return static`
`13`	`13`	`*/`
`14`	`14`	`public function setParameters($parameters)`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ class QueryBuilder`
`6`	`6`	`{`
`7`	`7`
`8`	`8`	`/**`
`9`		`- * @param \Doctrine\Common\Collections\ArrayCollection<mixed, mixed>\|array<mixed> $parameters`
	`9`	`+ * @param \Doctrine\Common\Collections\ArrayCollection<array-key, mixed>\|array<mixed> $parameters`
`10`	`10`	`* @return static`
`11`	`11`	`*/`
`12`	`12`	`public function setParameters($parameters)`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ interface ManagerRegistry`
`6`	`6`	`{`
`7`	`7`
`8`	`8`	`/**`
`9`		`- * @template T`
	`9`	`+ * @template T of object`
`10`	`10`	`* @phpstan-param class-string<T> $persistentObject`
`11`	`11`	`* @phpstan-param string $persistentManagerName`
`12`	`12`	`* @phpstan-return ObjectRepository<T>`