Класс yii\validators\EmailValidator
| Наследование | yii\validators\EmailValidator » yii\validators\Validator » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/validators/EmailValidator.php |
EmailValidator проверяет, является ли значение атрибута корректным адресом электронной почты.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $allowName | boolean | Разрешить имя в адресе электронной почты (например, "John Smith <john. | yii\validators\EmailValidator |
| $attributeNames | массив | Имена атрибутов. | yii\validators\Validator |
| $attributes | массив|строка | Атрибуты, которые должны быть проверены этим валидатором. | yii\validators\Validator |
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к этому компоненту | yii\base\Component |
| $builtInValidators | массив | Список встроенных валидаторов (имя => класс или конфигурация) | yii\validators\Validator |
| $checkDNS | boolean | Проверить, существует ли домен электронной почты и есть ли запись A или MX. | yii\validators\EmailValidator |
| $enableClientValidation | boolean | Включить проверку на стороне клиента для этого валидатора. | yii\validators\Validator |
| $enableIDN | boolean | Включить проверку IDN (международные доменные имена). | yii\validators\EmailValidator |
| $except | массив|строка | Сценарии, для которых валидатор не должен применяться. | yii\validators\Validator |
| $fullPattern | строка | Регулярное выражение для проверки адресов электронной почты с частью имени. | yii\validators\EmailValidator |
| $isEmpty | вызываемая функция | PHP-вызываемая функция, которая заменяет стандартную реализацию isEmpty(). | yii\validators\Validator |
| $message | строка | Пользовательское сообщение об ошибке. | yii\validators\Validator |
| $on | массив|строка | Сценарии, для которых валидатор может быть применён. | yii\validators\Validator |
| $pattern | строка | Регулярное выражение для проверки значения атрибута. | yii\validators\EmailValidator |
| $skipOnEmpty | boolean | Пропустить проверку, если значение атрибута null или пустая строка. | yii\validators\Validator |
| $skipOnError | boolean | Пропустить проверку, если для атрибута уже есть ошибка. | yii\validators\Validator |
| $when | вызываемая функция | PHP-вызываемая функция, определяющая, следует ли применять данный валидатор. | yii\validators\Validator |
| $whenClient | строка | Имя JavaScript-функции, определяющей, следует ли применять валидатор на стороне клиента. | yii\validators\Validator |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Component |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства компонента. | yii\base\Component |
| __isset() | Проверяет, установлено ли свойство, т. е. определено и не равно null. | yii\base\Component |
| __set() | Устанавливает значение свойства компонента. | yii\base\Component |
| __unset() | Устанавливает свойство компонента в null. | yii\base\Component |
| addError() | Добавляет ошибку относительно указанного атрибута в объект модели. | yii\validators\Validator |
| attachBehavior() | Присоединяет поведение к данному компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, по которым должен вести себя этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Component |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Component |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| clientValidateAttribute() | Возвращает JavaScript, необходимый для выполнения проверки на стороне клиента. | yii\validators\EmailValidator |
| createValidator() | Создаёт объект валидатора. | yii\validators\Validator |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| getAttributeNames() | Возвращает очищенные имена атрибутов без символа ! в начале. | yii\validators\Validator |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все поведения, присоединённые к этому компоненту. | yii\base\Component |
| getClientOptions() | Возвращает параметры проверки на стороне клиента. | yii\validators\EmailValidator |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, присоединённый к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для данного компонента. | yii\base\Component |
| init() | Инициализирует объект. | yii\validators\EmailValidator |
| isActive() | Возвращает значение, указывающее, активен ли валидатор для данного сценария и атрибута. | yii\validators\Validator |
| isEmpty() | Проверяет, пусто ли данное значение. | yii\validators\Validator |
| off() | Отсоединяет существующий обработчик событий от данного компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| trigger() | Срабатывает событие. | yii\base\Component |
| validate() | Проверяет данное значение. | yii\validators\Validator |
| validateAttribute() | Проверяет одно свойство. | yii\validators\Validator |
| validateAttributes() | Проверяет указанный объект. | yii\validators\Validator |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| formatMessage() | Форматирует сообщение, используя I18N, или простым strtr, если \Yii::$app недоступен. | yii\validators\Validator |
| validateValue() | Проверяет значение. | yii\validators\EmailValidator |
Подробное описание свойств
$allowName общедоступное свойство
Разрешать имя в адресе электронной почты (например, «Иван Иванов ivan.ivanov@example.com»). По умолчанию значение false.
См. также $fullPattern.
public boolean $allowName = false
$checkDNS общедоступное свойство
Проверять, существует ли домен электронной почты и имеет ли он запись A или MX. Имейте в виду, что эта проверка может завершиться ошибкой из-за временных проблем с DNS, даже если адрес электронной почты действителен и электронное письмо будет доставлено. По умолчанию значение false.
public boolean $checkDNS = false
$enableIDN общедоступное свойство
Включать ли в процесс проверки IDN (международные доменные имена). По умолчанию значение false, что означает, что проверка адресов электронной почты, содержащих IDN, всегда будет провалена. Обратите внимание, что для использования проверки IDN вам необходимо установить и включить intl расширение PHP, в противном случае будет выброшено исключение.
public boolean $enableIDN = false
$fullPattern общедоступное свойство
Регулярное выражение, используемое для проверки адресов электронной почты с частью имени. Это свойство используется только тогда, когда $allowName равно true.
См. также $allowName.
public string $fullPattern = '/^[^@]*<[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?>$/'
$pattern общедоступное свойство
Регулярное выражение, используемое для проверки значения атрибута.
См. также http://www.regular-expressions.info/email.html.
public string $pattern = '/^[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$/'
Подробное описание методов
clientValidateAttribute() public method
Возвращает JavaScript, необходимый для выполнения проверки на стороне клиента.
Вызывает getClientOptions() для генерации массива опций для проверки на стороне клиента.
Вы можете переопределить этот метод, чтобы вернуть код проверки JavaScript, если валидатор поддерживает проверку на стороне клиента.
Следующие переменные JavaScript определены заранее и могут быть использованы в коде проверки:
-
attribute: объект, описывающий атрибут, который проверяется. -
value: значение, которое проверяется. -
messages: массив, используемый для хранения сообщений об ошибках проверки для атрибута. -
deferred: массив, используемый для хранения отложенных объектов для асинхронной проверки -
$form: объект jQuery, содержащий элемент формы
Объект attribute содержит следующие свойства:
-
id: уникальный идентификатор атрибута (например, "loginform-username") в форме -
name: имя атрибута или выражение (например, "[0]content" для табличных данных) -
container: селектор jQuery контейнера поля ввода -
input: селектор jQuery поля ввода в контексте формы -
error: селектор jQuery тега ошибки в контексте контейнера -
status: состояние поля ввода, 0: пустое, не введено ранее, 1: проверено, 2: ожидается проверка, 3: проверка
| public string|null clientValidateAttribute ( $model, $attribute, $view ) | ||
|---|---|---|
| $model | yii\base\Model |
Модель данных, которая проверяется |
| $attribute | string |
Имя атрибута, который необходимо проверить. |
| $view | yii\web\View |
Объект представления, который будет использоваться для рендеринга представлений или файлов представлений, содержащих форму модели с примененным этим валидатором. |
| return | string|null |
Скрипт проверки на стороне клиента. Null, если валидатор не поддерживает проверку на стороне клиента. |
getClientOptions() public method
Возвращает параметры проверки на стороне клиента.
Этот метод обычно вызывается из clientValidateAttribute(). Вы можете переопределить этот метод, чтобы изменить параметры, которые будут переданы в проверку на стороне клиента.
| public array getClientOptions ( $model, $attribute ) | ||
|---|---|---|
| $model | yii\base\Model |
Проверяемая модель |
| $attribute | string |
Имя проверяемого атрибута |
| return | array |
Параметры проверки на стороне клиента |
init() public method
Инициализирует объект.
Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.
| public void init ( ) |
|---|
validateValue() protected method
Проверяет значение.
Класс валидатора может реализовать этот метод, чтобы поддерживать проверку данных вне контекста модели данных.
| protected array|null validateValue ( $value ) | ||
|---|---|---|
| $value | mixed |
Значение данных, которое нужно проверить. |
| return | array|null |
Сообщение об ошибке и параметры, которые необходимо вставить в сообщение об ошибке. Null должен быть возвращен, если данные валидны. |
| throws | yii\base\NotSupportedException |
если валидатор не поддерживает проверку данных без модели |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-validators-emailvalidator.html