Skip to content

Commit cc3778a

Browse files
committed
Tweak usage
1 parent c163398 commit cc3778a

File tree

5 files changed

+28
-17
lines changed

5 files changed

+28
-17
lines changed

docs/collectors.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,8 @@ The Query Collector has the following features
139139
#### On-demand query EXPLAIN
140140

141141
<!-- md:version v3.14.0 -->
142-
<!-- md:feature options.db.explain -->
143142
<!-- md:flag experimental -->
143+
<!-- md:feature options.db.explain -->
144144

145145
Enable the `options.db.explain` option to run on-demand EXPLAIN queries for any SELECT query in the Debugbar.
146146
This will update in the interface. You also have an option to navigate to mysqlexplain.com for a visual explain.
@@ -151,9 +151,8 @@ This will update in the interface. You also have an option to navigate to mysqle
151151
#### Query limits
152152

153153
<!-- md:version v3.10.0 -->
154-
<!-- md:feature options.db.soft_limit -->
155-
<!-- md:feature options.db.hard_limit -->
156-
<!-- md:flag experimental -->
154+
<!-- md:feature options.db.soft_limit: 100 -->
155+
<!-- md:feature options.db.hard_limit: 500 -->
157156

158157
With Query Hard & Soft limits, you can reduce the amount of queries shown by default. When the soft limit is reached, bindings will be excluded.
159158
When the hard limit is reached, the queries are excluded altogether to prevent loading too much data.

docs/img/usage.gif

756 KB
Loading

docs/installation.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
hide:
3+
- navigation
4+
---
5+
16
# Installation
27

38
## Install with composer

docs/usage.md

+18-10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
---
2+
hide:
3+
- navigation
4+
---
5+
6+
# Usage
7+
8+
## Using the Debugbar
9+
10+
When the Debugbar is enabled, the Debugbar is shown on the bottom of the screen, similar to the documentation preview.
11+
12+
Based on your configuration, it shows the [Collectors](#collectors.md) for the current request. You can open, close, restore or minimize the toolbar for your need. The state will be remembered.
13+
14+
![Usage](img/usage.gif)
15+
16+
## Debugbar Facade
117
You can now add messages using the Facade (when added), using the PSR-3 levels (debug, info, notice, warning, error, critical, alert, emergency):
218

319
```php
@@ -28,6 +44,8 @@ try {
2844
}
2945
```
3046

47+
## Helpers
48+
3149
There are also helper functions available for the most common calls:
3250

3351
```php
@@ -54,16 +72,6 @@ $debugbar = App::make('debugbar');
5472
$debugbar->addCollector(new DebugBar\DataCollector\MessagesCollector('my_messages'));
5573
```
5674

57-
By default, the Debugbar is injected just before `</body>`. If you want to inject the Debugbar yourself,
58-
set the config option 'inject' to false and use the renderer yourself and follow http://phpdebugbar.com/docs/rendering.html
59-
60-
```php
61-
$renderer = Debugbar::getJavascriptRenderer();
62-
```
63-
64-
Note: Not using the auto-inject, will disable the Request information, because that is added After the response.
65-
You can add the default_request datacollector in the config as alternative.
66-
6775
## Enabling/Disabling on run time
6876
You can enable or disable the debugbar during run time.
6977

mkdocs.yml

+2-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@ copyright: Copyright &copy; Barry vd. Heuvel
88

99
nav:
1010
- Home: index.md
11-
- Getting started:
12-
- Install: installation.md
13-
- Usage: usage.md
11+
- Install: installation.md
12+
- Usage: usage.md
1413
- Features: features.md
1514
- Collectors: collectors.md
1615

0 commit comments

Comments
 (0)