vendor/symfony/http-kernel/EventListener/LocaleListener.php line 61

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.     /**
  37.      * @param RequestStack                      $requestStack  A RequestStack instance
  38.      * @param string                            $defaultLocale The default locale
  39.      * @param RequestContextAwareInterface|null $router        The router
  40.      */
  41.     public function __construct(RequestStack $requestStack, string $defaultLocale = 'en', RequestContextAwareInterface $router = null)
  42.     {
  43.         $this->defaultLocale = $defaultLocale;
  44.         $this->requestStack = $requestStack;
  45.         $this->router = $router;
  46.     }
  48.     public function setDefaultLocale(KernelEvent $event)
  49.     {
  50.         $event->getRequest()->setDefaultLocale($this->defaultLocale);
  51.     }
  53.     public function onKernelRequest(GetResponseEvent $event)
  54.     {
  55.         $request = $event->getRequest();
  57.         $this->setLocale($request);
  58.         $this->setRouterContext($request);
  59.     }
  61.     public function onKernelFinishRequest(FinishRequestEvent $event)
  62.     {
  63.         if (null !== $parentRequest = $this->requestStack->getParentRequest()) {
  64.             $this->setRouterContext($parentRequest);
  65.         }
  66.     }
  68.     private function setLocale(Request $request)
  69.     {
  70.         if ($locale = $request->attributes->get('_locale')) {
  71.             $request->setLocale($locale);
  72.         }
  73.     }
  75.     private function setRouterContext(Request $request)
  76.     {
  77.         if (null !== $this->router) {
  78.             $this->router->getContext()->setParameter('_locale', $request->getLocale());
  79.         }
  80.     }
  82.     public static function getSubscribedEvents()
  83.     {
  84.         return [
  85.             KernelEvents::REQUEST => [
  86.                 ['setDefaultLocale', 100],
  87.                 // must be registered after the Router to have access to the _locale
  88.                 ['onKernelRequest', 16],
  89.             ],
  90.             KernelEvents::FINISH_REQUEST => [['onKernelFinishRequest', 0]],
  91.         ];
  92.     }
  93. }