1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/* |
4
|
|
|
* This file is part of the API Platform project. |
5
|
|
|
* |
6
|
|
|
* (c) Kévin Dunglas <[email protected]> |
7
|
|
|
* |
8
|
|
|
* For the full copyright and license information, please view the LICENSE |
9
|
|
|
* file that was distributed with this source code. |
10
|
|
|
*/ |
11
|
|
|
|
12
|
|
|
declare(strict_types=1); |
13
|
|
|
|
14
|
|
|
namespace ApiPlatform\Core\Bridge\Doctrine\Orm; |
15
|
|
|
|
16
|
|
|
use ApiPlatform\Core\Bridge\Doctrine\Common\Util\IdentifierManagerTrait; |
17
|
|
|
use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\FilterEagerLoadingExtension; |
18
|
|
|
use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryCollectionExtensionInterface; |
19
|
|
|
use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryItemExtensionInterface; |
20
|
|
|
use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface; |
21
|
|
|
use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultItemExtensionInterface; |
22
|
|
|
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator; |
23
|
|
|
use ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface; |
24
|
|
|
use ApiPlatform\Core\Exception\ResourceClassNotSupportedException; |
25
|
|
|
use ApiPlatform\Core\Exception\RuntimeException; |
26
|
|
|
use ApiPlatform\Core\Identifier\IdentifierConverterInterface; |
27
|
|
|
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface; |
28
|
|
|
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface; |
29
|
|
|
use Doctrine\Common\Persistence\ManagerRegistry; |
30
|
|
|
use Doctrine\ORM\EntityManagerInterface; |
31
|
|
|
use Doctrine\ORM\Mapping\ClassMetadataInfo; |
32
|
|
|
use Doctrine\ORM\QueryBuilder; |
33
|
|
|
|
34
|
|
|
/** |
35
|
|
|
* Subresource data provider for the Doctrine ORM. |
36
|
|
|
* |
37
|
|
|
* @author Antoine Bluchet <[email protected]> |
38
|
|
|
*/ |
39
|
|
|
final class SubresourceDataProvider implements SubresourceDataProviderInterface |
40
|
|
|
{ |
41
|
|
|
use IdentifierManagerTrait; |
42
|
|
|
|
43
|
|
|
private $managerRegistry; |
44
|
|
|
private $collectionExtensions; |
45
|
|
|
private $itemExtensions; |
46
|
|
|
|
47
|
|
|
/** |
48
|
|
|
* @param QueryCollectionExtensionInterface[] $collectionExtensions |
49
|
|
|
* @param QueryItemExtensionInterface[] $itemExtensions |
50
|
|
|
*/ |
51
|
|
|
public function __construct(ManagerRegistry $managerRegistry, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, iterable $collectionExtensions = [], iterable $itemExtensions = []) |
52
|
|
|
{ |
53
|
|
|
$this->managerRegistry = $managerRegistry; |
54
|
|
|
$this->propertyNameCollectionFactory = $propertyNameCollectionFactory; |
55
|
|
|
$this->propertyMetadataFactory = $propertyMetadataFactory; |
56
|
|
|
$this->collectionExtensions = $collectionExtensions; |
57
|
|
|
$this->itemExtensions = $itemExtensions; |
58
|
|
|
} |
59
|
|
|
|
60
|
|
|
/** |
61
|
|
|
* {@inheritdoc} |
62
|
|
|
* |
63
|
|
|
* @throws RuntimeException |
64
|
|
|
*/ |
65
|
|
|
public function getSubresource(string $resourceClass, array $identifiers, array $context, string $operationName = null) |
66
|
|
|
{ |
67
|
|
|
$manager = $this->managerRegistry->getManagerForClass($resourceClass); |
68
|
|
|
if (null === $manager) { |
69
|
|
|
throw new ResourceClassNotSupportedException(sprintf('The object manager associated with the "%s" resource class cannot be retrieved.', $resourceClass)); |
70
|
|
|
} |
71
|
|
|
|
72
|
|
|
$repository = $manager->getRepository($resourceClass); |
73
|
|
|
if (!method_exists($repository, 'createQueryBuilder')) { |
74
|
|
|
throw new RuntimeException('The repository class must have a "createQueryBuilder" method.'); |
75
|
|
|
} |
76
|
|
|
|
77
|
|
|
if (!isset($context['identifiers'], $context['property'])) { |
78
|
|
|
throw new ResourceClassNotSupportedException('The given resource class is not a subresource.'); |
79
|
|
|
} |
80
|
|
|
|
81
|
|
|
$queryNameGenerator = new QueryNameGenerator(); |
82
|
|
|
|
83
|
|
|
/* |
84
|
|
|
* The following recursively translates to this pseudo-dql: |
85
|
|
|
* |
86
|
|
|
* SELECT thirdLevel WHERE thirdLevel IN ( |
87
|
|
|
* SELECT thirdLevel FROM relatedDummies WHERE relatedDummies = ? AND relatedDummies IN ( |
88
|
|
|
* SELECT relatedDummies FROM Dummy WHERE Dummy = ? |
89
|
|
|
* ) |
90
|
|
|
* ) |
91
|
|
|
* |
92
|
|
|
* By using subqueries, we're forcing the SQL execution plan to go through indexes on doctrine identifiers. |
93
|
|
|
*/ |
94
|
|
|
$queryBuilder = $this->buildQuery($identifiers, $context, $queryNameGenerator, $repository->createQueryBuilder($alias = 'o'), $alias, \count($context['identifiers'])); |
95
|
|
|
|
96
|
|
|
if (true === $context['collection']) { |
97
|
|
|
foreach ($this->collectionExtensions as $extension) { |
98
|
|
|
// We don't need this anymore because we already made sub queries to ensure correct results |
99
|
|
|
if ($extension instanceof FilterEagerLoadingExtension) { |
100
|
|
|
continue; |
101
|
|
|
} |
102
|
|
|
|
103
|
|
|
$extension->applyToCollection($queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $context); |
104
|
|
|
if ($extension instanceof QueryResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) { |
105
|
|
|
return $extension->getResult($queryBuilder, $resourceClass, $operationName, $context); |
106
|
|
|
} |
107
|
|
|
} |
108
|
|
|
} else { |
109
|
|
|
foreach ($this->itemExtensions as $extension) { |
110
|
|
|
$extension->applyToItem($queryBuilder, $queryNameGenerator, $resourceClass, $identifiers, $operationName, $context); |
111
|
|
|
if ($extension instanceof QueryResultItemExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) { |
|
|
|
|
112
|
|
|
return $extension->getResult($queryBuilder, $resourceClass, $operationName, $context); |
|
|
|
|
113
|
|
|
} |
114
|
|
|
} |
115
|
|
|
} |
116
|
|
|
|
117
|
|
|
$query = $queryBuilder->getQuery(); |
118
|
|
|
|
119
|
|
|
return $context['collection'] ? $query->getResult() : $query->getOneOrNullResult(); |
|
|
|
|
120
|
|
|
} |
121
|
|
|
|
122
|
|
|
/** |
123
|
|
|
* @throws RuntimeException |
124
|
|
|
*/ |
125
|
|
|
private function buildQuery(array $identifiers, array $context, QueryNameGenerator $queryNameGenerator, QueryBuilder $previousQueryBuilder, string $previousAlias, int $remainingIdentifiers, QueryBuilder $topQueryBuilder = null): QueryBuilder |
126
|
|
|
{ |
127
|
|
|
if ($remainingIdentifiers <= 0) { |
128
|
|
|
return $previousQueryBuilder; |
129
|
|
|
} |
130
|
|
|
|
131
|
|
|
$topQueryBuilder = $topQueryBuilder ?? $previousQueryBuilder; |
132
|
|
|
|
133
|
|
|
[$identifier, $identifierResourceClass] = $context['identifiers'][$remainingIdentifiers - 1]; |
134
|
|
|
$previousAssociationProperty = $context['identifiers'][$remainingIdentifiers][0] ?? $context['property']; |
135
|
|
|
|
136
|
|
|
$manager = $this->managerRegistry->getManagerForClass($identifierResourceClass); |
137
|
|
|
|
138
|
|
|
if (!$manager instanceof EntityManagerInterface) { |
139
|
|
|
throw new RuntimeException("The manager for $identifierResourceClass must be an EntityManager."); |
140
|
|
|
} |
141
|
|
|
|
142
|
|
|
$classMetadata = $manager->getClassMetadata($identifierResourceClass); |
143
|
|
|
|
144
|
|
|
if (!$classMetadata instanceof ClassMetadataInfo) { |
145
|
|
|
throw new RuntimeException("The class metadata for $identifierResourceClass must be an instance of ClassMetadataInfo."); |
146
|
|
|
} |
147
|
|
|
|
148
|
|
|
$qb = $manager->createQueryBuilder(); |
149
|
|
|
$alias = $queryNameGenerator->generateJoinAlias($identifier); |
150
|
|
|
$normalizedIdentifiers = []; |
151
|
|
|
|
152
|
|
|
if (isset($identifiers[$identifier])) { |
153
|
|
|
// if it's an array it's already normalized, the IdentifierManagerTrait is deprecated |
154
|
|
|
if ($context[IdentifierConverterInterface::HAS_IDENTIFIER_CONVERTER] ?? false) { |
155
|
|
|
$normalizedIdentifiers = $identifiers[$identifier]; |
156
|
|
|
} else { |
157
|
|
|
$normalizedIdentifiers = $this->normalizeIdentifiers($identifiers[$identifier], $manager, $identifierResourceClass); |
158
|
|
|
} |
159
|
|
|
} |
160
|
|
|
|
161
|
|
|
if ($classMetadata->hasAssociation($previousAssociationProperty)) { |
162
|
|
|
$relationType = $classMetadata->getAssociationMapping($previousAssociationProperty)['type']; |
163
|
|
|
switch ($relationType) { |
164
|
|
|
// MANY_TO_MANY relations need an explicit join so that the identifier part can be retrieved |
165
|
|
|
case ClassMetadataInfo::MANY_TO_MANY: |
166
|
|
|
$joinAlias = $queryNameGenerator->generateJoinAlias($previousAssociationProperty); |
167
|
|
|
|
168
|
|
|
$qb->select($joinAlias) |
169
|
|
|
->from($identifierResourceClass, $alias) |
170
|
|
|
->innerJoin("$alias.$previousAssociationProperty", $joinAlias); |
171
|
|
|
break; |
172
|
|
|
case ClassMetadataInfo::ONE_TO_MANY: |
173
|
|
|
$mappedBy = $classMetadata->getAssociationMapping($previousAssociationProperty)['mappedBy']; |
174
|
|
|
$previousAlias = "$previousAlias.$mappedBy"; |
175
|
|
|
|
176
|
|
|
$qb->select($alias) |
177
|
|
|
->from($identifierResourceClass, $alias); |
178
|
|
|
break; |
179
|
|
|
case ClassMetadataInfo::ONE_TO_ONE: |
180
|
|
|
$association = $classMetadata->getAssociationMapping($previousAssociationProperty); |
181
|
|
|
if (!isset($association['mappedBy'])) { |
182
|
|
|
$qb->select("IDENTITY($alias.$previousAssociationProperty)") |
183
|
|
|
->from($identifierResourceClass, $alias); |
184
|
|
|
break; |
185
|
|
|
} |
186
|
|
|
$mappedBy = $association['mappedBy']; |
187
|
|
|
$previousAlias = "$previousAlias.$mappedBy"; |
188
|
|
|
|
189
|
|
|
$qb->select($alias) |
190
|
|
|
->from($identifierResourceClass, $alias); |
191
|
|
|
break; |
192
|
|
|
default: |
193
|
|
|
$qb->select("IDENTITY($alias.$previousAssociationProperty)") |
194
|
|
|
->from($identifierResourceClass, $alias); |
195
|
|
|
} |
196
|
|
|
} elseif ($classMetadata->isIdentifier($previousAssociationProperty)) { |
197
|
|
|
$qb->select($alias) |
198
|
|
|
->from($identifierResourceClass, $alias); |
199
|
|
|
} |
200
|
|
|
|
201
|
|
|
$isLeaf = 1 === $remainingIdentifiers; |
202
|
|
|
|
203
|
|
|
// Add where clause for identifiers |
204
|
|
|
foreach ($normalizedIdentifiers as $key => $value) { |
205
|
|
|
$placeholder = $queryNameGenerator->generateParameterName($key); |
206
|
|
|
$topQueryBuilder->setParameter($placeholder, $value, (string) $classMetadata->getTypeOfField($key)); |
207
|
|
|
|
208
|
|
|
// Optimization: add where clause for identifiers, but not via a WHERE ... IN ( ...subquery... ). |
209
|
|
|
// Instead we use a direct identifier equality clause, to speed things up when dealing with large tables. |
210
|
|
|
// We may do so if there is no more recursion levels from here, and if relation allows it. |
211
|
|
|
$association = $classMetadata->hasAssociation($previousAssociationProperty) ? $classMetadata->getAssociationMapping($previousAssociationProperty) : []; |
212
|
|
|
$oneToOneBidirectional = isset($association['inversedBy']) && ClassMetadataInfo::ONE_TO_ONE === $association['type']; |
213
|
|
|
$oneToManyBidirectional = isset($association['mappedBy']) && ClassMetadataInfo::ONE_TO_MANY === $association['type']; |
214
|
|
|
if ($isLeaf && $oneToOneBidirectional) { |
215
|
|
|
$joinAlias = $queryNameGenerator->generateJoinAlias($association['inversedBy']); |
216
|
|
|
|
217
|
|
|
return $previousQueryBuilder->innerJoin("$previousAlias.{$association['inversedBy']}", $joinAlias) |
218
|
|
|
->andWhere("$joinAlias.$key = :$placeholder"); |
219
|
|
|
} |
220
|
|
|
if ($isLeaf && $oneToManyBidirectional) { |
221
|
|
|
return $previousQueryBuilder->andWhere("IDENTITY($previousAlias) = :$placeholder"); |
222
|
|
|
} |
223
|
|
|
|
224
|
|
|
$qb->andWhere("$alias.$key = :$placeholder"); |
225
|
|
|
} |
226
|
|
|
|
227
|
|
|
// Recurse queries |
228
|
|
|
$qb = $this->buildQuery($identifiers, $context, $queryNameGenerator, $qb, $alias, --$remainingIdentifiers, $topQueryBuilder); |
229
|
|
|
|
230
|
|
|
return $previousQueryBuilder->andWhere($qb->expr()->in($previousAlias, $qb->getDQL())); |
231
|
|
|
} |
232
|
|
|
} |
233
|
|
|
|
This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. Please note the @ignore annotation hint above.