You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
237 lines
7.0 KiB
237 lines
7.0 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\bootstrap; |
|
|
|
use Yii; |
|
use yii\helpers\ArrayHelper; |
|
use yii\helpers\Html; |
|
|
|
/** |
|
* Modal renders a modal window that can be toggled by clicking on a button. |
|
* |
|
* The following example will show the content enclosed between the [[begin()]] |
|
* and [[end()]] calls within the modal window: |
|
* |
|
* ~~~php |
|
* Modal::begin([ |
|
* 'header' => '<h2>Hello world</h2>', |
|
* 'toggleButton' => ['label' => 'click me'], |
|
* ]); |
|
* |
|
* echo 'Say hello...'; |
|
* |
|
* Modal::end(); |
|
* ~~~ |
|
* |
|
* @see http://getbootstrap.com/javascript/#modals |
|
* @author Antonio Ramirez <amigo.cobos@gmail.com> |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
class Modal extends Widget |
|
{ |
|
const SIZE_LARGE = "modal-lg"; |
|
const SIZE_SMALL = "modal-sm"; |
|
const SIZE_DEFAULT = ""; |
|
|
|
/** |
|
* @var string the header content in the modal window. |
|
*/ |
|
public $header; |
|
/** |
|
* @var string the footer content in the modal window. |
|
*/ |
|
public $footer; |
|
/** |
|
* @var string the modal size. Can be MODAL_LG or MODAL_SM, or empty for default. |
|
*/ |
|
public $size; |
|
/** |
|
* @var array|false 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 false, 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 '×'. |
|
* |
|
* The rest of the options will be rendered as the HTML attributes of the button tag. |
|
* Please refer to the [Modal plugin help](http://getbootstrap.com/javascript/#modals) |
|
* for the supported HTML attributes. |
|
*/ |
|
public $closeButton = []; |
|
/** |
|
* @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 false, 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://getbootstrap.com/javascript/#modals) |
|
* for the supported HTML attributes. |
|
*/ |
|
public $toggleButton = false; |
|
|
|
|
|
/** |
|
* Initializes the widget. |
|
*/ |
|
public function init() |
|
{ |
|
parent::init(); |
|
|
|
$this->initOptions(); |
|
|
|
echo $this->renderToggleButton() . "\n"; |
|
echo Html::beginTag('div', $this->options) . "\n"; |
|
echo Html::beginTag('div', ['class' => 'modal-dialog ' . $this->size]) . "\n"; |
|
echo Html::beginTag('div', ['class' => 'modal-content']) . "\n"; |
|
echo $this->renderHeader() . "\n"; |
|
echo $this->renderBodyBegin() . "\n"; |
|
} |
|
|
|
/** |
|
* Renders the widget. |
|
*/ |
|
public function run() |
|
{ |
|
echo "\n" . $this->renderBodyEnd(); |
|
echo "\n" . $this->renderFooter(); |
|
echo "\n" . Html::endTag('div'); // modal-content |
|
echo "\n" . Html::endTag('div'); // modal-dialog |
|
echo "\n" . Html::endTag('div'); |
|
|
|
$this->registerPlugin('modal'); |
|
} |
|
|
|
/** |
|
* Renders the header HTML markup of the modal |
|
* @return string the rendering result |
|
*/ |
|
protected function renderHeader() |
|
{ |
|
$button = $this->renderCloseButton(); |
|
if ($button !== null) { |
|
$this->header = $button . "\n" . $this->header; |
|
} |
|
if ($this->header !== null) { |
|
return Html::tag('div', "\n" . $this->header . "\n", ['class' => 'modal-header']); |
|
} else { |
|
return null; |
|
} |
|
} |
|
|
|
/** |
|
* Renders the opening tag of the modal body. |
|
* @return string the rendering result |
|
*/ |
|
protected function renderBodyBegin() |
|
{ |
|
return Html::beginTag('div', ['class' => 'modal-body']); |
|
} |
|
|
|
/** |
|
* Renders the closing tag of the modal body. |
|
* @return string the rendering result |
|
*/ |
|
protected function renderBodyEnd() |
|
{ |
|
return Html::endTag('div'); |
|
} |
|
|
|
/** |
|
* Renders the HTML markup for the footer of the modal |
|
* @return string the rendering result |
|
*/ |
|
protected function renderFooter() |
|
{ |
|
if ($this->footer !== null) { |
|
return Html::tag('div', "\n" . $this->footer . "\n", ['class' => 'modal-footer']); |
|
} else { |
|
return null; |
|
} |
|
} |
|
|
|
/** |
|
* Renders the toggle button. |
|
* @return string the rendering result |
|
*/ |
|
protected function renderToggleButton() |
|
{ |
|
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'; |
|
} |
|
|
|
return Html::tag($tag, $label, $this->toggleButton); |
|
} else { |
|
return null; |
|
} |
|
} |
|
|
|
/** |
|
* Renders the close button. |
|
* @return string the rendering result |
|
*/ |
|
protected function renderCloseButton() |
|
{ |
|
if ($this->closeButton !== false) { |
|
$tag = ArrayHelper::remove($this->closeButton, 'tag', 'button'); |
|
$label = ArrayHelper::remove($this->closeButton, 'label', '×'); |
|
if ($tag === 'button' && !isset($this->closeButton['type'])) { |
|
$this->closeButton['type'] = 'button'; |
|
} |
|
|
|
return Html::tag($tag, $label, $this->closeButton); |
|
} else { |
|
return null; |
|
} |
|
} |
|
|
|
/** |
|
* Initializes the widget options. |
|
* This method sets the default values for various options. |
|
*/ |
|
protected function initOptions() |
|
{ |
|
$this->options = array_merge([ |
|
'class' => 'fade', |
|
'role' => 'dialog', |
|
'tabindex' => -1, |
|
], $this->options); |
|
Html::addCssClass($this->options, 'modal'); |
|
|
|
if ($this->clientOptions !== false) { |
|
$this->clientOptions = array_merge(['show' => false], $this->clientOptions); |
|
} |
|
|
|
if ($this->closeButton !== false) { |
|
$this->closeButton = array_merge([ |
|
'data-dismiss' => 'modal', |
|
'aria-hidden' => 'true', |
|
'class' => 'close', |
|
], $this->closeButton); |
|
} |
|
|
|
if ($this->toggleButton !== false) { |
|
$this->toggleButton = array_merge([ |
|
'data-toggle' => 'modal', |
|
], $this->toggleButton); |
|
if (!isset($this->toggleButton['data-target']) && !isset($this->toggleButton['href'])) { |
|
$this->toggleButton['data-target'] = '#' . $this->options['id']; |
|
} |
|
} |
|
} |
|
}
|
|
|