class GetResponseForControllerResultEvent extends GetResponseEvent

Allows to create a response for the return value of a controller.

Call setResponse() to set the response that will be returned for the current request. The propagation of this event is stopped as soon as a response is set.

Methods

bool
isPropagationStopped()

Returns whether further event listeners should be triggered.

from Event
stopPropagation()

Stops the propagation of the event to further event listeners.

from Event
__construct(HttpKernelInterface $kernel, Request $request, int $requestType, $controllerResult)

No description

getKernel()

Returns the kernel in which this event was thrown.

getRequest()

Returns the request the kernel is currently processing.

int
getRequestType()

Returns the request type the kernel is currently processing.

bool
isMasterRequest()

Checks if this is a master request.

Response
getResponse()

Returns the response object.

setResponse(Response $response)

Sets a response and stops event propagation.

bool
hasResponse()

Returns whether a response was set.

mixed
getControllerResult()

Returns the return value of the controller.

setControllerResult(mixed $controllerResult)

Assigns the return value of the controller.

Details

in Event at line line 42
bool isPropagationStopped()

Returns whether further event listeners should be triggered.

Return Value

bool Whether propagation was already stopped for this event

See also

Event::stopPropagation()

in Event at line line 54
stopPropagation()

Stops the propagation of the event to further event listeners.

If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().

at line line 35
__construct(HttpKernelInterface $kernel, Request $request, int $requestType, $controllerResult)

Parameters

HttpKernelInterface $kernel The kernel in which this event was thrown
Request $request The request the kernel is currently processing
int $requestType The request type the kernel is currently processing; one of HttpKernelInterface::MASTERREQUEST or HttpKernelInterface::SUBREQUEST
$controllerResult

in KernelEvent at line line 47
HttpKernelInterface getKernel()

Returns the kernel in which this event was thrown.

Return Value

HttpKernelInterface

in KernelEvent at line line 57
Request getRequest()

Returns the request the kernel is currently processing.

Return Value

Request

in KernelEvent at line line 68
int getRequestType()

Returns the request type the kernel is currently processing.

Return Value

int One of HttpKernelInterface::MASTERREQUEST and HttpKernelInterface::SUBREQUEST

in KernelEvent at line line 78
bool isMasterRequest()

Checks if this is a master request.

Return Value

bool True if the request is a master request

in GetResponseEvent at line line 34
Response getResponse()

Returns the response object.

Return Value

Response

in GetResponseEvent at line line 42
setResponse(Response $response)

Sets a response and stops event propagation.

Parameters

Response $response

in GetResponseEvent at line line 54
bool hasResponse()

Returns whether a response was set.

Return Value

bool Whether a response was set

at line line 47
mixed getControllerResult()

Returns the return value of the controller.

Return Value

mixed The controller return value

at line line 57
setControllerResult(mixed $controllerResult)

Assigns the return value of the controller.

Parameters

mixed $controllerResult The controller return value