Your IP : 216.73.216.43
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
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;
/**
* Helper which provide methods, that helps to compare 2 different nodes:
* For instance, 2 columns between each other.
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class DiffManager
{
/**
* @var Comparator
*/
private $comparator;
/**
* Constructor.
*
* @param Comparator $comparator
*/
public function __construct(Comparator $comparator)
{
$this->comparator = $comparator;
}
/**
* Check whether this is element is new or not, by checking it in db schema.
*
* @param ElementInterface[] $generatedElements
* @param ElementInterface $element
* @return bool
*/
public function shouldBeCreated(array $generatedElements, ElementInterface $element)
{
return !isset($generatedElements[$element->getName()]);
}
/**
* Check whether we have elements that should be removed from database.
*
* @param array $generatedElements
* @return bool
*/
public function shouldBeRemoved(array $generatedElements)
{
return !empty($generatedElements);
}
/**
* Register element, that should changes.
*
* @param Diff $diff
* @param ElementInterface $element
* @param ElementInterface $generatedElement
* @return DiffInterface
*/
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;
}
/**
* If elements really dont exists in declaration - we will remove them.
* If some mistake happens (and element is just not preprocessed), we will throw exception.
*
* @param Diff $diff
* @param ElementInterface[] $generatedElements
* @return DiffInterface
*/
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;
}
/**
* Register creation.
*
* @param DiffInterface $diff
* @param ElementInterface $element
* @return DiffInterface
*/
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;
}
/**
* Depends on what should be changed we can re-create table or modify it.
*
* For example, we can modify table if we need to change comment or engine.
* Or we can re-create table, when we need to change it shard.
*
* @param Table $declaredTable
* @param Table $generatedTable
* @param Diff $diff
* @return void
*/
public function registerTableModification(Table $declaredTable, Table $generatedTable, Diff $diff)
{
$diff->register(
$declaredTable,
ModifyTable::OPERATION_NAME,
$generatedTable
);
}
/**
* Register recreation of table, in case for example, when we need to move table from one shard to another
*
* @param Table $declaredTable
* @param Table $generatedTable
* @param Diff $diff
* @return void
*/
public function registerRecreation(Table $declaredTable, Table $generatedTable, Diff $diff)
{
$diff->register(
$declaredTable,
ReCreateTable::OPERATION_NAME,
$generatedTable
);
}
/**
* Check whether element should be modified or not.
*
* @param ElementInterface $element
* @param ElementInterface $generatedElement
* @return bool
*/
public function shouldBeModified(
ElementInterface $element,
ElementInterface $generatedElement
) {
return !$this->comparator->compare($element, $generatedElement);
}
}