Accordion.php 3.71 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\jui;

use yii\base\InvalidConfigException;
11
use yii\helpers\ArrayHelper;
12 13 14 15 16 17 18 19
use yii\helpers\Html;

/**
 * Accordion renders an accordion jQuery UI widget.
 *
 * For example:
 *
 * ```php
Alexander Makarov committed
20 21 22
 * echo Accordion::widget([
 *     'items' => [
 *         [
23
 *             'header' => 'Section 1',
24
 *             'content' => 'Mauris mauris ante, blandit et, ultrices a, suscipit eget...',
Alexander Makarov committed
25 26
 *         ],
 *         [
27
 *             'header' => 'Section 2',
Alexander Makarov committed
28
 *             'headerOptions' => ['tag' => 'h3'],
29
 *             'content' => 'Sed non urna. Phasellus eu ligula. Vestibulum sit amet purus...',
Alexander Makarov committed
30 31 32 33 34 35 36 37
 *             'options' => ['tag' => 'div'],
 *         ],
 *     ],
 *     'options' => ['tag' => 'div'],
 *     'itemOptions' => ['tag' => 'div'],
 *     'headerOptions' => ['tag' => 'h3'],
 *     'clientOptions' => ['collapsible' => false],
 * ]);
38 39 40 41 42 43 44 45 46
 * ```
 *
 * @see http://api.jqueryui.com/accordion/
 * @author Alexander Kochetov <creocoder@gmail.com>
 * @since 2.0
 */
class Accordion extends Widget
{
	/**
47 48 49 50
	 * @var array the HTML attributes for the widget container tag. The following special options are recognized:
	 *
	 * - tag: string, defaults to "div", the tag name of the container tag of this widget
	 */
Alexander Makarov committed
51
	public $options = [];
52 53 54 55
	/**
	 * @var array list of collapsible items. Each item can be an array of the following structure:
	 *
	 * ~~~
Alexander Makarov committed
56
	 * [
57 58 59
	 *     'header' => 'Item header',
	 *     'content' => 'Item content',
	 *     // the HTML attributes of the item header container tag. This will overwrite "headerOptions".
Alexander Makarov committed
60
	 *     'headerOptions' => [],
61
	 *     // the HTML attributes of the item container tag. This will overwrite "itemOptions".
Alexander Makarov committed
62 63
	 *     'options' => [],
	 * ]
64
	 * ~~~
65
	 */
Alexander Makarov committed
66
	public $items = [];
67
	/**
68 69 70
	 * @var array list of HTML attributes for the item container tags. This will be overwritten
	 * by the "options" set in individual [[items]]. The following special options are recognized:
	 *
Alexander Kochetov committed
71
	 * - tag: string, defaults to "div", the tag name of the item container tags.
72
	 */
Alexander Makarov committed
73
	public $itemOptions = [];
74
	/**
75 76 77
	 * @var array list of HTML attributes for the item header container tags. This will be overwritten
	 * by the "headerOptions" set in individual [[items]]. The following special options are recognized:
	 *
Alexander Kochetov committed
78
	 * - tag: string, defaults to "h3", the tag name of the item container tags.
79
	 */
Alexander Makarov committed
80
	public $headerOptions = [];
81 82 83 84 85 86 87


	/**
	 * Renders the widget.
	 */
	public function run()
	{
88 89 90 91 92
		$options = $this->options;
		$tag = ArrayHelper::remove($options, 'tag', 'div');
		echo Html::beginTag($tag, $options) . "\n";
		echo $this->renderItems() . "\n";
		echo Html::endTag($tag) . "\n";
Qiang Xue committed
93
		$this->registerWidget('accordion', AccordionAsset::className());
94 95 96
	}

	/**
97
	 * Renders collapsible items as specified on [[items]].
98
	 * @return string the rendering result.
99
	 * @throws InvalidConfigException.
100
	 */
101
	protected function renderItems()
102
	{
Alexander Makarov committed
103
		$items = [];
104 105 106 107 108 109 110
		foreach ($this->items as $item) {
			if (!isset($item['header'])) {
				throw new InvalidConfigException("The 'header' option is required.");
			}
			if (!isset($item['content'])) {
				throw new InvalidConfigException("The 'content' option is required.");
			}
Alexander Makarov committed
111
			$headerOptions = array_merge($this->headerOptions, ArrayHelper::getValue($item, 'headerOptions', []));
112
			$headerTag = ArrayHelper::remove($headerOptions, 'tag', 'h3');
113
			$items[] = Html::tag($headerTag, $item['header'], $headerOptions);
Alexander Makarov committed
114
			$options = array_merge($this->itemOptions, ArrayHelper::getValue($item, 'options', []));
115
			$tag = ArrayHelper::remove($options, 'tag', 'div');
resurtm committed
116
			$items[] = Html::tag($tag, $item['content'], $options);
117
		}
118

119
		return implode("\n", $items);
120 121
	}
}