DbDumpTrait::getCreateTableQuery() - Code Metrics - Inspection of "Function refactoring." - lagdo/jaxon-dbadmin - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 7dd0c5...b31323 )

by Thierry

created 2021-12-23 16:03 UTC

DbDumpTrait::getCreateTableQuery() A

↳ Parent: DbDumpTrait

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	6
c	1
b	0
f	0
nc	3
nop	3
dl	0
loc	10
rs	10

<?php

namespace Lagdo\DbAdmin\DbAdmin\Traits;

use Lagdo\DbAdmin\Driver\Db\StatementInterface;
use Lagdo\DbAdmin\Driver\Entity\TableFieldEntity;

use function count;
use function strlen;
use function in_array;
use function preg_match;
use function str_replace;
use function implode;
use function is_numeric;
use function array_keys;
use function array_map;

trait DbDumpTrait
{
    /**
     * The dump options
     *
     * @var array
     */
    private $options;

    /**
     * The queries generated by the dump
     *
     * @var array
     */
    private $queries = [];

    // Temp vars for data dumps
    private $insert = '';
    private $buffer = '';
    private $suffix = '';
    private $views = [];
    private $fkeys = [];

    /**
     * Print CSV row
     *
     * @param array  $row
     *
     * @return void
     */
    private function dumpCsv(array $row)
    {
        // From functions.inc.php
        foreach ($row as $key => $val) {
            if (preg_match('~["\n,;\t]|^0|\.\d*0$~', $val) || $val === '') {
                $row[$key] = '"' . str_replace('"', '""', $val) . '"';
            }
        }
        $separator = $this->options['format'] === 'csv' ? ',' :
            ($this->options['format'] === 'tsv' ? "\t" : ';');
        $this->queries[] = implode($separator, $row);
    }

    /**
     * Convert a value to string
     *
     * @param mixed  $value
     * @param TableFieldEntity $field
     *
     * @return string
     */
    private function convertToString($value, TableFieldEntity $field): string
    {
        // From functions.inc.php
        if ($value === null) {
            return 'NULL';
        }
        if (!preg_match($this->driver->numberRegex(), $field->type) ||
            preg_match('~\[~', $field->fullType) && is_numeric($value)) {
            $value = $this->driver->quote(($value === false ? 0 : $value));
        }
        return $this->driver->unconvertField($field, $value);
    }

    /**
     * @param string $table
     * @param string $style
     * @param int $tableType
     *
     * @return string
     */
    private function getCreateTableQuery(string $table, string $style, int $tableType): string
    {
        if ($tableType !== 2) {
            return $this->driver->sqlForCreateTable($table, $this->options['autoIncrement'], $style);
        }
        $fields = [];
        foreach ($this->driver->fields($table) as $name => $field) {
            $fields[] = $this->driver->escapeId($name) . ' ' . $field->fullType;
        }
        return 'CREATE TABLE ' . $this->driver->table($table) . ' (' . implode(', ', $fields) . ')';
    }

    /**
     * Export table structure
     *
     * @param string $table
     * @param string $style
     * @param int    $tableType       0 table, 1 view, 2 temporary view table
     *
     * @return void
     */
    private function dumpTableOrView(string $table, string $style, int $tableType = 0)
    {
        // From adminer.inc.php
        if ($this->options['format'] !== 'sql') {
            $this->queries[] = "\xef\xbb\xbf"; // UTF-8 byte order mark
            if ($style) {
                $this->dumpCsv(array_keys($this->driver->fields($table)));
            }
            return;
        }
        if (!$style) {
            return;
        }

        $create = $this->getCreateTableQuery($table, $style, $tableType);
        $this->driver->setUtf8mb4($create);
        if (!$create) {
            return;
        }
        if ($style === 'DROP+CREATE' || $tableType === 1) {
            $this->queries[] = 'DROP ' . ($tableType === 2 ? 'VIEW' : 'TABLE') .
                ' IF EXISTS ' . $this->driver->table($table) . ';';
        }
        if ($tableType === 1) {
            $create = $this->admin->removeDefiner($create);
        }
        $this->queries[] = $create . ';';
    }

    /**
     * @param array $row
     * @param StatementInterface $statement
     *
     * @return array
     */
    private function getDataRowKeys(array $row, StatementInterface $statement): array
    {
        $values = [];
        $keys = [];
        // For is preferred to foreach because the values are not used.
        // foreach ($row as $val) {
        // }
        for ($i = 0; $i < count($row); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            $field = $statement->fetchField();
            $keys[] = $field->name();
            $key = $this->driver->escapeId($field->name());
            $values[] = "$key = VALUES($key)";
        }
        $this->suffix = ";\n";
        if ($this->options['data_style'] === 'INSERT+UPDATE') {
            $this->suffix = "\nON DUPLICATE KEY UPDATE " . implode(', ', $values) . ";\n";
        }
        return $keys;
    }

    /**
     * @param array $row
     *
     * @return void
     */
    private function saveRowInBuffer(array $row)
    {
        $max_packet = ($this->driver->jush() === 'sqlite' ? 0 : 1048576); // default, minimum is 1024
        $s = ($max_packet ? "\n" : ' ') . '(' . implode(",\t", $row) . ')';
        if (!$this->buffer) {
            $this->buffer = $this->insert . $s;
            return;
        }
        if (strlen($this->buffer) + 4 + strlen($s) + strlen($this->suffix) < $max_packet) { // 4 - length specification
            $this->buffer .= ",$s";
            return;
        }
        $this->queries[] = $this->buffer . $this->suffix;
        $this->buffer = $this->insert . $s;
    }

    /**
     * @param string $table
     * @param array $fields
     * @param array $row
     * @param array $keys
     *
     * @return void
     */
    private function dumpRow(string $table, array $fields, array $row, array $keys)
    {
        if ($this->options['format'] !== 'sql') {
            if ($this->options['data_style'] === 'table') {
                $this->dumpCsv($keys);
                $this->options['data_style'] = 'INSERT';
            }
            $this->dumpCsv($row);
            return;
        }
        if (!$this->insert) {
            $this->insert = 'INSERT INTO ' . $this->driver->table($table) . ' (' .
                implode(', ', array_map(function ($key) {
                    return $this->driver->escapeId($key);
                }, $keys)) . ') VALUES';
        }
        foreach ($row as $key => $val) {
            $field = $fields[$key];
            $row[$key] = $this->convertToString($val, $field);
        }
        $this->saveRowInBuffer($row);
    }

    /** Export table data
     *
     * @param string $table
     * @param string $query
     *
     * @return void
     */
    private function dumpData(string $table, string $query)
    {
        if (!$this->options['data_style']) {
            return;
        }
        $fields = [];
        if ($this->options['format'] === 'sql') {
            if ($this->options['data_style'] === 'TRUNCATE+INSERT') {
                $this->queries[] = $this->driver->sqlForTruncateTable($table) . ";\n";
            }
            $fields = $this->driver->fields($table);
        }
        $statement = $this->driver->query($query); // 1 - MYSQLI_USE_RESULT //! enum and set as numbers
        if (!$statement) {
            if ($this->options['format'] === 'sql') {
                $this->queries[] = '-- ' . str_replace("\n", ' ', $this->driver->error()) . "\n";
            }
            return;
        }
        $this->insert = '';
        $this->buffer = '';
        $this->suffix = '';
        $keys = [];
        $fetch_function = ($table !== '' ? 'fetchAssoc' : 'fetchRow');
        while ($row = $statement->$fetch_function()) {
            if (empty($keys)) {
                $keys = $this->getDataRowKeys($row, $statement);
            }
            $this->dumpRow($table, $fields, $row, $keys);
        }
        if (($this->buffer)) {
            $this->queries[] = $this->buffer . $this->suffix;
        }
    }

    /**
     * @param string $table
     * @param bool $dumpTable
     * @param bool $dumpData
     *
     * @return void
     */
    private function dumpTable(string $table, bool $dumpTable, bool $dumpData)
    {
        if (!$dumpTable && !$dumpData) {
            return;
        }
        $this->dumpTableOrView($table, ($dumpTable ? $this->options['table_style'] : ''));
        if ($dumpData) {
            $fields = $this->driver->fields($table);
            $query = 'SELECT *' . $this->driver->convertFields($fields, $fields) .
                ' FROM ' . $this->driver->table($table);
            $this->dumpData($table, $query);
        }
        if ($this->options['is_sql'] && $this->options['triggers'] && $dumpTable &&
            ($triggers = $this->driver->sqlForCreateTrigger($table))) {
            $this->queries[] = 'DELIMITER ;';
            $this->queries[] = $triggers;
            $this->queries[] = 'DELIMITER ;';
        }
        if ($this->options['is_sql']) {
            $this->queries[] = '';
        }
    }

    /**
     * Dump tables
     *
     * @param string $database      The database name
     *
     * @return void
     */
    private function dumpTables(string $database)
    {
        $dbDumpTable = $this->tables['list'] === '*' && in_array($database, $this->databases['list']);
        $dbDumpData = in_array($database, $this->databases['data']);
        $this->views = []; // View names
        $this->fkeys = []; // Table names for foreign keys
        $dbTables = $this->driver->tableStatuses(true);
        foreach ($dbTables as $table => $tableStatus) {
            $isView = $this->driver->isView($tableStatus);
            if ($isView) {
                // The views will be dumped after the tables
                $this->views[] = $table;
                continue;
            }
            $this->fkeys[] = $table;
            $dumpTable = $dbDumpTable || in_array($table, $this->tables['list']);
            $dumpData = $dbDumpData || in_array($table, $this->tables['data']);
            $this->dumpTable($table, $dumpTable, $dumpData);
        }
    }

    /**
     * @return void
     */
    private function dumpViewsAndFKeys()
    {
        // Add FKs after creating tables (except in MySQL which uses SET FOREIGN_KEY_CHECKS=0)
        if ($this->driver->support('fkeys_sql')) {
            foreach ($this->fkeys as $table) {
                $this->queries[] = $this->driver->sqlForForeignKeys($table);
            }
        }
        // Dump the views after all the tables
        foreach ($this->views as $view) {
            $this->dumpTableOrView($view, $this->options['table_style'], 1);
        }
    }
}


1			<?php
2
3			namespace Lagdo\DbAdmin\DbAdmin\Traits;
4
5			use Lagdo\DbAdmin\Driver\Db\StatementInterface;
6			use Lagdo\DbAdmin\Driver\Entity\TableFieldEntity;
7
8			use function count;
9			use function strlen;
10			use function in_array;
11			use function preg_match;
12			use function str_replace;
13			use function implode;
14			use function is_numeric;
15			use function array_keys;
16			use function array_map;
17
18			trait DbDumpTrait
19			{
20			/**
21			* The dump options
22			*
23			* @var array
24			*/
25			private $options;
26
27			/**
28			* The queries generated by the dump
29			*
30			* @var array
31			*/
32			private $queries = [];
33
34			// Temp vars for data dumps
35			private $insert = '';
36			private $buffer = '';
37			private $suffix = '';
38			private $views = [];
39			private $fkeys = [];
40
41			/**
42			* Print CSV row
43			*
44			* @param array $row
45			*
46			* @return void
47			*/
48			private function dumpCsv(array $row)
49			{
50			// From functions.inc.php
51			foreach ($row as $key => $val) {
52			if (preg_match('~["\n,;\t]\|^0\|\.\d*0$~', $val) \|\| $val === '') {
53			$row[$key] = '"' . str_replace('"', '""', $val) . '"';
54			}
55			}
56			$separator = $this->options['format'] === 'csv' ? ',' :
57			($this->options['format'] === 'tsv' ? "\t" : ';');
58			$this->queries[] = implode($separator, $row);
59			}
60
61			/**
62			* Convert a value to string
63			*
64			* @param mixed $value
65			* @param TableFieldEntity $field
66			*
67			* @return string
68			*/
69			private function convertToString($value, TableFieldEntity $field): string
70			{
71			// From functions.inc.php
72			if ($value === null) {
73			return 'NULL';
74			}
75			if (!preg_match($this->driver->numberRegex(), $field->type) \|\|
76			preg_match('~\[~', $field->fullType) && is_numeric($value)) {
77			$value = $this->driver->quote(($value === false ? 0 : $value));
78			}
79			return $this->driver->unconvertField($field, $value);
80			}
81
82			/**
83			* @param string $table
84			* @param string $style
85			* @param int $tableType
86			*
87			* @return string
88			*/
89			private function getCreateTableQuery(string $table, string $style, int $tableType): string
90			{
91			if ($tableType !== 2) {
92			return $this->driver->sqlForCreateTable($table, $this->options['autoIncrement'], $style);
93			}
94			$fields = [];
95			foreach ($this->driver->fields($table) as $name => $field) {
96			$fields[] = $this->driver->escapeId($name) . ' ' . $field->fullType;
97			}
98			return 'CREATE TABLE ' . $this->driver->table($table) . ' (' . implode(', ', $fields) . ')';
99			}
100
101			/**
102			* Export table structure
103			*
104			* @param string $table
105			* @param string $style
106			* @param int $tableType 0 table, 1 view, 2 temporary view table
107			*
108			* @return void
109			*/
110			private function dumpTableOrView(string $table, string $style, int $tableType = 0)
111			{
112			// From adminer.inc.php
113			if ($this->options['format'] !== 'sql') {
114			$this->queries[] = "\xef\xbb\xbf"; // UTF-8 byte order mark
115			if ($style) {
116			$this->dumpCsv(array_keys($this->driver->fields($table)));
117			}
118			return;
119			}
120			if (!$style) {
121			return;
122			}
123
124			$create = $this->getCreateTableQuery($table, $style, $tableType);
125			$this->driver->setUtf8mb4($create);
126			if (!$create) {
127			return;
128			}
129			if ($style === 'DROP+CREATE' \|\| $tableType === 1) {
130			$this->queries[] = 'DROP ' . ($tableType === 2 ? 'VIEW' : 'TABLE') .
131			' IF EXISTS ' . $this->driver->table($table) . ';';
132			}
133			if ($tableType === 1) {
134			$create = $this->admin->removeDefiner($create);
135			}
136			$this->queries[] = $create . ';';
137			}
138
139			/**
140			* @param array $row
141			* @param StatementInterface $statement
142			*
143			* @return array
144			*/
145			private function getDataRowKeys(array $row, StatementInterface $statement): array
146			{
147			$values = [];
148			$keys = [];
149			// For is preferred to foreach because the values are not used.
150			// foreach ($row as $val) {
151			// }
152			for ($i = 0; $i < count($row); $i++) {
			0 ignored issues – show Performance Best Practice introduced 2021-12-23 16:05 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
153			$field = $statement->fetchField();
154			$keys[] = $field->name();
155			$key = $this->driver->escapeId($field->name());
156			$values[] = "$key = VALUES($key)";
157			}
158			$this->suffix = ";\n";
159			if ($this->options['data_style'] === 'INSERT+UPDATE') {
160			$this->suffix = "\nON DUPLICATE KEY UPDATE " . implode(', ', $values) . ";\n";
161			}
162			return $keys;
163			}
164
165			/**
166			* @param array $row
167			*
168			* @return void
169			*/
170			private function saveRowInBuffer(array $row)
171			{
172			$max_packet = ($this->driver->jush() === 'sqlite' ? 0 : 1048576); // default, minimum is 1024
173			$s = ($max_packet ? "\n" : ' ') . '(' . implode(",\t", $row) . ')';
174			if (!$this->buffer) {
175			$this->buffer = $this->insert . $s;
176			return;
177			}
178			if (strlen($this->buffer) + 4 + strlen($s) + strlen($this->suffix) < $max_packet) { // 4 - length specification
179			$this->buffer .= ",$s";
180			return;
181			}
182			$this->queries[] = $this->buffer . $this->suffix;
183			$this->buffer = $this->insert . $s;
184			}
185
186			/**
187			* @param string $table
188			* @param array $fields
189			* @param array $row
190			* @param array $keys
191			*
192			* @return void
193			*/
194			private function dumpRow(string $table, array $fields, array $row, array $keys)
195			{
196			if ($this->options['format'] !== 'sql') {
197			if ($this->options['data_style'] === 'table') {
198			$this->dumpCsv($keys);
199			$this->options['data_style'] = 'INSERT';
200			}
201			$this->dumpCsv($row);
202			return;
203			}
204			if (!$this->insert) {
205			$this->insert = 'INSERT INTO ' . $this->driver->table($table) . ' (' .
206			implode(', ', array_map(function ($key) {
207			return $this->driver->escapeId($key);
208			}, $keys)) . ') VALUES';
209			}
210			foreach ($row as $key => $val) {
211			$field = $fields[$key];
212			$row[$key] = $this->convertToString($val, $field);
213			}
214			$this->saveRowInBuffer($row);
215			}
216
217			/** Export table data
218			*
219			* @param string $table
220			* @param string $query
221			*
222			* @return void
223			*/
224			private function dumpData(string $table, string $query)
225			{
226			if (!$this->options['data_style']) {
227			return;
228			}
229			$fields = [];
230			if ($this->options['format'] === 'sql') {
231			if ($this->options['data_style'] === 'TRUNCATE+INSERT') {
232			$this->queries[] = $this->driver->sqlForTruncateTable($table) . ";\n";
233			}
234			$fields = $this->driver->fields($table);
235			}
236			$statement = $this->driver->query($query); // 1 - MYSQLI_USE_RESULT //! enum and set as numbers
237			if (!$statement) {
238			if ($this->options['format'] === 'sql') {
239			$this->queries[] = '-- ' . str_replace("\n", ' ', $this->driver->error()) . "\n";
240			}
241			return;
242			}
243			$this->insert = '';
244			$this->buffer = '';
245			$this->suffix = '';
246			$keys = [];
247			$fetch_function = ($table !== '' ? 'fetchAssoc' : 'fetchRow');
248			while ($row = $statement->$fetch_function()) {
249			if (empty($keys)) {
250			$keys = $this->getDataRowKeys($row, $statement);
251			}
252			$this->dumpRow($table, $fields, $row, $keys);
253			}
254			if (($this->buffer)) {
255			$this->queries[] = $this->buffer . $this->suffix;
256			}
257			}
258
259			/**
260			* @param string $table
261			* @param bool $dumpTable
262			* @param bool $dumpData
263			*
264			* @return void
265			*/
266			private function dumpTable(string $table, bool $dumpTable, bool $dumpData)
267			{
268			if (!$dumpTable && !$dumpData) {
269			return;
270			}
271			$this->dumpTableOrView($table, ($dumpTable ? $this->options['table_style'] : ''));
272			if ($dumpData) {
273			$fields = $this->driver->fields($table);
274			$query = 'SELECT *' . $this->driver->convertFields($fields, $fields) .
275			' FROM ' . $this->driver->table($table);
276			$this->dumpData($table, $query);
277			}
278			if ($this->options['is_sql'] && $this->options['triggers'] && $dumpTable &&
279			($triggers = $this->driver->sqlForCreateTrigger($table))) {
280			$this->queries[] = 'DELIMITER ;';
281			$this->queries[] = $triggers;
282			$this->queries[] = 'DELIMITER ;';
283			}
284			if ($this->options['is_sql']) {
285			$this->queries[] = '';
286			}
287			}
288
289			/**
290			* Dump tables
291			*
292			* @param string $database The database name
293			*
294			* @return void
295			*/
296			private function dumpTables(string $database)
297			{
298			$dbDumpTable = $this->tables['list'] === '*' && in_array($database, $this->databases['list']);
299			$dbDumpData = in_array($database, $this->databases['data']);
300			$this->views = []; // View names
301			$this->fkeys = []; // Table names for foreign keys
302			$dbTables = $this->driver->tableStatuses(true);
303			foreach ($dbTables as $table => $tableStatus) {
304			$isView = $this->driver->isView($tableStatus);
305			if ($isView) {
306			// The views will be dumped after the tables
307			$this->views[] = $table;
308			continue;
309			}
310			$this->fkeys[] = $table;
311			$dumpTable = $dbDumpTable \|\| in_array($table, $this->tables['list']);
312			$dumpData = $dbDumpData \|\| in_array($table, $this->tables['data']);
313			$this->dumpTable($table, $dumpTable, $dumpData);
314			}
315			}
316
317			/**
318			* @return void
319			*/
320			private function dumpViewsAndFKeys()
321			{
322			// Add FKs after creating tables (except in MySQL which uses SET FOREIGN_KEY_CHECKS=0)
323			if ($this->driver->support('fkeys_sql')) {
324			foreach ($this->fkeys as $table) {
325			$this->queries[] = $this->driver->sqlForForeignKeys($table);
326			}
327			}
328			// Dump the views after all the tables
329			foreach ($this->views as $view) {
330			$this->dumpTableOrView($view, $this->options['table_style'], 1);
331			}
332			}
333			}
334

lagdo / jaxon-dbadmin

Push — main ( 7dd0c5...b31323 )

DbDumpTrait::getCreateTableQuery() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like