Spec-Zone.ru › Symfony 3.2

Обязательный

класс Обязательный расширяет 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::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/Required.html

Spec-Zone.ru

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