Class yii\validators\UniqueValidator
UniqueValidator 校验指定的属性值在数据库表中是唯一的。
UniqueValidator 检查指定的值是否在由 AR 类 $targetClass 和 $targetAttribute 属性指定的数据库表列中唯一。
如下是使用这个校验器的校验规则示例：
// a1 needs to be unique
['a1', 'unique']
// a1 needs to be unique, but column a2 will be used to check the uniqueness of the a1 value
['a1', 'unique', 'targetAttribute' => 'a2']
// a1 and a2 need to be unique together, and they both will receive error message
[['a1', 'a2'], 'unique', 'targetAttribute' => ['a1', 'a2']]
// a1 and a2 need to be unique together, only a1 will receive error message
['a1', 'unique', 'targetAttribute' => ['a1', 'a2']]
// a1 needs to be unique by checking the uniqueness of both a2 and a3 (using a1 value)
['a1', 'unique', 'targetAttribute' => ['a2', 'a1' => 'a3']]
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| $attributeNames | array | 属性名称列表. | yii\validators\Validator |
| $attributes | array|string | 将要被这个校验器校验的属性名，或者列表。如果多属性，请通过一个数组设置它们。 对于单属性，你可以使用一个字符串，也可以使用一个数组指定。 | yii\validators\Validator |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $builtInValidators | array | List of built-in validators (name => class or configuration) | yii\validators\Validator |
| $comboNotUnique | string | yii\validators\UniqueValidator | |
| $enableClientValidation | boolean | 是否启用这个校验器的客户端校验。 实际的校验过程是通过 clientValidateAttribute() 返回的 JS 代码来执行。 如果这个方法返回 null， 即使这个属性值为 true ，也不会执行任何客户端校验。 | yii\validators\Validator |
| $except | array|string | 校验器不应该应用的情景。 对于多情景，请以一个数组的形式指定它们。对于单情景，你可以使用一个字符串或者一个数组。 | yii\validators\Validator |
| $filter | string|array|Closure | 用于应用在检查属性值唯一性的 DB 查询中的额外过滤器。
这个过滤器可以是一个字符串或者一个数组，代表额外的查询条件。（格式参考 yii\db\Query::where()）
或者是一个匿名函数，签名为 function ($query)，
其中 $query 是 Query 对象，你可以在函数中修改。 |
yii\validators\UniqueValidator |
| $forceMasterDb | boolean | Whether this validator is forced to always use master DB | yii\validators\UniqueValidator |
| $isEmpty | callable | 用于替换默认的 isEmpty() 空值校验方法，
如果没有设置，将会使用 isEmpty() 做空值校验。
这个函数的声明应该为 function ($value)，
它的返回值为一个代表这个值是否为空的布尔值。 |
yii\validators\Validator |
| $message | string | 用户自定义错误消息。
当校验单个属性时，它可以包含如下占位符，
这些占位符将会根据具体的值做替换：
- {attribute}: 被校验的属性标签
- {value}: 被校验的属性值
当校验多个属性时，它可以包含如下占位符：
- {attributes}: 被校验的属性值标签列表
- {values}: 被校验的属性值列表 |
yii\validators\UniqueValidator |
| $on | array|string | 校验器被应用的情景。 对于多情景，请以一个数组的形式指定它们。对于单情景，你可以使用一个字符串或者一个数组。 | yii\validators\Validator |
| $skipOnEmpty | boolean | 当被校验的属性值为 null 或者空字符串时， 是否该跳过这个校验规则。 | yii\validators\Validator |
| $skipOnError | boolean | 当被校验的属性根据之前的校验规则已经有一些校验错误时，这个校验规则是否应该被跳过。 默认为 true。 | yii\validators\Validator |
| $targetAttribute | string|array | 用于校验当前属性值唯一性的 ActiveRecord 的属性名称。 如果没有设置，它会使用当前被校验的属性名称。 你可以使用一个数组来在同一时刻校验多个列。 数组的值是被用于校验唯一性的属性， 数组的键则是将要被校验其值的属性。 | yii\validators\UniqueValidator |
| $targetAttributeJunction | string | And|or define how target attributes are related | yii\validators\UniqueValidator |
| $targetClass | string | 用于校验当前属性值唯一性的 AR 类的名字。 如果没有设置，它将会使用被校验的属性所在的 AR 类。 | yii\validators\UniqueValidator |
| $validationAttributes | yii\validators\Validator | ||
| $when | callable | 一个PHP函数调用，它的返回值将会决定这个校验器是否被应用。
这个函数的声明应该为 function ($model, $attribute) ，其中 $model 和 $attribute 代表被校验的模型和属性。
这个函数应该返回一个布尔值。
这个属性主要用于支持服务端条件校验。
如果这个属性没有被设置，这个校验器将会总是在服务端执行校验。
以下是一个示例，只有当前选择的国家为 USA 时，才会在服务端执行此校验器：
`php
function ($model) {
return $model->country == Country::USA;
}
` |
yii\validators\Validator |
| $whenClient | string | 这是一个 JS 函数，它的返回值将会决定校验器是否在客户端执行。
这个函数的声明应该为 function (attribute, value) ，
其中 attribute 代表被要被校验的属性对象（参考： clientValidateAttribute()），
value 是属性当前值。
这个属性主要用于支持客户端条件校验。
如果这个属性没有被设置，这个校验器将会总是在客户端执行校验。
以下是一个示例，只有当前选择的国家为 USA 时，才会在客户端执行此校验器：
`javascript
function (attribute, value) {
return $('#country'). |
yii\validators\Validator |
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| addError() | 添加指定属性的错误到模型对象中。 这是一个帮助方法用于执行消息的选择和国际化。 | yii\validators\Validator |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| clientValidateAttribute() | 返回可用于客户端校验的 JS 代码。 | yii\validators\Validator |
| createValidator() | 创建校验器对象。 | yii\validators\Validator |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getAttributeNames() | 返回去除开头 ! 的属性名称。 |
yii\validators\Validator |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getClientOptions() | 返回客户端校验参数。 这个方法通常在 clientValidateAttribute() 中调用。 你可以改写这个方法用于修改传给客户端校验的参数。 | yii\validators\Validator |
| getValidationAttributes() | yii\validators\Validator | |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the object. | yii\validators\UniqueValidator |
| isActive() | 返回一个值代表当前校验器在当前情景和属性下是否是激活状态。 | yii\validators\Validator |
| isEmpty() | 检测指定的值是否为空。 如果它是一个 null，一个空的数组，或者一个空字符串，那么它会被认为是一个空值。 注意这个方法和 PHP 的 empty() 函数不同，当值为 0 时，它会返还 false 。（非空值） | yii\validators\Validator |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| trigger() | Triggers an event. | yii\base\Component |
| validate() | 校验一个指定的值。 你可以使用这个方法在数据模型上下文之外的地方校验一个值。 | yii\validators\Validator |
| validateAttribute() | 校验单个属性。 子类必须实现这个方法以实现具体的校验逻辑。 | yii\validators\UniqueValidator |
| validateAttributes() | 校验指定的对象。 | yii\validators\Validator |
受保护的方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| formatMessage() | 使用 I18N 格式化消息，或者只是简单的 strtr ，如果 \Yii::$app 不可用的话。 |
yii\validators\Validator |
| validateValue() | 校验一个值。 一个校验类可以实现这个方法，以支持在数据模型上下文之外的地方支持数据校验。 | yii\validators\Validator |
属性详情
Deprecated since version 2.0.10, to be removed in 2.1. Use $message property
to setup custom message for multiple target attributes.
用于应用在检查属性值唯一性的 DB 查询中的额外过滤器。
这个过滤器可以是一个字符串或者一个数组，代表额外的查询条件。（格式参考 yii\db\Query::where()）
或者是一个匿名函数，签名为 function ($query)，
其中 $query 是 Query 对象，你可以在函数中修改。
Whether this validator is forced to always use master DB
用户自定义错误消息。
当校验单个属性时，它可以包含如下占位符， 这些占位符将会根据具体的值做替换：
{attribute}: 被校验的属性标签{value}: 被校验的属性值
当校验多个属性时，它可以包含如下占位符：
{attributes}: 被校验的属性值标签列表{values}: 被校验的属性值列表
用于校验当前属性值唯一性的 ActiveRecord 的属性名称。 如果没有设置，它会使用当前被校验的属性名称。 你可以使用一个数组来在同一时刻校验多个列。 数组的值是被用于校验唯一性的属性， 数组的键则是将要被校验其值的属性。
And|or define how target attributes are related
用于校验当前属性值唯一性的 AR 类的名字。 如果没有设置，它将会使用被校验的属性所在的 AR 类。
参见 $targetAttribute.
方法详情
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
| public void init() |
校验单个属性。 子类必须实现这个方法以实现具体的校验逻辑。
| public void validateAttribute($model, $attribute) | ||
| $model | yii\base\Model | 被校验的数据模型对象。 |
| $attribute | string | 被校验的属性名称。 |