Getters

getPageRenderer
get
getMethod
getAllowedUserGroups_function
getUserGroups
getResponseParameters
getResponseParameter
getFormat
getRoute
getPath
getContext
getPageInformation
getJSONFlags
getAllowedMethods
getBlockSize
getFileRedirect
getFileRedirectMask
getFileRedirectRelDir
getCsrfToken
getImportmapEntry

getPageRenderer

Returns the PageRenderer instance.
@return PageRenderer

getPageRenderer(): PageRenderer

get

Retrieves a parameter from the request input data.
Checks POST or GET data depending on the request method.
@param string $parameter Parameter name to retrieve
@return mixed|null Parameter value if found, or null if not present

get(string $parameter): mixed

Example:

$parameter = $this->get('magicNumber');

getMethod

Gets the HTTP request method.
@param bool $lowercase Return method name in lowercase if true, uppercase otherwise
@return string HTTP method

getMethod(bool $lowercase = false): string

getAllowedUserGroups_function

Retrieves the allowed user groups for the current route.
@return array Array of allowed user group identifiers

getAllowedUserGroups(): array

getUserGroups

Retrieves the user groups of the currently authenticated user.
@return array Array of user group identifiers

getUserGroups(): array

getResponseParameters

Returns all accumulated response parameters.
@return array Associative array of response parameters

getResponseParameters(): array

getResponseParameter

Retrieves a single response parameter by key.
@param string $key Parameter key to retrieve
@return mixed|null Returns the parameter value if set, or null if not found

getResponseParameter(string $key): mixed

getFormat

Gets the configured format for the current route.
@return string|null Format string (e.g., 'html', 'json') or null if not set

getFormat(): ?string

getRoute

Returns the current RouteObject instance associated with this controller.
@return RouteObject The route object

getRoute(): RouteObject

getPath

Retrieves the current request URI path.
@return string URI path of the request

getPath(): string

getContext

Retrieves the current TYPO3 context identifier from server parameters.
@return string|null TYPO3 context string or null if not set

getContext(): ?string

getPageInformation

Returns information about the current page, if available.
@return PageInformation|null Page information object or null if not set

getPageInformation(): ?PageInformation

getJSONFlags

Gets the current JSON encoding flags.
@return int JSON encoding bitmask flags

getJSONFlags(): int

getAllowedMethods

Returns the list of allowed HTTP methods for this request.
@return array|null Array of allowed methods or null if not restricted

getAllowedMethods(): ?array

getBlockSize

Returns the configured block size used when streaming files.
@return int|null Block size in bytes or null if unset

getBlockSize(): ?int

getFileRedirect

Gets the configured file redirect type.
@return int File redirect type constant (NONE, APACHE, NGINX)

getFileRedirect(): int

These constants are used by the file response method.

ConstantDefinition
FILE_REDIRECT_NONECould not get server information or architecture is neither APACHE nor NGINX
FILE_REDIRECT_APACHEServer is APACHE
FILE_REDIRECT_NGINXServer is NGINX

getFileRedirectMask

Gets the file redirect mask path for Nginx X-Accel-Redirect.
@return string|null Mask path string or null if unset

getFileRedirectMask(): ?string

getFileRedirectRelDir

Gets the relative directory path for Nginx X-Accel-Redirect file handling.
@return string|null Relative directory path or null if unset

getFileRedirectRelDir(): ?string

getCsrfToken

Returns the current CSRF token string.
@return string CSRF token value

getCsrfToken(): string

getImportmapEntry

Retrieves the path of the given key or null.
 

@param string $key Key of the entry
@param int $moduleSpecifierKey The import map section to search in (default: self::IMPORTMAP_IMPORTS)
@return string|null The path or null if entry does not exist

protected function getImportmapEntry(string $key, int $moduleSpecifierKey = self::IMPORTMAP_IMPORTS): string|null

See: addImportmapEntry() for a full list of moduleSpecifierKey values.