Use real object managers to know repository type

Based on the class metadata we can easily fetch data from any
configuration format.

Author: lcobucci

extension.neon

@@ -1,6 +1,6 @@
 parameters:
 	doctrine:
-		repositoryClass: Doctrine\ORM\EntityRepository
+		objectManagerLoader: ~
 
 services:
 	-
@@ -17,8 +17,6 @@ services:
 			- phpstan.broker.dynamicMethodReturnTypeExtension
 	-
 		class: PHPStan\Type\Doctrine\ObjectManagerGetRepositoryDynamicReturnTypeExtension
-		arguments:
-			repositoryClass: %doctrine.repositoryClass%
 		tags:
 			- phpstan.broker.dynamicMethodReturnTypeExtension
 	-
@@ -29,3 +27,7 @@ services:
 		class: PHPStan\Type\Doctrine\ObjectRepositoryDynamicReturnTypeExtension
 		tags:
 			- phpstan.broker.dynamicMethodReturnTypeExtension
+	-
+		class: PHPStan\Type\Doctrine\ObjectMetadataResolver
+		arguments:
+			objectManagerLoader: %doctrine.objectManagerLoader%

src/Type/Doctrine/ObjectManagerGetRepositoryDynamicReturnTypeExtension.php

@@ -13,12 +13,12 @@
 class ObjectManagerGetRepositoryDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
 {
 
-	/** @var string */
-	private $repositoryClass;
+	/** @var ObjectMetadataResolver */
+	private $metadataResolver;
 
-	public function __construct(string $repositoryClass)
+	public function __construct(ObjectMetadataResolver $metadataResolver)
 	{
-		$this->repositoryClass = $repositoryClass;
+		$this->metadataResolver = $metadataResolver;
 	}
 
 	public function getClass(): string
@@ -47,7 +47,14 @@ public function getTypeFromMethodCall(
 			return new MixedType();
 		}
 
-		return new ObjectRepositoryType($argType->getValue(), $this->repositoryClass);
+		$objectName = $argType->getValue();
+		$repositoryClass = $this->metadataResolver->getRepositoryClass($objectName);
+
+		if ($repositoryClass === null) {
+			return new MixedType();
+		}
+
+		return new ObjectRepositoryType($objectName, $repositoryClass);
 	}
 
 }

src/Type/Doctrine/ObjectMetadataResolver.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Doctrine;
+
+use Doctrine\Common\Persistence\ObjectManager;
+use Doctrine\ODM\MongoDB\Mapping\ClassMetadata as ODMMetadata;
+use Doctrine\ORM\Mapping\ClassMetadata as ORMMetadata;
+use RuntimeException;
+use function file_exists;
+use function is_readable;
+
+final class ObjectMetadataResolver
+{
+
+	/** @var ObjectManager */
+	private $objectManager;
+
+	public function __construct(string $objectManagerLoader)
+	{
+		$this->objectManager = $this->getObjectManager($objectManagerLoader);
+	}
+
+	private function getObjectManager(string $objectManagerLoader): ObjectManager
+	{
+		if (! file_exists($objectManagerLoader) && ! is_readable($objectManagerLoader)) {
+			throw new RuntimeException('Object manager could not be loaded');
+		}
+
+		return require $objectManagerLoader;
+	}
+
+	public function getRepositoryClass(string $className): ?string
+	{
+		$metatada = $this->objectManager->getClassMetadata($className);
+
+		if ($metatada instanceof ORMMetadata) {
+			return $metatada->customRepositoryClassName ?? 'Doctrine\ORM\EntityRepository';
+		}
+
+		if ($metatada instanceof ODMMetadata) {
+			return $metatada->customRepositoryClassName ?? 'Doctrine\ODM\MongoDB\DocumentRepository';
+		}
+
+		return null;
+	}
+
+}

tests/DoctrineIntegration/ODM/DocumentManagerIntegrationTest.php

@@ -16,6 +16,7 @@ public function dataTopics(): array
 			['documentManagerDynamicReturn'],
 			['documentRepositoryDynamicReturn'],
 			['documentManagerMergeReturn'],
+			['customRepositoryUsage'],
 		];
 	}
 

tests/DoctrineIntegration/ODM/data/customRepositoryUsage.php

@@ -0,0 +1,59 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\DoctrineIntegration\ODM\CustomRepositoryUsage;
+
+use Doctrine\ODM\MongoDB\DocumentManager;
+use Doctrine\ODM\MongoDB\DocumentRepository;
+use Doctrine\ODM\MongoDB\Mapping\Annotations\Document;
+use Doctrine\ODM\MongoDB\Mapping\Annotations\Id;
+use RuntimeException;
+
+class Example
+{
+	/**
+	 * @var MyRepository
+	 */
+	private $repository;
+
+	public function __construct(DocumentManager $documentManager)
+	{
+		$this->repository = $documentManager->getRepository(MyDocument::class);
+	}
+
+	public function get(): void
+	{
+		$test = $this->repository->get('testing');
+		$test->doSomethingElse();
+	}
+}
+
+/**
+ * @Document(repositoryClass=MyRepository::class)
+ */
+class MyDocument
+{
+	/**
+	 * @Id(strategy="NONE", type="string")
+	 *
+	 * @var string
+	 */
+	private $id;
+
+	public function doSomethingElse(): void
+	{
+	}
+}
+
+class MyRepository extends DocumentRepository
+{
+	public function get(string $id): MyDocument
+	{
+		$document = $this->find($id);
+
+		if ($document === null) {
+			throw new RuntimeException('Not found...');
+		}
+
+		return $document;
+	}
+}

tests/DoctrineIntegration/ODM/document-manager.php

@@ -0,0 +1,29 @@
+<?php declare(strict_types = 1);
+
+use Doctrine\Common\Annotations\AnnotationReader;
+use Doctrine\Common\Annotations\AnnotationRegistry;
+use Doctrine\Common\Cache\ArrayCache;
+use Doctrine\ODM\MongoDB\Configuration;
+use Doctrine\ODM\MongoDB\DocumentManager;
+use Doctrine\ODM\MongoDB\Mapping\Driver\AnnotationDriver;
+
+AnnotationRegistry::registerUniqueLoader('class_exists');
+
+$config = new Configuration();
+$config->setProxyDir(__DIR__);
+$config->setProxyNamespace('PHPstan\Doctrine\OdmProxies');
+$config->setMetadataCacheImpl(new ArrayCache());
+$config->setHydratorDir(__DIR__);
+$config->setHydratorNamespace('PHPstan\Doctrine\OdmHydrators');
+
+$config->setMetadataDriverImpl(
+	new AnnotationDriver(
+		new AnnotationReader(),
+		[__DIR__ . '/data']
+	)
+);
+
+return DocumentManager::create(
+	null,
+	$config
+);

tests/DoctrineIntegration/ODM/phpstan.neon

@@ -3,4 +3,4 @@ includes:
 
 parameters:
 	doctrine:
-		repositoryClass: Doctrine\ODM\MongoDB\DocumentRepository
+		objectManagerLoader: tests/DoctrineIntegration/ODM/document-manager.php

tests/DoctrineIntegration/ORM/EntityManagerIntegrationTest.php

@@ -16,6 +16,7 @@ public function dataTopics(): array
 			['entityManagerDynamicReturn'],
 			['entityRepositoryDynamicReturn'],
 			['entityManagerMergeReturn'],
+			['customRepositoryUsage'],
 		];
 	}
 

tests/DoctrineIntegration/ORM/data/customRepositoryUsage.php

@@ -0,0 +1,60 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\DoctrineIntegration\ORM\CustomRepositoryUsage;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\EntityRepository;
+use Doctrine\ORM\Mapping as ORM;
+use RuntimeException;
+
+class Example
+{
+	/**
+	 * @var MyRepository
+	 */
+	private $repository;
+
+	public function __construct(EntityManagerInterface $entityManager)
+	{
+		$this->repository = $entityManager->getRepository(MyEntity::class);
+	}
+
+	public function get(): void
+	{
+		$test = $this->repository->get(1);
+		$test->doSomethingElse();
+	}
+}
+
+/**
+ * @ORM\Entity(repositoryClass=MyRepository::class)
+ */
+class MyEntity
+{
+	/**
+	 * @ORM\Id()
+	 * @ORM\GeneratedValue()
+	 * @ORM\Column(type="integer")
+	 *
+	 * @var int
+	 */
+	private $id;
+
+	public function doSomethingElse(): void
+	{
+	}
+}
+
+class MyRepository extends EntityRepository
+{
+	public function get(int $id): MyEntity
+	{
+		$entity = $this->find($id);
+
+		if ($entity === null) {
+			throw new RuntimeException('Not found...');
+		}
+
+		return $entity;
+	}
+}

tests/DoctrineIntegration/ORM/entity-manager.php

@@ -0,0 +1,30 @@
+<?php declare(strict_types = 1);
+
+use Doctrine\Common\Annotations\AnnotationReader;
+use Doctrine\Common\Annotations\AnnotationRegistry;
+use Doctrine\Common\Cache\ArrayCache;
+use Doctrine\ORM\Configuration;
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
+
+AnnotationRegistry::registerUniqueLoader('class_exists');
+
+$config = new Configuration();
+$config->setProxyDir(__DIR__);
+$config->setProxyNamespace('PHPstan\Doctrine\OrmProxies');
+$config->setMetadataCacheImpl(new ArrayCache());
+
+$config->setMetadataDriverImpl(
+	new AnnotationDriver(
+		new AnnotationReader(),
+		[__DIR__ . '/data']
+	)
+);
+
+return EntityManager::create(
+	[
+		'driver' => 'pdo_sqlite',
+		'memory' => true,
+	],
+	$config
+);

tests/DoctrineIntegration/ORM/phpstan.neon

@@ -1,2 +1,6 @@
 includes:
 	- ../../../extension.neon
+
+parameters:
+	doctrine:
+		objectManagerLoader: tests/DoctrineIntegration/ORM/entity-manager.php