* @since 2.0 */ class QueryBuilder extends \yii\base\Object { /** * The prefix for automatically generated query binding parameters. */ const PARAM_PREFIX = ':qp'; /** * @var Connection the database 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 = " "; /** * @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. */ public $typeMap = []; /** * Constructor. * @param Connection $connection the database 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); } /** * Generates a SELECT SQL statement from a [[Query]] object. * @param Query $query the [[Query]] object from which the SQL statement will be generated * @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). */ public function build($query) { $params = $query->params; $clauses = [ $this->buildSelect($query->select, $query->distinct, $query->selectOption), $this->buildFrom($query->from), $this->buildJoin($query->join, $params), $this->buildWhere($query->where, $params), $this->buildGroupBy($query->groupBy), $this->buildHaving($query->having, $params), $this->buildUnion($query->union, $params), $this->buildOrderBy($query->orderBy), $this->buildLimit($query->limit, $query->offset), ]; return [implode($this->separator, array_filter($clauses)), $params]; } /** * Creates an INSERT SQL statement. * For example, * * ~~~ * $sql = $queryBuilder->insert('tbl_user', [ * 'name' => 'Sam', * 'age' => 30, * ], $params); * ~~~ * * The method will properly escape the table and column names. * * @param string $table the table that new rows will be inserted into. * @param array $columns the column data (name => value) to be inserted into the table. * @param array $params the binding parameters that will be generated by this method. * They should be bound to the DB command later. * @return string the INSERT SQL */ public function insert($table, $columns, &$params) { if (($tableSchema = $this->db->getTableSchema($table)) !== null) { $columnSchemas = $tableSchema->columns; } else { $columnSchemas = []; } $names = []; $placeholders = []; foreach ($columns as $name => $value) { $names[] = $this->db->quoteColumnName($name); if ($value instanceof Expression) { $placeholders[] = $value->expression; foreach ($value->params as $n => $v) { $params[$n] = $v; } } else { $phName = self::PARAM_PREFIX . count($params); $placeholders[] = $phName; $params[$phName] = !is_array($value) && isset($columnSchemas[$name]) ? $columnSchemas[$name]->typecast($value) : $value; } } return 'INSERT INTO ' . $this->db->quoteTableName($table) . ' (' . implode(', ', $names) . ') VALUES (' . implode(', ', $placeholders) . ')'; } /** * Generates a batch INSERT SQL statement. * For example, * * ~~~ * $connection->createCommand()->batchInsert('tbl_user', ['name', 'age'], [ * ['Tom', 30], * ['Jane', 20], * ['Linda', 25], * ])->execute(); * ~~~ * * Note that the values in each row must match the corresponding column names. * * @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 */ public function batchInsert($table, $columns, $rows) { 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) . ')'; } return 'INSERT INTO ' . $this->db->quoteTableName($table) . ' (' . implode(', ', $columns) . ') VALUES ' . implode(', ', $values); } /** * Creates an UPDATE SQL statement. * For example, * * ~~~ * $params = []; * $sql = $queryBuilder->update('tbl_user', ['status' => 1], 'age > 30', $params); * ~~~ * * The method will properly escape the table and column names. * * @param string $table the table 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 * so that they can be bound to the DB command later. * @return string the UPDATE SQL */ public function update($table, $columns, $condition, &$params) { if (($tableSchema = $this->db->getTableSchema($table)) !== null) { $columnSchemas = $tableSchema->columns; } else { $columnSchemas = []; } $lines = []; foreach ($columns as $name => $value) { if ($value instanceof Expression) { $lines[] = $this->db->quoteColumnName($name) . '=' . $value->expression; foreach ($value->params as $n => $v) { $params[$n] = $v; } } else { $phName = self::PARAM_PREFIX . count($params); $lines[] = $this->db->quoteColumnName($name) . '=' . $phName; $params[$phName] = !is_array($value) && isset($columnSchemas[$name]) ? $columnSchemas[$name]->typecast($value) : $value; } } $sql = 'UPDATE ' . $this->db->quoteTableName($table) . ' SET ' . implode(', ', $lines); $where = $this->buildWhere($condition, $params); return $where === '' ? $sql : $sql . ' ' . $where; } /** * Creates a DELETE SQL statement. * For example, * * ~~~ * $sql = $queryBuilder->delete('tbl_user', 'status = 0'); * ~~~ * * The method will properly escape the table and column names. * * @param string $table the table 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 * so that they can be bound to the DB command later. * @return string the DELETE SQL */ public function delete($table, $condition, &$params) { $sql = 'DELETE FROM ' . $this->db->quoteTableName($table); $where = $this->buildWhere($condition, $params); return $where === '' ? $sql : $sql . ' ' . $where; } /** * Builds a SQL statement for creating a new DB table. * * The columns in the new table should be specified as name-definition pairs (e.g. 'name' => 'string'), * 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. * The [[getColumnType()]] method will be invoked to convert any abstract type into a physical one. * * If a column is specified with definition only (e.g. 'PRIMARY KEY (name, type)'), it will be directly * inserted into the generated SQL. * * For example, * * ~~~ * $sql = $queryBuilder->createTable('tbl_user', [ * 'id' => 'pk', * 'name' => 'string', * 'age' => 'integer', * ]); * ~~~ * * @param string $table the name of the table to be created. The name will be properly quoted by the method. * @param array $columns the columns (name => definition) in the new table. * @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) { $cols = []; foreach ($columns as $name => $type) { if (is_string($name)) { $cols[] = "\t" . $this->db->quoteColumnName($name) . ' ' . $this->getColumnType($type); } else { $cols[] = "\t" . $type; } } $sql = "CREATE TABLE " . $this->db->quoteTableName($table) . " (\n" . implode(",\n", $cols) . "\n)"; return $options === null ? $sql : $sql . ' ' . $options; } /** * Builds a SQL statement for renaming a DB table. * @param string $oldName the table to be renamed. The name will be properly quoted by the method. * @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. */ public function renameTable($oldName, $newName) { return 'RENAME TABLE ' . $this->db->quoteTableName($oldName) . ' TO ' . $this->db->quoteTableName($newName); } /** * 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) { return "DROP TABLE " . $this->db->quoteTableName($table); } /** * 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. */ public function addPrimaryKey($name, $table, $columns) { if (is_string($columns)) { $columns = preg_split('/\s*,\s*/', $columns, -1, PREG_SPLIT_NO_EMPTY); } foreach ($columns as $i => $col) { $columns[$i] = $this->db->quoteColumnName($col); } return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' ADD CONSTRAINT ' . $this->db->quoteColumnName($name) . ' PRIMARY KEY (' . implode(', ', $columns). ' )'; } /** * 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. * */ public function dropPrimaryKey($name, $table) { return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' DROP CONSTRAINT ' . $this->db->quoteColumnName($name); } /** * 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) { return "TRUNCATE TABLE " . $this->db->quoteTableName($table); } /** * 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. * @param string $type the 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'. * @return string the SQL statement for adding a new column. */ public function addColumn($table, $column, $type) { return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' ADD ' . $this->db->quoteColumnName($column) . ' ' . $this->getColumnType($type); } /** * 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) { return "ALTER TABLE " . $this->db->quoteTableName($table) . " DROP COLUMN " . $this->db->quoteColumnName($column); } /** * 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. * @param string $oldName the old name of the column. The name will be properly quoted by the method. * @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. */ public function renameColumn($table, $oldName, $newName) { return "ALTER TABLE " . $this->db->quoteTableName($table) . " RENAME COLUMN " . $this->db->quoteColumnName($oldName) . " TO " . $this->db->quoteColumnName($newName); } /** * 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. * @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'. * @return string the SQL statement for changing the definition of a column. */ public function alterColumn($table, $column, $type) { return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' CHANGE ' . $this->db->quoteColumnName($column) . ' ' . $this->db->quoteColumnName($column) . ' ' . $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. * @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. * @param string $refTable the table that the foreign key references to. * @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. * @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) { $sql = 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' ADD CONSTRAINT ' . $this->db->quoteColumnName($name) . ' FOREIGN KEY (' . $this->buildColumns($columns) . ')' . ' REFERENCES ' . $this->db->quoteTableName($refTable) . ' (' . $this->buildColumns($refColumns) . ')'; if ($delete !== null) { $sql .= ' ON DELETE ' . $delete; } if ($update !== null) { $sql .= ' ON UPDATE ' . $update; } 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) { return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' DROP CONSTRAINT ' . $this->db->quoteColumnName($name); } /** * 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. * @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. * @param boolean $unique whether to add UNIQUE constraint on the created index. * @return string the SQL statement for creating a new index. */ public function createIndex($name, $table, $columns, $unique = false) { return ($unique ? 'CREATE UNIQUE INDEX ' : 'CREATE INDEX ') . $this->db->quoteTableName($name) . ' ON ' . $this->db->quoteTableName($table) . ' (' . $this->buildColumns($columns) . ')'; } /** * 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) { return 'DROP INDEX ' . $this->db->quoteTableName($name) . ' ON ' . $this->db->quoteTableName($table); } /** * Creates a SQL statement for resetting the sequence value of a table's primary key. * The sequence will be reset such that the primary key of the next new row inserted * will have the specified value or 1. * @param string $table the name of the table whose primary key sequence will be reset * @param array|string $value the value for the primary key of the next new row inserted. If this is not set, * the next new row's primary key will have a value 1. * @return string the SQL statement for resetting sequence * @throws NotSupportedException if this is not supported by the underlying DBMS */ public function resetSequence($table, $value = null) { throw new NotSupportedException($this->db->getDriverName() . ' does not support resetting sequence.'); } /** * Builds a SQL statement for enabling or disabling integrity check. * @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. * @param string $table the table name. Defaults to empty string, meaning that no table will be changed. * @return string the SQL statement for checking integrity * @throws NotSupportedException if this is not supported by the underlying DBMS */ public function checkIntegrity($check = true, $schema = '', $table = '') { throw new NotSupportedException($this->db->getDriverName() . ' does not support enabling/disabling integrity check.'); } /** * Converts an abstract column type into a physical column type. * The conversion is done using the type map specified in [[typeMap]]. * The following abstract column types are supported (using MySQL as an example to explain the corresponding * physical types): * * - `pk`: an auto-incremental primary key type, will be converted into "int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY" * - `bigpk`: an auto-incremental primary key type, will be converted into "bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY" * - `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" * * If the abstract type contains two or more parts separated by spaces (e.g. "string NOT NULL"), then only * the first part will be converted, and the rest of the parts will be appended to the converted result. * For example, 'string NOT NULL' is converted to 'varchar(255) NOT NULL'. * * 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. * * If a type cannot be found in [[typeMap]], it will be returned without any change. * @param string $type abstract column type * @return string physical column type. */ public function getColumnType($type) { if (isset($this->typeMap[$type])) { return $this->typeMap[$type]; } elseif (preg_match('/^(\w+)\((.+?)\)(.*)$/', $type, $matches)) { if (isset($this->typeMap[$matches[1]])) { return preg_replace('/\(.+\)/', '(' . $matches[2] . ')', $this->typeMap[$matches[1]]) . $matches[3]; } } elseif (preg_match('/^(\w+)\s+/', $type, $matches)) { if (isset($this->typeMap[$matches[1]])) { return preg_replace('/^\w+/', $this->typeMap[$matches[1]], $type); } } return $type; } /** * @param array $columns * @param boolean $distinct * @param string $selectOption * @return string the SELECT clause built from [[query]]. */ public function buildSelect($columns, $distinct = false, $selectOption = null) { $select = $distinct ? 'SELECT DISTINCT' : 'SELECT'; if ($selectOption !== null) { $select .= ' ' . $selectOption; } if (empty($columns)) { return $select . ' *'; } 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)) { $columns[$i] = $this->db->quoteColumnName($matches[1]) . ' AS ' . $this->db->quoteColumnName($matches[2]); } else { $columns[$i] = $this->db->quoteColumnName($column); } } } if (is_array($columns)) { $columns = implode(', ', $columns); } return $select . ' ' . $columns; } /** * @param array $tables * @return string the FROM clause built from [[query]]. */ public function buildFrom($tables) { if (empty($tables)) { return ''; } foreach ($tables as $i => $table) { if (strpos($table, '(') === false) { if (preg_match('/^(.*?)(?i:\s+as|)\s+([^ ]+)$/', $table, $matches)) { // with alias $tables[$i] = $this->db->quoteTableName($matches[1]) . ' ' . $this->db->quoteTableName($matches[2]); } else { $tables[$i] = $this->db->quoteTableName($table); } } } if (is_array($tables)) { $tables = implode(', ', $tables); } return 'FROM ' . $tables; } /** * @param string|array $joins * @param array $params the binding parameters to be populated * @return string the JOIN clause built from [[query]]. * @throws Exception if the $joins parameter is not in proper format */ public function buildJoin($joins, &$params) { if (empty($joins)) { return ''; } foreach ($joins as $i => $join) { 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) { if (preg_match('/^(.*?)(?i:\s+as|)\s+([^ ]+)$/', $table, $matches)) { // with alias $table = $this->db->quoteTableName($matches[1]) . ' ' . $this->db->quoteTableName($matches[2]); } else { $table = $this->db->quoteTableName($table); } } $joins[$i] = $join[0] . ' ' . $table; if (isset($join[2])) { $condition = $this->buildCondition($join[2], $params); if ($condition !== '') { $joins[$i] .= ' ON ' . $condition; } } } else { throw new Exception('A join clause must be specified as an array of join type, join table, and optionally join condition.'); } } return implode($this->separator, $joins); } /** * @param string|array $condition * @param array $params the binding parameters to be populated * @return string the WHERE clause built from [[query]]. */ public function buildWhere($condition, &$params) { $where = $this->buildCondition($condition, $params); 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 string|array $condition * @param array $params the binding parameters to be populated * @return string the HAVING clause built from [[query]]. */ public function buildHaving($condition, &$params) { $having = $this->buildCondition($condition, $params); return $having === '' ? '' : 'HAVING ' . $having; } /** * @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) { if (is_object($direction)) { $orders[] = (string)$direction; } else { $orders[] = $this->db->quoteColumnName($name) . ($direction === SORT_DESC ? ' DESC' : ''); } } 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 = ''; if ($limit !== null && $limit >= 0) { $sql = 'LIMIT ' . (int)$limit; } if ($offset > 0) { $sql .= ' OFFSET ' . (int)$offset; } return ltrim($sql); } /** * @param array $unions * @param array $params the binding parameters to be populated * @return string the UNION clause built from [[query]]. */ public function buildUnion($unions, &$params) { if (empty($unions)) { return ''; } foreach ($unions as $i => $union) { if ($union instanceof Query) { // save the original parameters so that we can restore them later to prevent from modifying the query object $originalParams = $union->params; $union->addParams($params); list ($unions[$i], $params) = $this->build($union); $union->params = $originalParams; } } return "UNION (\n" . implode("\n) UNION (\n", $unions) . "\n)"; } /** * 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) { if (is_object($column)) { $columns[$i] = (string)$column; } 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. * @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 InvalidParamException if the condition is in bad format */ public function buildCondition($condition, &$params) { 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); return $this->$method($operator, $condition, $params); } else { throw new InvalidParamException('Found unknown operator in query: ' . $operator); } } else { // hash format: 'column1' => 'value1', 'column2' => 'value2', ... return $this->buildHashCondition($condition, $params); } } /** * 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) { $parts = []; foreach ($condition as $column => $value) { if (is_array($value)) { // IN condition $parts[] = $this->buildInCondition('IN', [$column, $value], $params); } else { if (strpos($column, '(') === false) { $column = $this->db->quoteColumnName($column); } if ($value === null) { $parts[] = "$column IS NULL"; } elseif ($value instanceof Expression) { $parts[] = "$column=" . $value->expression; foreach ($value->params as $n => $v) { $params[$n] = $v; } } else { $phName = self::PARAM_PREFIX . count($params); $parts[] = "$column=$phName"; $params[$phName] = $value; } } } return count($parts) === 1 ? $parts[0] : '(' . implode(') AND (', $parts) . ')'; } /** * 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) { $parts = []; foreach ($operands as $operand) { if (is_array($operand)) { $operand = $this->buildCondition($operand, $params); } if ($operand !== '') { $parts[] = $operand; } } if (!empty($parts)) { return '(' . implode(") $operator (", $parts) . ')'; } else { return ''; } } /** * 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 * @throws InvalidParamException if wrong number of operands have been given. */ public function buildBetweenCondition($operator, $operands, &$params) { if (!isset($operands[0], $operands[1], $operands[2])) { throw new InvalidParamException("Operator '$operator' requires three operands."); } list($column, $value1, $value2) = $operands; if (strpos($column, '(') === false) { $column = $this->db->quoteColumnName($column); } $phName1 = self::PARAM_PREFIX . count($params); $params[$phName1] = $value1; $phName2 = self::PARAM_PREFIX . count($params); $params[$phName2] = $value2; return "$column $operator $phName1 AND $phName2"; } /** * 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) { 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) { 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'; } elseif ($value instanceof Expression) { $values[$i] = $value->expression; foreach ($value->params as $n => $v) { $params[$n] = $v; } } 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) { $vss = []; foreach ($values as $value) { $vs = []; 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) . ')'; } 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. * @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 * @throws Exception if wrong number of operands have been given. */ public function buildLikeCondition($operator, $operands, &$params) { if (!isset($operands[0], $operands[1])) { throw new InvalidParamException("Operator '$operator' requires two operands."); } 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); $params[$phName] = $value; $parts[] = "$column $operator $phName"; } return implode($andor, $parts); } }