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

  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.     /**
  49.      * {@inheritdoc}
  50.      */
  51.     public function create(string $resourceClass): array
  52.     {
  53.         $tree = [];
  55.         try {
  56.             $this->computeSubresourceOperations($resourceClass, $tree);
  57.         } catch (ResourceClassNotFoundException $e) {
  58.             return [];
  59.         }
  61.         return $tree;
  62.     }
  64.     /**
  65.      * Handles subresource operations recursively and declare their corresponding routes.
  66.      *
  67.      * @param string $rootResourceClass null on the first iteration, it then keeps track of the origin resource class
  68.      * @param array  $parentOperation   the previous call operation
  69.      * @param int    $depth             the number of visited
  70.      * @param int    $maxDepth
  71.      */
  72.     private function computeSubresourceOperations(string $resourceClass, array &$tree, string $rootResourceClass = null, array $parentOperation = null, array $visited = [], int $depth = 0, int $maxDepth = null): void
  73.     {
  74.         if (null === $rootResourceClass) {
  75.             $rootResourceClass = $resourceClass;
  76.         }
  78.         foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $property) {
  79.             $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $property, ['deprecate' => false]);
  81.             if (!$subresource = $propertyMetadata->getSubresource()) {
  82.                 continue;
  83.             }
  85.             trigger_deprecation('api-platform/core', '2.7', sprintf('A subresource is declared on "%s::%s". Subresources are deprecated, use another #[ApiResource] instead.', $resourceClass, $property));
  86.             $subresourceClass = $subresource->getResourceClass();
  87.             $subresourceMetadata = $this->resourceMetadataFactory->create($subresourceClass);
  88.             $subresourceMetadata = $subresourceMetadata->withAttributes(($subresourceMetadata->getAttributes() ?: []) + ['identifiers' => !$this->identifiersExtractor ? [$property] : $this->identifiersExtractor->getIdentifiersFromResourceClass($subresourceClass)]);
  89.             $isLastItem = ($parentOperation['resource_class'] ?? null) === $resourceClass && $propertyMetadata->isIdentifier();
  91.             // A subresource that is also an identifier can't be a start point
  92.             if ($isLastItem && (null === $parentOperation || false === $parentOperation['collection'])) {
  93.                 continue;
  94.             }
  96.             $visiting = "$resourceClass $property $subresourceClass";
  98.             // Handle maxDepth
  99.             if (null !== $maxDepth && $depth >= $maxDepth) {
  100.                 break;
  101.             }
  102.             if (isset($visited[$visiting])) {
  103.                 continue;
  104.             }
  106.             $rootResourceMetadata = $this->resourceMetadataFactory->create($rootResourceClass);
  107.             $rootResourceMetadata = $rootResourceMetadata->withAttributes(($rootResourceMetadata->getAttributes() ?: []) + ['identifiers' => !$this->identifiersExtractor ? ['id'] : $this->identifiersExtractor->getIdentifiersFromResourceClass($rootResourceClass)]);
  108.             $operationName = 'get';
  109.             $operation = [
  110.                 'property' => $property,
  111.                 'collection' => $subresource->isCollection(),
  112.                 'resource_class' => $subresourceClass,
  113.                 'shortNames' => [$subresourceMetadata->getShortName()],
  114.                 'legacy_filters' => $subresourceMetadata->getAttribute('filters', []),
  115.                 'legacy_normalization_context' => $subresourceMetadata->getAttribute('normalization_context', []),
  116.                 'legacy_type' => $subresourceMetadata->getIri(),
  117.             ];
  119.             if (null === $parentOperation) {
  120.                 $identifiers = (array) $rootResourceMetadata->getAttribute('identifiers');
  121.                 $rootShortname = $rootResourceMetadata->getShortName();
  122.                 $identifier = \is_string($key = array_key_first($identifiers)) ? $key : $identifiers[0];
  123.                 $operation['identifiers'][$identifier] = [$rootResourceClass, $identifiers[$identifier][1] ?? $identifier, true];
  124.                 $operation['operation_name'] = sprintf(
  125.                     '%s_%s%s',
  126.                     RouteNameGenerator::inflector($operation['property'], $operation['collection']),
  127.                     $operationName,
  128.                     self::SUBRESOURCE_SUFFIX
  129.                 );
  131.                 $subresourceOperation = $rootResourceMetadata->getSubresourceOperations()[$operation['operation_name']] ?? [];
  133.                 $operation['route_name'] = sprintf(
  134.                     '%s%s_%s',
  135.                     RouteNameGenerator::ROUTE_NAME_PREFIX,
  136.                     RouteNameGenerator::inflector($rootShortname),
  137.                     $operation['operation_name']
  138.                 );
  140.                 $prefix = trim(trim($rootResourceMetadata->getAttribute('route_prefix', '')), '/');
  141.                 if ('' !== $prefix) {
  142.                     $prefix .= '/';
  143.                 }
  145.                 $operation['path'] = $subresourceOperation['path'] ?? sprintf(
  146.                     '/%s%s/{%s}/%s%s',
  147.                     $prefix,
  148.                     $this->pathSegmentNameGenerator->getSegmentName($rootShortname),
  149.                     $identifier,
  150.                     $this->pathSegmentNameGenerator->getSegmentName($operation['property'], $operation['collection']),
  151.                     self::FORMAT_SUFFIX
  152.                 );
  154.                 if (!\in_array($rootShortname, $operation['shortNames'], true)) {
  155.                     $operation['shortNames'][] = $rootShortname;
  156.                 }
  157.             } else {
  158.                 $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  159.                 $identifiers = (array) $resourceMetadata->getAttribute('identifiers', null === $this->identifiersExtractor ? ['id'] : $this->identifiersExtractor->getIdentifiersFromResourceClass($resourceClass));
  160.                 $identifier = \is_string($key = array_key_first($identifiers)) ? $key : $identifiers[0];
  161.                 $operation['identifiers'] = $parentOperation['identifiers'];
  163.                 if (!isset($operation['identifiers'][$parentOperation['property']])) {
  164.                     $operation['identifiers'][$parentOperation['property']] = [$resourceClass, $identifiers[$identifier][1] ?? $identifier, $isLastItem ? true : $parentOperation['collection']];
  165.                 }
  167.                 $operation['operation_name'] = str_replace(
  168.                     'get'.self::SUBRESOURCE_SUFFIX,
  169.                     RouteNameGenerator::inflector($isLastItem ? 'item' : $property, $operation['collection']).'_get'.self::SUBRESOURCE_SUFFIX,
  170.                     $parentOperation['operation_name']
  171.                 );
  172.                 $operation['route_name'] = str_replace($parentOperation['operation_name'], $operation['operation_name'], $parentOperation['route_name']);
  174.                 if (!\in_array($resourceMetadata->getShortName(), $operation['shortNames'], true)) {
  175.                     $operation['shortNames'][] = $resourceMetadata->getShortName();
  176.                 }
  178.                 $subresourceOperation = $rootResourceMetadata->getSubresourceOperations()[$operation['operation_name']] ?? [];
  180.                 if (isset($subresourceOperation['path'])) {
  181.                     $operation['path'] = $subresourceOperation['path'];
  182.                 } else {
  183.                     $operation['path'] = str_replace(self::FORMAT_SUFFIX, '', (string) $parentOperation['path']);
  185.                     if ($parentOperation['collection']) {
  186.                         $operation['path'] .= sprintf('/{%s}', array_key_last($operation['identifiers']));
  187.                     }
  189.                     if ($isLastItem) {
  190.                         $operation['path'] .= self::FORMAT_SUFFIX;
  191.                     } else {
  192.                         $operation['path'] .= sprintf('/%s%s', $this->pathSegmentNameGenerator->getSegmentName($property, $operation['collection']), self::FORMAT_SUFFIX);
  193.                     }
  194.                 }
  195.             }
  197.             if (isset($subresourceOperation['openapi_context'])) {
  198.                 $operation['openapi_context'] = $subresourceOperation['openapi_context'];
  199.             }
  201.             foreach (self::ROUTE_OPTIONS as $routeOption => $defaultValue) {
  202.                 $operation[$routeOption] = $subresourceOperation[$routeOption] ?? $defaultValue;
  203.             }
  205.             $tree[$operation['route_name']] = $operation;
  207.             // Get the minimum maxDepth between the rootMaxDepth and the maxDepth of the to be visited Subresource
  208.             $currentMaxDepth = array_filter([$maxDepth, $subresource->getMaxDepth()], 'is_int');
  209.             $currentMaxDepth = empty($currentMaxDepth) ? null : min($currentMaxDepth);
  211.             $this->computeSubresourceOperations($subresourceClass, $tree, $rootResourceClass, $operation, $visited + [$visiting => true], $depth + 1, $currentMaxDepth);
  212.         }
  213.     }
  214. }