FrontendController.php

Go to the documentation of this file.

<?php
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\Extbase\Mvc\Controller\ActionController;
use TYPO3\CMS\Form\Domain\Model\ValidationElement;
use TYPO3\CMS\Form\Mvc\Controller\ControllerContext;
use TYPO3\CMS\Form\Domain\Builder\FormBuilder;
use TYPO3\CMS\Form\Domain\Builder\ValidationBuilder;
use TYPO3\CMS\Form\Domain\Model\Configuration;
use TYPO3\CMS\Form\Utility\FormUtility;
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;

class FrontendController extends ActionController
{
    protected $formBuilder;

    protected $validationBuilder;

    protected $sessionUtility;

    protected $formUtility;

    protected $typoscript = array();

    protected $skipValidation = false;

    protected $controllerContext;

    protected $configuration;

    public function injectSessionUtility(\TYPO3\CMS\Form\Utility\SessionUtility $sessionUtility)
    {
        $this->sessionUtility = $sessionUtility;
    }

    protected function initializeAction()
    {
        $this->configuration = Configuration::create()->setTypoScript($this->settings['typoscript']);
        $this->formUtility = FormUtility::create($this->configuration);
        $this->validationBuilder = ValidationBuilder::create($this->configuration);
        $this->validationBuilder->setFormUtility($this->formUtility);
        $this->formBuilder = FormBuilder::create($this->configuration);
        $this->formBuilder->setValidationBuilder($this->validationBuilder);
        $this->formBuilder->setFormUtility($this->formUtility);
        $this->typoscript = $this->settings['typoscript'];

            // uploaded file storage
        $this->sessionUtility->initSession($this->configuration->getPrefix());
            // move the incoming "formPrefix" data to the $model argument
            // now we can validate the $model argument
        if ($this->request->hasArgument($this->configuration->getPrefix())) {
            $this->skipValidation = false;
            $argument = $this->request->getArgument($this->configuration->getPrefix());
            $this->request->setArgument('model', $argument);
        } else {
            // If there are more forms at a page we have to skip
            // the validation of not submitted forms
            $this->skipValidation = true;
            $this->request->setArgument('model', array());
        }
    }

    protected function initializeShowAction()
    {
        // set validation errors
        $validationResults = $this->request->getOriginalRequestMappingResults()->forProperty('model');
        if (!$validationResults->hasErrors()) {
            // If there are errors, the rules already build
                // but if there are errors, we need to build the rules here,
                // because of the mandatory message rendering
            $this->validationBuilder->buildRules();
            return;
        }
        $this->formBuilder->setValidationErrors($validationResults);
    }

    protected function initializeConfirmationAction()
    {
        $this->prepareValidations();
    }

    protected function initializeProcessAction()
    {
        $this->prepareValidations();
    }

    protected function buildControllerContext()
    {
        $controllerContext = ControllerContext::extend(parent::buildControllerContext())
            ->setConfiguration($this->configuration);
        $this->formBuilder->setControllerContext($controllerContext);
        return $controllerContext;
    }

    public function showAction(ValidationElement $incomingData = null)
    {
        if ($incomingData !== null) {
            $this->controllerContext->setValidationElement($incomingData);
        }
        $form = $this->formBuilder->buildModel();
        $this->view->assign('model', $form);
    }

    public function confirmationAction(ValidationElement $model)
    {
        $this->skipForeignFormProcessing();

        if (count($model->getIncomingFields()) === 0) {
            $this->sessionUtility->destroySession();
            $this->forward('show');
        }
        $this->controllerContext->setValidationElement($model);
        $form = $this->formBuilder->buildModel();
        // store uploaded files
        $this->sessionUtility->storeSession();
        $this->view->assign('model', $form);

        $message = $this->formUtility->renderItem(
            $this->typoscript['confirmation.']['message.'],
            $this->typoscript['confirmation.']['message'],
            LocalizationUtility::translate('tx_form_view_confirmation.message', 'form')
        );
        $this->view->assign('message', $message);
    }

    public function dispatchConfirmationButtonClickAction(ValidationElement $model)
    {
        $this->skipForeignFormProcessing();

        if ($this->request->hasArgument('confirmation-true')) {
            $this->forward('process', null, null, array($this->configuration->getPrefix() => $this->request->getArgument('model')));
        } else {
            $this->sessionUtility->destroySession();
            $this->forward('show', null, null, array('incomingData' => $this->request->getArgument('model')));
        }
    }

    public function processAction(ValidationElement $model)
    {
        $this->skipForeignFormProcessing();

        $this->controllerContext->setValidationElement($model);
        $form = $this->formBuilder->buildModel();
        $postProcessorTypoScript = array();
        if (isset($this->typoscript['postProcessor.'])) {
            $postProcessorTypoScript = $this->typoscript['postProcessor.'];
        }

        $postProcessor = $this->objectManager->get(
            \TYPO3\CMS\Form\PostProcess\PostProcessor::class,
            $form, $postProcessorTypoScript
        );
        $postProcessor->setControllerContext($this->controllerContext);

        // @todo What is happening here?
        $content = $postProcessor->process();
        $this->sessionUtility->destroySession();
        $this->forward('afterProcess', null, null, array('postProcessorContent' => $content));
    }

    public function afterProcessAction($postProcessorContent)
    {
        $this->view->assign('postProcessorContent', $postProcessorContent);
    }

    protected function skipForeignFormProcessing()
    {
        if (
            !$this->request->hasArgument($this->configuration->getPrefix())
            && !$this->sessionUtility->getSessionData()
        ) {
            $this->forward('show');
        }
    }

    protected function prepareValidations()
    {
        if ($this->skipValidation || !$this->arguments->hasArgument('model')) {
            return;
        }

        $this->validationBuilder->buildRules($this->request->getArgument('model'));
        $this->setDynamicValidation($this->validationBuilder->getRules());
        $this->skipValidation = false;
    }

    protected function setDynamicValidation(array $toValidate = array())
    {
        // build custom validation chain
        $validatorResolver = $this->objectManager->get(\TYPO3\CMS\Extbase\Validation\ValidatorResolver::class);

        $modelValidator = $validatorResolver->createValidator(\TYPO3\CMS\Form\Domain\Validator\ValidationElementValidator::class);
        foreach ($toValidate as $propertyName => $validations) {
            foreach ($validations as $validation) {
                if (empty($validation['validator'])) {
                    throw new \TYPO3\CMS\Extbase\Validation\Exception\NoSuchValidatorException('Invalid validate configuration for ' . $propertyName . ': Could not resolve class name for validator "' . $validation['validatorName'] . '".', 1441893777);
                }
                $modelValidator->addPropertyValidator($propertyName, $validation['validator']);
            }
        }

        if ($modelValidator->countPropertyValidators()) {
            $baseConjunctionValidator = $this->arguments->getArgument('model')->getValidator();
            if ($baseConjunctionValidator === null) {
                $baseConjunctionValidator = $validatorResolver->createValidator(\TYPO3\CMS\Extbase\Validation\Validator\ConjunctionValidator::class);
                $this->arguments->getArgument('model')->setValidator($baseConjunctionValidator);
            }
            $baseConjunctionValidator->addValidator($modelValidator);
        }
    }
}