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, ?string $code = null, ?Constraint $constraint = null, $cause = null)
  53. {
  54. if (!\is_string($message) && !(\is_object($message) && method_exists($message, '__toString'))) {
  55. throw new \TypeError('Constraint violation message should be a string or an object which implements the __toString() method.');
  56. }
  58. $this->message = $message;
  59. $this->messageTemplate = $messageTemplate;
  60. $this->parameters = $parameters;
  61. $this->plural = $plural;
  62. $this->root = $root;
  63. $this->propertyPath = $propertyPath;
  64. $this->invalidValue = $invalidValue;
  65. $this->constraint = $constraint;
  66. $this->code = $code;
  67. $this->cause = $cause;
  68. }
  70. /**
  71. * Converts the violation into a string for debugging purposes.
  72. *
  73. * @return string
  74. */
  75. public function __toString()
  76. {
  77. if (\is_object($this->root)) {
  78. $class = 'Object('.\get_class($this->root).')';
  79. } elseif (\is_array($this->root)) {
  80. $class = 'Array';
  81. } else {
  82. $class = (string) $this->root;
  83. }
  85. $propertyPath = (string) $this->propertyPath;
  87. if ('' !== $propertyPath && '[' !== $propertyPath[0] && '' !== $class) {
  88. $class .= '.';
  89. }
  91. if (null !== ($code = $this->code) && '' !== $code) {
  92. $code = ' (code '.$code.')';
  93. }
  95. return $class.$propertyPath.":\n ".$this->getMessage().$code;
  96. }
  98. /**
  99. * {@inheritdoc}
  100. */
  101. public function getMessageTemplate()
  102. {
  103. return (string) $this->messageTemplate;
  104. }
  106. /**
  107. * {@inheritdoc}
  108. */
  109. public function getParameters()
  110. {
  111. return $this->parameters;
  112. }
  114. /**
  115. * {@inheritdoc}
  116. */
  117. public function getPlural()
  118. {
  119. return $this->plural;
  120. }
  122. /**
  123. * {@inheritdoc}
  124. */
  125. public function getMessage()
  126. {
  127. return $this->message;
  128. }
  130. /**
  131. * {@inheritdoc}
  132. */
  133. public function getRoot()
  134. {
  135. return $this->root;
  136. }
  138. /**
  139. * {@inheritdoc}
  140. */
  141. public function getPropertyPath()
  142. {
  143. return (string) $this->propertyPath;
  144. }
  146. /**
  147. * {@inheritdoc}
  148. */
  149. public function getInvalidValue()
  150. {
  151. return $this->invalidValue;
  152. }
  154. /**
  155. * Returns the constraint whose validation caused the violation.
  156. *
  157. * @return Constraint|null
  158. */
  159. public function getConstraint()
  160. {
  161. return $this->constraint;
  162. }
  164. /**
  165. * Returns the cause of the violation.
  166. *
  167. * @return mixed
  168. */
  169. public function getCause()
  170. {
  171. return $this->cause;
  172. }
  174. /**
  175. * {@inheritdoc}
  176. */
  177. public function getCode()
  178. {
  179. return $this->code;
  180. }
  181. }