|
| 1 | +.. index:: |
| 2 | + single: Sessions, saving locale |
| 3 | + |
| 4 | +Making the Locale "Sticky" during a User's Session |
| 5 | +================================================== |
| 6 | + |
| 7 | +Prior to Symfony 2.1, the locale was stored in a session called ``_locale``. |
| 8 | +Since 2.1, it is stored in the Request, which means that it's not "sticky" |
| 9 | +during a user's request. In this article, you'll learn how to make the locale |
| 10 | +of a user "sticky" so that once it's set, that same locale will be used for |
| 11 | +every subsequent request. |
| 12 | + |
| 13 | +Creating LocaleListener |
| 14 | +----------------------- |
| 15 | + |
| 16 | +To simulate that the locale is stored in a session, you need to create and |
| 17 | +register a :doc:`new event listener</cookbook/service_container/event_listener>`. |
| 18 | +The listener will look something like this. Typically, ``_locale`` is used |
| 19 | +as a routing parameter to signify the locale, though it doesn't really matter |
| 20 | +how you determine the desired locale from the request:: |
| 21 | + |
| 22 | + // src/Acme/LocaleBundle/EventListener/LocaleListener.php |
| 23 | + namespace Acme\LocaleBundle\EventListener; |
| 24 | + |
| 25 | + use Symfony\Component\HttpKernel\Event\GetResponseEvent; |
| 26 | + use Symfony\Component\HttpKernel\KernelEvents; |
| 27 | + use Symfony\Component\EventDispatcher\EventSubscriberInterface; |
| 28 | + |
| 29 | + class LocaleListener implements EventSubscriberInterface |
| 30 | + { |
| 31 | + private $defaultLocale; |
| 32 | + |
| 33 | + public function __construct($defaultLocale = 'en') |
| 34 | + { |
| 35 | + $this->defaultLocale = $defaultLocale; |
| 36 | + } |
| 37 | + |
| 38 | + public function onKernelRequest(GetResponseEvent $event) |
| 39 | + { |
| 40 | + $request = $event->getRequest(); |
| 41 | + if (!$request->hasPreviousSession()) { |
| 42 | + return; |
| 43 | + } |
| 44 | + |
| 45 | + // try to see if the locale has been set as a _locale routing parameter |
| 46 | + if ($locale = $request->attributes->get('_locale')) { |
| 47 | + $request->getSession()->set('_locale', $locale); |
| 48 | + } else { |
| 49 | + // if no explicit locale has been set on this request, use one from the session |
| 50 | + $request->setLocale($request->getSession()->get('_locale', $this->defaultLocale)); |
| 51 | + } |
| 52 | + } |
| 53 | + |
| 54 | + public static function getSubscribedEvents() |
| 55 | + { |
| 56 | + return array( |
| 57 | + // must be registered before the default Locale listener |
| 58 | + KernelEvents::REQUEST => array(array('onKernelRequest', 17)), |
| 59 | + ); |
| 60 | + } |
| 61 | + } |
| 62 | + |
| 63 | +Then register the listener: |
| 64 | + |
| 65 | +.. configuration-block:: |
| 66 | + |
| 67 | + .. code-block:: yaml |
| 68 | +
|
| 69 | + services: |
| 70 | + acme_locale.locale_listener: |
| 71 | + class: Acme\LocaleBundle\EventListener\LocaleListener |
| 72 | + arguments: ["%kernel.default_locale%"] |
| 73 | + tags: |
| 74 | + - { name: kernel.event_subscriber } |
| 75 | +
|
| 76 | + .. code-block:: xml |
| 77 | +
|
| 78 | + <service id="acme_locale.locale_listener" |
| 79 | + class="Acme\LocaleBundle\EventListener\LocaleListener"> |
| 80 | + <argument>%kernel.default_locale%</argument> |
| 81 | +
|
| 82 | + <tag name="kernel.event_subscriber" /> |
| 83 | + </service> |
| 84 | +
|
| 85 | + .. code-block:: php |
| 86 | +
|
| 87 | + use Symfony\Component\DependencyInjection\Definition; |
| 88 | +
|
| 89 | + $container |
| 90 | + ->setDefinition('acme_locale.locale_listener', new Definition( |
| 91 | + 'Acme\LocaleBundle\EventListener\LocaleListener', |
| 92 | + array('%kernel.default_locale%') |
| 93 | + )) |
| 94 | + ->addTag('kernel.event_subscriber') |
| 95 | + ; |
| 96 | +
|
| 97 | +That's it! Now celebrate by changing the user's locale and seeing that it's |
| 98 | +sticky throughout the request. Remember, to get the user's locale, always |
| 99 | +use the :method:`Request::getLocale<Symfony\\Component\\HttpFoundation\\Request::getLocale>` |
| 100 | +method:: |
| 101 | + |
| 102 | + // from a controller... |
| 103 | + $locale = $this->getRequest()->getLocale(); |
0 commit comments