Tabs.php 7.17 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
 * ```
 *
MarsuBoss committed
50
 * @see http://getbootstrap.com/javascript/#tabs
Antonio Ramirez committed
51 52 53 54 55 56 57 58 59
 * @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
	 * - headerOptions: array, optional, the HTML attributes of the tab header.
62
	 * - linkOptions: array, optional, the HTML attributes of the tab header link tags.
63 64
	 * - 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
65
	 * - active: boolean, optional, whether the item tab header and pane should be visible or not.
66
	 * - items: array, optional, if not set then `content` will be required. The `items` specify a dropdown items
Qiang Xue committed
67
	 *   configuration array. Each item can hold two extra keys, besides the above ones:
Qiang Xue committed
68 69 70
	 *     * 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
71
	 */
Alexander Makarov committed
72
	public $items = [];
73 74 75 76 77 78
	/**
	 * @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
79
	public $itemOptions = [];
80 81 82 83
	/**
	 * @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
84
	public $headerOptions = [];
85 86 87 88 89
	/**
	 * @var array list of HTML attributes for the tab header link tags. This will be overwritten
	 * by the "linkOptions" set in individual [[items]].
	 */
	public $linkOptions = [];
90 91 92 93
	/**
	 * @var boolean whether the labels for header items should be HTML-encoded.
	 */
	public $encodeLabels = true;
94
	/**
95
	 * @var string specifies the Bootstrap tab styling.
96 97
	 */
	public $navType = 'nav-tabs';
Antonio Ramirez committed
98 99 100 101 102 103 104 105


	/**
	 * Initializes the widget.
	 */
	public function init()
	{
		parent::init();
106
		Html::addCssClass($this->options, 'nav ' . $this->navType);
Antonio Ramirez committed
107 108 109 110 111 112 113
	}

	/**
	 * Renders the widget.
	 */
	public function run()
	{
114
		echo $this->renderItems();
Antonio Ramirez committed
115 116 117 118
		$this->registerPlugin('tab');
	}

	/**
119
	 * Renders tab items as specified on [[items]].
Antonio Ramirez committed
120
	 * @return string the rendering result.
121
	 * @throws InvalidConfigException.
Antonio Ramirez committed
122
	 */
123
	protected function renderItems()
Antonio Ramirez committed
124
	{
Alexander Makarov committed
125 126
		$headers = [];
		$panes = [];
127 128 129 130 131

		if (!$this->hasActiveTab() && !empty($this->items)) {
			$this->items[0]['active'] = true;
		}

132 133 134
		foreach ($this->items as $n => $item) {
			if (!isset($item['label'])) {
				throw new InvalidConfigException("The 'label' option is required.");
Antonio Ramirez committed
135
			}
Qiang Xue committed
136
			$label = $this->encodeLabels ? Html::encode($item['label']) : $item['label'];
Alexander Makarov committed
137
			$headerOptions = array_merge($this->headerOptions, ArrayHelper::getValue($item, 'headerOptions', []));
138
			$linkOptions = array_merge($this->linkOptions, ArrayHelper::getValue($item, 'linkOptions', []));
139 140 141

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

Qiang Xue committed
144
				if ($this->renderDropdown($item['items'], $panes)) {
145
					Html::addCssClass($headerOptions, 'active');
146 147
				}

148 149 150
				Html::addCssClass($linkOptions, 'dropdown-toggle');
				$linkOptions['data-toggle'] = 'dropdown';
				$header = Html::a($label, "#", $linkOptions) . "\n"
151
					. Dropdown::widget(['items' => $item['items'], 'clientOptions' => false, 'view' => $this->getView()]);
Qiang Xue committed
152
			} elseif (isset($item['content'])) {
Alexander Makarov committed
153
				$options = array_merge($this->itemOptions, ArrayHelper::getValue($item, 'options', []));
154 155
				$options['id'] = ArrayHelper::getValue($options, 'id', $this->options['id'] . '-tab' . $n);

156
				Html::addCssClass($options, 'tab-pane');
157
				if (ArrayHelper::remove($item, 'active')) {
158 159
					Html::addCssClass($options, 'active');
					Html::addCssClass($headerOptions, 'active');
160
				}
161 162
				$linkOptions['data-toggle'] = 'tab';
				$header = Html::a($label, '#' . $options['id'], $linkOptions);
163
				$panes[] = Html::tag('div', $item['content'], $options);
Qiang Xue committed
164 165
			} else {
				throw new InvalidConfigException("Either the 'content' or 'items' option must be set.");
166 167
			}

Qiang Xue committed
168
			$headers[] = Html::tag('li', $header, $headerOptions);
Antonio Ramirez committed
169
		}
Qiang Xue committed
170 171

		return Html::tag('ul', implode("\n", $headers), $this->options) . "\n"
172
		. Html::tag('div', implode("\n", $panes), ['class' => 'tab-content']);
Antonio Ramirez committed
173 174
	}

175 176 177 178 179 180 181 182 183 184 185 186 187
	/**
	 * @return boolean if there's active tab defined
	 */
	protected function hasActiveTab()
	{
		foreach ($this->items as $item) {
			if (isset($item['active']) && $item['active']===true) {
				return true;
			}
		}
		return false;
	}

Antonio Ramirez committed
188
	/**
189 190 191 192 193
	 * 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
194 195
	 * @throws InvalidConfigException
	 */
Qiang Xue committed
196
	protected function renderDropdown(&$items, &$panes)
Antonio Ramirez committed
197
	{
198 199 200 201 202
		$itemActive = false;

		foreach ($items as $n => &$item) {
			if (is_string($item)) {
				continue;
Antonio Ramirez committed
203
			}
Qiang Xue committed
204
			if (!isset($item['content'])) {
Antonio Ramirez committed
205 206
				throw new InvalidConfigException("The 'content' option is required.");
			}
207 208

			$content = ArrayHelper::remove($item, 'content');
Alexander Makarov committed
209
			$options = ArrayHelper::remove($item, 'contentOptions', []);
210
			Html::addCssClass($options, 'tab-pane');
211
			if (ArrayHelper::remove($item, 'active')) {
212 213
				Html::addCssClass($options, 'active');
				Html::addCssClass($item['options'], 'active');
214
				$itemActive = true;
Antonio Ramirez committed
215
			}
Antonio Ramirez committed
216

217 218 219
			$options['id'] = ArrayHelper::getValue($options, 'id', $this->options['id'] . '-dd-tab' . $n);
			$item['url'] = '#' . $options['id'];
			$item['linkOptions']['data-toggle'] = 'tab';
Antonio Ramirez committed
220

221 222 223
			$panes[] = Html::tag('div', $content, $options);

			unset($item);
Antonio Ramirez committed
224
		}
225
		return $itemActive;
Antonio Ramirez committed
226
	}
Qiang Xue committed
227
}