質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

91.28%

  • Laravel 5

    1021questions

    Laravel 5は、PHPフレームワークLaravelの最新バージョンで、2014年11月に発表予定です。ディレクトリ構造がが現行版より大幅に変更されるほか、メソッドインジェクションやFormRequestの利用が可能になります。

Laravel5.4で、モデルに使用されているCarbonのTimezoneをユーザごとに自動で切り替えたい

解決済

回答 2

投稿 編集

  • 評価
  • クリップ 1
  • VIEW 38

masaya_ohashi

score 7801

前提・実現したいこと

OSのシステム時刻のタイムゾーンはCET(UTC+1)、DBはシステム時刻と同じものを使用する設定です。この状態でViewなどにCarbonの時刻表示を行えば、CET時刻が表示されて、日本時刻にはなりません。

DBからLaravelのModelを取得したものをdd等のデバッグ表示で確認したところ、created_atやupdated_atはCarbonクラスに変換され、タイムゾーンはCETが設定されていました。これをそのままViewに渡したり、responseとしてブラウザに返すと、CETの時刻が表示されてしまいます。
しかし、日本で使っているときはJSTで表示したいので、以下のように、Model読み込み後に該当のプロパティに対してCarbon#timezoneを使ってJST時刻へ変換します。

$model->created_at->timezone("JST");


一応これでもJST表記になってくれるのですが、とにかくめんどくさいのです。画面に表示する時刻項目ごとにこんなことをしていては相当な数の行になります。いちいち人力で変換していては抜けの発生にも繋がります。
システムのタイムゾーンをJSTに変えることでこんなことを考えなくても済むのですが、今制作しているアプリは「海外からの利用」も想定しているため、特定のタイムゾーンで固定することは望ましくなく、ユーザ単位で表示されるタイムゾーンを切り替えることを実装する必要があります。

どうにかしてModelからCarbonプロパティへアクセスするときに、一括で指定したタイムゾーンへ変換する方法はないでしょうか?また、こういった「Laravelでユーザごとに使用するタイムゾーンを切り分けられる手法」があれば教えていただけないでしょうか。

考えている方法としては以下のような物があります。

  • Providerを使って、ログインユーザの設定したタイムゾーンに切り替える(しかしDBから受け取った値自体が書き変わらないのでうまくいかない)
  • アプリで使用するModel用の中間クラスModelBaseを作り、そのModelBase内でなんとか変換する(__constructorをいじってみたが、__constructor内ではまだプロパティが空なのでなにもできない)

 状況

Sampleというモデルで、created_atが2018-01-01 12:00:00なデータがDBに保存されているとします。

$sample = Sample::where('id', '=', 1)->first();
dd($sample->created_at, $sample->created_at->copy()->timezone("JST"));


この時ddで表示されるデータは以下のようになっています。

Carbon {#487 ▼
  +"date": "2018-01-01 12:00:00.000000"
  +"timezone_type": 3
  +"timezone": "UTC"
}
Carbon {#521 ▼
  +"date": "2018-01-01 21:00:00.000000"
  +"timezone_type": 2
  +"timezone": "JST"
}


これを、使用箇所ごとにtimezone設定するのではなく、ビューに渡される、またはレスポンスで返されるときにすべてのCarbonのタイムゾーンが一括で指定できるようになりたいのです。

発生している問題・エラーメッセージ

とくになし。

試したこと

  • Modelの読み込み前にdate_default_timezone_setをしてみたところ、Carbonのtimezoneプロパティだけは変わったが、時刻自体は書き換わらなかったので意味がなかった。
  • Modelの読み込み後にdate_default_timezone_setをしてみたところ、なにも変化はなかった。

補足情報(言語/FW/ツール等のバージョンなど)

Laravel 5.4
CentOS 7.1.1503
MariaDB 10.1.25-MariaDB

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

check解決した方法

0

※この試行錯誤の過程でLaravelを5.5にアップデートしたため、以下のコードは5.4で動作しない可能性がありますのでご注意ください。

アプリ内で使うモデルの共通基底クラスのasDateTimeをオーバーライドすることで解決しました。

<?php
namespace App;

use Illuminate\Database\Eloquent\Model;

class ModelBase extends Model {
    protected function asDateTime($value) {
        $date = parent::asDateTime($value);
        $time_zone = null;
        if(\Auth::check()) {
            $config = \Auth::user()->config; // ユーザ固有の設定を持つ自作クラスUserConfigモデル
            if($config) {
                $time_zone = $config->time_zone?:$time_zone; // UserConfigのtime_zoneが設定されていればそちらを使う
            }
        }
        if($time_zone) {
            $date->timezone($time_zone); // timezoneメソッドでCarbonのタイムゾーンを上書き
        }
        return $date;
    }
    public function fromDateTime($value)
    {
        // DBに保存する際に時刻がタイムゾーンの影響を受けてしまうため、デフォルトのタイムゾーンに戻す処理を挟む
        return empty($value) ? $value : $this->asDateTime($value)->timezone(config('app.timezone'))->format(
            $this->getDateFormat()
        );
    }
}

ただし、以下のようなHasAttribute#asDateTimeを経由しない処理の場合、当然ながらtime_zoneが適用されません。

  • Modelのミューテタ(getXXXXXAtributeメソッド)が定義されていたとき
  • Model$casts対象だったとき
  • Model$dates対象でないとき
  • HasAttribute#getAttributeFromArraygetAttributesgetOriginalを使って直接アクセスしたとき

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2018/01/11 13:55

    fromDateTimeで元のタイムゾーンに戻さないとDB保存時にDBのタイムゾーンとユーザのタイムゾーンのズレがそのままDBに保存されてしまうので修正しました。

    キャンセル

0

モデルに備わるアクセサを利用することで、要望の機能を実現できるかもしれません。
Laravel 5.5 Eloquent:ミューテタ

    public function getCreatedAtJstAttribute()
    {
        #〜ユーザーによる分岐処理なども必要であれば記述

        return $this->created_at->timezone("JST");
    }    
#利用
$model->created_at_jst

[追記]
created_at自体にアクセサを以下のようにつけても動作したので、ユーザー毎のタイムゾーン変更に有益かもしれません。

    public function getCreatedAtAttribute()
    {
        #return $this->asDateTime($this->attributes["created_at"])->timezone("CST");
        return $this->asDateTime($this->attributes["created_at"])->timezone("JST");
    }

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2018/01/09 17:42 編集

    その方法もありですが、これだとModelごとに全て書く必要がある、Ajax等のresponseで返すときにcreatedAtJstをappends等で追加する必要があるため、もう少し別の方法も待ってみたいと思います。

    キャンセル

  • 2018/01/09 17:50

    手間的にはアプリ用のモデルクラスを作ってのクラス継承やtraitを使うと共通化はできます。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

ただいまの回答率

91.28%

関連した質問

同じタグがついた質問を見る

  • Laravel 5

    1021questions

    Laravel 5は、PHPフレームワークLaravelの最新バージョンで、2014年11月に発表予定です。ディレクトリ構造がが現行版より大幅に変更されるほか、メソッドインジェクションやFormRequestの利用が可能になります。