ConstraintViolationInterface
интерфейс ConstraintViolationInterface
Нарушение ограничения, произошедшее во время валидации.
Для каждого ограничения, которое не выполняется во время валидации, создается одно или несколько нарушений. Нарушения хранят сообщение об ошибке, путь к нарушенному элементу в графе валидации и корневой элемент, который изначально был передан валидатору. Например, рассмотрим следующую диаграмму:
(Person)---(firstName: string)
\
(address: Address)---(street: string)
Если объект Person валидируется и валидация завершается неудачей для свойства "firstName", сгенерированное нарушение имеет экземпляр Person в качестве корня и путь свойства "firstName". Если валидация завершается неудачей для свойства "street" связанного экземпляра Address, корневым элементом по-прежнему является человек, но путь свойства равен "address.street".
Методы
| string | getMessage() Возвращает сообщение о нарушении. | |
| string | getMessageTemplate() Возвращает исходное сообщение о нарушении. | |
| array | getMessageParameters() устарело Возвращает параметры, которые должны быть вставлены в исходное сообщение о нарушении. | |
| int|null | getMessagePluralization() устарело Возвращает число для множественного числа сообщения о нарушении. | |
| mixed | getRoot() Возвращает корневой элемент валидации. | |
| string | getPropertyPath() Возвращает путь к свойству от корневого элемента до нарушения. | |
| mixed | getInvalidValue() Возвращает значение, вызвавшее нарушение. | |
| mixed | getCode() Возвращает удобочитаемый код ошибки для нарушения. |
Подробности
string getMessage()
Возвращает сообщение о нарушении.
Возвращаемое значение
| string | Сообщение о нарушении |
string getMessageTemplate()
Возвращает исходное сообщение о нарушении.
Исходное сообщение о нарушении содержит заполнитель для параметров, возвращаемых {@link getMessageParameters}. Обычно вы передаете шаблон сообщения и параметры в движок перевода.
Возвращаемое значение
| string | Исходное сообщение о нарушении |
array getMessageParameters() устарело
устарело
Возвращает параметры, которые должны быть вставлены в исходное сообщение о нарушении.
Возвращаемое значение
| array | возможно пустой список параметров, индексированных по именам, которые появляются в шаблоне сообщения |
См. также
| getMessageTemplate() |
int|null getMessagePluralization() устарело
устарело
Возвращает число для множественного числа сообщения о нарушении.
Например, шаблон сообщения может иметь разные переводы, основанные на параметре "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 | недействительное значение, которое привело к тому, что валидированное ограничение не выполнилось |
mixed getCode()
Возвращает удобочитаемый код ошибки для нарушения.
Возвращаемое значение
| mixed | Код ошибки |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Validator/ConstraintViolationInterface.html
