vendor/api-platform/core/src/Symfony/EventListener/ValidateListener.php line 47

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\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  17. use ApiPlatform\Core\Metadata\Resource\ToggleableOperationAttributeTrait;
  18. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  19. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  20. use ApiPlatform\Util\RequestAttributesExtractor;
  21. use ApiPlatform\Validator\Exception\ValidationException;
  22. use ApiPlatform\Validator\ValidatorInterface;
  23. use Symfony\Component\HttpFoundation\Response;
  24. use Symfony\Component\HttpKernel\Event\ViewEvent;
  26. /**
  27.  * Validates data.
  28.  *
  29.  * @author Kévin Dunglas <dunglas@gmail.com>
  30.  */
  31. final class ValidateListener
  32. {
  33.     use OperationRequestInitiatorTrait;
  34.     use ToggleableOperationAttributeTrait;
  36.     public const OPERATION_ATTRIBUTE_KEY = 'validate';
  38.     private $validator;
  39.     private $resourceMetadataFactory;
  41.     public function __construct(ValidatorInterface $validator, $resourceMetadataFactory)
  42.     {
  43.         $this->validator = $validator;
  44.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  46.         if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  47.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  48.         } else {
  49.             $this->resourceMetadataCollectionFactory = $resourceMetadataFactory;
  50.         }
  51.     }
  53.     /**
  54.      * Validates data returned by the controller if applicable.
  55.      *
  56.      * @throws ValidationException
  57.      */
  58.     public function onKernelView(ViewEvent $event): void
  59.     {
  60.         $controllerResult = $event->getControllerResult();
  61.         $request = $event->getRequest();
  62.         $operation = $this->initializeOperation($request);
  64.         if (
  65.             $controllerResult instanceof Response
  66.             || $request->isMethodSafe()
  67.             || $request->isMethod('DELETE')
  68.             || !($attributes = RequestAttributesExtractor::extractAttributes($request))
  69.         ) {
  70.             return;
  71.         }
  73.         if ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface &&
  74.             (!$operation || !($operation->canValidate() ?? true))
  75.         ) {
  76.             return;
  77.         }
  79.         // TODO: 3.0 remove condition
  80.         if (
  81.             $this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface && (
  82.                 !$attributes['receive']
  83.                 || $this->isOperationAttributeDisabled($attributes, self::OPERATION_ATTRIBUTE_KEY)
  84.             )
  85.         ) {
  86.             return;
  87.         }
  89.         $validationContext = $operation ? ($operation->getValidationContext() ?? []) : [];
  91.         if (!$validationContext && $this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  92.             $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
  93.             $validationGroups = $resourceMetadata->getOperationAttribute($attributes, 'validation_groups', null, true);
  94.             $validationContext = ['groups' => $validationGroups];
  95.         }
  97.         $this->validator->validate($controllerResult, $validationContext);
  98.     }
  99. }
  101. class_alias(ValidateListener::class, \ApiPlatform\Core\Validator\EventListener\ValidateListener::class);