CEmailValidator
| 包 | system.validators |
|---|---|
| 继承 | class CEmailValidator » CValidator » CComponent |
| 可用自 | 1.0 |
| 源码 | framework/validators/CEmailValidator.php |
CEmailValidator validates that the attribute value is a valid email address.
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| allowEmpty | boolean | whether the attribute value can be null or empty. | CEmailValidator |
| allowName | boolean | whether to allow name in the email address (e.g. "Qiang Xue | CEmailValidator |
|
| attributes | array | list of attributes to be validated. | CValidator |
| builtInValidators | array | list of built-in validators (name=>class) | CValidator |
| checkMX | boolean | whether to check the MX record for the email address. | CEmailValidator |
| checkPort | boolean | whether to check port 25 for the email address. | CEmailValidator |
| enableClientValidation | boolean | whether to perform client-side validation. | CValidator |
| except | array | list of scenarios that the validator should not be applied to. | CValidator |
| fullPattern | string | the regular expression used to validate email addresses with the name part. | CEmailValidator |
| message | string | the user-defined error message. | CValidator |
| on | array | list of scenarios that the validator should be applied. | CValidator |
| pattern | string | the regular expression used to validate the attribute value. | CEmailValidator |
| safe | boolean | whether attributes listed with this validator should be considered safe for massive assignment. | CValidator |
| skipOnError | boolean | whether this validation rule should be skipped when there is already a validation error for the current attribute. | CValidator |
| timeout | null|int | timeout to use when attempting to open connection to port in checkMxPorts. | CEmailValidator |
| validateIDN | boolean | whether validation process should care about IDN (internationalized domain names). | CEmailValidator |
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| applyTo() | Returns a value indicating whether the validator applies to the specified scenario. | CValidator |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| clientValidateAttribute() | Returns the JavaScript needed for performing client-side validation. | CEmailValidator |
| createValidator() | Creates a validator object. | CValidator |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| raiseEvent() | Raises an event. | CComponent |
| validate() | Validates the specified object. | CValidator |
| validateValue() | Validates a static value to see if it is a valid email. | CEmailValidator |
受保护的方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| addError() | Adds an error about the specified attribute to the active record. | CValidator |
| checkMxPorts() | Retrieves the list of MX records for $domain and checks if port 25 | CEmailValidator |
| isEmpty() | Checks if the given value is empty. | CValidator |
| mxSort() | Determines if one MX record has higher priority as another | CEmailValidator |
| validateAttribute() | Validates the attribute of the object. | CEmailValidator |
属性详情
allowEmpty
属性
public boolean $allowEmpty;
whether the attribute value can be null or empty. Defaults to true, meaning that if the attribute is empty, it is considered valid.
allowName
属性
public boolean $allowName;
whether to allow name in the email address (e.g. "Qiang Xue
参见
checkMX
属性
public boolean $checkMX;
whether to check the MX record for the email address. Defaults to false. To enable it, you need to make sure the PHP function 'checkdnsrr' exists in your PHP installation. Please note that this check may fail due to temporary problems even if email is deliverable.
checkPort
属性
public boolean $checkPort;
whether to check port 25 for the email address. Defaults to false. To enable it, ensure that the PHP functions 'dns_get_record' and 'fsockopen' are available in your PHP installation. Please note that this check may fail due to temporary problems even if email is deliverable.
fullPattern
属性
public string $fullPattern;
the regular expression used to validate email addresses with the name part. This property is used only when allowName is true.
参见
pattern
属性
public string $pattern;
the regular expression used to validate the attribute value.
timeout
属性
（自版本 v1.1.19 可用）
public null|int $timeout;
timeout to use when attempting to open connection to port in checkMxPorts. If null (default) use default_socket_timeout value from php.ini. If not null the timeout is set in seconds.
validateIDN
属性
（自版本 v1.1.13 可用）
public boolean $validateIDN;
whether validation process should care about IDN (internationalized domain names). Default value is false which means that validation of emails containing IDN will always fail.
方法详情
checkMxPorts()
方法
（自版本 v1.1.11 可用）
|
protected boolean checkMxPorts(string $domain)
| ||
| $domain | string | domain to be checked |
| {return} | boolean | true if a reachable MX server has been found |
源码： framework/validators/CEmailValidator.php#160 (显示)
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;
}
Retrieves the list of MX records for $domain and checks if port 25 is opened on any of these.
clientValidateAttribute()
方法
（自版本 v1.1.7 可用）
|
public string clientValidateAttribute(CModel $object, string $attribute)
| ||
| $object | CModel | the data object being validated |
| $attribute | string | the name of the attribute to be validated. |
| {return} | string | the client-side validation script. |
源码： framework/validators/CEmailValidator.php#121 (显示)
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).");
}
";
}
Returns the JavaScript needed for performing client-side validation.
mxSort()
方法
（自版本 v1.1.11 可用）
|
protected boolean mxSort(mixed $a, mixed $b)
| ||
| $a | mixed | first item for comparison |
| $b | mixed | second item for comparison |
| {return} | boolean | |
源码： framework/validators/CEmailValidator.php#187 (显示)
protected function mxSort($a, $b)
{
return $a['pri']-$b['pri'];
}
Determines if one MX record has higher priority as another (i.e. 'pri' is lower). Used by checkMxPorts.
validateAttribute()
方法
|
protected void validateAttribute(CModel $object, string $attribute)
| ||
| $object | CModel | the object being validated |
| $attribute | string | the attribute being validated |
源码： framework/validators/CEmailValidator.php#74 (显示)
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);
}
}
Validates the attribute of the object. If there is any error, the error message is added to the object.
validateValue()
方法
（自版本 v1.1.1 可用）
|
public boolean validateValue(mixed $value)
| ||
| $value | mixed | the value to be validated |
| {return} | boolean | whether the value is a valid email |
源码： framework/validators/CEmailValidator.php#98 (显示)
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;
}
Validates a static value to see if it is a valid email.
This method is provided so that you can call it directly without going through the model validation rule mechanism.
Note that this method does not respect the allowEmpty property.