CUniqueValidator

优质

小牛编辑

126浏览

2023-12-01

所有包 | 属性 | 方法

包	system.validators
继承	class CUniqueValidator » CValidator » CComponent
源自	1.0
版本	$Id: CUniqueValidator.php 3549 2012-01-27 15:36:43Z qiang.xue $
源码	framework/validators/CUniqueValidator.php

CUniqueValidator验证属性值在相关数据库表中是否唯一。

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

{value}: 使用属性值替换。

公共属性

隐藏继承属性

属性	类型	描述	定义在
allowEmpty	boolean	是否此属性值可以为null或empty。默认值为true，表示当此属性为空时将通过验证。	CUniqueValidator
attributeName	string	在其中检索此属性值是否存在的活动记录类的属性的名字。默认值为null，表示使用被验证的属性的名字。	CUniqueValidator
attributes	array	需要被验证的属性的列表。	CValidator
builtInValidators	array	内置验证器列表 (name=>class)	CValidator
caseSensitive	boolean	比较时是否对大小写敏感。默认值是true。注意：如果此值设置为false，表示你设定了属性的类型是字符串。	CUniqueValidator
className	string	在其中检索此属性值是否存在的活动记录类的名字。默认值为null，表示使用被验证的属性所属的活动记录类。你可以在此使用路径别名指定一个类。	CUniqueValidator
criteria	array	附加的查询条件。它与用于检测对应的表和列是否存在属性值的条件组合成为最终的查询条件。此数组用于实例化一个CDbCriteria对象。	CUniqueValidator
enableClientValidation	boolean	是否执行客户端验证。默认值为true。参见CActiveForm::enableClientValidation以了解更多关于客户端验证的细节。	CValidator
message	string	用户自定义的错误提示信息。占位符"{attribute}" 和 "{value}" 可以被识别，它们分别被实际的属性名字和值替换。	CUniqueValidator
on	array	验证器将被应用到的情景模式的列表。数组的键-值都是情景模式的名称。	CValidator
safe	boolean	进行整块赋值是是否考虑此验证器中列出的属性的安全性。默认值为true。	CValidator
skipOnError	boolean	如果当前属性已经存在验证错误时，是否跳过这条验证规则。默认值是true。	CUniqueValidator

公共方法

隐藏继承方法

方法	描述	定义在
__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()	验证传入对象的属性。	CUniqueValidator

属性详细

allowEmpty 属性 public boolean $allowEmpty;

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

attributeName 属性 public string $attributeName;

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

参见

className

caseSensitive 属性 public boolean $caseSensitive;

比较时是否对大小写敏感。默认值是true。注意：如果此值设置为false，表示你设定了属性的类型是字符串。

className 属性 public string $className;

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

参见

attributeName

criteria 属性 public array $criteria;

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

message 属性 public string $message;

用户自定义的错误提示信息。占位符"{attribute}" 和 "{value}" 可以被识别，它们分别被实际的属性名字和值替换。

skipOnError 属性（可用自 v1.1.1） public boolean $skipOnError;

如果当前属性已经存在验证错误时，是否跳过这条验证规则。默认值是true。

方法详细

validateAttribute() 方法

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

源码： framework/validators/CUniqueValidator.php#79 (显示)

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)));

$columnName=$column->rawName;
$criteria=newCDbCriteria(array(
'condition'=>$this->caseSensitive?"$columnName=:value":"LOWER($columnName)=LOWER(:value)",
'params'=>array(':value'=>$value),
));
if($this->criteria!==array())
$criteria->mergeWith($this->criteria);

if(!$objectinstanceofCActiveRecord||$object->isNewRecord||$object->tableName()!==$finder->tableName())
$exists=$finder->exists($criteria);
else
{
$criteria->limit=2;
$objects=$finder->findAll($criteria);
$n=count($objects);
if($n===1)
{
if($column->isPrimaryKey)//primarykeyismodifiedandnotunique
$exists=$object->getOldPrimaryKey()!=$object->getPrimaryKey();
else
{
//non-primarykey,needtoexcludethecurrentrecordbasedonPK
$exists=array_shift($objects)->getPrimaryKey()!=$object->getOldPrimaryKey();
}
}
else
$exists=$n>1;
}

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

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