vendor/api-platform/core/src/Core/Metadata/Property/Factory/ExtractorPropertyMetadataFactory.php line 36

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\Exception\PropertyNotFoundException;
  17. use ApiPlatform\Core\Metadata\Extractor\ExtractorInterface;
  18. use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
  19. use ApiPlatform\Core\Metadata\Property\SubresourceMetadata;
  20. use ApiPlatform\Metadata\Extractor\ResourceExtractorInterface;
  21. use Symfony\Component\PropertyInfo\Type;
  23. /**
  24. * Creates properties's metadata using an extractor.
  25. *
  26. * @author Kévin Dunglas <dunglas@gmail.com>
  27. */
  28. final class ExtractorPropertyMetadataFactory implements PropertyMetadataFactoryInterface
  29. {
  30. private $extractor;
  31. private $decorated;
  33. /**
  34. * @param ResourceExtractorInterface|ExtractorInterface $extractor
  35. */
  36. public function __construct($extractor, PropertyMetadataFactoryInterface $decorated = null)
  37. {
  38. $this->extractor = $extractor;
  39. $this->decorated = $decorated;
  40. }
  42. /**
  43. * {@inheritdoc}
  44. */
  45. public function create(string $resourceClass, string $property, array $options = []): PropertyMetadata
  46. {
  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. $isInterface = interface_exists($resourceClass);
  58. if (
  59. !property_exists($resourceClass, $property) && !$isInterface ||
  60. null === ($propertyMetadata = $this->extractor->getResources()[$resourceClass]['properties'][$property] ?? null)
  61. ) {
  62. return $this->handleNotFound($parentPropertyMetadata, $resourceClass, $property);
  63. }
  65. if ($parentPropertyMetadata) {
  66. return $this->update($parentPropertyMetadata, $propertyMetadata);
  67. }
  69. return ($metadata = new PropertyMetadata(
  70. null,
  71. $propertyMetadata['description'],
  72. $propertyMetadata['readable'],
  73. $propertyMetadata['writable'],
  74. $propertyMetadata['readableLink'],
  75. $propertyMetadata['writableLink'],
  76. $propertyMetadata['required'],
  77. $propertyMetadata['identifier'],
  78. $propertyMetadata['iri'],
  79. null,
  80. $propertyMetadata['attributes']
  81. ))->withSubresource($this->createSubresourceMetadata($propertyMetadata['subresource'], $metadata));
  82. }
  84. /**
  85. * Returns the metadata from the decorated factory if available or throws an exception.
  86. *
  87. * @throws PropertyNotFoundException
  88. */
  89. private function handleNotFound(?PropertyMetadata $parentPropertyMetadata, string $resourceClass, string $property): PropertyMetadata
  90. {
  91. if ($parentPropertyMetadata) {
  92. return $parentPropertyMetadata;
  93. }
  95. throw new PropertyNotFoundException(sprintf('Property "%s" of the resource class "%s" not found.', $property, $resourceClass));
  96. }
  98. /**
  99. * Creates a new instance of metadata if the property is not already set.
  100. */
  101. private function update(PropertyMetadata $propertyMetadata, array $metadata): PropertyMetadata
  102. {
  103. $metadataAccessors = [
  104. 'description' => 'get',
  105. 'readable' => 'is',
  106. 'writable' => 'is',
  107. 'writableLink' => 'is',
  108. 'readableLink' => 'is',
  109. 'required' => 'is',
  110. 'identifier' => 'is',
  111. 'iri' => 'get',
  112. 'attributes' => 'get',
  113. ];
  115. foreach ($metadataAccessors as $metadataKey => $accessorPrefix) {
  116. if (null === $metadata[$metadataKey]) {
  117. continue;
  118. }
  120. $propertyMetadata = $propertyMetadata->{'with'.ucfirst($metadataKey)}($metadata[$metadataKey]);
  121. }
  123. if ($propertyMetadata->hasSubresource()) {
  124. return $propertyMetadata;
  125. }
  127. return $propertyMetadata->withSubresource($this->createSubresourceMetadata($metadata['subresource'], $propertyMetadata));
  128. }
  130. /**
  131. * Creates a SubresourceMetadata.
  132. *
  133. * @param bool|array|null $subresource the subresource metadata coming from XML or YAML
  134. * @param PropertyMetadata $propertyMetadata the current property metadata
  135. */
  136. private function createSubresourceMetadata($subresource, PropertyMetadata $propertyMetadata): ?SubresourceMetadata
  137. {
  138. if (!$subresource) {
  139. return null;
  140. }
  142. $type = $propertyMetadata->getType();
  143. $maxDepth = \is_array($subresource) ? $subresource['maxDepth'] ?? null : null;
  145. if (null !== $type) {
  146. $isCollection = $type->isCollection();
  147. if (
  148. $isCollection &&
  149. $collectionValueType = method_exists(Type::class, 'getCollectionValueTypes') ? ($type->getCollectionValueTypes()[0] ?? null) : $type->getCollectionValueType()
  150. ) {
  151. $resourceClass = $collectionValueType->getClassName();
  152. } else {
  153. $resourceClass = $type->getClassName();
  154. }
  155. } elseif (\is_array($subresource) && isset($subresource['resourceClass'])) {
  156. $resourceClass = $subresource['resourceClass'];
  157. $isCollection = $subresource['collection'] ?? true;
  158. } else {
  159. return null;
  160. }
  162. return new SubresourceMetadata($resourceClass, $isCollection, $maxDepth);
  163. }
  164. }