Class

Symfony\Component\Validator\ConstraintViolation

class ConstraintViolation implements ConstraintViolationInterface

Default implementation of {@ConstraintViolationInterface}.

Methods

__construct(string $message, string $messageTemplate, array $messageParameters, mixed $root, string $propertyPath, mixed $invalidValue, integer|null $messagePluralization = null, mixed $code = null)

Creates a new constraint violation.

string __toString()

Converts the violation into a string for debugging purposes.

string getMessageTemplate()

Returns the raw violation message.

array getMessageParameters()

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

integer|null getMessagePluralization()

Returns a number for pluralizing the violation message.

string getMessage()

Returns the violation message.

mixed getRoot()

Returns the root element of the validation.

string getPropertyPath()

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

mixed getInvalidValue()

Returns the value that caused the violation.

mixed getCode()

Returns a machine-digestible error code for the violation.

Details

at line 79
public __construct(string $message, string $messageTemplate, array $messageParameters, mixed $root, string $propertyPath, mixed $invalidValue, integer|null $messagePluralization = null, mixed $code = null)

Creates a new constraint violation.

Parameters

string $message The violation message.
string $messageTemplate The raw violation message.
array $messageParameters The parameters to substitute in the raw message.
mixed $root The value originally passed to the validator.
string $propertyPath The property path from the root value to the invalid value.
mixed $invalidValue The invalid value causing the violation.
integer|null $messagePluralization The pluralization parameter.
mixed $code The error code of the violation, if any.

at line 96
public string __toString()

Converts the violation into a string for debugging purposes.

Return Value

string The violation as string.

at line 116
public string getMessageTemplate()

Returns the raw violation message.

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

Return Value

string The raw violation message.

at line 124
public array getMessageParameters()

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.

at line 132
public integer|null getMessagePluralization()

Returns a number for pluralizing the violation message.

For example, the message template could have different translation based on a parameter "choices":

This method returns the value of the parameter for choosing the right pluralization form (in this case "choices").

Return Value

integer|null The number to use to pluralize of the message.

at line 140
public string getMessage()

Returns the violation message.

Return Value

string The violation message.

at line 148
public 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.

at line 156
public 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".

at line 164
public mixed getInvalidValue()

Returns the value that caused the violation.

Return Value

mixed The invalid value that caused the validated constraint to fail.

at line 172
public mixed getCode()

Returns a machine-digestible error code for the violation.

Return Value

mixed The error code.