RedirectFinisher.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\Http\PropagateResponseException;
use ‪TYPO3\CMS\Core\Http\RedirectResponse;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder;
 
class ‪RedirectFinisher extends ‪AbstractFinisher
{
    protected ‪$defaultOptions = [
        'pageUid' => 1,
        'additionalParameters' => '',
        'statusCode' => 303,
    ];
 
    protected ‪$request;
 
    protected ‪$uriBuilder;
 
    protected function ‪executeInternal()
    {
        $formRuntime = $this->finisherContext->getFormRuntime();
        $this->request = $formRuntime->getRequest();
        $this->uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
        $this->uriBuilder->setRequest($this->request);
 
        $pageUid = $this->‪parseOption('pageUid');
        $pageUid = (int)str_replace('pages_', '', (string)$pageUid);
        $additionalParameters = $this->‪parseOption('additionalParameters');
        $additionalParameters = is_string($additionalParameters) ? $additionalParameters : '';
        $additionalParameters = '&' . ltrim($additionalParameters, '&');
        $statusCode = (int)$this->‪parseOption('statusCode');
 
        $this->finisherContext->cancel();
        $this->‪redirect($pageUid, $additionalParameters, $statusCode);
    }
 
    protected function ‪redirect(int $pageUid = 1, string $additionalParameters = '', int $statusCode = 303)
    {
        $typolinkConfiguration = [
            'parameter' => $pageUid,
            'additionalParams' => $additionalParameters,
        ];
        $redirectUri = $this->‪getTypoScriptFrontendController()->cObj->typoLink_URL($typolinkConfiguration);
        $this->‪redirectToUri($redirectUri, $statusCode);
    }
 
    protected function ‪redirectToUri(string $uri, int $statusCode = 303)
    {
        $uri = $this->‪addBaseUriIfNecessary($uri);
        $response = new ‪RedirectResponse($uri, $statusCode);
        // End processing and dispatching by throwing a PropagateResponseException with our response.
        // @todo: Should be changed to *return* a response instead, but this requires the ContentObjectRender
        // @todo: to deal with responses instead of strings, if the form is used in a fluid template rendered by the
        // @todo: FluidTemplateContentObject and the extbase bootstrap isn't used.
        throw new ‪PropagateResponseException($response, 1477070964);
    }
 
    protected function ‪addBaseUriIfNecessary(string $uri): string
    {
        return GeneralUtility::locationHeaderUrl((string)$uri);
    }
}