abstract class HttpExceptionSubscriberBase implements EventSubscriberInterface (View source)

Utility base class for exception subscribers.

A subscriber may extend this class and implement getHandledFormats() to indicate which request formats it will respond to. Then implement an on*() method for any error code (HTTP response code) that should be handled. For example, to handle a specific error code like 404 Not Found messages add the method:

Methods

array
getHandledFormats()

Specifies the request formats this subscriber will respond to.

static int
getPriority()

Specifies the priority of all listeners in this class.

onException(ExceptionEvent $event)

Handles errors for this subscriber.

static array
getSubscribedEvents()

Registers the methods in this class that should be listeners.

Details

abstract protected array getHandledFormats()

Specifies the request formats this subscriber will respond to.

Return Value

array

An indexed array of the format machine names that this subscriber will attempt to process, such as "html" or "json". Returning an empty array will apply to all formats.

See also

Request

static protected int getPriority()

Specifies the priority of all listeners in this class.

The default priority is 1, which is very low. To have listeners that have a "first attempt" at handling exceptions return a higher priority.

Return Value

int

The event priority of this subscriber.

onException(ExceptionEvent $event)

Handles errors for this subscriber.

Parameters

ExceptionEvent $event

The event to process.

static array getSubscribedEvents()

Registers the methods in this class that should be listeners.

Return Value

array

An array of event listener definitions.