Modal.php 5.77 KB
Newer Older
1 2 3 4 5 6 7
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

Antonio Ramirez committed
8
namespace yii\bootstrap;
9 10 11

use Yii;
use yii\helpers\ArrayHelper;
12
use yii\helpers\Html;
13 14

/**
15
 * Modal renders a modal window that can be toggled by clicking on a button.
16
 *
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
 * The following example will show the content enclosed between the [[begin()]]
 * and [[end()]] calls within the modal window:
 *
 * ~~~php
 * Modal::begin(array(
 *     'header' => '<h2>Hello world</h2>',
 *     'toggleButton' => array(
 *         'label' => 'click me',
 *     ),
 * ));
 *
 * echo 'Say hello...';
 *
 * Modal::end();
 * ~~~
 *
33 34
 * @see http://twitter.github.io/bootstrap/javascript.html#modals
 * @author Antonio Ramirez <amigo.cobos@gmail.com>
35
 * @author Qiang Xue <qiang.xue@gmail.com>
36 37
 * @since 2.0
 */
Antonio Ramirez committed
38
class Modal extends Widget
39 40
{
	/**
41
	 * @var string the header content in the modal window.
42
	 */
43
	public $header;
44
	/**
45
	 * @var string the footer content in the modal window.
46
	 */
47
	public $footer;
48
	/**
49 50 51 52 53 54 55 56 57 58 59 60
	 * @var array the options for rendering the close button tag.
	 * The close button is displayed in the header of the modal window. Clicking
	 * on the button will hide the modal window. If this is null, no close button will be rendered.
	 *
	 * The following special options are supported:
	 *
	 * - tag: string, the tag name of the button. Defaults to 'button'.
	 * - label: string, the label of the button. Defaults to '&times;'.
	 *
	 * The rest of the options will be rendered as the HTML attributes of the button tag.
	 * Please refer to the [Modal plugin help](http://twitter.github.com/bootstrap/javascript.html#modals)
	 * for the supported HTML attributes.
61
	 */
62
	public $closeButton = array();
63
	/**
64 65 66 67 68 69 70 71 72 73 74 75
	 * @var array the options for rendering the toggle button tag.
	 * The toggle button is used to toggle the visibility of the modal window.
	 * If this property is null, no toggle button will be rendered.
	 *
	 * The following special options are supported:
	 *
	 * - tag: string, the tag name of the button. Defaults to 'button'.
	 * - label: string, the label of the button. Defaults to 'Show'.
	 *
	 * The rest of the options will be rendered as the HTML attributes of the button tag.
	 * Please refer to the [Modal plugin help](http://twitter.github.com/bootstrap/javascript.html#modals)
	 * for the supported HTML attributes.
76
	 */
77
	public $toggleButton;
78 79 80


	/**
81
	 * Initializes the widget.
82 83 84 85 86
	 */
	public function init()
	{
		parent::init();

Qiang Xue committed
87
		$this->initOptions();
88

Qiang Xue committed
89
		echo $this->renderToggleButton() . "\n";
90
		echo Html::beginTag('div', $this->options) . "\n";
Qiang Xue committed
91 92
		echo $this->renderHeader() . "\n";
		echo $this->renderBodyBegin() . "\n";
93 94 95
	}

	/**
96
	 * Renders the widget.
97 98 99
	 */
	public function run()
	{
Qiang Xue committed
100 101 102
		echo "\n" . $this->renderBodyEnd();
		echo "\n" . $this->renderFooter();
		echo "\n" . Html::endTag('div');
103

104
		$this->registerPlugin('modal');
105 106 107
	}

	/**
108 109
	 * Renders the header HTML markup of the modal
	 * @return string the rendering result
110
	 */
111
	protected function renderHeader()
112
	{
113 114 115 116 117 118 119 120 121
		$button = $this->renderCloseButton();
		if ($button !== null) {
			$this->header = $button . "\n" . $this->header;
		}
		if ($this->header !== null) {
			return Html::tag('div', "\n" . $this->header . "\n", array('class' => 'modal-header'));
		} else {
			return null;
		}
122 123 124
	}

	/**
Qiang Xue committed
125
	 * Renders the opening tag of the modal body.
126
	 * @return string the rendering result
127
	 */
Qiang Xue committed
128
	protected function renderBodyBegin()
129
	{
Qiang Xue committed
130 131 132 133 134 135 136 137 138
		return Html::beginTag('div', array('class' => 'modal-body'));
	}

	/**
	 * Renders the closing tag of the modal body.
	 * @return string the rendering result
	 */
	protected function renderBodyEnd()
	{
Qiang Xue committed
139
		return Html::endTag('div');
140 141 142
	}

	/**
143 144
	 * Renders the HTML markup for the footer of the modal
	 * @return string the rendering result
145
	 */
146
	protected function renderFooter()
147
	{
148
		if ($this->footer !== null) {
Qiang Xue committed
149
			return Html::tag('div', "\n" . $this->footer . "\n", array('class' => 'modal-footer'));
150 151 152
		} else {
			return null;
		}
153 154 155
	}

	/**
156 157
	 * Renders the toggle button.
	 * @return string the rendering result
158
	 */
159
	protected function renderToggleButton()
160
	{
161 162 163 164 165 166
		if ($this->toggleButton !== null) {
			$tag = ArrayHelper::remove($this->toggleButton, 'tag', 'button');
			$label = ArrayHelper::remove($this->toggleButton, 'label', 'Show');
			if ($tag === 'button' && !isset($this->toggleButton['type'])) {
				$this->toggleButton['type'] = 'button';
			}
Qiang Xue committed
167
			return Html::tag($tag, $label, $this->toggleButton);
168 169 170
		} else {
			return null;
		}
171 172 173
	}

	/**
174 175
	 * Renders the close button.
	 * @return string the rendering result
176
	 */
177
	protected function renderCloseButton()
178
	{
179 180 181 182 183 184 185 186 187 188
		if ($this->closeButton !== null) {
			$tag = ArrayHelper::remove($this->closeButton, 'tag', 'button');
			$label = ArrayHelper::remove($this->closeButton, 'label', '&times;');
			if ($tag === 'button' && !isset($this->closeButton['type'])) {
				$this->closeButton['type'] = 'button';
			}
			return Html::tag($tag, $label, $this->closeButton);
		} else {
			return null;
		}
189
	}
Qiang Xue committed
190 191 192 193 194 195 196

	/**
	 * Initializes the widget options.
	 * This method sets the default values for various options.
	 */
	protected function initOptions()
	{
197
		$this->options = array_merge(array(
Qiang Xue committed
198
			'class' => 'modal hide',
199
		), $this->options);
200
		Html::addCssClass($this->options, 'modal');
Qiang Xue committed
201

202
		$this->clientOptions = array_merge(array(
Qiang Xue committed
203
			'show' => false,
204
		), $this->clientOptions);
Qiang Xue committed
205 206 207 208 209 210 211 212 213 214 215 216 217 218

		if ($this->closeButton !== null) {
			$this->closeButton = array_merge(array(
				'data-dismiss' => 'modal',
				'aria-hidden' => 'true',
				'class' => 'close',
			), $this->closeButton);
		}

		if ($this->toggleButton !== null) {
			$this->toggleButton = array_merge(array(
				'data-toggle' => 'modal',
			), $this->toggleButton);
			if (!isset($this->toggleButton['data-target']) && !isset($this->toggleButton['href'])) {
219
				$this->toggleButton['data-target'] = '#' . $this->options['id'];
Qiang Xue committed
220 221 222
			}
		}
	}
223
}