Выбор
класс Choice расширяет Constraint
Константы
| DEFAULT_GROUP | Название группы, присвоенной всем ограничениям без явного указания группы. |
| CLASS_CONSTRAINT | Помечает ограничение, которое может быть применено к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое может быть применено к свойствам. |
| NO_SUCH_CHOICE_ERROR | |
| TOO_FEW_ERROR | |
| TOO_MANY_ERROR |
Свойства
| смешанный | $payload | Данные, специфичные для домена, присоединенные к ограничению. | из Constraint |
| массив | $groups | Группы, к которым относится ограничение | из Constraint |
| $choices | |||
| $callback | |||
| $multiple | |||
| $strict | |||
| $min | |||
| $max | |||
| $message | |||
| $multipleMessage | |||
| $minMessage | |||
| $maxMessage |
Методы
| статический строка | getErrorName(целое число $errorCode) Возвращает имя заданного кода ошибки. | из Constraint |
| __construct(смешанный $options = null) Инициализирует ограничение с параметрами. | из Constraint | |
| __set(строка $option, смешанный $value) Устанавливает значение отложенно инициализированного параметра. | из Constraint | |
| смешанный | __get(строка $option) Возвращает значение отложенно инициализированного параметра. | из Constraint |
| addImplicitGroupName(строка $group) Добавляет заданную группу, если данное ограничение находится в группе «По умолчанию». | из Constraint | |
| строка | getDefaultOption() Возвращает имя параметра по умолчанию. | |
| массив | getRequiredOptions() Возвращает имя необходимых параметров. | из Constraint |
| строка | validatedBy() Возвращает имя класса, который валидирует данное ограничение. | из Constraint |
| строка|массив | getTargets() Возвращает, можно ли ограничение применять к классам, свойствам или к обоим. | из Constraint |
| массив | __sleep() Оптимизирует сериализованное значение для минимизации занимаемого места. | из Constraint |
Детали
статический строка 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 | Если задано недопустимое имя параметра |
addImplicitGroupName(строка $group)
Добавляет заданную группу, если данное ограничение находится в группе «По умолчанию».
Параметры
| строка | $group |
строка getDefaultOption()
Возвращает имя параметра по умолчанию.
Переопределите этот метод для определения параметра по умолчанию.
Возвращаемое значение
| строка |
массив getRequiredOptions()
Возвращает имя необходимых параметров.
Переопределите этот метод, если хотите определить необходимые параметры.
Возвращаемое значение
| массив |
См. также
| __construct() |
строка validatedBy()
Возвращает имя класса, который валидирует данное ограничение.
По умолчанию это полное имя класса ограничения, дополненное «Validator». Вы можете переопределить этот метод, чтобы изменить это поведение.
Возвращаемое значение
| строка |
строка|массив getTargets()
Возвращает, можно ли ограничение применять к классам, свойствам или к обоим.
Этот метод должен возвращать одно или несколько из констант Constraint::CLASSCONSTRAINT и Constraint::PROPERTYCONSTRAINT.
Возвращаемое значение
| строка|массив | Одно или несколько значений констант |
массив __sleep()
Оптимизирует сериализованное значение для минимизации занимаемого места.
Возвращаемое значение
| массив | Свойства для сериализации |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Validator/Constraints/Choice.html
