Spec-Zone.ru › Symfony 3.2

IsNull

class IsNull extends Constraint

Постоянные значения

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

NOT_NULL_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)

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

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

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

Параметры

string $group

string getDefaultOption()

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

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

Значение результата

string

См. также

__construct()

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.2/Symfony/Component/Validator/Constraints/IsNull.html

Spec-Zone.ru

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