AddColumn.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\Columns\Integer;
use Magento\Framework\Setup\Declaration\Schema\Dto\ElementFactory;
use Magento\Framework\Setup\Declaration\Schema\Dto\Index;
use Magento\Framework\Setup\Declaration\Schema\ElementHistory;
use Magento\Framework\Setup\Declaration\Schema\ElementHistoryFactory;
use Magento\Framework\Setup\Declaration\Schema\OperationInterface;

class AddColumn implements OperationInterface
{
    const OPERATION_NAME = 'add_column';

    const TEMPORARY_KEY = 'AUTO_INCREMENT_TEMPORARY_KEY';

    private $definitionAggregator;

    private $dbSchemaWriter;

    private $elementFactory;

    private $elementHistoryFactory;

    private $addComplexElement;

    private $dropElement;

    private $triggers;

    public function __construct(
        DefinitionAggregator $definitionAggregator,
        DbSchemaWriterInterface $dbSchemaWriter,
        ElementFactory $elementFactory,
        ElementHistoryFactory $elementHistoryFactory,
        AddComplexElement $addComplexElement,
        DropElement $dropElement,
        array $triggers = []
    ) {
        $this->definitionAggregator = $definitionAggregator;
        $this->dbSchemaWriter = $dbSchemaWriter;
        $this->elementFactory = $elementFactory;
        $this->elementHistoryFactory = $elementHistoryFactory;
        $this->addComplexElement = $addComplexElement;
        $this->dropElement = $dropElement;
        $this->triggers = $triggers;
    }

    private function getTemporaryIndexHistory(Column $column)
    {
        $index = $this->elementFactory->create(
            Index::TYPE,
            [
                'name' => self::TEMPORARY_KEY,
                'column' => [$column->getName()],
                'columns' => [$column],
                'table' => $column->getTable()
            ]
        );
        return $this->elementHistoryFactory->create(['new' => $index]);
    }

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

    public function isOperationDestructive()
    {
        return false;
    }

    private function columnIsAutoIncrement(Column $column)
    {
        return $column instanceof Integer && $column->isIdentity();
    }

    private function setupTriggersIfExists(Statement $statement, ElementHistory $elementHistory)
    {
        $column = $elementHistory->getNew();
        //Add triggers to column
        foreach ($this->triggers as $ddlTrigger) {
            if ($ddlTrigger->isApplicable((string) $column->getOnCreate())) {
                $statement->addTrigger($ddlTrigger->getCallback($elementHistory));
            }
        }
        $statements = [$statement];
        if ($this->columnIsAutoIncrement($column) && !empty($statement->getTriggers())) {
            $indexHistory = $this->getTemporaryIndexHistory($column);
            $statements = array_merge($this->addComplexElement->doOperation($indexHistory), $statements);
            $statements = array_merge($statements, $this->dropElement->doOperation($indexHistory));
        }

        return $statements;
    }

    public function doOperation(ElementHistory $elementHistory)
    {
        $element = $elementHistory->getNew();
        $definition = $this->definitionAggregator->toDefinition($element);
        
        $statement = $this->dbSchemaWriter->addElement(
            $element->getName(),
            $element->getTable()->getResource(),
            $element->getTable()->getName(),
            $definition,
            Column::TYPE
        );
        $statements = $this->setupTriggersIfExists($statement, $elementHistory);

        if ($this->columnIsAutoIncrement($element)) {
            $statements[] = $this->dbSchemaWriter->resetAutoIncrement(
                $element->getTable()->getName(),
                $element->getTable()->getResource()
            );
        }

        return $statements;
    }
}