AbstractComparisonValidator
абстрактный класс AbstractComparisonValidator расширяет ConstraintValidator
Предоставляет базовый класс для валидации сравнения свойств.
Константы
| PRETTY_DATE | Определяет, нужно ли форматировать объекты {@link \DateTime} как даты RFC-3339 ("Y-m-d H:i:s"). |
| OBJECT_TO_STRING | Определяет, нужно ли преобразовывать объекты с методом "__toString()" в строки. |
Свойства
| protected ExecutionContextInterface | $context | из ConstraintValidator |
Методы
| initialize(ExecutionContextInterface $context) Инициализирует валидатор ограничений. | из ConstraintValidator | |
| string | formatTypeOf(mixed $value) Возвращает строковое представление типа значения. | из ConstraintValidator |
| string | formatValue(mixed $value, int $format = 0) Возвращает строковое представление значения. | из ConstraintValidator |
| string | formatValues(array $values, int $format = 0) Возвращает строковое представление списка значений. | из ConstraintValidator |
| __construct(PropertyAccessor $propertyAccessor = null) | ||
| validate(mixed $value, Constraint $constraint) Проверяет, является ли переданное значение допустимым. | ||
| bool | compareValues(mixed $value1, mixed $value2) Сравнивает два заданных значения, чтобы определить, является ли их отношение допустимым. | |
| string|null | getErrorCode() Возвращает код ошибки, используемый при неудачном сравнении. |
Детали
initialize(ExecutionContextInterface $context)
Инициализирует валидатор ограничений.
Параметры
| ExecutionContextInterface | $context | Текущий контекст валидации |
protected string formatTypeOf(mixed $value)
Возвращает строковое представление типа значения.
Этот метод следует использовать, если вы передаете тип значения в качестве параметра сообщения нарушению ограничения. Обратите внимание, что такие параметры обычно не должны включаться в сообщения, предназначенные для нетехнических пользователей.
Параметры
| mixed | $value | Значение, тип которого необходимо вернуть |
Возвращаемое значение
| string | Тип значения |
protected string formatValue(mixed $value, int $format = 0)
Возвращает строковое представление значения.
Этот метод возвращает эквивалентные PHP токены для большинства скалярных типов (т.е. "false" для false, "1" для 1 и т.д.). Строки всегда заключаются в двойные кавычки ("). Объекты, массивы и ресурсы форматируются как "object", "array" и "resource". Если битовая маска $format содержит бит PRETTY_DATE, то объекты {@link \DateTime} будут форматироваться как даты RFC-3339 ("Y-m-d H:i:s").
Будьте осторожны при передаче параметров сообщений нарушению ограничения, которые могут содержать объекты, массивы или ресурсы. Эти параметры должны отображаться только для технических пользователей. Нетехнические пользователи не будут знать, что такое "объект", "массив" или "ресурс", и будут сбиты с толку сообщением об ошибке.
Параметры
| mixed | $value | Значение для форматирования в строку |
| int | $format | Битовая комбинация констант формата в этом классе |
Возвращаемое значение
| string | Строковое представление переданного значения |
protected string formatValues(array $values, int $format = 0)
Возвращает строковое представление списка значений.
Каждое из значений преобразуется в строку с помощью {@link formatValue()}. Значения конкатенируются запятыми.
Параметры
| array | $values | Список значений |
| int | $format | Битовая комбинация констант формата в этом классе |
Возвращаемое значение
| string | Строковое представление списка значений |
См. также
| formatValue() |
__construct(PropertyAccessor $propertyAccessor = null)
Параметры
| PropertyAccessor | $propertyAccessor |
validate(mixed $value, Constraint $constraint)
Проверяет, является ли переданное значение допустимым.
Параметры
| mixed | $value | Значение, которое должно быть проверено |
| Constraint | $constraint | Ограничение для проверки |
abstract protected bool compareValues(mixed $value1, mixed $value2)
Сравнивает два заданных значения, чтобы определить, является ли их отношение допустимым.
Параметры
| mixed | $value1 | Первое значение для сравнения |
| mixed | $value2 | Второе значение для сравнения |
Возвращаемое значение
| bool | true, если отношение допустимо, иначе false |
protected string|null getErrorCode()
Возвращает код ошибки, используемый при неудачном сравнении.
Возвращаемое значение
| string|null | Код ошибки или null если код не должен быть установлен |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Validator/Constraints/AbstractComparisonValidator.html