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 $message;
  22.     private $messageTemplate;
  23.     private $parameters;
  24.     private $plural;
  25.     private $root;
  26.     private $propertyPath;
  27.     private $invalidValue;
  28.     private $constraint;
  29.     private $code;
  30.     private $cause;
  32.     /**
  33.      * Creates a new constraint violation.
  34.      *
  35.      * @param string|object $message         The violation message as a string or a stringable object
  36.      * @param string        $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        $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 mixed         $cause           The cause of the violation
  49.      */
  50.     public function __construct($message, ?string $messageTemplate, array $parameters, $root, ?string $propertyPath, $invalidValue, int $plural = null, $code = null, Constraint $constraint = null, $cause = null)
  51.     {
  52.         if (null === $message) {
  53.             @trigger_error(sprintf('Passing a null message when instantiating a "%s" is deprecated since Symfony 4.4.', __CLASS__), E_USER_DEPRECATED);
  54.             $message = '';
  55.         }
  57.         if (null !== $code && !\is_string($code)) {
  58.             @trigger_error(sprintf('Not using a string as the error code in %s() is deprecated since Symfony 4.4. A type-hint will be added in 5.0.', __METHOD__), E_USER_DEPRECATED);
  59.         }
  61.         if (!\is_string($message) && !(\is_object($message) && method_exists($message, '__toString'))) {
  62.             throw new \TypeError('Constraint violation message should be a string or an object which implements the __toString() method.');
  63.         }
  65.         $this->message = $message;
  66.         $this->messageTemplate = $messageTemplate;
  67.         $this->parameters = $parameters;
  68.         $this->plural = $plural;
  69.         $this->root = $root;
  70.         $this->propertyPath = $propertyPath;
  71.         $this->invalidValue = $invalidValue;
  72.         $this->constraint = $constraint;
  73.         $this->code = $code;
  74.         $this->cause = $cause;
  75.     }
  77.     /**
  78.      * Converts the violation into a string for debugging purposes.
  79.      *
  80.      * @return string The violation as string
  81.      */
  82.     public function __toString()
  83.     {
  84.         if (\is_object($this->root)) {
  85.             $class = 'Object('.\get_class($this->root).')';
  86.         } elseif (\is_array($this->root)) {
  87.             $class = 'Array';
  88.         } else {
  89.             $class = (string) $this->root;
  90.         }
  92.         $propertyPath = (string) $this->propertyPath;
  93.         $code = (string) $this->code;
  95.         if ('' !== $propertyPath && '[' !== $propertyPath[0] && '' !== $class) {
  96.             $class .= '.';
  97.         }
  99.         if ('' !== $code) {
  100.             $code = ' (code '.$code.')';
  101.         }
  103.         return $class.$propertyPath.":\n    ".$this->getMessage().$code;
  104.     }
  106.     /**
  107.      * {@inheritdoc}
  108.      */
  109.     public function getMessageTemplate()
  110.     {
  111.         return $this->messageTemplate;
  112.     }
  114.     /**
  115.      * {@inheritdoc}
  116.      */
  117.     public function getParameters()
  118.     {
  119.         return $this->parameters;
  120.     }
  122.     /**
  123.      * {@inheritdoc}
  124.      */
  125.     public function getPlural()
  126.     {
  127.         return $this->plural;
  128.     }
  130.     /**
  131.      * {@inheritdoc}
  132.      */
  133.     public function getMessage()
  134.     {
  135.         return $this->message;
  136.     }
  138.     /**
  139.      * {@inheritdoc}
  140.      */
  141.     public function getRoot()
  142.     {
  143.         return $this->root;
  144.     }
  146.     /**
  147.      * {@inheritdoc}
  148.      */
  149.     public function getPropertyPath()
  150.     {
  151.         return $this->propertyPath;
  152.     }
  154.     /**
  155.      * {@inheritdoc}
  156.      */
  157.     public function getInvalidValue()
  158.     {
  159.         return $this->invalidValue;
  160.     }
  162.     /**
  163.      * Returns the constraint whose validation caused the violation.
  164.      *
  165.      * @return Constraint|null The constraint or null if it is not known
  166.      */
  167.     public function getConstraint()
  168.     {
  169.         return $this->constraint;
  170.     }
  172.     /**
  173.      * Returns the cause of the violation.
  174.      *
  175.      * @return mixed
  176.      */
  177.     public function getCause()
  178.     {
  179.         return $this->cause;
  180.     }
  182.     /**
  183.      * {@inheritdoc}
  184.      */
  185.     public function getCode()
  186.     {
  187.         return $this->code;
  188.     }
  189. }