Failed Conditions
Pull Request — 2.6 (#7785)
by Luís
12:23
created

ClassMetadataFactory::completeIdGeneratorMapping()   F

Complexity

Conditions 21
Paths 208

Size

Total Lines 103
Code Lines 69

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 40
CRAP Score 44.2558

Importance

Changes 0
Metric Value
cc 21
eloc 69
c 0
b 0
f 0
nc 208
nop 1
dl 0
loc 103
ccs 40
cts 64
cp 0.625
crap 44.2558
rs 3.2333

How to fix   Long Method    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
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14
 *
15
 * This software consists of voluntary contributions made by many individuals
16
 * and is licensed under the MIT license. For more information, see
17
 * <http://www.doctrine-project.org>.
18
 */
19
20
namespace Doctrine\ORM\Mapping;
21
22
use Doctrine\Common\Persistence\Mapping\AbstractClassMetadataFactory;
23
use Doctrine\Common\Persistence\Mapping\ClassMetadata as ClassMetadataInterface;
24
use Doctrine\Common\Persistence\Mapping\ReflectionService;
25
use Doctrine\DBAL\Platforms;
26
use Doctrine\ORM\EntityManagerInterface;
27
use Doctrine\ORM\Event\LoadClassMetadataEventArgs;
28
use Doctrine\ORM\Event\OnClassMetadataNotFoundEventArgs;
29
use Doctrine\ORM\Events;
30
use Doctrine\ORM\Id\BigIntegerIdentityGenerator;
31
use Doctrine\ORM\Id\IdentityGenerator;
32
use Doctrine\ORM\ORMException;
33
use ReflectionException;
34
35
/**
36
 * The ClassMetadataFactory is used to create ClassMetadata objects that contain all the
37
 * metadata mapping information of a class which describes how a class should be mapped
38
 * to a relational database.
39
 *
40
 * @since   2.0
41
 * @author  Benjamin Eberlei <[email protected]>
42
 * @author  Guilherme Blanco <[email protected]>
43
 * @author  Jonathan Wage <[email protected]>
44
 * @author  Roman Borschel <[email protected]>
45
 */
46
class ClassMetadataFactory extends AbstractClassMetadataFactory
47
{
48
    /**
49
     * @var EntityManagerInterface|null
50
     */
51
    private $em;
52
53
    /**
54
     * @var \Doctrine\DBAL\Platforms\AbstractPlatform
55
     */
56
    private $targetPlatform;
57
58
    /**
59
     * @var \Doctrine\Common\Persistence\Mapping\Driver\MappingDriver
60
     */
61
    private $driver;
62
63
    /**
64
     * @var \Doctrine\Common\EventManager
65
     */
66
    private $evm;
67
68
    /**
69
     * @var array
70
     */
71
    private $embeddablesActiveNesting = [];
72
73
    /**
74
     * {@inheritDoc}
75
     */
76 499
    protected function loadMetadata($name)
77
    {
78 499
        $loaded = parent::loadMetadata($name);
79
80 477
        array_map([$this, 'resolveDiscriminatorValue'], array_map([$this, 'getMetadataFor'], $loaded));
81
82 477
        return $loaded;
83
    }
84
85
    /**
86
     * @param EntityManagerInterface $em
87
     */
88 2490
    public function setEntityManager(EntityManagerInterface $em)
89
    {
90 2490
        $this->em = $em;
91 2490
    }
92
93
    /**
94
     * {@inheritDoc}
95
     */
96 568
    protected function initialize()
97
    {
98 568
        $this->driver = $this->em->getConfiguration()->getMetadataDriverImpl();
0 ignored issues
show
Bug introduced by
The method getConfiguration() does not exist on null. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

98
        $this->driver = $this->em->/** @scrutinizer ignore-call */ getConfiguration()->getMetadataDriverImpl();

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
99 568
        $this->evm = $this->em->getEventManager();
100 568
        $this->initialized = true;
101 568
    }
102
103
    /**
104
     * {@inheritDoc}
105
     */
106 3
    protected function onNotFoundMetadata($className)
107
    {
108 3
        if (! $this->evm->hasListeners(Events::onClassMetadataNotFound)) {
109 1
            return;
110
        }
111
112 2
        $eventArgs = new OnClassMetadataNotFoundEventArgs($className, $this->em);
0 ignored issues
show
Bug introduced by
It seems like $this->em can also be of type null; however, parameter $objectManager of Doctrine\ORM\Event\OnCla...ventArgs::__construct() does only seem to accept Doctrine\Common\Persistence\ObjectManager, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

112
        $eventArgs = new OnClassMetadataNotFoundEventArgs($className, /** @scrutinizer ignore-type */ $this->em);
Loading history...
113
114 2
        $this->evm->dispatchEvent(Events::onClassMetadataNotFound, $eventArgs);
115
116 2
        return $eventArgs->getFoundMetadata();
117
    }
118
119
    /**
120
     * {@inheritDoc}
121
     */
122 496
    protected function doLoadMetadata($class, $parent, $rootEntityFound, array $nonSuperclassParents)
123
    {
124
        /* @var $class ClassMetadata */
125
        /* @var $parent ClassMetadata */
126 496
        if ($parent) {
0 ignored issues
show
introduced by
$parent is of type Doctrine\ORM\Mapping\ClassMetadata, thus it always evaluated to true.
Loading history...
127 146
            $class->setInheritanceType($parent->inheritanceType);
128 146
            $class->setDiscriminatorColumn($parent->discriminatorColumn);
129 146
            $class->setIdGeneratorType($parent->generatorType);
130 146
            $this->addInheritedFields($class, $parent);
131 146
            $this->addInheritedRelations($class, $parent);
132 145
            $this->addInheritedEmbeddedClasses($class, $parent);
133 145
            $class->setIdentifier($parent->identifier);
134 145
            $class->setVersioned($parent->isVersioned);
135 145
            $class->setVersionField($parent->versionField);
136 145
            $class->setDiscriminatorMap($parent->discriminatorMap);
137 145
            $class->setLifecycleCallbacks($parent->lifecycleCallbacks);
138 145
            $class->setChangeTrackingPolicy($parent->changeTrackingPolicy);
139
140 145
            if ( ! empty($parent->customGeneratorDefinition)) {
141 1
                $class->setCustomGeneratorDefinition($parent->customGeneratorDefinition);
142
            }
143
144 145
            if ($parent->isMappedSuperclass) {
145 52
                $class->setCustomRepositoryClass($parent->customRepositoryClassName);
146
            }
147
        }
148
149
        // Invoke driver
150
        try {
151 496
            $this->driver->loadMetadataForClass($class->getName(), $class);
152 5
        } catch (ReflectionException $e) {
153
            throw MappingException::reflectionFailure($class->getName(), $e);
154
        }
155
156
        // If this class has a parent the id generator strategy is inherited.
157
        // However this is only true if the hierarchy of parents contains the root entity,
158
        // if it consists of mapped superclasses these don't necessarily include the id field.
159 491
        if ($parent && $rootEntityFound) {
160 98
            $this->inheritIdGeneratorMapping($class, $parent);
161
        } else {
162 489
            $this->completeIdGeneratorMapping($class);
163
        }
164
165 489
        if (!$class->isMappedSuperclass) {
166 487
            foreach ($class->embeddedClasses as $property => $embeddableClass) {
167
168 14
                if (isset($embeddableClass['inherited'])) {
169 1
                    continue;
170
                }
171
172 14
                if ( ! (isset($embeddableClass['class']) && $embeddableClass['class'])) {
173 1
                    throw MappingException::missingEmbeddedClass($property);
174
                }
175
176 13
                if (isset($this->embeddablesActiveNesting[$embeddableClass['class']])) {
177 2
                    throw MappingException::infiniteEmbeddableNesting($class->name, $property);
178
                }
179
180 13
                $this->embeddablesActiveNesting[$class->name] = true;
181
182 13
                $embeddableMetadata = $this->getMetadataFor($embeddableClass['class']);
183
184 12
                if ($embeddableMetadata->isEmbeddedClass) {
0 ignored issues
show
Bug introduced by
Accessing isEmbeddedClass on the interface Doctrine\Common\Persistence\Mapping\ClassMetadata suggest that you code against a concrete implementation. How about adding an instanceof check?
Loading history...
185 12
                    $this->addNestedEmbeddedClasses($embeddableMetadata, $class, $property);
186
                }
187
188 12
                $identifier = $embeddableMetadata->getIdentifier();
189
190 12
                if (! empty($identifier)) {
191 5
                    $this->inheritIdGeneratorMapping($class, $embeddableMetadata);
192
                }
193
194 12
                $class->inlineEmbeddable($property, $embeddableMetadata);
195
196 12
                unset($this->embeddablesActiveNesting[$class->name]);
197
            }
198
        }
199
200 486
        if ($parent) {
0 ignored issues
show
introduced by
$parent is of type Doctrine\ORM\Mapping\ClassMetadata, thus it always evaluated to true.
Loading history...
201 145
            if ($parent->isInheritanceTypeSingleTable()) {
202 37
                $class->setPrimaryTable($parent->table);
203
            }
204
205 145
            if ($parent) {
0 ignored issues
show
introduced by
$parent is of type Doctrine\ORM\Mapping\ClassMetadata, thus it always evaluated to true.
Loading history...
206 145
                $this->addInheritedIndexes($class, $parent);
207
            }
208
209 145
            if ($parent->cache) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $parent->cache of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
210 3
                $class->cache = $parent->cache;
211
            }
212
213 145
            if ($parent->containsForeignIdentifier) {
214 1
                $class->containsForeignIdentifier = true;
215
            }
216
217 145
            if ( ! empty($parent->namedQueries)) {
218 1
                $this->addInheritedNamedQueries($class, $parent);
219
            }
220
221 145
            if ( ! empty($parent->namedNativeQueries)) {
222 9
                $this->addInheritedNamedNativeQueries($class, $parent);
223
            }
224
225 145
            if ( ! empty($parent->sqlResultSetMappings)) {
226 9
                $this->addInheritedSqlResultSetMappings($class, $parent);
227
            }
228
229 145
            if ( ! empty($parent->entityListeners) && empty($class->entityListeners)) {
230 15
                $class->entityListeners = $parent->entityListeners;
231
            }
232
        }
233
234 486
        $class->setParentClasses($nonSuperclassParents);
235
236 486
        if ($class->isRootEntity() && ! $class->isInheritanceTypeNone() && ! $class->discriminatorMap) {
237
            $this->addDefaultDiscriminatorMap($class);
238
        }
239
240 486
        if ($this->evm->hasListeners(Events::loadClassMetadata)) {
241 6
            $eventArgs = new LoadClassMetadataEventArgs($class, $this->em);
242 6
            $this->evm->dispatchEvent(Events::loadClassMetadata, $eventArgs);
243
        }
244
245 485
        $this->validateRuntimeMetadata($class, $parent);
246 484
    }
247
248
    /**
249
     * Validate runtime metadata is correctly defined.
250
     *
251
     * @param ClassMetadata               $class
252
     * @param ClassMetadataInterface|null $parent
253
     *
254
     * @return void
255
     *
256
     * @throws MappingException
257
     */
258 485
    protected function validateRuntimeMetadata($class, $parent)
259
    {
260 485
        if ( ! $class->reflClass ) {
261
            // only validate if there is a reflection class instance
262 8
            return;
263
        }
264
265 477
        $class->validateIdentifier();
266 477
        $class->validateAssociations();
267 477
        $class->validateLifecycleCallbacks($this->getReflectionService());
268
269
        // verify inheritance
270 477
        if ( ! $class->isMappedSuperclass && !$class->isInheritanceTypeNone()) {
271 88
            if ( ! $parent) {
272 85
                if (count($class->discriminatorMap) == 0) {
273
                    throw MappingException::missingDiscriminatorMap($class->name);
274
                }
275 85
                if ( ! $class->discriminatorColumn) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $class->discriminatorColumn of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
276 88
                    throw MappingException::missingDiscriminatorColumn($class->name);
277
                }
278
            }
279 431
        } else if ($class->isMappedSuperclass && $class->name == $class->rootEntityName && (count($class->discriminatorMap) || $class->discriminatorColumn)) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $class->discriminatorColumn of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
280
            // second condition is necessary for mapped superclasses in the middle of an inheritance hierarchy
281 1
            throw MappingException::noInheritanceOnMappedSuperClass($class->name);
282
        }
283 476
    }
284
285
    /**
286
     * {@inheritDoc}
287
     */
288 491
    protected function newClassMetadataInstance($className)
289
    {
290 491
        return new ClassMetadata($className, $this->em->getConfiguration()->getNamingStrategy());
291
    }
292
293
    /**
294
     * Populates the discriminator value of the given metadata (if not set) by iterating over discriminator
295
     * map classes and looking for a fitting one.
296
     *
297
     * @param ClassMetadata $metadata
298
     *
299
     * @return void
300
     *
301
     * @throws MappingException
302
     */
303 477
    private function resolveDiscriminatorValue(ClassMetadata $metadata)
304
    {
305 477
        if ($metadata->discriminatorValue
306 458
            || ! $metadata->discriminatorMap
307 50
            || $metadata->isMappedSuperclass
308 49
            || ! $metadata->reflClass
309 477
            || $metadata->reflClass->isAbstract()
310
        ) {
311 477
            return;
312
        }
313
314
        // minor optimization: avoid loading related metadata when not needed
315 5
        foreach ($metadata->discriminatorMap as $discriminatorValue => $discriminatorClass) {
316 5
            if ($discriminatorClass === $metadata->name) {
317 3
                $metadata->discriminatorValue = $discriminatorValue;
318
319 5
                return;
320
            }
321
        }
322
323
        // iterate over discriminator mappings and resolve actual referenced classes according to existing metadata
324 2
        foreach ($metadata->discriminatorMap as $discriminatorValue => $discriminatorClass) {
325 2
            if ($metadata->name === $this->getMetadataFor($discriminatorClass)->getName()) {
326 1
                $metadata->discriminatorValue = $discriminatorValue;
327
328 2
                return;
329
            }
330
        }
331
332 1
        throw MappingException::mappedClassNotPartOfDiscriminatorMap($metadata->name, $metadata->rootEntityName);
333
    }
334
335
    /**
336
     * Adds a default discriminator map if no one is given
337
     *
338
     * If an entity is of any inheritance type and does not contain a
339
     * discriminator map, then the map is generated automatically. This process
340
     * is expensive computation wise.
341
     *
342
     * The automatically generated discriminator map contains the lowercase short name of
343
     * each class as key.
344
     *
345
     * @param \Doctrine\ORM\Mapping\ClassMetadata $class
346
     *
347
     * @throws MappingException
348
     */
349
    private function addDefaultDiscriminatorMap(ClassMetadata $class)
350
    {
351
        $allClasses = $this->driver->getAllClassNames();
352
        $fqcn = $class->getName();
353
        $map = [$this->getShortName($class->name) => $fqcn];
354
355
        $duplicates = [];
356
        foreach ($allClasses as $subClassCandidate) {
357
            if (is_subclass_of($subClassCandidate, $fqcn)) {
358
                $shortName = $this->getShortName($subClassCandidate);
359
360
                if (isset($map[$shortName])) {
361
                    $duplicates[] = $shortName;
362
                }
363
364
                $map[$shortName] = $subClassCandidate;
365
            }
366
        }
367
368
        if ($duplicates) {
369
            throw MappingException::duplicateDiscriminatorEntry($class->name, $duplicates, $map);
370
        }
371
372
        $class->setDiscriminatorMap($map);
373
    }
374
375
    /**
376
     * Gets the lower-case short name of a class.
377
     *
378
     * @param string $className
379
     *
380
     * @return string
381
     */
382
    private function getShortName($className)
383
    {
384
        if (strpos($className, "\\") === false) {
385
            return strtolower($className);
386
        }
387
388
        $parts = explode("\\", $className);
389
390
        return strtolower(end($parts));
391
    }
392
393
    /**
394
     * Adds inherited fields to the subclass mapping.
395
     *
396
     * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass
397
     * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass
398
     *
399
     * @return void
400
     */
401 146
    private function addInheritedFields(ClassMetadata $subClass, ClassMetadata $parentClass)
402
    {
403 146
        foreach ($parentClass->fieldMappings as $mapping) {
404 130
            if ( ! isset($mapping['inherited']) && ! $parentClass->isMappedSuperclass) {
405 98
                $mapping['inherited'] = $parentClass->name;
406
            }
407 130
            if ( ! isset($mapping['declared'])) {
408 130
                $mapping['declared'] = $parentClass->name;
409
            }
410 130
            $subClass->addInheritedFieldMapping($mapping);
411
        }
412 146
        foreach ($parentClass->reflFields as $name => $field) {
413 131
            $subClass->reflFields[$name] = $field;
414
        }
415 146
    }
416
417
    /**
418
     * Adds inherited association mappings to the subclass mapping.
419
     *
420
     * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass
421
     * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass
422
     *
423
     * @return void
424
     *
425
     * @throws MappingException
426
     */
427 146
    private function addInheritedRelations(ClassMetadata $subClass, ClassMetadata $parentClass)
428
    {
429 146
        foreach ($parentClass->associationMappings as $field => $mapping) {
430 59
            if ($parentClass->isMappedSuperclass) {
431 16
                if ($mapping['type'] & ClassMetadata::TO_MANY && !$mapping['isOwningSide']) {
432 1
                    throw MappingException::illegalToManyAssociationOnMappedSuperclass($parentClass->name, $field);
433
                }
434 15
                $mapping['sourceEntity'] = $subClass->name;
435
            }
436
437
            //$subclassMapping = $mapping;
438 58
            if ( ! isset($mapping['inherited']) && ! $parentClass->isMappedSuperclass) {
439 43
                $mapping['inherited'] = $parentClass->name;
440
            }
441 58
            if ( ! isset($mapping['declared'])) {
442 58
                $mapping['declared'] = $parentClass->name;
443
            }
444 58
            $subClass->addInheritedAssociationMapping($mapping);
445
        }
446 145
    }
447
448 145
    private function addInheritedEmbeddedClasses(ClassMetadata $subClass, ClassMetadata $parentClass)
449
    {
450 145
        foreach ($parentClass->embeddedClasses as $field => $embeddedClass) {
451 2
            if ( ! isset($embeddedClass['inherited']) && ! $parentClass->isMappedSuperclass) {
452 1
                $embeddedClass['inherited'] = $parentClass->name;
453
            }
454 2
            if ( ! isset($embeddedClass['declared'])) {
455 2
                $embeddedClass['declared'] = $parentClass->name;
456
            }
457
458 2
            $subClass->embeddedClasses[$field] = $embeddedClass;
459
        }
460 145
    }
461
462
    /**
463
     * Adds nested embedded classes metadata to a parent class.
464
     *
465
     * @param ClassMetadata $subClass    Sub embedded class metadata to add nested embedded classes metadata from.
466
     * @param ClassMetadata $parentClass Parent class to add nested embedded classes metadata to.
467
     * @param string        $prefix      Embedded classes' prefix to use for nested embedded classes field names.
468
     */
469 12
    private function addNestedEmbeddedClasses(ClassMetadata $subClass, ClassMetadata $parentClass, $prefix)
470
    {
471 12
        foreach ($subClass->embeddedClasses as $property => $embeddableClass) {
472 4
            if (isset($embeddableClass['inherited'])) {
473
                continue;
474
            }
475
476 4
            $embeddableMetadata = $this->getMetadataFor($embeddableClass['class']);
477
478 4
            $parentClass->mapEmbedded(
479
                [
480 4
                    'fieldName' => $prefix . '.' . $property,
481 4
                    'class' => $embeddableMetadata->name,
0 ignored issues
show
Bug introduced by
Accessing name on the interface Doctrine\Common\Persistence\Mapping\ClassMetadata suggest that you code against a concrete implementation. How about adding an instanceof check?
Loading history...
482 4
                    'columnPrefix' => $embeddableClass['columnPrefix'],
483 4
                    'declaredField' => $embeddableClass['declaredField']
484 1
                            ? $prefix . '.' . $embeddableClass['declaredField']
485 4
                            : $prefix,
486 4
                    'originalField' => $embeddableClass['originalField'] ?: $property,
487
                ]
488
            );
489
        }
490 12
    }
491
492
    /**
493
     * Copy the table indices from the parent class superclass to the child class
494
     *
495
     * @param ClassMetadata $subClass
496
     * @param ClassMetadata $parentClass
497
     *
498
     * @return void
499
     */
500 145
    private function addInheritedIndexes(ClassMetadata $subClass, ClassMetadata $parentClass)
501
    {
502 145
        if (! $parentClass->isMappedSuperclass) {
503 98
            return;
504
        }
505
506 52
        foreach (['uniqueConstraints', 'indexes'] as $indexType) {
507 52
            if (isset($parentClass->table[$indexType])) {
508 1
                foreach ($parentClass->table[$indexType] as $indexName => $index) {
509 1
                    if (isset($subClass->table[$indexType][$indexName])) {
510
                        continue; // Let the inheriting table override indices
511
                    }
512
513 52
                    $subClass->table[$indexType][$indexName] = $index;
514
                }
515
            }
516
        }
517 52
    }
518
519
    /**
520
     * Adds inherited named queries to the subclass mapping.
521
     *
522
     * @since 2.2
523
     *
524
     * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass
525
     * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass
526
     *
527
     * @return void
528
     */
529 1
    private function addInheritedNamedQueries(ClassMetadata $subClass, ClassMetadata $parentClass)
530
    {
531 1
        foreach ($parentClass->namedQueries as $name => $query) {
532 1
            if ( ! isset ($subClass->namedQueries[$name])) {
533 1
                $subClass->addNamedQuery(
534
                    [
535 1
                        'name'  => $query['name'],
536 1
                        'query' => $query['query']
537
                    ]
538
                );
539
            }
540
        }
541 1
    }
542
543
    /**
544
     * Adds inherited named native queries to the subclass mapping.
545
     *
546
     * @since 2.3
547
     *
548
     * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass
549
     * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass
550
     *
551
     * @return void
552
     */
553 9
    private function addInheritedNamedNativeQueries(ClassMetadata $subClass, ClassMetadata $parentClass)
554
    {
555 9
        foreach ($parentClass->namedNativeQueries as $name => $query) {
556 9
            if ( ! isset ($subClass->namedNativeQueries[$name])) {
557 9
                $subClass->addNamedNativeQuery(
558
                    [
559 9
                        'name'              => $query['name'],
560 9
                        'query'             => $query['query'],
561 9
                        'isSelfClass'       => $query['isSelfClass'],
562 9
                        'resultSetMapping'  => $query['resultSetMapping'],
563 9
                        'resultClass'       => $query['isSelfClass'] ? $subClass->name : $query['resultClass'],
564
                    ]
565
                );
566
            }
567
        }
568 9
    }
569
570
    /**
571
     * Adds inherited sql result set mappings to the subclass mapping.
572
     *
573
     * @since 2.3
574
     *
575
     * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass
576
     * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass
577
     *
578
     * @return void
579
     */
580 9
    private function addInheritedSqlResultSetMappings(ClassMetadata $subClass, ClassMetadata $parentClass)
581
    {
582 9
        foreach ($parentClass->sqlResultSetMappings as $name => $mapping) {
583 9
            if ( ! isset ($subClass->sqlResultSetMappings[$name])) {
584 9
                $entities = [];
585 9
                foreach ($mapping['entities'] as $entity) {
586 9
                    $entities[] = [
587 9
                        'fields'                => $entity['fields'],
588 9
                        'isSelfClass'           => $entity['isSelfClass'],
589 9
                        'discriminatorColumn'   => $entity['discriminatorColumn'],
590 9
                        'entityClass'           => $entity['isSelfClass'] ? $subClass->name : $entity['entityClass'],
591
                    ];
592
                }
593
594 9
                $subClass->addSqlResultSetMapping(
595
                    [
596 9
                        'name'          => $mapping['name'],
597 9
                        'columns'       => $mapping['columns'],
598 9
                        'entities'      => $entities,
599
                    ]
600
                );
601
            }
602
        }
603 9
    }
604
605
    /**
606
     * Completes the ID generator mapping. If "auto" is specified we choose the generator
607
     * most appropriate for the targeted database platform.
608
     *
609
     * @param ClassMetadataInfo $class
610
     *
611
     * @return void
612
     *
613
     * @throws ORMException
614
     */
615 489
    private function completeIdGeneratorMapping(ClassMetadataInfo $class)
616
    {
617 489
        $idGenType = $class->generatorType;
618 489
        if ($idGenType == ClassMetadata::GENERATOR_TYPE_AUTO) {
619 349
            if ($this->getTargetPlatform()->prefersSequences()) {
620
                $class->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_SEQUENCE);
621 349
            } else if ($this->getTargetPlatform()->prefersIdentityColumns()) {
622 349
                $class->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_IDENTITY);
623
            } else {
624
                $class->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_TABLE);
625
            }
626
        }
627
628
        // Create & assign an appropriate ID generator instance
629 489
        switch ($class->generatorType) {
630 489
            case ClassMetadata::GENERATOR_TYPE_IDENTITY:
631 362
                $sequenceName = null;
632 362
                $fieldName    = $class->identifier ? $class->getSingleIdentifierFieldName() : null;
633
634
                // Platforms that do not have native IDENTITY support need a sequence to emulate this behaviour.
635 362
                if ($this->getTargetPlatform()->usesSequenceEmulatedIdentityColumns()) {
636
                    $columnName     = $class->getSingleIdentifierColumnName();
637
                    $quoted         = isset($class->fieldMappings[$fieldName]['quoted']) || isset($class->table['quoted']);
638
                    $sequencePrefix = $class->getSequencePrefix($this->getTargetPlatform());
639
                    $sequenceName   = $this->getTargetPlatform()->getIdentitySequenceName($sequencePrefix, $columnName);
640
                    $definition     = [
641
                        'sequenceName' => $this->getTargetPlatform()->fixSchemaElementName($sequenceName)
642
                    ];
643
644
                    if ($quoted) {
645
                        $definition['quoted'] = true;
646
                    }
647
648
                    $sequenceName = $this
649
                        ->em
650
                        ->getConfiguration()
651
                        ->getQuoteStrategy()
652
                        ->getSequenceName($definition, $class, $this->getTargetPlatform());
653
                }
654
655 362
                $generator = ($fieldName && $class->fieldMappings[$fieldName]['type'] === 'bigint')
656 1
                    ? new BigIntegerIdentityGenerator($sequenceName)
657 362
                    : new IdentityGenerator($sequenceName);
658
659 362
                $class->setIdGenerator($generator);
660
661 362
                break;
662
663 174
            case ClassMetadata::GENERATOR_TYPE_SEQUENCE:
664
                // If there is no sequence definition yet, create a default definition
665 6
                $definition = $class->sequenceGeneratorDefinition;
666
667 6
                if ( ! $definition) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $definition of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
668
                    $fieldName      = $class->getSingleIdentifierFieldName();
669
                    $sequenceName   = $class->getSequenceName($this->getTargetPlatform());
670
                    $quoted         = isset($class->fieldMappings[$fieldName]['quoted']) || isset($class->table['quoted']);
671
672
                    $definition = [
673
                        'sequenceName'      => $this->getTargetPlatform()->fixSchemaElementName($sequenceName),
674
                        'allocationSize'    => 1,
675
                        'initialValue'      => 1,
676
                    ];
677
678
                    if ($quoted) {
679
                        $definition['quoted'] = true;
680
                    }
681
682
                    $class->setSequenceGeneratorDefinition($definition);
683
                }
684
685 6
                $sequenceGenerator = new \Doctrine\ORM\Id\SequenceGenerator(
686 6
                    $this->em->getConfiguration()->getQuoteStrategy()->getSequenceName($definition, $class, $this->getTargetPlatform()),
687 6
                    $definition['allocationSize']
688
                );
689 6
                $class->setIdGenerator($sequenceGenerator);
690 6
                break;
691
692 171
            case ClassMetadata::GENERATOR_TYPE_NONE:
693 166
                $class->setIdGenerator(new \Doctrine\ORM\Id\AssignedGenerator());
694 166
                break;
695
696 7
            case ClassMetadata::GENERATOR_TYPE_UUID:
697 2
                $class->setIdGenerator(new \Doctrine\ORM\Id\UuidGenerator());
698 2
                break;
699
700 5
            case ClassMetadata::GENERATOR_TYPE_TABLE:
701
                throw new ORMException("TableGenerator not yet implemented.");
702
                break;
703
704 5
            case ClassMetadata::GENERATOR_TYPE_CUSTOM:
705 5
                $definition = $class->customGeneratorDefinition;
706 5
                if ($definition === null) {
707 1
                    throw new ORMException("Can't instantiate custom generator : no custom generator definition");
708
                }
709 4
                if ( ! class_exists($definition['class'])) {
710 1
                    throw new ORMException("Can't instantiate custom generator : " .
711 1
                        $definition['class']);
712
                }
713 3
                $class->setIdGenerator(new $definition['class']);
714 3
                break;
715
716
            default:
717
                throw new ORMException("Unknown generator type: " . $class->generatorType);
718
        }
719 487
    }
720
721
    /**
722
     * Inherits the ID generator mapping from a parent class.
723
     *
724
     * @param ClassMetadataInfo $class
725
     * @param ClassMetadataInfo $parent
726
     */
727 103
    private function inheritIdGeneratorMapping(ClassMetadataInfo $class, ClassMetadataInfo $parent)
728
    {
729 103
        if ($parent->isIdGeneratorSequence()) {
730 3
            $class->setSequenceGeneratorDefinition($parent->sequenceGeneratorDefinition);
731 100
        } elseif ($parent->isIdGeneratorTable()) {
732
            $class->tableGeneratorDefinition = $parent->tableGeneratorDefinition;
733
        }
734
735 103
        if ($parent->generatorType) {
736 103
            $class->setIdGeneratorType($parent->generatorType);
737
        }
738
739 103
        if ($parent->idGenerator) {
740 103
            $class->setIdGenerator($parent->idGenerator);
741
        }
742 103
    }
743
744
    /**
745
     * {@inheritDoc}
746
     */
747 2137
    protected function wakeupReflection(ClassMetadataInterface $class, ReflectionService $reflService)
748
    {
749
        /* @var $class ClassMetadata */
750 2137
        $class->wakeupReflection($reflService);
751 2137
    }
752
753
    /**
754
     * {@inheritDoc}
755
     */
756 496
    protected function initializeReflection(ClassMetadataInterface $class, ReflectionService $reflService)
757
    {
758
        /* @var $class ClassMetadata */
759 496
        $class->initializeReflection($reflService);
760 496
    }
761
762
    /**
763
     * {@inheritDoc}
764
     */
765 4
    protected function getFqcnFromAlias($namespaceAlias, $simpleClassName)
766
    {
767 4
        return $this->em->getConfiguration()->getEntityNamespace($namespaceAlias) . '\\' . $simpleClassName;
768
    }
769
770
    /**
771
     * {@inheritDoc}
772
     */
773 256
    protected function getDriver()
774
    {
775 256
        return $this->driver;
776
    }
777
778
    /**
779
     * {@inheritDoc}
780
     */
781 484
    protected function isEntity(ClassMetadataInterface $class)
782
    {
783 484
        return isset($class->isMappedSuperclass) && $class->isMappedSuperclass === false;
0 ignored issues
show
Bug introduced by
Accessing isMappedSuperclass on the interface Doctrine\Common\Persistence\Mapping\ClassMetadata suggest that you code against a concrete implementation. How about adding an instanceof check?
Loading history...
784
    }
785
786
    /**
787
     * @return Platforms\AbstractPlatform
788
     */
789 368
    private function getTargetPlatform()
790
    {
791 368
        if (!$this->targetPlatform) {
792 368
            $this->targetPlatform = $this->em->getConnection()->getDatabasePlatform();
793
        }
794
795 368
        return $this->targetPlatform;
796
    }
797
}
798