vendor/api-platform/core/src/Core/Metadata/Resource/Factory/OperationResourceMetadataFactory.php line 125

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <[email protected]>
  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\Metadata\Resource\Factory;
  16. use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
  18. /**
  19.  * Creates or completes operations.
  20.  *
  21.  * @author Kévin Dunglas <[email protected]>
  22.  */
  23. final class OperationResourceMetadataFactory implements ResourceMetadataFactoryInterface
  24. {
  25.     /**
  26.      * @internal
  27.      */
  28.     public const SUPPORTED_COLLECTION_OPERATION_METHODS = [
  29.         'GET' => true,
  30.         'POST' => true,
  31.     ];
  33.     /**
  34.      * @internal
  35.      */
  36.     public const SUPPORTED_ITEM_OPERATION_METHODS = [
  37.         'GET' => true,
  38.         'PUT' => true,
  39.         // PATCH is automatically supported if at least one patch format has been configured
  40.         'DELETE' => true,
  41.     ];
  43.     private $decorated;
  44.     private $patchFormats;
  46.     public function __construct(ResourceMetadataFactoryInterface $decorated, array $patchFormats = [])
  47.     {
  48.         $this->decorated = $decorated;
  49.         $this->patchFormats = $patchFormats;
  50.     }
  52.     /**
  53.      * {@inheritdoc}
  54.      */
  55.     public function create(string $resourceClass): ResourceMetadata
  56.     {
  57.         $resourceMetadata = $this->decorated->create($resourceClass);
  58.         $isAbstract = (new \ReflectionClass($resourceClass))->isAbstract();
  60.         $collectionOperations = $resourceMetadata->getCollectionOperations();
  61.         if (null === $collectionOperations) {
  62.             $resourceMetadata = $resourceMetadata->withCollectionOperations($this->createOperations($isAbstract ? ['GET'] : ['GET', 'POST'], $resourceMetadata));
  63.         } else {
  64.             $resourceMetadata = $this->normalize(true, $resourceClass, $resourceMetadata, $collectionOperations);
  65.         }
  67.         $itemOperations = $resourceMetadata->getItemOperations();
  68.         if (null === $itemOperations) {
  69.             $methods = ['GET', 'DELETE'];
  71.             if (!$isAbstract) {
  72.                 $methods[] = 'PUT';
  74.                 if ($this->patchFormats) {
  75.                     $methods[] = 'PATCH';
  76.                 }
  77.             }
  79.             $resourceMetadata = $resourceMetadata->withItemOperations($this->createOperations($methods, $resourceMetadata));
  80.         } else {
  81.             $resourceMetadata = $this->normalize(false, $resourceClass, $resourceMetadata, $itemOperations);
  82.         }
  84.         $graphql = $resourceMetadata->getGraphql();
  85.         if (null === $graphql) {
  86.             $resourceMetadata = $resourceMetadata->withGraphql(['item_query' => [], 'collection_query' => [], 'delete' => [], 'update' => [], 'create' => []]);
  87.         } else {
  88.             $resourceMetadata = $this->normalizeGraphQl($resourceMetadata, $graphql);
  89.         }
  91.         return $resourceMetadata;
  92.     }
  94.     private function createOperations(array $methods, ResourceMetadata $resourceMetadata): array
  95.     {
  96.         $operations = [];
  97.         foreach ($methods as $method) {
  98.             $operations[strtolower($method)] = ['method' => $method, 'stateless' => $resourceMetadata->getAttribute('stateless')];
  99.         }
  101.         return $operations;
  102.     }
  104.     private function normalize(bool $collection, string $resourceClass, ResourceMetadata $resourceMetadata, array $operations): ResourceMetadata
  105.     {
  106.         $newOperations = [];
  107.         foreach ($operations as $operationName => $operation) {
  108.             // e.g.: @ApiResource(itemOperations={"get"})
  109.             if (\is_int($operationName) && \is_string($operation)) {
  110.                 $operationName = $operation;
  111.                 $operation = [];
  112.             }
  114.             $upperOperationName = strtoupper((string) $operationName);
  115.             if ($collection) {
  116.                 $supported = isset(self::SUPPORTED_COLLECTION_OPERATION_METHODS[$upperOperationName]);
  117.             } else {
  118.                 $supported = isset(self::SUPPORTED_ITEM_OPERATION_METHODS[$upperOperationName]) || ($this->patchFormats && 'PATCH' === $upperOperationName);
  119.             }
  121.             if (!isset($operation['method']) && !isset($operation['route_name'])) {
  122.                 if ($supported) {
  123.                     $operation['method'] = $upperOperationName;
  124.                 } else {
  125.                     @trigger_error(sprintf('The "route_name" attribute will not be set automatically again in API Platform 3.0, set it for the %s operation "%s" of the class "%s".', $collection ? 'collection' : 'item', $operationName, $resourceClass), \E_USER_DEPRECATED);
  126.                     $operation['route_name'] = $operationName;
  127.                 }
  128.             }
  130.             if (isset($operation['method'])) {
  131.                 $operation['method'] = strtoupper($operation['method']);
  132.             }
  134.             $operation['stateless'] = $operation['stateless'] ?? $resourceMetadata->getAttribute('stateless');
  136.             $newOperations[$operationName] = $operation;
  137.         }
  139.         return $collection ? $resourceMetadata->withCollectionOperations($newOperations) : $resourceMetadata->withItemOperations($newOperations);
  140.     }
  142.     private function normalizeGraphQl(ResourceMetadata $resourceMetadata, array $operations): ResourceMetadata
  143.     {
  144.         foreach ($operations as $operationName => $operation) {
  145.             if (\is_int($operationName) && \is_string($operation)) {
  146.                 unset($operations[$operationName]);
  147.                 $operations[$operation] = [];
  148.             }
  149.         }
  151.         return $resourceMetadata->withGraphql($operations);
  152.     }
  153. }