vendor/api-platform/core/src/Core/Bridge/Symfony/Routing/IriConverter.php line 56

  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\Bridge\Symfony\Routing;
  16. use ApiPlatform\Core\Api\IdentifiersExtractor;
  17. use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
  18. use ApiPlatform\Core\Api\IriConverterInterface;
  19. use ApiPlatform\Core\Api\OperationType;
  20. use ApiPlatform\Core\Api\ResourceClassResolverInterface;
  21. use ApiPlatform\Core\Api\UrlGeneratorInterface;
  22. use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
  23. use ApiPlatform\Core\DataProvider\OperationDataProviderTrait;
  24. use ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface;
  25. use ApiPlatform\Core\Identifier\CompositeIdentifierParser;
  26. use ApiPlatform\Core\Identifier\IdentifierConverterInterface;
  27. use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
  28. use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
  29. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  30. use ApiPlatform\Exception\InvalidArgumentException;
  31. use ApiPlatform\Exception\InvalidIdentifierException;
  32. use ApiPlatform\Exception\ItemNotFoundException;
  33. use ApiPlatform\Exception\RuntimeException;
  34. use ApiPlatform\Symfony\Routing\IriConverter as NewIriConverter;
  35. use ApiPlatform\Util\AttributesExtractor;
  36. use ApiPlatform\Util\ResourceClassInfoTrait;
  37. use Symfony\Component\PropertyAccess\PropertyAccess;
  38. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  39. use Symfony\Component\Routing\Exception\ExceptionInterface as RoutingExceptionInterface;
  40. use Symfony\Component\Routing\RouterInterface;
  42. /**
  43.  * {@inheritdoc}
  44.  *
  45.  * @author Kévin Dunglas <dunglas@gmail.com>
  46.  */
  47. final class IriConverter implements IriConverterInterface
  48. {
  49.     use OperationDataProviderTrait;
  50.     use ResourceClassInfoTrait;
  52.     private $routeNameResolver;
  53.     private $router;
  54.     private $identifiersExtractor;
  56.     public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ItemDataProviderInterface $itemDataProvider, RouteNameResolverInterface $routeNameResolver, RouterInterface $router, PropertyAccessorInterface $propertyAccessor = null, IdentifiersExtractorInterface $identifiersExtractor = null, SubresourceDataProviderInterface $subresourceDataProvider = null, IdentifierConverterInterface $identifierConverter = null, ResourceClassResolverInterface $resourceClassResolver = null, ResourceMetadataFactoryInterface $resourceMetadataFactory = null)
  57.     {
  58.         $this->itemDataProvider = $itemDataProvider;
  59.         $this->routeNameResolver = $routeNameResolver;
  60.         $this->router = $router;
  61.         $this->subresourceDataProvider = $subresourceDataProvider;
  62.         $this->identifierConverter = $identifierConverter;
  63.         $this->resourceClassResolver = $resourceClassResolver;
  64.         $this->identifiersExtractor = $identifiersExtractor ?: new IdentifiersExtractor($propertyNameCollectionFactory, $propertyMetadataFactory, $propertyAccessor ?? PropertyAccess::createPropertyAccessor());
  65.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  67.         trigger_deprecation('api-platform/core', '2.7', sprintf('The service "%s" is deprecated, use %s instead.', self::class, NewIriConverter::class));
  68.     }
  70.     /**
  71.      * {@inheritdoc}
  72.      *
  73.      * @return object
  74.      */
  75.     public function getItemFromIri(string $iri, array $context = [])
  76.     {
  77.         try {
  78.             $parameters = $this->router->match($iri);
  79.         } catch (RoutingExceptionInterface $e) {
  80.             throw new InvalidArgumentException(sprintf('No route matches "%s".', $iri), $e->getCode(), $e);
  81.         }
  83.         if (!isset($parameters['_api_resource_class'])) {
  84.             throw new InvalidArgumentException(sprintf('No resource associated to "%s".', $iri));
  85.         }
  87.         if (isset($parameters['_api_collection_operation_name'])) {
  88.             throw new InvalidArgumentException(sprintf('The iri "%s" references a collection not an item.', $iri));
  89.         }
  91.         $attributes = AttributesExtractor::extractAttributes($parameters);
  93.         try {
  94.             $identifiers = $this->extractIdentifiers($parameters, $attributes);
  95.         } catch (InvalidIdentifierException $e) {
  96.             throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e);
  97.         }
  99.         if ($this->identifierConverter) {
  100.             $context[IdentifierConverterInterface::HAS_IDENTIFIER_CONVERTER] = true;
  101.         }
  103.         if (isset($attributes['subresource_operation_name'])) {
  104.             if (($item = $this->getSubresourceData($identifiers, $attributes, $context)) && !\is_array($item)) {
  105.                 return $item;
  106.             }
  108.             throw new ItemNotFoundException(sprintf('Item not found for "%s".', $iri));
  109.         }
  111.         if ($item = $this->getItemData($identifiers, $attributes, $context)) {
  112.             return $item;
  113.         }
  115.         throw new ItemNotFoundException(sprintf('Item not found for "%s".', $iri));
  116.     }
  118.     /**
  119.      * {@inheritdoc}
  120.      */
  121.     public function getIriFromItem($item, int $referenceType = null): string
  122.     {
  123.         $resourceClass = $this->getResourceClass($item, true);
  125.         try {
  126.             $identifiers = $this->identifiersExtractor->getIdentifiersFromItem($item);
  127.         } catch (RuntimeException $e) {
  128.             throw new InvalidArgumentException(sprintf('Unable to generate an IRI for the item of type "%s"', $resourceClass), $e->getCode(), $e);
  129.         }
  131.         return $this->getItemIriFromResourceClass($resourceClass, $identifiers, $this->getReferenceType($resourceClass, $referenceType));
  132.     }
  134.     /**
  135.      * {@inheritdoc}
  136.      */
  137.     public function getIriFromResourceClass(string $resourceClass, int $referenceType = null): string
  138.     {
  139.         try {
  140.             return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::COLLECTION), [], $this->getReferenceType($resourceClass, $referenceType));
  141.         } catch (RoutingExceptionInterface $e) {
  142.             throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e);
  143.         }
  144.     }
  146.     /**
  147.      * {@inheritdoc}
  148.      */
  149.     public function getItemIriFromResourceClass(string $resourceClass, array $identifiers, int $referenceType = null): string
  150.     {
  151.         $routeName = $this->routeNameResolver->getRouteName($resourceClass, OperationType::ITEM);
  152.         $metadata = $this->resourceMetadataFactory->create($resourceClass);
  154.         if (\count($identifiers) > 1 && true === $metadata->getAttribute('composite_identifier', true)) {
  155.             $identifiers = ['id' => CompositeIdentifierParser::stringify($identifiers)];
  156.         }
  158.         try {
  159.             return $this->router->generate($routeName, $identifiers, $this->getReferenceType($resourceClass, $referenceType));
  160.         } catch (RoutingExceptionInterface $e) {
  161.             throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e);
  162.         }
  163.     }
  165.     /**
  166.      * {@inheritdoc}
  167.      */
  168.     public function getSubresourceIriFromResourceClass(string $resourceClass, array $context, int $referenceType = null): string
  169.     {
  170.         try {
  171.             return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::SUBRESOURCE, $context), $context['subresource_identifiers'], $this->getReferenceType($resourceClass, $referenceType));
  172.         } catch (RoutingExceptionInterface $e) {
  173.             throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e);
  174.         }
  175.     }
  177.     private function getReferenceType(string $resourceClass, ?int $referenceType): ?int
  178.     {
  179.         if (null === $referenceType && null !== $this->resourceMetadataFactory) {
  180.             $metadata = $this->resourceMetadataFactory->create($resourceClass);
  181.             $referenceType = $metadata->getAttribute('url_generation_strategy');
  182.         }
  184.         return $referenceType ?? UrlGeneratorInterface::ABS_PATH;
  185.     }
  186. }