Трейт yii\bootstrap\BootstrapWidgetTrait

Все классы | Свойства | Методы

Реализовано в	yii\apidoc\templates\bootstrap\SideNavWidget, yii\bootstrap\Alert, yii\bootstrap\Button, yii\bootstrap\ButtonDropdown, yii\bootstrap\ButtonGroup, yii\bootstrap\Carousel, yii\bootstrap\Collapse, yii\bootstrap\Dropdown, yii\bootstrap\InputWidget, yii\bootstrap\Modal, yii\bootstrap\Nav, yii\bootstrap\NavBar, yii\bootstrap\Progress, yii\bootstrap\Tabs, yii\bootstrap\ToggleButtonGroup, yii\bootstrap\Widget
Доступно с версии	2.0.6
Исходный код	https://github.com/yiisoft/yii2-bootstrap/blob/master/BootstrapWidgetTrait.php

BootstrapWidgetTrait — это трейт, который предоставляет базовые возможности для всех виджетов Bootstrap.

Примечание: класс, использующий этот трейт, должен объявить общедоступное поле с именем options со значением по умолчанию по умолчанию:

class MyWidget extends \yii\base\Widget
{
    use BootstrapWidgetTrait;

    public $options = [];
}

Это поле отсутствует в трейте, чтобы избежать возможной ошибки PHP Fatal error при конфликте определений.

Общедоступные свойства

Свойство	Тип	Описание	Определено
$clientEvents	массив	Обработчики событий для базового плагина Bootstrap JS.	yii\bootstrap\BootstrapWidgetTrait
$clientOptions	массив	Параметры для базового плагина Bootstrap JS.	yii\bootstrap\BootstrapWidgetTrait

Общедоступные методы

Метод	Описание	Определено
getView()		yii\bootstrap\BootstrapWidgetTrait
init()	Инициализирует виджет.	yii\bootstrap\BootstrapWidgetTrait

Защищённые методы

Метод	Описание	Определено
registerClientEvents()	Регистрирует обработчики событий JS, перечисленные в $clientEvents.	yii\bootstrap\BootstrapWidgetTrait
registerPlugin()	Регистрирует конкретный плагин Bootstrap и связанные события.	yii\bootstrap\BootstrapWidgetTrait

Подробное описание свойств

$clientEvents общедоступное свойство

Обработчики событий для базового плагина Bootstrap JS. Обратитесь к соответствующей веб-странице плагина Bootstrap для возможных событий. Например, эта страница показывает, как использовать плагин «Modal» и поддерживаемые события (например, «shown»).

public array $clientEvents = []

$clientOptions общедоступное свойство

Параметры для базового плагина Bootstrap JS. Обратитесь к соответствующей веб-странице плагина Bootstrap для возможных параметров. Например, эта страница показывает, как использовать плагин «Modal» и поддерживаемые параметры (например, «remote»).

public array $clientOptions = []

Подробное описание методов

getView() общедоступный абстрактный метод

См. также yii\base\Widget::getView().

общедоступный абстрактный yii\web\View getView ( )
возвращает	yii\web\View	Объект представления, который можно использовать для отображения представлений или файлов представлений.

init() общедоступный метод

Инициализирует виджет.

Этот метод зарегистрирует пакет ресурсов Bootstrap. Если вы переопределите этот метод, убедитесь, что вы сначала вызываете родительскую реализацию.

общедоступный void init ( )

registerClientEvents() защищённый метод (доступно с версии 2.0.2)

Регистрирует обработчики событий JS, перечисленные в $clientEvents.

защищённый void registerClientEvents ( )

registerPlugin() защищённый метод

Регистрирует конкретный плагин Bootstrap и связанные события

защищённый void registerPlugin ( $name )
$name	строка	Название плагина Bootstrap

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-bootstrap-bootstrapwidgettrait.html