# sw2DecorationToolkitPlugin #

This contains some frequently used helpers, libraries, and images used for most projects

## Libraries ##

### sw2Debug class ###
This class contains a static method to output a variable

    [php]
    sw2Debug::p($variable, &quot;I&#039;m dead&quot;, true); // Will echo the var_dump of $variable and die() afterwards with &quot;I&#039;m Dead&quot;

## Helpers ##

### sw2AdminLayout ###
This contains the functionality to output a full admin panel layout with drop down menu

#### Menu Array ####
First make the menu array in your app.yml file for the correct app

__Example__ */apps/admin/config/app.yml*

    [yaml]
    all:
      sw2AdminLayout:
        menu:
          Admin:
            Home: &#039;@homepage&#039;
            Logout: &#039;@sf_guard_signout&#039;
          Persons: person/index
          Settings:
            Capabilities: capability/index
            Settings: &#039;@sf_settings&#039;
          Work:
            Works: work/index
            Clients: client/index
          Security:
            Users: &#039;@sf_guard_user&#039;
            Groups: &#039;@sf_guard_group&#039;

Then update the layout.php for the correct app

__Example__ */apps/admin/templates/layout.php*

    [php]
    &lt;?php use_helper(&#039;sw2AdminLayout&#039;, &#039;sw2LayoutControl&#039;) ?&gt;
    &lt;!DOCTYPE html PUBLIC &quot;-//W3C//DTD XHTML 1.0 Transitional//EN&quot; &quot;http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd&quot;&gt;
    &lt;html xmlns=&quot;http://www.w3.org/1999/xhtml&quot; xml:lang=&quot;en&quot; lang=&quot;en&quot;&gt;
    &lt;head&gt;
      &lt;?php include_http_metas() ?&gt;
      &lt;?php include_metas() ?&gt;

      &lt;?php include_title() ?&gt;

      &lt;link rel=&quot;shortcut icon&quot; href=&quot;/favicon.ico&quot; /&gt;
      &lt;?php include_stylesheets() ?&gt;
      &lt;?php include_javascripts() ?&gt;
    &lt;/head&gt;
    &lt;body&lt;?php echo get_body_class($this, &#039;&#039;) ?&gt;&gt;
    &lt;h2&gt;Admin Panel - STUDIO llc&lt;/h2&gt;
    &lt;?php echo getAdminPage($sf_data-&gt;getRaw(&#039;sf_content&#039;)) ?&gt;
    &lt;/body&gt;
    &lt;/html&gt;

![Admin Panel Menu](http://svn.symfony-project.org/plugins/sw2DecorationToolkitPlugin/docs/2.0/images/s2AdminLayout_Screenshot.png &quot;Screenshot of the Admin Menu in Action&quot;)


### sw2LayoutControl ###
This contains functionality for outputting the correct body class.

    [php]
    # To use helper
    &lt;?php use_helper(&#039;sw2LayoutControl&#039;); ?&gt;

    # /apps/frontend/public/templates/layout.php
    &lt;body&lt;?php echo get_body_class($this, &#039;parent_class&#039;) ?&gt;&gt;

    # /apps/frontend/public/modules/home/templates/indexSuccess.php
    &lt;?php add_body_class(&#039;home_class&#039;); /&gt;
    
    # Outputs the following html
    &lt;body class=&quot;.home .index .home_class&quot;&gt;

## Images ##
In /web/images/icons is the entire [FamFamFam Silk Icon][famfamfam] set

    [php]
    &lt;img src=&quot;&lt;?php echo image_path(&#039;/sw2DecorationToolkitPlugin/images/icons/wrench.png&#039;) ?&gt;&quot; alt=&quot;Wrench&quot; /&gt;

[famfamfam]: http://www.famfamfam.com/lab/icons/silk/ &quot;Silk Icons&quot;