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|\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($message, ?string $messageTemplate, array $parameters, $root, ?string $propertyPath, $invalidValue, int $plural = null, $code = null, Constraint $constraint = null, $cause = null)
  53.     {
  54.         if (null === $message) {
  55.             @trigger_error(sprintf('Passing a null message when instantiating a "%s" is deprecated since Symfony 4.4.', __CLASS__), \E_USER_DEPRECATED);
  56.             $message = '';
  57.         }
  59.         if (null !== $code && !\is_string($code)) {
  60.             @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);
  61.         }
  63.         if (!\is_string($message) && !(\is_object($message) && method_exists($message, '__toString'))) {
  64.             throw new \TypeError('Constraint violation message should be a string or an object which implements the __toString() method.');
  65.         }
  67.         $this->message = $message;
  68.         $this->messageTemplate = $messageTemplate;
  69.         $this->parameters = $parameters;
  70.         $this->plural = $plural;
  71.         $this->root = $root;
  72.         $this->propertyPath = $propertyPath;
  73.         $this->invalidValue = $invalidValue;
  74.         $this->constraint = $constraint;
  75.         $this->code = $code;
  76.         $this->cause = $cause;
  77.     }
  79.     /**
  80.      * Converts the violation into a string for debugging purposes.
  81.      *
  82.      * @return string The violation as string
  83.      */
  84.     public function __toString()
  85.     {
  86.         if (\is_object($this->root)) {
  87.             $class = 'Object('.\get_class($this->root).')';
  88.         } elseif (\is_array($this->root)) {
  89.             $class = 'Array';
  90.         } else {
  91.             $class = (string) $this->root;
  92.         }
  94.         $propertyPath = (string) $this->propertyPath;
  95.         $code = (string) $this->code;
  97.         if ('' !== $propertyPath && '[' !== $propertyPath[0] && '' !== $class) {
  98.             $class .= '.';
  99.         }
  101.         if ('' !== $code) {
  102.             $code = ' (code '.$code.')';
  103.         }
  105.         return $class.$propertyPath.":\n    ".$this->getMessage().$code;
  106.     }
  108.     /**
  109.      * {@inheritdoc}
  110.      */
  111.     public function getMessageTemplate()
  112.     {
  113.         return $this->messageTemplate;
  114.     }
  116.     /**
  117.      * {@inheritdoc}
  118.      */
  119.     public function getParameters()
  120.     {
  121.         return $this->parameters;
  122.     }
  124.     /**
  125.      * {@inheritdoc}
  126.      */
  127.     public function getPlural()
  128.     {
  129.         return $this->plural;
  130.     }
  132.     /**
  133.      * {@inheritdoc}
  134.      */
  135.     public function getMessage()
  136.     {
  137.         return $this->message;
  138.     }
  140.     /**
  141.      * {@inheritdoc}
  142.      */
  143.     public function getRoot()
  144.     {
  145.         return $this->root;
  146.     }
  148.     /**
  149.      * {@inheritdoc}
  150.      */
  151.     public function getPropertyPath()
  152.     {
  153.         return $this->propertyPath;
  154.     }
  156.     /**
  157.      * {@inheritdoc}
  158.      */
  159.     public function getInvalidValue()
  160.     {
  161.         return $this->invalidValue;
  162.     }
  164.     /**
  165.      * Returns the constraint whose validation caused the violation.
  166.      *
  167.      * @return Constraint|null The constraint or null if it is not known
  168.      */
  169.     public function getConstraint()
  170.     {
  171.         return $this->constraint;
  172.     }
  174.     /**
  175.      * Returns the cause of the violation.
  176.      *
  177.      * @return mixed
  178.      */
  179.     public function getCause()
  180.     {
  181.         return $this->cause;
  182.     }
  184.     /**
  185.      * {@inheritdoc}
  186.      */
  187.     public function getCode()
  188.     {
  189.         return $this->code;
  190.     }
  191. }