Skip to content

Commit e89cf2b

Browse files
committed
Update docs
1 parent 81a72fb commit e89cf2b

9 files changed

Lines changed: 59 additions & 38 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ For details and older versions see [version map](https://github.com/cakephp/debu
2424

2525
* Install the plugin with [Composer](https://getcomposer.org/) from your CakePHP Project's ROOT directory (where the **composer.json** file is located)
2626
```sh
27-
php composer.phar require --dev cakephp/debug_kit:"^5.0"
27+
php composer.phar require --dev cakephp/debug_kit:"^6.0"
2828
```
2929

30-
* [Load the plugin](https://book.cakephp.org/5/en/plugins.html#loading-a-plugin)
30+
* [Load the plugin](https://book.cakephp.org/6/en/plugins.html#loading-a-plugin)
3131
```
3232
bin/cake plugin load DebugKit --only-debug
3333
```
@@ -60,7 +60,7 @@ requests](https://help.github.com/articles/using-pull-requests) or open
6060
## Documentation
6161

6262
Documentation for DebugKit can be found in the
63-
[CakePHP documentation](https://book.cakephp.org/debugkit/5/en/index.html).
63+
[CakePHP documentation](https://book.cakephp.org/debugkit/6/en/index.html).
6464

6565
## Panels
6666
Panels by other plugins:

‎docs/.vitepress/config.js‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ const tocJa = require('./toc_ja.json')
88
const tocPt = require('./toc_pt.json')
99

1010
const versions = {
11-
text: '5.x',
11+
text: '6.x',
1212
items: [
13-
{ text: '5.x (current)', link: 'https://book.cakephp.org/debugkit/5/', target: '_self' },
13+
{ text: '6.x (current)', link: 'https://book.cakephp.org/debugkit/6/', target: '_self' },
14+
{ text: '5.x', link: 'https://book.cakephp.org/debugkit/5/', target: '_self' },
1415
{ text: '4.x', link: 'https://book.cakephp.org/debugkit/4/en/', target: '_self' },
1516
],
1617
}
@@ -20,12 +21,12 @@ export default {
2021
srcDir: '.',
2122
title: 'DebugKit',
2223
description: 'CakePHP DebugKit Documentation',
23-
base: '/debugkit/5/',
24+
base: '/debugkit/6/',
2425
rewrites: {
2526
'en/:slug*': ':slug*',
2627
},
2728
sitemap: {
28-
hostname: 'https://book.cakephp.org/debugkit/5/',
29+
hostname: 'https://book.cakephp.org/debugkit/6/',
2930
},
3031
themeConfig: {
3132
siteTitle: false,
@@ -34,7 +35,7 @@ export default {
3435
{ icon: 'github', link: 'https://github.com/cakephp/debug_kit' },
3536
],
3637
editLink: {
37-
pattern: 'https://github.com/cakephp/debug_kit/edit/5.x/docs/:path',
38+
pattern: 'https://github.com/cakephp/debug_kit/edit/6.x/docs/:path',
3839
text: 'Edit this page on GitHub',
3940
},
4041
sidebar: tocEn,

‎docs/en/configuration.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuration
22

3-
DebugKit supports several configuration keys that let you tailor the toolbar for local development.
3+
DebugKit supports several configuration keys that let you tailor the toolbar for local development. Every key below is listed with its default value in DebugKit's `config/app.example.php`, which you can copy into your application's `config` directory.
44

55
* `DebugKit.panels` enables or disables individual panels:
66

@@ -32,6 +32,12 @@ Configure::write('DebugKit.forceEnable', function () {
3232
Configure::write('DebugKit.ignorePathsPattern', '/\.(jpg|png|gif)$/');
3333
```
3434

35+
* `DebugKit.requestCount` controls how many requests are kept in the History panel. The default is `20`:
36+
37+
```php
38+
Configure::write('DebugKit.requestCount', 50);
39+
```
40+
3541
* `DebugKit.maxDepth` controls how many levels of nested data are rendered in general debug output. The default is `5`.
3642
* `DebugKit.variablesPanelMaxDepth` controls how many levels of nested data are rendered in the Variables panel. The default is `5`.
3743

‎docs/en/custom-panels.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ Custom panels must extend `DebugPanel`.
2121

2222
## Callbacks
2323

24-
Panel objects hook into the current request through the `Controller.initialize` and `Controller.shutdown` events by default. If your panel needs additional events, implement `implementedEvents()` and return the full event map your panel requires.
24+
By default panels only subscribe to the `Controller.shutdown` event, which is where `shutdown()` collects the panel data. The `initialize()` hook is called for every loaded panel by DebugKit's middleware before the controller runs. If your panel needs additional events, implement `implementedEvents()` and return the full event map your panel requires.
2525

2626
The built-in panels are the best reference when you need examples.
2727

2828
## Panel Elements
2929

3030
Each panel should have a matching view element that renders the panel content. The element name is the underscored form of the class name:
3131

32-
* `SessionPanel` maps to `session_panel.php`
33-
* `SqllogPanel` maps to `sqllog_panel.php`
32+
* `CachePanel` maps to `cache_panel.php`
33+
* `SqlLogPanel` maps to `sql_log_panel.php`
3434

3535
Store panel elements in `templates/element`.
3636

‎docs/en/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ DebugKit stores panel data in a database. The default setup uses SQLite through
1515
Install the plugin with Composer from your application's root directory:
1616

1717
```bash
18-
php composer.phar require --dev cakephp/debug_kit:"^5.0"
18+
php composer.phar require --dev cakephp/debug_kit:"^6.0"
1919
```
2020

2121
Then load the plugin in debug mode:

‎docs/en/toolbar.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,19 @@ The DebugKit toolbar appears after you click the CakePHP icon in the lower-right
55
Built-in panels include:
66

77
* **Cache** shows cache usage during the request and lets you clear caches.
8+
* **Deprecations** renders deprecation warnings in a less disruptive format.
89
* **Environment** shows PHP and CakePHP environment details.
910
* **History** lists previous requests and lets you inspect their panel data.
10-
* **Include** groups included files by type.
1111
* **Log** shows log entries created during the request.
12-
* **Packages** lists installed dependencies, their versions, and outdated packages.
1312
* **Mail** captures mail sent during the request and supports previews.
13+
* **Packages** lists installed dependencies, their versions, and outdated packages.
14+
* **Plugins** lists the plugins loaded by the application.
1415
* **Request** shows request data, route information, cookies, and request parameters.
15-
* **Session** displays the active session contents.
16-
* **Sql Logs** shows SQL logs for each datasource.
16+
* **Routes** lists the routes matched during the request.
17+
* **Sql Log** shows SQL logs for each datasource.
1718
* **Timer** displays timers from `DebugKit\DebugTimer` and memory readings from `DebugKit\DebugMemory`.
1819
* **Variables** shows view variables set in the controller.
19-
* **Deprecations** renders deprecation warnings in a less disruptive format.
20+
21+
The deprecated **Include** and **Session** panels still exist but are disabled by default. Use the Environment panel instead of Include, and the Request panel instead of Session.
2022

2123
You can use the built-in panels as-is or register your own custom panels alongside them.

‎docs/fr/index.md‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ DebugKit est destiné uniquement aux environnements de développement local à u
1111
Par défaut, DebugKit est installé avec le squelette d'application. Si vous l'avez retiré, réinstallez-le depuis le répertoire racine de l'application :
1212

1313
```bash
14-
php composer.phar require --dev cakephp/debug_kit:"^5.0"
14+
php composer.phar require --dev cakephp/debug_kit:"^6.0"
1515
```
1616

1717
Chargez ensuite le plugin :
@@ -31,18 +31,21 @@ La toolbar DebugKit comprend plusieurs panneaux accessibles depuis l'icône Cake
3131
Chaque panneau inspecte un aspect différent de l'application :
3232

3333
* **Cache** montre l'utilisation du cache et permet de le vider.
34+
* **Deprecations** affiche les avertissements de dépréciation dans un format moins intrusif.
3435
* **Environment** affiche les variables d'environnement liées à PHP et CakePHP.
3536
* **History** affiche la liste des requêtes précédentes et permet de recharger leurs données.
36-
* **Include** montre les fichiers inclus par type.
3737
* **Log** affiche les écritures de log de la requête.
38-
* **Packages** affiche les dépendances installées et les versions obsolètes.
3938
* **Mail** affiche les emails envoyés pendant la requête.
39+
* **Packages** affiche les dépendances installées et les versions obsolètes.
40+
* **Plugins** liste les plugins chargés par l'application.
4041
* **Request** affiche les informations de requête, de route et les cookies.
41-
* **Session** affiche le contenu de la session.
42-
* **Sql Logs** affiche les logs SQL pour chaque connexion.
42+
* **Routes** liste les routes correspondantes à la requête.
43+
* **Sql Log** affiche les logs SQL pour chaque connexion.
4344
* **Timer** affiche les timers créés avec `DebugKit\\DebugTimer` ainsi que l'usage mémoire via `DebugKit\\DebugMemory`.
4445
* **Variables** affiche les variables de vue définies par le contrôleur.
4546

47+
Les panneaux dépréciés **Include** et **Session** existent toujours mais sont désactivés par défaut. Utilisez le panneau Environment à la place de Include, et le panneau Request à la place de Session.
48+
4649
## Utiliser le panneau History
4750

4851
Le panneau History permet de consulter les données de requêtes précédentes, y compris après une erreur ou une redirection.
@@ -80,11 +83,11 @@ class MyCustomPanel extends DebugPanel
8083

8184
### Callbacks
8285

83-
Par défaut, les panneaux s'abonnent aux événements `Controller.initialize` et `Controller.shutdown`. Si vous avez besoin d'autres événements, implémentez `implementedEvents()`.
86+
Par défaut, les panneaux ne s'abonnent qu'à l'événement `Controller.shutdown`, dans lequel `shutdown()` collecte les données du panneau. La méthode `initialize()` est appelée pour chaque panneau chargé par le middleware de DebugKit avant l'exécution du contrôleur. Si vous avez besoin d'autres événements, implémentez `implementedEvents()`.
8487

8588
### Éléments de panneau
8689

87-
Chaque panneau s'appuie sur un élément de vue. Le nom suit la convention underscore de la classe, par exemple `SessionPanel` devient `session_panel.php`.
90+
Chaque panneau s'appuie sur un élément de vue. Le nom suit la convention underscore de la classe, par exemple `CachePanel` devient `cache_panel.php`.
8891

8992
### Titres et éléments personnalisés
9093

‎docs/ja/index.md‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ DebugKit は単一ユーザーのローカル開発環境でのみ使用して
1111
アプリケーションのルートディレクトリーで次を実行します。
1212

1313
```bash
14-
php composer.phar require --dev cakephp/debug_kit:"^5.0"
14+
php composer.phar require --dev cakephp/debug_kit:"^6.0"
1515
```
1616

1717
続いてプラグインを有効化します。
@@ -26,6 +26,7 @@ bin/cake plugin load DebugKit --only-debug
2626
* `DebugKit.includeSchemaReflection` を `true` にするとスキーマリフレクションのクエリーを記録します。
2727
* `DebugKit.safeTld` でローカル開発用の TLD を追加できます。
2828
* `DebugKit.forceEnable` で DebugKit を強制表示できます。
29+
* `DebugKit.requestCount` で履歴パネルに保持するリクエスト数を変更できます(デフォルトは `20`)。
2930

3031
## データベース設定
3132

@@ -36,18 +37,21 @@ bin/cake plugin load DebugKit --only-debug
3637
DebugKit ツールバーはブラウザー右下の CakePHP アイコンから開けます。各パネルはアプリケーションの異なる側面を表示します。
3738

3839
* **Cache** キャッシュ使用状況の確認と削除。
40+
* **Deprecations** 非破壊的な形式で非推奨警告を表示します。
3941
* **Environment** PHP と CakePHP の環境情報。
4042
* **History** 過去のリクエスト一覧とそのデータの再表示。
41-
* **Include** 読み込まれたファイル一覧。
4243
* **Log** リクエスト中に書かれたログ。
43-
* **Packages** 依存パッケージとバージョン情報。
4444
* **Mail** 送信メールの確認とプレビュー。
45+
* **Packages** 依存パッケージとバージョン情報。
46+
* **Plugins** アプリケーションで読み込まれたプラグインの一覧。
4547
* **Request** 現在のリクエスト情報、ルート、Cookie。
46-
* **Session** セッション内容。
47-
* **Sql Logs** 接続ごとの SQL ログ。
48+
* **Routes** リクエストでマッチしたルートの一覧。
49+
* **Sql Log** 接続ごとの SQL ログ。
4850
* **Timer** `DebugKit\\DebugTimer` と `DebugKit\\DebugMemory` の情報。
4951
* **Variables** ビュー変数。
5052

53+
非推奨の **Include** と **Session** パネルも残っていますが、デフォルトでは無効です。Include の代わりに Environment パネル、Session の代わりに Request パネルを使ってください。
54+
5155
## 履歴パネルを使う
5256

5357
履歴パネルではエラーやリダイレクトを含む過去のリクエストを確認できます。
@@ -107,11 +111,11 @@ class MyCustomPanel extends DebugPanel
107111

108112
### コールバック
109113

110-
デフォルトでは `Controller.initialize` と `Controller.shutdown` を購読します。追加イベントが必要なら `implementedEvents()` を定義してください。
114+
デフォルトではパネルは `Controller.shutdown` イベントのみを購読し、`shutdown()` でパネルデータを収集します。`initialize()` はコントローラー実行前に DebugKit のミドルウェアが各パネルに対して呼び出します。追加イベントが必要なら `implementedEvents()` を定義してください。
111115

112116
### パネル要素
113117

114-
パネル表示用のビュー要素を用意します。名前はクラス名のアンダースコア形式です。例えば `SessionPanel` は `session_panel.php` を使います。
118+
パネル表示用のビュー要素を用意します。名前はクラス名のアンダースコア形式です。例えば `CachePanel` は `cache_panel.php` を使います。
115119

116120
### カスタムタイトルとエレメント
117121

‎docs/pt/index.md‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ DebugKit deve ser usado apenas em ambientes locais de desenvolvimento para um ú
1111
No diretório raiz da aplicação, execute:
1212

1313
```bash
14-
php composer.phar require --dev cakephp/debug_kit:"^5.0"
14+
php composer.phar require --dev cakephp/debug_kit:"^6.0"
1515
```
1616

1717
Depois carregue o plugin:
@@ -31,16 +31,21 @@ A toolbar do DebugKit é exibida ao clicar no ícone do CakePHP no canto inferio
3131
Cada painel mostra uma parte diferente da aplicação:
3232

3333
* **Cache** mostra o uso de cache e permite limpá-lo.
34+
* **Deprecations** exibe avisos de depreciação de forma menos intrusiva.
3435
* **Environment** exibe variáveis de ambiente relacionadas a PHP e CakePHP.
3536
* **History** mostra requisições anteriores e permite recarregar seus dados.
36-
* **Include** exibe os arquivos incluídos por tipo.
3737
* **Log** mostra as entradas de log da requisição.
38+
* **Mail** mostra os e-mails enviados durante a requisição e permite pré-visualização.
39+
* **Packages** mostra as dependências instaladas e as versões desatualizadas.
40+
* **Plugins** lista os plugins carregados pela aplicação.
3841
* **Request** exibe dados da requisição atual, rota e cookies.
39-
* **Session** exibe o conteúdo da sessão.
40-
* **Sql Logs** mostra logs SQL por conexão.
42+
* **Routes** lista as rotas correspondentes à requisição.
43+
* **Sql Log** mostra logs SQL por conexão.
4144
* **Timer** exibe timers criados com `DebugKit\\DebugTimer` e dados de memória com `DebugKit\\DebugMemory`.
4245
* **Variables** exibe variáveis de view definidas no controller.
4346

47+
Os painéis depreciados **Include** e **Session** ainda existem, mas estão desativados por padrão. Use o painel Environment no lugar do Include e o painel Request no lugar do Session.
48+
4449
## Usando o painel History
4550

4651
O painel History permite revisar dados de requisições anteriores, incluindo erros e redirecionamentos.
@@ -70,11 +75,11 @@ class MyCustomPanel extends DebugPanel
7075

7176
### Callbacks
7277

73-
Por padrão os painéis se inscrevem nos eventos `Controller.initialize` e `Controller.shutdown`. Se precisar de eventos adicionais, implemente `implementedEvents()`.
78+
Por padrão os painéis apenas assinam o evento `Controller.shutdown`, no qual `shutdown()` coleta os dados do painel. O hook `initialize()` é chamado para cada painel carregado pelo middleware do DebugKit antes da execução do controller. Se precisar de eventos adicionais, implemente `implementedEvents()`.
7479

7580
### Elementos do painel
7681

77-
Cada painel precisa de um elemento de view. O nome deve ser a versão underscore do nome da classe, por exemplo `session_panel.php`.
82+
Cada painel precisa de um elemento de view. O nome deve ser a versão underscore do nome da classe, por exemplo `cache_panel.php`.
7883

7984
### Títulos e elementos personalizados
8085

0 commit comments

Comments
 (0)