TableBuilder::renameTableSql() - Code Metrics - Inspection of "Merge pull request #67 from armanist/master" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f6579a...8994b4 )

by Arman

created 2022-05-26 11:59 UTC

TableBuilder::renameTableSql() A

↳ Parent: TableBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <[email protected]>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.7.0
 */

namespace Quantum\Libraries\Database\Schema;

/**
 * Trait TableBuilder
 * @package Quantum\Libraries\Database
 */
trait TableBuilder
{

    /**
     * Generates create table statement
     * @return string
     */
    protected function createTableSql()
    {
        $tableSchema = array_filter([$this->columnsSql(), $this->indexesSql()]);
        $sql = '';

        if ($tableSchema) {

            $sql = 'CREATE TABLE `' . $this->name . '` (';
            $sql .= implode(', ', $tableSchema);
            $sql .= ');';
        }

        return $sql;
    }

    /**
     * Generates alter table statement
     * @return string
     */
    protected function alterTableSql(): string
    {
        $tableSchema = array_filter([$this->columnsSql(), $this->indexesSql(), $this->dropIndexesSql()]);
        $sql = '';

        if ($tableSchema) {

            $sql = 'ALTER TABLE `' . $this->name . '` ';
            $sql .= implode(', ', $tableSchema);
            $sql .= ';';
        }

        return $sql;
    }

    /**
     * Prepares rename table statement
     * @return string
     */
    protected function renameTableSql(): string
    {
        return 'RENAME TABLE `' . $this->name . '` TO `' . $this->newName . '`;';
    }

    /**
     * Prepares drop table statement
     * @return string
     */
    protected function dropTableSql(): string
    {
        return 'DROP TABLE `' . $this->name . '`';
    }

    /**
     * Prepares columns statements for table
     * @return string
     */
    protected function columnsSql(): string
    {
        $sql = '';

        if ($this->columns) {
            $columns = [];

            foreach ($this->columns as $entry) {
                $columnString = '';

                if ($entry['action'] != Column::ADD_INDEX && $entry['action'] != Column::DROP_INDEX) {
                    $columnString .= ($entry['action'] ? $entry['action'] . ' COLUMN ' : '');
                    $columnString .= $this->composeColumn($entry['column'], $entry['action']);
                }

                if ($entry['column']->get('indexKey')) {
                    $this->indexKeys[$entry['column']->get('indexKey')][] = [

                        'columnName' => $entry['column']->get('name'),
                        'indexName' => $entry['column']->get('indexName'),
                    ];
                }

                if ($entry['column']->get('indexDrop')) {
                    $this->droppedIndexKeys[] = $entry['column']->get('indexDrop');

                }

                if ($columnString) {
                    array_push($columns, $columnString);
                }
            }

            $sql = implode(', ', $columns);
        }

        return $sql;
    }

    /**
     * Composes the column 
     * @param Column $column
     * @param string $action
     * @return string
     */
    protected function composeColumn(Column $column, string $action = null): string
    {
        return
                $this->columnAttrSql($column->get(Column::NAME), '`', '`') .
                $this->columnAttrSql($column->get(Column::NEW_NAME), ' TO `', '`') .
                $this->columnAttrSql($column->get(Column::TYPE), ' ') .
                $this->columnAttrSql($column->get(Column::CONSTRAINT), '(', ')') .
                $this->columnAttrSql($column->get(Column::ATTRIBUTE), ' ') .
                $this->columnAttrSql($column->get(Column::NULLABLE, $action), ' ',) .
                $this->columnAttrSql($column->get(Column::DEFAULT), ' DEFAULT ' . ($column->defaultQuoted() ? '\'' : ''), ($column->defaultQuoted() ? '\'' : '')) .
                $this->columnAttrSql($column->get(Column::COMMENT), ' COMMENT \'', '\'') .
                $this->columnAttrSql($column->get(Column::AFTER), ' AFTER `', '`') .
                $this->columnAttrSql($column->get(Column::AUTO_INCREMENT), ' ');
    }

    /**
     * Prepares column attributes
     * @param mixed $definition
     * @param string $before
     * @param string $after
     * @return string
     */
    protected function columnAttrSql($definition, string $before = '', string $after = ''): string
    {
        $sql = '';

        if (!is_null($definition)) {

            $sql .= $before . (is_array($definition) ? ("'" . implode("', '", $definition) . "'") : $definition) . $after;
        }

        return $sql;
    }

    /**
     * Prepares statement for primary key
     * @return string
     */
    protected function primaryKeysSql(): string
    {
        $sql = '';

        if (isset($this->indexKeys['primary'])) {
            $sql .= ($this->action == self::ALTER ? 'ADD ' : '');


            $sql .= 'PRIMARY KEY (';

            foreach ($this->indexKeys['primary'] as $key => $primaryKey) {
                $sql .= '`' . $primaryKey['columnName'] . '`';
                $sql .= (array_key_last($this->indexKeys['primary']) != $key ? ', ' : '');
            }

            $sql .= ')';
        }

        return $sql;
    }

    /**
     * Prepares statement for index keys
     * @param string $type
     * @return string
     */
    protected function indexKeysSql(string $type): string
    {
        $sql = '';

        if (isset($this->indexKeys[$type])) {
            $indexes = [];

            foreach ($this->indexKeys[$type] as $indexKey) {
                $indexString = '';

                $indexString .= ($this->action == self::ALTER ? 'ADD ' : '');

                $indexString .= strtoupper($type);
                $indexString .= ($indexKey['indexName'] ? ' `' . $indexKey['indexName'] . '`' : '');
                $indexString .= ' (`' . $indexKey['columnName'] . '`)';

                array_push($indexes, $indexString);
            }

            $sql = implode(', ', $indexes);
        }

        return $sql;
    }

    /**
     * Builds a complete statement for index keys
     * @return string
     */
    protected function indexesSql(): string
    {
        $indexes = [
            $this->primaryKeysSql(),
            $this->indexKeysSql(Key::INDEX),
            $this->indexKeysSql(Key::UNIQUE),
            $this->indexKeysSql(Key::FULLTEXT),
            $this->indexKeysSql(Key::SPATIAL)
        ];

        return implode(', ', array_filter($indexes));
    }

    /**
     * Builds a statement for drop indexes
     * @return string
     */
    protected function dropIndexesSql()
    {
        $sql = '';

        if (!empty($this->droppedIndexKeys)) {
            $indexes = [];

            foreach ($this->droppedIndexKeys as $index) {
                $indexes[] = 'DROP INDEX `' . $index . '`';
            }

            $sql .= implode(', ', $indexes);
        }

        return $sql;
    }

}


1			<?php
2
3			/**
4			* Quantum PHP Framework
5			*
6			* An open source software development framework for PHP
7			*
8			* @package Quantum
9			* @author Arman Ag. <[email protected]>
10			* @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
11			* @link http://quantum.softberg.org/
12			* @since 2.7.0
13			*/
14
15			namespace Quantum\Libraries\Database\Schema;
16
17			/**
18			* Trait TableBuilder
19			* @package Quantum\Libraries\Database
20			*/
21			trait TableBuilder
22			{
23
24			/**
25			* Generates create table statement
26			* @return string
27			*/
28			protected function createTableSql()
29			{
30			$tableSchema = array_filter([$this->columnsSql(), $this->indexesSql()]);
31			$sql = '';
32
33			if ($tableSchema) {
			0 ignored issues – show Bug Best Practice introduced 2022-05-25 16:44 UTC by Report Bug Copy Issue Report The expression `$tableSchema` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
34			$sql = 'CREATE TABLE `' . $this->name . '` (';
35			$sql .= implode(', ', $tableSchema);
36			$sql .= ');';
37			}
38
39			return $sql;
40			}
41
42			/**
43			* Generates alter table statement
44			* @return string
45			*/
46			protected function alterTableSql(): string
47			{
48			$tableSchema = array_filter([$this->columnsSql(), $this->indexesSql(), $this->dropIndexesSql()]);
49			$sql = '';
50
51			if ($tableSchema) {
			0 ignored issues – show Bug Best Practice introduced 2022-05-25 16:44 UTC by Report Bug Copy Issue Report The expression `$tableSchema` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
52			$sql = 'ALTER TABLE `' . $this->name . '` ';
53			$sql .= implode(', ', $tableSchema);
54			$sql .= ';';
55			}
56
57			return $sql;
58			}
59
60			/**
61			* Prepares rename table statement
62			* @return string
63			*/
64			protected function renameTableSql(): string
65			{
66			return 'RENAME TABLE `' . $this->name . '` TO `' . $this->newName . '`;';
67			}
68
69			/**
70			* Prepares drop table statement
71			* @return string
72			*/
73			protected function dropTableSql(): string
74			{
75			return 'DROP TABLE `' . $this->name . '`';
76			}
77
78			/**
79			* Prepares columns statements for table
80			* @return string
81			*/
82			protected function columnsSql(): string
83			{
84			$sql = '';
85
86			if ($this->columns) {
87			$columns = [];
88
89			foreach ($this->columns as $entry) {
90			$columnString = '';
91
92			if ($entry['action'] != Column::ADD_INDEX && $entry['action'] != Column::DROP_INDEX) {
93			$columnString .= ($entry['action'] ? $entry['action'] . ' COLUMN ' : '');
94			$columnString .= $this->composeColumn($entry['column'], $entry['action']);
95			}
96
97			if ($entry['column']->get('indexKey')) {
98			$this->indexKeys[$entry['column']->get('indexKey')][] = [
			0 ignored issues – show Bug Best Practice introduced 2022-05-17 08:57 UTC by Report Bug Copy Issue Report The property `indexKeys` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
99			'columnName' => $entry['column']->get('name'),
100			'indexName' => $entry['column']->get('indexName'),
101			];
102			}
103
104			if ($entry['column']->get('indexDrop')) {
105			$this->droppedIndexKeys[] = $entry['column']->get('indexDrop');
			0 ignored issues – show Bug Best Practice introduced 2022-05-17 08:57 UTC by Report Bug Copy Issue Report The property `droppedIndexKeys` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
106			}
107
108			if ($columnString) {
109			array_push($columns, $columnString);
110			}
111			}
112
113			$sql = implode(', ', $columns);
114			}
115
116			return $sql;
117			}
118
119			/**
120			* Composes the column
121			* @param Column $column
122			* @param string $action
123			* @return string
124			*/
125			protected function composeColumn(Column $column, string $action = null): string
126			{
127			return
128			$this->columnAttrSql($column->get(Column::NAME), '`', '`') .
129			$this->columnAttrSql($column->get(Column::NEW_NAME), ' TO `', '`') .
130			$this->columnAttrSql($column->get(Column::TYPE), ' ') .
131			$this->columnAttrSql($column->get(Column::CONSTRAINT), '(', ')') .
132			$this->columnAttrSql($column->get(Column::ATTRIBUTE), ' ') .
133			$this->columnAttrSql($column->get(Column::NULLABLE, $action), ' ',) .
134			$this->columnAttrSql($column->get(Column::DEFAULT), ' DEFAULT ' . ($column->defaultQuoted() ? '\'' : ''), ($column->defaultQuoted() ? '\'' : '')) .
135			$this->columnAttrSql($column->get(Column::COMMENT), ' COMMENT \'', '\'') .
136			$this->columnAttrSql($column->get(Column::AFTER), ' AFTER `', '`') .
137			$this->columnAttrSql($column->get(Column::AUTO_INCREMENT), ' ');
138			}
139
140			/**
141			* Prepares column attributes
142			* @param mixed $definition
143			* @param string $before
144			* @param string $after
145			* @return string
146			*/
147			protected function columnAttrSql($definition, string $before = '', string $after = ''): string
148			{
149			$sql = '';
150
151			if (!is_null($definition)) {
152
153			$sql .= $before . (is_array($definition) ? ("'" . implode("', '", $definition) . "'") : $definition) . $after;
154			}
155
156			return $sql;
157			}
158
159			/**
160			* Prepares statement for primary key
161			* @return string
162			*/
163			protected function primaryKeysSql(): string
164			{
165			$sql = '';
166
167			if (isset($this->indexKeys['primary'])) {
168			$sql .= ($this->action == self::ALTER ? 'ADD ' : '');
			0 ignored issues – show Bug introduced 2022-05-17 08:57 UTC by Report Bug Copy Issue Report The constant `Quantum\Libraries\Databa...ema\TableBuilder::ALTER` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
169
170			$sql .= 'PRIMARY KEY (';
171
172			foreach ($this->indexKeys['primary'] as $key => $primaryKey) {
173			$sql .= '`' . $primaryKey['columnName'] . '`';
174			$sql .= (array_key_last($this->indexKeys['primary']) != $key ? ', ' : '');
175			}
176
177			$sql .= ')';
178			}
179
180			return $sql;
181			}
182
183			/**
184			* Prepares statement for index keys
185			* @param string $type
186			* @return string
187			*/
188			protected function indexKeysSql(string $type): string
189			{
190			$sql = '';
191
192			if (isset($this->indexKeys[$type])) {
193			$indexes = [];
194
195			foreach ($this->indexKeys[$type] as $indexKey) {
196			$indexString = '';
197
198			$indexString .= ($this->action == self::ALTER ? 'ADD ' : '');
			0 ignored issues – show Bug introduced 2022-05-17 08:57 UTC by Report Bug Copy Issue Report The constant `Quantum\Libraries\Databa...ema\TableBuilder::ALTER` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
199			$indexString .= strtoupper($type);
200			$indexString .= ($indexKey['indexName'] ? ' `' . $indexKey['indexName'] . '`' : '');
201			$indexString .= ' (`' . $indexKey['columnName'] . '`)';
202
203			array_push($indexes, $indexString);
204			}
205
206			$sql = implode(', ', $indexes);
207			}
208
209			return $sql;
210			}
211
212			/**
213			* Builds a complete statement for index keys
214			* @return string
215			*/
216			protected function indexesSql(): string
217			{
218			$indexes = [
219			$this->primaryKeysSql(),
220			$this->indexKeysSql(Key::INDEX),
221			$this->indexKeysSql(Key::UNIQUE),
222			$this->indexKeysSql(Key::FULLTEXT),
223			$this->indexKeysSql(Key::SPATIAL)
224			];
225
226			return implode(', ', array_filter($indexes));
227			}
228
229			/**
230			* Builds a statement for drop indexes
231			* @return string
232			*/
233			protected function dropIndexesSql()
234			{
235			$sql = '';
236
237			if (!empty($this->droppedIndexKeys)) {
238			$indexes = [];
239
240			foreach ($this->droppedIndexKeys as $index) {
241			$indexes[] = 'DROP INDEX `' . $index . '`';
242			}
243
244			$sql .= implode(', ', $indexes);
245			}
246
247			return $sql;
248			}
249
250			}
251

softberg / quantum-php-core

Push — master ( f6579a...8994b4 )

TableBuilder::renameTableSql() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like