From 6330bca1c7eb26f1b54db46e27e8ecba810115d9 Mon Sep 17 00:00:00 2001 From: maximebf Date: Thu, 19 Sep 2013 18:05:12 -0400 Subject: [PATCH] updated docs [ci skip] --- docs/http_drivers.md | 12 ++++++++++++ docs/manifest.json | 1 + docs/rendering.md | 17 +++++++++++++++++ 3 files changed, 30 insertions(+) create mode 100644 docs/http_drivers.md diff --git a/docs/http_drivers.md b/docs/http_drivers.md new file mode 100644 index 0000000..047793d --- /dev/null +++ b/docs/http_drivers.md @@ -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. \ No newline at end of file diff --git a/docs/manifest.json b/docs/manifest.json index 1a04f90..389377b 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -11,6 +11,7 @@ "bridge_collectors.md", "storage.md", "openhandler.md", + "http_drivers.md", "javascript_bar.md" ] } diff --git a/docs/rendering.md b/docs/rendering.md index 6d5c8ab..07a6f30 100644 --- a/docs/rendering.md +++ b/docs/rendering.md @@ -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