CakePHP3のデバッグキット（DebugKit）を強制的に有効、無効に変更する方法

2018/08/05 2019/03/02

CakePHP3のデバッグキットを強制的に有効、無効の切り替えを行う方法

　
CakePHP3には、強力なデバッグツールとして「デバッグキット（DebugKit）」が付属しています。
　
これを強制的に有効化したり、無効化したりする方法を解説します
　
　

CakePHP3のデバッグキットを強制的に有効にする方法

　
CakePHP3でプログラム開発をしている際、デバッグキットが表示されていませんでした。
　
その調査の過程で、エラーログ（/logs/error.log）を見ると、下記のようなワーニングメッセージが出力されていました。
　
Warning: DebugKit is disabling itself as your host www.ドメイン.com is not in the known safe list of top-level-domains (localhost, dev, invalid, test, example, local). If you would like to force DebugKit on use the DebugKit.forceEnable Configure option.
　
ざっくり要約すると、下記のような感じです。
「ドメインが開発サイト用のものではないので、デバッグキットの起動を停止します。
強制的にデバッグキットを使う場合は、「DebugKit.forceEnable」の設定をしてください。」
　
　
デバッグキットは、開発環境では動作しても、本番環境では動作しないようにしておく必要があります。
そのため、あらかじめ開発環境でありがちなトップレベルドメインとして「localhost, dev, invalid, test, example, local」が設定されており、その場合はデバッグツールが有効になり表示されます。
それ以外の場合は、開発環境ではないとして、デバッグキットは表示されない仕様になっています。
　
つまり、デバッグキットが表示されないのは、トップレベルドメインが「localhost, dev, invalid, test, example, local」ではないので、開発環境として認識されていない、ということです。
　
　
そのため、対応方法としては下記のいずれかになります。
　

開発用のトップレベルドメイン「localhost, dev, invalid, test, example, local」のリストに追加する
強制的に有効にする「DebugKit.forceEnable」の設定をする

開発用のトップレベルドメインのリストに追加する

　
前者の設定は、「/vendor/cakephp/debug_kit/src/toolbarservice.php」の 134行目に以下の記述があります。
　

$safeTopLevelDomains = ['localhost', 'dev', 'invalid', 'test', 'example', 'local'];

1	$safeTopLevelDomains = ['localhost', 'dev', 'invalid', 'test', 'example', 'local'];

　
この配列に求めるドメインのトップレベルドメインを追加することで対応することができます。
　
ただし、トップレベルドメインですので、「www.example.com」というドメインの場合は、「.com」がトップレベルドメインとなりますので、テスト環境だけを指定するのはなかなか難しそうです。
　
ソースコードを確認すると、ホスト名を取得し、「.」で区切った一番最後の文字列を取得して、それをトップレベルドメインとしていました。
なので「www.ドメイン.com」の場合は、「.com」がトップレベルドメインになります。
　
　

強制的に有効にする「DebugKit.forceEnable」の設定をする

　
そのため、普通は、2つ目の項目の「DebugKit.forceEnable」の設定をすることになります。
　
「DebugKit.forceEnable」を設定する具体的な対処する内容は、「/config/app.php」に下記を追加すれば OKです。
　

    'DebugKit' => [
        'forceEnable' => true,
    ],

'DebugKit' => [

'forceEnable' => true,

　
追加する場所は、「app.php」内のどこでも問題ありませんが、本番に移す際はデバッグキットを使用しないように変更する必要がありますので、ファイルの一番最後などに分かりやすく書いておく方がいいでしょう。
　

CakePHP3のデバッグキットを強制的に無効にする方法

　
デバッグキットを強制的に有効にする方法を紹介しましたので、ついでに、強制的に無効にする方法も紹介しておきます。
　
　
デバッグキットを強制的に無効にする場合は、設定ファイル「/config/app.php」に記述してある内容を、下記の様に変更します。
　

// 変更前
'debug' => filter_var(env('DEBUG', true), FILTER_VALIDATE_BOOLEAN),
　
// 変更後
'debug' => filter_var(env('DEBUG', false), FILTER_VALIDATE_BOOLEAN),

// 変更前

'debug' => filter_var(env('DEBUG', true), FILTER_VALIDATE_BOOLEAN),

// 変更後

'debug' => filter_var(env('DEBUG', false), FILTER_VALIDATE_BOOLEAN),

　
「app.php」の 12行目辺りにある設定を、「true」から「false」に変更します。
　
ただ、先に書いたとおり、一般的なドメインで運用しているサイトは、デバッグキットは無効になりますので、わざわざ強制的に無効にしなくても問題ないと言えます。
　
　

- CakePHP 3.x 4.x 5.x CakePHP3

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説

CakePHP3でCSVファイルをアップロードしレコードを追加、更新する処理の作成方法の解説。モデルとは直接関連しないフォームからCSVファイルをアップロードするため汎用的に使用可能。

: Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法

CakePHP4のコマンド（シェル）に対して、環境変数を指定して実行する方法を解説。LinuxとWindows上のXAMPPとでは記述方法が異なるため、Windowsのsetコマンドについても詳細解説。

: CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法

CakePHP3でtitleタグ、h1タグのテキストをデフォルトから変更する方法を解説。テンプレートファイルに「$this->assign()」でテキストを指定して「/Layout/defult.ctp」で受け取る。