CreateTable.php 5.16 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
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

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

use Magento\Framework\Setup\Declaration\Schema\Db\DbSchemaWriterInterface;
use Magento\Framework\Setup\Declaration\Schema\Db\DDLTriggerInterface;
use Magento\Framework\Setup\Declaration\Schema\Db\DefinitionAggregator;
use Magento\Framework\Setup\Declaration\Schema\Db\Statement;
use Magento\Framework\Setup\Declaration\Schema\Dto\Column;
use Magento\Framework\Setup\Declaration\Schema\Dto\Constraint;
use Magento\Framework\Setup\Declaration\Schema\Dto\ElementInterface;
use Magento\Framework\Setup\Declaration\Schema\Dto\Index;
use Magento\Framework\Setup\Declaration\Schema\Dto\Table;
use Magento\Framework\Setup\Declaration\Schema\ElementHistory;
use Magento\Framework\Setup\Declaration\Schema\ElementHistoryFactory;
use Magento\Framework\Setup\Declaration\Schema\OperationInterface;

/**
 * Create table operation.
 */
class CreateTable implements OperationInterface
{
    /**
     * Operation name.
     */
    const OPERATION_NAME = 'create_table';

    /**
     * @var DbSchemaWriterInterface
     */
    private $dbSchemaWriter;

    /**
     * @var DefinitionAggregator
     */
    private $definitionAggregator;

    /**
     * @var DDLTriggerInterface[]
     */
    private $columnTriggers;

    /**
     * @var DDLTriggerInterface[]
     */
    private $triggers;

    /**
     * @var ElementHistoryFactory
     */
    private $elementHistoryFactory;

    /**
     * @param DbSchemaWriterInterface $dbSchemaWriter
     * @param DefinitionAggregator $definitionAggregator
     * @param ElementHistoryFactory $elementHistoryFactory
     * @param array $columnTriggers
     * @param array $triggers
     */
    public function __construct(
        DbSchemaWriterInterface $dbSchemaWriter,
        DefinitionAggregator $definitionAggregator,
        ElementHistoryFactory $elementHistoryFactory,
        array $columnTriggers = [],
        array $triggers = []
    ) {
        $this->dbSchemaWriter = $dbSchemaWriter;
        $this->definitionAggregator = $definitionAggregator;
        $this->columnTriggers = $columnTriggers;
        $this->triggers = $triggers;
        $this->elementHistoryFactory = $elementHistoryFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function getOperationName()
    {
        return self::OPERATION_NAME;
    }

    /**
     * {@inheritdoc}
     */
    public function isOperationDestructive()
    {
        return false;
    }

    /**
     * Setup callbacks for newely created columns
     *
     * @param array $columns
     * @param Statement $createTableStatement
     * @return void
     */
    private function setupColumnTriggers(array $columns, Statement $createTableStatement)
    {
        foreach ($columns as $column) {
            foreach ($this->columnTriggers as $trigger) {
                if ($trigger->isApplicable((string) $column->getOnCreate())) {
                    $elementHistory = $this->elementHistoryFactory->create([
                        'new' => $column,
                        'old' => $column
                    ]);
                    $createTableStatement->addTrigger(
                        $trigger->getCallback($elementHistory)
                    );
                }
            }
        }
    }

    /**
     * Setup triggers for entire table
     *
     * @param Table $table
     * @param Statement $createTableStatement
     * @return void
     */
    private function setupTableTriggers(Table $table, Statement $createTableStatement)
    {
        foreach ($this->triggers as $trigger) {
            if ($trigger->isApplicable((string) $table->getOnCreate())) {
                $elementHistory = $this->elementHistoryFactory->create([
                    'new' => $table,
                    'old' => $table
                ]);
                $createTableStatement->addTrigger(
                    $trigger->getCallback($elementHistory)
                );
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    public function doOperation(ElementHistory $elementHistory)
    {
        /** @var Table $table */
        $table = $elementHistory->getNew();
        $definition = [];
        $data = [
            Column::TYPE => $table->getColumns(),
            Constraint::TYPE => $table->getConstraints(),
            Index::TYPE => $table->getIndexes()
        ];

        foreach ($data as $type => $elements) {
            /**
             * @var ElementInterface $element
             */
            foreach ($elements as $element) {
                //Make definition as flat list.
                $definition[$type . $element->getName()] = $this->definitionAggregator->toDefinition($element);
            }
        }

        $createTableStatement = $this->dbSchemaWriter
            ->createTable(
                $table->getName(),
                $elementHistory->getNew()->getResource(),
                $definition,
                $table->getDiffSensitiveParams()
            );

        $this->setupTableTriggers($table, $createTableStatement);
        $this->setupColumnTriggers($table->getColumns(), $createTableStatement);

        return [$createTableStatement];
    }
}