Выбор
класс Выбор расширяет Ограничение
Константы
| DEFAULT_GROUP | Имя группы, заданной для всех ограничений без явной группы. |
| CLASS_CONSTRAINT | Помечает ограничение, которое можно применить к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое можно применить к свойствам. |
| NO_SUCH_CHOICE_ERROR | |
| TOO_FEW_ERROR | |
| TOO_MANY_ERROR |
Свойства
| статический защищенный | $errorNames | ||
| смешанный | $payload | Данные, специфичные для домена, прикрепленные к ограничению. | из Ограничение |
| массив | $groups | Группы, к которым относится ограничение | из Ограничение |
| $choices | |||
| $callback | |||
| $multiple | |||
| $strict | |||
| $min | |||
| $max | |||
| $message | |||
| $multipleMessage | |||
| $minMessage | |||
| $maxMessage |
Методы
| статический строка | getErrorName(строка $errorCode) Возвращает имя заданного кода ошибки. | из Ограничение |
| __construct(смешанный $options = null) Инициализирует ограничение параметрами. | из Ограничение | |
| __set(строка $option, смешанный $value) Устанавливает значение параметра, инициализируемого по мере необходимости. | из Ограничение | |
| смешанный | __get(строка $option) Возвращает значение параметра, инициализируемого по мере необходимости. | из Ограничение |
| логический | __isset(строка $option) | из Ограничение |
| addImplicitGroupName(строка $group) Добавляет заданную группу, если это ограничение находится в группе По умолчанию. | из Ограничение | |
| строка | getDefaultOption() Возвращает имя параметра по умолчанию. | |
| массив | getRequiredOptions() Возвращает имена необходимых параметров. | из Ограничение |
| строка | validatedBy() Возвращает имя класса, который валидирует это ограничение. | из Ограничение |
| строка|массив | getTargets() Возвращает, можно ли ограничение применить к классам, свойствам или обоим. | из Ограничение |
| массив | __sleep() Оптимизирует сериализованное значение для минимизации занимаемого места. | из Ограничение |
Подробности
static строка 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 | Если указано недопустимое имя параметра |
bool __isset(строка $option)
Параметры
| строка | $option | Имя параметра |
Возвращаемое значение
| bool |
addImplicitGroupName(строка $group)
Добавляет заданную группу, если это ограничение находится в группе по умолчанию.
Параметры
| строка | $group |
строка getDefaultOption()
Возвращает имя параметра по умолчанию.
Переопределите этот метод для определения параметра по умолчанию.
Возвращаемое значение
| строка |
массив 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/Choice.html
