vendor/easycorp/easyadmin-bundle/src/EventListener/ExceptionListener.php line 35
<?php
namespace EasyCorp\Bundle\EasyAdminBundle\EventListener;
use EasyCorp\Bundle\EasyAdminBundle\Exception\BaseException;
use EasyCorp\Bundle\EasyAdminBundle\Exception\FlattenException;
use EasyCorp\Bundle\EasyAdminBundle\Provider\AdminContextProvider;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Event\ExceptionEvent;
use Twig\Environment;
use Twig\Error\RuntimeError;
/**
* This listener allows to display customized error pages in the production
* environment.
*
* @internal
*
* @author Javier Eguiluz <javier.eguiluz@gmail.com>
* @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
*/
final class ExceptionListener
{
private bool $kernelDebug;
private AdminContextProvider $adminContextProvider;
private Environment $twig;
public function __construct(bool $kernelDebug, AdminContextProvider $adminContextProvider, Environment $twig)
{
$this->kernelDebug = $kernelDebug;
$this->adminContextProvider = $adminContextProvider;
$this->twig = $twig;
}
public function onKernelException(ExceptionEvent $event)
{
$exception = $event->getThrowable();
if ($this->kernelDebug && $exception instanceof RuntimeError && 'Variable "ea" does not exist.' === $exception->getRawMessage()) {
$exception->appendMessage($this->getEaVariableExceptionMessage());
return;
}
if ($this->kernelDebug || !$exception instanceof BaseException) {
return;
}
if (null === $this->adminContextProvider->getContext()) {
return;
}
// TODO: check why these custom error pages don't work
$event->setResponse($this->createExceptionResponse(FlattenException::create($exception)));
}
public function createExceptionResponse(FlattenException $exception): Response
{
$context = $this->adminContextProvider->getContext();
$exceptionTemplatePath = null === $context ? '@EasyAdmin/exception.html.twig' : $context->getTemplatePath('exception');
$layoutTemplatePath = null === $context ? '@EasyAdmin/layout.html.twig' : $context->getTemplatePath('layout');
return new Response($this->twig->render($exceptionTemplatePath, [
'exception' => $exception,
'layout_template_path' => $layoutTemplatePath,
]), $exception->getStatusCode());
}
private function getEaVariableExceptionMessage(): string
{
return <<<MESSAGE
The "ea" variable stores the admin context (menu items, actions, fields, etc.) and it's created automatically for requests served by EasyAdmin.
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.
Your request must meet one of these conditions to be served by EasyAdmin (and to have the "ea" variable defined):
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.
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).
MESSAGE;
}
}