class DefaultExceptionSubscriber
Serializes exceptions in compliance with the JSON:API specification.
@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.
Hierarchy
- class \Drupal\Core\EventSubscriber\HttpExceptionSubscriberBase implements \Symfony\Component\EventDispatcher\EventSubscriberInterface
- class \Drupal\serialization\EventSubscriber\DefaultExceptionSubscriber extends \Drupal\Core\EventSubscriber\HttpExceptionSubscriberBase
- class \Drupal\jsonapi\EventSubscriber\DefaultExceptionSubscriber extends \Drupal\serialization\EventSubscriber\DefaultExceptionSubscriber
 
 
 - class \Drupal\serialization\EventSubscriber\DefaultExceptionSubscriber extends \Drupal\Core\EventSubscriber\HttpExceptionSubscriberBase
 
Expanded class hierarchy of DefaultExceptionSubscriber
See also
https://www.drupal.org/project/drupal/issues/3032787
1 string reference to 'DefaultExceptionSubscriber'
- jsonapi.services.yml in core/
modules/ jsonapi/ jsonapi.services.yml  - core/modules/jsonapi/jsonapi.services.yml
 
1 service uses DefaultExceptionSubscriber
File
- 
              core/
modules/ jsonapi/ src/ EventSubscriber/ DefaultExceptionSubscriber.php, line 25  
Namespace
Drupal\jsonapi\EventSubscriberView source
class DefaultExceptionSubscriber extends SerializationDefaultExceptionSubscriber {
  
  /**
   * {@inheritdoc}
   */
  protected static function getPriority() {
    return parent::getPriority() + 25;
  }
  
  /**
   * {@inheritdoc}
   */
  protected function getHandledFormats() {
    return [
      'api_json',
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function onException(ExceptionEvent $event) {
    if (!$this->isJsonApiExceptionEvent($event)) {
      return;
    }
    if (($exception = $event->getThrowable()) && !$exception instanceof HttpException) {
      $exception = new HttpException(500, $exception->getMessage(), $exception);
      $event->setThrowable($exception);
    }
    $this->setEventResponse($event, $exception->getStatusCode());
  }
  
  /**
   * {@inheritdoc}
   */
  protected function setEventResponse(ExceptionEvent $event, $status) {
    /** @var \Symfony\Component\HttpKernel\Exception\HttpException $exception */
    $exception = $event->getThrowable();
    $document = new JsonApiDocumentTopLevel(new ErrorCollection([
      $exception,
    ]), new NullIncludedData(), new LinkCollection([]));
    if ($event->getRequest()
      ->isMethodCacheable()) {
      $response = new CacheableResourceResponse($document, $exception->getStatusCode(), $exception->getHeaders());
      $response->addCacheableDependency($exception);
    }
    else {
      $response = new ResourceResponse($document, $exception->getStatusCode(), $exception->getHeaders());
    }
    $event->setResponse($response);
  }
  
  /**
   * 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.
   *
   * @param \Symfony\Component\HttpKernel\Event\ExceptionEvent $exception_event
   *   The exception event.
   *
   * @return bool
   *   TRUE if it needs to be formatted using JSON:API. FALSE otherwise.
   */
  protected function isJsonApiExceptionEvent(ExceptionEvent $exception_event) {
    $request = $exception_event->getRequest();
    $parameters = $request->attributes
      ->all();
    return $request->getRequestFormat() === 'api_json' || (bool) Routes::getResourceTypeNameFromParameters($parameters);
  }
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| DefaultExceptionSubscriber::$serializer | protected | property | The serializer. | ||
| DefaultExceptionSubscriber::$serializerFormats | protected | property | The available serialization formats. | ||
| DefaultExceptionSubscriber::getHandledFormats | protected | function | Specifies the request formats this subscriber will respond to. | Overrides DefaultExceptionSubscriber::getHandledFormats | |
| DefaultExceptionSubscriber::getPriority | protected static | function | Specifies the priority of all listeners in this class. | Overrides DefaultExceptionSubscriber::getPriority | |
| DefaultExceptionSubscriber::isJsonApiExceptionEvent | protected | function | Check if the error should be formatted using JSON:API. | ||
| DefaultExceptionSubscriber::on4xx | public | function | Handles all 4xx errors for all serialization failures. | ||
| DefaultExceptionSubscriber::onException | public | function | Handles errors for this subscriber. | Overrides HttpExceptionSubscriberBase::onException | |
| DefaultExceptionSubscriber::setEventResponse | protected | function | |||
| DefaultExceptionSubscriber::__construct | public | function | DefaultExceptionSubscriber constructor. | ||
| HttpExceptionSubscriberBase::getSubscribedEvents | public static | function | Registers the methods in this class that should be listeners. | 1 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.