From a3b005092236dee6771c76a4e78c3016290dfc7f Mon Sep 17 00:00:00 2001 From: Daniel Seifert Date: Wed, 3 Aug 2022 00:33:55 +0200 Subject: [PATCH] adjust documentation --- CHANGELOG.md | 8 +++++++- README.md | 15 +++++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index db8b0e7..db8bff1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,4 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [1.0.0.0](https://git.d3data.de/D3Public/DebugBar/releases/tag/1.0.0.0) - 2022-07-30 ### Added -- generate debug bar instance with Monolog collector and Doctrine collector \ No newline at end of file +- generate debug bar instance with + - Request data colletor + - Monolog log messages collector + - Doctrine database queries collector + - Smarty variables collector + - Timeline profiling collector + - Collector for freely definable debug messages \ No newline at end of file diff --git a/README.md b/README.md index 2608791..fd334ca 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,21 @@ Aktivieren Sie das Modul im Shopadmin unter "Erweiterungen -> Module". ``` include './modules/d3/debugbar/Modules/functions.php'; ``` +## Verwendung + +Die DebugBar stellt folgende Tabs dar: +- Messages + kann individuelle Debugausgaben enthalten. Die Nachrichten können innerhalb des PHP-Codes mit `debugVar($message)` gesetzt werden und entspricht der OXID-Funktion `dumpVar(...)`. +- Request + zeigt alle Angaben aus GET- und POST-Requests, sowie Session-, Cookie- und Servervariablen +- Timeline + stellt alle mit `startProfile` und `stopProfile` definierten Bereiche mit einzelner und summierter Ausführungszeit sowie als Wasserfalldiagramm dar +- Monolog + listet alle an den Monolog Logger übergebenen Lognachrichten +- Database + zeigt alle zur Generierung der aktuellen Seite nötigen Datenbankabfragen +- Smarty + listet alle Smarty-Variablen, die auf der aktuellen Shopseite zur Verfügung stehen ## Changelog