包 | system.validators |
---|---|
继承 | class CFilterValidator » CValidator » CComponent |
源自 | 1.0 |
版本 | $Id: CFilterValidator.php 2799 2011-01-01 19:31:13Z qiang.xue $ |
源码 |
CFilterValidator基于一个过滤器将数据进行变换。
CFilterValidator事实上并不是一个验证器,而是一 个数据处理器。它调用指定的过滤方法,处理属性的 值,然后将处理后的值重新保存到属性中。该过滤必 须形如以下签名:
要指定过滤方法,设置filter属性为函数的名字。
CFilterValidator事实上并不是一个验证器,而是一 个数据处理器。它调用指定的过滤方法,处理属性的 值,然后将处理后的值重新保存到属性中。该过滤必 须形如以下签名:
function foo($value) {...return $newValue; }很多PHP函数符合这种签名(例如,trim)。
要指定过滤方法,设置filter属性为函数的名字。
公共属性
属性 | 类型 | 描述 | 定义在 |
---|---|---|---|
attributes | array | 需要被验证的属性的列表。 | CValidator |
builtInValidators | array | 内置验证器列表 (name=>class) | CValidator |
enableClientValidation | boolean | 是否执行客户端验证。默认值为true。 参见CActiveForm::enableClientValidation以了解更多关于客户端验证的细节。 | CValidator |
filter | 回调过滤方法 | CFilterValidator | |
message | string | 用户自定义的错误提示信息。不同的验证器可以在该信息中 定义各种占位符(将被实际值替换)。占位符“{attribute}”可以被所有 验证器识别,它会被使用属性的标签来替换。 | CValidator |
on | array | 验证器将被应用到的情景模式的列表。 数组的键-值都是情景模式的名称。 | CValidator |
safe | boolean | 进行整块赋值是是否考虑此验证器中列出的属性的安全性。 默认值为true。 | CValidator |
skipOnError | boolean | 如果当前属性已经存在验证错误,这个验证规则 是否跳过。默认值是false。 | CValidator |
公共方法
受保护方法
方法 | 描述 | 定义在 |
---|---|---|
addError() | 添加关于指定属性的一个错误提示信息到活动记录中。 | CValidator |
isEmpty() | 检测给定值是否为空。 | CValidator |
validateAttribute() | 验证传入对象的属性。 | CFilterValidator |
属性详细
filter
属性
public 回调过滤方法 $filter;
方法详细
validateAttribute()
方法
protected void validateAttribute(CModel $object, string $attribute)
| ||
$object | CModel | 需要验证的对象 |
$attribute | string | 需要验证的属性 |
protected function validateAttribute($object,$attribute)
{
if($this->filter===null || !is_callable($this->filter))
throw new CException(Yii::t('yii','The "filter" property must be specified with a valid callback.'));
$object->$attribute=call_user_func_array($this->filter,array($object->$attribute));
}
验证传入对象的属性。 如果存在任何验证错误,错误提示信息将被添加到此对象中。