UniqueValidator::modelExists() - Code Metrics - Inspection of "Fixes #13501: Fixed `yii\rbac\DbManager::getRule()..." - rob006/yii2-dev - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c73de3...97c43c )

by Robert

created 2017-02-05 13:04 UTC

UniqueValidator::modelExists() C

↳ Parent: UniqueValidator

Complexity

Conditions	7
Paths	5

Size

Total Lines	34
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	21
CRAP Score	7

Importance

Changes

Metric	Value
dl	0
loc	34
rs	6.7272
c	0
b	0
f	0
ccs	21
cts	21
cp	1
cc	7
eloc	19
nc	5
nop	3
crap	7

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\validators;

use Yii;
use yii\base\Model;
use yii\db\ActiveQuery;
use yii\db\ActiveQueryInterface;
use yii\db\ActiveRecordInterface;
use yii\db\Query;
use yii\helpers\Inflector;

/**
 * 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 following 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 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']]
 * ```
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
class UniqueValidator extends Validator
{
    /**
     * @var string the name of the ActiveRecord class that should be used to validate the uniqueness
     * of the current attribute value. If not set, it will use the ActiveRecord class of the attribute being validated.
     * @see targetAttribute
     */
    public $targetClass;
    /**
     * @var string|array the name of the [[\yii\db\ActiveRecord|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.
     */
    public $targetAttribute;
    /**
     * @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;
    /**
     * @var string the user-defined error message.
     *
     * When validating single attribute, it may contain
     * the following placeholders which will be replaced accordingly by the validator:
     *
     * - `{attribute}`: the label of the attribute being validated
     * - `{value}`: the value of the attribute being validated
     *
     * When validating mutliple attributes, it may contain the following placeholders:
     *
     * - `{attributes}`: the labels of the attributes being validated.
     * - `{values}`: the values of the attributes being validated.
     *
     */
    public $message;
    /**
     * @var string
     * @since 2.0.9
     * @deprecated since version 2.0.10, to be removed in 2.1. Use [[message]] property
     * to setup custom message for multiple target attributes.
     */
    public $comboNotUnique;
    /**
     * @var string and|or define how target attributes are related
     * @since 2.0.11
     */
    public $targetAttributeJunction = 'and';


    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();
        if ($this->message !== null) {
            return;
        }
        if (is_array($this->targetAttribute) && count($this->targetAttribute) > 1) {
            // fallback for deprecated `comboNotUnique` property - use it as message if is set
            if ($this->comboNotUnique === null) {

                $this->message = Yii::t('yii', 'The combination {values} of {attributes} has already been taken.');
            } else {
                $this->message = $this->comboNotUnique;

            }
        } else {
            $this->message = Yii::t('yii', '{attribute} "{value}" has already been taken.');
        }
    }

    /**
     * @inheritdoc
     */
    public function validateAttribute($model, $attribute)
    {
        /* @var $targetClass ActiveRecordInterface */
        $targetClass = $this->targetClass === null ? get_class($model) : $this->targetClass;
        $targetAttribute = $this->targetAttribute === null ? $attribute : $this->targetAttribute;
        $rawConditions = $this->prepareConditions($targetAttribute, $model, $attribute);
        $conditions[] = $this->targetAttributeJunction === 'or' ? 'or' : 'and';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        foreach ($rawConditions as $key => $value) {
            if (is_array($value)) {
                $this->addError($model, $attribute, Yii::t('yii', '{attribute} is invalid.'));
                return;
            }
            $conditions[] = [$key => $value];
        }

        if ($this->modelExists($targetClass, $conditions, $model)) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            if (count($targetAttribute) > 1) {
                $this->addComboNotUniqueError($model, $attribute);
            } else {
                $this->addError($model, $attribute, $this->message);
            }
        }
    }

    /**
     * Checks whether the $model exists in the database.
     *
     * @param string $targetClass the name of the ActiveRecord class that should be used to validate the uniqueness
     * of the current attribute value.
     * @param array $conditions conditions, compatible with [[\yii\db\Query::where()|Query::where()]] key-value format.
     * @param Model $model the data model to be validated
     *
     * @return bool whether the model already exists
     */
    private function modelExists($targetClass, $conditions, $model)
    {
        /** @var ActiveRecordInterface $targetClass $query */
        $query = $this->prepareQuery($targetClass, $conditions);

        if (!$model instanceof ActiveRecordInterface || $model->getIsNewRecord() || $model->className() !== $targetClass::className()) {
            // if current $model isn't in the database yet then it's OK just to call exists()
            // also there's no need to run check based on primary keys, when $targetClass is not the same as $model's class
            $exists = $query->exists();
        } else {
            // if current $model is in the database already we can't use exists()
            if ($query instanceof \yii\db\ActiveQuery) {
                // only select primary key to optimize query
                $query->select($targetClass::primaryKey());
            }
            $models = $query->limit(2)->asArray()->all();
            $n = count($models);
            if ($n === 1) {
                // if there is one record, check if it is the currently validated model
                $dbModel = reset($models);
                $pks = $targetClass::primaryKey();
                $pk = [];
                foreach($pks as $pkAttribute) {
                    $pk[$pkAttribute] = $dbModel[$pkAttribute];
                }
                $exists = ($pk != $model->getOldPrimaryKey(true));
            } else {
                // if there is more than one record, the value is not unique
                $exists = $n > 1;
            }
        }

        return $exists;
    }

    /**
     * Prepares a query by applying filtering conditions defined in $conditions method property
     * and [[filter]] class property.
     *
     * @param ActiveRecordInterface $targetClass the name of the ActiveRecord class that should be used to validate
     * the uniqueness of the current attribute value.
     * @param array $conditions conditions, compatible with [[\yii\db\Query::where()|Query::where()]] key-value format
     *
     * @return ActiveQueryInterface|ActiveQuery
     */
    private function prepareQuery($targetClass, $conditions)
    {
        $query = $targetClass::find();
        $query->andWhere($conditions);
        if ($this->filter instanceof \Closure) {
            call_user_func($this->filter, $query);
        } elseif ($this->filter !== null) {
            $query->andWhere($this->filter);
        }

        return $query;
    }

    /**
     * Processes attributes' relations described in $targetAttribute parameter into conditions, compatible with
     * [[\yii\db\Query::where()|Query::where()]] key-value format.
     *
     * @param string|array $targetAttribute the name of the [[\yii\db\ActiveRecord|ActiveRecord]] attribute that
     * should be used to validate the uniqueness of the current attribute value. 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.
     * @param Model $model the data model to be validated
     * @param string $attribute the name of the attribute to be validated in the $model
     *
     * @return array conditions, compatible with [[\yii\db\Query::where()|Query::where()]] key-value format.
     */
    private function prepareConditions($targetAttribute, $model, $attribute)
    {
        if (is_array($targetAttribute)) {
            $conditions = [];
            foreach ($targetAttribute as $k => $v) {
                $conditions[$v] = is_int($k) ? $model->$v : $model->$k;
            }
        } else {
            $conditions = [$targetAttribute => $model->$attribute];
        }

        return $conditions;
    }

    /**
     * Builds and adds [[comboNotUnique]] error message to the specified model attribute.
     * @param \yii\base\Model $model the data model.
     * @param string $attribute the name of the attribute.
     */
    private function addComboNotUniqueError($model, $attribute)
    {
        $attributeCombo = [];
        $valueCombo = [];
        foreach ($this->targetAttribute as $key => $value) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if(is_int($key)) {
                $attributeCombo[] = $model->getAttributeLabel($value);
                $valueCombo[] = '"' . $model->$value . '"';
            } else {
                $attributeCombo[] = $model->getAttributeLabel($key);
                $valueCombo[] = '"' . $model->$key . '"';
            }
        }
        $this->addError($model, $attribute, $this->message, [
            'attributes' => Inflector::sentence($attributeCombo),
            'values' => implode('-', $valueCombo)
        ]);
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\validators;
9
10		use Yii;
11		use yii\base\Model;
12		use yii\db\ActiveQuery;
13		use yii\db\ActiveQueryInterface;
14		use yii\db\ActiveRecordInterface;
15		use yii\db\Query;
16		use yii\helpers\Inflector;
17
18		/**
19		* UniqueValidator validates that the attribute value is unique in the specified database table.
20		*
21		* UniqueValidator checks if the value being validated is unique in the table column specified by
22		* the ActiveRecord class [[targetClass]] and the attribute [[targetAttribute]].
23		*
24		* The following are examples of validation rules using this validator:
25		*
26		* ```php
27		* // a1 needs to be unique
28		* ['a1', 'unique']
29		* // a1 needs to be unique, but column a2 will be used to check the uniqueness of the a1 value
30		* ['a1', 'unique', 'targetAttribute' => 'a2']
31		* // a1 and a2 need to be unique together, and they both will receive error message
32		* [['a1', 'a2'], 'unique', 'targetAttribute' => ['a1', 'a2']]
33		* // a1 and a2 need to be unique together, only a1 will receive error message
34		* ['a1', 'unique', 'targetAttribute' => ['a1', 'a2']]
35		* // a1 needs to be unique by checking the uniqueness of both a2 and a3 (using a1 value)
36		* ['a1', 'unique', 'targetAttribute' => ['a2', 'a1' => 'a3']]
37		* ```
38		*
39		* @author Qiang Xue <[email protected]>
40		* @since 2.0
41		*/
42		class UniqueValidator extends Validator
43		{
44		/**
45		* @var string the name of the ActiveRecord class that should be used to validate the uniqueness
46		* of the current attribute value. If not set, it will use the ActiveRecord class of the attribute being validated.
47		* @see targetAttribute
48		*/
49		public $targetClass;
50		/**
51		* @var string\|array the name of the [[\yii\db\ActiveRecord\|ActiveRecord]] attribute that should be used to
52		* validate the uniqueness of the current attribute value. If not set, it will use the name
53		* of the attribute currently being validated. You may use an array to validate the uniqueness
54		* of multiple columns at the same time. The array values are the attributes that will be
55		* used to validate the uniqueness, while the array keys are the attributes whose values are to be validated.
56		*/
57		public $targetAttribute;
58		/**
59		* @var string\|array\|\Closure additional filter to be applied to the DB query used to check the uniqueness of the attribute value.
60		* This can be a string or an array representing the additional query condition (refer to [[\yii\db\Query::where()]]
61		* on the format of query condition), or an anonymous function with the signature `function ($query)`, where `$query`
62		* is the [[\yii\db\Query\|Query]] object that you can modify in the function.
63		*/
64		public $filter;
65		/**
66		* @var string the user-defined error message.
67		*
68		* When validating single attribute, it may contain
69		* the following placeholders which will be replaced accordingly by the validator:
70		*
71		* - `{attribute}`: the label of the attribute being validated
72		* - `{value}`: the value of the attribute being validated
73		*
74		* When validating mutliple attributes, it may contain the following placeholders:
75		*
76		* - `{attributes}`: the labels of the attributes being validated.
77		* - `{values}`: the values of the attributes being validated.
78		*
79		*/
80		public $message;
81		/**
82		* @var string
83		* @since 2.0.9
84		* @deprecated since version 2.0.10, to be removed in 2.1. Use [[message]] property
85		* to setup custom message for multiple target attributes.
86		*/
87		public $comboNotUnique;
88		/**
89		* @var string and\|or define how target attributes are related
90		* @since 2.0.11
91		*/
92		public $targetAttributeJunction = 'and';
93
94
95		/**
96		* @inheritdoc
97		*/
98	48	public function init()
99		{
100	48	parent::init();
101	48	if ($this->message !== null) {
102	3	return;
103		}
104	48	if (is_array($this->targetAttribute) && count($this->targetAttribute) > 1) {
105		// fallback for deprecated `comboNotUnique` property - use it as message if is set
106	6	if ($this->comboNotUnique === null) {
		0 ignored issues – show Deprecated Code introduced 2016-12-01 11:12 UTC by Report Bug Copy Issue Report The property `yii\validators\UniqueValidator::$comboNotUnique` has been deprecated with message: since version 2.0.10, to be removed in 2.1. Use [[message]] property to setup custom message for multiple target attributes. This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
107	3	$this->message = Yii::t('yii', 'The combination {values} of {attributes} has already been taken.');
108	3	} else {
109	3	$this->message = $this->comboNotUnique;
		0 ignored issues – show Deprecated Code introduced 2016-12-01 11:12 UTC by Report Bug Copy Issue Report The property `yii\validators\UniqueValidator::$comboNotUnique` has been deprecated with message: since version 2.0.10, to be removed in 2.1. Use [[message]] property to setup custom message for multiple target attributes. This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
110		}
111	6	} else {
112	45	$this->message = Yii::t('yii', '{attribute} "{value}" has already been taken.');
113		}
114	48	}
115
116		/**
117		* @inheritdoc
118		*/
119	39	public function validateAttribute($model, $attribute)
120		{
121		/* @var $targetClass ActiveRecordInterface */
122	39	$targetClass = $this->targetClass === null ? get_class($model) : $this->targetClass;
123	39	$targetAttribute = $this->targetAttribute === null ? $attribute : $this->targetAttribute;
124	39	$rawConditions = $this->prepareConditions($targetAttribute, $model, $attribute);
125	39	$conditions[] = $this->targetAttributeJunction === 'or' ? 'or' : 'and';
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-01-23 16:33 UTC by Report Bug Copy Issue Report `$conditions` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$conditions = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
126
127	39	foreach ($rawConditions as $key => $value) {
128	39	if (is_array($value)) {
129	6	$this->addError($model, $attribute, Yii::t('yii', '{attribute} is invalid.'));
130	6	return;
131		}
132	36	$conditions[] = [$key => $value];
133	36	}
134
135	36	if ($this->modelExists($targetClass, $conditions, $model)) {
		0 ignored issues – show Documentation introduced 2016-12-16 23:29 UTC by Report Bug Copy Issue Report `$targetClass` is of type `object<yii\db\ActiveRecordInterface>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
136	29	if (count($targetAttribute) > 1) {
137	6	$this->addComboNotUniqueError($model, $attribute);
138	6	} else {
139	29	$this->addError($model, $attribute, $this->message);
140		}
141	29	}
142	33	}
143
144		/**
145		* Checks whether the $model exists in the database.
146		*
147		* @param string $targetClass the name of the ActiveRecord class that should be used to validate the uniqueness
148		* of the current attribute value.
149		* @param array $conditions conditions, compatible with [[\yii\db\Query::where()\|Query::where()]] key-value format.
150		* @param Model $model the data model to be validated
151		*
152		* @return bool whether the model already exists
153		*/
154	36	private function modelExists($targetClass, $conditions, $model)
155		{
156		/** @var ActiveRecordInterface $targetClass $query */
157	36	$query = $this->prepareQuery($targetClass, $conditions);
158
159	36	if (!$model instanceof ActiveRecordInterface \|\| $model->getIsNewRecord() \|\| $model->className() !== $targetClass::className()) {
160		// if current $model isn't in the database yet then it's OK just to call exists()
161		// also there's no need to run check based on primary keys, when $targetClass is not the same as $model's class
162	33	$exists = $query->exists();
163	30	} else {
164		// if current $model is in the database already we can't use exists()
165	13	if ($query instanceof \yii\db\ActiveQuery) {
166		// only select primary key to optimize query
167	13	$query->select($targetClass::primaryKey());
168	13	}
169	13	$models = $query->limit(2)->asArray()->all();
170	13	$n = count($models);
171	13	if ($n === 1) {
172		// if there is one record, check if it is the currently validated model
173	13	$dbModel = reset($models);
174	13	$pks = $targetClass::primaryKey();
175	13	$pk = [];
176	13	foreach($pks as $pkAttribute) {
177	13	$pk[$pkAttribute] = $dbModel[$pkAttribute];
178	13	}
179	13	$exists = ($pk != $model->getOldPrimaryKey(true));
180	13	} else {
181		// if there is more than one record, the value is not unique
182	3	$exists = $n > 1;
183		}
184		}
185
186	33	return $exists;
187		}
188
189		/**
190		* Prepares a query by applying filtering conditions defined in $conditions method property
191		* and [[filter]] class property.
192		*
193		* @param ActiveRecordInterface $targetClass the name of the ActiveRecord class that should be used to validate
194		* the uniqueness of the current attribute value.
195		* @param array $conditions conditions, compatible with [[\yii\db\Query::where()\|Query::where()]] key-value format
196		*
197		* @return ActiveQueryInterface\|ActiveQuery
198		*/
199	39	private function prepareQuery($targetClass, $conditions)
200		{
201	39	$query = $targetClass::find();
202	39	$query->andWhere($conditions);
203	39	if ($this->filter instanceof \Closure) {
204	3	call_user_func($this->filter, $query);
205	39	} elseif ($this->filter !== null) {
206	3	$query->andWhere($this->filter);
207	3	}
208
209	39	return $query;
210		}
211
212		/**
213		* Processes attributes' relations described in $targetAttribute parameter into conditions, compatible with
214		* [[\yii\db\Query::where()\|Query::where()]] key-value format.
215		*
216		* @param string\|array $targetAttribute the name of the [[\yii\db\ActiveRecord\|ActiveRecord]] attribute that
217		* should be used to validate the uniqueness of the current attribute value. You may use an array to validate
218		* the uniqueness of multiple columns at the same time. The array values are the attributes that will be
219		* used to validate the uniqueness, while the array keys are the attributes whose values are to be validated.
220		* If the key and the value are the same, you can just specify the value.
221		* @param Model $model the data model to be validated
222		* @param string $attribute the name of the attribute to be validated in the $model
223		*
224		* @return array conditions, compatible with [[\yii\db\Query::where()\|Query::where()]] key-value format.
225		*/
226	42	private function prepareConditions($targetAttribute, $model, $attribute)
227		{
228	42	if (is_array($targetAttribute)) {
229	15	$conditions = [];
230	15	foreach ($targetAttribute as $k => $v) {
231	15	$conditions[$v] = is_int($k) ? $model->$v : $model->$k;
232	15	}
233	15	} else {
234	36	$conditions = [$targetAttribute => $model->$attribute];
235		}
236
237	42	return $conditions;
238		}
239
240		/**
241		* Builds and adds [[comboNotUnique]] error message to the specified model attribute.
242		* @param \yii\base\Model $model the data model.
243		* @param string $attribute the name of the attribute.
244		*/
245	6	private function addComboNotUniqueError($model, $attribute)
246		{
247	6	$attributeCombo = [];
248	6	$valueCombo = [];
249	6	foreach ($this->targetAttribute as $key => $value) {
		0 ignored issues – show Bug introduced 2016-09-02 20:20 UTC by Report Bug Copy Issue Report The expression `$this->targetAttribute` of type `string\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
250	6	if(is_int($key)) {
251	6	$attributeCombo[] = $model->getAttributeLabel($value);
252	6	$valueCombo[] = '"' . $model->$value . '"';
253	6	} else {
254		$attributeCombo[] = $model->getAttributeLabel($key);
255		$valueCombo[] = '"' . $model->$key . '"';
256		}
257	6	}
258	6	$this->addError($model, $attribute, $this->message, [
259	6	'attributes' => Inflector::sentence($attributeCombo),
260	6	'values' => implode('-', $valueCombo)
261	6	]);
262	6	}
263		}
264

rob006 / yii2-dev

GitHub Access Token became invalid

Push — master ( c73de3...97c43c )

UniqueValidator::modelExists() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like