UID	github.com/firephp/firephp/			Stream	1	Author	cadorn
Namespace	github.com/firephp	Name	firephp	Version	1.0.0b1rc6	Date	1321310596

This approach of including FirePHP is DEPRECATED!

Overview

FirePHP has evolved a lot since its first release in 2007. One major enhancement is built-in security to ensure only authorized clients are allowed to access application internal information. This addition among other features has lead to a modified approach in how to configure and include FirePHP. See ../Install for a comparison.

The traditional way of just including and using FirePHP is still supported BUT when using this approach all new FirePHP 1.0 features will be bypassed!

You are encouraged to upgrade (see below) to the new way of configuring FirePHP.

Including

It is assumed you have FirePHP downloaded.

The code below should be placed at the top of the bootstrap file before any application code is run.

See here for details on the FirePHP Object Oriented and Procedural APIs.

Instead of ob_start(), the output_buffering php ini directive may be used. Output buffering is needed as headers are sent while logging to FirePHP throughout the request.

ANYONE will be able to receive logged data unless you specifically disable FirePHP! See FirePHP API.

If using the extracted zip archive

// Object Oriented API
require_once('/.../FirePHPCore/FirePHP.class.php');
// or Procedural API
require_once('/.../FirePHPCore/FB.php');
// start output buffering
ob_start();

Three dots (...) denotes a path that needs to be replaced.

Instead of using an absolute path to the FirePHPCore folder it may be placed on the include path.

If using the phar archive

// Object Oriented API
require_once('phar://.../firephp.phar/FirePHPCore/FirePHP.class.php');
// or Procedural API
require_once('phar://.../firephp.phar/FirePHPCore/FB.php');
// start output buffering
ob_start();

Three dots (...) denotes a path that needs to be replaced.

Upgrading to FirePHP 1.0 proper

As mentioned above, when using the traditional way of including FirePHP, all new features are bypassed and the new built-in security features are not utilized.

Upgrading to the new configuration and inclusion approach is recommended for all users. The traditional FirePHP Object-Oriented and Procedural APIs will continue to work.

A comparison of the different approaches and detailed instruction links can be found here.

Required Changes

Set some constants prior to including FirePHP.
Change the FirePHP file being included.
Remove explicit ob_start() call if applicable as output buffering will automatically be enabled.

The constants (and configuration files if applicable) that need to be used for a specific application are provided when setting up the application in the FirePHP Client. See Configure: constants or Configure: files (preferred) for detailed instructions.

Upgrade support is provided via the FirePHP mailing list. See OpenSource.

Example

Before (FirePHP Traditional):

require_once('/.../FirePHPCore/FirePHP.class.php');
ob_start();
$firephp = FirePHP::getInstance(true);
$firephp->log('Hello World');

After (Configure: files):

define('INSIGHT_CONFIG_PATH', '/.../package.json');
require_once('/.../FirePHP/Init.php');
$firephp = FirePHP::getInstance(true);
$firephp->log('Hello World');