ExtbaseRequestParameters

Extbase request related state.

Attached as 'extbase' attribute to PSR-7 ServerRequestInterface.

Internal

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

Table of Contents

Properties

$arguments  : array<string|int, mixed>
The arguments for this request. This receives only those arguments relevant and prefixed for this extension/controller/plugin combination.
$controllerActionName  : string
Name of the action the controller is supposed to execute. For example "create" with the controller method name being "createAction()".
$controllerAliasToClassNameMapping  : array<string|int, mixed>
A map $controllerName => $controllerObjectName
$controllerExtensionName  : string
Name of the extension which is supposed to handle this request. This is the extension key in UpperCamelCase.
$controllerName  : string
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".
$controllerObjectName  : string
This is the FQDN of a controller, example: "TYPO3\CMS\Form\Controller\FormManagerController" for ext:form backend module.
$format  : string
The requested representation format, "html", "xml", "png", "json" or the like.
$internalArguments  : array<string|int, mixed>
Framework-internal arguments for this request, such as __referrer.
$originalRequest  : RequestInterface|null
If this request is a forward because of an error, the original request gets filled.
$originalRequestMappingResults  : Result|null
If the request is a forward because of an error, these mapping results get filled here.
$pluginName  : string
Key of the plugin which identifies the plugin.
$uploadedFiles  : array<string|int, mixed>
If files were uploaded, this array holds the files prefixed for this extension/controller/plugin combination.

Methods

__construct()  : mixed
getArgument()  : mixed
Returns the value of the specified argument.
getArguments()  : array<string|int, mixed>
getControllerActionName()  : string
getControllerExtensionKey()  : string
getControllerExtensionName()  : string
getControllerName()  : string
getControllerObjectName()  : string
getFormat()  : string
getInternalArgument()  : mixed
Returns the value of the specified argument
getOriginalRequest()  : RequestInterface|null
Returns the original request. Filled only if a property mapping error occurred.
getOriginalRequestMappingResults()  : Result
getPluginName()  : string
getUploadedFiles()  : array<string|int, mixed>
hasArgument()  : bool
Checks if an argument of the given name exists (is set)
setArgument()  : self
setArguments()  : self
Sets the whole arguments array and therefore replaces any arguments which existed before.
setControllerActionName()  : self
setControllerAliasToClassNameMapping()  : self
setControllerExtensionName()  : self
setControllerName()  : self
setControllerObjectName()  : self
setFormat()  : self
setOriginalRequest()  : self
setOriginalRequestMappingResults()  : self
setPluginName()  : self
setUploadedFiles()  : self
validateUploadedFiles()  : void
Recursively validate the structure in an uploaded files array.

Properties

$arguments

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

protected array<string|int, mixed> $arguments = []

$controllerActionName

Name of the action the controller is supposed to execute. For example "create" with the controller method name being "createAction()".

protected string $controllerActionName = 'index'

Action name must start with a lower case letter and is case-sensitive.

$controllerAliasToClassNameMapping

A map $controllerName => $controllerObjectName

protected array<string|int, mixed> $controllerAliasToClassNameMapping = []

$controllerExtensionName

Name of the extension which is supposed to handle this request. This is the extension key in UpperCamelCase.

protected string $controllerExtensionName = ''

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.

$controllerName

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

protected string $controllerName = 'Standard'

$controllerObjectName

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

protected string $controllerObjectName = ''

$format

The requested representation format, "html", "xml", "png", "json" or the like.

protected string $format = 'html'

Can even be something like "rss.xml".

$internalArguments

Framework-internal arguments for this request, such as __referrer.

protected array<string|int, mixed> $internalArguments = []

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

$originalRequest

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

protected RequestInterface|null $originalRequest = null

$originalRequestMappingResults

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

protected Result|null $originalRequestMappingResults = null

$pluginName

Key of the plugin which identifies the plugin.

protected string $pluginName = ''

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.

$uploadedFiles

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

protected array<string|int, mixed> $uploadedFiles = []

Methods

__construct()

public __construct([string $controllerClassName = '' ]) : mixed
Parameters
$controllerClassName : string = ''

getArgument()

Returns the value of the specified argument.

public getArgument(string $argumentName) : mixed
Parameters
$argumentName : string
Tags
throws
NoSuchArgumentException

if such an argument does not exist

Return values
mixed —

Value of the argument

getArguments()

public getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>

getControllerActionName()

public getControllerActionName() : string
Return values
string

getControllerExtensionKey()

public getControllerExtensionKey() : string
Return values
string

getControllerExtensionName()

public getControllerExtensionName() : string
Return values
string

getControllerName()

public getControllerName() : string
Return values
string

getControllerObjectName()

public getControllerObjectName() : string
Return values
string

getFormat()

public getFormat() : string
Return values
string

getInternalArgument()

Returns the value of the specified argument

public getInternalArgument(mixed $argumentName) : mixed
Parameters
$argumentName : mixed
Return values
mixed —

Value of the argument, or NULL if not set.

getOriginalRequestMappingResults()

public getOriginalRequestMappingResults() : Result
Return values
Result

getPluginName()

public getPluginName() : string
Return values
string

getUploadedFiles()

public getUploadedFiles() : array<string|int, mixed>
Return values
array<string|int, mixed>

hasArgument()

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

public hasArgument([string $argumentName = '' ]) : bool
Parameters
$argumentName : string = ''
Return values
bool

setArgument()

public setArgument(string $argumentName, mixed $value) : self
Parameters
$argumentName : string
$value : mixed

The new value

Tags
throws
InvalidArgumentNameException
Return values
self

setArguments()

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

public setArguments(array<string, mixed> $arguments) : self
Parameters
$arguments : array<string, mixed>
Tags
throws
InvalidArgumentNameException
Return values
self

setControllerActionName()

public setControllerActionName(string $actionName) : self
Parameters
$actionName : string
Return values
self

setControllerAliasToClassNameMapping()

public setControllerAliasToClassNameMapping(array<string|int, mixed> $controllerAliasToClassNameMapping) : self
Parameters
$controllerAliasToClassNameMapping : array<string|int, mixed>
Return values
self

setControllerExtensionName()

public setControllerExtensionName(string $controllerExtensionName) : self
Parameters
$controllerExtensionName : string
Return values
self

setControllerName()

public setControllerName(string $controllerName) : self
Parameters
$controllerName : string
Return values
self

setControllerObjectName()

public setControllerObjectName(string $controllerObjectName) : self
Parameters
$controllerObjectName : string
Return values
self

setFormat()

public setFormat(string $format) : self
Parameters
$format : string
Return values
self

setOriginalRequestMappingResults()

public setOriginalRequestMappingResults(Result $originalRequestMappingResults) : self
Parameters
$originalRequestMappingResults : Result
Return values
self

setPluginName()

public setPluginName(string $pluginName) : self
Parameters
$pluginName : string
Return values
self

setUploadedFiles()

public setUploadedFiles(array<string|int, mixed> $files) : self
Parameters
$files : array<string|int, mixed>
Return values
self

validateUploadedFiles()

Recursively validate the structure in an uploaded files array.

protected validateUploadedFiles(array<string|int, mixed> $uploadedFiles) : void
Parameters
$uploadedFiles : array<string|int, mixed>
Tags
throws
InvalidArgumentException

if any leaf is not an UploadedFileInterface instance.


        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results