The debug widget for now is very simplistic and more of a proof-of-concept. It expects you have three services in your dependency injector named "db", "dispatcher" and "view" and that they correspond to those services. When you pass the DI to Phalcon Debug Widget It looks for those specific services and:
- sets them as shared services
- sets the eventManager for them
- Attaches itself to those events
This means passing the DI to the debug widget will alter those services. Generally speaking, a shared db, dispatcher, and view is fine. If you have ideas for other ways to hook in, please open an issue for discussion.
The Phalcon Debug Widget is designed to make development easier by displaying debugging information directly in your browser window. Currently it displays php globals such as $_SESSION as well as outputing resource usage and database queries and connection information. It includes syntax highlighting via Prismjs.com.
If it looks familiar, its because its modeled after the Yii debug toolbar
Copy the main PDW folder into your project where you keep third-party libraries. For example (app/library or app/vendor or /vendor). Copy or move the pdw-assets folder to your public folder.
Define a debug or environment flag in your main index.php file so you can easily disable the Phalcon Debug Widget on production environments. Example:
defined('PHALCONDEBUG') || define('PHALCONDEBUG', true);After you have setup your \Phalcon\Loader and \Phalcon\DI\FactoryDefault() create a new instance of the debug widget. Here we will tell phalcon about the PDW namespace and instantiate the widget with the $di. (Assuming $di is your dependency injector and $loader is your \Phalcon\Loader)
if (PHALCONDEBUG == true) {
$namespaces = array_merge($loader->getNamespaces(), array('PDW'=>realpath('/path/to/PDW')));
$loader->registerNamespaces($namespaces);
$debugWidget = new \PDW\DebugWidget($di);
}
Bug Icon designed by Nithin Viswanathan from the Noun Project
JQuery Syntax Highlighting implemented with Prismjs.com