DiffManager.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Setup\Declaration\Schema\Diff;

use Magento\Framework\Setup\Declaration\Schema\Comparator;
use Magento\Framework\Setup\Declaration\Schema\Dto\Column;
use Magento\Framework\Setup\Declaration\Schema\Dto\Constraints\Reference;
use Magento\Framework\Setup\Declaration\Schema\Dto\ElementInterface;
use Magento\Framework\Setup\Declaration\Schema\Dto\Table;
use Magento\Framework\Setup\Declaration\Schema\Operations\AddColumn;
use Magento\Framework\Setup\Declaration\Schema\Operations\AddComplexElement;
use Magento\Framework\Setup\Declaration\Schema\Operations\CreateTable;
use Magento\Framework\Setup\Declaration\Schema\Operations\DropElement;
use Magento\Framework\Setup\Declaration\Schema\Operations\DropReference;
use Magento\Framework\Setup\Declaration\Schema\Operations\DropTable;
use Magento\Framework\Setup\Declaration\Schema\Operations\ModifyColumn;
use Magento\Framework\Setup\Declaration\Schema\Operations\ModifyTable;
use Magento\Framework\Setup\Declaration\Schema\Operations\ReCreateTable;

class DiffManager
{
    private $comparator;

    public function __construct(Comparator $comparator)
    {
        $this->comparator = $comparator;
    }

    public function shouldBeCreated(array $generatedElements, ElementInterface $element)
    {
        return !isset($generatedElements[$element->getName()]);
    }

    public function shouldBeRemoved(array $generatedElements)
    {
        return !empty($generatedElements);
    }

    public function registerModification(
        Diff $diff,
        ElementInterface $element,
        ElementInterface $generatedElement
    ) {
        if ($element instanceof Column) {
            $diff->register($element, ModifyColumn::OPERATION_NAME, $generatedElement);
        } else {
            $diff = $this->registerRemoval($diff, [$generatedElement]);
            $diff = $this->registerCreation($diff, $element);
        }

        return $diff;
    }

    public function registerRemoval(
        Diff $diff,
        array $generatedElements
    ) {
        foreach ($generatedElements as $generatedElement) {
            if ($generatedElement instanceof Reference) {
                $diff->register($generatedElement, DropReference::OPERATION_NAME, $generatedElement);
            } elseif ($generatedElement instanceof Table) {
                $diff->register($generatedElement, DropTable::OPERATION_NAME, $generatedElement);
            } else {
                $diff->register($generatedElement, DropElement::OPERATION_NAME, $generatedElement);
            }
        }

        return $diff;
    }

    public function registerCreation(DiffInterface $diff, ElementInterface $element)
    {
        if ($element instanceof Table) {
            $operation = CreateTable::OPERATION_NAME;
        } elseif ($element instanceof Column) {
            $operation = AddColumn::OPERATION_NAME;
        } else {
            $operation = AddComplexElement::OPERATION_NAME;
        }

        $diff->register($element, $operation);

        return $diff;
    }

    public function registerTableModification(Table $declaredTable, Table $generatedTable, Diff $diff)
    {
        $diff->register(
            $declaredTable,
            ModifyTable::OPERATION_NAME,
            $generatedTable
        );
    }

    public function registerRecreation(Table $declaredTable, Table $generatedTable, Diff $diff)
    {
        $diff->register(
            $declaredTable,
            ReCreateTable::OPERATION_NAME,
            $generatedTable
        );
    }

    public function shouldBeModified(
        ElementInterface $element,
        ElementInterface $generatedElement
    ) {
        return !$this->comparator->compare($element, $generatedElement);
    }
}