AbstractController.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extbase\Mvc\Controller;

abstract class AbstractController implements \TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface {

    protected $signalSlotDispatcher;

    protected $objectManager;

    protected $uriBuilder;

    protected $extensionName;

    protected $settings;

    protected $request;

    protected $response;

    protected $deprecatedPropertyMapper;

    protected $validatorResolver;

    protected $arguments;

    protected $argumentsMappingResults;

    protected $supportedRequestTypes = array('TYPO3\\CMS\\Extbase\\Mvc\\Request');

    protected $controllerContext;

    public function getControllerContext() {
        return $this->controllerContext;
    }

    protected $flashMessageContainer;

    protected $configurationManager;

    public function __construct() {
        $className = get_class($this);
        if (strpos($className, '\\') !== FALSE) {
            $classNameParts = explode('\\', $className, 4);
            // Skip vendor and product name for core classes
            if (strpos($className, 'TYPO3\\CMS\\') === 0) {
                $this->extensionName = $classNameParts[2];
            } else {
                $this->extensionName = $classNameParts[1];
            }
        } else {
            list(, $this->extensionName) = explode('_', $className);
        }
    }

    public function injectConfigurationManager(\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager) {
        $this->configurationManager = $configurationManager;
        $this->settings = $this->configurationManager->getConfiguration(\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_SETTINGS);
    }

    public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager) {
        $this->objectManager = $objectManager;
        $this->arguments = $this->objectManager->get('TYPO3\\CMS\\Extbase\\Mvc\\Controller\\Arguments');
    }

    public function injectFlashMessageContainer(\TYPO3\CMS\Extbase\Mvc\Controller\FlashMessageContainer $flashMessageContainer) {
        $this->flashMessageContainer = $flashMessageContainer;
    }

    public function addFlashMessage($messageBody, $messageTitle = '', $severity = \TYPO3\CMS\Core\Messaging\AbstractMessage::OK, $storeInSession = TRUE) {
        if (!is_string($messageBody)) {
            throw new \InvalidArgumentException('The message body must be of type string, "' . gettype($messageBody) . '" given.', 1243258395);
        }
        /* @var \TYPO3\CMS\Core\Messaging\FlashMessage $flashMessage */
        $flashMessage = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
            'TYPO3\\CMS\\Core\\Messaging\\FlashMessage', $messageBody, $messageTitle, $severity, $storeInSession
        );
        $this->controllerContext->getFlashMessageQueue()->enqueue($flashMessage);
    }

    public function canProcessRequest(\TYPO3\CMS\Extbase\Mvc\RequestInterface $request) {
        foreach ($this->supportedRequestTypes as $supportedRequestType) {
            if ($request instanceof $supportedRequestType) {
                return TRUE;
            }
        }
        return FALSE;
    }

    public function processRequest(\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response) {
        if (!$this->canProcessRequest($request)) {
            throw new \TYPO3\CMS\Extbase\Mvc\Exception\UnsupportedRequestTypeException(get_class($this) . ' does not support requests of type "' . get_class($request) . '". Supported types are: ' . implode(' ', $this->supportedRequestTypes), 1187701132);
        }
        $response->setRequest($request);
        $this->request = $request;
        $this->request->setDispatched(TRUE);
        $this->response = $response;
        $this->uriBuilder = $this->objectManager->get('TYPO3\\CMS\\Extbase\\Mvc\\Web\\Routing\\UriBuilder');
        $this->uriBuilder->setRequest($request);
        $this->initializeControllerArgumentsBaseValidators();
        $this->mapRequestArgumentsToControllerArguments();
        $this->controllerContext = $this->buildControllerContext();
    }

    protected function buildControllerContext() {
        $controllerContext = $this->objectManager->get('TYPO3\\CMS\\Extbase\\Mvc\\Controller\\ControllerContext');
        $controllerContext->setRequest($this->request);
        $controllerContext->setResponse($this->response);
        if ($this->arguments !== NULL) {
            $controllerContext->setArguments($this->arguments);
        }
        if ($this->argumentsMappingResults !== NULL) {
            $controllerContext->setArgumentsMappingResults($this->argumentsMappingResults);
        }
        $controllerContext->setUriBuilder($this->uriBuilder);

        $controllerContext->setFlashMessageContainer($this->flashMessageContainer);
        return $controllerContext;
    }

    public function forward($actionName, $controllerName = NULL, $extensionName = NULL, array $arguments = NULL) {
        $this->request->setDispatched(FALSE);
        $this->request->setControllerActionName($actionName);
        if ($controllerName !== NULL) {
            $this->request->setControllerName($controllerName);
        }
        if ($extensionName !== NULL) {
            $this->request->setControllerExtensionName($extensionName);
        }
        if ($arguments !== NULL) {
            $this->request->setArguments($arguments);
        }
        throw new \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException();
    }

    protected function redirect($actionName, $controllerName = NULL, $extensionName = NULL, array $arguments = NULL, $pageUid = NULL, $delay = 0, $statusCode = 303) {
        if (!$this->request instanceof \TYPO3\CMS\Extbase\Mvc\Web\Request) {
            throw new \TYPO3\CMS\Extbase\Mvc\Exception\UnsupportedRequestTypeException('redirect() only supports web requests.', 1220539734);
        }
        if ($controllerName === NULL) {
            $controllerName = $this->request->getControllerName();
        }
        $this->uriBuilder->reset()->setTargetPageUid($pageUid)->setCreateAbsoluteUri(TRUE);
        if (\TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('TYPO3_SSL')) {
            $this->uriBuilder->setAbsoluteUriScheme('https');
        }
        $uri = $this->uriBuilder->uriFor($actionName, $arguments, $controllerName, $extensionName);
        $this->redirectToUri($uri, $delay, $statusCode);
    }

    protected function redirectToUri($uri, $delay = 0, $statusCode = 303) {
        if (!$this->request instanceof \TYPO3\CMS\Extbase\Mvc\Web\Request) {
            throw new \TYPO3\CMS\Extbase\Mvc\Exception\UnsupportedRequestTypeException('redirect() only supports web requests.', 1220539735);
        }

        $this->objectManager->get('TYPO3\CMS\Extbase\Service\CacheService')->clearCachesOfRegisteredPageIds();

        $uri = $this->addBaseUriIfNecessary($uri);
        $escapedUri = htmlentities($uri, ENT_QUOTES, 'utf-8');
        $this->response->setContent('<html><head><meta http-equiv="refresh" content="' . (int)$delay . ';url=' . $escapedUri . '"/></head></html>');
        $this->response->setStatus($statusCode);
        $this->response->setHeader('Location', (string) $uri);
        throw new \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException();
    }

    protected function addBaseUriIfNecessary($uri) {
        return \TYPO3\CMS\Core\Utility\GeneralUtility::locationHeaderUrl((string) $uri);
    }

    public function throwStatus($statusCode, $statusMessage = NULL, $content = NULL) {
        if (!$this->request instanceof \TYPO3\CMS\Extbase\Mvc\Web\Request) {
            throw new \TYPO3\CMS\Extbase\Mvc\Exception\UnsupportedRequestTypeException('throwStatus() only supports web requests.', 1220539739);
        }
        $this->response->setStatus($statusCode, $statusMessage);
        if ($content === NULL) {
            $content = $this->response->getStatus();
        }
        $this->response->setContent($content);
        throw new \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException();
    }

    public function initializeControllerArgumentsBaseValidators() {
        foreach ($this->arguments as $argument) {
            $validator = $this->validatorResolver->getBaseValidatorConjunction($argument->getDataType());
            if ($validator !== NULL) {
                $argument->setValidator($validator);
            }
        }
    }

    protected function mapRequestArgumentsToControllerArguments() {
        if ($this->configurationManager->isFeatureEnabled('rewrittenPropertyMapper')) {
            foreach ($this->arguments as $argument) {
                $argumentName = $argument->getName();
                if ($this->request->hasArgument($argumentName)) {
                    $argument->setValue($this->request->getArgument($argumentName));
                } elseif ($argument->isRequired()) {
                    throw new \TYPO3\CMS\Extbase\Mvc\Controller\Exception\RequiredArgumentMissingException('Required argument "' . $argumentName . '" is not set for ' . $this->request->getControllerObjectName() . '->' . $this->request->getControllerActionName() . '.', 1298012500);
                }
            }
        } else {
            // @deprecated since Extbase 1.4, will be removed two versions after Extbase 6.1
            $optionalPropertyNames = array();
            $allPropertyNames = $this->arguments->getArgumentNames();
            foreach ($allPropertyNames as $propertyName) {
                if ($this->arguments[$propertyName]->isRequired() === FALSE) {
                    $optionalPropertyNames[] = $propertyName;
                }
            }
            $validator = $this->objectManager->get('TYPO3\\CMS\\Extbase\\Mvc\\Controller\\ArgumentsValidator');
            $this->deprecatedPropertyMapper->mapAndValidate($allPropertyNames, $this->request->getArguments(), $this->arguments, $optionalPropertyNames, $validator);
            $this->argumentsMappingResults = $this->deprecatedPropertyMapper->getMappingResults();
        }
    }
}