dimtrovich / php-db-dumper

src/Adapters/Factory.php

<?php

/**
 * This file is part of dimtrovich/db-dumper".
 *
 * (c) 2024 Dimitri Sitchet Tomkeu <devcode.dst@gmail.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace Dimtrovich\DbDumper\Adapters;

use Dimtrovich\DbDumper\Exceptions\Exception;
use Dimtrovich\DbDumper\Option;
use PDO;

abstract class Factory
{
    /**
     * Database connection PDO instance
     */
    protected PDO $pdo;

    /**
     * Option instance
     */
    protected Option $option;

    public function __construct(PDO $pdo, Option $option)
    {
        $this->pdo    = $pdo;
        $this->option = $option;
    }

    /**
     * Create an instance of compressor
     *
     * @internal
     *
     * @return static
     */
    public static function create(PDO $pdo, Option $option)
    {
        $type = $pdo->getAttribute(PDO::ATTR_DRIVER_NAME);

        $class = __NAMESPACE__ . '\\' . ucfirst(strtolower($type)) . 'Adapter';

        if (! class_exists($class) || $class === self::class) {
            throw Exception::invalidAdapter($type);
        }

        return new $class($pdo, $option);
    }

    /**
     * Get information about a current database
     */
    public function getDatabaseHeader(): string
    {
        $args = func_get_args();

        if (! isset($args[0])) {
            return '';
        }

        return '--' . PHP_EOL .
            "-- Current Database: `{$args[0]}`" . PHP_EOL .
            '--' . PHP_EOL . PHP_EOL;
    }

    /**
     * Add sql to create and use database
     */
    public function databases(string $databaseName): string

The parameter $databaseName is not used and could be removed.

    {
        return '';
    }

    /**
     * Get table creation code from database
     */
    abstract public function showCreateTable(string $tableName): string;

    /**
     * Modify table creation code to add something according options
     */
    public function createTable(array $row): string

The parameter $row is not used and could be removed.

    {
        return '';
    }

    /**
     * Get view creation code from database
     */
    abstract public function showCreateView(string $viewName): string;

    /**
     * Modify view creation code to add something according options
     */
    public function createView(array $row): string

The parameter $row is not used and could be removed.

    {
        return '';
    }

    /**
     * Get trigger creation code from database
     */
    public function showCreateTrigger(string $triggerName): string

The parameter $triggerName is not used and could be removed.

    {
        return '';
    }

    /**
     * Modify trigger creation code, delimiters, etc
     */
    public function createTrigger(array $row): string

The parameter $row is not used and could be removed.

    {
        return '';
    }

    /**
     * Get procedure creation code from database
     */
    public function showCreateProcedure(string $procedureName): string

The parameter $procedureName is not used and could be removed.

    {
        return '';
    }

    /**
     * Modify procedure creation code, add delimiters, etc
     */
    public function createProcedure(array $row): string

The parameter $row is not used and could be removed.

    {
        return '';
    }

    /**
     * Get function creation code from database
     */
    public function showCreateFunction(string $functionName): string

The parameter $functionName is not used and could be removed.

    {
        return '';
    }

    /**
     * Modify function creation code, add delimiters, etc
     */
    public function createFunction(array $row): string

The parameter $row is not used and could be removed.

    {
        return '';
    }

    /**
     * Get event creation code from database
     */
    public function showCreateEvent(string $eventName): string

The parameter $eventName is not used and could be removed.

    {
        return '';
    }

    /**
     * Modify event creation code to add something according options
     */
    public function createEvent(array $row): string

The parameter $row is not used and could be removed.

    {
        return '';
    }

    /**
     * Get code to list tables of database
     */
    abstract public function showTables(string $database): string;

    /**
     * Get code to list views of database
     */
    abstract public function showViews(string $database): string;

    /**
     * Get code to list triggers of database
     */
    abstract public function showTriggers(string $database): string;

    /**
     * Get code to list columns of table
     */
    abstract public function showColumns(string $table): string;

    /**
     * Get code to list procedures of database
     */
    public function showProcedures(string $database): string

The parameter $database is not used and could be removed.

    {
        return '';
    }

    /**
     * Get code to list functions of database
     */
    public function showFunctions(string $database): string

The parameter $database is not used and could be removed.

    {
        return '';
    }

    /**
     * Get code to list events of database
     */
    public function showEvents(string $database): string

The parameter $database is not used and could be removed.

    {
        return '';
    }

    /**
     * Get code to setup database transaction
     */
    public function setupTransaction(): string
    {
        return '';
    }

    /**
     * Get code to start database transaction
     */
    abstract public function startTransaction(): string;

    /**
     * Get code to commit transaction
     */
    abstract public function commitTransaction(): string;

    /**
     * Perform lock table
     *
     * @return false|int
     */
    public function lockTable(string $table)

The parameter $table is not used and could be removed.

    {
        return false;
    }

    /**
     * Perform unlock table
     *
     * @return false|int
     */
    public function unlockTable(string $table)

The parameter $table is not used and could be removed.

    {
        return false;
    }

    /**
     * Get code to start lock table operation
     */
    public function startAddLockTable(string $table): string

The parameter $table is not used and could be removed.

    {
        return PHP_EOL;
    }

    /**
     * Get code to finish lock table operation
     */
    public function endAddLockTable(string $table): string

The parameter $table is not used and could be removed.

    {
        return PHP_EOL;
    }

    /**
     * Get code to start disabled keys operation
     */
    public function startAddDisableKeys(string $table): string

The parameter $table is not used and could be removed.

    {
        return PHP_EOL;
    }

    /**
     * Get code to finish disabled keys operation
     */
    public function endAddDisableKeys(string $table): string

The parameter $table is not used and could be removed.

    {
        return PHP_EOL;
    }

    /**
     * Get code to start disabled foreign keys operation
     */
    public function startDisableForeignKeysCheck(): string
    {
        return '';
    }

    /**
     * Get code to finish disabled foreign keys operation
     */
    public function endDisableForeignKeysCheck(): string
    {
        return '';
    }

    /**
     * Get code to start disabled autocommit operation
     */
    public function startDisableAutocommit(): string
    {
        return PHP_EOL;
    }

    /**
     * Get code to finish disabled autocommit operation
     */
    public function endDisableAutocommit(): string
    {
        return PHP_EOL;
    }

    /**
     * Get code to drop database
     */
    public function addDropDatabase(string $database): string

The parameter $database is not used and could be removed.

    {
        return PHP_EOL;
    }

    /**
     * Get code to drop trigger
     */
    public function addDropTrigger(string $trigger): string

The parameter $trigger is not used and could be removed.

    {
        return PHP_EOL;
    }

    /**
     * Get code to drop table
     */
    public function dropTable(): string
    {
        $this->checkParameters(func_num_args(), $expected_num_args = 1, __METHOD__);
        $table = func_get_arg(0);

        return "DROP TABLE IF EXISTS `{$table}`;" . PHP_EOL;
    }

    /**
     * Get code to drop view
     */
    public function dropView(string $view): string

The parameter $view is not used and could be removed.

    {
        return PHP_EOL;
    }

    /**
     * Decode column metadata and fill info structure.
     * type, is_numeric and is_blob will always be available.
     *
     * @param array $colType Array returned from "SHOW COLUMNS FROM tableName"
     */
    public function parseColumnType(array $colType): array
    {
        return $this->_parseColumnType($colType, []);
    }

    /**
     * Parse the column type and extract detailed information.
     *
     * This function takes the column type information and an optional mapping of types,
     * and returns an array with detailed information about the column's properties.
     *
     * @param array $colType  An array containing the column type information.
     *                        Expected to have either a 'type' or 'Type' key.
     * @param array $mapTypes An optional array containing mappings for numerical and blob types.
     *                        Expected to have 'numerical' and 'blob' keys as arrays.
     *
     * @return array An array containing parsed column information including:
     *               - type: The base type of the column
     *               - length: The length or precision of the column (if applicable)
     *               - attributes: Any additional attributes of the column
     *               - type_sql: The full SQL type definition
     *               - is_numeric: Boolean indicating if the type is numeric
     *               - is_blob: Boolean indicating if the type is a blob
     *               - is_virtual: Boolean indicating if the column is virtual (always false in this implementation)
     */
    protected function _parseColumnType(array $colType, array $mapTypes = []): array
    {
        if ('' === $type = $colType['type'] ?? ($colType['Type'] ?? '')) {
            return [];
        }

        $colInfo  = [];
        $colParts = explode(' ', $type);

        if ($fparen = strpos($colParts[0], '(')) {
            $colInfo['type']       = substr($colParts[0], 0, $fparen);
            $colInfo['length']     = str_replace(')', '', substr($colParts[0], $fparen + 1));
            $colInfo['attributes'] = $colParts[1] ?? null;
        } else {
            $colInfo['type'] = $colParts[0];
        }

        $colInfo['type_sql']   = $type;
        $colInfo['is_numeric'] = in_array($colInfo['type'], $mapTypes['numerical'], true);
        $colInfo['is_blob']    = in_array($colInfo['type'], $mapTypes['blob'], true);
        $colInfo['is_virtual'] = false;

        return $colInfo;
    }

    /**
     * Get code backup database parameters
     */
    public function backupParameters(): string
    {
        return PHP_EOL;
    }

    /**
     * Get code restore database parameters
     */
    public function restoreParameters(): string
    {
        return PHP_EOL;
    }

    /**
     * Check number of parameters passed to function, useful when inheriting.
     * Raise exception if unexpected.
     */
    protected function checkParameters(int $num_args, int $expected_num_args, string $method_name)
    {
        if ($num_args !== $expected_num_args) {
            throw new Exception("Unexpected parameter passed to {$method_name}");
        }
    }
}