TypoScriptServiceTest.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\TypoScript;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\TypoScript\TypoScriptService;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪TypoScriptServiceTest extends UnitTestCase
{
    public static function ‪convertTypoScriptArrayToPlainArrayTestdata(): array
    {
        return [
            'simple typoscript array' => [
                'typoScriptSettings' => [
                    '10.' => [
                        'value' => 'Hello World!',
                        'foo.' => [
                            'bar' => 5,
                        ],
                    ],
                    '10' => 'TEXT',
                ],
                'expectedSettings' => [
                    '10' => [
                        'value' => 'Hello World!',
                        'foo' => [
                            'bar' => 5,
                        ],
                        '_typoScriptNodeValue' => 'TEXT',
                    ],
                ],
            ],
            'typoscript with intermediate dots' => [
                'typoScriptSettings' => [
                    '10.' => [
                        'value' => 'Hello World!',
                        'foo.' => [
                            'bar' => 5,
                        ],
                    ],
                    '10' => 'TEXT',
                ],
                'expectedSettings' => [
                    '10' => [
                        'value' => 'Hello World!',
                        'foo' => [
                            'bar' => 5,
                        ],
                        '_typoScriptNodeValue' => 'TEXT',
                    ],
                ],
            ],
            'typoscript array with changed order' => [
                'typoScriptSettings' => [
                    '10' => 'TEXT',
                    '10.' => [
                        'value' => 'Hello World!',
                        'foo.' => [
                            'bar' => 5,
                        ],
                    ],
                ],
                'expectedSettings' => [
                    '10' => [
                        'value' => 'Hello World!',
                        'foo' => [
                            'bar' => 5,
                        ],
                        '_typoScriptNodeValue' => 'TEXT',
                    ],
                ],
            ],
            'nested typoscript array' => [
                'typoScriptSettings' => [
                    '10' => 'COA',
                    '10.' => [
                        '10' => 'TEXT',
                        '10.' => [
                            'value' => 'Hello World!',
                            'foo.' => [
                                'bar' => 5,
                            ],
                        ],
                        '20' => 'COA',
                        '20.' => [
                            '10' => 'TEXT',
                            '10.' => [
                                'value' => 'Test',
                                'wrap' => '[|]',
                            ],
                            '20' => 'TEXT',
                            '20.' => [
                                'value' => 'Test',
                                'wrap' => '[|]',
                            ],
                        ],
                        '30' => 'custom',
                    ],
                ],
                'expectedSettings' => [
                    '10' => [
                        '10' => [
                            'value' => 'Hello World!',
                            'foo' => [
                                'bar' => 5,
                            ],
                            '_typoScriptNodeValue' => 'TEXT',
                        ],
                        '20' => [
                            '10' => [
                                'value' => 'Test',
                                'wrap' => '[|]',
                                '_typoScriptNodeValue' => 'TEXT',
                            ],
                            '20' => [
                                'value' => 'Test',
                                'wrap' => '[|]',
                                '_typoScriptNodeValue' => 'TEXT',
                            ],
                            '_typoScriptNodeValue' => 'COA',
                        ],
                        '30' => 'custom',
                        '_typoScriptNodeValue' => 'COA',
                    ],
                ],
            ],
        ];
    }
 
    #[DataProvider('convertTypoScriptArrayToPlainArrayTestdata')]
    #[Test]
    public function ‪convertTypoScriptArrayToPlainArrayRemovesTrailingDotsWithChangedOrderInTheTypoScriptArray(
        $typoScriptSettings,
        $expectedSettings
    ): void {
        $typoScriptService = new ‪TypoScriptService();
        $processedSettings = $typoScriptService->convertTypoScriptArrayToPlainArray($typoScriptSettings);
        self::assertEquals($expectedSettings, $processedSettings);
    }
 
    public static function ‪convertPlainArrayToTypoScriptArrayTestdata(): array
    {
        return [
            'simple typoscript' => [
                'extbaseTS' => [
                    '10' => [
                        'value' => 'Hallo',
                        '_typoScriptNodeValue' => 'TEXT',
                    ],
                ],
                'classic' => [
                    '10' => 'TEXT',
                    '10.' => [
                        'value' => 'Hallo',
                    ],
                ],
            ],
            'typoscript with null value' => [
                'extbaseTS' => [
                    '10' => [
                        'value' => 'Hallo',
                        '_typoScriptNodeValue' => 'TEXT',
                    ],
                    '20' => null,
                ],
                'classic' => [
                    '10' => 'TEXT',
                    '10.' => [
                        'value' => 'Hallo',
                    ],
                    '20' => '',
                ],
            ],
            'ts with dots in key' => [
                'extbaseTS' => [
                    '1.0' => [
                        'value' => 'Hallo',
                        '_typoScriptNodeValue' => 'TEXT',
                    ],
                ],
                'classic' => [
                    '1.0' => 'TEXT',
                    '1.0.' => [
                        'value' => 'Hallo',
                    ],
                ],
            ],
            'ts with backslashes in key' => [
                'extbaseTS' => [
                    '1\\0\\' => [
                        'value' => 'Hallo',
                        '_typoScriptNodeValue' => 'TEXT',
                    ],
                ],
                'classic' => [
                    '1\\0\\' => 'TEXT',
                    '1\\0\\.' => [
                        'value' => 'Hallo',
                    ],
                ],
            ],
            'bigger typoscript' => [
                'extbaseTS' => [
                    '10' => [
                        '10' => [
                            'value' => 'Hello World!',
                            'foo' => [
                                'bar' => 5,
                            ],
                            '_typoScriptNodeValue' => 'TEXT',
                        ],
                        '20' => [
                            '10' => [
                                'value' => 'Test',
                                'wrap' => '[|]',
                                '_typoScriptNodeValue' => 'TEXT',
                            ],
                            '20' => [
                                'value' => 'Test',
                                'wrap' => '[|]',
                                '_typoScriptNodeValue' => 'TEXT',
                            ],
                            '_typoScriptNodeValue' => 'COA',
                        ],
                        '_typoScriptNodeValue' => 'COA',
                    ],
                ],
                'classic' => [
                    '10' => 'COA',
                    '10.' => [
                        '10' => 'TEXT',
                        '10.' => [
                            'value' => 'Hello World!',
                            'foo.' => [
                                'bar' => 5,
                            ],
                        ],
                        '20' => 'COA',
                        '20.' => [
                            '10' => 'TEXT',
                            '10.' => [
                                'value' => 'Test',
                                'wrap' => '[|]',
                            ],
                            '20' => 'TEXT',
                            '20.' => [
                                'value' => 'Test',
                                'wrap' => '[|]',
                            ],
                        ],
                    ],
                ],
            ],
        ];
    }
 
    #[DataProvider('convertPlainArrayToTypoScriptArrayTestdata')]
    #[Test]
    public function ‪convertPlainArrayToTypoScriptArray($extbaseTS, $classic): void
    {
        $typoScriptService = new ‪TypoScriptService();
        $converted = $typoScriptService->convertPlainArrayToTypoScriptArray($extbaseTS);
        self::assertEquals($converted, $classic);
    }
 
    public static function ‪explodeConfigurationForOptionSplitProvider(): array
    {
        return [
            [
                ['splitConfiguration' => 'a'],
                3,
                [
                    0 => ['splitConfiguration' => 'a'],
                    1 => ['splitConfiguration' => 'a'],
                    2 => ['splitConfiguration' => 'a'],
                ],
            ],
            [
                ['splitConfiguration' => 'a || b || c'],
                5,
                [
                    0 => ['splitConfiguration' => 'a'],
                    1 => ['splitConfiguration' => 'b'],
                    2 => ['splitConfiguration' => 'c'],
                    3 => ['splitConfiguration' => 'c'],
                    4 => ['splitConfiguration' => 'c'],
                ],
            ],
            [
                ['splitConfiguration' => 'a || b |*| c'],
                5,
                [
                    0 => ['splitConfiguration' => 'a'],
                    1 => ['splitConfiguration' => 'b'],
                    2 => ['splitConfiguration' => 'c'],
                    3 => ['splitConfiguration' => 'c'],
                    4 => ['splitConfiguration' => 'c'],
                ],
            ],
            [
                ['splitConfiguration' => 'a || b |*| c |*| d || e'],
                7,
                [
                    0 => ['splitConfiguration' => 'a'],
                    1 => ['splitConfiguration' => 'b'],
                    2 => ['splitConfiguration' => 'c'],
                    3 => ['splitConfiguration' => 'c'],
                    4 => ['splitConfiguration' => 'c'],
                    5 => ['splitConfiguration' => 'd'],
                    6 => ['splitConfiguration' => 'e'],
                ],
            ],
            [
                ['splitConfiguration' => 'a || b |*| c |*| d || e'],
                4,
                [
                    0 => ['splitConfiguration' => 'a'],
                    1 => ['splitConfiguration' => 'b'],
                    2 => ['splitConfiguration' => 'd'],
                    3 => ['splitConfiguration' => 'e'],
                ],
            ],
            [
                ['splitConfiguration' => 'a || b |*| c |*| d || e'],
                3,
                [
                    0 => ['splitConfiguration' => 'a'],
                    1 => ['splitConfiguration' => 'd'],
                    2 => ['splitConfiguration' => 'e'],
                ],
            ],
            [
                ['splitConfiguration' => 'a || b |*||*| c || d'],
                7,
                [
                    0 => ['splitConfiguration' => 'a'],
                    1 => ['splitConfiguration' => 'b'],
                    2 => ['splitConfiguration' => 'b'],
                    3 => ['splitConfiguration' => 'b'],
                    4 => ['splitConfiguration' => 'b'],
                    5 => ['splitConfiguration' => 'c'],
                    6 => ['splitConfiguration' => 'd'],
                ],
            ],
            [
                ['splitConfiguration' => '|*||*| a || b'],
                7,
                [
                    0 => ['splitConfiguration' => 'a'],
                    1 => ['splitConfiguration' => 'a'],
                    2 => ['splitConfiguration' => 'a'],
                    3 => ['splitConfiguration' => 'a'],
                    4 => ['splitConfiguration' => 'a'],
                    5 => ['splitConfiguration' => 'a'],
                    6 => ['splitConfiguration' => 'b'],
                ],
            ],
            [
                ['splitConfiguration' => 'a |*| b || c |*|'],
                7,
                [
                    0 => ['splitConfiguration' => 'a'],
                    1 => ['splitConfiguration' => 'b'],
                    2 => ['splitConfiguration' => 'c'],
                    3 => ['splitConfiguration' => 'b'],
                    4 => ['splitConfiguration' => 'c'],
                    5 => ['splitConfiguration' => 'b'],
                    6 => ['splitConfiguration' => 'c'],
                ],
            ],
        ];
    }
 
    #[DataProvider('explodeConfigurationForOptionSplitProvider')]
    #[Test]
    public function ‪explodeConfigurationForOptionSplitTest($configuration, $splitCount, $expected): void
    {
        $serviceObject = new ‪TypoScriptService();
        $actual = $serviceObject->explodeConfigurationForOptionSplit($configuration, $splitCount);
        self::assertSame($expected, $actual);
    }
}