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

Public Member Functions

 __construct (string $controllerClassName='')
 
 getControllerObjectName ()
 
 setControllerObjectName (string $controllerObjectName)
 
 setPluginName (string $pluginName)
 
 getPluginName ()
 
 setControllerExtensionName (string $controllerExtensionName)
 
 getControllerExtensionName ()
 
 getControllerExtensionKey ()
 
 setControllerAliasToClassNameMapping (array $controllerAliasToClassNameMapping)
 
 setControllerName (string $controllerName)
 
 getControllerName ()
 
 setControllerActionName (string $actionName)
 
 getControllerActionName ()
 
 setArgument (string $argumentName, mixed $value)
 
 setArguments (array $arguments)
 
 getArguments ()
 
mixed getArgument (string $argumentName)
 
 hasArgument (string $argumentName='')
 
 setFormat (string $format)
 
 getFormat ()
 
 getOriginalRequest ()
 
 setOriginalRequest (RequestInterface $originalRequest)
 
 getOriginalRequestMappingResults ()
 
 setOriginalRequestMappingResults (Result $originalRequestMappingResults)
 
mixed getInternalArgument ($argumentName)
 
 getUploadedFiles ()
 
 setUploadedFiles (array $files)
 

Protected Member Functions

 validateUploadedFiles (array $uploadedFiles)
 

Protected Attributes

string $pluginName = ''
 
string $controllerExtensionName = ''
 
string $controllerObjectName = ''
 
string $controllerName = 'Standard'
 
array $controllerAliasToClassNameMapping = []
 
string $controllerActionName = 'index'
 
array $arguments = []
 
array $internalArguments = []
 
string $format = 'html'
 
RequestInterface $originalRequest = null
 
Result $originalRequestMappingResults = null
 
array $uploadedFiles = []
 

Detailed Description

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

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

Definition at line 34 of file ExtbaseRequestParameters.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 111 of file ExtbaseRequestParameters.php.

Member Function Documentation

◆ getArgument()

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

Returns the value of the specified argument.

Returns
‪mixed Value of the argument
Exceptions
NoSuchArgumentException‪if such an argument does not exist

Definition at line 255 of file ExtbaseRequestParameters.php.

◆ getArguments()

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

◆ getControllerActionName()

◆ getControllerExtensionKey()

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

◆ getControllerExtensionName()

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

◆ getControllerName()

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

◆ getControllerObjectName()

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

◆ getFormat()

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

◆ getInternalArgument()

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

Returns the value of the specified argument

Returns
‪mixed Value of the argument, or NULL if not set.

Definition at line 315 of file ExtbaseRequestParameters.php.

◆ getOriginalRequest()

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

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

Definition at line 285 of file ExtbaseRequestParameters.php.

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

◆ getOriginalRequestMappingResults()

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

◆ getPluginName()

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

◆ getUploadedFiles()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::getUploadedFiles ( )

◆ hasArgument()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::hasArgument ( string  $argumentName = '')

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

Definition at line 266 of file ExtbaseRequestParameters.php.

◆ setArgument()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setArgument ( string  $argumentName,
mixed  $value 
)
Parameters
mixed$value‪The new value
Exceptions
InvalidArgumentNameException

Definition at line 214 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<string,mixed>‪$arguments
Exceptions
InvalidArgumentNameException

Definition at line 235 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 ( string  $actionName)
Exceptions
InvalidActionNameException‪if the action name is not valid

Definition at line 180 of file ExtbaseRequestParameters.php.

◆ setControllerAliasToClassNameMapping()

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

◆ setControllerExtensionName()

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

◆ setControllerName()

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

◆ setControllerObjectName()

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

◆ setFormat()

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

◆ setOriginalRequest()

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

◆ setOriginalRequestMappingResults()

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

◆ setPluginName()

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

◆ setUploadedFiles()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::setUploadedFiles ( array  $files)

◆ validateUploadedFiles()

TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::validateUploadedFiles ( array  $uploadedFiles)
protected

Recursively validate the structure in an uploaded files array.

Exceptions

Definition at line 340 of file ExtbaseRequestParameters.php.

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

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

Member Data Documentation

◆ $arguments

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

The arguments for this request. This receives only those arguments relevant and prefixed for this extension/controller/plugin combination.

Definition at line 79 of file ExtbaseRequestParameters.php.

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

◆ $controllerActionName

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

Name of the action the controller is supposed to execute. For example "create" with the controller method name being "createAction()". Action name must start with a lower case letter and is case-sensitive.

Definition at line 73 of file ExtbaseRequestParameters.php.

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

◆ $controllerAliasToClassNameMapping

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

A map $controllerName => $controllerObjectName

Definition at line 66 of file ExtbaseRequestParameters.php.

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

◆ $controllerExtensionName

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

Name of the extension which is supposed to handle this request. This is the extension key in UpperCamelCase. This is typically defined by ExtensionUtility::configurePlugin() and friends as first argument. Example: "IndexedSearch", when the extension key "directory name of extension" is indexed_search.

Definition at line 49 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. This is the non-FQDN version of $controllerObjectName, without the word "Controller", example: "FormManager".

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

This is the FQDN of a controller, example: "TYPO3\CMS\Form\Controller\FormManagerController" for ext:form backend module.

Definition at line 55 of file ExtbaseRequestParameters.php.

Referenced by TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\getControllerActionName(), TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\getControllerObjectName(), and TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\setControllerObjectName().

◆ $format

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

The requested representation format, "html", "xml", "png", "json" or the like. Can even be something like "rss.xml".

Definition at line 93 of file ExtbaseRequestParameters.php.

Referenced by TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\getFormat(), and TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\setFormat().

◆ $internalArguments

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

Framework-internal arguments for this request, such as __referrer. All framework-internal arguments start with double underscore (__), and are only used from within the framework. Not for user consumption. Internal Arguments can be objects, in contrast to public arguments

Definition at line 87 of file ExtbaseRequestParameters.php.

◆ $originalRequest

RequestInterface TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters::$originalRequest = null
protected

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

Definition at line 98 of file ExtbaseRequestParameters.php.

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

◆ $originalRequestMappingResults

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

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

Definition at line 103 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. In frontend, it is the second argument of ExtensionUtility::configurePlugin(), example: "FormFramework" in ext:form. In backend, it is the module identifier from the corresponding module configuration, for example "web_FormFormbuilder" for the ext:form backend module.

Definition at line 42 of file ExtbaseRequestParameters.php.

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

◆ $uploadedFiles

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

If files were uploaded, this array holds the files prefixed for this extension/controller/plugin combination.

Definition at line 109 of file ExtbaseRequestParameters.php.

Referenced by TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\getUploadedFiles(), and TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\validateUploadedFiles().