vendor/api-platform/core/src/Symfony/Routing/ApiLoader.php line 74

  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\Symfony\Routing;
  16. use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
  17. use ApiPlatform\Core\Api\OperationType;
  18. use ApiPlatform\Core\Bridge\Symfony\Routing\RouteNameGenerator;
  19. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  20. use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
  21. use ApiPlatform\Core\Operation\Factory\SubresourceOperationFactoryInterface;
  22. use ApiPlatform\Exception\InvalidResourceException;
  23. use ApiPlatform\Exception\RuntimeException;
  24. use ApiPlatform\Metadata\CollectionOperationInterface;
  25. use ApiPlatform\Metadata\HttpOperation;
  26. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  27. use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
  28. use ApiPlatform\PathResolver\OperationPathResolverInterface;
  29. use Symfony\Component\Config\FileLocator;
  30. use Symfony\Component\Config\Loader\Loader;
  31. use Symfony\Component\Config\Resource\DirectoryResource;
  32. use Symfony\Component\DependencyInjection\ContainerInterface;
  33. use Symfony\Component\HttpKernel\KernelInterface;
  34. use Symfony\Component\Routing\Loader\XmlFileLoader;
  35. use Symfony\Component\Routing\Route;
  36. use Symfony\Component\Routing\RouteCollection;
  38. /**
  39.  * Loads Resources.
  40.  *
  41.  * @author Kévin Dunglas <dunglas@gmail.com>
  42.  */
  43. final class ApiLoader extends Loader
  44. {
  45.     /**
  46.      * @deprecated since version 2.1, to be removed in 3.0. Use {@see RouteNameGenerator::ROUTE_NAME_PREFIX} instead.
  47.      */
  48.     public const ROUTE_NAME_PREFIX = 'api_';
  49.     public const DEFAULT_ACTION_PATTERN = 'api_platform.action.';
  51.     private $fileLoader;
  52.     private $resourceNameCollectionFactory;
  53.     private $resourceMetadataFactory;
  54.     private $operationPathResolver;
  55.     private $container;
  56.     private $formats;
  57.     private $resourceClassDirectories;
  58.     private $subresourceOperationFactory;
  59.     private $graphqlEnabled;
  60.     private $graphiQlEnabled;
  61.     private $graphQlPlaygroundEnabled;
  62.     private $entrypointEnabled;
  63.     private $docsEnabled;
  64.     private $identifiersExtractor;
  66.     public function __construct(KernelInterface $kernel, ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, $resourceMetadataFactory, OperationPathResolverInterface $operationPathResolver, ContainerInterface $container, array $formats, array $resourceClassDirectories = [], SubresourceOperationFactoryInterface $subresourceOperationFactory = null, bool $graphqlEnabled = false, bool $entrypointEnabled = true, bool $docsEnabled = true, bool $graphiQlEnabled = false, bool $graphQlPlaygroundEnabled = false, IdentifiersExtractorInterface $identifiersExtractor = null)
  67.     {
  68.         /** @var string[]|string $paths */
  69.         $paths = $kernel->locateResource('@ApiPlatformBundle/Resources/config/routing');
  70.         $this->fileLoader = new XmlFileLoader(new FileLocator($paths));
  71.         $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
  73.         if ($resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  74.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  75.         }
  76.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  77.         $this->operationPathResolver = $operationPathResolver;
  78.         $this->container = $container;
  79.         $this->formats = $formats;
  80.         $this->resourceClassDirectories = $resourceClassDirectories;
  81.         $this->subresourceOperationFactory = $subresourceOperationFactory;
  82.         $this->graphqlEnabled = $graphqlEnabled;
  83.         $this->graphiQlEnabled = $graphiQlEnabled;
  84.         $this->graphQlPlaygroundEnabled = $graphQlPlaygroundEnabled;
  85.         $this->entrypointEnabled = $entrypointEnabled;
  86.         $this->docsEnabled = $docsEnabled;
  87.         $this->identifiersExtractor = $identifiersExtractor;
  88.     }
  90.     /**
  91.      * {@inheritdoc}
  92.      */
  93.     public function load($data, $type = null): RouteCollection
  94.     {
  95.         $routeCollection = new RouteCollection();
  96.         foreach ($this->resourceClassDirectories as $directory) {
  97.             $routeCollection->addResource(new DirectoryResource($directory, '/\.php$/'));
  98.         }
  100.         $this->loadExternalFiles($routeCollection);
  101.         foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
  102.             if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  103.                 $this->loadLegacyMetadata($routeCollection, $resourceClass);
  104.                 $this->loadLegacySubresources($routeCollection, $resourceClass);
  105.                 continue;
  106.             }
  108.             foreach ($this->resourceMetadataFactory->create($resourceClass) as $resourceMetadata) {
  109.                 foreach ($resourceMetadata->getOperations() as $operationName => $operation) {
  110.                     if ($operation->getRouteName()) {
  111.                         continue;
  112.                     }
  114.                     if (SkolemIriConverter::$skolemUriTemplate === $operation->getUriTemplate()) {
  115.                         continue;
  116.                     }
  118.                     $legacyDefaults = [];
  120.                     if ($operation->getExtraProperties()['is_legacy_subresource'] ?? false) {
  121.                         $legacyDefaults['_api_subresource_operation_name'] = $operationName;
  122.                         $legacyDefaults['_api_subresource_context'] = [
  123.                             'property' => $operation->getExtraProperties()['legacy_subresource_property'],
  124.                             'identifiers' => $operation->getExtraProperties()['legacy_subresource_identifiers'],
  125.                             'collection' => $operation instanceof CollectionOperationInterface,
  126.                             'operationId' => $operation->getExtraProperties()['legacy_subresource_operation_name'] ?? null,
  127.                         ];
  128.                         $legacyDefaults['_api_identifiers'] = $operation->getExtraProperties()['legacy_subresource_identifiers'];
  129.                     } elseif ($operation->getExtraProperties()['is_legacy_resource_metadata'] ?? false) {
  130.                         $legacyDefaults[sprintf('_api_%s_operation_name', $operation instanceof CollectionOperationInterface ? OperationType::COLLECTION : OperationType::ITEM)] = $operationName;
  131.                         $legacyDefaults['_api_identifiers'] = [];
  132.                         // Legacy identifiers
  133.                         $hasCompositeIdentifier = false;
  134.                         foreach ($operation->getUriVariables() ?? [] as $parameterName => $identifiedBy) {
  135.                             $hasCompositeIdentifier = $identifiedBy->getCompositeIdentifier();
  136.                             foreach ($identifiedBy->getIdentifiers() ?? [] as $identifier) {
  137.                                 $legacyDefaults['_api_identifiers'][] = $identifier;
  138.                             }
  139.                         }
  140.                         $legacyDefaults['_api_has_composite_identifier'] = $hasCompositeIdentifier;
  141.                     }
  143.                     $path = ($operation->getRoutePrefix() ?? '').$operation->getUriTemplate();
  144.                     foreach ($operation->getUriVariables() ?? [] as $parameterName => $link) {
  145.                         if (!$expandedValue = $link->getExpandedValue()) {
  146.                             continue;
  147.                         }
  149.                         $path = str_replace(sprintf('{%s}', $parameterName), $expandedValue, $path);
  150.                     }
  152.                     $route = new Route(
  153.                         $path,
  154.                         $legacyDefaults + [
  155.                             '_controller' => $operation->getController() ?? 'api_platform.action.placeholder',
  156.                             '_format' => null,
  157.                             '_stateless' => $operation->getStateless(),
  158.                             '_api_resource_class' => $resourceClass,
  159.                             '_api_operation_name' => $operationName,
  160.                         ] + ($operation->getDefaults() ?? []),
  161.                         $operation->getRequirements() ?? [],
  162.                         $operation->getOptions() ?? [],
  163.                         $operation->getHost() ?? '',
  164.                         $operation->getSchemes() ?? [],
  165.                         [$operation->getMethod() ?? HttpOperation::METHOD_GET],
  166.                         $operation->getCondition() ?? ''
  167.                     );
  169.                     $routeCollection->add($operationName, $route);
  170.                 }
  171.             }
  172.         }
  174.         return $routeCollection;
  175.     }
  177.     /**
  178.      * {@inheritdoc}
  179.      */
  180.     public function supports($resource, $type = null): bool
  181.     {
  182.         return 'api_platform' === $type;
  183.     }
  185.     /**
  186.      * Load external files.
  187.      */
  188.     private function loadExternalFiles(RouteCollection $routeCollection): void
  189.     {
  190.         $routeCollection->addCollection($this->fileLoader->load('genid.xml'));
  192.         if ($this->entrypointEnabled) {
  193.             $routeCollection->addCollection($this->fileLoader->load('api.xml'));
  194.         }
  196.         if ($this->docsEnabled) {
  197.             $routeCollection->addCollection($this->fileLoader->load('docs.xml'));
  198.         }
  200.         if ($this->graphqlEnabled) {
  201.             $graphqlCollection = $this->fileLoader->load('graphql/graphql.xml');
  202.             $graphqlCollection->addDefaults(['_graphql' => true]);
  203.             $routeCollection->addCollection($graphqlCollection);
  204.         }
  206.         if ($this->graphiQlEnabled) {
  207.             $graphiQlCollection = $this->fileLoader->load('graphql/graphiql.xml');
  208.             $graphiQlCollection->addDefaults(['_graphql' => true]);
  209.             $routeCollection->addCollection($graphiQlCollection);
  210.         }
  212.         if ($this->graphQlPlaygroundEnabled) {
  213.             $graphQlPlaygroundCollection = $this->fileLoader->load('graphql/graphql_playground.xml');
  214.             $graphQlPlaygroundCollection->addDefaults(['_graphql' => true]);
  215.             $routeCollection->addCollection($graphQlPlaygroundCollection);
  216.         }
  218.         if (isset($this->formats['jsonld'])) {
  219.             $routeCollection->addCollection($this->fileLoader->load('jsonld.xml'));
  220.         }
  221.     }
  223.     /**
  224.      * TODO: remove in 3.0.
  225.      */
  226.     private function loadLegacyMetadata(RouteCollection $routeCollection, string $resourceClass)
  227.     {
  228.         $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  229.         $resourceShortName = $resourceMetadata->getShortName();
  231.         if (null === $resourceShortName) {
  232.             throw new InvalidResourceException(sprintf('Resource %s has no short name defined.', $resourceClass));
  233.         }
  235.         if (null !== $collectionOperations = $resourceMetadata->getCollectionOperations()) {
  236.             foreach ($collectionOperations as $operationName => $operation) {
  237.                 $this->addRoute($routeCollection, $resourceClass, $operationName, $operation, $resourceMetadata, OperationType::COLLECTION);
  238.             }
  239.         }
  241.         if (null !== $itemOperations = $resourceMetadata->getItemOperations()) {
  242.             foreach ($itemOperations as $operationName => $operation) {
  243.                 $this->addRoute($routeCollection, $resourceClass, $operationName, $operation, $resourceMetadata, OperationType::ITEM);
  244.             }
  245.         }
  246.     }
  248.     /**
  249.      * TODO: remove in 3.0.
  250.      */
  251.     private function loadLegacySubresources(RouteCollection $routeCollection, string $resourceClass)
  252.     {
  253.         if (null === $this->subresourceOperationFactory) {
  254.             return;
  255.         }
  257.         foreach ($this->subresourceOperationFactory->create($resourceClass) as $operationId => $operation) {
  258.             if (null === $controller = $operation['controller'] ?? null) {
  259.                 $controller = self::DEFAULT_ACTION_PATTERN.'get_subresource';
  261.                 if (!$this->container->has($controller)) {
  262.                     throw new RuntimeException(sprintf('There is no builtin action for the %s %s operation. You need to define the controller yourself.', OperationType::SUBRESOURCE, 'GET'));
  263.                 }
  264.             }
  266.             $routeCollection->add($operation['route_name'], new Route(
  267.                 $operation['path'],
  268.                 [
  269.                     '_controller' => $controller,
  270.                     '_format' => $operation['defaults']['_format'] ?? null,
  271.                     '_stateless' => $operation['stateless'] ?? null,
  272.                     '_api_resource_class' => $operation['resource_class'],
  273.                     '_api_identifiers' => $operation['identifiers'],
  274.                     '_api_has_composite_identifier' => false,
  275.                     '_api_subresource_operation_name' => $operation['route_name'],
  276.                     '_api_subresource_context' => [
  277.                         'property' => $operation['property'],
  278.                         'identifiers' => $operation['identifiers'],
  279.                         'collection' => $operation['collection'],
  280.                         'operationId' => $operationId,
  281.                     ],
  282.                 ] + ($operation['defaults'] ?? []),
  283.                 $operation['requirements'] ?? [],
  284.                 $operation['options'] ?? [],
  285.                 $operation['host'] ?? '',
  286.                 $operation['schemes'] ?? [],
  287.                 ['GET'],
  288.                 $operation['condition'] ?? ''
  289.             ));
  290.         }
  291.     }
  293.     /**
  294.      * Creates and adds a route for the given operation to the route collection.
  295.      *
  296.      * @throws RuntimeException
  297.      */
  298.     private function addRoute(RouteCollection $routeCollection, string $resourceClass, string $operationName, array $operation, ResourceMetadata $resourceMetadata, string $operationType): void
  299.     {
  300.         $resourceShortName = $resourceMetadata->getShortName();
  302.         if (isset($operation['route_name'])) {
  303.             if (!isset($operation['method'])) {
  304.                 @trigger_error(sprintf('Not setting the "method" attribute is deprecated and will not be supported anymore in API Platform 3.0, set it for the %s operation "%s" of the class "%s".', OperationType::COLLECTION === $operationType ? 'collection' : 'item', $operationName, $resourceClass), \E_USER_DEPRECATED);
  305.             }
  307.             return;
  308.         }
  310.         if (!isset($operation['method'])) {
  311.             throw new RuntimeException(sprintf('Either a "route_name" or a "method" operation attribute must exist for the operation "%s" of the resource "%s".', $operationName, $resourceClass));
  312.         }
  314.         if (null === $controller = $operation['controller'] ?? null) {
  315.             $controller = sprintf('%s%s_%s', self::DEFAULT_ACTION_PATTERN, strtolower($operation['method']), $operationType);
  317.             if (!$this->container->has($controller)) {
  318.                 throw new RuntimeException(sprintf('There is no builtin action for the %s %s operation. You need to define the controller yourself.', $operationType, $operation['method']));
  319.             }
  320.         }
  322.         if ($resourceMetadata->getItemOperations()) {
  323.             $operation['identifiers'] = (array) ($operation['identifiers'] ?? $resourceMetadata->getAttribute('identifiers', $this->identifiersExtractor ? $this->identifiersExtractor->getIdentifiersFromResourceClass($resourceClass) : ['id']));
  324.         }
  326.         $operation['has_composite_identifier'] = isset($operation['identifiers']) && \count($operation['identifiers']) > 1 ? $resourceMetadata->getAttribute('composite_identifier', true) : false;
  327.         $path = trim(trim($resourceMetadata->getAttribute('route_prefix', '')), '/');
  328.         $path .= $this->operationPathResolver->resolveOperationPath($resourceShortName, $operation, $operationType, $operationName);
  330.         $route = new Route(
  331.             $path,
  332.             [
  333.                 '_controller' => $controller,
  334.                 '_format' => $operation['defaults']['_format'] ?? null,
  335.                 '_stateless' => $operation['stateless'] ?? null,
  336.                 '_api_resource_class' => $resourceClass,
  337.                 '_api_identifiers' => $operation['identifiers'] ?? [],
  338.                 '_api_has_composite_identifier' => $operation['has_composite_identifier'] ?? true,
  339.                 '_api_exception_to_status' => $operation['exception_to_status'] ?? $resourceMetadata->getAttribute('exception_to_status') ?? [],
  340.                 '_api_operation_name' => RouteNameGenerator::generate($operationName, $resourceShortName, $operationType),
  341.                 sprintf('_api_%s_operation_name', $operationType) => $operationName,
  342.             ] + ($operation['defaults'] ?? []),
  343.             $operation['requirements'] ?? [],
  344.             $operation['options'] ?? [],
  345.             $operation['host'] ?? '',
  346.             $operation['schemes'] ?? [],
  347.             [$operation['method']],
  348.             $operation['condition'] ?? ''
  349.         );
  351.         $routeCollection->add(RouteNameGenerator::generate($operationName, $resourceShortName, $operationType), $route);
  352.     }
  353. }
  355. class_alias(ApiLoader::class, \ApiPlatform\Core\Bridge\Symfony\Routing\ApiLoader::class);