Электронная почта
класс Email расширяет Constraint
Константы
| DEFAULT_GROUP | Название группы, присваиваемой всем ограничениям без явного указания. |
| CLASS_CONSTRAINT | Помечает ограничение, которое может быть применено к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое может быть применено к свойствам. |
| INVALID_FORMAT_ERROR | |
| MX_CHECK_FAILED_ERROR | |
| HOST_CHECK_FAILED_ERROR |
Свойства
| смешанный | $payload | Данные, специфичные для домена, прикрепленные к ограничению. | из Constraint |
| массив | $groups | Группы, к которым относится ограничение | из Constraint |
| $message | |||
| $checkMX | |||
| $checkHost | |||
| $strict |
Методы
| статический строка | getErrorName(int $errorCode) Возвращает имя заданного кода ошибки. | из Constraint |
| __construct(смешанный $options = null) Инициализирует ограничение параметрами. | из Constraint | |
| __set(строка $option, смешанный $value) Устанавливает значение отложенно инициализированного параметра. | из Constraint | |
| смешанный | __get(строка $option) Возвращает значение отложенно инициализированного параметра. | из Constraint |
| addImplicitGroupName(строка $group) Добавляет заданную группу, если это ограничение находится в группе По умолчанию. | из Constraint | |
| строка | getDefaultOption() Возвращает имя параметра по умолчанию. | из Constraint |
| массив | getRequiredOptions() Возвращает имена необходимых параметров. | из Constraint |
| строка | validatedBy() Возвращает имя класса, который валидирует это ограничение. | из Constraint |
| строка|массив | getTargets() Возвращает, может ли ограничение быть применено к классам, свойствам или обоим. | из Constraint |
| массив | __sleep() Оптимизирует сериализованное значение для минимизации занимаемого места. | из Constraint |
Подробности
статический строка getErrorName(int $errorCode)
Возвращает имя заданного кода ошибки.
Параметры
| int | $errorCode | Код ошибки |
Возвращаемое значение
| строка | Имя кода ошибки |
Исключения
| InvalidArgumentException | Если код ошибки не существует |
__construct(смешанный $options = null)
Инициализирует ограничение параметрами.
Вы должны передать ассоциативный массив. Ключи должны соответствовать именам существующих свойств в этом классе. Значения должны быть значениями для этих свойств.
В качестве альтернативы, вы можете переопределить метод getDefaultOption(), чтобы вернуть имя существующего свойства. Если ассоциативный массив не передан, это свойство устанавливается вместо него.
Вы можете принудительно установить определенные параметры, переопределив getRequiredOptions(), чтобы вернуть имена этих параметров. Если какой-либо параметр не установлен здесь, генерируется исключение.
Параметры
| смешанный | $options | Параметры (в виде ассоциативного массива) или значение для параметра по умолчанию (любой другой тип) |
Исключения
| InvalidOptionsException | Когда вы передаете имена несуществующих параметров |
| MissingOptionsException | Когда вы не передаете ни одного из параметров, возвращаемых getRequiredOptions() |
| ConstraintDefinitionException | Когда вы не передаете ассоциативный массив, а getDefaultOption() возвращает null |
__set(строка $option, смешанный $value)
Устанавливает значение отложенно инициализированного параметра.
Соответствующие свойства добавляются в объект при первом доступе. Следовательно, этот метод будет вызываться не более одного раза на экземпляр ограничения и имя параметра.
Параметры
| строка | $option | Имя параметра |
| смешанный | $value | Значение для установки |
Исключения
| InvalidOptionsException | Если задано некорректное имя параметра |
смешанный __get(строка $option)
Возвращает значение отложенно инициализированного параметра.
Соответствующие свойства добавляются в объект при первом доступе. Следовательно, этот метод будет вызываться не более одного раза на экземпляр ограничения и имя параметра.
Параметры
| строка | $option | Имя параметра |
Возвращаемое значение
| смешанный | Значение параметра |
Исключения
| InvalidOptionsException | Если задано некорректное имя параметра |
addImplicitGroupName(строка $group)
Добавляет заданную группу, если это ограничение находится в группе По умолчанию.
Параметры
| строка | $group |
строка getDefaultOption()
Возвращает имя параметра по умолчанию.
Переопределите этот метод, чтобы определить параметр по умолчанию.
Возвращаемое значение
| строка |
См. также
| __construct() |
массив getRequiredOptions()
Возвращает имена необходимых параметров.
Переопределите этот метод, если хотите определить необходимые параметры.
Возвращаемое значение
| массив |
См. также
| __construct() |
строка validatedBy()
Возвращает имя класса, который валидирует это ограничение.
По умолчанию это полное имя класса ограничения с добавленным «Validator». Вы можете переопределить этот метод, чтобы изменить это поведение.
Возвращаемое значение
| строка |
строка|массив getTargets()
Возвращает, может ли ограничение быть применено к классам, свойствам или обоим.
Этот метод должен возвращать одно или несколько значений констант Constraint::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.
Возвращаемое значение
| строка|массив | Одно или несколько значений констант |
массив __sleep()
Оптимизирует сериализованное значение для минимизации занимаемого места.
Возвращаемое значение
| массив | Свойства для сериализации |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Validator/Constraints/Email.html