9.5/_form_frontend_controller_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Form\Controller;


/*

 * 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\Configuration\FlexForm\FlexFormTools;

use ‪TYPO3\CMS\Core\Service\FlexFormService;

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

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

use ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController;

use ‪TYPO3\CMS\Form\Domain\Configuration\ArrayProcessing\ArrayProcessing;

use ‪TYPO3\CMS\Form\Domain\Configuration\ArrayProcessing\ArrayProcessor;

use ‪TYPO3\CMS\Form\Domain\Configuration\ConfigurationService;

use ‪TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Converters\FinisherOptionsFlexFormOverridesConverter;

use ‪TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Converters\FlexFormFinisherOverridesConverterDto;

use ‪TYPO3\CMS\Form\Mvc\Configuration\TypoScriptService;


class ‪FormFrontendController extends ‪ActionController

{


    protected ‪$formPersistenceManager;


    public function ‪injectFormPersistenceManager(\‪TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface ‪$formPersistenceManager)

    {

        $this->formPersistenceManager = ‪$formPersistenceManager;

    }


    public function ‪renderAction()

    {

        $formDefinition = [];

        if (!empty($this->settings['persistenceIdentifier'])) {

            $formDefinition = $this->formPersistenceManager->load($this->settings['persistenceIdentifier']);

            $formDefinition['persistenceIdentifier'] = $this->settings['persistenceIdentifier'];

            $formDefinition = $this->‪overrideByTypoScriptSettings($formDefinition);

            $formDefinition = $this->‪overrideByFlexFormSettings($formDefinition);

            $formDefinition = ‪ArrayUtility::setValueByPath($formDefinition, 'renderingOptions._originalIdentifier', $formDefinition['identifier'], '.');

            $formDefinition['identifier'] .= '-' . $this->configurationManager->getContentObject()->data['uid'];

        }

        $this->view->assign('formConfiguration', $formDefinition);

    }


    public function ‪performAction()

    {

        $this->‪forward('render');

    }


    protected function ‪overrideByFlexFormSettings(array $formDefinition): array

    {

        $flexFormData = GeneralUtility::xml2array($this->configurationManager->getContentObject()->data['pi_flexform'] ?? '');


        if (!is_array($flexFormData)) {

            return $formDefinition;

        }


        if (isset($formDefinition['finishers'])) {

            $prototypeName = $formDefinition['prototypeName'] ?? 'standard';

            $configurationService = $this->objectManager->get(ConfigurationService::class);

            $prototypeConfiguration = $configurationService->getPrototypeConfiguration($prototypeName);


            foreach ($formDefinition['finishers'] as $index => $formFinisherDefinition) {

                $finisherIdentifier = $formFinisherDefinition['identifier'];


                $sheetIdentifier = $this->‪getFlexformSheetIdentifier($formDefinition, $prototypeName, $finisherIdentifier);

                $flexFormSheetSettings = $this->‪getFlexFormSettingsFromSheet($flexFormData, $sheetIdentifier);


                if ($this->settings['overrideFinishers'] && isset($flexFormSheetSettings['finishers'][$finisherIdentifier])) {

                    $prototypeFinisherDefinition = $prototypeConfiguration['finishersDefinition'][$finisherIdentifier] ?? [];

                    $converterDto = GeneralUtility::makeInstance(

                        FlexFormFinisherOverridesConverterDto::class,

                        $formFinisherDefinition,

                        $finisherIdentifier,

                        $flexFormSheetSettings

                    );


                    // Iterate over all `TYPO3.CMS.Form.prototypes.<prototypeName>.finishersDefinition.<finisherIdentifier>.FormEngine.elements` values

                    GeneralUtility::makeInstance(ArrayProcessor::class, $prototypeFinisherDefinition['FormEngine']['elements'])->forEach(

                        GeneralUtility::makeInstance(

                            ArrayProcessing::class,

                            'modifyFinisherOptionsFromFlexFormOverrides',

                            '^(.*)\.config\.type$',

                            GeneralUtility::makeInstance(FinisherOptionsFlexFormOverridesConverter::class, $converterDto)

                        )

                    );


                    $formDefinition['finishers'][$index] = $converterDto->getFinisherDefinition();

                }

            }

        }

        return $formDefinition;

    }


    protected function ‪overrideByTypoScriptSettings(array $formDefinition): array

    {

        if (

            isset($this->settings['formDefinitionOverrides'][$formDefinition['identifier']])

            && !empty($this->settings['formDefinitionOverrides'][$formDefinition['identifier']])

        ) {

            ‪ArrayUtility::mergeRecursiveWithOverrule(

                $formDefinition,

                $this->settings['formDefinitionOverrides'][$formDefinition['identifier']]

            );

            $formDefinition = $this->objectManager->get(TypoScriptService::class)

                ->resolvePossibleTypoScriptConfiguration($formDefinition);

        }

        return $formDefinition;

    }


    protected function ‪getFlexformSheetIdentifier(

        array $formDefinition,

        string $prototypeName,

        string $finisherIdentifier

    ): string {

        return md5(

            implode('', [

                $formDefinition['persistenceIdentifier'],

                $prototypeName,

                $formDefinition['identifier'],

                $finisherIdentifier

            ])

        );

    }


    protected function ‪getFlexFormSettingsFromSheet(

        array $flexForm,

        string $sheetIdentifier

    ): array {

        $sheetData['data'] = array_filter(

            $flexForm['data'] ?? [],

            function ($key) use ($sheetIdentifier) {

                return $key === $sheetIdentifier;

            },

            ARRAY_FILTER_USE_KEY

        );


        if (empty($sheetData['data'])) {

            return [];

        }


        $flexFormService = GeneralUtility::makeInstance(FlexFormService::class);

        $flexFormTools = GeneralUtility::makeInstance(FlexFormTools::class);


        $sheetDataXml = $flexFormTools->flexArray2Xml($sheetData);

        return $flexFormService->convertFlexFormContentToArray($sheetDataXml)['settings'] ?? [];

    }

}