1. class
  2. Symfony
  3. Component
  4. HttpKernel
  5. Event
  6. 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
setDispatcher(EventDispatcherInterface $dispatcher) deprecated

Stores the EventDispatcher that dispatches this Event.

from Event
EventDispatcherInterface
getDispatcher() deprecated

Returns the EventDispatcher that dispatches this Event.

from Event
string
getName() deprecated

Gets the event's name.

from Event
setName(string $name) deprecated

Sets the event's name property.

from Event
__construct(HttpKernelInterface $kernel, Request $request, $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
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.

Details

in Event at line line 52
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 64
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().

in Event at line line 76
setDispatcher(EventDispatcherInterface $dispatcher) deprecated

deprecated since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.

Stores the EventDispatcher that dispatches this Event.

Parameters

EventDispatcherInterface $dispatcher

in Event at line line 88
EventDispatcherInterface getDispatcher() deprecated

deprecated since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.

Returns the EventDispatcher that dispatches this Event.

Return Value

EventDispatcherInterface

in Event at line line 102
string getName() deprecated

deprecated since version 2.4, to be removed in 3.0. The event name is passed to the listener call.

Gets the event's name.

Return Value

string

in Event at line line 116
setName(string $name) deprecated

deprecated since version 2.4, to be removed in 3.0. The event name is passed to the listener call.

Sets the event's name property.

Parameters

string $name The event name.

at line line 39
__construct(HttpKernelInterface $kernel, Request $request, $requestType, Exception $e)

Parameters

HttpKernelInterface $kernel
Request $request
$requestType
Exception $e

in KernelEvent at line line 59
HttpKernelInterface getKernel()

Returns the kernel in which this event was thrown.

Return Value

HttpKernelInterface

in KernelEvent at line line 69
Request getRequest()

Returns the request the kernel is currently processing.

Return Value

Request

in KernelEvent at line line 80
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 90
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 39
Response getResponse()

Returns the response object.

Return Value

Response

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

Sets a response and stops event propagation.

Parameters

Response $response

in GetResponseEvent at line line 61
bool hasResponse()

Returns whether a response was set.

Return Value

bool Whether a response was set

at line line 51
Exception getException()

Returns the thrown exception.

Return Value

Exception The thrown exception

at line line 63
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