# DebugKit ドキュメント
DebugKit は、CakePHP 2 アプリケーションにデバッグ用のツールバーを追加します。このプラグインは、
[pieceofcake2/cakephp](https://github.com/pieceofcake2/cakephp) 向けの
[cakephp/debug_kit](https://github.com/cakephp/debug_kit) のフォークです。
- [インストール](#installation)
- [ツールバー](#the-toolbar)
- [パネル](https://pieceofcake2.github.io/debug_kit/ja/panels.md): 組み込みのパネルと独自のパネルの開発
- [設定](https://pieceofcake2.github.io/debug_kit/ja/configuration.md): ツールバーの設定、リクエスト履歴のストレージ、キャッシュエンジン
- [2.2.x からのアップグレード](https://pieceofcake2.github.io/debug_kit/ja/upgrading.md)
- 2.3.x と 2.2.x の [ツールバーのスクリーンショット](https://pieceofcake2.github.io/debug_kit/ja/screenshots.md)
- [クレジット](#credits)
## インストール
[Composer](https://getcomposer.org/) でプラグインをインストールします。
```bash
composer require --dev pieceofcake2/debug_kit
```
プラグインのタイプは `cakephp-plugin` なので、`composer/installers` によってプラグインディレクトリに
インストールされます。正しい場所にインストールされるように、アプリケーションの `composer.json` で
`installer-paths` を設定してください。
| 構成 | `installer-paths` |
| --- | --- |
| モダン (`config/`、`src/`、`templates/`、`plugins/`) | `"plugins/{$name}/": ["type:cakephp-plugin"]` |
| レガシー (`app/Config/`、`app/Plugin/`) | `"app/Plugin/{$name}/": ["type:cakephp-plugin"]` |
### プラグインを有効にする
`config/bootstrap.php` (レガシー構成では `app/Config/bootstrap.php`) でプラグインを読み込みます。
すでに `CakePlugin::loadAll()` を使っている場合は不要です。
```php
CakePlugin::load('DebugKit');
```
`src/Controller/AppController.php` (レガシー構成では `app/Controller/AppController.php`) に
ツールバーのコンポーネントを追加します。
```php
class AppController extends Controller
{
public $components = ['DebugKit.Toolbar'];
}
```
`config/core.php` で `debug` が 1 以上のときに、ツールバーが表示されます。
レイアウト (通常は `templates/Layouts/default.ctp`、レガシー構成では
`app/View/Layouts/default.ctp`) から `sql_dump` エレメントを削除してください。このエレメントは
Sql Log パネルが読み込む前にクエリログを空にしてしまうので、パネルに "No query logs" と表示されます。
## ツールバー
2.3.0 から、ツールバーは DebugKit 5 (cakephp/debug_kit 5.x) の見た目とアーキテクチャを、
CakePHP 2 に合わせて取り入れています。
- HTML ページの右下に小さな CakePHP のアイコンが表示されます。クリックするとツールバーが開き、
ページの下部にパネルごとのボタンが並びます。ボタンをクリックすると、パネルの内容がスライドして
表示されます。Esc でパネルまたはツールバーを閉じ、矢印キーでパネルを切り替えます。
- ツールバーは iframe の中に描画されます。そのため、アプリケーションの CSS や JavaScript がツールバーを
壊すことはなく、ツールバーがアプリケーションを壊すこともありません。
- 各リクエストの最後 (`ToolbarComponent::shutdown()`、リダイレクトの場合は `beforeRedirect()`) に、
パネルが描画されて [リクエスト履歴のストレージ](https://pieceofcake2.github.io/debug_kit/ja/configuration.md#request-history-storage) に
保存され、小さなローダースクリプト (`webroot/js/inject-iframe.js`) が `` の前に挿入されます。
その後、ツールバー (`/debug_kit/requests/view/