Query.php 27.4 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 26 27 28
 *
 * ~~~
 * $query = new Query;
 * $query->select('id, name')
 *     ->from('tbl_user')
 *     ->limit(10);
Qiang Xue committed
29
 * // build and execute the query
Qiang Xue committed
30 31 32
 * $command = $query->createCommand();
 * // $command->sql returns the actual SQL
 * $rows = $command->queryAll();
Qiang Xue committed
33 34
 * ~~~
 *
w  
Qiang Xue committed
35 36 37
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
38
class Query extends Component
w  
Qiang Xue committed
39
{
Qiang Xue committed
40
	/**
Qiang Xue committed
41 42 43 44 45
	 * Sort ascending
	 * @see orderBy
	 */
	const SORT_ASC = false;
	/**
46
	 * Sort descending
Qiang Xue committed
47 48 49 50 51
	 * @see orderBy
	 */
	const SORT_DESC = true;

	/**
Alexander Makarov committed
52
	 * @var array the columns being selected. For example, `['id', 'name']`.
Qiang Xue committed
53
	 * This is used to construct the SELECT clause in a SQL statement. If not set, if means selecting all columns.
Qiang Xue committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67
	 * @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
68
	 * @var array the table(s) to be selected from. For example, `['tbl_user', 'tbl_post']`.
Qiang Xue committed
69
	 * This is used to construct the FROM clause in a SQL statement.
Qiang Xue committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
	 * @see from()
	 */
	public $from;
	/**
	 * @var string|array query condition. This refers to the WHERE clause in a SQL statement.
	 * For example, `age > 31 AND team = 1`.
	 * @see where()
	 */
	public $where;
	/**
	 * @var integer maximum number of records to be returned. If not set or less than 0, it means no limit.
	 */
	public $limit;
	/**
	 * @var integer zero-based offset from where the records are to be returned. If not set or
	 * less than 0, it means starting from the beginning.
	 */
	public $offset;
	/**
Qiang Xue committed
89 90 91 92
	 * @var array how to sort the query results. This is used to construct the ORDER BY clause in a SQL statement.
	 * The array keys are the columns to be sorted by, and the array values are the corresponding sort directions which
	 * can be either [[Query::SORT_ASC]] or [[Query::SORT_DESC]]. The array may also contain [[Expression]] objects.
	 * If that is the case, the expressions will be converted into strings without any change.
Qiang Xue committed
93
	 */
Qiang Xue committed
94
	public $orderBy;
Qiang Xue committed
95
	/**
Alexander Makarov committed
96
	 * @var array how to group the query results. For example, `['company', 'department']`.
Qiang Xue committed
97
	 * This is used to construct the GROUP BY clause in a SQL statement.
Qiang Xue committed
98
	 */
Qiang Xue committed
99 100
	public $groupBy;
	/**
Qiang Xue committed
101 102 103 104
	 * @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
105
	 * [$joinType, $tableName, $joinCondition]
Qiang Xue committed
106 107 108 109 110
	 * ~~~
	 *
	 * For example,
	 *
	 * ~~~
Alexander Makarov committed
111 112 113 114
	 * [
	 *     ['INNER JOIN', 'tbl_user', 'tbl_user.id = author_id'],
	 *     ['LEFT JOIN', 'tbl_team', 'tbl_team.id = team_id'],
	 * ]
Qiang Xue committed
115
	 * ~~~
Qiang Xue committed
116 117 118 119 120 121 122 123
	 */
	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
124 125
	 * @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
126 127 128 129
	 */
	public $union;
	/**
	 * @var array list of query parameter values indexed by parameter placeholders.
Alexander Makarov committed
130
	 * For example, `[':name' => 'Dan', ':age' => 31]`.
Qiang Xue committed
131 132
	 */
	public $params;
Qiang Xue committed
133 134 135 136 137 138 139
	/**
	 * @var string|callable $column the name of the column by which the query results should be indexed by.
	 * This can also be a callable (e.g. anonymous function) that returns the index value based on the given
	 * row data. For more details, see [[indexBy()]]. This property is only used by [[all()]].
	 */
	public $indexBy;

Qiang Xue committed
140 141

	/**
Qiang Xue committed
142 143
	 * 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
144
	 * If this parameter is not given, the `db` application component will be used.
Qiang Xue committed
145
	 * @return Command the created DB command instance.
Qiang Xue committed
146
	 */
Qiang Xue committed
147
	public function createCommand($db = null)
Qiang Xue committed
148
	{
Qiang Xue committed
149
		if ($db === null) {
150
			$db = Yii::$app->getDb();
Qiang Xue committed
151
		}
152 153
		list ($sql, $params) = $db->getQueryBuilder()->build($this);
		return $db->createCommand($sql, $params);
Qiang Xue committed
154 155
	}

Qiang Xue committed
156 157 158 159 160 161 162 163 164 165 166 167 168
	/**
	 * Sets the [[indexBy]] property.
	 * @param string|callable $column the name of the column by which the query results should be indexed by.
	 * This can also be a callable (e.g. anonymous function) that returns the index value based on the given
	 * row data. The signature of the callable should be:
	 *
	 * ~~~
	 * function ($row)
	 * {
	 *     // return the index value corresponding to $row
	 * }
	 * ~~~
	 *
169
	 * @return static the query object itself
Qiang Xue committed
170 171 172 173 174 175 176
	 */
	public function indexBy($column)
	{
		$this->indexBy = $column;
		return $this;
	}

177 178 179 180 181 182 183 184
	/**
	 * 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
185 186 187 188
		$rows = $this->createCommand($db)->queryAll();
		if ($this->indexBy === null) {
			return $rows;
		}
Alexander Makarov committed
189
		$result = [];
Qiang Xue committed
190 191 192 193 194 195 196 197 198
		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;
199 200 201 202 203 204 205 206 207 208 209
	}

	/**
	 * 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.
	 * @return array|boolean the first row (in terms of an array) of the query result. False is returned if the query
	 * results in nothing.
	 */
	public function one($db = null)
	{
210
		return $this->createCommand($db)->queryOne();
211 212 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 238 239 240 241 242 243 244 245 246
	}

	/**
	 * 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.
	 * @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 number of records
	 */
	public function count($q = '*', $db = null)
	{
Alexander Makarov committed
247
		$this->select = ["COUNT($q)"];
248 249 250 251 252 253 254 255 256 257 258 259 260
		return $this->createCommand($db)->queryScalar();
	}

	/**
	 * 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)
	{
Alexander Makarov committed
261
		$this->select = ["SUM($q)"];
262 263 264 265 266 267 268 269 270 271 272 273 274
		return $this->createCommand($db)->queryScalar();
	}

	/**
	 * 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)
	{
Alexander Makarov committed
275
		$this->select = ["AVG($q)"];
276 277 278 279 280 281 282 283 284 285 286 287 288
		return $this->createCommand($db)->queryScalar();
	}

	/**
	 * 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)
	{
Alexander Makarov committed
289
		$this->select = ["MIN($q)"];
290 291 292 293 294 295 296 297 298 299 300 301 302
		return $this->createCommand($db)->queryScalar();
	}

	/**
	 * 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)
	{
Alexander Makarov committed
303
		$this->select = ["MAX($q)"];
304 305 306 307 308 309 310 311 312 313 314
		return $this->createCommand($db)->queryScalar();
	}

	/**
	 * 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)
	{
Alexander Makarov committed
315
		$this->select = [new Expression('1')];
316 317 318
		return $this->scalar($db) !== false;
	}

Qiang Xue committed
319
	/**
Qiang Xue committed
320 321
	 * Sets the SELECT part of the query.
	 * @param string|array $columns the columns to be selected.
Alexander Makarov committed
322
	 * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
Qiang Xue committed
323 324 325 326 327
	 * 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).
	 * @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.
328
	 * @return static the query object itself
Qiang Xue committed
329 330 331
	 */
	public function select($columns, $option = null)
	{
Qiang Xue committed
332 333 334
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
Qiang Xue committed
335 336 337 338 339 340 341 342
		$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.
343
	 * @return static the query object itself
Qiang Xue committed
344 345 346 347 348 349 350 351 352 353
	 */
	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
354
	 * or an array (e.g. `['tbl_user', 'tbl_profile']`) specifying one or several table names.
Qiang Xue committed
355 356 357
	 * 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).
358
	 * @return static the query object itself
Qiang Xue committed
359 360 361
	 */
	public function from($tables)
	{
Qiang Xue committed
362 363 364
		if (!is_array($tables)) {
			$tables = preg_split('/\s*,\s*/', trim($tables), -1, PREG_SPLIT_NO_EMPTY);
		}
Qiang Xue committed
365 366 367 368 369 370 371 372 373 374 375 376 377
		$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
378 379
	 * - hash format: `['column1' => value1, 'column2' => value2, ...]`
	 * - operator format: `[operator, operand1, operand2, ...]`
Qiang Xue committed
380 381 382 383 384 385
	 *
	 * 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
386 387 388
	 * - `['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
389 390 391 392 393
	 *
	 * 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
394
	 * `['and', 'id=1', 'id=2']` will generate `id=1 AND id=2`. If an operand is an array,
Qiang Xue committed
395
	 * it will be converted into a string using the rules described here. For example,
Alexander Makarov committed
396
	 * `['and', 'type=1', ['or', 'id=1', 'id=2']]` will generate `type=1 AND (id=1 OR id=2)`.
Qiang Xue committed
397 398 399 400 401 402
	 * 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
403
	 * For example, `['between', 'id', 1, 10]` will generate `id BETWEEN 1 AND 10`.
Qiang Xue committed
404 405 406 407 408 409
	 *
	 * - `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
410
	 * `['in', 'id', [1, 2, 3]]` will generate `id IN (1, 2, 3)`.
Qiang Xue committed
411 412 413 414 415 416
	 * 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.
Alexander Makarov committed
417
	 * For example, `['like', 'name', '%tester%']` will generate `name LIKE '%tester%'`.
Qiang Xue committed
418
	 * When the value range is given as an array, multiple `LIKE` predicates will be generated and concatenated
Alexander Makarov committed
419
	 * using `AND`. For example, `['like', 'name', ['%test%', '%sample%']]` will generate
Qiang Xue committed
420 421 422 423 424 425 426 427 428 429 430 431 432
	 * `name LIKE '%test%' AND name LIKE '%sample%'`.
	 * The method will properly quote the column name and escape values in the range.
	 *
	 * - `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
433
	 * @param array $params the parameters (name => value) to be bound to the query.
434
	 * @return static the query object itself
Qiang Xue committed
435 436
	 * @see andWhere()
	 * @see orWhere()
Qiang Xue committed
437
	 */
Alexander Makarov committed
438
	public function where($condition, $params = [])
Qiang Xue committed
439
	{
Qiang Xue committed
440 441 442 443 444 445 446 447 448 449
		$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
450
	 * @param array $params the parameters (name => value) to be bound to the query.
451
	 * @return static the query object itself
Qiang Xue committed
452 453 454
	 * @see where()
	 * @see orWhere()
	 */
Alexander Makarov committed
455
	public function andWhere($condition, $params = [])
Qiang Xue committed
456 457 458 459
	{
		if ($this->where === null) {
			$this->where = $condition;
		} else {
Alexander Makarov committed
460
			$this->where = ['and', $this->where, $condition];
Qiang Xue committed
461
		}
Qiang Xue committed
462 463
		$this->addParams($params);
		return $this;
Qiang Xue committed
464 465
	}

Qiang Xue committed
466
	/**
Qiang Xue committed
467 468 469 470
	 * 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
471
	 * @param array $params the parameters (name => value) to be bound to the query.
472
	 * @return static the query object itself
Qiang Xue committed
473 474
	 * @see where()
	 * @see andWhere()
Qiang Xue committed
475
	 */
Alexander Makarov committed
476
	public function orWhere($condition, $params = [])
Qiang Xue committed
477
	{
Qiang Xue committed
478 479 480
		if ($this->where === null) {
			$this->where = $condition;
		} else {
Alexander Makarov committed
481
			$this->where = ['or', $this->where, $condition];
Qiang Xue committed
482 483
		}
		$this->addParams($params);
Qiang Xue committed
484 485 486 487
		return $this;
	}

	/**
Qiang Xue committed
488 489 490 491 492 493 494 495
	 * 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
496
	 * Please refer to [[where()]] on how to specify this parameter.
resurtm committed
497
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
498 499
	 * @return Query the query object itself
	 */
Alexander Makarov committed
500
	public function join($type, $table, $on = '', $params = [])
Qiang Xue committed
501
	{
Alexander Makarov committed
502
		$this->join[] = [$type, $table, $on];
Qiang Xue committed
503
		return $this->addParams($params);
Qiang Xue committed
504 505 506
	}

	/**
Qiang Xue committed
507 508 509 510 511 512
	 * 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
513
	 * 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.
Qiang Xue committed
515 516
	 * @return Query the query object itself
	 */
Alexander Makarov committed
517
	public function innerJoin($table, $on = '', $params = [])
Qiang Xue committed
518
	{
Alexander Makarov committed
519
		$this->join[] = ['INNER JOIN', $table, $on];
Qiang Xue committed
520
		return $this->addParams($params);
Qiang Xue committed
521 522 523
	}

	/**
Qiang Xue committed
524 525 526 527 528 529 530
	 * 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
531
	 * @param array $params the parameters (name => value) to be bound to the query
Qiang Xue committed
532 533
	 * @return Query the query object itself
	 */
Alexander Makarov committed
534
	public function leftJoin($table, $on = '', $params = [])
Qiang Xue committed
535
	{
Alexander Makarov committed
536
		$this->join[] = ['LEFT JOIN', $table, $on];
Qiang Xue committed
537 538 539 540 541 542 543 544 545 546 547
		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
548
	 * @param array $params the parameters (name => value) to be bound to the query
Qiang Xue committed
549 550
	 * @return Query the query object itself
	 */
Alexander Makarov committed
551
	public function rightJoin($table, $on = '', $params = [])
Qiang Xue committed
552
	{
Alexander Makarov committed
553
		$this->join[] = ['RIGHT JOIN', $table, $on];
Qiang Xue committed
554 555 556 557 558 559
		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
560
	 * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
Qiang Xue committed
561 562
	 * The method will automatically quote the column names unless a column contains some parenthesis
	 * (which means the column contains a DB expression).
563
	 * @return static the query object itself
Qiang Xue committed
564
	 * @see addGroupBy()
Qiang Xue committed
565 566 567
	 */
	public function groupBy($columns)
	{
Qiang Xue committed
568 569 570
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
Qiang Xue committed
571
		$this->groupBy = $columns;
Qiang Xue committed
572 573 574 575
		return $this;
	}

	/**
Qiang Xue committed
576 577
	 * Adds additional group-by columns to the existing ones.
	 * @param string|array $columns additional columns to be grouped by.
Alexander Makarov committed
578
	 * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
Qiang Xue committed
579 580
	 * The method will automatically quote the column names unless a column contains some parenthesis
	 * (which means the column contains a DB expression).
581
	 * @return static the query object itself
Qiang Xue committed
582
	 * @see groupBy()
Qiang Xue committed
583
	 */
Qiang Xue committed
584
	public function addGroupBy($columns)
Qiang Xue committed
585
	{
Qiang Xue committed
586 587 588 589
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
		if ($this->groupBy === null) {
Qiang Xue committed
590 591 592 593
			$this->groupBy = $columns;
		} else {
			$this->groupBy = array_merge($this->groupBy, $columns);
		}
Qiang Xue committed
594 595 596 597
		return $this;
	}

	/**
Qiang Xue committed
598 599 600
	 * 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
601
	 * @param array $params the parameters (name => value) to be bound to the query.
602
	 * @return static the query object itself
Qiang Xue committed
603 604
	 * @see andHaving()
	 * @see orHaving()
Qiang Xue committed
605
	 */
Alexander Makarov committed
606
	public function having($condition, $params = [])
Qiang Xue committed
607
	{
Qiang Xue committed
608 609
		$this->having = $condition;
		$this->addParams($params);
Qiang Xue committed
610
		return $this;
w  
Qiang Xue committed
611 612
	}

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

	/**
Qiang Xue committed
635 636 637 638
	 * 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
639
	 * @param array $params the parameters (name => value) to be bound to the query.
640
	 * @return static the query object itself
Qiang Xue committed
641 642
	 * @see having()
	 * @see andHaving()
Qiang Xue committed
643
	 */
Alexander Makarov committed
644
	public function orHaving($condition, $params = [])
Qiang Xue committed
645
	{
Qiang Xue committed
646 647 648
		if ($this->having === null) {
			$this->having = $condition;
		} else {
Alexander Makarov committed
649
			$this->having = ['or', $this->having, $condition];
Qiang Xue committed
650 651
		}
		$this->addParams($params);
Qiang Xue committed
652 653 654 655
		return $this;
	}

	/**
Qiang Xue committed
656 657
	 * Sets the ORDER BY part of the query.
	 * @param string|array $columns the columns (and the directions) to be ordered by.
Qiang Xue committed
658
	 * Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array
Alexander Makarov committed
659
	 * (e.g. `['id' => Query::SORT_ASC, 'name' => Query::SORT_DESC]`).
Qiang Xue committed
660 661
	 * The method will automatically quote the column names unless a column contains some parenthesis
	 * (which means the column contains a DB expression).
662
	 * @return static the query object itself
Qiang Xue committed
663
	 * @see addOrderBy()
Qiang Xue committed
664
	 */
Qiang Xue committed
665
	public function orderBy($columns)
Qiang Xue committed
666
	{
Qiang Xue committed
667
		$this->orderBy = $this->normalizeOrderBy($columns);
Qiang Xue committed
668 669 670 671
		return $this;
	}

	/**
Qiang Xue committed
672 673
	 * Adds additional ORDER BY columns to the query.
	 * @param string|array $columns the columns (and the directions) to be ordered by.
Qiang Xue committed
674
	 * Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array
Alexander Makarov committed
675
	 * (e.g. `['id' => Query::SORT_ASC, 'name' => Query::SORT_DESC]`).
Qiang Xue committed
676 677
	 * The method will automatically quote the column names unless a column contains some parenthesis
	 * (which means the column contains a DB expression).
678
	 * @return static the query object itself
Qiang Xue committed
679
	 * @see orderBy()
Qiang Xue committed
680
	 */
Qiang Xue committed
681
	public function addOrderBy($columns)
Qiang Xue committed
682
	{
Qiang Xue committed
683 684
		$columns = $this->normalizeOrderBy($columns);
		if ($this->orderBy === null) {
Qiang Xue committed
685 686 687 688
			$this->orderBy = $columns;
		} else {
			$this->orderBy = array_merge($this->orderBy, $columns);
		}
Qiang Xue committed
689 690 691
		return $this;
	}

Qiang Xue committed
692 693 694 695 696 697
	protected function normalizeOrderBy($columns)
	{
		if (is_array($columns)) {
			return $columns;
		} else {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
Alexander Makarov committed
698
			$result = [];
Qiang Xue committed
699 700 701 702 703 704 705 706 707 708 709
			foreach ($columns as $column) {
				if (preg_match('/^(.*?)\s+(asc|desc)$/i', $column, $matches)) {
					$result[$matches[1]] = strcasecmp($matches[2], 'desc') ? self::SORT_ASC : self::SORT_DESC;
				} else {
					$result[$column] = self::SORT_ASC;
				}
			}
			return $result;
		}
	}

Qiang Xue committed
710
	/**
Qiang Xue committed
711
	 * Sets the LIMIT part of the query.
712
	 * @param integer $limit the limit. Use null or negative value to disable limit.
713
	 * @return static the query object itself
Qiang Xue committed
714
	 */
Qiang Xue committed
715
	public function limit($limit)
Qiang Xue committed
716
	{
Qiang Xue committed
717
		$this->limit = $limit;
Qiang Xue committed
718 719 720 721
		return $this;
	}

	/**
Qiang Xue committed
722
	 * Sets the OFFSET part of the query.
723
	 * @param integer $offset the offset. Use null or negative value to disable offset.
724
	 * @return static the query object itself
Qiang Xue committed
725
	 */
Qiang Xue committed
726
	public function offset($offset)
Qiang Xue committed
727
	{
Qiang Xue committed
728
		$this->offset = $offset;
Qiang Xue committed
729 730 731 732
		return $this;
	}

	/**
Qiang Xue committed
733 734
	 * Appends a SQL statement using UNION operator.
	 * @param string|Query $sql the SQL statement to be appended using UNION
735
	 * @return static the query object itself
Qiang Xue committed
736
	 */
Qiang Xue committed
737
	public function union($sql)
Qiang Xue committed
738
	{
Qiang Xue committed
739
		$this->union[] = $sql;
Qiang Xue committed
740 741 742 743
		return $this;
	}

	/**
Qiang Xue committed
744 745
	 * Sets the parameters to be bound to the query.
	 * @param array $params list of query parameter values indexed by parameter placeholders.
Alexander Makarov committed
746
	 * For example, `[':name' => 'Dan', ':age' => 31]`.
747
	 * @return static the query object itself
Qiang Xue committed
748
	 * @see addParams()
Qiang Xue committed
749
	 */
Qiang Xue committed
750
	public function params($params)
Qiang Xue committed
751
	{
Qiang Xue committed
752
		$this->params = $params;
Qiang Xue committed
753 754 755 756
		return $this;
	}

	/**
Qiang Xue committed
757 758
	 * Adds additional parameters to be bound to the query.
	 * @param array $params list of query parameter values indexed by parameter placeholders.
Alexander Makarov committed
759
	 * For example, `[':name' => 'Dan', ':age' => 31]`.
760
	 * @return static the query object itself
Qiang Xue committed
761
	 * @see params()
Qiang Xue committed
762
	 */
Qiang Xue committed
763
	public function addParams($params)
Qiang Xue committed
764
	{
765
		if (!empty($params)) {
Qiang Xue committed
766 767 768 769 770 771 772 773 774 775 776 777
			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
778 779
		return $this;
	}
w  
Qiang Xue committed
780
}