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

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