Collapse.php 3.52 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;
Antonio Ramirez committed
11
use yii\helpers\ArrayHelper;
Antonio Ramirez committed
12 13 14 15 16 17 18 19
use yii\helpers\Html;

/**
 * Collapse renders an accordion bootstrap javascript component.
 *
 * For example:
 *
 * ```php
Alexander Makarov committed
20 21
 * echo Collapse::widget([
 *     'items' => [
Antonio Ramirez committed
22
 *         // equivalent to the above
Alexander Makarov committed
23
 *         'Collapsible Group Item #1' => [
Antonio Ramirez committed
24 25
 *             'content' => 'Anim pariatur cliche...',
 *             // open its content by default
Alexander Makarov committed
26 27
 *             'contentOptions' => ['class' => 'in']
 *         ],
Antonio Ramirez committed
28
 *         // another group item
Alexander Makarov committed
29
 *         'Collapsible Group Item #2' => [
Antonio Ramirez committed
30
 *             'content' => 'Anim pariatur cliche...',
Alexander Makarov committed
31 32 33 34 35
 *             'contentOptions' => [...],
 *             'options' => [...],
 *         ],
 *     ]
 * ]);
Antonio Ramirez committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49
 * ```
 *
 * @see http://twitter.github.io/bootstrap/javascript.html#collapse
 * @author Antonio Ramirez <amigo.cobos@gmail.com>
 * @since 2.0
 */
class Collapse extends Widget
{
	/**
	 * @var array list of groups in the collapse widget. Each array element represents a single
	 * group with the following structure:
	 *
	 * ```php
	 * // item key is the actual group header
Alexander Makarov committed
50
	 * 'Collapsible Group Item #1' => [
Antonio Ramirez committed
51 52 53
	 *     // required, the content (HTML) of the group
	 *     'content' => 'Anim pariatur cliche...',
	 *     // optional the HTML attributes of the content group
Alexander Makarov committed
54
	 *     'contentOptions' => [],
Antonio Ramirez committed
55
	 *     // optional the HTML attributes of the group
Alexander Makarov committed
56 57
	 *     'options' => [],
	 * ]
Antonio Ramirez committed
58 59
	 * ```
	 */
Alexander Makarov committed
60
	public $items = [];
Antonio Ramirez committed
61 62 63 64 65 66 67 68


	/**
	 * Initializes the widget.
	 */
	public function init()
	{
		parent::init();
69
		Html::addCssClass($this->options, 'accordion');
Antonio Ramirez committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
	}

	/**
	 * Renders the widget.
	 */
	public function run()
	{
		echo Html::beginTag('div', $this->options) . "\n";
		echo $this->renderItems() . "\n";
		echo Html::endTag('div') . "\n";
		$this->registerPlugin('collapse');
	}

	/**
	 * Renders collapsible items as specified on [[items]].
	 * @return string the rendering result
	 */
	public function renderItems()
	{
Alexander Makarov committed
89
		$items = [];
Antonio Ramirez committed
90 91
		$index = 0;
		foreach ($this->items as $header => $item) {
Alexander Makarov committed
92
			$options = ArrayHelper::getValue($item, 'options', []);
93
			Html::addCssClass($options, 'accordion-group');
Antonio Ramirez committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
			$items[] = Html::tag('div', $this->renderItem($header, $item, ++$index), $options);
		}

		return implode("\n", $items);
	}

	/**
	 * Renders a single collapsible item group
	 * @param string $header a label of the item group [[items]]
	 * @param array $item a single item from [[items]]
	 * @param integer $index the item index as each item group content must have an id
	 * @return string the rendering result
	 * @throws InvalidConfigException
	 */
	public function renderItem($header, $item, $index)
	{
		if (isset($item['content'])) {
			$id = $this->options['id'] . '-collapse' . $index;
Alexander Makarov committed
112
			$options = ArrayHelper::getValue($item, 'contentOptions', []);
Antonio Ramirez committed
113
			$options['id'] = $id;
114
			Html::addCssClass($options, 'accordion-body collapse');
Antonio Ramirez committed
115

Alexander Makarov committed
116
			$header = Html::a($header, '#' . $id, [
Antonio Ramirez committed
117 118 119
					'class' => 'accordion-toggle',
					'data-toggle' => 'collapse',
					'data-parent' => '#' . $this->options['id']
Alexander Makarov committed
120
				]) . "\n";
Antonio Ramirez committed
121

Alexander Makarov committed
122
			$content = Html::tag('div', $item['content'], ['class' => 'accordion-inner']) . "\n";
Antonio Ramirez committed
123 124 125
		} else {
			throw new InvalidConfigException('The "content" option is required.');
		}
Alexander Makarov committed
126
		$group = [];
Antonio Ramirez committed
127

Alexander Makarov committed
128
		$group[] = Html::tag('div', $header, ['class' => 'accordion-heading']);
Antonio Ramirez committed
129 130 131 132
		$group[] = Html::tag('div', $content, $options);

		return implode("\n", $group);
	}
resurtm committed
133
}