Spec-Zone.ru › Symfony 3.1

Ложь устаревший

класс Ложь расширяет IsFalse

устаревший

since версия 2.7, будет удалена в 3.0. Используйте IsFalse вместо этого.

Константы

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

NOT_FALSE_ERROR

Свойства

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

Методы

статический string getErrorName(int $errorCode)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из Constraint

Подробности

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

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

Параметры

int $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()

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

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

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

строка

См. также

__construct()

массив getRequiredOptions()

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

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

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

массив

См. также

__construct()

строка validatedBy()

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

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

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

строка

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

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

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

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

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

массив __sleep()

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

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

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

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

Spec-Zone.ru

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