0 follower

CEmailValidator

Package system.validators
Inheritance class CEmailValidator » CValidator » CComponent
Since 1.0
Version $Id$
Source Code framework/validators/CEmailValidator.php
CEmailValidator validates that the attribute value is a valid email address.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
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
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

Public Methods

Hide inherited methods

MethodDescriptionDefined 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
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
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

Protected Methods

Hide inherited methods

MethodDescriptionDefined 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 (available since v1.0.5)
public boolean $allowName;

whether to allow name in the email address (e.g. "Qiang Xue "). Defaults to false.

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 (available since v1.0.4)
public boolean $checkPort;

whether to check port 25 for the email address. Defaults to false.

fullPattern property (available since v1.0.5)
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.

See Also

Method Details

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#63 (show)
protected function validateAttribute($object,$attribute)
{
    $value=$object->$attribute;
    if($this->allowEmpty && $this->isEmpty($value))
        return;
    $valid=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;
    if(!$valid)
    {
        $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.