CEmailValidator - system.validators - [ Yii中文参考手册 ]

CEmailValidator

包	system.validators
继承	class CEmailValidator » CValidator » CComponent
源自	1.0
版本	$Id: CEmailValidator.php 3515 2011-12-28 12:29:24Z mdomba $
源码

CEmailValidator验证此属性值是否一个有效的email地址。

公共属性

属性	类型	描述	定义在
allowEmpty	boolean	此属性值是否可以为null或empty。默认值是true，表示如果此属性值为空时它将通过验证。	CEmailValidator
allowName	boolean	是否允许在email地址中包含姓名（例如："Qiang Xue	CEmailValidator
attributes	array	需要被验证的属性的列表。	CValidator
builtInValidators	array	内置验证器列表 (name=>class)	CValidator
checkMX	boolean	是否检测email地址的MX记录。默认值是false。要启用它，你需要确保你的PHP 安装里含有'checkdnsrr'函数。	CEmailValidator
checkPort	boolean	是否在端口25检测email地址。默认值是false。	CEmailValidator
enableClientValidation	boolean	是否执行客户端验证。默认值为true。参见CActiveForm::enableClientValidation以了解更多关于客户端验证的细节。	CValidator
fullPattern	string	用于验证带有名字部分的email地址的正则表达式。此属性仅当allowName为true时才会被使用。	CEmailValidator
message	string	用户自定义的错误提示信息。不同的验证器可以在该信息中定义各种占位符（将被实际值替换）。占位符“{attribute}”可以被所有验证器识别，它会被使用属性的标签来替换。	CValidator
on	array	验证器将被应用到的情景模式的列表。数组的键-值都是情景模式的名称。	CValidator
pattern	string	用于验证属性值的正则表达式。	CEmailValidator
safe	boolean	进行整块赋值是是否考虑此验证器中列出的属性的安全性。默认值为true。	CValidator
skipOnError	boolean	如果当前属性已经存在验证错误，这个验证规则是否跳过。默认值是false。	CValidator

公共方法

方法	描述	定义在
__call()	如果类中没有调的方法名，则调用这个方法。	CComponent
__get()	返回一个属性值、一个事件处理程序列表或一个行为名称。	CComponent
__isset()	检查一个属性是否为null。	CComponent
__set()	设置一个组件的属性值。	CComponent
__unset()	设置一个组件的属性为null。	CComponent
applyTo()	返回值指定此验证器是否应用到指定的情景模式。	CValidator
asa()	返回这个名字的行为对象。	CComponent
attachBehavior()	附加一个行为到组件。	CComponent
attachBehaviors()	附加一个行为列表到组件。	CComponent
attachEventHandler()	为事件附加一个事件处理程序。	CComponent
canGetProperty()	确定属性是否可读。	CComponent
canSetProperty()	确定属性是否可写。	CComponent
clientValidateAttribute()	返回执行客户端验证所需的Javascript。	CEmailValidator
createValidator()	创建一个验证器对象。	CValidator
detachBehavior()	从组件中分离一个行为。	CComponent
detachBehaviors()	从组件中分离所有行为。	CComponent
detachEventHandler()	分离一个存在的事件处理程序。	CComponent
disableBehavior()	禁用一个附加行为。	CComponent
disableBehaviors()	禁用组件附加的所有行为。	CComponent
enableBehavior()	启用一个附加行为。	CComponent
enableBehaviors()	启用组件附加的所有行为。	CComponent
evaluateExpression()	计算一个PHP表达式，或根据组件上下文执行回调。	CComponent
getEventHandlers()	返回一个事件的附加处理程序列表。	CComponent
hasEvent()	确定一个事件是否定义。	CComponent
hasEventHandler()	检查事件是否有附加的处理程序。	CComponent
hasProperty()	确定属性是否被定义。	CComponent
raiseEvent()	发起一个事件。	CComponent
validate()	验证给定的对象。	CValidator
validateValue()	验证一个静态值是否一个有效的email地址。	CEmailValidator

受保护方法

方法	描述	定义在
addError()	添加关于指定属性的一个错误提示信息到活动记录中。	CValidator
isEmpty()	检测给定值是否为空。	CValidator
validateAttribute()	验证传入对象的属性。	CEmailValidator

属性详细

allowEmpty 属性

public boolean $allowEmpty;

此属性值是否可以为null或empty。默认值是true，表示如果此属性值为空时它将通过验证。

allowName 属性

public boolean $allowName;

是否允许在email地址中包含姓名（例如："Qiang Xue "）。默认值是false。

参见

fullPattern

checkMX 属性

public boolean $checkMX;

是否检测email地址的MX记录。默认值是false。要启用它，你需要确保你的PHP 安装里含有'checkdnsrr'函数。

checkPort 属性

public boolean $checkPort;

是否在端口25检测email地址。默认值是false。

fullPattern 属性

public string $fullPattern;

用于验证带有名字部分的email地址的正则表达式。此属性仅当allowName为true时才会被使用。

参见

allowName

pattern 属性

public string $pattern;

用于验证属性值的正则表达式。

参见

http://www.regular-expressions.info/email.html

方法详细

clientValidateAttribute() 方法（可用自 v1.1.7）

public string clientValidateAttribute(CModel $object, string $attribute)
$object	CModel	需要验证的对象
$attribute	string	需要验证的属性的名字
{return}	string	客户端验证脚本


public function clientValidateAttribute($object,$attribute)
{
    $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 "
if(".($this->allowEmpty ? "$.trim(value)!='' && " : '').$condition.") {
messages.push(".CJSON::encode($message).");
}
";
}

返回执行客户端验证所需的Javascript。

参见

CActiveForm::enableClientValidation

validateAttribute() 方法

protected void validateAttribute(CModel $object, string $attribute)
$object	CModel	需要验证的对象
$attribute	string	需要验证的属性


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() 方法（可用自 v1.1.1）

public boolean validateValue(mixed $value)
$value	mixed	需要验证的值
{return}	boolean	验证的值是否有效的email地址


public function validateValue($value)
{
    // 确保字符串的长度受限制以避免DOS攻击
    $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'))
        $valid=fsockopen($domain,25)!==false;
    return $valid;
}

验证一个静态值是否一个有效的email地址。注意：此方法不受allowEmpty属性的影响。此方法的目的是使你可以简单地直接调用它而不用通过模型验证规则机制。