mirror_php/php-debugbar
1
0
Fork 0
mirror of https://github.com/maximebf/php-debugbar.git synced 2025-03-15 11:50:01 +01:00
Code Issues Releases Wiki Activity

Merge pull request #13 from thekonz/patch-1

Browse Source 
README syntax highlighting
This commit is contained in:
Maxime Bouroumeau-Fuseau 2013-08-28 05:28:17 -07:00
commit c40f48c0d6
1 changed files with 27 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -38,11 +38,13 @@ examples and [phpdebugbar.com](http://phpdebugbar.com) for a live example.
The best way to install DebugBar is using [Composer](http://getcomposer.org)
with the following requirement:
{
"require": {
"maximebf/debugbar": ">=1.0.0"
}
```JSON
{
"require": {
"maximebf/debugbar": ">=1.0.0"
}
}
```
If you are cloning the repository, you'll need to run `composer install`.
@ -52,30 +54,34 @@ If you are cloning the repository, you'll need to run `composer install`.
DebugBar is very easy to use and you can add it to any of your projects in no time.
The easiest way is using the `render()` functions
<?php
use DebugBar\StandardDebugBar;
use DebugBar\JavascriptRenderer;
```PHP
<?php
use DebugBar\StandardDebugBar;
use DebugBar\JavascriptRenderer;
$debugbar = new StandardDebugBar();
$debugbarRenderer = $debugbar->getJavascriptRenderer();
$debugbar = new StandardDebugBar();
$debugbarRenderer = $debugbar->getJavascriptRenderer();
$debugbar["messages"]->addMessage("hello world!");
?>
<html>
<head>
<?php echo $debugbarRenderer->renderHead() ?>
</head>
<body>
...
<?php echo $debugbarRenderer->render() ?>
</body>
</html>
$debugbar["messages"]->addMessage("hello world!");
?>
<html>
<head>
<?php echo $debugbarRenderer->renderHead() ?>
</head>
<body>
...
<?php echo $debugbarRenderer->render() ?>
</body>
</html>+6
```
The DebugBar uses DataCollectors to collect data from your PHP code. Some of them are
automated but others are manual. Use the `DebugBar` like an array where keys are the
collector names. In our previous example, we add a message to the `MessagesCollector`:
$debugbar["messages"]->addMessage("hello world!");
```PHP
$debugbar["messages"]->addMessage("hello world!");
```
`StandardDebugBar` activates the following collectors: