MySqlSchemaManager::_getPortableTableDefinition() - Code Metrics - Inspection of "[CS] Apply Doctrine CS 3.0 in lib" - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#3018)

by Gabriel

created 2018-02-11 15:57 UTC

MySqlSchemaManager::_getPortableTableDefinition() A

↳ Parent: MySqlSchemaManager

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

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

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\DBAL\Schema;

use Doctrine\DBAL\Platforms\MariaDb1027Platform;
use Doctrine\DBAL\Platforms\MySqlPlatform;
use Doctrine\DBAL\Types\Type;
use const CASE_LOWER;
use function array_change_key_case;
use function array_shift;
use function array_values;
use function end;
use function preg_match;
use function preg_replace;
use function str_replace;
use function stripslashes;
use function strpos;
use function strtok;
use function strtolower;

/**
 * Schema manager for the MySql RDBMS.
 *
 */
class MySqlSchemaManager extends AbstractSchemaManager
{
    /**
     * {@inheritdoc}
     */
    protected function _getPortableViewDefinition($view)
    {
        return new View($view['TABLE_NAME'], $view['VIEW_DEFINITION']);
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableDefinition($table)
    {
        return array_shift($table);
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableUserDefinition($user)
    {
        return [
            'user' => $user['User'],
            'password' => $user['Password'],
        ];
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableIndexesList($tableIndexes, $tableName = null)
    {
        foreach ($tableIndexes as $k => $v) {
            $v = array_change_key_case($v, CASE_LOWER);
            if ($v['key_name'] === 'PRIMARY') {
                $v['primary'] = true;
            } else {
                $v['primary'] = false;
            }
            if (strpos($v['index_type'], 'FULLTEXT') !== false) {
                $v['flags'] = ['FULLTEXT'];
            } elseif (strpos($v['index_type'], 'SPATIAL') !== false) {
                $v['flags'] = ['SPATIAL'];
            }
            $tableIndexes[$k] = $v;
        }

        return parent::_getPortableTableIndexesList($tableIndexes, $tableName);
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableSequenceDefinition($sequence)
    {
        return end($sequence);
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableDatabaseDefinition($database)
    {
        return $database['Database'];
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableColumnDefinition($tableColumn)
    {
        $tableColumn = array_change_key_case($tableColumn, CASE_LOWER);

        $dbType = strtolower($tableColumn['type']);
        $dbType = strtok($dbType, '(), ');
        $length = $tableColumn['length'] ?? strtok('(), ');

        $fixed = null;

        if (! isset($tableColumn['name'])) {
            $tableColumn['name'] = '';
        }

        $scale     = null;
        $precision = null;

        $type = $this->_platform->getDoctrineTypeMapping($dbType);

        // In cases where not connected to a database DESCRIBE $table does not return 'Comment'
        if (isset($tableColumn['comment'])) {
            $type                   = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
            $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type);
        }

        switch ($dbType) {
            case 'char':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
            case 'binary':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
                $fixed = true;
                break;
            case 'float':
            case 'double':
            case 'real':
            case 'numeric':
            case 'decimal':
                if (preg_match('([A-Za-z]+\(([0-9]+)\,([0-9]+)\))', $tableColumn['type'], $match)) {
                    $precision = $match[1];
                    $scale     = $match[2];
                    $length    = null;
                }
                break;
            case 'tinytext':
                $length = MySqlPlatform::LENGTH_LIMIT_TINYTEXT;
                break;
            case 'text':
                $length = MySqlPlatform::LENGTH_LIMIT_TEXT;
                break;
            case 'mediumtext':
                $length = MySqlPlatform::LENGTH_LIMIT_MEDIUMTEXT;
                break;
            case 'tinyblob':
                $length = MySqlPlatform::LENGTH_LIMIT_TINYBLOB;
                break;
            case 'blob':
                $length = MySqlPlatform::LENGTH_LIMIT_BLOB;
                break;
            case 'mediumblob':
                $length = MySqlPlatform::LENGTH_LIMIT_MEDIUMBLOB;
                break;
            case 'tinyint':
            case 'smallint':
            case 'mediumint':
            case 'int':
            case 'integer':
            case 'bigint':
            case 'year':
                $length = null;
                break;
        }

        if ($this->_platform instanceof MariaDb1027Platform) {
            $columnDefault = $this->getMariaDb1027ColumnDefault($this->_platform, $tableColumn['default']);
        } else {
            $columnDefault = $tableColumn['default'];
        }

        $options = [
            'length'        => $length !== null ? (int) $length : null,
            'unsigned'      => strpos($tableColumn['type'], 'unsigned') !== false,
            'fixed'         => (bool) $fixed,
            'default'       => $columnDefault,
            'notnull'       => $tableColumn['null'] !== 'YES',
            'scale'         => null,
            'precision'     => null,
            'autoincrement' => strpos($tableColumn['extra'], 'auto_increment') !== false,
            'comment'       => isset($tableColumn['comment']) && $tableColumn['comment'] !== ''
                ? $tableColumn['comment']
                : null,
        ];

        if ($scale !== null && $precision !== null) {
            $options['scale']     = (int) $scale;
            $options['precision'] = (int) $precision;
        }

        $column = new Column($tableColumn['field'], Type::getType($type), $options);

        if (isset($tableColumn['collation'])) {
            $column->setPlatformOption('collation', $tableColumn['collation']);
        }

        return $column;
    }

    /**
     * Return Doctrine/Mysql-compatible column default values for MariaDB 10.2.7+ servers.
     *
     * - Since MariaDb 10.2.7 column defaults stored in information_schema are now quoted
     *   to distinguish them from expressions (see MDEV-10134).
     * - CURRENT_TIMESTAMP, CURRENT_TIME, CURRENT_DATE are stored in information_schema
     *   as current_timestamp(), currdate(), currtime()
     * - Quoted 'NULL' is not enforced by Maria, it is technically possible to have
     *   null in some circumstances (see https://jira.mariadb.org/browse/MDEV-14053)
     * - \' is always stored as '' in information_schema (normalized)
     *
     * @link https://mariadb.com/kb/en/library/information-schema-columns-table/
     * @link https://jira.mariadb.org/browse/MDEV-13132
     *
     * @param null|string $columnDefault default value as stored in information_schema for MariaDB >= 10.2.7
     */
    private function getMariaDb1027ColumnDefault(MariaDb1027Platform $platform, ?string $columnDefault) : ?string
    {
        if ($columnDefault === 'NULL' || $columnDefault === null) {
            return null;
        }
        if ($columnDefault[0] === "'") {
            return stripslashes(
                str_replace(
                    "''",
                    "'",
                    preg_replace('/^\'(.*)\'$/', '$1', $columnDefault)
                )
            );
        }
        switch ($columnDefault) {
            case 'current_timestamp()':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
                return $platform->getCurrentTimestampSQL();
            case 'curdate()':
                return $platform->getCurrentDateSQL();
            case 'curtime()':
                return $platform->getCurrentTimeSQL();
        }
        return $columnDefault;
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableForeignKeysList($tableForeignKeys)
    {
        $list = [];
        foreach ($tableForeignKeys as $value) {
            $value = array_change_key_case($value, CASE_LOWER);
            if (! isset($list[$value['constraint_name']])) {
                if (! isset($value['delete_rule']) || $value['delete_rule'] === 'RESTRICT') {
                    $value['delete_rule'] = null;
                }
                if (! isset($value['update_rule']) || $value['update_rule'] === 'RESTRICT') {
                    $value['update_rule'] = null;
                }

                $list[$value['constraint_name']] = [
                    'name' => $value['constraint_name'],
                    'local' => [],
                    'foreign' => [],
                    'foreignTable' => $value['referenced_table_name'],
                    'onDelete' => $value['delete_rule'],
                    'onUpdate' => $value['update_rule'],
                ];
            }
            $list[$value['constraint_name']]['local'][]   = $value['column_name'];
            $list[$value['constraint_name']]['foreign'][] = $value['referenced_column_name'];
        }

        $result = [];
        foreach ($list as $constraint) {
            $result[] = new ForeignKeyConstraint(
                array_values($constraint['local']),
                $constraint['foreignTable'],
                array_values($constraint['foreign']),
                $constraint['name'],
                [
                    'onDelete' => $constraint['onDelete'],
                    'onUpdate' => $constraint['onUpdate'],
                ]
            );
        }

        return $result;
    }
}


1		<?php
2		/*
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*
15		* This software consists of voluntary contributions made by many individuals
16		* and is licensed under the MIT license. For more information, see
17		* <http://www.doctrine-project.org>.
18		*/
19
20		namespace Doctrine\DBAL\Schema;
21
22		use Doctrine\DBAL\Platforms\MariaDb1027Platform;
23		use Doctrine\DBAL\Platforms\MySqlPlatform;
24		use Doctrine\DBAL\Types\Type;
25		use const CASE_LOWER;
26		use function array_change_key_case;
27		use function array_shift;
28		use function array_values;
29		use function end;
30		use function preg_match;
31		use function preg_replace;
32		use function str_replace;
33		use function stripslashes;
34		use function strpos;
35		use function strtok;
36		use function strtolower;
37
38		/**
39		* Schema manager for the MySql RDBMS.
40		*
41		*/
42		class MySqlSchemaManager extends AbstractSchemaManager
43		{
44		/**
45		* {@inheritdoc}
46		*/
47		protected function _getPortableViewDefinition($view)
48		{
49		return new View($view['TABLE_NAME'], $view['VIEW_DEFINITION']);
50		}
51
52		/**
53		* {@inheritdoc}
54		*/
55		protected function _getPortableTableDefinition($table)
56		{
57		return array_shift($table);
58		}
59
60		/**
61		* {@inheritdoc}
62		*/
63		protected function _getPortableUserDefinition($user)
64		{
65		return [
66		'user' => $user['User'],
67		'password' => $user['Password'],
68		];
69		}
70
71		/**
72		* {@inheritdoc}
73		*/
74		protected function _getPortableTableIndexesList($tableIndexes, $tableName = null)
75		{
76		foreach ($tableIndexes as $k => $v) {
77		$v = array_change_key_case($v, CASE_LOWER);
78		if ($v['key_name'] === 'PRIMARY') {
79		$v['primary'] = true;
80		} else {
81		$v['primary'] = false;
82		}
83		if (strpos($v['index_type'], 'FULLTEXT') !== false) {
84		$v['flags'] = ['FULLTEXT'];
85		} elseif (strpos($v['index_type'], 'SPATIAL') !== false) {
86		$v['flags'] = ['SPATIAL'];
87		}
88		$tableIndexes[$k] = $v;
89		}
90
91		return parent::_getPortableTableIndexesList($tableIndexes, $tableName);
92		}
93
94		/**
95		* {@inheritdoc}
96		*/
97		protected function _getPortableSequenceDefinition($sequence)
98		{
99		return end($sequence);
100		}
101
102		/**
103		* {@inheritdoc}
104		*/
105		protected function _getPortableDatabaseDefinition($database)
106		{
107		return $database['Database'];
108		}
109
110		/**
111		* {@inheritdoc}
112		*/
113		protected function _getPortableTableColumnDefinition($tableColumn)
114		{
115		$tableColumn = array_change_key_case($tableColumn, CASE_LOWER);
116
117		$dbType = strtolower($tableColumn['type']);
118		$dbType = strtok($dbType, '(), ');
119		$length = $tableColumn['length'] ?? strtok('(), ');
120
121		$fixed = null;
122
123		if (! isset($tableColumn['name'])) {
124		$tableColumn['name'] = '';
125		}
126
127		$scale = null;
128		$precision = null;
129
130		$type = $this->_platform->getDoctrineTypeMapping($dbType);
131
132		// In cases where not connected to a database DESCRIBE $table does not return 'Comment'
133		if (isset($tableColumn['comment'])) {
134		$type = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
135		$tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type);
136		}
137
138		switch ($dbType) {
139		case 'char':
		0 ignored issues – show Coding Style introduced 2018-01-03 22:40 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
140		case 'binary':
		0 ignored issues – show Coding Style introduced 2018-01-03 22:40 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
141		$fixed = true;
142		break;
143		case 'float':
144		case 'double':
145		case 'real':
146		case 'numeric':
147		case 'decimal':
148		if (preg_match('([A-Za-z]+\(([0-9]+)\,([0-9]+)\))', $tableColumn['type'], $match)) {
149		$precision = $match[1];
150		$scale = $match[2];
151		$length = null;
152		}
153		break;
154		case 'tinytext':
155		$length = MySqlPlatform::LENGTH_LIMIT_TINYTEXT;
156		break;
157		case 'text':
158		$length = MySqlPlatform::LENGTH_LIMIT_TEXT;
159		break;
160		case 'mediumtext':
161		$length = MySqlPlatform::LENGTH_LIMIT_MEDIUMTEXT;
162		break;
163		case 'tinyblob':
164		$length = MySqlPlatform::LENGTH_LIMIT_TINYBLOB;
165		break;
166		case 'blob':
167		$length = MySqlPlatform::LENGTH_LIMIT_BLOB;
168		break;
169		case 'mediumblob':
170		$length = MySqlPlatform::LENGTH_LIMIT_MEDIUMBLOB;
171		break;
172		case 'tinyint':
173		case 'smallint':
174		case 'mediumint':
175		case 'int':
176		case 'integer':
177		case 'bigint':
178		case 'year':
179		$length = null;
180		break;
181		}
182
183		if ($this->_platform instanceof MariaDb1027Platform) {
184		$columnDefault = $this->getMariaDb1027ColumnDefault($this->_platform, $tableColumn['default']);
185		} else {
186		$columnDefault = $tableColumn['default'];
187		}
188
189		$options = [
190		'length' => $length !== null ? (int) $length : null,
191		'unsigned' => strpos($tableColumn['type'], 'unsigned') !== false,
192		'fixed' => (bool) $fixed,
193		'default' => $columnDefault,
194		'notnull' => $tableColumn['null'] !== 'YES',
195		'scale' => null,
196		'precision' => null,
197		'autoincrement' => strpos($tableColumn['extra'], 'auto_increment') !== false,
198		'comment' => isset($tableColumn['comment']) && $tableColumn['comment'] !== ''
199		? $tableColumn['comment']
200		: null,
201		];
202
203		if ($scale !== null && $precision !== null) {
204		$options['scale'] = (int) $scale;
205		$options['precision'] = (int) $precision;
206		}
207
208		$column = new Column($tableColumn['field'], Type::getType($type), $options);
209
210		if (isset($tableColumn['collation'])) {
211		$column->setPlatformOption('collation', $tableColumn['collation']);
212		}
213
214		return $column;
215		}
216
217		/**
218		* Return Doctrine/Mysql-compatible column default values for MariaDB 10.2.7+ servers.
219		*
220		* - Since MariaDb 10.2.7 column defaults stored in information_schema are now quoted
221		* to distinguish them from expressions (see MDEV-10134).
222		* - CURRENT_TIMESTAMP, CURRENT_TIME, CURRENT_DATE are stored in information_schema
223		* as current_timestamp(), currdate(), currtime()
224		* - Quoted 'NULL' is not enforced by Maria, it is technically possible to have
225		* null in some circumstances (see https://jira.mariadb.org/browse/MDEV-14053)
226		* - \' is always stored as '' in information_schema (normalized)
227		*
228		* @link https://mariadb.com/kb/en/library/information-schema-columns-table/
229		* @link https://jira.mariadb.org/browse/MDEV-13132
230		*
231		* @param null\|string $columnDefault default value as stored in information_schema for MariaDB >= 10.2.7
232		*/
233		private function getMariaDb1027ColumnDefault(MariaDb1027Platform $platform, ?string $columnDefault) : ?string
234		{
235		if ($columnDefault === 'NULL' \|\| $columnDefault === null) {
236		return null;
237		}
238		if ($columnDefault[0] === "'") {
239		return stripslashes(
240		str_replace(
241		"''",
242		"'",
243		preg_replace('/^\'(.*)\'$/', '$1', $columnDefault)
244		)
245		);
246		}
247		switch ($columnDefault) {
248		case 'current_timestamp()':
		0 ignored issues – show Coding Style introduced 2017-10-11 12:57 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
249		return $platform->getCurrentTimestampSQL();
250		case 'curdate()':
251		return $platform->getCurrentDateSQL();
252	1	case 'curtime()':
253		return $platform->getCurrentTimeSQL();
254	1	}
255	1	return $columnDefault;
256	1	}
257	1
258	1	/**
259	1	* {@inheritdoc}
260		*/
261	1	protected function _getPortableTableForeignKeysList($tableForeignKeys)
262	1	{
263		$list = [];
264		foreach ($tableForeignKeys as $value) {
265	1	$value = array_change_key_case($value, CASE_LOWER);
266	1	if (! isset($list[$value['constraint_name']])) {
267		if (! isset($value['delete_rule']) \|\| $value['delete_rule'] === 'RESTRICT') {
268		$value['delete_rule'] = null;
269	1	}
270	1	if (! isset($value['update_rule']) \|\| $value['update_rule'] === 'RESTRICT') {
271	1	$value['update_rule'] = null;
272		}
273
274	1	$list[$value['constraint_name']] = [
275	1	'name' => $value['constraint_name'],
276		'local' => [],
277		'foreign' => [],
278	1	'foreignTable' => $value['referenced_table_name'],
279	1	'onDelete' => $value['delete_rule'],
280	1	'onUpdate' => $value['update_rule'],
281	1	];
282	1	}
283	1	$list[$value['constraint_name']]['local'][] = $value['column_name'];
284	1	$list[$value['constraint_name']]['foreign'][] = $value['referenced_column_name'];
285		}
286	1
287	1	$result = [];
288		foreach ($list as $constraint) {
289		$result[] = new ForeignKeyConstraint(
290		array_values($constraint['local']),
291		$constraint['foreignTable'],
292	1	array_values($constraint['foreign']),
293		$constraint['name'],
294		[
295		'onDelete' => $constraint['onDelete'],
296		'onUpdate' => $constraint['onUpdate'],
297		]
298		);
299		}
300
301		return $result;
302		}
303		}
304

doctrine / dbal

Pull Request — master (#3018)

MySqlSchemaManager::_getPortableTableDefinition() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like