Spec-Zone.ru › Symfony 3.2

Выбор

класс Выбор расширяет Constraint

Константы

DEFAULT_GROUP

Имя группы, присваиваемой всем ограничениям без явной группы.

CLASS_CONSTRAINT

Помечает ограничение, которое может быть применено к классам.

PROPERTY_CONSTRAINT

Помечает ограничение, которое может быть применено к свойствам.

NO_SUCH_CHOICE_ERROR
TOO_FEW_ERROR
TOO_MANY_ERROR

Свойства

mixed $payload Данные, специфичные для области, прикрепленные к ограничению. из Constraint
array $groups Группы, к которым относится ограничение из Constraint
$choices
$callback
$multiple
$strict
$min
$max
$message
$multipleMessage
$minMessage
$maxMessage

Методы

static string getErrorName(int $errorCode)

Возвращает имя заданного кода ошибки.

из Constraint
__construct(mixed $options = null)

Инициализирует ограничение параметрами.

из Constraint
__set(string $option, mixed $value)

Устанавливает значение отложенного параметра.

из Constraint
mixed __get(string $option)

Возвращает значение отложенного параметра.

из Constraint
addImplicitGroupName(string $group)

Добавляет заданную группу, если это ограничение находится в группе По умолчанию.

из Constraint
string getDefaultOption()

Возвращает имя параметра по умолчанию.

array getRequiredOptions()

Возвращает имена обязательных параметров.

из Constraint
string validatedBy()

Возвращает имя класса, который валидирует данное ограничение.

из Constraint
string|array getTargets()

Возвращает, может ли ограничение быть применено к классам, свойствам или обоим.

из Constraint
array __sleep()

Оптимизирует сериализованное значение для минимизации объема занимаемого места.

из Constraint

Детали

static string getErrorName(int $errorCode)

Возвращает имя заданного кода ошибки.

Параметры

int $errorCode Код ошибки

Значение, возвращаемое функцией

string Имя кода ошибки

Исключения

InvalidArgumentException Если код ошибки не существует

__construct(mixed $options = null)

Инициализирует ограничение параметрами.

Вы должны передать ассоциативный массив. Ключи должны соответствовать именам существующих свойств в этом классе. Значения должны соответствовать значениям этих свойств.

В качестве альтернативы вы можете переопределить метод getDefaultOption(), чтобы вернуть имя существующего свойства. Если не передается ассоциативный массив, вместо этого устанавливается это свойство.

Вы можете принудительно установить определенные параметры, переопределив getRequiredOptions() для возврата имен этих параметров. Если какой-либо параметр не установлен здесь, генерируется исключение.

Параметры

mixed $options Параметры (в виде ассоциативного массива) или значение для параметра по умолчанию (любой другой тип)

Исключения

InvalidOptionsException Когда вы передаете имена несуществующих параметров
MissingOptionsException Когда вы не передаете ни одного из параметров, возвращаемых getRequiredOptions()
ConstraintDefinitionException Когда вы не передаете ассоциативный массив, но getDefaultOption() возвращает null

__set(string $option, mixed $value)

Устанавливает значение отложенного параметра.

Соответствующие свойства добавляются в объект при первом обращении. Следовательно, этот метод будет вызван не более одного раза на экземпляр ограничения и имя параметра.

Параметры

string $option Имя параметра
mixed $value Значение для установки

Исключения

InvalidOptionsException Если указано недопустимое имя параметра

mixed __get(string $option)

Возвращает значение отложенного параметра.

Соответствующие свойства добавляются в объект при первом обращении. Следовательно, этот метод будет вызван не более одного раза на экземпляр ограничения и имя параметра.

Параметры

string $option Имя параметра

Значение, возвращаемое функцией

mixed Значение параметра

Исключения

InvalidOptionsException Если указано недопустимое имя параметра

addImplicitGroupName(string $group)

Добавляет заданную группу, если это ограничение находится в группе По умолчанию.

Параметры

string $group

string getDefaultOption()

Возвращает имя параметра по умолчанию.

Переопределите этот метод для определения параметра по умолчанию.

Значение, возвращаемое функцией

string

array getRequiredOptions()

Возвращает имена обязательных параметров.

Переопределите этот метод, если хотите определить обязательные параметры.

Значение, возвращаемое функцией

array

См. также

__construct()

string validatedBy()

Возвращает имя класса, который валидирует данное ограничение.

По умолчанию это полное имя класса ограничения с добавленным "Validator". Вы можете переопределить этот метод, чтобы изменить это поведение.

Значение, возвращаемое функцией

string

string|array getTargets()

Возвращает, может ли ограничение быть применено к классам, свойствам или обоим.

Этот метод должен возвращать одно или несколько значений констант Constraint::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.

Значение, возвращаемое функцией

string|array Одно или несколько значений констант

array __sleep()

Оптимизирует сериализованное значение для минимизации объема занимаемого места.

Значение, возвращаемое функцией

array Свойства для сериализации

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Validator/Constraints/Choice.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API