CheckReferenceColumnHasIndex.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\Constraints\Internal;
use Magento\Framework\Setup\Declaration\Schema\Dto\Index;
use Magento\Framework\Setup\Declaration\Schema\Dto\Schema;

class CheckReferenceColumnHasIndex implements ValidationInterface
{
    const ERROR_TYPE = 'reference_column_without_unique_index';

    const ERROR_MESSAGE = 'Reference column %s in reference table %s do not have index';

    public function validate(Schema $schema)
    {
        $errors = [];
        foreach ($schema->getTables() as $table) {
            foreach ($table->getReferenceConstraints() as $constraint) {
                $referenceColumnName = $constraint->getReferenceColumn()->getName();
                $indexesAndConstraints = array_merge(
                    $constraint->getReferenceTable()->getConstraints(),
                    $constraint->getReferenceTable()->getIndexes()
                );
                foreach ($indexesAndConstraints as $key) {
                    if ($key instanceof Internal || $key instanceof Index) {
                        if (in_array($referenceColumnName, $key->getColumnNames())) {
                            continue 2;
                        }
                    }
                }

                $errors[] = [
                    'column' => $referenceColumnName,
                    'message' => sprintf(
                        self::ERROR_MESSAGE,
                        $referenceColumnName,
                        $constraint->getReferenceTable()->getName()
                    )
                ];
            }
        }

        return $errors;
    }
}