TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
RequestInterface Interface Reference
Inheritance diagram for RequestInterface:
Request Request Request ReferringRequest WidgetRequest

Public Member Functions

 setDispatched ($flag)
 
 isDispatched ()
 
 getControllerObjectName ()
 
 setArgument ($argumentName, $value)
 
 setArguments (array $arguments)
 
 getArgument ($argumentName)
 
 hasArgument ($argumentName)
 
 getArguments ()
 

Detailed Description

Contract for a request.

Definition at line 22 of file RequestInterface.php.

Member Function Documentation

getArgument (   $argumentName)

Returns the value of the specified argument

Parameters
string$argumentNameName of the argument
Returns
string Value of the argument
Exceptions
TYPO3 if such an argument does not exist

Implemented in Request, and Request.

getArguments ( )

Returns an array of arguments and their values

Returns
array Array of arguments and their values (which may be arguments and values as well)

Implemented in Request, and Request.

getControllerObjectName ( )

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

Returns
string The controller's Object Name
Exceptions
TYPO3 if the controller does not exist

Implemented in Request, and Request.

hasArgument (   $argumentName)

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

Parameters
string$argumentNameName of the argument to check
Returns
bool TRUE if the argument is set, otherwise FALSE

Implemented in Request, and Request.

isDispatched ( )

If this request has been dispatched and addressed by the responsible controller and the response is ready to be sent.

The dispatcher will try to dispatch the request again if it has not been addressed yet.

Returns
bool TRUE if this request has been disptached successfully

Implemented in Request, and Request.

setArgument (   $argumentName,
  $value 
)

Sets the value of the specified argument

Parameters
string$argumentNameName of the argument to set
mixed$valueThe new value
Returns
void

Implemented in Request, Request, and ReferringRequest.

setArguments ( array  $arguments)

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

Parameters
array$argumentsAn array of argument names and their values
Returns
void

Implemented in Request, and Request.

setDispatched (   $flag)

Sets the dispatched flag

Parameters
bool$flagIf this request has been dispatched
Returns
void

Implemented in Request, and Request.