vendor/api-platform/core/src/Core/Metadata/Resource/Factory/ExtractorResourceMetadataFactory.php line 32

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\Exception\ResourceClassNotFoundException;
  17. use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
  18. use ApiPlatform\Metadata\Extractor\ResourceExtractorInterface;
  20. /**
  21. * Creates resource's metadata using an extractor.
  22. *
  23. * @author Kévin Dunglas <dunglas@gmail.com>
  24. * @author Antoine Bluchet <soyuka@gmail.com>
  25. */
  26. final class ExtractorResourceMetadataFactory implements ResourceMetadataFactoryInterface
  27. {
  28. private $extractor;
  29. private $decorated;
  30. private $defaults;
  32. public function __construct(ResourceExtractorInterface $extractor, ResourceMetadataFactoryInterface $decorated = null, array $defaults = [])
  33. {
  34. $this->extractor = $extractor;
  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. if (!(class_exists($resourceClass) || interface_exists($resourceClass)) || !$resource = $this->extractor->getResources()[$resourceClass] ?? false) {
  54. return $this->handleNotFound($parentResourceMetadata, $resourceClass);
  55. }
  57. $resource['description'] = $resource['description'] ?? $this->defaults['description'] ?? null;
  58. $resource['iri'] = $resource['iri'] ?? $this->defaults['iri'] ?? null;
  59. $resource['itemOperations'] = $resource['itemOperations'] ?? $this->defaults['item_operations'] ?? null;
  60. $resource['collectionOperations'] = $resource['collectionOperations'] ?? $this->defaults['collection_operations'] ?? null;
  61. $resource['graphql'] = $resource['graphql'] ?? $this->defaults['graphql'] ?? null;
  63. if (\array_key_exists('attributes', $resource) && (null !== $resource['attributes'] || [] !== $this->defaults['attributes'])) {
  64. $resource['attributes'] = (array) $resource['attributes'];
  65. foreach ($this->defaults['attributes'] as $key => $value) {
  66. if (!isset($resource['attributes'][$key])) {
  67. $resource['attributes'][$key] = $value;
  68. }
  69. }
  70. }
  72. return $this->update($parentResourceMetadata ?: new ResourceMetadata(), $resource);
  73. }
  75. /**
  76. * Returns the metadata from the decorated factory if available or throws an exception.
  77. *
  78. * @throws ResourceClassNotFoundException
  79. */
  80. private function handleNotFound(?ResourceMetadata $parentPropertyMetadata, string $resourceClass): ResourceMetadata
  81. {
  82. if (null !== $parentPropertyMetadata) {
  83. return $parentPropertyMetadata;
  84. }
  86. throw new ResourceClassNotFoundException(sprintf('Resource "%s" not found.', $resourceClass));
  87. }
  89. /**
  90. * Creates a new instance of metadata if the property is not already set.
  91. */
  92. private function update(ResourceMetadata $resourceMetadata, array $metadata): ResourceMetadata
  93. {
  94. foreach (['shortName', 'description', 'iri', 'itemOperations', 'collectionOperations', 'subresourceOperations', 'graphql', 'attributes'] as $property) {
  95. if (!\array_key_exists($property, $metadata) || null === $metadata[$property] || null !== $resourceMetadata->{'get'.ucfirst($property)}()) {
  96. continue;
  97. }
  99. $resourceMetadata = $resourceMetadata->{'with'.ucfirst($property)}($metadata[$property]);
  100. }
  102. return $resourceMetadata;
  103. }
  104. }