1
0
mirror of https://github.com/maximebf/php-debugbar.git synced 2025-01-17 05:18:32 +01:00

updated docs [ci skip]

This commit is contained in:
maximebf 2013-09-19 18:05:12 -04:00
parent 02599ef57b
commit 6330bca1c7
3 changed files with 30 additions and 0 deletions

12
docs/http_drivers.md Normal file
View File

@ -0,0 +1,12 @@
# HTTP drivers
Some features of the debug bar requires sending http headers or
using the session. Many frameworks implement their own mechanism
on top of PHP native features.
Two make integration with other frameworks as easy as possible,
the `DebugBar` object uses an instance of `DebugBar\HttpDriverInterface`
to access those features.
`DebugBar\PhpHttpDriver`, which uses native PHP mechanisms, is provided
and will be used if no other driver are specified.

View File

@ -11,6 +11,7 @@
"bridge_collectors.md",
"storage.md",
"openhandler.md",
"http_drivers.md",
"javascript_bar.md"
]
}

View File

@ -55,6 +55,23 @@ Note that you can only use the debug bar assets and manage the dependencies by y
using `$renderer->setIncludeVendors(false)`. Instead of false, *css* or *js* may be used
to only include css or js assets of vendors.
## Managing jQuery conflicts
When the debug bar script is included, it will be bound to the current jQuery object.
The default action is to call `jQuery.noConflict(true)` after this is done.
This has two implications:
- jQuery won't be available anymore if you didn't include your own version
before including the debug bar's vendors
- your own version will be restored.
If you use `JavascriptRenderer::setIncludeVendors()` to disable the inclusion of js
vendors (ie. jquery), `jQuery.noConflict(true)` won't be called.
You can manage whether `jQuery.noConflict(true)` should be called or not using
`JavascriptRenderer::setEnableJqueryNoConflict()`.
## The javascript object
The renderer will generate all the needed code for your debug bar. This means