vendor/contao/core-bundle/src/EventListener/Menu/BackendPreviewListener.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\CoreBundle\Event\ContaoCoreEvents;
  16. use Contao\CoreBundle\Event\MenuEvent;
  17. use Contao\CoreBundle\Event\PreviewUrlCreateEvent;
  18. use Symfony\Component\HttpFoundation\Request;
  19. use Symfony\Component\HttpFoundation\RequestStack;
  20. use Symfony\Component\Routing\RouterInterface;
  21. use Symfony\Component\Security\Core\Security;
  22. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  23. use Symfony\Contracts\Translation\TranslatorInterface;
  25. /**
  26.  * @internal
  27.  */
  28. class BackendPreviewListener
  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 EventDispatcherInterface
  52.      */
  53.     private $eventDispatcher;
  55.     public function __construct(Security $security, RouterInterface $router, RequestStack $requestStack, TranslatorInterface $translator, EventDispatcherInterface $eventDispatcher)
  56.     {
  57.         $this->security = $security;
  58.         $this->router = $router;
  59.         $this->requestStack = $requestStack;
  60.         $this->translator = $translator;
  61.         $this->eventDispatcher = $eventDispatcher;
  62.     }
  64.     public function __invoke(MenuEvent $event): void
  65.     {
  66.         if (!$this->security->isGranted('ROLE_USER')) {
  67.             return;
  68.         }
  70.         $tree = $event->getTree();
  72.         if ('headerMenu' !== $tree->getName()) {
  73.             return;
  74.         }
  76.         $preview = $event->getFactory()
  77.             ->createItem('preview')
  78.             ->setLabel('MSC.fePreview')
  79.             ->setUri($this->getPreviewUrl())
  80.             ->setLinkAttribute('class', 'icon-preview')
  81.             ->setLinkAttribute('title', $this->translator->trans('MSC.fePreviewTitle', [], 'contao_default'))
  82.             ->setLinkAttribute('target', '_blank')
  83.             ->setLinkAttribute('accesskey', 'f')
  84.             ->setExtra('translation_domain', 'contao_default')
  85.         ;
  87.         $children = [];
  89.         // Try adding the preview button after the alerts button
  90.         foreach ($tree->getChildren() as $name => $item) {
  91.             $children[$name] = $item;
  93.             if ('alerts' === $name) {
  94.                 $children['preview'] = $preview;
  95.             }
  96.         }
  98.         // Prepend the preview button if it could not be added above
  99.         if (!isset($children['preview'])) {
  100.             $children = ['preview' => $preview] + $children;
  101.         }
  103.         $tree->setChildren($children);
  104.     }
  106.     private function getPreviewUrl(): string
  107.     {
  108.         if (!$request = $this->requestStack->getCurrentRequest()) {
  109.             throw new \RuntimeException('The request stack did not contain a request');
  110.         }
  112.         $id = $this->getIdFromRequest($request);
  113.         $do = $request->query->get('do', '');
  114.         $url = $this->router->generate('contao_backend_preview');
  116.         $event = new PreviewUrlCreateEvent($do, $id);
  117.         $this->eventDispatcher->dispatch($event, ContaoCoreEvents::PREVIEW_URL_CREATE);
  119.         if ($query = $event->getQuery()) {
  120.             return $url.'?'.$query;
  121.         }
  123.         return $url;
  124.     }
  126.     private function getIdFromRequest(Request $request): int
  127.     {
  128.         if (!$request->query->has('table')) {
  129.             return (int) $request->query->get('id');
  130.         }
  132.         return (int) $request->getSession()->get('CURRENT_ID');
  133.     }
  134. }