Spec-Zone.ru › Symfony 3.0

Требуемое

класс Требуемое расширяет Existence

Константы

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

Свойства

mixed $payload Данные, специфичные для домена, прикрепленные к ограничению из Constraint
array $groups Группы, к которым относится ограничение из Constraint
$constraints из Existence

Методы

static string getErrorName(int $errorCode)

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

из Constraint
__construct(mixed $options = null)

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

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

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

из Constraint
mixed __get(string $option)

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

из Constraint
addImplicitGroupName(string $group)

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

из Composite
string getDefaultOption()

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

из Existence
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::CLASSCONSTRAINT и Constraint::PROPERTYCONSTRAINT.

Возвращаемое значение

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

array __sleep()

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

Возвращаемое значение

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

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

Spec-Zone.ru

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