vendor/symfony/serializer/Normalizer/ConstraintViolationListNormalizer.php line 42

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.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. namespace Symfony\Component\Serializer\Normalizer;
  14. use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
  15. use Symfony\Component\Validator\ConstraintViolationListInterface;
  17. /**
  18.  * A normalizer that normalizes a ConstraintViolationListInterface instance.
  19.  *
  20.  * This Normalizer implements RFC7807 {@link https://tools.ietf.org/html/rfc7807}.
  21.  *
  22.  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  23.  * @author Kévin Dunglas <dunglas@gmail.com>
  24.  */
  25. class ConstraintViolationListNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
  26. {
  27.     public const INSTANCE = 'instance';
  28.     public const STATUS = 'status';
  29.     public const TITLE = 'title';
  30.     public const TYPE = 'type';
  31.     public const PAYLOAD_FIELDS = 'payload_fields';
  33.     private $defaultContext;
  34.     private $nameConverter;
  36.     public function __construct(array $defaultContext = [], NameConverterInterface $nameConverter = null)
  37.     {
  38.         $this->defaultContext = $defaultContext;
  39.         $this->nameConverter = $nameConverter;
  40.     }
  42.     public function normalize(mixed $object, string $format = null, array $context = []): array
  43.     {
  44.         if (\array_key_exists(self::PAYLOAD_FIELDS, $context)) {
  45.             $payloadFieldsToSerialize = $context[self::PAYLOAD_FIELDS];
  46.         } elseif (\array_key_exists(self::PAYLOAD_FIELDS, $this->defaultContext)) {
  47.             $payloadFieldsToSerialize = $this->defaultContext[self::PAYLOAD_FIELDS];
  48.         } else {
  49.             $payloadFieldsToSerialize = [];
  50.         }
  52.         if (\is_array($payloadFieldsToSerialize) && [] !== $payloadFieldsToSerialize) {
  53.             $payloadFieldsToSerialize = array_flip($payloadFieldsToSerialize);
  54.         }
  56.         $violations = [];
  57.         $messages = [];
  58.         foreach ($object as $violation) {
  59.             $propertyPath = $this->nameConverter ? $this->nameConverter->normalize($violation->getPropertyPath(), null, $format, $context) : $violation->getPropertyPath();
  61.             $violationEntry = [
  62.                 'propertyPath' => $propertyPath,
  63.                 'title' => $violation->getMessage(),
  64.                 'parameters' => $violation->getParameters(),
  65.             ];
  66.             if (null !== $code = $violation->getCode()) {
  67.                 $violationEntry['type'] = sprintf('urn:uuid:%s', $code);
  68.             }
  70.             $constraint = $violation->getConstraint();
  71.             if (
  72.                 [] !== $payloadFieldsToSerialize &&
  73.                 $constraint &&
  74.                 $constraint->payload &&
  75.                 // If some or all payload fields are whitelisted, add them
  76.                 $payloadFields = null === $payloadFieldsToSerialize || true === $payloadFieldsToSerialize ? $constraint->payload : array_intersect_key($constraint->payload, $payloadFieldsToSerialize)
  77.             ) {
  78.                 $violationEntry['payload'] = $payloadFields;
  79.             }
  81.             $violations[] = $violationEntry;
  83.             $prefix = $propertyPath ? sprintf('%s: ', $propertyPath) : '';
  84.             $messages[] = $prefix.$violation->getMessage();
  85.         }
  87.         $result = [
  88.             'type' => $context[self::TYPE] ?? $this->defaultContext[self::TYPE] ?? 'https://symfony.com/errors/validation',
  89.             'title' => $context[self::TITLE] ?? $this->defaultContext[self::TITLE] ?? 'Validation Failed',
  90.         ];
  91.         if (null !== $status = ($context[self::STATUS] ?? $this->defaultContext[self::STATUS] ?? null)) {
  92.             $result['status'] = $status;
  93.         }
  94.         if ($messages) {
  95.             $result['detail'] = implode("\n", $messages);
  96.         }
  97.         if (null !== $instance = ($context[self::INSTANCE] ?? $this->defaultContext[self::INSTANCE] ?? null)) {
  98.             $result['instance'] = $instance;
  99.         }
  101.         return $result + ['violations' => $violations];
  102.     }
  104.     /**
  105.      * @param array $context
  106.      */
  107.     public function supportsNormalization(mixed $data, string $format = null /* , array $context = [] */): bool
  108.     {
  109.         return $data instanceof ConstraintViolationListInterface;
  110.     }
  112.     public function hasCacheableSupportsMethod(): bool
  113.     {
  114.         return __CLASS__ === static::class;
  115.     }
  116. }