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