vendor/contao/core-bundle/src/EventListener/Menu/BackendMenuListener.php line 64

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\CoreBundle\EventListener\Menu;
  15. use Contao\Backend;
  16. use Contao\BackendUser;
  17. use Contao\CoreBundle\Event\MenuEvent;
  18. use Contao\CoreBundle\Framework\ContaoFramework;
  19. use Contao\StringUtil;
  20. use Symfony\Component\HttpFoundation\RequestStack;
  21. use Symfony\Component\Routing\RouterInterface;
  22. use Symfony\Component\Security\Core\Security;
  23. use Symfony\Contracts\Translation\TranslatorInterface;
  25. /**
  26.  * @internal
  27.  */
  28. class BackendMenuListener
  29. {
  30.     /**
  31.      * @var Security
  32.      */
  33.     private $security;
  35.     /**
  36.      * @var RouterInterface
  37.      */
  38.     private $router;
  40.     /**
  41.      * @var RequestStack
  42.      */
  43.     private $requestStack;
  45.     /**
  46.      * @var TranslatorInterface
  47.      */
  48.     private $translator;
  50.     /**
  51.      * @var ContaoFramework
  52.      */
  53.     private $framework;
  55.     public function __construct(Security $security, RouterInterface $router, RequestStack $requestStack, TranslatorInterface $translator, ContaoFramework $framework)
  56.     {
  57.         $this->security = $security;
  58.         $this->router = $router;
  59.         $this->requestStack = $requestStack;
  60.         $this->translator = $translator;
  61.         $this->framework = $framework;
  62.     }
  64.     public function __invoke(MenuEvent $event): void
  65.     {
  66.         $user = $this->security->getUser();
  68.         if (!$user instanceof BackendUser) {
  69.             return;
  70.         }
  72.         $name = $event->getTree()->getName();
  74.         if ('mainMenu' === $name) {
  75.             $this->buildMainMenu($event, $user);
  76.         } elseif ('headerMenu' === $name) {
  77.             $this->buildHeaderMenu($event, $user);
  78.         }
  79.     }
  81.     private function buildMainMenu(MenuEvent $event, BackendUser $user): void
  82.     {
  83.         $factory = $event->getFactory();
  84.         $tree = $event->getTree();
  85.         $modules = $user->navigation();
  86.         $path = $this->router->generate('contao_backend');
  88.         foreach ($modules as $categoryName => $categoryData) {
  89.             $categoryNode = $tree->getChild($categoryName);
  91.             if (!$categoryNode) {
  92.                 $categoryNode = $factory
  93.                     ->createItem($categoryName)
  94.                     ->setLabel($categoryData['label'])
  95.                     ->setUri($categoryData['href'])
  96.                     ->setLinkAttribute('class', $this->getClassFromAttributes($categoryData))
  97.                     ->setLinkAttribute('title', $categoryData['title'])
  98.                     ->setLinkAttribute('onclick', "return AjaxRequest.toggleNavigation(this, '".$categoryName."', '".$path."')")
  99.                     ->setChildrenAttribute('id', $categoryName)
  100.                     ->setExtra('translation_domain', false)
  101.                 ;
  103.                 if (isset($categoryData['class']) && preg_match('/\bnode-collapsed\b/', $categoryData['class'])) {
  104.                     $categoryNode->setAttribute('class', 'collapsed');
  105.                 }
  107.                 $tree->addChild($categoryNode);
  108.             }
  110.             // Create the child nodes
  111.             foreach ($categoryData['modules'] as $nodeName => $nodeData) {
  112.                 $moduleNode = $factory
  113.                     ->createItem($nodeName)
  114.                     ->setLabel($nodeData['label'])
  115.                     ->setUri($nodeData['href'])
  116.                     ->setLinkAttribute('class', $this->getClassFromAttributes($nodeData))
  117.                     ->setLinkAttribute('title', $nodeData['title'])
  118.                     ->setCurrent((bool) $nodeData['isActive'])
  119.                     ->setExtra('translation_domain', false)
  120.                 ;
  122.                 $categoryNode->addChild($moduleNode);
  123.             }
  124.         }
  125.     }
  127.     private function buildHeaderMenu(MenuEvent $event, BackendUser $user): void
  128.     {
  129.         $factory = $event->getFactory();
  130.         $tree = $event->getTree();
  131.         $ref = $this->getRefererId();
  132.         $systemMessages = $this->translator->trans('MSC.systemMessages', [], 'contao_default');
  134.         $alerts = $event->getFactory()
  135.             ->createItem('alerts')
  136.             ->setLabel($this->getAlertsLabel($systemMessages))
  137.             ->setUri($this->router->generate('contao_backend_alerts'))
  138.             ->setLinkAttribute('class', 'icon-alert')
  139.             ->setLinkAttribute('title', $systemMessages)
  140.             ->setLinkAttribute('onclick', "Backend.openModalIframe({'title':'".StringUtil::specialchars(str_replace("'", "\\'", $systemMessages))."','url':this.href});return false")
  141.             ->setExtra('safe_label', true)
  142.             ->setExtra('translation_domain', false)
  143.         ;
  145.         $tree->addChild($alerts);
  147.         $submenu = $factory
  148.             ->createItem('submenu')
  149.             ->setLabel($this->translator->trans('MSC.user', [], 'contao_default').' '.$user->username)
  150.             ->setAttribute('class', 'submenu')
  151.             ->setLabelAttribute('class', 'h2')
  152.             ->setExtra('translation_domain', false)
  153.         ;
  155.         $tree->addChild($submenu);
  157.         $info = $factory
  158.             ->createItem('info')
  159.             ->setLabel(sprintf('<strong>%s</strong> %s', $user->name, $user->email))
  160.             ->setAttribute('class', 'info')
  161.             ->setExtra('safe_label', true)
  162.             ->setExtra('translation_domain', false)
  163.         ;
  165.         $submenu->addChild($info);
  167.         $login = $factory
  168.             ->createItem('login')
  169.             ->setLabel('MSC.profile')
  170.             ->setUri($this->router->generate('contao_backend', ['do' => 'login', 'ref' => $ref]))
  171.             ->setLinkAttribute('class', 'icon-profile')
  172.             ->setExtra('translation_domain', 'contao_default')
  173.         ;
  175.         $submenu->addChild($login);
  177.         $security = $factory
  178.             ->createItem('security')
  179.             ->setLabel('MSC.security')
  180.             ->setUri($this->router->generate('contao_backend', ['do' => 'security', 'ref' => $ref]))
  181.             ->setLinkAttribute('class', 'icon-security')
  182.             ->setExtra('translation_domain', 'contao_default')
  183.         ;
  185.         $submenu->addChild($security);
  187.         $buger = $factory
  188.             ->createItem('burger')
  189.             ->setLabel('<button type="button" id="burger"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" stroke="#fff" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M3 12h18M3 6h18M3 18h18"/></svg></button>')
  190.             ->setAttribute('class', 'burger')
  191.             ->setExtra('safe_label', true)
  192.             ->setExtra('translation_domain', false)
  193.         ;
  195.         $tree->addChild($buger);
  196.     }
  198.     private function getAlertsLabel(string $systemMessages): string
  199.     {
  200.         /** @var Backend $adapter */
  201.         $adapter = $this->framework->getAdapter(Backend::class);
  202.         $count = substr_count($adapter->getSystemMessages(), 'class="tl_error');
  204.         if ($count > 0) {
  205.             $systemMessages .= ' <sup>'.$count.'</sup>';
  206.         }
  208.         return $systemMessages;
  209.     }
  211.     private function getRefererId(): string
  212.     {
  213.         if (!$request = $this->requestStack->getCurrentRequest()) {
  214.             throw new \RuntimeException('The request stack did not contain a request');
  215.         }
  217.         return $request->attributes->get('_contao_referer_id');
  218.     }
  220.     private function getClassFromAttributes(array $attributes): string
  221.     {
  222.         $classes = [];
  224.         // Remove the default CSS classes and keep potentially existing custom ones (see #1357)
  225.         if (isset($attributes['class'])) {
  226.             $classes = array_flip(array_filter(explode(' ', $attributes['class'])));
  227.             unset($classes['node-expanded'], $classes['node-collapsed'], $classes['trail']);
  228.         }
  230.         return implode(' ', array_keys($classes));
  231.     }
  232. }