Spec-Zone.ru › Symfony 3.1

ConstraintViolation

class ConstraintViolation implements ConstraintViolationInterface

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

Методы

__construct(string $message, string $messageTemplate, array $parameters, mixed $root, string $propertyPath, mixed $invalidValue, int|null $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 $message, string $messageTemplate, array $parameters, mixed $root, string $propertyPath, mixed $invalidValue, int|null $plural = null, mixed $code = null, Constraint $constraint = null, mixed $cause = null)

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

Параметры

string $message Сообщение о нарушении
string $messageTemplate Исходное сообщение о нарушении
array $parameters Параметры для подстановки в исходное сообщение о нарушении
mixed $root Значение, первоначально переданное валидатору
string $propertyPath Путь к свойству от корневого значения до некорректного значения
mixed $invalidValue Некорректное значение, вызвавшее нарушение
int|null $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.
http://api.symfony.com/3.1/Symfony/Component/Validator/ConstraintViolation.html

Spec-Zone.ru

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