ActiveQuery.php 19 KB
Newer Older
Qiang Xue committed
1 2 3 4
<?php
/**
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @link http://www.yiiframework.com/
Qiang Xue committed
5
 * @copyright Copyright (c) 2008 Yii Software LLC
Qiang Xue committed
6 7 8
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
9
namespace yii\db;
Qiang Xue committed
10

Qiang Xue committed
11 12 13
/**
 * ActiveQuery represents a DB query associated with an Active Record class.
 *
14 15
 * An ActiveQuery can be a normal query or be used in a relational context.
 *
16
 * ActiveQuery instances are usually created by [[ActiveRecord::find()]] and [[ActiveRecord::findBySql()]].
17 18 19 20
 * Relational queries are created by [[ActiveRecord::hasOne()]] and [[ActiveRecord::hasMany()]].
 *
 * Normal Query
 * ------------
Qiang Xue committed
21 22 23 24 25
 *
 * ActiveQuery mainly provides the following methods to retrieve the query results:
 *
 * - [[one()]]: returns a single record populated with the first row of data.
 * - [[all()]]: returns all records based on the query results.
26 27 28 29 30 31
 * - [[count()]]: returns the number of records.
 * - [[sum()]]: returns the sum over the specified column.
 * - [[average()]]: returns the average over the specified column.
 * - [[min()]]: returns the min over the specified column.
 * - [[max()]]: returns the max over the specified column.
 * - [[scalar()]]: returns the value of the first column in the first row of the query result.
32
 * - [[column()]]: returns the value of the first column in the query result.
Qiang Xue committed
33 34 35 36 37 38 39
 * - [[exists()]]: returns a value indicating whether the query result has data or not.
 *
 * Because ActiveQuery extends from [[Query]], one can use query methods, such as [[where()]],
 * [[orderBy()]] to customize the query options.
 *
 * ActiveQuery also provides the following additional query options:
 *
Qiang Xue committed
40 41 42
 * - [[with()]]: list of relations that this query should be performed with.
 * - [[indexBy()]]: the name of the column by which the query result should be indexed.
 * - [[asArray()]]: whether to return each record as an array.
Qiang Xue committed
43 44 45
 *
 * These options can be configured using methods of the same name. For example:
 *
46
 * ```php
Qiang Xue committed
47
 * $customers = Customer::find()->with('orders')->asArray()->all();
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
 * ```
 *
 * Relational query
 * ----------------
 *
 * In relational context ActiveQuery represents a relation between two Active Record classes.
 *
 * Relational ActiveQuery instances are usually created by calling [[ActiveRecord::hasOne()]] and
 * [[ActiveRecord::hasMany()]]. An Active Record class declares a relation by defining
 * a getter method which calls one of the above methods and returns the created ActiveQuery object.
 *
 * A relation is specified by [[link]] which represents the association between columns
 * of different tables; and the multiplicity of the relation is indicated by [[multiple]].
 *
 * If a relation involves a pivot table, it may be specified by [[via()]] or [[viaTable()]] method.
 * These methods may only be called in a relational context. Same is true for [[inverseOf()]], which
 * marks a relation as inverse of another relation and [[onCondition()]] which adds a condition that
 * is to be added to relational querys join condition.
Qiang Xue committed
66 67
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
68
 * @author Carsten Brandt <mail@cebe.cc>
Qiang Xue committed
69 70
 * @since 2.0
 */
71
class ActiveQuery extends Query implements ActiveQueryInterface
Qiang Xue committed
72
{
73
	use ActiveQueryTrait;
74
	use ActiveRelationTrait;
75

Qiang Xue committed
76 77 78 79 80
	/**
	 * @var string the SQL statement to be executed for retrieving AR records.
	 * This is set by [[ActiveRecord::findBySql()]].
	 */
	public $sql;
81 82 83 84 85 86 87 88
	/**
	 * @var string|array the join condition to be used when this query is used in a relational context.
	 * The condition will be used in the ON part when [[ActiveQuery::joinWith()]] is called.
	 * Otherwise, the condition will be used in the WHERE part of a query.
	 * Please refer to [[Query::where()]] on how to specify this parameter.
	 * @see onCondition()
	 */
	public $on;
89 90 91 92
	/**
	 * @var array a list of relations that this query should be joined with
	 */
	public $joinWith;
Qiang Xue committed
93 94 95 96


	/**
	 * Executes query and returns all results as an array.
97 98
	 * @param Connection $db the DB connection used to create the DB command.
	 * If null, the DB connection returned by [[modelClass]] will be used.
99
	 * @return array|ActiveRecord[] the query results. If the query results in nothing, an empty array will be returned.
Qiang Xue committed
100
	 */
101
	public function all($db = null)
Qiang Xue committed
102
	{
103 104 105
		return parent::all($db);
	}

106 107 108
	/**
	 * @inheritdoc
	 */
109 110 111
	public function prepareResult($rows)
	{
		if (empty($rows)) {
Alexander Makarov committed
112
			return [];
Qiang Xue committed
113
		}
114 115 116 117 118 119 120 121 122 123 124 125 126 127

		$models = $this->createModels($rows);
		if (!empty($this->join) && $this->indexBy === null) {
			$models = $this->removeDuplicatedModels($models);
		}
		if (!empty($this->with)) {
			$this->findWith($this->with, $models);
		}
		if (!$this->asArray) {
			foreach($models as $model) {
				$model->afterFind();
			}
		}
		return $models;
Qiang Xue committed
128 129
	}

130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 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
	/**
	 * Removes duplicated models by checking their primary key values.
	 * This method is mainly called when a join query is performed, which may cause duplicated rows being returned.
	 * @param array $models the models to be checked
	 * @return array the distinctive models
	 */
	private function removeDuplicatedModels($models)
	{
		$hash = [];
		/** @var ActiveRecord $class */
		$class = $this->modelClass;
		$pks = $class::primaryKey();

		if (count($pks) > 1) {
			foreach ($models as $i => $model) {
				$key = [];
				foreach ($pks as $pk) {
					$key[] = $model[$pk];
				}
				$key = serialize($key);
				if (isset($hash[$key])) {
					unset($models[$i]);
				} else {
					$hash[$key] = true;
				}
			}
		} else {
			$pk = reset($pks);
			foreach ($models as $i => $model) {
				$key = $model[$pk];
				if (isset($hash[$key])) {
					unset($models[$i]);
				} else {
					$hash[$key] = true;
				}
			}
		}

		return array_values($models);
	}

Qiang Xue committed
171 172
	/**
	 * Executes query and returns a single row of result.
173 174
	 * @param Connection $db the DB connection used to create the DB command.
	 * If null, the DB connection returned by [[modelClass]] will be used.
Qiang Xue committed
175 176
	 * @return ActiveRecord|array|null a single row of query result. Depending on the setting of [[asArray]],
	 * the query result may be either an array or an ActiveRecord object. Null will be returned
Qiang Xue committed
177 178
	 * if the query results in nothing.
	 */
179
	public function one($db = null)
Qiang Xue committed
180
	{
181
		$command = $this->createCommand($db);
182
		$row = $command->queryOne();
183 184 185 186
		if ($row !== false) {
			if ($this->asArray) {
				$model = $row;
			} else {
slavcodev committed
187
				/** @var ActiveRecord $class */
188
				$class = $this->modelClass;
189 190
				$model = $class::instantiate($row);
				$class::populateRecord($model, $row);
191
			}
Qiang Xue committed
192
			if (!empty($this->with)) {
Alexander Makarov committed
193
				$models = [$model];
194
				$this->findWith($this->with, $models);
Qiang Xue committed
195
				$model = $models[0];
Qiang Xue committed
196
			}
197 198 199
			if (!$this->asArray) {
				$model->afterFind();
			}
Qiang Xue committed
200
			return $model;
201
		} else {
202
			return null;
Qiang Xue committed
203
		}
Qiang Xue committed
204 205 206
	}

	/**
Qiang Xue committed
207
	 * Creates a DB command that can be used to execute this query.
Qiang Xue committed
208 209
	 * @param Connection $db the DB connection used to create the DB command.
	 * If null, the DB connection returned by [[modelClass]] will be used.
Qiang Xue committed
210
	 * @return Command the created DB command instance.
Qiang Xue committed
211
	 */
Qiang Xue committed
212
	public function createCommand($db = null)
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
	{
		if ($this->primaryModel === null) {
			// not a relational context or eager loading
			if (!empty($this->on)) {
				$where = $this->where;
				$this->andWhere($this->on);
				$command = $this->createCommandInternal($db);
				$this->where = $where;
				return $command;
			} else {
				return $this->createCommandInternal($db);
			}
		} else {
			// lazy loading of a relation
			return $this->createRelationalCommand($db);
		}
	}

	/**
	 * Creates a DB command that can be used to execute this query.
	 * @param Connection $db the DB connection used to create the DB command.
	 * If null, the DB connection returned by [[modelClass]] will be used.
	 * @return Command the created DB command instance.
	 */
	protected function createCommandInternal($db)
Qiang Xue committed
238
	{
239 240 241 242
		if (!empty($this->joinWith)) {
			$this->buildJoinWith();
		}

slavcodev committed
243
		/** @var ActiveRecord $modelClass */
Qiang Xue committed
244
		$modelClass = $this->modelClass;
Qiang Xue committed
245
		if ($db === null) {
Qiang Xue committed
246
			$db = $modelClass::getDb();
Qiang Xue committed
247
		}
248

Qiang Xue committed
249
		if ($this->sql === null) {
Carsten Brandt committed
250 251 252 253
			list ($sql, $params) = $db->getQueryBuilder()->build($this);
		} else {
			$sql = $this->sql;
			$params = $this->params;
Qiang Xue committed
254
		}
Carsten Brandt committed
255
		return $db->createCommand($sql, $params);
Qiang Xue committed
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 291 292 293 294 295 296 297 298
	/**
	 * Creates a command for lazy loading of a relation.
	 * @param Connection $db the DB connection used to create the DB command.
	 * @return Command the created DB command instance.
	 */
	private function createRelationalCommand($db = null)
	{
		$where = $this->where;

		if ($this->via instanceof self) {
			// via pivot table
			$viaModels = $this->via->findPivotRows([$this->primaryModel]);
			$this->filterByModels($viaModels);
		} elseif (is_array($this->via)) {
			// via relation
			/** @var ActiveQuery $viaQuery */
			list($viaName, $viaQuery) = $this->via;
			if ($viaQuery->multiple) {
				$viaModels = $viaQuery->all();
				$this->primaryModel->populateRelation($viaName, $viaModels);
			} else {
				$model = $viaQuery->one();
				$this->primaryModel->populateRelation($viaName, $model);
				$viaModels = $model === null ? [] : [$model];
			}
			$this->filterByModels($viaModels);
		} else {
			$this->filterByModels([$this->primaryModel]);
		}

		if (!empty($this->on)) {
			$this->andWhere($this->on);
		}

		$command = $this->createCommandInternal($db);

		$this->where = $where;

		return $command;
	}

299 300 301 302 303 304 305 306 307 308 309 310
	/**
	 * Joins with the specified relations.
	 *
	 * This method allows you to reuse existing relation definitions to perform JOIN queries.
	 * Based on the definition of the specified relation(s), the method will append one or multiple
	 * JOIN statements to the current query.
	 *
	 * If the `$eagerLoading` parameter is true, the method will also eager loading the specified relations,
	 * which is equivalent to calling [[with()]] using the specified relations.
	 *
	 * Note that because a JOIN query will be performed, you are responsible to disambiguate column names.
	 *
311 312
	 * This method differs from [[with()]] in that it will build up and execute a JOIN SQL statement
	 * for the primary table. And when `$eagerLoading` is true, it will call [[with()]] in addition with the specified relations.
313 314 315 316 317 318 319 320 321
	 *
	 * @param array $with the relations to be joined. Each array element represents a single relation.
	 * The array keys are relation names, and the array values are the corresponding anonymous functions that
	 * can be used to modify the relation queries on-the-fly. If a relation query does not need modification,
	 * you may use the relation name as the array value. Sub-relations can also be specified (see [[with()]]).
	 * For example,
	 *
	 * ```php
	 * // find all orders that contain books, and eager loading "books"
322 323
	 * Order::find()->joinWith('books', true, 'INNER JOIN')->all();
	 * // find all orders, eager loading "books", and sort the orders and books by the book names.
324 325 326 327 328 329 330
	 * Order::find()->joinWith([
	 *     'books' => function ($query) {
	 *         $query->orderBy('tbl_item.name');
	 *     }
	 * ])->all();
	 * ```
	 *
Qiang Xue committed
331 332 333 334 335 336 337
	 * @param boolean|array $eagerLoading whether to eager load the relations specified in `$with`.
	 * When this is a boolean, it applies to all relations specified in `$with`. Use an array
	 * to explicitly list which relations in `$with` need to be eagerly loaded.
	 * @param string|array $joinType the join type of the relations specified in `$with`.
	 * When this is a string, it applies to all relations specified in `$with`. Use an array
	 * in the format of `relationName => joinType` to specify different join types for different relations.
	 * @return static the query object itself
338
	 */
339
	public function joinWith($with, $eagerLoading = true, $joinType = 'LEFT JOIN')
340
	{
341 342 343
		$this->joinWith[] = [(array)$with, $eagerLoading, $joinType];
		return $this;
	}
344

345 346 347 348 349 350 351 352 353 354 355 356 357
	private function buildJoinWith()
	{
		foreach ($this->joinWith as $config) {
			list ($with, $eagerLoading, $joinType) = $config;
			$this->joinWithRelations(new $this->modelClass, $with, $joinType);

			if (is_array($eagerLoading)) {
				foreach ($with as $name => $callback) {
					if (is_integer($name)) {
						if (!in_array($callback, $eagerLoading, true)) {
							unset($with[$name]);
						}
					} elseif (!in_array($name, $eagerLoading, true)) {
358 359 360
						unset($with[$name]);
					}
				}
361 362
			} elseif (!$eagerLoading) {
				$with = [];
363
			}
Qiang Xue committed
364

365 366
			$this->with($with);
		}
367 368
	}

369 370 371 372 373 374 375 376 377 378 379 380 381 382
	/**
	 * Inner joins with the specified relations.
	 * This is a shortcut method to [[joinWith()]] with the join type set as "INNER JOIN".
	 * Please refer to [[joinWith()]] for detailed usage of this method.
	 * @param array $with the relations to be joined with
	 * @param boolean|array $eagerLoading whether to eager loading the relations
	 * @return static the query object itself
	 * @see joinWith()
	 */
	public function innerJoinWith($with, $eagerLoading = true)
	{
		return $this->joinWith($with, $eagerLoading, 'INNER JOIN');
	}

383
	/**
384 385 386 387
	 * Modifies the current query by adding join fragments based on the given relations.
	 * @param ActiveRecord $model the primary model
	 * @param array $with the relations to be joined
	 * @param string|array $joinType the join type
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
	 */
	private function joinWithRelations($model, $with, $joinType)
	{
		$relations = [];

		foreach ($with as $name => $callback) {
			if (is_integer($name)) {
				$name = $callback;
				$callback = null;
			}

			$primaryModel = $model;
			$parent = $this;
			$prefix = '';
			while (($pos = strpos($name, '.')) !== false) {
				$childName = substr($name, $pos + 1);
				$name = substr($name, 0, $pos);
				$fullName = $prefix === '' ? $name : "$prefix.$name";
				if (!isset($relations[$fullName])) {
					$relations[$fullName] = $relation = $primaryModel->getRelation($name);
					$this->joinWithRelation($parent, $relation, $this->getJoinType($joinType, $fullName));
				} else {
					$relation = $relations[$fullName];
				}
				$primaryModel = new $relation->modelClass;
				$parent = $relation;
				$prefix = $fullName;
				$name = $childName;
			}

			$fullName = $prefix === '' ? $name : "$prefix.$name";
			if (!isset($relations[$fullName])) {
				$relations[$fullName] = $relation = $primaryModel->getRelation($name);
				if ($callback !== null) {
					call_user_func($callback, $relation);
				}
				$this->joinWithRelation($parent, $relation, $this->getJoinType($joinType, $fullName));
			}
		}
	}

429 430 431 432 433 434
	/**
	 * Returns the join type based on the given join type parameter and the relation name.
	 * @param string|array $joinType the given join type(s)
	 * @param string $name relation name
	 * @return string the real join type
	 */
435 436 437 438 439 440 441 442 443 444
	private function getJoinType($joinType, $name)
	{
		if (is_array($joinType) && isset($joinType[$name])) {
			return $joinType[$name];
		} else {
			return is_string($joinType) ? $joinType : 'INNER JOIN';
		}
	}

	/**
445
	 * Returns the table name and the table alias for [[modelClass]].
446
	 * @param ActiveQuery $query
447
	 * @return array the table name and the table alias.
448
	 */
449
	private function getQueryTableName($query)
450 451 452 453
	{
		if (empty($query->from)) {
			/** @var ActiveRecord $modelClass */
			$modelClass = $query->modelClass;
454
			$tableName = $modelClass::tableName();
455
		} else {
456
			$tableName = reset($query->from);
457
		}
458 459

		if (preg_match('/^(.*?)\s+({{\w+}}|\w+)$/', $tableName, $matches)) {
460 461 462
			$alias = $matches[2];
		} else {
			$alias = $tableName;
463
		}
464 465

		return [$tableName, $alias];
466 467 468
	}

	/**
469 470
	 * Joins a parent query with a child query.
	 * The current query object will be modified accordingly.
471
	 * @param ActiveQuery $parent
472
	 * @param ActiveQuery $child
473 474 475 476
	 * @param string $joinType
	 */
	private function joinWithRelation($parent, $child, $joinType)
	{
477 478
		$via = $child->via;
		$child->via = null;
479
		if ($via instanceof ActiveQuery) {
480 481 482 483 484 485 486 487 488 489 490
			// via table
			$this->joinWithRelation($parent, $via, $joinType);
			$this->joinWithRelation($via, $child, $joinType);
			return;
		} elseif (is_array($via)) {
			// via relation
			$this->joinWithRelation($parent, $via[1], $joinType);
			$this->joinWithRelation($via[1], $child, $joinType);
			return;
		}

491 492
		list ($parentTable, $parentAlias) = $this->getQueryTableName($parent);
		list ($childTable, $childAlias) = $this->getQueryTableName($child);
493

494
		if (!empty($child->link)) {
495 496 497 498 499 500 501 502

			if (strpos($parentAlias, '{{') === false) {
				$parentAlias = '{{' . $parentAlias . '}}';
			}
			if (strpos($childAlias, '{{') === false) {
				$childAlias = '{{' . $childAlias . '}}';
			}

503 504
			$on = [];
			foreach ($child->link as $childColumn => $parentColumn) {
505
				$on[] = "$parentAlias.[[$parentColumn]] = $childAlias.[[$childColumn]]";
506 507
			}
			$on = implode(' AND ', $on);
508 509 510
			if (!empty($child->on)) {
				$on = ['and', $on, $child->on];
			}
511
		} else {
512
			$on = $child->on;
513 514
		}
		$this->join($joinType, $childTable, $on);
515 516


517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
		if (!empty($child->where)) {
			$this->andWhere($child->where);
		}
		if (!empty($child->having)) {
			$this->andHaving($child->having);
		}
		if (!empty($child->orderBy)) {
			$this->addOrderBy($child->orderBy);
		}
		if (!empty($child->groupBy)) {
			$this->addGroupBy($child->groupBy);
		}
		if (!empty($child->params)) {
			$this->addParams($child->params);
		}
		if (!empty($child->join)) {
			foreach ($child->join as $join) {
				$this->join[] = $join;
			}
		}
		if (!empty($child->union)) {
			foreach ($child->union as $union) {
				$this->union[] = $union;
			}
		}
	}
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605

	/**
	 * Sets the ON condition for a relational query.
	 * The condition will be used in the ON part when [[ActiveQuery::joinWith()]] is called.
	 * Otherwise, the condition will be used in the WHERE part of a query.
	 *
	 * Use this method to specify additional conditions when declaring a relation in the [[ActiveRecord]] class:
	 *
	 * ```php
	 * public function getActiveUsers()
	 * {
	 *     return $this->hasMany(User::className(), ['id' => 'user_id'])->onCondition(['active' => true]);
	 * }
	 * ```
	 *
	 * @param string|array $condition the ON condition. Please refer to [[Query::where()]] on how to specify this parameter.
	 * @param array $params the parameters (name => value) to be bound to the query.
	 * @return static the query object itself
	 */
	public function onCondition($condition, $params = [])
	{
		$this->on = $condition;
		$this->addParams($params);
		return $this;
	}

	/**
	 * Specifies the pivot table for a relational query.
	 *
	 * Use this method to specify a pivot table when declaring a relation in the [[ActiveRecord]] class:
	 *
	 * ```php
	 * public function getItems()
	 * {
	 *     return $this->hasMany(Item::className(), ['id' => 'item_id'])
	 *                 ->viaTable('tbl_order_item', ['order_id' => 'id']);
	 * }
	 * ```
	 *
	 * @param string $tableName the name of the pivot table.
	 * @param array $link the link between the pivot table and the table associated with [[primaryModel]].
	 * The keys of the array represent the columns in the pivot table, and the values represent the columns
	 * in the [[primaryModel]] table.
	 * @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
	 * @see via()
	 */
	public function viaTable($tableName, $link, $callable = null)
	{
		$relation = new ActiveQuery([
			'modelClass' => get_class($this->primaryModel),
			'from' => [$tableName],
			'link' => $link,
			'multiple' => true,
			'asArray' => true,
		]);
		$this->via = $relation;
		if ($callable !== null) {
			call_user_func($callable, $relation);
		}
		return $this;
	}
Qiang Xue committed
606
}