Debug Kit¶

インストール¶

デフォルトで、DebugKit はデフォルトのアプリケーションスケルトンにインストールされています。 もし削除してしまって再インストールしたい場合は、以下のコマンドをアプリケーションの ルートディレクトリー (composer.json ファイルのある場所) で実行してください。

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

そして以下のコマンドでプラグインを有効化する必要があります。

bin/cake plugin load DebugKit

設定¶

• DebugKit.panels - DebugKit のパネルを有効化または無効化します。 次のようにして、任意の標準パネルを無効にすることができます。

  // DebugKit をロードする前に
  Configure::write('DebugKit.panels', ['DebugKit.Packages' => false]);
  

• DebugKit.includeSchemaReflection - スキーマリフレクションクエリーの ロギングを有効にするには、true に設定します。デフォルトは無効になっています。

• DebugKit.safeTld - ローカル開発用のトップレベルドメインのホワイトリストを設定します。 これにより安全でないと判断したホスト上で DebugKit を表示できるようになります。

  // 例: http://foo.bar.dev または http://my-shop.local のドメインはローカルとして許可する
  Configure::write('DebugKit.safeTld', ['dev', 'local', 'example']);
  

• DebugKit.forceEnable - DebugKit を強制的に表示します。これを使うときは注意してください。 通常は単純にローカルのトップレベルドメインをホワイトリストに追加したほうが安全です。 使用例:

  // DebugKit をロードする前に
  Configure::write('DebugKit.forceEnable', true);
  

/**
 * debug_kit コネクションは DebugKit のメタデータを格納します。
 */
'debug_kit' => [
    'className' => 'Cake\Database\Connection',
    'driver' => 'Cake\Database\Driver\Mysql',
    'persistent' => false,
    'host' => 'localhost',
    //'port' => 'nonstandard_port_number',
    'username' => 'dbusername',    // Your DB username here
    'password' => 'dbpassword',    // Your DB password here
    'database' => 'debug_kit',
    'encoding' => 'utf8',
    'timezone' => 'UTC',
    'cacheMetadata' => true,
    'quoteIdentifiers' => false,
    //'init' => ['SET GLOBAL innodb_stats_on_metadata = 0'],
],

ツールバーの使い方¶

DebugKit ツールバーは、いくつかのパネルで構成されています。これらのパネルは、 DebugKit をインストールしてロードした後、ブラウザーの右下隅にある CakePHP アイコンをクリックすると表示されます。各パネルは、パネルクラスとビューエレメントで構成されています。 一般的に、パネルは単一の種類の情報のコレクションの処理やログやリクエスト情報の表示を行います。 ツールバーからパネルを表示したり、独自のカスタムパネルを追加することを選択できます。

各パネルはアプリケーションの様々な側面を見せてくれます。

• Cache リクエスト中のキャッシュの使用状況の確認とキャッシュのクリアー。

• Environment PHP 及び CakePHP に関連する環境変数の表示。

• History 以前のリクエストの一覧の表示と、以前のリクエストのツールバーデータの読み込みと表示。

• Include タイプごとにグループ化されたインクルードファイルを表示。

• Log このリクエスト中にログファイルに加えられたすべてのエントリーを表示。

• Packages 現在のバージョンのパッケージの依存関係の一覧を表示し、 古いパッケージをチェックすることができます。

• Mail このリクエスト中の全てのメール送信を表示し、 送信せずに開発中のメールのプレビューができます。

• Request 現在のリクエスト、GET、POST、Cake パラメーター、現在のルート情報、クッキー情報の表示。

• Session 現在のセッション情報の表示。

• Sql Logs 各データベースコネクションの SQL ログの表示。

• Timer リクエスト中に DebugKit\DebugTimer で設定されたすべてのタイマーと、 DebugKit\DebugMemory で収集されたメモリー使用状況の表示。

• Variables コントローラーでセットされたビュー変数の表示。

履歴パネルを使用する¶

履歴パネルは DebugKit で最も勘違いされやすい機能の一つです。 エラーやリダイレクトを含む以前のリクエストのツールバーのデータを表示することができます。

ご覧のようにパネルにはリクエストの一覧が含まれます。左側にドットがついているのがアクティブな リクエストです。どれかのリクエストをクリックするとそのリクエストのデータが読み込まれます。 履歴データがロードされると代替のデータが読み込まれたことを示すようにパネルのタイトルが遷移します。

メールパネルを使用¶

メールパネルは、リクエストの間に送信された全てのメールを追跡することができます。

メーラープレビューは、開発中のメールを簡単にプレビューすることができます。

// src/Mailer/MailPreview/WelcomePreview.php の中で
namespace App\Mailer\Preview;

use DebugKit\Mailer\MailPreview;

class WelcomePreview extends MailPreview
{
    public function welcome()
    {
        $mailer = $this->getMailer('Welcome');
        // メーラーのテンプレート変数受信者を設定します。

        return $mailer;
    }
}

独自のパネルを開発する¶

アプリケーションのデバッグを補助するための DebugKit の独自のカスタムパネルを 作成することができます。

namespace App\Panel;

use DebugKit\DebugPanel;

/**
 * My Custom Panel
 */
class MyCustomPanel extends DebugPanel
{
    ...
}

namespace MyPlugin\Panel;

use DebugKit\DebugPanel;

class MyCustomPanel extends DebugPanel
{
    public $plugin = 'MyPlugin';
        ...
}

// src/Application.php の bootstrap() メソッドの中に追加
Configure::write('DebugKit.panels', ['App', 'MyPlugin.MyCustom']);
$this->addPlugin('DebugKit', ['bootstrap' => true]);

ヘルパー関数¶

• sql() ORM クエリーから SQL をダンプします。

• sqld() ORM クエリーから SQL をダンプして終了します。