interface RequestInterface (View source)

Contract for a dispatchable request.

Methods

void
setDispatched(bool $flag)

Sets the dispatched flag

bool
isDispatched()

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

string
getControllerObjectName()

Returns the object name of the controller which is supposed to process the request.

getMainRequest()

Returns the top level Request: the one just below the HTTP request

bool
isMainRequest()

Checks if this request is the uppermost ActionRequest, just one below the HTTP request.

Details

void setDispatched(bool $flag)

Sets the dispatched flag

Parameters

bool $flag

If this request has been dispatched

Return Value

void

bool 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.

Return Value

bool

true if this request has been dispatched successfully

string getControllerObjectName()

Returns the object name of the controller which is supposed to process the request.

Return Value

string

The controller's object name

RequestInterface getMainRequest()

Returns the top level Request: the one just below the HTTP request

Return Value

RequestInterface

bool isMainRequest()

Checks if this request is the uppermost ActionRequest, just one below the HTTP request.

Return Value

bool