DataStructureIdentifierHookTest.php

Go to the documentation of this file.

<?php
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 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;

class DataStructureIdentifierHookTest extends \TYPO3\TestingFramework\Core\Unit\UnitTestCase
{
    protected $singletonInstances = [];

    public function setUp()
    {
        $this->singletonInstances = GeneralUtility::getSingletonInstances();
    }

    public function tearDown()
    {
        GeneralUtility::resetSingletonInstances($this->singletonInstances);
        parent::tearDown();
    }

    public function getDataStructureIdentifierPostProcessReturnsIdentifierForNotMatchingScenario()
    {
        $givenIdentifier = ['aKey' => 'aValue'];
        $result = (new DataStructureIdentifierHook())->getDataStructureIdentifierPostProcess(
            [],
            'aTable',
            'aField',
            [],
            $givenIdentifier
        );
        $this->assertEquals($givenIdentifier, $result);
    }

    public function getDataStructureIdentifierPostProcessAddDefaultValuesForNewRecord()
    {
        $result = (new DataStructureIdentifierHook())->getDataStructureIdentifierPostProcess(
            [],
            'tt_content',
            'pi_flexform',
            ['CType' => 'form_formframework'],
            []
        );
        $this->assertEquals(
            ['ext-form-persistenceIdentifier' => '', 'ext-form-overrideFinishers' => false],
            $result
        );
    }

    public function getDataStructureIdentifierPostProcessAddsGivenPersistenceIdentifier()
    {
        $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()
    {
        $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()
    {
        $dataStructure = ['foo' => 'bar'];
        $expected = $dataStructure;
        $result = (new DataStructureIdentifierHook())->parseDataStructureByIdentifierPostProcess(
            $dataStructure,
            []
        );
        $this->assertEquals($expected, $result);
    }

    public function parseDataStructureByIdentifierPostProcessAddsExistingFormItems(array $formDefinition, array $expectedItem)
    {
        $objectMangerProphecy = $this->prophesize(ObjectManager::class);
        GeneralUtility::setSingletonInstance(ObjectManager::class, $objectMangerProphecy->reveal());
        $formPersistenceManagerProphecy = $this->prophesize(FormPersistenceManager::class);
        $objectMangerProphecy->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',
                ],
            ],
        ];
    }

    public function implodeArrayKeysReturnsStringDataProvider()
    {
        return [
            'One string' => [
                [
                    'a' => 'b',
                ],
                'a'
            ],
            'Two strings' => [
                [
                    'a' => [
                        'b' => 'c'
                    ],
                ],
                'a.b'
            ],
            'One integer' => [
                [
                    20 => 'a',
                ],
                '20'
            ],
            'Two integers' => [
                [
                    20 => [
                        30 => 'a'
                    ],
                ],
                '20.30'
            ],
            'Mixed' => [
                [
                    20 => [
                        'a' => 'b'
                    ],
                ],
                '20.a'
            ],
            'Multiple Entries' => [
                [
                    1 => [
                        'a' => 'b',
                        'b' => 'foo',
                    ],
                ],
                '1.a'
            ],
            'four levels' => [
                [
                    1 => [
                        'a' => [
                            '2' => [
                                42 => 'foo',
                            ],
                        ],
                        'b' => 22,
                    ],
                ],
                '1.a.2.42',
            ],
        ];
    }

    public function implodeArrayKeysReturnsString($array, $expectation)
    {
        $hookMock = $this->getAccessibleMock(DataStructureIdentifierHook::class, [ 'dummy' ], [], '', false);
        $this->assertEquals($expectation, $hookMock->_call('implodeArrayKeys', $array));
    }
}