Класс yii\bootstrap\Collapse
| Наследование | yii\bootstrap\Collapse » 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/Collapse.php |
Collapse отображает компонент аккордеона Bootstrap JavaScript.
Например:
echo Collapse::widget([
'items' => [
// equivalent to the above
[
'label' => 'Collapsible Group Item #1',
'content' => 'Anim pariatur cliche...',
// open its content by default
'contentOptions' => ['class' => 'in']
],
// another group item
[
'label' => 'Collapsible Group Item #1',
'content' => 'Anim pariatur cliche...',
'contentOptions' => [...],
'options' => [...],
],
// if you want to swap out .panel-body with .list-group, you may use the following
[
'label' => 'Collapsible Group Item #1',
'content' => [
'Anim pariatur cliche...',
'Anim pariatur cliche...'
],
'contentOptions' => [...],
'options' => [...],
'footer' => 'Footer' // the footer label in list-group
],
]
]);
См. также http://getbootstrap.com/javascript/#collapse.
Открытые свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $autoCloseItems | boolean | Закрывать ли другие элементы, если открыт элемент. | yii\bootstrap\Collapse |
| $autoIdPrefix | string | Префикс для автоматически сгенерированных идентификаторов виджета. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список поведенческих правил, присоединенных к этому компоненту | yii\base\Component |
| $clientEvents | array | Обработчики событий для базового плагина Bootstrap JS. | yii\bootstrap\BootstrapWidgetTrait |
| $clientOptions | array | Параметры для базового плагина Bootstrap JS. | yii\bootstrap\BootstrapWidgetTrait |
| $counter | integer | Счетчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $encodeLabels | boolean | Нужно ли кодировать метки заголовков элементов. | yii\bootstrap\Collapse |
| $id | string | Идентификатор виджета. | yii\base\Widget |
| $items | array | Список групп в виджете collapse. | yii\bootstrap\Collapse |
| $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 |
Открытые методы
| Метод | Описание | Определено в |
|---|---|---|
| __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\Collapse |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| render() | Отображает представление. | yii\base\Widget |
| renderFile() | Отображает файл представления. | yii\base\Widget |
| renderItem() | Отображает одну группу элементов с возможностью сворачивания | yii\bootstrap\Collapse |
| renderItems() | Отображает элементы, которые можно сворачивать, как указано в $items. | yii\bootstrap\Collapse |
| run() | Отображает виджет. | yii\bootstrap\Collapse |
| 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 |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| 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 |
Подробное описание свойств
$autoCloseItems общедоступное свойство (доступно начиная с версии 2.0.7)
Определяет, нужно ли закрывать другие элементы, если открыт один элемент. По умолчанию установлено в true, что приводит к эффекту аккордеона. Установите это в false, чтобы разрешить одновременное открытие нескольких элементов.
public boolean $autoCloseItems = true
$encodeLabels общедоступное свойство
Определяет, следует ли кодировать метки для заголовков элементов HTML.
public boolean $encodeLabels = true
$items общедоступное свойство
Список групп в виджете Collapse. Каждый элемент массива представляет собой отдельную группу со следующей структурой:
- label: строка, обязательное поле, метка заголовка группы.
- encode: булево значение, необязательное, нужно ли кодировать метку HTML. Этот параметр переопределяет глобальный параметр
$this->encodeLabels. - content: массив|строка|объект, обязательное поле, содержимое (HTML) группы.
- options: массив, необязательное поле, атрибуты HTML группы.
- contentOptions: необязательное поле, атрибуты HTML содержимого группы.
Начиная с версии 2.0.7, вы также можете указать этот параметр в виде пар ключ-значение, где ключ относится к label, а значение относится к content. Если значение является строкой, оно интерпретируется как метка. Если это массив, он интерпретируется как описано выше.
Например:
echo Collapse::widget([
'items' => [
'Introduction' => 'This is the first collapsable menu',
'Second panel' => [
'content' => 'This is the second collapsable menu',
],
[
'label' => 'Third panel',
'content' => 'This is the third collapsable menu',
],
]
])
public array $items = []
Подробное описание методов
init() публичный метод
Инициализирует виджет.
| public void init ( ) |
|---|
renderItem() публичный метод
Отображает отдельную группу элементов с возможностью сворачивания
| public строка renderItem ( $header, $item, $index ) | ||
|---|---|---|
| $header | строка |
Метка группы элементов $items |
| $item | массив |
Один элемент из $items |
| $index | целое число |
Индекс элемента, так как каждый элемент группы содержимого должен иметь id |
| return | строка |
Результат отображения |
| throws | yii\base\InvalidConfigException | |
renderItems() публичный метод
Отображает элементы со сворачиванием, как указано в $items.
| public строка renderItems ( ) | ||
|---|---|---|
| return | строка |
Результат отображения |
| throws | yii\base\InvalidConfigException |
если метка не указана |
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-collapse.html