IncosistentReferenceDefinition.php

Go to the documentation of this file.

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

use Magento\Framework\Setup\Declaration\Schema\Declaration\ValidationInterface;
use Magento\Framework\Setup\Declaration\Schema\Dto\Column;
use Magento\Framework\Setup\Declaration\Schema\Dto\Columns\ColumnNullableAwareInterface;
use Magento\Framework\Setup\Declaration\Schema\Dto\Columns\ColumnUnsignedAwareInterface;
use Magento\Framework\Setup\Declaration\Schema\Dto\Columns\Integer;
use Magento\Framework\Setup\Declaration\Schema\Dto\Columns\StringBinary;
use Magento\Framework\Setup\Declaration\Schema\Dto\Schema;

class IncosistentReferenceDefinition implements ValidationInterface
{
    const ERROR_TYPE = 'reference_incosistence_definition';

    private function assertDefinitionEqual(Column $column, Column $referenceColumn)
    {
        if ($column->getType() !== $referenceColumn->getType()) {
            return true;
        }

        return $this->assertUnsigned($column, $referenceColumn) &&
            $this->assertIntegersEquals($column, $referenceColumn) &&
            $this->assertStringBinariesEqual($column, $referenceColumn);
    }

    private function assertUnsigned(Column $column, Column $referenceColumn)
    {
        if ($column instanceof ColumnUnsignedAwareInterface &&
            $column->isUnsigned() !== $referenceColumn->isUnsigned()
        ) {
            return false;
        }

        return true;
    }

    private function assertStringBinariesEqual(Column $column, Column $referenceColumn)
    {
        if ($column instanceof StringBinary &&
            $column->getLength() !== $referenceColumn->getLength()
        ) {
            return false;
        }

        return true;
    }

    private function assertIntegersEquals(Column $column, Column $referenceColumn)
    {
        if ($column instanceof Integer &&
            $column->getPadding() !== $referenceColumn->getPadding()
        ) {
            return false;
        }

        return true;
    }

    public function validate(Schema $schema)
    {
        $message = 'Column definition "%s" and reference column definition "%s" are different in tables "%s" and "%s"';
        $errors = [];
        foreach ($schema->getTables() as $table) {
            foreach ($table->getReferenceConstraints() as $reference) {
                $column = $reference->getColumn();
                $referenceColumn = $reference->getReferenceColumn();

                if (!$this->assertDefinitionEqual($column, $referenceColumn)) {
                    $errors[] = [
                        'column' => $column->getName(),
                        'message' => sprintf(
                            $message,
                            $column->getName(),
                            $referenceColumn->getName(),
                            $column->getTable()->getName(),
                            $referenceColumn->getTable()->getName()
                        )
                    ];
                }
            }
        }

        return $errors;
    }
}