TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Extbase\Mvc\Web\Request Class Reference
Inheritance diagram for TYPO3\CMS\Extbase\Mvc\Web\Request:
TYPO3\CMS\Extbase\Mvc\Request TYPO3\CMS\Extbase\Mvc\RequestInterface Tx_Extbase_MVC_Web_Request TYPO3\CMS\Extbase\Mvc\Web\ReferringRequest TYPO3\CMS\Fluid\Core\Widget\WidgetRequest Tx_Fluid_Core_Widget_WidgetRequest

Public Member Functions

 setMethod ($method)
 
 getMethod ()
 
 setRequestUri ($requestUri)
 
 getRequestUri ()
 
 setBaseUri ($baseUri)
 
 getBaseUri ()
 
 setHmacVerified ($hmacVerified)
 
 isHmacVerified ()
 
 setIsCached ($isCached)
 
 isCached ()
 
 getReferringRequest ()
 
 getValidatedReferrerArguments ()
 
- Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Request
 setDispatched ($flag)
 
 isDispatched ()
 
 getControllerObjectName ()
 
 setControllerObjectName ($controllerObjectName)
 
 setPluginName ($pluginName=NULL)
 
 getPluginName ()
 
 setControllerExtensionName ($controllerExtensionName)
 
 getControllerExtensionName ()
 
 getControllerExtensionKey ()
 
 setControllerSubpackageKey ($subpackageKey)
 
 getControllerSubpackageKey ()
 
 setControllerName ($controllerName)
 
 getControllerName ()
 
 setControllerActionName ($actionName)
 
 getControllerActionName ()
 
 setArgument ($argumentName, $value)
 
 setControllerVendorName ($vendorName)
 
 getControllerVendorName ()
 
 setArguments (array $arguments)
 
 getArguments ()
 
 getArgument ($argumentName)
 
 hasArgument ($argumentName)
 
 setFormat ($format)
 
 getFormat ()
 
 setErrors (array $errors)
 
 getErrors ()
 
 getOriginalRequest ()
 
 setOriginalRequest (\TYPO3\CMS\Extbase\Mvc\Request $originalRequest)
 
 getOriginalRequestMappingResults ()
 
 setOriginalRequestMappingResults (\TYPO3\CMS\Extbase\Error\Result $originalRequestMappingResults)
 
 getInternalArguments ()
 
 getInternalArgument ($argumentName)
 

Protected Attributes

 $hashService
 
 $format = 'html'
 
 $method = 'GET'
 
 $requestUri
 
 $baseUri
 
 $hmacVerified = FALSE
 
 $isCached = FALSE
 
 $configurationManager
 
 $environmentService
 
- Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Request
 $controllerObjectNamePattern = 'Tx_@extension_@subpackage_Controller_@controllerController'
 
 $namespacedControllerObjectNamePattern = '@vendor\@extension\@subpackage\Controller\@controllerController'
 
 $pluginName = ''
 
 $controllerExtensionName = NULL
 
 $controllerVendorName = NULL
 
 $controllerSubpackageKey = NULL
 
 $controllerName = 'Standard'
 
 $controllerActionName = 'index'
 
 $arguments = array()
 
 $internalArguments = array()
 
 $format = 'txt'
 
 $dispatched = FALSE
 
 $originalRequest = NULL
 
 $originalRequestMappingResults = NULL
 
 $errors = array()
 

Additional Inherited Members

- Public Attributes inherited from TYPO3\CMS\Extbase\Mvc\Request
const PATTERN_MATCH_FORMAT = '/^[a-z0-9]{1,5}$/'
 

Detailed Description

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! Represents a web request.

Definition at line 21 of file Request.php.

Member Function Documentation

◆ getBaseUri()

TYPO3\CMS\Extbase\Mvc\Web\Request::getBaseUri ( )

Returns the base URI

Returns
string Base URI of this web request

Definition at line 132 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Web\Request\$baseUri.

◆ getMethod()

TYPO3\CMS\Extbase\Mvc\Web\Request::getMethod ( )

Returns the name of the request method

Returns
string Name of the request method

Definition at line 92 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Web\Request\$method.

◆ getReferringRequest()

TYPO3\CMS\Extbase\Mvc\Web\Request::getReferringRequest ( )

Get a freshly built request object pointing to the Referrer.

Returns
Request the referring request, or NULL if no referrer found

Definition at line 185 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$arguments, and TYPO3\CMS\Extbase\Mvc\Web\Request\getValidatedReferrerArguments().

◆ getRequestUri()

TYPO3\CMS\Extbase\Mvc\Web\Request::getRequestUri ( )

Returns the request URI

Returns
string URI of this web request

Definition at line 112 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Web\Request\$requestUri.

◆ getValidatedReferrerArguments()

TYPO3\CMS\Extbase\Mvc\Web\Request::getValidatedReferrerArguments ( )
Returns
array|NULL
Exceptions

Definition at line 205 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Request\getReferringRequest().

◆ isCached()

TYPO3\CMS\Extbase\Mvc\Web\Request::isCached ( )

Return whether the current request is a cached request or not.

(v4 only)

Returns
boolean the caching status.

Definition at line 176 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Web\Request\$isCached.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Request\setIsCached().

◆ isHmacVerified()

TYPO3\CMS\Extbase\Mvc\Web\Request::isHmacVerified ( )

Could the request be verified via a HMAC?

Returns
boolean TRUE if request could be verified, FALSE otherwise
Deprecated:
since Extbase 1.4.0, will be removed two versions after Extbase 6.1

Definition at line 157 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Web\Request\$hmacVerified.

◆ setBaseUri()

TYPO3\CMS\Extbase\Mvc\Web\Request::setBaseUri (   $baseUri)

Sets the base URI for this request.

Parameters
string$baseUriNew base URI
Returns
void

Definition at line 122 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Web\Request\$baseUri.

◆ setHmacVerified()

TYPO3\CMS\Extbase\Mvc\Web\Request::setHmacVerified (   $hmacVerified)

Could the request be verified via a HMAC?

Parameters
boolean$hmacVerifiedTRUE if request could be verified, FALSE otherwise
Returns
void
Deprecated:
since Extbase 1.4.0, will be removed two versions after Extbase 6.1

Definition at line 147 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Web\Request\$hmacVerified.

◆ setIsCached()

TYPO3\CMS\Extbase\Mvc\Web\Request::setIsCached (   $isCached)

Set if the current request is cached.

Parameters
boolean$isCached

Definition at line 166 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Web\Request\$isCached, and TYPO3\CMS\Extbase\Mvc\Web\Request\isCached().

◆ setMethod()

TYPO3\CMS\Extbase\Mvc\Web\Request::setMethod (   $method)

Sets the request method

Parameters
string$methodName of the request method
Returns
void
Exceptions

Definition at line 79 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Web\Request\$method.

◆ setRequestUri()

TYPO3\CMS\Extbase\Mvc\Web\Request::setRequestUri (   $requestUri)

Sets the request URI

Parameters
string$requestUriURI of this web request
Returns
void

Definition at line 102 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Web\Request\$requestUri.

Member Data Documentation

◆ $baseUri

TYPO3\CMS\Extbase\Mvc\Web\Request::$baseUri
protected

◆ $configurationManager

TYPO3\CMS\Extbase\Mvc\Web\Request::$configurationManager
protected

Definition at line 64 of file Request.php.

◆ $environmentService

TYPO3\CMS\Extbase\Mvc\Web\Request::$environmentService
protected

Definition at line 70 of file Request.php.

◆ $format

TYPO3\CMS\Extbase\Mvc\Web\Request::$format = 'html'
protected

Definition at line 32 of file Request.php.

◆ $hashService

TYPO3\CMS\Extbase\Mvc\Web\Request::$hashService
protected

Definition at line 27 of file Request.php.

◆ $hmacVerified

TYPO3\CMS\Extbase\Mvc\Web\Request::$hmacVerified = FALSE
protected

◆ $isCached

TYPO3\CMS\Extbase\Mvc\Web\Request::$isCached = FALSE
protected

◆ $method

TYPO3\CMS\Extbase\Mvc\Web\Request::$method = 'GET'
protected

◆ $requestUri

TYPO3\CMS\Extbase\Mvc\Web\Request::$requestUri
protected