ExistValidator.php 4.73 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;
Qiang Xue committed
11
use yii\base\InvalidConfigException;
w  
Qiang Xue committed
12

w  
Qiang Xue committed
13
/**
Alexander Makarov committed
14
 * ExistValidator validates that the attribute value exists in a table.
w  
Qiang Xue committed
15
 *
16 17 18
 * ExistValidator checks if the value being validated can be found in the table column specified by
 * the ActiveRecord class [[targetClass]] and the attribute [[targetAttribute]].
 *
w  
Qiang Xue committed
19 20 21
 * This validator is often used to verify that a foreign key contains a value
 * that can be found in the foreign table.
 *
22 23 24 25 26 27 28 29
 * The followings are examples of validation rules using this validator:
 *
 * ```php
 * // a1 needs to exist
 * ['a1', 'exist']
 * // a1 needs to exist, but its value will use a2 to check for the existence
 * ['a1', 'exist', 'targetAttribute' => 'a2']
 * // a1 and a2 need to exist together, and they both will receive error message
Qiang Xue committed
30
 * [['a1', 'a2'], 'exist', 'targetAttribute' => ['a1', 'a2']]
31 32
 * // a1 and a2 need to exist together, only a1 will receive error message
 * ['a1', 'exist', 'targetAttribute' => ['a1', 'a2']]
Qiang Xue committed
33 34
 * // a1 needs to exist by checking the existence of both a2 and a3 (using a1 value)
 * ['a1', 'exist', 'targetAttribute' => ['a2', 'a1' => 'a3']]
35 36
 * ```
 *
w  
Qiang Xue committed
37
 * @author Qiang Xue <qiang.xue@gmail.com>
Alexander Makarov committed
38
 * @since 2.0
w  
Qiang Xue committed
39
 */
Alexander Makarov committed
40
class ExistValidator extends Validator
w  
Qiang Xue committed
41 42
{
	/**
43 44 45
	 * @var string the name of the ActiveRecord class that should be used to validate the existence
	 * 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
46
	 */
47
	public $targetClass;
w  
Qiang Xue committed
48
	/**
49 50 51 52 53 54
	 * @var string|array the name of the ActiveRecord attribute that should be used to
	 * validate the existence 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 existence
	 * of multiple columns at the same time. The array values are the attributes that will be
	 * used to validate the existence, 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
55
	 */
56
	public $targetAttribute;
57 58 59 60 61 62 63
	/**
	 * @var string|array|\Closure additional filter to be applied to the DB query used to check the existence 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
64

Qiang Xue committed
65 66

	/**
Qiang Xue committed
67
	 * @inheritdoc
Qiang Xue committed
68 69 70 71 72
	 */
	public function init()
	{
		parent::init();
		if ($this->message === null) {
73
			$this->message = Yii::t('yii', '{attribute} is invalid.');
Qiang Xue committed
74 75 76
		}
	}

w  
Qiang Xue committed
77
	/**
Qiang Xue committed
78
	 * @inheritdoc
w  
Qiang Xue committed
79
	 */
w  
Qiang Xue committed
80
	public function validateAttribute($object, $attribute)
w  
Qiang Xue committed
81
	{
82
		$targetAttribute = $this->targetAttribute === null ? $attribute : $this->targetAttribute;
Alexander Makarov committed
83

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

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

100 101 102 103
		$targetClass = $this->targetClass === null ? get_class($object) : $this->targetClass;
		$query = $this->createQuery($targetClass, $params);

		if (!$query->exists()) {
Qiang Xue committed
104
			$this->addError($object, $attribute, $this->message);
w  
Qiang Xue committed
105 106
		}
	}
Qiang Xue committed
107 108

	/**
Qiang Xue committed
109
	 * @inheritdoc
Qiang Xue committed
110
	 */
Qiang Xue committed
111
	protected function validateValue($value)
Qiang Xue committed
112
	{
113
		if (is_array($value)) {
Qiang Xue committed
114
			return [$this->message, []];
115
		}
116
		if ($this->targetClass === null) {
Qiang Xue committed
117
			throw new InvalidConfigException('The "targetClass" property must be set.');
Qiang Xue committed
118
		}
119
		if (!is_string($this->targetAttribute)) {
Qiang Xue committed
120
			throw new InvalidConfigException('The "targetAttribute" property must be configured as a string.');
Qiang Xue committed
121
		}
122

123 124
		$query = $this->createQuery($this->targetClass, [$this->targetAttribute => $value]);

125
		return $query->exists() ? null : [$this->message, []];
Qiang Xue committed
126
	}
127

Qiang Xue committed
128 129 130 131 132 133
	/**
	 * Creates a query instance with the given condition.
	 * @param string $targetClass the target AR class
	 * @param mixed $condition query condition
	 * @return \yii\db\ActiveQueryInterface the query instance
	 */
134 135 136 137 138 139 140 141 142 143 144
	protected function createQuery($targetClass, $condition)
	{
		/** @var \yii\db\ActiveRecordInterface $targetClass */
		$query = $targetClass::find()->where($condition);
		if ($this->filter instanceof \Closure) {
			call_user_func($this->filter, $query);
		} elseif ($this->filter !== null) {
			$query->andWhere($this->filter);
		}
		return $query;
	}
w  
Qiang Xue committed
145
}