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

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\Core\EventListener;
  16. use ApiPlatform\Core\Filter\QueryParameterValidator;
  17. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  18. use ApiPlatform\Core\Util\RequestAttributesExtractor;
  19. use ApiPlatform\Core\Util\RequestParser;
  20. use Symfony\Component\HttpKernel\Event\RequestEvent;
  22. /**
  23.  * Validates query parameters depending on filter description.
  24.  *
  25.  * @author Julien Deniau <julien.deniau@mapado.com>
  26.  */
  27. final class QueryParameterValidateListener
  28. {
  29.     private $resourceMetadataFactory;
  31.     private $queryParameterValidator;
  33.     public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, QueryParameterValidator $queryParameterValidator)
  34.     {
  35.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  36.         $this->queryParameterValidator = $queryParameterValidator;
  37.     }
  39.     public function onKernelRequest(RequestEvent $event)
  40.     {
  41.         $request = $event->getRequest();
  42.         if (
  43.             !$request->isMethodSafe()
  44.             || !($attributes = RequestAttributesExtractor::extractAttributes($request))
  45.             || !isset($attributes['collection_operation_name'])
  46.             || !($operationName = $attributes['collection_operation_name'])
  47.             || 'GET' !== $request->getMethod()
  48.         ) {
  49.             return;
  50.         }
  51.         $queryString = RequestParser::getQueryString($request);
  52.         $queryParameters = $queryString ? RequestParser::parseRequestParams($queryString) : [];
  54.         $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
  55.         $resourceFilters = $resourceMetadata->getCollectionOperationAttribute($operationName, 'filters', [], true);
  57.         $this->queryParameterValidator->validateFilters($attributes['resource_class'], $resourceFilters, $queryParameters);
  58.     }
  59. }