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.
https://api.symfony.com/4.1/Symfony/Component/Validator/ConstraintViolationInterface.html
