包 | system.validators |
---|---|
继承 | class CInlineValidator » CValidator » CComponent |
源自 | 1.0 |
版本 | $Id: CInlineValidator.php 3517 2011-12-28 23:22:21Z mdomba $ |
源码 |
CInlineValidator是一个验证器,它作为需要验证的对象中的一个方法被定义。
公共属性
属性 | 类型 | 描述 | 定义在 |
---|---|---|---|
attributes | array | 需要被验证的属性的列表。 | CValidator |
builtInValidators | array | 内置验证器列表 (name=>class) | CValidator |
clientValidate | string | 返回客户端验证代码的方法的名字(参见clientValidateAttribute)。 | CInlineValidator |
enableClientValidation | boolean | 是否执行客户端验证。默认值为true。 参见CActiveForm::enableClientValidation以了解更多关于客户端验证的细节。 | CValidator |
message | string | 用户自定义的错误提示信息。不同的验证器可以在该信息中 定义各种占位符(将被实际值替换)。占位符“{attribute}”可以被所有 验证器识别,它会被使用属性的标签来替换。 | CValidator |
method | string | 定义在活动记录类中的验证方法的名字 | CInlineValidator |
on | array | 验证器将被应用到的情景模式的列表。 数组的键-值都是情景模式的名称。 | CValidator |
params | array | 需要传递给验证方法的额外的参数 | CInlineValidator |
safe | boolean | 进行整块赋值是是否考虑此验证器中列出的属性的安全性。 默认值为true。 | CValidator |
skipOnError | boolean | 如果当前属性已经存在验证错误,这个验证规则 是否跳过。默认值是false。 | CValidator |
公共方法
受保护方法
方法 | 描述 | 定义在 |
---|---|---|
addError() | 添加关于指定属性的一个错误提示信息到活动记录中。 | CValidator |
isEmpty() | 检测给定值是否为空。 | CValidator |
validateAttribute() | 验证传入对象的属性。 | CInlineValidator |
属性详细
clientValidate
属性
public string $clientValidate;
返回客户端验证代码的方法的名字(参见clientValidateAttribute)。
method
属性
public string $method;
定义在活动记录类中的验证方法的名字
params
属性
public array $params;
需要传递给验证方法的额外的参数
方法详细
clientValidateAttribute()
方法
(可用自 v1.1.9)
public string clientValidateAttribute(CModel $object, string $attribute)
| ||
$object | CModel | 需要验证的对象 |
$attribute | string | 需要验证的属性 |
{return} | string | 客户端验证脚本 |
public function clientValidateAttribute($object,$attribute)
{
if($this->clientValidate!==null)
{
$method=$this->clientValidate;
return $object->$method($attribute);
}
}
通过调用clientValidate方法,返回执行客户端验证所需的JavaScript代码。 在客户端验证代码中,这些变量已经被预定义:
- value: 与此属性相关的当前输入值、
- messages: 与此属性相关的错误提示信息的数组,新的错误提示信息可以加入其中。
- attribute: 为此属性保存所有客户端选项的数据结构。
假设clientValidate设置为“clientValidate123”,clientValidate123() 是返回客户端验证代码的方法的名字,此方法可能看起来象下面这样:
<?php public function clientValidate123($attribute) { $js = "if(value != '123') { messages.push('Value should be 123'); }"; return $js; } ?>
validateAttribute()
方法
protected void validateAttribute(CModel $object, string $attribute)
| ||
$object | CModel | 需要验证的对象 |
$attribute | string | 需要验证的属性 |
protected function validateAttribute($object,$attribute)
{
$method=$this->method;
$object->$method($attribute,$this->params);
}
验证传入对象的属性。 如果存在任何验证错误,错误提示信息将被添加到此对象中。