# Class yii\bootstrap\Alert

Inheritance | yii\bootstrap\Alert » yii\bootstrap\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable, yii\base\ViewContextInterface
Uses Traits | yii\bootstrap\BootstrapWidgetTrait
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2-bootstrap/blob/master/Alert.php

Alert renders an alert bootstrap component.

For example,

    echo Alert::widget([
        'options' => [
            'class' => 'alert-info',
        ],
        'body' => 'Say hello...',
    ]);

The following example will show the content enclosed between the begin() and end() calls within the alert box:

    Alert::begin([
        'options' => [
            'class' => 'alert-warning',
        ],
    ]);

    echo 'Say hello...';

    Alert::end();

See also http://getbootstrap.com/components/#alerts.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined 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. This property is read-only. | yii\base\Component
$body | string | The body content in the alert component. | yii\bootstrap\Alert
$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\Alert
$counter | integer | A counter used to generate $id for widgets. | yii\base\Widget
$id | string|null | ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. | yii\base\Widget
$options | array | The HTML attributes for the widget container tag. | yii\bootstrap\Widget
$stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget
$view | yii\web\View | The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details. | yii\base\Widget
$viewPath | string | The directory containing the view files for this widget. This property is read-only. | yii\base\Widget

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\Component
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component
__construct() | Constructor. | yii\base\BaseObject
__get() | Returns the value of a component property. | yii\base\Component
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component
__set() | Sets the value of a component property. | yii\base\Component
__unset() | Sets a component property to be null. | yii\base\Component
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\Component
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
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\Component
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component
init() | Initializes the widget. | yii\bootstrap\Alert
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\Alert
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

Method | Description | Defined By
--- | --- | ---
initOptions() | Initializes the widget options. | yii\bootstrap\Alert
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 close button if any before rendering the content. | yii\bootstrap\Alert
renderBodyEnd() | Renders the alert body (if any). | yii\bootstrap\Alert
renderCloseButton() | Renders the close button. | yii\bootstrap\Alert

## Events

Hide inherited events

Event | Type | Description | Defined 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

## Property Details

$body public property

The body content in the alert component. Note that anything between the begin() and end() calls of the Alert widget will also be treated as the body content, and will be rendered before this.

public string $body = null
$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 Alert documentation for the supported HTML attributes.

public array|false $closeButton = []

## 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 close button if any before rendering the content.

protected string renderBodyBegin ( )
return | string | The rendering result

renderBodyEnd() protected method

Renders the alert body (if any).

protected string renderBodyEnd ( )
return | string | The rendering result

renderCloseButton() protected method

Renders the close button.

protected string renderCloseButton ( )
return | string | The rendering result

run() public method

Renders the widget.

public void run ( )