W3cubDocs

/Symfony 2.8

Symfony\Component\HttpKernel\Event\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)

Stores the EventDispatcher that dispatches this Event.

from Event
EventDispatcherInterface getDispatcher()

Returns the EventDispatcher that dispatches this Event.

from Event
string getName()

Gets the event's name.

from Event
setName(string $name)

Sets the event's name property.

from Event
__construct(HttpKernelInterface $kernel, Request $request, $requestType, Exception $e)
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

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

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

public setDispatcher(EventDispatcherInterface $dispatcher)

Stores the EventDispatcher that dispatches this Event.

Parameters

EventDispatcherInterface $dispatcher

public EventDispatcherInterface getDispatcher()

Returns the EventDispatcher that dispatches this Event.

public string getName()

Gets the event's name.

Return Value

string

public setName(string $name)

Sets the event's name property.

Parameters

string $name The event name.

public __construct(HttpKernelInterface $kernel, Request $request, $requestType, Exception $e)

Parameters

HttpKernelInterface $kernel
Request $request
$requestType
Exception $e

public HttpKernelInterface getKernel()

Returns the kernel in which this event was thrown.

Return Value

HttpKernelInterface

public Request getRequest()

Returns the request the kernel is currently processing.

Return Value

Request

public int getRequestType()

Returns the request type the kernel is currently processing.

Return Value

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

public bool isMasterRequest()

Checks if this is a master request.

Return Value

bool True if the request is a master request

public Response getResponse()

Returns the response object.

Return Value

Response

public setResponse(Response $response)

Sets a response and stops event propagation.

Parameters

Response $response

public bool hasResponse()

Returns whether a response was set.

Return Value

bool Whether a response was set

public Exception getException()

Returns the thrown exception.

Return Value

Exception The thrown exception

public 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

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/HttpKernel/Event/GetResponseForExceptionEvent.html