interface ConstraintViolationInterface

A violation of a constraint that happened during validation.

For each constraint that fails during validation one or more violations are created. The violations store the violation message, the path to the failing element in the validation graph and the root element that was originally passed to the validator. For example, take the following graph:

<pre> (Person)---(firstName: string) \ (address: Address)---(street: string) </pre>

If the <tt>Person</tt> object is validated and validation fails for the "firstName" property, the generated violation has the <tt>Person</tt> instance as root and the property path "firstName". If validation fails for the "street" property of the related <tt>Address</tt> instance, the root element is still the person, but the property path is "address.street".

@author Bernhard Schussek <bschussek@gmail.com>

@api

Hierarchy

Expanded class hierarchy of ConstraintViolationInterface

All classes that implement ConstraintViolationInterface

File

drupal/core/vendor/symfony/validator/Symfony/Component/Validator/ConstraintViolationInterface.php, line 38

Namespace

Symfony\Component\Validator
View source

Members

Namesort descending Modifiers Type Description Overrides
ConstraintViolationInterface::getCode public function Returns a machine-digestible error code for the violation. 1
ConstraintViolationInterface::getInvalidValue public function Returns the value that caused the violation. 1
ConstraintViolationInterface::getMessage public function Returns the violation message. 1
ConstraintViolationInterface::getMessageParameters public function Returns the parameters to be inserted into the raw violation message. 1
ConstraintViolationInterface::getMessagePluralization public function Returns a number for pluralizing the violation message. 1
ConstraintViolationInterface::getMessageTemplate public function Returns the raw violation message. 1
ConstraintViolationInterface::getPropertyPath public function Returns the property path from the root element to the violation. 1
ConstraintViolationInterface::getRoot public function Returns the root element of the validation. 1