vendor/doctrine/orm/src/Mapping/Driver/AttributeReader.php line 103

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Mapping\Driver;
  7. use Attribute;
  8. use Doctrine\ORM\Mapping\Annotation;
  9. use LogicException;
  10. use ReflectionAttribute;
  11. use ReflectionClass;
  12. use ReflectionMethod;
  13. use ReflectionProperty;
  15. use function assert;
  16. use function is_string;
  17. use function is_subclass_of;
  18. use function sprintf;
  20. /** @internal */
  21. final class AttributeReader
  22. {
  23. /** @var array<class-string<Annotation>,bool> */
  24. private array $isRepeatableAttribute = [];
  26. /**
  27. * @phpstan-return class-string-map<T, T|RepeatableAttributeCollection<T>>
  28. *
  29. * @template T of Annotation
  30. */
  31. public function getClassAttributes(ReflectionClass $class): array
  32. {
  33. return $this->convertToAttributeInstances($class->getAttributes());
  34. }
  36. /**
  37. * @return class-string-map<T, T|RepeatableAttributeCollection<T>>
  38. *
  39. * @template T of Annotation
  40. */
  41. public function getMethodAttributes(ReflectionMethod $method): array
  42. {
  43. return $this->convertToAttributeInstances($method->getAttributes());
  44. }
  46. /**
  47. * @return class-string-map<T, T|RepeatableAttributeCollection<T>>
  48. *
  49. * @template T of Annotation
  50. */
  51. public function getPropertyAttributes(ReflectionProperty $property): array
  52. {
  53. return $this->convertToAttributeInstances($property->getAttributes());
  54. }
  56. /**
  57. * @param class-string<T> $attributeName The name of the annotation.
  58. *
  59. * @return T|null
  60. *
  61. * @template T of Annotation
  62. */
  63. public function getPropertyAttribute(ReflectionProperty $property, $attributeName)
  64. {
  65. if ($this->isRepeatable($attributeName)) {
  66. throw new LogicException(sprintf(
  67. 'The attribute "%s" is repeatable. Call getPropertyAttributeCollection() instead.',
  68. $attributeName
  69. ));
  70. }
  72. return $this->getPropertyAttributes($property)[$attributeName] ?? null;
  73. }
  75. /**
  76. * @param class-string<T> $attributeName The name of the annotation.
  77. *
  78. * @return RepeatableAttributeCollection<T>
  79. *
  80. * @template T of Annotation
  81. */
  82. public function getPropertyAttributeCollection(
  83. ReflectionProperty $property,
  84. string $attributeName
  85. ): RepeatableAttributeCollection {
  86. if (! $this->isRepeatable($attributeName)) {
  87. throw new LogicException(sprintf(
  88. 'The attribute "%s" is not repeatable. Call getPropertyAttribute() instead.',
  89. $attributeName
  90. ));
  91. }
  93. return $this->getPropertyAttributes($property)[$attributeName] ?? new RepeatableAttributeCollection();
  94. }
  96. /**
  97. * @param array<ReflectionAttribute> $attributes
  98. *
  99. * @return class-string-map<T, T|RepeatableAttributeCollection<T>>
  100. *
  101. * @template T of Annotation
  102. */
  103. private function convertToAttributeInstances(array $attributes): array
  104. {
  105. $instances = [];
  107. foreach ($attributes as $attribute) {
  108. $attributeName = $attribute->getName();
  109. assert(is_string($attributeName));
  110. // Make sure we only get Doctrine Attributes
  111. if (! is_subclass_of($attributeName, Annotation::class)) {
  112. continue;
  113. }
  115. $instance = $attribute->newInstance();
  116. assert($instance instanceof Annotation);
  118. if ($this->isRepeatable($attributeName)) {
  119. if (! isset($instances[$attributeName])) {
  120. $instances[$attributeName] = new RepeatableAttributeCollection();
  121. }
  123. $collection = $instances[$attributeName];
  124. assert($collection instanceof RepeatableAttributeCollection);
  125. $collection[] = $instance;
  126. } else {
  127. $instances[$attributeName] = $instance;
  128. }
  129. }
  131. return $instances;
  132. }
  134. /** @param class-string<Annotation> $attributeClassName */
  135. private function isRepeatable(string $attributeClassName): bool
  136. {
  137. if (isset($this->isRepeatableAttribute[$attributeClassName])) {
  138. return $this->isRepeatableAttribute[$attributeClassName];
  139. }
  141. $reflectionClass = new ReflectionClass($attributeClassName);
  142. $attribute = $reflectionClass->getAttributes()[0]->newInstance();
  144. return $this->isRepeatableAttribute[$attributeClassName] = ($attribute->flags & Attribute::IS_REPEATABLE) > 0;
  145. }
  146. }