Query.php 24.3 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 98
	 * @var array this is used to construct the UNION clause(s) in a SQL statement.
	 * Each array element can be either a string or a [[Query]] object representing a sub-query.
Qiang Xue committed
99 100 101 102
	 */
	public $union;
	/**
	 * @var array list of query parameter values indexed by parameter placeholders.
Alexander Makarov committed
103
	 * For example, `[':name' => 'Dan', ':age' => 31]`.
Qiang Xue committed
104 105
	 */
	public $params;
Qiang Xue committed
106

Qiang Xue committed
107 108

	/**
Qiang Xue committed
109 110
	 * 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
111
	 * If this parameter is not given, the `db` application component will be used.
Qiang Xue committed
112
	 * @return Command the created DB command instance.
Qiang Xue committed
113
	 */
Qiang Xue committed
114
	public function createCommand($db = null)
Qiang Xue committed
115
	{
Qiang Xue committed
116
		if ($db === null) {
117
			$db = Yii::$app->getDb();
Qiang Xue committed
118
		}
119 120
		list ($sql, $params) = $db->getQueryBuilder()->build($this);
		return $db->createCommand($sql, $params);
Qiang Xue committed
121 122
	}

123 124 125 126 127 128 129 130
	/**
	 * 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
131 132 133 134
		$rows = $this->createCommand($db)->queryAll();
		if ($this->indexBy === null) {
			return $rows;
		}
Alexander Makarov committed
135
		$result = [];
Qiang Xue committed
136 137 138 139 140 141 142 143 144
		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;
145 146 147 148 149 150
	}

	/**
	 * 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.
151
	 * @return array|boolean the first row (in terms of an array) of the query result. False is returned if the query
152 153 154 155
	 * results in nothing.
	 */
	public function one($db = null)
	{
156
		return $this->createCommand($db)->queryOne();
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
	}

	/**
	 * 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.
187 188
	 * @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.
189 190
	 * @return integer number of records
	 */
191
	public function count($q = '*', $db = null)
192
	{
193
		return $this->queryScalar("COUNT($q)", $db);
194 195 196 197 198 199 200 201 202 203 204 205
	}

	/**
	 * 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)
	{
206
		return $this->queryScalar("SUM($q)", $db);
207 208 209 210 211 212 213 214 215 216 217 218
	}

	/**
	 * 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)
	{
219
		return $this->queryScalar("AVG($q)", $db);
220 221 222 223 224 225 226 227 228 229 230 231
	}

	/**
	 * 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)
	{
232
		return $this->queryScalar("MIN($q)", $db);
233 234 235 236 237 238 239 240 241 242 243 244
	}

	/**
	 * 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)
	{
245
		return $this->queryScalar("MAX($q)", $db);
246 247 248 249 250 251 252 253 254
	}

	/**
	 * 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)
255
	{
256 257 258 259 260
		$select = $this->select;
		$this->select = [new Expression('1')];
		$command = $this->createCommand($db);
		$this->select = $select;
		return $command->queryScalar() !== false;
261 262 263 264 265 266 267 268 269 270
	}

	/**
	 * 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)
271
	{
Carsten Brandt committed
272
		$select = $this->select;
273 274 275
		$limit = $this->limit;
		$offset = $this->offset;

276
		$this->select = [$selectExpression];
277 278
		$this->limit = null;
		$this->offset = null;
Carsten Brandt committed
279
		$command = $this->createCommand($db);
280

Carsten Brandt committed
281
		$this->select = $select;
282 283 284
		$this->limit = $limit;
		$this->offset = $offset;

285
		return $command->queryScalar();
286 287
	}

Qiang Xue committed
288
	/**
Qiang Xue committed
289 290
	 * Sets the SELECT part of the query.
	 * @param string|array $columns the columns to be selected.
Alexander Makarov committed
291
	 * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
Qiang Xue committed
292 293 294
	 * 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).
295 296 297 298
	 *
	 * 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.
	 * 
Qiang Xue committed
299 300
	 * @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.
301
	 * @return static the query object itself
Qiang Xue committed
302 303 304
	 */
	public function select($columns, $option = null)
	{
Qiang Xue committed
305 306 307
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
Qiang Xue committed
308 309 310 311 312 313 314 315
		$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.
316
	 * @return static the query object itself
Qiang Xue committed
317 318 319 320 321 322 323 324 325 326
	 */
	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
327
	 * or an array (e.g. `['tbl_user', 'tbl_profile']`) specifying one or several table names.
Qiang Xue committed
328 329 330
	 * 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).
331
	 * @return static the query object itself
Qiang Xue committed
332 333 334
	 */
	public function from($tables)
	{
Qiang Xue committed
335 336 337
		if (!is_array($tables)) {
			$tables = preg_split('/\s*,\s*/', trim($tables), -1, PREG_SPLIT_NO_EMPTY);
		}
Qiang Xue committed
338 339 340 341 342 343 344 345 346 347 348 349 350
		$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
351 352
	 * - hash format: `['column1' => value1, 'column2' => value2, ...]`
	 * - operator format: `[operator, operand1, operand2, ...]`
Qiang Xue committed
353 354 355 356 357 358
	 *
	 * 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
359 360 361
	 * - `['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
362 363 364 365 366
	 *
	 * 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
367
	 * `['and', 'id=1', 'id=2']` will generate `id=1 AND id=2`. If an operand is an array,
Qiang Xue committed
368
	 * it will be converted into a string using the rules described here. For example,
Alexander Makarov committed
369
	 * `['and', 'type=1', ['or', 'id=1', 'id=2']]` will generate `type=1 AND (id=1 OR id=2)`.
Qiang Xue committed
370 371 372 373 374 375
	 * 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
376
	 * For example, `['between', 'id', 1, 10]` will generate `id BETWEEN 1 AND 10`.
Qiang Xue committed
377 378 379 380 381 382
	 *
	 * - `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
383
	 * `['in', 'id', [1, 2, 3]]` will generate `id IN (1, 2, 3)`.
Qiang Xue committed
384 385 386 387 388 389
	 * 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.
390
	 * For example, `['like', 'name', 'tester']` will generate `name LIKE '%tester%'`.
Qiang Xue committed
391
	 * When the value range is given as an array, multiple `LIKE` predicates will be generated and concatenated
392
	 * using `AND`. For example, `['like', 'name', ['test', 'sample']]` will generate
Qiang Xue committed
393
	 * `name LIKE '%test%' AND name LIKE '%sample%'`.
394 395 396
	 * 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
397 398 399 400 401 402 403 404 405 406 407
	 *
	 * - `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.
	 *
	 * @param string|array $condition the conditions that should be put in the WHERE part.
resurtm committed
408
	 * @param array $params the parameters (name => value) to be bound to the query.
409
	 * @return static the query object itself
Qiang Xue committed
410 411
	 * @see andWhere()
	 * @see orWhere()
Qiang Xue committed
412
	 */
Alexander Makarov committed
413
	public function where($condition, $params = [])
Qiang Xue committed
414
	{
Qiang Xue committed
415 416 417 418 419 420 421 422 423 424
		$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
425
	 * @param array $params the parameters (name => value) to be bound to the query.
426
	 * @return static the query object itself
Qiang Xue committed
427 428 429
	 * @see where()
	 * @see orWhere()
	 */
Alexander Makarov committed
430
	public function andWhere($condition, $params = [])
Qiang Xue committed
431 432 433 434
	{
		if ($this->where === null) {
			$this->where = $condition;
		} else {
Alexander Makarov committed
435
			$this->where = ['and', $this->where, $condition];
Qiang Xue committed
436
		}
Qiang Xue committed
437 438
		$this->addParams($params);
		return $this;
Qiang Xue committed
439 440
	}

Qiang Xue committed
441
	/**
Qiang Xue committed
442 443 444 445
	 * 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
446
	 * @param array $params the parameters (name => value) to be bound to the query.
447
	 * @return static the query object itself
Qiang Xue committed
448 449
	 * @see where()
	 * @see andWhere()
Qiang Xue committed
450
	 */
Alexander Makarov committed
451
	public function orWhere($condition, $params = [])
Qiang Xue committed
452
	{
Qiang Xue committed
453 454 455
		if ($this->where === null) {
			$this->where = $condition;
		} else {
Alexander Makarov committed
456
			$this->where = ['or', $this->where, $condition];
Qiang Xue committed
457 458
		}
		$this->addParams($params);
Qiang Xue committed
459 460 461 462
		return $this;
	}

	/**
Qiang Xue committed
463 464 465 466 467 468 469 470
	 * 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.
	 * @param string $table the table to be joined.
	 * 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).
	 * @param string|array $on the join condition that should appear in the ON part.
Qiang Xue committed
471
	 * Please refer to [[where()]] on how to specify this parameter.
resurtm committed
472
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
473 474
	 * @return Query the query object itself
	 */
Alexander Makarov committed
475
	public function join($type, $table, $on = '', $params = [])
Qiang Xue committed
476
	{
Alexander Makarov committed
477
		$this->join[] = [$type, $table, $on];
Qiang Xue committed
478
		return $this->addParams($params);
Qiang Xue committed
479 480 481
	}

	/**
Qiang Xue committed
482 483 484 485 486 487
	 * Appends an INNER JOIN part to the query.
	 * @param string $table the table to be joined.
	 * 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).
	 * @param string|array $on the join condition that should appear in the ON part.
Qiang Xue committed
488
	 * Please refer to [[where()]] on how to specify this parameter.
resurtm committed
489
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
490 491
	 * @return Query the query object itself
	 */
Alexander Makarov committed
492
	public function innerJoin($table, $on = '', $params = [])
Qiang Xue committed
493
	{
Alexander Makarov committed
494
		$this->join[] = ['INNER JOIN', $table, $on];
Qiang Xue committed
495
		return $this->addParams($params);
Qiang Xue committed
496 497 498
	}

	/**
Qiang Xue committed
499 500 501 502 503 504 505
	 * Appends a LEFT OUTER JOIN part to the query.
	 * @param string $table the table to be joined.
	 * 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).
	 * @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
506
	 * @param array $params the parameters (name => value) to be bound to the query
Qiang Xue committed
507 508
	 * @return Query the query object itself
	 */
Alexander Makarov committed
509
	public function leftJoin($table, $on = '', $params = [])
Qiang Xue committed
510
	{
Alexander Makarov committed
511
		$this->join[] = ['LEFT JOIN', $table, $on];
Qiang Xue committed
512 513 514 515 516 517 518 519 520 521 522
		return $this->addParams($params);
	}

	/**
	 * Appends a RIGHT OUTER JOIN part to the query.
	 * @param string $table the table to be joined.
	 * 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).
	 * @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
523
	 * @param array $params the parameters (name => value) to be bound to the query
Qiang Xue committed
524 525
	 * @return Query the query object itself
	 */
Alexander Makarov committed
526
	public function rightJoin($table, $on = '', $params = [])
Qiang Xue committed
527
	{
Alexander Makarov committed
528
		$this->join[] = ['RIGHT JOIN', $table, $on];
Qiang Xue committed
529 530 531 532 533 534
		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
535
	 * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
Qiang Xue committed
536 537
	 * The method will automatically quote the column names unless a column contains some parenthesis
	 * (which means the column contains a DB expression).
538
	 * @return static the query object itself
Qiang Xue committed
539
	 * @see addGroupBy()
Qiang Xue committed
540 541 542
	 */
	public function groupBy($columns)
	{
Qiang Xue committed
543 544 545
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
Qiang Xue committed
546
		$this->groupBy = $columns;
Qiang Xue committed
547 548 549 550
		return $this;
	}

	/**
Qiang Xue committed
551 552
	 * Adds additional group-by columns to the existing ones.
	 * @param string|array $columns additional columns to be grouped by.
Alexander Makarov committed
553
	 * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
Qiang Xue committed
554 555
	 * The method will automatically quote the column names unless a column contains some parenthesis
	 * (which means the column contains a DB expression).
556
	 * @return static the query object itself
Qiang Xue committed
557
	 * @see groupBy()
Qiang Xue committed
558
	 */
Qiang Xue committed
559
	public function addGroupBy($columns)
Qiang Xue committed
560
	{
Qiang Xue committed
561 562 563 564
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
		if ($this->groupBy === null) {
Qiang Xue committed
565 566 567 568
			$this->groupBy = $columns;
		} else {
			$this->groupBy = array_merge($this->groupBy, $columns);
		}
Qiang Xue committed
569 570 571 572
		return $this;
	}

	/**
Qiang Xue committed
573 574 575
	 * 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
576
	 * @param array $params the parameters (name => value) to be bound to the query.
577
	 * @return static the query object itself
Qiang Xue committed
578 579
	 * @see andHaving()
	 * @see orHaving()
Qiang Xue committed
580
	 */
Alexander Makarov committed
581
	public function having($condition, $params = [])
Qiang Xue committed
582
	{
Qiang Xue committed
583 584
		$this->having = $condition;
		$this->addParams($params);
Qiang Xue committed
585
		return $this;
w  
Qiang Xue committed
586 587
	}

Qiang Xue committed
588
	/**
Qiang Xue committed
589 590 591 592
	 * 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
593
	 * @param array $params the parameters (name => value) to be bound to the query.
594
	 * @return static the query object itself
Qiang Xue committed
595 596
	 * @see having()
	 * @see orHaving()
Qiang Xue committed
597
	 */
Alexander Makarov committed
598
	public function andHaving($condition, $params = [])
Qiang Xue committed
599
	{
Qiang Xue committed
600 601 602
		if ($this->having === null) {
			$this->having = $condition;
		} else {
Alexander Makarov committed
603
			$this->having = ['and', $this->having, $condition];
Qiang Xue committed
604 605
		}
		$this->addParams($params);
Qiang Xue committed
606 607 608 609
		return $this;
	}

	/**
Qiang Xue committed
610 611 612 613
	 * 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
614
	 * @param array $params the parameters (name => value) to be bound to the query.
615
	 * @return static the query object itself
Qiang Xue committed
616 617
	 * @see having()
	 * @see andHaving()
Qiang Xue committed
618
	 */
Alexander Makarov committed
619
	public function orHaving($condition, $params = [])
Qiang Xue committed
620
	{
Qiang Xue committed
621 622 623
		if ($this->having === null) {
			$this->having = $condition;
		} else {
Alexander Makarov committed
624
			$this->having = ['or', $this->having, $condition];
Qiang Xue committed
625 626
		}
		$this->addParams($params);
Qiang Xue committed
627 628 629 630
		return $this;
	}

	/**
Qiang Xue committed
631 632
	 * Appends a SQL statement using UNION operator.
	 * @param string|Query $sql the SQL statement to be appended using UNION
633
	 * @return static the query object itself
Qiang Xue committed
634
	 */
Qiang Xue committed
635
	public function union($sql)
Qiang Xue committed
636
	{
Qiang Xue committed
637
		$this->union[] = $sql;
Qiang Xue committed
638 639 640 641
		return $this;
	}

	/**
Qiang Xue committed
642 643
	 * Sets the parameters to be bound to the query.
	 * @param array $params list of query parameter values indexed by parameter placeholders.
Alexander Makarov committed
644
	 * For example, `[':name' => 'Dan', ':age' => 31]`.
645
	 * @return static the query object itself
Qiang Xue committed
646
	 * @see addParams()
Qiang Xue committed
647
	 */
Qiang Xue committed
648
	public function params($params)
Qiang Xue committed
649
	{
Qiang Xue committed
650
		$this->params = $params;
Qiang Xue committed
651 652 653 654
		return $this;
	}

	/**
Qiang Xue committed
655 656
	 * Adds additional parameters to be bound to the query.
	 * @param array $params list of query parameter values indexed by parameter placeholders.
Alexander Makarov committed
657
	 * For example, `[':name' => 'Dan', ':age' => 31]`.
658
	 * @return static the query object itself
Qiang Xue committed
659
	 * @see params()
Qiang Xue committed
660
	 */
Qiang Xue committed
661
	public function addParams($params)
Qiang Xue committed
662
	{
663
		if (!empty($params)) {
Qiang Xue committed
664 665 666 667 668 669 670 671 672 673 674 675
			if ($this->params === null) {
				$this->params = $params;
			} else {
				foreach ($params as $name => $value) {
					if (is_integer($name)) {
						$this->params[] = $value;
					} else {
						$this->params[$name] = $value;
					}
				}
			}
		}
Qiang Xue committed
676 677
		return $this;
	}
w  
Qiang Xue committed
678
}