Spec-Zone.ru › Symfony 3.0

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.0/Symfony/Component/Validator/ConstraintViolation.html

Spec-Zone.ru

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