mirror of
https://github.com/maximebf/php-debugbar.git
synced 2025-06-21 18:25:18 +02:00
264 lines
7.9 KiB
HTML
264 lines
7.9 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
<title>PHP Debug Bar</title>
|
|
<link type="text/css" rel="stylesheet" href="http://fonts.googleapis.com/css?family=Droid+Sans&subset=latin">
|
|
<link type="text/css" rel="stylesheet" href="/php-debugbar/docs/css/reset.css">
|
|
<link type="text/css" rel="stylesheet" href="/php-debugbar/docs/css/docs.css">
|
|
<link type="text/css" rel="stylesheet" href="/php-debugbar/docs/css/print.css" media="print">
|
|
<link type="text/css" rel="stylesheet" href="http://yandex.st/highlightjs/6.1/styles/sunburst.min.css">
|
|
|
|
<link type="text/css" rel="stylesheet" href="style.css">
|
|
|
|
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.4.3/jquery.min.js"></script>
|
|
<script type="text/javascript" src="http://yandex.st/highlightjs/6.1/highlight.min.js"></script>
|
|
|
|
<script type="text/javascript" src="/php-debugbar/docs/js/viewer.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="page">
|
|
<a name="top" />
|
|
|
|
<header id="header">
|
|
<h1><a href="/php-debugbar/docs/">PHP Debug Bar</a></h1>
|
|
</header>
|
|
|
|
|
|
|
|
|
|
<div id="sidebar">
|
|
<nav id="toc">
|
|
|
|
<ol>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/readme.html#php-debug-bar">PHP Debug Bar</a>
|
|
|
|
|
|
<ol>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/readme.html#installation">Installation</a>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/readme.html#quick-start">Quick start</a>
|
|
|
|
</li>
|
|
|
|
</ol>
|
|
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/data-collectors.html#collecting-data">Collecting Data</a>
|
|
|
|
|
|
<ol>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/data-collectors.html#using-collectors">Using collectors</a>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/data-collectors.html#creating-collectors">Creating collectors</a>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/data-collectors.html#base-collectors">Base collectors</a>
|
|
|
|
</li>
|
|
|
|
</ol>
|
|
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/rendering.html#rendering">Rendering</a>
|
|
|
|
|
|
<ol>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/rendering.html#assets">Assets</a>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/rendering.html#the-javascript-object">The javascript object</a>
|
|
|
|
</li>
|
|
|
|
</ol>
|
|
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/javascript-bar.html#javascript-bar">Javascript Bar</a>
|
|
|
|
|
|
<ol>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/javascript-bar.html#tabs-and-indicators">Tabs and indicators</a>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/javascript-bar.html#data-mapping">Data mapping</a>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/javascript-bar.html#datasets">Datasets</a>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/javascript-bar.html#widgets">Widgets</a>
|
|
|
|
</li>
|
|
|
|
</ol>
|
|
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/bridge-collectors.html#bridge-collectors">Bridge collectors</a>
|
|
|
|
|
|
<ol>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/bridge-collectors.html#monolog">Monolog</a>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/bridge-collectors.html#propel">Propel</a>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<a href="/php-debugbar/docs/bridge-collectors.html#twig">Twig</a>
|
|
|
|
</li>
|
|
|
|
</ol>
|
|
|
|
|
|
</li>
|
|
|
|
</ol>
|
|
|
|
</nav>
|
|
</div>
|
|
|
|
<article id="content">
|
|
<a name="php-debug-bar"></a><h1>PHP Debug Bar</h1>
|
|
<p>Displays a debug bar in the browser with information from php.
|
|
No more <code>var_dump()</code> in your code!
|
|
|
|
</p>
|
|
<p><img src="https://raw.github.com/maximebf/php-debugbar/master/docs/screenshot.png" alt="Screenshot">
|
|
|
|
</p>
|
|
<p><strong>Features:</strong>
|
|
|
|
</p>
|
|
<ul>
|
|
<li>Generic debug bar with no other dependencies</li>
|
|
<li>Easy to integrate with any project</li>
|
|
<li>Clean, fast and easy to use interface</li>
|
|
<li>Handles AJAX request</li>
|
|
<li>Includes generic data collectors and collectors for well known libraries</li>
|
|
<li>The client side bar is 100% coded in javascript</li>
|
|
<li>Easily create your own collectors and their associated view in the bar</li>
|
|
</ul>
|
|
<a name="installation"></a><h2>Installation</h2>
|
|
<p>The easiest way to install DebugBar is using <a href="https://github.com/composer/composer">Composer</a>
|
|
with the following requirement:
|
|
|
|
</p>
|
|
<pre><code>{
|
|
"require": {
|
|
"maximebf/debugbar": ">=1.0.0"
|
|
}
|
|
}</code></pre>
|
|
<p>Alternatively, you can <a href="https://github.com/maximebf/php-debugbar/zipball/master">download the archive</a>
|
|
and add the src/ folder to PHP's include path:
|
|
|
|
</p>
|
|
<pre><code>set_include_path('/path/to/src' . PATH_SEPARATOR . get_include_path());</code></pre>
|
|
<p>DebugBar does not provide an autoloader but follows the <a href="https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md">PSR-0 convention</a>.<br>You can use the following snippet to autoload ConsoleKit classes:
|
|
|
|
</p>
|
|
<pre><code>spl_autoload_register(function($className) {
|
|
if (substr($className, 0, 8) === 'DebugBar') {
|
|
$filename = str_replace('\\', DIRECTORY_SEPARATOR, trim($className, '\\')) . '.php';
|
|
require_once $filename;
|
|
}
|
|
});</code></pre>
|
|
<a name="quick-start"></a><h2>Quick start</h2>
|
|
<p>DebugBar is very easy to use and you can add it to any of your projets in no time.
|
|
The easiest way is using the <code>render()</code> functions
|
|
|
|
</p>
|
|
<pre><code><?php
|
|
use DebugBar\StandardDebugBar;
|
|
use DebugBar\JavascriptRenderer;
|
|
|
|
$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></code></pre>
|
|
<p>The DebugBar uses DataCollectors to collect data from your PHP code. Some of them are
|
|
automated but others are manual. Use the <code>DebugBar</code> like an array where keys are the
|
|
collector names. In our previous example, we add a message to the <code>MessagesCollector</code>:
|
|
|
|
</p>
|
|
<pre><code>$debugbar["messages"]->addMessage("hello world!");</code></pre>
|
|
<p><code>StandardDebugBar</code> activates all bundled collectors:
|
|
|
|
</p>
|
|
<ul>
|
|
<li><code>MemoryCollector</code> (<em>memory</em>)</li>
|
|
<li><code>MessagesCollector</code> (<em>messages</em>)</li>
|
|
<li><code>PhpInfoCollector</code> (<em>php</em>)</li>
|
|
<li><code>RequestDataCollector</code> (<em>request</em>)</li>
|
|
<li><code>TimeDataCollector</code> (<em>time</em>)</li>
|
|
<li><code>ExceptionsCollector</code> (<em>exceptions</em>)</li>
|
|
</ul>
|
|
<p>Learn more about DebugBar in the <a href="http://maximebf.github.io/php-debugbar">docs</a>.
|
|
</p>
|
|
|
|
</article>
|
|
|
|
<footer id="footer">
|
|
Powered by <a href="http://github.com/maximebf/beautiful-docs">beautiful-docs</a> -
|
|
<a href="#top">Back to top</a> - <a href="/php-debugbar/docs/all.html">Everything on a single page</a>
|
|
- <a href="?print=1">Print current page</a> - <a href="/php-debugbar/docs/all.html?print=1">Print all pages</a>
|
|
|
|
</footer>
|
|
</div>
|
|
</body>
|
|
</html>
|