Skip to content

Commit f66919f

Browse files
ondrejmirtesondrejmirtes
committed
Fix getRepository on DocumentManager
1 parent 9f1df5b commit f66919f

16 files changed

+166
-82
lines changed

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ If your repositories have a common base class, you can configure it in your `php
5555
```neon
5656
parameters:
5757
doctrine:
58-
repositoryClass: MyApp\Doctrine\BetterEntityRepository
58+
ormRepositoryClass: MyApp\Doctrine\BetterEntityRepository
59+
odmRepositoryClass: MyApp\Doctrine\BetterDocumentRepository
5960
```
6061

6162
You can opt in for more advanced analysis by providing the object manager from your own application. This will enable DQL validation:

‎extension.neon‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
parameters:
22
doctrine:
33
repositoryClass: null
4+
ormRepositoryClass: null
5+
odmRepositoryClass: null
46
queryBuilderClass: null
57
allCollectionsSelectable: true
68
objectManagerLoader: null
@@ -47,6 +49,8 @@ parameters:
4749
parametersSchema:
4850
doctrine: structure([
4951
repositoryClass: schema(string(), nullable())
52+
ormRepositoryClass: schema(string(), nullable())
53+
odmRepositoryClass: schema(string(), nullable())
5054
queryBuilderClass: schema(string(), nullable())
5155
allCollectionsSelectable: bool()
5256
objectManagerLoader: schema(string(), nullable())
@@ -90,7 +94,6 @@ services:
9094
class: PHPStan\Type\Doctrine\ObjectMetadataResolver
9195
arguments:
9296
objectManagerLoader: %doctrine.objectManagerLoader%
93-
repositoryClass: %doctrine.repositoryClass%
9497
-
9598
class: PHPStan\Type\Doctrine\QueryBuilder\QueryBuilderGetDqlDynamicReturnTypeExtension
9699
arguments:
@@ -155,27 +158,39 @@ services:
155158
- phpstan.broker.dynamicMethodReturnTypeExtension
156159
arguments:
157160
managerClass: Doctrine\Persistence\ManagerRegistry
161+
repositoryClass: %doctrine.repositoryClass%
162+
ormRepositoryClass: %doctrine.ormRepositoryClass%
163+
odmRepositoryClass: %doctrine.odmRepositoryClass%
158164

159165
objectManagerGetRepository:
160166
class: PHPStan\Type\Doctrine\GetRepositoryDynamicReturnTypeExtension
161167
tags:
162168
- phpstan.broker.dynamicMethodReturnTypeExtension
163169
arguments:
164170
managerClass: Doctrine\Persistence\ObjectManager
171+
repositoryClass: %doctrine.repositoryClass%
172+
ormRepositoryClass: %doctrine.ormRepositoryClass%
173+
odmRepositoryClass: %doctrine.odmRepositoryClass%
165174

166175
persistenceManagerRegistryGetRepository:
167176
class: PHPStan\Type\Doctrine\GetRepositoryDynamicReturnTypeExtension
168177
tags:
169178
- phpstan.broker.dynamicMethodReturnTypeExtension
170179
arguments:
171180
managerClass: Doctrine\Persistence\ManagerRegistry
181+
repositoryClass: %doctrine.repositoryClass%
182+
ormRepositoryClass: %doctrine.ormRepositoryClass%
183+
odmRepositoryClass: %doctrine.odmRepositoryClass%
172184

173185
persistenceObjectManagerGetRepository:
174186
class: PHPStan\Type\Doctrine\GetRepositoryDynamicReturnTypeExtension
175187
tags:
176188
- phpstan.broker.dynamicMethodReturnTypeExtension
177189
arguments:
178190
managerClass: Doctrine\Persistence\ObjectManager
191+
repositoryClass: %doctrine.repositoryClass%
192+
ormRepositoryClass: %doctrine.ormRepositoryClass%
193+
odmRepositoryClass: %doctrine.odmRepositoryClass%
179194

180195
## NewExprDynamicReturnTypeExtensions
181196

‎rules.neon‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ parameters:
77
parametersSchema:
88
doctrine: structure([
99
repositoryClass: schema(string(), nullable())
10+
ormRepositoryClass: schema(string(), nullable())
11+
odmRepositoryClass: schema(string(), nullable())
1012
queryBuilderClass: schema(string(), nullable())
1113
allCollectionsSelectable: bool()
1214
objectManagerLoader: schema(string(), nullable())

‎src/Type/Doctrine/GetRepositoryDynamicReturnTypeExtension.php‎

Lines changed: 69 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@
22

33
namespace PHPStan\Type\Doctrine;
44

5+
use Doctrine\ODM\MongoDB\DocumentManager;
6+
use Doctrine\ODM\MongoDB\Repository\DocumentRepository;
7+
use Doctrine\ORM\EntityRepository;
58
use PhpParser\Node\Expr\MethodCall;
69
use PHPStan\Analyser\Scope;
710
use PHPStan\Reflection\MethodReflection;
811
use PHPStan\Reflection\ParametersAcceptorSelector;
12+
use PHPStan\Reflection\ReflectionProvider;
913
use PHPStan\Type\Constant\ConstantStringType;
1014
use PHPStan\Type\Generic\GenericClassStringType;
1115
use PHPStan\Type\Generic\GenericObjectType;
@@ -17,17 +21,37 @@
1721
class GetRepositoryDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
1822
{
1923

24+
/** @var ReflectionProvider */
25+
private $reflectionProvider;
26+
27+
/** @var string|null */
28+
private $repositoryClass;
29+
30+
/** @var string|null */
31+
private $ormRepositoryClass;
32+
33+
/** @var string|null */
34+
private $odmRepositoryClass;
35+
2036
/** @var string */
2137
private $managerClass;
2238

2339
/** @var ObjectMetadataResolver */
2440
private $metadataResolver;
2541

2642
public function __construct(
43+
ReflectionProvider $reflectionProvider,
44+
?string $repositoryClass,
45+
?string $ormRepositoryClass,
46+
?string $odmRepositoryClass,
2747
string $managerClass,
2848
ObjectMetadataResolver $metadataResolver
2949
)
3050
{
51+
$this->reflectionProvider = $reflectionProvider;
52+
$this->repositoryClass = $repositoryClass;
53+
$this->ormRepositoryClass = $ormRepositoryClass;
54+
$this->odmRepositoryClass = $odmRepositoryClass;
3155
$this->managerClass = $managerClass;
3256
$this->metadataResolver = $metadataResolver;
3357
}
@@ -48,9 +72,15 @@ public function getTypeFromMethodCall(
4872
Scope $scope
4973
): Type
5074
{
75+
$calledOnType = $scope->getType($methodCall->var);
76+
if ((new ObjectType(DocumentManager::class))->isSuperTypeOf($calledOnType)->yes()) {
77+
$defaultRepositoryClass = $this->odmRepositoryClass ?? $this->repositoryClass ?? DocumentRepository::class;
78+
} else {
79+
$defaultRepositoryClass = $this->ormRepositoryClass ?? $this->repositoryClass ?? EntityRepository::class;
80+
}
5181
if (count($methodCall->getArgs()) === 0) {
5282
return new GenericObjectType(
53-
$this->metadataResolver->getResolvedRepositoryClass(),
83+
$defaultRepositoryClass,
5484
[new ObjectWithoutClassType()]
5585
);
5686
}
@@ -62,20 +92,20 @@ public function getTypeFromMethodCall(
6292
$classType = $argType->getGenericType();
6393
if (!$classType instanceof TypeWithClassName) {
6494
return new GenericObjectType(
65-
$this->metadataResolver->getResolvedRepositoryClass(),
95+
$defaultRepositoryClass,
6696
[$classType]
6797
);
6898
}
6999

70100
$objectName = $classType->getClassName();
71101
} else {
72-
return $this->getDefaultReturnType($scope, $methodCall->getArgs(), $methodReflection);
102+
return $this->getDefaultReturnType($scope, $methodCall->getArgs(), $methodReflection, $defaultRepositoryClass);
73103
}
74104

75105
try {
76-
$repositoryClass = $this->metadataResolver->getRepositoryClass($objectName);
106+
$repositoryClass = $this->getRepositoryClass($objectName, $defaultRepositoryClass);
77107
} catch (\Doctrine\ORM\Mapping\MappingException $e) {
78-
return $this->getDefaultReturnType($scope, $methodCall->getArgs(), $methodReflection);
108+
return $this->getDefaultReturnType($scope, $methodCall->getArgs(), $methodReflection, $defaultRepositoryClass);
79109
}
80110

81111
return new GenericObjectType($repositoryClass, [
@@ -89,7 +119,7 @@ public function getTypeFromMethodCall(
89119
* @param \PHPStan\Reflection\MethodReflection $methodReflection
90120
* @return \PHPStan\Type\Type
91121
*/
92-
private function getDefaultReturnType(Scope $scope, array $args, MethodReflection $methodReflection): Type
122+
private function getDefaultReturnType(Scope $scope, array $args, MethodReflection $methodReflection, string $defaultRepositoryClass): Type
93123
{
94124
$defaultType = ParametersAcceptorSelector::selectFromArgs(
95125
$scope,
@@ -98,12 +128,44 @@ private function getDefaultReturnType(Scope $scope, array $args, MethodReflectio
98128
)->getReturnType();
99129
if ($defaultType instanceof GenericObjectType && count($defaultType->getTypes()) > 0) {
100130
return new GenericObjectType(
101-
$this->metadataResolver->getResolvedRepositoryClass(),
131+
$defaultRepositoryClass,
102132
[$defaultType->getTypes()[0]]
103133
);
104134
}
105135

106136
return $defaultType;
107137
}
108138

139+
private function getRepositoryClass(string $className, string $defaultRepositoryClass): string
140+
{
141+
if (!$this->reflectionProvider->hasClass($className)) {
142+
return $defaultRepositoryClass;
143+
}
144+
145+
$classReflection = $this->reflectionProvider->getClass($className);
146+
if ($classReflection->isInterface() || $classReflection->isTrait()) {
147+
return $defaultRepositoryClass;
148+
}
149+
150+
$metadata = $this->metadataResolver->getClassMetadata($classReflection->getName());
151+
if ($metadata !== null) {
152+
return $metadata->customRepositoryClassName ?? $defaultRepositoryClass;
153+
}
154+
155+
$objectManager = $this->metadataResolver->getObjectManager();
156+
if ($objectManager === null) {
157+
return $defaultRepositoryClass;
158+
}
159+
160+
$metadata = $objectManager->getClassMetadata($classReflection->getName());
161+
$odmMetadataClass = 'Doctrine\ODM\MongoDB\Mapping\ClassMetadata';
162+
if ($metadata instanceof $odmMetadataClass) {
163+
/** @var \Doctrine\ODM\MongoDB\Mapping\ClassMetadata<object> $odmMetadata */
164+
$odmMetadata = $metadata;
165+
return $odmMetadata->customRepositoryClassName ?? $defaultRepositoryClass;
166+
}
167+
168+
return $defaultRepositoryClass;
169+
}
170+
109171
}

‎src/Type/Doctrine/ObjectMetadataResolver.php‎

Lines changed: 0 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -6,40 +6,26 @@
66
use Doctrine\ORM\Mapping\ClassMetadataInfo;
77
use Doctrine\Persistence\Mapping\ClassMetadataFactory;
88
use Doctrine\Persistence\ObjectManager;
9-
use PHPStan\Reflection\ReflectionProvider;
109
use function is_file;
1110
use function is_readable;
1211

1312
final class ObjectMetadataResolver
1413
{
1514

16-
/** @var ReflectionProvider */
17-
private $reflectionProvider;
18-
1915
/** @var string|null */
2016
private $objectManagerLoader;
2117

2218
/** @var ObjectManager|null|false */
2319
private $objectManager;
2420

25-
/** @var string|null */
26-
private $repositoryClass;
27-
28-
/** @var string|null */
29-
private $resolvedRepositoryClass;
30-
3121
/** @var ClassMetadataFactory<ClassMetadata>|null */
3222
private $metadataFactory;
3323

3424
public function __construct(
35-
ReflectionProvider $reflectionProvider,
3625
?string $objectManagerLoader,
37-
?string $repositoryClass
3826
)
3927
{
40-
$this->reflectionProvider = $reflectionProvider;
4128
$this->objectManagerLoader = $objectManagerLoader;
42-
$this->repositoryClass = $repositoryClass;
4329
}
4430

4531
public function hasObjectManagerLoader(): bool
@@ -154,54 +140,4 @@ private function loadObjectManager(string $objectManagerLoader): ?ObjectManager
154140
return require $objectManagerLoader;
155141
}
156142

157-
public function getResolvedRepositoryClass(): string
158-
{
159-
if ($this->resolvedRepositoryClass !== null) {
160-
return $this->resolvedRepositoryClass;
161-
}
162-
163-
$objectManager = $this->getObjectManager();
164-
if ($this->repositoryClass !== null) {
165-
return $this->resolvedRepositoryClass = $this->repositoryClass;
166-
}
167-
168-
if ($objectManager !== null && get_class($objectManager) === 'Doctrine\ODM\MongoDB\DocumentManager') {
169-
return $this->resolvedRepositoryClass = 'Doctrine\ODM\MongoDB\Repository\DocumentRepository';
170-
}
171-
172-
return $this->resolvedRepositoryClass = 'Doctrine\ORM\EntityRepository';
173-
}
174-
175-
public function getRepositoryClass(string $className): string
176-
{
177-
if (!$this->reflectionProvider->hasClass($className)) {
178-
return $this->getResolvedRepositoryClass();
179-
}
180-
181-
$classReflection = $this->reflectionProvider->getClass($className);
182-
if ($classReflection->isInterface() || $classReflection->isTrait()) {
183-
return $this->getResolvedRepositoryClass();
184-
}
185-
186-
$metadata = $this->getClassMetadata($classReflection->getName());
187-
if ($metadata !== null) {
188-
return $metadata->customRepositoryClassName ?? $this->getResolvedRepositoryClass();
189-
}
190-
191-
$objectManager = $this->getObjectManager();
192-
if ($objectManager === null) {
193-
return $this->getResolvedRepositoryClass();
194-
}
195-
196-
$metadata = $objectManager->getClassMetadata($classReflection->getName());
197-
$odmMetadataClass = 'Doctrine\ODM\MongoDB\Mapping\ClassMetadata';
198-
if ($metadata instanceof $odmMetadataClass) {
199-
/** @var \Doctrine\ODM\MongoDB\Mapping\ClassMetadata<object> $odmMetadata */
200-
$odmMetadata = $metadata;
201-
return $odmMetadata->customRepositoryClassName ?? $this->getResolvedRepositoryClass();
202-
}
203-
204-
return $this->getResolvedRepositoryClass();
205-
}
206-
207143
}

‎tests/DoctrineIntegration/TypeInferenceTest.php‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\DoctrineIntegration;
4+
5+
use PHPStan\Testing\TypeInferenceTestCase;
6+
7+
class TypeInferenceTest extends TypeInferenceTestCase
8+
{
9+
10+
/**
11+
* @return iterable<mixed>
12+
*/
13+
public function dataFileAsserts(): iterable
14+
{
15+
yield from $this->gatherAssertTypes(__DIR__ . '/data/getRepository.php');
16+
}
17+
18+
/**
19+
* @dataProvider dataFileAsserts
20+
*/
21+
public function testFileAsserts(
22+
string $assertType,
23+
string $file,
24+
mixed ...$args
25+
): void
26+
{
27+
$this->assertFileAsserts($assertType, $file, ...$args);
28+
}
29+
30+
public static function getAdditionalConfigFiles(): array
31+
{
32+
return [__DIR__ . '/../../extension.neon'];
33+
}
34+
35+
}

0 commit comments

Comments
 (0)