ConstraintViolationInterface
in
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:
(Person)---(firstName: string)
\
(address: Address)---(street: string)
If the Person object is validated and validation fails for the "firstName" property, the generated violation has the Person instance as root and the property path "firstName". If validation fails for the "street" property of the related Address instance, the root element is still the person, but the property path is "address.street".
Tags
Table of Contents
Methods
- getCode() : string|null
- Returns a machine-digestible error code for the violation.
- getInvalidValue() : mixed
- Returns the value that caused the violation.
- getMessage() : string|Stringable
- Returns the violation message.
- getMessageTemplate() : string
- Returns the raw violation message.
- getParameters() : array<string|int, mixed>
- Returns the parameters to be inserted into the raw violation message.
- getPlural() : int|null
- Returns a number for pluralizing the violation message.
- getPropertyPath() : string
- Returns the property path from the root element to the violation.
- getRoot() : mixed
- Returns the root element of the validation.
Methods
getCode()
Returns a machine-digestible error code for the violation.
public
getCode() : string|null
Return values
string|nullgetInvalidValue()
Returns the value that caused the violation.
public
getInvalidValue() : mixed
Return values
mixed —the invalid value that caused the validated constraint to fail
getMessage()
Returns the violation message.
public
getMessage() : string|Stringable
Return values
string|StringablegetMessageTemplate()
Returns the raw violation message.
public
getMessageTemplate() : string
The raw violation message contains placeholders for the parameters returned by . Typically you'll pass the message template and parameters to a translation engine.
Return values
stringgetParameters()
Returns the parameters to be inserted into the raw violation message.
public
getParameters() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —a possibly empty list of parameters indexed by the names that appear in the message template
getPlural()
Returns a number for pluralizing the violation message.
public
getPlural() : int|null
For example, the message template could have different translation based on a parameter "choices":
- Please select exactly one entry. (choices=1)
- Please select two entries. (choices=2)
This method returns the value of the parameter for choosing the right pluralization form (in this case "choices").
Return values
int|nullgetPropertyPath()
Returns the property path from the root element to the violation.
public
getPropertyPath() : string
Return values
string —The property path indicates how the validator reached the invalid value from the root element. If the root element is a Person instance with a property "address" that contains an Address instance with an invalid property "street", the generated property path is "address.street". Property access is denoted by dots, while array access is denoted by square brackets, for example "addresses[1].street".
getRoot()
Returns the root element of the validation.
public
getRoot() : mixed
Return values
mixed —The value that was passed originally to the validator when the validation was started. Because the validator traverses the object graph, the value at which the violation occurs is not necessarily the value that was originally validated.