QueryBuilder::selectExists() - Code Metrics - Inspection of "Sync to master branch." - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 22.0 (#20401)

by Wilmer

created 2025-06-09 12:55 UTC

QueryBuilder::selectExists() A

↳ Parent: QueryBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

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

namespace yii\db\mysql;

use yii\base\InvalidArgumentException;
use yii\base\NotSupportedException;
use yii\caching\CacheInterface;
use yii\caching\DbCache;
use yii\db\Exception;
use yii\db\Expression;
use yii\db\Query;

/**
 * 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_TINYINT => 'tinyint(3)',
        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_DATE => 'date',
        Schema::TYPE_BINARY => 'blob',
        Schema::TYPE_BOOLEAN => 'tinyint(1)',
        Schema::TYPE_MONEY => 'decimal(19,4)',
        Schema::TYPE_JSON => 'json'
    ];


    /**
     * {@inheritdoc}
     */
    public function init()
    {
        parent::init();

        $this->typeMap = array_merge($this->typeMap, $this->defaultTimeTypeMap());
    }

    /**
     * {@inheritdoc}
     */
    protected function defaultExpressionBuilders()
    {
        return array_merge(parent::defaultExpressionBuilders(), [
            'yii\db\JsonExpression' => 'yii\db\mysql\JsonExpressionBuilder',
        ]);
    }

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

    /**
     * {@inheritdoc}
     */
    public function dropUnique($name, $table)
    {
        return $this->dropIndex($name, $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 $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 InvalidArgumentException 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 InvalidArgumentException("Table not found: $tableName");
        }

        throw new InvalidArgumentException("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
            // https://stackoverflow.com/questions/255517/mysql-offset-infinite-rows/271650#271650
            // https://dev.mysql.com/doc/refman/5.7/en/select.html#idm46193796386608
            $sql = "LIMIT $offset, 18446744073709551615"; // 2^64-1
        }

        return $sql;
    }

    /**
     * {@inheritdoc}
     */
    protected function hasLimit($limit)
    {
        // In MySQL limit argument must be nonnegative integer constant
        return ctype_digit((string) $limit);
    }

    /**
     * {@inheritdoc}
     */
    protected function hasOffset($offset)
    {
        // In MySQL offset argument must be nonnegative integer constant
        $offset = (string) $offset;
        return ctype_digit($offset) && $offset !== '0';
    }

    /**
     * {@inheritdoc}
     */
    protected function prepareInsertValues($table, $columns, $params = [])
    {
        list($names, $placeholders, $values, $params) = parent::prepareInsertValues($table, $columns, $params);
        if (!$columns instanceof Query && empty($names)) {
            $tableSchema = $this->db->getSchema()->getTableSchema($table);
            if ($tableSchema !== null) {
                if (!empty($tableSchema->primaryKey)) {
                    $columns = $tableSchema->primaryKey;
                    $defaultValue = 'NULL';
                } else {
                    $columns = [reset($tableSchema->columns)->name];
                    $defaultValue = 'DEFAULT';
                }

                foreach ($columns as $name) {
                    $names[] = $this->db->quoteColumnName($name);
                    $placeholders[] = $defaultValue;
                }
            }
        }
        return [$names, $placeholders, $values, $params];
    }

    /**
     * {@inheritdoc}
     * @see https://downloads.mysql.com/docs/refman-5.1-en.pdf
     */
    public function upsert($table, $insertColumns, $updateColumns, &$params)
    {
        $insertSql = $this->insert($table, $insertColumns, $params);
        list($uniqueNames, , $updateNames) = $this->prepareUpsertColumns($table, $insertColumns, $updateColumns);
        if (empty($uniqueNames)) {
            return $insertSql;
        }
        if ($updateNames === []) {
            // there are no columns to update
            $updateColumns = false;
        }

        if ($updateColumns === true) {
            $updateColumns = [];
            foreach ($updateNames as $name) {
                $updateColumns[$name] = new Expression('VALUES(' . $this->db->quoteColumnName($name) . ')');
            }
        } elseif ($updateColumns === false) {
            $name = $this->db->quoteColumnName(reset($uniqueNames));
            $updateColumns = [$name => new Expression($this->db->quoteTableName($table) . '.' . $name)];
        }
        list($updates, $params) = $this->prepareUpdateSets($table, $updateColumns, $params);
        return $insertSql . ' ON DUPLICATE KEY UPDATE ' . implode(', ', $updates);
    }

    /**
     * {@inheritdoc}
     * @since 2.0.8
     */
    public function addCommentOnColumn($table, $column, $comment)
    {
        // Strip existing comment which may include escaped quotes
        $definition = trim(preg_replace("/COMMENT '(?:''|[^'])*'/i", '', $this->getColumnDefinition($table, $column)));

        $checkRegex = '/CHECK *(\(([^()]|(?-2))*\))/';
        $check = preg_match($checkRegex, $definition, $checkMatches);
        if ($check === 1) {
            $definition = preg_replace($checkRegex, '', $definition);
        }
        $alterSql = 'ALTER TABLE ' . $this->db->quoteTableName($table)
            . ' CHANGE ' . $this->db->quoteColumnName($column)
            . ' ' . $this->db->quoteColumnName($column)
            . (empty($definition) ? '' : ' ' . $definition)
            . ' COMMENT ' . $this->db->quoteValue($comment);
        if ($check === 1) {
            $alterSql .= ' ' . $checkMatches[0];
        }
        return $alterSql;
    }

    /**
     * {@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, '');
    }

    /**
     * {@inheritdoc}
     * @since 2.0.8
     */
    public function selectExists($rawSql)
    {
        return 'SELECT EXISTS(' . $rawSql . ') AS ' . $this->db->quoteColumnName('result');
    }

    /**
     * Gets column definition.
     *
     * @param string $table table name
     * @param string $column column name
     * @return string|null 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;
    }

    /**
     * Checks the ability to use fractional seconds.
     *
     * @return bool
     * @see https://dev.mysql.com/doc/refman/5.6/en/fractional-seconds.html
     */
    private function supportsFractionalSeconds()
    {
        // use cache to prevent opening MySQL connection
        // https://github.com/yiisoft/yii2/issues/13749#issuecomment-481657224
        $key = [__METHOD__, $this->db->dsn];
        $cache = null;
        $schemaCache = (\Yii::$app && is_string($this->db->schemaCache)) ? \Yii::$app->get($this->db->schemaCache, false) : $this->db->schemaCache;
        // If the `$schemaCache` is an instance of `DbCache` we don't use it to avoid a loop
        if ($this->db->enableSchemaCache && $schemaCache instanceof CacheInterface && !($schemaCache instanceof DbCache)) {
            $cache = $schemaCache;
        }
        $version = $cache ? $cache->get($key) : null;
        if (!$version) {
            $version = $this->db->getSlavePdo(true)->getAttribute(\PDO::ATTR_SERVER_VERSION);
            if ($cache) {
                $cache->set($key, $version, $this->db->schemaCacheDuration);
            }
        }

        return version_compare($version, '5.6.4', '>=');

    }

    /**
     * Returns the map for default time type.
     * If the version of MySQL is lower than 5.6.4, then the types will be without fractional seconds,
     * otherwise with fractional seconds.
     *
     * @return array
     */
    private function defaultTimeTypeMap()
    {
        $map = [
            Schema::TYPE_DATETIME => 'datetime',
            Schema::TYPE_TIMESTAMP => 'timestamp',
            Schema::TYPE_TIME => 'time',
        ];

        if ($this->supportsFractionalSeconds()) {
            $map = [
                Schema::TYPE_DATETIME => 'datetime(0)',
                Schema::TYPE_TIMESTAMP => 'timestamp(0)',
                Schema::TYPE_TIME => 'time(0)',
            ];
        }

        return $map;
    }
}


1			<?php
2			/**
3			* @link https://www.yiiframework.com/
4			* @copyright Copyright (c) 2008 Yii Software LLC
5			* @license https://www.yiiframework.com/license/
6			*/
7
8			namespace yii\db\mysql;
9
10			use yii\base\InvalidArgumentException;
11			use yii\base\NotSupportedException;
12			use yii\caching\CacheInterface;
13			use yii\caching\DbCache;
14			use yii\db\Exception;
15			use yii\db\Expression;
16			use yii\db\Query;
17
18			/**
19			* QueryBuilder is the query builder for MySQL databases.
20			*
21			* @author Qiang Xue <[email protected]>
22			* @since 2.0
23			*/
24			class QueryBuilder extends \yii\db\QueryBuilder
25			{
26			/**
27			* @var array mapping from abstract column types (keys) to physical column types (values).
28			*/
29			public $typeMap = [
30			Schema::TYPE_PK => 'int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY',
31			Schema::TYPE_UPK => 'int(10) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY',
32			Schema::TYPE_BIGPK => 'bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY',
33			Schema::TYPE_UBIGPK => 'bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY',
34			Schema::TYPE_CHAR => 'char(1)',
35			Schema::TYPE_STRING => 'varchar(255)',
36			Schema::TYPE_TEXT => 'text',
37			Schema::TYPE_TINYINT => 'tinyint(3)',
38			Schema::TYPE_SMALLINT => 'smallint(6)',
39			Schema::TYPE_INTEGER => 'int(11)',
40			Schema::TYPE_BIGINT => 'bigint(20)',
41			Schema::TYPE_FLOAT => 'float',
42			Schema::TYPE_DOUBLE => 'double',
43			Schema::TYPE_DECIMAL => 'decimal(10,0)',
44			Schema::TYPE_DATE => 'date',
45			Schema::TYPE_BINARY => 'blob',
46			Schema::TYPE_BOOLEAN => 'tinyint(1)',
47			Schema::TYPE_MONEY => 'decimal(19,4)',
48			Schema::TYPE_JSON => 'json'
49			];
50
51
52			/**
53			* {@inheritdoc}
54			*/
55			public function init()
56			{
57			parent::init();
58
59			$this->typeMap = array_merge($this->typeMap, $this->defaultTimeTypeMap());
60			}
61
62			/**
63			* {@inheritdoc}
64			*/
65			protected function defaultExpressionBuilders()
66			{
67			return array_merge(parent::defaultExpressionBuilders(), [
68			'yii\db\JsonExpression' => 'yii\db\mysql\JsonExpressionBuilder',
69			]);
70			}
71
72			/**
73			* Builds a SQL statement for renaming a column.
74			* @param string $table the table whose column is to be renamed. The name will be properly quoted by the method.
75			* @param string $oldName the old name of the column. The name will be properly quoted by the method.
76			* @param string $newName the new name of the column. The name will be properly quoted by the method.
77			* @return string the SQL statement for renaming a DB column.
78			* @throws Exception
79			*/
80			public function renameColumn($table, $oldName, $newName)
81			{
82			$quotedTable = $this->db->quoteTableName($table);
83			$row = $this->db->createCommand('SHOW CREATE TABLE ' . $quotedTable)->queryOne();
84			if ($row === false) {
85			throw new Exception("Unable to find column '$oldName' in table '$table'.");
86			}
87			if (isset($row['Create Table'])) {
88			$sql = $row['Create Table'];
89			} else {
90			$row = array_values($row);
91			$sql = $row[1];
92			}
93			if (preg_match_all('/^\s[`"](.?)[`"]\s+(.*?),?$/m', $sql, $matches)) {
94			foreach ($matches[1] as $i => $c) {
95			if ($c === $oldName) {
96			return "ALTER TABLE $quotedTable CHANGE "
97			. $this->db->quoteColumnName($oldName) . ' '
98			. $this->db->quoteColumnName($newName) . ' '
99			. $matches[2][$i];
100			}
101			}
102			}
103			// try to give back a SQL anyway
104			return "ALTER TABLE $quotedTable CHANGE "
105			. $this->db->quoteColumnName($oldName) . ' '
106			. $this->db->quoteColumnName($newName);
107			}
108
109			/**
110			* {@inheritdoc}
111			* @see https://bugs.mysql.com/bug.php?id=48875
112			*/
113			public function createIndex($name, $table, $columns, $unique = false)
114			{
115			return 'ALTER TABLE '
116			. $this->db->quoteTableName($table)
117			. ($unique ? ' ADD UNIQUE INDEX ' : ' ADD INDEX ')
118			. $this->db->quoteTableName($name)
119			. ' (' . $this->buildColumns($columns) . ')';
120			}
121
122			/**
123			* Builds a SQL statement for dropping a foreign key constraint.
124			* @param string $name the name of the foreign key constraint to be dropped. The name will be properly quoted by the method.
125			* @param string $table the table whose foreign is to be dropped. The name will be properly quoted by the method.
126			* @return string the SQL statement for dropping a foreign key constraint.
127			*/
128			public function dropForeignKey($name, $table)
129			{
130			return 'ALTER TABLE ' . $this->db->quoteTableName($table)
131			. ' DROP FOREIGN KEY ' . $this->db->quoteColumnName($name);
132			}
133
134			/**
135			* Builds a SQL statement for removing a primary key constraint to an existing table.
136			* @param string $name the name of the primary key constraint to be removed.
137			* @param string $table the table that the primary key constraint will be removed from.
138			* @return string the SQL statement for removing a primary key constraint from an existing table.
139			*/
140			public function dropPrimaryKey($name, $table)
141			{
142			return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' DROP PRIMARY KEY';
143			}
144
145			/**
146			* {@inheritdoc}
147			*/
148			public function dropUnique($name, $table)
149			{
150			return $this->dropIndex($name, $table);
151			}
152
153			/**
154			* Creates a SQL statement for resetting the sequence value of a table's primary key.
155			* The sequence will be reset such that the primary key of the next new row inserted
156			* will have the specified value or 1.
157			* @param string $tableName the name of the table whose primary key sequence will be reset
158			* @param mixed $value the value for the primary key of the next new row inserted. If this is not set,
159			* the next new row's primary key will have a value 1.
160			* @return string the SQL statement for resetting sequence
161			* @throws InvalidArgumentException if the table does not exist or there is no sequence associated with the table.
162			*/
163			public function resetSequence($tableName, $value = null)
164			{
165			$table = $this->db->getTableSchema($tableName);
166			if ($table !== null && $table->sequenceName !== null) {
167			$tableName = $this->db->quoteTableName($tableName);
168			if ($value === null) {
169			$key = reset($table->primaryKey);
170			$value = $this->db->createCommand("SELECT MAX(`$key`) FROM $tableName")->queryScalar() + 1;
171			} else {
172			$value = (int) $value;
173			}
174
175			return "ALTER TABLE $tableName AUTO_INCREMENT=$value";
176			} elseif ($table === null) {
177			throw new InvalidArgumentException("Table not found: $tableName");
178			}
179
180			throw new InvalidArgumentException("There is no sequence associated with table '$tableName'.");
181			}
182
183			/**
184			* Builds a SQL statement for enabling or disabling integrity check.
185			* @param bool $check whether to turn on or off the integrity check.
186			* @param string $schema the schema of the tables. Meaningless for MySQL.
187			* @param string $table the table name. Meaningless for MySQL.
188			* @return string the SQL statement for checking integrity
189			*/
190			public function checkIntegrity($check = true, $schema = '', $table = '')
191			{
192			return 'SET FOREIGN_KEY_CHECKS = ' . ($check ? 1 : 0);
193			}
194
195			/**
196			* {@inheritdoc}
197			*/
198			public function buildLimit($limit, $offset)
199			{
200			$sql = '';
201			if ($this->hasLimit($limit)) {
202			$sql = 'LIMIT ' . $limit;
203			if ($this->hasOffset($offset)) {
204			$sql .= ' OFFSET ' . $offset;
205			}
206			} elseif ($this->hasOffset($offset)) {
207			// limit is not optional in MySQL
208			// https://stackoverflow.com/questions/255517/mysql-offset-infinite-rows/271650#271650
209			// https://dev.mysql.com/doc/refman/5.7/en/select.html#idm46193796386608
210			$sql = "LIMIT $offset, 18446744073709551615"; // 2^64-1
211			}
212
213			return $sql;
214			}
215
216			/**
217			* {@inheritdoc}
218			*/
219			protected function hasLimit($limit)
220			{
221			// In MySQL limit argument must be nonnegative integer constant
222			return ctype_digit((string) $limit);
223			}
224
225			/**
226			* {@inheritdoc}
227			*/
228			protected function hasOffset($offset)
229			{
230			// In MySQL offset argument must be nonnegative integer constant
231			$offset = (string) $offset;
232			return ctype_digit($offset) && $offset !== '0';
233			}
234
235			/**
236			* {@inheritdoc}
237			*/
238			protected function prepareInsertValues($table, $columns, $params = [])
239			{
240			list($names, $placeholders, $values, $params) = parent::prepareInsertValues($table, $columns, $params);
241			if (!$columns instanceof Query && empty($names)) {
242			$tableSchema = $this->db->getSchema()->getTableSchema($table);
243			if ($tableSchema !== null) {
244			if (!empty($tableSchema->primaryKey)) {
245			$columns = $tableSchema->primaryKey;
246			$defaultValue = 'NULL';
247			} else {
248			$columns = [reset($tableSchema->columns)->name];
249			$defaultValue = 'DEFAULT';
250			}
251
252			foreach ($columns as $name) {
253			$names[] = $this->db->quoteColumnName($name);
254			$placeholders[] = $defaultValue;
255			}
256			}
257			}
258			return [$names, $placeholders, $values, $params];
259			}
260
261			/**
262			* {@inheritdoc}
263			* @see https://downloads.mysql.com/docs/refman-5.1-en.pdf
264			*/
265			public function upsert($table, $insertColumns, $updateColumns, &$params)
266			{
267			$insertSql = $this->insert($table, $insertColumns, $params);
268			list($uniqueNames, , $updateNames) = $this->prepareUpsertColumns($table, $insertColumns, $updateColumns);
269			if (empty($uniqueNames)) {
270			return $insertSql;
271			}
272			if ($updateNames === []) {
273			// there are no columns to update
274			$updateColumns = false;
275			}
276
277			if ($updateColumns === true) {
278			$updateColumns = [];
279			foreach ($updateNames as $name) {
280			$updateColumns[$name] = new Expression('VALUES(' . $this->db->quoteColumnName($name) . ')');
281			}
282			} elseif ($updateColumns === false) {
283			$name = $this->db->quoteColumnName(reset($uniqueNames));
284			$updateColumns = [$name => new Expression($this->db->quoteTableName($table) . '.' . $name)];
285			}
286			list($updates, $params) = $this->prepareUpdateSets($table, $updateColumns, $params);
287			return $insertSql . ' ON DUPLICATE KEY UPDATE ' . implode(', ', $updates);
288			}
289
290			/**
291			* {@inheritdoc}
292			* @since 2.0.8
293			*/
294			public function addCommentOnColumn($table, $column, $comment)
295			{
296			// Strip existing comment which may include escaped quotes
297			$definition = trim(preg_replace("/COMMENT '(?:''\|[^'])*'/i", '', $this->getColumnDefinition($table, $column)));
298
299			$checkRegex = '/CHECK (\(([^()]\|(?-2))\))/';
300			$check = preg_match($checkRegex, $definition, $checkMatches);
301			if ($check === 1) {
302			$definition = preg_replace($checkRegex, '', $definition);
303			}
304			$alterSql = 'ALTER TABLE ' . $this->db->quoteTableName($table)
305			. ' CHANGE ' . $this->db->quoteColumnName($column)
306			. ' ' . $this->db->quoteColumnName($column)
307			. (empty($definition) ? '' : ' ' . $definition)
308			. ' COMMENT ' . $this->db->quoteValue($comment);
309			if ($check === 1) {
310			$alterSql .= ' ' . $checkMatches[0];
311			}
312			return $alterSql;
313			}
314
315			/**
316			* {@inheritdoc}
317			* @since 2.0.8
318			*/
319			public function addCommentOnTable($table, $comment)
320			{
321			return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' COMMENT ' . $this->db->quoteValue($comment);
322			}
323
324			/**
325			* {@inheritdoc}
326			* @since 2.0.8
327			*/
328			public function dropCommentFromColumn($table, $column)
329			{
330			return $this->addCommentOnColumn($table, $column, '');
331			}
332
333			/**
334			* {@inheritdoc}
335			* @since 2.0.8
336			*/
337			public function dropCommentFromTable($table)
338			{
339			return $this->addCommentOnTable($table, '');
340			}
341
342			/**
343			* {@inheritdoc}
344			* @since 2.0.8
345			*/
346			public function selectExists($rawSql)
347			{
348			return 'SELECT EXISTS(' . $rawSql . ') AS ' . $this->db->quoteColumnName('result');
349			}
350
351			/**
352			* Gets column definition.
353			*
354			* @param string $table table name
355			* @param string $column column name
356			* @return string\|null the column definition
357			* @throws Exception in case when table does not contain column
358			*/
359			private function getColumnDefinition($table, $column)
360			{
361			$quotedTable = $this->db->quoteTableName($table);
362			$row = $this->db->createCommand('SHOW CREATE TABLE ' . $quotedTable)->queryOne();
363			if ($row === false) {
364			throw new Exception("Unable to find column '$column' in table '$table'.");
365			}
366			if (isset($row['Create Table'])) {
367			$sql = $row['Create Table'];
368			} else {
369			$row = array_values($row);
370			$sql = $row[1];
371			}
372			if (preg_match_all('/^\s[`"](.?)[`"]\s+(.*?),?$/m', $sql, $matches)) {
373			foreach ($matches[1] as $i => $c) {
374			if ($c === $column) {
375			return $matches[2][$i];
376			}
377			}
378			}
379
380			return null;
381			}
382
383			/**
384			* Checks the ability to use fractional seconds.
385			*
386			* @return bool
387			* @see https://dev.mysql.com/doc/refman/5.6/en/fractional-seconds.html
388			*/
389			private function supportsFractionalSeconds()
390			{
391			// use cache to prevent opening MySQL connection
392			// https://github.com/yiisoft/yii2/issues/13749#issuecomment-481657224
393			$key = [__METHOD__, $this->db->dsn];
394			$cache = null;
395			$schemaCache = (\Yii::$app && is_string($this->db->schemaCache)) ? \Yii::$app->get($this->db->schemaCache, false) : $this->db->schemaCache;
396			// If the `$schemaCache` is an instance of `DbCache` we don't use it to avoid a loop
397			if ($this->db->enableSchemaCache && $schemaCache instanceof CacheInterface && !($schemaCache instanceof DbCache)) {
398			$cache = $schemaCache;
399			}
400			$version = $cache ? $cache->get($key) : null;
401			if (!$version) {
402			$version = $this->db->getSlavePdo(true)->getAttribute(\PDO::ATTR_SERVER_VERSION);
403			if ($cache) {
404			$cache->set($key, $version, $this->db->schemaCacheDuration);
405			}
406			}
407
408			return version_compare($version, '5.6.4', '>=');
			0 ignored issues – show Bug Best Practice introduced 2021-01-11 08:29 UTC by Report Bug Copy Issue Report The expression `return version_compare($version, '5.6.4', '>=')` also could return the type `integer` which is incompatible with the documented return type `boolean`. Loading history...
409			}
410
411			/**
412			* Returns the map for default time type.
413			* If the version of MySQL is lower than 5.6.4, then the types will be without fractional seconds,
414			* otherwise with fractional seconds.
415			*
416			* @return array
417			*/
418			private function defaultTimeTypeMap()
419			{
420			$map = [
421			Schema::TYPE_DATETIME => 'datetime',
422			Schema::TYPE_TIMESTAMP => 'timestamp',
423			Schema::TYPE_TIME => 'time',
424			];
425
426			if ($this->supportsFractionalSeconds()) {
427			$map = [
428			Schema::TYPE_DATETIME => 'datetime(0)',
429			Schema::TYPE_TIMESTAMP => 'timestamp(0)',
430			Schema::TYPE_TIME => 'time(0)',
431			];
432			}
433
434			return $map;
435			}
436			}
437

yiisoft / yii2

Pull Request — 22.0 (#20401)

QueryBuilder::selectExists() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like