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

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. private Security $security;
  28. private RouterInterface $router;
  29. private RequestStack $requestStack;
  30. private TranslatorInterface $translator;
  31. private bool $debug;
  32. private ?string $managerPath;
  33. private ?JwtManager $jwtManager;
  35. public function __construct(Security $security, RouterInterface $router, RequestStack $requestStack, TranslatorInterface $translator, bool $debug, ?string $managerPath, ?JwtManager $jwtManager)
  36. {
  37. $this->security = $security;
  38. $this->router = $router;
  39. $this->requestStack = $requestStack;
  40. $this->translator = $translator;
  41. $this->debug = $debug;
  42. $this->managerPath = $managerPath;
  43. $this->jwtManager = $jwtManager;
  44. }
  46. public function __invoke(MenuEvent $event): void
  47. {
  48. if (!$this->security->isGranted('ROLE_ADMIN')) {
  49. return;
  50. }
  52. $this->addDebugButton($event);
  53. $this->addManagerLink($event);
  54. }
  56. /**
  57. * Adds a debug button to the back end header navigation.
  58. */
  59. private function addDebugButton(MenuEvent $event): void
  60. {
  61. if (null === $this->jwtManager) {
  62. return;
  63. }
  65. $tree = $event->getTree();
  67. if ('headerMenu' !== $tree->getName()) {
  68. return;
  69. }
  71. if (!$request = $this->requestStack->getCurrentRequest()) {
  72. throw new \RuntimeException('The request stack did not contain a request');
  73. }
  75. $params = [
  76. 'do' => 'debug',
  77. 'key' => $this->debug ? 'disable' : 'enable',
  78. 'referer' => base64_encode($request->server->get('QUERY_STRING', '')),
  79. 'ref' => $request->attributes->get('_contao_referer_id'),
  80. ];
  82. $class = 'icon-debug';
  84. if ($this->debug) {
  85. $class .= ' hover';
  86. }
  88. $debug = $event->getFactory()
  89. ->createItem('debug')
  90. ->setLabel('debug_mode')
  91. ->setUri($this->router->generate('contao_backend', $params))
  92. ->setLinkAttribute('class', $class)
  93. ->setLinkAttribute('title', $this->translator->trans('debug_mode', [], 'ContaoManagerBundle'))
  94. ->setExtra('translation_domain', 'ContaoManagerBundle')
  95. ;
  97. $children = [];
  99. // Try adding the debug button after the alerts button
  100. foreach ($tree->getChildren() as $name => $item) {
  101. $children[$name] = $item;
  103. if ('alerts' === $name) {
  104. $children['debug'] = $debug;
  105. }
  106. }
  108. // Prepend the debug button if it could not be added above
  109. if (!isset($children['debug'])) {
  110. $children = ['debug' => $debug] + $children;
  111. }
  113. $tree->setChildren($children);
  114. }
  116. /**
  117. * Adds a link to the Contao Manager to the back end main navigation.
  118. */
  119. private function addManagerLink(MenuEvent $event): void
  120. {
  121. if (null === $this->managerPath) {
  122. return;
  123. }
  125. $categoryNode = $event->getTree()->getChild('system');
  127. if (null === $categoryNode || !$request = $this->requestStack->getCurrentRequest()) {
  128. return;
  129. }
  131. $item = $event->getFactory()
  132. ->createItem('contao_manager')
  133. ->setLabel('Contao Manager')
  134. ->setUri($request->getUriForPath('/'.$this->managerPath))
  135. ->setLinkAttribute('class', 'navigation contao_manager')
  136. ->setLinkAttribute('title', $this->translator->trans('contao_manager_title', [], 'ContaoManagerBundle'))
  137. ->setExtra('translation_domain', false)
  138. ;
  140. $categoryNode->addChild($item);
  141. }
  142. }