symfony + dojo = xtDojoPlugin
================================

Requirements
------------
* [symfony framework](http://www.symfony-project.org/installation) 1.2.X or higher

* [Dojo Toolkit SDK](http://www.dojotoolkit.org/download/)

Installation
------------
At first, you need to download or checkout plugin sources. Then to install plugin into project, 
move xtDojoPlugin into plugin directory and activate it.

    [php]
    // &lt;project_directory&gt;/config/ProjectConfiguration.class.php
    ...
    public function setup() 
    {
    ...
        $this-&gt;enablePlugins(&#039;xtDojoPlugin&#039;);
    ...
    }
    ...

After activation run clear cache symfony task.

    symfony cc

Now plugin is ready to configure dojo environment. You must run init task 
from console like this:

    symfony dojo:init

After that download Dojo SDK sources and place it to generated `src` directory. By default it is: `&lt;project_directory&gt;/web/js/dojo/src/`

    default directory structure:

    web/
      ...
      js/
        ...
        dojo/
          dev/
            main.js
          src/
            dijit/
            dojo/
            dojox/
            util/
            builder.js

Now dojo is configured and you can start using it.
Using plugin
------------
Fisrt of all you must define global `dojo.yml` file in the config folder of application you need. For example:

    &lt;project_directory&gt;/apps/backend/config/dojo.yml

This file has following structure:

    [yml]
    default: # required element
      theme: # theme block
        name: &#039;dojo_theme&#039; # dojo theme title | default: tundra
        css:  [&#039;css_file&#039;, &#039;another_css_file&#039;] # additional css files
      actions: # required element, action groups
        all: [group_name, another_group_name] # required elemrnt, set wich groups of dijits use for all actions
        action_name: [group_name] # set custom action to use specific groups of dijits
      dijits: # dijit blocks container
        group_name: # dijits block title
          block_id: {dojotype: &#039;dojoType&#039;} # id of html element in template: set of attributes for this id
          another_block_id: {dojotype: &#039;dojoType&#039;} # id of html element in template: set of attributes for this id
        another_group_name: # another dijits block

dojo.yml file example:

    [yml]
    default:
      theme: &#039;tundra&#039;
      actions:
        all: [&#039;layout&#039;]
      dijits:
        layout:
          borderConteiner: {dojoType: &#039;dijit.layout.BorderContainer&#039;, design: &#039;headline&#039;, liveSplitters: &#039;true&#039;}
          topPane: {dojoType: &#039;dijit.layout.ContentPane&#039;, region: &#039;top&#039;, minSize: &#039;50&#039;, splitter: &#039;true&#039;, style: &#039;height:50px&#039;}
          centerPane: {dojoType: &#039;dijit.layout.ContentPane&#039;, region: &#039;center&#039;, title: &#039;Another Pane&#039;}

template code for this specification will be:

    &lt;div id=&quot;borderConteiner&quot;&gt;
      &lt;div id=&quot;topPane&quot; title=&quot;The Title&quot;&gt;
        &lt;h1&gt;I&#039;m content!&lt;/h1&gt;
      &lt;/div&gt;
      &lt;div id=&quot;centerPane&quot;&gt;
        &lt;h1&gt;I&#039;m more content!&lt;/h1&gt;
      &lt;/div&gt;
    &lt;/div&gt;

Also you can use per module dojo.yml files to specify custom definition for layouts. You must place additional dojo.yml files into config folder of module. Files has folowwing structure

    [yml]
    default: # same as global, but not required
    all: # same as default excepts theme block 

&gt; #### Warning!
&gt; default directive is not required for this file. If you specify it here it will rewrite global specification

Some dojo instances must be defined in layout.php of your application for dojo. You must put in head block the following code:

    [php]
    &lt;?php echo dojo::init() ?&gt;

before &lt;/head&gt; tag, and set theme with

    &lt;body class=&quot;&lt;?php echo dojo::$theme ?&gt;&quot;&gt;

To add javascript functions in onload action you may use

    [php]
    &lt;?php dojo::addOnLoad(&#039;&lt;your javascript code here&gt;&#039;) ?&gt;

before `init()` is called.
[BR]
And at last to specify wich dojo widjets to use edit main.js file in `./web/js/dojo/dev` folder

    example main.js listing:

    dojo.provide(&quot;app.main&quot;);

    dojo.require(&quot;dojo.cookie&quot;);
    dojo.require(&quot;dojo.parser&quot;);

    dojo.require(&quot;dijit.layout.BorderContainer&quot;);
    dojo.require(&quot;dijit.layout.ContentPane&quot;);

Building dojo for production.
-----------------------------
To use dojo in production you must build dojo javascript with build task.

    symfony dojo:build

&gt; #### Warning!
&gt; to build dojo successfully you must have JRE/JDK installed on your computer

after build is necessary to put following string in your settings.yml file

    [yml]
    dojo_env: &#039;prod&#039;  # default value is dev

you must rebuild dojo after main.js changing

&gt; questions and suggestions you can sent to sadikoff [at] gmail.com