thecodingmachine / tdbm

src/SchemaVersionControl/SchemaBuilder.php

<?php

namespace TheCodingMachine\TDBM\SchemaVersionControl;

use Doctrine\DBAL\Schema\Column;
use Doctrine\DBAL\Schema\Schema;
use Doctrine\DBAL\Schema\SchemaConfig;
use Doctrine\DBAL\Schema\Table;

/**
 * Database schema builder.
 *
 * Given a deep associative array supposed to describe a database schema, SchemaBuilder::build will construct a
 * corresponding Schema object.
 */
class SchemaBuilder
{
    /** @var array */
    protected $schemaDesc;

    /**
     * Build an array descriptor into a Schema object
     * @param array $schemaDesc
     * @return Schema
     */
    public function build(array $schemaDesc): Schema
    {
        $this->schemaDesc = $schemaDesc;
        $schemaConfig = new SchemaConfig();
        $schemaConfig->setDefaultTableOptions($schemaDesc['default_table_options'] ?? []);
        $schema = new Schema([], [], $schemaConfig);
        foreach ($schemaDesc['tables'] as $name => $tableDesc) {
            $table = $schema->createTable($name);
            $this->buildTable($tableDesc, $table);
        }
        return $schema;
    }

    protected function buildTable(array $tableDesc, Table $table)
    {
        $pk_columns = [];

        if (isset($tableDesc['comment'])) {
            $table->addOption("comment", $tableDesc['comment']);
        }

        foreach ($tableDesc['columns'] as $columnName => $columnDesc) {
            if (!is_array($columnDesc)) {
                $columnDesc = ['type' => $columnDesc];
            }
            if (isset($columnDesc['primary_key'])
                && $columnDesc['primary_key']) {
                $pk_columns[] = $columnName;
            }
            $column = $table->addColumn($columnName, $columnDesc['type']);
            $this->buildColumn($columnDesc, $column);
        }
        if (isset($tableDesc['indexes'])) {
            foreach ($tableDesc['indexes'] as $indexName => $indexDesc) {
                $this->buildIndex($indexDesc, $table, $indexName);
            }
        }
        if (!empty($pk_columns)) {
            $table->setPrimaryKey($pk_columns);
        }
        if (isset($tableDesc['foreign_keys'])) {
            foreach ($tableDesc['foreign_keys'] as $constraintName => $constraintDesc) {
                $this->buildForeignKeyConstraint($constraintDesc, $table, $constraintName);
            }
        }
    }

    protected function buildColumn(array $columnDesc, Column $column)
    {
        if (isset($columnDesc['fixed'])) {
            $column->setFixed($columnDesc['fixed']);
        }
        if (isset($columnDesc['length'])) {
            $column->setLength($columnDesc['length']);
        }
        if (isset($columnDesc['precision'])) {
            $column->setPrecision($columnDesc['precision']);
        }
        if (isset($columnDesc['scale'])) {
            $column->setScale($columnDesc['scale']);
        }
        $column->setNotnull(isset($columnDesc['not_null']) && $columnDesc['not_null']);
        if (isset($columnDesc['default'])) {
            $column->setDefault($columnDesc['default']);
        }
        if (isset($columnDesc['auto_increment'])) {
            $column->setAutoincrement($columnDesc['auto_increment']);
        }
        if (isset($columnDesc['comment'])) {
            $column->setComment($columnDesc['comment']);
        }
        if (isset($columnDesc['custom'])) {
            $column->setPlatformOptions($columnDesc['custom']);
        }
    }

    protected function buildForeignKeyConstraint(array $constraintDesc, Table $table, string $name)
    {
        if (isset($constraintDesc['column'])) {
            $localColumns = [$constraintDesc['column']];
        } else {
            $localColumns = $constraintDesc['columns'];
        }
        $references = $constraintDesc['references'];
        if (is_array($references)) {
            $foreignTable = $references['table'];
            if (isset($references['column'])) {
                $foreignColumns = [$references['column']];
            } else {
                $foreignColumns = $references['columns'];
            }
        } else {
            $foreignTable = $references;
            $foreignColumns = $this->getPrimaryKeyColumns($foreignTable);
            if (!is_array($foreignColumns)) {

The condition is_array($foreignColumns) is always true.

                $foreignColumns = [$foreignColumns];
            }
        }
        $options = array_diff_key($constraintDesc, ['column' => 0,'columns' => 0,'references' => 0]);
        $table->addForeignKeyConstraint($foreignTable, $localColumns, $foreignColumns, $options, $name);
    }

    protected function getPrimaryKeyColumns(string $tableName)
    {
        $pkColumns = [];
        $tableDesc = $this->schemaDesc['tables'][$tableName];
        foreach ($tableDesc['columns'] as $columnName => $columnDesc) {
            if (isset($columnDesc['primary_key'])
                && $columnDesc['primary_key']) {
                $pkColumns[] = $columnName;
            }
        }
        return $pkColumns;
    }

    protected function buildIndex($indexDesc, Table $table, $name)
    {
        if (!is_array($indexDesc)) {
            $indexDesc = ['column' => $indexDesc];
        } elseif (array_keys($indexDesc) === range(0, count($indexDesc) - 1)) {
            $indexDesc = ['columns' => $indexDesc];
        }

        if (isset($indexDesc['column'])) {
            $columns = [$indexDesc['column']];
        } else {
            $columns = $indexDesc['columns'];
        }

        if (is_int($name)) {
            $name = implode('_', $columns);
        }

        $options = array_diff_key($indexDesc, ['column' => 0,'columns' => 0]);
        if (isset($indexDesc['unique']) && $indexDesc['unique'] === true) {
            $table->addUniqueIndex($columns, $name, [], $options);

The call to Doctrine\DBAL\Schema\Table::addUniqueIndex() has too many arguments starting with $options.

        } else {
            $table->addIndex($columns, $name, [], $options);
        }
    }
}