vendor/easycorp/easyadmin-bundle/src/EventListener/AdminRouterSubscriber.php line 69

Open in your IDE?
  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\EventListener;
  5. use EasyCorp\Bundle\EasyAdminBundle\Config\Option\EA;
  6. use EasyCorp\Bundle\EasyAdminBundle\Contracts\Controller\CrudControllerInterface;
  7. use EasyCorp\Bundle\EasyAdminBundle\Contracts\Controller\DashboardControllerInterface;
  8. use EasyCorp\Bundle\EasyAdminBundle\Factory\AdminContextFactory;
  9. use EasyCorp\Bundle\EasyAdminBundle\Factory\ControllerFactory;
  10. use EasyCorp\Bundle\EasyAdminBundle\Registry\CrudControllerRegistry;
  11. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  12. use Symfony\Component\HttpFoundation\Request;
  13. use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
  14. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  15. use Symfony\Component\HttpKernel\Event\RequestEvent;
  16. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  17. use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
  18. use Twig\Environment;
  20. /**
  21.  * This subscriber acts as a "proxy" of all backend requests. First, if the
  22.  * request is related to EasyAdmin, it creates the AdminContext variable and
  23.  * stores it in the Request as an attribute.
  24.  *
  25.  * Second, it uses Symfony events to serve all backend requests using a single
  26.  * route. The trick is to change dynamically the controller to execute when
  27.  * the request is related to a CRUD action or a normal Symfony route/action.
  28.  *
  29.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  30.  * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
  31.  * @author Yonel Ceruto <yonelceruto@gmail.com>
  32.  */
  33. class AdminRouterSubscriber implements EventSubscriberInterface
  34. {
  35.     private AdminContextFactory $adminContextFactory;
  36.     private CrudControllerRegistry $crudControllerRegistry;
  37.     private ControllerFactory $controllerFactory;
  38.     private ControllerResolverInterface $controllerResolver;
  39.     private UrlGeneratorInterface $urlGenerator;
  40.     private RequestMatcherInterface $requestMatcher;
  41.     private Environment $twig;
  43.     public function __construct(AdminContextFactory $adminContextFactory, CrudControllerRegistry $crudControllerRegistry, ControllerFactory $controllerFactory, ControllerResolverInterface $controllerResolver, UrlGeneratorInterface $urlGenerator, RequestMatcherInterface $requestMatcher, Environment $twig)
  44.     {
  45.         $this->adminContextFactory = $adminContextFactory;
  46.         $this->crudControllerRegistry = $crudControllerRegistry;
  47.         $this->controllerFactory = $controllerFactory;
  48.         $this->controllerResolver = $controllerResolver;
  49.         $this->urlGenerator = $urlGenerator;
  50.         $this->requestMatcher = $requestMatcher;
  51.         $this->twig = $twig;
  52.     }
  54.     public static function getSubscribedEvents(): array
  55.     {
  56.         return [
  57.             RequestEvent::class => [
  58.                 ['onKernelRequest', 0],
  59.             ],
  60.             // the priority must be higher than 0 to run it before ParamConverterListener
  61.             ControllerEvent::class => ['onKernelController', 128],
  62.         ];
  63.     }
  65.     /**
  66.      * If this is an EasyAdmin request, it creates the AdminContext variable, stores it
  67.      * in the Request as an attribute and injects it as a global Twig variable.
  68.      */
  69.     public function onKernelRequest(RequestEvent $event): void
  70.     {
  71.         $request = $event->getRequest();
  72.         if (null === $dashboardControllerFqcn = $this->getDashboardControllerFqcn($request)) {
  73.             return;
  74.         }
  76.         if (null === $dashboardControllerInstance = $this->getDashboardControllerInstance($dashboardControllerFqcn, $request)) {
  77.             return;
  78.         }
  80.         // creating the context is expensive, so it's created once and stored in the request
  81.         // if the current request already has an AdminContext object, do nothing
  82.         if (null === $adminContext = $request->attributes->get(EA::CONTEXT_REQUEST_ATTRIBUTE)) {
  83.             $crudControllerInstance = $this->getCrudControllerInstance($request);
  84.             $adminContext = $this->adminContextFactory->create($request, $dashboardControllerInstance, $crudControllerInstance);
  85.         }
  87.         $request->attributes->set(EA::CONTEXT_REQUEST_ATTRIBUTE, $adminContext);
  89.         // this makes the AdminContext available in all templates as a short named variable
  90.         $this->twig->addGlobal('ea', $adminContext);
  91.     }
  93.     /**
  94.      * In EasyAdmin all backend requests are served via the same route (that allows to
  95.      * detect under which dashboard you want to process the request). This method handles
  96.      * the requests related to "CRUD controller actions" and "custom Symfony actions".
  97.      * The trick used is to change dynamically the controller executed by Symfony.
  98.      */
  99.     public function onKernelController(ControllerEvent $event): void
  100.     {
  101.         $request = $event->getRequest();
  102.         if (null === $request->attributes->get(EA::CONTEXT_REQUEST_ATTRIBUTE)) {
  103.             return;
  104.         }
  106.         // if the request is related to a CRUD controller, change the controller to be executed
  107.         if (null !== $crudControllerInstance = $this->getCrudControllerInstance($request)) {
  108.             $symfonyControllerFqcnCallable = [$crudControllerInstance, $request->query->get(EA::CRUD_ACTION)];
  109.             $symfonyControllerStringCallable = [\get_class($crudControllerInstance), $request->query->get(EA::CRUD_ACTION)];
  111.             // this makes Symfony believe that another controller is being executed
  112.             // (e.g. this is needed for the autowiring of controller action arguments)
  113.             // VERY IMPORTANT: here the Symfony controller must be passed as a string (['App\Controller\Foo', 'index'])
  114.             // Otherwise, the param converter of the controller method doesn't work
  115.             $event->getRequest()->attributes->set('_controller', $symfonyControllerStringCallable);
  117.             // this actually makes Symfony to execute the other controller
  118.             $event->setController($symfonyControllerFqcnCallable);
  119.         }
  121.         // if the request is related to a custom action, change the controller to be executed
  122.         if (null !== $request->query->get(EA::ROUTE_NAME)) {
  123.             $symfonyControllerAsString = $this->getSymfonyControllerFqcn($request);
  124.             $symfonyControllerCallable = $this->getSymfonyControllerInstance($symfonyControllerAsString, $request->query->all()[EA::ROUTE_PARAMS] ?? []);
  125.             if (false !== $symfonyControllerCallable) {
  126.                 // this makes Symfony believe that another controller is being executed
  127.                 // (e.g. this is needed for the autowiring of controller action arguments)
  128.                 // VERY IMPORTANT: here the Symfony controller must be passed as a string ('App\Controller\Foo::index')
  129.                 // Otherwise, the param converter of the controller method doesn't work
  130.                 $event->getRequest()->attributes->set('_controller', $symfonyControllerAsString);
  131.                 // route params must be added as route attribute; otherwise, param converters don't work
  132.                 $event->getRequest()->attributes->replace(array_merge(
  133.                     $request->query->all()[EA::ROUTE_PARAMS] ?? [],
  134.                     $event->getRequest()->attributes->all()
  135.                 ));
  137.                 // this actually makes Symfony to execute the other controller
  138.                 $event->setController($symfonyControllerCallable);
  139.             }
  140.         }
  141.     }
  143.     /**
  144.      * It returns the FQCN of the EasyAdmin Dashboard controller used to serve this
  145.      * request or null if this is not an EasyAdmin request.
  146.      * Because of how EasyAdmin works, all backend requests are handled via the
  147.      * Dashboard controller, so its enough to check if the request controller implements
  148.      * the DashboardControllerInterface.
  149.      */
  150.     private function getDashboardControllerFqcn(Request $request): ?string
  151.     {
  152.         $controller = $request->attributes->get('_controller');
  153.         $controllerFqcn = null;
  155.         if (\is_string($controller)) {
  156.             [$controllerFqcn, ] = explode('::', $controller);
  157.         }
  159.         if (\is_array($controller)) {
  160.             $controllerFqcn = $controller[0];
  161.         }
  163.         if (\is_object($controller)) {
  164.             $controllerFqcn = \get_class($controller);
  165.         }
  167.         return is_subclass_of($controllerFqcn, DashboardControllerInterface::class) ? $controllerFqcn : null;
  168.     }
  170.     private function getDashboardControllerInstance(string $dashboardControllerFqcn, Request $request): ?DashboardControllerInterface
  171.     {
  172.         return $this->controllerFactory->getDashboardControllerInstance($dashboardControllerFqcn, $request);
  173.     }
  175.     private function getCrudControllerInstance(Request $request): ?CrudControllerInterface
  176.     {
  177.         $crudControllerFqcn = $request->query->get(EA::CRUD_CONTROLLER_FQCN);
  179.         $crudAction = $request->query->get(EA::CRUD_ACTION);
  181.         return $this->controllerFactory->getCrudControllerInstance($crudControllerFqcn, $crudAction, $request);
  182.     }
  184.     private function getSymfonyControllerFqcn(Request $request): ?string
  185.     {
  186.         $routeName = $request->query->get(EA::ROUTE_NAME);
  187.         $routeParams = $request->query->all()[EA::ROUTE_PARAMS] ?? [];
  188.         $url = $this->urlGenerator->generate($routeName, $routeParams);
  190.         $newRequest = $request->duplicate();
  191.         $newRequest->attributes->remove('_controller');
  192.         $newRequest->attributes->set('_route', $routeName);
  193.         $newRequest->attributes->add($routeParams);
  194.         $newRequest->server->set('REQUEST_URI', $url);
  196.         $parameters = $this->requestMatcher->matchRequest($newRequest);
  198.         return $parameters['_controller'] ?? null;
  199.     }
  201.     private function getSymfonyControllerInstance(string $controllerFqcn, array $routeParams): callable|false
  202.     {
  203.         $newRequest = new Request([], [], ['_controller' => $controllerFqcn, '_route_params' => $routeParams], [], [], []);
  205.         return $this->controllerResolver->getController($newRequest);
  206.     }
  207. }