Spec-Zone.ru › Symfony 3.0

Ограничение

класс Constraint

Содержит свойства определения ограничения.

Ограничение может быть определено для класса, опции или метода-геттера. Класс Constraint encapsulates всю необходимую конфигурацию для успешной проверки результата этого класса, опции или метода-геттера.

Экземпляры Constraint неизменяемы и сериализуемы.

Константы

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

Свойства

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

Методы

static string getErrorName(int $errorCode)

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

__construct(mixed $options = null)

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

__set(string $option, mixed $value)

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

mixed __get(string $option)

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

addImplicitGroupName(string $group)

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

string getDefaultOption()

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

array getRequiredOptions()

Возвращает имя необходимых опций.

string validatedBy()

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

string|array getTargets()

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

array __sleep()

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

Подробности

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::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/Constraint.html

Spec-Zone.ru

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