QueryBuilder.php 36.8 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
use yii\base\InvalidParamException;
Qiang Xue committed
11
use yii\base\NotSupportedException;
w  
Qiang Xue committed
12

w  
Qiang Xue committed
13
/**
Qiang Xue committed
14
 * QueryBuilder builds a SELECT SQL statement based on the specification given as a [[Query]] object.
w  
Qiang Xue committed
15
 *
Qiang Xue committed
16
 * QueryBuilder can also be used to build SQL statements such as INSERT, UPDATE, DELETE, CREATE TABLE,
Qiang Xue committed
17 18
 * from a [[Query]] object.
 *
w  
Qiang Xue committed
19 20 21
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
Qiang Xue committed
22
class QueryBuilder extends \yii\base\Object
w  
Qiang Xue committed
23
{
24 25 26 27 28
	/**
	 * The prefix for automatically generated query binding parameters.
	 */
	const PARAM_PREFIX = ':qp';

Qiang Xue committed
29 30 31
	/**
	 * @var Connection the database connection.
	 */
Qiang Xue committed
32
	public $db;
Qiang Xue committed
33 34 35 36 37
	/**
	 * @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 = " ";
Qiang Xue committed
38 39 40 41 42
	/**
	 * @var array the abstract column types mapped to physical column types.
	 * This is mainly used to support creating/modifying tables using DB-independent data type specifications.
	 * Child classes should override this property to declare supported type mappings.
	 */
Alexander Makarov committed
43
	public $typeMap = [];
w  
Qiang Xue committed
44

Qiang Xue committed
45 46
	/**
	 * Constructor.
Qiang Xue committed
47
	 * @param Connection $connection the database connection.
Qiang Xue committed
48
	 * @param array $config name-value pairs that will be used to initialize the object properties
Qiang Xue committed
49
	 */
Alexander Makarov committed
50
	public function __construct($connection, $config = [])
w  
Qiang Xue committed
51
	{
Qiang Xue committed
52
		$this->db = $connection;
Qiang Xue committed
53
		parent::__construct($config);
w  
Qiang Xue committed
54 55
	}

Qiang Xue committed
56
	/**
Qiang Xue committed
57 58
	 * Generates a SELECT SQL statement from a [[Query]] object.
	 * @param Query $query the [[Query]] object from which the SQL statement will be generated
59 60
	 * @return array the generated SQL statement (the first array element) and the corresponding
	 * parameters to be bound to the SQL statement (the second array element).
Qiang Xue committed
61
	 */
w  
Qiang Xue committed
62 63
	public function build($query)
	{
64
		$params = $query->params;
Alexander Makarov committed
65
		$clauses = [
Qiang Xue committed
66 67
			$this->buildSelect($query->select, $query->distinct, $query->selectOption),
			$this->buildFrom($query->from),
68 69
			$this->buildJoin($query->join, $params),
			$this->buildWhere($query->where, $params),
Qiang Xue committed
70
			$this->buildGroupBy($query->groupBy),
71 72
			$this->buildHaving($query->having, $params),
			$this->buildUnion($query->union, $params),
Qiang Xue committed
73
			$this->buildOrderBy($query->orderBy),
Qiang Xue committed
74
			$this->buildLimit($query->limit, $query->offset),
Alexander Makarov committed
75 76
		];
		return [implode($this->separator, array_filter($clauses)), $params];
w  
Qiang Xue committed
77 78 79
	}

	/**
Qiang Xue committed
80
	 * Creates an INSERT SQL statement.
Qiang Xue committed
81 82 83
	 * For example,
	 *
	 * ~~~
Alexander Makarov committed
84
	 * $sql = $queryBuilder->insert('tbl_user', [
Qiang Xue committed
85 86
	 *	 'name' => 'Sam',
	 *	 'age' => 30,
Alexander Makarov committed
87
	 * ], $params);
Qiang Xue committed
88 89
	 * ~~~
	 *
Qiang Xue committed
90 91
	 * The method will properly escape the table and column names.
	 *
w  
Qiang Xue committed
92
	 * @param string $table the table that new rows will be inserted into.
resurtm committed
93
	 * @param array $columns the column data (name => value) to be inserted into the table.
Qiang Xue committed
94 95
	 * @param array $params the binding parameters that will be generated by this method.
	 * They should be bound to the DB command later.
96
	 * @return string the INSERT SQL
w  
Qiang Xue committed
97
	 */
Qiang Xue committed
98
	public function insert($table, $columns, &$params)
w  
Qiang Xue committed
99
	{
100 101 102
		if (($tableSchema = $this->db->getTableSchema($table)) !== null) {
			$columnSchemas = $tableSchema->columns;
		} else {
Alexander Makarov committed
103
			$columnSchemas = [];
104
		}
Alexander Makarov committed
105 106
		$names = [];
		$placeholders = [];
w  
Qiang Xue committed
107
		foreach ($columns as $name => $value) {
Qiang Xue committed
108
			$names[] = $this->db->quoteColumnName($name);
w  
Qiang Xue committed
109 110 111 112 113
			if ($value instanceof Expression) {
				$placeholders[] = $value->expression;
				foreach ($value->params as $n => $v) {
					$params[$n] = $v;
				}
Qiang Xue committed
114
			} else {
115 116
				$phName = self::PARAM_PREFIX . count($params);
				$placeholders[] = $phName;
Qiang Xue committed
117
				$params[$phName] = !is_array($value) && isset($columnSchemas[$name]) ? $columnSchemas[$name]->typecast($value) : $value;
w  
Qiang Xue committed
118 119 120
			}
		}

Qiang Xue committed
121
		return 'INSERT INTO ' . $this->db->quoteTableName($table)
w  
Qiang Xue committed
122 123 124 125
			. ' (' . implode(', ', $names) . ') VALUES ('
			. implode(', ', $placeholders) . ')';
	}

Qiang Xue committed
126 127 128 129 130
	/**
	 * Generates a batch INSERT SQL statement.
	 * For example,
	 *
	 * ~~~
Alexander Makarov committed
131 132 133 134 135
	 * $connection->createCommand()->batchInsert('tbl_user', ['name', 'age'], [
	 *     ['Tom', 30],
	 *     ['Jane', 20],
	 *     ['Linda', 25],
	 * ])->execute();
Qiang Xue committed
136 137
	 * ~~~
	 *
138
	 * Note that the values in each row must match the corresponding column names.
Qiang Xue committed
139 140 141 142 143 144
	 *
	 * @param string $table the table that new rows will be inserted into.
	 * @param array $columns the column names
	 * @param array $rows the rows to be batch inserted into the table
	 * @return string the batch INSERT SQL statement
	 */
145
	public function batchInsert($table, $columns, $rows)
Qiang Xue committed
146
	{
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
		if (($tableSchema = $this->db->getTableSchema($table)) !== null) {
			$columnSchemas = $tableSchema->columns;
		} else {
			$columnSchemas = [];
		}

		foreach ($columns as $i => $name) {
			$columns[$i] = $this->db->quoteColumnName($name);
		}

		$values = [];
		foreach ($rows as $row) {
			$vs = [];
			foreach ($row as $i => $value) {
				if (!is_array($value) && isset($columnSchemas[$columns[$i]])) {
					$value = $columnSchemas[$columns[$i]]->typecast($value);
				}
				$vs[] = is_string($value) ? $this->db->quoteValue($value) : $value;
			}
			$values[] = '(' . implode(', ', $vs) . ')';
		}
Qiang Xue committed
168

169 170
		return 'INSERT INTO ' . $this->db->quoteTableName($table)
		. ' (' . implode(', ', $columns) . ') VALUES ' . implode(', ', $values);
Qiang Xue committed
171 172
	}

w  
Qiang Xue committed
173
	/**
Qiang Xue committed
174
	 * Creates an UPDATE SQL statement.
Qiang Xue committed
175 176 177
	 * For example,
	 *
	 * ~~~
Alexander Makarov committed
178 179
	 * $params = [];
	 * $sql = $queryBuilder->update('tbl_user', ['status' => 1], 'age > 30', $params);
Qiang Xue committed
180 181
	 * ~~~
	 *
Qiang Xue committed
182 183
	 * The method will properly escape the table and column names.
	 *
w  
Qiang Xue committed
184
	 * @param string $table the table to be updated.
resurtm committed
185
	 * @param array $columns the column data (name => value) to be updated.
186
	 * @param array|string $condition the condition that will be put in the WHERE part. Please
Qiang Xue committed
187
	 * refer to [[Query::where()]] on how to specify condition.
Qiang Xue committed
188 189
	 * @param array $params the binding parameters that will be modified by this method
	 * so that they can be bound to the DB command later.
190
	 * @return string the UPDATE SQL
w  
Qiang Xue committed
191
	 */
192
	public function update($table, $columns, $condition, &$params)
w  
Qiang Xue committed
193
	{
194 195 196
		if (($tableSchema = $this->db->getTableSchema($table)) !== null) {
			$columnSchemas = $tableSchema->columns;
		} else {
Alexander Makarov committed
197
			$columnSchemas = [];
198 199
		}

Alexander Makarov committed
200
		$lines = [];
w  
Qiang Xue committed
201 202
		foreach ($columns as $name => $value) {
			if ($value instanceof Expression) {
Qiang Xue committed
203
				$lines[] = $this->db->quoteColumnName($name) . '=' . $value->expression;
w  
Qiang Xue committed
204 205 206
				foreach ($value->params as $n => $v) {
					$params[$n] = $v;
				}
Qiang Xue committed
207
			} else {
208 209
				$phName = self::PARAM_PREFIX . count($params);
				$lines[] = $this->db->quoteColumnName($name) . '=' . $phName;
Qiang Xue committed
210
				$params[$phName] = !is_array($value) && isset($columnSchemas[$name]) ? $columnSchemas[$name]->typecast($value) : $value;
w  
Qiang Xue committed
211 212
			}
		}
w  
Qiang Xue committed
213

214 215 216
		$sql = 'UPDATE ' . $this->db->quoteTableName($table) . ' SET ' . implode(', ', $lines);
		$where = $this->buildWhere($condition, $params);
		return $where === '' ? $sql : $sql . ' ' . $where;
w  
Qiang Xue committed
217 218 219
	}

	/**
Qiang Xue committed
220
	 * Creates a DELETE SQL statement.
Qiang Xue committed
221 222 223 224 225 226
	 * For example,
	 *
	 * ~~~
	 * $sql = $queryBuilder->delete('tbl_user', 'status = 0');
	 * ~~~
	 *
Qiang Xue committed
227 228
	 * The method will properly escape the table and column names.
	 *
w  
Qiang Xue committed
229
	 * @param string $table the table where the data will be deleted from.
230
	 * @param array|string $condition the condition that will be put in the WHERE part. Please
Qiang Xue committed
231
	 * refer to [[Query::where()]] on how to specify condition.
232 233
	 * @param array $params the binding parameters that will be modified by this method
	 * so that they can be bound to the DB command later.
234
	 * @return string the DELETE SQL
w  
Qiang Xue committed
235
	 */
236
	public function delete($table, $condition, &$params)
w  
Qiang Xue committed
237
	{
Qiang Xue committed
238
		$sql = 'DELETE FROM ' . $this->db->quoteTableName($table);
239 240
		$where = $this->buildWhere($condition, $params);
		return $where === '' ? $sql : $sql . ' ' . $where;
w  
Qiang Xue committed
241 242
	}

w  
Qiang Xue committed
243 244 245
	/**
	 * Builds a SQL statement for creating a new DB table.
	 *
resurtm committed
246
	 * The columns in the new  table should be specified as name-definition pairs (e.g. 'name' => 'string'),
w  
Qiang Xue committed
247 248
	 * where name stands for a column name which will be properly quoted by the method, and definition
	 * stands for the column type which can contain an abstract DB type.
Qiang Xue committed
249
	 * The [[getColumnType()]] method will be invoked to convert any abstract type into a physical one.
w  
Qiang Xue committed
250 251 252 253
	 *
	 * If a column is specified with definition only (e.g. 'PRIMARY KEY (name, type)'), it will be directly
	 * inserted into the generated SQL.
	 *
Qiang Xue committed
254 255 256
	 * For example,
	 *
	 * ~~~
Alexander Makarov committed
257
	 * $sql = $queryBuilder->createTable('tbl_user', [
Qiang Xue committed
258 259 260
	 *	 'id' => 'pk',
	 *	 'name' => 'string',
	 *	 'age' => 'integer',
Alexander Makarov committed
261
	 * ]);
Qiang Xue committed
262 263
	 * ~~~
	 *
w  
Qiang Xue committed
264
	 * @param string $table the name of the table to be created. The name will be properly quoted by the method.
resurtm committed
265
	 * @param array $columns the columns (name => definition) in the new table.
w  
Qiang Xue committed
266 267 268 269 270
	 * @param string $options additional SQL fragment that will be appended to the generated SQL.
	 * @return string the SQL statement for creating a new DB table.
	 */
	public function createTable($table, $columns, $options = null)
	{
Alexander Makarov committed
271
		$cols = [];
w  
Qiang Xue committed
272 273
		foreach ($columns as $name => $type) {
			if (is_string($name)) {
Qiang Xue committed
274
				$cols[] = "\t" . $this->db->quoteColumnName($name) . ' ' . $this->getColumnType($type);
Qiang Xue committed
275
			} else {
w  
Qiang Xue committed
276
				$cols[] = "\t" . $type;
Qiang Xue committed
277
			}
w  
Qiang Xue committed
278
		}
Qiang Xue committed
279
		$sql = "CREATE TABLE " . $this->db->quoteTableName($table) . " (\n" . implode(",\n", $cols) . "\n)";
w  
Qiang Xue committed
280 281 282 283 284
		return $options === null ? $sql : $sql . ' ' . $options;
	}

	/**
	 * Builds a SQL statement for renaming a DB table.
Qiang Xue committed
285
	 * @param string $oldName the table to be renamed. The name will be properly quoted by the method.
w  
Qiang Xue committed
286 287 288
	 * @param string $newName the new table name. The name will be properly quoted by the method.
	 * @return string the SQL statement for renaming a DB table.
	 */
Qiang Xue committed
289
	public function renameTable($oldName, $newName)
w  
Qiang Xue committed
290
	{
Qiang Xue committed
291
		return 'RENAME TABLE ' . $this->db->quoteTableName($oldName) . ' TO ' . $this->db->quoteTableName($newName);
w  
Qiang Xue committed
292 293 294 295 296 297 298 299 300
	}

	/**
	 * Builds a SQL statement for dropping a DB table.
	 * @param string $table the table to be dropped. The name will be properly quoted by the method.
	 * @return string the SQL statement for dropping a DB table.
	 */
	public function dropTable($table)
	{
Qiang Xue committed
301
		return "DROP TABLE " . $this->db->quoteTableName($table);
w  
Qiang Xue committed
302
	}
303

304 305 306 307 308 309 310
	/**
	 * Builds a SQL statement for adding a primary key constraint to an existing table.
	 * @param string $name the name of the primary key constraint.
	 * @param string $table the table that the primary key constraint will be added to.
	 * @param string|array $columns comma separated string or array of columns that the primary key will consist of.
	 * @return string the SQL statement for adding a primary key constraint to an existing table.
	 */
311
	public function addPrimaryKey($name, $table, $columns)
312
	{
313
		if (is_string($columns)) {
Alexander Makarov committed
314
			$columns = preg_split('/\s*,\s*/', $columns, -1, PREG_SPLIT_NO_EMPTY);
315
		}
Alexander Makarov committed
316 317 318

		foreach ($columns as $i => $col) {
			$columns[$i] = $this->db->quoteColumnName($col);
319
		}
320

321 322
		return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' ADD CONSTRAINT '
			. $this->db->quoteColumnName($name) . '  PRIMARY KEY ('
323
			. implode(', ', $columns). ' )';
Alexander Makarov committed
324
	}
325

326
	/**
327 328 329 330
	 * Builds a SQL statement for removing a primary key constraint to an existing table.
	 * @param string $name the name of the primary key constraint to be removed.
	 * @param string $table the table that the primary key constraint will be removed from.
	 * @return string the SQL statement for removing a primary key constraint from an existing table.	 *
331
	 */
332
	public function dropPrimaryKey($name, $table)
333
	{
334 335
		return 'ALTER TABLE ' . $this->db->quoteTableName($table)
			. ' DROP CONSTRAINT ' . $this->db->quoteColumnName($name);
Alexander Makarov committed
336
	}
w  
Qiang Xue committed
337 338 339 340 341 342 343

	/**
	 * Builds a SQL statement for truncating a DB table.
	 * @param string $table the table to be truncated. The name will be properly quoted by the method.
	 * @return string the SQL statement for truncating a DB table.
	 */
	public function truncateTable($table)
w  
Qiang Xue committed
344
	{
Qiang Xue committed
345
		return "TRUNCATE TABLE " . $this->db->quoteTableName($table);
w  
Qiang Xue committed
346 347 348 349 350 351
	}

	/**
	 * Builds a SQL statement for adding a new DB column.
	 * @param string $table the table that the new column will be added to. The table name will be properly quoted by the method.
	 * @param string $column the name of the new column. The name will be properly quoted by the method.
Qiang Xue committed
352
	 * @param string $type the column type. The [[getColumnType()]] method will be invoked to convert abstract column type (if any)
w  
Qiang Xue committed
353 354 355 356 357 358
	 * into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL.
	 * For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'.
	 * @return string the SQL statement for adding a new column.
	 */
	public function addColumn($table, $column, $type)
	{
Qiang Xue committed
359 360
		return 'ALTER TABLE ' . $this->db->quoteTableName($table)
			. ' ADD ' . $this->db->quoteColumnName($column) . ' '
w  
Qiang Xue committed
361 362
			. $this->getColumnType($type);
	}
w  
Qiang Xue committed
363

w  
Qiang Xue committed
364 365 366 367 368 369 370 371
	/**
	 * Builds a SQL statement for dropping a DB column.
	 * @param string $table the table whose column is to be dropped. The name will be properly quoted by the method.
	 * @param string $column the name of the column to be dropped. The name will be properly quoted by the method.
	 * @return string the SQL statement for dropping a DB column.
	 */
	public function dropColumn($table, $column)
	{
Qiang Xue committed
372 373
		return "ALTER TABLE " . $this->db->quoteTableName($table)
			. " DROP COLUMN " . $this->db->quoteColumnName($column);
w  
Qiang Xue committed
374 375 376 377 378
	}

	/**
	 * Builds a SQL statement for renaming a column.
	 * @param string $table the table whose column is to be renamed. The name will be properly quoted by the method.
Qiang Xue committed
379
	 * @param string $oldName the old name of the column. The name will be properly quoted by the method.
w  
Qiang Xue committed
380 381 382
	 * @param string $newName the new name of the column. The name will be properly quoted by the method.
	 * @return string the SQL statement for renaming a DB column.
	 */
Qiang Xue committed
383
	public function renameColumn($table, $oldName, $newName)
w  
Qiang Xue committed
384
	{
Qiang Xue committed
385 386 387
		return "ALTER TABLE " . $this->db->quoteTableName($table)
			. " RENAME COLUMN " . $this->db->quoteColumnName($oldName)
			. " TO " . $this->db->quoteColumnName($newName);
w  
Qiang Xue committed
388 389 390 391 392 393
	}

	/**
	 * Builds a SQL statement for changing the definition of a column.
	 * @param string $table the table whose column is to be changed. The table name will be properly quoted by the method.
	 * @param string $column the name of the column to be changed. The name will be properly quoted by the method.
Qiang Xue committed
394 395 396 397
	 * @param string $type the new column type. The [[getColumnType()]] method will be invoked to convert abstract
	 * column type (if any) into the physical one. Anything that is not recognized as abstract type will be kept
	 * in the generated SQL. For example, 'string' will be turned into 'varchar(255)', while 'string not null'
	 * will become 'varchar(255) not null'.
w  
Qiang Xue committed
398 399 400 401
	 * @return string the SQL statement for changing the definition of a column.
	 */
	public function alterColumn($table, $column, $type)
	{
Qiang Xue committed
402 403 404
		return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' CHANGE '
			. $this->db->quoteColumnName($column) . ' '
			. $this->db->quoteColumnName($column) . ' '
w  
Qiang Xue committed
405 406 407 408 409 410 411 412
			. $this->getColumnType($type);
	}

	/**
	 * Builds a SQL statement for adding a foreign key constraint to an existing table.
	 * The method will properly quote the table and column names.
	 * @param string $name the name of the foreign key constraint.
	 * @param string $table the table that the foreign key constraint will be added to.
Qiang Xue committed
413 414
	 * @param string|array $columns the name of the column to that the constraint will be added on.
	 * If there are multiple columns, separate them with commas or use an array to represent them.
w  
Qiang Xue committed
415
	 * @param string $refTable the table that the foreign key references to.
Qiang Xue committed
416 417
	 * @param string|array $refColumns the name of the column that the foreign key references to.
	 * If there are multiple columns, separate them with commas or use an array to represent them.
w  
Qiang Xue committed
418 419 420 421 422 423
	 * @param string $delete the ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
	 * @param string $update the ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
	 * @return string the SQL statement for adding a foreign key constraint to an existing table.
	 */
	public function addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null)
	{
Qiang Xue committed
424 425
		$sql = 'ALTER TABLE ' . $this->db->quoteTableName($table)
			. ' ADD CONSTRAINT ' . $this->db->quoteColumnName($name)
Qiang Xue committed
426
			. ' FOREIGN KEY (' . $this->buildColumns($columns) . ')'
Qiang Xue committed
427
			. ' REFERENCES ' . $this->db->quoteTableName($refTable)
Qiang Xue committed
428
			. ' (' . $this->buildColumns($refColumns) . ')';
Qiang Xue committed
429
		if ($delete !== null) {
w  
Qiang Xue committed
430
			$sql .= ' ON DELETE ' . $delete;
Qiang Xue committed
431 432
		}
		if ($update !== null) {
w  
Qiang Xue committed
433
			$sql .= ' ON UPDATE ' . $update;
Qiang Xue committed
434
		}
w  
Qiang Xue committed
435 436 437 438 439 440 441 442 443 444 445
		return $sql;
	}

	/**
	 * Builds a SQL statement for dropping a foreign key constraint.
	 * @param string $name the name of the foreign key constraint to be dropped. The name will be properly quoted by the method.
	 * @param string $table the table whose foreign is to be dropped. The name will be properly quoted by the method.
	 * @return string the SQL statement for dropping a foreign key constraint.
	 */
	public function dropForeignKey($name, $table)
	{
Qiang Xue committed
446 447
		return 'ALTER TABLE ' . $this->db->quoteTableName($table)
			. ' DROP CONSTRAINT ' . $this->db->quoteColumnName($name);
w  
Qiang Xue committed
448 449 450 451 452 453
	}

	/**
	 * Builds a SQL statement for creating a new index.
	 * @param string $name the name of the index. The name will be properly quoted by the method.
	 * @param string $table the table that the new index will be created for. The table name will be properly quoted by the method.
Qiang Xue committed
454 455 456
	 * @param string|array $columns the column(s) that should be included in the index. If there are multiple columns,
	 * separate them with commas or use an array to represent them. Each column name will be properly quoted
	 * by the method, unless a parenthesis is found in the name.
w  
Qiang Xue committed
457 458 459
	 * @param boolean $unique whether to add UNIQUE constraint on the created index.
	 * @return string the SQL statement for creating a new index.
	 */
Qiang Xue committed
460
	public function createIndex($name, $table, $columns, $unique = false)
w  
Qiang Xue committed
461 462
	{
		return ($unique ? 'CREATE UNIQUE INDEX ' : 'CREATE INDEX ')
Qiang Xue committed
463 464
			. $this->db->quoteTableName($name) . ' ON '
			. $this->db->quoteTableName($table)
Qiang Xue committed
465
			. ' (' . $this->buildColumns($columns) . ')';
w  
Qiang Xue committed
466 467 468 469 470 471 472 473 474 475
	}

	/**
	 * Builds a SQL statement for dropping an index.
	 * @param string $name the name of the index to be dropped. The name will be properly quoted by the method.
	 * @param string $table the table whose index is to be dropped. The name will be properly quoted by the method.
	 * @return string the SQL statement for dropping an index.
	 */
	public function dropIndex($name, $table)
	{
Qiang Xue committed
476
		return 'DROP INDEX ' . $this->db->quoteTableName($name) . ' ON ' . $this->db->quoteTableName($table);
w  
Qiang Xue committed
477 478
	}

w  
Qiang Xue committed
479
	/**
Qiang Xue committed
480
	 * Creates a SQL statement for resetting the sequence value of a table's primary key.
w  
Qiang Xue committed
481 482
	 * The sequence will be reset such that the primary key of the next new row inserted
	 * will have the specified value or 1.
Qiang Xue committed
483
	 * @param string $table the name of the table whose primary key sequence will be reset
484
	 * @param array|string $value the value for the primary key of the next new row inserted. If this is not set,
w  
Qiang Xue committed
485
	 * the next new row's primary key will have a value 1.
Qiang Xue committed
486 487
	 * @return string the SQL statement for resetting sequence
	 * @throws NotSupportedException if this is not supported by the underlying DBMS
w  
Qiang Xue committed
488 489 490
	 */
	public function resetSequence($table, $value = null)
	{
Qiang Xue committed
491
		throw new NotSupportedException($this->db->getDriverName() . ' does not support resetting sequence.');
w  
Qiang Xue committed
492 493 494
	}

	/**
Qiang Xue committed
495
	 * Builds a SQL statement for enabling or disabling integrity check.
w  
Qiang Xue committed
496 497
	 * @param boolean $check whether to turn on or off the integrity check.
	 * @param string $schema the schema of the tables. Defaults to empty string, meaning the current or default schema.
resurtm committed
498
	 * @param string $table the table name. Defaults to empty string, meaning that no table will be changed.
Qiang Xue committed
499 500
	 * @return string the SQL statement for checking integrity
	 * @throws NotSupportedException if this is not supported by the underlying DBMS
w  
Qiang Xue committed
501
	 */
resurtm committed
502
	public function checkIntegrity($check = true, $schema = '', $table = '')
w  
Qiang Xue committed
503
	{
Qiang Xue committed
504
		throw new NotSupportedException($this->db->getDriverName() . ' does not support enabling/disabling integrity check.');
w  
Qiang Xue committed
505 506 507 508
	}

	/**
	 * Converts an abstract column type into a physical column type.
Qiang Xue committed
509
	 * The conversion is done using the type map specified in [[typeMap]].
Qiang Xue committed
510
	 * The following abstract column types are supported (using MySQL as an example to explain the corresponding
w  
Qiang Xue committed
511
	 * physical types):
Qiang Xue committed
512
	 *
Qiang Xue committed
513
	 * - `pk`: an auto-incremental primary key type, will be converted into "int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY"
514
	 * - `bigpk`: an auto-incremental primary key type, will be converted into "bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY"
Qiang Xue committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528
	 * - `string`: string type, will be converted into "varchar(255)"
	 * - `text`: a long string type, will be converted into "text"
	 * - `smallint`: a small integer type, will be converted into "smallint(6)"
	 * - `integer`: integer type, will be converted into "int(11)"
	 * - `bigint`: a big integer type, will be converted into "bigint(20)"
	 * - `boolean`: boolean type, will be converted into "tinyint(1)"
	 * - `float``: float number type, will be converted into "float"
	 * - `decimal`: decimal number type, will be converted into "decimal"
	 * - `datetime`: datetime type, will be converted into "datetime"
	 * - `timestamp`: timestamp type, will be converted into "timestamp"
	 * - `time`: time type, will be converted into "time"
	 * - `date`: date type, will be converted into "date"
	 * - `money`: money type, will be converted into "decimal(19,4)"
	 * - `binary`: binary data type, will be converted into "blob"
w  
Qiang Xue committed
529 530
	 *
	 * If the abstract type contains two or more parts separated by spaces (e.g. "string NOT NULL"), then only
Qiang Xue committed
531
	 * the first part will be converted, and the rest of the parts will be appended to the converted result.
w  
Qiang Xue committed
532
	 * For example, 'string NOT NULL' is converted to 'varchar(255) NOT NULL'.
Qiang Xue committed
533
	 *
534 535 536 537 538
	 * For some of the abstract types you can also specify a length or precision constraint
	 * by prepending it in round brackets directly to the type.
	 * For example `string(32)` will be converted into "varchar(32)" on a MySQL database.
	 * If the underlying DBMS does not support these kind of constraints for a type it will
	 * be ignored.
539
	 *
Qiang Xue committed
540
	 * If a type cannot be found in [[typeMap]], it will be returned without any change.
w  
Qiang Xue committed
541 542 543
	 * @param string $type abstract column type
	 * @return string physical column type.
	 */
Qiang Xue committed
544 545
	public function getColumnType($type)
	{
w  
Qiang Xue committed
546 547
		if (isset($this->typeMap[$type])) {
			return $this->typeMap[$type];
548
		} elseif (preg_match('/^(\w+)\((.+?)\)(.*)$/', $type, $matches)) {
549 550 551
			if (isset($this->typeMap[$matches[1]])) {
				return preg_replace('/\(.+\)/', '(' . $matches[2] . ')', $this->typeMap[$matches[1]]) . $matches[3];
			}
Qiang Xue committed
552
		} elseif (preg_match('/^(\w+)\s+/', $type, $matches)) {
Qiang Xue committed
553 554
			if (isset($this->typeMap[$matches[1]])) {
				return preg_replace('/^\w+/', $this->typeMap[$matches[1]], $type);
Qiang Xue committed
555 556 557 558 559 560
			}
		}
		return $type;
	}

	/**
Qiang Xue committed
561
	 * @param array $columns
Qiang Xue committed
562 563
	 * @param boolean $distinct
	 * @param string $selectOption
Qiang Xue committed
564 565
	 * @return string the SELECT clause built from [[query]].
	 */
Qiang Xue committed
566
	public function buildSelect($columns, $distinct = false, $selectOption = null)
w  
Qiang Xue committed
567
	{
Qiang Xue committed
568 569 570
		$select = $distinct ? 'SELECT DISTINCT' : 'SELECT';
		if ($selectOption !== null) {
			$select .= ' ' . $selectOption;
w  
Qiang Xue committed
571
		}
w  
Qiang Xue committed
572

w  
Qiang Xue committed
573 574 575 576
		if (empty($columns)) {
			return $select . ' *';
		}

577 578 579 580 581
		foreach ($columns as $i => $column) {
			if (is_object($column)) {
				$columns[$i] = (string)$column;
			} elseif (strpos($column, '(') === false) {
				if (preg_match('/^(.*?)(?i:\s+as\s+|\s+)([\w\-_\.]+)$/', $column, $matches)) {
Qiang Xue committed
582
					$columns[$i] = $this->db->quoteColumnName($matches[1]) . ' AS ' . $this->db->quoteColumnName($matches[2]);
583
				} else {
Qiang Xue committed
584
					$columns[$i] = $this->db->quoteColumnName($column);
w  
Qiang Xue committed
585 586 587 588
				}
			}
		}

Qiang Xue committed
589 590 591 592 593
		if (is_array($columns)) {
			$columns = implode(', ', $columns);
		}

		return $select . ' ' . $columns;
w  
Qiang Xue committed
594 595
	}

Qiang Xue committed
596
	/**
Qiang Xue committed
597
	 * @param array $tables
Qiang Xue committed
598 599
	 * @return string the FROM clause built from [[query]].
	 */
Qiang Xue committed
600
	public function buildFrom($tables)
w  
Qiang Xue committed
601
	{
Qiang Xue committed
602
		if (empty($tables)) {
Qiang Xue committed
603 604 605
			return '';
		}

606 607
		foreach ($tables as $i => $table) {
			if (strpos($table, '(') === false) {
608
				if (preg_match('/^(.*?)(?i:\s+as|)\s+([^ ]+)$/', $table, $matches)) { // with alias
Qiang Xue committed
609
					$tables[$i] = $this->db->quoteTableName($matches[1]) . ' ' . $this->db->quoteTableName($matches[2]);
610
				} else {
Qiang Xue committed
611
					$tables[$i] = $this->db->quoteTableName($table);
Qiang Xue committed
612 613 614 615 616 617
				}
			}
		}

		if (is_array($tables)) {
			$tables = implode(', ', $tables);
w  
Qiang Xue committed
618 619
		}

Qiang Xue committed
620
		return 'FROM ' . $tables;
w  
Qiang Xue committed
621
	}
w  
Qiang Xue committed
622

Qiang Xue committed
623
	/**
Qiang Xue committed
624
	 * @param string|array $joins
625
	 * @param array $params the binding parameters to be populated
Qiang Xue committed
626
	 * @return string the JOIN clause built from [[query]].
Qiang Xue committed
627
	 * @throws Exception if the $joins parameter is not in proper format
Qiang Xue committed
628
	 */
629
	public function buildJoin($joins, &$params)
w  
Qiang Xue committed
630 631 632 633
	{
		if (empty($joins)) {
			return '';
		}
w  
Qiang Xue committed
634

w  
Qiang Xue committed
635
		foreach ($joins as $i => $join) {
Qiang Xue committed
636 637 638 639 640 641
			if (is_object($join)) {
				$joins[$i] = (string)$join;
			} elseif (is_array($join) && isset($join[0], $join[1])) {
				// 0:join type, 1:table name, 2:on-condition
				$table = $join[1];
				if (strpos($table, '(') === false) {
642
					if (preg_match('/^(.*?)(?i:\s+as|)\s+([^ ]+)$/', $table, $matches)) { // with alias
Qiang Xue committed
643 644 645
						$table = $this->db->quoteTableName($matches[1]) . ' ' . $this->db->quoteTableName($matches[2]);
					} else {
						$table = $this->db->quoteTableName($table);
w  
Qiang Xue committed
646
					}
Qiang Xue committed
647 648 649
				}
				$joins[$i] = $join[0] . ' ' . $table;
				if (isset($join[2])) {
650
					$condition = $this->buildCondition($join[2], $params);
Qiang Xue committed
651
					if ($condition !== '') {
652
						$joins[$i] .= ' ON ' . $condition;
w  
Qiang Xue committed
653 654
					}
				}
Qiang Xue committed
655 656
			} else {
				throw new Exception('A join clause must be specified as an array of join type, join table, and optionally join condition.');
w  
Qiang Xue committed
657 658
			}
		}
w  
Qiang Xue committed
659

Qiang Xue committed
660
		return implode($this->separator, $joins);
w  
Qiang Xue committed
661 662
	}

Qiang Xue committed
663
	/**
Qiang Xue committed
664
	 * @param string|array $condition
665
	 * @param array $params the binding parameters to be populated
Qiang Xue committed
666 667
	 * @return string the WHERE clause built from [[query]].
	 */
668
	public function buildWhere($condition, &$params)
w  
Qiang Xue committed
669
	{
670
		$where = $this->buildCondition($condition, $params);
Qiang Xue committed
671
		return $where === '' ? '' : 'WHERE ' . $where;
w  
Qiang Xue committed
672 673
	}

Qiang Xue committed
674
	/**
Qiang Xue committed
675
	 * @param array $columns
Qiang Xue committed
676
	 * @return string the GROUP BY clause
Qiang Xue committed
677
	 */
Qiang Xue committed
678
	public function buildGroupBy($columns)
w  
Qiang Xue committed
679
	{
Qiang Xue committed
680
		return empty($columns) ? '' : 'GROUP BY ' . $this->buildColumns($columns);
w  
Qiang Xue committed
681 682
	}

Qiang Xue committed
683
	/**
Qiang Xue committed
684
	 * @param string|array $condition
685
	 * @param array $params the binding parameters to be populated
Qiang Xue committed
686 687
	 * @return string the HAVING clause built from [[query]].
	 */
688
	public function buildHaving($condition, &$params)
w  
Qiang Xue committed
689
	{
690
		$having = $this->buildCondition($condition, $params);
Qiang Xue committed
691
		return $having === '' ? '' : 'HAVING ' . $having;
w  
Qiang Xue committed
692 693
	}

Qiang Xue committed
694
	/**
Qiang Xue committed
695
	 * @param array $columns
Qiang Xue committed
696 697
	 * @return string the ORDER BY clause built from [[query]].
	 */
Qiang Xue committed
698
	public function buildOrderBy($columns)
w  
Qiang Xue committed
699
	{
Qiang Xue committed
700
		if (empty($columns)) {
w  
Qiang Xue committed
701 702
			return '';
		}
Alexander Makarov committed
703
		$orders = [];
Qiang Xue committed
704 705 706
		foreach ($columns as $name => $direction) {
			if (is_object($direction)) {
				$orders[] = (string)$direction;
707
			} else {
708
				$orders[] = $this->db->quoteColumnName($name) . ($direction === SORT_DESC ? ' DESC' : '');
Qiang Xue committed
709 710
			}
		}
Qiang Xue committed
711 712

		return 'ORDER BY ' . implode(', ', $orders);
w  
Qiang Xue committed
713 714
	}

Qiang Xue committed
715
	/**
Qiang Xue committed
716 717
	 * @param integer $limit
	 * @param integer $offset
Qiang Xue committed
718 719
	 * @return string the LIMIT and OFFSET clauses built from [[query]].
	 */
Qiang Xue committed
720
	public function buildLimit($limit, $offset)
w  
Qiang Xue committed
721
	{
w  
Qiang Xue committed
722
		$sql = '';
Qiang Xue committed
723 724
		if ($limit !== null && $limit >= 0) {
			$sql = 'LIMIT ' . (int)$limit;
w  
Qiang Xue committed
725
		}
Qiang Xue committed
726 727
		if ($offset > 0) {
			$sql .= ' OFFSET ' . (int)$offset;
w  
Qiang Xue committed
728 729
		}
		return ltrim($sql);
w  
Qiang Xue committed
730 731
	}

Qiang Xue committed
732
	/**
Qiang Xue committed
733
	 * @param array $unions
734
	 * @param array $params the binding parameters to be populated
Qiang Xue committed
735 736
	 * @return string the UNION clause built from [[query]].
	 */
737
	public function buildUnion($unions, &$params)
w  
Qiang Xue committed
738
	{
w  
Qiang Xue committed
739 740 741 742
		if (empty($unions)) {
			return '';
		}
		foreach ($unions as $i => $union) {
Qiang Xue committed
743
			if ($union instanceof Query) {
744 745
				// save the original parameters so that we can restore them later to prevent from modifying the query object
				$originalParams = $union->params;
746
				$union->addParams($params);
747 748
				list ($unions[$i], $params) = $this->build($union);
				$union->params = $originalParams;
w  
Qiang Xue committed
749 750 751
			}
		}
		return "UNION (\n" . implode("\n) UNION (\n", $unions) . "\n)";
w  
Qiang Xue committed
752
	}
Qiang Xue committed
753 754 755 756 757 758 759

	/**
	 * 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
	 */
760
	public function buildColumns($columns)
Qiang Xue committed
761
	{
762 763 764 765 766
		if (!is_array($columns)) {
			if (strpos($columns, '(') !== false) {
				return $columns;
			} else {
				$columns = preg_split('/\s*,\s*/', $columns, -1, PREG_SPLIT_NO_EMPTY);
Qiang Xue committed
767
			}
768 769 770 771 772
		}
		foreach ($columns as $i => $column) {
			if (is_object($column)) {
				$columns[$i] = (string)$column;
			} elseif (strpos($column, '(') === false) {
Qiang Xue committed
773
				$columns[$i] = $this->db->quoteColumnName($column);
Qiang Xue committed
774 775 776 777
			}
		}
		return is_array($columns) ? implode(', ', $columns) : $columns;
	}
778 779 780 781 782 783 784 785


	/**
	 * Parses the condition specification and generates the corresponding SQL expression.
	 * @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
786
	 * @throws InvalidParamException if the condition is in bad format
787 788 789
	 */
	public function buildCondition($condition, &$params)
	{
Alexander Makarov committed
790
		static $builders = [
791 792 793 794 795 796 797 798 799 800
			'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',
Alexander Makarov committed
801
		];
802 803 804

		if (!is_array($condition)) {
			return (string)$condition;
805
		} elseif (empty($condition)) {
806 807 808 809 810 811 812 813 814
			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);
				return $this->$method($operator, $condition, $params);
			} else {
815
				throw new InvalidParamException('Found unknown operator in query: ' . $operator);
816
			}
resurtm committed
817
		} else { // hash format: 'column1' => 'value1', 'column2' => 'value2', ...
818 819 820 821
			return $this->buildHashCondition($condition, $params);
		}
	}

822 823 824 825 826 827 828
	/**
	 * Creates a condition based on column-value pairs.
	 * @param array $condition the condition specification.
	 * @param array $params the binding parameters to be populated
	 * @return string the generated SQL expression
	 */
	public function buildHashCondition($condition, &$params)
829
	{
Alexander Makarov committed
830
		$parts = [];
831 832
		foreach ($condition as $column => $value) {
			if (is_array($value)) { // IN condition
Alexander Makarov committed
833
				$parts[] = $this->buildInCondition('IN', [$column, $value], $params);
834 835 836 837 838 839
			} else {
				if (strpos($column, '(') === false) {
					$column = $this->db->quoteColumnName($column);
				}
				if ($value === null) {
					$parts[] = "$column IS NULL";
840 841 842 843 844
				} elseif ($value instanceof Expression) {
					$parts[] = "$column=" . $value->expression;
					foreach ($value->params as $n => $v) {
						$params[$n] = $v;
					}
845 846 847 848 849 850 851 852 853 854
				} else {
					$phName = self::PARAM_PREFIX . count($params);
					$parts[] = "$column=$phName";
					$params[$phName] = $value;
				}
			}
		}
		return count($parts) === 1 ? $parts[0] : '(' . implode(') AND (', $parts) . ')';
	}

855 856 857 858 859 860 861 862
	/**
	 * Connects two or more SQL expressions with the `AND` or `OR` operator.
	 * @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
	 */
	public function buildAndCondition($operator, $operands, &$params)
863
	{
Alexander Makarov committed
864
		$parts = [];
865 866 867 868 869 870 871 872
		foreach ($operands as $operand) {
			if (is_array($operand)) {
				$operand = $this->buildCondition($operand, $params);
			}
			if ($operand !== '') {
				$parts[] = $operand;
			}
		}
873
		if (!empty($parts)) {
874 875 876 877 878 879
			return '(' . implode(") $operator (", $parts) . ')';
		} else {
			return '';
		}
	}

880 881 882 883 884 885 886
	/**
	 * Creates an SQL expressions with the `BETWEEN` operator.
	 * @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
887
	 * @throws InvalidParamException if wrong number of operands have been given.
888 889
	 */
	public function buildBetweenCondition($operator, $operands, &$params)
890 891
	{
		if (!isset($operands[0], $operands[1], $operands[2])) {
892
			throw new InvalidParamException("Operator '$operator' requires three operands.");
893 894 895 896 897 898 899 900 901
		}

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

		if (strpos($column, '(') === false) {
			$column = $this->db->quoteColumnName($column);
		}
		$phName1 = self::PARAM_PREFIX . count($params);
		$params[$phName1] = $value1;
Qiang Xue committed
902
		$phName2 = self::PARAM_PREFIX . count($params);
903 904 905 906 907
		$params[$phName2] = $value2;

		return "$column $operator $phName1 AND $phName2";
	}

908 909 910 911 912 913 914 915 916 917 918 919 920
	/**
	 * Creates an SQL expressions with the `IN` operator.
	 * @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.
	 */
	public function buildInCondition($operator, $operands, &$params)
921 922 923 924 925 926 927 928 929
	{
		if (!isset($operands[0], $operands[1])) {
			throw new Exception("Operator '$operator' requires two operands.");
		}

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

		$values = (array)$values;

Alexander Makarov committed
930
		if (empty($values) || $column === []) {
931 932 933 934 935 936 937 938 939 940 941 942 943 944
			return $operator === 'IN' ? '0=1' : '';
		}

		if (count($column) > 1) {
			return $this->buildCompositeInCondition($operator, $column, $values, $params);
		} elseif (is_array($column)) {
			$column = reset($column);
		}
		foreach ($values as $i => $value) {
			if (is_array($value)) {
				$value = isset($value[$column]) ? $value[$column] : null;
			}
			if ($value === null) {
				$values[$i] = 'NULL';
945 946 947 948 949
			} elseif ($value instanceof Expression) {
				$values[$i] = $value->expression;
				foreach ($value->params as $n => $v) {
					$params[$n] = $v;
				}
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
			} else {
				$phName = self::PARAM_PREFIX . count($params);
				$params[$phName] = $value;
				$values[$i] = $phName;
			}
		}
		if (strpos($column, '(') === false) {
			$column = $this->db->quoteColumnName($column);
		}

		if (count($values) > 1) {
			return "$column $operator (" . implode(', ', $values) . ')';
		} else {
			$operator = $operator === 'IN' ? '=' : '<>';
			return "$column$operator{$values[0]}";
		}
	}

	protected function buildCompositeInCondition($operator, $columns, $values, &$params)
	{
Alexander Makarov committed
970
		$vss = [];
971
		foreach ($values as $value) {
Alexander Makarov committed
972
			$vs = [];
973 974 975 976 977 978 979 980 981 982 983
			foreach ($columns as $column) {
				if (isset($value[$column])) {
					$phName = self::PARAM_PREFIX . count($params);
					$params[$phName] = $value[$column];
					$vs[] = $phName;
				} else {
					$vs[] = 'NULL';
				}
			}
			$vss[] = '(' . implode(', ', $vs) . ')';
		}
Qiang Xue committed
984 985 986 987 988
		foreach ($columns as $i => $column) {
			if (strpos($column, '(') === false) {
				$columns[$i] = $this->db->quoteColumnName($column);
			}
		}
989 990 991
		return '(' . implode(', ', $columns) . ") $operator (" . implode(', ', $vss) . ')';
	}

992 993 994 995 996 997 998 999 1000 1001
	/**
	 * Creates an SQL expressions with the `LIKE` operator.
	 * @param string $operator the operator to use (e.g. `LIKE`, `NOT LIKE`, `OR LIKE` or `OR NOT LIKE`)
	 * @param array $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`.
	 * @param array $params the binding parameters to be populated
	 * @return string the generated SQL expression
1002
	 * @throws InvalidParamException if wrong number of operands have been given.
1003 1004
	 */
	public function buildLikeCondition($operator, $operands, &$params)
1005 1006
	{
		if (!isset($operands[0], $operands[1])) {
1007
			throw new InvalidParamException("Operator '$operator' requires two operands.");
1008 1009 1010 1011 1012 1013
		}

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

		$values = (array)$values;

1014
		if (empty($values)) {
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
			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);
		}

Alexander Makarov committed
1029
		$parts = [];
1030 1031 1032 1033 1034 1035 1036 1037
		foreach ($values as $value) {
			$phName = self::PARAM_PREFIX . count($params);
			$params[$phName] = $value;
			$parts[] = "$column $operator $phName";
		}

		return implode($andor, $parts);
	}
w  
Qiang Xue committed
1038
}