Spec-Zone.ru › Symfony 3.0

Существование

класс Существование расширяет Composite

Константы

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

Свойства

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

Методы

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)

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

из Composite
string getDefaultOption()

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

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

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.0/Symfony/Component/Validator/Constraints/Existence.html

Spec-Zone.ru

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