class GetResponseForExceptionEvent extends GetResponseEvent

Allows to create a response for a thrown exception.

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.

You can also call setException() to replace the thrown exception. This exception will be thrown if no response is set during processing of this event.

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, Exception $e)

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|null
getResponse()

Returns the response object.

setResponse(Response $response)

Sets a response and stops event propagation.

bool
hasResponse()

Returns whether a response was set.

getException()

Returns the thrown exception.

setException(Exception $exception)

Replaces the thrown exception.

allowCustomResponseCode()

Mark the event as allowing a custom response code.

bool
isAllowingCustomResponseCode()

Returns true if the event allows a custom response code.

Details

in Event at 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 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 44
__construct(HttpKernelInterface $kernel, Request $request, int|null $requestType, Exception $e)

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
Exception $e

in KernelEvent at line 47
HttpKernelInterface getKernel()

Returns the kernel in which this event was thrown.

Return Value

HttpKernelInterface

in KernelEvent at line 57
Request getRequest()

Returns the request the kernel is currently processing.

Return Value

Request

in KernelEvent at line 68
int getRequestType()

Returns the request type the kernel is currently processing.

Return Value

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

in KernelEvent at 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 34
Response|null getResponse()

Returns the response object.

Return Value

Response|null

in GetResponseEvent at line 42
setResponse(Response $response)

Sets a response and stops event propagation.

Parameters

Response $response

in GetResponseEvent at line 54
bool hasResponse()

Returns whether a response was set.

Return Value

bool Whether a response was set

at line 56
Exception getException()

Returns the thrown exception.

Return Value

Exception The thrown exception

at line 68
setException(Exception $exception)

Replaces the thrown exception.

This exception will be thrown if no response is set in the event.

Parameters

Exception $exception The thrown exception

at line 76
allowCustomResponseCode()

Mark the event as allowing a custom response code.

at line 86
bool isAllowingCustomResponseCode()

Returns true if the event allows a custom response code.

Return Value

bool