MySqlSchemaManager::_getPortableViewDefinition() - Code Metrics - Inspection of "Replaced Xdebug with PCOV for code coverage" - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#3469)

by Sergei

created 2019-02-23 01:59 UTC

MySqlSchemaManager::_getPortableViewDefinition() A

↳ Parent: MySqlSchemaManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

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 assert;
use function explode;
use function is_string;
use function preg_match;
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'];
            }
            $v['length'] = isset($v['sub_part']) ? (int) $v['sub_part'] : null;

            $tableIndexes[$k] = $v;
        }

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

    /**
     * {@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, '(), ');
        assert(is_string($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':
            case 'binary':
                $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['characterset'])) {
            $column->setPlatformOption('charset', $tableColumn['characterset']);
        }
        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 string|null $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 (preg_match('/^\'(.*)\'$/', $columnDefault, $matches)) {
            return stripslashes(str_replace("''", "'", $matches[1]));
        }

        switch ($columnDefault) {
            case 'current_timestamp()':
                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;
    }

    public function listTableDetails($tableName)
    {
        $table = parent::listTableDetails($tableName);

        /** @var MySqlPlatform $platform */
        $platform = $this->_platform;
        $sql      = $platform->getListTableMetadataSQL($tableName);

        $tableOptions = $this->_conn->fetchAssoc($sql);

        $table->addOption('engine', $tableOptions['ENGINE']);
        if ($tableOptions['TABLE_COLLATION'] !== null) {
            $table->addOption('collation', $tableOptions['TABLE_COLLATION']);
        }
        if ($tableOptions['AUTO_INCREMENT'] !== null) {
            $table->addOption('autoincrement', $tableOptions['AUTO_INCREMENT']);
        }
        $table->addOption('comment', $tableOptions['TABLE_COMMENT']);
        $table->addOption('create_options', $this->parseCreateOptions($tableOptions['CREATE_OPTIONS']));

        return $table;
    }

    /**
     * @return string[]|true[]
     */
    private function parseCreateOptions(?string $string) : array
    {
        $options = [];

        if ($string === null || $string === '') {
            return $options;
        }

        foreach (explode(' ', $string) as $pair) {
            $parts = explode('=', $pair, 2);

            $options[$parts[0]] = $parts[1] ?? true;
        }

        return $options;
    }
}


1		<?php
2
3		namespace Doctrine\DBAL\Schema;
4
5		use Doctrine\DBAL\Platforms\MariaDb1027Platform;
6		use Doctrine\DBAL\Platforms\MySqlPlatform;
7		use Doctrine\DBAL\Types\Type;
8		use const CASE_LOWER;
9		use function array_change_key_case;
10		use function array_shift;
11		use function array_values;
12		use function assert;
13		use function explode;
14		use function is_string;
15		use function preg_match;
16		use function str_replace;
17		use function stripslashes;
18		use function strpos;
19		use function strtok;
20		use function strtolower;
21
22		/**
23		* Schema manager for the MySql RDBMS.
24		*/
25		class MySqlSchemaManager extends AbstractSchemaManager
26		{
27		/**
28		* {@inheritdoc}
29		*/
30	484	protected function _getPortableViewDefinition($view)
31		{
32	484	return new View($view['TABLE_NAME'], $view['VIEW_DEFINITION']);
33		}
34
35		/**
36		* {@inheritdoc}
37		*/
38	1142	protected function _getPortableTableDefinition($table)
39		{
40	1142	return array_shift($table);
41		}
42
43		/**
44		* {@inheritdoc}
45		*/
46		protected function _getPortableUserDefinition($user)
47		{
48		return [
49		'user' => $user['User'],
50		'password' => $user['Password'],
51		];
52		}
53
54		/**
55		* {@inheritdoc}
56		*/
57	1044	protected function _getPortableTableIndexesList($tableIndexes, $tableName = null)
58		{
59	1044	foreach ($tableIndexes as $k => $v) {
60	1044	$v = array_change_key_case($v, CASE_LOWER);
61	1044	if ($v['key_name'] === 'PRIMARY') {
62	1044	$v['primary'] = true;
63		} else {
64	1044	$v['primary'] = false;
65		}
66	1044	if (strpos($v['index_type'], 'FULLTEXT') !== false) {
67	974	$v['flags'] = ['FULLTEXT'];
68	1044	} elseif (strpos($v['index_type'], 'SPATIAL') !== false) {
69	960	$v['flags'] = ['SPATIAL'];
70		}
71	1044	$v['length'] = isset($v['sub_part']) ? (int) $v['sub_part'] : null;
72
73	1044	$tableIndexes[$k] = $v;
74		}
75
76	1044	return parent::_getPortableTableIndexesList($tableIndexes, $tableName);
77		}
78
79		/**
80		* {@inheritdoc}
81		*/
82	680	protected function _getPortableDatabaseDefinition($database)
83		{
84	680	return $database['Database'];
85		}
86
87		/**
88		* {@inheritdoc}
89		*/
90	1044	protected function _getPortableTableColumnDefinition($tableColumn)
91		{
92	1044	$tableColumn = array_change_key_case($tableColumn, CASE_LOWER);
93
94	1044	$dbType = strtolower($tableColumn['type']);
95	1044	$dbType = strtok($dbType, '(), ');
96	1044	assert(is_string($dbType));
97
98	1044	$length = $tableColumn['length'] ?? strtok('(), ');
99
100	1044	$fixed = null;
101
102	1044	if (! isset($tableColumn['name'])) {
103	1044	$tableColumn['name'] = '';
104		}
105
106	1044	$scale = null;
107	1044	$precision = null;
108
109	1044	$type = $this->_platform->getDoctrineTypeMapping($dbType);
110
111		// In cases where not connected to a database DESCRIBE $table does not return 'Comment'
112	1044	if (isset($tableColumn['comment'])) {
113	1044	$type = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
114	1044	$tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type);
115		}
116
117		switch ($dbType) {
118	1044	case 'char':
119	1044	case 'binary':
120	824	$fixed = true;
121	824	break;
122	1044	case 'float':
123	1044	case 'double':
124	1044	case 'real':
125	1044	case 'numeric':
126	1044	case 'decimal':
127	810	if (preg_match('([A-Za-z]+\(([0-9]+)\,([0-9]+)\))', $tableColumn['type'], $match)) {
128	810	$precision = $match[1];
129	810	$scale = $match[2];
130	810	$length = null;
131		}
132	810	break;
133	1044	case 'tinytext':
134	838	$length = MySqlPlatform::LENGTH_LIMIT_TINYTEXT;
135	838	break;
136	1044	case 'text':
137	838	$length = MySqlPlatform::LENGTH_LIMIT_TEXT;
138	838	break;
139	1044	case 'mediumtext':
140	838	$length = MySqlPlatform::LENGTH_LIMIT_MEDIUMTEXT;
141	838	break;
142	1044	case 'tinyblob':
143		$length = MySqlPlatform::LENGTH_LIMIT_TINYBLOB;
144		break;
145	1044	case 'blob':
146	838	$length = MySqlPlatform::LENGTH_LIMIT_BLOB;
147	838	break;
148	1044	case 'mediumblob':
149	838	$length = MySqlPlatform::LENGTH_LIMIT_MEDIUMBLOB;
150	838	break;
151	1044	case 'tinyint':
152	1044	case 'smallint':
153	1044	case 'mediumint':
154	1044	case 'int':
155	1044	case 'integer':
156	1044	case 'bigint':
157	1044	case 'year':
158	1044	$length = null;
159	1044	break;
160		}
161
162	1044	if ($this->_platform instanceof MariaDb1027Platform) {
163	296	$columnDefault = $this->getMariaDb1027ColumnDefault($this->_platform, $tableColumn['default']);
164		} else {
165	748	$columnDefault = $tableColumn['default'];
166		}
167
168		$options = [
169	1044	'length' => $length !== null ? (int) $length : null,
170	1044	'unsigned' => strpos($tableColumn['type'], 'unsigned') !== false,
171	1044	'fixed' => (bool) $fixed,
172	1044	'default' => $columnDefault,
173	1044	'notnull' => $tableColumn['null'] !== 'YES',
174		'scale' => null,
175		'precision' => null,
176	1044	'autoincrement' => strpos($tableColumn['extra'], 'auto_increment') !== false,
177	1044	'comment' => isset($tableColumn['comment']) && $tableColumn['comment'] !== ''
178	414	? $tableColumn['comment']
179		: null,
180		];
181
182	1044	if ($scale !== null && $precision !== null) {
183	810	$options['scale'] = (int) $scale;
184	810	$options['precision'] = (int) $precision;
185		}
186
187	1044	$column = new Column($tableColumn['field'], Type::getType($type), $options);
188
189	1044	if (isset($tableColumn['characterset'])) {
190	1044	$column->setPlatformOption('charset', $tableColumn['characterset']);
191		}
192	1044	if (isset($tableColumn['collation'])) {
193	1044	$column->setPlatformOption('collation', $tableColumn['collation']);
194		}
195
196	1044	return $column;
197		}
198
199		/**
200		* Return Doctrine/Mysql-compatible column default values for MariaDB 10.2.7+ servers.
201		*
202		* - Since MariaDb 10.2.7 column defaults stored in information_schema are now quoted
203		* to distinguish them from expressions (see MDEV-10134).
204		* - CURRENT_TIMESTAMP, CURRENT_TIME, CURRENT_DATE are stored in information_schema
205		* as current_timestamp(), currdate(), currtime()
206		* - Quoted 'NULL' is not enforced by Maria, it is technically possible to have
207		* null in some circumstances (see https://jira.mariadb.org/browse/MDEV-14053)
208		* - \' is always stored as '' in information_schema (normalized)
209		*
210		* @link https://mariadb.com/kb/en/library/information-schema-columns-table/
211		* @link https://jira.mariadb.org/browse/MDEV-13132
212		*
213		* @param string\|null $columnDefault default value as stored in information_schema for MariaDB >= 10.2.7
214		*/
215	296	private function getMariaDb1027ColumnDefault(MariaDb1027Platform $platform, ?string $columnDefault) : ?string
216		{
217	296	if ($columnDefault === 'NULL' \|\| $columnDefault === null) {
218	296	return null;
219		}
220
221	292	if (preg_match('/^\'(.*)\'$/', $columnDefault, $matches)) {
222	208	return stripslashes(str_replace("''", "'", $matches[1]));
223		}
224
225		switch ($columnDefault) {
226	292	case 'current_timestamp()':
227	220	return $platform->getCurrentTimestampSQL();
228	292	case 'curdate()':
229	212	return $platform->getCurrentDateSQL();
230	292	case 'curtime()':
231	212	return $platform->getCurrentTimeSQL();
232		}
233	292	return $columnDefault;
234		}
235
236		/**
237		* {@inheritdoc}
238		*/
239	1057	protected function _getPortableTableForeignKeysList($tableForeignKeys)
240		{
241	1057	$list = [];
242	1057	foreach ($tableForeignKeys as $value) {
243	553	$value = array_change_key_case($value, CASE_LOWER);
244	553	if (! isset($list[$value['constraint_name']])) {
245	553	if (! isset($value['delete_rule']) \|\| $value['delete_rule'] === 'RESTRICT') {
246	474	$value['delete_rule'] = null;
247		}
248	553	if (! isset($value['update_rule']) \|\| $value['update_rule'] === 'RESTRICT') {
249	474	$value['update_rule'] = null;
250		}
251
252	553	$list[$value['constraint_name']] = [
253	553	'name' => $value['constraint_name'],
254		'local' => [],
255		'foreign' => [],
256	553	'foreignTable' => $value['referenced_table_name'],
257	553	'onDelete' => $value['delete_rule'],
258	553	'onUpdate' => $value['update_rule'],
259		];
260		}
261	553	$list[$value['constraint_name']]['local'][] = $value['column_name'];
262	553	$list[$value['constraint_name']]['foreign'][] = $value['referenced_column_name'];
263		}
264
265	1057	$result = [];
266	1057	foreach ($list as $constraint) {
267	553	$result[] = new ForeignKeyConstraint(
268	553	array_values($constraint['local']),
269	553	$constraint['foreignTable'],
270	553	array_values($constraint['foreign']),
271	553	$constraint['name'],
272		[
273	553	'onDelete' => $constraint['onDelete'],
274	553	'onUpdate' => $constraint['onUpdate'],
275		]
276		);
277		}
278
279	1057	return $result;
280		}
281
282	1044	public function listTableDetails($tableName)
283		{
284	1044	$table = parent::listTableDetails($tableName);
285
286		/** @var MySqlPlatform $platform */
287	1044	$platform = $this->_platform;
288	1044	$sql = $platform->getListTableMetadataSQL($tableName);
289
290	1044	$tableOptions = $this->_conn->fetchAssoc($sql);
291
292	1044	$table->addOption('engine', $tableOptions['ENGINE']);
293	1044	if ($tableOptions['TABLE_COLLATION'] !== null) {
294	1044	$table->addOption('collation', $tableOptions['TABLE_COLLATION']);
295		}
296	1044	if ($tableOptions['AUTO_INCREMENT'] !== null) {
297	1044	$table->addOption('autoincrement', $tableOptions['AUTO_INCREMENT']);
298		}
299	1044	$table->addOption('comment', $tableOptions['TABLE_COMMENT']);
300	1044	$table->addOption('create_options', $this->parseCreateOptions($tableOptions['CREATE_OPTIONS']));
301
302	1044	return $table;
303		}
304
305		/**
306		* @return string[]\|true[]
307		*/
308	1044	private function parseCreateOptions(?string $string) : array
309		{
310	1044	$options = [];
311
312	1044	if ($string === null \|\| $string === '') {
313	1044	return $options;
314		}
315
316	722	foreach (explode(' ', $string) as $pair) {
317	722	$parts = explode('=', $pair, 2);
318
319	722	$options[$parts[0]] = $parts[1] ?? true;
320		}
321
322	722	return $options;
323		}
324		}
325

doctrine / dbal

Pull Request — master (#3469)

MySqlSchemaManager::_getPortableViewDefinition() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like