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

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. public function create(string $resourceClass): ResourceMetadata
  40. {
  41. $parentResourceMetadata = null;
  42. if ($this->decorated) {
  43. try {
  44. $parentResourceMetadata = $this->decorated->create($resourceClass);
  45. } catch (ResourceClassNotFoundException $resourceNotFoundException) {
  46. // Ignore not found exception from decorated factories
  47. }
  48. }
  50. try {
  51. $reflectionClass = new \ReflectionClass($resourceClass);
  52. } catch (\ReflectionException $reflectionException) {
  53. return $this->handleNotFound($parentResourceMetadata, $resourceClass);
  54. }
  56. if (\PHP_VERSION_ID >= 80000 && $attributes = $reflectionClass->getAttributes(ApiResource::class)) {
  57. return $this->createMetadata($attributes[0]->newInstance(), $parentResourceMetadata);
  58. }
  60. if (null === $this->reader) {
  61. $this->handleNotFound($parentResourceMetadata, $resourceClass);
  62. }
  64. $resourceAnnotation = $this->reader->getClassAnnotation($reflectionClass, ApiResource::class);
  66. if (!$resourceAnnotation instanceof ApiResource) {
  67. return $this->handleNotFound($parentResourceMetadata, $resourceClass);
  68. }
  70. return $this->createMetadata($resourceAnnotation, $parentResourceMetadata);
  71. }
  73. /**
  74. * Returns the metadata from the decorated factory if available or throws an exception.
  75. *
  76. * @throws ResourceClassNotFoundException
  77. */
  78. private function handleNotFound(?ResourceMetadata $parentPropertyMetadata, string $resourceClass): ResourceMetadata
  79. {
  80. if (null !== $parentPropertyMetadata) {
  81. return $parentPropertyMetadata;
  82. }
  84. throw new ResourceClassNotFoundException(sprintf('Resource "%s" not found.', $resourceClass));
  85. }
  87. private function createMetadata(ApiResource $annotation, ResourceMetadata $parentResourceMetadata = null): ResourceMetadata
  88. {
  89. $attributes = null;
  90. if (null !== $annotation->attributes || [] !== $this->defaults['attributes']) {
  91. $attributes = (array) $annotation->attributes;
  92. foreach ($this->defaults['attributes'] as $key => $value) {
  93. if (!isset($attributes[$key])) {
  94. $attributes[$key] = $value;
  95. }
  96. }
  97. }
  99. if (!$parentResourceMetadata) {
  100. return new ResourceMetadata(
  101. $annotation->shortName,
  102. $annotation->description ?? $this->defaults['description'] ?? null, // @phpstan-ignore-line
  103. $annotation->iri ?? $this->defaults['iri'] ?? null, // @phpstan-ignore-line
  104. $annotation->itemOperations ?? $this->defaults['item_operations'] ?? null, // @phpstan-ignore-line
  105. $annotation->collectionOperations ?? $this->defaults['collection_operations'] ?? null, // @phpstan-ignore-line
  106. $attributes,
  107. $annotation->subresourceOperations,
  108. $annotation->graphql ?? $this->defaults['graphql'] ?? null // @phpstan-ignore-line
  109. );
  110. }
  112. $resourceMetadata = $parentResourceMetadata;
  113. foreach (['shortName', 'description', 'iri', 'itemOperations', 'collectionOperations', 'subresourceOperations', 'graphql', 'attributes'] as $property) {
  114. $resourceMetadata = $this->createWith($resourceMetadata, $property, $annotation->{$property});
  115. }
  117. return $resourceMetadata;
  118. }
  120. /**
  121. * Creates a new instance of metadata if the property is not already set.
  122. */
  123. private function createWith(ResourceMetadata $resourceMetadata, string $property, $value): ResourceMetadata
  124. {
  125. $upperProperty = ucfirst($property);
  126. $getter = "get$upperProperty";
  128. if (null !== $resourceMetadata->{$getter}()) {
  129. return $resourceMetadata;
  130. }
  132. if (null === $value) {
  133. return $resourceMetadata;
  134. }
  136. $wither = "with$upperProperty";
  138. return $resourceMetadata->{$wither}($value);
  139. }
  140. }