vendor/contao/core-bundle/src/EventListener/LocaleSubscriber.php line 67

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;
  15. use Contao\CoreBundle\Intl\Locales;
  16. use Contao\CoreBundle\Routing\ScopeMatcher;
  17. use Contao\CoreBundle\Util\LocaleUtil;
  18. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  19. use Symfony\Component\HttpFoundation\Request;
  20. use Symfony\Component\HttpKernel\Event\RequestEvent;
  21. use Symfony\Component\HttpKernel\KernelEvents;
  22. use Symfony\Contracts\Translation\LocaleAwareInterface;
  24. /**
  25.  * @internal
  26.  */
  27. class LocaleSubscriber implements EventSubscriberInterface
  28. {
  29.     /**
  30.      * @var LocaleAwareInterface
  31.      */
  32.     private $translator;
  34.     /**
  35.      * @var ScopeMatcher
  36.      */
  37.     private $scopeMatcher;
  39.     /**
  40.      * @var array
  41.      */
  42.     private $availableLocales;
  44.     public function __construct(LocaleAwareInterface $translator, ScopeMatcher $scopeMatcher, Locales $locales)
  45.     {
  46.         $this->translator = $translator;
  47.         $this->scopeMatcher = $scopeMatcher;
  48.         $this->availableLocales = $locales->getEnabledLocaleIds();
  49.     }
  51.     /**
  52.      * Adds the default locale as request attribute.
  53.      */
  54.     public function onKernelRequest(RequestEvent $event): void
  55.     {
  56.         if (!$this->scopeMatcher->isContaoRequest($event->getRequest())) {
  57.             return;
  58.         }
  60.         $request = $event->getRequest();
  61.         $request->attributes->set('_locale', $this->getLocale($request));
  62.     }
  64.     /**
  65.      * Sets the translator locale to the preferred browser language.
  66.      */
  67.     public function setTranslatorLocale(RequestEvent $event): void
  68.     {
  69.         $this->translator->setLocale($event->getRequest()->getPreferredLanguage($this->availableLocales));
  70.     }
  72.     public static function getSubscribedEvents(): array
  73.     {
  74.         return [
  75.             KernelEvents::REQUEST => [
  76.                 // The priority must be lower than the one of the Symfony route listener (defaults to 32)
  77.                 // and higher than the Symfony locale listener (defaults to 16)
  78.                 ['onKernelRequest', 20],
  79.                 ['setTranslatorLocale', 100],
  80.             ],
  81.         ];
  82.     }
  84.     /**
  85.      * Returns the locale from the request or the HTTP header.
  86.      */
  87.     private function getLocale(Request $request): string
  88.     {
  89.         if (null !== $request->attributes->get('_locale')) {
  90.             return LocaleUtil::formatAsLocale($request->attributes->get('_locale'));
  91.         }
  93.         return $request->getPreferredLanguage($this->availableLocales);
  94.     }
  95. }