Making the Locale "Sticky" during a User's Session

Symfony stores the locale setting in the Request, which means that this setting is not automatically saved ("sticky") across requests. But, you can store the locale in the session, so that it's used on subsequent requests.

symfony はロケール設定をリクエストに保存します。つまり、この設定はリクエスト間で自動的に保存 (「スティッキー」) されません。ただし、ロケールをセッションに保存して、後続のリクエストで使用することができます。

Creating a LocaleSubscriber

Create a new event subscriber. Typically, _locale is used as a routing parameter to signify the locale, though you can determine the correct locale however you want:

新しいイベント サブスクライバーを作成します。通常、_localeis はロケールを示すルーティング パラメーターとして使用されますが、必要に応じて正しいロケールを決定できます。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
// src/EventSubscriber/LocaleSubscriber.php
namespace App\EventSubscriber;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\KernelEvents;

class LocaleSubscriber implements EventSubscriberInterface
{
    private $defaultLocale;

    public function __construct(string $defaultLocale = 'en')
    {
        $this->defaultLocale = $defaultLocale;
    }

    public function onKernelRequest(RequestEvent $event)
    {
        $request = $event->getRequest();
        if (!$request->hasPreviousSession()) {
            return;
        }

        // try to see if the locale has been set as a _locale routing parameter
        if ($locale = $request->attributes->get('_locale')) {
            $request->getSession()->set('_locale', $locale);
        } else {
            // if no explicit locale has been set on this request, use one from the session
            $request->setLocale($request->getSession()->get('_locale', $this->defaultLocale));
        }
    }

    public static function getSubscribedEvents()
    {
        return [
            // must be registered before (i.e. with a higher priority than) the default Locale listener
            KernelEvents::REQUEST => [['onKernelRequest', 20]],
        ];
    }
}

If you're using the default services.yaml configuration, you're done! Symfony will automatically know about the event subscriber and call the onKernelRequest method on each request.

デフォルトの services.yaml 構成を使用している場合は、これで完了です。 symfony は自動的にイベント サブスクライバーを認識し、各リクエストで onKernelRequest メソッドを呼び出します。

To see it working, either set the _locale key on the session manually (e.g. via some "Change Locale" route & controller), or create a route with the _locale default.

それが機能していることを確認するには、セッションに _locale キーを手動で設定するか (たとえば、「ロケールの変更」ルートとコントローラーを介して)、_locale デフォルトでルートを作成します。

Explicitly Configure the Subscriber

サブスクライバーを明示的に構成する

You can also explicitly configure it, in order to pass in the default_locale:

default_locale を渡すために、明示的に設定することもできます。
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
6
7
8
 
# config/services.yaml
services:
    # ...

    App\EventSubscriber\LocaleSubscriber:
        arguments: ['%kernel.default_locale%']
        # uncomment the next line if you are not using autoconfigure
        # tags: [kernel.event_subscriber]

That's it! Now celebrate by changing the user's locale and seeing that it's sticky throughout the request.

それでおしまい！ここで、ユーザーのロケールを変更して、リクエスト全体で一貫性があることを確認して祝いましょう。

Remember, to get the user's locale, always use the Request::getLocale method:

ユーザーのロケールを取得するには、常に Request::getLocale メソッドを使用することを忘れないでください。
1
2
3
4
5
6
7
 
// from a controller...
use Symfony\Component\HttpFoundation\Request;

public function index(Request $request)
{
    $locale = $request->getLocale();
}

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 LocaleSubscriber is called before the FirewallListener, which is responsible for handling authentication and setting the user token on the TokenStorage, you have no access to the user which is logged in.

この手法をさらに改善して、ログインしているユーザーのユーザー エンティティに基づいてロケールを定義することをお勧めします。ただし、LocaleSubscriber は、認証の処理と TokenStorage でのユーザー トークンの設定を担当する FirewallListener の前に呼び出されるため、ログインしているユーザーにはアクセスできません。

Suppose you have a locale property on your User entity and want to use this as the locale for the given user. To accomplish this, you can hook into the login process and update the user's session with this locale value before they are redirected to their first page.

User エンティティにロケール プロパティがあり、これを特定のユーザーのロケールとして使用したいとします。これを実現するには、ログイン プロセスにフックし、ユーザーが最初のページにリダイレクトされる前に、このロケール値でユーザーのセッションを更新します。

To do this, you need an event subscriber on the security.interactive_login event:

これを行うには、security.interactive_loginevent のイベント サブスクライバーが必要です。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
// src/EventSubscriber/UserLocaleSubscriber.php
namespace App\EventSubscriber;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Security\Http\Event\InteractiveLoginEvent;
use Symfony\Component\Security\Http\SecurityEvents;

/**
 * Stores the locale of the user in the session after the
 * login. This can be used by the LocaleSubscriber afterwards.
 */
class UserLocaleSubscriber implements EventSubscriberInterface
{
    private $requestStack;

    public function __construct(RequestStack $requestStack)
    {
        $this->requestStack = $requestStack;
    }

    public function onInteractiveLogin(InteractiveLoginEvent $event)
    {
        $user = $event->getAuthenticationToken()->getUser();

        if (null !== $user->getLocale()) {
            $this->requestStack->getSession()->set('_locale', $user->getLocale());
        }
    }

    public static function getSubscribedEvents()
    {
        return [
            SecurityEvents::INTERACTIVE_LOGIN => 'onInteractiveLogin',
        ];
    }
}

Caution

注意

In order to update the language immediately after a user has changed their language preferences, you also need to update the session when you change the User entity.

ユーザーが言語設定を変更した直後に言語を更新するには、User エンティティを変更するときにセッションも更新する必要があります。