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 CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3、CakePHP4のdatetime型カラムの日時の扱い。秒まで表示する方法

CakePHP3の日時カラムで秒まで扱う場合はdate()、strtotime()関数ではうまくいかない。CakePHP3であらかじめ用意された「i18nFormat()」を使用する。

: CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース＋解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。

: CakePHP 2.3　デバッグキット（DebugKit）超初心者向けフォロー講座

CakePHP初心者に向けてデバッグキット（DebugKit）のインストール方法、はまりポイントを解説。

: CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その２

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその2でバリデーションなどの実用的なカスタマイズ方法を解説。

: CakePHP3チュートリアルで日付と時刻のDateTimeでエラーが出たときの対処方法

CakePHP3のブックマークチュートリアルには記載ミスもあり、そのまま動かない個所もある。CakePHP3では namespaceを使うようになったので、classを呼び出すときに￥を追加する必要が！

: CakePHP3ログファイルへの出力・$this->log()、独自ログへの出力方法の解説

コントロール、モデルの変数の中身を見るときはログに出力する方法が有効です。$this->log()を利用すると変数だけじゃなく、連想配列、オブジェクトも簡単にログ出力ができます。

: CakePHP 2.3で saveの便利な使い方・サンプルソース付き

CakePHPのレコードを保存、更新する際に使う Saveを詳細解説します。

: CakePHP 2.3　Search Pluginで検索処理　その１設置方法

CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。

: URL短縮サービス「TTTオンライン（https://ttt.onl）」公開

URL短縮サービス「TTTオンライン（https://ttt.onl）」を公開。メールやSNSでは使いにくい長いURLを短いURLに変換するサービス。QRコードも。Google URL Shortenerが2019年3月にサービス終了。