vendor/api-platform/core/src/Core/Operation/Factory/SubresourceOperationFactory.php line 81

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\Operation\Factory;
  16. use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
  17. use ApiPlatform\Core\Bridge\Symfony\Routing\RouteNameGenerator;
  18. use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
  19. use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
  20. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  21. use ApiPlatform\Exception\ResourceClassNotFoundException;
  22. use ApiPlatform\Operation\PathSegmentNameGeneratorInterface;
  24. /**
  25.  * @internal
  26.  */
  27. final class SubresourceOperationFactory implements SubresourceOperationFactoryInterface
  28. {
  29.     public const SUBRESOURCE_SUFFIX = '_subresource';
  30.     public const FORMAT_SUFFIX = '.{_format}';
  31.     public const ROUTE_OPTIONS = ['defaults' => [], 'requirements' => [], 'options' => [], 'host' => '', 'schemes' => [], 'condition' => '', 'controller' => null, 'stateless' => null];
  33.     private $resourceMetadataFactory;
  34.     private $propertyNameCollectionFactory;
  35.     private $propertyMetadataFactory;
  36.     private $pathSegmentNameGenerator;
  37.     private $identifiersExtractor;
  39.     public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, PathSegmentNameGeneratorInterface $pathSegmentNameGenerator, IdentifiersExtractorInterface $identifiersExtractor = null)
  40.     {
  41.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  42.         $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
  43.         $this->propertyMetadataFactory = $propertyMetadataFactory;
  44.         $this->pathSegmentNameGenerator = $pathSegmentNameGenerator;
  45.         $this->identifiersExtractor = $identifiersExtractor;
  46.     }
  48.     public function create(string $resourceClass): array
  49.     {
  50.         $tree = [];
  52.         try {
  53.             $this->computeSubresourceOperations($resourceClass, $tree);
  54.         } catch (ResourceClassNotFoundException $e) {
  55.             return [];
  56.         }
  58.         return $tree;
  59.     }
  61.     /**
  62.      * Handles subresource operations recursively and declare their corresponding routes.
  63.      *
  64.      * @param string $rootResourceClass null on the first iteration, it then keeps track of the origin resource class
  65.      * @param array  $parentOperation   the previous call operation
  66.      * @param int    $depth             the number of visited
  67.      */
  68.     private function computeSubresourceOperations(string $resourceClass, array &$tree, string $rootResourceClass = null, array $parentOperation = null, array $visited = [], int $depth = 0, int $maxDepth = null): void
  69.     {
  70.         if (null === $rootResourceClass) {
  71.             $rootResourceClass = $resourceClass;
  72.         }
  74.         foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $property) {
  75.             $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $property, ['deprecate' => false]);
  77.             if (!$subresource = $propertyMetadata->getSubresource()) {
  78.                 continue;
  79.             }
  81.             trigger_deprecation('api-platform/core', '2.7', sprintf('A subresource is declared on "%s::%s". Subresources are deprecated, use another #[ApiResource] instead.', $resourceClass, $property));
  82.             $subresourceClass = $subresource->getResourceClass();
  83.             $subresourceMetadata = $this->resourceMetadataFactory->create($subresourceClass);
  84.             $subresourceMetadata = $subresourceMetadata->withAttributes(($subresourceMetadata->getAttributes() ?: []) + ['identifiers' => !$this->identifiersExtractor ? [$property] : $this->identifiersExtractor->getIdentifiersFromResourceClass($subresourceClass)]);
  85.             $isLastItem = ($parentOperation['resource_class'] ?? null) === $resourceClass && $propertyMetadata->isIdentifier();
  87.             // A subresource that is also an identifier can't be a start point
  88.             if ($isLastItem && (null === $parentOperation || false === $parentOperation['collection'])) {
  89.                 continue;
  90.             }
  92.             $visiting = "$resourceClass $property $subresourceClass";
  94.             // Handle maxDepth
  95.             if (null !== $maxDepth && $depth >= $maxDepth) {
  96.                 break;
  97.             }
  98.             if (isset($visited[$visiting])) {
  99.                 continue;
  100.             }
  102.             $rootResourceMetadata = $this->resourceMetadataFactory->create($rootResourceClass);
  103.             $rootResourceMetadata = $rootResourceMetadata->withAttributes(($rootResourceMetadata->getAttributes() ?: []) + ['identifiers' => !$this->identifiersExtractor ? ['id'] : $this->identifiersExtractor->getIdentifiersFromResourceClass($rootResourceClass)]);
  104.             $operationName = 'get';
  105.             $operation = [
  106.                 'property' => $property,
  107.                 'collection' => $subresource->isCollection(),
  108.                 'resource_class' => $subresourceClass,
  109.                 'shortNames' => [$subresourceMetadata->getShortName()],
  110.                 'legacy_filters' => $subresourceMetadata->getAttribute('filters', []),
  111.                 'legacy_normalization_context' => $subresourceMetadata->getAttribute('normalization_context', []),
  112.                 'legacy_type' => $subresourceMetadata->getIri(),
  113.             ];
  115.             if (null === $parentOperation) {
  116.                 $identifiers = (array) $rootResourceMetadata->getAttribute('identifiers');
  117.                 $rootShortname = $rootResourceMetadata->getShortName();
  118.                 $identifier = \is_string($key = array_key_first($identifiers)) ? $key : $identifiers[0];
  119.                 $operation['identifiers'][$identifier] = [$rootResourceClass, $identifiers[$identifier][1] ?? $identifier, true];
  120.                 $operation['operation_name'] = sprintf(
  121.                     '%s_%s%s',
  122.                     RouteNameGenerator::inflector($operation['property'], $operation['collection']),
  123.                     $operationName,
  124.                     self::SUBRESOURCE_SUFFIX
  125.                 );
  127.                 $subresourceOperation = $rootResourceMetadata->getSubresourceOperations()[$operation['operation_name']] ?? [];
  129.                 $operation['route_name'] = sprintf(
  130.                     '%s%s_%s',
  131.                     RouteNameGenerator::ROUTE_NAME_PREFIX,
  132.                     RouteNameGenerator::inflector($rootShortname),
  133.                     $operation['operation_name']
  134.                 );
  136.                 $prefix = trim(trim($rootResourceMetadata->getAttribute('route_prefix', '')), '/');
  137.                 if ('' !== $prefix) {
  138.                     $prefix .= '/';
  139.                 }
  141.                 $operation['path'] = $subresourceOperation['path'] ?? sprintf(
  142.                     '/%s%s/{%s}/%s%s',
  143.                     $prefix,
  144.                     $this->pathSegmentNameGenerator->getSegmentName($rootShortname),
  145.                     $identifier,
  146.                     $this->pathSegmentNameGenerator->getSegmentName($operation['property'], $operation['collection']),
  147.                     self::FORMAT_SUFFIX
  148.                 );
  150.                 if (!\in_array($rootShortname, $operation['shortNames'], true)) {
  151.                     $operation['shortNames'][] = $rootShortname;
  152.                 }
  153.             } else {
  154.                 $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  155.                 $identifiers = (array) $resourceMetadata->getAttribute('identifiers', null === $this->identifiersExtractor ? ['id'] : $this->identifiersExtractor->getIdentifiersFromResourceClass($resourceClass));
  156.                 $identifier = \is_string($key = array_key_first($identifiers)) ? $key : $identifiers[0];
  157.                 $operation['identifiers'] = $parentOperation['identifiers'];
  159.                 if (!isset($operation['identifiers'][$parentOperation['property']])) {
  160.                     $operation['identifiers'][$parentOperation['property']] = [$resourceClass, $identifiers[$identifier][1] ?? $identifier, $isLastItem ? true : $parentOperation['collection']];
  161.                 }
  163.                 $operation['operation_name'] = str_replace(
  164.                     'get'.self::SUBRESOURCE_SUFFIX,
  165.                     RouteNameGenerator::inflector($isLastItem ? 'item' : $property, $operation['collection']).'_get'.self::SUBRESOURCE_SUFFIX,
  166.                     $parentOperation['operation_name']
  167.                 );
  168.                 $operation['route_name'] = str_replace($parentOperation['operation_name'], $operation['operation_name'], $parentOperation['route_name']);
  170.                 if (!\in_array($resourceMetadata->getShortName(), $operation['shortNames'], true)) {
  171.                     $operation['shortNames'][] = $resourceMetadata->getShortName();
  172.                 }
  174.                 $subresourceOperation = $rootResourceMetadata->getSubresourceOperations()[$operation['operation_name']] ?? [];
  176.                 if (isset($subresourceOperation['path'])) {
  177.                     $operation['path'] = $subresourceOperation['path'];
  178.                 } else {
  179.                     $operation['path'] = str_replace(self::FORMAT_SUFFIX, '', (string) $parentOperation['path']);
  181.                     if ($parentOperation['collection']) {
  182.                         $operation['path'] .= sprintf('/{%s}', array_key_last($operation['identifiers']));
  183.                     }
  185.                     if ($isLastItem) {
  186.                         $operation['path'] .= self::FORMAT_SUFFIX;
  187.                     } else {
  188.                         $operation['path'] .= sprintf('/%s%s', $this->pathSegmentNameGenerator->getSegmentName($property, $operation['collection']), self::FORMAT_SUFFIX);
  189.                     }
  190.                 }
  191.             }
  193.             if (isset($subresourceOperation['openapi_context'])) {
  194.                 $operation['openapi_context'] = $subresourceOperation['openapi_context'];
  195.             }
  197.             foreach (self::ROUTE_OPTIONS as $routeOption => $defaultValue) {
  198.                 $operation[$routeOption] = $subresourceOperation[$routeOption] ?? $defaultValue;
  199.             }
  201.             $tree[$operation['route_name']] = $operation;
  203.             // Get the minimum maxDepth between the rootMaxDepth and the maxDepth of the to be visited Subresource
  204.             $currentMaxDepth = array_filter([$maxDepth, $subresource->getMaxDepth()], 'is_int');
  205.             $currentMaxDepth = empty($currentMaxDepth) ? null : min($currentMaxDepth);
  207.             $this->computeSubresourceOperations($subresourceClass, $tree, $rootResourceClass, $operation, $visited + [$visiting => true], $depth + 1, $currentMaxDepth);
  208.         }
  209.     }
  210. }