(Person)---(firstName: string)
     \
  (address: Address)---(street: string)

string getMessage()

Returns the violation message.

Return Value

string

The violation message

string getMessageTemplate()

Returns the raw violation message.

The raw violation message contains placeholders for the parameters returned by {@link getParameters}. Typically you'll pass the message template and parameters to a translation engine.

Return Value

string

The raw violation message

array getParameters()

Returns the parameters to be inserted into the raw violation message.

Return Value

array

a possibly empty list of parameters indexed by the names that appear in the message template

See also

getMessageTemplate()

int|null getPlural()

Returns a number for pluralizing the violation message.

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 Value

int|null

The number to use to pluralize of the message

mixed getRoot()

Returns the root element of the validation.

Return Value

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.

string getPropertyPath()

Returns the property path from the root element to the violation.

Return Value

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".

mixed getInvalidValue()

Returns the value that caused the violation.

Return Value

mixed

the invalid value that caused the validated constraint to fail

string|null getCode()

Returns a machine-digestible error code for the violation.

Return Value

string|null

The error code