vendor/sulu/sulu/src/Sulu/Bundle/WebsiteBundle/EventListener/RouterListener.php line 57

  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sulu\Bundle\WebsiteBundle\EventListener;
  14. use Sulu\Component\Webspace\Analyzer\RequestAnalyzerInterface;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
  17. use Symfony\Component\HttpKernel\Event\RequestEvent;
  18. use Symfony\Component\HttpKernel\EventListener\RouterListener as BaseRouterListener;
  19. use Symfony\Component\HttpKernel\KernelEvents;
  21. /**
  22.  * This listener replaces the default RouterListener delivered by Symfony and adds the analyzing of the request as
  23.  * required by Sulu. Validating the result can be deactivated by passing `false` to the `_requestAnalyzer` default in
  24.  * the route.
  25.  */
  26. class RouterListener implements EventSubscriberInterface
  27. {
  28.     public const REQUEST_ANALYZER = '_requestAnalyzer';
  30.     /**
  31.      * @var BaseRouterListener
  32.      */
  33.     private $baseRouteListener;
  35.     /**
  36.      * @var RequestAnalyzerInterface
  37.      */
  38.     private $requestAnalyzer;
  40.     public function __construct(BaseRouterListener $baseRouterListener, RequestAnalyzerInterface $requestAnalyzer)
  41.     {
  42.         $this->baseRouteListener = $baseRouterListener;
  43.         $this->requestAnalyzer = $requestAnalyzer;
  44.     }
  46.     /**
  47.      * Analyzes the request before passing the event to the default RouterListener from symfony and validates the result
  48.      * afterwards.
  49.      */
  50.     public function onKernelRequest(RequestEvent $event)
  51.     {
  52.         $request = $event->getRequest();
  54.         // This call is required in all cases, because the default router needs our webspace information
  55.         // Would be nice to also only call this if the _requestAnalyzer attribute is set, but it's set on the next line
  56.         $this->requestAnalyzer->analyze($request);
  57.         $this->baseRouteListener->onKernelRequest($event);
  58.         if (false !== $request->attributes->getBoolean(static::REQUEST_ANALYZER, true)) {
  59.             $this->requestAnalyzer->validate($request);
  60.         }
  61.     }
  63.     /**
  64.      * Simply pass the event to the route listener, because we have nothing to add here.
  65.      */
  66.     public function onKernelFinishRequest(FinishRequestEvent $event)
  67.     {
  68.         $this->baseRouteListener->onKernelFinishRequest($event);
  69.     }
  71.     public static function getSubscribedEvents()
  72.     {
  73.         return [
  74.             KernelEvents::REQUEST => [['onKernelRequest', 32]],
  75.             KernelEvents::FINISH_REQUEST => [['onKernelFinishRequest', 0]],
  76.         ];
  77.     }
  78. }