Class yii\bootstrap\Modal

Inheritanceyii\bootstrap\Modal » yii\bootstrap\Widget » yii\base\Widget » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable, yii\base\ViewContextInterface
Uses Traitsyii\bootstrap\BootstrapWidgetTrait
Available since version2.0
Source Code https://github.com/yiisoft/yii2-bootstrap/blob/master/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

PropertyTypeDescriptionDefined By
$autoIdPrefix string The prefix to the automatically generated widget IDs. yii\base\Widget
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$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
$counter integer A counter used to generate $id for widgets. yii\base\Widget
$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
$id string ID of the widget. yii\base\Widget
$options array The HTML attributes for the widget container tag. yii\bootstrap\Widget
$size string The modal size. yii\bootstrap\Modal
$stack yii\base\Widget[] The widgets that are currently being rendered (not ended). yii\base\Widget
$toggleButton array The options for rendering the toggle button tag. yii\bootstrap\Modal
$view yii\web\View The view object that can be used to render views or view files. yii\bootstrap\BootstrapWidgetTrait
$viewPath string The directory containing the view files for this widget. yii\base\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Object
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\Object
__get() Returns the value of an object property. yii\base\Object
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Object
__set() Sets value of an object property. yii\base\Object
__unset() Sets an object property to null. yii\base\Object
afterRun() This method is invoked right after a widget is executed. yii\base\Widget
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeRun() This method is invoked right before the widget is executed. yii\base\Widget
begin() Begins a widget. yii\base\Widget
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Object
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Object
className() Returns the fully qualified name of this class. yii\base\Object
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
end() Ends a widget. yii\base\Widget
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getId() Returns the ID of the widget. yii\base\Widget
getView() yii\bootstrap\BootstrapWidgetTrait
getViewPath() Returns the directory containing the view files for this widget. yii\base\Widget
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Object
hasProperty() Returns a value indicating whether a property is defined. yii\base\Object
init() Initializes the widget. yii\bootstrap\Modal
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
render() Renders a view. yii\base\Widget
renderFile() Renders a view file. yii\base\Widget
run() Renders the widget. yii\bootstrap\Modal
setId() Sets the ID of the widget. yii\base\Widget
setView() Sets the view object to be used by this widget. yii\base\Widget
trigger() Triggers an event. yii\base\Component
widget() Creates a widget instance and runs it. yii\base\Widget

Protected Methods

Hide inherited methods

MethodDescriptionDefined 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

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_RUN yii\base\WidgetEvent An event raised right after executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent An event raised right before executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_INIT yii\base\Event An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) yii\base\Widget

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
SIZE_DEFAULT "" yii\bootstrap\Modal
SIZE_LARGE "modal-lg" yii\bootstrap\Modal
SIZE_SMALL "modal-sm" yii\bootstrap\Modal

Property Details

$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

init() public method

Initializes the widget.

public void init ( )
initOptions() protected method

Initializes the widget options.

This method sets the default values for various options.

protected void initOptions ( )
renderBodyBegin() protected method

Renders the opening tag of the modal body.

protected string renderBodyBegin ( )
return string

The rendering result

renderBodyEnd() protected method

Renders the closing tag of the modal body.

protected string renderBodyEnd ( )
return string

The rendering result

renderCloseButton() protected method

Renders the close button.

protected string renderCloseButton ( )
return string

The rendering result

renderFooter() protected method

Renders the HTML markup for the footer of the modal

protected string renderFooter ( )
return string

The rendering result

renderHeader() protected method

Renders the header HTML markup of the modal

protected string renderHeader ( )
return string

The rendering result

renderToggleButton() protected method

Renders the toggle button.

protected string renderToggleButton ( )
return string

The rendering result

run() public method

Renders the widget.

public void run ( )