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

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