Class yii\bootstrap\Modal

All Classes | Properties | Methods | Constants
Inheritanceyii\bootstrap\Modal » yii\bootstrap\Widget » yii\base\Widget
Uses Traitsyii\bootstrap\BootstrapWidgetTrait
Available since extension's version2.0
Source Code https://github.com/yiisoft/yii2-bootstrap/blob/master/src/Modal.php

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:

Modal::begin([
    'header' => '<h2>Hello world</h2>',
    'toggleButton' => ['label' => 'click me'],
]);

echo 'Say hello...';

Modal::end();

See also http://getbootstrap.com/javascript/#modals.

Public Properties

Hide inherited properties

Property Type Description Defined By
$bodyOptions array Body options yii\bootstrap\Modal
$clientEvents array The event handlers for the underlying Bootstrap JS plugin. yii\bootstrap\BootstrapWidgetTrait
$clientOptions array The options for the underlying Bootstrap JS plugin. yii\bootstrap\BootstrapWidgetTrait
$closeButton array|false The options for rendering the close button tag. yii\bootstrap\Modal
$footer string The footer content in the modal window. yii\bootstrap\Modal
$footerOptions string Additional footer options yii\bootstrap\Modal
$header string The header content in the modal window. yii\bootstrap\Modal
$headerOptions string Additional header options yii\bootstrap\Modal
$options array The HTML attributes for the widget container tag. yii\bootstrap\Widget
$size string The modal size. yii\bootstrap\Modal
$toggleButton array The options for rendering the toggle button tag. yii\bootstrap\Modal

Public Methods

Hide inherited methods

Method Description Defined By
getView() yii\bootstrap\BootstrapWidgetTrait
init() Initializes the widget. yii\bootstrap\Modal
run() Renders the widget. yii\bootstrap\Modal

Protected Methods

Hide inherited methods

Method Description Defined By
initOptions() Initializes the widget options. yii\bootstrap\Modal
registerClientEvents() Registers JS event handlers that are listed in $clientEvents. yii\bootstrap\BootstrapWidgetTrait
registerPlugin() Registers a specific Bootstrap plugin and the related events yii\bootstrap\BootstrapWidgetTrait
renderBodyBegin() Renders the opening tag of the modal body. yii\bootstrap\Modal
renderBodyEnd() Renders the closing tag of the modal body. yii\bootstrap\Modal
renderCloseButton() Renders the close button. yii\bootstrap\Modal
renderFooter() Renders the HTML markup for the footer of the modal yii\bootstrap\Modal
renderHeader() Renders the header HTML markup of the modal yii\bootstrap\Modal
renderToggleButton() Renders the toggle button. yii\bootstrap\Modal

Constants

Hide inherited constants

Constant Value Description Defined By
SIZE_DEFAULT "" yii\bootstrap\Modal
SIZE_LARGE "modal-lg" yii\bootstrap\Modal
SIZE_SMALL "modal-sm" yii\bootstrap\Modal

Property Details

Hide inherited properties

$bodyOptions public property (available since version 2.0.7)

Body options

See also \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $bodyOptions = [
    'class' => 'modal-body',
]
$closeButton public property

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 for the supported HTML attributes.

public array|false $closeButton = []
$footer public property

The footer content in the modal window.

public string $footer = null
$footerOptions public property (available since version 2.0.1)

Additional footer options

See also \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public string $footerOptions = null
$header public property

The header content in the modal window.

public string $header = null
$headerOptions public property (available since version 2.0.1)

Additional header options

See also \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public string $headerOptions = null
$size public property

The modal size. Can be SIZE_LARGE or SIZE_SMALL, or empty for default.

public string $size = null
$toggleButton public property

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 for the supported HTML attributes.

public array $toggleButton = false

Method Details

Hide inherited methods

getView() public abstract method

Defined in: yii\bootstrap\BootstrapWidgetTrait::getView()

See also \yii\base\Widget::getView().

public abstract \yii\web\View getView ( )
return \yii\web\View

The view object that can be used to render views or view files.

 

                abstract function getView();
init() public method

Initializes the widget.

public void init ( )

                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";
}
initOptions() protected method

Initializes the widget options.

This method sets the default values for various options.

protected void initOptions ( )

                protected function initOptions()
{
    $this->options = array_merge([
        'class' => 'fade',
        'role' => 'dialog',
        'tabindex' => -1,
    ], $this->options);
    Html::addCssClass($this->options, ['widget' => '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'];
        }
    }
}
registerClientEvents() protected method (available since version 2.0.2)

Defined in: yii\bootstrap\BootstrapWidgetTrait::registerClientEvents()

Registers JS event handlers that are listed in $clientEvents.

protected void registerClientEvents ( )

                protected function registerClientEvents()
{
    if (!empty($this->clientEvents)) {
        $id = $this->options['id'];
        $js = [];
        foreach ($this->clientEvents as $event => $handler) {
            $js[] = "jQuery('#$id').on('$event', $handler);";
        }
        $this->getView()->registerJs(implode("\n", $js));
    }
}
registerPlugin() protected method

Defined in: yii\bootstrap\BootstrapWidgetTrait::registerPlugin()

Registers a specific Bootstrap plugin and the related events

protected void registerPlugin ( $name )
$name string

The name of the Bootstrap plugin

 

                protected function registerPlugin($name)
{
    $view = $this->getView();
    BootstrapPluginAsset::register($view);
    $id = $this->options['id'];
    if ($this->clientOptions !== false) {
        $options = empty($this->clientOptions) ? '' : Json::htmlEncode($this->clientOptions);
        $js = "jQuery('#$id').$name($options);";
        $view->registerJs($js);
    }
    $this->registerClientEvents();
}
renderBodyBegin() protected method

Renders the opening tag of the modal body.

protected string renderBodyBegin ( )
return string

The rendering result

 

                protected function renderBodyBegin()
{
    return Html::beginTag('div', $this->bodyOptions);
}
renderBodyEnd() protected method

Renders the closing tag of the modal body.

protected string renderBodyEnd ( )
return string

The rendering result

 

                protected function renderBodyEnd()
{
    return Html::endTag('div');
}
renderCloseButton() protected method

Renders the close button.

protected string renderCloseButton ( )
return string

The rendering result

 

                protected function renderCloseButton()
{
    if (($closeButton = $this->closeButton) !== false) {
        $tag = ArrayHelper::remove($closeButton, 'tag', 'button');
        $label = ArrayHelper::remove($closeButton, 'label', '&times;');
        if ($tag === 'button' && !isset($closeButton['type'])) {
            $closeButton['type'] = 'button';
        }
        return Html::tag($tag, $label, $closeButton);
    } else {
        return null;
    }
}
renderFooter() protected method

Renders the HTML markup for the footer of the modal

protected string renderFooter ( )
return string

The rendering result

 

                protected function renderFooter()
{
    if ($this->footer !== null) {
        Html::addCssClass($this->footerOptions, ['widget' => 'modal-footer']);
        return Html::tag('div', "\n" . $this->footer . "\n", $this->footerOptions);
    } else {
        return null;
    }
}
renderHeader() protected method

Renders the header HTML markup of the modal

protected string renderHeader ( )
return string

The rendering result

 

                protected function renderHeader()
{
    $button = $this->renderCloseButton();
    if ($button !== null) {
        $this->header = $button . "\n" . $this->header;
    }
    if ($this->header !== null) {
        Html::addCssClass($this->headerOptions, ['widget' => 'modal-header']);
        return Html::tag('div', "\n" . $this->header . "\n", $this->headerOptions);
    } else {
        return null;
    }
}
renderToggleButton() protected method

Renders the toggle button.

protected string renderToggleButton ( )
return string

The rendering result

 

                protected function renderToggleButton()
{
    if (($toggleButton = $this->toggleButton) !== false) {
        $tag = ArrayHelper::remove($toggleButton, 'tag', 'button');
        $label = ArrayHelper::remove($toggleButton, 'label', 'Show');
        if ($tag === 'button' && !isset($toggleButton['type'])) {
            $toggleButton['type'] = 'button';
        }
        return Html::tag($tag, $label, $toggleButton);
    } else {
        return null;
    }
}
run() public method

Renders the widget.

public void run ( )

                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');
}