CakePHP3のタイムゾーンを協定世界時UTCから日本標準時間JSTにずれを変更する方法

CakePHP3でタイムゾーンを指定する手順の解説

　
CakePHP3の定義ファイルに記載してある「タイムゾーン」の設定は、標準設定では「UTC」になっています。
これを日本時間に設定を変更します。
　
ちなみに、「UTC」は「協定世界時」と呼ばれる世界の標準時刻で、かつて広く使われていました「グリニッジ標準時（GMT）」から置き換えられたものです。
また、日本の標準時は「JST」と表現します。
　
　

CakePHP3でタイムゾーンの設定をする前に MySQLの設定を確認する

　
「CakePHP3でタイムゾーンを設定する手順」として開設を行いますが、まず最初に、下記の記事に従って、MySQL側でタイムゾーンの設定がされているか、確認をしてください。
　
MySQLのタイムゾーン（mysql_tzinfo_to_sql）の設定方法・XAMPP環境の解説も
　
　
この MySQLのタイムゾーンの設定ができていない場合は、下記のエラーメッセージが表示されるためです。
　

Error: SQLSTATE[HY000]: General error: 1298 Unknown or incorrect time zone: 'Asia/Tokyo'

　
ローカル環境でエラーが出ても問題ない場合は、次項の CakePHP3の設定を先に行っても問題ありませんが、本番環境などでエラーが発生することを避けたい場合は、先に MySQLの設定を行ってください。
　
　

CakePHP3の定義ファイルの設定

　
CakePHP3のタイムゾーンの変更は、設定ファイルである、app.php、bootstrap.phpの 2ファイルの設定情報を変更します。
　

/config/app.phpの値の変更

　
/config/app.php の「Datasources」にある「timezone」の値を変更します。
　
デフォルトでは「UTC」になっていますので、これを「Asia/Tokyo」もしくは「+09:00」にします。
　

    'Datasources' => [
        'default' => [
            'className' => 'Cake\Database\Connection',
            'driver' => 'Cake\Database\Driver\Mysql',
            'persistent' => false,
            'host' => 'localhost',
            'username' => 'root',
            'password' => 'pass',
            'database' => 'cake3',
            'encoding' => 'utf8',
//          'timezone' => 'UTC',
            'timezone' => 'Asia/Tokyo',
            'flags' => [],
            'cacheMetadata' => true,
            'log' => false,

CakePHP3.4 の場合は　/config/bootstrap.phpの値を変更

　
続けて、/config/bootstrap.php の「date_default_timezone_set」の値を変更します。
こちらもデフォルトでは「UTC」になっていますので、これを「Asia/Tokyo」にします。
　

/*
 * Set server timezone to UTC. You can change it to another timezone of your
 * choice but using UTC makes time calculations / conversions easier.
 */
// date_default_timezone_set('UTC');
date_default_timezone_set('Asia/Tokyo');

CakePHP3.6 の場合は　/config/app.phpの値を変更

　
CakePHP3.6の場合は、/config/app.php の「APP_DEFAULT_TIMEZONE」の値を変更します。
こちらもデフォルトでは「UTC」になっていますので、これを「Asia/Tokyo」にします。
　

    'App' => [
        'namespace' => 'App',
        'encoding' => env('APP_ENCODING', 'UTF-8'),
        'defaultLocale' => env('APP_DEFAULT_LOCALE', 'en_US'),
//      'defaultTimezone' => env('APP_DEFAULT_TIMEZONE', 'UTC'),
        'defaultTimezone' => env('APP_DEFAULT_TIMEZONE', 'Asia/Tokyo'),

変更されたことの確認

　
わざわざ記載するほどのことでもないですが、設定した内容が正しく変更されたことを確認するために、適当なテンプレートファイル「index.ctp」などに下記の日時を表示する処理を追記して、確認を行ってください。
　

<div>
<?php echo date("Y/m/d H:i:s"); ?>
</div>

php.iniのタイムゾーンの設定

　
CakePHP3の設定を行うことで、この「php.ini」の設定を行っていなくても日本時間の表示はできますが、CakePHPを使わない PHPのプログラムで日本時間になっていないということが発生する場合もありますので、予防措置として、php.iniの設定箇所についてもご紹介しておきます。
　
php.iniの場所は、標準設定の場合はそれぞれ下記になります。
　Linuxの場合　/etc/php.ini
　XAMPPの場合　c:\xampp\php\php.ini
　
下記の通り、「date.timezone」を検索し、「Asia/Tokyo」を設定します。

[Date]
; Defines the default timezone used by the date functions
; http://php.net/date.timezone
;date.timezone =
date.timezone = Asia/Tokyo

　
私の環境の XAMPPの php.iniでは「date.timezone」の記述が 2ヵ所にありました。
複数個所ないか、確認しておく方がいいでしょう。
　
また、php.iniの設定変更を反映させるために、Apacheを再起動することを忘れずに実行しましょう。
　
　

CakePHP3の関連記事