Класс yii\bootstrap\Dropdown

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

Наследование	yii\bootstrap\Dropdown » 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/Dropdown.php

Dropdown отображает компонент меню выпадающего списка Bootstrap.

Например,

<div class="dropdown">
    <a href="#" data-toggle="dropdown" class="dropdown-toggle">Label <b class="caret"></b></a>
    <?php
        echo Dropdown::widget([
            'items' => [
                ['label' => 'DropdownA', 'url' => '/'],
                ['label' => 'DropdownB', 'url' => '#'],
            ],
        ]);
    ?>
</div>

См. также http://getbootstrap.com/javascript/#dropdowns.

Открытые свойства

Свойство	Тип	Описание	Определено в
$autoIdPrefix	строка	Префикс для автоматически сгенерированных идентификаторов виджета.	yii\base\Widget
$behaviors	yii\base\Behavior[]	Список присоединённых к этому компоненту поведений.	yii\base\Component
$clientEvents	массив	Обработчики событий для базового JS-плагина Bootstrap.	yii\bootstrap\BootstrapWidgetTrait
$clientOptions	массив	Параметры для базового JS-плагина Bootstrap.	yii\bootstrap\BootstrapWidgetTrait
$counter	целое число	Счётчик, используемый для генерации $id для виджетов.	yii\base\Widget
$encodeLabels	булево	Нужно ли кодировать метки элементов заголовка в HTML.	yii\bootstrap\Dropdown
$id	строка	Идентификатор виджета.	yii\base\Widget
$items	массив	Список элементов меню в выпадающем списке.	yii\bootstrap\Dropdown
$options	массив	Атрибуты HTML для тега контейнера виджета.	yii\bootstrap\Widget
$stack	yii\base\Widget[]	Виджеты, которые в данный момент отрисовываются (не завершены).	yii\base\Widget
$submenuOptions	массив\|null	Атрибуты HTML для тегов контейнера подменю.	yii\bootstrap\Dropdown
$view	yii\web\View	Объект представления, который можно использовать для отрисовки представлений или файлов представления.	yii\bootstrap\BootstrapWidgetTrait
$viewPath	строка	Директория, содержащая файлы представлений для этого виджета.	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\Dropdown
off()	Отсоединяет существующий обработчик событий от этого компонента.	yii\base\Component
on()	Присоединяет обработчик событий к событию.	yii\base\Component
render()	Отображает представление.	yii\base\Widget
renderFile()	Отображает файл представления.	yii\base\Widget
run()	Отображает виджет.	yii\bootstrap\Dropdown
setId()	Устанавливает идентификатор виджета.	yii\base\Widget
setView()	Устанавливает объект представления, используемый этим виджетом.	yii\base\Widget
trigger()	Вызывает событие.	yii\base\Component
widget()	Создаёт экземпляр виджета и запускает его.	yii\base\Widget

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

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

События

Событие	Тип	Описание	Определено в
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

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

$encodeLabels публичное свойство

Нужно ли кодировать метки для элементов заголовка в HTML.

public boolean $encodeLabels = true

$items публичное свойство

Список пунктов меню в раскрывающемся списке. Каждый элемент массива может быть либо строкой HTML, либо массивом, представляющим отдельное меню со следующей структурой:

label: строка, обязательное поле, метка ссылки элемента.
encode: булево, необязательное поле, нужно ли кодировать метку элемента в HTML.
url: строка или массив, необязательное поле, URL ссылки элемента. Будет обработано с помощью yii\helpers\Url::to(). Если не задано, элемент будет обрабатываться как заголовок меню, если у элемента нет подменю.
visible: булево, необязательное поле, отображается ли этот элемент меню. По умолчанию — true.
linkOptions: массив, необязательное поле, атрибуты HTML ссылки элемента.
options: массив, необязательное поле, атрибуты HTML элемента.
items: массив, необязательное поле, элементы подменю. Структура такая же, как у этого свойства. Обратите внимание, что Bootstrap не поддерживает подменю-выпадающие списки. Вам нужно добавить собственные CSS-стили для их поддержки.
submenuOptions: массив, необязательное поле, атрибуты HTML тега контейнера подменю. Если указано, будет объединено с $submenuOptions.

Для вставки разделителя используйте <li role="presentation" class="divider"></li>.

public array $items = []

$submenuOptions общее свойство (доступно с версии 2.0.5)

Атрибуты HTML для тегов контейнера подменю. Если не задано, будет использовано значение $options.

public array|null $submenuOptions = null

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

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

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

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

общественный void init ( )

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

Отображает элементы меню.

защищённый строка renderItems ( $items, $options = [] )
$items	массив	Элементы меню для отображения
$options	массив	Атрибуты HTML контейнера
возвращает	строка	Результат рендеринга.
бросает	yii\base\InvalidConfigException	если опция метки не задана в одном из элементов.

run() общественный метод

Отображает виджет.

общественный void run ( )

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