Fix return type on EntityRepository::matching() generics (#743)

Co-authored-by: Eric Stern <eric@ericstern.com>

Author: VincentLanglet

extension.neon

@@ -32,6 +32,7 @@ parameters:
 		- stubs/Persistence/ObjectManagerDecorator.stub
 		- stubs/Persistence/ObjectRepository.stub
 		- stubs/RepositoryFactory.stub
+		- stubs/Collections/AbstractLazyCollection.stub
 		- stubs/Collections/ArrayCollection.stub
 		- stubs/Collections/Selectable.stub
 		- stubs/ORM/AbstractQuery.stub

stubs/Collections/AbstractLazyCollection.stub

@@ -0,0 +1,13 @@
+<?php
+
+namespace Doctrine\Common\Collections;
+
+/**
+ * @phpstan-template TKey of array-key
+ * @phpstan-template T
+ * @template-implements Collection<TKey,T>
+ * @template-implements Selectable<TKey,T>
+ */
+abstract class AbstractLazyCollection implements Collection, Selectable
+{
+}

stubs/EntityManagerInterface.stub

@@ -2,10 +2,10 @@
 
 namespace Doctrine\ORM;
 
-use Doctrine\Persistence\ObjectManager;
-use Doctrine\Persistence\ObjectRepository;
+use Doctrine\ORM\EntityRepository;
 use Doctrine\ORM\Exception\ORMException;
 use Doctrine\ORM\Mapping\ClassMetadata;
+use Doctrine\Persistence\ObjectManager;
 
 interface EntityManagerInterface extends ObjectManager
 {
@@ -29,7 +29,7 @@ interface EntityManagerInterface extends ObjectManager
 	/**
 	 * @template T of object
 	 * @phpstan-param class-string<T> $className
-	 * @phpstan-return ObjectRepository<T>
+	 * @phpstan-return EntityRepository<T>
 	 */
 	public function getRepository($className);
 

stubs/EntityRepository.stub

@@ -2,7 +2,9 @@
 
 namespace Doctrine\ORM;
 
+use Doctrine\Common\Collections\AbstractLazyCollection;
 use Doctrine\Common\Collections\Criteria;
+use Doctrine\Common\Collections\Selectable;
 use Doctrine\Persistence\ObjectRepository;
 
 /**
@@ -59,11 +61,9 @@ class EntityRepository implements ObjectRepository
 	protected function getEntityName();
 
 	/**
-	 * @param \Doctrine\Common\Collections\Criteria $criteria
+	 * @param Criteria $criteria
 	 *
-	 * @return \Doctrine\Common\Collections\Collection
-	 *
-	 * @psalm-return \Doctrine\Common\Collections\Collection<int, TEntityClass>
+	 * @phpstan-return AbstractLazyCollection<int, TEntityClass>&Selectable<int, TEntityClass>
 	 */
 	public function matching(Criteria $criteria);
 

tests/DoctrineIntegration/TypeInferenceTest.php

@@ -2,7 +2,10 @@
 
 namespace PHPStan\DoctrineIntegration;
 
+use Doctrine\Common\Collections\AbstractLazyCollection;
+use Doctrine\Common\Collections\Selectable;
 use PHPStan\Testing\TypeInferenceTestCase;
+use function is_a;
 
 class TypeInferenceTest extends TypeInferenceTestCase
 {
@@ -12,6 +15,12 @@ public function dataFileAsserts(): iterable
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/getRepository.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/isEmpty.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/Collection.php');
+
+		if (is_a(AbstractLazyCollection::class, Selectable::class, true)) { // @phpstan-ignore function.alreadyNarrowedType
+			yield from $this->gatherAssertTypes(__DIR__ . '/data/repositoryMatching-collection26.php');
+		} else {
+			yield from $this->gatherAssertTypes(__DIR__ . '/data/repositoryMatching-collection25.php');
+		}
 	}
 
 	/**

tests/DoctrineIntegration/data/repositoryMatching-collection25.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace RepositoryMatching25;
+
+use Doctrine\Common\Collections\Criteria;
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\EntityRepository;
+use function PHPStan\Testing\assertType;
+
+class Foo
+{
+
+	/** @var EntityManager */
+	private $entityManager;
+
+	public function doFoo(): void
+	{
+		$repository = $this->entityManager->getRepository(MyEntity::class);
+		$criteria = Criteria::create();
+		$results = $repository->matching($criteria);
+		assertType('Doctrine\Common\Collections\AbstractLazyCollection<int, RepositoryMatching25\MyEntity>&Doctrine\Common\Collections\Selectable<int, RepositoryMatching25\MyEntity>', $results);
+		foreach ($results as $result) {
+			assertType(MyEntity::class, $result);
+		}
+	}
+
+	/**
+	 * @param EntityRepository<MyEntity> $repository
+	 */
+	public function withTypedRepository(EntityRepository $repository): void
+	{
+		$criteria = Criteria::create();
+		$results = $repository->matching($criteria);
+		assertType('Doctrine\Common\Collections\AbstractLazyCollection<int, RepositoryMatching25\MyEntity>&Doctrine\Common\Collections\Selectable<int, RepositoryMatching25\MyEntity>', $results);
+		foreach ($results as $result) {
+			assertType(MyEntity::class, $result);
+		}
+	}
+
+}
+
+class MyEntity
+{
+
+}

tests/DoctrineIntegration/data/repositoryMatching-collection26.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace RepositoryMatching26;
+
+use Doctrine\Common\Collections\Criteria;
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\EntityRepository;
+use function PHPStan\Testing\assertType;
+
+class Foo
+{
+
+	/** @var EntityManager */
+	private $entityManager;
+
+	public function doFoo(): void
+	{
+		$repository = $this->entityManager->getRepository(MyEntity::class);
+		$criteria = Criteria::create();
+		$results = $repository->matching($criteria);
+		assertType('Doctrine\Common\Collections\AbstractLazyCollection<int, RepositoryMatching26\MyEntity>', $results);
+		foreach ($results as $result) {
+			assertType(MyEntity::class, $result);
+		}
+	}
+
+	/**
+	 * @param EntityRepository<MyEntity> $repository
+	 */
+	public function withTypedRepository(EntityRepository $repository): void
+	{
+		$criteria = Criteria::create();
+		$results = $repository->matching($criteria);
+		assertType('Doctrine\Common\Collections\AbstractLazyCollection<int, RepositoryMatching26\MyEntity>', $results);
+		foreach ($results as $result) {
+			assertType(MyEntity::class, $result);
+		}
+	}
+
+}
+
+class MyEntity
+{
+
+}