Yii Framework Debug Toolbar Extension
PHP
Pull request Compare This branch is 1 commit ahead, 21 commits behind cr0t:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
views
.gitignore
README.markdown
XWebDebugRouter.php

README.markdown

#Yii Debug Toolbar Yii Framework Extension

This extension is very useful in the development stage of project. It helps you to get info about PHP environment, application, queries logs, benchmarking with a simple little toolbar at the top of the page.

It is a recreated Symfony's developer toolbar. First idea and very first implementation was my, but this version mostly implemented by Eduard Kuleshov.

#Usage

##Requirements

  • Yii 1.0 or above

##Installation

  • Extract the release file under protected/extensions

##Usage

main.php configuration file update:

[...] 
// autoloading model and component classes
'import'=>array(
  'application.models.*',
  'application.components.*',
  'application.extensions.yiidebugtb.*', //our extension
),
[...]
'log'=>array(
  'class'=>'CLogRouter',
    'routes'=>array(
      array(
        'class'=>'CFileLogRoute',
        'levels'=>'error, warning, trace',
      ),
      array( // configuration for the toolbar
        'class'=>'XWebDebugRouter',
        'config'=>'alignLeft, opaque, runInDebug, fixedPos, collapsed, yamlStyle',
        'levels'=>'error, warning, trace, profile, info',
      ),
    ),
),
[...]

###Options reference

  • ‘alignLeft’ => Debug toolbar will be aligned to the top left corner of browser window
  • ‘opaque’ => Makes debug toolbar almost invisible when it’s minimized
  • ‘runInDebug’ => Show debug toolbar only if Yii application running in DEBUG MODE (see index.php for details)
  • ‘fixedPos’ => Makes debug toolbar sticky with browser window, not document!
  • ‘collapsed’ => Show debug toolbar minimized by default
  • ‘yamlStyle’ => Show configuration report in Yaml or PHP-array style.