[CakePHP4]デバッグキット(Debug Kit)をインストールしても表示されない原因と対処法

[CakePHP4]デバッグキット(Debug Kit)をインストールしても表示されない原因と対処法
2021年05月02日2023年10月10日

CakePHP4のDebug Kitはかなり優秀でお気に入りなんですが、公式サイトに書かれている通りにインストールしても表示されませんでした。

現在VagrantでCakePHP4を使ったプロジェクトを開発しているのですが環境によっては公式サイト通りにやっても表示されないことがわかりました。

そこで、Vagrant + CakePHP4でDebug Kitを表示する方法を紹介します。

Debug Kitをインストール

CakePHP4はデフォルトでDebug Kitがインストールされています。もし削除しまって再インストールしたい場合は、下記コマンドを実行します。

php composer.phar require --dev cakephp/debug_kit "~4.0"

プラグインを有効化します。

bin/cake plugin load DebugKit

デバッグモードを有効化する

config/app_local.php
<?php
return [
    ~ 省略 ~
    //'debug' => filter_var(env('DEBUG', true), FILTER_VALIDATE_BOOLEAN),
    'debug' => true,

.envで管理している場合は、.env側を修正する必要があります。

基本的にこれだけでDebug Kitを有効化することができるのですが、表示されなかった場合は次をやる必要があります。

Debug Kit表示されなかった場合

Vagrantなどの仮想サーバーで開発している場合は、下記のように修正してあげる必要があります。

file
    public function bootstrap(): void
    {
        
        ~省略~
        ↓↓↓↓↓ここから
        /*
         * Only try to load DebugKit in development mode
         * Debug Kit should not be installed on a production system
         */
        if (Configure::read('debug')) {
            Configure::write('DebugKit.forceEnable', true);
            
            $this->addPlugin('DebugKit');
        }
       ↑↑↑↑↑ここまで
        ~省略~
     }
プラグインの有効化コマンドを何度も実行している場合は、
$this->addPlugin('DebugKit');
が大量に記述されてしまっていることがあるので、一個のみに修正してください。
(インストールしたけど表示されないな~と何度も実行したら3個ほど同じ記述が追加されていました( ノД`)シクシク…)

この方法は、本家のイシューで紹介されている方法です。

https://github.com/cakephp/debug_kit/issues/616

まとめ

今回CakePHP4のDebug Kitを表示する方法を紹介しました。

コメント

コメントを残す

お名前(任意)
コメント:新規