Spec-Zone.ru › Symfony 4.1

НарушениеОграничения

класс НарушениеОграничения реализует ConstraintViolationInterface

Стандартная реализация {@ConstraintViolationInterface}.

Методы

__construct(string|null $message, string|null $messageTemplate, array $parameters, mixed $root, string|null $propertyPath, mixed $invalidValue, int $plural = null, mixed $code = null, Constraint $constraint = null, mixed $cause = null)

Создаёт новое нарушение ограничения.

string __toString()

Преобразует нарушение в строку для целей отладки.

string getMessageTemplate()

Возвращает исходное сообщение об ошибке.

array getParameters()

Возвращает параметры для вставки в исходное сообщение об ошибке.

int|null getPlural()

Возвращает число для склонения сообщения об ошибке.

string getMessage()

Возвращает сообщение об ошибке.

mixed getRoot()

Возвращает корневой элемент валидации.

string getPropertyPath()

Возвращает путь к свойству от корневого элемента до нарушения.

mixed getInvalidValue()

Возвращает значение, вызвавшее нарушение.

Constraint|null getConstraint()

Возвращает ограничение, валидация которого вызвала нарушение.

mixed getCause()

Возвращает причину нарушения.

string|null getCode()

Возвращает удобочитаемый код ошибки для нарушения.

Подробности

__construct(string|null $message, string|null $messageTemplate, array $parameters, mixed $root, string|null $propertyPath, mixed $invalidValue, int $plural = null, mixed $code = null, Constraint $constraint = null, mixed $cause = null)

Создаёт новое нарушение ограничения.

Параметры

string|null $message Сообщение об ошибке
string|null $messageTemplate Исходное сообщение об ошибке
array $parameters Параметры для подстановки в исходное сообщение об ошибке
mixed $root Значение, изначально переданное валидатору
string|null $propertyPath Путь к свойству от корневого значения до некорректного значения
mixed $invalidValue Некорректное значение, вызвавшее нарушение
int $plural Число для определения формы множественного числа при переводе сообщения
mixed $code Код ошибки нарушения
Constraint $constraint Ограничение, валидация которого вызвала нарушение
mixed $cause Причина нарушения

string __toString()

Преобразует нарушение в строку для целей отладки.

ЗначениеВозврата

string Нарушение в виде строки

string getMessageTemplate()

Возвращает исходное сообщение об ошибке.

Исходное сообщение об ошибке содержит заполнитель для параметров, возвращаемых {@link getParameters}. Обычно вы передаёте шаблон сообщения и параметры в механизм перевода.

ЗначениеВозврата

string Исходное сообщение об ошибке

array getParameters()

Возвращает параметры для вставки в исходное сообщение об ошибке.

ЗначениеВозврата

array Возможный пустой список параметров, индексированных по именам, которые появляются в шаблоне сообщения

int|null getPlural()

Возвращает число для склонения сообщения об ошибке.

Например, шаблон сообщения может иметь различные переводы в зависимости от параметра "choices":

  • Пожалуйста, выберите ровно одну запись. (choices=1)
  • Пожалуйста, выберите две записи. (choices=2)

Этот метод возвращает значение параметра для выбора правильной формы множественного числа (в данном случае "choices").

ЗначениеВозврата

int|null Число для склонения сообщения

string getMessage()

Возвращает сообщение об ошибке.

ЗначениеВозврата

string Сообщение об ошибке

mixed getRoot()

Возвращает корневой элемент валидации.

ЗначениеВозврата

mixed Значение, которое изначально было передано валидатору при запуске валидации. Поскольку валидатор обходит граф объектов, значение, в котором происходит нарушение, необязательно является значением, которое изначально было валидировано.

string getPropertyPath()

Возвращает путь к свойству от корневого элемента до нарушения.

ЗначениеВозврата

string Путь к свойству указывает, как валидатор достиг некорректного значения от корневого элемента. Если корневой элемент — экземпляр Person со свойством "address", содержащим экземпляр Address с некорректным свойством "street", сгенерированный путь к свойству — "address.street". Доступ к свойству обозначается точками, а доступ к массиву — квадратными скобками, например "addresses[1].street".

mixed getInvalidValue()

Возвращает значение, вызвавшее нарушение.

ЗначениеВозврата

mixed некорректное значение, которое привело к тому, что проверка ограничения не прошла

Constraint|null getConstraint()

Возвращает ограничение, валидация которого вызвала нарушение.

ЗначениеВозврата

Constraint|null Ограничение или null, если оно неизвестно

mixed getCause()

Возвращает причину нарушения.

ЗначениеВозврата

mixed

string|null getCode()

Возвращает удобочитаемый код ошибки для нарушения.

ЗначениеВозврата

string|null Код ошибки

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Validator/ConstraintViolation.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API