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