QueryBuilder::dropPrimaryKey() - Code Metrics - Inspection of "Updated PHPDocs: marked session-handling methods a..." - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fab53b...ab36cb )

by Dmitry

created 2017-02-20 20:13 UTC

QueryBuilder::dropPrimaryKey() A

↳ Parent: QueryBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
ccs	2
cts	2
cp	1
cc	1
eloc	2
nc	1
nop	2
crap	1

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\db\mysql;

use yii\base\InvalidParamException;
use yii\db\Exception;
use yii\db\Expression;

/**
 * QueryBuilder is the query builder for MySQL databases.
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
class QueryBuilder extends \yii\db\QueryBuilder
{
    /**
     * @var array mapping from abstract column types (keys) to physical column types (values).
     */
    public $typeMap = [
        Schema::TYPE_PK => 'int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY',
        Schema::TYPE_UPK => 'int(10) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY',
        Schema::TYPE_BIGPK => 'bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY',
        Schema::TYPE_UBIGPK => 'bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY',
        Schema::TYPE_CHAR => 'char(1)',
        Schema::TYPE_STRING => 'varchar(255)',
        Schema::TYPE_TEXT => 'text',
        Schema::TYPE_SMALLINT => 'smallint(6)',
        Schema::TYPE_INTEGER => 'int(11)',
        Schema::TYPE_BIGINT => 'bigint(20)',
        Schema::TYPE_FLOAT => 'float',
        Schema::TYPE_DOUBLE => 'double',
        Schema::TYPE_DECIMAL => 'decimal(10,0)',
        Schema::TYPE_DATETIME => 'datetime',
        Schema::TYPE_TIMESTAMP => 'timestamp',
        Schema::TYPE_TIME => 'time',
        Schema::TYPE_DATE => 'date',
        Schema::TYPE_BINARY => 'blob',
        Schema::TYPE_BOOLEAN => 'tinyint(1)',
        Schema::TYPE_MONEY => 'decimal(19,4)',
    ];


    /**
     * 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.
     * @throws Exception
     */
    public function renameColumn($table, $oldName, $newName)
    {
        $quotedTable = $this->db->quoteTableName($table);
        $row = $this->db->createCommand('SHOW CREATE TABLE ' . $quotedTable)->queryOne();
        if ($row === false) {
            throw new Exception("Unable to find column '$oldName' in table '$table'.");
        }
        if (isset($row['Create Table'])) {
            $sql = $row['Create Table'];
        } else {
            $row = array_values($row);
            $sql = $row[1];
        }
        if (preg_match_all('/^\s*`(.*?)`\s+(.*?),?$/m', $sql, $matches)) {
            foreach ($matches[1] as $i => $c) {
                if ($c === $oldName) {
                    return "ALTER TABLE $quotedTable CHANGE "
                        . $this->db->quoteColumnName($oldName) . ' '
                        . $this->db->quoteColumnName($newName) . ' '
                        . $matches[2][$i];
                }
            }
        }
        // try to give back a SQL anyway
        return "ALTER TABLE $quotedTable CHANGE "
            . $this->db->quoteColumnName($oldName) . ' '
            . $this->db->quoteColumnName($newName);
    }

    /**
     * @inheritdoc
     * @see https://bugs.mysql.com/bug.php?id=48875
     */
    public function createIndex($name, $table, $columns, $unique = false)
    {
        return 'ALTER TABLE '
        . $this->db->quoteTableName($table)
        . ($unique ? ' ADD UNIQUE INDEX ' : ' ADD INDEX ')
        . $this->db->quoteTableName($name)
        . ' (' . $this->buildColumns($columns) . ')';
    }

    /**
     * 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 FOREIGN KEY ' . $this->db->quoteColumnName($name);
    }

    /**
     * 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 PRIMARY KEY';
    }

    /**
     * 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 $tableName the name of the table whose primary key sequence will be reset
     * @param mixed $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 InvalidParamException if the table does not exist or there is no sequence associated with the table.
     */
    public function resetSequence($tableName, $value = null)
    {
        $table = $this->db->getTableSchema($tableName);
        if ($table !== null && $table->sequenceName !== null) {
            $tableName = $this->db->quoteTableName($tableName);
            if ($value === null) {
                $key = reset($table->primaryKey);
                $value = $this->db->createCommand("SELECT MAX(`$key`) FROM $tableName")->queryScalar() + 1;
            } else {
                $value = (int) $value;
            }

            return "ALTER TABLE $tableName AUTO_INCREMENT=$value";
        } elseif ($table === null) {
            throw new InvalidParamException("Table not found: $tableName");
        } else {
            throw new InvalidParamException("There is no sequence associated with table '$tableName'.");
        }
    }

    /**
     * Builds a SQL statement for enabling or disabling integrity check.
     * @param bool $check whether to turn on or off the integrity check.
     * @param string $schema the schema of the tables. Meaningless for MySQL.
     * @param string $table the table name. Meaningless for MySQL.
     * @return string the SQL statement for checking integrity
     */
    public function checkIntegrity($check = true, $schema = '', $table = '')
    {
        return 'SET FOREIGN_KEY_CHECKS = ' . ($check ? 1 : 0);
    }

    /**
     * @inheritdoc
     */
    public function buildLimit($limit, $offset)
    {
        $sql = '';
        if ($this->hasLimit($limit)) {
            $sql = 'LIMIT ' . $limit;
            if ($this->hasOffset($offset)) {
                $sql .= ' OFFSET ' . $offset;
            }
        } elseif ($this->hasOffset($offset)) {
            // limit is not optional in MySQL
            // http://stackoverflow.com/a/271650/1106908
            // http://dev.mysql.com/doc/refman/5.0/en/select.html#idm47619502796240
            $sql = "LIMIT $offset, 18446744073709551615"; // 2^64-1
        }

        return $sql;
    }

    /**
     * @inheritdoc
     */
    public function insert($table, $columns, &$params)
    {
        $schema = $this->db->getSchema();
        if (($tableSchema = $schema->getTableSchema($table)) !== null) {
            $columnSchemas = $tableSchema->columns;
        } else {
            $columnSchemas = [];
        }
        $names = [];
        $placeholders = [];
        $values = ' DEFAULT VALUES';
        if ($columns instanceof \yii\db\Query) {
            list($names, $values) = $this->prepareInsertSelectSubQuery($columns, $schema);
        } else {
            foreach ($columns as $name => $value) {
                $names[] = $schema->quoteColumnName($name);
                if ($value instanceof Expression) {
                    $placeholders[] = $value->expression;
                    foreach ($value->params as $n => $v) {
                        $params[$n] = $v;
                    }
                } elseif ($value instanceof \yii\db\Query) {
                    list($sql, $params) = $this->build($value, $params);
                    $placeholders[] = "($sql)";
                } else {
                    $phName = self::PARAM_PREFIX . count($params);
                    $placeholders[] = $phName;
                    $params[$phName] = !is_array($value) && isset($columnSchemas[$name]) ? $columnSchemas[$name]->dbTypecast($value) : $value;
                }
            }
            if (empty($names) && $tableSchema !== null) {
                $columns = !empty($tableSchema->primaryKey) ? $tableSchema->primaryKey : [reset($tableSchema->columns)->name];
                foreach ($columns as $name) {
                    $names[] = $schema->quoteColumnName($name);
                    $placeholders[] = 'DEFAULT';
                }
            }
        }

        return 'INSERT INTO ' . $schema->quoteTableName($table)
            . (!empty($names) ? ' (' . implode(', ', $names) . ')' : '')
            . (!empty($placeholders) ? ' VALUES (' . implode(', ', $placeholders) . ')' : $values);
    }

    /**
     * @inheritdoc
     * @since 2.0.8
     */
    public function addCommentOnColumn($table, $column, $comment)
    {
        $definition = $this->getColumnDefinition($table, $column);
        $definition = trim(preg_replace("/COMMENT '(.*?)'/i", '', $definition));

        return 'ALTER TABLE ' . $this->db->quoteTableName($table)
            . ' CHANGE ' . $this->db->quoteColumnName($column)
            . ' ' . $this->db->quoteColumnName($column)
            . (empty($definition) ? '' : ' ' . $definition)
            . ' COMMENT ' . $this->db->quoteValue($comment);
    }

    /**
     * @inheritdoc
     * @since 2.0.8
     */
    public function addCommentOnTable($table, $comment)
    {
        return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' COMMENT ' . $this->db->quoteValue($comment);
    }

    /**
     * @inheritdoc
     * @since 2.0.8
     */
    public function dropCommentFromColumn($table, $column)
    {
        return $this->addCommentOnColumn($table, $column, '');
    }

    /**
     * @inheritdoc
     * @since 2.0.8
     */
    public function dropCommentFromTable($table)
    {
        return $this->addCommentOnTable($table, '');
    }


    /**
     * Gets column definition.
     *
     * @param string $table table name
     * @param string $column column name
     * @return null|string the column definition
     * @throws Exception in case when table does not contain column
     */
    private function getColumnDefinition($table, $column)
    {
        $quotedTable = $this->db->quoteTableName($table);
        $row = $this->db->createCommand('SHOW CREATE TABLE ' . $quotedTable)->queryOne();
        if ($row === false) {
            throw new Exception("Unable to find column '$column' in table '$table'.");
        }
        if (isset($row['Create Table'])) {
            $sql = $row['Create Table'];
        } else {
            $row = array_values($row);
            $sql = $row[1];
        }
        if (preg_match_all('/^\s*`(.*?)`\s+(.*?),?$/m', $sql, $matches)) {
            foreach ($matches[1] as $i => $c) {
                if ($c === $column) {
                    return $matches[2][$i];
                }
            }
        }
        return null;
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\db\mysql;
9
10		use yii\base\InvalidParamException;
11		use yii\db\Exception;
12		use yii\db\Expression;
13
14		/**
15		* QueryBuilder is the query builder for MySQL databases.
16		*
17		* @author Qiang Xue <[email protected]>
18		* @since 2.0
19		*/
20		class QueryBuilder extends \yii\db\QueryBuilder
21		{
22		/**
23		* @var array mapping from abstract column types (keys) to physical column types (values).
24		*/
25		public $typeMap = [
26		Schema::TYPE_PK => 'int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY',
27		Schema::TYPE_UPK => 'int(10) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY',
28		Schema::TYPE_BIGPK => 'bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY',
29		Schema::TYPE_UBIGPK => 'bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY',
30		Schema::TYPE_CHAR => 'char(1)',
31		Schema::TYPE_STRING => 'varchar(255)',
32		Schema::TYPE_TEXT => 'text',
33		Schema::TYPE_SMALLINT => 'smallint(6)',
34		Schema::TYPE_INTEGER => 'int(11)',
35		Schema::TYPE_BIGINT => 'bigint(20)',
36		Schema::TYPE_FLOAT => 'float',
37		Schema::TYPE_DOUBLE => 'double',
38		Schema::TYPE_DECIMAL => 'decimal(10,0)',
39		Schema::TYPE_DATETIME => 'datetime',
40		Schema::TYPE_TIMESTAMP => 'timestamp',
41		Schema::TYPE_TIME => 'time',
42		Schema::TYPE_DATE => 'date',
43		Schema::TYPE_BINARY => 'blob',
44		Schema::TYPE_BOOLEAN => 'tinyint(1)',
45		Schema::TYPE_MONEY => 'decimal(19,4)',
46		];
47
48
49		/**
50		* Builds a SQL statement for renaming a column.
51		* @param string $table the table whose column is to be renamed. The name will be properly quoted by the method.
52		* @param string $oldName the old name of the column. The name will be properly quoted by the method.
53		* @param string $newName the new name of the column. The name will be properly quoted by the method.
54		* @return string the SQL statement for renaming a DB column.
55		* @throws Exception
56		*/
57		public function renameColumn($table, $oldName, $newName)
58		{
59		$quotedTable = $this->db->quoteTableName($table);
60		$row = $this->db->createCommand('SHOW CREATE TABLE ' . $quotedTable)->queryOne();
61		if ($row === false) {
62		throw new Exception("Unable to find column '$oldName' in table '$table'.");
63		}
64		if (isset($row['Create Table'])) {
65		$sql = $row['Create Table'];
66		} else {
67		$row = array_values($row);
68		$sql = $row[1];
69		}
70		if (preg_match_all('/^\s`(.?)`\s+(.*?),?$/m', $sql, $matches)) {
71		foreach ($matches[1] as $i => $c) {
72		if ($c === $oldName) {
73		return "ALTER TABLE $quotedTable CHANGE "
74		. $this->db->quoteColumnName($oldName) . ' '
75		. $this->db->quoteColumnName($newName) . ' '
76		. $matches[2][$i];
77		}
78		}
79		}
80		// try to give back a SQL anyway
81		return "ALTER TABLE $quotedTable CHANGE "
82		. $this->db->quoteColumnName($oldName) . ' '
83		. $this->db->quoteColumnName($newName);
84		}
85
86		/**
87		* @inheritdoc
88		* @see https://bugs.mysql.com/bug.php?id=48875
89		*/
90	1	public function createIndex($name, $table, $columns, $unique = false)
91		{
92		return 'ALTER TABLE '
93	1	. $this->db->quoteTableName($table)
94	1	. ($unique ? ' ADD UNIQUE INDEX ' : ' ADD INDEX ')
95	1	. $this->db->quoteTableName($name)
96	1	. ' (' . $this->buildColumns($columns) . ')';
97		}
98
99		/**
100		* Builds a SQL statement for dropping a foreign key constraint.
101		* @param string $name the name of the foreign key constraint to be dropped. The name will be properly quoted by the method.
102		* @param string $table the table whose foreign is to be dropped. The name will be properly quoted by the method.
103		* @return string the SQL statement for dropping a foreign key constraint.
104		*/
105		public function dropForeignKey($name, $table)
106		{
107		return 'ALTER TABLE ' . $this->db->quoteTableName($table)
108		. ' DROP FOREIGN KEY ' . $this->db->quoteColumnName($name);
109		}
110
111		/**
112		* Builds a SQL statement for removing a primary key constraint to an existing table.
113		* @param string $name the name of the primary key constraint to be removed.
114		* @param string $table the table that the primary key constraint will be removed from.
115		* @return string the SQL statement for removing a primary key constraint from an existing table.
116		*/
117	1	public function dropPrimaryKey($name, $table)
118		{
119	1	return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' DROP PRIMARY KEY';
120		}
121
122		/**
123		* Creates a SQL statement for resetting the sequence value of a table's primary key.
124		* The sequence will be reset such that the primary key of the next new row inserted
125		* will have the specified value or 1.
126		* @param string $tableName the name of the table whose primary key sequence will be reset
127		* @param mixed $value the value for the primary key of the next new row inserted. If this is not set,
128		* the next new row's primary key will have a value 1.
129		* @return string the SQL statement for resetting sequence
130		* @throws InvalidParamException if the table does not exist or there is no sequence associated with the table.
131		*/
132	3	public function resetSequence($tableName, $value = null)
133		{
134	3	$table = $this->db->getTableSchema($tableName);
135	3	if ($table !== null && $table->sequenceName !== null) {
136	3	$tableName = $this->db->quoteTableName($tableName);
137	3	if ($value === null) {
138	1	$key = reset($table->primaryKey);
139	1	$value = $this->db->createCommand("SELECT MAX(`$key`) FROM $tableName")->queryScalar() + 1;
140	1	} else {
141	3	$value = (int) $value;
142		}
143
144	3	return "ALTER TABLE $tableName AUTO_INCREMENT=$value";
145		} elseif ($table === null) {
146		throw new InvalidParamException("Table not found: $tableName");
147		} else {
148		throw new InvalidParamException("There is no sequence associated with table '$tableName'.");
149		}
150		}
151
152		/**
153		* Builds a SQL statement for enabling or disabling integrity check.
154		* @param bool $check whether to turn on or off the integrity check.
155		* @param string $schema the schema of the tables. Meaningless for MySQL.
156		* @param string $table the table name. Meaningless for MySQL.
157		* @return string the SQL statement for checking integrity
158		*/
159	4	public function checkIntegrity($check = true, $schema = '', $table = '')
160		{
161	4	return 'SET FOREIGN_KEY_CHECKS = ' . ($check ? 1 : 0);
162		}
163
164		/**
165		* @inheritdoc
166		*/
167	325	public function buildLimit($limit, $offset)
168		{
169	325	$sql = '';
170	325	if ($this->hasLimit($limit)) {
171	13	$sql = 'LIMIT ' . $limit;
172	13	if ($this->hasOffset($offset)) {
173	1	$sql .= ' OFFSET ' . $offset;
174	1	}
175	325	} elseif ($this->hasOffset($offset)) {
176		// limit is not optional in MySQL
177		// http://stackoverflow.com/a/271650/1106908
178		// http://dev.mysql.com/doc/refman/5.0/en/select.html#idm47619502796240
179	2	$sql = "LIMIT $offset, 18446744073709551615"; // 2^64-1
180	2	}
181
182	325	return $sql;
183		}
184
185		/**
186		* @inheritdoc
187		*/
188	141	public function insert($table, $columns, &$params)
189		{
190	141	$schema = $this->db->getSchema();
191	141	if (($tableSchema = $schema->getTableSchema($table)) !== null) {
192	140	$columnSchemas = $tableSchema->columns;
193	140	} else {
194	2	$columnSchemas = [];
195		}
196	141	$names = [];
197	141	$placeholders = [];
198	141	$values = ' DEFAULT VALUES';
199	141	if ($columns instanceof \yii\db\Query) {
200	5	list($names, $values) = $this->prepareInsertSelectSubQuery($columns, $schema);
201	2	} else {
202	138	foreach ($columns as $name => $value) {
203	137	$names[] = $schema->quoteColumnName($name);
204	137	if ($value instanceof Expression) {
205	1	$placeholders[] = $value->expression;
206	1	foreach ($value->params as $n => $v) {
207		$params[$n] = $v;
208	1	}
209	137	} elseif ($value instanceof \yii\db\Query) {
210	1	list($sql, $params) = $this->build($value, $params);
211	1	$placeholders[] = "($sql)";
212	1	} else {
213	137	$phName = self::PARAM_PREFIX . count($params);
214	137	$placeholders[] = $phName;
215	137	$params[$phName] = !is_array($value) && isset($columnSchemas[$name]) ? $columnSchemas[$name]->dbTypecast($value) : $value;
216		}
217	138	}
218	138	if (empty($names) && $tableSchema !== null) {
219	1	$columns = !empty($tableSchema->primaryKey) ? $tableSchema->primaryKey : [reset($tableSchema->columns)->name];
220	1	foreach ($columns as $name) {
221	1	$names[] = $schema->quoteColumnName($name);
222	1	$placeholders[] = 'DEFAULT';
223	1	}
224	1	}
225		}
226
227	138	return 'INSERT INTO ' . $schema->quoteTableName($table)
228	138	. (!empty($names) ? ' (' . implode(', ', $names) . ')' : '')
229	138	. (!empty($placeholders) ? ' VALUES (' . implode(', ', $placeholders) . ')' : $values);
230		}
231
232		/**
233		* @inheritdoc
234		* @since 2.0.8
235		*/
236	1	public function addCommentOnColumn($table, $column, $comment)
237		{
238	1	$definition = $this->getColumnDefinition($table, $column);
239	1	$definition = trim(preg_replace("/COMMENT '(.*?)'/i", '', $definition));
240
241	1	return 'ALTER TABLE ' . $this->db->quoteTableName($table)
242	1	. ' CHANGE ' . $this->db->quoteColumnName($column)
243	1	. ' ' . $this->db->quoteColumnName($column)
244	1	. (empty($definition) ? '' : ' ' . $definition)
245	1	. ' COMMENT ' . $this->db->quoteValue($comment);
246		}
247
248		/**
249		* @inheritdoc
250		* @since 2.0.8
251		*/
252	1	public function addCommentOnTable($table, $comment)
253		{
254	1	return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' COMMENT ' . $this->db->quoteValue($comment);
255		}
256
257		/**
258		* @inheritdoc
259		* @since 2.0.8
260		*/
261	1	public function dropCommentFromColumn($table, $column)
262		{
263	1	return $this->addCommentOnColumn($table, $column, '');
264		}
265
266		/**
267		* @inheritdoc
268		* @since 2.0.8
269		*/
270	1	public function dropCommentFromTable($table)
271		{
272	1	return $this->addCommentOnTable($table, '');
273		}
274
275
276		/**
277		* Gets column definition.
278		*
279		* @param string $table table name
280		* @param string $column column name
281		* @return null\|string the column definition
282		* @throws Exception in case when table does not contain column
283		*/
284	1	private function getColumnDefinition($table, $column)
285		{
286	1	$quotedTable = $this->db->quoteTableName($table);
287	1	$row = $this->db->createCommand('SHOW CREATE TABLE ' . $quotedTable)->queryOne();
288	1	if ($row === false) {
289		throw new Exception("Unable to find column '$column' in table '$table'.");
290		}
291	1	if (isset($row['Create Table'])) {
292	1	$sql = $row['Create Table'];
293	1	} else {
294		$row = array_values($row);
295		$sql = $row[1];
296		}
297	1	if (preg_match_all('/^\s`(.?)`\s+(.*?),?$/m', $sql, $matches)) {
298	1	foreach ($matches[1] as $i => $c) {
299	1	if ($c === $column) {
300	1	return $matches[2][$i];
301		}
302	1	}
303		}
304		return null;
305		}
306		}
307

yiisoft / yii2

Push — master ( fab53b...ab36cb )

QueryBuilder::dropPrimaryKey() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like