ConstraintViolationInterface
интерфейс ConstraintViolationInterface
Нарушение ограничения, произошедшее во время валидации.
Для каждого ограничения, которое не выполняется во время валидации, создается одно или несколько нарушений. Нарушения хранят сообщение о нарушении, путь к элементу, нарушающему валидацию, в графе валидации и корневой элемент, который был первоначально передан валидатору. Например, рассмотрим следующую графу:
(Person)---(firstName: string)
\
(address: Address)---(street: string)
Если объект Person валидируется, и валидация терпит неудачу для свойства "firstName", сгенерированное нарушение имеет экземпляр Person в качестве корня и путь свойства "firstName". Если валидация терпит неудачу для свойства "street" связанного экземпляра Address, корневой элемент по-прежнему является человеком, но путь свойства — "address.street".
Методы
| строка | getMessage() Возвращает сообщение о нарушении. | |
| строка | getMessageTemplate() Возвращает исходное сообщение о нарушении. | |
| массив | getParameters() Возвращает параметры, которые должны быть вставлены в исходное сообщение о нарушении. | |
| int|null | getPlural() Возвращает число для множественного числа сообщения о нарушении. | |
| смешанный тип | getRoot() Возвращает корневой элемент валидации. | |
| строка | getPropertyPath() Возвращает путь свойства от корневого элемента до нарушения. | |
| смешанный тип | getInvalidValue() Возвращает значение, вызвавшее нарушение. | |
| строка|null | getCode() Возвращает удобочитаемый код ошибки нарушения. |
Подробности
строка getMessage()
Возвращает сообщение о нарушении.
Значение, возвращаемое функцией
| строка | Сообщение о нарушении |
строка getMessageTemplate()
Возвращает исходное сообщение о нарушении.
Исходное сообщение о нарушении содержит заполнитель для параметров, возвращаемых {@link getParameters}. Обычно вы передаете шаблон сообщения и параметры в механизм перевода.
Значение, возвращаемое функцией
| строка | Исходное сообщение о нарушении |
массив getParameters()
Возвращает параметры, которые должны быть вставлены в исходное сообщение о нарушении.
Значение, возвращаемое функцией
| массив | Возможный пустой список параметров, индексированных именами, которые появляются в шаблоне сообщения. |
См. также
| getMessageTemplate() |
int|null getPlural()
Возвращает число для множественного числа сообщения о нарушении.
Например, шаблон сообщения может иметь разные переводы, основанные на параметре "choices":
- Пожалуйста, выберите ровно одну запись. (choices=1)
- Пожалуйста, выберите две записи. (choices=2)
Этот метод возвращает значение параметра для выбора правильной формы множественного числа (в данном случае "choices").
Значение, возвращаемое функцией
| int|null | Число, используемое для множественного числа сообщения |
смешанный тип getRoot()
Возвращает корневой элемент валидации.
Значение, возвращаемое функцией
| смешанный тип | Значение, которое было первоначально передано валидатору при запуске валидации. Поскольку валидатор обходит граф объектов, значение, в котором возникает нарушение, необязательно является значением, которое первоначально валидировалось. |
строка getPropertyPath()
Возвращает путь свойства от корневого элемента до нарушения.
Значение, возвращаемое функцией
| строка | Путь свойства указывает, как валидатор достиг недействительного значения от корневого элемента. Если корневой элемент — экземпляр Person со свойством "address", содержащим экземпляр Address с недопустимым свойством "street", сгенерированный путь свойства — "address.street". Доступ к свойствам обозначается точками, а доступ к массивам — квадратными скобками, например "addresses[1].street". |
смешанный тип getInvalidValue()
Возвращает значение, вызвавшее нарушение.
Значение, возвращаемое функцией
| смешанный тип | Недействительное значение, которое вызвало сбой валидации ограничения. |
строка|null getCode()
Возвращает удобочитаемый код ошибки нарушения.
Значение, возвращаемое функцией
| строка|null | Код ошибки |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Validator/ConstraintViolationInterface.html
