src/EventSubscriber/RedirectToLocaleSubscriber.php line 73

  1. <?php
  3. /*
  4.  * This file is part of the Tabler-Bundle demo.
  5.  * Copyright 2021 Kevin Papst - www.kevinpapst.de
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  11. namespace App\EventSubscriber;
  13. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  14. use Symfony\Component\HttpFoundation\RedirectResponse;
  15. use Symfony\Component\HttpKernel\Event\RequestEvent;
  16. use Symfony\Component\HttpKernel\KernelEvents;
  17. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  19. /**
  20.  * When visiting the homepage, this listener redirects the user to the most
  21.  * appropriate localized version according to the browser settings.
  22.  *
  23.  * See http://symfony.com/doc/current/components/http_kernel/introduction.html#the-kernel-request-event
  24.  *
  25.  * @author Oleg Voronkovich <oleg-voronkovich@yandex.ru>
  26.  */
  27. class RedirectToLocaleSubscriber implements EventSubscriberInterface
  28. {
  29.     /**
  30.      * List of supported locales.
  31.      *
  32.      * @var string[]
  33.      */
  34.     private array $locales = [];
  35.     private string $defaultLocale = '';
  36.     private UrlGeneratorInterface $urlGenerator;
  38.     public function __construct(UrlGeneratorInterface $urlGenerator, string $locales, ?string $defaultLocale = null)
  39.     {
  40.         $this->urlGenerator = $urlGenerator;
  42.         $this->locales = explode('|', trim($locales));
  43.         if (empty($this->locales)) {
  44.             throw new \UnexpectedValueException('The list of supported locales must not be empty.');
  45.         }
  46.         $this->defaultLocale = $defaultLocale ?: $this->locales[0];
  48.         if (!in_array($this->defaultLocale, $this->locales)) {
  49.             //
  50.             throw new \UnexpectedValueException(
  51.                 sprintf('The default locale ("%s") must be one of "%s".', $this->defaultLocale, $locales)
  52.             );
  53.         }
  55.         // Add the default locale at the first position of the array,
  56.         // because Symfony\HttpFoundation\Request::getPreferredLanguage
  57.         // returns the first element when no an appropriate language is found
  58.         array_unshift($this->locales, $this->defaultLocale);
  59.         $this->locales = array_unique($this->locales);
  61.     }
  63.     /**
  64.      * @return array
  65.      */
  66.     public static function getSubscribedEvents(): array
  67.     {
  68.         return [
  69.             KernelEvents::REQUEST => ['onKernelRequest', 1000],
  70.         ];
  71.     }
  73.     public function onKernelRequest(RequestEvent $event)
  74.     {
  75.         $request = $event->getRequest();
  77.         // Ignore sub-requests and all URLs but the homepage
  78.         if ('/' !== $request->getPathInfo()) {
  79.             return;
  80.         }
  82.         // Ignore requests from referrers with the same HTTP host in order to prevent
  83.         // changing language for users who possibly already selected it for this application.
  84.         if (0 === stripos($request->headers->get('referer'), $request->getSchemeAndHttpHost())) {
  85.             return;
  86.         }
  91.         $preferredLanguage = $request->getPreferredLanguage($this->locales);
  93.         $response = new RedirectResponse($this->urlGenerator->generate('app_dashboard', ['_locale' => 'ar']));
  94.         $event->setResponse($response);
  95.     }
  96. }