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

Open in your IDE?
  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\Core\Filter\QueryParameterValidator as LegacyQueryParameterValidator;
  18. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  19. use ApiPlatform\Core\Metadata\Resource\ToggleableOperationAttributeTrait;
  20. use ApiPlatform\Metadata\CollectionOperationInterface;
  21. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  22. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  23. use ApiPlatform\Util\RequestAttributesExtractor;
  24. use ApiPlatform\Util\RequestParser;
  25. use Symfony\Component\HttpKernel\Event\RequestEvent;
  27. /**
  28.  * Validates query parameters depending on filter description.
  29.  *
  30.  * @author Julien Deniau <julien.deniau@mapado.com>
  31.  */
  32. final class QueryParameterValidateListener
  33. {
  34.     use OperationRequestInitiatorTrait;
  35.     use ToggleableOperationAttributeTrait;
  37.     public const OPERATION_ATTRIBUTE_KEY = 'query_parameter_validate';
  39.     private $resourceMetadataFactory;
  41.     private $queryParameterValidator;
  43.     private $enabled;
  45.     /**
  46.      * @param ResourceMetadataCollectionFactoryInterface|ResourceMetadataFactoryInterface $resourceMetadataFactory
  47.      * @param QueryParameterValidator|LegacyQueryParameterValidator                       $queryParameterValidator
  48.      */
  49.     public function __construct($resourceMetadataFactory, $queryParameterValidator, bool $enabled = true)
  50.     {
  51.         if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  52.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  53.         } else {
  54.             $this->resourceMetadataCollectionFactory = $resourceMetadataFactory;
  55.         }
  57.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  58.         $this->queryParameterValidator = $queryParameterValidator;
  59.         $this->enabled = $enabled;
  60.     }
  62.     public function onKernelRequest(RequestEvent $event)
  63.     {
  64.         $request = $event->getRequest();
  65.         $operation = $this->initializeOperation($request);
  67.         if (
  68.             !$request->isMethodSafe()
  69.             || !($attributes = RequestAttributesExtractor::extractAttributes($request))
  70.             || 'GET' !== $request->getMethod()
  71.         ) {
  72.             return;
  73.         }
  75.         if ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface
  76.             && (!$operation || !($operation->getQueryParameterValidationEnabled() ?? true) || !$operation instanceof CollectionOperationInterface)
  77.         ) {
  78.             return;
  79.         }
  81.         // TODO: remove in 3.0
  82.         $operationName = $attributes['collection_operation_name'] ?? null;
  83.         if (!$this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface
  84.             && (
  85.                 null === $operationName
  86.                 || $this->isOperationAttributeDisabled($attributes, self::OPERATION_ATTRIBUTE_KEY, !$this->enabled)
  87.             )
  88.         ) {
  89.             return;
  90.         }
  92.         $queryString = RequestParser::getQueryString($request);
  93.         $queryParameters = $queryString ? RequestParser::parseRequestParams($queryString) : [];
  94.         $resourceFilters = [];
  95.         if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  96.             $resourceFilters = $this->resourceMetadataFactory->create($attributes['resource_class'])->getCollectionOperationAttribute($operationName, 'filters', [], true);
  97.         } elseif ($operation) {
  98.             $resourceFilters = $operation->getFilters() ?? [];
  99.         }
  100.         $this->queryParameterValidator->validateFilters($attributes['resource_class'], $resourceFilters, $queryParameters);
  101.     }
  102. }
  104. class_alias(QueryParameterValidateListener::class, \ApiPlatform\Core\EventListener\QueryParameterValidateListener::class);