fxstein / jfirephp Goto Github PK

JFirePHP takes FirePHP integration to the next level. JFirePHP is a fully configurable Joomla 1.5 native system plugin that adds FirePHP debugging capabilities to your php software. It allows developers to leverage the power of FirePHP inside of Joomla 1.5, configuring the level of integration in the Joomla backend for JFirePHP.

Simply install the system plugin via the Joomla Extension Manager, make sure it is published. Pick the user group level that should be able to see the console messages, set the various plugin options to your individual needs including the FirePHP setup options.

JFirePHP requires Firefox 3.5+ as well as the FireBug 1.5 plugin for Firefox. It leverages the FireBug console window to display any debugging info you want to show in there.

Simply leverage the FirePHP class FB to call functions like FB::trace, FB::notice, FB::warning, FB::error and others to display messages and information about your project in FireBug.

In the upcoming releases of Kunena, we will integrate profiling and debugging information that will help in the analysis of performance and template problems.

The output for FireBug can be turned off, limited to Joomla debug mode or limited to certain usergroups on Joomla. That way even sensitive information about the site can be made available if required, but can only be seen by e.g. Special Users on Joomla.

Add the firephp/firephp.defines.php to your project. You can either copy the content into your code (e.g. a global defines file) or copy the file into your project. Make sure it is included in your distribution. It ensures that all the FirePHP calls can stay in your code without creating errors on systems without FirePHP. Make sure you use the fb() or FB::* syntax on all FirePHP calls you place into your code. DO NOT include any FirePHP files and classes directly. All of that is performed for you as part of JFirePHP.

Once JFirePHP has been installed and the jfirephp.defines.php file has been added to you project you can leverage all of the JFirePHP (fb() and FB::*) functionality in your code. See the FirePHP Headquarters at http://www.firephp.org/HQ/Use.htm for detailed information about FirePHP and its usage.

For feedback and support please visit the forums at http://www.kunena.com/jfirephp