‪TYPO3CMS  11.5
TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters Class Reference

Public Member Functions

 setDispatched ($flag)
 
bool isDispatched ()
 
 __construct (string $controllerClassName='')
 
string getControllerObjectName ()
 
 setControllerObjectName ($controllerObjectName)
 
 setPluginName ($pluginName=null)
 
string getPluginName ()
 
 setControllerExtensionName ($controllerExtensionName)
 
string getControllerExtensionName ()
 
string getControllerExtensionKey ()
 
 setControllerAliasToClassNameMapping (array $controllerAliasToClassNameMapping)
 
 setControllerName ($controllerName)
 
string getControllerName ()
 
 setControllerActionName ($actionName)
 
string getControllerActionName ()
 
 setArgument (string $argumentName, $value)
 
 setArguments (array $arguments)
 
array getArguments ()
 
string array getArgument ($argumentName)
 
bool hasArgument ($argumentName)
 
 setFormat (string $format)
 
string getFormat ()
 
TYPO3 CMS Extbase Mvc Request null getOriginalRequest ()
 
 setOriginalRequest (\TYPO3\CMS\Extbase\Mvc\Request $originalRequest)
 
TYPO3 CMS Extbase Error Result getOriginalRequestMappingResults ()
 
 setOriginalRequestMappingResults (Result $originalRequestMappingResults)
 
array getInternalArguments ()
 
string null getInternalArgument ($argumentName)
 

Protected Attributes

string $pluginName = ''
 
string $controllerExtensionName
 
string $controllerObjectName
 
string $controllerName = 'Standard'
 
string $controllerActionName = 'index'
 
array $arguments = array( )
 
array $internalArguments = []
 
string $format = 'html'
 
bool $dispatched = false
 
TYPO3 CMS Extbase Mvc Request null $originalRequest
 
TYPO3 CMS Extbase Error Result null $originalRequestMappingResults
 
array $controllerAliasToClassNameMapping = array( )
 

Detailed Description

Extbase request related state. Attached as 'extbase' attribute to PSR-7 ServerRequestInterface.

Set up extbase internally, use TYPO3\CMS\Extbase\Mvc\Request instead.

Definition at line 32 of file ExtbaseRequestParameters.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::__construct ( string  $controllerClassName = '')
Parameters
string$controllerClassName

Definition at line 122 of file ExtbaseRequestParameters.php.

Member Function Documentation

◆ getArgument()

string array TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getArgument (   $argumentName)

Returns the value of the specified argument

Parameters
string$argumentName‪Name of the argument
Returns
‪string|array Value of the argument
Exceptions

Definition at line 361 of file ExtbaseRequestParameters.php.

◆ getArguments()

array TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getArguments ( )

Returns an array of arguments and their values

Returns
‪array Associative array of arguments and their values (which may be arguments and values as well)

Definition at line 348 of file ExtbaseRequestParameters.php.

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

◆ getControllerActionName()

string TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getControllerActionName ( )

◆ getControllerExtensionKey()

string TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getControllerExtensionKey ( )

Returns the extension name of the specified controller.

Returns
‪string The extension key

Definition at line 203 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\camelCaseToLowerCaseUnderscored().

◆ getControllerExtensionName()

string TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getControllerExtensionName ( )

Returns the extension name of the specified controller.

Returns
‪string The extension name

Definition at line 193 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$controllerExtensionName.

◆ getControllerName()

string TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getControllerName ( )

Returns the object name of the controller supposed to handle this request, if one was set already (if not, the name of the default controller is returned)

Returns
‪string Object name of the controller

Definition at line 250 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$controllerName.

◆ getControllerObjectName()

string TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getControllerObjectName ( )

◆ getFormat()

string TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getFormat ( )

Returns the requested representation format

Returns
‪string The desired format, something like "html", "xml", "png", "json" or the like.

Definition at line 398 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$format.

◆ getInternalArgument()

string null TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getInternalArgument (   $argumentName)

Returns the value of the specified argument

Parameters
string$argumentName‪Name of the argument
Returns
‪string|null Value of the argument, or NULL if not set.

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 465 of file ExtbaseRequestParameters.php.

◆ getInternalArguments()

array TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getInternalArguments ( )

Get the internal arguments of the request, i.e. every argument starting with two underscores.

Returns
‪array

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 453 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$internalArguments.

◆ getOriginalRequest()

TYPO3 CMS Extbase Mvc Request null TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getOriginalRequest ( )

Returns the original request. Filled only if a property mapping error occurred.

Returns
‪\TYPO3\CMS\Extbase\Mvc\Request|null the original request.

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 409 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$originalRequest.

◆ getOriginalRequestMappingResults()

TYPO3 CMS Extbase Error Result TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getOriginalRequestMappingResults ( )

Get the request mapping results for the original request.

Returns
‪\TYPO3\CMS\Extbase\Error\Result

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 429 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$originalRequestMappingResults.

◆ getPluginName()

string TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getPluginName ( )

Returns the plugin key.

Returns
‪string The plugin key

Definition at line 168 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$pluginName.

◆ hasArgument()

bool TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::hasArgument (   $argumentName)

Checks if an argument of the given name exists (is set)

Parameters
string$argumentName‪Name of the argument to check
Returns
‪bool TRUE if the argument is set, otherwise FALSE

Definition at line 376 of file ExtbaseRequestParameters.php.

◆ isDispatched()

bool TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::isDispatched ( )

If this request has been dispatched and addressed by the responsible controller and the response is ready to be sent.

The dispatcher will try to dispatch the request again if it has not been addressed yet.

Returns
‪bool TRUE if this request has been dispatched successfully
Deprecated:
‪since v11, will be removed in v12.

Definition at line 114 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$dispatched.

◆ setArgument()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setArgument ( string  $argumentName,
  $value 
)

Sets the value of the specified argument

Parameters
string$argumentName‪Name of the argument to set
mixed$value‪The new value
Exceptions
InvalidArgumentNameException

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 312 of file ExtbaseRequestParameters.php.

Referenced by TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\setArguments().

◆ setArguments()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setArguments ( array  $arguments)

Sets the whole arguments array and therefore replaces any arguments which existed before.

Parameters
array$arguments‪An array of argument names and their values

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 334 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$arguments, and TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\setArgument().

◆ setControllerActionName()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setControllerActionName (   $actionName)

Sets the name of the action contained in this request.

Note that the action name must start with a lower case letter and is case sensitive.

Parameters
string$actionName‪Name of the action to execute by the controller
Exceptions

Definition at line 264 of file ExtbaseRequestParameters.php.

◆ setControllerAliasToClassNameMapping()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setControllerAliasToClassNameMapping ( array  $controllerAliasToClassNameMapping)
Parameters
array$controllerAliasToClassNameMapping

Definition at line 215 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$controllerAliasToClassNameMapping.

◆ setControllerExtensionName()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setControllerExtensionName (   $controllerExtensionName)

Sets the extension name of the controller.

Parameters
string$controllerExtensionName‪The extension name.
Exceptions

Definition at line 180 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$controllerExtensionName.

◆ setControllerName()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setControllerName (   $controllerName)

Sets the name of the controller which is supposed to handle the request. Note: This is not the object name of the controller!

Parameters
string$controllerName‪Name of the controller
Exceptions
Exception

Definition at line 231 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$controllerName.

◆ setControllerObjectName()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setControllerObjectName (   $controllerObjectName)

Explicitly sets the object name of the controller

Parameters
string$controllerObjectName‪The fully qualified controller object name

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 141 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$controllerObjectName, and TYPO3\CMS\Core\Utility\ClassNamingUtility\explodeObjectControllerName().

◆ setDispatched()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setDispatched (   $flag)

Sets the dispatched flag

Parameters
bool$flag‪If this request has been dispatched
Deprecated:
‪since v11, will be removed in v12.

Definition at line 99 of file ExtbaseRequestParameters.php.

◆ setFormat()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setFormat ( string  $format)

Sets the requested representation format

Parameters
string$format‪The desired format, something like "html", "xml", "png", "json" or the like. Can even be something like "rss.xml".

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 387 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$format.

◆ setOriginalRequest()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setOriginalRequest ( \TYPO3\CMS\Extbase\Mvc\Request  $originalRequest)
Parameters
\TYPO3\CMS\Extbase\Mvc\Request$originalRequest

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 418 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$originalRequest.

◆ setOriginalRequestMappingResults()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setOriginalRequestMappingResults ( Result  $originalRequestMappingResults)
Parameters
\TYPO3\CMS\Extbase\Error\Result$originalRequestMappingResults

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 441 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$originalRequestMappingResults.

◆ setPluginName()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setPluginName (   $pluginName = null)

Sets the plugin name.

Parameters
string | null$pluginName

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 155 of file ExtbaseRequestParameters.php.

References TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\$pluginName.

Member Data Documentation

◆ $arguments

array TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::$arguments = array( )
protected

◆ $controllerActionName

string TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::$controllerActionName = 'index'
protected

Name of the action the controller is supposed to take.

Definition at line 56 of file ExtbaseRequestParameters.php.

Referenced by TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\getControllerActionName().

◆ $controllerAliasToClassNameMapping

array TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::$controllerAliasToClassNameMapping = array( )
protected

◆ $controllerExtensionName

string TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::$controllerExtensionName
protected

Name of the extension which is supposed to handle this request. This is the extension name converted to UpperCamelCase

Todo:
‪: Should probably at least init to empty string.

Definition at line 42 of file ExtbaseRequestParameters.php.

Referenced by TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\getControllerExtensionName(), and TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\setControllerExtensionName().

◆ $controllerName

string TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::$controllerName = 'Standard'
protected

Object name of the controller which is supposed to handle this request.

Definition at line 52 of file ExtbaseRequestParameters.php.

Referenced by TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\getControllerName(), and TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\setControllerName().

◆ $controllerObjectName

string TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::$controllerObjectName
protected

◆ $dispatched

bool TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::$dispatched = false
protected

If this request has been changed and needs to be dispatched again

Deprecated:
‪since v11, will be removed in v12.

Definition at line 79 of file ExtbaseRequestParameters.php.

Referenced by TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\isDispatched().

◆ $format

string TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::$format = 'html'
protected

◆ $internalArguments

array TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::$internalArguments = []
protected

◆ $originalRequest

TYPO3 CMS Extbase Mvc Request null TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::$originalRequest
protected

If this request is a forward because of an error, the original request gets filled.

Definition at line 85 of file ExtbaseRequestParameters.php.

Referenced by TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\getOriginalRequest(), and TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\setOriginalRequest().

◆ $originalRequestMappingResults

TYPO3 CMS Extbase Error Result null TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::$originalRequestMappingResults
protected

If the request is a forward because of an error, these mapping results get filled here.

Definition at line 91 of file ExtbaseRequestParameters.php.

Referenced by TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\getOriginalRequestMappingResults(), and TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\setOriginalRequestMappingResults().

◆ $pluginName

string TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::$pluginName = ''
protected

Key of the plugin which identifies the plugin. It must be a string containing [a-z0-9]

Definition at line 36 of file ExtbaseRequestParameters.php.

Referenced by TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\getPluginName(), and TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\setPluginName().