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.0/Symfony/Component/Validator/ConstraintViolationInterface.html