RequestInterface extends ServerRequestInterface

Contract for an extbase request.

Table of Contents

Methods

getArgument()  : mixed
Returns the value of the specified argument.
getArguments()  : array<string|int, mixed>
Returns an array of extbase arguments and their values.
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 object name of the controller supposed to handle this request, if one was specified 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.
getFormat()  : string
Returns the requested representation format, something like "html", "xml", "png", "json" or the like.
getPluginName()  : string
Returns the plugin key.
hasArgument()  : bool
Checks if an argument of the given name exists (is set).
withArgument()  : RequestInterface
Return an instance with the specified argument set.
withArguments()  : RequestInterface
Return an instance with the specified extbase arguments, replacing any arguments which existed before.
withControllerActionName()  : RequestInterface
Return an instance with the specified controller action name set.
withControllerExtensionName()  : RequestInterface
Return an instance with the specified controller extension name set.
withControllerName()  : RequestInterface
Return an instance with the specified controller name set.
withControllerObjectName()  : RequestInterface
Return an instance with the specified controller object name set.
withFormat()  : RequestInterface
Return an instance with the specified format.
withPluginName()  : RequestInterface
Return an instance with the specified plugin name set.

Methods

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<string|int, mixed>
Return values
array<string|int, mixed>

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 object name of the controller supposed to handle this request, if one was specified 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

getFormat()

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

public getFormat() : string
Return values
string

getPluginName()

Returns the plugin key.

public getPluginName() : string
Return values
string

hasArgument()

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

public hasArgument(string $argumentName) : bool
Parameters
$argumentName : string
Return values
bool

withArgument()

Return an instance with the specified argument set.

public withArgument(string $argumentName, mixed $value) : RequestInterface
Parameters
$argumentName : string
$value : mixed
Return values
RequestInterface

withArguments()

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

public withArguments(array<string|int, mixed> $arguments) : RequestInterface
Parameters
$arguments : array<string|int, mixed>
Return values
RequestInterface

withControllerActionName()

Return an instance with the specified controller action name set.

public withControllerActionName(string $actionName) : RequestInterface

Note that the action name must start with a lower case letter and is case-sensitive.

Parameters
$actionName : string
Return values
RequestInterface

withControllerExtensionName()

Return an instance with the specified controller extension name set.

public withControllerExtensionName(string $controllerExtensionName) : RequestInterface
Parameters
$controllerExtensionName : string
Return values
RequestInterface

withControllerName()

Return an instance with the specified controller name set.

public withControllerName(string $controllerName) : RequestInterface
Parameters
$controllerName : string
Return values
RequestInterface

withControllerObjectName()

Return an instance with the specified controller object name set.

public withControllerObjectName(string $controllerObjectName) : RequestInterface
Parameters
$controllerObjectName : string
Return values
RequestInterface

withFormat()

Return an instance with the specified format.

public withFormat(string $format) : RequestInterface

This method allows setting the format as described in getFormat().

Parameters
$format : string
Return values
RequestInterface 

        

        
    




    

    

                            

            

                        
    

        On this page

        
    


            

                    

        

    

        

            
Search results