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

  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.  * @author Antoine Bluchet <soyuka@gmail.com>
  26.  */
  27. final class IdentifiersExtractor implements IdentifiersExtractorInterface
  28. {
  29.     use ResourceClassInfoTrait;
  31.     private $propertyNameCollectionFactory;
  32.     private $propertyMetadataFactory;
  33.     private $propertyAccessor;
  35.     public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, PropertyAccessorInterface $propertyAccessor = null, ResourceClassResolverInterface $resourceClassResolver = null, bool $metadataBackwardCompatibilityLayer = null)
  36.     {
  37.         $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
  38.         $this->propertyMetadataFactory = $propertyMetadataFactory;
  39.         $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
  40.         $this->resourceClassResolver = $resourceClassResolver;
  42.         if (null === $this->resourceClassResolver) {
  43.             @trigger_error(sprintf('Not injecting %s in the IdentifiersExtractor might introduce cache issues with object identifiers.', ResourceClassResolverInterface::class), \E_USER_DEPRECATED);
  44.         }
  46.         if ($metadataBackwardCompatibilityLayer) {
  47.             trigger_deprecation('api-platform/core', '2.7', sprintf('The service "%s" is deprecated, use %s instead.', self::class, NewIdentifiersExtractor::class));
  48.         }
  49.     }
  51.     public function getIdentifiersFromResourceClass(string $resourceClass): array
  52.     {
  53.         $identifiers = [];
  54.         foreach ($properties = $this->propertyNameCollectionFactory->create($resourceClass) as $property) {
  55.             if ($this->propertyMetadataFactory->create($resourceClass, $property)->isIdentifier() ?? false) {
  56.                 $identifiers[] = $property;
  57.             }
  58.         }
  60.         if (!$identifiers) {
  61.             if (\in_array('id', iterator_to_array($properties), true)) {
  62.                 return ['id'];
  63.             }
  65.             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));
  66.         }
  68.         return $identifiers;
  69.     }
  71.     public function getIdentifiersFromItem($item): array
  72.     {
  73.         $identifiers = [];
  74.         $resourceClass = $this->getResourceClass($item, true);
  75.         $identifierProperties = $this->getIdentifiersFromResourceClass($resourceClass);
  77.         foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $propertyName) {
  78.             if (!\in_array($propertyName, $identifierProperties, true)) {
  79.                 continue;
  80.             }
  82.             $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $propertyName);
  83.             $identifier = $identifiers[$propertyName] = $this->propertyAccessor->getValue($item, $propertyName);
  85.             if (!\is_object($identifier)) {
  86.                 continue;
  87.             }
  89.             if (null === $relatedResourceClass = $this->getResourceClass($identifier)) {
  90.                 continue;
  91.             }
  93.             $relatedItem = $identifier;
  94.             unset($identifiers[$propertyName]);
  95.             foreach ($this->propertyNameCollectionFactory->create($relatedResourceClass) as $relatedPropertyName) {
  96.                 $propertyMetadata = $this->propertyMetadataFactory->create($relatedResourceClass, $relatedPropertyName);
  97.                 if ($propertyMetadata->isIdentifier()) {
  98.                     if (isset($identifiers[$propertyName])) {
  99.                         throw new RuntimeException(sprintf('Composite identifiers not supported in "%s" through relation "%s" of "%s" used as identifier', $relatedResourceClass, $propertyName, $resourceClass));
  100.                     }
  102.                     $identifiers[$propertyName] = $this->propertyAccessor->getValue($relatedItem, $relatedPropertyName);
  103.                 }
  104.             }
  106.             if (!isset($identifiers[$propertyName])) {
  107.                 throw new RuntimeException(sprintf('No identifier found in "%s" through relation "%s" of "%s" used as identifier', $relatedResourceClass, $propertyName, $resourceClass));
  108.             }
  109.         }
  111.         return $identifiers;
  112.     }
  113. }