src/EventSubscriber/RedirectToPreferredLocaleSubscriber.php line 64

  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 App\EventSubscriber;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\HttpFoundation\RedirectResponse;
  16. use Symfony\Component\HttpKernel\Event\RequestEvent;
  17. use Symfony\Component\HttpKernel\KernelEvents;
  18. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  19. use function Symfony\Component\String\u;
  21. /**
  22.  * When visiting the homepage, this listener redirects the user to the most
  23.  * appropriate localized version according to the browser settings.
  24.  *
  25.  * See https://symfony.com/doc/current/components/http_kernel.html#the-kernel-request-event
  26.  *
  27.  * @author Oleg Voronkovich <oleg-voronkovich@yandex.ru>
  28.  */
  29. class RedirectToPreferredLocaleSubscriber implements EventSubscriberInterface
  30. {
  31.     private array $locales;
  32.     private string $defaultLocale;
  34.     public function __construct(
  35.         private UrlGeneratorInterface $urlGenerator,
  36.         string $locales,
  37.         ?string $defaultLocale = null
  38.     ) {
  39.         $this->locales = explode('|', trim($locales));
  40.         if (empty($this->locales)) {
  41.             throw new \UnexpectedValueException('The list of supported locales must not be empty.');
  42.         }
  44.         $this->defaultLocale = $defaultLocale ?: $this->locales[0];
  46.         if (!\in_array($this->defaultLocale, $this->locales, true)) {
  47.             throw new \UnexpectedValueException(sprintf('The default locale ("%s") must be one of "%s".', $this->defaultLocale, $locales));
  48.         }
  50.         // Add the default locale at the first position of the array,
  51.         // because Symfony\HttpFoundation\Request::getPreferredLanguage
  52.         // returns the first element when no an appropriate language is found
  53.         array_unshift($this->locales, $this->defaultLocale);
  54.         $this->locales = array_unique($this->locales);
  55.     }
  57.     public static function getSubscribedEvents(): array
  58.     {
  59.         return [
  60.             KernelEvents::REQUEST => 'onKernelRequest',
  61.         ];
  62.     }
  64.     public function onKernelRequest(RequestEvent $event): void
  65.     {
  66.         $request = $event->getRequest();
  68.         // Ignore sub-requests and all URLs but the homepage
  69.         if (!$event->isMainRequest() || '/' !== $request->getPathInfo()) {
  70.             return;
  71.         }
  72.         // Ignore requests from referrers with the same HTTP host in order to prevent
  73.         // changing language for users who possibly already selected it for this application.
  74.         $referrer = $request->headers->get('referer');
  75.         if (null !== $referrer && u($referrer)->ignoreCase()->startsWith($request->getSchemeAndHttpHost())) {
  76.             return;
  77.         }
  79.         $preferredLanguage = $request->getPreferredLanguage($this->locales);
  81.         if ($preferredLanguage !== $this->defaultLocale) {
  82.             $response = new RedirectResponse($this->urlGenerator->generate('homepage', ['_locale' => $preferredLanguage]));
  83.             $event->setResponse($response);
  84.         }
  85.     }
  86. }