vendor/api-platform/core/src/Symfony/EventListener/ReadListener.php line 58

  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\Symfony\EventListener;
  16. use ApiPlatform\Api\UriVariablesConverterInterface;
  17. use ApiPlatform\Exception\InvalidIdentifierException;
  18. use ApiPlatform\Exception\InvalidUriVariableException;
  19. use ApiPlatform\Metadata\HttpOperation;
  20. use ApiPlatform\Metadata\Put;
  21. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  22. use ApiPlatform\Serializer\SerializerContextBuilderInterface;
  23. use ApiPlatform\State\ProviderInterface;
  24. use ApiPlatform\State\UriVariablesResolverTrait;
  25. use ApiPlatform\Util\CloneTrait;
  26. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  27. use ApiPlatform\Util\RequestAttributesExtractor;
  28. use ApiPlatform\Util\RequestParser;
  29. use Symfony\Component\HttpKernel\Event\RequestEvent;
  30. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  32. /**
  33.  * Retrieves data from the applicable data provider and sets it as a request parameter called data.
  34.  *
  35.  * @author Kévin Dunglas <dunglas@gmail.com>
  36.  */
  37. final class ReadListener
  38. {
  39.     use CloneTrait;
  40.     use OperationRequestInitiatorTrait;
  41.     use UriVariablesResolverTrait;
  43.     public function __construct(
  44.         private readonly ProviderInterface $provider,
  45.         ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null,
  46.         private readonly ?SerializerContextBuilderInterface $serializerContextBuilder = null,
  47.         UriVariablesConverterInterface $uriVariablesConverter = null,
  48.     ) {
  49.         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
  50.         $this->uriVariablesConverter = $uriVariablesConverter;
  51.     }
  53.     /**
  54.      * Calls the data provider and sets the data attribute.
  55.      *
  56.      * @throws NotFoundHttpException
  57.      */
  58.     public function onKernelRequest(RequestEvent $event): void
  59.     {
  60.         $request = $event->getRequest();
  61.         $operation = $this->initializeOperation($request);
  63.         if (!($attributes = RequestAttributesExtractor::extractAttributes($request))) {
  64.             return;
  65.         }
  67.         if (!$attributes['receive'] || !$operation || !($operation->canRead() ?? true) || (!$operation->getUriVariables() && !$request->isMethodSafe())) {
  68.             return;
  69.         }
  71.         $context = ['operation' => $operation];
  73.         if (null === $filters = $request->attributes->get('_api_filters')) {
  74.             $queryString = RequestParser::getQueryString($request);
  75.             $filters = $queryString ? RequestParser::parseRequestParams($queryString) : null;
  76.         }
  78.         if ($filters) {
  79.             $context['filters'] = $filters;
  80.         }
  82.         if ($this->serializerContextBuilder) {
  83.             // Builtin data providers are able to use the serialization context to automatically add join clauses
  84.             $context += $normalizationContext = $this->serializerContextBuilder->createFromRequest($request, true, $attributes);
  85.             $request->attributes->set('_api_normalization_context', $normalizationContext);
  86.         }
  88.         $parameters = $request->attributes->all();
  89.         $resourceClass = $operation->getClass() ?? $attributes['resource_class'];
  90.         try {
  91.             $uriVariables = $this->getOperationUriVariables($operation, $parameters, $resourceClass);
  92.             $data = $this->provider->provide($operation, $uriVariables, $context);
  93.         } catch (InvalidIdentifierException|InvalidUriVariableException $e) {
  94.             throw new NotFoundHttpException('Invalid identifier value or configuration.', $e);
  95.         }
  97.         if (
  98.             null === $data &&
  99.             (
  100.                 HttpOperation::METHOD_PUT !== $operation->getMethod() ||
  101.                 ($operation instanceof Put && !($operation->getAllowCreate() ?? false))
  102.             )
  103.         ) {
  104.             throw new NotFoundHttpException('Not Found');
  105.         }
  107.         $request->attributes->set('data', $data);
  108.         $request->attributes->set('previous_data', $this->clone($data));
  109.     }
  110. }