| 包 | system.validators |
|---|---|
| 继承 | class CBooleanValidator » CValidator » CComponent |
| 版本 | $Id: CBooleanValidator.php 3515 2011-12-28 12:29:24Z mdomba $ |
| 源码 |
CBooleanValidator 验证trueValue或者falseValue属性值。
当使用message属性值去定义一个自定义错误信息，这个信息 可能会包含一些附加的会被实际的内容代替的占位符。比如对于"{attribute}"占位符， 可以被所有的验证器识别(参考CValidator)， CBooleanValidator 允许如下的占位符指定：
当使用message属性值去定义一个自定义错误信息，这个信息 可能会包含一些附加的会被实际的内容代替的占位符。比如对于"{attribute}"占位符， 可以被所有的验证器识别(参考CValidator)， CBooleanValidator 允许如下的占位符指定：
- {true}: 被用于表示真的 trueValue值替换。
- {false}: 被用于表示假的falseValue值替换。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| allowEmpty | boolean | 是否允许属性值null或者empty，默认是真值， 表示如果属性值是empty，他表示是无效值。 | CBooleanValidator |
| attributes | array | 需要被验证的属性的列表。 | CValidator |
| builtInValidators | array | 内置验证器列表 (name=>class) | CValidator |
| enableClientValidation | boolean | 是否执行客户端验证。默认值为true。 参见CActiveForm::enableClientValidation以了解更多关于客户端验证的细节。 | CValidator |
| falseValue | mixed | 用于代表真值状态。默认是 '0'。 | CBooleanValidator |
| message | string | 用户自定义的错误提示信息。不同的验证器可以在该信息中 定义各种占位符（将被实际值替换）。占位符“{attribute}”可以被所有 验证器识别，它会被使用属性的标签来替换。 | CValidator |
| on | array | 验证器将被应用到的情景模式的列表。 数组的键-值都是情景模式的名称。 | CValidator |
| safe | boolean | 进行整块赋值是是否考虑此验证器中列出的属性的安全性。 默认值为true。 | CValidator |
| skipOnError | boolean | 如果当前属性已经存在验证错误，这个验证规则 是否跳过。默认值是false。 | CValidator |
| strict | boolean | 比较 trueValue 和 falseValue 时是否是严格匹配的。 当这个的值是真值的时候，这个的属性值和类型必须和trueValue或者falseValue匹配。 默认值是假，表示只是这个值需要匹配。 | CBooleanValidator |
| trueValue | mixed | 用于代表真值状态。 默认是'1'。 | CBooleanValidator |
公共方法
受保护方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| addError() | 添加关于指定属性的一个错误提示信息到活动记录中。 | CValidator |
| isEmpty() | 检测给定值是否为空。 | CValidator |
| validateAttribute() | 对目标的属性进行验证。 | CBooleanValidator |
属性详细
allowEmpty
属性
public boolean $allowEmpty;
是否允许属性值null或者empty，默认是真值， 表示如果属性值是empty，他表示是无效值。
falseValue
属性
public mixed $falseValue;
用于代表真值状态。默认是 '0'。
strict
属性
public boolean $strict;
比较 trueValue 和 falseValue 时是否是严格匹配的。 当这个的值是真值的时候，这个的属性值和类型必须和trueValue或者falseValue匹配。 默认值是假，表示只是这个值需要匹配。
trueValue
属性
public mixed $trueValue;
用于代表真值状态。 默认是'1'。
方法详细
clientValidateAttribute()
方法
（可用自 v1.1.7）
|
public string clientValidateAttribute(CModel $object, string $attribute)
| ||
| $object | CModel | 被验证的对象 |
| $attribute | string | 被验证的属性的名字。 |
| {return} | string | 客户端验证的脚本。 |
public function clientValidateAttribute($object,$attribute)
{
$message=$this->message!==null ? $this->message : Yii::t('yii','{attribute} must be either {true} or {false}.');
$message=strtr($message, array(
'{attribute}'=>$object->getAttributeLabel($attribute),
'{true}'=>$this->trueValue,
'{false}'=>$this->falseValue,
));
return "
if(".($this->allowEmpty ? "$.trim(value)!='' && " : '')."value!=".CJSON::encode($this->trueValue)." && value!=".CJSON::encode($this->falseValue).") {
messages.push(".CJSON::encode($message).");
}
";
}
返回用于客户端验证的JavaScript。
validateAttribute()
方法
|
protected void validateAttribute(CModel $object, string $attribute)
| ||
| $object | CModel | 用于验证的对象 |
| $attribute | string | 用于验证的属性 |
protected function validateAttribute($object,$attribute)
{
$value=$object->$attribute;
if($this->allowEmpty && $this->isEmpty($value))
return;
if(!$this->strict && $value!=$this->trueValue && $value!=$this->falseValue
|| $this->strict && $value!==$this->trueValue && $value!==$this->falseValue)
{
$message=$this->message!==null?$this->message:Yii::t('yii','{attribute} must be either {true} or {false}.');
$this->addError($object,$attribute,$message,array(
'{true}'=>$this->trueValue,
'{false}'=>$this->falseValue,
));
}
}
对目标的属性进行验证。 如果这个出现任何错误，这个错误将被加到这个对象中去。