9.5/_data_structure_identifier_hook_test_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Form\Tests\Unit\Hooks;


/*

 * 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 Prophecy\Argument;

use ‪TYPO3\CMS\Core\Cache\CacheManager;

use ‪TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Extbase\Object\ObjectManager;

use ‪TYPO3\CMS\Form\Hooks\DataStructureIdentifierHook;

use ‪TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager;

use ‪TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface;

use TYPO3\TestingFramework\Core\Unit\UnitTestCase;


class ‪DataStructureIdentifierHookTest extends UnitTestCase

{

    protected ‪$resetSingletonInstances = true;


    public function ‪setUp()

    {

        $cacheManagerProphecy = $this->prophesize(CacheManager::class);

        $cacheProphecy = $this->prophesize(FrontendInterface::class);

        $cacheManagerProphecy->getCache('cache_runtime')->willReturn($cacheProphecy->reveal());

        $cacheProphecy->get(Argument::cetera())->willReturn(false);

        $cacheProphecy->set(Argument::cetera())->willReturn(false);

        GeneralUtility::setSingletonInstance(CacheManager::class, $cacheManagerProphecy->reveal());

    }


    public function ‪getDataStructureIdentifierPostProcessReturnsIdentifierForNotMatchingScenario(): void

    {

        $givenIdentifier = ['aKey' => 'aValue'];

        $result = (new ‪DataStructureIdentifierHook())->getDataStructureIdentifierPostProcess(

            [],

            'aTable',

            'aField',

            [],

            $givenIdentifier

        );

        $this->assertEquals($givenIdentifier, $result);

    }


    public function ‪getDataStructureIdentifierPostProcessAddDefaultValuesForNewRecord(): void

    {

        $result = (new ‪DataStructureIdentifierHook())->getDataStructureIdentifierPostProcess(

            [],

            'tt_content',

            'pi_flexform',

            ['CType' => 'form_formframework'],

            []

        );

        $this->assertEquals(

            ['ext-form-persistenceIdentifier' => '', 'ext-form-overrideFinishers' => false],

            $result

        );

    }


    public function ‪getDataStructureIdentifierPostProcessAddsGivenPersistenceIdentifier(): void

    {

        $row = [

            'CType' => 'form_formframework',

            'pi_flexform' => '<?xml version="1.0" encoding="utf-8" standalone="yes" ?>

                <T3FlexForms>

                    <data>

                        <sheet index="sDEF">

                            <language index="lDEF">

                                <field index="settings.persistenceIdentifier">

                                    <value index="vDEF">1:user_upload/karl.yml</value>

                                </field>

                            </language>

                        </sheet>

                    </data>

                </T3FlexForms>

            ',

        ];

        $incomingIdentifier = [

            'aKey' => 'aValue',

        ];

        $expected = [

            'aKey' => 'aValue',

            'ext-form-persistenceIdentifier' => '1:user_upload/karl.yml',

            'ext-form-overrideFinishers' => false,

        ];

        $result = (new ‪DataStructureIdentifierHook())->getDataStructureIdentifierPostProcess(

            [],

            'tt_content',

            'pi_flexform',

            $row,

            $incomingIdentifier

        );

        $this->assertEquals($expected, $result);

    }


    public function ‪getDataStructureIdentifierPostProcessAddsOverrideFinisherValue(): void

    {

        $row = [

            'CType' => 'form_formframework',

            'pi_flexform' => '<?xml version="1.0" encoding="utf-8" standalone="yes" ?>

                <T3FlexForms>

                    <data>

                        <sheet index="sDEF">

                            <language index="lDEF">

                                <field index="settings.overrideFinishers">

                                    <value index="vDEF">1</value>

                               </field>

                            </language>

                        </sheet>

                    </data>

                </T3FlexForms>

            ',

        ];

        $expected = [

            'ext-form-persistenceIdentifier' => '',

            'ext-form-overrideFinishers' => true,

        ];

        $result = (new ‪DataStructureIdentifierHook())->getDataStructureIdentifierPostProcess(

            [],

            'tt_content',

            'pi_flexform',

            $row,

            []

        );

        $this->assertEquals($expected, $result);

    }


    public function ‪parseDataStructureByIdentifierPostProcessReturnsDataStructureUnchanged(): void

    {

        $dataStructure = ['foo' => 'bar'];

        $expected = $dataStructure;

        $result = (new ‪DataStructureIdentifierHook())->parseDataStructureByIdentifierPostProcess(

            $dataStructure,

            []

        );

        $this->assertEquals($expected, $result);

    }


    public function ‪parseDataStructureByIdentifierPostProcessAddsExistingFormItems(array $formDefinition, array $expectedItem): void

    {

        $objectManagerProphecy = $this->prophesize(ObjectManager::class);

        GeneralUtility::setSingletonInstance(ObjectManager::class, $objectManagerProphecy->reveal());

        $formPersistenceManagerProphecy = $this->prophesize(FormPersistenceManager::class);

        $objectManagerProphecy->get(FormPersistenceManagerInterface::class)

            ->willReturn($formPersistenceManagerProphecy->reveal());


        $formPersistenceManagerProphecy->listForms()->shouldBeCalled()->willReturn([$formDefinition]);


        $incomingDataStructure = [

            'sheets' => [

                'sDEF' => [

                    'ROOT' => [

                        'el' => [

                            'settings.persistenceIdentifier' => [

                                'TCEforms' => [

                                    'config' => [

                                        'items' => [

                                            0 => [

                                                0 => 'default, no value',

                                                1 => '',

                                            ],

                                        ],

                                    ],

                                ],

                            ],

                        ],

                    ],

                ],

            ],

        ];


        $expected = [

            'sheets' => [

                'sDEF' => [

                    'ROOT' => [

                        'el' => [

                            'settings.persistenceIdentifier' => [

                                'TCEforms' => [

                                    'config' => [

                                        'items' => [

                                            0 => [

                                                0 => 'default, no value',

                                                1 => '',

                                            ],

                                            1 => $expectedItem,

                                        ],

                                    ],

                                ],

                            ],

                        ],

                    ],

                ],

            ],

        ];


        $result = (new ‪DataStructureIdentifierHook())->parseDataStructureByIdentifierPostProcess(

            $incomingDataStructure,

            ['ext-form-persistenceIdentifier' => '']

        );


        $this->assertEquals($expected, $result);

    }


    public function ‪parseDataStructureByIdentifierPostProcessDataProvider(): array

    {

        return [

            'simple' => [

                [

                    'persistenceIdentifier' => 'hugo1',

                    'name' => 'myHugo1',

                    'location' => 'extension',

                ],

                [

                    'myHugo1 (hugo1)',

                    'hugo1',

                    'content-form',

                ],

            ],

            'invalid' => [

                [

                    'persistenceIdentifier' => 'Error.yaml',

                    'label' => 'Test Error Label',

                    'name' => 'Test Error Name',

                    'location' => 'extension',

                    'invalid' => true,

                ],

                [

                    'Test Error Name (Error.yaml)',

                    'Error.yaml',

                    'overlay-missing',

                ],

            ],

        ];

    }

}