Quantum\Libraries\Database\Schema\TableBuilder

Complexity

Total Complexity

42

Size/Duplication

Total Lines	228
Duplicated Lines	0 %

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	dropTableSql()	0	3	1
A	createTableSql()	0	14	3
B	alterTableSql()	0	16	9
A	indexKeysSql()	0	22	5
B	columnsSql()	0	35	9
A	dropIndexesSql()	0	15	3
A	columnAttrSql()	0	9	2
A	primaryKeysSql()	0	18	5
A	composeColumn()	0	13	3
A	renameTableSql()	0	3	1
A	indexesSql()	0	7	1

<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <arman.ag@softberg.org>
 * @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()
    {
        $columnsSql = $this->columnsSql();
        $indexesSql = $this->indexesSql();
        $sql = '';

        if ($columnsSql) {
            $sql = 'CREATE TABLE `' . $this->name . '` (';
            $sql .= $columnsSql;
            $sql .= ($indexesSql ? ', ' . $indexesSql : '');
            $sql .= ');';
        }

        return $sql;
    }

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

        if ($columnsSql || $indexesSql || $dropIndexesSql) {
            $sql = 'ALTER TABLE `' . $this->name . '` ';
            $sql .= $columnsSql;
            $sql .= (($columnsSql && $indexesSql) ? ', ' . $indexesSql : $indexesSql);
            $sql .= ((($columnsSql || $indexesSql) && $dropIndexesSql) ? ', ' . $dropIndexesSql : $dropIndexesSql);
            $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')][] = [

The property indexKeys does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

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

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

The property droppedIndexKeys does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

                }

                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 string|null $definition
     * @param string $before
     * @param string $after
     * @return string
     */
    protected function columnAttrSql(?string $definition, string $before = '', string $after = ''): string
    {
        $sql = '';

        if (!is_null($definition)) {
            $sql .= $before . $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 ' : '');

The constant Quantum\Libraries\Database\Schema\TableBuilder::ALTER was not found. Maybe you did not declare it correctly or list all dependencies?

            $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 $key => $indexKey) {
                $indexString = '';

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

The constant Quantum\Libraries\Database\Schema\TableBuilder::ALTER was not found. Maybe you did not declare it correctly or list all dependencies?

                $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
    {
        return $this->primaryKeysSql() .
                $this->indexKeysSql(Key::INDEX) .
                $this->indexKeysSql(Key::UNIQUE) .
                $this->indexKeysSql(Key::FULLTEXT) .
                $this->indexKeysSql(Key::SPATIAL);
    }

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

}