vendor/easycorp/easyadmin-bundle/src/EventListener/ExceptionListener.php line 35

Open in your IDE?
  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\EventListener;
  5. use EasyCorp\Bundle\EasyAdminBundle\Exception\BaseException;
  6. use EasyCorp\Bundle\EasyAdminBundle\Exception\FlattenException;
  7. use EasyCorp\Bundle\EasyAdminBundle\Provider\AdminContextProvider;
  8. use Symfony\Component\HttpFoundation\Response;
  9. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  10. use Twig\Environment;
  11. use Twig\Error\RuntimeError;
  13. /**
  14.  * This listener allows to display customized error pages in the production
  15.  * environment.
  16.  *
  17.  * @internal
  18.  *
  19.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  20.  * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
  21.  */
  22. final class ExceptionListener
  23. {
  24.     private $kernelDebug;
  25.     private $adminContextProvider;
  26.     private $twig;
  28.     public function __construct(bool $kernelDebug, AdminContextProvider $adminContextProvider, Environment $twig)
  29.     {
  30.         $this->kernelDebug = $kernelDebug;
  31.         $this->adminContextProvider = $adminContextProvider;
  32.         $this->twig = $twig;
  33.     }
  35.     public function onKernelException(ExceptionEvent $event)
  36.     {
  37.         $exception = $event->getThrowable();
  39.         if ($this->kernelDebug && $exception instanceof RuntimeError && 'Variable "ea" does not exist.' === $exception->getRawMessage()) {
  40.             $exception->appendMessage($this->getEaVariableExceptionMessage());
  42.             return;
  43.         }
  45.         if ($this->kernelDebug || !$exception instanceof BaseException) {
  46.             return;
  47.         }
  49.         // TODO: check why these custom error pages don't work
  50.         $event->setResponse($this->createExceptionResponse(FlattenException::create($exception)));
  51.     }
  53.     public function createExceptionResponse(FlattenException $exception): Response
  54.     {
  55.         $context = $this->adminContextProvider->getContext();
  56.         $exceptionTemplatePath = null === $context ? '@EasyAdmin/exception.html.twig' : $context->getTemplatePath('exception');
  57.         $layoutTemplatePath = null === $context ? '@EasyAdmin/layout.html.twig' : $context->getTemplatePath('layout');
  59.         return new Response($this->twig->render($exceptionTemplatePath, [
  60.             'exception' => $exception,
  61.             'layout_template_path' => $layoutTemplatePath,
  62.         ]), $exception->getStatusCode());
  63.     }
  65.     private function getEaVariableExceptionMessage(): string
  66.     {
  67.         return <<<MESSAGE
  70. The "ea" variable stores the admin context (menu items, actions, fields, etc.) and it's created automatically for requests served by EasyAdmin.
  72. If you are seeing this error, you are trying to use some EasyAdmin features in a request not served by EasyAdmin. For example, some of your custom actions may be trying to render or extend from one of the templates provided EasyAdmin.
  74. Your request must meet one of these conditions to be served by EasyAdmin (and to have the "ea" variable defined):
  76. 1) It must be run by a controller that implements DashboardControllerInterface. This is done automatically for all actions and CRUD controllers associated to your dashboard.
  78. 2) It must contain an "eaContext" query string parameter that identifies the Dashboard associated to this request (this parameter is automatically added by EasyAdmin when creating menu items that link to custom Symfony routes).
  79. MESSAGE;
  80.     }
  81. }