Diff.php

Go to the documentation of this file.

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

use Magento\Framework\Component\ComponentRegistrar;
use Magento\Framework\Setup\Declaration\Schema\Dto\Constraint;
use Magento\Framework\Setup\Declaration\Schema\Dto\Constraints\Reference;
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\Dto\TableElementInterface;
use Magento\Framework\Setup\Declaration\Schema\ElementHistory;
use Magento\Framework\Setup\Declaration\Schema\ElementHistoryFactory;
use Magento\Framework\Setup\Declaration\Schema\Operations\DropReference;

class Diff implements DiffInterface
{
    const GENERATED_WHITELIST_FILE_NAME = 'db_schema_whitelist.json';

    private $changes;

    public $debugChanges;

    private $whiteListTables = [];

    private $componentRegistrar;

    private $elementHistoryFactory;

    private $tableIndexes;

    private $destructiveOperations;

    public function __construct(
        ComponentRegistrar $componentRegistrar,
        ElementHistoryFactory $elementHistoryFactory,
        array $tableIndexes,
        array $destructiveOperations
    ) {
        $this->componentRegistrar = $componentRegistrar;
        $this->elementHistoryFactory = $elementHistoryFactory;
        $this->tableIndexes = $tableIndexes;
        $this->destructiveOperations = $destructiveOperations;
    }

    public function getAll()
    {
        if ($this->changes) {
            ksort($this->changes);
        }
        return $this->changes;
    }

    public function getChange($table, $operation)
    {
        $tableIndex = $this->tableIndexes[$table];
        return $this->changes[$tableIndex][$operation] ?? [];
    }

    private function getWhiteListTables()
    {
        if (!$this->whiteListTables) {
            foreach ($this->componentRegistrar->getPaths(ComponentRegistrar::MODULE) as $path) {
                $whiteListPath = $path . DIRECTORY_SEPARATOR . 'etc' .
                    DIRECTORY_SEPARATOR . 'db_schema_whitelist.json';

                if (file_exists($whiteListPath)) {
                    $this->whiteListTables = array_replace_recursive(
                        $this->whiteListTables,
                        json_decode(file_get_contents($whiteListPath), true)
                    );
                }
            }
        }

        return $this->whiteListTables;
    }

    public function canBeRegistered(ElementInterface $object, $operation): bool
    {
        if (!isset($this->destructiveOperations[$operation])) {
            return true;
        }

        $checkResult = false;
        $whiteList = $this->getWhiteListTables();

        if ($object instanceof TableElementInterface) {
            $tableNameWithoutPrefix = $object->getTable()->getNameWithoutPrefix();
            $type = $object->getElementType();

            if ($this->isElementHaveAutoGeneratedName($object)) {
                $checkResult =
                    isset($whiteList[$tableNameWithoutPrefix][$type][$object->getNameWithoutPrefix()]);
            } else {
                $checkResult = isset($whiteList[$tableNameWithoutPrefix][$type][$object->getName()]);
            }
        } elseif ($object instanceof Table) {
            $checkResult = isset($whiteList[$object->getNameWithoutPrefix()]);
        }

        return $checkResult;
    }

    private function isElementHaveAutoGeneratedName(ElementInterface $element): bool
    {
        return in_array($element->getElementType(), [Index::TYPE, Constraint::TYPE], true);
    }

    public function register(
        ElementInterface $dtoObject,
        $operation,
        ElementInterface $oldDtoObject = null
    ) {
        if (!$this->canBeRegistered($dtoObject, $operation)) {
            return $this;
        }

        $historyData = ['new' => $dtoObject, 'old' => $oldDtoObject];
        $history = $this->elementHistoryFactory->create($historyData);
        //dtoObjects can have 4 types: column, constraint, index, table
        $this->changes[$this->findTableIndex($dtoObject, $operation)][$operation][] = $history;
        $this->debugChanges[$operation][] = $history;
        return $this;
    }

    private function findTableIndex(ElementInterface $element, string $operation) : int
    {
        $elementName = $element instanceof TableElementInterface ?
            $element->getTable()->getName() : $element->getName();
        //We use not real tables but table indexes in order to be sure that order of table is correct
        $tableIndex = $this->tableIndexes[$elementName] ?? INF;
        return $operation === DropReference::OPERATION_NAME ? 0 : (int) $tableIndex;
    }
}