vendor/doctrine/mongodb-odm/lib/Doctrine/ODM/MongoDB/Mapping/Driver/AttributeReader.php line 24

  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ODM\MongoDB\Mapping\Driver;
  7. use Doctrine\Common\Annotations\Reader;
  8. use Doctrine\ODM\MongoDB\Mapping\Annotations\Annotation;
  9. use ReflectionAttribute;
  10. use ReflectionClass;
  11. use ReflectionMethod;
  12. use ReflectionProperty;
  14. use function assert;
  15. use function is_subclass_of;
  17. /**
  18.  * @internal
  19.  */
  20. final class AttributeReader implements Reader
  21. {
  22.     public function getClassAnnotations(ReflectionClass $class): array
  23.     {
  24.         return $this->convertToAttributeInstances($class->getAttributes());
  25.     }
  27.     /**
  28.      * @param class-string<T> $annotationName
  29.      *
  30.      * @return T|null
  31.      *
  32.      * @template T
  33.      */
  34.     public function getClassAnnotation(ReflectionClass $class, $annotationName)
  35.     {
  36.         foreach ($this->getClassAnnotations($class) as $annotation) {
  37.             if ($annotation instanceof $annotationName) {
  38.                 return $annotation;
  39.             }
  40.         }
  42.         return null;
  43.     }
  45.     public function getMethodAnnotations(ReflectionMethod $method): array
  46.     {
  47.         return $this->convertToAttributeInstances($method->getAttributes());
  48.     }
  50.     /**
  51.      * @param class-string<T> $annotationName
  52.      *
  53.      * @return T|null
  54.      *
  55.      * @template T
  56.      */
  57.     public function getMethodAnnotation(ReflectionMethod $method, $annotationName)
  58.     {
  59.         foreach ($this->getMethodAnnotations($method) as $annotation) {
  60.             if ($annotation instanceof $annotationName) {
  61.                 return $annotation;
  62.             }
  63.         }
  65.         return null;
  66.     }
  68.     public function getPropertyAnnotations(ReflectionProperty $property): array
  69.     {
  70.         return $this->convertToAttributeInstances($property->getAttributes());
  71.     }
  73.     /**
  74.      * @param class-string<T> $annotationName
  75.      *
  76.      * @return T|null
  77.      *
  78.      * @template T
  79.      */
  80.     public function getPropertyAnnotation(ReflectionProperty $property, $annotationName)
  81.     {
  82.         foreach ($this->getPropertyAnnotations($property) as $annotation) {
  83.             if ($annotation instanceof $annotationName) {
  84.                 return $annotation;
  85.             }
  86.         }
  88.         return null;
  89.     }
  91.     /**
  92.      * @param ReflectionAttribute<object>[] $attributes
  93.      *
  94.      * @return Annotation[]
  95.      */
  96.     private function convertToAttributeInstances(array $attributes): array
  97.     {
  98.         $instances = [];
  100.         foreach ($attributes as $attribute) {
  101.             $attributeName = $attribute->getName();
  102.             // Make sure we only get Doctrine Annotations
  103.             if (! is_subclass_of($attributeName, Annotation::class)) {
  104.                 continue;
  105.             }
  107.             $instance = $attribute->newInstance();
  108.             assert($instance instanceof Annotation);
  109.             $instances[] = $instance;
  110.         }
  112.         return $instances;
  113.     }
  114. }