9.5/_foreign_key_definition_test_8php_source.html

<?php

declare(strict_types = 1);


namespace ‪TYPO3\CMS\Core\Tests\Unit\Database\Schema\Parser;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


use ‪TYPO3\CMS\Core\Database\Schema\Parser\AST\CreateForeignKeyDefinitionItem;

use ‪TYPO3\CMS\Core\Database\Schema\Parser\AST\CreateTableStatement;

use ‪TYPO3\CMS\Core\Database\Schema\Parser\Parser;

use TYPO3\TestingFramework\Core\Unit\UnitTestCase;


class ‪ForeignKeyDefinitionTest extends UnitTestCase

{

    public function ‪canParseForeignKeyDefinitionDataProvider(): array

    {

        return [

            // See ReferenceDefinitionTest for actual reference definition parsing tests

            'FOREIGN KEY (single column)' => [

                'FOREIGN KEY (`aField`) REFERENCES `bTable` (`bField`)',

                '',

                [['aField', 0, null]],

                'bTable',

                [['bField', 0, null]],

            ],

            'FOREIGN KEY (multiple columns)' => [

                'FOREIGN KEY (`aField`(20) ASC, `bField`) REFERENCES `bTable` (`cField`, `dField`)',

                '',

                [['aField', 20, 'ASC'], ['bField', 0, null]],

                'bTable',

                [['cField', 0, null], ['dField', 0, null]],

            ],

            'FOREIGN KEY (index name)' => [

                'FOREIGN KEY `aIndex`(`aField`, `bField`) REFERENCES `bTable` (`cField`(240) DESC, `dField`)',

                'aIndex',

                [['aField', 0, null], ['bField', 0, null]],

                'bTable',

                [['cField', 240, 'DESC'], ['dField', 0, null]],

            ],

        ];

    }


    public function ‪canParseForeignKeyDefinition(

        string $indexDefinition,

        string $indexName,

        array $indexColumns,

        string $foreignTableName,

        array $foreignTableColumns

    ) {

        $statement = sprintf('CREATE TABLE `aTable`(`aField` INT(11), %s);', $indexDefinition);

        $subject = $this->‪createSubject($statement);


        $this->assertInstanceOf(CreateForeignKeyDefinitionItem::class, $subject);

        $this->assertSame($indexName, $subject->indexName->schemaObjectName);

        $this->assertSame($foreignTableName, $subject->reference->tableName->schemaObjectName);


        foreach ($indexColumns as $index => $column) {

            $this->assertSame($column[0], $subject->columnNames[$index]->columnName->schemaObjectName);

            $this->assertSame($column[1], $subject->columnNames[$index]->length);

            $this->assertSame($column[2], $subject->columnNames[$index]->direction);

        }


        foreach ($foreignTableColumns as $index => $column) {

            $this->assertSame($column[0], $subject->reference->columnNames[$index]->columnName->schemaObjectName);

            $this->assertSame($column[1], $subject->reference->columnNames[$index]->length);

            $this->assertSame($column[2], $subject->reference->columnNames[$index]->direction);

        }

    }


    protected function ‪createSubject(string $statement): ‪CreateForeignKeyDefinitionItem

    {

        ‪$parser = new ‪Parser($statement);

        $createTableStatement = ‪$parser->getAST();


        return $createTableStatement->createDefinition->items[1];

    }

}