| 包 | system.validators |
|---|---|
| 继承 | class CDateValidator » CValidator » CComponent |
| 源自 | 1.1.7 |
| 版本 | $Id: CDateValidator.PHP 2799 2011-01-01 19:31:13Z qiang.xue $ |
| 源码 |
CDateValidator检验此属性是否描述了一个日期、时间或日期时间。
通过设置format属性，我们可以指定期望的日期值的格式。 如果给定的值不符合此格式，那么验证将不会通过。
通过设置format属性，我们可以指定期望的日期值的格式。 如果给定的值不符合此格式，那么验证将不会通过。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| allowEmpty | boolean | 此属性的值是否可以为null或empty。默认值是true， 表示如果此属性值为空时将通过验证。 | CDateValidator |
| attributes | array | 需要被验证的属性的列表。 | CValidator |
| builtInValidators | array | 内置验证器列表 (name=>class) | CValidator |
| enableClientValidation | boolean | 是否执行客户端验证。默认值为true。 参见CActiveForm::enableClientValidation以了解更多关于客户端验证的细节。 | CValidator |
| format | mixed | 此日期值预期的格式。 这个值可以是一个字符串，也可以是一个表示多个格式的数组。 默认值为 'MM/dd/yyyy'。参见CDateTimeParser以了 解如何指定一个日期格式的细节。 | CDateValidator |
| message | string | 用户自定义的错误提示信息。不同的验证器可以在该信息中 定义各种占位符（将被实际值替换）。占位符“{attribute}”可以被所有 验证器识别，它会被使用属性的标签来替换。 | CValidator |
| on | array | 验证器将被应用到的情景模式的列表。 数组的键-值都是情景模式的名称。 | CValidator |
| safe | boolean | 进行整块赋值是是否考虑此验证器中列出的属性的安全性。 默认值为true。 | CValidator |
| skipOnError | boolean | 如果当前属性已经存在验证错误，这个验证规则 是否跳过。默认值是false。 | CValidator |
| timestampAttribute | string | 用于接收解析结果的属性名字。 当此属性值不为空，并且验证成功时，以此值为名的属性将 接收到解析的结果。 | CDateValidator |
公共方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| __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脚本。 | CValidator |
| 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() | 验证传入对象的属性。 | CDateValidator |
属性详细
allowEmpty
属性
public boolean $allowEmpty;
此属性的值是否可以为null或empty。默认值是true， 表示如果此属性值为空时将通过验证。
format
属性
public mixed $format;
此日期值预期的格式。 这个值可以是一个字符串，也可以是一个表示多个格式的数组。 默认值为 'MM/dd/yyyy'。参见CDateTimeParser以了 解如何指定一个日期格式的细节。
timestampAttribute
属性
public string $timestampAttribute;
用于接收解析结果的属性名字。 当此属性值不为空，并且验证成功时，以此值为名的属性将 接收到解析的结果。
方法详细
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;
$formats=is_string($this->format) ? array($this->format) : $this->format;
$valid=false;
foreach($formats as $format)
{
$timestamp=CDateTimeParser::parse($value,$format,array('month'=>1,'day'=>1,'hour'=>0,'minute'=>0,'second'=>0));
if($timestamp!==false)
{
$valid=true;
if($this->timestampAttribute!==null)
$object->{$this->timestampAttribute}=$timestamp;
break;
}
}
if(!$valid)
{
$message=$this->message!==null?$this->message : Yii::t('yii','The format of {attribute} is invalid.');
$this->addError($object,$attribute,$message);
}
}
验证传入对象的属性。 如果存在任何验证错误，错误的消息将被添加到此对象中。