vendor/api-platform/core/src/Serializer/AbstractConstraintViolationListNormalizer.php line 36

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\Serializer;
  16. use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
  17. use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
  18. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  19. use Symfony\Component\Validator\ConstraintViolation;
  20. use Symfony\Component\Validator\ConstraintViolationListInterface;
  22. /**
  23. * Common features regarding Constraint Violation normalization.
  24. *
  25. * @author Kévin Dunglas <dunglas@gmail.com>
  26. *
  27. * @internal
  28. */
  29. abstract class AbstractConstraintViolationListNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
  30. {
  31. public const FORMAT = null; // Must be overrode
  33. private $serializePayloadFields;
  34. private $nameConverter;
  36. public function __construct(array $serializePayloadFields = null, NameConverterInterface $nameConverter = null)
  37. {
  38. $this->nameConverter = $nameConverter;
  39. $this->serializePayloadFields = null === $serializePayloadFields ? null : array_flip($serializePayloadFields);
  40. }
  42. /**
  43. * {@inheritdoc}
  44. */
  45. public function supportsNormalization($data, $format = null, array $context = []): bool
  46. {
  47. return static::FORMAT === $format && $data instanceof ConstraintViolationListInterface;
  48. }
  50. /**
  51. * {@inheritdoc}
  52. */
  53. public function hasCacheableSupportsMethod(): bool
  54. {
  55. return true;
  56. }
  58. protected function getMessagesAndViolations(ConstraintViolationListInterface $constraintViolationList): array
  59. {
  60. $violations = $messages = [];
  62. foreach ($constraintViolationList as $violation) {
  63. $class = \is_object($root = $violation->getRoot()) ? \get_class($root) : null;
  64. $violationData = [
  65. 'propertyPath' => $this->nameConverter ? $this->nameConverter->normalize($violation->getPropertyPath(), $class, static::FORMAT) : $violation->getPropertyPath(),
  66. 'message' => $violation->getMessage(),
  67. 'code' => $violation->getCode(),
  68. ];
  70. $constraint = $violation instanceof ConstraintViolation ? $violation->getConstraint() : null;
  71. if (
  72. [] !== $this->serializePayloadFields &&
  73. $constraint &&
  74. $constraint->payload &&
  75. // If some fields are whitelisted, only them are added
  76. $payloadFields = null === $this->serializePayloadFields ? $constraint->payload : array_intersect_key($constraint->payload, $this->serializePayloadFields)
  77. ) {
  78. $violationData['payload'] = $payloadFields;
  79. }
  81. $violations[] = $violationData;
  82. $messages[] = ($violationData['propertyPath'] ? "{$violationData['propertyPath']}: " : '').$violationData['message'];
  83. }
  85. return [$messages, $violations];
  86. }
  87. }
  89. class_alias(AbstractConstraintViolationListNormalizer::class, \ApiPlatform\Core\Serializer\AbstractConstraintViolationListNormalizer::class);