vendor/api-platform/core/src/Core/DataProvider/OperationDataProviderTrait.php line 123

  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\DataProvider;
  16. use ApiPlatform\Core\Identifier\CompositeIdentifierParser;
  17. use ApiPlatform\Core\Identifier\ContextAwareIdentifierConverterInterface;
  18. use ApiPlatform\Core\Identifier\IdentifierConverterInterface;
  19. use ApiPlatform\Exception\InvalidIdentifierException;
  20. use ApiPlatform\Exception\RuntimeException;
  22. /**
  23.  * @internal
  24.  */
  25. trait OperationDataProviderTrait
  26. {
  27.     /**
  28.      * @var CollectionDataProviderInterface
  29.      */
  30.     private $collectionDataProvider;
  32.     /**
  33.      * @var ItemDataProviderInterface
  34.      */
  35.     private $itemDataProvider;
  37.     /**
  38.      * @var SubresourceDataProviderInterface|null
  39.      */
  40.     private $subresourceDataProvider;
  42.     /**
  43.      * @var IdentifierConverterInterface|null
  44.      */
  45.     private $identifierConverter;
  47.     /**
  48.      * Retrieves data for a collection operation.
  49.      */
  50.     private function getCollectionData(array $attributes, array $context): iterable
  51.     {
  52.         return $this->collectionDataProvider->getCollection($attributes['resource_class'], $attributes['collection_operation_name'], $context);
  53.     }
  55.     /**
  56.      * Gets data for an item operation.
  57.      *
  58.      * @return object|null
  59.      */
  60.     private function getItemData($identifiers, array $attributes, array $context)
  61.     {
  62.         return $this->itemDataProvider->getItem($attributes['resource_class'], $identifiers, $attributes['item_operation_name'], $context);
  63.     }
  65.     /**
  66.      * Gets data for a nested operation.
  67.      *
  68.      * @throws RuntimeException
  69.      *
  70.      * @return array|object|null
  71.      */
  72.     private function getSubresourceData($identifiers, array $attributes, array $context)
  73.     {
  74.         if (null === $this->subresourceDataProvider) {
  75.             throw new RuntimeException('Subresources not supported');
  76.         }
  78.         // TODO: SubresourceDataProvider wants: ['id' => ['id' => 1], 'relatedDummies' => ['id' => 2]], identifiers is ['id' => 1, 'relatedDummies' => 2]
  79.         $subresourceIdentifiers = [];
  80.         foreach ($attributes['identifiers'] as $parameterName => [$class, $property]) {
  81.             if (false !== ($attributes['identifiers'][$parameterName][2] ?? null)) {
  82.                 $subresourceIdentifiers[$parameterName] = [$property => $identifiers[$parameterName]];
  83.             }
  84.         }
  86.         return $this->subresourceDataProvider->getSubresource($attributes['resource_class'], $subresourceIdentifiers, $attributes['subresource_context'] + $context, $attributes['subresource_operation_name']);
  87.     }
  89.     /**
  90.      * @param array $parameters - usually comes from $request->attributes->all()
  91.      *
  92.      * @throws InvalidIdentifierException
  93.      */
  94.     private function extractIdentifiers(array $parameters, array $attributes)
  95.     {
  96.         $identifiersKeys = $attributes['identifiers'] ?? ['id' => [$attributes['resource_class'], 'id']];
  97.         $identifiers = [];
  99.         $identifiersNumber = \count($identifiersKeys);
  100.         foreach ($identifiersKeys as $parameterName => $identifiedBy) {
  101.             if (!isset($parameters[$parameterName])) {
  102.                 if ($attributes['has_composite_identifier']) {
  103.                     $identifiers = CompositeIdentifierParser::parse($parameters['id']);
  104.                     if (($currentIdentifiersNumber = \count($identifiers)) !== $identifiersNumber) {
  105.                         throw new InvalidIdentifierException(sprintf('Expected %d identifiers, got %d', $identifiersNumber, $currentIdentifiersNumber));
  106.                     }
  108.                     return $this->identifierConverter->convert($identifiers, $identifiedBy[0]);
  109.                 }
  111.                 // TODO: Subresources tuple may have a third item representing if it is a "collection", this behavior will be removed in 3.0
  112.                 if (false === ($identifiedBy[2] ?? null)) {
  113.                     continue;
  114.                 }
  116.                 throw new InvalidIdentifierException(sprintf('Parameter "%s" not found', $parameterName));
  117.             }
  119.             $identifiers[$parameterName] = $parameters[$parameterName];
  120.         }
  122.         if ($this->identifierConverter instanceof ContextAwareIdentifierConverterInterface) {
  123.             return $this->identifierConverter->convert($identifiers, $attributes['resource_class'], ['identifiers' => $identifiersKeys]);
  124.         }
  126.         return $this->identifierConverter->convert($identifiers, $attributes['resource_class']);
  127.     }
  128. }