CInlineValidator

所有包 | 属性 | 方法

包	system.validators
继承	class CInlineValidator » CValidator » CComponent
源自	1.0
版本	$Id: CInlineValidator.php 3517 2011-12-28 23:22:21Z mdomba $
源码	framework/validators/CInlineValidator.php

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

公共方法

隐藏继承方法

方法	描述	定义在
__call()	如果类中没有调的方法名，则调用这个方法。	CComponent
__get()	返回一个属性值、一个事件处理程序列表或一个行为名称。	CComponent
__isset()	检查一个属性是否为null。	CComponent
__set()	设置一个组件的属性值。	CComponent
__unset()	设置一个组件的属性为null。	CComponent
applyTo()	返回值指定此验证器是否应用到指定的情景模式。	CValidator
asa()	返回这个名字的行为对象。	CComponent
attachBehavior()	附加一个行为到组件。	CComponent
attachBehaviors()	附加一个行为列表到组件。	CComponent
attachEventHandler()	为事件附加一个事件处理程序。	CComponent
canGetProperty()	确定属性是否可读。	CComponent
canSetProperty()	确定属性是否可写。	CComponent
clientValidateAttribute()	通过调用clientValidate方法，返回执行客户端验证所需的JavaScript代码。	CInlineValidator
createValidator()	创建一个验证器对象。	CValidator
detachBehavior()	从组件中分离一个行为。	CComponent
detachBehaviors()	从组件中分离所有行为。	CComponent
detachEventHandler()	分离一个存在的事件处理程序。	CComponent
disableBehavior()	禁用一个附加行为。	CComponent
disableBehaviors()	禁用组件附加的所有行为。	CComponent
enableBehavior()	启用一个附加行为。	CComponent
enableBehaviors()	启用组件附加的所有行为。	CComponent
evaluateExpression()	计算一个PHP表达式，或根据组件上下文执行回调。	CComponent
getEventHandlers()	返回一个事件的附加处理程序列表。	CComponent
hasEvent()	确定一个事件是否定义。	CComponent
hasEventHandler()	检查事件是否有附加的处理程序。	CComponent
hasProperty()	确定属性是否被定义。	CComponent
raiseEvent()	发起一个事件。	CComponent
validate()	验证给定的对象。	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	客户端验证脚本

源码： framework/validators/CInlineValidator.php#73 (显示) publicfunctionclientValidateAttribute($object,$attribute)
{
if($this->clientValidate!==null)
{
$method=$this->clientValidate;
return$object->$method($attribute);
}
}

通过调用clientValidate方法，返回执行客户端验证所需的JavaScript代码。 在客户端验证代码中，这些变量已经被预定义：

• value: 与此属性相关的当前输入值、
• messages: 与此属性相关的错误提示信息的数组，新的错误提示信息可以加入其中。
• attribute: 为此属性保存所有客户端选项的数据结构。

示例:

假设clientValidate设置为“clientValidate123”，clientValidate123() 是返回客户端验证代码的方法的名字，此方法可能看起来象下面这样：

<?phppublic function clientValidate123($attribute){   $js = "if(value != '123') { messages.push('Value should be 123'); }";   return $js;}
?>

参见

• CActiveForm::enableClientValidation

validateAttribute() 方法

protected void validateAttribute(CModel $object, string $attribute)
$object	CModel	需要验证的对象
$attribute	string	需要验证的属性

源码： framework/validators/CInlineValidator.php#40 (显示) protectedfunctionvalidateAttribute($object,$attribute)
{
$method=$this->method;
$object->$method($attribute,$this->params);
}

验证传入对象的属性。 如果存在任何验证错误，错误提示信息将被添加到此对象中。