Диапазон
класс Диапазон расширяет Ограничение
Константы
| DEFAULT_GROUP | Имя группы, присваиваемой всем ограничениям без явного указания группы. |
| CLASS_CONSTRAINT | Помечает ограничение, которое может быть применено к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое может быть применено к свойствам. |
| INVALID_CHARACTERS_ERROR | |
| TOO_HIGH_ERROR | |
| TOO_LOW_ERROR |
Свойства
| статический защищённый | $errorNames | ||
| смешанный | $payload | Данные, специфичные для домена, присоединённые к ограничению. | из Ограничение |
| массив | $groups | Группы, к которым относится ограничение | из Ограничение |
| $minMessage | |||
| $maxMessage | |||
| $invalidMessage | |||
| $min | |||
| $max |
Методы
| статический строка | getErrorName(строка $errorCode) Возвращает имя данного кода ошибки. | из Ограничение |
| __construct(смешанный $options = null) Инициализирует ограничение с параметрами. | ||
| __set(строка $option, смешанный $value) Устанавливает значение отложенно инициализированного параметра. | из Ограничение | |
| смешанный | __get(строка $option) Возвращает значение отложенно инициализированного параметра. | из Ограничение |
| логическое | __isset(строка $option) | из Ограничение |
| addImplicitGroupName(строка $group) Добавляет заданную группу, если данное ограничение находится в группе По умолчанию. | из Ограничение | |
| строка | getDefaultOption() Возвращает имя параметра по умолчанию. | из Ограничение |
| массив | getRequiredOptions() Возвращает имя обязательных параметров. | из Ограничение |
| строка | validatedBy() Возвращает имя класса, который валидирует данное ограничение. | из Ограничение |
| строка|массив | getTargets() Возвращает, может ли ограничение быть применено к классам, свойствам или обоим. | из Ограничение |
| массив | __sleep() Оптимизирует сериализованное значение для минимизации занимаемого места. | из Ограничение |
Подробности
статический строка getErrorName(строка $errorCode)
Возвращает имя данного кода ошибки.
Параметры
| строка | $errorCode | Код ошибки |
Значение возврата
| строка | Имя кода ошибки |
Исключения
| InvalidArgumentException | Если код ошибки не существует |
__construct(смешанный $options = null)
Инициализирует ограничение с параметрами.
Вы должны передать ассоциативный массив. Ключи должны быть именами существующих свойств в этом классе. Значения должны быть значениями этих свойств.
В качестве альтернативы можно переопределить метод getDefaultOption(), чтобы вернуть имя существующего свойства. Если не передаётся ассоциативный массив, это свойство устанавливается вместо него.
Можно принудительно установить определённые параметры, переопределив getRequiredOptions(), чтобы вернуть имена этих параметров. Если какой-либо параметр не установлен здесь, выбрасывается исключение.
Параметры
| смешанный | $options | Параметры (как ассоциативный массив) или значение для параметра по умолчанию (любой другой тип) |
Исключения
| InvalidOptionsException | При передаче имён несуществующих параметров |
| MissingOptionsException | Когда не передаются какие-либо параметры, возвращённые getRequiredOptions() |
| ConstraintDefinitionException | Когда не передаётся ассоциативный массив, но getDefaultOption() возвращает null |
__set(строка $option, смешанный $value)
Устанавливает значение отложенно инициализированного параметра.
Соответствующие свойства добавляются в объект при первом доступе. Таким образом, этот метод будет вызываться не более одного раза на экземпляр ограничения и имя параметра.
Параметры
| строка | $option | Имя параметра |
| смешанный | $value | Значение для установки |
Исключения
| InvalidOptionsException | Если указано некорректное имя параметра |
смешанный __get(строка $option)
Возвращает значение отложенно инициализированного параметра.
Соответствующие свойства добавляются в объект при первом доступе. Таким образом, этот метод будет вызываться не более одного раза на экземпляр ограничения и имя параметра.
Параметры
| строка | $option | Имя параметра |
Значение возврата
| смешанный | Значение параметра |
Исключения
| InvalidOptionsException | Если указано некорректное имя параметра |
логическое __isset(строка $option)
Параметры
| строка | $option | Имя параметра |
Значение возврата
| логическое |
addImplicitGroupName(строка $group)
Добавляет заданную группу, если данное ограничение находится в группе По умолчанию.
Параметры
| строка | $group |
строка getDefaultOption()
Возвращает имя параметра по умолчанию.
Переопределите этот метод для определения параметра по умолчанию.
Значение возврата
| строка |
См. также
| __construct() |
массив getRequiredOptions()
Возвращает имя обязательных параметров.
Переопределите этот метод, если хотите определить обязательные параметры.
Значение возврата
| массив |
См. также
| __construct() |
строка validatedBy()
Возвращает имя класса, который валидирует данное ограничение.
По умолчанию это полное имя класса ограничения с добавленным «Validator». Вы можете переопределить этот метод, чтобы изменить это поведение.
Значение возврата
| строка |
строка|массив getTargets()
Возвращает, может ли ограничение быть применено к классам, свойствам или обоим.
Этот метод должен возвращать одно или несколько значений констант Constraint::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.
Значение возврата
| строка|массив | Одно или несколько значений констант |
массив __sleep()
Оптимизирует сериализованное значение для минимизации занимаемого места.
Значение возврата
| массив | Свойства для сериализации |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Validator/Constraints/Range.html