Query.php 26.5 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 46 47 48 49 50 51 52 53
	 * Sort ascending
	 * @see orderBy
	 */
	const SORT_ASC = false;
	/**
	 * Sort ascending
	 * @see orderBy
	 */
	const SORT_DESC = true;

	/**
	 * @var array the columns being selected. For example, `array('id', 'name')`.
	 * 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;
	/**
Qiang Xue committed
68 69
	 * @var array the table(s) to be selected from. For example, `array('tbl_user', 'tbl_post')`.
	 * 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
	/**
Qiang Xue committed
96 97
	 * @var array how to group the query results. For example, `array('company', 'department')`.
	 * 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 105 106 107 108 109 110 111 112 113 114 115
	 * @var array how to join with other tables. Each array element represents the specification
	 * of one join which has the following structure:
	 *
	 * ~~~
	 * array($joinType, $tableName, $joinCondition)
	 * ~~~
	 *
	 * For example,
	 *
	 * ~~~
	 * array(
	 *     array('INNER JOIN', 'tbl_user', 'tbl_user.id = author_id'),
	 *     array('LEFT JOIN', 'tbl_team', 'tbl_team.id = team_id'),
	 * )
	 * ~~~
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.
resurtm committed
130
	 * For example, `array(':name' => 'Dan', ':age' => 31)`.
Qiang Xue committed
131 132
	 */
	public $params;
Qiang Xue committed
133 134

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

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
	/**
	 * 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)
	{
		return $this->createCommand($db)->queryAll();
	}

	/**
	 * 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)
	{
169
		return $this->createCommand($db)->queryOne();
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 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 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
	}

	/**
	 * 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)
	{
		$this->select = array("COUNT($q)");
		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)
	{
		$this->select = array("SUM($q)");
		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)
	{
		$this->select = array("AVG($q)");
		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)
	{
		$this->select = array("MIN($q)");
		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)
	{
		$this->select = array("MAX($q)");
		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)
	{
		$this->select = array(new Expression('1'));
		return $this->scalar($db) !== false;
	}

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

Qiang Xue committed
425
	/**
Qiang Xue committed
426 427 428 429
	 * 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
430
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
431
	 * @return Query the query object itself
Qiang Xue committed
432 433
	 * @see where()
	 * @see andWhere()
Qiang Xue committed
434
	 */
Qiang Xue committed
435
	public function orWhere($condition, $params = array())
Qiang Xue committed
436
	{
Qiang Xue committed
437 438 439 440 441 442
		if ($this->where === null) {
			$this->where = $condition;
		} else {
			$this->where = array('or', $this->where, $condition);
		}
		$this->addParams($params);
Qiang Xue committed
443 444 445 446
		return $this;
	}

	/**
Qiang Xue committed
447 448 449 450 451 452 453 454
	 * 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
455
	 * Please refer to [[where()]] on how to specify this parameter.
resurtm committed
456
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
457 458
	 * @return Query the query object itself
	 */
Qiang Xue committed
459
	public function join($type, $table, $on = '', $params = array())
Qiang Xue committed
460
	{
Qiang Xue committed
461 462
		$this->join[] = array($type, $table, $on);
		return $this->addParams($params);
Qiang Xue committed
463 464 465
	}

	/**
Qiang Xue committed
466 467 468 469 470 471
	 * 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
472
	 * Please refer to [[where()]] on how to specify this parameter.
resurtm committed
473
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
474 475
	 * @return Query the query object itself
	 */
Qiang Xue committed
476
	public function innerJoin($table, $on = '', $params = array())
Qiang Xue committed
477
	{
Qiang Xue committed
478 479
		$this->join[] = array('INNER JOIN', $table, $on);
		return $this->addParams($params);
Qiang Xue committed
480 481 482
	}

	/**
Qiang Xue committed
483 484 485 486 487 488 489
	 * 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
490
	 * @param array $params the parameters (name => value) to be bound to the query
Qiang Xue committed
491 492
	 * @return Query the query object itself
	 */
Qiang Xue committed
493
	public function leftJoin($table, $on = '', $params = array())
Qiang Xue committed
494
	{
Qiang Xue committed
495 496 497 498 499 500 501 502 503 504 505 506
		$this->join[] = array('LEFT JOIN', $table, $on);
		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
507
	 * @param array $params the parameters (name => value) to be bound to the query
Qiang Xue committed
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
	 * @return Query the query object itself
	 */
	public function rightJoin($table, $on = '', $params = array())
	{
		$this->join[] = array('RIGHT JOIN', $table, $on);
		return $this->addParams($params);
	}

	/**
	 * Sets the GROUP BY part of the query.
	 * @param string|array $columns the columns to be grouped by.
	 * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. array('id', 'name')).
	 * The method will automatically quote the column names unless a column contains some parenthesis
	 * (which means the column contains a DB expression).
	 * @return Query the query object itself
Qiang Xue committed
523
	 * @see addGroupBy()
Qiang Xue committed
524 525 526
	 */
	public function groupBy($columns)
	{
Qiang Xue committed
527 528 529
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
Qiang Xue committed
530
		$this->groupBy = $columns;
Qiang Xue committed
531 532 533 534
		return $this;
	}

	/**
Qiang Xue committed
535 536 537 538 539
	 * Adds additional group-by columns to the existing ones.
	 * @param string|array $columns additional columns to be grouped by.
	 * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. array('id', 'name')).
	 * The method will automatically quote the column names unless a column contains some parenthesis
	 * (which means the column contains a DB expression).
Qiang Xue committed
540
	 * @return Query the query object itself
Qiang Xue committed
541
	 * @see groupBy()
Qiang Xue committed
542
	 */
Qiang Xue committed
543
	public function addGroupBy($columns)
Qiang Xue committed
544
	{
Qiang Xue committed
545 546 547 548
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
		if ($this->groupBy === null) {
Qiang Xue committed
549 550 551 552
			$this->groupBy = $columns;
		} else {
			$this->groupBy = array_merge($this->groupBy, $columns);
		}
Qiang Xue committed
553 554 555 556
		return $this;
	}

	/**
Qiang Xue committed
557 558 559
	 * 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
560
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
561
	 * @return Query the query object itself
Qiang Xue committed
562 563
	 * @see andHaving()
	 * @see orHaving()
Qiang Xue committed
564
	 */
Qiang Xue committed
565
	public function having($condition, $params = array())
Qiang Xue committed
566
	{
Qiang Xue committed
567 568
		$this->having = $condition;
		$this->addParams($params);
Qiang Xue committed
569
		return $this;
w  
Qiang Xue committed
570 571
	}

Qiang Xue committed
572
	/**
Qiang Xue committed
573 574 575 576
	 * 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
577
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
578
	 * @return Query the query object itself
Qiang Xue committed
579 580
	 * @see having()
	 * @see orHaving()
Qiang Xue committed
581
	 */
Qiang Xue committed
582
	public function andHaving($condition, $params = array())
Qiang Xue committed
583
	{
Qiang Xue committed
584 585 586 587 588 589
		if ($this->having === null) {
			$this->having = $condition;
		} else {
			$this->having = array('and', $this->having, $condition);
		}
		$this->addParams($params);
Qiang Xue committed
590 591 592 593
		return $this;
	}

	/**
Qiang Xue committed
594 595 596 597
	 * 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
598
	 * @param array $params the parameters (name => value) to be bound to the query.
Qiang Xue committed
599
	 * @return Query the query object itself
Qiang Xue committed
600 601
	 * @see having()
	 * @see andHaving()
Qiang Xue committed
602
	 */
Qiang Xue committed
603
	public function orHaving($condition, $params = array())
Qiang Xue committed
604
	{
Qiang Xue committed
605 606 607 608 609 610
		if ($this->having === null) {
			$this->having = $condition;
		} else {
			$this->having = array('or', $this->having, $condition);
		}
		$this->addParams($params);
Qiang Xue committed
611 612 613 614
		return $this;
	}

	/**
Qiang Xue committed
615 616
	 * Sets the ORDER BY part of the query.
	 * @param string|array $columns the columns (and the directions) to be ordered by.
Qiang Xue committed
617
	 * Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array
Alexander Makarov committed
618
	 * (e.g. `array('id' => Query::SORT_ASC, 'name' => Query::SORT_DESC)`).
Qiang Xue committed
619 620
	 * The method will automatically quote the column names unless a column contains some parenthesis
	 * (which means the column contains a DB expression).
Qiang Xue committed
621
	 * @return Query the query object itself
Qiang Xue committed
622
	 * @see addOrderBy()
Qiang Xue committed
623
	 */
Qiang Xue committed
624
	public function orderBy($columns)
Qiang Xue committed
625
	{
Qiang Xue committed
626
		$this->orderBy = $this->normalizeOrderBy($columns);
Qiang Xue committed
627 628 629 630
		return $this;
	}

	/**
Qiang Xue committed
631 632
	 * Adds additional ORDER BY columns to the query.
	 * @param string|array $columns the columns (and the directions) to be ordered by.
Qiang Xue committed
633
	 * Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array
Alexander Makarov committed
634
	 * (e.g. `array('id' => Query::SORT_ASC, 'name' => Query::SORT_DESC)`).
Qiang Xue committed
635 636
	 * The method will automatically quote the column names unless a column contains some parenthesis
	 * (which means the column contains a DB expression).
Qiang Xue committed
637
	 * @return Query the query object itself
Qiang Xue committed
638
	 * @see orderBy()
Qiang Xue committed
639
	 */
Qiang Xue committed
640
	public function addOrderBy($columns)
Qiang Xue committed
641
	{
Qiang Xue committed
642 643
		$columns = $this->normalizeOrderBy($columns);
		if ($this->orderBy === null) {
Qiang Xue committed
644 645 646 647
			$this->orderBy = $columns;
		} else {
			$this->orderBy = array_merge($this->orderBy, $columns);
		}
Qiang Xue committed
648 649 650
		return $this;
	}

Qiang Xue committed
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
	protected function normalizeOrderBy($columns)
	{
		if (is_array($columns)) {
			return $columns;
		} else {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
			$result = array();
			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
669
	/**
Qiang Xue committed
670
	 * Sets the LIMIT part of the query.
671
	 * @param integer $limit the limit. Use null or negative value to disable limit.
Qiang Xue committed
672 673
	 * @return Query the query object itself
	 */
Qiang Xue committed
674
	public function limit($limit)
Qiang Xue committed
675
	{
Qiang Xue committed
676
		$this->limit = $limit;
Qiang Xue committed
677 678 679 680
		return $this;
	}

	/**
Qiang Xue committed
681
	 * Sets the OFFSET part of the query.
682
	 * @param integer $offset the offset. Use null or negative value to disable offset.
Qiang Xue committed
683 684
	 * @return Query the query object itself
	 */
Qiang Xue committed
685
	public function offset($offset)
Qiang Xue committed
686
	{
Qiang Xue committed
687
		$this->offset = $offset;
Qiang Xue committed
688 689 690 691
		return $this;
	}

	/**
Qiang Xue committed
692 693
	 * Appends a SQL statement using UNION operator.
	 * @param string|Query $sql the SQL statement to be appended using UNION
Qiang Xue committed
694 695
	 * @return Query the query object itself
	 */
Qiang Xue committed
696
	public function union($sql)
Qiang Xue committed
697
	{
Qiang Xue committed
698
		$this->union[] = $sql;
Qiang Xue committed
699 700 701 702
		return $this;
	}

	/**
Qiang Xue committed
703 704
	 * Sets the parameters to be bound to the query.
	 * @param array $params list of query parameter values indexed by parameter placeholders.
resurtm committed
705
	 * For example, `array(':name' => 'Dan', ':age' => 31)`.
Qiang Xue committed
706
	 * @return Query the query object itself
Qiang Xue committed
707
	 * @see addParams()
Qiang Xue committed
708
	 */
Qiang Xue committed
709
	public function params($params)
Qiang Xue committed
710
	{
Qiang Xue committed
711
		$this->params = $params;
Qiang Xue committed
712 713 714 715
		return $this;
	}

	/**
Qiang Xue committed
716 717
	 * Adds additional parameters to be bound to the query.
	 * @param array $params list of query parameter values indexed by parameter placeholders.
resurtm committed
718
	 * For example, `array(':name' => 'Dan', ':age' => 31)`.
Qiang Xue committed
719
	 * @return Query the query object itself
Qiang Xue committed
720
	 * @see params()
Qiang Xue committed
721
	 */
Qiang Xue committed
722
	public function addParams($params)
Qiang Xue committed
723
	{
724
		if (!empty($params)) {
Qiang Xue committed
725 726 727 728 729 730 731 732 733 734 735 736
			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
737 738
		return $this;
	}
w  
Qiang Xue committed
739
}