# Advent Calendar 2009 Web Debug Plugin #

This plugin is meant to go along with chapter 10 of the 2009 symfony advent
calendar [More with Symfony](http://www.symfony-project.org/advent_calendar/).

This is an example of 3 different web debug panels:

 * [symplist.net](http://www.symplist.net) plugin search panel
 * [symfony-check.org](http://symfony-check.org) deployment checklist panel
 * symfony documentation link panel

## Prerequisites ##

The `symplist` panel requires the curl extension for PHP. The `symplist` panel also
requires jQuery. The developer can provide jQuery or the plugin can include it
automatically.

## Installation ##

 * Install the plugin (via a package)

        symfony plugin:install ac2009WebDebugPlugin --stability=alpha

 * Install the plugin (via a Subversion checkout)
  
        svn co http//svn.symfony-project.com/plugins/ac2009WebDebugPlugin plugins/ac2009WebDebugPlugin

 * Activate the plugin in the `config/ProjectConfiguration.class.php`
  
        [php]
        class ProjectConfiguration extends sfProjectConfiguration
        {
          public function setup()
          {
            $this->enablePlugins(array(
              'sfDoctrinePlugin', 
              'ac2009WebDebugPlugin',
              '...'
            ));
          }

 * Make sure that the plugin web directory is available

        symfony plugin:publish-assets

## Configuration ##

The plugin can be fully configured via a set of app.yml configuration variables. By default,
the following configuration is used:

        all:
          ac_2009_web_debug_plugin:
            panels:
              symplist:      ac2009WebDebugPanelSymplist
              checklist:     ac2009WebDebugPanelChecklist
              documentation: ac2009WebDebugPanelDocumentation
            include_jquery:  true
            symplist_proxy_path: "/ac2009WebDebugPlugin/scripts/symplist.php"

To disable a particular panel, replace the class name with a `~`:

        all:
          ac_2009_web_debug_plugin:
            panels:
              documentation:      ~