adjust documentation

This commit is contained in:
Daniel Seifert 2022-08-03 00:33:55 +02:00
parent 4cea1658bb
commit a3b0050922
Signed by: DanielS
GPG Key ID: 6A513E13AEE66170
2 changed files with 22 additions and 1 deletions

View File

@ -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 ## [1.0.0.0](https://git.d3data.de/D3Public/DebugBar/releases/tag/1.0.0.0) - 2022-07-30
### Added ### Added
- generate debug bar instance with Monolog collector and Doctrine collector - 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

View File

@ -49,6 +49,21 @@ Aktivieren Sie das Modul im Shopadmin unter "Erweiterungen -> Module".
``` ```
include './modules/d3/debugbar/Modules/functions.php'; 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 ## Changelog