vendor/api-platform/core/src/Core/Metadata/Resource/Factory/AnnotationResourceMetadataFactory.php line 90

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\Resource\Factory;
  16. use ApiPlatform\Core\Annotation\ApiResource;
  17. use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
  18. use ApiPlatform\Exception\ResourceClassNotFoundException;
  19. use Doctrine\Common\Annotations\Reader;
  21. /**
  22. * Creates a resource metadata from {@see ApiResource} annotations.
  23. *
  24. * @author Kévin Dunglas <dunglas@gmail.com>
  25. */
  26. final class AnnotationResourceMetadataFactory implements ResourceMetadataFactoryInterface
  27. {
  28. private $reader;
  29. private $decorated;
  30. private $defaults;
  32. public function __construct(Reader $reader = null, ResourceMetadataFactoryInterface $decorated = null, array $defaults = [])
  33. {
  34. $this->reader = $reader;
  35. $this->decorated = $decorated;
  36. $this->defaults = $defaults + ['attributes' => []];
  37. }
  39. /**
  40. * {@inheritdoc}
  41. */
  42. public function create(string $resourceClass): ResourceMetadata
  43. {
  44. $parentResourceMetadata = null;
  45. if ($this->decorated) {
  46. try {
  47. $parentResourceMetadata = $this->decorated->create($resourceClass);
  48. } catch (ResourceClassNotFoundException $resourceNotFoundException) {
  49. // Ignore not found exception from decorated factories
  50. }
  51. }
  53. try {
  54. $reflectionClass = new \ReflectionClass($resourceClass);
  55. } catch (\ReflectionException $reflectionException) {
  56. return $this->handleNotFound($parentResourceMetadata, $resourceClass);
  57. }
  59. if (\PHP_VERSION_ID >= 80000 && $attributes = $reflectionClass->getAttributes(ApiResource::class)) {
  60. return $this->createMetadata($attributes[0]->newInstance(), $parentResourceMetadata);
  61. }
  63. if (null === $this->reader) {
  64. $this->handleNotFound($parentResourceMetadata, $resourceClass);
  65. }
  67. $resourceAnnotation = $this->reader->getClassAnnotation($reflectionClass, ApiResource::class);
  69. if (!$resourceAnnotation instanceof ApiResource) {
  70. return $this->handleNotFound($parentResourceMetadata, $resourceClass);
  71. }
  73. return $this->createMetadata($resourceAnnotation, $parentResourceMetadata);
  74. }
  76. /**
  77. * Returns the metadata from the decorated factory if available or throws an exception.
  78. *
  79. * @throws ResourceClassNotFoundException
  80. */
  81. private function handleNotFound(?ResourceMetadata $parentPropertyMetadata, string $resourceClass): ResourceMetadata
  82. {
  83. if (null !== $parentPropertyMetadata) {
  84. return $parentPropertyMetadata;
  85. }
  87. throw new ResourceClassNotFoundException(sprintf('Resource "%s" not found.', $resourceClass));
  88. }
  90. private function createMetadata(ApiResource $annotation, ResourceMetadata $parentResourceMetadata = null): ResourceMetadata
  91. {
  92. $attributes = null;
  93. if (null !== $annotation->attributes || [] !== $this->defaults['attributes']) {
  94. $attributes = (array) $annotation->attributes;
  95. foreach ($this->defaults['attributes'] as $key => $value) {
  96. if (!isset($attributes[$key])) {
  97. $attributes[$key] = $value;
  98. }
  99. }
  100. }
  102. if (!$parentResourceMetadata) {
  103. return new ResourceMetadata(
  104. $annotation->shortName,
  105. $annotation->description ?? $this->defaults['description'] ?? null, // @phpstan-ignore-line
  106. $annotation->iri ?? $this->defaults['iri'] ?? null, // @phpstan-ignore-line
  107. $annotation->itemOperations ?? $this->defaults['item_operations'] ?? null, // @phpstan-ignore-line
  108. $annotation->collectionOperations ?? $this->defaults['collection_operations'] ?? null, // @phpstan-ignore-line
  109. $attributes,
  110. $annotation->subresourceOperations,
  111. $annotation->graphql ?? $this->defaults['graphql'] ?? null // @phpstan-ignore-line
  112. );
  113. }
  115. $resourceMetadata = $parentResourceMetadata;
  116. foreach (['shortName', 'description', 'iri', 'itemOperations', 'collectionOperations', 'subresourceOperations', 'graphql', 'attributes'] as $property) {
  117. $resourceMetadata = $this->createWith($resourceMetadata, $property, $annotation->{$property});
  118. }
  120. return $resourceMetadata;
  121. }
  123. /**
  124. * Creates a new instance of metadata if the property is not already set.
  125. *
  126. * @param mixed $value
  127. */
  128. private function createWith(ResourceMetadata $resourceMetadata, string $property, $value): ResourceMetadata
  129. {
  130. $upperProperty = ucfirst($property);
  131. $getter = "get$upperProperty";
  133. if (null !== $resourceMetadata->{$getter}()) {
  134. return $resourceMetadata;
  135. }
  137. if (null === $value) {
  138. return $resourceMetadata;
  139. }
  141. $wither = "with$upperProperty";
  143. return $resourceMetadata->{$wither}($value);
  144. }
  145. }