Tabs.php 6.39 KB
Newer Older
Antonio Ramirez committed
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\bootstrap;

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

/**
 * Tabs renders a Tab bootstrap javascript component.
 *
 * For example:
 *
 * ```php
Alexander Makarov committed
20 21 22
 * echo Tabs::widget([
 *     'items' => [
 *         [
23
 *             'label' => 'One',
Antonio Ramirez committed
24
 *             'content' => 'Anim pariatur cliche...',
25
 *             'active' => true
Alexander Makarov committed
26 27
 *         ],
 *         [
28
 *             'label' => 'Two',
Antonio Ramirez committed
29
 *             'content' => 'Anim pariatur cliche...',
Alexander Makarov committed
30 31 32 33
 *             'headerOptions' => [...],
 *             'options' => ['id' => 'myveryownID'],
 *         ],
 *         [
34
 *             'label' => 'Dropdown',
Alexander Makarov committed
35 36
 *             'items' => [
 *                  [
Antonio Ramirez committed
37 38
 *                      'label' => 'DropdownA',
 *                      'content' => 'DropdownA, Anim pariatur cliche...',
Alexander Makarov committed
39 40
 *                  ],
 *                  [
Antonio Ramirez committed
41 42
 *                      'label' => 'DropdownB',
 *                      'content' => 'DropdownB, Anim pariatur cliche...',
Alexander Makarov committed
43 44 45 46 47
 *                  ],
 *             ],
 *         ],
 *     ],
 * ]);
Antonio Ramirez committed
48 49 50 51 52 53 54 55 56 57 58 59
 * ```
 *
 * @see http://twitter.github.io/bootstrap/javascript.html#tabs
 * @author Antonio Ramirez <amigo.cobos@gmail.com>
 * @since 2.0
 */
class Tabs extends Widget
{
	/**
	 * @var array list of tabs in the tabs widget. Each array element represents a single
	 * tab with the following structure:
	 *
Antonio Ramirez committed
60
	 * - label: string, required, the tab header label.
61 62 63
	 * - headerOptions: array, optional, the HTML attributes of the tab header.
	 * - content: array, required if `items` is not set. The content (HTML) of the tab pane.
	 * - options: array, optional, the HTML attributes of the tab pane container.
Qiang Xue committed
64
	 * - active: boolean, optional, whether the item tab header and pane should be visible or not.
65
	 * - items: array, optional, if not set then `content` will be required. The `items` specify a dropdown items
Qiang Xue committed
66
	 *   configuration array. Each item can hold two extra keys, besides the above ones:
Qiang Xue committed
67 68 69
	 *     * active: boolean, optional, whether the item tab header and pane should be visible or not.
	 *     * content: string, required if `items` is not set. The content (HTML) of the tab pane.
	 *     * contentOptions: optional, array, the HTML attributes of the tab content container.
Antonio Ramirez committed
70
	 */
Alexander Makarov committed
71
	public $items = [];
72 73 74 75 76 77
	/**
	 * @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:
	 *
	 * - tag: string, defaults to "div", the tag name of the item container tags.
	 */
Alexander Makarov committed
78
	public $itemOptions = [];
79 80 81 82
	/**
	 * @var array list of HTML attributes for the header container tags. This will be overwritten
	 * by the "headerOptions" set in individual [[items]].
	 */
Alexander Makarov committed
83
	public $headerOptions = [];
84 85 86 87
	/**
	 * @var boolean whether the labels for header items should be HTML-encoded.
	 */
	public $encodeLabels = true;
88 89 90 91
	/**
	 * @var string, specifies the Bootstrap tab styling.
	 */
	public $navType = 'nav-tabs';
Antonio Ramirez committed
92 93 94 95 96 97 98 99


	/**
	 * Initializes the widget.
	 */
	public function init()
	{
		parent::init();
100
		Html::addCssClass($this->options, 'nav ' . $this->navType);
Antonio Ramirez committed
101 102 103 104 105 106 107
	}

	/**
	 * Renders the widget.
	 */
	public function run()
	{
108
		echo $this->renderItems();
Antonio Ramirez committed
109 110 111 112
		$this->registerPlugin('tab');
	}

	/**
113
	 * Renders tab items as specified on [[items]].
Antonio Ramirez committed
114
	 * @return string the rendering result.
115
	 * @throws InvalidConfigException.
Antonio Ramirez committed
116
	 */
117
	protected function renderItems()
Antonio Ramirez committed
118
	{
Alexander Makarov committed
119 120
		$headers = [];
		$panes = [];
121 122 123
		foreach ($this->items as $n => $item) {
			if (!isset($item['label'])) {
				throw new InvalidConfigException("The 'label' option is required.");
Antonio Ramirez committed
124
			}
Qiang Xue committed
125
			$label = $this->encodeLabels ? Html::encode($item['label']) : $item['label'];
Alexander Makarov committed
126
			$headerOptions = array_merge($this->headerOptions, ArrayHelper::getValue($item, 'headerOptions', []));
127 128 129

			if (isset($item['items'])) {
				$label .= ' <b class="caret"></b>';
130
				Html::addCssClass($headerOptions, 'dropdown');
131

Qiang Xue committed
132
				if ($this->renderDropdown($item['items'], $panes)) {
133
					Html::addCssClass($headerOptions, 'active');
134 135
				}

Alexander Makarov committed
136 137
				$header = Html::a($label, "#", ['class' => 'dropdown-toggle', 'data-toggle' => 'dropdown']) . "\n"
					. Dropdown::widget(['items' => $item['items'], 'clientOptions' => false]);
Qiang Xue committed
138
			} elseif (isset($item['content'])) {
Alexander Makarov committed
139
				$options = array_merge($this->itemOptions, ArrayHelper::getValue($item, 'options', []));
140 141
				$options['id'] = ArrayHelper::getValue($options, 'id', $this->options['id'] . '-tab' . $n);

142
				Html::addCssClass($options, 'tab-pane');
143
				if (ArrayHelper::remove($item, 'active')) {
144 145
					Html::addCssClass($options, 'active');
					Html::addCssClass($headerOptions, 'active');
146
				}
Alexander Makarov committed
147
				$header = Html::a($label, '#' . $options['id'], ['data-toggle' => 'tab']);
148
				$panes[] = Html::tag('div', $item['content'], $options);
Qiang Xue committed
149 150
			} else {
				throw new InvalidConfigException("Either the 'content' or 'items' option must be set.");
151 152
			}

Qiang Xue committed
153
			$headers[] = Html::tag('li', $header, $headerOptions);
Antonio Ramirez committed
154
		}
Qiang Xue committed
155 156

		return Html::tag('ul', implode("\n", $headers), $this->options) . "\n"
Alexander Makarov committed
157
			. Html::tag('div', implode("\n", $panes), ['class' => 'tab-content']);
Antonio Ramirez committed
158 159 160
	}

	/**
161 162 163 164 165
	 * Normalizes dropdown item options by removing tab specific keys `content` and `contentOptions`, and also
	 * configure `panes` accordingly.
	 * @param array $items the dropdown items configuration.
	 * @param array $panes the panes reference array.
	 * @return boolean whether any of the dropdown items is `active` or not.
Antonio Ramirez committed
166 167
	 * @throws InvalidConfigException
	 */
Qiang Xue committed
168
	protected function renderDropdown(&$items, &$panes)
Antonio Ramirez committed
169
	{
170 171 172 173 174
		$itemActive = false;

		foreach ($items as $n => &$item) {
			if (is_string($item)) {
				continue;
Antonio Ramirez committed
175
			}
Qiang Xue committed
176
			if (!isset($item['content'])) {
Antonio Ramirez committed
177 178
				throw new InvalidConfigException("The 'content' option is required.");
			}
179 180

			$content = ArrayHelper::remove($item, 'content');
Alexander Makarov committed
181
			$options = ArrayHelper::remove($item, 'contentOptions', []);
182
			Html::addCssClass($options, 'tab-pane');
183
			if (ArrayHelper::remove($item, 'active')) {
184 185
				Html::addCssClass($options, 'active');
				Html::addCssClass($item['options'], 'active');
186
				$itemActive = true;
Antonio Ramirez committed
187
			}
Antonio Ramirez committed
188

189 190 191
			$options['id'] = ArrayHelper::getValue($options, 'id', $this->options['id'] . '-dd-tab' . $n);
			$item['url'] = '#' . $options['id'];
			$item['linkOptions']['data-toggle'] = 'tab';
Antonio Ramirez committed
192

193 194 195
			$panes[] = Html::tag('div', $content, $options);

			unset($item);
Antonio Ramirez committed
196
		}
197
		return $itemActive;
Antonio Ramirez committed
198
	}
Qiang Xue committed
199
}