vendor/symfony/validator/ConstraintViolation.php line 19

Open in your IDE?
  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\Validator;
  14. /**
  15.  * Default implementation of {@ConstraintViolationInterface}.
  16.  *
  17.  * @author Bernhard Schussek <bschussek@gmail.com>
  18.  */
  19. class ConstraintViolation implements ConstraintViolationInterface
  20. {
  21.     private string|\Stringable $message;
  22.     private ?string $messageTemplate;
  23.     private array $parameters;
  24.     private ?int $plural;
  25.     private mixed $root;
  26.     private ?string $propertyPath;
  27.     private mixed $invalidValue;
  28.     private $constraint;
  29.     private ?string $code;
  30.     private mixed $cause;
  32.     /**
  33.      * Creates a new constraint violation.
  34.      *
  35.      * @param string|\Stringable $message         The violation message as a string or a stringable object
  36.      * @param string|null        $messageTemplate The raw violation message
  37.      * @param array              $parameters      The parameters to substitute in the
  38.      *                                            raw violation message
  39.      * @param mixed              $root            The value originally passed to the
  40.      *                                            validator
  41.      * @param string|null        $propertyPath    The property path from the root
  42.      *                                            value to the invalid value
  43.      * @param mixed              $invalidValue    The invalid value that caused this
  44.      *                                            violation
  45.      * @param int|null           $plural          The number for determining the plural
  46.      *                                            form when translating the message
  47.      * @param string|null        $code            The error code of the violation
  48.      * @param Constraint|null    $constraint      The constraint whose validation
  49.      *                                            caused the violation
  50.      * @param mixed              $cause           The cause of the violation
  51.      */
  52.     public function __construct(string|\Stringable $message, ?string $messageTemplate, array $parameters, mixed $root, ?string $propertyPath, mixed $invalidValue, int $plural = null, string $code = null, Constraint $constraint = null, mixed $cause = null)
  53.     {
  54.         $this->message = $message;
  55.         $this->messageTemplate = $messageTemplate;
  56.         $this->parameters = $parameters;
  57.         $this->plural = $plural;
  58.         $this->root = $root;
  59.         $this->propertyPath = $propertyPath;
  60.         $this->invalidValue = $invalidValue;
  61.         $this->constraint = $constraint;
  62.         $this->code = $code;
  63.         $this->cause = $cause;
  64.     }
  66.     /**
  67.      * Converts the violation into a string for debugging purposes.
  68.      */
  69.     public function __toString(): string
  70.     {
  71.         if (\is_object($this->root)) {
  72.             $class = 'Object('.\get_class($this->root).')';
  73.         } elseif (\is_array($this->root)) {
  74.             $class = 'Array';
  75.         } else {
  76.             $class = (string) $this->root;
  77.         }
  79.         $propertyPath = (string) $this->propertyPath;
  81.         if ('' !== $propertyPath && '[' !== $propertyPath[0] && '' !== $class) {
  82.             $class .= '.';
  83.         }
  85.         if (null !== ($code = $this->code) && '' !== $code) {
  86.             $code = ' (code '.$code.')';
  87.         }
  89.         return $class.$propertyPath.":\n    ".$this->getMessage().$code;
  90.     }
  92.     /**
  93.      * {@inheritdoc}
  94.      */
  95.     public function getMessageTemplate(): string
  96.     {
  97.         return (string) $this->messageTemplate;
  98.     }
  100.     /**
  101.      * {@inheritdoc}
  102.      */
  103.     public function getParameters(): array
  104.     {
  105.         return $this->parameters;
  106.     }
  108.     /**
  109.      * {@inheritdoc}
  110.      */
  111.     public function getPlural(): ?int
  112.     {
  113.         return $this->plural;
  114.     }
  116.     /**
  117.      * {@inheritdoc}
  118.      */
  119.     public function getMessage(): string|\Stringable
  120.     {
  121.         return $this->message;
  122.     }
  124.     /**
  125.      * {@inheritdoc}
  126.      */
  127.     public function getRoot(): mixed
  128.     {
  129.         return $this->root;
  130.     }
  132.     /**
  133.      * {@inheritdoc}
  134.      */
  135.     public function getPropertyPath(): string
  136.     {
  137.         return (string) $this->propertyPath;
  138.     }
  140.     /**
  141.      * {@inheritdoc}
  142.      */
  143.     public function getInvalidValue(): mixed
  144.     {
  145.         return $this->invalidValue;
  146.     }
  148.     /**
  149.      * Returns the constraint whose validation caused the violation.
  150.      */
  151.     public function getConstraint(): ?Constraint
  152.     {
  153.         return $this->constraint;
  154.     }
  156.     /**
  157.      * Returns the cause of the violation.
  158.      */
  159.     public function getCause(): mixed
  160.     {
  161.         return $this->cause;
  162.     }
  164.     /**
  165.      * {@inheritdoc}
  166.      */
  167.     public function getCode(): ?string
  168.     {
  169.         return $this->code;
  170.     }
  171. }