Request

class \TYPO3\CMS\Extbase\Mvc\Request

Implements
RequestInterface

The extbase request.

This is a decorator: The core PSR-7 request is hand over as constructor argument, this class implements ServerRequestInterface, too. Additionally, the extbase request details are attached as 'extbase' attribute to the PSR-7 request and this class implements extbase RequestInterface. This class has no state except the PSR-7 request, all operations are hand down to the PSR-7 request.

Table of Contents

Interfaces

RequestInterface
Contract for an extbase request.

Properties

$request  : ServerRequestInterface

Methods

__construct()  : mixed
getArgument()  : mixed
Returns the value of the specified argument.
getArguments()  : array
Returns an array of extbase arguments and their values.
getAttribute()  : mixed
getAttributes()  : array
getBody()  : StreamInterface
getControllerActionName()  : string
Returns the name of the action the controller is supposed to execute.
getControllerExtensionKey()  : string
Returns the extension key of the specified controller.
getControllerExtensionName()  : string
Returns the extension name of the specified controller.
getControllerName()  : string
Returns the controller name supposed to handle this request, if one was set already (if not, the name of the default controller is returned)
getControllerObjectName()  : string
Returns the object name of the controller defined by the package key and controller name.
getCookieParams()  : array
getFormat()  : string
Returns the requested representation format, something like "html", "xml", "png", "json" or the like.
getHeader()  : array
getHeaderLine()  : string
getHeaders()  : array
getMethod()  : string
getParsedBody()  : mixed
getPluginName()  : string
Returns the plugin key.
getProtocolVersion()  : string
Methods implementing MessageInterface
getQueryParams()  : array
getRequestTarget()  : string
Methods implementing RequestInterface
getServerParams()  : array
Methods implementing ServerRequestInterface
getUploadedFiles()  : array
getUri()  : UriInterface
hasArgument()  : bool
Checks if an argument of the given name exists (is set).
hasHeader()  : bool
withAddedHeader()  : static
withArgument()  : static
Return an instance with the specified argument set.
withArguments()  : static
Return an instance with the specified extbase arguments, replacing any arguments which existed before.
withAttribute()  : static
withBody()  : static
withControllerActionName()  : static
Return an instance with the specified controller action name set.
withControllerExtensionName()  : static
Return an instance with the specified controller extension name set.
withControllerName()  : static
Return an instance with the specified controller name set.
withControllerObjectName()  : static
Return an instance with the specified controller object name set.
withCookieParams()  : static
withFormat()  : static
Return an instance with the specified derived request attribute.
withHeader()  : static
withMethod()  : static
withoutAttribute()  : ($name is "extbase" ? ServerRequestInterface : static)
withoutHeader()  : static
withParsedBody()  : static
withPluginName()  : static
Return an instance with the specified plugin name set.
withProtocolVersion()  : static
withQueryParams()  : static
withRequestTarget()  : static
withUploadedFiles()  : static
withUri()  : static
getExtbaseAttribute()  : ExtbaseRequestParameters
ExtbaseAttribute attached as attribute 'extbase' to $request carries extbase specific request values. This helper method type hints this attribute.

Properties

$request

protected ServerRequestInterface $request

Methods

__construct()

public final __construct(ServerRequestInterface $request) : mixed

Parameters

$request : ServerRequestInterface

getArgument()

Returns the value of the specified argument.

public getArgument(string $argumentName) : mixed

Parameters

$argumentName : string

getArguments()

Returns an array of extbase arguments and their values.

public getArguments() : array

Return values

array

getAttribute()

public getAttribute(mixed $name[, mixed $default = null ]) : mixed

Parameters

$name : mixed
$default : mixed = null

getAttributes()

public getAttributes() : array

Return values

array

getBody()

public getBody() : StreamInterface

Return values

StreamInterface

getControllerActionName()

Returns the name of the action the controller is supposed to execute.

public getControllerActionName() : string

Return values

string

getControllerExtensionKey()

Returns the extension key of the specified controller.

public getControllerExtensionKey() : string

Return values

string

getControllerExtensionName()

Returns the extension name of the specified controller.

public getControllerExtensionName() : string

Return values

string

getControllerName()

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

public getControllerName() : string

Return values

string

getControllerObjectName()

Returns the object name of the controller defined by the package key and controller name.

public getControllerObjectName() : string

Return values

string

getCookieParams()

public getCookieParams() : array

Return values

array

getFormat()

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

public getFormat() : string

Return values

string

getHeader()

public getHeader(mixed $name) : array

Parameters

$name : mixed

Return values

array

getHeaderLine()

public getHeaderLine(mixed $name) : string

Parameters

$name : mixed

Return values

string

getHeaders()

public getHeaders() : array

Return values

array

getMethod()

public getMethod() : string

Return values

string

getParsedBody()

public getParsedBody() : mixed

getPluginName()

Returns the plugin key.

public getPluginName() : string

Return values

string

getProtocolVersion()

Methods implementing MessageInterface

public getProtocolVersion() : string

Return values

string

getQueryParams()

public getQueryParams() : array

Return values

array

getRequestTarget()

Methods implementing RequestInterface

public getRequestTarget() : string

Return values

string

getServerParams()

Methods implementing ServerRequestInterface

public getServerParams() : array

Return values

array

getUploadedFiles()

public getUploadedFiles() : array

Return values

array

getUri()

public getUri() : UriInterface

Return values

UriInterface

hasArgument()

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

public hasArgument(string $argumentName) : bool

Parameters

$argumentName : string

Return values

bool

hasHeader()

public hasHeader(mixed $name) : bool

Parameters

$name : mixed

Return values

bool

withAddedHeader()

public withAddedHeader(mixed $name, mixed $value) : static

Parameters

$name : mixed
$value : mixed

Return values

static

withArgument()

Return an instance with the specified argument set.

public withArgument(string $argumentName, mixed $value) : static

Parameters

$argumentName : string
$value : mixed

Return values

static

withArguments()

Return an instance with the specified extbase arguments, replacing any arguments which existed before.

public withArguments(array $arguments) : static

Parameters

$arguments : array

Return values

static

withAttribute()

public withAttribute(mixed $name, mixed $value) : static

Parameters

$name : mixed
$value : mixed

Return values

static

withBody()

public withBody(StreamInterface $body) : static

Parameters

$body : StreamInterface

Return values

static

withControllerActionName()

Return an instance with the specified controller action name set.

public withControllerActionName(string $actionName) : static

Parameters

$actionName : string

Return values

static

withControllerExtensionName()

Return an instance with the specified controller extension name set.

public withControllerExtensionName(string $controllerExtensionName) : static

Parameters

$controllerExtensionName : string

Return values

static

withControllerName()

Return an instance with the specified controller name set.

public withControllerName(string $controllerName) : static

Parameters

$controllerName : string

Return values

static

withControllerObjectName()

Return an instance with the specified controller object name set.

public withControllerObjectName(string $controllerObjectName) : static

Parameters

$controllerObjectName : string

Return values

static

withCookieParams()

public withCookieParams(array $cookies) : static

Parameters

$cookies : array

Return values

static

withFormat()

Return an instance with the specified derived request attribute.

public withFormat(string $format) : static

This method allows setting a single derived request attribute as described in getFormat().

Parameters

$format : string

Return values

static

withHeader()

public withHeader(mixed $name, mixed $value) : static

Parameters

$name : mixed
$value : mixed

Return values

static

withMethod()

public withMethod(mixed $method) : static

Parameters

$method : mixed

Return values

static

withoutAttribute()

public withoutAttribute(mixed $name) : ($name is "extbase" ? ServerRequestInterface : static)

Parameters

$name : mixed

Return values

($name is "extbase" ? ServerRequestInterface : static)

withoutHeader()

public withoutHeader(mixed $name) : static

Parameters

$name : mixed

Return values

static

withParsedBody()

public withParsedBody(mixed $data) : static

Parameters

$data : mixed

Return values

static

withPluginName()

Return an instance with the specified plugin name set.

public withPluginName(string $pluginName) : static

Parameters

$pluginName : string

Return values

static

withProtocolVersion()

public withProtocolVersion(mixed $version) : static

Parameters

$version : mixed

Return values

static

withQueryParams()

public withQueryParams(array $query) : static

Parameters

$query : array

Return values

static

withRequestTarget()

public withRequestTarget(mixed $requestTarget) : static

Parameters

$requestTarget : mixed

Return values

static

withUploadedFiles()

public withUploadedFiles(array $uploadedFiles) : static

Parameters

$uploadedFiles : array

Return values

static

withUri()

public withUri(UriInterface $uri[, mixed $preserveHost = false ]) : static

Parameters

$uri : UriInterface
$preserveHost : mixed = false

Return values

static
On this page