You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit e89cf2b
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,10 +24,10 @@ For details and older versions see [version map](https://github.com/cakephp/debu
24
24
25
25
* Install the plugin with [Composer](https://getcomposer.org/) from your CakePHP Project's ROOT directory (where the **composer.json** file is located)
Copy file name to clipboardExpand all lines: docs/en/configuration.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Configuration
2
2
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.
4
4
5
5
*`DebugKit.panels` enables or disables individual panels:
6
6
@@ -32,6 +32,12 @@ Configure::write('DebugKit.forceEnable', function () {
Copy file name to clipboardExpand all lines: docs/en/custom-panels.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,16 +21,16 @@ Custom panels must extend `DebugPanel`.
21
21
22
22
## Callbacks
23
23
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.
25
25
26
26
The built-in panels are the best reference when you need examples.
27
27
28
28
## Panel Elements
29
29
30
30
Each panel should have a matching view element that renders the panel content. The element name is the underscored form of the class name:
Copy file name to clipboardExpand all lines: docs/en/toolbar.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,17 +5,19 @@ The DebugKit toolbar appears after you click the CakePHP icon in the lower-right
5
5
Built-in panels include:
6
6
7
7
***Cache** shows cache usage during the request and lets you clear caches.
8
+
***Deprecations** renders deprecation warnings in a less disruptive format.
8
9
***Environment** shows PHP and CakePHP environment details.
9
10
***History** lists previous requests and lets you inspect their panel data.
10
-
***Include** groups included files by type.
11
11
***Log** shows log entries created during the request.
12
-
***Packages** lists installed dependencies, their versions, and outdated packages.
13
12
***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.
14
15
***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.
17
18
***Timer** displays timers from `DebugKit\DebugTimer` and memory readings from `DebugKit\DebugMemory`.
18
19
***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.
20
22
21
23
You can use the built-in panels as-is or register your own custom panels alongside them.
Copy file name to clipboardExpand all lines: docs/fr/index.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ DebugKit est destiné uniquement aux environnements de développement local à u
11
11
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 :
@@ -31,18 +31,21 @@ La toolbar DebugKit comprend plusieurs panneaux accessibles depuis l'icône Cake
31
31
Chaque panneau inspecte un aspect différent de l'application :
32
32
33
33
***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.
34
35
***Environment** affiche les variables d'environnement liées à PHP et CakePHP.
35
36
***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.
37
37
***Log** affiche les écritures de log de la requête.
38
-
***Packages** affiche les dépendances installées et les versions obsolètes.
39
38
***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.
40
41
***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.
43
44
***Timer** affiche les timers créés avec `DebugKit\\DebugTimer` ainsi que l'usage mémoire via `DebugKit\\DebugMemory`.
44
45
***Variables** affiche les variables de vue définies par le contrôleur.
45
46
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
+
46
49
## Utiliser le panneau History
47
50
48
51
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
80
83
81
84
### Callbacks
82
85
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()`.
84
87
85
88
### Éléments de panneau
86
89
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`.
@@ -31,16 +31,21 @@ A toolbar do DebugKit é exibida ao clicar no ícone do CakePHP no canto inferio
31
31
Cada painel mostra uma parte diferente da aplicação:
32
32
33
33
***Cache** mostra o uso de cache e permite limpá-lo.
34
+
***Deprecations** exibe avisos de depreciação de forma menos intrusiva.
34
35
***Environment** exibe variáveis de ambiente relacionadas a PHP e CakePHP.
35
36
***History** mostra requisições anteriores e permite recarregar seus dados.
36
-
***Include** exibe os arquivos incluídos por tipo.
37
37
***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.
38
41
***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.
41
44
***Timer** exibe timers criados com `DebugKit\\DebugTimer` e dados de memória com `DebugKit\\DebugMemory`.
42
45
***Variables** exibe variáveis de view definidas no controller.
43
46
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
+
44
49
## Usando o painel History
45
50
46
51
O painel History permite revisar dados de requisições anteriores, incluindo erros e redirecionamentos.
@@ -70,11 +75,11 @@ class MyCustomPanel extends DebugPanel
70
75
71
76
### Callbacks
72
77
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()`.
74
79
75
80
### Elementos do painel
76
81
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`.
0 commit comments