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\Extension; |
15
|
|
|
|
16
|
|
|
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\EagerLoadingTrait; |
17
|
|
|
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface; |
18
|
|
|
use ApiPlatform\Core\Exception\InvalidArgumentException; |
19
|
|
|
use ApiPlatform\Core\Exception\PropertyNotFoundException; |
20
|
|
|
use ApiPlatform\Core\Exception\ResourceClassNotFoundException; |
21
|
|
|
use ApiPlatform\Core\Exception\RuntimeException; |
22
|
|
|
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface; |
23
|
|
|
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface; |
24
|
|
|
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface; |
25
|
|
|
use ApiPlatform\Core\Serializer\SerializerContextBuilderInterface; |
26
|
|
|
use Doctrine\ORM\Mapping\ClassMetadataInfo; |
27
|
|
|
use Doctrine\ORM\QueryBuilder; |
28
|
|
|
use Symfony\Component\HttpFoundation\RequestStack; |
29
|
|
|
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface; |
30
|
|
|
use Symfony\Component\Serializer\Normalizer\AbstractNormalizer; |
31
|
|
|
use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer; |
32
|
|
|
|
33
|
|
|
/** |
34
|
|
|
* Eager loads relations. |
35
|
|
|
* |
36
|
|
|
* @author Charles Sarrazin <[email protected]> |
37
|
|
|
* @author Kévin Dunglas <[email protected]> |
38
|
|
|
* @author Antoine Bluchet <[email protected]> |
39
|
|
|
* @author Baptiste Meyer <[email protected]> |
40
|
|
|
*/ |
41
|
|
|
final class EagerLoadingExtension implements ContextAwareQueryCollectionExtensionInterface, QueryItemExtensionInterface |
42
|
|
|
{ |
43
|
|
|
use EagerLoadingTrait; |
|
|
|
|
44
|
|
|
|
45
|
|
|
private $propertyNameCollectionFactory; |
46
|
|
|
private $propertyMetadataFactory; |
47
|
|
|
private $classMetadataFactory; |
48
|
|
|
private $maxJoins; |
49
|
|
|
private $serializerContextBuilder; |
50
|
|
|
private $requestStack; |
51
|
|
|
|
52
|
|
|
/** |
53
|
|
|
* @TODO move $fetchPartial after $forceEager (@soyuka) in 3.0 |
54
|
|
|
*/ |
55
|
|
|
public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, int $maxJoins = 30, bool $forceEager = true, RequestStack $requestStack = null, SerializerContextBuilderInterface $serializerContextBuilder = null, bool $fetchPartial = false, ClassMetadataFactoryInterface $classMetadataFactory = null) |
56
|
|
|
{ |
57
|
|
|
if (null !== $this->requestStack) { |
58
|
|
|
@trigger_error(sprintf('Passing an instance of "%s" is deprecated since version 2.2 and will be removed in 3.0. Use the data provider\'s context instead.', RequestStack::class), E_USER_DEPRECATED); |
59
|
|
|
} |
60
|
|
|
if (null !== $this->serializerContextBuilder) { |
61
|
|
|
@trigger_error(sprintf('Passing an instance of "%s" is deprecated since version 2.2 and will be removed in 3.0. Use the data provider\'s context instead.', SerializerContextBuilderInterface::class), E_USER_DEPRECATED); |
62
|
|
|
} |
63
|
|
|
|
64
|
|
|
$this->propertyNameCollectionFactory = $propertyNameCollectionFactory; |
65
|
|
|
$this->propertyMetadataFactory = $propertyMetadataFactory; |
66
|
|
|
$this->resourceMetadataFactory = $resourceMetadataFactory; |
67
|
|
|
$this->classMetadataFactory = $classMetadataFactory; |
68
|
|
|
$this->maxJoins = $maxJoins; |
69
|
|
|
$this->forceEager = $forceEager; |
70
|
|
|
$this->fetchPartial = $fetchPartial; |
71
|
|
|
$this->serializerContextBuilder = $serializerContextBuilder; |
72
|
|
|
$this->requestStack = $requestStack; |
73
|
|
|
} |
74
|
|
|
|
75
|
|
|
/** |
76
|
|
|
* {@inheritdoc} |
77
|
|
|
*/ |
78
|
|
|
public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass = null, string $operationName = null, array $context = []) |
79
|
|
|
{ |
80
|
|
|
$this->apply(true, $queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $context); |
81
|
|
|
} |
82
|
|
|
|
83
|
|
|
/** |
84
|
|
|
* The context may contain serialization groups which helps defining joined entities that are readable. |
85
|
|
|
*/ |
86
|
|
|
public function applyToItem(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, array $identifiers, string $operationName = null, array $context = []) |
87
|
|
|
{ |
88
|
|
|
$this->apply(false, $queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $context); |
89
|
|
|
} |
90
|
|
|
|
91
|
|
|
private function apply(bool $collection, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass = null, string $operationName = null, array $context) |
92
|
|
|
{ |
93
|
|
|
if (null === $resourceClass) { |
94
|
|
|
throw new InvalidArgumentException('The "$resourceClass" parameter must not be null'); |
95
|
|
|
} |
96
|
|
|
|
97
|
|
|
$options = []; |
98
|
|
|
if (null !== $operationName) { |
99
|
|
|
$options[($collection ? 'collection' : 'item').'_operation_name'] = $operationName; |
100
|
|
|
} |
101
|
|
|
|
102
|
|
|
$forceEager = $this->shouldOperationForceEager($resourceClass, $options); |
103
|
|
|
$fetchPartial = $this->shouldOperationFetchPartial($resourceClass, $options); |
104
|
|
|
|
105
|
|
|
if (!isset($context['groups']) && !isset($context['attributes'])) { |
106
|
|
|
$contextType = isset($context['api_denormalize']) ? 'denormalization_context' : 'normalization_context'; |
107
|
|
|
$context += $this->getNormalizationContext($context['resource_class'] ?? $resourceClass, $contextType, $options); |
108
|
|
|
} |
109
|
|
|
|
110
|
|
|
if (empty($context[AbstractNormalizer::GROUPS]) && !isset($context[AbstractNormalizer::ATTRIBUTES])) { |
111
|
|
|
return; |
112
|
|
|
} |
113
|
|
|
|
114
|
|
|
$this->joinRelations($queryBuilder, $queryNameGenerator, $resourceClass, $forceEager, $fetchPartial, $queryBuilder->getRootAliases()[0], $options, $context); |
115
|
|
|
} |
116
|
|
|
|
117
|
|
|
/** |
118
|
|
|
* Joins relations to eager load. |
119
|
|
|
* |
120
|
|
|
* @param bool $wasLeftJoin if the relation containing the new one had a left join, we have to force the new one to left join too |
121
|
|
|
* @param int $joinCount the number of joins |
122
|
|
|
* @param int $currentDepth the current max depth |
123
|
|
|
* |
124
|
|
|
* @throws RuntimeException when the max number of joins has been reached |
125
|
|
|
*/ |
126
|
|
|
private function joinRelations(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, bool $forceEager, bool $fetchPartial, string $parentAlias, array $options = [], array $normalizationContext = [], bool $wasLeftJoin = false, int &$joinCount = 0, int $currentDepth = null) |
127
|
|
|
{ |
128
|
|
|
if ($joinCount > $this->maxJoins) { |
129
|
|
|
throw new RuntimeException('The total number of joined relations has exceeded the specified maximum. Raise the limit if necessary, or use the "max_depth" option of the Symfony serializer.'); |
130
|
|
|
} |
131
|
|
|
|
132
|
|
|
$currentDepth = $currentDepth > 0 ? $currentDepth - 1 : $currentDepth; |
133
|
|
|
$entityManager = $queryBuilder->getEntityManager(); |
134
|
|
|
$classMetadata = $entityManager->getClassMetadata($resourceClass); |
135
|
|
|
$attributesMetadata = $this->classMetadataFactory ? $this->classMetadataFactory->getMetadataFor($resourceClass)->getAttributesMetadata() : null; |
136
|
|
|
|
137
|
|
|
if (!empty($normalizationContext[AbstractNormalizer::GROUPS])) { |
138
|
|
|
$options['serializer_groups'] = $normalizationContext[AbstractNormalizer::GROUPS]; |
139
|
|
|
} |
140
|
|
|
|
141
|
|
|
foreach ($classMetadata->associationMappings as $association => $mapping) { |
142
|
|
|
//Don't join if max depth is enabled and the current depth limit is reached |
143
|
|
|
if (0 === $currentDepth && ($normalizationContext[AbstractObjectNormalizer::ENABLE_MAX_DEPTH] ?? false)) { |
144
|
|
|
continue; |
145
|
|
|
} |
146
|
|
|
|
147
|
|
|
try { |
148
|
|
|
$propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $association, $options); |
149
|
|
|
} catch (PropertyNotFoundException $propertyNotFoundException) { |
150
|
|
|
//skip properties not found |
151
|
|
|
continue; |
152
|
|
|
} catch (ResourceClassNotFoundException $resourceClassNotFoundException) { |
153
|
|
|
//skip associations that are not resource classes |
154
|
|
|
continue; |
155
|
|
|
} |
156
|
|
|
|
157
|
|
|
if ( |
158
|
|
|
// Always skip extra lazy associations |
159
|
|
|
ClassMetadataInfo::FETCH_EXTRA_LAZY === $mapping['fetch'] || |
160
|
|
|
// We don't want to interfere with doctrine on this association |
161
|
|
|
(false === $forceEager && ClassMetadataInfo::FETCH_EAGER !== $mapping['fetch']) |
162
|
|
|
) { |
163
|
|
|
continue; |
164
|
|
|
} |
165
|
|
|
|
166
|
|
|
if (isset($normalizationContext[AbstractNormalizer::ATTRIBUTES])) { |
167
|
|
|
if ($inAttributes = isset($normalizationContext[AbstractNormalizer::ATTRIBUTES][$association])) { |
168
|
|
|
// prepare the child context |
169
|
|
|
$normalizationContext[AbstractNormalizer::ATTRIBUTES] = $normalizationContext[AbstractNormalizer::ATTRIBUTES][$association]; |
170
|
|
|
} else { |
171
|
|
|
unset($normalizationContext[AbstractNormalizer::ATTRIBUTES]); |
172
|
|
|
} |
173
|
|
|
} else { |
174
|
|
|
$inAttributes = null; |
175
|
|
|
} |
176
|
|
|
|
177
|
|
|
if ( |
178
|
|
|
(null === $fetchEager = $propertyMetadata->getAttribute('fetch_eager')) && |
179
|
|
|
(null !== $fetchEager = $propertyMetadata->getAttribute('fetchEager')) |
180
|
|
|
) { |
181
|
|
|
@trigger_error('The "fetchEager" attribute is deprecated since 2.3. Please use "fetch_eager" instead.', E_USER_DEPRECATED); |
182
|
|
|
} |
183
|
|
|
|
184
|
|
|
if (false === $fetchEager) { |
185
|
|
|
continue; |
186
|
|
|
} |
187
|
|
|
|
188
|
|
|
$isNotReadableLink = false === $propertyMetadata->isReadableLink(); |
189
|
|
|
if (null === $fetchEager && (false === $propertyMetadata->isReadable() || ((null === $inAttributes && $isNotReadableLink) || (false === $inAttributes)))) { |
190
|
|
|
continue; |
191
|
|
|
} |
192
|
|
|
|
193
|
|
|
$isNullable = $mapping['joinColumns'][0]['nullable'] ?? true; |
194
|
|
|
if (false !== $wasLeftJoin || true === $isNullable) { |
195
|
|
|
$method = 'leftJoin'; |
196
|
|
|
} else { |
197
|
|
|
$method = 'innerJoin'; |
198
|
|
|
} |
199
|
|
|
|
200
|
|
|
$associationAlias = $queryNameGenerator->generateJoinAlias($association); |
201
|
|
|
$queryBuilder->{$method}(sprintf('%s.%s', $parentAlias, $association), $associationAlias); |
202
|
|
|
++$joinCount; |
203
|
|
|
|
204
|
|
|
if (true === $fetchPartial) { |
205
|
|
|
try { |
206
|
|
|
$this->addSelect($queryBuilder, $mapping['targetEntity'], $associationAlias, $options); |
207
|
|
|
} catch (ResourceClassNotFoundException $resourceClassNotFoundException) { |
208
|
|
|
continue; |
209
|
|
|
} |
210
|
|
|
} else { |
211
|
|
|
$queryBuilder->addSelect($associationAlias); |
212
|
|
|
} |
213
|
|
|
|
214
|
|
|
// Avoid recursive joins |
215
|
|
|
if ($mapping['targetEntity'] === $resourceClass) { |
216
|
|
|
// Avoid joining the same association twice (see #1959) |
217
|
|
|
if (!\in_array($associationAlias, $queryBuilder->getAllAliases(), true)) { |
218
|
|
|
$queryBuilder->addSelect($associationAlias); |
219
|
|
|
} |
220
|
|
|
|
221
|
|
|
continue; |
222
|
|
|
} |
223
|
|
|
|
224
|
|
|
if (isset($attributesMetadata[$association])) { |
225
|
|
|
$maxDepth = $attributesMetadata[$association]->getMaxDepth(); |
226
|
|
|
|
227
|
|
|
// The current depth is the lowest max depth available in the ancestor tree. |
228
|
|
|
if (null !== $maxDepth && (null === $currentDepth || $maxDepth < $currentDepth)) { |
229
|
|
|
$currentDepth = $maxDepth; |
230
|
|
|
} |
231
|
|
|
} |
232
|
|
|
|
233
|
|
|
$this->joinRelations($queryBuilder, $queryNameGenerator, $mapping['targetEntity'], $forceEager, $fetchPartial, $associationAlias, $options, $normalizationContext, 'leftJoin' === $method, $joinCount, $currentDepth); |
234
|
|
|
} |
235
|
|
|
} |
236
|
|
|
|
237
|
|
|
private function addSelect(QueryBuilder $queryBuilder, string $entity, string $associationAlias, array $propertyMetadataOptions) |
238
|
|
|
{ |
239
|
|
|
$select = []; |
240
|
|
|
$entityManager = $queryBuilder->getEntityManager(); |
241
|
|
|
$targetClassMetadata = $entityManager->getClassMetadata($entity); |
242
|
|
|
if (!empty($targetClassMetadata->subClasses)) { |
243
|
|
|
$queryBuilder->addSelect($associationAlias); |
244
|
|
|
|
245
|
|
|
return; |
246
|
|
|
} |
247
|
|
|
|
248
|
|
|
foreach ($this->propertyNameCollectionFactory->create($entity) as $property) { |
249
|
|
|
$propertyMetadata = $this->propertyMetadataFactory->create($entity, $property, $propertyMetadataOptions); |
250
|
|
|
|
251
|
|
|
if (true === $propertyMetadata->isIdentifier()) { |
252
|
|
|
$select[] = $property; |
253
|
|
|
continue; |
254
|
|
|
} |
255
|
|
|
|
256
|
|
|
// If it's an embedded property see below |
257
|
|
|
if (!array_key_exists($property, $targetClassMetadata->embeddedClasses)) { |
258
|
|
|
//the field test allows to add methods to a Resource which do not reflect real database fields |
259
|
|
|
if ($targetClassMetadata->hasField($property) && (true === $propertyMetadata->getAttribute('fetchable') || $propertyMetadata->isReadable())) { |
260
|
|
|
$select[] = $property; |
261
|
|
|
} |
262
|
|
|
|
263
|
|
|
continue; |
264
|
|
|
} |
265
|
|
|
|
266
|
|
|
// It's an embedded property, select relevent subfields |
267
|
|
|
foreach ($this->propertyNameCollectionFactory->create($targetClassMetadata->embeddedClasses[$property]['class']) as $embeddedProperty) { |
268
|
|
|
$propertyMetadata = $this->propertyMetadataFactory->create($entity, $property, $propertyMetadataOptions); |
269
|
|
|
$propertyName = "$property.$embeddedProperty"; |
270
|
|
|
if ($targetClassMetadata->hasField($propertyName) && (true === $propertyMetadata->getAttribute('fetchable') || $propertyMetadata->isReadable())) { |
271
|
|
|
$select[] = $propertyName; |
272
|
|
|
} |
273
|
|
|
} |
274
|
|
|
} |
275
|
|
|
|
276
|
|
|
$queryBuilder->addSelect(sprintf('partial %s.{%s}', $associationAlias, implode(',', $select))); |
277
|
|
|
} |
278
|
|
|
|
279
|
|
|
/** |
280
|
|
|
* Gets the serializer context. |
281
|
|
|
* |
282
|
|
|
* @param string $contextType normalization_context or denormalization_context |
283
|
|
|
* @param array $options represents the operation name so that groups are the one of the specific operation |
284
|
|
|
*/ |
285
|
|
|
private function getNormalizationContext(string $resourceClass, string $contextType, array $options): array |
286
|
|
|
{ |
287
|
|
|
if (null !== $this->requestStack && null !== $this->serializerContextBuilder && null !== $request = $this->requestStack->getCurrentRequest()) { |
288
|
|
|
return $this->serializerContextBuilder->createFromRequest($request, 'normalization_context' === $contextType); |
289
|
|
|
} |
290
|
|
|
|
291
|
|
|
$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass); |
292
|
|
|
if (isset($options['collection_operation_name'])) { |
293
|
|
|
$context = $resourceMetadata->getCollectionOperationAttribute($options['collection_operation_name'], $contextType, null, true); |
294
|
|
|
} elseif (isset($options['item_operation_name'])) { |
295
|
|
|
$context = $resourceMetadata->getItemOperationAttribute($options['item_operation_name'], $contextType, null, true); |
296
|
|
|
} else { |
297
|
|
|
$context = $resourceMetadata->getAttribute($contextType); |
298
|
|
|
} |
299
|
|
|
|
300
|
|
|
return $context ?? []; |
301
|
|
|
} |
302
|
|
|
} |
303
|
|
|
|