UniqueValidator.php 4.64 KB
Newer Older
w  
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
w  
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

w  
Qiang Xue committed
8
namespace yii\validators;
Qiang Xue committed
9 10

use Yii;
Carsten Brandt committed
11
use yii\db\ActiveRecordInterface;
w  
Qiang Xue committed
12

w  
Qiang Xue committed
13
/**
14 15 16 17 18 19 20 21 22 23 24 25 26
 * UniqueValidator validates that the attribute value is unique in the specified database table.
 *
 * UniqueValidator checks if the value being validated is unique in the table column specified by
 * the ActiveRecord class [[targetClass]] and the attribute [[targetAttribute]].
 *
 * The followings are examples of validation rules using this validator:
 *
 * ```php
 * // 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 unique together, and they both will receive error message
Qiang Xue committed
27
 * [['a1', 'a2'], 'unique', 'targetAttribute' => ['a1', 'a2']]
28 29 30 31 32
 * // a1 and a2 need to 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']]
 * ```
w  
Qiang Xue committed
33 34
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
Alexander Makarov committed
35
 * @since 2.0
w  
Qiang Xue committed
36
 */
Alexander Makarov committed
37
class UniqueValidator extends Validator
w  
Qiang Xue committed
38 39
{
	/**
40 41 42
	 * @var string the name of the ActiveRecord class that should be used to validate the uniqueness
	 * of the current attribute value. It not set, it will use the ActiveRecord class of the attribute being validated.
	 * @see targetAttribute
w  
Qiang Xue committed
43
	 */
44
	public $targetClass;
w  
Qiang Xue committed
45
	/**
46 47 48 49 50 51
	 * @var string|array the name of the ActiveRecord attribute that should be used to
	 * validate the uniqueness of the current attribute value. If not set, it will use the name
	 * of the attribute currently being validated. You may use an array to validate the uniqueness
	 * of multiple columns at the same time. The array values are the attributes that will be
	 * used to validate the uniqueness, while the array keys are the attributes whose values are to be validated.
	 * If the key and the value are the same, you can just specify the value.
w  
Qiang Xue committed
52
	 */
53
	public $targetAttribute;
54 55 56 57 58 59 60
	/**
	 * @var string|array|\Closure additional filter to be applied to the DB query used to check the uniqueness of the attribute value.
	 * This can be a string or an array representing the additional query condition (refer to [[\yii\db\Query::where()]]
	 * on the format of query condition), or an anonymous function with the signature `function ($query)`, where `$query`
	 * is the [[\yii\db\Query|Query]] object that you can modify in the function.
	 */
	public $filter;
w  
Qiang Xue committed
61

Qiang Xue committed
62
	/**
Qiang Xue committed
63
	 * @inheritdoc
Qiang Xue committed
64 65 66 67 68
	 */
	public function init()
	{
		parent::init();
		if ($this->message === null) {
69
			$this->message = Yii::t('yii', '{attribute} "{value}" has already been taken.');
Qiang Xue committed
70 71 72
		}
	}

w  
Qiang Xue committed
73
	/**
Qiang Xue committed
74
	 * @inheritdoc
w  
Qiang Xue committed
75
	 */
w  
Qiang Xue committed
76
	public function validateAttribute($object, $attribute)
w  
Qiang Xue committed
77
	{
78 79 80
		/** @var ActiveRecordInterface $targetClass */
		$targetClass = $this->targetClass === null ? get_class($object) : $this->targetClass;
		$targetAttribute = $this->targetAttribute === null ? $attribute : $this->targetAttribute;
81

82
		if (is_array($targetAttribute)) {
83
			$params = [];
84 85
			foreach ($targetAttribute as $k => $v) {
				$params[$v] = is_integer($k) ? $object->$v : $object->$k;
86 87
			}
		} else {
88 89 90 91 92 93 94 95
			$params = [$targetAttribute => $object->$attribute];
		}

		foreach ($params as $value) {
			if (is_array($value)) {
				$this->addError($object, $attribute, Yii::t('yii', '{attribute} is invalid.'));
				return;
			}
96
		}
97 98

		$query = $targetClass::find();
99
		$query->where($params);
Alexander Makarov committed
100

101 102 103 104 105 106
		if ($this->filter instanceof \Closure) {
			call_user_func($this->filter, $query);
		} elseif ($this->filter !== null) {
			$query->andWhere($this->filter);
		}

Carsten Brandt committed
107
		if (!$object instanceof ActiveRecordInterface || $object->getIsNewRecord()) {
Qiang Xue committed
108
			// if current $object isn't in the database yet then it's OK just to call exists()
Qiang Xue committed
109
			$exists = $query->exists();
Alexander Makarov committed
110 111
		} else {
			// if current $object is in the database already we can't use exists()
112
			/** @var ActiveRecordInterface[] $objects */
113
			$objects = $query->limit(2)->all();
w  
Qiang Xue committed
114
			$n = count($objects);
Alexander Makarov committed
115
			if ($n === 1) {
116
				$keys = array_keys($params);
117
				$pks = $targetClass::primaryKey();
118 119 120
				sort($keys);
				sort($pks);
				if ($keys === $pks) {
Alexander Makarov committed
121
					// primary key is modified and not unique
w  
Qiang Xue committed
122
					$exists = $object->getOldPrimaryKey() != $object->getPrimaryKey();
Alexander Makarov committed
123
				} else {
w  
Qiang Xue committed
124
					// non-primary key, need to exclude the current record based on PK
125
					$exists = $objects[0]->getPrimaryKey() != $object->getOldPrimaryKey();
w  
Qiang Xue committed
126
				}
Alexander Makarov committed
127
			} else {
w  
Qiang Xue committed
128
				$exists = $n > 1;
Alexander Makarov committed
129
			}
w  
Qiang Xue committed
130 131
		}

Alexander Makarov committed
132
		if ($exists) {
Qiang Xue committed
133
			$this->addError($object, $attribute, $this->message);
w  
Qiang Xue committed
134 135
		}
	}
Zander Baldwin committed
136
}