vendor/api-platform/core/src/Core/Metadata/Property/Factory/AnnotationPropertyMetadataFactory.php line 116

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the API Platform project.
  5. *
  6. * (c) Kévin Dunglas <dunglas@gmail.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\Core\Metadata\Property\Factory;
  16. use ApiPlatform\Core\Annotation\ApiProperty;
  17. use ApiPlatform\Core\Exception\PropertyNotFoundException;
  18. use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
  19. use ApiPlatform\Util\Reflection;
  20. use Doctrine\Common\Annotations\Reader;
  22. /**
  23. * Creates a property metadata from {@see ApiProperty} annotations.
  24. *
  25. * @author Kévin Dunglas <dunglas@gmail.com>
  26. */
  27. final class AnnotationPropertyMetadataFactory implements PropertyMetadataFactoryInterface
  28. {
  29. private $reader;
  30. private $decorated;
  32. public function __construct(Reader $reader = null, PropertyMetadataFactoryInterface $decorated = null)
  33. {
  34. $this->reader = $reader;
  35. $this->decorated = $decorated;
  36. }
  38. /**
  39. * {@inheritdoc}
  40. */
  41. public function create(string $resourceClass, string $property, array $options = []): PropertyMetadata
  42. {
  43. if (null === ($options['deprecate'] ?? null)) {
  44. trigger_deprecation('api-platform/core', '2.7', sprintf('Decorating the legacy %s is deprecated, use %s instead.', PropertyMetadataFactoryInterface::class, \ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface::class));
  45. }
  47. $parentPropertyMetadata = null;
  48. if ($this->decorated) {
  49. try {
  50. $parentPropertyMetadata = $this->decorated->create($resourceClass, $property, $options);
  51. } catch (PropertyNotFoundException $propertyNotFoundException) {
  52. // Ignore not found exception from decorated factories
  53. }
  54. }
  56. try {
  57. $reflectionClass = new \ReflectionClass($resourceClass);
  58. } catch (\ReflectionException $reflectionException) {
  59. return $this->handleNotFound($parentPropertyMetadata, $resourceClass, $property);
  60. }
  62. if ($reflectionClass->hasProperty($property)) {
  63. $annotation = null;
  64. $reflectionProperty = $reflectionClass->getProperty($property);
  65. if (\PHP_VERSION_ID >= 80000 && $attributes = $reflectionProperty->getAttributes(ApiProperty::class)) {
  66. $annotation = $attributes[0]->newInstance();
  67. } elseif (null !== $this->reader) {
  68. $annotation = $this->reader->getPropertyAnnotation($reflectionProperty, ApiProperty::class);
  69. }
  71. if ($annotation instanceof ApiProperty) {
  72. return $this->createMetadata($annotation, $parentPropertyMetadata);
  73. }
  74. }
  76. foreach (array_merge(Reflection::ACCESSOR_PREFIXES, Reflection::MUTATOR_PREFIXES) as $prefix) {
  77. $methodName = $prefix.ucfirst($property);
  78. if (!$reflectionClass->hasMethod($methodName)) {
  79. continue;
  80. }
  82. $reflectionMethod = $reflectionClass->getMethod($methodName);
  83. if (!$reflectionMethod->isPublic()) {
  84. continue;
  85. }
  87. $annotation = null;
  88. if (\PHP_VERSION_ID >= 80000 && $attributes = $reflectionMethod->getAttributes(ApiProperty::class)) {
  89. $annotation = $attributes[0]->newInstance();
  90. } elseif (null !== $this->reader) {
  91. $annotation = $this->reader->getMethodAnnotation($reflectionMethod, ApiProperty::class);
  92. }
  94. if ($annotation instanceof ApiProperty) {
  95. return $this->createMetadata($annotation, $parentPropertyMetadata);
  96. }
  97. }
  99. return $this->handleNotFound($parentPropertyMetadata, $resourceClass, $property);
  100. }
  102. /**
  103. * Returns the metadata from the decorated factory if available or throws an exception.
  104. *
  105. * @throws PropertyNotFoundException
  106. */
  107. private function handleNotFound(?PropertyMetadata $parentPropertyMetadata, string $resourceClass, string $property): PropertyMetadata
  108. {
  109. if (null !== $parentPropertyMetadata) {
  110. return $parentPropertyMetadata;
  111. }
  113. throw new PropertyNotFoundException(sprintf('Property "%s" of class "%s" not found.', $property, $resourceClass));
  114. }
  116. private function createMetadata(ApiProperty $annotation, PropertyMetadata $parentPropertyMetadata = null): PropertyMetadata
  117. {
  118. if (null === $parentPropertyMetadata) {
  119. return new PropertyMetadata(
  120. null,
  121. $annotation->description,
  122. $annotation->readable,
  123. $annotation->writable,
  124. $annotation->readableLink,
  125. $annotation->writableLink,
  126. $annotation->required,
  127. $annotation->identifier,
  128. $annotation->iri,
  129. null,
  130. $annotation->attributes,
  131. null,
  132. null,
  133. $annotation->default,
  134. $annotation->example
  135. );
  136. }
  138. $propertyMetadata = $parentPropertyMetadata;
  139. foreach ([['get', 'description'], ['is', 'readable'], ['is', 'writable'], ['is', 'readableLink'], ['is', 'writableLink'], ['is', 'required'], ['get', 'iri'], ['is', 'identifier'], ['get', 'attributes'], ['get', 'default'], ['get', 'example']] as $property) {
  140. if (null !== $value = $annotation->{$property[1]}) {
  141. $propertyMetadata = $this->createWith($propertyMetadata, $property, $value);
  142. }
  143. }
  145. return $propertyMetadata;
  146. }
  148. private function createWith(PropertyMetadata $propertyMetadata, array $property, $value): PropertyMetadata
  149. {
  150. $wither = 'with'.ucfirst($property[1]);
  152. return $propertyMetadata->{$wither}($value);
  153. }
  154. }