Dispatcher.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\Extbase\Mvc;
 
use Psr\Container\ContainerInterface;
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Http\Message\ResponseInterface;
use ‪TYPO3\CMS\Extbase\Annotation\IgnoreValidation;
use ‪TYPO3\CMS\Extbase\Event\Mvc\AfterRequestDispatchedEvent;
use ‪TYPO3\CMS\Extbase\Http\ForwardResponse;
use ‪TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface;
use ‪TYPO3\CMS\Extbase\Mvc\Exception\InfiniteLoopException;
use ‪TYPO3\CMS\Extbase\Mvc\Exception\InvalidControllerException;
 
class ‪Dispatcher
{
    private ContainerInterface ‪$container;
    protected EventDispatcherInterface ‪$eventDispatcher;
 
    public function ‪__construct(
        ContainerInterface ‪$container,
        EventDispatcherInterface ‪$eventDispatcher
    ) {
        $this->container = ‪$container;
        $this->eventDispatcher = ‪$eventDispatcher;
    }
 
    public function ‪dispatch(‪RequestInterface $request): ResponseInterface
    {
        $dispatchLoopCount = 0;
        $isDispatched = false;
        while (!$isDispatched) {
            if ($dispatchLoopCount++ > 99) {
                throw new ‪InfiniteLoopException(
                    'Could not ultimately dispatch the request after ' . $dispatchLoopCount
                    . ' iterations. Most probably, a @' . IgnoreValidation::class
                    . ' annotation is missing on re-displaying a form with validation errors.',
                    1217839467
                );
            }
            $controller = $this->‪resolveController($request);
            $response = $controller->processRequest($request);
            if ($response instanceof ‪ForwardResponse) {
                // The controller action returned an extbase internal Forward response:
                // Another action should be dispatched.
                $request = static::buildRequestFromCurrentRequestAndForwardResponse($request, $response);
            } else {
                // The controller action returned a casual or a HTTP redirect response.
                // Dispatching ends here and response is sent to client.
                $isDispatched = true;
            }
        }
        $this->eventDispatcher->dispatch(new ‪AfterRequestDispatchedEvent($request, $response));
        return $response;
    }
 
    protected function ‪resolveController(‪RequestInterface $request)
    {
        $controllerObjectName = $request->‪getControllerObjectName();
        $controller = $this->container->get($controllerObjectName);
        if (!$controller instanceof ‪ControllerInterface) {
            throw new ‪InvalidControllerException(
                'Invalid controller "' . $request->‪getControllerObjectName() . '". The controller must implement the TYPO3\\CMS\\Extbase\\Mvc\\Controller\\ControllerInterface.',
                1476109646
            );
        }
        return $controller;
    }
 
    public static function ‪buildRequestFromCurrentRequestAndForwardResponse(‪RequestInterface $currentRequest, ‪ForwardResponse $forwardResponse): ‪RequestInterface
    {
        $request = $currentRequest->‪withControllerActionName($forwardResponse->‪getActionName());
        if ($forwardResponse->‪getControllerName() !== null) {
            $request = $request->withControllerName($forwardResponse->‪getControllerName());
        }
        if ($forwardResponse->‪getExtensionName() !== null) {
            $request = $request->withControllerExtensionName($forwardResponse->‪getExtensionName());
        }
        if ($forwardResponse->‪getArguments() !== null) {
            $request = $request->withArguments($forwardResponse->‪getArguments());
        }
        $extbaseRequestParameters = clone $request->getAttribute('extbase');
        $extbaseRequestParameters->setOriginalRequest($currentRequest);
        $extbaseRequestParameters->setOriginalRequestMappingResults($forwardResponse->‪getArgumentsValidationResult());
        return $request->withAttribute('extbase', $extbaseRequestParameters);
    }
}