ConstraintViolationInterface

интерфейс ConstraintViolationInterface

Нарушение ограничения, произошедшее во время валидации.

Для каждого ограничения, которое не выполняется во время валидации, создаётся одно или несколько нарушений. Нарушения хранят сообщение о нарушении, путь к элементу с ошибкой в графе валидации и корневой элемент, который изначально был передан валидатору. Например, рассмотрим следующую графу:

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

Если объект Person валидируется и валидация терпит неудачу для свойства "firstName", сгенерированное нарушение имеет экземпляр Person в качестве корневого и путь к свойству "firstName". Если валидация терпит неудачу для свойства "street" связанного экземпляра Address, корневым элементом по-прежнему остаётся человек, но путь к свойству — "address.street".

Методы

string	getMessage() Возвращает сообщение о нарушении.
string	getMessageTemplate() Возвращает исходное сообщение о нарушении.
array	getParameters() Возвращает параметры, которые должны быть вставлены в исходное сообщение о нарушении.
int\|null	getPlural() Возвращает число для склонения сообщения о нарушении.
mixed	getRoot() Возвращает корневой элемент валидации.
string	getPropertyPath() Возвращает путь к свойству от корневого элемента до нарушения.
mixed	getInvalidValue() Возвращает значение, вызвавшее нарушение.
string\|null	getCode() Возвращает удобочитаемый код ошибки для нарушения.

Подробности

string getMessage()

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

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

string

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

string getMessageTemplate()

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

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

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

string

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

array getParameters()

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

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

array

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

См. также

getMessageTemplate()

int|null getPlural()

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

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

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

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

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

int|null

Число, используемое для склонения сообщения

mixed getRoot()

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

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

mixed

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

string getPropertyPath()

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

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

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

mixed getInvalidValue()

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

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

mixed

Некорректное значение, вызвавшее провал валидации ограничения.

string|null getCode()

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

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

string|null

Код ошибки

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Validator/ConstraintViolationInterface.html