Merge pull request #412 from creocoder/jui-accordion-rework

[READY] jQuery UI accordion rework

framework/yii/jui/Accordion.php

@@ -25,11 +25,27 @@ use yii\helpers\Html;
  *         ),
  *         array(
  *             'header' => 'Section 2',
- *             'headerOptions' => array(...),
+ *             'headerOptions' => array(
+ *                 'tag' => 'h3',
+ *             ),
  *             'content' => 'Sed non urna. Phasellus eu ligula. Vestibulum sit amet purus...',
- *             'options' => array(...),
+ *             'options' => array(
+ *                 'tag' => 'div',
+ *             ),
  *         ),
  *     ),
+ *     'options' => array(
+ *         'tag' => 'div',
+ *     ),
+ *     'itemOptions' => array(
+ *         'tag' => 'div',
+ *     ),
+ *     'headerOptions' => array(
+ *         'tag' => 'h3',
+ *     ),
+ *     'clientOptions' => array(
+ *         'collapsible' => false,
+ *     ),
  * ));
  * ```
  *
@@ -40,23 +56,17 @@ use yii\helpers\Html;
 class Accordion extends Widget
 {
 	/**
-	 * @var array list of sections in the accordion widget. Each array element represents a single
+	 * @var array list of collapsible sections.
-	 * section with the following structure:
-	 *
-	 * ```php
-	 * array(
-	 *     // required, the header (HTML) of the section
-	 *     'header' => 'Section label',
-	 *     // required, the content (HTML) of the section
-	 *     'content' => 'Mauris mauris ante, blandit et, ultrices a, suscipit eget...',
-	 *     // optional the HTML attributes of the section content container
-	 *     'options'=> array(...),
-	 *     // optional the HTML attributes of the section header container
-	 *     'headerOptions'=> array(...),
-	 * )
-	 * ```
 	 */
 	public $items = array();
+	/**
+	 * @var array list of individual collabsible section default options.
+	 */
+	public $itemOptions = array();
+	/**
+	 * @var array list of individual collabsible section header default options.
+	 */
+	public $headerOptions = array();
 
 
 	/**
@@ -64,9 +74,11 @@ class Accordion extends Widget
 	 */
 	public function run()
 	{
-		echo Html::beginTag('div', $this->options) . "\n";
+		$options = $this->options;
-		echo $this->renderSections() . "\n";
+		$tag = ArrayHelper::remove($options, 'tag', 'div');
-		echo Html::endTag('div') . "\n";
+		echo Html::beginTag($tag, $options) . "\n";
+		echo $this->renderItems() . "\n";
+		echo Html::endTag($tag) . "\n";
 		$this->registerWidget('accordion');
 	}
 
@@ -75,9 +87,9 @@ class Accordion extends Widget
 	 * @return string the rendering result.
 	 * @throws InvalidConfigException.
 	 */
-	protected function renderSections()
+	protected function renderItems()
 	{
-		$sections = array();
+		$items = array();
 		foreach ($this->items as $item) {
 			if (!isset($item['header'])) {
 				throw new InvalidConfigException("The 'header' option is required.");
@@ -85,12 +97,14 @@ class Accordion extends Widget
 			if (!isset($item['content'])) {
 				throw new InvalidConfigException("The 'content' option is required.");
 			}
-			$headerOptions = ArrayHelper::getValue($item, 'headerOptions', array());
+			$headerOptions = array_merge($this->headerOptions, ArrayHelper::getValue($item, 'headerOptions', array()));
-			$sections[] = Html::tag('h3', $item['header'], $headerOptions);
+			$headerTag = ArrayHelper::remove($headerOptions, 'tag', 'h3');
-			$options = ArrayHelper::getValue($item, 'options', array());
+			$items[] = Html::tag($headerTag, $item['header'], $headerOptions);
-			$sections[] = Html::tag('div', $item['content'], $options);;
+			$options = array_merge($this->itemOptions, ArrayHelper::getValue($item, 'options', array()));
+			$tag = ArrayHelper::remove($options, 'tag', 'div');
+			$items[] = Html::tag($tag, $item['content'], $options);;
 		}
 
-		return implode("\n", $sections);
+		return implode("\n", $items);
 	}
 }