TcaColumnsProcessFieldDescriptionsTest.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\Backend\Tests\Unit\Form\FormDataProvider;
 
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Backend\Form\FormDataProvider\TcaColumnsProcessFieldDescriptions;
use ‪TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Localization\Locales;
use ‪TYPO3\CMS\Core\Localization\LocalizationFactory;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪TcaColumnsProcessFieldDescriptionsTest extends UnitTestCase
{
    protected ‪TcaColumnsProcessFieldDescriptions ‪$subject;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->subject = new ‪TcaColumnsProcessFieldDescriptions();
    }
 
    #[Test]
    public function ‪addDataKeepsDescriptionAsIsIfNoOverrideIsGiven(): void
    {
        $input = [
            'tableName' => 'aTable',
            'processedTca' => [
                'columns' => [
                    'aField' => [
                        'description' => 'foo',
                    ],
                ],
            ],
        ];
 
        ‪$GLOBALS['LANG'] = new ‪LanguageService(
            new ‪Locales(),
            $this->createMock(LocalizationFactory::class),
            $this->createMock(FrontendInterface::class)
        );
 
        $expected = $input;
        self::assertSame($expected, $this->subject->addData($input));
    }
 
    #[Test]
    public function ‪addDataAddsDescriptionToExistingField(): void
    {
        $input = [
            'tableName' => 'aTable',
            'processedTca' => [
                'columns' => [
                    'aField' => [],
                ],
            ],
            'pageTsConfig' => [
                'TCEFORM.' => [
                    'aTable.' => [
                        'aField.' => [
                            'description' => 'aNewDescription',
                        ],
                    ],
                ],
            ],
        ];
        ‪$GLOBALS['LANG'] = new ‪LanguageService(
            new ‪Locales(),
            $this->createMock(LocalizationFactory::class),
            $this->createMock(FrontendInterface::class)
        );
 
        $expected = $input;
        $expected['processedTca']['columns']['aField']['description'] = 'aNewDescription';
        self::assertSame($expected, $this->subject->addData($input));
    }
 
    #[Test]
    public function ‪addDataSetsDescriptionFromPageTsConfig(): void
    {
        $input = [
            'tableName' => 'aTable',
            'processedTca' => [
                'columns' => [
                    'aField' => [
                        'description' => 'origDescription',
                    ],
                ],
            ],
            'pageTsConfig' => [
                'TCEFORM.' => [
                    'aTable.' => [
                        'aField.' => [
                            'description' => 'aDescriptionOverride',
                        ],
                    ],
                ],
            ],
        ];
        ‪$GLOBALS['LANG'] = new ‪LanguageService(
            new ‪Locales(),
            $this->createMock(LocalizationFactory::class),
            $this->createMock(FrontendInterface::class)
        );
 
        $expected = $input;
        $expected['processedTca']['columns']['aField']['description'] = 'aDescriptionOverride';
        self::assertSame($expected, $this->subject->addData($input));
    }
 
    #[Test]
    public function ‪addDataSetsDescriptionFromPageTsConfigForSpecificLanguage(): void
    {
        $input = [
            'tableName' => 'aTable',
            'processedTca' => [
                'columns' => [
                    'aField' => [
                        'description' => 'origDescription',
                    ],
                ],
            ],
            'pageTsConfig' => [
                'TCEFORM.' => [
                    'aTable.' => [
                        'aField.' => [
                            'description.' => [
                                'fr' => 'aDescriptionOverride',
                            ],
                        ],
                    ],
                ],
            ],
        ];
        ‪$GLOBALS['LANG'] = new ‪LanguageService(
            new ‪Locales(),
            $this->createMock(LocalizationFactory::class),
            $this->createMock(FrontendInterface::class)
        );
        ‪$GLOBALS['LANG']->init('fr');
 
        $expected = $input;
        $expected['processedTca']['columns']['aField']['description'] = 'aDescriptionOverride';
        self::assertSame($expected, $this->subject->addData($input));
    }
}