src/EventSubscriber/RedirectToLocaleSubscriber.php line 68

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