CEmailValidator
| Package | system.validators |
|---|---|
| Inheritance | class CEmailValidator » CValidator » CComponent |
| Since | 1.0 |
| Version | $Id: CEmailValidator.php 3515 2011-12-28 12:29:24Z mdomba $ |
| Source Code | framework/validators/CEmailValidator.php |
CEmailValidator validates that the attribute value is a valid email address.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| allowEmpty | boolean | whether the attribute value can be null or empty. | CEmailValidator |
| allowName | boolean | whether to allow name in the email address (e. | 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 |
| 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 |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __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 |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| addError() | Adds an error about the specified attribute to the active record. | CValidator |
| isEmpty() | Checks if the given value is empty. | CValidator |
| validateAttribute() | Validates the attribute of the object. | CEmailValidator |
Property Details
allowEmpty
property
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
property
public boolean $allowName;
whether to allow name in the email address (e.g. "Qiang Xue
See Also
checkMX
property
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.
checkPort
property
public boolean $checkPort;
whether to check port 25 for the email address. Defaults to false.
fullPattern
property
public string $fullPattern;
the regular expression used to validate email addresses with the name part. This property is used only when allowName is true.
See Also
pattern
property
public string $pattern;
the regular expression used to validate the attribute value.
Method Details
clientValidateAttribute()
method
(available since 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. |
Source Code: framework/validators/CEmailValidator.php#101 (show)
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).");
}
";
}
Returns the JavaScript needed for performing client-side validation.
See Also
validateAttribute()
method
|
protected void validateAttribute(CModel $object, string $attribute)
| ||
| $object | CModel | the object being validated |
| $attribute | string | the attribute being validated |
Source Code: framework/validators/CEmailValidator.php#60 (show)
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()
method
(available since v1.1.1)
|
public boolean validateValue(mixed $value)
| ||
| $value | mixed | the value to be validated |
| {return} | boolean | whether the value is a valid email |
Source Code: framework/validators/CEmailValidator.php#80 (show)
public function validateValue($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'))
$valid=fsockopen($domain,25)!==false;
return $valid;
}
Validates a static value to see if it is a valid email. Note that this method does not respect allowEmpty property. This method is provided so that you can call it directly without going through the model validation rule mechanism.