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

GetResponseForExceptionEvent

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

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

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, 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

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

Exception getException()

Returns the thrown exception.

Return Value

Exception The thrown exception

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

allowCustomResponseCode()

Mark the event as allowing a custom response code.

bool isAllowingCustomResponseCode()

Returns true if the event allows a custom response code.

Return Value

bool