Class dmitrybtn\yimp\widgets\Alert
| Inheritance | dmitrybtn\yimp\widgets\Alert » yii\bootstrap4\Widget |
|---|
Alert widget from Yii project template, adapted for Bootstrap 4
Alert widget renders a message from session flash. All flash messages are displayed in the sequence they were assigned using setFlash. You can set message as following:
Yii::$app->session->setFlash('error', 'This is the message');
Yii::$app->session->setFlash('success', 'This is the message');
Yii::$app->session->setFlash('info', 'This is the message');
Multiple messages could be set as follows:
Yii::$app->session->setFlash('error', ['Error 1', 'Error 2']);
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $alertTypes | array | The alert types configuration for the flash messages. | dmitrybtn\yimp\widgets\Alert |
| $closeButton | array | The options for rendering the close button tag. | dmitrybtn\yimp\widgets\Alert |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| run() | dmitrybtn\yimp\widgets\Alert |
Property Details
The alert types configuration for the flash messages. This array is setup as $key => $value, where:
- key: the name of the session flash variable
- value: the bootstrap alert type (i.e. danger, success, info, warning)
public array $alertTypes = ['error' => 'alert-danger', 'danger' => 'alert-danger', 'success' => 'alert-success', 'info' => 'alert-info', 'warning' => 'alert-warning']
The options for rendering the close button tag. Array will be passed to \yii\bootstrap\Alert::closeButton.