Spec-Zone.ru › Symfony 3.0

Почта

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

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

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

INVALID_FORMAT_ERROR
MX_CHECK_FAILED_ERROR
HOST_CHECK_FAILED_ERROR

Свойства

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

Методы

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

Spec-Zone.ru

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