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

  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Mapping;
  7. use Doctrine\Common\EventManager;
  8. use Doctrine\DBAL\Platforms;
  9. use Doctrine\DBAL\Platforms\AbstractPlatform;
  10. use Doctrine\Deprecations\Deprecation;
  11. use Doctrine\ORM\EntityManagerInterface;
  12. use Doctrine\ORM\Event\LoadClassMetadataEventArgs;
  13. use Doctrine\ORM\Event\OnClassMetadataNotFoundEventArgs;
  14. use Doctrine\ORM\Events;
  15. use Doctrine\ORM\Exception\ORMException;
  16. use Doctrine\ORM\Id\AssignedGenerator;
  17. use Doctrine\ORM\Id\BigIntegerIdentityGenerator;
  18. use Doctrine\ORM\Id\IdentityGenerator;
  19. use Doctrine\ORM\Id\SequenceGenerator;
  20. use Doctrine\ORM\Id\UuidGenerator;
  21. use Doctrine\ORM\Mapping\Exception\CannotGenerateIds;
  22. use Doctrine\ORM\Mapping\Exception\InvalidCustomGenerator;
  23. use Doctrine\ORM\Mapping\Exception\UnknownGeneratorType;
  24. use Doctrine\Persistence\Mapping\AbstractClassMetadataFactory;
  25. use Doctrine\Persistence\Mapping\ClassMetadata as ClassMetadataInterface;
  26. use Doctrine\Persistence\Mapping\Driver\MappingDriver;
  27. use Doctrine\Persistence\Mapping\ReflectionService;
  28. use ReflectionClass;
  29. use ReflectionException;
  31. use function assert;
  32. use function class_exists;
  33. use function count;
  34. use function end;
  35. use function explode;
  36. use function get_class;
  37. use function in_array;
  38. use function is_subclass_of;
  39. use function str_contains;
  40. use function strlen;
  41. use function strtolower;
  42. use function substr;
  44. /**
  45.  * The ClassMetadataFactory is used to create ClassMetadata objects that contain all the
  46.  * metadata mapping information of a class which describes how a class should be mapped
  47.  * to a relational database.
  48.  *
  49.  * @extends AbstractClassMetadataFactory<ClassMetadata>
  50.  * @psalm-import-type AssociationMapping from ClassMetadata
  51.  * @psalm-import-type EmbeddedClassMapping from ClassMetadata
  52.  * @psalm-import-type FieldMapping from ClassMetadata
  53.  */
  54. class ClassMetadataFactory extends AbstractClassMetadataFactory
  55. {
  56.     /** @var EntityManagerInterface|null */
  57.     private $em;
  59.     /** @var AbstractPlatform|null */
  60.     private $targetPlatform;
  62.     /** @var MappingDriver */
  63.     private $driver;
  65.     /** @var EventManager */
  66.     private $evm;
  68.     /** @var mixed[] */
  69.     private $embeddablesActiveNesting = [];
  71.     /** @return void */
  72.     public function setEntityManager(EntityManagerInterface $em)
  73.     {
  74.         $this->em = $em;
  75.     }
  77.     /**
  78.      * {@inheritDoc}
  79.      */
  80.     protected function initialize()
  81.     {
  82.         $this->driver      = $this->em->getConfiguration()->getMetadataDriverImpl();
  83.         $this->evm         = $this->em->getEventManager();
  84.         $this->initialized = true;
  85.     }
  87.     /**
  88.      * {@inheritDoc}
  89.      */
  90.     protected function onNotFoundMetadata($className)
  91.     {
  92.         if (! $this->evm->hasListeners(Events::onClassMetadataNotFound)) {
  93.             return null;
  94.         }
  96.         $eventArgs = new OnClassMetadataNotFoundEventArgs($className, $this->em);
  98.         $this->evm->dispatchEvent(Events::onClassMetadataNotFound, $eventArgs);
  99.         $classMetadata = $eventArgs->getFoundMetadata();
  100.         assert($classMetadata instanceof ClassMetadata || $classMetadata === null);
  102.         return $classMetadata;
  103.     }
  105.     /**
  106.      * {@inheritDoc}
  107.      */
  108.     protected function doLoadMetadata($class, $parent, $rootEntityFound, array $nonSuperclassParents)
  109.     {
  110.         if ($parent) {
  111.             $class->setInheritanceType($parent->inheritanceType);
  112.             $class->setDiscriminatorColumn($parent->discriminatorColumn);
  113.             $class->setIdGeneratorType($parent->generatorType);
  114.             $this->addInheritedFields($class, $parent);
  115.             $this->addInheritedRelations($class, $parent);
  116.             $this->addInheritedEmbeddedClasses($class, $parent);
  117.             $class->setIdentifier($parent->identifier);
  118.             $class->setVersioned($parent->isVersioned);
  119.             $class->setVersionField($parent->versionField);
  120.             $class->setDiscriminatorMap($parent->discriminatorMap);
  121.             $class->addSubClasses($parent->subClasses);
  122.             $class->setLifecycleCallbacks($parent->lifecycleCallbacks);
  123.             $class->setChangeTrackingPolicy($parent->changeTrackingPolicy);
  125.             if (! empty($parent->customGeneratorDefinition)) {
  126.                 $class->setCustomGeneratorDefinition($parent->customGeneratorDefinition);
  127.             }
  129.             if ($parent->isMappedSuperclass) {
  130.                 $class->setCustomRepositoryClass($parent->customRepositoryClassName);
  131.             }
  132.         }
  134.         // Invoke driver
  135.         try {
  136.             $this->driver->loadMetadataForClass($class->getName(), $class);
  137.         } catch (ReflectionException $e) {
  138.             throw MappingException::reflectionFailure($class->getName(), $e);
  139.         }
  141.         // If this class has a parent the id generator strategy is inherited.
  142.         // However this is only true if the hierarchy of parents contains the root entity,
  143.         // if it consists of mapped superclasses these don't necessarily include the id field.
  144.         if ($parent && $rootEntityFound) {
  145.             $this->inheritIdGeneratorMapping($class, $parent);
  146.         } else {
  147.             $this->completeIdGeneratorMapping($class);
  148.         }
  150.         if (! $class->isMappedSuperclass) {
  151.             if ($rootEntityFound && $class->isInheritanceTypeNone()) {
  152.                 Deprecation::trigger(
  153.                     'doctrine/orm',
  154.                     'https://github.com/doctrine/orm/pull/10431',
  155.                     "Entity class '%s' is a subclass of the root entity class '%s', but no inheritance mapping type was declared. This is a misconfiguration and will be an error in Doctrine ORM 3.0.",
  156.                     $class->name,
  157.                     end($nonSuperclassParents)
  158.                 );
  159.             }
  161.             foreach ($class->embeddedClasses as $property => $embeddableClass) {
  162.                 if (isset($embeddableClass['inherited'])) {
  163.                     continue;
  164.                 }
  166.                 if (isset($this->embeddablesActiveNesting[$embeddableClass['class']])) {
  167.                     throw MappingException::infiniteEmbeddableNesting($class->name, $property);
  168.                 }
  170.                 $this->embeddablesActiveNesting[$class->name] = true;
  172.                 $embeddableMetadata = $this->getMetadataFor($embeddableClass['class']);
  174.                 if ($embeddableMetadata->isEmbeddedClass) {
  175.                     $this->addNestedEmbeddedClasses($embeddableMetadata, $class, $property);
  176.                 }
  178.                 $identifier = $embeddableMetadata->getIdentifier();
  180.                 if (! empty($identifier)) {
  181.                     $this->inheritIdGeneratorMapping($class, $embeddableMetadata);
  182.                 }
  184.                 $class->inlineEmbeddable($property, $embeddableMetadata);
  186.                 unset($this->embeddablesActiveNesting[$class->name]);
  187.             }
  188.         }
  190.         if ($parent) {
  191.             if ($parent->isInheritanceTypeSingleTable()) {
  192.                 $class->setPrimaryTable($parent->table);
  193.             }
  195.             $this->addInheritedIndexes($class, $parent);
  197.             if ($parent->cache) {
  198.                 $class->cache = $parent->cache;
  199.             }
  201.             if ($parent->containsForeignIdentifier) {
  202.                 $class->containsForeignIdentifier = true;
  203.             }
  205.             if ($parent->containsEnumIdentifier) {
  206.                 $class->containsEnumIdentifier = true;
  207.             }
  209.             if (! empty($parent->namedQueries)) {
  210.                 $this->addInheritedNamedQueries($class, $parent);
  211.             }
  213.             if (! empty($parent->namedNativeQueries)) {
  214.                 $this->addInheritedNamedNativeQueries($class, $parent);
  215.             }
  217.             if (! empty($parent->sqlResultSetMappings)) {
  218.                 $this->addInheritedSqlResultSetMappings($class, $parent);
  219.             }
  221.             if (! empty($parent->entityListeners) && empty($class->entityListeners)) {
  222.                 $class->entityListeners = $parent->entityListeners;
  223.             }
  224.         }
  226.         $class->setParentClasses($nonSuperclassParents);
  228.         if ($class->isRootEntity() && ! $class->isInheritanceTypeNone() && ! $class->discriminatorMap) {
  229.             $this->addDefaultDiscriminatorMap($class);
  230.         }
  232.         // During the following event, there may also be updates to the discriminator map as per GH-1257/GH-8402.
  233.         // So, we must not discover the missing subclasses before that.
  235.         if ($this->evm->hasListeners(Events::loadClassMetadata)) {
  236.             $eventArgs = new LoadClassMetadataEventArgs($class, $this->em);
  237.             $this->evm->dispatchEvent(Events::loadClassMetadata, $eventArgs);
  238.         }
  240.         $this->findAbstractEntityClassesNotListedInDiscriminatorMap($class);
  242.         if ($class->changeTrackingPolicy === ClassMetadata::CHANGETRACKING_NOTIFY) {
  243.             Deprecation::trigger(
  244.                 'doctrine/orm',
  245.                 'https://github.com/doctrine/orm/issues/8383',
  246.                 'NOTIFY Change Tracking policy used in "%s" is deprecated, use deferred explicit instead.',
  247.                 $class->name
  248.             );
  249.         }
  251.         $this->validateRuntimeMetadata($class, $parent);
  252.     }
  254.     /**
  255.      * Validate runtime metadata is correctly defined.
  256.      *
  257.      * @param ClassMetadata               $class
  258.      * @param ClassMetadataInterface|null $parent
  259.      *
  260.      * @return void
  261.      *
  262.      * @throws MappingException
  263.      */
  264.     protected function validateRuntimeMetadata($class, $parent)
  265.     {
  266.         if (! $class->reflClass) {
  267.             // only validate if there is a reflection class instance
  268.             return;
  269.         }
  271.         $class->validateIdentifier();
  272.         $class->validateAssociations();
  273.         $class->validateLifecycleCallbacks($this->getReflectionService());
  275.         // verify inheritance
  276.         if (! $class->isMappedSuperclass && ! $class->isInheritanceTypeNone()) {
  277.             if (! $parent) {
  278.                 if (count($class->discriminatorMap) === 0) {
  279.                     throw MappingException::missingDiscriminatorMap($class->name);
  280.                 }
  282.                 if (! $class->discriminatorColumn) {
  283.                     throw MappingException::missingDiscriminatorColumn($class->name);
  284.                 }
  286.                 foreach ($class->subClasses as $subClass) {
  287.                     if ((new ReflectionClass($subClass))->name !== $subClass) {
  288.                         throw MappingException::invalidClassInDiscriminatorMap($subClass, $class->name);
  289.                     }
  290.                 }
  291.             } else {
  292.                 assert($parent instanceof ClassMetadataInfo); // https://github.com/doctrine/orm/issues/8746
  293.                 if (
  294.                     ! $class->reflClass->isAbstract()
  295.                     && ! in_array($class->name, $class->discriminatorMap, true)
  296.                 ) {
  297.                     throw MappingException::mappedClassNotPartOfDiscriminatorMap($class->name, $class->rootEntityName);
  298.                 }
  299.             }
  300.         } elseif ($class->isMappedSuperclass && $class->name === $class->rootEntityName && (count($class->discriminatorMap) || $class->discriminatorColumn)) {
  301.             // second condition is necessary for mapped superclasses in the middle of an inheritance hierarchy
  302.             throw MappingException::noInheritanceOnMappedSuperClass($class->name);
  303.         }
  304.     }
  306.     /**
  307.      * {@inheritDoc}
  308.      */
  309.     protected function newClassMetadataInstance($className)
  310.     {
  311.         return new ClassMetadata(
  312.             $className,
  313.             $this->em->getConfiguration()->getNamingStrategy(),
  314.             $this->em->getConfiguration()->getTypedFieldMapper()
  315.         );
  316.     }
  318.     /**
  319.      * Adds a default discriminator map if no one is given
  320.      *
  321.      * If an entity is of any inheritance type and does not contain a
  322.      * discriminator map, then the map is generated automatically. This process
  323.      * is expensive computation wise.
  324.      *
  325.      * The automatically generated discriminator map contains the lowercase short name of
  326.      * each class as key.
  327.      *
  328.      * @throws MappingException
  329.      */
  330.     private function addDefaultDiscriminatorMap(ClassMetadata $class): void
  331.     {
  332.         $allClasses = $this->driver->getAllClassNames();
  333.         $fqcn       = $class->getName();
  334.         $map        = [$this->getShortName($class->name) => $fqcn];
  336.         $duplicates = [];
  337.         foreach ($allClasses as $subClassCandidate) {
  338.             if (is_subclass_of($subClassCandidate, $fqcn)) {
  339.                 $shortName = $this->getShortName($subClassCandidate);
  341.                 if (isset($map[$shortName])) {
  342.                     $duplicates[] = $shortName;
  343.                 }
  345.                 $map[$shortName] = $subClassCandidate;
  346.             }
  347.         }
  349.         if ($duplicates) {
  350.             throw MappingException::duplicateDiscriminatorEntry($class->name, $duplicates, $map);
  351.         }
  353.         $class->setDiscriminatorMap($map);
  354.     }
  356.     private function findAbstractEntityClassesNotListedInDiscriminatorMap(ClassMetadata $rootEntityClass): void
  357.     {
  358.         // Only root classes in inheritance hierarchies need contain a discriminator map,
  359.         // so skip for other classes.
  360.         if (! $rootEntityClass->isRootEntity() || $rootEntityClass->isInheritanceTypeNone()) {
  361.             return;
  362.         }
  364.         $processedClasses = [$rootEntityClass->name => true];
  365.         foreach ($rootEntityClass->subClasses as $knownSubClass) {
  366.             $processedClasses[$knownSubClass] = true;
  367.         }
  369.         foreach ($rootEntityClass->discriminatorMap as $declaredClassName) {
  370.             // This fetches non-transient parent classes only
  371.             $parentClasses = $this->getParentClasses($declaredClassName);
  373.             foreach ($parentClasses as $parentClass) {
  374.                 if (isset($processedClasses[$parentClass])) {
  375.                     continue;
  376.                 }
  378.                 $processedClasses[$parentClass] = true;
  380.                 // All non-abstract entity classes must be listed in the discriminator map, and
  381.                 // this will be validated/enforced at runtime (possibly at a later time, when the
  382.                 // subclass is loaded, but anyways). Also, subclasses is about entity classes only.
  383.                 // That means we can ignore non-abstract classes here. The (expensive) driver
  384.                 // check for mapped superclasses need only be run for abstract candidate classes.
  385.                 if (! (new ReflectionClass($parentClass))->isAbstract() || $this->peekIfIsMappedSuperclass($parentClass)) {
  386.                     continue;
  387.                 }
  389.                 // We have found a non-transient, non-mapped-superclass = an entity class (possibly abstract, but that does not matter)
  390.                 $rootEntityClass->addSubClass($parentClass);
  391.             }
  392.         }
  393.     }
  395.     /** @param class-string $className */
  396.     private function peekIfIsMappedSuperclass(string $className): bool
  397.     {
  398.         $reflService = $this->getReflectionService();
  399.         $class       = $this->newClassMetadataInstance($className);
  400.         $this->initializeReflection($class, $reflService);
  402.         $this->driver->loadMetadataForClass($className, $class);
  404.         return $class->isMappedSuperclass;
  405.     }
  407.     /**
  408.      * Gets the lower-case short name of a class.
  409.      *
  410.      * @psalm-param class-string $className
  411.      */
  412.     private function getShortName(string $className): string
  413.     {
  414.         if (! str_contains($className, '\\')) {
  415.             return strtolower($className);
  416.         }
  418.         $parts = explode('\\', $className);
  420.         return strtolower(end($parts));
  421.     }
  423.     /**
  424.      * Puts the `inherited` and `declared` values into mapping information for fields, associations
  425.      * and embedded classes.
  426.      *
  427.      * @param AssociationMapping|EmbeddedClassMapping|FieldMapping $mapping
  428.      */
  429.     private function addMappingInheritanceInformation(array &$mapping, ClassMetadata $parentClass): void
  430.     {
  431.         if (! isset($mapping['inherited']) && ! $parentClass->isMappedSuperclass) {
  432.             $mapping['inherited'] = $parentClass->name;
  433.         }
  435.         if (! isset($mapping['declared'])) {
  436.             $mapping['declared'] = $parentClass->name;
  437.         }
  438.     }
  440.     /**
  441.      * Adds inherited fields to the subclass mapping.
  442.      */
  443.     private function addInheritedFields(ClassMetadata $subClass, ClassMetadata $parentClass): void
  444.     {
  445.         foreach ($parentClass->fieldMappings as $mapping) {
  446.             $this->addMappingInheritanceInformation($mapping, $parentClass);
  447.             $subClass->addInheritedFieldMapping($mapping);
  448.         }
  450.         foreach ($parentClass->reflFields as $name => $field) {
  451.             $subClass->reflFields[$name] = $field;
  452.         }
  453.     }
  455.     /**
  456.      * Adds inherited association mappings to the subclass mapping.
  457.      *
  458.      * @throws MappingException
  459.      */
  460.     private function addInheritedRelations(ClassMetadata $subClass, ClassMetadata $parentClass): void
  461.     {
  462.         foreach ($parentClass->associationMappings as $field => $mapping) {
  463.             $this->addMappingInheritanceInformation($mapping, $parentClass);
  464.             // When the class inheriting the relation ($subClass) is the first entity class since the
  465.             // relation has been defined in a mapped superclass (or in a chain
  466.             // of mapped superclasses) above, then declare this current entity class as the source of
  467.             // the relationship.
  468.             // According to the definitions given in https://github.com/doctrine/orm/pull/10396/,
  469.             // this is the case <=> ! isset($mapping['inherited']).
  470.             if (! isset($mapping['inherited'])) {
  471.                 $mapping['sourceEntity'] = $subClass->name;
  472.             }
  474.             $subClass->addInheritedAssociationMapping($mapping);
  475.         }
  476.     }
  478.     private function addInheritedEmbeddedClasses(ClassMetadata $subClass, ClassMetadata $parentClass): void
  479.     {
  480.         foreach ($parentClass->embeddedClasses as $field => $embeddedClass) {
  481.             $this->addMappingInheritanceInformation($embeddedClass, $parentClass);
  482.             $subClass->embeddedClasses[$field] = $embeddedClass;
  483.         }
  484.     }
  486.     /**
  487.      * Adds nested embedded classes metadata to a parent class.
  488.      *
  489.      * @param ClassMetadata $subClass    Sub embedded class metadata to add nested embedded classes metadata from.
  490.      * @param ClassMetadata $parentClass Parent class to add nested embedded classes metadata to.
  491.      * @param string        $prefix      Embedded classes' prefix to use for nested embedded classes field names.
  492.      */
  493.     private function addNestedEmbeddedClasses(
  494.         ClassMetadata $subClass,
  495.         ClassMetadata $parentClass,
  496.         string $prefix
  497.     ): void {
  498.         foreach ($subClass->embeddedClasses as $property => $embeddableClass) {
  499.             if (isset($embeddableClass['inherited'])) {
  500.                 continue;
  501.             }
  503.             $embeddableMetadata = $this->getMetadataFor($embeddableClass['class']);
  505.             $parentClass->mapEmbedded(
  506.                 [
  507.                     'fieldName' => $prefix . '.' . $property,
  508.                     'class' => $embeddableMetadata->name,
  509.                     'columnPrefix' => $embeddableClass['columnPrefix'],
  510.                     'declaredField' => $embeddableClass['declaredField']
  511.                             ? $prefix . '.' . $embeddableClass['declaredField']
  512.                             : $prefix,
  513.                     'originalField' => $embeddableClass['originalField'] ?: $property,
  514.                 ]
  515.             );
  516.         }
  517.     }
  519.     /**
  520.      * Copy the table indices from the parent class superclass to the child class
  521.      */
  522.     private function addInheritedIndexes(ClassMetadata $subClass, ClassMetadata $parentClass): void
  523.     {
  524.         if (! $parentClass->isMappedSuperclass) {
  525.             return;
  526.         }
  528.         foreach (['uniqueConstraints', 'indexes'] as $indexType) {
  529.             if (isset($parentClass->table[$indexType])) {
  530.                 foreach ($parentClass->table[$indexType] as $indexName => $index) {
  531.                     if (isset($subClass->table[$indexType][$indexName])) {
  532.                         continue; // Let the inheriting table override indices
  533.                     }
  535.                     $subClass->table[$indexType][$indexName] = $index;
  536.                 }
  537.             }
  538.         }
  539.     }
  541.     /**
  542.      * Adds inherited named queries to the subclass mapping.
  543.      */
  544.     private function addInheritedNamedQueries(ClassMetadata $subClass, ClassMetadata $parentClass): void
  545.     {
  546.         foreach ($parentClass->namedQueries as $name => $query) {
  547.             if (! isset($subClass->namedQueries[$name])) {
  548.                 $subClass->addNamedQuery(
  549.                     [
  550.                         'name'  => $query['name'],
  551.                         'query' => $query['query'],
  552.                     ]
  553.                 );
  554.             }
  555.         }
  556.     }
  558.     /**
  559.      * Adds inherited named native queries to the subclass mapping.
  560.      */
  561.     private function addInheritedNamedNativeQueries(ClassMetadata $subClass, ClassMetadata $parentClass): void
  562.     {
  563.         foreach ($parentClass->namedNativeQueries as $name => $query) {
  564.             if (! isset($subClass->namedNativeQueries[$name])) {
  565.                 $subClass->addNamedNativeQuery(
  566.                     [
  567.                         'name'              => $query['name'],
  568.                         'query'             => $query['query'],
  569.                         'isSelfClass'       => $query['isSelfClass'],
  570.                         'resultSetMapping'  => $query['resultSetMapping'],
  571.                         'resultClass'       => $query['isSelfClass'] ? $subClass->name : $query['resultClass'],
  572.                     ]
  573.                 );
  574.             }
  575.         }
  576.     }
  578.     /**
  579.      * Adds inherited sql result set mappings to the subclass mapping.
  580.      */
  581.     private function addInheritedSqlResultSetMappings(ClassMetadata $subClass, ClassMetadata $parentClass): void
  582.     {
  583.         foreach ($parentClass->sqlResultSetMappings as $name => $mapping) {
  584.             if (! isset($subClass->sqlResultSetMappings[$name])) {
  585.                 $entities = [];
  586.                 foreach ($mapping['entities'] as $entity) {
  587.                     $entities[] = [
  588.                         'fields'                => $entity['fields'],
  589.                         'isSelfClass'           => $entity['isSelfClass'],
  590.                         'discriminatorColumn'   => $entity['discriminatorColumn'],
  591.                         'entityClass'           => $entity['isSelfClass'] ? $subClass->name : $entity['entityClass'],
  592.                     ];
  593.                 }
  595.                 $subClass->addSqlResultSetMapping(
  596.                     [
  597.                         'name'          => $mapping['name'],
  598.                         'columns'       => $mapping['columns'],
  599.                         'entities'      => $entities,
  600.                     ]
  601.                 );
  602.             }
  603.         }
  604.     }
  606.     /**
  607.      * Completes the ID generator mapping. If "auto" is specified we choose the generator
  608.      * most appropriate for the targeted database platform.
  609.      *
  610.      * @throws ORMException
  611.      */
  612.     private function completeIdGeneratorMapping(ClassMetadataInfo $class): void
  613.     {
  614.         $idGenType = $class->generatorType;
  615.         if ($idGenType === ClassMetadata::GENERATOR_TYPE_AUTO) {
  616.             $class->setIdGeneratorType($this->determineIdGeneratorStrategy($this->getTargetPlatform()));
  617.         }
  619.         // Create & assign an appropriate ID generator instance
  620.         switch ($class->generatorType) {
  621.             case ClassMetadata::GENERATOR_TYPE_IDENTITY:
  622.                 $sequenceName = null;
  623.                 $fieldName    = $class->identifier ? $class->getSingleIdentifierFieldName() : null;
  625.                 // Platforms that do not have native IDENTITY support need a sequence to emulate this behaviour.
  626.                 if ($this->getTargetPlatform()->usesSequenceEmulatedIdentityColumns()) {
  627.                     Deprecation::trigger(
  628.                         'doctrine/orm',
  629.                         'https://github.com/doctrine/orm/issues/8850',
  630.                         <<<'DEPRECATION'
  631. Context: Loading metadata for class %s
  632. Problem: Using the IDENTITY generator strategy with platform "%s" is deprecated and will not be possible in Doctrine ORM 3.0.
  633. Solution: Use the SEQUENCE generator strategy instead.
  634. DEPRECATION
  635.                             ,
  636.                         $class->name,
  637.                         get_class($this->getTargetPlatform())
  638.                     );
  639.                     $columnName     = $class->getSingleIdentifierColumnName();
  640.                     $quoted         = isset($class->fieldMappings[$fieldName]['quoted']) || isset($class->table['quoted']);
  641.                     $sequencePrefix = $class->getSequencePrefix($this->getTargetPlatform());
  642.                     $sequenceName   = $this->getTargetPlatform()->getIdentitySequenceName($sequencePrefix, $columnName);
  643.                     $definition     = [
  644.                         'sequenceName' => $this->truncateSequenceName($sequenceName),
  645.                     ];
  647.                     if ($quoted) {
  648.                         $definition['quoted'] = true;
  649.                     }
  651.                     $sequenceName = $this
  652.                         ->em
  653.                         ->getConfiguration()
  654.                         ->getQuoteStrategy()
  655.                         ->getSequenceName($definition, $class, $this->getTargetPlatform());
  656.                 }
  658.                 $generator = $fieldName && $class->fieldMappings[$fieldName]['type'] === 'bigint'
  659.                     ? new BigIntegerIdentityGenerator($sequenceName)
  660.                     : new IdentityGenerator($sequenceName);
  662.                 $class->setIdGenerator($generator);
  664.                 break;
  666.             case ClassMetadata::GENERATOR_TYPE_SEQUENCE:
  667.                 // If there is no sequence definition yet, create a default definition
  668.                 $definition = $class->sequenceGeneratorDefinition;
  670.                 if (! $definition) {
  671.                     $fieldName    = $class->getSingleIdentifierFieldName();
  672.                     $sequenceName = $class->getSequenceName($this->getTargetPlatform());
  673.                     $quoted       = isset($class->fieldMappings[$fieldName]['quoted']) || isset($class->table['quoted']);
  675.                     $definition = [
  676.                         'sequenceName'      => $this->truncateSequenceName($sequenceName),
  677.                         'allocationSize'    => 1,
  678.                         'initialValue'      => 1,
  679.                     ];
  681.                     if ($quoted) {
  682.                         $definition['quoted'] = true;
  683.                     }
  685.                     $class->setSequenceGeneratorDefinition($definition);
  686.                 }
  688.                 $sequenceGenerator = new SequenceGenerator(
  689.                     $this->em->getConfiguration()->getQuoteStrategy()->getSequenceName($definition, $class, $this->getTargetPlatform()),
  690.                     (int) $definition['allocationSize']
  691.                 );
  692.                 $class->setIdGenerator($sequenceGenerator);
  693.                 break;
  695.             case ClassMetadata::GENERATOR_TYPE_NONE:
  696.                 $class->setIdGenerator(new AssignedGenerator());
  697.                 break;
  699.             case ClassMetadata::GENERATOR_TYPE_UUID:
  700.                 Deprecation::trigger(
  701.                     'doctrine/orm',
  702.                     'https://github.com/doctrine/orm/issues/7312',
  703.                     'Mapping for %s: the "UUID" id generator strategy is deprecated with no replacement',
  704.                     $class->name
  705.                 );
  706.                 $class->setIdGenerator(new UuidGenerator());
  707.                 break;
  709.             case ClassMetadata::GENERATOR_TYPE_CUSTOM:
  710.                 $definition = $class->customGeneratorDefinition;
  711.                 if ($definition === null) {
  712.                     throw InvalidCustomGenerator::onClassNotConfigured();
  713.                 }
  715.                 if (! class_exists($definition['class'])) {
  716.                     throw InvalidCustomGenerator::onMissingClass($definition);
  717.                 }
  719.                 $class->setIdGenerator(new $definition['class']());
  720.                 break;
  722.             default:
  723.                 throw UnknownGeneratorType::create($class->generatorType);
  724.         }
  725.     }
  727.     /** @psalm-return ClassMetadata::GENERATOR_TYPE_SEQUENCE|ClassMetadata::GENERATOR_TYPE_IDENTITY */
  728.     private function determineIdGeneratorStrategy(AbstractPlatform $platform): int
  729.     {
  730.         if (
  731.             $platform instanceof Platforms\OraclePlatform
  732.             || $platform instanceof Platforms\PostgreSQLPlatform
  733.         ) {
  734.             return ClassMetadata::GENERATOR_TYPE_SEQUENCE;
  735.         }
  737.         if ($platform->supportsIdentityColumns()) {
  738.             return ClassMetadata::GENERATOR_TYPE_IDENTITY;
  739.         }
  741.         if ($platform->supportsSequences()) {
  742.             return ClassMetadata::GENERATOR_TYPE_SEQUENCE;
  743.         }
  745.         throw CannotGenerateIds::withPlatform($platform);
  746.     }
  748.     private function truncateSequenceName(string $schemaElementName): string
  749.     {
  750.         $platform = $this->getTargetPlatform();
  751.         if (! $platform instanceof Platforms\OraclePlatform && ! $platform instanceof Platforms\SQLAnywherePlatform) {
  752.             return $schemaElementName;
  753.         }
  755.         $maxIdentifierLength = $platform->getMaxIdentifierLength();
  757.         if (strlen($schemaElementName) > $maxIdentifierLength) {
  758.             return substr($schemaElementName, 0, $maxIdentifierLength);
  759.         }
  761.         return $schemaElementName;
  762.     }
  764.     /**
  765.      * Inherits the ID generator mapping from a parent class.
  766.      */
  767.     private function inheritIdGeneratorMapping(ClassMetadataInfo $class, ClassMetadataInfo $parent): void
  768.     {
  769.         if ($parent->isIdGeneratorSequence()) {
  770.             $class->setSequenceGeneratorDefinition($parent->sequenceGeneratorDefinition);
  771.         }
  773.         if ($parent->generatorType) {
  774.             $class->setIdGeneratorType($parent->generatorType);
  775.         }
  777.         if ($parent->idGenerator) {
  778.             $class->setIdGenerator($parent->idGenerator);
  779.         }
  780.     }
  782.     /**
  783.      * {@inheritDoc}
  784.      */
  785.     protected function wakeupReflection(ClassMetadataInterface $class, ReflectionService $reflService)
  786.     {
  787.         assert($class instanceof ClassMetadata);
  788.         $class->wakeupReflection($reflService);
  789.     }
  791.     /**
  792.      * {@inheritDoc}
  793.      */
  794.     protected function initializeReflection(ClassMetadataInterface $class, ReflectionService $reflService)
  795.     {
  796.         assert($class instanceof ClassMetadata);
  797.         $class->initializeReflection($reflService);
  798.     }
  800.     /**
  801.      * @deprecated This method will be removed in ORM 3.0.
  802.      *
  803.      * @return class-string
  804.      */
  805.     protected function getFqcnFromAlias($namespaceAlias, $simpleClassName)
  806.     {
  807.         /** @psalm-var class-string */
  808.         return $this->em->getConfiguration()->getEntityNamespace($namespaceAlias) . '\\' . $simpleClassName;
  809.     }
  811.     /**
  812.      * {@inheritDoc}
  813.      */
  814.     protected function getDriver()
  815.     {
  816.         return $this->driver;
  817.     }
  819.     /**
  820.      * {@inheritDoc}
  821.      */
  822.     protected function isEntity(ClassMetadataInterface $class)
  823.     {
  824.         return ! $class->isMappedSuperclass;
  825.     }
  827.     private function getTargetPlatform(): Platforms\AbstractPlatform
  828.     {
  829.         if (! $this->targetPlatform) {
  830.             $this->targetPlatform = $this->em->getConnection()->getDatabasePlatform();
  831.         }
  833.         return $this->targetPlatform;
  834.     }
  835. }