Support EntityRepository<MyEntity> in phpDoc

Author: ondrejmirtes

README.md

@@ -11,6 +11,7 @@ This extension provides following features:
 
 * Provides correct return type for `Doctrine\ORM\EntityManager::find`, `getReference` and `getPartialReference` when `Foo::class` entity class name is provided as the first argument
 * Adds missing `matching` method on `Doctrine\Common\Collections\Collection`. This can be turned off by setting `parameters.doctrine.allCollectionsSelectable` to `false`.
+* Interpret `EntityRepository<MyEntity>` correctly in phpDocs for further type inference of methods called on the repository.
 * Basic DQL validation for parse errors, unknown entity classes and unknown persistent fields.
 
 ## Usage

extension.neon

@@ -33,6 +33,11 @@ services:
 			objectManagerLoader: %doctrine.objectManagerLoader%
 			repositoryClass: %doctrine.repositoryClass%
 
+	-
+		class: PHPStan\PhpDoc\Doctrine\EntityRepositoryTypeNodeResolverExtension
+		tags:
+			- phpstan.phpDoc.typeNodeResolverExtension
+
 	managerRegistryGetRepository:
 		class: PHPStan\Type\Doctrine\GetRepositoryDynamicReturnTypeExtension
 		tags:

src/PhpDoc/Doctrine/EntityRepositoryTypeNodeResolverExtension.php

@@ -0,0 +1,57 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\PhpDoc\Doctrine;
+
+use PHPStan\PhpDoc\TypeNodeResolver;
+use PHPStan\PhpDoc\TypeNodeResolverAwareExtension;
+use PHPStan\PhpDoc\TypeNodeResolverExtension;
+use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
+use PHPStan\PhpDocParser\Ast\Type\TypeNode;
+use PHPStan\Type\Doctrine\ObjectRepositoryType;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeWithClassName;
+
+class EntityRepositoryTypeNodeResolverExtension implements TypeNodeResolverExtension, TypeNodeResolverAwareExtension
+{
+
+	/** @var TypeNodeResolver */
+	private $typeNodeResolver;
+
+	public function setTypeNodeResolver(TypeNodeResolver $typeNodeResolver): void
+	{
+		$this->typeNodeResolver = $typeNodeResolver;
+	}
+
+	public function getCacheKey(): string
+	{
+		return 'doctrine-v1';
+	}
+
+	public function resolve(TypeNode $typeNode, \PHPStan\Analyser\NameScope $nameScope): ?Type
+	{
+		if (!$typeNode instanceof GenericTypeNode) {
+			return null;
+		}
+
+		if (count($typeNode->genericTypes) !== 1) {
+			return null;
+		}
+
+		$repositoryType = $this->typeNodeResolver->resolve($typeNode->type, $nameScope);
+		if (!$repositoryType instanceof TypeWithClassName) {
+			return null;
+		}
+		if (!(new ObjectType('Doctrine\Common\Persistence\ObjectRepository'))->isSuperTypeOf($repositoryType)->yes()) {
+			return null;
+		}
+
+		$entityType = $this->typeNodeResolver->resolve($typeNode->genericTypes[0], $nameScope);
+		if (!$entityType instanceof TypeWithClassName) {
+			return null;
+		}
+
+		return new ObjectRepositoryType($entityType->getClassName(), $repositoryType->getClassName());
+	}
+
+}

src/Type/Doctrine/ObjectRepositoryType.php

@@ -3,6 +3,7 @@
 namespace PHPStan\Type\Doctrine;
 
 use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
 use PHPStan\Type\VerbosityLevel;
 
 class ObjectRepositoryType extends ObjectType
@@ -27,4 +28,9 @@ public function describe(VerbosityLevel $level): string
 		return sprintf('%s<%s>', parent::describe($level), $this->entityClass);
 	}
 
+	public static function __set_state(array $properties): Type
+	{
+		return new self($properties['entityClass'], $properties['className']);
+	}
+
 }

tests/DoctrineIntegration/ORM/data/customRepositoryUsage-2.json

@@ -1,7 +1,17 @@
 [
+    {
+        "message": "Call to an undefined method PHPStan\\DoctrineIntegration\\ORM\\CustomRepositoryUsage\\MyEntity::nonexistent().",
+        "line": 35,
+        "ignorable": true
+    },
     {
         "message": "Call to an undefined method PHPStan\\DoctrineIntegration\\ORM\\CustomRepositoryUsage\\MyRepository::nonexistant().",
-        "line": 30,
+        "line": 40,
+        "ignorable": true
+    },
+    {
+        "message": "Call to an undefined method PHPStan\\DoctrineIntegration\\ORM\\CustomRepositoryUsage\\MyEntity::nonexistent().",
+        "line": 47,
         "ignorable": true
     }
 ]

tests/DoctrineIntegration/ORM/data/customRepositoryUsage-7-missing.json

@@ -0,0 +1,7 @@
+[
+    {
+        "message": "Call to an undefined method PHPStan\\DoctrineIntegration\\ORM\\CustomRepositoryUsage\\MyEntity::nonexistent().",
+        "line": 47,
+        "ignorable": true
+    }
+]

tests/DoctrineIntegration/ORM/data/customRepositoryUsage-7.json

@@ -0,0 +1,12 @@
+[
+    {
+        "message": "Cannot call method doSomethingElse() on PHPStan\\DoctrineIntegration\\ORM\\CustomRepositoryUsage\\MyEntity|null.",
+        "line": 46,
+        "ignorable": true
+    },
+    {
+        "message": "Cannot call method nonexistent() on PHPStan\\DoctrineIntegration\\ORM\\CustomRepositoryUsage\\MyEntity|null.",
+        "line": 47,
+        "ignorable": true
+    }
+]

tests/DoctrineIntegration/ORM/data/customRepositoryUsage.php

@@ -14,21 +14,38 @@ class Example
 	 */
 	private $repository;
 
-	public function __construct(EntityManagerInterface $entityManager)
+	/**
+	 * @var MyRepository<MyEntity>
+	 */
+	private $anotherRepository;
+
+	public function __construct(
+		EntityManagerInterface $entityManager,
+		MyRepository $anotherRepository
+	)
 	{
 		$this->repository = $entityManager->getRepository(MyEntity::class);
+		$this->anotherRepository = $anotherRepository;
 	}
 
 	public function get(): void
 	{
 		$test = $this->repository->get(1);
 		$test->doSomethingElse();
+		$test->nonexistent();
 	}
 
 	public function nonexistant(): void
 	{
 		$this->repository->nonexistant();
 	}
+
+	public function genericRepository(): void
+	{
+		$entity = $this->anotherRepository->find(1);
+		$entity->doSomethingElse();
+		$entity->nonexistent();
+	}
 }
 
 /**