From e89cf2bfec728c48ba9a1496ef957b81f99c8165 Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 25 Sep 2026 13:01:16 +0530 Subject: [PATCH] Update docs --- README.md | 6 +++--- docs/.vitepress/config.js | 11 ++++++----- docs/en/configuration.md | 8 +++++++- docs/en/custom-panels.md | 6 +++--- docs/en/index.md | 2 +- docs/en/toolbar.md | 12 +++++++----- docs/fr/index.md | 17 ++++++++++------- docs/ja/index.md | 18 +++++++++++------- docs/pt/index.md | 17 +++++++++++------ 9 files changed, 59 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 431f7c2c..b52a4bba 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,10 @@ For details and older versions see [version map](https://github.com/cakephp/debu * Install the plugin with [Composer](https://getcomposer.org/) from your CakePHP Project's ROOT directory (where the **composer.json** file is located) ```sh -php composer.phar require --dev cakephp/debug_kit:"^5.0" +php composer.phar require --dev cakephp/debug_kit:"^6.0" ``` -* [Load the plugin](https://book.cakephp.org/5/en/plugins.html#loading-a-plugin) +* [Load the plugin](https://book.cakephp.org/6/en/plugins.html#loading-a-plugin) ``` bin/cake plugin load DebugKit --only-debug ``` @@ -60,7 +60,7 @@ requests](https://help.github.com/articles/using-pull-requests) or open ## Documentation Documentation for DebugKit can be found in the -[CakePHP documentation](https://book.cakephp.org/debugkit/5/en/index.html). +[CakePHP documentation](https://book.cakephp.org/debugkit/6/en/index.html). ## Panels Panels by other plugins: diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index 4af712b3..ef80b15e 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -8,9 +8,10 @@ const tocJa = require('./toc_ja.json') const tocPt = require('./toc_pt.json') const versions = { - text: '5.x', + text: '6.x', items: [ - { text: '5.x (current)', link: 'https://book.cakephp.org/debugkit/5/', target: '_self' }, + { text: '6.x (current)', link: 'https://book.cakephp.org/debugkit/6/', target: '_self' }, + { text: '5.x', link: 'https://book.cakephp.org/debugkit/5/', target: '_self' }, { text: '4.x', link: 'https://book.cakephp.org/debugkit/4/en/', target: '_self' }, ], } @@ -20,12 +21,12 @@ export default { srcDir: '.', title: 'DebugKit', description: 'CakePHP DebugKit Documentation', - base: '/debugkit/5/', + base: '/debugkit/6/', rewrites: { 'en/:slug*': ':slug*', }, sitemap: { - hostname: 'https://book.cakephp.org/debugkit/5/', + hostname: 'https://book.cakephp.org/debugkit/6/', }, themeConfig: { siteTitle: false, @@ -34,7 +35,7 @@ export default { { icon: 'github', link: 'https://github.com/cakephp/debug_kit' }, ], editLink: { - pattern: 'https://github.com/cakephp/debug_kit/edit/5.x/docs/:path', + pattern: 'https://github.com/cakephp/debug_kit/edit/6.x/docs/:path', text: 'Edit this page on GitHub', }, sidebar: tocEn, diff --git a/docs/en/configuration.md b/docs/en/configuration.md index 6f10d20d..f291d5be 100644 --- a/docs/en/configuration.md +++ b/docs/en/configuration.md @@ -1,6 +1,6 @@ # Configuration -DebugKit supports several configuration keys that let you tailor the toolbar for local development. +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. * `DebugKit.panels` enables or disables individual panels: @@ -32,6 +32,12 @@ Configure::write('DebugKit.forceEnable', function () { Configure::write('DebugKit.ignorePathsPattern', '/\.(jpg|png|gif)$/'); ``` +* `DebugKit.requestCount` controls how many requests are kept in the History panel. The default is `20`: + +```php +Configure::write('DebugKit.requestCount', 50); +``` + * `DebugKit.maxDepth` controls how many levels of nested data are rendered in general debug output. The default is `5`. * `DebugKit.variablesPanelMaxDepth` controls how many levels of nested data are rendered in the Variables panel. The default is `5`. diff --git a/docs/en/custom-panels.md b/docs/en/custom-panels.md index a8ee1818..c7845697 100644 --- a/docs/en/custom-panels.md +++ b/docs/en/custom-panels.md @@ -21,7 +21,7 @@ Custom panels must extend `DebugPanel`. ## Callbacks -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. +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. The built-in panels are the best reference when you need examples. @@ -29,8 +29,8 @@ The built-in panels are the best reference when you need examples. Each panel should have a matching view element that renders the panel content. The element name is the underscored form of the class name: -* `SessionPanel` maps to `session_panel.php` -* `SqllogPanel` maps to `sqllog_panel.php` +* `CachePanel` maps to `cache_panel.php` +* `SqlLogPanel` maps to `sql_log_panel.php` Store panel elements in `templates/element`. diff --git a/docs/en/index.md b/docs/en/index.md index a3baf570..ddd07641 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -15,7 +15,7 @@ DebugKit stores panel data in a database. The default setup uses SQLite through Install the plugin with Composer from your application's root directory: ```bash -php composer.phar require --dev cakephp/debug_kit:"^5.0" +php composer.phar require --dev cakephp/debug_kit:"^6.0" ``` Then load the plugin in debug mode: diff --git a/docs/en/toolbar.md b/docs/en/toolbar.md index f4b87be5..d0c4c790 100644 --- a/docs/en/toolbar.md +++ b/docs/en/toolbar.md @@ -5,17 +5,19 @@ The DebugKit toolbar appears after you click the CakePHP icon in the lower-right Built-in panels include: * **Cache** shows cache usage during the request and lets you clear caches. +* **Deprecations** renders deprecation warnings in a less disruptive format. * **Environment** shows PHP and CakePHP environment details. * **History** lists previous requests and lets you inspect their panel data. -* **Include** groups included files by type. * **Log** shows log entries created during the request. -* **Packages** lists installed dependencies, their versions, and outdated packages. * **Mail** captures mail sent during the request and supports previews. +* **Packages** lists installed dependencies, their versions, and outdated packages. +* **Plugins** lists the plugins loaded by the application. * **Request** shows request data, route information, cookies, and request parameters. -* **Session** displays the active session contents. -* **Sql Logs** shows SQL logs for each datasource. +* **Routes** lists the routes matched during the request. +* **Sql Log** shows SQL logs for each datasource. * **Timer** displays timers from `DebugKit\DebugTimer` and memory readings from `DebugKit\DebugMemory`. * **Variables** shows view variables set in the controller. -* **Deprecations** renders deprecation warnings in a less disruptive format. + +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. You can use the built-in panels as-is or register your own custom panels alongside them. diff --git a/docs/fr/index.md b/docs/fr/index.md index 6645b45f..8250289f 100644 --- a/docs/fr/index.md +++ b/docs/fr/index.md @@ -11,7 +11,7 @@ DebugKit est destiné uniquement aux environnements de développement local à u 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 : ```bash -php composer.phar require --dev cakephp/debug_kit:"^5.0" +php composer.phar require --dev cakephp/debug_kit:"^6.0" ``` Chargez ensuite le plugin : @@ -31,18 +31,21 @@ La toolbar DebugKit comprend plusieurs panneaux accessibles depuis l'icône Cake Chaque panneau inspecte un aspect différent de l'application : * **Cache** montre l'utilisation du cache et permet de le vider. +* **Deprecations** affiche les avertissements de dépréciation dans un format moins intrusif. * **Environment** affiche les variables d'environnement liées à PHP et CakePHP. * **History** affiche la liste des requêtes précédentes et permet de recharger leurs données. -* **Include** montre les fichiers inclus par type. * **Log** affiche les écritures de log de la requête. -* **Packages** affiche les dépendances installées et les versions obsolètes. * **Mail** affiche les emails envoyés pendant la requête. +* **Packages** affiche les dépendances installées et les versions obsolètes. +* **Plugins** liste les plugins chargés par l'application. * **Request** affiche les informations de requête, de route et les cookies. -* **Session** affiche le contenu de la session. -* **Sql Logs** affiche les logs SQL pour chaque connexion. +* **Routes** liste les routes correspondantes à la requête. +* **Sql Log** affiche les logs SQL pour chaque connexion. * **Timer** affiche les timers créés avec `DebugKit\\DebugTimer` ainsi que l'usage mémoire via `DebugKit\\DebugMemory`. * **Variables** affiche les variables de vue définies par le contrôleur. +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. + ## Utiliser le panneau History 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 ### Callbacks -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()`. +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()`. ### Éléments de panneau -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`. +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`. ### Titres et éléments personnalisés diff --git a/docs/ja/index.md b/docs/ja/index.md index 4715ae4e..d11398a0 100644 --- a/docs/ja/index.md +++ b/docs/ja/index.md @@ -11,7 +11,7 @@ DebugKit は単一ユーザーのローカル開発環境でのみ使用して アプリケーションのルートディレクトリーで次を実行します。 ```bash -php composer.phar require --dev cakephp/debug_kit:"^5.0" +php composer.phar require --dev cakephp/debug_kit:"^6.0" ``` 続いてプラグインを有効化します。 @@ -26,6 +26,7 @@ bin/cake plugin load DebugKit --only-debug * `DebugKit.includeSchemaReflection` を `true` にするとスキーマリフレクションのクエリーを記録します。 * `DebugKit.safeTld` でローカル開発用の TLD を追加できます。 * `DebugKit.forceEnable` で DebugKit を強制表示できます。 +* `DebugKit.requestCount` で履歴パネルに保持するリクエスト数を変更できます（デフォルトは `20`）。 ## データベース設定 @@ -36,18 +37,21 @@ bin/cake plugin load DebugKit --only-debug DebugKit ツールバーはブラウザー右下の CakePHP アイコンから開けます。各パネルはアプリケーションの異なる側面を表示します。 * **Cache** キャッシュ使用状況の確認と削除。 +* **Deprecations** 非破壊的な形式で非推奨警告を表示します。 * **Environment** PHP と CakePHP の環境情報。 * **History** 過去のリクエスト一覧とそのデータの再表示。 -* **Include** 読み込まれたファイル一覧。 * **Log** リクエスト中に書かれたログ。 -* **Packages** 依存パッケージとバージョン情報。 * **Mail** 送信メールの確認とプレビュー。 +* **Packages** 依存パッケージとバージョン情報。 +* **Plugins** アプリケーションで読み込まれたプラグインの一覧。 * **Request** 現在のリクエスト情報、ルート、Cookie。 -* **Session** セッション内容。 -* **Sql Logs** 接続ごとの SQL ログ。 +* **Routes** リクエストでマッチしたルートの一覧。 +* **Sql Log** 接続ごとの SQL ログ。 * **Timer** `DebugKit\\DebugTimer` と `DebugKit\\DebugMemory` の情報。 * **Variables** ビュー変数。 +非推奨の **Include** と **Session** パネルも残っていますが、デフォルトでは無効です。Include の代わりに Environment パネル、Session の代わりに Request パネルを使ってください。 + ## 履歴パネルを使う 履歴パネルではエラーやリダイレクトを含む過去のリクエストを確認できます。 @@ -107,11 +111,11 @@ class MyCustomPanel extends DebugPanel ### コールバック -デフォルトでは `Controller.initialize` と `Controller.shutdown` を購読します。追加イベントが必要なら `implementedEvents()` を定義してください。 +デフォルトではパネルは `Controller.shutdown` イベントのみを購読し、`shutdown()` でパネルデータを収集します。`initialize()` はコントローラー実行前に DebugKit のミドルウェアが各パネルに対して呼び出します。追加イベントが必要なら `implementedEvents()` を定義してください。 ### パネル要素 -パネル表示用のビュー要素を用意します。名前はクラス名のアンダースコア形式です。例えば `SessionPanel` は `session_panel.php` を使います。 +パネル表示用のビュー要素を用意します。名前はクラス名のアンダースコア形式です。例えば `CachePanel` は `cache_panel.php` を使います。 ### カスタムタイトルとエレメント diff --git a/docs/pt/index.md b/docs/pt/index.md index 460609d0..4fff8b7f 100644 --- a/docs/pt/index.md +++ b/docs/pt/index.md @@ -11,7 +11,7 @@ DebugKit deve ser usado apenas em ambientes locais de desenvolvimento para um ú No diretório raiz da aplicação, execute: ```bash -php composer.phar require --dev cakephp/debug_kit:"^5.0" +php composer.phar require --dev cakephp/debug_kit:"^6.0" ``` Depois carregue o plugin: @@ -31,16 +31,21 @@ A toolbar do DebugKit é exibida ao clicar no ícone do CakePHP no canto inferio Cada painel mostra uma parte diferente da aplicação: * **Cache** mostra o uso de cache e permite limpá-lo. +* **Deprecations** exibe avisos de depreciação de forma menos intrusiva. * **Environment** exibe variáveis de ambiente relacionadas a PHP e CakePHP. * **History** mostra requisições anteriores e permite recarregar seus dados. -* **Include** exibe os arquivos incluídos por tipo. * **Log** mostra as entradas de log da requisição. +* **Mail** mostra os e-mails enviados durante a requisição e permite pré-visualização. +* **Packages** mostra as dependências instaladas e as versões desatualizadas. +* **Plugins** lista os plugins carregados pela aplicação. * **Request** exibe dados da requisição atual, rota e cookies. -* **Session** exibe o conteúdo da sessão. -* **Sql Logs** mostra logs SQL por conexão. +* **Routes** lista as rotas correspondentes à requisição. +* **Sql Log** mostra logs SQL por conexão. * **Timer** exibe timers criados com `DebugKit\\DebugTimer` e dados de memória com `DebugKit\\DebugMemory`. * **Variables** exibe variáveis de view definidas no controller. +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. + ## Usando o painel History O painel History permite revisar dados de requisições anteriores, incluindo erros e redirecionamentos. @@ -70,11 +75,11 @@ class MyCustomPanel extends DebugPanel ### Callbacks -Por padrão os painéis se inscrevem nos eventos `Controller.initialize` e `Controller.shutdown`. Se precisar de eventos adicionais, implemente `implementedEvents()`. +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()`. ### Elementos do painel -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`. +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`. ### Títulos e elementos personalizados