1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. HttpKernel
  7. \
  8. Event
  9. \
  10. GetResponseForControllerResultEvent

GetResponseForControllerResultEvent

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|null $requestType, $controllerResult)

No description

HttpKernelInterface
getKernel()

Returns the kernel in which this event was thrown.

from KernelEvent
Request
getRequest()

Returns the request the kernel is currently processing.

from KernelEvent
int
getRequestType()

Returns the request type the kernel is currently processing.

from KernelEvent
bool
isMasterRequest()

Checks if this is a master request.

from KernelEvent
Response|null
getResponse()

Returns the response object.

from GetResponseEvent
setResponse(Response $response)

Sets a response and stops event propagation.

from GetResponseEvent
bool
hasResponse()

Returns whether a response was set.

from GetResponseEvent
mixed
getControllerResult()

Returns the return value of the controller.

setControllerResult(mixed $controllerResult)

Assigns the return value of the controller.

Details

bool isPropagationStopped()

Returns whether further event listeners should be triggered.

Return Value

bool Whether propagation was already stopped for this event

See also

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().

__construct(HttpKernelInterface $kernel, Request $request, int|null $requestType, $controllerResult)

Parameters

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

HttpKernelInterface getKernel()

Returns the kernel in which this event was thrown.

Return Value

HttpKernelInterface

Request getRequest()

Returns the request the kernel is currently processing.

Return Value

Request

int getRequestType()

Returns the request type the kernel is currently processing.

Return Value

int One of HttpKernelInterface::MASTER_REQUEST and HttpKernelInterface::SUB_REQUEST

bool isMasterRequest()

Checks if this is a master request.

Return Value

bool True if the request is a master request

Response|null getResponse()

Returns the response object.

Return Value

Response|null

setResponse(Response $response)

Sets a response and stops event propagation.

Parameters

Response $response

bool hasResponse()

Returns whether a response was set.

Return Value

bool Whether a response was set

mixed getControllerResult()

Returns the return value of the controller.

Return Value

mixed The controller return value

setControllerResult(mixed $controllerResult)

Assigns the return value of the controller.

Parameters

mixed $controllerResult The controller return value