Query.php 28.8 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/
 */

Qiang Xue committed
8
namespace yii\db;
w  
Qiang Xue committed
9

10 11 12
use Yii;
use yii\base\Component;

w  
Qiang Xue committed
13
/**
Qiang Xue committed
14
 * Query represents a SELECT SQL statement in a way that is independent of DBMS.
Qiang Xue committed
15
 *
Qiang Xue committed
16 17
 * Query provides a set of methods to facilitate the specification of different clauses
 * in a SELECT statement. These methods can be chained together.
Qiang Xue committed
18
 *
Qiang Xue committed
19 20 21 22
 * By calling [[createCommand()]], we can get a [[Command]] instance which can be further
 * used to perform/execute the DB query against a database.
 *
 * For example,
Qiang Xue committed
23 24 25
 *
 * ~~~
 * $query = new Query;
Qiang Xue committed
26
 * // compose the query
Qiang Xue committed
27 28 29
 * $query->select('id, name')
 *     ->from('tbl_user')
 *     ->limit(10);
Qiang Xue committed
30
 * // build and execute the query
Qiang Xue committed
31 32
 * $rows = $query->all();
 * // alternatively, you can create DB command and execute it
Qiang Xue committed
33 34 35
 * $command = $query->createCommand();
 * // $command->sql returns the actual SQL
 * $rows = $command->queryAll();
Qiang Xue committed
36 37
 * ~~~
 *
w  
Qiang Xue committed
38
 * @author Qiang Xue <qiang.xue@gmail.com>
39
 * @author Carsten Brandt <mail@cebe.cc>
w  
Qiang Xue committed
40 41
 * @since 2.0
 */
42
class Query extends Component implements QueryInterface
w  
Qiang Xue committed
43
{
44
	use QueryTrait;
45

Qiang Xue committed
46
	/**
Alexander Makarov committed
47
	 * @var array the columns being selected. For example, `['id', 'name']`.
Carsten Brandt committed
48
	 * This is used to construct the SELECT clause in a SQL statement. If not set, it means selecting all columns.
Qiang Xue committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62
	 * @see select()
	 */
	public $select;
	/**
	 * @var string additional option that should be appended to the 'SELECT' keyword. For example,
	 * in MySQL, the option 'SQL_CALC_FOUND_ROWS' can be used.
	 */
	public $selectOption;
	/**
	 * @var boolean whether to select distinct rows of data only. If this is set true,
	 * the SELECT clause would be changed to SELECT DISTINCT.
	 */
	public $distinct;
	/**
Alexander Makarov committed
63
	 * @var array the table(s) to be selected from. For example, `['tbl_user', 'tbl_post']`.
Qiang Xue committed
64
	 * This is used to construct the FROM clause in a SQL statement.
Qiang Xue committed
65 66 67
	 * @see from()
	 */
	public $from;
Qiang Xue committed
68
	/**
Alexander Makarov committed
69
	 * @var array how to group the query results. For example, `['company', 'department']`.
Qiang Xue committed
70
	 * This is used to construct the GROUP BY clause in a SQL statement.
Qiang Xue committed
71
	 */
Qiang Xue committed
72 73
	public $groupBy;
	/**
Qiang Xue committed
74 75 76 77
	 * @var array how to join with other tables. Each array element represents the specification
	 * of one join which has the following structure:
	 *
	 * ~~~
Alexander Makarov committed
78
	 * [$joinType, $tableName, $joinCondition]
Qiang Xue committed
79 80 81 82 83
	 * ~~~
	 *
	 * For example,
	 *
	 * ~~~
Alexander Makarov committed
84 85 86 87
	 * [
	 *     ['INNER JOIN', 'tbl_user', 'tbl_user.id = author_id'],
	 *     ['LEFT JOIN', 'tbl_team', 'tbl_team.id = team_id'],
	 * ]
Qiang Xue committed
88
	 * ~~~
Qiang Xue committed
89 90 91 92 93 94 95 96
	 */
	public $join;
	/**
	 * @var string|array the condition to be applied in the GROUP BY clause.
	 * It can be either a string or an array. Please refer to [[where()]] on how to specify the condition.
	 */
	public $having;
	/**
Qiang Xue committed
97
	 * @var array this is used to construct the UNION clause(s) in a SQL statement.
98 99 100 101
	 * Each array element is an array of the following structure:
	 *
	 * - `query`: either a string or a [[Query]] object representing a query
	 * - `all`: boolean, whether it should be `UNION ALL` or `UNION`
Qiang Xue committed
102 103 104 105
	 */
	public $union;
	/**
	 * @var array list of query parameter values indexed by parameter placeholders.
Alexander Makarov committed
106
	 * For example, `[':name' => 'Dan', ':age' => 31]`.
Qiang Xue committed
107
	 */
108
	public $params = [];
Qiang Xue committed
109

Qiang Xue committed
110 111

	/**
Qiang Xue committed
112 113
	 * Creates a DB command that can be used to execute this query.
	 * @param Connection $db the database connection used to generate the SQL statement.
Qiang Xue committed
114
	 * If this parameter is not given, the `db` application component will be used.
Qiang Xue committed
115
	 * @return Command the created DB command instance.
Qiang Xue committed
116
	 */
Qiang Xue committed
117
	public function createCommand($db = null)
Qiang Xue committed
118
	{
Qiang Xue committed
119
		if ($db === null) {
120
			$db = Yii::$app->getDb();
Qiang Xue committed
121
		}
122 123
		list ($sql, $params) = $db->getQueryBuilder()->build($this);
		return $db->createCommand($sql, $params);
Qiang Xue committed
124 125
	}

126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
	/**
	 * Starts a batch query.
	 *
	 * A batch query supports fetching data in batches, which can keep the memory usage under a limit.
	 * This method will return a [[BatchQueryResult]] object which implements the `Iterator` interface
	 * and can be traversed to retrieve the data in batches.
	 *
	 * For example,
	 *
	 * ```php
	 * $query = (new Query)->from('tbl_user');
	 * foreach ($query->batch() as $rows) {
	 *     // $rows is an array of 10 or fewer rows from tbl_user
	 * }
	 * ```
	 *
Qiang Xue committed
142
	 * @param integer $batchSize the number of records to be fetched in each batch.
143 144 145 146
	 * @param Connection $db the database connection. If not set, the "db" application component will be used.
	 * @return BatchQueryResult the batch query result. It implements the `Iterator` interface
	 * and can be traversed to retrieve the data in batches.
	 */
Qiang Xue committed
147
	public function batch($batchSize = 100, $db = null)
148 149 150 151
	{
		return Yii::createObject([
			'class' => BatchQueryResult::className(),
			'query' => $this,
Qiang Xue committed
152
			'batchSize' => $batchSize,
153
			'db' => $db,
Qiang Xue committed
154
			'each' => false,
155 156 157
		]);
	}

158 159
	/**
	 * Starts a batch query and retrieves data row by row.
Qiang Xue committed
160 161 162 163 164 165 166 167 168 169
	 * This method is similar to [[batch()]] except that in each iteration of the result,
	 * only one row of data is returned. For example,
	 *
	 * ```php
	 * $query = (new Query)->from('tbl_user');
	 * foreach ($query->each() as $row) {
	 * }
	 * ```
	 *
	 * @param integer $batchSize the number of records to be fetched in each batch.
170 171 172 173
	 * @param Connection $db the database connection. If not set, the "db" application component will be used.
	 * @return BatchQueryResult the batch query result. It implements the `Iterator` interface
	 * and can be traversed to retrieve the data in batches.
	 */
Qiang Xue committed
174
	public function each($batchSize = 100, $db = null)
175
	{
Qiang Xue committed
176 177 178 179 180 181 182
		return Yii::createObject([
			'class' => BatchQueryResult::className(),
			'query' => $this,
			'batchSize' => $batchSize,
			'db' => $db,
			'each' => true,
		]);
183 184
	}

185 186 187 188 189 190 191 192
	/**
	 * Executes the query and returns all results as an array.
	 * @param Connection $db the database connection used to generate the SQL statement.
	 * If this parameter is not given, the `db` application component will be used.
	 * @return array the query results. If the query results in nothing, an empty array will be returned.
	 */
	public function all($db = null)
	{
Qiang Xue committed
193
		$rows = $this->createCommand($db)->queryAll();
194 195 196
		return $this->prepareResult($rows);
	}

197 198 199 200 201 202 203
	/**
	 * Converts the raw query results into the format as specified by this query.
	 * This method is internally used to convert the data fetched from database
	 * into the format as required by this query.
	 * @param array $rows the raw query result from database
	 * @return array the converted query result
	 */
204 205
	public function prepareResult($rows)
	{
Qiang Xue committed
206 207 208
		if ($this->indexBy === null) {
			return $rows;
		}
Alexander Makarov committed
209
		$result = [];
Qiang Xue committed
210 211 212 213 214 215 216 217 218
		foreach ($rows as $row) {
			if (is_string($this->indexBy)) {
				$key = $row[$this->indexBy];
			} else {
				$key = call_user_func($this->indexBy, $row);
			}
			$result[$key] = $row;
		}
		return $result;
219 220 221 222 223 224
	}

	/**
	 * Executes the query and returns a single row of result.
	 * @param Connection $db the database connection used to generate the SQL statement.
	 * If this parameter is not given, the `db` application component will be used.
225
	 * @return array|boolean the first row (in terms of an array) of the query result. False is returned if the query
226 227 228 229
	 * results in nothing.
	 */
	public function one($db = null)
	{
230
		return $this->createCommand($db)->queryOne();
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
	}

	/**
	 * Returns the query result as a scalar value.
	 * The value returned will be the first column in the first row of the query results.
	 * @param Connection $db the database connection used to generate the SQL statement.
	 * If this parameter is not given, the `db` application component will be used.
	 * @return string|boolean the value of the first column in the first row of the query result.
	 * False is returned if the query result is empty.
	 */
	public function scalar($db = null)
	{
		return $this->createCommand($db)->queryScalar();
	}

	/**
	 * Executes the query and returns the first column of the result.
	 * @param Connection $db the database connection used to generate the SQL statement.
	 * If this parameter is not given, the `db` application component will be used.
	 * @return array the first column of the query result. An empty array is returned if the query results in nothing.
	 */
	public function column($db = null)
	{
		return $this->createCommand($db)->queryColumn();
	}

	/**
	 * Returns the number of records.
	 * @param string $q the COUNT expression. Defaults to '*'.
	 * Make sure you properly quote column names in the expression.
261 262
	 * @param Connection $db the database connection used to generate the SQL statement.
	 * If this parameter is not given (or null), the `db` application component will be used.
263 264
	 * @return integer number of records
	 */
265
	public function count($q = '*', $db = null)
266
	{
267
		return $this->queryScalar("COUNT($q)", $db);
268 269 270 271 272 273 274 275 276 277 278 279
	}

	/**
	 * Returns the sum of the specified column values.
	 * @param string $q the column name or expression.
	 * Make sure you properly quote column names in the expression.
	 * @param Connection $db the database connection used to generate the SQL statement.
	 * If this parameter is not given, the `db` application component will be used.
	 * @return integer the sum of the specified column values
	 */
	public function sum($q, $db = null)
	{
280
		return $this->queryScalar("SUM($q)", $db);
281 282 283 284 285 286 287 288 289 290 291 292
	}

	/**
	 * Returns the average of the specified column values.
	 * @param string $q the column name or expression.
	 * Make sure you properly quote column names in the expression.
	 * @param Connection $db the database connection used to generate the SQL statement.
	 * If this parameter is not given, the `db` application component will be used.
	 * @return integer the average of the specified column values.
	 */
	public function average($q, $db = null)
	{
293
		return $this->queryScalar("AVG($q)", $db);
294 295 296 297 298 299 300 301 302 303 304 305
	}

	/**
	 * Returns the minimum of the specified column values.
	 * @param string $q the column name or expression.
	 * Make sure you properly quote column names in the expression.
	 * @param Connection $db the database connection used to generate the SQL statement.
	 * If this parameter is not given, the `db` application component will be used.
	 * @return integer the minimum of the specified column values.
	 */
	public function min($q, $db = null)
	{
306
		return $this->queryScalar("MIN($q)", $db);
307 308 309 310 311 312 313 314 315 316 317 318
	}

	/**
	 * Returns the maximum of the specified column values.
	 * @param string $q the column name or expression.
	 * Make sure you properly quote column names in the expression.
	 * @param Connection $db the database connection used to generate the SQL statement.
	 * If this parameter is not given, the `db` application component will be used.
	 * @return integer the maximum of the specified column values.
	 */
	public function max($q, $db = null)
	{
319
		return $this->queryScalar("MAX($q)", $db);
320 321 322 323 324 325 326 327 328
	}

	/**
	 * Returns a value indicating whether the query result contains any row of data.
	 * @param Connection $db the database connection used to generate the SQL statement.
	 * If this parameter is not given, the `db` application component will be used.
	 * @return boolean whether the query result contains any row of data.
	 */
	public function exists($db = null)
329
	{
330 331 332 333 334
		$select = $this->select;
		$this->select = [new Expression('1')];
		$command = $this->createCommand($db);
		$this->select = $select;
		return $command->queryScalar() !== false;
335 336 337 338 339 340 341 342 343 344
	}

	/**
	 * Queries a scalar value by setting [[select]] first.
	 * Restores the value of select to make this query reusable.
	 * @param string|Expression $selectExpression
	 * @param Connection $db
	 * @return bool|string
	 */
	private function queryScalar($selectExpression, $db)
345
	{
Carsten Brandt committed
346
		$select = $this->select;
347 348 349
		$limit = $this->limit;
		$offset = $this->offset;

350
		$this->select = [$selectExpression];
351 352
		$this->limit = null;
		$this->offset = null;
Carsten Brandt committed
353
		$command = $this->createCommand($db);
354

Carsten Brandt committed
355
		$this->select = $select;
356 357 358
		$this->limit = $limit;
		$this->offset = $offset;

359
		return $command->queryScalar();
360 361
	}

Qiang Xue committed
362
	/**
Qiang Xue committed
363 364
	 * Sets the SELECT part of the query.
	 * @param string|array $columns the columns to be selected.
Alexander Makarov committed
365
	 * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
Qiang Xue committed
366 367 368
	 * Columns can contain table prefixes (e.g. "tbl_user.id") and/or column aliases (e.g. "tbl_user.id AS user_id").
	 * The method will automatically quote the column names unless a column contains some parenthesis
	 * (which means the column contains a DB expression).
369 370 371
	 *
	 * Note that if you are selecting an expression like `CONCAT(first_name, ' ', last_name)`, you should
	 * use an array to specify the columns. Otherwise, the expression may be incorrectly split into several parts.
372 373 374
	 *
	 * When the columns are specified as an array, you may also use array keys as the column aliases (if a column
	 * does not need alias, do not use a string key).
375
	 * 
Qiang Xue committed
376 377
	 * @param string $option additional option that should be appended to the 'SELECT' keyword. For example,
	 * in MySQL, the option 'SQL_CALC_FOUND_ROWS' can be used.
378
	 * @return static the query object itself
Qiang Xue committed
379 380 381
	 */
	public function select($columns, $option = null)
	{
Qiang Xue committed
382 383 384
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
Qiang Xue committed
385 386 387 388 389 390 391 392
		$this->select = $columns;
		$this->selectOption = $option;
		return $this;
	}

	/**
	 * Sets the value indicating whether to SELECT DISTINCT or not.
	 * @param bool $value whether to SELECT DISTINCT or not.
393
	 * @return static the query object itself
Qiang Xue committed
394 395 396 397 398 399 400 401 402 403
	 */
	public function distinct($value = true)
	{
		$this->distinct = $value;
		return $this;
	}

	/**
	 * Sets the FROM part of the query.
	 * @param string|array $tables the table(s) to be selected from. This can be either a string (e.g. `'tbl_user'`)
Alexander Makarov committed
404
	 * or an array (e.g. `['tbl_user', 'tbl_profile']`) specifying one or several table names.
Qiang Xue committed
405 406 407
	 * Table names can contain schema prefixes (e.g. `'public.tbl_user'`) and/or table aliases (e.g. `'tbl_user u'`).
	 * The method will automatically quote the table names unless it contains some parenthesis
	 * (which means the table is given as a sub-query or DB expression).
408 409 410 411 412 413 414
	 *
	 * When the tables are specified as an array, you may also use the array keys as the table aliases
	 * (if a table does not need alias, do not use a string key).
	 *
	 * Use a Query object to represent a sub-query. In this case, the corresponding array key will be used
	 * as the alias for the sub-query.
	 *
415
	 * @return static the query object itself
Qiang Xue committed
416 417 418
	 */
	public function from($tables)
	{
Qiang Xue committed
419 420 421
		if (!is_array($tables)) {
			$tables = preg_split('/\s*,\s*/', trim($tables), -1, PREG_SPLIT_NO_EMPTY);
		}
Qiang Xue committed
422 423 424 425 426 427 428 429 430 431 432 433 434
		$this->from = $tables;
		return $this;
	}

	/**
	 * Sets the WHERE part of the query.
	 *
	 * The method requires a $condition parameter, and optionally a $params parameter
	 * specifying the values to be bound to the query.
	 *
	 * The $condition parameter should be either a string (e.g. 'id=1') or an array.
	 * If the latter, it must be in one of the following two formats:
	 *
Alexander Makarov committed
435 436
	 * - hash format: `['column1' => value1, 'column2' => value2, ...]`
	 * - operator format: `[operator, operand1, operand2, ...]`
Qiang Xue committed
437 438 439 440 441 442
	 *
	 * A condition in hash format represents the following SQL expression in general:
	 * `column1=value1 AND column2=value2 AND ...`. In case when a value is an array,
	 * an `IN` expression will be generated. And if a value is null, `IS NULL` will be used
	 * in the generated expression. Below are some examples:
	 *
Alexander Makarov committed
443 444 445
	 * - `['type' => 1, 'status' => 2]` generates `(type = 1) AND (status = 2)`.
	 * - `['id' => [1, 2, 3], 'status' => 2]` generates `(id IN (1, 2, 3)) AND (status = 2)`.
	 * - `['status' => null] generates `status IS NULL`.
Qiang Xue committed
446 447 448 449 450
	 *
	 * A condition in operator format generates the SQL expression according to the specified operator, which
	 * can be one of the followings:
	 *
	 * - `and`: the operands should be concatenated together using `AND`. For example,
Alexander Makarov committed
451
	 * `['and', 'id=1', 'id=2']` will generate `id=1 AND id=2`. If an operand is an array,
Qiang Xue committed
452
	 * it will be converted into a string using the rules described here. For example,
Alexander Makarov committed
453
	 * `['and', 'type=1', ['or', 'id=1', 'id=2']]` will generate `type=1 AND (id=1 OR id=2)`.
Qiang Xue committed
454 455 456 457 458 459
	 * The method will NOT do any quoting or escaping.
	 *
	 * - `or`: similar to the `and` operator except that the operands are concatenated using `OR`.
	 *
	 * - `between`: operand 1 should be the column name, and operand 2 and 3 should be the
	 * starting and ending values of the range that the column is in.
Alexander Makarov committed
460
	 * For example, `['between', 'id', 1, 10]` will generate `id BETWEEN 1 AND 10`.
Qiang Xue committed
461 462 463 464 465 466
	 *
	 * - `not between`: similar to `between` except the `BETWEEN` is replaced with `NOT BETWEEN`
	 * in the generated condition.
	 *
	 * - `in`: operand 1 should be a column or DB expression, and operand 2 be an array representing
	 * the range of the values that the column or DB expression should be in. For example,
Alexander Makarov committed
467
	 * `['in', 'id', [1, 2, 3]]` will generate `id IN (1, 2, 3)`.
Qiang Xue committed
468 469 470 471 472 473
	 * The method will properly quote the column name and escape values in the range.
	 *
	 * - `not in`: similar to the `in` operator except that `IN` is replaced with `NOT IN` in the generated condition.
	 *
	 * - `like`: operand 1 should be a column or DB expression, and operand 2 be a string or an array representing
	 * the values that the column or DB expression should be like.
474
	 * For example, `['like', 'name', 'tester']` will generate `name LIKE '%tester%'`.
Qiang Xue committed
475
	 * When the value range is given as an array, multiple `LIKE` predicates will be generated and concatenated
476
	 * using `AND`. For example, `['like', 'name', ['test', 'sample']]` will generate
Qiang Xue committed
477
	 * `name LIKE '%test%' AND name LIKE '%sample%'`.
478 479 480
	 * The method will properly quote the column name and escape special characters in the values.
	 * Sometimes, you may want to add the percentage characters to the matching value by yourself, you may supply
	 * a third operand `false` to do so. For example, `['like', 'name', '%tester', false]` will generate `name LIKE '%tester'`.
Qiang Xue committed
481 482 483 484 485 486 487 488 489 490
	 *
	 * - `or like`: similar to the `like` operator except that `OR` is used to concatenate the `LIKE`
	 * predicates when operand 2 is an array.
	 *
	 * - `not like`: similar to the `like` operator except that `LIKE` is replaced with `NOT LIKE`
	 * in the generated condition.
	 *
	 * - `or not like`: similar to the `not like` operator except that `OR` is used to concatenate
	 * the `NOT LIKE` predicates.
	 *
491 492 493 494 495
	 * - `exists`: requires one operand which must be an instance of [[Query]] representing the sub-query.
	 * It will build a `EXISTS (sub-query)` expression.
	 *
	 * - `not exists`: similar to the `exists` operator and builds a `NOT EXISTS (sub-query)` expression.
	 *
Qiang Xue committed
496
	 * @param string|array $condition the conditions that should be put in the WHERE part.
resurtm committed
497
	 * @param array $params the parameters (name => value) to be bound to the query.
498
	 * @return static the query object itself
Qiang Xue committed
499 500
	 * @see andWhere()
	 * @see orWhere()
Qiang Xue committed
501
	 */
Alexander Makarov committed
502
	public function where($condition, $params = [])
Qiang Xue committed
503
	{
Qiang Xue committed
504 505 506 507 508 509 510 511 512 513
		$this->where = $condition;
		$this->addParams($params);
		return $this;
	}

	/**
	 * Adds an additional WHERE condition to the existing one.
	 * The new condition and the existing one will be joined using the 'AND' operator.
	 * @param string|array $condition the new WHERE condition. Please refer to [[where()]]
	 * on how to specify this parameter.
resurtm committed
514
	 * @param array $params the parameters (name => value) to be bound to the query.
515
	 * @return static the query object itself
Qiang Xue committed
516 517 518
	 * @see where()
	 * @see orWhere()
	 */
Alexander Makarov committed
519
	public function andWhere($condition, $params = [])
Qiang Xue committed
520 521 522 523
	{
		if ($this->where === null) {
			$this->where = $condition;
		} else {
Alexander Makarov committed
524
			$this->where = ['and', $this->where, $condition];
Qiang Xue committed
525
		}
Qiang Xue committed
526 527
		$this->addParams($params);
		return $this;
Qiang Xue committed
528 529
	}

Qiang Xue committed
530
	/**
Qiang Xue committed
531 532 533 534
	 * Adds an additional WHERE condition to the existing one.
	 * The new condition and the existing one will be joined using the 'OR' operator.
	 * @param string|array $condition the new WHERE condition. Please refer to [[where()]]
	 * on how to specify this parameter.
resurtm committed
535
	 * @param array $params the parameters (name => value) to be bound to the query.
536
	 * @return static the query object itself
Qiang Xue committed
537 538
	 * @see where()
	 * @see andWhere()
Qiang Xue committed
539
	 */
Alexander Makarov committed
540
	public function orWhere($condition, $params = [])
Qiang Xue committed
541
	{
Qiang Xue committed
542 543 544
		if ($this->where === null) {
			$this->where = $condition;
		} else {
Alexander Makarov committed
545
			$this->where = ['or', $this->where, $condition];
Qiang Xue committed
546 547
		}
		$this->addParams($params);
Qiang Xue committed
548 549 550 551
		return $this;
	}

	/**
Qiang Xue committed
552 553 554
	 * Appends a JOIN part to the query.
	 * The first parameter specifies what type of join it is.
	 * @param string $type the type of join, such as INNER JOIN, LEFT JOIN.
555 556 557
	 * @param string|array $table the table to be joined.
	 *
	 * Use string to represent the name of the table to be joined.
Qiang Xue committed
558 559 560
	 * Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u').
	 * The method will automatically quote the table name unless it contains some parenthesis
	 * (which means the table is given as a sub-query or DB expression).
561 562 563 564 565
	 *
	 * Use array to represent joining with a sub-query. The array must contain only one element.
	 * The value must be a Query object representing the sub-query while the corresponding key
	 * represents the alias for the sub-query.
	 *
Qiang Xue committed
566
	 * @param string|array $on the join condition that should appear in the ON part.
Qiang Xue committed
567
	 * Please refer to [[where()]] on how to specify this parameter.
resurtm committed
568
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
569 570
	 * @return Query the query object itself
	 */
Alexander Makarov committed
571
	public function join($type, $table, $on = '', $params = [])
Qiang Xue committed
572
	{
Alexander Makarov committed
573
		$this->join[] = [$type, $table, $on];
Qiang Xue committed
574
		return $this->addParams($params);
Qiang Xue committed
575 576 577
	}

	/**
Qiang Xue committed
578
	 * Appends an INNER JOIN part to the query.
579 580 581
	 * @param string|array $table the table to be joined.
	 *
	 * Use string to represent the name of the table to be joined.
Qiang Xue committed
582 583 584
	 * Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u').
	 * The method will automatically quote the table name unless it contains some parenthesis
	 * (which means the table is given as a sub-query or DB expression).
585 586 587 588 589
	 *
	 * Use array to represent joining with a sub-query. The array must contain only one element.
	 * The value must be a Query object representing the sub-query while the corresponding key
	 * represents the alias for the sub-query.
	 *
Qiang Xue committed
590
	 * @param string|array $on the join condition that should appear in the ON part.
Qiang Xue committed
591
	 * Please refer to [[where()]] on how to specify this parameter.
resurtm committed
592
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
593 594
	 * @return Query the query object itself
	 */
Alexander Makarov committed
595
	public function innerJoin($table, $on = '', $params = [])
Qiang Xue committed
596
	{
Alexander Makarov committed
597
		$this->join[] = ['INNER JOIN', $table, $on];
Qiang Xue committed
598
		return $this->addParams($params);
Qiang Xue committed
599 600 601
	}

	/**
Qiang Xue committed
602
	 * Appends a LEFT OUTER JOIN part to the query.
603 604 605
	 * @param string|array $table the table to be joined.
	 *
	 * Use string to represent the name of the table to be joined.
Qiang Xue committed
606 607 608
	 * Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u').
	 * The method will automatically quote the table name unless it contains some parenthesis
	 * (which means the table is given as a sub-query or DB expression).
609 610 611 612 613
	 *
	 * Use array to represent joining with a sub-query. The array must contain only one element.
	 * The value must be a Query object representing the sub-query while the corresponding key
	 * represents the alias for the sub-query.
	 *
Qiang Xue committed
614 615
	 * @param string|array $on the join condition that should appear in the ON part.
	 * Please refer to [[where()]] on how to specify this parameter.
resurtm committed
616
	 * @param array $params the parameters (name => value) to be bound to the query
Qiang Xue committed
617 618
	 * @return Query the query object itself
	 */
Alexander Makarov committed
619
	public function leftJoin($table, $on = '', $params = [])
Qiang Xue committed
620
	{
Alexander Makarov committed
621
		$this->join[] = ['LEFT JOIN', $table, $on];
Qiang Xue committed
622 623 624 625 626
		return $this->addParams($params);
	}

	/**
	 * Appends a RIGHT OUTER JOIN part to the query.
627 628 629
	 * @param string|array $table the table to be joined.
	 *
	 * Use string to represent the name of the table to be joined.
Qiang Xue committed
630 631 632
	 * Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u').
	 * The method will automatically quote the table name unless it contains some parenthesis
	 * (which means the table is given as a sub-query or DB expression).
633 634 635 636 637
	 *
	 * Use array to represent joining with a sub-query. The array must contain only one element.
	 * The value must be a Query object representing the sub-query while the corresponding key
	 * represents the alias for the sub-query.
	 *
Qiang Xue committed
638 639
	 * @param string|array $on the join condition that should appear in the ON part.
	 * Please refer to [[where()]] on how to specify this parameter.
resurtm committed
640
	 * @param array $params the parameters (name => value) to be bound to the query
Qiang Xue committed
641 642
	 * @return Query the query object itself
	 */
Alexander Makarov committed
643
	public function rightJoin($table, $on = '', $params = [])
Qiang Xue committed
644
	{
Alexander Makarov committed
645
		$this->join[] = ['RIGHT JOIN', $table, $on];
Qiang Xue committed
646 647 648 649 650 651
		return $this->addParams($params);
	}

	/**
	 * Sets the GROUP BY part of the query.
	 * @param string|array $columns the columns to be grouped by.
Alexander Makarov committed
652
	 * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
Qiang Xue committed
653 654
	 * The method will automatically quote the column names unless a column contains some parenthesis
	 * (which means the column contains a DB expression).
655
	 * @return static the query object itself
Qiang Xue committed
656
	 * @see addGroupBy()
Qiang Xue committed
657 658 659
	 */
	public function groupBy($columns)
	{
Qiang Xue committed
660 661 662
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
Qiang Xue committed
663
		$this->groupBy = $columns;
Qiang Xue committed
664 665 666 667
		return $this;
	}

	/**
Qiang Xue committed
668 669
	 * Adds additional group-by columns to the existing ones.
	 * @param string|array $columns additional columns to be grouped by.
Alexander Makarov committed
670
	 * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
Qiang Xue committed
671 672
	 * The method will automatically quote the column names unless a column contains some parenthesis
	 * (which means the column contains a DB expression).
673
	 * @return static the query object itself
Qiang Xue committed
674
	 * @see groupBy()
Qiang Xue committed
675
	 */
Qiang Xue committed
676
	public function addGroupBy($columns)
Qiang Xue committed
677
	{
Qiang Xue committed
678 679 680 681
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
		if ($this->groupBy === null) {
Qiang Xue committed
682 683 684 685
			$this->groupBy = $columns;
		} else {
			$this->groupBy = array_merge($this->groupBy, $columns);
		}
Qiang Xue committed
686 687 688 689
		return $this;
	}

	/**
Qiang Xue committed
690 691 692
	 * Sets the HAVING part of the query.
	 * @param string|array $condition the conditions to be put after HAVING.
	 * Please refer to [[where()]] on how to specify this parameter.
resurtm committed
693
	 * @param array $params the parameters (name => value) to be bound to the query.
694
	 * @return static the query object itself
Qiang Xue committed
695 696
	 * @see andHaving()
	 * @see orHaving()
Qiang Xue committed
697
	 */
Alexander Makarov committed
698
	public function having($condition, $params = [])
Qiang Xue committed
699
	{
Qiang Xue committed
700 701
		$this->having = $condition;
		$this->addParams($params);
Qiang Xue committed
702
		return $this;
w  
Qiang Xue committed
703 704
	}

Qiang Xue committed
705
	/**
Qiang Xue committed
706 707 708 709
	 * Adds an additional HAVING condition to the existing one.
	 * The new condition and the existing one will be joined using the 'AND' operator.
	 * @param string|array $condition the new HAVING condition. Please refer to [[where()]]
	 * on how to specify this parameter.
resurtm committed
710
	 * @param array $params the parameters (name => value) to be bound to the query.
711
	 * @return static the query object itself
Qiang Xue committed
712 713
	 * @see having()
	 * @see orHaving()
Qiang Xue committed
714
	 */
Alexander Makarov committed
715
	public function andHaving($condition, $params = [])
Qiang Xue committed
716
	{
Qiang Xue committed
717 718 719
		if ($this->having === null) {
			$this->having = $condition;
		} else {
Alexander Makarov committed
720
			$this->having = ['and', $this->having, $condition];
Qiang Xue committed
721 722
		}
		$this->addParams($params);
Qiang Xue committed
723 724 725 726
		return $this;
	}

	/**
Qiang Xue committed
727 728 729 730
	 * Adds an additional HAVING condition to the existing one.
	 * The new condition and the existing one will be joined using the 'OR' operator.
	 * @param string|array $condition the new HAVING condition. Please refer to [[where()]]
	 * on how to specify this parameter.
resurtm committed
731
	 * @param array $params the parameters (name => value) to be bound to the query.
732
	 * @return static the query object itself
Qiang Xue committed
733 734
	 * @see having()
	 * @see andHaving()
Qiang Xue committed
735
	 */
Alexander Makarov committed
736
	public function orHaving($condition, $params = [])
Qiang Xue committed
737
	{
Qiang Xue committed
738 739 740
		if ($this->having === null) {
			$this->having = $condition;
		} else {
Alexander Makarov committed
741
			$this->having = ['or', $this->having, $condition];
Qiang Xue committed
742 743
		}
		$this->addParams($params);
Qiang Xue committed
744 745 746 747
		return $this;
	}

	/**
Qiang Xue committed
748 749
	 * Appends a SQL statement using UNION operator.
	 * @param string|Query $sql the SQL statement to be appended using UNION
Ivan Pomortsev committed
750
	 * @param bool $all TRUE if using UNION ALL and FALSE if using UNION
751
	 * @return static the query object itself
Qiang Xue committed
752
	 */
Ivan Pomortsev committed
753
	public function union($sql, $all = false)
Qiang Xue committed
754
	{
Ivan Pomortsev committed
755
		$this->union[] = [ 'query' => $sql, 'all' => $all ];
Qiang Xue committed
756 757 758 759
		return $this;
	}

	/**
Qiang Xue committed
760 761
	 * Sets the parameters to be bound to the query.
	 * @param array $params list of query parameter values indexed by parameter placeholders.
Alexander Makarov committed
762
	 * For example, `[':name' => 'Dan', ':age' => 31]`.
763
	 * @return static the query object itself
Qiang Xue committed
764
	 * @see addParams()
Qiang Xue committed
765
	 */
Qiang Xue committed
766
	public function params($params)
Qiang Xue committed
767
	{
Qiang Xue committed
768
		$this->params = $params;
Qiang Xue committed
769 770 771 772
		return $this;
	}

	/**
Qiang Xue committed
773 774
	 * Adds additional parameters to be bound to the query.
	 * @param array $params list of query parameter values indexed by parameter placeholders.
Alexander Makarov committed
775
	 * For example, `[':name' => 'Dan', ':age' => 31]`.
776
	 * @return static the query object itself
Qiang Xue committed
777
	 * @see params()
Qiang Xue committed
778
	 */
Qiang Xue committed
779
	public function addParams($params)
Qiang Xue committed
780
	{
781
		if (!empty($params)) {
782
			if (empty($this->params)) {
Qiang Xue committed
783 784 785 786 787 788 789 790 791 792 793
				$this->params = $params;
			} else {
				foreach ($params as $name => $value) {
					if (is_integer($name)) {
						$this->params[] = $value;
					} else {
						$this->params[$name] = $value;
					}
				}
			}
		}
Qiang Xue committed
794 795
		return $this;
	}
w  
Qiang Xue committed
796
}