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 2.x　3.x CakePHP3

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

Message コメントをキャンセル

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

: cakephp3 カスタムバリデーションを簡易的に実装する方法

CakePHP3の独自のバリデーションをテーブルクラス内に簡単に記述する方法を解説。他のテーブルクラスでは使えないが、記述する量は少なく実装できるため、他で使わない処理を書くのには便利。

: CakePHP 2.3　Search Pluginで検索処理　その２表示件数を動的に変える方法

CakePHPの検索プラグイン Search Pluginの検索処理の中で動的に表示件数を変える方法です。

: CakePHP3のルーティング（routes.php）の変更が反映されない時はキャッシュのクリアを

CakePHP3でルーティングの設定変更をしたけど反映されない！そんなときは慌てず騒がずキャッシュをクリアしよう！ルーティングの設定もキャッシュされることがあるらしい。

: CakePHP 2.3でファイルをアップロード・その2　ファイル名を乱数で設定

CakePHPのアップロードするファイル名を乱数で変更しセキュリティを高める方法を解説。

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

CakePHP3の標準設定のタイムゾーンは「UTC（協定世界時）」に設定されている。これを日本標準時に変更する方法（app.php、bootstrap.phpの変更方法）の解説。

: CakePHP3のCakeDC/UsersのUserHelperでログアウトやreCAPTCHAをカスタマイズ

CakeDC謹製Usersプラグインの紹介。UserHelperを利用し、ログアウトのリンクや権限があるときのみ表示されるリンク、プロフィールページへのリンク、reCAPTCHAの設置方法などを解説。

: CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する

CakePHP3のkeywordsとdescriptionを設定する方法の解説。CakePHP3にはmetaタグを編集するHTMLヘルパーが用意されているためそれを利用すればOK！ポイントはブロック化を有効にすること。

: CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い

CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。

: CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法

CakePHP3で検索をするプラグイン「friendsofcake/search」の検索条件のカスタマイズ方法の解説。検索項目を増やしたり、以上、以下での検索や、チェックボックスによる検索の方法などを解説。