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.     public function load($data, $type = null): RouteCollection
  91.     {
  92.         $routeCollection = new RouteCollection();
  93.         foreach ($this->resourceClassDirectories as $directory) {
  94.             $routeCollection->addResource(new DirectoryResource($directory, '/\.php$/'));
  95.         }
  97.         $this->loadExternalFiles($routeCollection);
  98.         foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
  99.             if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  100.                 $this->loadLegacyMetadata($routeCollection, $resourceClass);
  101.                 $this->loadLegacySubresources($routeCollection, $resourceClass);
  102.                 continue;
  103.             }
  105.             foreach ($this->resourceMetadataFactory->create($resourceClass) as $resourceMetadata) {
  106.                 foreach ($resourceMetadata->getOperations() as $operationName => $operation) {
  107.                     if ($operation->getRouteName()) {
  108.                         continue;
  109.                     }
  111.                     if (SkolemIriConverter::$skolemUriTemplate === $operation->getUriTemplate()) {
  112.                         continue;
  113.                     }
  115.                     $legacyDefaults = [];
  117.                     if ($operation->getExtraProperties()['is_legacy_subresource'] ?? false) {
  118.                         $legacyDefaults['_api_subresource_operation_name'] = $operationName;
  119.                         $legacyDefaults['_api_subresource_context'] = [
  120.                             'property' => $operation->getExtraProperties()['legacy_subresource_property'],
  121.                             'identifiers' => $operation->getExtraProperties()['legacy_subresource_identifiers'],
  122.                             'collection' => $operation instanceof CollectionOperationInterface,
  123.                             'operationId' => $operation->getExtraProperties()['legacy_subresource_operation_name'] ?? null,
  124.                         ];
  125.                         $legacyDefaults['_api_identifiers'] = $operation->getExtraProperties()['legacy_subresource_identifiers'];
  126.                     } elseif ($operation->getExtraProperties()['is_legacy_resource_metadata'] ?? false) {
  127.                         $legacyDefaults[sprintf('_api_%s_operation_name', $operation instanceof CollectionOperationInterface ? OperationType::COLLECTION : OperationType::ITEM)] = $operationName;
  128.                         $legacyDefaults['_api_identifiers'] = [];
  129.                         // Legacy identifiers
  130.                         $hasCompositeIdentifier = false;
  131.                         foreach ($operation->getUriVariables() ?? [] as $parameterName => $identifiedBy) {
  132.                             $hasCompositeIdentifier = $identifiedBy->getCompositeIdentifier();
  133.                             foreach ($identifiedBy->getIdentifiers() ?? [] as $identifier) {
  134.                                 $legacyDefaults['_api_identifiers'][] = $identifier;
  135.                             }
  136.                         }
  137.                         $legacyDefaults['_api_has_composite_identifier'] = $hasCompositeIdentifier;
  138.                     }
  140.                     $path = ($operation->getRoutePrefix() ?? '').$operation->getUriTemplate();
  141.                     foreach ($operation->getUriVariables() ?? [] as $parameterName => $link) {
  142.                         if (!$expandedValue = $link->getExpandedValue()) {
  143.                             continue;
  144.                         }
  146.                         $path = str_replace(sprintf('{%s}', $parameterName), $expandedValue, $path);
  147.                     }
  149.                     $route = new Route(
  150.                         $path,
  151.                         $legacyDefaults + [
  152.                             '_controller' => $operation->getController() ?? 'api_platform.action.placeholder',
  153.                             '_format' => null,
  154.                             '_stateless' => $operation->getStateless(),
  155.                             '_api_resource_class' => $resourceClass,
  156.                             '_api_operation_name' => $operationName,
  157.                         ] + ($operation->getDefaults() ?? []),
  158.                         $operation->getRequirements() ?? [],
  159.                         $operation->getOptions() ?? [],
  160.                         $operation->getHost() ?? '',
  161.                         $operation->getSchemes() ?? [],
  162.                         [$operation->getMethod() ?? HttpOperation::METHOD_GET],
  163.                         $operation->getCondition() ?? ''
  164.                     );
  166.                     $routeCollection->add($operationName, $route);
  167.                 }
  168.             }
  169.         }
  171.         return $routeCollection;
  172.     }
  174.     public function supports($resource, $type = null): bool
  175.     {
  176.         return 'api_platform' === $type;
  177.     }
  179.     /**
  180.      * Load external files.
  181.      */
  182.     private function loadExternalFiles(RouteCollection $routeCollection): void
  183.     {
  184.         $routeCollection->addCollection($this->fileLoader->load('genid.xml'));
  186.         if ($this->entrypointEnabled) {
  187.             $routeCollection->addCollection($this->fileLoader->load('api.xml'));
  188.         }
  190.         if ($this->docsEnabled) {
  191.             $routeCollection->addCollection($this->fileLoader->load('docs.xml'));
  192.         }
  194.         if ($this->graphqlEnabled) {
  195.             $graphqlCollection = $this->fileLoader->load('graphql/graphql.xml');
  196.             $graphqlCollection->addDefaults(['_graphql' => true]);
  197.             $routeCollection->addCollection($graphqlCollection);
  198.         }
  200.         if ($this->graphiQlEnabled) {
  201.             $graphiQlCollection = $this->fileLoader->load('graphql/graphiql.xml');
  202.             $graphiQlCollection->addDefaults(['_graphql' => true]);
  203.             $routeCollection->addCollection($graphiQlCollection);
  204.         }
  206.         if ($this->graphQlPlaygroundEnabled) {
  207.             $graphQlPlaygroundCollection = $this->fileLoader->load('graphql/graphql_playground.xml');
  208.             $graphQlPlaygroundCollection->addDefaults(['_graphql' => true]);
  209.             $routeCollection->addCollection($graphQlPlaygroundCollection);
  210.         }
  212.         if (isset($this->formats['jsonld'])) {
  213.             $routeCollection->addCollection($this->fileLoader->load('jsonld.xml'));
  214.         }
  215.     }
  217.     /**
  218.      * TODO: remove in 3.0.
  219.      */
  220.     private function loadLegacyMetadata(RouteCollection $routeCollection, string $resourceClass)
  221.     {
  222.         $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  223.         $resourceShortName = $resourceMetadata->getShortName();
  225.         if (null === $resourceShortName) {
  226.             throw new InvalidResourceException(sprintf('Resource %s has no short name defined.', $resourceClass));
  227.         }
  229.         if (null !== $collectionOperations = $resourceMetadata->getCollectionOperations()) {
  230.             foreach ($collectionOperations as $operationName => $operation) {
  231.                 $this->addRoute($routeCollection, $resourceClass, $operationName, $operation, $resourceMetadata, OperationType::COLLECTION);
  232.             }
  233.         }
  235.         if (null !== $itemOperations = $resourceMetadata->getItemOperations()) {
  236.             foreach ($itemOperations as $operationName => $operation) {
  237.                 $this->addRoute($routeCollection, $resourceClass, $operationName, $operation, $resourceMetadata, OperationType::ITEM);
  238.             }
  239.         }
  240.     }
  242.     /**
  243.      * TODO: remove in 3.0.
  244.      */
  245.     private function loadLegacySubresources(RouteCollection $routeCollection, string $resourceClass)
  246.     {
  247.         if (null === $this->subresourceOperationFactory) {
  248.             return;
  249.         }
  251.         foreach ($this->subresourceOperationFactory->create($resourceClass) as $operationId => $operation) {
  252.             if (null === $controller = $operation['controller'] ?? null) {
  253.                 $controller = self::DEFAULT_ACTION_PATTERN.'get_subresource';
  255.                 if (!$this->container->has($controller)) {
  256.                     throw new RuntimeException(sprintf('There is no builtin action for the %s %s operation. You need to define the controller yourself.', OperationType::SUBRESOURCE, 'GET'));
  257.                 }
  258.             }
  260.             $routeCollection->add($operation['route_name'], new Route(
  261.                 $operation['path'],
  262.                 [
  263.                     '_controller' => $controller,
  264.                     '_format' => $operation['defaults']['_format'] ?? null,
  265.                     '_stateless' => $operation['stateless'] ?? null,
  266.                     '_api_resource_class' => $operation['resource_class'],
  267.                     '_api_identifiers' => $operation['identifiers'],
  268.                     '_api_has_composite_identifier' => false,
  269.                     '_api_subresource_operation_name' => $operation['route_name'],
  270.                     '_api_subresource_context' => [
  271.                         'property' => $operation['property'],
  272.                         'identifiers' => $operation['identifiers'],
  273.                         'collection' => $operation['collection'],
  274.                         'operationId' => $operationId,
  275.                     ],
  276.                 ] + ($operation['defaults'] ?? []),
  277.                 $operation['requirements'] ?? [],
  278.                 $operation['options'] ?? [],
  279.                 $operation['host'] ?? '',
  280.                 $operation['schemes'] ?? [],
  281.                 ['GET'],
  282.                 $operation['condition'] ?? ''
  283.             ));
  284.         }
  285.     }
  287.     /**
  288.      * Creates and adds a route for the given operation to the route collection.
  289.      *
  290.      * @throws RuntimeException
  291.      */
  292.     private function addRoute(RouteCollection $routeCollection, string $resourceClass, string $operationName, array $operation, ResourceMetadata $resourceMetadata, string $operationType): void
  293.     {
  294.         $resourceShortName = $resourceMetadata->getShortName();
  296.         if (isset($operation['route_name'])) {
  297.             if (!isset($operation['method'])) {
  298.                 @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);
  299.             }
  301.             return;
  302.         }
  304.         if (!isset($operation['method'])) {
  305.             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));
  306.         }
  308.         if (null === $controller = $operation['controller'] ?? null) {
  309.             $controller = sprintf('%s%s_%s', self::DEFAULT_ACTION_PATTERN, strtolower($operation['method']), $operationType);
  311.             if (!$this->container->has($controller)) {
  312.                 throw new RuntimeException(sprintf('There is no builtin action for the %s %s operation. You need to define the controller yourself.', $operationType, $operation['method']));
  313.             }
  314.         }
  316.         if ($resourceMetadata->getItemOperations()) {
  317.             $operation['identifiers'] = (array) ($operation['identifiers'] ?? $resourceMetadata->getAttribute('identifiers', $this->identifiersExtractor ? $this->identifiersExtractor->getIdentifiersFromResourceClass($resourceClass) : ['id']));
  318.         }
  320.         $operation['has_composite_identifier'] = isset($operation['identifiers']) && \count($operation['identifiers']) > 1 ? $resourceMetadata->getAttribute('composite_identifier', true) : false;
  321.         $path = trim(trim($resourceMetadata->getAttribute('route_prefix', '')), '/');
  322.         $path .= $this->operationPathResolver->resolveOperationPath($resourceShortName, $operation, $operationType, $operationName);
  324.         $route = new Route(
  325.             $path,
  326.             [
  327.                 '_controller' => $controller,
  328.                 '_format' => $operation['defaults']['_format'] ?? null,
  329.                 '_stateless' => $operation['stateless'] ?? null,
  330.                 '_api_resource_class' => $resourceClass,
  331.                 '_api_identifiers' => $operation['identifiers'] ?? [],
  332.                 '_api_has_composite_identifier' => $operation['has_composite_identifier'] ?? true,
  333.                 '_api_exception_to_status' => $operation['exception_to_status'] ?? $resourceMetadata->getAttribute('exception_to_status') ?? [],
  334.                 '_api_operation_name' => RouteNameGenerator::generate($operationName, $resourceShortName, $operationType),
  335.                 sprintf('_api_%s_operation_name', $operationType) => $operationName,
  336.             ] + ($operation['defaults'] ?? []),
  337.             $operation['requirements'] ?? [],
  338.             $operation['options'] ?? [],
  339.             $operation['host'] ?? '',
  340.             $operation['schemes'] ?? [],
  341.             [$operation['method']],
  342.             $operation['condition'] ?? ''
  343.         );
  345.         $routeCollection->add(RouteNameGenerator::generate($operationName, $resourceShortName, $operationType), $route);
  346.     }
  347. }
  349. class_alias(ApiLoader::class, \ApiPlatform\Core\Bridge\Symfony\Routing\ApiLoader::class);