CreateTable.php

Go to the documentation of this file.

<?php
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;

class CreateTable implements OperationInterface
{
    const OPERATION_NAME = 'create_table';

    private $dbSchemaWriter;

    private $definitionAggregator;

    private $columnTriggers;

    private $triggers;

    private $elementHistoryFactory;

    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;
    }

    public function getOperationName()
    {
        return self::OPERATION_NAME;
    }

    public function isOperationDestructive()
    {
        return false;
    }

    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)
                    );
                }
            }
        }
    }

    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)
                );
            }
        }
    }

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

        foreach ($data as $type => $elements) {
            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];
    }
}