vendor/api-platform/core/src/Metadata/Resource/ResourceMetadataCollection.php line 38

  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\Metadata\Resource;
  16. use ApiPlatform\Metadata\ApiResource;
  17. use ApiPlatform\Metadata\CollectionOperationInterface;
  18. use ApiPlatform\Metadata\Exception\OperationNotFoundException;
  19. use ApiPlatform\Metadata\Operation;
  21. /**
  22.  * @extends \ArrayObject<int, ApiResource>
  23.  */
  24. final class ResourceMetadataCollection extends \ArrayObject
  25. {
  26.     private const GRAPHQL_PREFIX = 'g_';
  27.     private const HTTP_PREFIX = 'h_';
  28.     private const FORCE_COLLECTION = 'co_';
  29.     private const HTTP_OPERATION = 'ht_';
  31.     private array $operationCache = [];
  33.     public function __construct(private readonly string $resourceClass, array $input = [])
  34.     {
  35.         parent::__construct($input);
  36.     }
  38.     public function getOperation(string $operationName = null, bool $forceCollection = false, bool $httpOperation = false): Operation
  39.     {
  40.         $operationName ??= '';
  41.         $cachePrefix = ($forceCollection ? self::FORCE_COLLECTION : '').($httpOperation ? self::HTTP_OPERATION : '');
  42.         $httpCacheKey = self::HTTP_PREFIX.$cachePrefix.$operationName;
  43.         if (isset($this->operationCache[$httpCacheKey])) {
  44.             return $this->operationCache[$httpCacheKey];
  45.         }
  47.         $gqlCacheKey = self::GRAPHQL_PREFIX.$cachePrefix.$operationName;
  48.         if (isset($this->operationCache[$gqlCacheKey])) {
  49.             return $this->operationCache[$gqlCacheKey];
  50.         }
  52.         $it = $this->getIterator();
  53.         $metadata = null;
  55.         while ($it->valid()) {
  56.             /** @var ApiResource $metadata */
  57.             $metadata = $it->current();
  59.             foreach ($metadata->getOperations() ?? [] as $name => $operation) {
  60.                 $isCollection = $operation instanceof CollectionOperationInterface;
  61.                 $method = $operation->getMethod() ?? 'GET';
  62.                 $isGetOperation = 'GET' === $method || 'OPTIONS' === $method || 'HEAD' === $method;
  63.                 if ('' === $operationName && $isGetOperation && ($forceCollection ? $isCollection : !$isCollection)) {
  64.                     return $this->operationCache[$httpCacheKey] = $operation;
  65.                 }
  67.                 if ($name === $operationName) {
  68.                     return $this->operationCache[$httpCacheKey] = $operation;
  69.                 }
  71.                 if ($operation->getUriTemplate() === $operationName) {
  72.                     return $this->operationCache[$httpCacheKey] = $operation;
  73.                 }
  74.             }
  76.             foreach ($metadata->getGraphQlOperations() ?? [] as $name => $operation) {
  77.                 $isCollection = $operation instanceof CollectionOperationInterface;
  78.                 if ('' === $operationName && ($forceCollection ? $isCollection : !$isCollection) && false === $httpOperation) {
  79.                     return $this->operationCache[$gqlCacheKey] = $operation;
  80.                 }
  82.                 if ($name === $operationName) {
  83.                     return $this->operationCache[$httpCacheKey] = $operation;
  84.                 }
  85.             }
  87.             $it->next();
  88.         }
  90.         // Idea:
  91.         // if ($metadata) {
  92.         //     return (new class extends HttpOperation {})->withResource($metadata);
  93.         // }
  95.         $this->handleNotFound($operationName, $metadata);
  96.     }
  98.     /**
  99.      * @throws OperationNotFoundException
  100.      */
  101.     private function handleNotFound(string $operationName, ?ApiResource $metadata): void
  102.     {
  103.         // Hide the FQDN in the exception message if possible
  104.         $shortName = $metadata?->getShortName() ? $metadata->getShortName() : $this->resourceClass;
  105.         if (!$metadata && false !== $pos = strrpos($shortName, '\\')) {
  106.             $shortName = substr($shortName, $pos + 1);
  107.         }
  109.         throw new OperationNotFoundException(sprintf('Operation "%s" not found for resource "%s".', $operationName, $shortName));
  110.     }
  111. }