Completed
Pull Request — master (#1546)
by Kévin
03:20
created

EagerLoadingExtension::addSelect()   C

Complexity

Conditions 12
Paths 11

Size

Total Lines 35
Code Lines 21

Duplication

Lines 6
Ratio 17.14 %

Importance

Changes 0
Metric Value
dl 6
loc 35
rs 5.1612
c 0
b 0
f 0
cc 12
eloc 21
nc 11
nop 4

How to fix   Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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\PropertyNotFoundException;
19
use ApiPlatform\Core\Exception\ResourceClassNotFoundException;
20
use ApiPlatform\Core\Exception\RuntimeException;
21
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
22
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
23
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
24
use ApiPlatform\Core\Serializer\SerializerContextBuilderInterface;
25
use Doctrine\ORM\Mapping\ClassMetadataInfo;
26
use Doctrine\ORM\QueryBuilder;
27
use Symfony\Component\HttpFoundation\RequestStack;
28
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
29
use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
30
use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
31
32
/**
33
 * Eager loads relations.
34
 *
35
 * @author Charles Sarrazin <[email protected]>
36
 * @author Kévin Dunglas <[email protected]>
37
 * @author Antoine Bluchet <[email protected]>
38
 * @author Baptiste Meyer <[email protected]>
39
 */
40
final class EagerLoadingExtension implements QueryCollectionExtensionInterface, QueryItemExtensionInterface
41
{
42
    use EagerLoadingTrait;
43
44
    private $propertyNameCollectionFactory;
45
    private $propertyMetadataFactory;
46
    private $classMetadataFactory;
47
    private $maxJoins;
48
    private $serializerContextBuilder;
49
    private $requestStack;
50
51
    /**
52
     * @TODO move $fetchPartial after $forceEager (@soyuka) in 3.0
53
     */
54
    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)
55
    {
56
        $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
57
        $this->propertyMetadataFactory = $propertyMetadataFactory;
58
        $this->resourceMetadataFactory = $resourceMetadataFactory;
59
        $this->classMetadataFactory = $classMetadataFactory;
60
        $this->maxJoins = $maxJoins;
61
        $this->forceEager = $forceEager;
62
        $this->fetchPartial = $fetchPartial;
63
        $this->serializerContextBuilder = $serializerContextBuilder;
64
        $this->requestStack = $requestStack;
65
    }
66
67
    /**
68
     * {@inheritdoc}
69
     */
70
    public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
71
    {
72
        $options = [];
73
74
        if (null !== $operationName) {
75
            $options = ['collection_operation_name' => $operationName];
76
        }
77
78
        $forceEager = $this->shouldOperationForceEager($resourceClass, $options);
79
        $fetchPartial = $this->shouldOperationFetchPartial($resourceClass, $options);
80
        $serializerContext = $this->getSerializerContext($resourceClass, 'normalization_context', $options);
81
82
        $groups = $this->getPropertyMetadataOptions($options, $serializerContext);
83
84
        $this->joinRelations($queryBuilder, $queryNameGenerator, $resourceClass, $forceEager, $fetchPartial, $queryBuilder->getRootAliases()[0], $groups, $serializerContext);
85
    }
86
87
    /**
88
     * The context may contain serialization groups which helps defining joined entities that are readable.
89
     */
90
    public function applyToItem(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, array $identifiers, string $operationName = null, array $context = [])
91
    {
92
        $options = [];
93
94
        if (null !== $operationName) {
95
            $options = ['item_operation_name' => $operationName];
96
        }
97
98
        $forceEager = $this->shouldOperationForceEager($resourceClass, $options);
99
        $fetchPartial = $this->shouldOperationFetchPartial($resourceClass, $options);
100
        $contextType = isset($context['api_denormalize']) ? 'denormalization_context' : 'normalization_context';
101
        $serializerContext = $this->getSerializerContext($context['resource_class'] ?? $resourceClass, $contextType, $options);
102
        $serializerOptions = $this->getPropertyMetadataOptions($options, $serializerContext);
103
104
        $this->joinRelations($queryBuilder, $queryNameGenerator, $resourceClass, $forceEager, $fetchPartial, $queryBuilder->getRootAliases()[0], $serializerOptions, $serializerContext);
105
    }
106
107
    /**
108
     * Joins relations to eager load.
109
     *
110
     * @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
111
     * @param int  $joinCount    the number of joins
112
     * @param int  $currentDepth the current max depth
113
     *
114
     * @throws RuntimeException when the max number of joins has been reached
115
     */
116
    private function joinRelations(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, bool $forceEager, bool $fetchPartial, string $parentAlias, array $propertyMetadataOptions = [], array $context = [], bool $wasLeftJoin = false, int &$joinCount = 0, int $currentDepth = null)
117
    {
118
        if ($joinCount > $this->maxJoins) {
119
            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.');
120
        }
121
122
        $currentDepth = $currentDepth > 0 ? $currentDepth - 1 : $currentDepth;
123
        $entityManager = $queryBuilder->getEntityManager();
124
        $classMetadata = $entityManager->getClassMetadata($resourceClass);
125
        $attributesMetadata = $this->classMetadataFactory ? $this->classMetadataFactory->getMetadataFor($resourceClass)->getAttributesMetadata() : null;
126
127
        foreach ($classMetadata->associationMappings as $association => $mapping) {
128
            //Don't join if max depth is enabled and the current depth limit is reached
129
            if (isset($context[AbstractObjectNormalizer::ENABLE_MAX_DEPTH]) && 0 === $currentDepth) {
130
                continue;
131
            }
132
133
            try {
134
                $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $association, $propertyMetadataOptions);
135
            } catch (PropertyNotFoundException $propertyNotFoundException) {
136
                //skip properties not found
137
                continue;
138
            } catch (ResourceClassNotFoundException $resourceClassNotFoundException) {
139
                //skip associations that are not resource classes
140
                continue;
141
            }
142
143
            // We don't want to interfere with doctrine on this association
144
            if (false === $forceEager && ClassMetadataInfo::FETCH_EAGER !== $mapping['fetch']) {
145
                continue;
146
            }
147
148
            $attributes = $serializerContext[AbstractNormalizer::ATTRIBUTES] ?? null;
0 ignored issues
show
Unused Code introduced by
$attributes is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
149
            if ((false === $propertyMetadata->isReadableLink() || false === $propertyMetadata->isReadable()) && false === $propertyMetadata->getAttribute('fetchEager', false)) {
150
                continue;
151
            }
152
153
            $isNullable = $mapping['joinColumns'][0]['nullable'] ?? true;
154
            if (false !== $wasLeftJoin || true === $isNullable) {
155
                $method = 'leftJoin';
156
            } else {
157
                $method = 'innerJoin';
158
            }
159
160
            $associationAlias = $queryNameGenerator->generateJoinAlias($association);
161
            $queryBuilder->{$method}(sprintf('%s.%s', $parentAlias, $association), $associationAlias);
162
            ++$joinCount;
163
164
            if (true === $fetchPartial) {
165
                try {
166
                    $this->addSelect($queryBuilder, $mapping['targetEntity'], $associationAlias, $propertyMetadataOptions);
167
                } catch (ResourceClassNotFoundException $resourceClassNotFoundException) {
168
                    continue;
169
                }
170
            } else {
171
                $queryBuilder->addSelect($associationAlias);
172
            }
173
174
            // Avoid recursion
175
            if ($mapping['targetEntity'] === $resourceClass) {
176
                $queryBuilder->addSelect($associationAlias);
177
                continue;
178
            }
179
180
            if (isset($attributesMetadata[$association])) {
181
                $maxDepth = $attributesMetadata[$association]->getMaxDepth();
182
183
                // The current depth is the lowest max depth available in the ancestor tree.
184
                if (null !== $maxDepth && (null === $currentDepth || $maxDepth < $currentDepth)) {
185
                    $currentDepth = $maxDepth;
186
                }
187
            }
188
189
            $this->joinRelations($queryBuilder, $queryNameGenerator, $mapping['targetEntity'], $forceEager, $fetchPartial, $associationAlias, $propertyMetadataOptions, $context, 'leftJoin' === $method, $joinCount, $currentDepth);
190
        }
191
    }
192
193
    private function addSelect(QueryBuilder $queryBuilder, string $entity, string $associationAlias, array $propertyMetadataOptions)
194
    {
195
        $select = [];
196
        $entityManager = $queryBuilder->getEntityManager();
197
        $targetClassMetadata = $entityManager->getClassMetadata($entity);
198
        if ($targetClassMetadata->subClasses) {
199
            $queryBuilder->addSelect($associationAlias);
200
        } else {
201
            foreach ($this->propertyNameCollectionFactory->create($entity) as $property) {
202
                $propertyMetadata = $this->propertyMetadataFactory->create($entity, $property, $propertyMetadataOptions);
203
204
                if (true === $propertyMetadata->isIdentifier()) {
205
                    $select[] = $property;
206
                    continue;
207
                }
208
209
                //the field test allows to add methods to a Resource which do not reflect real database fields
210 View Code Duplication
                if ($targetClassMetadata->hasField($property) && (true === $propertyMetadata->getAttribute('fetchable') || $propertyMetadata->isReadable())) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
211
                    $select[] = $property;
212
                }
213
214
                if (array_key_exists($property, $targetClassMetadata->embeddedClasses)) {
215
                    foreach ($this->propertyNameCollectionFactory->create($targetClassMetadata->embeddedClasses[$property]['class']) as $embeddedProperty) {
216
                        $propertyMetadata = $this->propertyMetadataFactory->create($entity, $property, $propertyMetadataOptions);
217
                        $propertyName = "$property.$embeddedProperty";
218 View Code Duplication
                        if ($targetClassMetadata->hasField($propertyName) && (true === $propertyMetadata->getAttribute('fetchable') || $propertyMetadata->isReadable())) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
219
                            $select[] = $propertyName;
220
                        }
221
                    }
222
                }
223
            }
224
225
            $queryBuilder->addSelect(sprintf('partial %s.{%s}', $associationAlias, implode(',', $select)));
226
        }
227
    }
228
229
    /**
230
     * Gets serializer context.
231
     *
232
     * @param string $contextType normalization_context or denormalization_context
233
     * @param array  $options     represents the operation name so that groups are the one of the specific operation
234
     */
235
    private function getSerializerContext(string $resourceClass, string $contextType, array $options): array
236
    {
237
        $request = null;
238
239
        if (null !== $this->requestStack && null !== $this->serializerContextBuilder) {
240
            $request = $this->requestStack->getCurrentRequest();
241
        }
242
243
        if (null !== $this->serializerContextBuilder && null !== $request && !$request->attributes->get('_graphql')) {
244
            return $this->serializerContextBuilder->createFromRequest($request, 'normalization_context' === $contextType);
245
        }
246
247
        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
248
249 View Code Duplication
        if (isset($options['collection_operation_name'])) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
250
            $context = $resourceMetadata->getCollectionOperationAttribute($options['collection_operation_name'], $contextType, null, true);
251
        } elseif (isset($options['item_operation_name'])) {
252
            $context = $resourceMetadata->getItemOperationAttribute($options['item_operation_name'], $contextType, null, true);
253
        } else {
254
            $context = $resourceMetadata->getAttribute($contextType);
255
        }
256
257
        return $context ?: [];
258
    }
259
260
    /**
261
     * Gets serializer groups if available, if not it returns the $options array.
262
     *
263
     * @param array $options represents the operation name so that groups are the one of the specific operation
264
     */
265
    private function getPropertyMetadataOptions(array $options, array $context): array
266
    {
267
        if (!empty($context[AbstractNormalizer::GROUPS])) {
268
            $options ['serializer_groups'] = $context[AbstractNormalizer::GROUPS];
269
        }
270
271
        return $options;
272
    }
273
}
274