Request.php

Go to the documentation of this file.

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

/*
 * 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\Core\Utility\ClassNamingUtility;

class Request implements RequestInterface
{
    const PATTERN_MATCH_FORMAT = '/^[a-z0-9]{1,5}$/';

    protected $controllerObjectNamePattern = 'Tx_@extension_@subpackage_Controller_@controllerController';

    protected $namespacedControllerObjectNamePattern = '@vendor\@extension\@subpackage\Controller\@controllerController';

    protected $pluginName = '';

    protected $controllerExtensionName = null;

    protected $controllerVendorName = null;

    protected $controllerSubpackageKey = null;

    protected $controllerName = 'Standard';

    protected $controllerActionName = 'index';

    protected $arguments = [];

    protected $internalArguments = [];

    protected $format = 'txt';

    protected $dispatched = false;

    protected $originalRequest = null;

    protected $originalRequestMappingResults = null;

    public function setDispatched($flag)
    {
        $this->dispatched = (bool)$flag;
    }

    public function isDispatched()
    {
        return $this->dispatched;
    }

    public function getControllerObjectName()
    {
        if (null !== $this->controllerVendorName) {
            // It's safe to assume a namespaced name as namespaced names have to follow PSR-0
            $objectName = str_replace(
                [
                    '@extension',
                    '@subpackage',
                    '@controller',
                    '@vendor',
                    '\\\\'
                ],
                [
                    $this->controllerExtensionName,
                    $this->controllerSubpackageKey,
                    $this->controllerName,
                    $this->controllerVendorName,
                    '\\'
                ],
                $this->namespacedControllerObjectNamePattern
            );
        } else {
            $objectName = str_replace(
                [
                    '@extension',
                    '@subpackage',
                    '@controller',
                    '__'
                ],
                [
                    $this->controllerExtensionName,
                    $this->controllerSubpackageKey,
                    $this->controllerName,
                    '_'
                ],
                $this->controllerObjectNamePattern
            );
        }
        // @todo implement getCaseSensitiveObjectName()
        if ($objectName === false) {
            throw new \TYPO3\CMS\Extbase\Mvc\Exception\NoSuchControllerException('The controller object "' . $objectName . '" does not exist.', 1220884009);
        }
        return $objectName;
    }

    public function setControllerObjectName($controllerObjectName)
    {
        $nameParts = ClassNamingUtility::explodeObjectControllerName($controllerObjectName);
        $this->controllerVendorName = isset($nameParts['vendorName']) ? $nameParts['vendorName'] : null;
        $this->controllerExtensionName = $nameParts['extensionName'];
        $this->controllerSubpackageKey = isset($nameParts['subpackageKey']) ? $nameParts['subpackageKey'] : null;
        $this->controllerName = $nameParts['controllerName'];
    }

    public function setPluginName($pluginName = null)
    {
        if ($pluginName !== null) {
            $this->pluginName = $pluginName;
        }
    }

    public function getPluginName()
    {
        return $this->pluginName;
    }

    public function setControllerExtensionName($controllerExtensionName)
    {
        if ($controllerExtensionName !== null) {
            $this->controllerExtensionName = $controllerExtensionName;
        }
    }

    public function getControllerExtensionName()
    {
        return $this->controllerExtensionName;
    }

    public function getControllerExtensionKey()
    {
        return \TYPO3\CMS\Core\Utility\GeneralUtility::camelCaseToLowerCaseUnderscored($this->controllerExtensionName);
    }

    public function setControllerSubpackageKey($subpackageKey)
    {
        $this->controllerSubpackageKey = $subpackageKey;
    }

    public function getControllerSubpackageKey()
    {
        return $this->controllerSubpackageKey;
    }

    public function setControllerName($controllerName)
    {
        if (!is_string($controllerName) && $controllerName !== null) {
            throw new \TYPO3\CMS\Extbase\Mvc\Exception\InvalidControllerNameException('The controller name must be a valid string, ' . gettype($controllerName) . ' given.', 1187176358);
        }
        if (strpos($controllerName, '_') !== false) {
            throw new \TYPO3\CMS\Extbase\Mvc\Exception\InvalidControllerNameException('The controller name must not contain underscores.', 1217846412);
        }
        if ($controllerName !== null) {
            $this->controllerName = $controllerName;
        }
    }

    public function getControllerName()
    {
        return $this->controllerName;
    }

    public function setControllerActionName($actionName)
    {
        if (!is_string($actionName) && $actionName !== null) {
            throw new \TYPO3\CMS\Extbase\Mvc\Exception\InvalidActionNameException('The action name must be a valid string, ' . gettype($actionName) . ' given (' . $actionName . ').', 1187176359);
        }
        if ($actionName[0] !== strtolower($actionName[0]) && $actionName !== null) {
            throw new \TYPO3\CMS\Extbase\Mvc\Exception\InvalidActionNameException('The action name must start with a lower case letter, "' . $actionName . '" does not match this criteria.', 1218473352);
        }
        if ($actionName !== null) {
            $this->controllerActionName = $actionName;
        }
    }

    public function getControllerActionName()
    {
        $controllerObjectName = $this->getControllerObjectName();
        if ($controllerObjectName !== '' && $this->controllerActionName === strtolower($this->controllerActionName)) {
            $actionMethodName = $this->controllerActionName . 'Action';
            $classMethods = get_class_methods($controllerObjectName);
            if (is_array($classMethods)) {
                foreach ($classMethods as $existingMethodName) {
                    if (strtolower($existingMethodName) === strtolower($actionMethodName)) {
                        $this->controllerActionName = substr($existingMethodName, 0, -6);
                        break;
                    }
                }
            }
        }
        return $this->controllerActionName;
    }

    public function setArgument($argumentName, $value)
    {
        if (!is_string($argumentName) || $argumentName === '') {
            throw new \TYPO3\CMS\Extbase\Mvc\Exception\InvalidArgumentNameException('Invalid argument name.', 1210858767);
        }
        if ($argumentName[0] === '_' && $argumentName[1] === '_') {
            $this->internalArguments[$argumentName] = $value;
            return;
        }
        if (!in_array($argumentName, ['@extension', '@subpackage', '@controller', '@action', '@format', '@vendor'], true)) {
            $this->arguments[$argumentName] = $value;
        }
    }

    public function setControllerVendorName($vendorName)
    {
        $this->controllerVendorName = $vendorName;
    }

    public function getControllerVendorName()
    {
        return $this->controllerVendorName;
    }

    public function setArguments(array $arguments)
    {
        $this->arguments = [];
        foreach ($arguments as $argumentName => $argumentValue) {
            $this->setArgument($argumentName, $argumentValue);
        }
    }

    public function getArguments()
    {
        return $this->arguments;
    }

    public function getArgument($argumentName)
    {
        if (!isset($this->arguments[$argumentName])) {
            throw new \TYPO3\CMS\Extbase\Mvc\Exception\NoSuchArgumentException('An argument "' . $argumentName . '" does not exist for this request.', 1176558158);
        }
        return $this->arguments[$argumentName];
    }

    public function hasArgument($argumentName)
    {
        return isset($this->arguments[$argumentName]);
    }

    public function setFormat($format)
    {
        $this->format = $format;
    }

    public function getFormat()
    {
        return $this->format;
    }

    public function getOriginalRequest()
    {
        return $this->originalRequest;
    }

    public function setOriginalRequest(\TYPO3\CMS\Extbase\Mvc\Request $originalRequest)
    {
        $this->originalRequest = $originalRequest;
    }

    public function getOriginalRequestMappingResults()
    {
        if ($this->originalRequestMappingResults === null) {
            return new \TYPO3\CMS\Extbase\Error\Result();
        }
        return $this->originalRequestMappingResults;
    }

    public function setOriginalRequestMappingResults(\TYPO3\CMS\Extbase\Error\Result $originalRequestMappingResults)
    {
        $this->originalRequestMappingResults = $originalRequestMappingResults;
    }

    public function getInternalArguments()
    {
        return $this->internalArguments;
    }

    public function getInternalArgument($argumentName)
    {
        if (!isset($this->internalArguments[$argumentName])) {
            return null;
        }
        return $this->internalArguments[$argumentName];
    }
}