|
| 1 | +.. index:: |
| 2 | + single: Sessions, saving locale |
| 3 | + |
| 4 | +Simulate old Behaviour of Saving the Locale |
| 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. You'll learn how to simulate the old |
| 9 | +way in this article. |
| 10 | + |
| 11 | +Creating LocaleListener |
| 12 | +----------------------- |
| 13 | + |
| 14 | +To simulate that the locale is stored in a session, you need to create and |
| 15 | +register a new listener. The listener will look like the following, assuming |
| 16 | +that the parameter which handels the locale value in the request is called |
| 17 | +``_locale``:: |
| 18 | + |
| 19 | + // src/Acme/LocaleBundle/EventListener/LocaleListener.php |
| 20 | + namespace Acme\LocaleBundle\EventListener; |
| 21 | + |
| 22 | + use Symfony\Component\HttpKernel\Event\GetResponseEvent; |
| 23 | + use Symfony\Component\HttpKernel\KernelEvents; |
| 24 | + use Symfony\Component\EventDispatcher\EventSubscriberInterface; |
| 25 | + |
| 26 | + class LocaleListener implements EventSubscriberInterface |
| 27 | + { |
| 28 | + private $defaultLocale; |
| 29 | + |
| 30 | + public function __construct($defaultLocale = 'en') |
| 31 | + { |
| 32 | + $this->defaultLocale = $defaultLocale; |
| 33 | + } |
| 34 | + |
| 35 | + public function onKernelRequest(GetResponseEvent $event) |
| 36 | + { |
| 37 | + $request = $event->getRequest(); |
| 38 | + if (!$request->hasPreviousSession()) { |
| 39 | + return; |
| 40 | + } |
| 41 | + |
| 42 | + if ($locale = $request->attributes->get('_locale')) { |
| 43 | + $request->getSession()->set('_locale', $locale); |
| 44 | + } else { |
| 45 | + $request->setLocale($request->getSession()->get('_locale', $this->defaultLocale)); |
| 46 | + } |
| 47 | + } |
| 48 | + |
| 49 | + public static function getSubscribedEvents() |
| 50 | + { |
| 51 | + return array( |
| 52 | + // must be registered before the default Locale listener |
| 53 | + KernelEvents::REQUEST => array(array('onKernelRequest', 17)), |
| 54 | + ); |
| 55 | + } |
| 56 | + } |
| 57 | + |
| 58 | +Then register the listener: |
| 59 | + |
| 60 | +.. configuration-block:: |
| 61 | + |
| 62 | + .. code-block:: yaml |
| 63 | +
|
| 64 | + services: |
| 65 | + acme_locale.locale_listener: |
| 66 | + class: Acme\LocaleBundle\EventListener\LocaleListener |
| 67 | + arguments: ["%kernel.default_locale%"] |
| 68 | + tags: |
| 69 | + - { name: kernel.event_subscriber } |
| 70 | +
|
| 71 | + .. code-block:: xml |
| 72 | +
|
| 73 | + <service id="acme_locale.locale_listener" |
| 74 | + class="Acme\LocaleBundle\EventListener\LocaleListener"> |
| 75 | + <argument>%kernel.default_locale%</argument> |
| 76 | +
|
| 77 | + <tag name="kernel.event_subscriber" /> |
| 78 | + </service> |
| 79 | +
|
| 80 | + .. code-block:: php |
| 81 | +
|
| 82 | + use Symfony\Component\DependencyInjection\Definition; |
| 83 | +
|
| 84 | + $container |
| 85 | + ->setDefinition('acme_locale.locale_listener', new Definition( |
| 86 | + 'Acme\LocaleBundle\EventListener\LocaleListener', |
| 87 | + array('%kernel.default_locale%') |
| 88 | + )) |
| 89 | + ->addTag('kernel.event_subscriber') |
| 90 | + ; |
0 commit comments