FinisherContext.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!
 */
 
/*
 * Inspired by and partially taken from the Neos.Form package (www.neos.io)
 */
 
namespace ‪TYPO3\CMS\Form\Domain\Finishers;
 
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext;
use ‪TYPO3\CMS\Extbase\Mvc\Request;
use ‪TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
 
class ‪FinisherContext
{
    protected ‪$cancelled = false;
 
    protected ‪FormRuntime ‪$formRuntime;
 
    protected ‪ControllerContext ‪$controllerContext;
 
    protected ‪FinisherVariableProvider ‪$finisherVariableProvider;
 
    private ‪Request ‪$request;
 
    public function ‪__construct(‪FormRuntime ‪$formRuntime, ‪ControllerContext ‪$controllerContext, ‪Request ‪$request)
    {
        $this->formRuntime = ‪$formRuntime;
        // @deprecated since v11, will be removed with v12.
        $this->controllerContext = ‪$controllerContext;
        $this->request = ‪$request;
        $this->finisherVariableProvider = GeneralUtility::makeInstance(FinisherVariableProvider::class);
    }
 
    public function ‪cancel()
    {
        $this->cancelled = true;
    }
 
    public function ‪isCancelled(): bool
    {
        return ‪$this->cancelled;
    }
 
    public function ‪getFormRuntime(): FormRuntime
    {
        return ‪$this->formRuntime;
    }
 
    public function ‪getFormValues(): array
    {
        return $this->formRuntime->getFormState()->getFormValues();
    }
 
    public function ‪getControllerContext(): ControllerContext
    {
        return ‪$this->controllerContext;
    }
 
    public function ‪getFinisherVariableProvider(): FinisherVariableProvider
    {
        return ‪$this->finisherVariableProvider;
    }
 
    public function ‪getRequest(): ‪Request
    {
        return ‪$this->request;
    }
}