vendor/api-platform/core/src/Core/Api/IdentifiersExtractor.php line 37

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\Api;
  16. use ApiPlatform\Api\IdentifiersExtractor as NewIdentifiersExtractor;
  17. use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
  18. use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
  19. use ApiPlatform\Exception\RuntimeException;
  20. use ApiPlatform\Util\ResourceClassInfoTrait;
  21. use Symfony\Component\PropertyAccess\PropertyAccess;
  22. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  24. /**
  25. * {@inheritdoc}
  26. *
  27. * @author Antoine Bluchet <soyuka@gmail.com>
  28. */
  29. final class IdentifiersExtractor implements IdentifiersExtractorInterface
  30. {
  31. use ResourceClassInfoTrait;
  33. private $propertyNameCollectionFactory;
  34. private $propertyMetadataFactory;
  35. private $propertyAccessor;
  37. public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, PropertyAccessorInterface $propertyAccessor = null, ResourceClassResolverInterface $resourceClassResolver = null, bool $metadataBackwardCompatibilityLayer = null)
  38. {
  39. $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
  40. $this->propertyMetadataFactory = $propertyMetadataFactory;
  41. $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
  42. $this->resourceClassResolver = $resourceClassResolver;
  44. if (null === $this->resourceClassResolver) {
  45. @trigger_error(sprintf('Not injecting %s in the IdentifiersExtractor might introduce cache issues with object identifiers.', ResourceClassResolverInterface::class), \E_USER_DEPRECATED);
  46. }
  48. if ($metadataBackwardCompatibilityLayer) {
  49. trigger_deprecation('api-platform/core', '2.7', sprintf('The service "%s" is deprecated, use %s instead.', self::class, NewIdentifiersExtractor::class));
  50. }
  51. }
  53. /**
  54. * {@inheritdoc}
  55. */
  56. public function getIdentifiersFromResourceClass(string $resourceClass): array
  57. {
  58. $identifiers = [];
  59. foreach ($properties = $this->propertyNameCollectionFactory->create($resourceClass) as $property) {
  60. if ($this->propertyMetadataFactory->create($resourceClass, $property)->isIdentifier() ?? false) {
  61. $identifiers[] = $property;
  62. }
  63. }
  65. if (!$identifiers) {
  66. if (\in_array('id', iterator_to_array($properties), true)) {
  67. return ['id'];
  68. }
  70. throw new RuntimeException(sprintf('No identifier defined in "%s". You should add #[\ApiPlatform\Core\Annotation\ApiProperty(identifier: true)]" on the property identifying the resource."', $resourceClass));
  71. }
  73. return $identifiers;
  74. }
  76. /**
  77. * {@inheritdoc}
  78. */
  79. public function getIdentifiersFromItem($item): array
  80. {
  81. $identifiers = [];
  82. $resourceClass = $this->getResourceClass($item, true);
  83. $identifierProperties = $this->getIdentifiersFromResourceClass($resourceClass);
  85. foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $propertyName) {
  86. if (!\in_array($propertyName, $identifierProperties, true)) {
  87. continue;
  88. }
  90. $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $propertyName);
  91. $identifier = $identifiers[$propertyName] = $this->propertyAccessor->getValue($item, $propertyName);
  93. if (!\is_object($identifier)) {
  94. continue;
  95. }
  97. if (null === $relatedResourceClass = $this->getResourceClass($identifier)) {
  98. continue;
  99. }
  101. $relatedItem = $identifier;
  102. unset($identifiers[$propertyName]);
  103. foreach ($this->propertyNameCollectionFactory->create($relatedResourceClass) as $relatedPropertyName) {
  104. $propertyMetadata = $this->propertyMetadataFactory->create($relatedResourceClass, $relatedPropertyName);
  105. if ($propertyMetadata->isIdentifier()) {
  106. if (isset($identifiers[$propertyName])) {
  107. throw new RuntimeException(sprintf('Composite identifiers not supported in "%s" through relation "%s" of "%s" used as identifier', $relatedResourceClass, $propertyName, $resourceClass));
  108. }
  110. $identifiers[$propertyName] = $this->propertyAccessor->getValue($relatedItem, $relatedPropertyName);
  111. }
  112. }
  114. if (!isset($identifiers[$propertyName])) {
  115. throw new RuntimeException(sprintf('No identifier found in "%s" through relation "%s" of "%s" used as identifier', $relatedResourceClass, $propertyName, $resourceClass));
  116. }
  117. }
  119. return $identifiers;
  120. }
  121. }