vendor/symfony/symfony/src/Symfony/Component/HttpKernel/EventListener/LocaleListener.php line 56

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpKernel\EventListener;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\RequestStack;
  17. use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
  18. use Symfony\Component\HttpKernel\Event\GetResponseEvent;
  19. use Symfony\Component\HttpKernel\Event\KernelEvent;
  20. use Symfony\Component\HttpKernel\KernelEvents;
  21. use Symfony\Component\Routing\RequestContextAwareInterface;
  23. /**
  24.  * Initializes the locale based on the current request.
  25.  *
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  *
  28.  * @final since Symfony 4.3
  29.  */
  30. class LocaleListener implements EventSubscriberInterface
  31. {
  32.     private $router;
  33.     private $defaultLocale;
  34.     private $requestStack;
  36.     public function __construct(RequestStack $requestStack, string $defaultLocale = 'en', RequestContextAwareInterface $router = null)
  37.     {
  38.         $this->defaultLocale = $defaultLocale;
  39.         $this->requestStack = $requestStack;
  40.         $this->router = $router;
  41.     }
  43.     public function setDefaultLocale(KernelEvent $event)
  44.     {
  45.         $event->getRequest()->setDefaultLocale($this->defaultLocale);
  46.     }
  48.     public function onKernelRequest(GetResponseEvent $event)
  49.     {
  50.         $request = $event->getRequest();
  52.         $this->setLocale($request);
  53.         $this->setRouterContext($request);
  54.     }
  56.     public function onKernelFinishRequest(FinishRequestEvent $event)
  57.     {
  58.         if (null !== $parentRequest = $this->requestStack->getParentRequest()) {
  59.             $this->setRouterContext($parentRequest);
  60.         }
  61.     }
  63.     private function setLocale(Request $request)
  64.     {
  65.         if ($locale = $request->attributes->get('_locale')) {
  66.             $request->setLocale($locale);
  67.         }
  68.     }
  70.     private function setRouterContext(Request $request)
  71.     {
  72.         if (null !== $this->router) {
  73.             $this->router->getContext()->setParameter('_locale', $request->getLocale());
  74.         }
  75.     }
  77.     public static function getSubscribedEvents()
  78.     {
  79.         return [
  80.             KernelEvents::REQUEST => [
  81.                 ['setDefaultLocale', 100],
  82.                 // must be registered after the Router to have access to the _locale
  83.                 ['onKernelRequest', 16],
  84.             ],
  85.             KernelEvents::FINISH_REQUEST => [['onKernelFinishRequest', 0]],
  86.         ];
  87.     }
  88. }