Spec-Zone.ru › Symfony 3.1

IsTrue

class IsTrue extends Constraint

Константы

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

NOT_TRUE_ERROR

Свойства

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

Методы

static string getErrorName(int $errorCode)

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

из Constraint
__construct(mixed $options = null)

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

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

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

из Constraint
mixed __get(string $option)

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

из Constraint
addImplicitGroupName(string $group)

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

из Constraint
string getDefaultOption()

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

из Constraint
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)

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

Параметры

string $group

string getDefaultOption()

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

Переопределите этот метод для определения параметра по умолчанию.

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

string

См. также

__construct()

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.1/Symfony/Component/Validator/Constraints/IsTrue.html

Spec-Zone.ru

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