class RequestStack

Request stack that controls the lifecycle of requests.

Methods

push(Request $request)

Pushes a Request on the stack.

Request|null
pop()

Pops the current request from the stack.

Request|null
getCurrentRequest()

No description

Request|null
getMasterRequest()

Gets the master Request.

Request|null
getParentRequest()

Returns the parent request of the current.

Details

push(Request $request)

Pushes a Request on the stack.

This method should generally not be called directly as the stack management should be taken care of by the application itself.

Parameters

Request $request

Request|null pop()

Pops the current request from the stack.

This operation lets the current request go out of scope.

This method should generally not be called directly as the stack management should be taken care of by the application itself.

Return Value

Request|null

Request|null getCurrentRequest()

Return Value

Request|null

Request|null getMasterRequest()

Gets the master Request.

Be warned that making your code aware of the master request might make it un-compatible with other features of your framework like ESI support.

Return Value

Request|null

Request|null getParentRequest()

Returns the parent request of the current.

Be warned that making your code aware of the parent request might make it un-compatible with other features of your framework like ESI support.

If current Request is the master request, it returns null.

Return Value

Request|null