CEmailValidator

Подробное описание свойств

allowEmpty свойство

public boolean $allowEmpty;

указывает, может ли значение атрибута быть null или пустым. По умолчанию true, что означает, что если атрибут пуст, он считается корректным.

allowName свойство

public boolean $allowName;

разрешить имя в адресе электронной почты (например, "Qiang Xue "). По умолчанию false.

checkMX свойство

public boolean $checkMX;

указывать, следует ли проверять запись MX для адреса электронной почты. По умолчанию false. Чтобы включить проверку, необходимо убедиться, что функция PHP 'checkdnsrr' присутствует в вашей установке PHP. Обратите внимание, что эта проверка может завершиться неудачей из-за временных проблем, даже если адрес электронной почты действителен.

checkPort свойство

public boolean $checkPort;

указывает, следует ли проверять порт 25 для адреса электронной почты. По умолчанию false. Для включения, убедитесь, что функции PHP 'dns_get_record' и 'fsockopen' доступны в вашей установке PHP. Обратите внимание, что эта проверка может завершиться неудачей из-за временных проблем, даже если адрес электронной почты действителен.

fullPattern свойство

public string $fullPattern;

регулярное выражение, используемое для проверки адресов электронной почты с частью имени. Это свойство используется только тогда, когда allowName равно true.

pattern свойство

public string $pattern;

регулярное выражение, используемое для проверки значения атрибута.

timeout свойство (доступно начиная с версии 1.1.19)

public null|int $timeout;

таймаут, используемый при попытке открыть соединение с портом в checkMxPorts. Если null (по умолчанию), используется значение default_socket_timeout из php.ini. Если не равно null, таймаут устанавливается в секундах.

validateIDN свойство (доступно начиная с версии 1.1.13)

public boolean $validateIDN;

указывает, должна ли проверка учитывать IDN (международные доменные имена). Значение по умолчанию — false, что означает, что проверка адресов электронной почты, содержащих IDN, всегда будет неудачной.

Подробное описание методов

checkMxPorts() метод (доступен начиная с версии 1.1.11)

protected boolean checkMxPorts(string $domain)

protected function checkMxPorts($domain)
{
    $records=dns_get_record($domain, DNS_MX);
    if($records===false || empty($records))
        return false;
    $timeout=is_int($this->timeout)?$this->timeout:((int)ini_get('default_socket_timeout'));
    usort($records,array($this,'mxSort'));
    foreach($records as $record)
    {
        $handle=@fsockopen($record['target'],25,$errno,$errstr,$timeout);
        if($handle!==false)
        {
            fclose($handle);
            return true;
        }
    }
    return false;
}

Возвращает список записей MX для $domain и проверяет, открыт ли порт 25 на одном из них.

clientValidateAttribute() метод (доступен начиная с версии 1.1.7)

public string clientValidateAttribute(CModel $object, string $attribute)

public function clientValidateAttribute($object,$attribute)
{
    if($this->validateIDN)
    {
        Yii::app()->getClientScript()->registerCoreScript('punycode');
        // punycode.js works only with the domains - so we have to extract it before punycoding
        $validateIDN='
var info = value.match(/^(.[^@]+)@(.+)$/);
if (info)
value = info[1] + "@" + punycode.toASCII(info[2]);
';
    }
    else
        $validateIDN='';

    $message=$this->message!==null ? $this->message : Yii::t('yii','{attribute} is not a valid email address.');
    $message=strtr($message, array(
        '{attribute}'=>$object->getAttributeLabel($attribute),
    ));

    $condition="!value.match({$this->pattern})";
    if($this->allowName)
        $condition.=" && !value.match({$this->fullPattern})";

    return "
$validateIDN
if(".($this->allowEmpty ? "jQuery.trim(value)!='' && " : '').$condition.") {
messages.push(".CJSON::encode($message).");
}
";
}

Возвращает JavaScript, необходимый для выполнения проверки на стороне клиента.

mxSort() метод (доступен начиная с версии 1.1.11)

protected boolean mxSort(mixed $a, mixed $b)

protected function mxSort($a, $b)
{
    return $a['pri']-$b['pri'];
}

Определяет, имеет ли одна запись MX более высокий приоритет, чем другая (т.е. 'pri' меньше). Используется в checkMxPorts.

validateAttribute() метод

protected void validateAttribute(CModel $object, string $attribute)

protected function validateAttribute($object,$attribute)
{
    $value=$object->$attribute;
    if($this->allowEmpty && $this->isEmpty($value))
        return;

    if(!$this->validateValue($value))
    {
        $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} is not a valid email address.');
        $this->addError($object,$attribute,$message);
    }
}

Проверяет атрибут объекта. Если есть ошибка, сообщение об ошибке добавляется в объект.

validateValue() метод (доступен начиная с версии 1.1.1)

public boolean validateValue(mixed $value)

public function validateValue($value)
{
    if(is_string($value) && $this->validateIDN)
        $value=$this->encodeIDN($value);
    // make sure string length is limited to avoid DOS attacks
    $valid=is_string($value) && strlen($value)<=254 && (preg_match($this->pattern,$value) || $this->allowName && preg_match($this->fullPattern,$value));
    if($valid)
        $domain=rtrim(substr($value,strpos($value,'@')+1),'>');
    if($valid && $this->checkMX && function_exists('checkdnsrr'))
        $valid=checkdnsrr($domain,'MX');
    if($valid && $this->checkPort && function_exists('fsockopen') && function_exists('dns_get_record'))
        $valid=$this->checkMxPorts($domain);
    return $valid;
}

Проверяет статическое значение на соответствие формату электронного адреса. Этот метод предоставляет возможность вызова напрямую без использования механизма проверки правил модели.

Обратите внимание, что этот метод не учитывает свойство allowEmpty.