* @link http://www.yiiframework.com/ * @copyright 2008-2013 Yii Software LLC * @license http://www.yiiframework.com/license/ */ /** * CValidator is the base class for all validators. * * Child classes must implement the {@link validateAttribute} method. * * The following properties are defined in CValidator: *

*
• {@link attributes}: array, list of attributes to be validated;
*
• {@link message}: string, the customized error message. The message * may contain placeholders that will be replaced with the actual content. * For example, the "{attribute}" placeholder will be replaced with the label * of the problematic attribute. Different validators may define additional * placeholders.
*
• {@link on}: string, in which scenario should the validator be in effect. * This is used to match the 'on' parameter supplied when calling {@link CModel::validate}.
*

* * When using {@link createValidator} to create a validator, the following aliases * are recognized as the corresponding built-in validator classes: *

*
• required: {@link CRequiredValidator}
*
• filter: {@link CFilterValidator}
*
• match: {@link CRegularExpressionValidator}
*
• email: {@link CEmailValidator}
*
• url: {@link CUrlValidator}
*
• unique: {@link CUniqueValidator}
*
• compare: {@link CCompareValidator}
*
• length: {@link CStringValidator}
*
• in: {@link CRangeValidator}
*
• numerical: {@link CNumberValidator}
*
• captcha: {@link CCaptchaValidator}
*
• type: {@link CTypeValidator}
*
• file: {@link CFileValidator}
*
• default: {@link CDefaultValueValidator}
*
• exist: {@link CExistValidator}
*
• boolean: {@link CBooleanValidator}
*
• date: {@link CDateValidator}
*
• safe: {@link CSafeValidator}
*
• unsafe: {@link CUnsafeValidator}
*

* * @author Qiang Xue * @package system.validators * @since 1.0 */ abstract class CValidator extends CComponent { /** * @var array list of built-in validators (name=>class) */ public static $builtInValidators=array( 'required'=>'CRequiredValidator', 'filter'=>'CFilterValidator', 'match'=>'CRegularExpressionValidator', 'email'=>'CEmailValidator', 'url'=>'CUrlValidator', 'unique'=>'CUniqueValidator', 'compare'=>'CCompareValidator', 'length'=>'CStringValidator', 'in'=>'CRangeValidator', 'numerical'=>'CNumberValidator', 'captcha'=>'CCaptchaValidator', 'type'=>'CTypeValidator', 'file'=>'CFileValidator', 'default'=>'CDefaultValueValidator', 'exist'=>'CExistValidator', 'boolean'=>'CBooleanValidator', 'safe'=>'CSafeValidator', 'unsafe'=>'CUnsafeValidator', 'date'=>'CDateValidator', ); /** * @var array list of attributes to be validated. */ public $attributes; /** * @var string the user-defined error message. Different validators may define various * placeholders in the message that are to be replaced with actual values. All validators * recognize "{attribute}" placeholder, which will be replaced with the label of the attribute. */ public $message; /** * @var boolean whether this validation rule should be skipped when there is already a validation * error for the current attribute. Defaults to false. * @since 1.1.1 */ public $skipOnError=false; /** * @var array list of scenarios that the validator should be applied. * Each array value refers to a scenario name with the same name as its array key. */ public $on; /** * @var array list of scenarios that the validator should not be applied to. * Each array value refers to a scenario name with the same name as its array key. * @since 1.1.11 */ public $except; /** * @var boolean whether attributes listed with this validator should be considered safe for massive assignment. * Defaults to true. * @since 1.1.4 */ public $safe=true; /** * @var boolean whether to perform client-side validation. Defaults to true. * Please refer to {@link CActiveForm::enableClientValidation} for more details about client-side validation. * @since 1.1.7 */ public $enableClientValidation=true; /** * Validates a single attribute. * This method should be overridden by child classes. * @param CModel $object the data object being validated * @param string $attribute the name of the attribute to be validated. */ abstract protected function validateAttribute($object,$attribute); /** * Creates a validator object. * @param string $name the name or class of the validator * @param CModel $object the data object being validated that may contain the inline validation method * @param mixed $attributes list of attributes to be validated. This can be either an array of * the attribute names or a string of comma-separated attribute names. * @param array $params initial values to be applied to the validator properties * @return CValidator the validator */ public static function createValidator($name,$object,$attributes,$params=array()) { if(is_string($attributes)) $attributes=preg_split('/[\s,]+/',$attributes,-1,PREG_SPLIT_NO_EMPTY); if(isset($params['on'])) { if(is_array($params['on'])) $on=$params['on']; else $on=preg_split('/[\s,]+/',$params['on'],-1,PREG_SPLIT_NO_EMPTY); } else $on=array(); if(isset($params['except'])) { if(is_array($params['except'])) $except=$params['except']; else $except=preg_split('/[\s,]+/',$params['except'],-1,PREG_SPLIT_NO_EMPTY); } else $except=array(); if(method_exists($object,$name)) { $validator=new CInlineValidator; $validator->attributes=$attributes; $validator->method=$name; if(isset($params['clientValidate'])) { $validator->clientValidate=$params['clientValidate']; unset($params['clientValidate']); } $validator->params=$params; if(isset($params['skipOnError'])) $validator->skipOnError=$params['skipOnError']; } else { $params['attributes']=$attributes; if(isset(self::$builtInValidators[$name])) $className=Yii::import(self::$builtInValidators[$name],true); else $className=Yii::import($name,true); $validator=new $className; foreach($params as $name=>$value) $validator->$name=$value; } $validator->on=empty($on) ? array() : array_combine($on,$on); $validator->except=empty($except) ? array() : array_combine($except,$except); return $validator; } /** * Validates the specified object. * @param CModel $object the data object being validated * @param array $attributes the list of attributes to be validated. Defaults to null, * meaning every attribute listed in {@link attributes} will be validated. */ public function validate($object,$attributes=null) { if(is_array($attributes)) $attributes=array_intersect($this->attributes,$attributes); else $attributes=$this->attributes; foreach($attributes as $attribute) { if(!$this->skipOnError || !$object->hasErrors($attribute)) $this->validateAttribute($object,$attribute); } } /** * Returns the JavaScript needed for performing client-side validation. * Do not override this method if the validator does not support client-side validation. * Two predefined JavaScript variables can be used: *

*
• value: the value to be validated
*
• messages: an array used to hold the validation error messages for the value
*

* @param CModel $object the data object being validated * @param string $attribute the name of the attribute to be validated. * @return string the client-side validation script. Null if the validator does not support client-side validation. * @see CActiveForm::enableClientValidation * @since 1.1.7 */ public function clientValidateAttribute($object,$attribute) { } /** * Returns a value indicating whether the validator applies to the specified scenario. * A validator applies to a scenario as long as any of the following conditions is met: *

*
• the validator's "on" property is empty
*
• the validator's "on" property contains the specified scenario
*

* @param string $scenario scenario name * @return boolean whether the validator applies to the specified scenario. */ public function applyTo($scenario) { if(isset($this->except[$scenario])) return false; return empty($this->on) || isset($this->on[$scenario]); } /** * Adds an error about the specified attribute to the active record. * This is a helper method that performs message selection and internationalization. * @param CModel $object the data object being validated * @param string $attribute the attribute being validated * @param string $message the error message * @param array $params values for the placeholders in the error message */ protected function addError($object,$attribute,$message,$params=array()) { $params['{attribute}']=$object->getAttributeLabel($attribute); $object->addError($attribute,strtr($message,$params)); } /** * Checks if the given value is empty. * A value is considered empty if it is null, an empty array, or the trimmed result is an empty string. * Note that this method is different from PHP empty(). It will return false when the value is 0. * @param mixed $value the value to be checked * @param boolean $trim whether to perform trimming before checking if the string is empty. Defaults to false. * @return boolean whether the value is empty */ protected function isEmpty($value,$trim=false) { return $value===null || $value===array() || $value==='' || $trim && is_scalar($value) && trim($value)===''; } }