CExistValidator

优质
小牛编辑
136浏览
2023-12-01
所有包 | 属性 | 方法
system.validators
继承class CExistValidator » CValidator » CComponent
版本$Id: CExistValidator.php 3549 2012-01-27 15:36:43Z qiang.xue $
源码framework/validators/CExistValidator.php
CExistValidator验证属性值在数据库中是否存在。

此验证器通常用于检验一个外键的值在外键参照 表中已经存在。

当使用message属性定义了一个自定义错误提示信息, 此信息可以包含附加的占位符,占位符可以被实际内容替换。 除了可以被所有验证器识别的"{attribute}"占位符外(参见CValidator), CExistValidator还允许指定下列占位符:
  • {value}: 使用属性值替换。

公共属性

隐藏继承属性

属性类型描述定义在
allowEmptyboolean是否此属性值可以为null或empty。默认值为true, 表示如此此属性为空,它将通过验证。CExistValidator
attributeNamestring在其中检索此属性值是否存在的 活动记录类的属性的名字。默认值为null, 表示使用被验证的属性的名字。CExistValidator
attributesarray需要被验证的属性的列表。CValidator
builtInValidatorsarray内置验证器列表 (name=>class)CValidator
classNamestring在其中检索此属性值是否存在的 活动记录类的名字。默认值为null, 表示使用被验证的属性所属的活动记录类。 你可以在此使用路径别名指定一个类。CExistValidator
criteriaarray附加的查询条件。它与用于检测对应的表 和列是否存在属性值的条件组合成为最终的查询条件。 此数组用于实例化一个CDbCriteria对象。CExistValidator
enableClientValidationboolean是否执行客户端验证。默认值为true。 参见CActiveForm::enableClientValidation以了解更多关于客户端验证的细节。CValidator
messagestring用户自定义的错误提示信息。不同的验证器可以在该信息中 定义各种占位符(将被实际值替换)。占位符“{attribute}”可以被所有 验证器识别,它会被使用属性的标签来替换。CValidator
onarray验证器将被应用到的情景模式的列表。 数组的键-值都是情景模式的名称。CValidator
safeboolean进行整块赋值是是否考虑此验证器中列出的属性的安全性。 默认值为true。CValidator
skipOnErrorboolean如果当前属性已经存在验证错误,这个验证规则 是否跳过。默认值是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()返回执行客户端验证所需的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()验证传入对象的属性。CExistValidator

属性详细

allowEmpty 属性 public boolean $allowEmpty;

是否此属性值可以为null或empty。默认值为true, 表示如此此属性为空,它将通过验证。

attributeName 属性 public string $attributeName;

在其中检索此属性值是否存在的 活动记录类的属性的名字。默认值为null, 表示使用被验证的属性的名字。

参见

  • className
className 属性 public string $className;

在其中检索此属性值是否存在的 活动记录类的名字。默认值为null, 表示使用被验证的属性所属的活动记录类。 你可以在此使用路径别名指定一个类。

参见

  • attributeName
criteria 属性 public array $criteria;

附加的查询条件。它与用于检测对应的表 和列是否存在属性值的条件组合成为最终的查询条件。 此数组用于实例化一个CDbCriteria对象。

方法详细

validateAttribute() 方法
protected void validateAttribute(CModel $object, string $attribute)
$objectCModel需要验证的对象
$attributestring需要验证的属性
源码: framework/validators/CExistValidator.php#64 (显示) protectedfunctionvalidateAttribute($object,$attribute)
{
$value=$object->$attribute;
if($this->allowEmpty&&$this->isEmpty($value))
return;

$className=$this->className===null?get_class($object):Yii::import($this->className);
$attributeName=$this->attributeName===null?$attribute:$this->attributeName;
$finder=CActiveRecord::model($className);
$table=$finder->getTableSchema();
if(($column=$table->getColumn($attributeName))===null)
thrownewCException(Yii::t('yii','Table"{table}"doesnothaveacolumnnamed"{column}".',
array('{column}'=>$attributeName,'{table}'=>$table->name)));

$criteria=array('condition'=>$column->rawName.'=:vp','params'=>array(':vp'=>$value));
if($this->criteria!==array())
{
$criteria=newCDbCriteria($criteria);
$criteria->mergeWith($this->criteria);
}

if(!$finder->exists($criteria))
{
$message=$this->message!==null?$this->message:Yii::t('yii','{attribute}"{value}"isinvalid.');
$this->addError($object,$attribute,$message,array('{value}'=>CHtml::encode($value)));
}
}

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