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

Question

###前提・実現したいこと
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

Answer 1

モデルに備わるアクセサを利用することで、要望の機能を実現できるかもしれません。
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");
    }

Comments

[masaya_ohashi]

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

[aro10]

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

Answer 2

※この試行錯誤の過程で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#getAttributeFromArrayやgetAttributesやgetOriginalを使って直接アクセスしたとき

Comments

[masaya_ohashi]

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