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

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