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

  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\Metadata\CollectionOperationInterface;
  18. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  19. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  20. use ApiPlatform\Util\RequestAttributesExtractor;
  21. use ApiPlatform\Util\RequestParser;
  22. use Symfony\Component\HttpKernel\Event\RequestEvent;
  24. /**
  25.  * Validates query parameters depending on filter description.
  26.  *
  27.  * @author Julien Deniau <julien.deniau@mapado.com>
  28.  */
  29. final class QueryParameterValidateListener
  30. {
  31.     use OperationRequestInitiatorTrait;
  33.     public const OPERATION_ATTRIBUTE_KEY = 'query_parameter_validate';
  35.     public function __construct(private readonly QueryParameterValidator $queryParameterValidator, ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null)
  36.     {
  37.         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
  38.     }
  40.     public function onKernelRequest(RequestEvent $event): void
  41.     {
  42.         $request = $event->getRequest();
  44.         if (
  45.             !$request->isMethodSafe()
  46.             || !($attributes = RequestAttributesExtractor::extractAttributes($request))
  47.             || 'GET' !== $request->getMethod()
  48.         ) {
  49.             return;
  50.         }
  52.         $operation = $this->initializeOperation($request);
  54.         if (!($operation?->getQueryParameterValidationEnabled() ?? true) || !$operation instanceof CollectionOperationInterface) {
  55.             return;
  56.         }
  58.         $queryString = RequestParser::getQueryString($request);
  59.         $queryParameters = $queryString ? RequestParser::parseRequestParams($queryString) : [];
  60.         $this->queryParameterValidator->validateFilters($attributes['resource_class'], $operation->getFilters() ?? [], $queryParameters);
  61.     }
  62. }