Query.php 21.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

/**
Qiang Xue committed
11
 * Query represents a SELECT SQL statement in a way that is independent of DBMS.
Qiang Xue committed
12
 *
Qiang Xue committed
13 14
 * 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
15
 *
Qiang Xue committed
16 17 18 19
 * 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
20 21 22 23 24 25
 *
 * ~~~
 * $query = new Query;
 * $query->select('id, name')
 *     ->from('tbl_user')
 *     ->limit(10);
Qiang Xue committed
26
 * // build and execute the query
Qiang Xue committed
27 28 29
 * $command = $query->createCommand();
 * // $command->sql returns the actual SQL
 * $rows = $command->queryAll();
Qiang Xue committed
30 31
 * ~~~
 *
w  
Qiang Xue committed
32 33 34
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
Qiang Xue committed
35
class Query extends \yii\base\Component
w  
Qiang Xue committed
36
{
Qiang Xue committed
37
	/**
Qiang Xue committed
38 39 40 41 42 43 44 45 46 47 48 49 50
	 * 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
51 52 53 54 55 56 57 58 59 60 61 62 63 64
	 * @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
65 66
	 * @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
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
	 * @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
86 87 88 89
	 * @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
90
	 */
Qiang Xue committed
91
	public $orderBy;
Qiang Xue committed
92
	/**
Qiang Xue committed
93 94
	 * @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
95
	 */
Qiang Xue committed
96 97
	public $groupBy;
	/**
Qiang Xue committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
	 * @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
113 114 115 116 117 118 119 120
	 */
	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
121 122
	 * @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
123 124 125 126 127 128 129
	 */
	public $union;
	/**
	 * @var array list of query parameter values indexed by parameter placeholders.
	 * For example, `array(':name'=>'Dan', ':age'=>31)`.
	 */
	public $params;
Qiang Xue committed
130 131

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

	/**
Qiang Xue committed
147 148 149 150 151 152 153 154 155 156 157 158
	 * 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
159 160 161
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
Qiang Xue committed
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 187 188
		$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
189 190 191
		if (!is_array($tables)) {
			$tables = preg_split('/\s*,\s*/', trim($tables), -1, PREG_SPLIT_NO_EMPTY);
		}
Qiang Xue committed
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
		$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:
	 *
	 * - `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`.
	 *
	 * 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,
	 * `array('in', 'id', array(1,2,3))` will generate `id IN (1,2,3)`.
	 * 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.
	 * @param array $params the parameters (name=>value) to be bound to the query.
	 * @return Query the query object itself
	 * @see andWhere()
	 * @see orWhere()
Qiang Xue committed
264
	 */
Qiang Xue committed
265
	public function where($condition, $params = array())
Qiang Xue committed
266
	{
Qiang Xue committed
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
		$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.
	 * @param array $params the parameters (name=>value) to be bound to the query.
	 * @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
288
		}
Qiang Xue committed
289 290
		$this->addParams($params);
		return $this;
Qiang Xue committed
291 292
	}

Qiang Xue committed
293
	/**
Qiang Xue committed
294 295 296 297 298
	 * 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.
	 * @param array $params the parameters (name=>value) to be bound to the query.
Qiang Xue committed
299
	 * @return Query the query object itself
Qiang Xue committed
300 301
	 * @see where()
	 * @see andWhere()
Qiang Xue committed
302
	 */
Qiang Xue committed
303
	public function orWhere($condition, $params = array())
Qiang Xue committed
304
	{
Qiang Xue committed
305 306 307 308 309 310
		if ($this->where === null) {
			$this->where = $condition;
		} else {
			$this->where = array('or', $this->where, $condition);
		}
		$this->addParams($params);
Qiang Xue committed
311 312 313 314
		return $this;
	}

	/**
Qiang Xue committed
315 316 317 318 319 320 321 322
	 * 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
323
	 * Please refer to [[where()]] on how to specify this parameter.
Qiang Xue committed
324
	 * @param array $params the parameters (name=>value) to be bound to the query.
Qiang Xue committed
325 326
	 * @return Query the query object itself
	 */
Qiang Xue committed
327
	public function join($type, $table, $on = '', $params = array())
Qiang Xue committed
328
	{
Qiang Xue committed
329 330
		$this->join[] = array($type, $table, $on);
		return $this->addParams($params);
Qiang Xue committed
331 332 333
	}

	/**
Qiang Xue committed
334 335 336 337 338 339
	 * 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
340
	 * Please refer to [[where()]] on how to specify this parameter.
Qiang Xue committed
341
	 * @param array $params the parameters (name=>value) to be bound to the query.
Qiang Xue committed
342 343
	 * @return Query the query object itself
	 */
Qiang Xue committed
344
	public function innerJoin($table, $on = '', $params = array())
Qiang Xue committed
345
	{
Qiang Xue committed
346 347
		$this->join[] = array('INNER JOIN', $table, $on);
		return $this->addParams($params);
Qiang Xue committed
348 349 350
	}

	/**
Qiang Xue committed
351 352 353 354 355 356 357 358
	 * 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.
	 * @param array $params the parameters (name=>value) to be bound to the query
Qiang Xue committed
359 360
	 * @return Query the query object itself
	 */
Qiang Xue committed
361
	public function leftJoin($table, $on = '', $params = array())
Qiang Xue committed
362
	{
Qiang Xue committed
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
		$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.
	 * @param array $params the parameters (name=>value) to be bound to the query
	 * @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
391
	 * @see addGroupBy()
Qiang Xue committed
392 393 394
	 */
	public function groupBy($columns)
	{
Qiang Xue committed
395 396 397
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
Qiang Xue committed
398
		$this->groupBy = $columns;
Qiang Xue committed
399 400 401 402
		return $this;
	}

	/**
Qiang Xue committed
403 404 405 406 407
	 * 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
408
	 * @return Query the query object itself
Qiang Xue committed
409
	 * @see groupBy()
Qiang Xue committed
410
	 */
Qiang Xue committed
411
	public function addGroupBy($columns)
Qiang Xue committed
412
	{
Qiang Xue committed
413 414 415 416
		if (!is_array($columns)) {
			$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
		}
		if ($this->groupBy === null) {
Qiang Xue committed
417 418 419 420
			$this->groupBy = $columns;
		} else {
			$this->groupBy = array_merge($this->groupBy, $columns);
		}
Qiang Xue committed
421 422 423 424
		return $this;
	}

	/**
Qiang Xue committed
425 426 427 428
	 * 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.
	 * @param array $params the parameters (name=>value) to be bound to the query.
Qiang Xue committed
429
	 * @return Query the query object itself
Qiang Xue committed
430 431
	 * @see andHaving()
	 * @see orHaving()
Qiang Xue committed
432
	 */
Qiang Xue committed
433
	public function having($condition, $params = array())
Qiang Xue committed
434
	{
Qiang Xue committed
435 436
		$this->having = $condition;
		$this->addParams($params);
Qiang Xue committed
437
		return $this;
w  
Qiang Xue committed
438 439
	}

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

	/**
Qiang Xue committed
462 463 464 465 466
	 * 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.
	 * @param array $params the parameters (name=>value) to be bound to the query.
Qiang Xue committed
467
	 * @return Query the query object itself
Qiang Xue committed
468 469
	 * @see having()
	 * @see andHaving()
Qiang Xue committed
470
	 */
Qiang Xue committed
471
	public function orHaving($condition, $params = array())
Qiang Xue committed
472
	{
Qiang Xue committed
473 474 475 476 477 478
		if ($this->having === null) {
			$this->having = $condition;
		} else {
			$this->having = array('or', $this->having, $condition);
		}
		$this->addParams($params);
Qiang Xue committed
479 480 481 482
		return $this;
	}

	/**
Qiang Xue committed
483 484
	 * Sets the ORDER BY part of the query.
	 * @param string|array $columns the columns (and the directions) to be ordered by.
Qiang Xue committed
485
	 * Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array
Alexander Makarov committed
486
	 * (e.g. `array('id' => Query::SORT_ASC, 'name' => Query::SORT_DESC)`).
Qiang Xue committed
487 488
	 * 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
489
	 * @return Query the query object itself
Qiang Xue committed
490
	 * @see addOrderBy()
Qiang Xue committed
491
	 */
Qiang Xue committed
492
	public function orderBy($columns)
Qiang Xue committed
493
	{
Qiang Xue committed
494
		$this->orderBy = $this->normalizeOrderBy($columns);
Qiang Xue committed
495 496 497 498
		return $this;
	}

	/**
Qiang Xue committed
499 500
	 * Adds additional ORDER BY columns to the query.
	 * @param string|array $columns the columns (and the directions) to be ordered by.
Qiang Xue committed
501
	 * Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array
Alexander Makarov committed
502
	 * (e.g. `array('id' => Query::SORT_ASC, 'name' => Query::SORT_DESC)`).
Qiang Xue committed
503 504
	 * 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
505
	 * @return Query the query object itself
Qiang Xue committed
506
	 * @see orderBy()
Qiang Xue committed
507
	 */
Qiang Xue committed
508
	public function addOrderBy($columns)
Qiang Xue committed
509
	{
Qiang Xue committed
510 511
		$columns = $this->normalizeOrderBy($columns);
		if ($this->orderBy === null) {
Qiang Xue committed
512 513 514 515
			$this->orderBy = $columns;
		} else {
			$this->orderBy = array_merge($this->orderBy, $columns);
		}
Qiang Xue committed
516 517 518
		return $this;
	}

Qiang Xue committed
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
	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
537
	/**
Qiang Xue committed
538 539
	 * Sets the LIMIT part of the query.
	 * @param integer $limit the limit
Qiang Xue committed
540 541
	 * @return Query the query object itself
	 */
Qiang Xue committed
542
	public function limit($limit)
Qiang Xue committed
543
	{
Qiang Xue committed
544
		$this->limit = $limit;
Qiang Xue committed
545 546 547 548
		return $this;
	}

	/**
Qiang Xue committed
549 550
	 * Sets the OFFSET part of the query.
	 * @param integer $offset the offset
Qiang Xue committed
551 552
	 * @return Query the query object itself
	 */
Qiang Xue committed
553
	public function offset($offset)
Qiang Xue committed
554
	{
Qiang Xue committed
555
		$this->offset = $offset;
Qiang Xue committed
556 557 558 559
		return $this;
	}

	/**
Qiang Xue committed
560 561
	 * Appends a SQL statement using UNION operator.
	 * @param string|Query $sql the SQL statement to be appended using UNION
Qiang Xue committed
562 563
	 * @return Query the query object itself
	 */
Qiang Xue committed
564
	public function union($sql)
Qiang Xue committed
565
	{
Qiang Xue committed
566
		$this->union[] = $sql;
Qiang Xue committed
567 568 569 570
		return $this;
	}

	/**
Qiang Xue committed
571 572 573
	 * Sets the parameters to be bound to the query.
	 * @param array $params list of query parameter values indexed by parameter placeholders.
	 * For example, `array(':name'=>'Dan', ':age'=>31)`.
Qiang Xue committed
574
	 * @return Query the query object itself
Qiang Xue committed
575
	 * @see addParams()
Qiang Xue committed
576
	 */
Qiang Xue committed
577
	public function params($params)
Qiang Xue committed
578
	{
Qiang Xue committed
579
		$this->params = $params;
Qiang Xue committed
580 581 582 583
		return $this;
	}

	/**
Qiang Xue committed
584 585 586
	 * Adds additional parameters to be bound to the query.
	 * @param array $params list of query parameter values indexed by parameter placeholders.
	 * For example, `array(':name'=>'Dan', ':age'=>31)`.
Qiang Xue committed
587
	 * @return Query the query object itself
Qiang Xue committed
588
	 * @see params()
Qiang Xue committed
589
	 */
Qiang Xue committed
590
	public function addParams($params)
Qiang Xue committed
591
	{
592
		if (!empty($params)) {
Qiang Xue committed
593 594 595 596 597 598 599 600 601 602 603 604
			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
605 606
		return $this;
	}
w  
Qiang Xue committed
607
}