Yii2 Bootstrap 3
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

196 lines
6.4 KiB

12 years ago
<?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;
use yii\helpers\ArrayHelper;
12 years ago
use yii\helpers\Html;
/**
* Tabs renders a Tab bootstrap javascript component.
*
* For example:
*
* ```php
* echo Tabs::widget(array(
* 'items' => array(
* array(
* 'label' => 'One',
12 years ago
* 'content' => 'Anim pariatur cliche...',
* 'active' => true
12 years ago
* ),
* array(
* 'label' => 'Two',
12 years ago
* 'content' => 'Anim pariatur cliche...',
12 years ago
* 'headerOptions' => array(...),
12 years ago
* 'options' => array('id'=>'myveryownID'),
* ),
* array(
* 'label' => 'Dropdown',
12 years ago
* 'dropdown' => array(
12 years ago
* array(
12 years ago
* 'label' => 'DropdownA',
* 'content' => 'DropdownA, Anim pariatur cliche...',
* ),
* array(
* 'label' => 'DropdownB',
* 'content' => 'DropdownB, Anim pariatur cliche...',
12 years ago
* ),
* ),
* ),
* ),
* ));
* ```
*
* @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:
*
12 years ago
* - label: string, required, the tab header label.
* - 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.
12 years ago
* - active: boolean, optional, whether the item tab header and pane should be visible or not.
* - items: array, optional, if not set then `content` will be required. The `items` specify a dropdown items
* configuration array. Items can also hold two extra keys:
12 years ago
* * 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.
12 years ago
*/
public $items = array();
/**
* @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.
*/
public $itemOptions = array();
/**
* @var array list of HTML attributes for the header container tags. This will be overwritten
* by the "headerOptions" set in individual [[items]].
*/
public $headerOptions = array();
/**
* @var boolean whether the labels for header items should be HTML-encoded.
*/
public $encodeLabels = true;
12 years ago
/**
* Initializes the widget.
*/
public function init()
{
parent::init();
$this->addCssClass($this->options, 'nav nav-tabs');
12 years ago
}
/**
* Renders the widget.
*/
public function run()
{
echo $this->renderItems();
12 years ago
$this->registerPlugin('tab');
}
/**
* Renders tab items as specified on [[items]].
12 years ago
* @return string the rendering result.
* @throws InvalidConfigException.
12 years ago
*/
protected function renderItems()
12 years ago
{
$headers = array();
$panes = array();
foreach ($this->items as $n => $item) {
if (!isset($item['label'])) {
throw new InvalidConfigException("The 'label' option is required.");
12 years ago
}
12 years ago
$label = $this->encodeLabels ? Html::encode($item['label']) : $item['label'];
$headerOptions = array_merge($this->headerOptions, ArrayHelper::getValue($item, 'headerOptions', array()));
if (isset($item['items'])) {
$label .= ' <b class="caret"></b>';
$this->addCssClass($headerOptions, 'dropdown');
12 years ago
if ($this->renderDropdown($item['items'], $panes)) {
$this->addCssClass($headerOptions, 'active');
}
12 years ago
$header = Html::a($label, "#", array('class' => 'dropdown-toggle', 'data-toggle' => 'dropdown')) . "\n"
. Dropdown::widget(array('items' => $item['items'], 'clientOptions' => false));
} elseif (isset($item['content'])) {
$options = array_merge($this->itemOptions, ArrayHelper::getValue($item, 'options'));
$options['id'] = ArrayHelper::getValue($options, 'id', $this->options['id'] . '-tab' . $n);
$this->addCssClass($options, 'tab-pane');
if (ArrayHelper::remove($item, 'active')) {
$this->addCssClass($options, 'active');
$this->addCssClass($headerOptions, 'active');
}
$header = Html::a($label, '#' . $options['id'], array('data-toggle' => 'tab', 'tabindex' => '-1'));
$panes[] = Html::tag('div', $item['content'], $options);
12 years ago
} else {
throw new InvalidConfigException("Either the 'content' or 'items' option must be set.");
}
12 years ago
$headers[] = Html::tag('li', $header, $headerOptions);
12 years ago
}
12 years ago
return Html::tag('ul', implode("\n", $headers), $this->options) . "\n"
. Html::tag('div', implode("\n", $panes), array('class' => 'tab-content'));
12 years ago
}
/**
* 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.
12 years ago
* @throws InvalidConfigException
*/
12 years ago
protected function renderDropdown(&$items, &$panes)
12 years ago
{
$itemActive = false;
foreach ($items as $n => &$item) {
if (is_string($item)) {
continue;
12 years ago
}
12 years ago
if (!isset($item['content'])) {
12 years ago
throw new InvalidConfigException("The 'content' option is required.");
}
$content = ArrayHelper::remove($item, 'content');
$options = ArrayHelper::remove($item, 'contentOptions', array());
$this->addCssClass($options, 'tab-pane');
if (ArrayHelper::remove($item, 'active')) {
$this->addCssClass($options, 'active');
$this->addCssClass($item['options'], 'active');
$itemActive = true;
12 years ago
}
12 years ago
$options['id'] = ArrayHelper::getValue($options, 'id', $this->options['id'] . '-dd-tab' . $n);
$item['url'] = '#' . $options['id'];
$item['linkOptions']['data-toggle'] = 'tab';
12 years ago
$panes[] = Html::tag('div', $content, $options);
unset($item);
12 years ago
}
return $itemActive;
12 years ago
}
12 years ago
}