Почта
класс 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::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.
Значение
| string|array | Одно или несколько значений констант |
array __sleep()
Оптимизирует сериализованное значение для минимизации занимаемого места.
Значение
| array | Свойства для сериализации |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Validator/Constraints/Email.html