Versions
Look up a class, method, property or event

CRegularExpressionValidator

Package system.validators
Inheritance class CRegularExpressionValidator » CValidator » CComponent
Since 1.0
Source Code framework/validators/CRegularExpressionValidator.php
CRegularExpressionValidator validates that the attribute value matches to the specified regular expression. You may invert the validation logic with help of the not property (available since 1.1.5).

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
allowEmpty boolean whether the attribute value can be null or empty. CRegularExpressionValidator
attributes array list of attributes to be validated. CValidator
builtInValidators array list of built-in validators (name=>class) CValidator
enableClientValidation boolean whether to perform client-side validation. CValidator
except array list of scenarios that the validator should not be applied to. CValidator
message string the user-defined error message. CValidator
not boolean whether to invert the validation logic. CRegularExpressionValidator
on array list of scenarios that the validator should be applied. CValidator
pattern string the regular expression to be matched with CRegularExpressionValidator
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

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
clientValidateAttribute() Returns the JavaScript needed for performing client-side validation. CRegularExpressionValidator
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

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. CRegularExpressionValidator

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.

not property (available since v1.1.5)
public boolean $not;

whether to invert the validation logic. Defaults to false. If set to true, the regular expression defined via pattern should NOT match the attribute value.

pattern property
public string $pattern;

the regular expression to be matched with

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/CRegularExpressionValidator.php#70 (show)
public function clientValidateAttribute($object,$attribute)
{
    if(
$this->pattern===null)
        throw new 
CException(Yii::t('yii','The "pattern" property must be specified with a valid regular expression.'));

    
$message=$this->message!==null $this->message Yii::t('yii','{attribute} is invalid.');
    
$message=strtr($message, array(
        
'{attribute}'=>$object->getAttributeLabel($attribute),
    ));

    
$pattern=$this->pattern;
    
$pattern=preg_replace('/\\\\x\{?([0-9a-fA-F]+)\}?/''\u$1'$pattern);
    
$delim=substr($pattern01);
    
$endpos=strrpos($pattern$delim1);
    
$flag=substr($pattern$endpos 1);
    if (
$delim!=='/')
        
$pattern='/' str_replace('/''\\/'substr($pattern1$endpos 1)) . '/';
    else
        
$pattern substr($pattern0$endpos 1);
    if (!empty(
$flag))
        
$pattern .= preg_replace('/[^igm]/'''$flag);

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

Returns the JavaScript needed for performing client-side validation.

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/CRegularExpressionValidator.php#44 (show)
protected function validateAttribute($object,$attribute)
{
    
$value=$object->$attribute;
    if(
$this->allowEmpty && $this->isEmpty($value))
        return;
    if(
$this->pattern===null)
        throw new 
CException(Yii::t('yii','The "pattern" property must be specified with a valid regular expression.'));
    
// reason of array checking explained here: https://github.com/yiisoft/yii/issues/1955
    
if(is_array($value) ||
        (!
$this->not && !preg_match($this->pattern,$value)) ||
        (
$this->not && preg_match($this->pattern,$value)))
    {
        
$message=$this->message!==null?$this->message:Yii::t('yii','{attribute} is invalid.');
        
$this->addError($object,$attribute,$message);
    }
}

Validates the attribute of the object. If there is any error, the error message is added to the object.

Total 4 comments

#13089 report it
bennouna at 2013/05/03 12:22pm
To include accented letters (and any Unicode letter in fact)

Taking for instance the Blog demo, in the Post model, transform:

array('tags', 'match', 'pattern'=>'/^[\w\s,]+$/', 'message'=>'Tags can only contain word characters.'),

into

array('tags', 'match', 'pattern'=>'/^[\p{L}\s,0-9]+$/u', 'message'=>'Tags can only contain word characters.'),

More info: Regex Syntax (Unicode) on php.net

#6518 report it
Chris Backhouse at 2012/01/16 09:05am
More examples ...

Name and address match: allowing all alphanumeric including diacritics, comma, hyphen, underscore and single quote.

array('fieldname', 'pattern'=>'/^[\w\-\_\'\,]+$/'),
#5320 report it
Tohotom at 2011/10/04 06:40am
Difference between PHP and JS

Note, that regular expressions do not work exactly the same way in Javascript and PHP, therefore client side validation may not work as expected.

Client-side regex matching also depends on the browser, so if you need to use some non-standard regex, consider disabling client side validation.

#3090 report it
zaccaria at 2011/03/15 10:26am
Example of usage:

Validate a username: only letters, numbers and underscore:

array('username', 'match', 'pattern'=>'/^([a-z0-9_])+$/'),

Validate a telephone number: a + at the beginning, then only numbers or spaces

array('telephone', 'match', 'pattern'=>'/^([+]?[0-9 ]+)$/'),

Leave a comment

Please to leave your comment.