ConfirmationFinisher.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\Domain\Finishers;
 
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
use ‪TYPO3\CMS\Fluid\View\StandaloneView;
use ‪TYPO3\CMS\Form\Domain\Finishers\Exception\FinisherException;
use ‪TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
use ‪TYPO3\CMS\Form\ViewHelpers\RenderRenderableViewHelper;
use ‪TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
 
class ‪ConfirmationFinisher extends ‪AbstractFinisher
{
 
    protected ‪$defaultOptions = [
        'message' => 'The form has been submitted.',
        'contentElementUid' => 0,
        'typoscriptObjectPath' => 'lib.tx_form.contentElementRendering'
    ];
 
    protected ‪$typoScriptSetup = [];
 
    protected ‪$configurationManager;
 
    protected ‪$contentObjectRenderer;
 
    public function ‪injectConfigurationManager(‪ConfigurationManagerInterface ‪$configurationManager)
    {
        $this->configurationManager = ‪$configurationManager;
        $this->typoScriptSetup = $this->configurationManager->‪getConfiguration(‪ConfigurationManagerInterface::CONFIGURATION_TYPE_FULL_TYPOSCRIPT);
    }
 
    public function ‪injectContentObjectRenderer(‪ContentObjectRenderer ‪$contentObjectRenderer)
    {
        $this->contentObjectRenderer = ‪$contentObjectRenderer;
    }
 
    protected function ‪executeInternal()
    {
        $contentElementUid = $this->‪parseOption('contentElementUid');
        $typoscriptObjectPath = $this->‪parseOption('typoscriptObjectPath');
        $typoscriptObjectPath = is_string($typoscriptObjectPath) ? $typoscriptObjectPath : '';
        if (!empty($contentElementUid)) {
            $pathSegments = ‪GeneralUtility::trimExplode('.', $typoscriptObjectPath);
            $lastSegment = array_pop($pathSegments);
            $setup = ‪$this->typoScriptSetup;
            foreach ($pathSegments as $segment) {
                if (!array_key_exists($segment . '.', $setup)) {
                    throw new ‪FinisherException(
                        sprintf('TypoScript object path "%s" does not exist', $typoscriptObjectPath),
                        1489238980
                    );
                }
                $setup = $setup[$segment . '.'];
            }
            $this->contentObjectRenderer->start([$contentElementUid], '');
            $this->contentObjectRenderer->setCurrentVal((string)$contentElementUid);
            $message = $this->contentObjectRenderer->cObjGetSingle($setup[$lastSegment], $setup[$lastSegment . '.'], $lastSegment);
        } else {
            $message = $this->‪parseOption('message');
        }
 
        $standaloneView = $this->‪initializeStandaloneView(
            $this->finisherContext->getFormRuntime()
        );
 
        $standaloneView->assignMultiple([
            'message' => $message,
            'isPreparedMessage' => !empty($contentElementUid),
        ]);
 
        return $standaloneView->render();
    }
 
    protected function ‪initializeStandaloneView(FormRuntime $formRuntime): StandaloneView
    {
        $standaloneView = $this->objectManager->get(StandaloneView::class);
 
        if (!isset($this->options['templateName'])) {
            throw new FinisherException(
                'The option "templateName" must be set for the ConfirmationFinisher.',
                1521573955
            );
        }
 
        $standaloneView->setTemplate($this->options['templateName']);
        $standaloneView->getTemplatePaths()->fillFromConfigurationArray($this->options);
 
        if (isset($this->options['variables']) && is_array($this->options['variables'])) {
            $standaloneView->assignMultiple($this->options['variables']);
        }
 
        $standaloneView->assign('form', $formRuntime);
        $standaloneView->assign('finisherVariableProvider', $this->finisherContext->getFinisherVariableProvider());
 
        $standaloneView->getRenderingContext()
            ->getViewHelperVariableContainer()
            ->addOrUpdate(RenderRenderableViewHelper::class, 'formRuntime', $formRuntime);
 
        return $standaloneView;
    }
}