QueryBuilder.php 31.2 KB
Newer Older
1 2 3 4 5 6 7 8
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\sphinx;
9

10
use yii\base\InvalidParamException;
11 12
use yii\base\Object;
use yii\db\Exception;
13
use yii\db\Expression;
14 15

/**
16 17 18 19
 * QueryBuilder builds a SELECT SQL statement based on the specification given as a [[Query]] object.
 *
 * QueryBuilder can also be used to build SQL statements such as INSERT, REPLACE, UPDATE, DELETE,
 * from a [[Query]] object.
20 21 22 23
 *
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
24
class QueryBuilder extends Object
25
{
26 27 28
	/**
	 * The prefix for automatically generated query binding parameters.
	 */
29
	const PARAM_PREFIX = ':qp';
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

	/**
	 * @var Connection the Sphinx connection.
	 */
	public $db;
	/**
	 * @var string the separator between different fragments of a SQL statement.
	 * Defaults to an empty space. This is mainly used by [[build()]] when generating a SQL statement.
	 */
	public $separator = " ";

	/**
	 * Constructor.
	 * @param Connection $connection the Sphinx connection.
	 * @param array $config name-value pairs that will be used to initialize the object properties
	 */
	public function __construct($connection, $config = [])
	{
		$this->db = $connection;
		parent::__construct($config);
	}

52 53 54
	/**
	 * Generates a SELECT SQL statement from a [[Query]] object.
	 * @param Query $query the [[Query]] object from which the SQL statement will be generated
55 56
	 * @param array $params the parameters to be bound to the generated SQL statement. These parameters will
	 * be included in the result with the additional parameters generated during the query building process.
57
	 * @return array the generated SQL statement (the first array element) and the corresponding
58 59
	 * parameters to be bound to the SQL statement (the second array element). The parameters returned
	 * include those provided in `$params`.
60
	 */
61
	public function build($query, $params = [])
62
	{
63 64
		$params = empty($params) ? $query->params : array_merge($params, $query->params);

65 66 67 68 69
		if ($query->match !== null) {
			$phName = self::PARAM_PREFIX . count($params);
			$params[$phName] = (string)$query->match;
			$query->andWhere('MATCH(' . $phName . ')');
		}
70 71 72 73 74

		$from = $query->from;
		if ($from === null && $query instanceof ActiveQuery) {
			/** @var ActiveRecord $modelClass */
			$modelClass = $query->modelClass;
75
			$from = [$modelClass::indexName()];
76 77
		}

78
		$clauses = [
79 80
			$this->buildSelect($query->select, $params, $query->distinct, $query->selectOption),
			$this->buildFrom($from, $Params),
81
			$this->buildWhere($query->from, $query->where, $params),
82 83 84 85
			$this->buildGroupBy($query->groupBy),
			$this->buildWithin($query->within),
			$this->buildOrderBy($query->orderBy),
			$this->buildLimit($query->limit, $query->offset),
86
			$this->buildOption($query->options, $params),
87 88 89 90 91
		];
		return [implode($this->separator, array_filter($clauses)), $params];
	}

	/**
92 93 94 95 96 97 98
	 * Creates an INSERT SQL statement.
	 * For example,
	 *
	 * ~~~
	 * $sql = $queryBuilder->insert('idx_user', [
	 *	 'name' => 'Sam',
	 *	 'age' => 30,
99
	 *	 'id' => 10,
100 101 102 103 104 105 106 107
	 * ], $params);
	 * ~~~
	 *
	 * The method will properly escape the index and column names.
	 *
	 * @param string $index the index that new rows will be inserted into.
	 * @param array $columns the column data (name => value) to be inserted into the index.
	 * @param array $params the binding parameters that will be generated by this method.
108
	 * They should be bound to the Sphinx command later.
109
	 * @return string the INSERT SQL
110
	 */
111
	public function insert($index, $columns, &$params)
112 113 114 115 116 117 118 119 120 121 122 123
	{
		return $this->generateInsertReplace('INSERT', $index, $columns, $params);
	}

	/**
	 * Creates an REPLACE SQL statement.
	 * For example,
	 *
	 * ~~~
	 * $sql = $queryBuilder->replace('idx_user', [
	 *	 'name' => 'Sam',
	 *	 'age' => 30,
124
	 *	 'id' => 10,
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
	 * ], $params);
	 * ~~~
	 *
	 * The method will properly escape the index and column names.
	 *
	 * @param string $index the index that new rows will be replaced.
	 * @param array $columns the column data (name => value) to be replaced in the index.
	 * @param array $params the binding parameters that will be generated by this method.
	 * They should be bound to the Sphinx command later.
	 * @return string the INSERT SQL
	 */
	public function replace($index, $columns, &$params)
	{
		return $this->generateInsertReplace('REPLACE', $index, $columns, $params);
	}

	/**
	 * Generates INSERT/REPLACE SQL statement.
	 * @param string $statement statement ot be generated.
	 * @param string $index the affected index name.
	 * @param array $columns the column data (name => value).
	 * @param array $params the binding parameters that will be generated by this method.
	 * @return string generated SQL
	 */
	protected function generateInsertReplace($statement, $index, $columns, &$params)
150
	{
151
		if (($indexSchema = $this->db->getIndexSchema($index)) !== null) {
152
			$indexSchemas = [$indexSchema];
153
		} else {
154
			$indexSchemas = [];
155
		}
156 157 158 159
		$names = [];
		$placeholders = [];
		foreach ($columns as $name => $value) {
			$names[] = $this->db->quoteColumnName($name);
160
			$placeholders[] = $this->composeColumnValue($indexSchemas, $name, $value, $params);
161
		}
162
		return $statement . ' INTO ' . $this->db->quoteIndexName($index)
163 164
			. ' (' . implode(', ', $names) . ') VALUES ('
			. implode(', ', $placeholders) . ')';
165 166 167
	}

	/**
168 169 170 171
	 * Generates a batch INSERT SQL statement.
	 * For example,
	 *
	 * ~~~
172
	 * $sql = $queryBuilder->batchInsert('idx_user', ['id', 'name', 'age'], [
173 174 175
	 *     [1, 'Tom', 30],
	 *     [2, 'Jane', 20],
	 *     [3, 'Linda', 25],
176
	 * ], $params);
177 178 179 180 181 182 183
	 * ~~~
	 *
	 * Note that the values in each row must match the corresponding column names.
	 *
	 * @param string $index the index that new rows will be inserted into.
	 * @param array $columns the column names
	 * @param array $rows the rows to be batch inserted into the index
184
	 * @param array $params the binding parameters that will be generated by this method.
185
	 * They should be bound to the Sphinx command later.
186
	 * @return string the batch INSERT SQL statement
187
	 */
188
	public function batchInsert($index, $columns, $rows, &$params)
189 190 191 192 193 194 195 196 197
	{
		return $this->generateBatchInsertReplace('INSERT', $index, $columns, $rows, $params);
	}

	/**
	 * Generates a batch REPLACE SQL statement.
	 * For example,
	 *
	 * ~~~
198
	 * $sql = $queryBuilder->batchReplace('idx_user', ['id', 'name', 'age'], [
199 200 201
	 *     [1, 'Tom', 30],
	 *     [2, 'Jane', 20],
	 *     [3, 'Linda', 25],
202
	 * ], $params);
203 204 205 206 207 208 209 210
	 * ~~~
	 *
	 * Note that the values in each row must match the corresponding column names.
	 *
	 * @param string $index the index that new rows will be replaced.
	 * @param array $columns the column names
	 * @param array $rows the rows to be batch replaced in the index
	 * @param array $params the binding parameters that will be generated by this method.
211
	 * They should be bound to the Sphinx command later.
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
	 * @return string the batch INSERT SQL statement
	 */
	public function batchReplace($index, $columns, $rows, &$params)
	{
		return $this->generateBatchInsertReplace('REPLACE', $index, $columns, $rows, $params);
	}

	/**
	 * Generates a batch INSERT/REPLACE SQL statement.
	 * @param string $statement statement ot be generated.
	 * @param string $index the affected index name.
	 * @param array $columns the column data (name => value).
	 * @param array $rows the rows to be batch inserted into the index
	 * @param array $params the binding parameters that will be generated by this method.
	 * @return string generated SQL
	 */
	protected function generateBatchInsertReplace($statement, $index, $columns, $rows, &$params)
229
	{
230
		if (($indexSchema = $this->db->getIndexSchema($index)) !== null) {
231
			$indexSchemas = [$indexSchema];
232
		} else {
233
			$indexSchemas = [];
234
		}
235 236 237

		foreach ($columns as $i => $name) {
			$columns[$i] = $this->db->quoteColumnName($name);
238
		}
239 240 241 242 243

		$values = [];
		foreach ($rows as $row) {
			$vs = [];
			foreach ($row as $i => $value) {
244
				$vs[] = $this->composeColumnValue($indexSchemas, $columns[$i], $value, $params);
245 246 247 248
			}
			$values[] = '(' . implode(', ', $vs) . ')';
		}

249
		return $statement . ' INTO ' . $this->db->quoteIndexName($index)
250
			. ' (' . implode(', ', $columns) . ') VALUES ' . implode(', ', $values);
251
	}
252 253

	/**
254
	 * Creates an UPDATE SQL statement.
255 256 257
	 * For example,
	 *
	 * ~~~
258 259
	 * $params = [];
	 * $sql = $queryBuilder->update('idx_user', ['status' => 1], 'age > 30', $params);
260 261
	 * ~~~
	 *
262
	 * The method will properly escape the index and column names.
263
	 *
264 265 266 267 268
	 * @param string $index the index to be updated.
	 * @param array $columns the column data (name => value) to be updated.
	 * @param array|string $condition the condition that will be put in the WHERE part. Please
	 * refer to [[Query::where()]] on how to specify condition.
	 * @param array $params the binding parameters that will be modified by this method
269
	 * so that they can be bound to the Sphinx command later.
270
	 * @param array $options list of options in format: optionName => optionValue
271
	 * @return string the UPDATE SQL
272
	 */
273
	public function update($index, $columns, $condition, &$params, $options)
274
	{
275
		if (($indexSchema = $this->db->getIndexSchema($index)) !== null) {
276
			$indexSchemas = [$indexSchema];
277
		} else {
278
			$indexSchemas = [];
279
		}
280 281

		$lines = [];
282
		foreach ($columns as $name => $value) {
283
			$lines[] = $this->db->quoteColumnName($name) . '=' . $this->composeColumnValue($indexSchemas, $name, $value, $params);
284 285
		}

286
		$sql = 'UPDATE ' . $this->db->quoteIndexName($index) . ' SET ' . implode(', ', $lines);
287
		$where = $this->buildWhere([$index], $condition, $params);
288 289 290 291 292 293 294 295
		if ($where !== '') {
			$sql = $sql . ' ' . $where;
		}
		$option = $this->buildOption($options, $params);
		if ($option !== '') {
			$sql = $sql . ' ' . $option;
		}
		return $sql;
296 297 298 299 300 301 302
	}

	/**
	 * Creates a DELETE SQL statement.
	 * For example,
	 *
	 * ~~~
303
	 * $sql = $queryBuilder->delete('idx_user', 'status = 0');
304 305 306 307 308 309 310 311
	 * ~~~
	 *
	 * The method will properly escape the index and column names.
	 *
	 * @param string $index the index where the data will be deleted from.
	 * @param array|string $condition the condition that will be put in the WHERE part. Please
	 * refer to [[Query::where()]] on how to specify condition.
	 * @param array $params the binding parameters that will be modified by this method
312
	 * so that they can be bound to the Sphinx command later.
313 314 315 316 317
	 * @return string the DELETE SQL
	 */
	public function delete($index, $condition, &$params)
	{
		$sql = 'DELETE FROM ' . $this->db->quoteIndexName($index);
318
		$where = $this->buildWhere([$index], $condition, $params);
319 320 321 322
		return $where === '' ? $sql : $sql . ' ' . $where;
	}

	/**
323
	 * Builds a SQL statement for truncating an index.
324
	 * @param string $index the index to be truncated. The name will be properly quoted by the method.
325
	 * @return string the SQL statement for truncating an index.
326 327 328 329 330 331
	 */
	public function truncateIndex($index)
	{
		return 'TRUNCATE RTINDEX ' . $this->db->quoteIndexName($index);
	}

332 333 334 335 336
	/**
	 * Builds a SQL statement for call snippet from provided data and query, using specified index settings.
	 * @param string $index name of the index, from which to take the text processing settings.
	 * @param string|array $source is the source data to extract a snippet from.
	 * It could be either a single string or array of strings.
337
	 * @param string $match the full-text query to build snippets for.
338 339 340 341 342
	 * @param array $options list of options in format: optionName => optionValue
	 * @param array $params the binding parameters that will be modified by this method
	 * so that they can be bound to the Sphinx command later.
	 * @return string the SQL statement for call snippets.
	 */
343
	public function callSnippets($index, $source, $match, $options, &$params)
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
	{
		if (is_array($source)) {
			$dataSqlParts = [];
			foreach ($source as $sourceRow) {
				$phName = self::PARAM_PREFIX . count($params);
				$params[$phName] = $sourceRow;
				$dataSqlParts[] = $phName;
			}
			$dataSql = '(' . implode(',', $dataSqlParts) . ')';
		} else {
			$phName = self::PARAM_PREFIX . count($params);
			$params[$phName] = $source;
			$dataSql = $phName;
		}
		$indexParamName = self::PARAM_PREFIX . count($params);
		$params[$indexParamName] = $index;
360 361
		$matchParamName = self::PARAM_PREFIX . count($params);
		$params[$matchParamName] = $match;
362 363 364
		if (!empty($options)) {
			$optionParts = [];
			foreach ($options as $name => $value) {
365 366 367 368 369 370 371
				if ($value instanceof Expression) {
					$actualValue = $value->expression;
				} else {
					$actualValue = self::PARAM_PREFIX . count($params);
					$params[$actualValue] = $value;
				}
				$optionParts[] = $actualValue . ' AS ' . $name;
372 373 374 375 376
			}
			$optionSql = ', ' . implode(', ', $optionParts);
		} else {
			$optionSql = '';
		}
377
		return 'CALL SNIPPETS(' . $dataSql. ', ' . $indexParamName . ', ' . $matchParamName . $optionSql. ')';
378 379
	}

380 381 382 383 384 385 386 387 388 389
	/**
	 * Builds a SQL statement for returning tokenized and normalized forms of the keywords, and,
	 * optionally, keyword statistics.
	 * @param string $index the name of the index from which to take the text processing settings
	 * @param string $text the text to break down to keywords.
	 * @param boolean $fetchStatistic whether to return document and hit occurrence statistics
	 * @param array $params the binding parameters that will be modified by this method
	 * so that they can be bound to the Sphinx command later.
	 * @return string the SQL statement for call keywords.
	 */
390 391 392 393 394 395 396 397 398
	public function callKeywords($index, $text, $fetchStatistic, &$params)
	{
		$indexParamName = self::PARAM_PREFIX . count($params);
		$params[$indexParamName] = $index;
		$textParamName = self::PARAM_PREFIX . count($params);
		$params[$textParamName] = $text;
		return 'CALL KEYWORDS(' . $textParamName . ', ' . $indexParamName . ($fetchStatistic ? ', 1' : '') . ')';
	}

399 400
	/**
	 * @param array $columns
401
	 * @param array $params the binding parameters to be populated
402 403 404 405
	 * @param boolean $distinct
	 * @param string $selectOption
	 * @return string the SELECT clause built from [[query]].
	 */
406
	public function buildSelect($columns, &$params, $distinct = false, $selectOption = null)
407 408 409 410 411 412 413 414 415 416 417
	{
		$select = $distinct ? 'SELECT DISTINCT' : 'SELECT';
		if ($selectOption !== null) {
			$select .= ' ' . $selectOption;
		}

		if (empty($columns)) {
			return $select . ' *';
		}

		foreach ($columns as $i => $column) {
418 419 420 421 422 423 424 425
			if ($column instanceof Expression) {
				$columns[$i] = $column->expression;
				$params = array_merge($params, $column->params);
			} elseif (is_string($i)) {
				if (strpos($column, '(') === false) {
					$column = $this->db->quoteColumnName($column);
				}
				$columns[$i] = "$column AS " . $this->db->quoteColumnName($i);;
426 427 428 429 430 431 432 433 434
			} elseif (strpos($column, '(') === false) {
				if (preg_match('/^(.*?)(?i:\s+as\s+|\s+)([\w\-_\.]+)$/', $column, $matches)) {
					$columns[$i] = $this->db->quoteColumnName($matches[1]) . ' AS ' . $this->db->quoteColumnName($matches[2]);
				} else {
					$columns[$i] = $this->db->quoteColumnName($column);
				}
			}
		}

435
		return $select . ' ' . implode(', ', $columns);
436 437 438 439
	}

	/**
	 * @param array $indexes
440
	 * @param array $params the binding parameters to be populated
441 442
	 * @return string the FROM clause built from [[query]].
	 */
443
	public function buildFrom($indexes, &$params)
444 445 446 447 448 449
	{
		if (empty($indexes)) {
			return '';
		}

		foreach ($indexes as $i => $index) {
450 451 452 453 454 455 456 457 458
			if ($index instanceof Query) {
				list($sql, $params) = $this->build($index, $params);
				$indexes[$i] = "($sql) " . $this->db->quoteIndexName($i);
			} elseif (is_string($i)) {
				if (strpos($index, '(') === false) {
					$index = $this->db->quoteIndexName($index);
				}
				$indexes[$i] = "$index " . $this->db->quoteIndexName($i);
			} elseif (strpos($index, '(') === false) {
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
				if (preg_match('/^(.*?)(?i:\s+as|)\s+([^ ]+)$/', $index, $matches)) { // with alias
					$indexes[$i] = $this->db->quoteIndexName($matches[1]) . ' ' . $this->db->quoteIndexName($matches[2]);
				} else {
					$indexes[$i] = $this->db->quoteIndexName($index);
				}
			}
		}

		if (is_array($indexes)) {
			$indexes = implode(', ', $indexes);
		}

		return 'FROM ' . $indexes;
	}

	/**
475
	 * @param string[] $indexes list of index names, which affected by query
476 477 478 479
	 * @param string|array $condition
	 * @param array $params the binding parameters to be populated
	 * @return string the WHERE clause built from [[query]].
	 */
480
	public function buildWhere($indexes, $condition, &$params)
481
	{
482 483 484 485 486 487 488 489 490 491 492 493 494
		if (empty($condition)) {
			return '';
		}
		$indexSchemas = [];
		if (!empty($indexes)) {
			foreach ($indexes as $indexName) {
				$index = $this->db->getIndexSchema($indexName);
				if ($index !== null) {
					$indexSchemas[] = $index;
				}
			}
		}
		$where = $this->buildCondition($indexSchemas, $condition, $params);
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
		return $where === '' ? '' : 'WHERE ' . $where;
	}

	/**
	 * @param array $columns
	 * @return string the GROUP BY clause
	 */
	public function buildGroupBy($columns)
	{
		return empty($columns) ? '' : 'GROUP BY ' . $this->buildColumns($columns);
	}

	/**
	 * @param array $columns
	 * @return string the ORDER BY clause built from [[query]].
	 */
	public function buildOrderBy($columns)
	{
		if (empty($columns)) {
			return '';
		}
		$orders = [];
		foreach ($columns as $name => $direction) {
518 519
			if ($direction instanceof Expression) {
				$orders[] = $direction->expression;
520
			} else {
521
				$orders[] = $this->db->quoteColumnName($name) . ($direction === SORT_DESC ? ' DESC' : 'ASC');
522 523 524 525 526 527 528 529 530 531 532 533 534 535
			}
		}

		return 'ORDER BY ' . implode(', ', $orders);
	}

	/**
	 * @param integer $limit
	 * @param integer $offset
	 * @return string the LIMIT and OFFSET clauses built from [[query]].
	 */
	public function buildLimit($limit, $offset)
	{
		$sql = '';
536 537
		if (is_integer($offset) && $offset > 0 || is_string($offset) && ctype_digit($offset) && $offset !== '0') {
			$sql = 'LIMIT ' . $offset;
538
		}
539 540 541 542
		if (is_string($limit) && ctype_digit($limit) || is_integer($limit) && $limit >= 0) {
			$sql = $sql === '' ? "LIMIT $limit" : "$sql,$limit";
		} elseif ($sql !== '') {
			$sql .= ',1000';  // this is the default limit by sphinx
543
		}
544 545

		return $sql;
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
	}

	/**
	 * Processes columns and properly quote them if necessary.
	 * It will join all columns into a string with comma as separators.
	 * @param string|array $columns the columns to be processed
	 * @return string the processing result
	 */
	public function buildColumns($columns)
	{
		if (!is_array($columns)) {
			if (strpos($columns, '(') !== false) {
				return $columns;
			} else {
				$columns = preg_split('/\s*,\s*/', $columns, -1, PREG_SPLIT_NO_EMPTY);
			}
		}
		foreach ($columns as $i => $column) {
564 565
			if ($column instanceof Expression) {
				$columns[$i] = $column->expression;
566 567 568 569 570 571 572 573 574
			} elseif (strpos($column, '(') === false) {
				$columns[$i] = $this->db->quoteColumnName($column);
			}
		}
		return is_array($columns) ? implode(', ', $columns) : $columns;
	}

	/**
	 * Parses the condition specification and generates the corresponding SQL expression.
575
	 * @param IndexSchema[] $indexes list of indexes, which affected by query
576 577 578 579 580 581
	 * @param string|array $condition the condition specification. Please refer to [[Query::where()]]
	 * on how to specify a condition.
	 * @param array $params the binding parameters to be populated
	 * @return string the generated SQL expression
	 * @throws \yii\db\Exception if the condition is in bad format
	 */
582
	public function buildCondition($indexes, $condition, &$params)
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
	{
		static $builders = [
			'AND' => 'buildAndCondition',
			'OR' => 'buildAndCondition',
			'BETWEEN' => 'buildBetweenCondition',
			'NOT BETWEEN' => 'buildBetweenCondition',
			'IN' => 'buildInCondition',
			'NOT IN' => 'buildInCondition',
			'LIKE' => 'buildLikeCondition',
			'NOT LIKE' => 'buildLikeCondition',
			'OR LIKE' => 'buildLikeCondition',
			'OR NOT LIKE' => 'buildLikeCondition',
		];

		if (!is_array($condition)) {
			return (string)$condition;
		} elseif (empty($condition)) {
			return '';
		}
		if (isset($condition[0])) { // operator format: operator, operand 1, operand 2, ...
			$operator = strtoupper($condition[0]);
			if (isset($builders[$operator])) {
				$method = $builders[$operator];
				array_shift($condition);
607
				return $this->$method($indexes, $operator, $condition, $params);
608 609 610 611
			} else {
				throw new Exception('Found unknown operator in query: ' . $operator);
			}
		} else { // hash format: 'column1' => 'value1', 'column2' => 'value2', ...
612
			return $this->buildHashCondition($indexes, $condition, $params);
613 614 615 616 617
		}
	}

	/**
	 * Creates a condition based on column-value pairs.
618
	 * @param IndexSchema[] $indexes list of indexes, which affected by query
619 620 621 622
	 * @param array $condition the condition specification.
	 * @param array $params the binding parameters to be populated
	 * @return string the generated SQL expression
	 */
623
	public function buildHashCondition($indexes, $condition, &$params)
624 625 626 627
	{
		$parts = [];
		foreach ($condition as $column => $value) {
			if (is_array($value)) { // IN condition
628
				$parts[] = $this->buildInCondition($indexes, 'IN', [$column, $value], $params);
629 630
			} else {
				if (strpos($column, '(') === false) {
631 632 633
					$quotedColumn = $this->db->quoteColumnName($column);
				} else {
					$quotedColumn = $column;
634 635
				}
				if ($value === null) {
636
					$parts[] = "$quotedColumn IS NULL";
637
				} else {
638
					$parts[] = $quotedColumn . '=' . $this->composeColumnValue($indexes, $column, $value, $params);
639 640 641 642 643 644 645 646
				}
			}
		}
		return count($parts) === 1 ? $parts[0] : '(' . implode(') AND (', $parts) . ')';
	}

	/**
	 * Connects two or more SQL expressions with the `AND` or `OR` operator.
647
	 * @param IndexSchema[] $indexes list of indexes, which affected by query
648 649 650 651 652
	 * @param string $operator the operator to use for connecting the given operands
	 * @param array $operands the SQL expressions to connect.
	 * @param array $params the binding parameters to be populated
	 * @return string the generated SQL expression
	 */
653
	public function buildAndCondition($indexes, $operator, $operands, &$params)
654 655 656 657
	{
		$parts = [];
		foreach ($operands as $operand) {
			if (is_array($operand)) {
658
				$operand = $this->buildCondition($indexes, $operand, $params);
659 660 661 662 663 664 665 666 667 668 669 670 671 672
			}
			if ($operand !== '') {
				$parts[] = $operand;
			}
		}
		if (!empty($parts)) {
			return '(' . implode(") $operator (", $parts) . ')';
		} else {
			return '';
		}
	}

	/**
	 * Creates an SQL expressions with the `BETWEEN` operator.
673
	 * @param IndexSchema[] $indexes list of indexes, which affected by query
674 675 676 677 678 679 680
	 * @param string $operator the operator to use (e.g. `BETWEEN` or `NOT BETWEEN`)
	 * @param array $operands the first operand is the column name. The second and third operands
	 * describe the interval that column value should be in.
	 * @param array $params the binding parameters to be populated
	 * @return string the generated SQL expression
	 * @throws Exception if wrong number of operands have been given.
	 */
681
	public function buildBetweenCondition($indexes, $operator, $operands, &$params)
682 683 684 685 686 687 688 689
	{
		if (!isset($operands[0], $operands[1], $operands[2])) {
			throw new Exception("Operator '$operator' requires three operands.");
		}

		list($column, $value1, $value2) = $operands;

		if (strpos($column, '(') === false) {
690 691 692
			$quotedColumn = $this->db->quoteColumnName($column);
		} else {
			$quotedColumn = $column;
693
		}
694 695
		$phName1 = $this->composeColumnValue($indexes, $column, $value1, $params);
		$phName2 = $this->composeColumnValue($indexes, $column, $value2, $params);
696

697
		return "$quotedColumn $operator $phName1 AND $phName2";
698 699 700 701
	}

	/**
	 * Creates an SQL expressions with the `IN` operator.
702
	 * @param IndexSchema[] $indexes list of indexes, which affected by query
703 704 705 706 707 708 709 710 711 712
	 * @param string $operator the operator to use (e.g. `IN` or `NOT IN`)
	 * @param array $operands the first operand is the column name. If it is an array
	 * a composite IN condition will be generated.
	 * The second operand is an array of values that column value should be among.
	 * If it is an empty array the generated expression will be a `false` value if
	 * operator is `IN` and empty if operator is `NOT IN`.
	 * @param array $params the binding parameters to be populated
	 * @return string the generated SQL expression
	 * @throws Exception if wrong number of operands have been given.
	 */
713
	public function buildInCondition($indexes, $operator, $operands, &$params)
714 715 716 717 718 719 720 721 722 723 724 725 726 727
	{
		if (!isset($operands[0], $operands[1])) {
			throw new Exception("Operator '$operator' requires two operands.");
		}

		list($column, $values) = $operands;

		$values = (array)$values;

		if (empty($values) || $column === []) {
			return $operator === 'IN' ? '0=1' : '';
		}

		if (count($column) > 1) {
728
			return $this->buildCompositeInCondition($indexes, $operator, $column, $values, $params);
729 730 731 732 733 734 735
		} elseif (is_array($column)) {
			$column = reset($column);
		}
		foreach ($values as $i => $value) {
			if (is_array($value)) {
				$value = isset($value[$column]) ? $value[$column] : null;
			}
736
			$values[$i] = $this->composeColumnValue($indexes, $column, $value, $params);
737 738 739 740 741 742 743 744 745
		}
		if (strpos($column, '(') === false) {
			$column = $this->db->quoteColumnName($column);
		}

		if (count($values) > 1) {
			return "$column $operator (" . implode(', ', $values) . ')';
		} else {
			$operator = $operator === 'IN' ? '=' : '<>';
746
			return $column . $operator . reset($values);
747 748 749
		}
	}

750 751 752 753 754 755 756 757 758
	/**
	 * @param IndexSchema[] $indexes list of indexes, which affected by query
	 * @param string $operator the operator to use (e.g. `IN` or `NOT IN`)
	 * @param array $columns
	 * @param array $values
	 * @param array $params the binding parameters to be populated
	 * @return string the generated SQL expression
	 */
	protected function buildCompositeInCondition($indexes, $operator, $columns, $values, &$params)
759 760 761 762 763 764
	{
		$vss = [];
		foreach ($values as $value) {
			$vs = [];
			foreach ($columns as $column) {
				if (isset($value[$column])) {
765
					$vs[] = $this->composeColumnValue($indexes, $column, $value[$column], $params);
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
				} else {
					$vs[] = 'NULL';
				}
			}
			$vss[] = '(' . implode(', ', $vs) . ')';
		}
		foreach ($columns as $i => $column) {
			if (strpos($column, '(') === false) {
				$columns[$i] = $this->db->quoteColumnName($column);
			}
		}
		return '(' . implode(', ', $columns) . ") $operator (" . implode(', ', $vss) . ')';
	}

	/**
	 * Creates an SQL expressions with the `LIKE` operator.
782
	 * @param IndexSchema[] $indexes list of indexes, which affected by query
783
	 * @param string $operator the operator to use (e.g. `LIKE`, `NOT LIKE`, `OR LIKE` or `OR NOT LIKE`)
784 785 786 787 788 789 790 791 792 793 794 795 796
	 * @param array $operands an array of two or three operands
	 *
	 * - The first operand is the column name.
	 * - The second operand is a single value or an array of values that column value
	 *   should be compared with. If it is an empty array the generated expression will
	 *   be a `false` value if operator is `LIKE` or `OR LIKE`, and empty if operator
	 *   is `NOT LIKE` or `OR NOT LIKE`.
	 * - An optional third operand can also be provided to specify how to escape special characters
	 *   in the value(s). The operand should be an array of mappings from the special characters to their
	 *   escaped counterparts. If this operand is not provided, a default escape mapping will be used.
	 *   You may use `false` or an empty array to indicate the values are already escaped and no escape
	 *   should be applied. Note that when using an escape mapping (or the third operand is not provided),
	 *   the values will be automatically enclosed within a pair of percentage characters.
797 798
	 * @param array $params the binding parameters to be populated
	 * @return string the generated SQL expression
799
	 * @throws InvalidParamException if wrong number of operands have been given.
800
	 */
801
	public function buildLikeCondition($indexes, $operator, $operands, &$params)
802 803
	{
		if (!isset($operands[0], $operands[1])) {
804
			throw new InvalidParamException("Operator '$operator' requires two operands.");
805 806
		}

807 808 809
		$escape = isset($operands[2]) ? $operands[2] : ['%'=>'\%', '_'=>'\_', '\\'=>'\\\\'];
		unset($operands[2]);

810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
		list($column, $values) = $operands;

		$values = (array)$values;

		if (empty($values)) {
			return $operator === 'LIKE' || $operator === 'OR LIKE' ? '0=1' : '';
		}

		if ($operator === 'LIKE' || $operator === 'NOT LIKE') {
			$andor = ' AND ';
		} else {
			$andor = ' OR ';
			$operator = $operator === 'OR LIKE' ? 'LIKE' : 'NOT LIKE';
		}

		if (strpos($column, '(') === false) {
			$column = $this->db->quoteColumnName($column);
		}

		$parts = [];
		foreach ($values as $value) {
			$phName = self::PARAM_PREFIX . count($params);
832
			$params[$phName] = empty($escape) ? $value : ('%' . strtr($value, $escape) . '%');
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
			$parts[] = "$column $operator $phName";
		}

		return implode($andor, $parts);
	}

	/**
	 * @param array $columns
	 * @return string the ORDER BY clause built from [[query]].
	 */
	public function buildWithin($columns)
	{
		if (empty($columns)) {
			return '';
		}
		$orders = [];
		foreach ($columns as $name => $direction) {
850 851
			if ($direction instanceof Expression) {
				$orders[] = $direction->expression;
852
			} else {
Paul Klimov committed
853
				$orders[] = $this->db->quoteColumnName($name) . ($direction === SORT_DESC ? ' DESC' : '');
854 855 856 857 858 859
			}
		}
		return 'WITHIN GROUP ORDER BY ' . implode(', ', $orders);
	}

	/**
860 861
	 * @param array $options query options in format: optionName => optionValue
	 * @param array $params the binding parameters to be populated
862 863
	 * @return string the OPTION clause build from [[query]]
	 */
864
	public function buildOption($options, &$params)
865 866 867 868 869 870
	{
		if (empty($options)) {
			return '';
		}
		$optionLines = [];
		foreach ($options as $name => $value) {
871 872 873
			if ($value instanceof Expression) {
				$actualValue = $value->expression;
			} else {
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
				if (is_array($value)) {
					$actualValueParts = [];
					foreach ($value as $key => $valuePart) {
						if (is_numeric($key)) {
							$actualValuePart = '';
						} else {
							$actualValuePart = $key . ' = ';
						}
						if ($valuePart instanceof Expression) {
							$actualValuePart .= $valuePart->expression;
						} else {
							$phName = self::PARAM_PREFIX . count($params);
							$params[$phName] = $valuePart;
							$actualValuePart .= $phName;
						}
						$actualValueParts[] = $actualValuePart;
					}
					$actualValue = '(' . implode(', ', $actualValueParts) . ')';
				} else {
					$actualValue = self::PARAM_PREFIX . count($params);
					$params[$actualValue] = $value;
				}
896 897
			}
			$optionLines[] = $name . ' = ' . $actualValue;
898 899
		}
		return 'OPTION ' . implode(', ', $optionLines);
900
	}
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942

	/**
	 * Composes column value for SQL, taking in account the column type.
	 * @param IndexSchema[] $indexes list of indexes, which affected by query
	 * @param string $columnName name of the column
	 * @param mixed $value raw column value
	 * @param array $params the binding parameters to be populated
	 * @return string SQL expression, which represents column value
	 */
	protected function composeColumnValue($indexes, $columnName, $value, &$params) {
		if ($value === null) {
			return 'NULL';
		} elseif ($value instanceof Expression) {
			$params = array_merge($params, $value->params);
			return $value->expression;
		}
		foreach ($indexes as $index) {
			$columnSchema = $index->getColumn($columnName);
			if ($columnSchema !== null) {
				break;
			}
		}
		if (is_array($value)) {
			// MVA :
			$lineParts = [];
			foreach ($value as $subValue) {
				if ($subValue instanceof Expression) {
					$params = array_merge($params, $subValue->params);
					$lineParts[] = $subValue->expression;
				} else {
					$phName = self::PARAM_PREFIX . count($params);
					$lineParts[] = $phName;
					$params[$phName] = (isset($columnSchema)) ? $columnSchema->typecast($subValue) : $subValue;
				}
			}
			return '(' . implode(',', $lineParts) . ')';
		} else {
			$phName = self::PARAM_PREFIX . count($params);
			$params[$phName] = (isset($columnSchema)) ? $columnSchema->typecast($value) : $value;
			return $phName;
		}
	}
943
}