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

  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\KernelEvent;
  19. use Symfony\Component\HttpKernel\Event\RequestEvent;
  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
  29.  */
  30. class LocaleListener implements EventSubscriberInterface
  31. {
  32.     private ?RequestContextAwareInterface $router;
  33.     private string $defaultLocale;
  34.     private RequestStack $requestStack;
  35.     private bool $useAcceptLanguageHeader;
  36.     private array $enabledLocales;
  38.     public function __construct(RequestStack $requestStack, string $defaultLocale = 'en', RequestContextAwareInterface $router = null, bool $useAcceptLanguageHeader = false, array $enabledLocales = [])
  39.     {
  40.         $this->defaultLocale = $defaultLocale;
  41.         $this->requestStack = $requestStack;
  42.         $this->router = $router;
  43.         $this->useAcceptLanguageHeader = $useAcceptLanguageHeader;
  44.         $this->enabledLocales = $enabledLocales;
  45.     }
  47.     public function setDefaultLocale(KernelEvent $event)
  48.     {
  49.         $event->getRequest()->setDefaultLocale($this->defaultLocale);
  50.     }
  52.     public function onKernelRequest(RequestEvent $event)
  53.     {
  54.         $request = $event->getRequest();
  56.         $this->setLocale($request);
  57.         $this->setRouterContext($request);
  58.     }
  60.     public function onKernelFinishRequest(FinishRequestEvent $event)
  61.     {
  62.         if (null !== $parentRequest = $this->requestStack->getParentRequest()) {
  63.             $this->setRouterContext($parentRequest);
  64.         }
  65.     }
  67.     private function setLocale(Request $request)
  68.     {
  69.         if ($locale = $request->attributes->get('_locale')) {
  70.             $request->setLocale($locale);
  71.         } elseif ($this->useAcceptLanguageHeader) {
  72.             if ($preferredLanguage = $request->getPreferredLanguage($this->enabledLocales)) {
  73.                 $request->setLocale($preferredLanguage);
  74.             }
  75.             $request->attributes->set('_vary_by_language', true);
  76.         }
  77.     }
  79.     private function setRouterContext(Request $request)
  80.     {
  81.         $this->router?->getContext()->setParameter('_locale', $request->getLocale());
  82.     }
  84.     public static function getSubscribedEvents(): array
  85.     {
  86.         return [
  87.             KernelEvents::REQUEST => [
  88.                 ['setDefaultLocale', 100],
  89.                 // must be registered after the Router to have access to the _locale
  90.                 ['onKernelRequest', 16],
  91.             ],
  92.             KernelEvents::FINISH_REQUEST => [['onKernelFinishRequest', 0]],
  93.         ];
  94.     }
  95. }