CAKEPHP3:ログイン画面へのリダイレクト先について

Question

###前提・実現したいこと
CAKEPHP3のAuthコンポーネントを利用して、ログイン認証をしたいと思っております。
ただし、多言語に対応させる必要があり、URLとしてはhttps://www.hoge.com/jp/users/login
のようになることを想定しています。（「jp」部分にはその他「en」などの言語設定を表す文字列が入ります）

###発生している問題・エラーメッセージ
AuthコンポーネントのloginActionの設定でcontrollerとactionの指定をすることで
https://www.hoge.com/users/loginにリダイレクトはできるのですが、
https://www.hoge.com/jp/から認証の必要なページにアクセスしても
https://www.hoge.com/users/loginにリダイレクトされてしまい、
言語設定を表す「jp」が失われてしまいます。

これを言語設定つきのhttps://www.hoge.com/jp/users/login
へリダイレクトさせるためにはどのようにすればよいでしょうか？
よろしくお願いいたします。

###ルーティング設定
routes.phpは以下のように（全てではありませんが）記載しています。

    $routes->connect('/:language/:controller/:action/*', ['controller' => null, 'action' => null], ['language' => 'jp']);
    $routes->connect('/:language/:controller/*', ['controller' => null, 'action' => 'index'], ['language' => 'jp']);
    $routes->connect('/:language/:controller/:action/*', ['controller' => null, 'action' => null], ['language' => 'en']);
    $routes->connect('/:language/:controller/*', ['controller' => null, 'action' => 'index'], ['language' => 'en']);

    $routes->connect('/:language/:controller/:action/*', ['controller' => null, 'action' => null], ['language' => 'ja_JP']);
    $routes->connect('/:language/:controller/*', ['controller' => null, 'action' => 'index'], ['language' => 'ja_JP']);
    $routes->connect('/:language/:controller/:action/*', ['controller' => null, 'action' => null], ['language' => 'en_US']);
    $routes->connect('/:language/:controller/*', ['controller' => null, 'action' => 'index'], ['language' => 'en_US']);

日本語ページへは/jpまたは/ja_JPでアクセスする想定です。

Comments

[popobot]

なんらかのプラグインかprefixルーティングを使っているのでしょうか？

Answer 1

icchii様

ご回答ありがとうございました。
ご教示いただいたようにpersistの指定を行ってみたのですが、
https://www.hoge.com/users/loginへリダイレクトされてしまう
現象は変わらなかったのですが、Authコンポーネントの読み込みで

'loginAction' => [
  'controller' => 'Users',
  'action' => 'login',
  'language' => $language
],

としてその前に$languageに言語設定パラメータを格納しておくことで、
https://www.hoge.com/jpにアクセスした際にはログイン画面を
https://www.hoge.com/jp/users/loginとしてリダイレクトできるようになりました。

これがベストな方法では恐らくないかと思いますがひとまず目的の動作はできたので
自己解決としてクローズさせていただきます。

Comments

[popobot]

なるほど、'language'も設定しちゃえばよかったんですね

すみません... 後langじゃなくてlanguageだったので、'persist' => ['language']と指定しなければだめだったかもです（すでにやってみていたらスルーしてください）

[ranchu]

補足ありがとうございます。
'persist' => ['language']も試してはいましたが結果は同様でした。

[popobot]

ご連絡ありがとうございます。そうなんですね...コード上はそれっぽい処理がありましたが、何か足りないのかもしれません。なお、もう少し調べたところRouter::addUrlFilter()を使う方法もありそうだったので、自分の回答に追記しておきました。時間があったら試して見てください
※全url指定で'language'を指定すれば今のやり方でもうまくは行きそうですけどね

Answer 2

試してはいませんが、connect()の第３引数に'persist' => ['lang']を指定すればうまくいくかもしれません。CakePHP3のマニュアルにはありませんが、2系のマニュアルには説明が書いてありました。

persist はURLを新規に生成したときに、どのルーティングパラメーターが 自動的にインクルードされるのかを定義するために使われます。 URLで再定義することで一定のパラメーターをオーバーライドしたり、 false に設定することで除去できます。たとえば、 'persist' => array('lang') のように。

その他の参考

• 同じような質問がStackoverFlowにありましたので参考にしてください。
• また、そのような対応ができそうなプラグインcakephp-i18nもありました。

---

追記 persistオプションがうまく動かないみたいなので、もう少し調べたら、Router::addUrlFilter()方法があるみたいなので載せておきます。（実際には試していません）

Router::addUrlFilter(function ($params, $request) {
    if ($request->param('language')) {
        $params['language'] = $request->param('language');
    }
    return $params;
});

参考

• [CakePHP]URLクエリを自動で引き継ぎたい
• Cakephp 3 routing with language parameter

Comments

[ranchu]

追記ありがとうございます。
Router::addUrlFilter()を使ってみたところ、ログインURLに直接アクセスした場合
（https://www.hoge.com/jp/users/login）
には言語設定のついたログインページへアクセスできたのですが、
未ログイン状態で認証の必要なページへアクセスしログインページへリダイレクトされた場合
（https://www.hoge.com/jpへアクセスしてログインページへリダイレクト）
には言語設定が外れてしまいました。

Router::addUrlFilter()を使わないときはログインURLに直接アクセスした場合でも
https://www.hoge.com/users/loginにリダイレクトされてしまっていたので、
もし自分のやり方で何か問題が出た場合にはご教示いただいた方法の利用も検討したいと思います。
（未ログイン時の自動リダイレクトを止めたりできればこれでもいけそうですし）

[popobot]

検証ありがとうございます。うーん、不思議ですね... 手元の環境で動作確認してみたら、ちゃんと/jp/users/loginにリダイレクトできました。CakePHPのバージョンは3.4.10で検証しました。
Router::addUrlFilter()もpersistもどちらも動きました。

少し気になったのはroutes.phpの$routes->connect('/:language', []);の設定が質問に記載されていないけどどうなっているのかなぁぐらいで後は特別何も設定はいらなそうでした。

※自分は興味本位でやっているので、お忙しいと思いますので、別に返信不要ですよ^^