Modal.php 6 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
 * The following example will show the content enclosed between the [[begin()]]
 * and [[end()]] calls within the modal window:
 *
 * ~~~php
Alexander Makarov committed
21
 * Modal::begin([
22
 *     'header' => '<h2>Hello world</h2>',
Alexander Makarov committed
23 24
 *     'toggleButton' => ['label' => 'click me'],
 * ]);
25 26 27 28 29 30
 *
 * echo 'Say hello...';
 *
 * Modal::end();
 * ~~~
 *
31 32
 * @see http://twitter.github.io/bootstrap/javascript.html#modals
 * @author Antonio Ramirez <amigo.cobos@gmail.com>
33
 * @author Qiang Xue <qiang.xue@gmail.com>
34 35
 * @since 2.0
 */
Antonio Ramirez committed
36
class Modal extends Widget
37 38
{
	/**
39
	 * @var string the header content in the modal window.
40
	 */
41
	public $header;
42
	/**
43
	 * @var string the footer content in the modal window.
44
	 */
45
	public $footer;
46
	/**
47 48 49 50 51 52 53 54 55 56 57 58
	 * @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.
59
	 */
Alexander Makarov committed
60
	public $closeButton = [];
61
	/**
62 63 64 65 66 67 68 69 70 71 72 73
	 * @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.
74
	 */
75
	public $toggleButton;
76 77 78


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

Qiang Xue committed
85
		$this->initOptions();
86

Qiang Xue committed
87
		echo $this->renderToggleButton() . "\n";
88
		echo Html::beginTag('div', $this->options) . "\n";
Alexander Makarov committed
89 90
		echo Html::beginTag('div', ['class' => 'modal-dialog']) . "\n";
		echo Html::beginTag('div', ['class' => 'modal-content']) . "\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
		echo "\n" . $this->renderBodyEnd();
		echo "\n" . $this->renderFooter();
102 103
		echo "\n" . Html::endTag('div'); // modal-content
		echo "\n" . Html::endTag('div'); // modal-dialog
Qiang Xue committed
104
		echo "\n" . Html::endTag('div');
105

106
		$this->registerPlugin('modal');
107 108 109
	}

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

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

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

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

	/**
158 159
	 * Renders the toggle button.
	 * @return string the rendering result
160
	 */
161
	protected function renderToggleButton()
162
	{
163 164 165 166 167 168
		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
169
			return Html::tag($tag, $label, $this->toggleButton);
170 171 172
		} else {
			return null;
		}
173 174 175
	}

	/**
176 177
	 * Renders the close button.
	 * @return string the rendering result
178
	 */
179
	protected function renderCloseButton()
180
	{
181 182 183 184 185 186 187 188 189 190
		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;
		}
191
	}
Qiang Xue committed
192 193 194 195 196 197 198

	/**
	 * Initializes the widget options.
	 * This method sets the default values for various options.
	 */
	protected function initOptions()
	{
Alexander Makarov committed
199
		$this->options = array_merge([
200 201 202
			'class' => 'fade',
			'role' => 'dialog',
			'tabindex' => -1,
Alexander Makarov committed
203
		], $this->options);
204
		Html::addCssClass($this->options, 'modal');
205 206
		
		if ($this->clientOptions !== false) {
Alexander Makarov committed
207
			$this->clientOptions = array_merge(['show' => false], $this->clientOptions);
208
		}
Qiang Xue committed
209 210

		if ($this->closeButton !== null) {
Alexander Makarov committed
211
			$this->closeButton = array_merge([
Qiang Xue committed
212 213 214
				'data-dismiss' => 'modal',
				'aria-hidden' => 'true',
				'class' => 'close',
Alexander Makarov committed
215
			], $this->closeButton);
Qiang Xue committed
216 217 218
		}

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