Platine\Database\Driver\Driver

Complexity

Total Complexity

192

Size/Duplication

Total Lines	1694
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

107 Methods

Rating	Name	Duplication	Size	Complexity
A	getModifierDefault()	0	5	2
A	havingNested()	0	3	1
A	quote()	0	3	1
A	getAddUnique()	0	7	1
A	getSetDefaultValue()	0	7	1
A	whereBetween()	0	8	2
A	whereExists()	0	6	2
A	havingInSelect()	0	7	2
A	renameTable()	0	6	1
A	whereNull()	0	6	2
A	getOffset()	0	3	2
A	getSqlFunction()	0	5	1
A	getModifierAutoincrement()	0	9	4
B	getExpressions()	0	30	8
A	getTables()	0	14	1
A	getTypeString()	0	3	1
A	getSetColumns()	0	12	3
A	getTableList()	0	15	4
A	getViews()	0	14	1
A	getColumnType()	0	14	3
A	getDropIndex()	0	6	1
A	update()	0	9	1
A	getTypeEnum()	0	3	1
A	whereLike()	0	7	2
A	columns()	0	3	1
A	getAddColumn()	0	6	1
A	getAddForeign()	0	11	1
A	aggregateFunctionCOUNT()	0	6	2
A	getTypeDecimal()	0	3	1
A	getModifierNullable()	0	3	2
A	aggregateFunctionMAX()	0	6	2
A	quoteIdentifiers()	0	3	1
A	joinNested()	0	3	1
A	getTypeDate()	0	3	1
A	getIndexKeys()	0	17	3
A	havingBetween()	0	8	2
A	aggregateFunctionMIN()	0	6	2
A	havingIn()	0	7	2
A	getDropForeignKey()	0	6	1
A	joinExpression()	0	3	1
A	getDropColumn()	0	6	1
A	getModifierAfter()	0	4	2
A	setOptions()	0	4	2
A	delete()	0	9	2
A	getModifierDescription()	0	4	2
A	getOrders()	0	11	3
A	getTypeDouble()	0	3	1
A	whereNop()	0	3	1
A	truncate()	0	5	1
A	getHaving()	0	7	3
A	getDropUniqueKey()	0	6	1
A	getTypeBoolean()	0	3	1
A	whereSubQuery()	0	7	1
A	getEngine()	0	8	2
A	getModifyColumn()	0	6	1
A	getJoins()	0	23	5
A	params()	0	3	1
A	getWheres()	0	7	3
A	param()	0	11	3
A	setDateFormat()	0	5	1
A	getWheresHaving()	0	13	3
A	getPrimaryKey()	0	9	2
A	getTypeInteger()	0	3	1
A	getSchemaColumns()	0	13	2
A	getDatabaseName()	0	5	1
A	getTypeBinary()	0	3	1
A	getDropDefaultValue()	0	6	1
A	aggregateFunctionSUM()	0	6	2
A	whereIn()	0	7	2
A	value()	0	15	5
A	__construct()	0	2	1
A	getTypeDatetime()	0	3	1
A	getDropPrimaryKey()	0	6	1
A	joinColumn()	0	7	1
A	getTypeFloat()	0	3	1
A	getAddIndex()	0	7	1
A	getViewColumns()	0	19	1
A	getTypeFixed()	0	3	1
A	insert()	0	10	2
A	getColumns()	0	19	1
A	getTypeText()	0	3	1
A	quoteIdentifier()	0	17	4
A	getForeignKeys()	0	23	4
A	create()	0	26	2
A	getInto()	0	6	2
A	getTypeTime()	0	3	1
A	whereInSelect()	0	7	2
A	getParams()	0	6	1
A	getRenameColumn()	0	4	1
A	getModifierUnsigned()	0	3	2
A	getColumnModifiers()	0	16	3
A	getDateFormat()	0	3	1
A	aggregateFunctionAVG()	0	6	2
A	havingCondition()	0	7	1
A	getTypeTimestamp()	0	3	1
A	select()	0	16	2
A	getJoinConditions()	0	17	3
A	getUniqueKeys()	0	16	3
A	whereColumn()	0	7	1
A	drop()	0	5	1
A	getAddPrimary()	0	7	1
A	alter()	0	19	3
A	getGroupBy()	0	3	2
A	getColumnList()	0	17	4
A	whereNested()	0	3	1
A	getInsertValues()	0	3	1
A	getLimit()	0	3	2

<?php

/**
 * Platine Database
 *
 * Platine Database is the abstraction layer using PDO with support of query and schema builder
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine Database
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file Driver.php
 *
 *  The Database Query Driver class
 *
 *  Each driver like MySQL, SQLite, Oracle, etc. need extend this class
 *
 *  @package    Platine\Database\Driver
 *  @author Platine Developers Team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\Database\Driver;

use DateTime;
use Platine\Database\Connection;
use Platine\Database\Query\Expression;
use Platine\Database\Query\QueryStatement;
use Platine\Database\Schema\AlterTable;
use Platine\Database\Schema\BaseColumn;
use Platine\Database\Schema\CreateTable;
use Platine\Database\Schema\ForeignKey;


/**
 * @class Driver
 * @package Platine\Database\Driver
 */
class Driver
{
    /**
     * The driver default date format
     * @var string
     */
    protected string $dateFormat = 'Y-m-d H:i:s';

    /**
     * The quote identifier for a table and columns
     * @var string
     */
    protected string $identifier = '"%s"';

    /**
     * Each query separator
     * @var string
     */
    protected string $separator = ';';

    /**
     * The columns modifiers
     * @var array<string>
     */
    protected array $modifiers = [
        'unsigned',
        'nullable',
        'default',
        'autoincrement',
        'description',
        'after',
    ];

    /**
     * Columns serial
     * @var array<string>
     */
    protected array $serials = [
        'tiny',
        'small',
        'normal',
        'medium',
        'big'
    ];

    /**
     * Auto increment value modifier
     * @var string
     */
    protected string $autoincrement = 'AUTO_INCREMENT';

    /**
     * The query parameters
     * @var array<mixed>
     */
    protected array $params = [];

    /**
     * @class constructor
     * @param Connection $connection
     */
    public function __construct(protected Connection $connection)
    {
    }

    /**
     * Returns the SQL for SELECT statement
     * @param QueryStatement $select
     *
     * @return string
     */
    public function select(QueryStatement $select): string
    {
        $sql = $select->hasDistinct() ? 'SELECT DISTINCT ' : 'SELECT ';
        $sql .= $this->getColumnList($select->getColumns());
        $sql .= $this->getInto($select->getIntoTable());
        $sql .= ' FROM ';
        $sql .= $this->getTableList($select->getTables());
        $sql .= $this->getJoins($select->getJoins());
        $sql .= $this->getWheres($select->getWheres());
        $sql .= $this->getGroupBy($select->getGroupBy());
        $sql .= $this->getHaving($select->getHaving());
        $sql .= $this->getOrders($select->getOrder());
        $sql .= $this->getLimit($select->getLimit());
        $sql .= $this->getOffset($select->getOffset());

        return $sql;
    }

    /**
     * Return SQL for INSERT statement
     * @param QueryStatement $insert
     *
     * @return string
     */
    public function insert(QueryStatement $insert): string
    {
        $columns = $this->getColumnList($insert->getColumns());

        $sql = 'INSERT INTO ';
        $sql .= $this->getTableList($insert->getTables());
        $sql .= ($columns == '*') ? '' : '(' . $columns . ')';
        $sql .= $this->getInsertValues($insert->getValues());

        return $sql;
    }

    /**
     * Return the SQL for UPDATE statement
     * @param QueryStatement $update
     *
     * @return string
     */
    public function update(QueryStatement $update): string
    {
        $sql = 'UPDATE ';
        $sql .= $this->getTableList($update->getTables());
        $sql .= $this->getJoins($update->getJoins());
        $sql .= $this->getSetColumns($update->getColumns());
        $sql .= $this->getWheres($update->getWheres());

        return $sql;
    }

    /**
     * Return the SQL for DELETE statement
     * @param QueryStatement $delete
     *
     * @return string
     */
    public function delete(QueryStatement $delete): string
    {
        $sql = 'DELETE ' . $this->getTableList($delete->getTables());
        $sql .= $sql === 'DELETE ' ? 'FROM ' : ' FROM ';
        $sql .= $this->getTableList($delete->getFrom());
        $sql .= $this->getJoins($delete->getJoins());
        $sql .= $this->getWheres($delete->getWheres());

        return $sql;
    }

    /**
     * Return the date format
     * @return string
     */
    public function getDateFormat(): string
    {
        return $this->dateFormat;
    }

    /**
     *
     * @param string $format
     * @return $this
     */
    public function setDateFormat(string $format): self
    {
        $this->dateFormat = $format;

        return $this;
    }

    /**
     * Set the drive options
     * @param array<string, mixed> $options
     */
    public function setOptions(array $options): void
    {
        foreach ($options as $name => $value) {
            $this->{$name} = $value;
        }
    }

    /**
     * @param array<mixed> $params
     *
     * @return string
     */
    public function params(array $params): string
    {
        return implode(', ', array_map([$this, 'param'], $params));
    }

    /**
     * @return array<mixed>
     */
    public function getParams(): array
    {
        $params = $this->params;
        $this->params = [];

        return $params;
    }

    /**
     * @param Expression[]|string[] $columns
     *
     * @return string
     */
    public function columns(array $columns): string
    {
        return implode(', ', array_map([$this, 'quoteIdentifier'], $columns));
    }

    /**
     * @param string $value
     *
     * @return string
     */
    public function quote(string $value): string
    {
        return "'" . str_replace("'", "''", $value) . "'";
    }

    /**
     * Return the SQL for the current database
     * @return array<string, mixed>
     */
    public function getDatabaseName(): array
    {
        return [
            'sql' => 'SELECT database()',
            'params' => []
        ];
    }

    /**
     *
     * @param string $current
     * @param string $new
     * @return array<string, mixed>
     */
    public function renameTable(string $current, string $new): array
    {
        return [
            'sql' => 'RENAME TABLE ' . $this->quoteIdentifier($current)
            . ' TO ' . $this->quoteIdentifier($new),
            'params' => []
        ];
    }

    /**
     *
     * @param string $database
     * @return array<string, mixed>
     */
    public function getTables(string $database): array
    {
        $sql = sprintf(
            'SELECT %s FROM %s.%s WHERE table_type = ? '
                . 'AND table_schema = ? ORDER BY %s ASC',
            $this->quoteIdentifier('table_name'),
            $this->quoteIdentifier('information_schema'),
            $this->quoteIdentifier('tables'),
            $this->quoteIdentifier('table_name'),
        );

        return [
            'sql' => $sql,
            'params' => ['BASE TABLE', $database]
        ];
    }

    /**
     *
     * @param string $database
     * @return array<string, mixed>
     */
    public function getViews(string $database): array
    {
        $sql = sprintf(
            'SELECT %s FROM %s.%s WHERE table_type = ? '
                . 'AND table_schema = ? ORDER BY %s ASC',
            $this->quoteIdentifier('table_name'),
            $this->quoteIdentifier('information_schema'),
            $this->quoteIdentifier('tables'),
            $this->quoteIdentifier('table_name'),
        );

        return [
            'sql' => $sql,
            'params' => ['VIEW', $database]
        ];
    }

    /**
     *
     * @param string $database
     * @param string $table
     * @return array<string, mixed>
     */
    public function getColumns(string $database, string $table): array
    {
        $sql = sprintf(
            'SELECT %s AS %s, %s AS %s FROM %s.%s WHERE %s = ? '
                . 'AND %s = ? ORDER BY %s ASC',
            $this->quoteIdentifier('column_name'),
            $this->quoteIdentifier('name'),
            $this->quoteIdentifier('column_type'),
            $this->quoteIdentifier('type'),
            $this->quoteIdentifier('information_schema'),
            $this->quoteIdentifier('columns'),
            $this->quoteIdentifier('table_schema'),
            $this->quoteIdentifier('table_name'),
            $this->quoteIdentifier('ordinal_position'),
        );

        return [
            'sql' => $sql,
            'params' => [$database, $table]
        ];
    }

    /**
     *
     * @param string $database
     * @param string $view
     * @return array<string, mixed>
     */
    public function getViewColumns(string $database, string $view): array
    {
        $sql = sprintf(
            'SELECT %s AS %s, %s AS %s FROM %s.%s WHERE %s = ? '
                . 'AND %s = ? ORDER BY %s ASC',
            $this->quoteIdentifier('column_name'),
            $this->quoteIdentifier('name'),
            $this->quoteIdentifier('column_type'),
            $this->quoteIdentifier('type'),
            $this->quoteIdentifier('information_schema'),
            $this->quoteIdentifier('columns'),
            $this->quoteIdentifier('table_schema'),
            $this->quoteIdentifier('table_name'),
            $this->quoteIdentifier('ordinal_position'),
        );

        return [
            'sql' => $sql,
            'params' => [$database, $view]
        ];
    }

    /**
     *
     * @param CreateTable $schema
     * @return array<int, array<string, mixed>>
     */
    public function create(CreateTable $schema): array
    {
        $sql = 'CREATE TABLE ' . $this->quoteIdentifier($schema->getTableName());
        $sql .= "(\n";
        $sql .= $this->getSchemaColumns($schema->getColumns());
        $sql .= $this->getPrimaryKey($schema);
        $sql .= $this->getUniqueKeys($schema);
        $sql .= $this->getForeignKeys($schema);
        $sql .= ")\n";
        $sql .= $this->getEngine($schema);

        $commands = [];

        $commands[] = [
            'sql' => $sql,
            'params' => []
        ];

        foreach ($this->getIndexKeys($schema) as $index) {
            $commands[] = [
                'sql' => $index,
                'params' => []
            ];
        }

        return $commands;
    }

    /**
     *
     * @param AlterTable $schema
     * @return array<int, array<string, mixed>>
     */
    public function alter(AlterTable $schema): array
    {
        $commands = [];

        foreach ($schema->getCommands() as $command) {
            $callback = 'get' . ucfirst($command['type']);
            $sql = $this->{$callback}($schema, $command['data']);

            if ($sql === '') {
                continue;
            }

            $commands[] = [
                'sql' => $sql,
                'params' => $this->getParams()
            ];
        }

        return $commands;
    }

    /**
     *
     * @param string $table
     * @return array<string, mixed>
     */
    public function drop(string $table): array
    {
        return [
            'sql' => 'DROP TABLE ' . $this->quoteIdentifier($table),
            'params' => []
        ];
    }

    /**
     *
     * @param string $table
     * @return array<string, mixed>
     */
    public function truncate(string $table): array
    {
        return [
            'sql' => 'TRUNCATE TABLE ' . $this->quoteIdentifier($table),
            'params' => []
        ];
    }

    /**
     * @param mixed $value
     *
     * @return string
     */
    protected function param(mixed $value): string
    {
        if ($value instanceof Expression) {
            return $this->getExpressions($value->getExpressions());
        } elseif ($value instanceof DateTime) {
            $this->params[] = $value->format($this->dateFormat);
        } else {
            $this->params[] = $value;
        }

        return '?';
    }

    /**
     * Get the value by convert it to the type
     * @param mixed $value
     * @return mixed
     *
     */
    protected function value(mixed $value): mixed
    {
        if (is_numeric($value)) {
            return $value;
        }

        if (is_bool($value)) {
            return $value ? 1 : 0;
        }

        if (is_string($value)) {
            return "'" . str_replace("'", "''", $value) . "'";
        }

        return 'NULL';
    }

    /**
     * Add quote identifier like "", ``
     * @param string|Expression $value
     *
     * @return string
     */
    protected function quoteIdentifier(string|Expression $value): string
    {
        if ($value instanceof Expression) {
            return $this->getExpressions($value->getExpressions());
        }

        $identifiers = [];

        foreach (explode('.', $value) as $segment) {
            if ($segment === '*') {
                $identifiers[] = $segment;
            } else {
                $identifiers[] = sprintf($this->identifier, $segment);
            }
        }

        return implode('.', $identifiers);
    }

    /**
     *
     * @param array<mixed> $values
     * @param string $separator
     * @return string
     */
    protected function quoteIdentifiers(array $values, string $separator = ', '): string
    {
        return implode($separator, array_map([$this, 'quoteIdentifier'], $values));
    }

    /**
     * Handle expressions
     * @param array<int, array<string, mixed>> $expressions
     *
     * @return string
     */
    protected function getExpressions(array $expressions): string
    {
        $sql = [];

        foreach ($expressions as $expression) {
            switch ($expression['type']) {
                case 'column':
                    $sql[] = $this->quoteIdentifier($expression['value']);
                    break;
                case 'op':
                    $sql[] = $expression['value'];
                    break;
                case 'value':
                    $sql[] = $this->param($expression['value']);
                    break;
                case 'group':
                    $expr = $expression['value'];
                    $sql[] = '(' . $this->getExpressions($expr->getExpressions()) . ')';
                    break;
                case 'function':
                    $sql[] = $this->getSqlFunction($expression['value']);
                    break;
                case 'subquery':
                    $subQuery = $expression['value'];
                    $sql[] = '(' . $this->select($subQuery->getQueryStatement()) . ')';
                    break;
            }
        }

        return implode(' ', $sql);
    }

    /**
     * Handle SQL function
     * @param array<string, mixed> $functions
     *
     * @return string
     */
    protected function getSqlFunction(array $functions): string
    {
        $method = $functions['type'] . $functions['name'];

        return $this->{$method}($functions);
    }

    /**
     * Handle columns
     * @param array<int, array<string, mixed>> $columns
     *
     * @return string
     */
    protected function getColumnList(array $columns): string
    {
        if (count($columns) === 0) {
            return '*';
        }
        $sql = [];

        foreach ($columns as $column) {
            if (isset($column['alias'])) {
                $sql[] = $this->quoteIdentifier($column['name'])
                        . ' AS ' . $this->quoteIdentifier($column['alias']);
            } else {
                $sql[] = $this->quoteIdentifier($column['name']);
            }
        }

        return implode(', ', $sql);
    }

    /**
     * Handle schema columns
     * @param array<int|string, BaseColumn> $columns list of BaseColumn
     * @return string
     */
    protected function getSchemaColumns(array $columns): string
    {
        $sql = [];

        foreach ($columns as $column) {
            $line = $this->quoteIdentifier($column->getName());
            $line .= $this->getColumnType($column);
            $line .= $this->getColumnModifiers($column);

            $sql[] = $line;
        }

        return implode(",\n", $sql);
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getColumnType(BaseColumn $column): string
    {
        $type = $column->getType();
        $result = '';
        if (is_string($type)) {
            $callback = 'getType' . ucfirst($type);
            $result = trim($this->{$callback}($column));

            if ($result !== '') {
                $result = ' ' . $result;
            }
        }

        return $result;
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getColumnModifiers(BaseColumn $column): string
    {
        $line = '';
        foreach ($this->modifiers as $modifier) {
            $callback = 'getModifier' . ucfirst($modifier);
            $result = trim($this->{$callback}($column));


            if ($result !== '') {
                $result = ' ' . $result;
            }

            $line .= $result;
        }

        return $line;
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeInteger(BaseColumn $column): string
    {
        return 'INT';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeFloat(BaseColumn $column): string
    {
        return 'FLOAT';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeDouble(BaseColumn $column): string
    {
        return 'DOUBLE';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeDecimal(BaseColumn $column): string
    {
        return 'DECIMAL';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeEnum(BaseColumn $column): string
    {
        return 'ENUM';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeBoolean(BaseColumn $column): string
    {
        return 'BOOLEAN';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeBinary(BaseColumn $column): string
    {
        return 'BLOB';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeText(BaseColumn $column): string
    {
        return 'TEXT';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeString(BaseColumn $column): string
    {
        return 'VARCHAR(' . $this->value($column->get('length', 255)) . ')';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeFixed(BaseColumn $column): string
    {
        return 'CHAR(' . $this->value($column->get('length', 255)) . ')';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeTime(BaseColumn $column): string
    {
        return 'TIME';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeTimestamp(BaseColumn $column): string
    {
        return 'TIMESTAMP';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeDate(BaseColumn $column): string
    {
        return 'DATE';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getTypeDatetime(BaseColumn $column): string
    {
        return 'DATETIME';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getModifierUnsigned(BaseColumn $column): string
    {
        return $column->get('unsigned', false) ? 'UNSIGNED' : '';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getModifierNullable(BaseColumn $column): string
    {
        return $column->get('nullable', true) ? '' : 'NOT NULL';
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getModifierDefault(BaseColumn $column): string
    {
        return $column->get('default', null) === null
                ? ''
                : 'DEFAULT ' . $this->value($column->get('default'));
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getModifierDescription(BaseColumn $column): string
    {
        return $column->get('description', null) === null ? '' : 'COMMENT '
                . $this->value($column->get('description'));
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getModifierAfter(BaseColumn $column): string
    {
        return $column->get('after', null) === null ? '' : 'AFTER '
                . $this->quoteIdentifier($column->get('after'));
    }

    /**
     *
     * @param BaseColumn $column
     * @return string
     */
    protected function getModifierAutoincrement(BaseColumn $column): string
    {
        if (
            $column->getType() !== 'integer'
            || !in_array($column->get('size', 'normal'), $this->serials)
        ) {
            return '';
        }
        return $column->get('autoincrement', false) ? $this->autoincrement : '';
    }

    /**
     *
     * @param CreateTable $schema
     * @return string
     */
    protected function getPrimaryKey(CreateTable $schema): string
    {
        $primaryKey = $schema->getPrimaryKey();
        if (count($primaryKey) === 0) {
            return '';
        }

        return ",\n" . 'CONSTRAINT ' . $this->quoteIdentifier($primaryKey['name'])
                . ' PRIMARY KEY (' . $this->quoteIdentifiers($primaryKey['columns']) . ')';
    }

    /**
     *
     * @param CreateTable $schema
     * @return string
     */
    protected function getUniqueKeys(CreateTable $schema): string
    {
        $indexes = $schema->getUniqueKeys();

        if (count($indexes) === 0) {
            return '';
        }

        $sql = [];

        foreach ($indexes as $name => $columns) {
            $sql[] = 'CONSTRAINT ' . $this->quoteIdentifier($name)
                    . ' UNIQUE (' . $this->quoteIdentifiers($columns) . ')';
        }

        return ",\n" . implode(",\n", $sql);
    }

    /**
     *
     * @param CreateTable $schema
     * @return array<int, string>
     */
    protected function getIndexKeys(CreateTable $schema): array
    {
        $indexes = $schema->getIndexes();

        if (count($indexes) === 0) {
            return [];
        }

        $sql = [];
        $table = $this->quoteIdentifier($schema->getTableName());

        foreach ($indexes as $name => $columns) {
            $sql[] = 'CREATE INDEX ' . $this->quoteIdentifier($name)
                    . ' ON ' . $table . '(' . $this->quoteIdentifiers($columns) . ')';
        }

        return $sql;
    }

    /**
     *
     * @param CreateTable $schema
     * @return string
     */
    protected function getForeignKeys(CreateTable $schema): string
    {
        $keys = $schema->getForeignKeys();

        if (count($keys) === 0) {
            return '';
        }

        $sql = [];

        foreach ($keys as $name => $key) {
            $cmd = 'CONSTRAINT ' . $this->quoteIdentifier($name)
                    . ' FOREIGN KEY (' . $this->quoteIdentifiers($key->getColumns()) . ') ';
            $cmd .= 'REFERENCES ' . $this->quoteIdentifier($key->getReferenceTable())
                    . ' (' . $this->quoteIdentifiers($key->getReferenceColumns()) . ')';

            foreach ($key->getActions() as $actionName => $action) {
                $cmd .= ' ' . $actionName . ' ' . $action;
            }
            $sql[] = $cmd;
        }

        return ",\n" . implode(",\n", $sql);
    }

    /**
     *
     * @param CreateTable $schema
     * @return string
     */
    protected function getEngine(CreateTable $schema): string
    {
        $engine = $schema->getEngine();
        if ($engine === null) {
            return '';
        }

        return ' ENGINE = ' . strtoupper($engine);
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getDropPrimaryKey(AlterTable $schema, mixed $data): string
    {
        return sprintf(
            'ALTER TABLE %s DROP CONSTRAINT %s',
            $this->quoteIdentifier($schema->getTableName()),
            $this->quoteIdentifier($data)
        );
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getDropUniqueKey(AlterTable $schema, mixed $data): string
    {
        return sprintf(
            'ALTER TABLE %s DROP CONSTRAINT %s',
            $this->quoteIdentifier($schema->getTableName()),
            $this->quoteIdentifier($data)
        );
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getDropIndex(AlterTable $schema, mixed $data): string
    {
        return sprintf(
            'DROP INDEX %s.%s',
            $this->quoteIdentifier($schema->getTableName()),
            $this->quoteIdentifier($data)
        );
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getDropForeignKey(AlterTable $schema, mixed $data): string
    {
        return sprintf(
            'ALTER TABLE %s DROP CONSTRAINT %s',
            $this->quoteIdentifier($schema->getTableName()),
            $this->quoteIdentifier($data)
        );
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getDropColumn(AlterTable $schema, mixed $data): string
    {
        return sprintf(
            'ALTER TABLE %s DROP COLUMN %s',
            $this->quoteIdentifier($schema->getTableName()),
            $this->quoteIdentifier($data)
        );
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getRenameColumn(AlterTable $schema, mixed $data): string
    {
        //TODO: please implement it in subclass
        return '';
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getModifyColumn(AlterTable $schema, mixed $data): string
    {
        return sprintf(
            'ALTER TABLE %s MODIFY COLUMN %s',
            $this->quoteIdentifier($schema->getTableName()),
            $this->getSchemaColumns([$data])
        );
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getAddColumn(AlterTable $schema, mixed $data): string
    {
        return sprintf(
            'ALTER TABLE %s ADD COLUMN %s',
            $this->quoteIdentifier($schema->getTableName()),
            $this->getSchemaColumns([$data])
        );
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getAddPrimary(AlterTable $schema, mixed $data): string
    {
        return sprintf(
            'ALTER TABLE %s ADD CONSTRAINT %s PRIMARY KEY (%s)',
            $this->quoteIdentifier($schema->getTableName()),
            $this->quoteIdentifier($data['name']),
            $this->quoteIdentifiers($data['columns'])
        );
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getAddUnique(AlterTable $schema, mixed $data): string
    {
        return sprintf(
            'ALTER TABLE %s ADD CONSTRAINT %s UNIQUE (%s)',
            $this->quoteIdentifier($schema->getTableName()),
            $this->quoteIdentifier($data['name']),
            $this->quoteIdentifiers($data['columns'])
        );
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getAddIndex(AlterTable $schema, mixed $data): string
    {
        return sprintf(
            'CREATE INDEX %s ON %s (%s)',
            $this->quoteIdentifier($data['name']),
            $this->quoteIdentifier($schema->getTableName()),
            $this->quoteIdentifiers($data['columns'])
        );
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getAddForeign(AlterTable $schema, mixed $data): string
    {
        /** @var ForeignKey $key */
        $key = $data['foreign'];
        return sprintf(
            'ALTER TABLE %s ADD CONSTRAINT %s FOREIGN KEY (%s) REFERENCES %s (%s)',
            $this->quoteIdentifier($schema->getTableName()),
            $this->quoteIdentifier($data['name']),
            $this->quoteIdentifiers($key->getColumns()),
            $this->quoteIdentifier($key->getReferenceTable()),
            $this->quoteIdentifiers($key->getReferenceColumns()),
        );
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getSetDefaultValue(AlterTable $schema, mixed $data): string
    {
        return sprintf(
            'ALTER TABLE %s ALTER COLUMN %s SET DEFAULT (%s)',
            $this->quoteIdentifier($schema->getTableName()),
            $this->quoteIdentifier($data['column']),
            $this->value($data['value'])
        );
    }

    /**
     *
     * @param AlterTable $schema
     * @param mixed $data
     * @return string
     */
    protected function getDropDefaultValue(AlterTable $schema, mixed $data): string
    {
        return sprintf(
            'ALTER TABLE %s ALTER COLUMN %s DROP DEFAULT',
            $this->quoteIdentifier($schema->getTableName()),
            $this->quoteIdentifier($data)
        );
    }

    /**
     * Handle into the table
     *
     * @param string|null $table
     *
     * @return string
     */
    protected function getInto(?string $table): string
    {
        if ($table === null) {
            return '';
        }
        return ' INTO ' . $this->quoteIdentifier($table);
    }

    /**
     * Handle tables
     * @param array<mixed, string> $tables
     *
     * @return string
     */
    protected function getTableList(array $tables): string
    {
        if (count($tables) === 0) {
            return '';
        }
        $sql = [];
        foreach ($tables as $name => $alias) {
            if (is_string($name)) {
                $sql[] = $this->quoteIdentifier($name) . ' AS ' . $this->quoteIdentifier($alias);
            } else {
                $sql[] = $this->quoteIdentifier($alias);
            }
        }

        return implode(', ', $sql);
    }

    /**
     * Handle for joins
     * @param array<int, mixed> $joins
     *
     * @return string
     */
    protected function getJoins(array $joins): string
    {
        if (count($joins) === 0) {
            return '';
        }
        $sql = [];

        foreach ($joins as $join) {
            $joinObject = $join['join'];

            $on = '';
            if ($joinObject) {
                $on = $this->getJoinConditions($joinObject->getJoinConditions());
            }

            if ($on !== '') {
                $on = ' ON ' . $on;
            }

            $sql[] = $join['type'] . ' JOIN ' . $this->getTableList($join['table']) . $on;
        }

        return ' ' . implode(' ', $sql);
    }

    /**
     * Handle for the join conditions
     * @param array<int, mixed> $conditions
     * @return string
     */
    protected function getJoinConditions(array $conditions): string
    {
        if (count($conditions) === 0) {
            return '';
        }

        $sql = [];

        $sql[] = $this->{$conditions[0]['type']}($conditions[0]);

        $count = count($conditions);
        for ($i = 1; $i < $count; $i++) {
            $sql[] = $conditions[$i]['separator'] . ' '
                    . $this->{$conditions[$i]['type']}($conditions[$i]);
        }

        return implode(' ', $sql);
    }

    /**
     * Handle group by
     * @param Expression[]|string[] $groupBy
     *
     * @return string
     */
    protected function getGroupBy(array $groupBy): string
    {
        return count($groupBy) === 0 ? '' : ' GROUP BY ' . $this->columns($groupBy);
    }

    /**
     * Handle for Order
     * @param array<int, array<string, mixed>> $orders
     * @return string
     */
    protected function getOrders(array $orders): string
    {
        if (count($orders) === 0) {
            return '';
        }
        $sql = [];
        foreach ($orders as $order) {
            $sql[] = $this->columns($order['columns']) . ' ' . $order['order'];
        }

        return ' ORDER BY ' . implode(', ', $sql);
    }

    /**
     * Handle columns for set (UPDATE)
     * @param array<int, array<string, mixed>> $columns
     * @return string
     */
    protected function getSetColumns(array $columns): string
    {
        if (count($columns) === 0) {
            return '';
        }
        $sql = [];

        foreach ($columns as $column) {
            $sql[] = $this->quoteIdentifier($column['column']) . ' = ' . $this->param($column['value']);
        }

        return ' SET ' . implode(', ', $sql);
    }

    /**
     * Handler where
     * @param array<int, mixed> $wheres
     * @param bool $prefix
     *
     * @return string
     */
    protected function getWheres(array $wheres, bool $prefix = true): string
    {
        $sql = $this->getWheresHaving($wheres);
        if (empty($sql)) {
            return '';
        }
        return ($prefix ? ' WHERE ' : '') . $sql;
    }

    /**
     * Handle for having
     * @param array<int, mixed> $having
     * @param bool $prefix
     * @return string
     */
    protected function getHaving(array $having, bool $prefix = true): string
    {
        $sql = $this->getWheresHaving($having);
        if (empty($sql)) {
            return '';
        }
        return ($prefix ? ' HAVING ' : '') . $sql;
    }

    /**
     * Return the build part for where or having
     * @param array<int, mixed> $values
     *
     * @return string
     */
    protected function getWheresHaving(array $values): string
    {
        if (count($values) === 0) {
            return '';
        }
        $sql = [];
        $sql[] = $this->{$values[0]['type']}($values[0]);
        $count = count($values);

        for ($i = 1; $i < $count; $i++) {
            $sql[] = $values[$i]['separator'] . ' ' . $this->{$values[$i]['type']}($values[$i]);
        }
        return implode(' ', $sql);
    }

    /**
     * Handle for insert values
     * @param array<int, mixed> $values
     * @return string
     */
    protected function getInsertValues(array $values): string
    {
        return ' VALUES (' . $this->params($values) . ')';
    }

    /**
     * Handle for limit
     * @param int $limit
     * @return string
     */
    protected function getLimit(int $limit): string
    {
        return ($limit === 0) ? '' : ' LIMIT ' . $this->param($limit);
    }

    /**
     * Handle for offset
     * @param int $offset
     * @return string
     */
    protected function getOffset(int $offset): string
    {
        return ($offset < 0) ? '' : ' OFFSET ' . $this->param($offset);
    }

    /**
     * @param array<string, mixed> $join
     * @return string
     */
    protected function joinColumn(array $join): string
    {
        return sprintf(
            '%s %s %s',
            $this->quoteIdentifier($join['column1']),
            $join['operator'],
            $this->quoteIdentifier($join['column2'])
        );
    }

    /**
     * @param array<string, mixed> $join
     * @return string
     */
    protected function joinNested(array $join): string
    {
        return '(' . $this->getJoinConditions($join['join']->getJoinConditions()) . ')';
    }

    /**
     * @param array<string, mixed> $join
     * @return string
     */
    protected function joinExpression(array $join): string
    {
        return $this->quoteIdentifier($join['expression']);
    }

    /**
     * @param array<string, mixed> $where
     * @return string
     */
    protected function whereColumn(array $where): string
    {
        return sprintf(
            '%s %s %s',
            $this->quoteIdentifier($where['column']),
            $where['operator'],
            $this->param($where['value'])
        );
    }

    /**
     * @param array<string, mixed> $where
     * @return string
     */
    protected function whereIn(array $where): string
    {
        return sprintf(
            '%s %s (%s)',
            $this->quoteIdentifier($where['column']),
            $where['not'] ? 'NOT IN' : 'IN',
            $this->params($where['value'])
        );
    }

    /**
     * @param array<string, mixed> $where
     * @return string
     */
    protected function whereInSelect(array $where): string
    {
        return sprintf(
            '%s %s (%s)',
            $this->quoteIdentifier($where['column']),
            $where['not'] ? 'NOT IN' : 'IN',
            $this->select($where['subquery']->getQueryStatement())
        );
    }

    /**
     * @param array<string, mixed> $where
     * @return string
     */
    protected function whereNested(array $where): string
    {
        return '(' . $this->getWheres($where['clause'], false) . ')';
    }

    /**
     * @param array<string, mixed> $where
     * @return string
     */
    public function whereExists(array $where): string
    {
        return sprintf(
            '%s (%s)',
            $where['not'] ? 'NOT EXISTS' : 'EXISTS',
            $this->select($where['subquery']->getQueryStatement())
        );
    }

    /**
     * @param array<string, mixed> $where
     * @return string
     */
    protected function whereNull(array $where): string
    {
        return sprintf(
            '%s %s',
            $this->quoteIdentifier($where['column']),
            $where['not'] ? 'IS NOT NULL' : 'IS NULL',
        );
    }

    /**
     * @param array<string, mixed> $where
     * @return string
     */
    protected function whereBetween(array $where): string
    {
        return sprintf(
            '%s %s %s AND %s',
            $this->quoteIdentifier($where['column']),
            $where['not'] ? 'NOT BETWEEN' : 'BETWEEN',
            $this->param($where['value1']),
            $this->param($where['value2']),
        );
    }

    /**
     * @param array<string, mixed> $where
     * @return string
     */
    protected function whereLike(array $where): string
    {
        return sprintf(
            '%s %s %s',
            $this->quoteIdentifier($where['column']),
            $where['not'] ? 'NOT LIKE' : 'LIKE',
            $this->param($where['pattern']),
        );
    }

    /**
     * @param array<string, mixed> $where
     * @return string
     */
    protected function whereSubQuery(array $where): string
    {
        return sprintf(
            '%s %s (%s)',
            $this->quoteIdentifier($where['column']),
            $where['operator'],
            $this->select($where['subquery']->getQueryStatement())
        );
    }

    /**
     * @param array<string, mixed> $where
     * @return string
     */
    protected function whereNop(array $where): string
    {
        return $this->quoteIdentifier($where['column']);
    }

    /**
     * @param array<string, mixed> $having
     * @return string
     */
    protected function havingCondition(array $having): string
    {
        return sprintf(
            '%s %s %s',
            $this->quoteIdentifier($having['aggregate']),
            $having['operator'],
            $having['value']
        );
    }

    /**
     * @param array<string, mixed> $having
     * @return string
     */
    protected function havingNested(array $having): string
    {
        return '(' . $this->getHaving($having['conditions'], false) . ')';
    }

    /**
     * @param array<string, mixed> $having
     * @return string
     */
    protected function havingBetween(array $having): string
    {
        return sprintf(
            '%s %s %s AND %s',
            $this->quoteIdentifier($having['aggregate']),
            $having['not'] ? 'NOT BETWEEN' : 'BETWEEN',
            $this->param($having['value1']),
            $this->param($having['value2']),
        );
    }

    /**
     * @param array<string, mixed> $having
     * @return string
     */
    protected function havingInSelect(array $having): string
    {
        return sprintf(
            '%s %s (%s)',
            $this->quoteIdentifier($having['aggregate']),
            $having['not'] ? 'NOT IN' : 'IN',
            $this->select($having['subquery']->getQueryStatement())
        );
    }

    /**
     * @param array<string, mixed> $having
     * @return string
     */
    protected function havingIn(array $having): string
    {
        return sprintf(
            '%s %s (%s)',
            $this->quoteIdentifier($having['aggregate']),
            $having['not'] ? 'NOT IN' : 'IN',
            $this->params($having['value'])
        );
    }

    /**
     * Return aggregate function COUNT
     * @param array<string, mixed> $function
     * @return string
     */
    protected function aggregateFunctionCOUNT(array $function): string
    {
        return sprintf(
            'COUNT(%s%s)',
            $function['distinct'] ? 'DISTINCT ' : '',
            $this->columns($function['column'])
        );
    }

    /**
     * Return aggregate function AVG
     * @param array<string, mixed> $function
     * @return string
     */
    protected function aggregateFunctionAVG(array $function): string
    {
        return sprintf(
            'AVG(%s%s)',
            $function['distinct'] ? 'DISTINCT ' : '',
            $this->quoteIdentifier($function['column'])
        );
    }

    /**
     * Return aggregate function SUM
     * @param array<string, mixed> $function
     * @return string
     */
    protected function aggregateFunctionSUM(array $function): string
    {
        return sprintf(
            'SUM(%s%s)',
            $function['distinct'] ? 'DISTINCT ' : '',
            $this->quoteIdentifier($function['column'])
        );
    }

    /**
     * Return aggregate function MIN
     * @param array<string, mixed> $function
     * @return string
     */
    protected function aggregateFunctionMIN(array $function): string
    {
        return sprintf(
            'MIN(%s%s)',
            $function['distinct'] ? 'DISTINCT ' : '',
            $this->quoteIdentifier($function['column'])
        );
    }

    /**
     * Return aggregate function MAX
     * @param array<string, mixed> $function
     * @return string
     */
    protected function aggregateFunctionMAX(array $function): string
    {
        return sprintf(
            'MAX(%s%s)',
            $function['distinct'] ? 'DISTINCT ' : '',
            $this->quoteIdentifier($function['column'])
        );
    }
}