jusuff edited this page Aug 4, 2012 · 9 revisions
Clone this wiki locally

What is ZikulaBug

ZikulaBug is Firebug extension which provides a friendly interface for Zikula's DebugToolbar data.



Server side: Zikula 1.3 with DebugToolbar enabled (see Installation)
Client side: Firefox 14+, Firebug 1.10+


Download ZikulaBug and install ZikulaBug as any other Firefox extension.

Go to Mozilla Addons site to download ZikulaBug

After installation configure you Zikula powered site to enable DebugToolbar and turn on data export for ZikulaBug.

To do this you will need to edit config.php file (personal_config.php etc).

First you need to turn on development mode:

$ZConfig['System']['development'] = 1;      // development mode 1/0 for on or off.  Disable in production mode.

Next set up DebugToolbar:

$ZConfig['Log']['log.to_debug_toolbar'] = 1;        // 1 to show the debug toolbar (reqires development 1), 0 to disable
$ZConfig['Log']['log.to_debug_toolbar_output'] = 1; // Debug toolbar output type: 0 - normal toolbar, 1 - json output, 2 - both
$ZConfig['Log']['log.to_debug_toolbar_seckey'] = ''; // Security key for debug toolbar output of json type
                                                     // If defined - it's required that http request contains custom header
                                                     // "HTTP_X_ZIKULA_DEBUGTOOLBAR" equal to this key, otherwise no data is returned.

$ZConfig['Log']['log.to_debug_toolbar_output'] says how DebugToolbar should work. If set to "0" it will display regular toolbar. When set to "1" - toolbar will be invisible, but it's data will be available for ZikulaBug. When set to "2" - both modes will work - toolbar and ZikulaBug.

$ZConfig['Log']['log.to_debug_toolbar_seckey'] allows to set secret key, which protects data. When "secKey" is set, DebugToolbar data is accessible only for authorized request. To access it using ZikulaBug you will need to set the same key in "Settings" tab.

You can test addon without installing and/or configuring Zikula - just install ZikulaBug, visit test site and set secKey to "testKey".


After successful installation you'll see new panel inside Firebug, called "Zikula". First time you'll need to activate it, the same way as any other Firebug panel.

Once ZikulaBug is activated you will see eight tabs: General, Configuration, SQL, Templates, Function Executions, Log Console, HTTP request and Settings.


This tab displays general informations and statistics about Zikula and ZikulaBug.

General panel.


Here you can find Zikula and current module configuration variables. They are displayed in collapsible tree, which allows to easy explore them.



Lists all executed SQL queries and time it took.

SQL queries.


Contains list of included templates with variables assigned to them. After each template file name, inside parentheses module or theme name is displayed.


Function Executions

List all module/API function executions. For each function you can find: its name, the arguments passed, the returned data and the time it took.

Function extecutions.

Log Console

Shows errors, warnings and data logged to Zikula LogUtil. For each entry you can find: its type, message and file and line it was called. Entry message is preceded by a plus icon, which allows to show/hide additional tab, containing full backtrace for given entry.

Log console.

HTTP request

Lists PHP superglobals such as $_GET, $_POST, $_FILES, $_COOKIE, $_SERVER and _$_ENV. First entry - "method" - tells what type of request has been sent.

Inside "cookie" entry cookies encoded by Zikula.Cookie javascript util contain two entries: "Original value" with raw cookie data and "Decoded value" with readable, decoded value.

HTTP request.


This tab allows to browse and manage "secKeys". When you set in Zikula's config file some key in $ZConfig['Log']['log.to_debug_toolbar_seckey'] variable, you will need to set the same key for this site in this tab.