Spec-Zone.ru › Symfony 3.3

Дополнительный

класс Optional расширяет 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.3/Symfony/Component/Validator/Constraints/Optional.html

Spec-Zone.ru

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