src/EventSubscriber/Api/ExceptionSubscriber.php line 76

Open in your IDE?
  1. <?php
  3. namespace App\EventSubscriber\Api;
  5. use App\Helper\Api\JsonFormatter\Throwable\Formatter;
  6. use App\Helper\Api\Translator\ApiTranslator;
  7. use Psr\Log\LoggerInterface;
  8. use Symfony\Component\HttpFoundation\Response;
  9. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  10. use Symfony\Component\HttpKernel\KernelEvents;
  12. /**
  13.  * Subscriber for kernel exception to handle most unexpected errors.
  14.  *
  15.  * @package API
  16.  * @internal
  17.  */
  18. class ExceptionSubscriber extends AbstractSubscriber
  19. {
  21.     protected LoggerInterface $logger;
  23.     /**
  24.      * Returns an array of event names this subscriber wants to listen to.
  25.      *
  26.      * The array keys are event names and the value can be:
  27.      *
  28.      *  * The method name to call (priority defaults to 0)
  29.      *  * An array composed of the method name to call and the priority
  30.      *  * An array of arrays composed of the method names to call and respective
  31.      *    priorities, or 0 if unset
  32.      *
  33.      * For instance:
  34.      *
  35.      *  * ['eventName' => 'methodName']
  36.      *  * ['eventName' => ['methodName', $priority]]
  37.      *  * ['eventName' => [['methodName1', $priority], ['methodName2']]]
  38.      *
  39.      * The code must not depend on runtime state as it will only be called at compile time.
  40.      * All logic depending on runtime state must be put into the individual methods handling the events.
  41.      *
  42.      * @noinspection PhpArrayShapeAttributeCanBeAddedInspection
  43.      * @noinspection PhpUnused
  44.      */
  45.     public static function getSubscribedEvents(): array
  46.     {
  47.         // return the subscribed events, their methods and priorities
  48.         return [
  49.             KernelEvents::EXCEPTION => [
  50.                 ['onKernelException', 0]
  51.             ]
  52.         ];
  53.     }
  55.     /**
  56.      * Constructor.
  57.      *
  58.      * @param Formatter $formatter
  59.      * @param ApiTranslator $translator
  60.      * @param LoggerInterface $logger
  61.      */
  62.     public function __construct(Formatter $formatter, ApiTranslator $translator, LoggerInterface $logger)
  63.     {
  64.         parent::__construct($formatter, $translator);
  65.         $this->logger = $logger;
  66.     }
  68.     /**
  69.      * Handles most unexpected backend API errors after kernel initialization and ensures a JSON response is given to
  70.      * the frontend.
  71.      *
  72.      * @param ExceptionEvent $event
  73.      * @return void
  74.      * @noinspection PhpUnused
  75.      */
  76.     public function onKernelException(ExceptionEvent $event): void
  77.     {
  78.         // only handle for API routes
  79.         if (preg_match('/^\/api\/|^\/api$/', $event->getRequest()->getRequestUri())) {
  80.             $event->setResponse($this->formatter->format($event->getThrowable()));
  81.             $errorData = $this->formatter->getErrorData($event->getThrowable());
  82.             $message = $errorData->getHttpStatusCode() . ' ' . Response::$statusTexts[$errorData->getHttpStatusCode()];
  83.             if ($errorData->getHttpStatusCode() !== Response::HTTP_UNPROCESSABLE_ENTITY) {
  84.                 $errorData->addData(["request-data" => $event->getRequest()->request->all()]);
  85.             }
  86.             $this->logger->error($message, $errorData->jsonSerialize());
  87.         }
  88.     }
  90. }