vendor/doctrine/orm/lib/Doctrine/ORM/Mapping/Driver/AttributeDriver.php line 102

  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Mapping\Driver;
  7. use Doctrine\Deprecations\Deprecation;
  8. use Doctrine\ORM\Events;
  9. use Doctrine\ORM\Mapping;
  10. use Doctrine\ORM\Mapping\Builder\EntityListenerBuilder;
  11. use Doctrine\ORM\Mapping\ClassMetadata;
  12. use Doctrine\ORM\Mapping\MappingAttribute;
  13. use Doctrine\ORM\Mapping\MappingException;
  14. use Doctrine\Persistence\Mapping\ClassMetadata as PersistenceClassMetadata;
  15. use Doctrine\Persistence\Mapping\Driver\ColocatedMappingDriver;
  16. use LogicException;
  17. use ReflectionClass;
  18. use ReflectionMethod;
  19. use ReflectionProperty;
  21. use function assert;
  22. use function class_exists;
  23. use function constant;
  24. use function defined;
  25. use function get_class;
  26. use function sprintf;
  28. use const PHP_VERSION_ID;
  30. class AttributeDriver extends CompatibilityAnnotationDriver
  31. {
  32.     use ColocatedMappingDriver;
  34.     private const ENTITY_ATTRIBUTE_CLASSES = [
  35.         Mapping\Entity::class => 1,
  36.         Mapping\MappedSuperclass::class => 2,
  37.     ];
  39.     /**
  40.      * @deprecated override isTransient() instead of overriding this property
  41.      *
  42.      * @var array<class-string<MappingAttribute>, int>
  43.      */
  44.     protected $entityAnnotationClasses = self::ENTITY_ATTRIBUTE_CLASSES;
  46.     /**
  47.      * The attribute reader.
  48.      *
  49.      * @internal this property will be private in 3.0
  50.      *
  51.      * @var AttributeReader
  52.      */
  53.     protected $reader;
  55.     /** @param array<string> $paths */
  56.     public function __construct(array $paths)
  57.     {
  58.         if (PHP_VERSION_ID < 80000) {
  59.             throw new LogicException(sprintf(
  60.                 'The attribute metadata driver cannot be enabled on PHP 7. Please upgrade to PHP 8 or choose a different'
  61.                 . ' metadata driver.'
  62.             ));
  63.         }
  65.         $this->reader = new AttributeReader();
  66.         $this->addPaths($paths);
  68.         if ($this->entityAnnotationClasses !== self::ENTITY_ATTRIBUTE_CLASSES) {
  69.             Deprecation::trigger(
  70.                 'doctrine/orm',
  71.                 'https://github.com/doctrine/orm/pull/10204',
  72.                 'Changing the value of %s::$entityAnnotationClasses is deprecated and will have no effect in Doctrine ORM 3.0.',
  73.                 self::class
  74.             );
  75.         }
  76.     }
  78.     /**
  79.      * Retrieve the current annotation reader
  80.      *
  81.      * @deprecated no replacement planned.
  82.      *
  83.      * @return AttributeReader
  84.      */
  85.     public function getReader()
  86.     {
  87.         Deprecation::trigger(
  88.             'doctrine/orm',
  89.             'https://github.com/doctrine/orm/pull/9587',
  90.             '%s is deprecated with no replacement',
  91.             __METHOD__
  92.         );
  94.         return $this->reader;
  95.     }
  97.     /**
  98.      * {@inheritDoc}
  99.      */
  100.     public function isTransient($className)
  101.     {
  102.         $classAttributes = $this->reader->getClassAttributes(new ReflectionClass($className));
  104.         foreach ($classAttributes as $a) {
  105.             $attr = $a instanceof RepeatableAttributeCollection ? $a[0] : $a;
  106.             if (isset($this->entityAnnotationClasses[get_class($attr)])) {
  107.                 return false;
  108.             }
  109.         }
  111.         return true;
  112.     }
  114.     /**
  115.      * {@inheritDoc}
  116.      *
  117.      * @psalm-param class-string<T> $className
  118.      * @psalm-param ClassMetadata<T> $metadata
  119.      *
  120.      * @template T of object
  121.      */
  122.     public function loadMetadataForClass($className, PersistenceClassMetadata $metadata): void
  123.     {
  124.         $reflectionClass = $metadata->getReflectionClass()
  125.             // this happens when running attribute driver in combination with
  126.             // static reflection services. This is not the nicest fix
  127.             ?? new ReflectionClass($metadata->name);
  129.         $classAttributes = $this->reader->getClassAttributes($reflectionClass);
  131.         // Evaluate Entity attribute
  132.         if (isset($classAttributes[Mapping\Entity::class])) {
  133.             $entityAttribute = $classAttributes[Mapping\Entity::class];
  134.             if ($entityAttribute->repositoryClass !== null) {
  135.                 $metadata->setCustomRepositoryClass($entityAttribute->repositoryClass);
  136.             }
  138.             if ($entityAttribute->readOnly) {
  139.                 $metadata->markReadOnly();
  140.             }
  141.         } elseif (isset($classAttributes[Mapping\MappedSuperclass::class])) {
  142.             $mappedSuperclassAttribute = $classAttributes[Mapping\MappedSuperclass::class];
  144.             $metadata->setCustomRepositoryClass($mappedSuperclassAttribute->repositoryClass);
  145.             $metadata->isMappedSuperclass = true;
  146.         } elseif (isset($classAttributes[Mapping\Embeddable::class])) {
  147.             $metadata->isEmbeddedClass = true;
  148.         } else {
  149.             throw MappingException::classIsNotAValidEntityOrMappedSuperClass($className);
  150.         }
  152.         $primaryTable = [];
  154.         if (isset($classAttributes[Mapping\Table::class])) {
  155.             $tableAnnot             = $classAttributes[Mapping\Table::class];
  156.             $primaryTable['name']   = $tableAnnot->name;
  157.             $primaryTable['schema'] = $tableAnnot->schema;
  159.             if ($tableAnnot->options) {
  160.                 $primaryTable['options'] = $tableAnnot->options;
  161.             }
  162.         }
  164.         if (isset($classAttributes[Mapping\Index::class])) {
  165.             foreach ($classAttributes[Mapping\Index::class] as $idx => $indexAnnot) {
  166.                 $index = [];
  168.                 if (! empty($indexAnnot->columns)) {
  169.                     $index['columns'] = $indexAnnot->columns;
  170.                 }
  172.                 if (! empty($indexAnnot->fields)) {
  173.                     $index['fields'] = $indexAnnot->fields;
  174.                 }
  176.                 if (
  177.                     isset($index['columns'], $index['fields'])
  178.                     || (
  179.                         ! isset($index['columns'])
  180.                         && ! isset($index['fields'])
  181.                     )
  182.                 ) {
  183.                     throw MappingException::invalidIndexConfiguration(
  184.                         $className,
  185.                         (string) ($indexAnnot->name ?? $idx)
  186.                     );
  187.                 }
  189.                 if (! empty($indexAnnot->flags)) {
  190.                     $index['flags'] = $indexAnnot->flags;
  191.                 }
  193.                 if (! empty($indexAnnot->options)) {
  194.                     $index['options'] = $indexAnnot->options;
  195.                 }
  197.                 if (! empty($indexAnnot->name)) {
  198.                     $primaryTable['indexes'][$indexAnnot->name] = $index;
  199.                 } else {
  200.                     $primaryTable['indexes'][] = $index;
  201.                 }
  202.             }
  203.         }
  205.         if (isset($classAttributes[Mapping\UniqueConstraint::class])) {
  206.             foreach ($classAttributes[Mapping\UniqueConstraint::class] as $idx => $uniqueConstraintAnnot) {
  207.                 $uniqueConstraint = [];
  209.                 if (! empty($uniqueConstraintAnnot->columns)) {
  210.                     $uniqueConstraint['columns'] = $uniqueConstraintAnnot->columns;
  211.                 }
  213.                 if (! empty($uniqueConstraintAnnot->fields)) {
  214.                     $uniqueConstraint['fields'] = $uniqueConstraintAnnot->fields;
  215.                 }
  217.                 if (
  218.                     isset($uniqueConstraint['columns'], $uniqueConstraint['fields'])
  219.                     || (
  220.                         ! isset($uniqueConstraint['columns'])
  221.                         && ! isset($uniqueConstraint['fields'])
  222.                     )
  223.                 ) {
  224.                     throw MappingException::invalidUniqueConstraintConfiguration(
  225.                         $className,
  226.                         (string) ($uniqueConstraintAnnot->name ?? $idx)
  227.                     );
  228.                 }
  230.                 if (! empty($uniqueConstraintAnnot->options)) {
  231.                     $uniqueConstraint['options'] = $uniqueConstraintAnnot->options;
  232.                 }
  234.                 if (! empty($uniqueConstraintAnnot->name)) {
  235.                     $primaryTable['uniqueConstraints'][$uniqueConstraintAnnot->name] = $uniqueConstraint;
  236.                 } else {
  237.                     $primaryTable['uniqueConstraints'][] = $uniqueConstraint;
  238.                 }
  239.             }
  240.         }
  242.         $metadata->setPrimaryTable($primaryTable);
  244.         // Evaluate #[Cache] attribute
  245.         if (isset($classAttributes[Mapping\Cache::class])) {
  246.             $cacheAttribute = $classAttributes[Mapping\Cache::class];
  247.             $cacheMap       = [
  248.                 'region' => $cacheAttribute->region,
  249.                 'usage'  => constant('Doctrine\ORM\Mapping\ClassMetadata::CACHE_USAGE_' . $cacheAttribute->usage),
  250.             ];
  252.             $metadata->enableCache($cacheMap);
  253.         }
  255.         // Evaluate InheritanceType attribute
  256.         if (isset($classAttributes[Mapping\InheritanceType::class])) {
  257.             $inheritanceTypeAttribute = $classAttributes[Mapping\InheritanceType::class];
  259.             $metadata->setInheritanceType(
  260.                 constant('Doctrine\ORM\Mapping\ClassMetadata::INHERITANCE_TYPE_' . $inheritanceTypeAttribute->value)
  261.             );
  263.             if ($metadata->inheritanceType !== ClassMetadata::INHERITANCE_TYPE_NONE) {
  264.                 // Evaluate DiscriminatorColumn attribute
  265.                 if (isset($classAttributes[Mapping\DiscriminatorColumn::class])) {
  266.                     $discrColumnAttribute = $classAttributes[Mapping\DiscriminatorColumn::class];
  268.                     $columnDef = [
  269.                         'name' => isset($discrColumnAttribute->name) ? (string) $discrColumnAttribute->name : null,
  270.                         'type' => isset($discrColumnAttribute->type) ? (string) $discrColumnAttribute->type : 'string',
  271.                         'length' => isset($discrColumnAttribute->length) ? (int) $discrColumnAttribute->length : 255,
  272.                         'columnDefinition' => isset($discrColumnAttribute->columnDefinition) ? (string) $discrColumnAttribute->columnDefinition : null,
  273.                         'enumType' => isset($discrColumnAttribute->enumType) ? (string) $discrColumnAttribute->enumType : null,
  274.                     ];
  276.                     if ($discrColumnAttribute->options) {
  277.                         $columnDef['options'] = (array) $discrColumnAttribute->options;
  278.                     }
  280.                     $metadata->setDiscriminatorColumn($columnDef);
  281.                 } else {
  282.                     $metadata->setDiscriminatorColumn(['name' => 'dtype', 'type' => 'string', 'length' => 255]);
  283.                 }
  285.                 // Evaluate DiscriminatorMap attribute
  286.                 if (isset($classAttributes[Mapping\DiscriminatorMap::class])) {
  287.                     $discrMapAttribute = $classAttributes[Mapping\DiscriminatorMap::class];
  288.                     $metadata->setDiscriminatorMap($discrMapAttribute->value);
  289.                 }
  290.             }
  291.         }
  293.         // Evaluate DoctrineChangeTrackingPolicy attribute
  294.         if (isset($classAttributes[Mapping\ChangeTrackingPolicy::class])) {
  295.             $changeTrackingAttribute = $classAttributes[Mapping\ChangeTrackingPolicy::class];
  296.             $metadata->setChangeTrackingPolicy(constant('Doctrine\ORM\Mapping\ClassMetadata::CHANGETRACKING_' . $changeTrackingAttribute->value));
  297.         }
  299.         foreach ($reflectionClass->getProperties() as $property) {
  300.             assert($property instanceof ReflectionProperty);
  301.             if (
  302.                 $metadata->isMappedSuperclass && ! $property->isPrivate()
  303.                 ||
  304.                 $metadata->isInheritedField($property->name)
  305.                 ||
  306.                 $metadata->isInheritedAssociation($property->name)
  307.                 ||
  308.                 $metadata->isInheritedEmbeddedClass($property->name)
  309.             ) {
  310.                 continue;
  311.             }
  313.             $mapping              = [];
  314.             $mapping['fieldName'] = $property->getName();
  316.             // Evaluate #[Cache] attribute
  317.             $cacheAttribute = $this->reader->getPropertyAttribute($property, Mapping\Cache::class);
  318.             if ($cacheAttribute !== null) {
  319.                 assert($cacheAttribute instanceof Mapping\Cache);
  321.                 $mapping['cache'] = $metadata->getAssociationCacheDefaults(
  322.                     $mapping['fieldName'],
  323.                     [
  324.                         'usage'  => (int) constant('Doctrine\ORM\Mapping\ClassMetadata::CACHE_USAGE_' . $cacheAttribute->usage),
  325.                         'region' => $cacheAttribute->region,
  326.                     ]
  327.                 );
  328.             }
  330.             // Check for JoinColumn/JoinColumns attributes
  331.             $joinColumns = [];
  333.             $joinColumnAttributes = $this->reader->getPropertyAttributeCollection($property, Mapping\JoinColumn::class);
  335.             foreach ($joinColumnAttributes as $joinColumnAttribute) {
  336.                 $joinColumns[] = $this->joinColumnToArray($joinColumnAttribute);
  337.             }
  339.             // Field can only be attributed with one of:
  340.             // Column, OneToOne, OneToMany, ManyToOne, ManyToMany, Embedded
  341.             $columnAttribute     = $this->reader->getPropertyAttribute($property, Mapping\Column::class);
  342.             $oneToOneAttribute   = $this->reader->getPropertyAttribute($property, Mapping\OneToOne::class);
  343.             $oneToManyAttribute  = $this->reader->getPropertyAttribute($property, Mapping\OneToMany::class);
  344.             $manyToOneAttribute  = $this->reader->getPropertyAttribute($property, Mapping\ManyToOne::class);
  345.             $manyToManyAttribute = $this->reader->getPropertyAttribute($property, Mapping\ManyToMany::class);
  346.             $embeddedAttribute   = $this->reader->getPropertyAttribute($property, Mapping\Embedded::class);
  348.             if ($columnAttribute !== null) {
  349.                 $mapping = $this->columnToArray($property->getName(), $columnAttribute);
  351.                 if ($this->reader->getPropertyAttribute($property, Mapping\Id::class)) {
  352.                     $mapping['id'] = true;
  353.                 }
  355.                 $generatedValueAttribute = $this->reader->getPropertyAttribute($property, Mapping\GeneratedValue::class);
  357.                 if ($generatedValueAttribute !== null) {
  358.                     $metadata->setIdGeneratorType(constant('Doctrine\ORM\Mapping\ClassMetadata::GENERATOR_TYPE_' . $generatedValueAttribute->strategy));
  359.                 }
  361.                 if ($this->reader->getPropertyAttribute($property, Mapping\Version::class)) {
  362.                     $metadata->setVersionMapping($mapping);
  363.                 }
  365.                 $metadata->mapField($mapping);
  367.                 // Check for SequenceGenerator/TableGenerator definition
  368.                 $seqGeneratorAttribute    = $this->reader->getPropertyAttribute($property, Mapping\SequenceGenerator::class);
  369.                 $customGeneratorAttribute = $this->reader->getPropertyAttribute($property, Mapping\CustomIdGenerator::class);
  371.                 if ($seqGeneratorAttribute !== null) {
  372.                     $metadata->setSequenceGeneratorDefinition(
  373.                         [
  374.                             'sequenceName' => $seqGeneratorAttribute->sequenceName,
  375.                             'allocationSize' => $seqGeneratorAttribute->allocationSize,
  376.                             'initialValue' => $seqGeneratorAttribute->initialValue,
  377.                         ]
  378.                     );
  379.                 } elseif ($customGeneratorAttribute !== null) {
  380.                     $metadata->setCustomGeneratorDefinition(
  381.                         [
  382.                             'class' => $customGeneratorAttribute->class,
  383.                         ]
  384.                     );
  385.                 }
  386.             } elseif ($oneToOneAttribute !== null) {
  387.                 if ($this->reader->getPropertyAttribute($property, Mapping\Id::class)) {
  388.                     $mapping['id'] = true;
  389.                 }
  391.                 $mapping['targetEntity']  = $oneToOneAttribute->targetEntity;
  392.                 $mapping['joinColumns']   = $joinColumns;
  393.                 $mapping['mappedBy']      = $oneToOneAttribute->mappedBy;
  394.                 $mapping['inversedBy']    = $oneToOneAttribute->inversedBy;
  395.                 $mapping['cascade']       = $oneToOneAttribute->cascade;
  396.                 $mapping['orphanRemoval'] = $oneToOneAttribute->orphanRemoval;
  397.                 $mapping['fetch']         = $this->getFetchMode($className, $oneToOneAttribute->fetch);
  398.                 $metadata->mapOneToOne($mapping);
  399.             } elseif ($oneToManyAttribute !== null) {
  400.                 $mapping['mappedBy']      = $oneToManyAttribute->mappedBy;
  401.                 $mapping['targetEntity']  = $oneToManyAttribute->targetEntity;
  402.                 $mapping['cascade']       = $oneToManyAttribute->cascade;
  403.                 $mapping['indexBy']       = $oneToManyAttribute->indexBy;
  404.                 $mapping['orphanRemoval'] = $oneToManyAttribute->orphanRemoval;
  405.                 $mapping['fetch']         = $this->getFetchMode($className, $oneToManyAttribute->fetch);
  407.                 $orderByAttribute = $this->reader->getPropertyAttribute($property, Mapping\OrderBy::class);
  409.                 if ($orderByAttribute !== null) {
  410.                     $mapping['orderBy'] = $orderByAttribute->value;
  411.                 }
  413.                 $metadata->mapOneToMany($mapping);
  414.             } elseif ($manyToOneAttribute !== null) {
  415.                 $idAttribute = $this->reader->getPropertyAttribute($property, Mapping\Id::class);
  417.                 if ($idAttribute !== null) {
  418.                     $mapping['id'] = true;
  419.                 }
  421.                 $mapping['joinColumns']  = $joinColumns;
  422.                 $mapping['cascade']      = $manyToOneAttribute->cascade;
  423.                 $mapping['inversedBy']   = $manyToOneAttribute->inversedBy;
  424.                 $mapping['targetEntity'] = $manyToOneAttribute->targetEntity;
  425.                 $mapping['fetch']        = $this->getFetchMode($className, $manyToOneAttribute->fetch);
  426.                 $metadata->mapManyToOne($mapping);
  427.             } elseif ($manyToManyAttribute !== null) {
  428.                 $joinTable          = [];
  429.                 $joinTableAttribute = $this->reader->getPropertyAttribute($property, Mapping\JoinTable::class);
  431.                 if ($joinTableAttribute !== null) {
  432.                     $joinTable = [
  433.                         'name' => $joinTableAttribute->name,
  434.                         'schema' => $joinTableAttribute->schema,
  435.                     ];
  437.                     if ($joinTableAttribute->options) {
  438.                         $joinTable['options'] = $joinTableAttribute->options;
  439.                     }
  441.                     foreach ($joinTableAttribute->joinColumns as $joinColumn) {
  442.                         $joinTable['joinColumns'][] = $this->joinColumnToArray($joinColumn);
  443.                     }
  445.                     foreach ($joinTableAttribute->inverseJoinColumns as $joinColumn) {
  446.                         $joinTable['inverseJoinColumns'][] = $this->joinColumnToArray($joinColumn);
  447.                     }
  448.                 }
  450.                 foreach ($this->reader->getPropertyAttributeCollection($property, Mapping\JoinColumn::class) as $joinColumn) {
  451.                     $joinTable['joinColumns'][] = $this->joinColumnToArray($joinColumn);
  452.                 }
  454.                 foreach ($this->reader->getPropertyAttributeCollection($property, Mapping\InverseJoinColumn::class) as $joinColumn) {
  455.                     $joinTable['inverseJoinColumns'][] = $this->joinColumnToArray($joinColumn);
  456.                 }
  458.                 $mapping['joinTable']     = $joinTable;
  459.                 $mapping['targetEntity']  = $manyToManyAttribute->targetEntity;
  460.                 $mapping['mappedBy']      = $manyToManyAttribute->mappedBy;
  461.                 $mapping['inversedBy']    = $manyToManyAttribute->inversedBy;
  462.                 $mapping['cascade']       = $manyToManyAttribute->cascade;
  463.                 $mapping['indexBy']       = $manyToManyAttribute->indexBy;
  464.                 $mapping['orphanRemoval'] = $manyToManyAttribute->orphanRemoval;
  465.                 $mapping['fetch']         = $this->getFetchMode($className, $manyToManyAttribute->fetch);
  467.                 $orderByAttribute = $this->reader->getPropertyAttribute($property, Mapping\OrderBy::class);
  469.                 if ($orderByAttribute !== null) {
  470.                     $mapping['orderBy'] = $orderByAttribute->value;
  471.                 }
  473.                 $metadata->mapManyToMany($mapping);
  474.             } elseif ($embeddedAttribute !== null) {
  475.                 $mapping['class']        = $embeddedAttribute->class;
  476.                 $mapping['columnPrefix'] = $embeddedAttribute->columnPrefix;
  478.                 $metadata->mapEmbedded($mapping);
  479.             }
  480.         }
  482.         // Evaluate AssociationOverrides attribute
  483.         if (isset($classAttributes[Mapping\AssociationOverrides::class])) {
  484.             $associationOverride = $classAttributes[Mapping\AssociationOverrides::class];
  486.             foreach ($associationOverride->overrides as $associationOverride) {
  487.                 $override  = [];
  488.                 $fieldName = $associationOverride->name;
  490.                 // Check for JoinColumn/JoinColumns attributes
  491.                 if ($associationOverride->joinColumns) {
  492.                     $joinColumns = [];
  494.                     foreach ($associationOverride->joinColumns as $joinColumn) {
  495.                         $joinColumns[] = $this->joinColumnToArray($joinColumn);
  496.                     }
  498.                     $override['joinColumns'] = $joinColumns;
  499.                 }
  501.                 if ($associationOverride->inverseJoinColumns) {
  502.                     $joinColumns = [];
  504.                     foreach ($associationOverride->inverseJoinColumns as $joinColumn) {
  505.                         $joinColumns[] = $this->joinColumnToArray($joinColumn);
  506.                     }
  508.                     $override['inverseJoinColumns'] = $joinColumns;
  509.                 }
  511.                 // Check for JoinTable attributes
  512.                 if ($associationOverride->joinTable) {
  513.                     $joinTableAnnot = $associationOverride->joinTable;
  514.                     $joinTable      = [
  515.                         'name'      => $joinTableAnnot->name,
  516.                         'schema'    => $joinTableAnnot->schema,
  517.                         'joinColumns' => $override['joinColumns'] ?? [],
  518.                         'inverseJoinColumns' => $override['inverseJoinColumns'] ?? [],
  519.                     ];
  521.                     unset($override['joinColumns'], $override['inverseJoinColumns']);
  523.                     $override['joinTable'] = $joinTable;
  524.                 }
  526.                 // Check for inversedBy
  527.                 if ($associationOverride->inversedBy) {
  528.                     $override['inversedBy'] = $associationOverride->inversedBy;
  529.                 }
  531.                 // Check for `fetch`
  532.                 if ($associationOverride->fetch) {
  533.                     $override['fetch'] = constant(ClassMetadata::class . '::FETCH_' . $associationOverride->fetch);
  534.                 }
  536.                 $metadata->setAssociationOverride($fieldName, $override);
  537.             }
  538.         }
  540.         // Evaluate AttributeOverrides attribute
  541.         if (isset($classAttributes[Mapping\AttributeOverrides::class])) {
  542.             $attributeOverridesAnnot = $classAttributes[Mapping\AttributeOverrides::class];
  544.             foreach ($attributeOverridesAnnot->overrides as $attributeOverride) {
  545.                 $mapping = $this->columnToArray($attributeOverride->name, $attributeOverride->column);
  547.                 $metadata->setAttributeOverride($attributeOverride->name, $mapping);
  548.             }
  549.         }
  551.         // Evaluate EntityListeners attribute
  552.         if (isset($classAttributes[Mapping\EntityListeners::class])) {
  553.             $entityListenersAttribute = $classAttributes[Mapping\EntityListeners::class];
  555.             foreach ($entityListenersAttribute->value as $item) {
  556.                 $listenerClassName = $metadata->fullyQualifiedClassName($item);
  558.                 if (! class_exists($listenerClassName)) {
  559.                     throw MappingException::entityListenerClassNotFound($listenerClassName, $className);
  560.                 }
  562.                 $hasMapping    = false;
  563.                 $listenerClass = new ReflectionClass($listenerClassName);
  565.                 foreach ($listenerClass->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
  566.                     assert($method instanceof ReflectionMethod);
  567.                     // find method callbacks.
  568.                     $callbacks  = $this->getMethodCallbacks($method);
  569.                     $hasMapping = $hasMapping ?: ! empty($callbacks);
  571.                     foreach ($callbacks as $value) {
  572.                         $metadata->addEntityListener($value[1], $listenerClassName, $value[0]);
  573.                     }
  574.                 }
  576.                 // Evaluate the listener using naming convention.
  577.                 if (! $hasMapping) {
  578.                     EntityListenerBuilder::bindEntityListener($metadata, $listenerClassName);
  579.                 }
  580.             }
  581.         }
  583.         // Evaluate #[HasLifecycleCallbacks] attribute
  584.         if (isset($classAttributes[Mapping\HasLifecycleCallbacks::class])) {
  585.             foreach ($reflectionClass->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
  586.                 assert($method instanceof ReflectionMethod);
  587.                 foreach ($this->getMethodCallbacks($method) as $value) {
  588.                     $metadata->addLifecycleCallback($value[0], $value[1]);
  589.                 }
  590.             }
  591.         }
  592.     }
  594.     /**
  595.      * Attempts to resolve the fetch mode.
  596.      *
  597.      * @param class-string $className The class name.
  598.      * @param string       $fetchMode The fetch mode.
  599.      *
  600.      * @return ClassMetadata::FETCH_* The fetch mode as defined in ClassMetadata.
  601.      *
  602.      * @throws MappingException If the fetch mode is not valid.
  603.      */
  604.     private function getFetchMode(string $className, string $fetchMode): int
  605.     {
  606.         if (! defined('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . $fetchMode)) {
  607.             throw MappingException::invalidFetchMode($className, $fetchMode);
  608.         }
  610.         return constant('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . $fetchMode);
  611.     }
  613.     /**
  614.      * Attempts to resolve the generated mode.
  615.      *
  616.      * @throws MappingException If the fetch mode is not valid.
  617.      */
  618.     private function getGeneratedMode(string $generatedMode): int
  619.     {
  620.         if (! defined('Doctrine\ORM\Mapping\ClassMetadata::GENERATED_' . $generatedMode)) {
  621.             throw MappingException::invalidGeneratedMode($generatedMode);
  622.         }
  624.         return constant('Doctrine\ORM\Mapping\ClassMetadata::GENERATED_' . $generatedMode);
  625.     }
  627.     /**
  628.      * Parses the given method.
  629.      *
  630.      * @return list<array{string, string}>
  631.      * @psalm-return list<array{string, (Events::*)}>
  632.      */
  633.     private function getMethodCallbacks(ReflectionMethod $method): array
  634.     {
  635.         $callbacks  = [];
  636.         $attributes = $this->reader->getMethodAttributes($method);
  638.         foreach ($attributes as $attribute) {
  639.             if ($attribute instanceof Mapping\PrePersist) {
  640.                 $callbacks[] = [$method->name, Events::prePersist];
  641.             }
  643.             if ($attribute instanceof Mapping\PostPersist) {
  644.                 $callbacks[] = [$method->name, Events::postPersist];
  645.             }
  647.             if ($attribute instanceof Mapping\PreUpdate) {
  648.                 $callbacks[] = [$method->name, Events::preUpdate];
  649.             }
  651.             if ($attribute instanceof Mapping\PostUpdate) {
  652.                 $callbacks[] = [$method->name, Events::postUpdate];
  653.             }
  655.             if ($attribute instanceof Mapping\PreRemove) {
  656.                 $callbacks[] = [$method->name, Events::preRemove];
  657.             }
  659.             if ($attribute instanceof Mapping\PostRemove) {
  660.                 $callbacks[] = [$method->name, Events::postRemove];
  661.             }
  663.             if ($attribute instanceof Mapping\PostLoad) {
  664.                 $callbacks[] = [$method->name, Events::postLoad];
  665.             }
  667.             if ($attribute instanceof Mapping\PreFlush) {
  668.                 $callbacks[] = [$method->name, Events::preFlush];
  669.             }
  670.         }
  672.         return $callbacks;
  673.     }
  675.     /**
  676.      * Parse the given JoinColumn as array
  677.      *
  678.      * @param Mapping\JoinColumn|Mapping\InverseJoinColumn $joinColumn
  679.      *
  680.      * @return mixed[]
  681.      * @psalm-return array{
  682.      *                   name: string|null,
  683.      *                   unique: bool,
  684.      *                   nullable: bool,
  685.      *                   onDelete: mixed,
  686.      *                   columnDefinition: string|null,
  687.      *                   referencedColumnName: string,
  688.      *                   options?: array<string, mixed>
  689.      *               }
  690.      */
  691.     private function joinColumnToArray($joinColumn): array
  692.     {
  693.         $mapping = [
  694.             'name' => $joinColumn->name,
  695.             'unique' => $joinColumn->unique,
  696.             'nullable' => $joinColumn->nullable,
  697.             'onDelete' => $joinColumn->onDelete,
  698.             'columnDefinition' => $joinColumn->columnDefinition,
  699.             'referencedColumnName' => $joinColumn->referencedColumnName,
  700.         ];
  702.         if ($joinColumn->options) {
  703.             $mapping['options'] = $joinColumn->options;
  704.         }
  706.         return $mapping;
  707.     }
  709.     /**
  710.      * Parse the given Column as array
  711.      *
  712.      * @return mixed[]
  713.      * @psalm-return array{
  714.      *                   fieldName: string,
  715.      *                   type: mixed,
  716.      *                   scale: int,
  717.      *                   length: int,
  718.      *                   unique: bool,
  719.      *                   nullable: bool,
  720.      *                   precision: int,
  721.      *                   enumType?: class-string,
  722.      *                   options?: mixed[],
  723.      *                   columnName?: string,
  724.      *                   columnDefinition?: string
  725.      *               }
  726.      */
  727.     private function columnToArray(string $fieldName, Mapping\Column $column): array
  728.     {
  729.         $mapping = [
  730.             'fieldName' => $fieldName,
  731.             'type'      => $column->type,
  732.             'scale'     => $column->scale,
  733.             'length'    => $column->length,
  734.             'unique'    => $column->unique,
  735.             'nullable'  => $column->nullable,
  736.             'precision' => $column->precision,
  737.         ];
  739.         if ($column->options) {
  740.             $mapping['options'] = $column->options;
  741.         }
  743.         if (isset($column->name)) {
  744.             $mapping['columnName'] = $column->name;
  745.         }
  747.         if (isset($column->columnDefinition)) {
  748.             $mapping['columnDefinition'] = $column->columnDefinition;
  749.         }
  751.         if ($column->updatable === false) {
  752.             $mapping['notUpdatable'] = true;
  753.         }
  755.         if ($column->insertable === false) {
  756.             $mapping['notInsertable'] = true;
  757.         }
  759.         if ($column->generated !== null) {
  760.             $mapping['generated'] = $this->getGeneratedMode($column->generated);
  761.         }
  763.         if ($column->enumType) {
  764.             $mapping['enumType'] = $column->enumType;
  765.         }
  767.         return $mapping;
  768.     }
  769. }