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

8
namespace yii\db;
9 10

use yii\base\InvalidConfigException;
11
use yii\base\InvalidParamException;
12 13

/**
14
 * ActiveRelationTrait implements the common methods and properties for active record relational queries.
15 16
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
17
 * @author Carsten Brandt <mail@cebe.cc>
18 19
 * @since 2.0
 */
20
trait ActiveRelationTrait
21 22
{
	/**
23 24 25 26
	 * @var boolean whether this query represents a relation to more than one record.
	 * This property is only used in relational context. If true, this relation will
	 * populate all query results into AR instances using [[all()]].
	 * If false, only the first row of the results will be retrieved using [[one()]].
27 28 29
	 */
	public $multiple;
	/**
30
	 * @var ActiveRecord the primary model of a relational query.
31 32 33 34
	 * This is used only in lazy loading with dynamic query options.
	 */
	public $primaryModel;
	/**
35
	 * @var array the columns of the primary and foreign tables that establish a relation.
36 37
	 * The array keys must be columns of the table for this relation, and the array values
	 * must be the corresponding columns from the primary table.
38
	 * Do not prefix or quote the column names as this will be done automatically by Yii.
39
	 * This property is only used in relational context.
40 41 42 43 44
	 */
	public $link;
	/**
	 * @var array the query associated with the pivot table. Please call [[via()]]
	 * to set this property instead of directly setting it.
45 46
	 * This property is only used in relational context.
	 * @see via()
47 48
	 */
	public $via;
49 50 51 52 53 54 55
	/**
	 * @var string the name of the relation that is the inverse of this relation.
	 * For example, an order has a customer, which means the inverse of the "customer" relation
	 * is the "orders", and the inverse of the "orders" relation is the "customer".
	 * If this property is set, the primary record(s) will be referenced through the specified relation.
	 * For example, `$customer->orders[0]->customer` and `$customer` will be the same object,
	 * and accessing the customer of an order will not trigger new DB query.
56 57
	 * This property is only used in relational context.
	 * @see inverseOf()
58 59
	 */
	public $inverseOf;
60

61

62 63 64 65 66
	/**
	 * Clones internal objects.
	 */
	public function __clone()
	{
67
		parent::__clone();
68
		// make a clone of "via" object so that the same query object can be reused multiple times
69 70
		if (is_object($this->via)) {
			$this->via = clone $this->via;
71 72
		} elseif (is_array($this->via)) {
			$this->via = [$this->via[0], clone $this->via[1]];
73 74 75 76 77
		}
	}

	/**
	 * Specifies the relation associated with the pivot table.
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
	 *
	 * Use this method to specify a pivot record/table when declaring a relation in the [[ActiveRecord]] class:
	 *
	 * ```php
	 * public function getOrders()
	 * {
	 *     return $this->hasOne(Order::className(), ['id' => 'order_id']);
	 * }
	 *
	 * public function getOrderItems()
	 * {
	 *     return $this->hasMany(Item::className(), ['id' => 'item_id'])
	 *                 ->via('orders', ['order_id' => 'id']);
	 * }
	 * ```
	 *
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
	 * @param string $relationName the relation name. This refers to a relation declared in [[primaryModel]].
	 * @param callable $callable a PHP callback for customizing the relation associated with the pivot table.
	 * Its signature should be `function($query)`, where `$query` is the query to be customized.
	 * @return static the relation object itself.
	 */
	public function via($relationName, $callable = null)
	{
		$relation = $this->primaryModel->getRelation($relationName);
		$this->via = [$relationName, $relation];
		if ($callable !== null) {
			call_user_func($callable, $relation);
		}
		return $this;
	}

109 110 111 112 113 114
	/**
	 * Sets the name of the relation that is the inverse of this relation.
	 * For example, an order has a customer, which means the inverse of the "customer" relation
	 * is the "orders", and the inverse of the "orders" relation is the "customer".
	 * If this property is set, the primary record(s) will be referenced through the specified relation.
	 * For example, `$customer->orders[0]->customer` and `$customer` will be the same object,
115 116 117 118 119 120 121 122 123 124 125
	 * and accessing the customer of an order will not trigger a new DB query.
	 *
	 * Use this method when declaring a relation in the [[ActiveRecord]] class:
	 *
	 * ```php
	 * public function getOrders()
	 * {
	 *     return $this->hasMany(Order::className(), ['customer_id' => 'id'])->inverseOf('customer');
	 * }
	 * ```
	 *
126 127 128 129 130 131 132 133 134 135 136 137 138
	 * @param string $relationName the name of the relation that is the inverse of this relation.
	 * @return static the relation object itself.
	 */
	public function inverseOf($relationName)
	{
		$this->inverseOf = $relationName;
		return $this;
	}

	/**
	 * Finds the related records for the specified primary record.
	 * This method is invoked when a relation of an ActiveRecord is being accessed in a lazy fashion.
	 * @param string $name the relation name
139
	 * @param ActiveRecordInterface|BaseActiveRecord $model the primary model
140 141 142 143 144
	 * @return mixed the related record(s)
	 * @throws InvalidParamException if the relation is invalid
	 */
	public function findFor($name, $model)
	{
145
		if ($model->hasMethod('get' . $name)) {
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
			$method = new \ReflectionMethod($model, 'get' . $name);
			$realName = lcfirst(substr($method->getName(), 3));
			if ($realName !== $name) {
				throw new InvalidParamException('Relation names are case sensitive. ' . get_class($model) . " has a relation named \"$realName\" instead of \"$name\".");
			}
		}

		$related = $this->multiple ? $this->all() : $this->one();

		if ($this->inverseOf === null || empty($related)) {
			return $related;
		}

		$inverseRelation = (new $this->modelClass)->getRelation($this->inverseOf);

		if ($this->multiple) {
			foreach ($related as $i => $relatedModel) {
				if ($relatedModel instanceof ActiveRecordInterface) {
					$relatedModel->populateRelation($this->inverseOf, $inverseRelation->multiple ? [$model] : $model);
				} else {
					$related[$i][$this->inverseOf] = $inverseRelation->multiple ? [$model] : $model;
				}
			}
		} else {
			if ($related instanceof ActiveRecordInterface) {
				$related->populateRelation($this->inverseOf, $inverseRelation->multiple ? [$model] : $model);
			} else {
				$related[$this->inverseOf] = $inverseRelation->multiple ? [$model] : $model;
			}
		}

		return $related;
	}

180 181 182 183 184
	/**
	 * Finds the related records and populates them into the primary models.
	 * @param string $name the relation name
	 * @param array $primaryModels primary models
	 * @return array the related models
185
	 * @throws InvalidConfigException if [[link]] is invalid
186
	 */
187
	public function populateRelation($name, &$primaryModels)
188 189 190 191 192 193 194
	{
		if (!is_array($this->link)) {
			throw new InvalidConfigException('Invalid link: it must be an array of key-value pairs.');
		}

		if ($this->via instanceof self) {
			// via pivot table
195
			/** @var ActiveRelationTrait $viaQuery */
196 197 198 199 200
			$viaQuery = $this->via;
			$viaModels = $viaQuery->findPivotRows($primaryModels);
			$this->filterByModels($viaModels);
		} elseif (is_array($this->via)) {
			// via relation
201
			/** @var ActiveRelationTrait $viaQuery */
202 203
			list($viaName, $viaQuery) = $this->via;
			$viaQuery->primaryModel = null;
204
			$viaModels = $viaQuery->populateRelation($viaName, $primaryModels);
205 206 207 208 209 210 211 212
			$this->filterByModels($viaModels);
		} else {
			$this->filterByModels($primaryModels);
		}

		if (count($primaryModels) === 1 && !$this->multiple) {
			$model = $this->one();
			foreach ($primaryModels as $i => $primaryModel) {
Carsten Brandt committed
213
				if ($primaryModel instanceof ActiveRecordInterface) {
214 215 216 217
					$primaryModel->populateRelation($name, $model);
				} else {
					$primaryModels[$i][$name] = $model;
				}
218 219 220
				if ($this->inverseOf !== null) {
					$this->populateInverseRelation($primaryModels, [$model], $name, $this->inverseOf);
				}
221 222 223 224 225 226 227 228 229 230 231 232 233 234
			}
			return [$model];
		} else {
			$models = $this->all();
			if (isset($viaModels, $viaQuery)) {
				$buckets = $this->buildBuckets($models, $this->link, $viaModels, $viaQuery->link);
			} else {
				$buckets = $this->buildBuckets($models, $this->link);
			}

			$link = array_values(isset($viaQuery) ? $viaQuery->link : $this->link);
			foreach ($primaryModels as $i => $primaryModel) {
				$key = $this->getModelKey($primaryModel, $link);
				$value = isset($buckets[$key]) ? $buckets[$key] : ($this->multiple ? [] : null);
Carsten Brandt committed
235
				if ($primaryModel instanceof ActiveRecordInterface) {
236 237 238 239 240
					$primaryModel->populateRelation($name, $value);
				} else {
					$primaryModels[$i][$name] = $value;
				}
			}
241 242 243
			if ($this->inverseOf !== null) {
				$this->populateInverseRelation($primaryModels, $models, $name, $this->inverseOf);
			}
244 245 246 247
			return $models;
		}
	}

248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
	private function populateInverseRelation(&$primaryModels, $models, $primaryName, $name)
	{
		if (empty($models) || empty($primaryModels)) {
			return;
		}
		$model = reset($models);
		$relation = $model instanceof ActiveRecordInterface ? $model->getRelation($name) : (new $this->modelClass)->getRelation($name);

		if ($relation->multiple) {
			$buckets = $this->buildBuckets($primaryModels, $relation->link, null, null, false);
			if ($model instanceof ActiveRecordInterface) {
				foreach ($models as $model) {
					$key = $this->getModelKey($model, $relation->link);
					$model->populateRelation($name, isset($buckets[$key]) ? $buckets[$key] : []);
				}
			} else {
				foreach ($primaryModels as $i => $primaryModel) {
					if ($this->multiple) {
						foreach ($primaryModel as $j => $m) {
							$key = $this->getModelKey($m, $relation->link);
							$primaryModels[$i][$j][$name] = isset($buckets[$key]) ? $buckets[$key] : [];
						}
					} elseif (!empty($primaryModel[$primaryName])) {
						$key = $this->getModelKey($primaryModel[$primaryName], $relation->link);
						$primaryModels[$i][$primaryName][$name] = isset($buckets[$key]) ? $buckets[$key] : [];
					}
				}
			}
		} else {
			if ($this->multiple) {
				foreach ($primaryModels as $i => $primaryModel) {
					foreach ($primaryModel[$primaryName] as $j => $m) {
						if ($m instanceof ActiveRecordInterface) {
							$m->populateRelation($name, $primaryModel);
						} else {
							$primaryModels[$i][$primaryName][$j][$name] = $primaryModel;
						}
					}
				}
			} else {
				foreach ($primaryModels as $i => $primaryModel) {
					if ($primaryModels[$i][$primaryName] instanceof ActiveRecordInterface) {
						$primaryModels[$i][$primaryName]->populateRelation($name, $primaryModel);
AlexGx committed
291
					} elseif (!empty($primaryModels[$i][$primaryName])) {
292 293 294 295 296 297 298
						$primaryModels[$i][$primaryName][$name] = $primaryModel;
					}
				}
			}
		}
	}

299 300 301 302 303
	/**
	 * @param array $models
	 * @param array $link
	 * @param array $viaModels
	 * @param array $viaLink
304
	 * @param boolean $checkMultiple
305 306
	 * @return array
	 */
307
	private function buildBuckets($models, $link, $viaModels = null, $viaLink = null, $checkMultiple = true)
308 309
	{
		if ($viaModels !== null) {
310
			$map = [];
311 312 313 314 315
			$viaLinkKeys = array_keys($viaLink);
			$linkValues = array_values($link);
			foreach ($viaModels as $viaModel) {
				$key1 = $this->getModelKey($viaModel, $viaLinkKeys);
				$key2 = $this->getModelKey($viaModel, $linkValues);
316 317 318 319 320 321 322 323 324 325 326 327
				$map[$key2][$key1] = true;
			}
		}

		$buckets = [];
		$linkKeys = array_keys($link);

		if (isset($map)) {
			foreach ($models as $i => $model) {
				$key = $this->getModelKey($model, $linkKeys);
				if (isset($map[$key])) {
					foreach (array_keys($map[$key]) as $key2) {
328
						if ($this->indexBy !== null) {
329
							$buckets[$key2][$i] = $model;
330
						} else {
331
							$buckets[$key2][] = $model;
332 333 334 335
						}
					}
				}
			}
336 337 338 339 340 341 342 343 344
		} else {
			foreach ($models as $i => $model) {
				$key = $this->getModelKey($model, $linkKeys);
				if ($this->indexBy !== null) {
					$buckets[$key][$i] = $model;
				} else {
					$buckets[$key][] = $model;
				}
			}
345 346
		}

347
		if ($checkMultiple && !$this->multiple) {
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
			foreach ($buckets as $i => $bucket) {
				$buckets[$i] = reset($bucket);
			}
		}
		return $buckets;
	}

	/**
	 * @param array $models
	 */
	private function filterByModels($models)
	{
		$attributes = array_keys($this->link);
		$values = [];
		if (count($attributes) === 1) {
			// single key
			$attribute = reset($this->link);
			foreach ($models as $model) {
				if (($value = $model[$attribute]) !== null) {
					$values[] = $value;
				}
			}
		} else {
			// composite keys
			foreach ($models as $model) {
				$v = [];
				foreach ($this->link as $attribute => $link) {
					$v[$attribute] = $model[$link];
				}
				$values[] = $v;
			}
		}
		$this->andWhere(['in', $attributes, array_unique($values, SORT_REGULAR)]);
	}

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
	/**
	 * @param ActiveRecord|array $model
	 * @param array $attributes
	 * @return string
	 */
	private function getModelKey($model, $attributes)
	{
		if (count($attributes) > 1) {
			$key = [];
			foreach ($attributes as $attribute) {
				$key[] = $model[$attribute];
			}
			return serialize($key);
		} else {
			$attribute = reset($attributes);
			$key = $model[$attribute];
			return is_scalar($key) ? $key : serialize($key);
		}
	}

403
	/**
404
	 * @param array $primaryModels either array of AR instances or arrays
405 406 407 408 409 410 411 412
	 * @return array
	 */
	private function findPivotRows($primaryModels)
	{
		if (empty($primaryModels)) {
			return [];
		}
		$this->filterByModels($primaryModels);
413
		/** @var ActiveRecord $primaryModel */
414
		$primaryModel = reset($primaryModels);
415 416 417 418
		if (!$primaryModel instanceof ActiveRecordInterface) {
			// when primaryModels are array of arrays (asArray case)
			$primaryModel = new $this->modelClass;
		}
419 420 421
		return $this->asArray()->all($primaryModel->getDb());
	}
}