Chris@18: <?php
Chris@18: 
Chris@18: namespace Drupal\jsonapi\EventSubscriber;
Chris@18: 
Chris@18: use Drupal\jsonapi\JsonApiResource\ErrorCollection;
Chris@18: use Drupal\jsonapi\JsonApiResource\JsonApiDocumentTopLevel;
Chris@18: use Drupal\jsonapi\JsonApiResource\LinkCollection;
Chris@18: use Drupal\jsonapi\JsonApiResource\NullIncludedData;
Chris@18: use Drupal\jsonapi\ResourceResponse;
Chris@18: use Drupal\jsonapi\Routing\Routes;
Chris@18: use Drupal\serialization\EventSubscriber\DefaultExceptionSubscriber as SerializationDefaultExceptionSubscriber;
Chris@18: use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
Chris@18: use Symfony\Component\HttpKernel\Exception\HttpException;
Chris@18: 
Chris@18: /**
Chris@18:  * Serializes exceptions in compliance with the  JSON:API specification.
Chris@18:  *
Chris@18:  * @internal JSON:API maintains no PHP API. The API is the HTTP API. This class
Chris@18:  *   may change at any time and could break any dependencies on it.
Chris@18:  *
Chris@18:  * @see https://www.drupal.org/project/jsonapi/issues/3032787
Chris@18:  * @see jsonapi.api.php
Chris@18:  */
Chris@18: class DefaultExceptionSubscriber extends SerializationDefaultExceptionSubscriber {
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected static function getPriority() {
Chris@18:     return parent::getPriority() + 25;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function getHandledFormats() {
Chris@18:     return ['api_json'];
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function onException(GetResponseForExceptionEvent $event) {
Chris@18:     if (!$this->isJsonApiExceptionEvent($event)) {
Chris@18:       return;
Chris@18:     }
Chris@18:     if (($exception = $event->getException()) && !$exception instanceof HttpException) {
Chris@18:       $exception = new HttpException(500, $exception->getMessage(), $exception);
Chris@18:       $event->setException($exception);
Chris@18:     }
Chris@18: 
Chris@18:     $this->setEventResponse($event, $exception->getStatusCode());
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function setEventResponse(GetResponseForExceptionEvent $event, $status) {
Chris@18:     /* @var \Symfony\Component\HttpKernel\Exception\HttpException $exception */
Chris@18:     $exception = $event->getException();
Chris@18:     $response = new ResourceResponse(new JsonApiDocumentTopLevel(new ErrorCollection([$exception]), new NullIncludedData(), new LinkCollection([])), $exception->getStatusCode(), $exception->getHeaders());
Chris@18:     $response->addCacheableDependency($exception);
Chris@18:     $event->setResponse($response);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Check if the error should be formatted using JSON:API.
Chris@18:    *
Chris@18:    * The JSON:API format is supported if the format is explicitly set or the
Chris@18:    * request is for a known JSON:API route.
Chris@18:    *
Chris@18:    * @param \Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent $exception_event
Chris@18:    *   The exception event.
Chris@18:    *
Chris@18:    * @return bool
Chris@18:    *   TRUE if it needs to be formatted using JSON:API. FALSE otherwise.
Chris@18:    */
Chris@18:   protected function isJsonApiExceptionEvent(GetResponseForExceptionEvent $exception_event) {
Chris@18:     $request = $exception_event->getRequest();
Chris@18:     $parameters = $request->attributes->all();
Chris@18:     return $request->getRequestFormat() === 'api_json' || (bool) Routes::getResourceTypeNameFromParameters($parameters);
Chris@18:   }
Chris@18: 
Chris@18: }