RequestBuilder implements SingletonInterface
Builds a web request.
only to be used within Extbase, not part of TYPO3 Core API.
Table of Contents
Interfaces
- SingletonInterface
- "empty" interface for singletons (marker interface pattern)
Properties
- $allowedControllerActions : array<string|int, mixed>
- The allowed actions of the controller. This actions can be called via $_GET and $_POST.
- $configurationManager : ConfigurationManagerInterface
- $defaultControllerName : string
- The default controller name
- $defaultFormat : string
- The default format of the response object
- $extensionName : string
- The name of the extension (in UpperCamelCase)
- $extensionService : ExtensionService
- $pluginName : string
- This is a unique key for a plugin (not the extension key!)
Methods
- build() : Request
- Builds a web request object from the raw HTTP information and the configuration
- injectConfigurationManager() : mixed
- injectExtensionService() : mixed
- calculateFieldPaths() : array<string|int, mixed>
- Returns an array of all possibles "field paths" for the given array.
- loadDefaultValues() : mixed
- resolveActionName() : string
- Returns the current actionName extracted from given $parameters.
- resolveControllerClassName() : string
- Returns the current ControllerName extracted from given $parameters.
- untangleFilesArray() : array<string|int, mixed>
- Transforms the convoluted _FILES superglobal into a manageable form.
Properties
$allowedControllerActions
The allowed actions of the controller. This actions can be called via $_GET and $_POST.
protected
array<string|int, mixed>
$allowedControllerActions
= []
$configurationManager
protected
ConfigurationManagerInterface
$configurationManager
$defaultControllerName
The default controller name
protected
string
$defaultControllerName
= ''
$defaultFormat
The default format of the response object
protected
string
$defaultFormat
= 'html'
$extensionName
The name of the extension (in UpperCamelCase)
protected
string
$extensionName
$extensionService
protected
ExtensionService
$extensionService
$pluginName
This is a unique key for a plugin (not the extension key!)
protected
string
$pluginName
= 'plugin'
Methods
build()
Builds a web request object from the raw HTTP information and the configuration
public
build(ServerRequestInterface $mainRequest) : Request
Parameters
- $mainRequest : ServerRequestInterface
Return values
Request —The web request as an object
injectConfigurationManager()
public
injectConfigurationManager(ConfigurationManagerInterface $configurationManager) : mixed
Parameters
- $configurationManager : ConfigurationManagerInterface
injectExtensionService()
public
injectExtensionService(ExtensionService $extensionService) : mixed
Parameters
- $extensionService : ExtensionService
calculateFieldPaths()
Returns an array of all possibles "field paths" for the given array.
protected
calculateFieldPaths(array<string|int, mixed> $structure[, string $firstLevelFieldName = null ]) : array<string|int, mixed>
Parameters
- $structure : array<string|int, mixed>
-
The array to walk through
- $firstLevelFieldName : string = null
Return values
array<string|int, mixed> —An array of paths (as strings) in the format "key1/key2/key3" ...
loadDefaultValues()
protected
loadDefaultValues() : mixed
Tags
resolveActionName()
Returns the current actionName extracted from given $parameters.
protected
resolveActionName(string $controllerClassName, array<string|int, mixed> $parameters) : string
If no action is specified, the defaultActionName will be returned. If that's not available or the specified action is not defined in the current plugin, an exception is thrown.
Parameters
- $controllerClassName : string
- $parameters : array<string|int, mixed>
Tags
Return values
stringresolveControllerClassName()
Returns the current ControllerName extracted from given $parameters.
protected
resolveControllerClassName(array<string|int, mixed> $parameters) : string
If no controller is specified, the defaultControllerName will be returned. If that's not available, an exception is thrown.
Parameters
- $parameters : array<string|int, mixed>
Tags
Return values
stringuntangleFilesArray()
Transforms the convoluted _FILES superglobal into a manageable form.
protected
untangleFilesArray(array<string|int, mixed> $convolutedFiles) : array<string|int, mixed>
Parameters
- $convolutedFiles : array<string|int, mixed>
-
The _FILES superglobal
Return values
array<string|int, mixed> —Untangled files