Spec-Zone.ru › Symfony 3.2

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

класс Optional наследует Existence

Константы

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

Свойства

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

Методы

статический строка getErrorName(целое число $errorCode)

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

из Constraint
__construct(смешанный $options = null)

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

из Composite
__set(строка $option, смешанный $value)

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

из Constraint
смешанный __get(строка $option)

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

из Constraint
addImplicitGroupName(строка $group)

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

из Composite
строка getDefaultOption()

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

из Existence
массив getRequiredOptions()

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

из Constraint
строка validatedBy()

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

из Constraint
строка|массив getTargets()

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

из Constraint
массив __sleep()

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

из Constraint

Подробности

статический строка 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 Если задано некорректное имя параметра

addImplicitGroupName(строка $group)

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

Параметры

строка $group

строка getDefaultOption()

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

Переопределите этот метод, чтобы определить параметр по умолчанию.

Значение возврата

строка

массив getRequiredOptions()

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

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

Значение возврата

массив

См. также

__construct()

строка validatedBy()

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

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

Значение возврата

строка

строка|массив getTargets()

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

Этот метод должен вернуть одну или несколько констант Constraint::CLASSCONSTRAINT и Constraint::PROPERTYCONSTRAINT.

Значение возврата

строка|массив Одно или несколько значений констант

массив __sleep()

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

Значение возврата

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

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

Spec-Zone.ru

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