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

namespace yii\bootstrap;

use yii\helpers\Html;

/**
 * NavBar renders a navbar HTML component.
 *
15 16 17
 * Any content enclosed between the [[begin()]] and [[end()]] calls of NavBar
 * is treated as the content of the navbar. You may use widgets such as [[Nav]]
 * or [[\yii\widgets\Menu]] to build up such content. For example,
18 19
 *
 * ```php
20 21 22 23
 * use yii\bootstrap\NavBar;
 * use yii\widgets\Menu;
 *
 * NavBar::begin(array('brandLabel' => 'NavBar Test'));
Qiang Xue committed
24
 * echo Nav::widget(array(
25
 *     'items' => array(
26 27
 *         array('label' => 'Home', 'url' => array('/site/index')),
 *         array('label' => 'About', 'url' => array('/site/about')),
28 29
 *     ),
 * ));
30
 * NavBar::end();
31 32 33 34 35 36 37 38
 * ```
 *
 * @see http://twitter.github.io/bootstrap/components.html#navbar
 * @author Antonio Ramirez <amigo.cobos@gmail.com>
 * @since 2.0
 */
class NavBar extends Widget
{
39
	/**
Qiang Xue committed
40
	 * @var string the text of the brand. Note that this is not HTML-encoded.
41 42 43 44 45 46 47
	 * @see http://twitter.github.io/bootstrap/components.html#navbar
	 */
	public $brandLabel;
	/**
	 * @param array|string $url the URL for the brand's hyperlink tag. This parameter will be processed by [[Html::url()]]
	 * and will be used for the "href" attribute of the brand link. Defaults to site root.
	 */
Qiang Xue committed
48
	public $brandUrl = '/';
49 50 51 52
	/**
	 * @var array the HTML attributes of the brand link.
	 */
	public $brandOptions = array();
53

54
	public $screenReaderToggleText = 'Toggle navigation';
55 56 57 58 59 60 61

	/**
	 * Initializes the widget.
	 */
	public function init()
	{
		parent::init();
62
		$this->clientOptions = false;
63
		Html::addCssClass($this->options, 'navbar navbar-default');
64
		Html::addCssClass($this->brandOptions, 'navbar-brand');
65 66 67
		if (empty($this->options['role'])) {
			$this->options['role'] = 'navigation';
		}
68

69
		echo Html::beginTag('nav', $this->options);
70 71 72 73
		echo Html::beginTag('div', array('class' => 'container'));

		echo Html::beginTag('div', array('class' => 'navbar-header'));
		echo $this->renderToggleButton();
74 75
		if ($this->brandLabel !== null) {
			echo Html::a($this->brandLabel, $this->brandUrl, $this->brandOptions);
76
		}
77 78 79
		echo Html::endTag('div');

		echo Html::beginTag('div', array('class' => 'collapse navbar-collapse navbar-ex1-collapse'));
80 81 82
	}

	/**
83
	 * Renders the widget.
84
	 */
85
	public function run()
86
	{
87 88 89

		echo Html::endTag('div');
		echo Html::endTag('div');
90
		echo Html::endTag('nav');
91
		BootstrapPluginAsset::register($this->getView());
92 93 94 95 96 97 98 99
	}

	/**
	 * Renders collapsible toggle button.
	 * @return string the rendering toggle button.
	 */
	protected function renderToggleButton()
	{
100
		$bar = Html::tag('span', '', array('class' => 'icon-bar'));
101 102
		$screenReader = '<span class="sr-only">'.$this->screenReaderToggleText.'</span>';
		return Html::button("{$screenReader}\n{$bar}\n{$bar}\n{$bar}", array(
103
			'class' => 'navbar-toggle',
104
			'data-toggle' => 'collapse',
105
			'data-target' => '.navbar-ex1-collapse',
106
		));
107
	}
Qiang Xue committed
108
}