Yii Framework v1.1.10 类参考
CRangeValidator
| 包 | system.validators |
|---|---|
| 继承 | class CRangeValidator » CValidator » CComponent |
| 源自 | 1.0 |
| 版本 | $Id: CRangeValidator.php 3120 2011-03-25 01:50:48Z qiang.xue $ |
| 源码 | framework/validators/CRangeValidator.php |
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| allowEmpty | boolean | 是否此属性值可以为null或empty。默认值是true， 表示如果此属性值为空时将通过验证。 | CRangeValidator |
| attributes | array | 需要被验证的属性的列表。 | CValidator |
| builtInValidators | array | 内置验证器列表 (name=>class) | CValidator |
| enableClientValidation | boolean | 是否执行客户端验证。默认值为true。 参见CActiveForm::enableClientValidation以了解更多关于客户端验证的细节。 | CValidator |
| message | string | 用户自定义的错误提示信息。不同的验证器可以在该信息中 定义各种占位符（将被实际值替换）。占位符“{attribute}”可以被所有 验证器识别，它会被使用属性的标签来替换。 | CValidator |
| not | boolean | 是否反转验证逻辑。默认值是false。如果设置为true， 此属性值不在列表（通过range定义）中时验证通过。 | CRangeValidator |
| on | array | 验证器将被应用到的情景模式的列表。 数组的键-值都是情景模式的名称。 | CValidator |
| range | array | 此属性值的有效值列表 | CRangeValidator |
| safe | boolean | 进行整块赋值是是否考虑此验证器中列出的属性的安全性。 默认值为true。 | CValidator |
| skipOnError | boolean | 如果当前属性已经存在验证错误，这个验证规则 是否跳过。默认值是false。 | CValidator |
| strict | boolean | 是否执行严格比较（类型与值都必须一致）。默认值是false。 | CRangeValidator |
公共方法
受保护方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| addError() | 添加关于指定属性的一个错误提示信息到活动记录中。 | CValidator |
| isEmpty() | 检测给定值是否为空。 | CValidator |
| validateAttribute() | 验证传入对象的属性。 | CRangeValidator |
属性详细
allowEmpty
属性
public boolean $allowEmpty;
是否此属性值可以为null或empty。默认值是true， 表示如果此属性值为空时将通过验证。
not
属性
（可用自 v1.1.5）
public boolean $not;
是否反转验证逻辑。默认值是false。如果设置为true， 此属性值不在列表（通过range定义）中时验证通过。
range
属性
public array $range;
此属性值的有效值列表
strict
属性
public boolean $strict;
是否执行严格比较（类型与值都必须一致）。默认值是false。
方法详细
clientValidateAttribute()
方法
（可用自 v1.1.7）
|
public string clientValidateAttribute(CModel $object, string $attribute)
| ||
| $object | CModel | 需要验证的对象 |
| $attribute | string | 需要验证的属性 |
| {return} | string | 客户端验证脚本 |
源码： framework/validators/CRangeValidator.php#75 (显示)
public function clientValidateAttribute($object,$attribute)
{
if(!is_array($this->range))
throw new CException(Yii::t('yii','The "range" property must be specified with a list of values.'));
if(($message=$this->message)===null)
$message=$this->not ? Yii::t('yii','{attribute} is in the list.') : Yii::t('yii','{attribute} is not in the list.');
$message=strtr($message,array(
'{attribute}'=>$object->getAttributeLabel($attribute),
));
$range=array();
foreach($this->range as $value)
$range[]=(string)$value;
$range=CJSON::encode($range);
return "
if(".($this->allowEmpty ? "$.trim(value)!='' && " : '').($this->not ? "$.inArray(value, $range)>=0" : "$.inArray(value, $range)<0").") {
messages.push(".CJSON::encode($message).");
}
";
}
返回执行客户端验证所需的JavaScript。
validateAttribute()
方法
|
protected void validateAttribute(CModel $object, string $attribute)
| ||
| $object | CModel | 需要验证的对象 |
| $attribute | string | 需要验证的属性 |
源码： framework/validators/CRangeValidator.php#48 (显示)
protected function validateAttribute($object,$attribute)
{
$value=$object->$attribute;
if($this->allowEmpty && $this->isEmpty($value))
return;
if(!is_array($this->range))
throw new CException(Yii::t('yii','The "range" property must be specified with a list of values.'));
if(!$this->not && !in_array($value,$this->range,$this->strict))
{
$message=$this->message!==null?$this->message:Yii::t('yii','{attribute} is not in the list.');
$this->addError($object,$attribute,$message);
}
else if($this->not && in_array($value,$this->range,$this->strict))
{
$message=$this->message!==null?$this->message:Yii::t('yii','{attribute} is in the list.');
$this->addError($object,$attribute,$message);
}
}
验证传入对象的属性。 如果存在任何验证错误，错误提示信息将被添加到此对象中。