Класс yii\bootstrap\Modal
| Наследование | yii\bootstrap\Modal » 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/Modal.php |
Modal отображает модальное окно, которое можно переключать, нажав на кнопку.
Следующий пример покажет содержимое, заключенное между вызовами begin() и end() внутри модального окна:
Modal::begin([
'header' => '<h2>Hello world</h2>',
'toggleButton' => ['label' => 'click me'],
]);
echo 'Say hello...';
Modal::end();
См. также http://getbootstrap.com/javascript/#modals.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $autoIdPrefix | string | Префикс для автоматически сгенерированных идентификаторов виджетов. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к этому компоненту | yii\base\Component |
| $clientEvents | array | Обработчики событий для базового JS-плагина Bootstrap. | yii\bootstrap\BootstrapWidgetTrait |
| $clientOptions | array | Параметры для базового JS-плагина Bootstrap. | yii\bootstrap\BootstrapWidgetTrait |
| $closeButton | array|false | Параметры для рендеринга тега кнопки закрытия. | yii\bootstrap\Modal |
| $counter | integer | Счетчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $footer | string | Контент подвала модального окна. | yii\bootstrap\Modal |
| $footerOptions | string | Дополнительные параметры подвала | yii\bootstrap\Modal |
| $header | string | Контент заголовка модального окна. | yii\bootstrap\Modal |
| $headerOptions | string | Дополнительные параметры заголовка | yii\bootstrap\Modal |
| $id | string | Идентификатор виджета. | yii\base\Widget |
| $options | array | Атрибуты HTML для тега контейнера виджета. | yii\bootstrap\Widget |
| $size | string | Размер модального окна. | yii\bootstrap\Modal |
| $stack | yii\base\Widget[] | Виджеты, которые в данный момент отображаются (не завершены). | yii\base\Widget |
| $toggleButton | array | Параметры для рендеринга тега кнопки переключения. | yii\bootstrap\Modal |
| $view | yii\web\View | Объект представления, который может использоваться для рендеринга представлений или файлов представления. | yii\bootstrap\BootstrapWidgetTrait |
| $viewPath | string | Директория, содержащая файлы представлений для этого виджета. | yii\base\Widget |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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\Modal |
| off() | Отсоединяет существующего обработчика событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Отображает представление. | yii\base\Widget |
| renderFile() | Отображает файл представления. | yii\base\Widget |
| run() | Отображает виджет. | yii\bootstrap\Modal |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Срабатывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| initOptions() | Инициализирует параметры виджета. | yii\bootstrap\Modal |
| registerClientEvents() | Регистрирует обработчики событий JS, перечисленные в $clientEvents. | yii\bootstrap\BootstrapWidgetTrait |
| registerPlugin() | Регистрирует конкретный плагин Bootstrap и связанные с ним события | yii\bootstrap\BootstrapWidgetTrait |
| renderBodyBegin() | Отображает открывающий тег тела модального окна. | yii\bootstrap\Modal |
| renderBodyEnd() | Отображает закрывающий тег тела модального окна. | yii\bootstrap\Modal |
| renderCloseButton() | Отображает кнопку закрытия. | yii\bootstrap\Modal |
| renderFooter() | Отображает HTML-разметку подвала модального окна. | yii\bootstrap\Modal |
| renderHeader() | Отображает HTML-разметку заголовка модального окна. | yii\bootstrap\Modal |
| renderToggleButton() | Отображает кнопку переключения. | yii\bootstrap\Modal |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| 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 |
Константы
| Константа | Значение | Описание | Определено в |
|---|---|---|---|
| SIZE_DEFAULT | "" | yii\bootstrap\Modal | |
| SIZE_LARGE | "modal-lg" | yii\bootstrap\Modal | |
| SIZE_SMALL | "modal-sm" | yii\bootstrap\Modal |
Подробное описание свойств
$closeButton общественное свойство
Параметры для рендеринга тега кнопки закрытия. Кнопка закрытия отображается в заголовке модального окна. Нажатие на кнопку скрывает модальное окно. Если значение ложь, кнопка закрытия не будет отображаться.
Поддерживаются следующие специальные параметры:
- tag: строка, имя тега кнопки. По умолчанию 'button'.
- label: строка, метка кнопки. По умолчанию '×'.
Остальные параметры будут отображены как атрибуты тега кнопки. Для получения информации о поддерживаемых атрибутах HTML обратитесь к справочнику по плагину Modal.
public array|false $closeButton = []
$footer общественное свойство
Контент подвала в модальном окне.
public string $footer = null
$footerOptions общественное свойство (доступно начиная с версии 2.0.1)
Дополнительные параметры подвала
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о рендеринге атрибутов.
public string $footerOptions = null
$header общественное свойство
Контент заголовка в модальном окне.
public string $header = null
$headerOptions общественное свойство (доступно начиная с версии 2.0.1)
Дополнительные параметры заголовка
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о рендеринге атрибутов.
public string $headerOptions = null
$size общественное свойство
Размер модального окна. Может быть SIZE_LARGE или SIZE_SMALL, или пустым для значения по умолчанию.
public string $size = null
$toggleButton общественное свойство
Параметры для рендеринга тега кнопки переключения. Кнопка переключения используется для переключения видимости модального окна. Если это свойство ложь, кнопка переключения не будет отображаться.
Поддерживаются следующие специальные параметры:
- tag: строка, имя тега кнопки. По умолчанию 'button'.
- label: строка, метка кнопки. По умолчанию 'Показать'.
Остальные параметры будут отображены как атрибуты тега кнопки. Для получения информации о поддерживаемых атрибутах HTML обратитесь к справочнику по плагину Modal.
public array $toggleButton = false
Подробное описание методов
init() общественный метод
Инициализация виджета.
| public void init ( ) |
|---|
initOptions() защищённый метод
Инициализация параметров виджета.
Этот метод устанавливает значения по умолчанию для различных параметров.
| protected void initOptions ( ) |
|---|
renderBodyBegin() защищённый метод
Отображает открывающий тег тела модального окна.
| protected string renderBodyBegin ( ) | ||
|---|---|---|
| return | string |
Результат рендеринга |
renderBodyEnd() защищённый метод
Отображает закрывающий тег тела модального окна.
| protected string renderBodyEnd ( ) | ||
|---|---|---|
| return | string |
Результат рендеринга |
renderCloseButton() защищённый метод
Отображает кнопку закрытия.
| protected string renderCloseButton ( ) | ||
|---|---|---|
| return | string |
Результат рендеринга |
renderFooter() защищённый метод
Отображает HTML-разметку подвала модального окна.
| protected string renderFooter ( ) | ||
|---|---|---|
| return | string |
Результат рендеринга |
renderHeader() защищённый метод
Отображает HTML-разметку заголовка модального окна.
| protected string renderHeader ( ) | ||
|---|---|---|
| return | string |
Результат рендеринга |
renderToggleButton() защищённый метод
Отображает кнопку переключения.
| protected string renderToggleButton ( ) | ||
|---|---|---|
| return | string |
Результат рендеринга |
run() общественный метод
Отображает виджет.
| 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-modal.html
