How to automatically remove debug statements for FirePHP?

Question

FirePHP asks me to add debug function call on every .php page:

require_once('FirePHPCore/FirePHP.class.php');
ob_start();

It ist't a problem on my local machine. But I want to remove/disable them when my code is working in real world.

Is there any "debug mode" variable to disable them or tool to remove them?

score 5 · Answer 1 · answered Jul 14 '11 at 18:37

NOTE: If you remove the FirePHP include call but still have FirePHP logging calls in your code you will get a fatal error!

The proper solution is to disable FirePHPCore 0.3:

$firephp->setEnabled(false);

See API reference for more information.

All pages/scripts in your application/website should call a central bootstrap file before doing anything else. The code above should be in this bootstrap file which will allow you to easily disable FirePHP for the entire application when deployed:

bootstrap.php ~

ob_start();
require_once('FirePHPCore/FirePHP.class.php');
$firephp = FirePHP::getInstance(true);
// always disable FirePHP first - best practice
$firephp->setEnabled(false);
// only enable if in dev environment - best practice
if ($isDevMode) {
    $firephp->setEnabled(true);
}

FYI, If using FirePHP 1.0 logging messages will only be sent if an authorized client is detected eliminating the need for the code above.

score 0 · Accepted Answer · answered Jul 08 '11 at 04:03

0

Just define a constant

define('IS_PRODUCTION', false);

and use it later:

if (!IS_PRODUCTION) {
    require_once('FirePHPCore/FirePHP.class.php');
    ...
}

answered Jul 08 '11 at 04:03

zerkms

249,484
69
436
539

Where should I put this define()? A .php which is included by each other .php? – Lai Yu-Hsuan Jul 08 '11 at 04:25
1

@Lai Yu-Hsuan: You should have a Configuration file somewhere, containing details which are constant, and reused, throughout your website (like the database username/password/hostname, etc.) and that file is `include()`'d or `require()`'d once in every other PHP file on the site. So you would just include @zerkms' `define()` within that file, maybe even the `if()` section as well, and then you can switch FirePHP on and off very easily. – Luke Stevenson Jul 08 '11 at 05:25
1

this will produce an error if logging outside the if, better disable by $firephp->setEnabled(false); as mentioned by @cadom – wesamly Nov 02 '14 at 09:38

score 0 · Answer 3 · answered Jan 18 '12 at 12:42

followup to cadorn: If in your framework FirePHP is an optional install (addon,plugin,..) someone could eventually dissable or uninstall completely, you might consider to check FirePHP class or functions availability in your frameworks core via class_exists() or function_exists(), and in case FirePHP is out of reach, define subsititute functions. That way, you can avoid fatals, and eventually give some feedback/ouput alike "FirePHP not available"..

How to automatically remove debug statements for FirePHP?

3 Answers3