vendor/api-platform/core/src/Symfony/EventListener/QueryParameterValidateListener.php line 41

  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\QueryParameterValidator\QueryParameterValidator;
  17. use ApiPlatform\Doctrine\Orm\State\Options;
  18. use ApiPlatform\Metadata\CollectionOperationInterface;
  19. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  20. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  21. use ApiPlatform\Util\RequestAttributesExtractor;
  22. use ApiPlatform\Util\RequestParser;
  23. use Symfony\Component\HttpKernel\Event\RequestEvent;
  25. /**
  26.  * Validates query parameters depending on filter description.
  27.  *
  28.  * @author Julien Deniau <julien.deniau@mapado.com>
  29.  */
  30. final class QueryParameterValidateListener
  31. {
  32.     use OperationRequestInitiatorTrait;
  34.     public const OPERATION_ATTRIBUTE_KEY = 'query_parameter_validate';
  36.     public function __construct(private readonly QueryParameterValidator $queryParameterValidator, ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null)
  37.     {
  38.         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
  39.     }
  41.     public function onKernelRequest(RequestEvent $event): void
  42.     {
  43.         $request = $event->getRequest();
  45.         if (
  46.             !$request->isMethodSafe()
  47.             || !($attributes = RequestAttributesExtractor::extractAttributes($request))
  48.             || 'GET' !== $request->getMethod()
  49.         ) {
  50.             return;
  51.         }
  53.         $operation = $this->initializeOperation($request);
  55.         if (!($operation?->getQueryParameterValidationEnabled() ?? true) || !$operation instanceof CollectionOperationInterface) {
  56.             return;
  57.         }
  59.         $queryString = RequestParser::getQueryString($request);
  60.         $queryParameters = $queryString ? RequestParser::parseRequestParams($queryString) : [];
  62.         $class = $attributes['resource_class'];
  64.         if (($options = $operation->getStateOptions()) && $options instanceof Options && $options->getEntityClass()) {
  65.             $class = $options->getEntityClass();
  66.         }
  68.         $this->queryParameterValidator->validateFilters($class, $operation->getFilters() ?? [], $queryParameters);
  69.     }
  70. }