UniqueValidator.php 4.02 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;
w  
Qiang Xue committed
54

Qiang Xue committed
55
	/**
Qiang Xue committed
56
	 * @inheritdoc
Qiang Xue committed
57 58 59 60 61
	 */
	public function init()
	{
		parent::init();
		if ($this->message === null) {
62
			$this->message = Yii::t('yii', '{attribute} "{value}" has already been taken.');
Qiang Xue committed
63 64 65
		}
	}

w  
Qiang Xue committed
66
	/**
Qiang Xue committed
67
	 * @inheritdoc
w  
Qiang Xue committed
68
	 */
w  
Qiang Xue committed
69
	public function validateAttribute($object, $attribute)
w  
Qiang Xue committed
70
	{
71 72 73
		/** @var ActiveRecordInterface $targetClass */
		$targetClass = $this->targetClass === null ? get_class($object) : $this->targetClass;
		$targetAttribute = $this->targetAttribute === null ? $attribute : $this->targetAttribute;
74

75
		if (is_array($targetAttribute)) {
76
			$params = [];
77 78
			foreach ($targetAttribute as $k => $v) {
				$params[$v] = is_integer($k) ? $object->$v : $object->$k;
79 80
			}
		} else {
81 82 83 84 85 86 87 88
			$params = [$targetAttribute => $object->$attribute];
		}

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

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

Carsten Brandt committed
94
		if (!$object instanceof ActiveRecordInterface || $object->getIsNewRecord()) {
Qiang Xue committed
95
			// if current $object isn't in the database yet then it's OK just to call exists()
Qiang Xue committed
96
			$exists = $query->exists();
Alexander Makarov committed
97 98
		} else {
			// if current $object is in the database already we can't use exists()
99
			/** @var ActiveRecordInterface[] $objects */
100
			$objects = $query->limit(2)->all();
w  
Qiang Xue committed
101
			$n = count($objects);
Alexander Makarov committed
102
			if ($n === 1) {
103
				$keys = array_keys($params);
104
				$pks = $targetClass::primaryKey();
105 106 107
				sort($keys);
				sort($pks);
				if ($keys === $pks) {
Alexander Makarov committed
108
					// primary key is modified and not unique
w  
Qiang Xue committed
109
					$exists = $object->getOldPrimaryKey() != $object->getPrimaryKey();
Alexander Makarov committed
110
				} else {
w  
Qiang Xue committed
111
					// non-primary key, need to exclude the current record based on PK
112
					$exists = $objects[0]->getPrimaryKey() != $object->getOldPrimaryKey();
w  
Qiang Xue committed
113
				}
Alexander Makarov committed
114
			} else {
w  
Qiang Xue committed
115
				$exists = $n > 1;
Alexander Makarov committed
116
			}
w  
Qiang Xue committed
117 118
		}

Alexander Makarov committed
119
		if ($exists) {
Qiang Xue committed
120
			$this->addError($object, $attribute, $this->message);
w  
Qiang Xue committed
121 122
		}
	}
Zander Baldwin committed
123
}