SchemaBuilder.php 7.34 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

namespace Magento\Framework\Setup\Declaration\Schema\Db;

use Magento\Framework\Phrase;
use Magento\Framework\Setup\Declaration\Schema\Dto\Column;
use Magento\Framework\Setup\Declaration\Schema\Dto\ElementFactory;
use Magento\Framework\Setup\Declaration\Schema\Dto\Schema;
use Magento\Framework\Setup\Declaration\Schema\Dto\Table;
use Magento\Framework\Setup\Declaration\Schema\Sharding;
use Magento\Framework\Setup\Exception;

/**
 * This type of builder is responsible for converting ENTIRE data, that comes from db
 * into DTO`s format, with aggregation root: Schema.
 *
 * Note: SchemaBuilder can not be used for one structural element, like column or constraint
 * because it should have references to other DTO objects.
 * In order to convert build only 1 structural element use directly it factory.
 *
 * @see        Schema
 * @inheritdoc
 */
class SchemaBuilder
{
    /**
     * @var ElementFactory
     */
    private $elementFactory;

    /**
     * @var DbSchemaReaderInterface
     */
    private $dbSchemaReader;

    /**
     * @var Sharding
     */
    private $sharding;

    /**
     * @var array
     */
    private $tables;

    /**
     * Constructor.
     *
     * @param ElementFactory          $elementFactory
     * @param DbSchemaReaderInterface $dbSchemaReader
     * @param Sharding                $sharding
     */
    public function __construct(
        ElementFactory $elementFactory,
        DbSchemaReaderInterface $dbSchemaReader,
        Sharding $sharding
    ) {
        $this->elementFactory = $elementFactory;
        $this->dbSchemaReader = $dbSchemaReader;
        $this->sharding = $sharding;
    }

    /**
     * @inheritdoc
     */
    public function build(Schema $schema)
    {
        foreach ($this->sharding->getResources() as $resource) {
            foreach ($this->dbSchemaReader->readTables($resource) as $tableName) {
                $columns = [];
                $indexes = [];
                $constraints = [];

                $tableOptions = $this->dbSchemaReader->getTableOptions($tableName, $resource);
                $columnsData = $this->dbSchemaReader->readColumns($tableName, $resource);
                $indexesData = $this->dbSchemaReader->readIndexes($tableName, $resource);
                $constrainsData = $this->dbSchemaReader->readConstraints($tableName, $resource);

                /**
                 * @var Table $table
                 */
                $table = $this->elementFactory->create(
                    'table',
                    [
                        'name' => $tableName,
                        'resource' => $resource,
                        'engine' => strtolower($tableOptions['engine']),
                        'comment' => $tableOptions['comment'] === '' ? null : $tableOptions['comment'],
                        'charset' => $tableOptions['charset'],
                        'collation' => $tableOptions['collation']
                    ]
                );

                // Process columns
                foreach ($columnsData as $columnData) {
                    $columnData['table'] = $table;
                    $column = $this->elementFactory->create($columnData['type'], $columnData);
                    $columns[$column->getName()] = $column;
                }

                $table->addColumns($columns);
                //Process indexes
                foreach ($indexesData as $indexData) {
                    $indexData['table'] = $table;
                    $indexData['columns'] = $this->resolveInternalRelations($columns, $indexData);
                    $index = $this->elementFactory->create('index', $indexData);
                    $indexes[$index->getName()] = $index;
                }
                //Process internal constraints
                foreach ($constrainsData as $constraintData) {
                    $constraintData['table'] = $table;
                    $constraintData['columns'] = $this->resolveInternalRelations($columns, $constraintData);
                    $constraint = $this->elementFactory->create($constraintData['type'], $constraintData);
                    $constraints[$constraint->getName()] = $constraint;
                }

                $table->addIndexes($indexes);
                $table->addConstraints($constraints);
                $this->tables[$table->getName()] = $table;
            }
        }

        $this->processReferenceKeys($this->tables, $schema);
        return $schema;
    }

    /**
     * Process references for all tables. Schema validation required.
     *
     * @param  Table[] $tables
     * @param Schema $schema
     */
    private function processReferenceKeys(array $tables, Schema $schema)
    {
        foreach ($tables as $table) {
            $tableName = $table->getName();
            if ($schema->getTableByName($tableName) instanceof Table) {
                continue;
            }
            $referencesData = $this->dbSchemaReader->readReferences($tableName, $table->getResource());
            $references = [];

            foreach ($referencesData as $referenceData) {
                //Prepare reference data
                $referenceData['table'] = $table;
                $referenceTableName = $referenceData['referenceTable'];
                $referenceData['column'] = $table->getColumnByName($referenceData['column']);
                $referenceData['referenceTable'] = $this->tables[$referenceTableName];
                $referenceData['referenceColumn'] = $referenceData['referenceTable']->getColumnByName(
                    $referenceData['referenceColumn']
                );

                $references[$referenceData['name']] = $this->elementFactory->create('foreign', $referenceData);
                //We need to instantiate tables in order of references tree
                if (isset($tables[$referenceTableName]) && $referenceTableName !== $tableName) {
                    $this->processReferenceKeys([$referenceTableName => $tables[$referenceTableName]], $schema);
                    unset($tables[$referenceTableName]);
                }
            }

            $table->addConstraints($references);
            $schema->addTable($table);
        }
    }

    /**
     * Retrieve column objects from names.
     *
     * @param  Column[] $columns
     * @param  array    $data
     * @return Column[]
     * @throws Exception
     */
    private function resolveInternalRelations(array $columns, array $data)
    {
        if (!is_array($data['column'])) {
            throw new Exception(
                new Phrase("Cannot find columns for internal index")
            );
        }

        $referenceColumns = [];
        foreach ($data['column'] as $columnName) {
            if (!isset($columns[$columnName])) {
                $tableName = isset($data['table']) ? $data['table']->getName() : '';
                trigger_error(
                    new Phrase(
                        'Column %1 does not exist for index/constraint %2 in table %3.',
                        [
                            $columnName,
                            $data['name'],
                            $tableName
                        ]
                    ),
                    E_USER_WARNING
                );
            } else {
                $referenceColumns[] = $columns[$columnName];
            }
        }

        return $referenceColumns;
    }
}