| 包 | system.validators |
|---|---|
| 继承 | class CRequiredValidator » CValidator » CComponent |
| 源自 | 1.0 |
| 版本 | $Id: CRequiredValidator.php 3515 2011-12-28 12:29:24Z mDOMba $ |
| 源码 |
CRequiredValidator验证指定的属性的值不为null或empty。
当使用message属性自定义错误提示信息时，该信息可以 占位符，占位符可以被实际内容替换。除了所有验证器均可识别的 "{attribute}" 占位符(参见CValidator)外， CRequiredValidator还允许指定下列占位符：
当使用message属性自定义错误提示信息时，该信息可以 占位符，占位符可以被实际内容替换。除了所有验证器均可识别的 "{attribute}" 占位符(参见CValidator)外， CRequiredValidator还允许指定下列占位符：
- {value}: 使用期望的值替换requiredValue。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| attributes | array | 需要被验证的属性的列表。 | CValidator |
| builtInValidators | array | 内置验证器列表 (name=>class) | CValidator |
| enableClientValidation | boolean | 是否执行客户端验证。默认值为true。 参见CActiveForm::enableClientValidation以了解更多关于客户端验证的细节。 | CValidator |
| message | string | 用户自定义的错误提示信息。不同的验证器可以在该信息中 定义各种占位符（将被实际值替换）。占位符“{attribute}”可以被所有 验证器识别，它会被使用属性的标签来替换。 | CValidator |
| on | array | 验证器将被应用到的情景模式的列表。 数组的键-值都是情景模式的名称。 | CValidator |
| requiredValue | mixed | 此属性必须输入的期望的值。 如果设置为null，验证器将验证指定的属性值不为null或empty。 如果设置为不是null的值，验证器将验证 此属性的值与设置的值相同。 默认值是null。 | CRequiredValidator |
| safe | boolean | 进行整块赋值是是否考虑此验证器中列出的属性的安全性。 默认值为true。 | CValidator |
| skipOnError | boolean | 如果当前属性已经存在验证错误，这个验证规则 是否跳过。默认值是false。 | CValidator |
| strict | boolean | 是否与requiredValue进行严格比较。 如果设置为true，此属性的值与类型都必须与requiredValue相同。 默认值是false，表示只需要值相同即可。 此参数仅在requiredValue不为null时被使用。 | CRequiredValidator |
公共方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| __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() | 返回执行客户端验证所需的javascript。 | CRequiredValidator |
| 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() | 验证传入对象的属性。 | CRequiredValidator |
属性详细
requiredValue
属性
public mixed $requiredValue;
此属性必须输入的期望的值。 如果设置为null，验证器将验证指定的属性值不为null或empty。 如果设置为不是null的值，验证器将验证 此属性的值与设置的值相同。 默认值是null。
strict
属性
public boolean $strict;
是否与requiredValue进行严格比较。 如果设置为true，此属性的值与类型都必须与requiredValue相同。 默认值是false，表示只需要值相同即可。 此参数仅在requiredValue不为null时被使用。
方法详细
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;
if($this->requiredValue!==null)
{
if($message===null)
$message=Yii::t('yii','{attribute} must be {value}.');
$message=strtr($message, array(
'{value}'=>$this->requiredValue,
'{attribute}'=>$object->getAttributeLabel($attribute),
));
return "
if(value!=" . Cjson::encode($this->requiredValue) . ") {
messages.push(".CJSON::encode($message).");
}
";
}
else
{
if($message===null)
$message=Yii::t('yii','{attribute} cannot be blank.');
$message=strtr($message, array(
'{attribute}'=>$object->getAttributeLabel($attribute),
));
return "
if($.trim(value)=='') {
messages.push(".CJSON::encode($message).");
}
";
}
}
返回执行客户端验证所需的JavaScript。
参见
- CActiveForm::enableClientValidation
validateAttribute()
方法
|
protected void validateAttribute(CModel $object, string $attribute)
| ||
| $object | CModel | 需要验证的对象 |
| $attribute | string | 需要验证的属性 |
protected function validateAttribute($object,$attribute)
{
$value=$object->$attribute;
if($this->requiredValue!==null)
{
if(!$this->strict && $value!=$this->requiredValue || $this->strict && $value!==$this->requiredValue)
{
$message=$this->message!==null?$this->message:Yii::t('yii','{attribute} must be {value}.',
array('{value}'=>$this->requiredValue));
$this->addError($object,$attribute,$message);
}
}
else if($this->isEmpty($value,true))
{
$message=$this->message!==null?$this->message:Yii::t('yii','{attribute} cannot be blank.');
$this->addError($object,$attribute,$message);
}
}
验证传入对象的属性。 如果存在任何验证错误，错误提示信息将被添加到此对象中。