| 包 | system.validators |
|---|---|
| 继承 | class CNumberValidator » CValidator » CComponent |
| 源自 | 1.0 |
| 版本 | $Id: CNumberValidator.php 3491 2011-12-17 05:17:57Z jefftulsa $ |
| 源码 |
CNumberValidator验证此属性的值是一个数字。
除了使用message属性设置一个自定义错误提示信息之外， CNumberValidator还有一对自定义错误提示信息，你可以针对不同 的验证情景模式分别使用。要为一个太大的数值指定自定义错误提 示信息，你可以使用tooBig属性。类似地有tooSmall。 提示信息可以包含占位符，占位符可以被实际内容替换。 除了所有验证器均可识别的 "{attribute}" 占位符外， CNumberValidator还允许指定下列 占位符：
除了使用message属性设置一个自定义错误提示信息之外， CNumberValidator还有一对自定义错误提示信息，你可以针对不同 的验证情景模式分别使用。要为一个太大的数值指定自定义错误提 示信息，你可以使用tooBig属性。类似地有tooSmall。 提示信息可以包含占位符，占位符可以被实际内容替换。 除了所有验证器均可识别的 "{attribute}" 占位符外， CNumberValidator还允许指定下列 占位符：
- {min}: 当使用tooSmall时，使用数值的下限min替换。
- {max}: 当使用tooBig时，使用数值的上限max替换。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| allowEmpty | boolean | 是否此属性值允许为null或empty。默认值是true， 表示如果此属性值为空时它将通过验证。 | CNumberValidator |
| attributes | array | 需要被验证的属性的列表。 | CValidator |
| builtInValidators | array | 内置验证器列表 (name=>class) | CValidator |
| enableClientValidation | boolean | 是否执行客户端验证。默认值为true。 参见CActiveForm::enableClientValidation以了解更多关于客户端验证的细节。 | CValidator |
| integerOnly | boolean | 是否此属性值仅允许整数。默认值是false。 | CNumberValidator |
| integerPattern | string | 匹配整数的正则表达式。 | CNumberValidator |
| max | integer|float | 数值的上限。默认值是null，表示没有上限。 | CNumberValidator |
| message | string | 用户自定义的错误提示信息。不同的验证器可以在该信息中 定义各种占位符（将被实际值替换）。占位符“{attribute}”可以被所有 验证器识别，它会被使用属性的标签来替换。 | CValidator |
| min | integer|float | 数值的上限。默认值是null，表示没有下限。 | CNumberValidator |
| numberPattern | string | the 匹配数值的正则表达式。 | CNumberValidator |
| on | array | 验证器将被应用到的情景模式的列表。 数组的键-值都是情景模式的名称。 | CValidator |
| safe | boolean | 进行整块赋值是是否考虑此验证器中列出的属性的安全性。 默认值为true。 | CValidator |
| skipOnError | boolean | 如果当前属性已经存在验证错误，这个验证规则 是否跳过。默认值是false。 | CValidator |
| tooBig | string | 当数值太大时使用的用户自定义错误提示信息。 | CNumberValidator |
| tooSmall | string | 当数值太小时使用的用户自定义错误提示信息。 | CNumberValidator |
公共方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| __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。 | CNumberValidator |
| 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() | 验证传入对象的属性。 | CNumberValidator |
属性详细
allowEmpty
属性
public boolean $allowEmpty;
是否此属性值允许为null或empty。默认值是true， 表示如果此属性值为空时它将通过验证。
integerOnly
属性
public boolean $integerOnly;
是否此属性值仅允许整数。默认值是false。
integerPattern
属性
（可用自 v1.1.7）
public string $integerPattern;
匹配整数的正则表达式。
max
属性
public integer|float $max;
数值的上限。默认值是null，表示没有上限。
min
属性
public integer|float $min;
数值的上限。默认值是null，表示没有下限。
numberPattern
属性
（可用自 v1.1.7）
public string $numberPattern;
the 匹配数值的正则表达式。
tooBig
属性
public string $tooBig;
当数值太大时使用的用户自定义错误提示信息。
tooSmall
属性
public string $tooSmall;
当数值太小时使用的用户自定义错误提示信息。
方法详细
clientValidateAttribute()
方法
（可用自 v1.1.7）
|
public string clientValidateAttribute(CModel $object, string $attribute)
| ||
| $object | CModel | 需要验证的对象 |
| $attribute | string | 需要验证的属性 |
| {return} | string | 客户端验证脚本 |
public function clientValidateAttribute($object,$attribute)
{
$label=$object->getAttributeLabel($attribute);
if(($message=$this->message)===null)
$message=$this->integerOnly ? Yii::t('yii','{attribute} must be an integer.') : Yii::t('yii','{attribute} must be a number.');
$message=strtr($message, array(
'{attribute}'=>$label,
));
if(($tooBig=$this->tooBig)===null)
$tooBig=Yii::t('yii','{attribute} is too big (maximum is {max}).');
$tooBig=strtr($tooBig, array(
'{attribute}'=>$label,
'{max}'=>$this->max,
));
if(($tooSmall=$this->tooSmall)===null)
$tooSmall=Yii::t('yii','{attribute} is too small (minimum is {min}).');
$tooSmall=strtr($tooSmall, array(
'{attribute}'=>$label,
'{min}'=>$this->min,
));
$pattern=$this->integerOnly ? $this->integerPattern : $this->numberPattern;
$js="
if(!value.match($pattern)) {
messages.push(".Cjson::encode($message).");
}
";
if($this->min!==null)
{
$js.="
if(value<{$this->min}) {
messages.push(".CJSON::encode($tooSmall).");
}
";
}
if($this->max!==null)
{
$js.="
if(value>{$this->max}) {
messages.push(".CJSON::encode($tooBig).");
}
";
}
if($this->allowEmpty)
{
$js="
if($.trim(value)!='') {
$js
}
";
}
return $js;
}
返回执行客户端验证所需的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->allowEmpty && $this->isEmpty($value))
return;
if($this->integerOnly)
{
if(!preg_match($this->integerPattern,"$value"))
{
$message=$this->message!==null?$this->message:Yii::t('yii','{attribute} must be an integer.');
$this->addError($object,$attribute,$message);
}
}
else
{
if(!preg_match($this->numberPattern,"$value"))
{
$message=$this->message!==null?$this->message:Yii::t('yii','{attribute} must be a number.');
$this->addError($object,$attribute,$message);
}
}
if($this->min!==null && $value<$this->min)
{
$message=$this->tooSmall!==null?$this->tooSmall:Yii::t('yii','{attribute} is too small (minimum is {min}).');
$this->addError($object,$attribute,$message,array('{min}'=>$this->min));
}
if($this->max!==null && $value>$this->max)
{
$message=$this->tooBig!==null?$this->tooBig:Yii::t('yii','{attribute} is too big (maximum is {max}).');
$this->addError($object,$attribute,$message,array('{max}'=>$this->max));
}
}
验证传入对象的属性。 如果存在任何验证错误，错误提示信息将被添加到此对象中。