StateTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\Unit\DataHandling\Localization;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\DataHandling\Localization\State;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪StateTest extends UnitTestCase
{
    public const ‪TABLE_NAME = 'tx_test_table';
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        ‪$GLOBALS['TCA'] = [];
    }
 
    #[DataProvider('stateObjectCanBeCreatedDataProvider')]
    #[Test]
    public function ‪stateObjectCanBeCreated(string $tableName, array $states): void
    {
        $subject = new ‪State($tableName, $states);
 
        self::assertInstanceOf(State::class, $subject);
    }
 
    public static function ‪stateObjectCanBeCreatedDataProvider(): array
    {
        return [
            'without states' => [
                static::TABLE_NAME,
                [],
            ],
            'with states' => [
                static::TABLE_NAME,
                ['nonExistingField' => 'invalidState'],
            ],
        ];
    }
 
    #[DataProvider('statesAreEnrichedAndSanitizedOnObjectCreationDataProvider')]
    #[Test]
    public function ‪statesAreEnrichedAndSanitizedOnObjectCreation(
        array $states,
        array $expected
    ): void {
        ‪$GLOBALS['TCA'] = $this->‪provideTableConfiguration(
            'first_field',
            'second_field'
        );
 
        $subject = new ‪State(static::TABLE_NAME, $states);
 
        self::assertSame(
            $expected,
            $subject->toArray()
        );
    }
 
    public static function ‪statesAreEnrichedAndSanitizedOnObjectCreationDataProvider(): array
    {
        return [
            'empty' => [
                [],
                [
                    'first_field' => 'parent',
                    'second_field' => 'parent',
                ],
            ],
            'invalid field only' => [
                [
                    'invalid_field' => 'invalidState',
                ],
                [
                    'first_field' => 'parent',
                    'second_field' => 'parent',
                ],
            ],
            'first_field only, valid state' => [
                [
                    'first_field' => 'custom',
                ],
                [
                    'first_field' => 'custom',
                    'second_field' => 'parent',
                ],
            ],
            'first_field only, invalid state' => [
                [
                    'first_field' => 'invalidState',
                ],
                [
                    'first_field' => 'parent',
                    'second_field' => 'parent',
                ],
            ],
            'all valid fields, valid states' => [
                [
                    'first_field' => 'custom',
                    'second_field' => 'parent',
                ],
                [
                    'first_field' => 'custom',
                    'second_field' => 'parent',
                ],
            ],
            'all valid fields, invalid states' => [
                [
                    'first_field' => 'invalidState',
                    'second_field' => 'invalidState',
                ],
                [
                    'first_field' => 'parent',
                    'second_field' => 'parent',
                ],
            ],
            'all valid fields, valid states and invalid field' => [
                [
                    'invalid_field' => 'invalidState',
                    'first_field' => 'custom',
                    'second_field' => 'parent',
                ],
                [
                    'first_field' => 'custom',
                    'second_field' => 'parent',
                ],
            ],
            'all valid fields, invalid states and invalid field' => [
                [
                    'invalid_field' => 'invalidState',
                    'first_field' => 'invalidState',
                    'second_field' => 'invalidState',
                ],
                [
                    'first_field' => 'parent',
                    'second_field' => 'parent',
                ],
            ],
        ];
    }
 
    private function ‪provideTableConfiguration(string ...$fieldNames): array
    {
        $columnsConfiguration = [];
        foreach ($fieldNames as $fieldName) {
            $columnsConfiguration[$fieldName]['config']['behaviour']['allowLanguageSynchronization'] = true;
        }
        return [
            static::TABLE_NAME => [
                'columns' => $columnsConfiguration,
            ],
        ];
    }
}