НарушениеОграничения

__construct(string $message, string $messageTemplate, array $parameters, mixed $root, string $propertyPath, mixed $invalidValue, int|null $plural = null, mixed $code = null, Constraint $constraint = null, mixed $cause = null)

Создаёт новое нарушение ограничения.

Параметры

string	$message	Сообщение о нарушении
string	$messageTemplate	Исходное сообщение о нарушении
array	$parameters	Параметры для подстановки в исходное сообщение о нарушении
mixed	$root	Значение, первоначально переданное валидатору
string	$propertyPath	Путь к свойству от корневого значения до некорректного значения
mixed	$invalidValue	Некорректное значение, вызвавшее это нарушение
int|null	$plural	Число для определения формы множественного числа при переводе сообщения
mixed	$code	Код ошибки нарушения
Constraint	$constraint	Ограничение, валидация которого привела к нарушению
mixed	$cause	Причина нарушения

string __toString()

Преобразует нарушение в строку для отладки.

Возвращаемое значение

string

Нарушение в виде строки

string getMessageTemplate()

Возвращает исходное сообщение о нарушении.

Исходное сообщение о нарушении содержит заглушки для параметров, возвращаемых {@link getMessageParameters}. Обычно вы передаёте шаблон сообщения и параметры в движок перевода.

Возвращаемое значение

string

Исходное сообщение о нарушении

array getMessageParameters() ^{устарело}

^{устарело}

с версии 2.7, будет удалено в 3.0. Используйте getParameters() вместо этого

Возвращает параметры для подстановки в исходное сообщение о нарушении.

Возвращаемое значение

array

возможно пустой список параметров, индексированных именами, которые появляются в шаблоне сообщения

getParameters()

Псевдоним для {@link getMessageParameters()}.

int|null getMessagePluralization() ^{устарело}

^{устарело}

с версии 2.7, будет удалено в 3.0. Используйте getPlural() вместо этого

Возвращает число для склонения сообщения о нарушении.

Например, шаблон сообщения может иметь разные переводы в зависимости от параметра «choices»:

• Пожалуйста, выберите ровно одну запись. (choices=1)
• Пожалуйста, выберите две записи. (choices=2)

Этот метод возвращает значение параметра для выбора правильной формы множественного числа (в данном случае «choices»).

Возвращаемое значение

int|null

Число для склонения сообщения

getPlural()

Псевдоним для {@link getMessagePluralization()}.

string getMessage()

Возвращает сообщение о нарушении.

Возвращаемое значение

string

Сообщение о нарушении

mixed getRoot()

Возвращает корневой элемент валидации.

Возвращаемое значение

mixed

Значение, которое было первоначально передано валидатору при запуске валидации. Поскольку валидатор проходит по объектной графе, значение, в котором возникает нарушение, не обязательно является значением, которое изначально было валидировано.

string getPropertyPath()

Возвращает путь к свойству от корневого элемента до нарушения.

Возвращаемое значение

string

Путь к свойству показывает, как валидатор достиг некорректного значения от корневого элемента. Если корневой элемент — экземпляр Person со свойством «address», содержащим экземпляр Address с некорректным свойством «street», сгенерированный путь к свойству — «address.street». Доступ к свойству обозначается точками, а доступ к массиву — квадратными скобками, например «addresses[1].street».

mixed getInvalidValue()

Возвращает значение, вызвавшее нарушение.

Возвращаемое значение

mixed

некорректное значение, вызвавшее сбой валидируемого ограничения

Constraint|null getConstraint()

Возвращает ограничение, валидация которого привела к нарушению.

Возвращаемое значение

Constraint|null

Ограничение или null, если оно неизвестно

mixed getCause()

Возвращает причину нарушения.

Возвращаемое значение

mixed

string|null getCode()

Возвращает код ошибки для нарушения, удобный для обработки машиной.

Возвращаемое значение

string|null

Код ошибки