DefaultExceptionSubscriber
class DefaultExceptionSubscriber extends DefaultExceptionSubscriber (View source)
| internal | JSON:API maintains no PHP API. The API is the HTTP API. This class may change at any time and could break any dependencies on it. |
Serializes exceptions in compliance with the JSON:API specification.
Properties
| protected Serializer | $serializer | The serializer. |
from DefaultExceptionSubscriber |
| protected array | $serializerFormats | The available serialization formats. |
from DefaultExceptionSubscriber |
Methods
Specifies the request formats this subscriber will respond to.
Specifies the priority of all listeners in this class.
Handles errors for this subscriber.
Registers the methods in this class that should be listeners.
DefaultExceptionSubscriber constructor.
Handles all 4xx errors for all serialization failures.
{@inheritdoc}
Check if the error should be formatted using JSON:API.
Details
protected array
getHandledFormats()
Specifies the request formats this subscriber will respond to.
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.
onException(ExceptionEvent $event)
Handles errors for this subscriber.
static array
getSubscribedEvents()
Registers the methods in this class that should be listeners.
__construct(SerializerInterface $serializer, array $serializer_formats)
DefaultExceptionSubscriber constructor.
on4xx(ExceptionEvent $event)
Handles all 4xx errors for all serialization failures.
protected
setEventResponse(ExceptionEvent $event, $status)
{@inheritdoc}
protected bool
isJsonApiExceptionEvent(ExceptionEvent $exception_event)
Check if the error should be formatted using JSON:API.
The JSON:API format is supported if the format is explicitly set or the request is for a known JSON:API route.