vendor/doctrine/orm/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php line 249

Open in your IDE?
  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.  */
  20. namespace Doctrine\ORM\Mapping;
  22. use Doctrine\DBAL\Platforms;
  23. use Doctrine\ORM\EntityManagerInterface;
  24. use Doctrine\ORM\Event\LoadClassMetadataEventArgs;
  25. use Doctrine\ORM\Event\OnClassMetadataNotFoundEventArgs;
  26. use Doctrine\ORM\Events;
  27. use Doctrine\ORM\Id\BigIntegerIdentityGenerator;
  28. use Doctrine\ORM\Id\IdentityGenerator;
  29. use Doctrine\ORM\ORMException;
  30. use Doctrine\Persistence\Mapping\AbstractClassMetadataFactory;
  31. use Doctrine\Persistence\Mapping\ClassMetadata as ClassMetadataInterface;
  32. use Doctrine\Persistence\Mapping\Driver\MappingDriver;
  33. use Doctrine\Persistence\Mapping\ReflectionService;
  34. use ReflectionClass;
  35. use ReflectionException;
  36. use function assert;
  37. use function interface_exists;
  39. /**
  40.  * The ClassMetadataFactory is used to create ClassMetadata objects that contain all the
  41.  * metadata mapping information of a class which describes how a class should be mapped
  42.  * to a relational database.
  43.  *
  44.  * @since   2.0
  45.  * @author  Benjamin Eberlei <kontakt@beberlei.de>
  46.  * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>
  47.  * @author  Jonathan Wage <jonwage@gmail.com>
  48.  * @author  Roman Borschel <roman@code-factory.org>
  49.  */
  50. class ClassMetadataFactory extends AbstractClassMetadataFactory
  51. {
  52.     /**
  53.      * @var EntityManagerInterface|null
  54.      */
  55.     private $em;
  57.     /**
  58.      * @var \Doctrine\DBAL\Platforms\AbstractPlatform
  59.      */
  60.     private $targetPlatform;
  62.     /**
  63.      * @var MappingDriver
  64.      */
  65.     private $driver;
  67.     /**
  68.      * @var \Doctrine\Common\EventManager
  69.      */
  70.     private $evm;
  72.     /**
  73.      * @var array
  74.      */
  75.     private $embeddablesActiveNesting = [];
  77.     /**
  78.      * {@inheritDoc}
  79.      */
  80.     protected function loadMetadata($name)
  81.     {
  82.         $loaded = parent::loadMetadata($name);
  84.         array_map([$this, 'resolveDiscriminatorValue'], array_map([$this, 'getMetadataFor'], $loaded));
  86.         return $loaded;
  87.     }
  89.     /**
  90.      * @param EntityManagerInterface $em
  91.      */
  92.     public function setEntityManager(EntityManagerInterface $em)
  93.     {
  94.         $this->em = $em;
  95.     }
  97.     /**
  98.      * {@inheritDoc}
  99.      */
  100.     protected function initialize()
  101.     {
  102.         $this->driver = $this->em->getConfiguration()->getMetadataDriverImpl();
  103.         $this->evm = $this->em->getEventManager();
  104.         $this->initialized = true;
  105.     }
  107.     /**
  108.      * {@inheritDoc}
  109.      */
  110.     protected function onNotFoundMetadata($className)
  111.     {
  112.         if (! $this->evm->hasListeners(Events::onClassMetadataNotFound)) {
  113.             return;
  114.         }
  116.         $eventArgs = new OnClassMetadataNotFoundEventArgs($className, $this->em);
  118.         $this->evm->dispatchEvent(Events::onClassMetadataNotFound, $eventArgs);
  120.         return $eventArgs->getFoundMetadata();
  121.     }
  123.     /**
  124.      * {@inheritDoc}
  125.      */
  126.     protected function doLoadMetadata($class, $parent, $rootEntityFound, array $nonSuperclassParents)
  127.     {
  128.         /* @var $class ClassMetadata */
  129.         /* @var $parent ClassMetadata */
  130.         if ($parent) {
  131.             $class->setInheritanceType($parent->inheritanceType);
  132.             $class->setDiscriminatorColumn($parent->discriminatorColumn);
  133.             $class->setIdGeneratorType($parent->generatorType);
  134.             $this->addInheritedFields($class, $parent);
  135.             $this->addInheritedRelations($class, $parent);
  136.             $this->addInheritedEmbeddedClasses($class, $parent);
  137.             $class->setIdentifier($parent->identifier);
  138.             $class->setVersioned($parent->isVersioned);
  139.             $class->setVersionField($parent->versionField);
  140.             $class->setDiscriminatorMap($parent->discriminatorMap);
  141.             $class->setLifecycleCallbacks($parent->lifecycleCallbacks);
  142.             $class->setChangeTrackingPolicy($parent->changeTrackingPolicy);
  144.             if ( ! empty($parent->customGeneratorDefinition)) {
  145.                 $class->setCustomGeneratorDefinition($parent->customGeneratorDefinition);
  146.             }
  148.             if ($parent->isMappedSuperclass) {
  149.                 $class->setCustomRepositoryClass($parent->customRepositoryClassName);
  150.             }
  151.         }
  153.         // Invoke driver
  154.         try {
  155.             $this->driver->loadMetadataForClass($class->getName(), $class);
  156.         } catch (ReflectionException $e) {
  157.             throw MappingException::reflectionFailure($class->getName(), $e);
  158.         }
  160.         // If this class has a parent the id generator strategy is inherited.
  161.         // However this is only true if the hierarchy of parents contains the root entity,
  162.         // if it consists of mapped superclasses these don't necessarily include the id field.
  163.         if ($parent && $rootEntityFound) {
  164.             $this->inheritIdGeneratorMapping($class, $parent);
  165.         } else {
  166.             $this->completeIdGeneratorMapping($class);
  167.         }
  169.         if (!$class->isMappedSuperclass) {
  170.             foreach ($class->embeddedClasses as $property => $embeddableClass) {
  172.                 if (isset($embeddableClass['inherited'])) {
  173.                     continue;
  174.                 }
  176.                 if ( ! (isset($embeddableClass['class']) && $embeddableClass['class'])) {
  177.                     throw MappingException::missingEmbeddedClass($property);
  178.                 }
  180.                 if (isset($this->embeddablesActiveNesting[$embeddableClass['class']])) {
  181.                     throw MappingException::infiniteEmbeddableNesting($class->name, $property);
  182.                 }
  184.                 $this->embeddablesActiveNesting[$class->name] = true;
  186.                 $embeddableMetadata = $this->getMetadataFor($embeddableClass['class']);
  188.                 if ($embeddableMetadata->isEmbeddedClass) {
  189.                     $this->addNestedEmbeddedClasses($embeddableMetadata, $class, $property);
  190.                 }
  192.                 $identifier = $embeddableMetadata->getIdentifier();
  194.                 if (! empty($identifier)) {
  195.                     $this->inheritIdGeneratorMapping($class, $embeddableMetadata);
  196.                 }
  198.                 $class->inlineEmbeddable($property, $embeddableMetadata);
  200.                 unset($this->embeddablesActiveNesting[$class->name]);
  201.             }
  202.         }
  204.         if ($parent) {
  205.             if ($parent->isInheritanceTypeSingleTable()) {
  206.                 $class->setPrimaryTable($parent->table);
  207.             }
  209.             if ($parent) {
  210.                 $this->addInheritedIndexes($class, $parent);
  211.             }
  213.             if ($parent->cache) {
  214.                 $class->cache = $parent->cache;
  215.             }
  217.             if ($parent->containsForeignIdentifier) {
  218.                 $class->containsForeignIdentifier = true;
  219.             }
  221.             if ( ! empty($parent->namedQueries)) {
  222.                 $this->addInheritedNamedQueries($class, $parent);
  223.             }
  225.             if ( ! empty($parent->namedNativeQueries)) {
  226.                 $this->addInheritedNamedNativeQueries($class, $parent);
  227.             }
  229.             if ( ! empty($parent->sqlResultSetMappings)) {
  230.                 $this->addInheritedSqlResultSetMappings($class, $parent);
  231.             }
  233.             if ( ! empty($parent->entityListeners) && empty($class->entityListeners)) {
  234.                 $class->entityListeners = $parent->entityListeners;
  235.             }
  236.         }
  238.         $class->setParentClasses($nonSuperclassParents);
  240.         if ($class->isRootEntity() && ! $class->isInheritanceTypeNone() && ! $class->discriminatorMap) {
  241.             $this->addDefaultDiscriminatorMap($class);
  242.         }
  244.         if ($this->evm->hasListeners(Events::loadClassMetadata)) {
  245.             $eventArgs = new LoadClassMetadataEventArgs($class, $this->em);
  246.             $this->evm->dispatchEvent(Events::loadClassMetadata, $eventArgs);
  247.         }
  249.         $this->validateRuntimeMetadata($class, $parent);
  250.     }
  252.     /**
  253.      * Validate runtime metadata is correctly defined.
  254.      *
  255.      * @param ClassMetadata               $class
  256.      * @param ClassMetadataInterface|null $parent
  257.      *
  258.      * @return void
  259.      *
  260.      * @throws MappingException
  261.      */
  262.     protected function validateRuntimeMetadata($class, $parent)
  263.     {
  264.         if ( ! $class->reflClass ) {
  265.             // only validate if there is a reflection class instance
  266.             return;
  267.         }
  269.         $class->validateIdentifier();
  270.         $class->validateAssociations();
  271.         $class->validateLifecycleCallbacks($this->getReflectionService());
  273.         // verify inheritance
  274.         if ( ! $class->isMappedSuperclass && !$class->isInheritanceTypeNone()) {
  275.             if ( ! $parent) {
  276.                 if (count($class->discriminatorMap) == 0) {
  277.                     throw MappingException::missingDiscriminatorMap($class->name);
  278.                 }
  279.                 if ( ! $class->discriminatorColumn) {
  280.                     throw MappingException::missingDiscriminatorColumn($class->name);
  281.                 }
  282.                 foreach ($class->subClasses as $subClass) {
  283.                     if ((new ReflectionClass($subClass))->name !== $subClass) {
  284.                         throw MappingException::invalidClassInDiscriminatorMap($subClass, $class->name);
  285.                     }
  286.                 }
  287.             }
  288.         } else if ($class->isMappedSuperclass && $class->name == $class->rootEntityName && (count($class->discriminatorMap) || $class->discriminatorColumn)) {
  289.             // second condition is necessary for mapped superclasses in the middle of an inheritance hierarchy
  290.             throw MappingException::noInheritanceOnMappedSuperClass($class->name);
  291.         }
  292.     }
  294.     /**
  295.      * {@inheritDoc}
  296.      */
  297.     protected function newClassMetadataInstance($className)
  298.     {
  299.         return new ClassMetadata($className, $this->em->getConfiguration()->getNamingStrategy());
  300.     }
  302.     /**
  303.      * Populates the discriminator value of the given metadata (if not set) by iterating over discriminator
  304.      * map classes and looking for a fitting one.
  305.      *
  306.      * @param ClassMetadata $metadata
  307.      *
  308.      * @return void
  309.      *
  310.      * @throws MappingException
  311.      */
  312.     private function resolveDiscriminatorValue(ClassMetadata $metadata)
  313.     {
  314.         if ($metadata->discriminatorValue
  315.             || ! $metadata->discriminatorMap
  316.             || $metadata->isMappedSuperclass
  317.             || ! $metadata->reflClass
  318.             || $metadata->reflClass->isAbstract()
  319.         ) {
  320.             return;
  321.         }
  323.         // minor optimization: avoid loading related metadata when not needed
  324.         foreach ($metadata->discriminatorMap as $discriminatorValue => $discriminatorClass) {
  325.             if ($discriminatorClass === $metadata->name) {
  326.                 $metadata->discriminatorValue = $discriminatorValue;
  328.                 return;
  329.             }
  330.         }
  332.         // iterate over discriminator mappings and resolve actual referenced classes according to existing metadata
  333.         foreach ($metadata->discriminatorMap as $discriminatorValue => $discriminatorClass) {
  334.             if ($metadata->name === $this->getMetadataFor($discriminatorClass)->getName()) {
  335.                 $metadata->discriminatorValue = $discriminatorValue;
  337.                 return;
  338.             }
  339.         }
  341.         throw MappingException::mappedClassNotPartOfDiscriminatorMap($metadata->name, $metadata->rootEntityName);
  342.     }
  344.     /**
  345.      * Adds a default discriminator map if no one is given
  346.      *
  347.      * If an entity is of any inheritance type and does not contain a
  348.      * discriminator map, then the map is generated automatically. This process
  349.      * is expensive computation wise.
  350.      *
  351.      * The automatically generated discriminator map contains the lowercase short name of
  352.      * each class as key.
  353.      *
  354.      * @param \Doctrine\ORM\Mapping\ClassMetadata $class
  355.      *
  356.      * @throws MappingException
  357.      */
  358.     private function addDefaultDiscriminatorMap(ClassMetadata $class)
  359.     {
  360.         $allClasses = $this->driver->getAllClassNames();
  361.         $fqcn = $class->getName();
  362.         $map = [$this->getShortName($class->name) => $fqcn];
  364.         $duplicates = [];
  365.         foreach ($allClasses as $subClassCandidate) {
  366.             if (is_subclass_of($subClassCandidate, $fqcn)) {
  367.                 $shortName = $this->getShortName($subClassCandidate);
  369.                 if (isset($map[$shortName])) {
  370.                     $duplicates[] = $shortName;
  371.                 }
  373.                 $map[$shortName] = $subClassCandidate;
  374.             }
  375.         }
  377.         if ($duplicates) {
  378.             throw MappingException::duplicateDiscriminatorEntry($class->name, $duplicates, $map);
  379.         }
  381.         $class->setDiscriminatorMap($map);
  382.     }
  384.     /**
  385.      * Gets the lower-case short name of a class.
  386.      *
  387.      * @param string $className
  388.      *
  389.      * @return string
  390.      */
  391.     private function getShortName($className)
  392.     {
  393.         if (strpos($className, "\\") === false) {
  394.             return strtolower($className);
  395.         }
  397.         $parts = explode("\\", $className);
  399.         return strtolower(end($parts));
  400.     }
  402.     /**
  403.      * Adds inherited fields to the subclass mapping.
  404.      *
  405.      * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass
  406.      * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass
  407.      *
  408.      * @return void
  409.      */
  410.     private function addInheritedFields(ClassMetadata $subClass, ClassMetadata $parentClass)
  411.     {
  412.         foreach ($parentClass->fieldMappings as $mapping) {
  413.             if (! isset($mapping['inherited']) && ! $parentClass->isMappedSuperclass) {
  414.                 $mapping['inherited'] = $parentClass->name;
  415.             }
  416.             if (! isset($mapping['declared'])) {
  417.                 $mapping['declared'] = $parentClass->name;
  418.             }
  419.             $subClass->addInheritedFieldMapping($mapping);
  420.         }
  421.         foreach ($parentClass->reflFields as $name => $field) {
  422.             $subClass->reflFields[$name] = $field;
  423.         }
  424.     }
  426.     /**
  427.      * Adds inherited association mappings to the subclass mapping.
  428.      *
  429.      * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass
  430.      * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass
  431.      *
  432.      * @return void
  433.      *
  434.      * @throws MappingException
  435.      */
  436.     private function addInheritedRelations(ClassMetadata $subClass, ClassMetadata $parentClass)
  437.     {
  438.         foreach ($parentClass->associationMappings as $field => $mapping) {
  439.             if ($parentClass->isMappedSuperclass) {
  440.                 if ($mapping['type'] & ClassMetadata::TO_MANY && !$mapping['isOwningSide']) {
  441.                     throw MappingException::illegalToManyAssociationOnMappedSuperclass($parentClass->name, $field);
  442.                 }
  443.                 $mapping['sourceEntity'] = $subClass->name;
  444.             }
  446.             //$subclassMapping = $mapping;
  447.             if ( ! isset($mapping['inherited']) && ! $parentClass->isMappedSuperclass) {
  448.                 $mapping['inherited'] = $parentClass->name;
  449.             }
  450.             if ( ! isset($mapping['declared'])) {
  451.                 $mapping['declared'] = $parentClass->name;
  452.             }
  453.             $subClass->addInheritedAssociationMapping($mapping);
  454.         }
  455.     }
  457.     private function addInheritedEmbeddedClasses(ClassMetadata $subClass, ClassMetadata $parentClass)
  458.     {
  459.         foreach ($parentClass->embeddedClasses as $field => $embeddedClass) {
  460.             if ( ! isset($embeddedClass['inherited']) && ! $parentClass->isMappedSuperclass) {
  461.                 $embeddedClass['inherited'] = $parentClass->name;
  462.             }
  463.             if ( ! isset($embeddedClass['declared'])) {
  464.                 $embeddedClass['declared'] = $parentClass->name;
  465.             }
  467.             $subClass->embeddedClasses[$field] = $embeddedClass;
  468.         }
  469.     }
  471.     /**
  472.      * Adds nested embedded classes metadata to a parent class.
  473.      *
  474.      * @param ClassMetadata $subClass    Sub embedded class metadata to add nested embedded classes metadata from.
  475.      * @param ClassMetadata $parentClass Parent class to add nested embedded classes metadata to.
  476.      * @param string        $prefix      Embedded classes' prefix to use for nested embedded classes field names.
  477.      */
  478.     private function addNestedEmbeddedClasses(ClassMetadata $subClass, ClassMetadata $parentClass, $prefix)
  479.     {
  480.         foreach ($subClass->embeddedClasses as $property => $embeddableClass) {
  481.             if (isset($embeddableClass['inherited'])) {
  482.                 continue;
  483.             }
  485.             $embeddableMetadata = $this->getMetadataFor($embeddableClass['class']);
  487.             $parentClass->mapEmbedded(
  488.                 [
  489.                     'fieldName' => $prefix . '.' . $property,
  490.                     'class' => $embeddableMetadata->name,
  491.                     'columnPrefix' => $embeddableClass['columnPrefix'],
  492.                     'declaredField' => $embeddableClass['declaredField']
  493.                             ? $prefix . '.' . $embeddableClass['declaredField']
  494.                             : $prefix,
  495.                     'originalField' => $embeddableClass['originalField'] ?: $property,
  496.                 ]
  497.             );
  498.         }
  499.     }
  501.     /**
  502.      * Copy the table indices from the parent class superclass to the child class
  503.      *
  504.      * @param ClassMetadata $subClass
  505.      * @param ClassMetadata $parentClass
  506.      *
  507.      * @return void
  508.      */
  509.     private function addInheritedIndexes(ClassMetadata $subClass, ClassMetadata $parentClass)
  510.     {
  511.         if (! $parentClass->isMappedSuperclass) {
  512.             return;
  513.         }
  515.         foreach (['uniqueConstraints', 'indexes'] as $indexType) {
  516.             if (isset($parentClass->table[$indexType])) {
  517.                 foreach ($parentClass->table[$indexType] as $indexName => $index) {
  518.                     if (isset($subClass->table[$indexType][$indexName])) {
  519.                         continue; // Let the inheriting table override indices
  520.                     }
  522.                     $subClass->table[$indexType][$indexName] = $index;
  523.                 }
  524.             }
  525.         }
  526.     }
  528.     /**
  529.      * Adds inherited named queries to the subclass mapping.
  530.      *
  531.      * @since 2.2
  532.      *
  533.      * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass
  534.      * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass
  535.      *
  536.      * @return void
  537.      */
  538.     private function addInheritedNamedQueries(ClassMetadata $subClass, ClassMetadata $parentClass)
  539.     {
  540.         foreach ($parentClass->namedQueries as $name => $query) {
  541.             if ( ! isset ($subClass->namedQueries[$name])) {
  542.                 $subClass->addNamedQuery(
  543.                     [
  544.                         'name'  => $query['name'],
  545.                         'query' => $query['query']
  546.                     ]
  547.                 );
  548.             }
  549.         }
  550.     }
  552.     /**
  553.      * Adds inherited named native queries to the subclass mapping.
  554.      *
  555.      * @since 2.3
  556.      *
  557.      * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass
  558.      * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass
  559.      *
  560.      * @return void
  561.      */
  562.     private function addInheritedNamedNativeQueries(ClassMetadata $subClass, ClassMetadata $parentClass)
  563.     {
  564.         foreach ($parentClass->namedNativeQueries as $name => $query) {
  565.             if ( ! isset ($subClass->namedNativeQueries[$name])) {
  566.                 $subClass->addNamedNativeQuery(
  567.                     [
  568.                         'name'              => $query['name'],
  569.                         'query'             => $query['query'],
  570.                         'isSelfClass'       => $query['isSelfClass'],
  571.                         'resultSetMapping'  => $query['resultSetMapping'],
  572.                         'resultClass'       => $query['isSelfClass'] ? $subClass->name : $query['resultClass'],
  573.                     ]
  574.                 );
  575.             }
  576.         }
  577.     }
  579.     /**
  580.      * Adds inherited sql result set mappings to the subclass mapping.
  581.      *
  582.      * @since 2.3
  583.      *
  584.      * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass
  585.      * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass
  586.      *
  587.      * @return void
  588.      */
  589.     private function addInheritedSqlResultSetMappings(ClassMetadata $subClass, ClassMetadata $parentClass)
  590.     {
  591.         foreach ($parentClass->sqlResultSetMappings as $name => $mapping) {
  592.             if ( ! isset ($subClass->sqlResultSetMappings[$name])) {
  593.                 $entities = [];
  594.                 foreach ($mapping['entities'] as $entity) {
  595.                     $entities[] = [
  596.                         'fields'                => $entity['fields'],
  597.                         'isSelfClass'           => $entity['isSelfClass'],
  598.                         'discriminatorColumn'   => $entity['discriminatorColumn'],
  599.                         'entityClass'           => $entity['isSelfClass'] ? $subClass->name : $entity['entityClass'],
  600.                     ];
  601.                 }
  603.                 $subClass->addSqlResultSetMapping(
  604.                     [
  605.                         'name'          => $mapping['name'],
  606.                         'columns'       => $mapping['columns'],
  607.                         'entities'      => $entities,
  608.                     ]
  609.                 );
  610.             }
  611.         }
  612.     }
  614.     /**
  615.      * Completes the ID generator mapping. If "auto" is specified we choose the generator
  616.      * most appropriate for the targeted database platform.
  617.      *
  618.      * @param ClassMetadataInfo $class
  619.      *
  620.      * @return void
  621.      *
  622.      * @throws ORMException
  623.      */
  624.     private function completeIdGeneratorMapping(ClassMetadataInfo $class)
  625.     {
  626.         $idGenType = $class->generatorType;
  627.         if ($idGenType == ClassMetadata::GENERATOR_TYPE_AUTO) {
  628.             if ($this->getTargetPlatform()->prefersSequences()) {
  629.                 $class->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_SEQUENCE);
  630.             } else if ($this->getTargetPlatform()->prefersIdentityColumns()) {
  631.                 $class->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_IDENTITY);
  632.             } else {
  633.                 $class->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_TABLE);
  634.             }
  635.         }
  637.         // Create & assign an appropriate ID generator instance
  638.         switch ($class->generatorType) {
  639.             case ClassMetadata::GENERATOR_TYPE_IDENTITY:
  640.                 $sequenceName = null;
  641.                 $fieldName    = $class->identifier ? $class->getSingleIdentifierFieldName() : null;
  643.                 // Platforms that do not have native IDENTITY support need a sequence to emulate this behaviour.
  644.                 if ($this->getTargetPlatform()->usesSequenceEmulatedIdentityColumns()) {
  645.                     $columnName     = $class->getSingleIdentifierColumnName();
  646.                     $quoted         = isset($class->fieldMappings[$fieldName]['quoted']) || isset($class->table['quoted']);
  647.                     $sequencePrefix = $class->getSequencePrefix($this->getTargetPlatform());
  648.                     $sequenceName   = $this->getTargetPlatform()->getIdentitySequenceName($sequencePrefix, $columnName);
  649.                     $definition     = [
  650.                         'sequenceName' => $this->getTargetPlatform()->fixSchemaElementName($sequenceName)
  651.                     ];
  653.                     if ($quoted) {
  654.                         $definition['quoted'] = true;
  655.                     }
  657.                     $sequenceName = $this
  658.                         ->em
  659.                         ->getConfiguration()
  660.                         ->getQuoteStrategy()
  661.                         ->getSequenceName($definition, $class, $this->getTargetPlatform());
  662.                 }
  664.                 $generator = ($fieldName && $class->fieldMappings[$fieldName]['type'] === 'bigint')
  665.                     ? new BigIntegerIdentityGenerator($sequenceName)
  666.                     : new IdentityGenerator($sequenceName);
  668.                 $class->setIdGenerator($generator);
  670.                 break;
  672.             case ClassMetadata::GENERATOR_TYPE_SEQUENCE:
  673.                 // If there is no sequence definition yet, create a default definition
  674.                 $definition = $class->sequenceGeneratorDefinition;
  676.                 if ( ! $definition) {
  677.                     $fieldName      = $class->getSingleIdentifierFieldName();
  678.                     $sequenceName   = $class->getSequenceName($this->getTargetPlatform());
  679.                     $quoted         = isset($class->fieldMappings[$fieldName]['quoted']) || isset($class->table['quoted']);
  681.                     $definition = [
  682.                         'sequenceName'      => $this->getTargetPlatform()->fixSchemaElementName($sequenceName),
  683.                         'allocationSize'    => 1,
  684.                         'initialValue'      => 1,
  685.                     ];
  687.                     if ($quoted) {
  688.                         $definition['quoted'] = true;
  689.                     }
  691.                     $class->setSequenceGeneratorDefinition($definition);
  692.                 }
  694.                 $sequenceGenerator = new \Doctrine\ORM\Id\SequenceGenerator(
  695.                     $this->em->getConfiguration()->getQuoteStrategy()->getSequenceName($definition, $class, $this->getTargetPlatform()),
  696.                     $definition['allocationSize']
  697.                 );
  698.                 $class->setIdGenerator($sequenceGenerator);
  699.                 break;
  701.             case ClassMetadata::GENERATOR_TYPE_NONE:
  702.                 $class->setIdGenerator(new \Doctrine\ORM\Id\AssignedGenerator());
  703.                 break;
  705.             case ClassMetadata::GENERATOR_TYPE_UUID:
  706.                 $class->setIdGenerator(new \Doctrine\ORM\Id\UuidGenerator());
  707.                 break;
  709.             case ClassMetadata::GENERATOR_TYPE_TABLE:
  710.                 throw new ORMException("TableGenerator not yet implemented.");
  711.                 break;
  713.             case ClassMetadata::GENERATOR_TYPE_CUSTOM:
  714.                 $definition = $class->customGeneratorDefinition;
  715.                 if ($definition === null) {
  716.                     throw new ORMException("Can't instantiate custom generator : no custom generator definition");
  717.                 }
  718.                 if ( ! class_exists($definition['class'])) {
  719.                     throw new ORMException("Can't instantiate custom generator : " .
  720.                         $definition['class']);
  721.                 }
  722.                 $class->setIdGenerator(new $definition['class']);
  723.                 break;
  725.             default:
  726.                 throw new ORMException("Unknown generator type: " . $class->generatorType);
  727.         }
  728.     }
  730.     /**
  731.      * Inherits the ID generator mapping from a parent class.
  732.      *
  733.      * @param ClassMetadataInfo $class
  734.      * @param ClassMetadataInfo $parent
  735.      */
  736.     private function inheritIdGeneratorMapping(ClassMetadataInfo $class, ClassMetadataInfo $parent)
  737.     {
  738.         if ($parent->isIdGeneratorSequence()) {
  739.             $class->setSequenceGeneratorDefinition($parent->sequenceGeneratorDefinition);
  740.         } elseif ($parent->isIdGeneratorTable()) {
  741.             $class->tableGeneratorDefinition = $parent->tableGeneratorDefinition;
  742.         }
  744.         if ($parent->generatorType) {
  745.             $class->setIdGeneratorType($parent->generatorType);
  746.         }
  748.         if ($parent->idGenerator) {
  749.             $class->setIdGenerator($parent->idGenerator);
  750.         }
  751.     }
  753.     /**
  754.      * {@inheritDoc}
  755.      */
  756.     protected function wakeupReflection(ClassMetadataInterface $class, ReflectionService $reflService)
  757.     {
  758.         /* @var $class ClassMetadata */
  759.         $class->wakeupReflection($reflService);
  760.     }
  762.     /**
  763.      * {@inheritDoc}
  764.      */
  765.     protected function initializeReflection(ClassMetadataInterface $class, ReflectionService $reflService)
  766.     {
  767.         /* @var $class ClassMetadata */
  768.         $class->initializeReflection($reflService);
  769.     }
  771.     /**
  772.      * {@inheritDoc}
  773.      */
  774.     protected function getFqcnFromAlias($namespaceAlias, $simpleClassName)
  775.     {
  776.         return $this->em->getConfiguration()->getEntityNamespace($namespaceAlias) . '\\' . $simpleClassName;
  777.     }
  779.     /**
  780.      * {@inheritDoc}
  781.      */
  782.     protected function getDriver()
  783.     {
  784.         return $this->driver;
  785.     }
  787.     /**
  788.      * {@inheritDoc}
  789.      */
  790.     protected function isEntity(ClassMetadataInterface $class)
  791.     {
  792.         return isset($class->isMappedSuperclass) && $class->isMappedSuperclass === false;
  793.     }
  795.     /**
  796.      * @return Platforms\AbstractPlatform
  797.      */
  798.     private function getTargetPlatform()
  799.     {
  800.         if (!$this->targetPlatform) {
  801.             $this->targetPlatform = $this->em->getConnection()->getDatabasePlatform();
  802.         }
  804.         return $this->targetPlatform;
  805.     }
  806. }
  808. interface_exists(ClassMetadataInterface::class);
  809. interface_exists(ReflectionService::class);