= sfCssTabs plugin =

Plugin for the symfony framework that generates tabs dynamically depending on the module that this seeing itself, to the style Wordpress Admin (of 2 levels: main tabs &amp; sub tabs), with valid XHTML.

== Screenshot ==

[[Image(screenshot.jpg)]]

== Instalation ==
Install the plugin
{{{
$ php symfony plugin-install http://plugins.symfony-project.com/sfCssTabsPlugin
}}}

== Usage ==
1. Opens to the file &#039;&#039;&#039;&quot;layout.php&quot;&#039;&#039;&#039;, located in: &lt;my_project&gt;/apps/&lt;myapp&gt;/templates/layout.php

2. It places the following code within the tags &lt;body&gt;&lt;/body&gt;

{{{
#!php
&lt;?php sfCssTabs::render() ?&gt;
}}}

3. Copy the example file called sfCssTabs.css that is in: &lt;my_project&gt;/web/sfCssTabsPlugin/css, to the folder css in: &lt;my_project&gt;/web/css

4. Opens to the file &#039;&#039;&#039;&quot;view.yml&quot;&#039;&#039;&#039;, located in: &lt;my_project&gt;/apps/&lt;myapp&gt;/config/view.yml

5. Adds or modifies the corresponding line by this:

{{{
#!yml
stylesheets: [main, sfCssTabs]
}}}

6. The following thing is to fill the configuration file: &#039;&#039;&#039;&quot;siteTabs.php&quot;&#039;&#039;&#039;.

== Config ==
Open the file &#039;&#039;&#039;&quot;siteTabs.php&quot;&#039;&#039;&#039;, located in: &lt;my_project&gt;/plugins/sfCssTabsPlugin/lib/siteTabs.php

=== $configTabs ===
1. Some keys have the following prefix: &#039;&#039;&#039;&quot;pt_&quot;&#039;&#039;&#039; (the configuration is applied for the main tabs); and &#039;&#039;&#039;&quot;st_&quot;&#039;&#039;&#039; (it is applied for the sub tabs).

2. &#039;&#039;&#039;&lt;properties&gt;&#039;&#039;&#039;: Within this array you can place all the properties that you please of the corresponding tag. This content works just as the one of the third parameter of helper link_to().

3. The content of: &#039;&#039;&#039;pt_li&#039;&#039;&#039;, &#039;&#039;&#039;pt_a&#039;&#039;&#039;, &#039;&#039;&#039;st_li&#039;&#039;&#039;, &#039;&#039;&#039;st_a&#039;&#039;&#039;; they are assigned to those tab that agree with the present module.
	 
It has the following format:

{{{
#!php
$configTabs = array(
	&#039;div&#039;   =&gt; array(&lt;properties&gt;),
	&#039;pt_ul&#039; =&gt; array(&lt;properties&gt;),
	&#039;pt_li&#039; =&gt; array(&lt;properties&gt;),
	&#039;pt_a&#039;  =&gt; array(&lt;properties&gt;),
	&#039;st_ul&#039; =&gt; array(&lt;properties&gt;),
	&#039;st_li&#039; =&gt; array(&lt;properties&gt;),
	&#039;st_a&#039;  =&gt; array(&lt;properties&gt;)
);
}}}

  a. &#039;&#039;&#039;&quot;div&quot;&#039;&#039;&#039;. By empty default. Single if something is added to him, the tabs are surrounded between &lt;div&gt;&lt;/div&gt;. Example:
  {{{
  #!php
  &#039;div&#039; =&gt; array(&#039;id&#039; =&gt; &#039;navcontainer&#039;, &#039;style&#039; =&gt; &#039;padding:2px&#039;),
  }}}

  b. &#039;&#039;&#039;&quot;pt_ul&quot;&#039;&#039;&#039;. By empty default. It is applied to the tags &lt;ul&gt;&lt;/ul&gt; of the main tabs. Example:
  {{{
  #!php
  &#039;pt_ul&#039; =&gt; array(&#039;id&#039; =&gt; &#039;adminmenu&#039;)
  }}}

  c. &#039;&#039;&#039;&quot;pt_li&quot;&#039;&#039;&#039;. By empty default. It is applied to the tags &lt;li&gt;&lt;/li&gt; of the main tabs. Example:
  {{{
  #!php
  &#039;pt_ul&#039; =&gt; array(&#039;id&#039; =&gt; &#039;adminmenu&#039;)
  }}}

  d. &#039;&#039;&#039;&quot;pt_a&quot;&#039;&#039;&#039;. By empty default. It is applied to the tags &lt;a&gt;&lt;/a&gt; of the main tabs. This part uses helper link_to(), and what you place within &lt;properties&gt; it is used within the third parameter of this helper. Example:
  {{{
  #!php
  &#039;pt_a&#039; =&gt; array(&#039;class&#039; =&gt; &#039;current&#039;),
  }}}

  e. &#039;&#039;&#039;&quot;st_ul&quot;&#039;&#039;&#039;. By empty default. It is applied to the tags &lt;ul&gt;&lt;/ul&gt; of the sub tabs. Example:
  {{{
  #!php
  &#039;st_ul&#039; =&gt; array(&#039;id&#039; =&gt; &#039;submenu&#039;),
  }}}

  f. &#039;&#039;&#039;&quot;st_li&quot;&#039;&#039;&#039;. By empty default. It is applied to the tags &lt;li&gt;&lt;/li&gt; of the sub tabs. Example:
  {{{
  #!php
  &#039;st_li&#039; =&gt; array(&#039;id&#039; =&gt; &#039;activeII&#039;),
  }}}

  g. &#039;&#039;&#039;&quot;st_a&quot;&#039;&#039;&#039;. By empty default. It is applied to the tags &lt;a&gt;&lt;/a&gt; of the sub tabs. This part uses helper link_to(), and what you place within &lt;properties&gt; it is used within the third parameter of this helper. Example:
  {{{
  #!php
  &#039;st_a&#039; =&gt; array(&#039;class&#039; =&gt; &#039;current&#039;)
  }}}
		 
		 
=== $tabs ===
It represents a main tab that will be added. It has the following format:

{{{
#!php
$tabs[] = array(
  &#039;label&#039;       =&gt; &#039;&#039;,
  &#039;module&#039;      =&gt; &#039;&#039;,
  &#039;linkOptions&#039; =&gt; array()
);
}}}

  a. &#039;&#039;&#039;&quot;label&quot;&#039;&#039;&#039;. This value will be added in the first parameter of helper link_to(), and is the content of the tab. Example:
  {{{
  #!php
  &#039;label&#039; =&gt; &#039;Home&#039;,
  }}}

  b. &#039;&#039;&#039;&quot;module&quot;&#039;&#039;&#039;. The name of the module to which an tab belongs. Its value is added to the second parameter of helper link_to(). Example:
  {{{
  #!php
  &#039;module&#039; =&gt; &#039;index&#039;,
  }}}

  c. &#039;&#039;&#039;&quot;linkOptions&quot;&#039;&#039;&#039;. Its value is added to the third parameter of helper link_to(). It verifies not to such place data that you placed in &quot;pt_a&quot;. Example:
  {{{
  #!php
  &#039;linkOptions&#039; =&gt; array(&#039;title&#039; =&gt; &#039;My tab&#039;)
  }}}
		 
	
=== $subTabs ===
It represents a sub tab that will be added under a &quot;main tab&quot; or &quot;parent tab&quot;. It has the following format:

{{{
#!php
$subTabs[] = array(
  &#039;label&#039;       =&gt; &#039;&#039;,
  &#039;module&#039;      =&gt; &#039;&#039;,
  &#039;linkOptions&#039; =&gt; array(),
  &#039;parentTab&#039;   =&gt; &#039;&#039;
);
}}}

  a. &#039;&#039;&#039;&quot;label&quot;&#039;&#039;&#039;. This value will be added in the first parameter of helper link_to(), and is the content of the tab. Example:
  {{{
  #!php
  &#039;label&#039; =&gt; &#039;Index&#039;,
  }}}

  b. &#039;&#039;&#039;&quot;module&quot;&#039;&#039;&#039;. The name of the module to which an tab belongs. Its value is added to the second parameter of helper link_to().
  {{{
  &#039;&#039;&#039;Note&#039;&#039;&#039;
  In most of the cases, first sub tab has like Link to the module of his parent tab.
  }}}

  Example:
  {{{
  #!php
  &#039;module&#039; =&gt; &#039;index&#039;,
  }}}

  c. &#039;&#039;&#039;&quot;linkOptions&quot;&#039;&#039;&#039;. Its value is added to the third parameter of helper link_to(). It verifies not to such place data that you placed in &quot;st_a&quot;. Example:
  {{{
  #!php
  &#039;linkOptions&#039; =&gt; array(&#039;title&#039; =&gt; &#039;my tab 1&#039;),
  }}}

  d. &#039;&#039;&#039;&quot;parentTab&#039;&#039;&#039;&quot;. Parent tab to which sub tab belongs. Example:
  {{{
  #!php
  &#039;parentTab&#039; =&gt; &#039;index&#039;
  }}}


== Results ==
The XHTML code:
{{{
#!text/html
&lt;div id=&quot;navcontainer&quot; style=&quot;padding: 2px;&quot;&gt;
  &lt;ul id=&quot;adminmenu&quot;&gt;
    &lt;li id=&quot;active&quot;&gt;
      &lt;a class=&quot;current&quot; href=&quot;/edit&quot;&gt;Manage&lt;/a&gt;
    &lt;/li&gt;
    &lt;li&gt;
      &lt;a href=&quot;/comments&quot;&gt;Comments&lt;/a&gt;
    &lt;/li&gt;
    &lt;li&gt;
      &lt;a href=&quot;/blogroll&quot;&gt;Blog Roll&lt;/a&gt;
    &lt;/li&gt;
  &lt;/ul&gt;
  &lt;ul id=&quot;submenu&quot;&gt;
    &lt;li id=&quot;activeII&quot;&gt;
      &lt;a class=&quot;current&quot; href=&quot;/edit&quot;&gt;Posts&lt;/a&gt;
    &lt;/li&gt;
    &lt;li&gt;
      &lt;a href=&quot;/pages&quot;&gt;Pages&lt;/a&gt;
    &lt;/li&gt;
    &lt;li&gt;
      &lt;a href=&quot;/uploads&quot;&gt;Uploads&lt;/a&gt;
    &lt;/li&gt;
  &lt;/ul&gt;
&lt;/div&gt;
}}}

The image:

[[Image(screenshot.jpg)]]

== Contacts ==
 * Pedro Hernández (phpleo [at] gmail [dot] com ), [http://blog.phpleo.com/ http://blog.phpleo.com/]

== TODO ==
 * Integration with AJAX.
 * Integration with Admin generation.

== Changelog ==

=== 2007-08-22 | 0.0.5 Alpha ===
 * Corrected errors in the documentation.
 * Changed to the licenses of the archives *.php to the one of MIT.

=== 2007-08-22 | 0.0.4 Alpha ===
 * Initial public release.