TYPO3\CMS\Extbase\Mvc\Web\Request Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Mvc\Web\Request:

Public Member Functions
	injectHashService (\TYPO3\CMS\Extbase\Security\Cryptography\HashService $hashService)
	injectConfigurationManager (\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager)
	injectEnvironmentService (\TYPO3\CMS\Extbase\Service\EnvironmentService $environmentService)
	setMethod ($method)
	getMethod ()
	setRequestUri ($requestUri)
	getRequestUri ()
	setBaseUri ($baseUri)
	getBaseUri ()
	setIsCached ($isCached)
	isCached ()
	getReferringRequest ()
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 ()
	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
	$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 = []
	$internalArguments = []
	$format = 'txt'
	$dispatched = false
	$originalRequest = null
	$originalRequestMappingResults = null

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

Detailed Description

Represents a web request.

Definition at line 22 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 153 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 109 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

ReferringRequest the referring request, or null if no referrer found

Definition at line 188 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$arguments.

getRequestUri()

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

(

)

Returns the request URI

Returns

string URI of this web request

Definition at line 131 of file Request.php.

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

injectConfigurationManager()

TYPO3\CMS\Extbase\Mvc\Web\Request::injectConfigurationManager

(

\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface

$configurationManager

)

Parameters

\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface

$configurationManager

Definition at line 75 of file Request.php.

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

injectEnvironmentService()

TYPO3\CMS\Extbase\Mvc\Web\Request::injectEnvironmentService

(

\TYPO3\CMS\Extbase\Service\EnvironmentService

$environmentService

)

Parameters

\TYPO3\CMS\Extbase\Service\EnvironmentService

$environmentService

Definition at line 83 of file Request.php.

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

injectHashService()

TYPO3\CMS\Extbase\Mvc\Web\Request::injectHashService

(

\TYPO3\CMS\Extbase\Security\Cryptography\HashService

$hashService

)

Parameters

\TYPO3\CMS\Extbase\Security\Cryptography\HashService

$hashService

Definition at line 67 of file Request.php.

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

isCached()

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

(

)

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

(v4 only)

Returns

bool the caching status.

Definition at line 178 of file Request.php.

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

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

setBaseUri()

TYPO3\CMS\Extbase\Mvc\Web\Request::setBaseUri

(

$baseUri

)

Sets the base URI for this request.

Parameters

string

$baseUri

New base URI

Returns

void

Definition at line 142 of file Request.php.

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

setIsCached()

TYPO3\CMS\Extbase\Mvc\Web\Request::setIsCached

(

$isCached

)

Set if the current request is cached.

Parameters

bool

$isCached

Definition at line 167 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

$method

Name of the request method

Returns

void

Exceptions

Definition at line 95 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

$requestUri

URI of this web request

Returns

void

Definition at line 120 of file Request.php.

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

Member Data Documentation

$baseUri

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

protected

Definition at line 47 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Request\getBaseUri(), and TYPO3\CMS\Extbase\Mvc\Web\Request\setBaseUri().

$configurationManager

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

protected

Definition at line 57 of file Request.php.

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

$environmentService

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

protected

Definition at line 62 of file Request.php.

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

$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.

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

$isCached

TYPO3\CMS\Extbase\Mvc\Web\Request::$isCached = false

protected

Definition at line 52 of file Request.php.

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

$method

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

protected

Definition at line 37 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Request\getMethod(), and TYPO3\CMS\Extbase\Mvc\Web\Request\setMethod().

$requestUri

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

protected

Definition at line 42 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Request\getRequestUri(), and TYPO3\CMS\Extbase\Mvc\Web\Request\setRequestUri().