Dropdown.php 2.76 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
use yii\helpers\Html;

/**
15
 * Dropdown renders a Bootstrap dropdown menu component.
Antonio Ramirez committed
16 17 18 19 20 21 22 23 24 25
 *
 * @see http://twitter.github.io/bootstrap/javascript.html#dropdowns
 * @author Antonio Ramirez <amigo.cobos@gmail.com>
 * @since 2.0
 */
class Dropdown extends Widget
{
	/**
	 * @var array list of menu items in the dropdown. Each array element represents a single
	 * menu with the following structure:
Antonio Ramirez committed
26 27 28 29 30 31
	 * - label: string, required, the label of the item link
	 * - url: string, optional, the url of the item link. Defaults to "#".
	 * - linkOptions: array, optional, the HTML attributes of the item link.
	 * - options: array, optional, the HTML attributes of the item.
	 * - items: array, optional, the dropdown items configuration array. if `items` is set, then `url` of the parent
	 *   item will be ignored and automatically set to "#"
Antonio Ramirez committed
32
	 *
Antonio Ramirez committed
33
	 * @see https://github.com/twitter/bootstrap/issues/5050#issuecomment-11741727
Antonio Ramirez committed
34 35
	 */
	public $items = array();
36 37 38 39
	/**
	 * @var boolean whether the labels for header items should be HTML-encoded.
	 */
	public $encodeLabels = true;
Antonio Ramirez committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56


	/**
	 * Initializes the widget.
	 * If you override this method, make sure you call the parent implementation first.
	 */
	public function init()
	{
		parent::init();
		$this->addCssClass($this->options, 'dropdown-menu');
	}

	/**
	 * Renders the widget.
	 */
	public function run()
	{
57
		echo $this->renderItems($this->items);
Antonio Ramirez committed
58 59 60 61
		$this->registerPlugin('dropdown');
	}

	/**
62 63
	 * Renders menu items.
	 * @param array $items the menu items to be rendered
Antonio Ramirez committed
64
	 * @return string the rendering result.
65
	 * @throws InvalidConfigException if the label option is not specified in one of the items.
Antonio Ramirez committed
66
	 */
67
	protected function renderItems($items)
Antonio Ramirez committed
68
	{
69 70
		$lines = array();
		foreach ($items as $item) {
Antonio Ramirez committed
71
			if (is_string($item)) {
72
				$lines[] = $item;
Antonio Ramirez committed
73 74 75 76 77
				continue;
			}
			if (!isset($item['label'])) {
				throw new InvalidConfigException("The 'label' option is required.");
			}
78
			$label = $this->encodeLabels ? Html::encode($item['label']) : $item['label'];
Antonio Ramirez committed
79
			$options = ArrayHelper::getValue($item, 'options', array());
80 81
			$linkOptions = ArrayHelper::getValue($item, 'linkOptions', array());
			$linkOptions['tabindex'] = '-1';
Antonio Ramirez committed
82 83 84

			if (isset($item['items'])) {
				$this->addCssClass($options, 'dropdown-submenu');
85
				$content = Html::a($label, '#', $linkOptions) . $this->renderItems($item['items']);
Antonio Ramirez committed
86
			} else {
87
				$content = Html::a($label, ArrayHelper::getValue($item, 'url', '#'), $linkOptions);
Antonio Ramirez committed
88
			}
89
			$lines[] = Html::tag('li', $content, $options);
Antonio Ramirez committed
90 91
		}

92
		return Html::tag('ul', implode("\n", $lines), $this->options);
Antonio Ramirez committed
93
	}
94
}