FormEditorControllerTest.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\Form\Tests\Unit\Controller;
 
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Form\Controller\FormEditorController;
use ‪TYPO3\CMS\Form\Domain\Exception\RenderingException;
use ‪TYPO3\CMS\Form\Service\TranslationService;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪FormEditorControllerTest extends UnitTestCase
{
    protected bool ‪$resetSingletonInstances = true;
 
    public function ‪setUp(): void
    {
        parent::setUp();
        ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] = '12345';
    }
 
    #[Test]
    public function ‪getInsertRenderablesPanelConfigurationReturnsGroupedAndSortedConfiguration(): void
    {
        $mockTranslationService = $this->getAccessibleMock(TranslationService::class, ['translate'], [], '', false);
        GeneralUtility::setSingletonInstance(TranslationService::class, $mockTranslationService);
        $mockTranslationService
            ->method('translate')
            ->willReturnArgument(4);
 
        $subject = $this->getAccessibleMock(FormEditorController::class, null, [], '', false);
        $subject->_set('prototypeConfiguration', [
            'formEditor' => [
                'formElementGroups' => [
                    'input' => [
                        'label' => 'Basic elements',
                    ],
                    'select' => [
                        'label' => 'Select elements',
                    ],
                ],
            ],
        ]);
 
        $input = [
            'Password' => [
                'group' => 'input',
                'groupSorting' => 110,
                'iconIdentifier' => 'form-password',
                'label' => 'Password label',
            ],
            'Text' => [
                'group' => 'input',
                'groupSorting' => 100,
                'iconIdentifier' => 'form-text',
                'label' => 'Text label',
            ],
            'SingleSelect' => [
                'group' => 'select',
                'groupSorting' => 100,
                'iconIdentifier' => 'form-single-select',
                'label' => 'Single select label',
            ],
        ];
 
        $expected = [
            0 => [
                'key' => 'input',
                'elements' => [
                    0 => [
                        'key' => 'Text',
                        'cssKey' => 'text',
                        'label' => 'Text label',
                        'sorting' => 100,
                        'iconIdentifier' => 'form-text',
                    ],
                    1 => [
                        'key' => 'Password',
                        'cssKey' => 'password',
                        'label' => 'Password label',
                        'sorting' => 110,
                        'iconIdentifier' => 'form-password',
                    ],
                ],
                'label' => 'Basic elements',
            ],
            1 => [
                'key' => 'select',
                'elements' => [
                    0 => [
                        'key' => 'SingleSelect',
                        'cssKey' => 'singleselect',
                        'label' => 'Single select label',
                        'sorting' => 100,
                        'iconIdentifier' => 'form-single-select',
                    ],
                ],
                'label' => 'Select elements',
            ],
        ];
 
        self::assertSame($expected, $subject->_call('getInsertRenderablesPanelConfiguration', $input));
    }
 
    #[Test]
    public function ‪getFormEditorDefinitionsReturnReducedConfiguration(): void
    {
        $mockTranslationService = $this->getAccessibleMock(TranslationService::class, ['translateValuesRecursive'], [], '', false);
        GeneralUtility::setSingletonInstance(TranslationService::class, $mockTranslationService);
        $mockTranslationService
            ->method('translateValuesRecursive')
            ->willReturnArgument(0);
 
        $subject = $this->getAccessibleMock(FormEditorController::class, null, [], '', false);
        $subject->_set('prototypeConfiguration', [
            'formEditor' => [
                'someOtherValues' => [
                    'horst' => [
                        'key' => 'value',
                    ],
                    'gertrud' => [
                        'key' => 'value',
                    ],
                ],
                'formElementPropertyValidatorsDefinition' => [
                    'NotEmpty' => [
                        'key' => 'value',
                    ],
                ],
            ],
            'formElementsDefinition' => [
                'Form' => [
                    'formEditor' => [
                        'key' => 'value',
                    ],
                    'someOtherValues' => [
                        'horst' => [
                            'key' => 'value',
                        ],
                        'gertrud' => [
                            'key' => 'value',
                        ],
                    ],
                ],
                'Text' => [
                    'formEditor' => [
                        'key' => 'value',
                    ],
                    'someOtherValues' => [
                        'horst' => [
                            'key' => 'value',
                        ],
                        'gertrud' => [
                            'key' => 'value',
                        ],
                    ],
                ],
            ],
            'finishersDefinition' => [
                'Confirmation' => [
                    'formEditor' => [
                        'key' => 'value',
                    ],
                    'someOtherValues' => [
                        'horst' => [
                            'key' => 'value',
                        ],
                        'gertrud' => [
                            'key' => 'value',
                        ],
                    ],
                ],
                'EmailToSender' => [
                    'formEditor' => [
                        'key' => 'value',
                    ],
                    'someOtherValues' => [
                        'horst' => [
                            'key' => 'value',
                        ],
                        'gertrud' => [
                            'key' => 'value',
                        ],
                    ],
                ],
            ],
            'someOtherValues' => [
                'horst' => [
                    'key' => 'value',
                ],
                'gertrud' => [
                    'key' => 'value',
                ],
            ],
        ]);
 
        $expected = [
            'formElements' => [
                'Form' => [
                    'key' => 'value',
                ],
                'Text' => [
                    'key' => 'value',
                ],
            ],
            'finishers' => [
                'Confirmation' => [
                    'key' => 'value',
                ],
                'EmailToSender' => [
                    'key' => 'value',
                ],
            ],
            'formElementPropertyValidators' => [
                'NotEmpty' => [
                    'key' => 'value',
                ],
            ],
        ];
 
        self::assertSame($expected, $subject->_call('getFormEditorDefinitions'));
    }
 
    #[Test]
    public function ‪renderFormEditorTemplatesThrowsExceptionIfLayoutRootPathsNotSet(): void
    {
        $this->expectException(RenderingException::class);
        $this->expectExceptionCode(1480294721);
 
        $mockController = $this->getAccessibleMock(FormEditorController::class, null, [], '', false);
 
        $mockController->_set('prototypeConfiguration', [
            'formEditor' => [
                'formEditorFluidConfiguration' => [
                    'templatePathAndFilename' => '',
                ],
            ],
        ]);
 
        $mockController->_call('renderFormEditorTemplates', []);
    }
 
    #[Test]
    public function ‪renderFormEditorTemplatesThrowsExceptionIfLayoutRootPathsNotArray(): void
    {
        $this->expectException(RenderingException::class);
        $this->expectExceptionCode(1480294721);
 
        $mockController = $this->getAccessibleMock(FormEditorController::class, null, [], '', false);
 
        $mockController->_set('prototypeConfiguration', [
            'formEditor' => [
                'formEditorFluidConfiguration' => [
                    'templatePathAndFilename' => '',
                    'layoutRootPaths' => '',
                ],
            ],
        ]);
 
        $mockController->_call('renderFormEditorTemplates', []);
    }
 
    #[Test]
    public function ‪renderFormEditorTemplatesThrowsExceptionIfPartialRootPathsNotSet(): void
    {
        $this->expectException(RenderingException::class);
        $this->expectExceptionCode(1480294722);
 
        $mockController = $this->getAccessibleMock(FormEditorController::class, null, [], '', false);
 
        $mockController->_set('prototypeConfiguration', [
            'formEditor' => [
                'formEditorFluidConfiguration' => [
                    'templatePathAndFilename' => '',
                    'layoutRootPaths' => [],
                ],
            ],
        ]);
 
        $mockController->_call('renderFormEditorTemplates', []);
    }
 
    #[Test]
    public function ‪renderFormEditorTemplatesThrowsExceptionIfPartialRootPathsNotArray(): void
    {
        $this->expectException(RenderingException::class);
        $this->expectExceptionCode(1480294722);
 
        $mockController = $this->getAccessibleMock(FormEditorController::class, null, [], '', false);
 
        $mockController->_set('prototypeConfiguration', [
            'formEditor' => [
                'formEditorFluidConfiguration' => [
                    'templatePathAndFilename' => '',
                    'layoutRootPaths' => [],
                ],
            ],
        ]);
 
        $mockController->_call('renderFormEditorTemplates', []);
    }
 
    #[Test]
    public function ‪renderFormEditorTemplatesThrowsExceptionIfTemplatePathAndFilenameNotSet(): void
    {
        $this->expectException(RenderingException::class);
        $this->expectExceptionCode(1485636499);
 
        $mockController = $this->getAccessibleMock(FormEditorController::class, null, [], '', false);
 
        $mockController->_set('prototypeConfiguration', [
            'formEditor' => [
                'formEditorFluidConfiguration' => [],
            ],
        ]);
 
        $mockController->_call('renderFormEditorTemplates', []);
    }
 
    #[Test]
    public function ‪transformMultiValuePropertiesForFormEditorConvertMultiValueDataIntoMetaData(): void
    {
        $mockController = $this->getAccessibleMock(FormEditorController::class, null, [], '', false);
 
        $input = [
            0 => [
                'bar' => 'baz',
            ],
            1 => [
                'type' => 'SOMEELEMENT',
                'properties' => [
                    'options' => [
                        5 => '5',
                        4 => '4',
                        3 => '3',
                        2 => '2',
                        1 => '1',
                    ],
                ],
            ],
            2 => [
                0 => [
                    'type' => 'TEST',
                    'properties' => [
                        'options' => [
                            5 => '5',
                            4 => '4',
                            3 => '3',
                            2 => '2',
                            1 => '1',
                        ],
                    ],
                ],
            ],
        ];
 
        $multiValueProperties = [
            'TEST' => [
                0 => 'properties.options',
            ],
        ];
 
        $expected = [
            0 => [
                'bar' => 'baz',
            ],
            1 => [
                'type' => 'SOMEELEMENT',
                'properties' => [
                    'options' => [
                        5 => '5',
                        4 => '4',
                        3 => '3',
                        2 => '2',
                        1 => '1',
                    ],
                ],
            ],
            2 => [
                0 => [
                    'type' => 'TEST',
                    'properties' => [
                        'options' => [
                            ['_label' => '5', '_value' => 5],
                            ['_label' => '4', '_value' => 4],
                            ['_label' => '3', '_value' => 3],
                            ['_label' => '2', '_value' => 2],
                            ['_label' => '1', '_value' => 1],
                        ],
                    ],
                ],
            ],
        ];
 
        self::assertSame($expected, $mockController->_call('transformMultiValuePropertiesForFormEditor', $input, 'type', $multiValueProperties));
    }
 
    #[Test]
    public function ‪filterEmptyArraysRemovesEmptyArrayKeys(): void
    {
        $mockController = $this->getAccessibleMock(FormEditorController::class, null, [], '', false);
 
        $input = [
            'heinz' => 1,
            'klaus' => [],
            'sabine' => [
                'heinz' => '2',
                'klaus' => [],
                'horst' => [
                    'heinz' => '',
                    'paul' => [[]],
                ],
            ],
        ];
 
        $expected = [
            'heinz' => 1,
            'sabine' => [
                'heinz' => '2',
                'horst' => [
                    'heinz' => '',
                ],
            ],
        ];
 
        self::assertSame($expected, $mockController->_call('filterEmptyArrays', $input));
    }
}