vendor/contao/manager-bundle/src/EventListener/BackendMenuListener.php line 73

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\ManagerBundle\EventListener;
  15. use Contao\CoreBundle\Event\MenuEvent;
  16. use Contao\ManagerBundle\HttpKernel\JwtManager;
  17. use Symfony\Component\HttpFoundation\RequestStack;
  18. use Symfony\Component\Routing\RouterInterface;
  19. use Symfony\Component\Security\Core\Security;
  20. use Symfony\Contracts\Translation\TranslatorInterface;
  22. /**
  23.  * @internal
  24.  */
  25. class BackendMenuListener
  26. {
  27.     /**
  28.      * @var Security
  29.      */
  30.     private $security;
  32.     /**
  33.      * @var RouterInterface
  34.      */
  35.     private $router;
  37.     /**
  38.      * @var RequestStack
  39.      */
  40.     private $requestStack;
  42.     /**
  43.      * @var TranslatorInterface
  44.      */
  45.     private $translator;
  47.     /**
  48.      * @var bool
  49.      */
  50.     private $debug;
  52.     /**
  53.      * @var string
  54.      */
  55.     private $managerPath;
  57.     /**
  58.      * @var JwtManager
  59.      */
  60.     private $jwtManager;
  62.     public function __construct(Security $security, RouterInterface $router, RequestStack $requestStack, TranslatorInterface $translator, bool $debug, ?string $managerPath, ?JwtManager $jwtManager)
  63.     {
  64.         $this->security = $security;
  65.         $this->router = $router;
  66.         $this->requestStack = $requestStack;
  67.         $this->translator = $translator;
  68.         $this->debug = $debug;
  69.         $this->managerPath = $managerPath;
  70.         $this->jwtManager = $jwtManager;
  71.     }
  73.     public function __invoke(MenuEvent $event): void
  74.     {
  75.         if (!$this->security->isGranted('ROLE_ADMIN')) {
  76.             return;
  77.         }
  79.         $this->addDebugButton($event);
  80.         $this->addManagerLink($event);
  81.     }
  83.     /**
  84.      * Adds a debug button to the back end header navigation.
  85.      */
  86.     private function addDebugButton(MenuEvent $event): void
  87.     {
  88.         if (null === $this->jwtManager) {
  89.             return;
  90.         }
  92.         $tree = $event->getTree();
  94.         if ('headerMenu' !== $tree->getName()) {
  95.             return;
  96.         }
  98.         if (!$request = $this->requestStack->getCurrentRequest()) {
  99.             throw new \RuntimeException('The request stack did not contain a request');
  100.         }
  102.         $params = [
  103.             'do' => 'debug',
  104.             'key' => $this->debug ? 'disable' : 'enable',
  105.             'referer' => base64_encode($request->server->get('QUERY_STRING', '')),
  106.             'ref' => $request->attributes->get('_contao_referer_id'),
  107.         ];
  109.         $class = 'icon-debug';
  111.         if ($this->debug) {
  112.             $class .= ' hover';
  113.         }
  115.         $debug = $event->getFactory()
  116.             ->createItem('debug')
  117.             ->setLabel('debug_mode')
  118.             ->setUri($this->router->generate('contao_backend', $params))
  119.             ->setLinkAttribute('class', $class)
  120.             ->setLinkAttribute('title', $this->translator->trans('debug_mode', [], 'ContaoManagerBundle'))
  121.             ->setExtra('translation_domain', 'ContaoManagerBundle')
  122.         ;
  124.         $children = [];
  126.         // Try adding the debug button after the alerts button
  127.         foreach ($tree->getChildren() as $name => $item) {
  128.             $children[$name] = $item;
  130.             if ('alerts' === $name) {
  131.                 $children['debug'] = $debug;
  132.             }
  133.         }
  135.         // Prepend the debug button if it could not be added above
  136.         if (!isset($children['debug'])) {
  137.             $children = ['debug' => $debug] + $children;
  138.         }
  140.         $tree->setChildren($children);
  141.     }
  143.     /**
  144.      * Adds a link to the Contao Manager to the back end main navigation.
  145.      */
  146.     private function addManagerLink(MenuEvent $event): void
  147.     {
  148.         if (null === $this->managerPath) {
  149.             return;
  150.         }
  152.         $categoryNode = $event->getTree()->getChild('system');
  154.         if (null === $categoryNode) {
  155.             return;
  156.         }
  158.         $item = $event->getFactory()
  159.             ->createItem('contao_manager')
  160.             ->setLabel('Contao Manager')
  161.             ->setUri('/'.$this->managerPath)
  162.             ->setLinkAttribute('class', 'navigation contao_manager')
  163.             ->setLinkAttribute('title', $this->translator->trans('contao_manager_title', [], 'ContaoManagerBundle'))
  164.             ->setExtra('translation_domain', false)
  165.         ;
  167.         $categoryNode->addChild($item);
  168.     }
  169. }