Commit cbb33bd1 by Antonio Ramirez

refactored based on comments (2nd round)

parent 96a8c4a8
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
namespace yii\bootstrap; namespace yii\bootstrap;
use yii\base\InvalidConfigException; use yii\base\InvalidConfigException;
use yii\helpers\base\ArrayHelper; use yii\helpers\ArrayHelper;
use yii\helpers\Html; use yii\helpers\Html;
/** /**
...@@ -22,12 +22,12 @@ use yii\helpers\Html; ...@@ -22,12 +22,12 @@ use yii\helpers\Html;
* array( * array(
* 'label' => 'Home', * 'label' => 'Home',
* 'url' => '/', * 'url' => '/',
* 'options' => array(...), * 'linkOptions' => array(...),
* 'active' => true, * 'active' => true,
* ), * ),
* array( * array(
* 'label' => 'Dropdown', * 'label' => 'Dropdown',
* 'dropdown' => array( * 'items' => array(
* array( * array(
* 'label' => 'DropdownA', * 'label' => 'DropdownA',
* 'url' => '#', * 'url' => '#',
...@@ -52,26 +52,25 @@ class Nav extends Widget ...@@ -52,26 +52,25 @@ class Nav extends Widget
* @var array list of items in the nav widget. Each array element represents a single * @var array list of items in the nav widget. Each array element represents a single
* menu item with the following structure: * menu item with the following structure:
* *
* ```php * - label: string, required, the nav item label.
* array( * - url: optional, the item's URL. Defaults to "#".
* // required, the menu item label. * - linkOptions: array, optional, the HTML attributes of the item's link.
* 'label' => 'Nav item label', * - options: array, optional, the HTML attributes of the item container (LI).
* // optional, the URL of the menu item. Defaults to "#" * - active: boolean, optional, whether the item should be on active state or not.
* 'url'=> '#', * - items: array, optional, the configuration of specify the item's dropdown menu. You can optionally set this as
* // optional, the HTML options of the URL. * a string (ie. `'items'=> Dropdown::widget(array(...))`
* 'urlOptions' => array(...), * - important: there is an issue with sub-dropdown menus, and as of 3.0, bootstrap won't support sub-dropdown.
* // optional the HTML attributes of the item container (LI). *
* 'options' => array(...), * **Note:** Optionally, you can also use a plain string instead of an array element.
* // optional, an array of [[Dropdown]] widget items so to display a dropdown menu on the tab header.
* // important: there is an issue with sub-dropdown menus, and as of 3.0, bootstrap won't support sub-dropdown
* // @see https://github.com/twitter/bootstrap/issues/5050#issuecomment-11741727
* 'dropdown'=> array(...)
* )
* ```
* *
* Optionally, you can also use a plain string instead of an array element. * @see https://github.com/twitter/bootstrap/issues/5050#issuecomment-11741727
* @see [[Dropdown]]
*/ */
public $items = array(); public $items = array();
/**
* @var boolean whether the nav items labels should be HTML-encoded.
*/
public $encodeLabels = true;
/** /**
...@@ -79,6 +78,7 @@ class Nav extends Widget ...@@ -79,6 +78,7 @@ class Nav extends Widget
*/ */
public function init() public function init()
{ {
parent::init();
$this->addCssClass($this->options, 'nav'); $this->addCssClass($this->options, 'nav');
} }
...@@ -88,6 +88,7 @@ class Nav extends Widget ...@@ -88,6 +88,7 @@ class Nav extends Widget
public function run() public function run()
{ {
echo $this->renderItems(); echo $this->renderItems();
$this->registerPlugin('dropdown');
} }
/** /**
...@@ -117,21 +118,26 @@ class Nav extends Widget ...@@ -117,21 +118,26 @@ class Nav extends Widget
if (!isset($item['label'])) { if (!isset($item['label'])) {
throw new InvalidConfigException("The 'label' option is required."); throw new InvalidConfigException("The 'label' option is required.");
} }
$label = $item['label']; $label = $this->encodeLabels ? Html::encode($item['label']) : $item['label'];
$url = ArrayHelper::getValue($item, 'url', '#');
$options = ArrayHelper::getValue($item, 'options', array()); $options = ArrayHelper::getValue($item, 'options', array());
$urlOptions = ArrayHelper::getValue($item, 'urlOptions', array()); $dropdown = ArrayHelper::getValue($item, 'items');
$dropdown = null; $url = Html::url(ArrayHelper::getValue($item, 'url', '#'));
$linkOptions = ArrayHelper::getValue($item, 'linkOptions', array());
if(ArrayHelper::getValue($item, 'active')) {
$this->addCssClass($options, 'active');
}
// does it has a dropdown widget? if ($dropdown !== null) {
if (isset($item['dropdown'])) { $linkOptions['data-toggle'] = 'dropdown';
$urlOptions['data-toggle'] = 'dropdown';
$this->addCssClass($options, 'dropdown'); $this->addCssClass($options, 'dropdown');
$this->addCssClass($urlOptions, 'dropdown-toggle'); $this->addCssClass($urlOptions, 'dropdown-toggle');
$label .= ' ' . Html::tag('b', '', array('class' => 'caret')); $label .= ' ' . Html::tag('b', '', array('class' => 'caret'));
$dropdown = Dropdown::widget(array('items' => $item['dropdown'], 'clientOptions' => false)); $dropdown = is_string($dropdown)
? $dropdown
: Dropdown::widget(array('items' => $item['items'], 'clientOptions' => false));
} }
return Html::tag('li', Html::a($label, $url, $urlOptions) . $dropdown, $options); return Html::tag('li', Html::a($label, $url, $linkOptions) . $dropdown, $options);
} }
} }
\ No newline at end of file
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
namespace yii\bootstrap; namespace yii\bootstrap;
use yii\base\InvalidConfigException; use yii\base\InvalidConfigException;
use yii\helpers\base\ArrayHelper; use yii\helpers\ArrayHelper;
use yii\helpers\Html; use yii\helpers\Html;
/** /**
...@@ -18,6 +18,7 @@ use yii\helpers\Html; ...@@ -18,6 +18,7 @@ use yii\helpers\Html;
* *
* ```php * ```php
* echo NavBar::widget(array( * echo NavBar::widget(array(
* 'brandLabel' => 'NavBar Test',
* 'items' => array( * 'items' => array(
* // a Nav widget * // a Nav widget
* array( * array(
...@@ -33,8 +34,8 @@ use yii\helpers\Html; ...@@ -33,8 +34,8 @@ use yii\helpers\Html;
* ), * ),
* array( * array(
* 'label' => 'Dropdown', * 'label' => 'Dropdown',
* // configure a dropdown menu * 'content' => new Dropdown(array(
* 'dropdown' => array( * 'items' => array(
* array( * array(
* 'label' => 'DropdownA', * 'label' => 'DropdownA',
* 'url' => '#', * 'url' => '#',
...@@ -45,6 +46,7 @@ use yii\helpers\Html; ...@@ -45,6 +46,7 @@ use yii\helpers\Html;
* ), * ),
* ) * )
* ), * ),
* ),
* ) * )
* ), * ),
* ), * ),
...@@ -62,7 +64,20 @@ use yii\helpers\Html; ...@@ -62,7 +64,20 @@ use yii\helpers\Html;
*/ */
class NavBar extends Widget class NavBar extends Widget
{ {
public $brand; /**
* @var string the text of the brand.
* @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.
*/
public $brandRoute = '/';
/**
* @var array the HTML attributes of the brand link.
*/
public $brandOptions = array();
/** /**
* @var array list of menu items in the navbar widget. Each array element represents a single * @var array list of menu items in the navbar widget. Each array element represents a single
* menu item with the following structure: * menu item with the following structure:
...@@ -83,6 +98,10 @@ class NavBar extends Widget ...@@ -83,6 +98,10 @@ class NavBar extends Widget
* Optionally, you can also use a plain string instead of an array element. * Optionally, you can also use a plain string instead of an array element.
*/ */
public $items = array(); public $items = array();
/**
* @var string the generated brand url if specified by [[brandLabel]]
*/
protected $brand;
/** /**
...@@ -91,7 +110,10 @@ class NavBar extends Widget ...@@ -91,7 +110,10 @@ class NavBar extends Widget
public function init() public function init()
{ {
parent::init(); parent::init();
$this->clientOptions = false;
$this->addCssClass($this->options, 'navbar'); $this->addCssClass($this->options, 'navbar');
$this->addCssClass($this->brandOptions, 'brand');
$this->brand = Html::a($this->brandLabel, $this->brandRoute, $this->brandOptions);
} }
/** /**
...@@ -102,19 +124,20 @@ class NavBar extends Widget ...@@ -102,19 +124,20 @@ class NavBar extends Widget
echo Html::beginTag('div', $this->options); echo Html::beginTag('div', $this->options);
echo $this->renderItems(); echo $this->renderItems();
echo Html::endTag('div'); echo Html::endTag('div');
$this->getView()->registerAssetBundle('yii/bootstrap');
} }
/** /**
* Renders the items.
* @return string the rendering items. * @return string the rendering items.
*/ */
protected function renderItems() protected function renderItems()
{ {
$items = array(); $items = array();
foreach ($this->items as $item) { foreach ($this->items as $item) {
$items[] = $this->renderItem($item); $items[] = $this->renderItem($item);
} }
$contents =implode("\n", $items); $contents = implode("\n", $items);
if (self::$responsive === true) { if (self::$responsive === true) {
$this->getView()->registerAssetBundle('yii/bootstrap/collapse'); $this->getView()->registerAssetBundle('yii/bootstrap/collapse');
$contents = $contents =
...@@ -127,6 +150,7 @@ class NavBar extends Widget ...@@ -127,6 +150,7 @@ class NavBar extends Widget
} else { } else {
$contents = $this->brand . "\n" . $contents; $contents = $this->brand . "\n" . $contents;
} }
return Html::tag('div', $contents, array('class' => 'navbar-inner')); return Html::tag('div', $contents, array('class' => 'navbar-inner'));
} }
...@@ -143,11 +167,11 @@ class NavBar extends Widget ...@@ -143,11 +167,11 @@ class NavBar extends Widget
return $item; return $item;
} }
$config = ArrayHelper::getValue($item, 'options', array()); $config = ArrayHelper::getValue($item, 'options', array());
$config['class'] = ArrayHelper::getValue($item, 'class', 'yii\bootstrap\Nav'); $config['clientOptions'] = false;
$widget = \Yii::createObject($config);
ob_start(); $class = ArrayHelper::getValue($item, 'class', 'yii\bootstrap\Nav');
$widget->run();
return ob_get_clean(); return $class::widget($config);
} }
/** /**
...@@ -160,10 +184,10 @@ class NavBar extends Widget ...@@ -160,10 +184,10 @@ class NavBar extends Widget
for ($i = 0; $i < 3; $i++) { for ($i = 0; $i < 3; $i++) {
$items[] = Html::tag('span', '', array('class' => 'icon-bar')); $items[] = Html::tag('span', '', array('class' => 'icon-bar'));
} }
return Html::tag('a', implode("\n", $items), array( return Html::a(implode("\n", $items), null, array(
'class' => 'btn btn-navbar', 'class' => 'btn btn-navbar',
'data-toggle' => 'collapse', 'data-toggle' => 'collapse',
'data-target' => 'div.navbar-collapse', 'data-target' => 'div.navbar-collapse',
)) . "\n"; ));
} }
} }
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment