Updated as per feedback

symfony · weaverryan · Mar 13, 2015 · Jan 17, 2015 · Jan 17, 2015 · Jan 21, 2015
commit 0fc72a8199371e4ec4a63b94ddaffdd34de5886c
diff --git a/cookbook/session/locale_sticky_session.rst b/cookbook/session/locale_sticky_session.rst
@@ -107,20 +107,20 @@ method::
        $locale = $request->getLocale();
    }

-Setting the Locale based on the User Entity
-------------------------------------------
+Setting the Locale Based on the User's Preferences
+--------------------------------------------------

 You might want to improve this technique even further and define the locale based on
-the user entity of the logged in user. However since the ``LocaleListener`` is called
+the user entity of the logged in user. However, since the ``LocaleListener`` is called
 before the ``FirewallListener``, which is responsible for handling authentication and
 is setting the user token into the ``TokenStorage``, you have no access to the user
 which is logged in.

-First lets pretend you have defined a property locale in your user entity which you
+Let's pretend you have defined a property "locale" in your user entity which you
 want to be used as the locale for the given user. In order to achieve the wanted locale
-configuration you can set the locale which is defined for the user to the session right
-after the login. Fortunately you can hook into the login process and update your session
-variable before the redirect to the first page. For this you need an event listener for the
+configuration, you can set the locale which is defined for the user to the session right
+after the login. Fortunately, you can hook into the login process and update the user's
+session before the redirect to the first page. For this you need an event listener for the
 ``security.interactive_login`` event.

 .. code-block:: php
@@ -175,24 +175,37 @@ Then register the listener:

    .. code-block:: xml

-        <!-- app/config/services.xml -->
-        <service id="kernel.listener.your_listener_name" class="AppBundle\EventListener\UserLocaleListener">
-            <tag name="kernel.event_listener" event="security.interactive_login" method="onInteractiveLogin" />
-        </service>
+        <!-- app/config/config.xml -->
+        <?xml version="1.0" encoding="UTF-8" ?>
+        <container xmlns="http://symfony.com/schema/dic/services"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xsi:schemaLocation="http://symfony.com/schema/dic/services
+                http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+            <services>
+                <service id="app.user_locale_listener"
+                    class="AppBundle\EventListener\UserLocaleListener">
+
+                    <tag name="kernel.event_listener"
+                        event="security.interactive_login"
+                        method="onInteractiveLogin" />
+                </service>
+            </services>
+        </container>

    .. code-block:: php

        // app/config/services.php
        $container
-            ->register('kernel.listener.your_listener_name', 'AppBundle\EventListener\UserLocaleListener')
+            ->register('app.user_locale_listener', 'AppBundle\EventListener\UserLocaleListener')
            ->addTag('kernel.event_listener', array('event' => 'security.interactive_login', 'method' => 'onInteractiveLogin'))
        ;

 .. caution::

    With this configuration you are all set for having the locale based on the user's
-    locale. If however the locale changes during the session it would not be updated
+    locale. If however the locale changes during the session, it would not be updated
    since with the current implementation the user locale will only be stored to the
    session on login. In order to update the language immediately after a user has
-    changed their language you need to update the session variable after an update to
+    changed their language, you need to update the session after an update to
    the user entity.