Класс yii\bootstrap\Alert
| Наследование | yii\bootstrap\Alert » yii\bootstrap\Widget » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Использует трейты | yii\bootstrap\BootstrapWidgetTrait |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-bootstrap/blob/master/Alert.php |
Alert отображает компонент Bootstrap alert.
Например,
echo Alert::widget([
'options' => [
'class' => 'alert-info',
],
'body' => 'Say hello...',
]);
Следующий пример отобразит содержимое, заключенное между вызовами begin() и end() внутри блока alert:
Alert::begin([
'options' => [
'class' => 'alert-warning',
],
]);
echo 'Say hello...';
Alert::end();
См. также http://getbootstrap.com/components/#alerts.
Свойства Public
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $autoIdPrefix | string | Префикс для автоматически сгенерированных идентификаторов виджета. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список присоединённых к компоненту поведений | yii\base\Component |
| $body | string | Содержимое тела в компоненте alert. | yii\bootstrap\Alert |
| $clientEvents | array | Обработчики событий для базового плагина Bootstrap JS. | yii\bootstrap\BootstrapWidgetTrait |
| $clientOptions | array | Параметры для базового плагина Bootstrap JS. | yii\bootstrap\BootstrapWidgetTrait |
| $closeButton | array|false | Параметры для рендеринга тега кнопки закрытия. | yii\bootstrap\Alert |
| $counter | integer | Счётчик, используемый для генерации $id виджетов. | yii\base\Widget |
| $id | string | Идентификатор виджета. | yii\base\Widget |
| $options | array | HTML атрибуты для тега контейнера виджета. | yii\bootstrap\Widget |
| $stack | yii\base\Widget[] | Виджеты, которые в настоящее время рендерятся (не завершены). | yii\base\Widget |
| $view | yii\web\View | Объект представления, который можно использовать для рендеринга представлений или файлов представления. | yii\bootstrap\BootstrapWidgetTrait |
| $viewPath | string | Директория, содержащая файлы представления для данного виджета. | yii\base\Widget |
Public Methods
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т. е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| afterRun() | Этот метод вызывается сразу после выполнения виджета. | yii\base\Widget |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| beforeRun() | Этот метод вызывается сразу перед выполнением виджета. | yii\base\Widget |
| begin() | Начало работы виджета. | yii\base\Widget |
| behaviors() | Возвращает список поведений, которые должен выполнять этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| end() | Завершение работы виджета. | yii\base\Widget |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все присоединённые к этому компоненту поведения. | yii\base\Component |
| getId() | Возвращает идентификатор виджета. | yii\base\Widget |
| getView() | yii\bootstrap\BootstrapWidgetTrait | |
| getViewPath() | Возвращает директорию, содержащую файлы представления для этого виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли какой-либо обработчик, присоединённый к заданному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует виджет. | yii\bootstrap\Alert |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Отображает представление. | yii\base\Widget |
| renderFile() | Отображает файл представления. | yii\base\Widget |
| run() | Отображает виджет. | yii\bootstrap\Alert |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| initOptions() | Инициализирует параметры виджета. | yii\bootstrap\Alert |
| registerClientEvents() | Регистрирует обработчики событий JavaScript, которые указаны в $clientEvents. | yii\bootstrap\BootstrapWidgetTrait |
| registerPlugin() | Регистрирует конкретный плагин Bootstrap и связанные с ним события | yii\bootstrap\BootstrapWidgetTrait |
| renderBodyBegin() | Отображает кнопку закрытия, если она есть, перед отображением содержимого. | yii\bootstrap\Alert |
| renderBodyEnd() | Отображает тело предупреждения (если оно есть). | yii\bootstrap\Alert |
| renderCloseButton() | Отображает кнопку закрытия. | yii\bootstrap\Alert |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | Событие, генерируемое сразу после выполнения виджета. (доступно с версии 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | Событие, генерируемое сразу перед выполнением виджета. (доступно с версии 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | Событие, которое срабатывает при инициализации виджета через init(). (доступно с версии 2.0.11) | yii\base\Widget |
Подробное описание свойств
$body публичное свойство
Содержимое тела компонента предупреждения. Обратите внимание, что всё между вызовами begin() и end() виджета Alert также будет обрабатываться как содержимое тела и будет отображено перед этим.
public string $body = null
$closeButton публичное свойство
Варианты рендеринга тега кнопки закрытия. Кнопка закрытия отображается в заголовке модального окна. Нажатие на кнопку скрывает модальное окно. Если значение ложно, кнопка закрытия не будет отображаться.
Поддерживаются следующие специальные опции:
- tag: строка, имя тега кнопки. По умолчанию 'button'.
- label: строка, метка кнопки. По умолчанию '×'.
Остальные опции будут отображены как атрибуты тега кнопки. Обратитесь к документации по Alert для просмотра поддерживаемых HTML-атрибутов.
public array|false $closeButton = []
Подробное описание методов
init() public метод
Инициализирует виджет.
| public void init ( ) |
|---|
initOptions() защищённый метод
Инициализирует опции виджета.
Этот метод устанавливает значения по умолчанию для различных опций.
| protected void initOptions ( ) |
|---|
renderBodyBegin() защищённый метод
Отображает кнопку закрытия, если она есть, перед рендерингом содержимого.
| protected строка renderBodyBegin ( ) | ||
|---|---|---|
| возвращает | строка |
Результат рендеринга |
renderBodyEnd() защищённый метод
Отображает тело алерта (если оно есть).
| protected строка renderBodyEnd ( ) | ||
|---|---|---|
| возвращает | строка |
Результат рендеринга |
renderCloseButton() защищённый метод
Отображает кнопку закрытия.
| protected строка renderCloseButton ( ) | ||
|---|---|---|
| возвращает | строка |
Результат рендеринга |
run() public метод
Отображает виджет.
| public void run ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-bootstrap-alert.html
