Spec-Zone.ru › Symfony 3.1

Обратный вызов

класс Callback расширяет Constraint

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

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

Свойства

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

Методы

static string getErrorName(string $errorCode)

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

из Constraint
__construct(mixed $options = null)

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

__set(string $option, mixed $value)

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

из Constraint
mixed __get(string $option)

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

из Constraint
addImplicitGroupName(string $group)

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

из Constraint
string getDefaultOption()

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

array getRequiredOptions()

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

из Constraint
string validatedBy()

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

из Constraint
string|array getTargets()

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

array __sleep()

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

из Constraint

Детали

static string getErrorName(string $errorCode)

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

Параметры

string $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

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

Spec-Zone.ru

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