Класс yii\jui\Accordion
| Наследование | yii\jui\Accordion » yii\jui\Widget » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-jui/blob/master/Accordion.php |
Accordion отображает виджет jQuery UI accordion.
Например:
echo Accordion::widget([
'items' => [
[
'header' => 'Section 1',
'content' => 'Mauris mauris ante, blandit et, ultrices a, suscipit eget...',
],
[
'header' => 'Section 2',
'headerOptions' => ['tag' => 'h3'],
'content' => 'Sed non urna. Phasellus eu ligula. Vestibulum sit amet purus...',
'options' => ['tag' => 'div'],
],
],
'options' => ['tag' => 'div'],
'itemOptions' => ['tag' => 'div'],
'headerOptions' => ['tag' => 'h3'],
'clientOptions' => ['collapsible' => false],
]);
См. также http://api.jqueryui.com/accordion/.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $autoIdPrefix | строка | Префикс для автоматически сгенерированных идентификаторов виджетов. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к этому компоненту | yii\base\Component |
| $clientEvents | массив | Обработчики событий для базового виджета jQuery UI. | yii\jui\Widget |
| $clientOptions | массив | Параметры для базового виджета jQuery UI. | yii\jui\Widget |
| $counter | целое число | Счетчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $headerOptions | массив | Список HTML атрибутов для тегов контейнера заголовка элемента. | yii\jui\Accordion |
| $id | строка | Идентификатор виджета. | yii\base\Widget |
| $itemOptions | массив | Список HTML атрибутов для тегов контейнера элемента. | yii\jui\Accordion |
| $items | массив | Список сворачиваемых элементов. | yii\jui\Accordion |
| $options | массив | HTML атрибуты для тега контейнера виджета. | yii\jui\Accordion |
| $stack | yii\base\Widget[] | Виджеты, которые в настоящее время отображаются (не завершены). | yii\base\Widget |
| $view | yii\web\View | Объект представления, который можно использовать для отображения представлений или файлов представления. | yii\base\Widget |
| $viewPath | строка | Директория, содержащая файлы представления для этого виджета. | yii\base\Widget |
Защищенные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $clientEventMap | массив | Имена событий, сопоставленные с тем, что должно быть указано в `. | yii\jui\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\base\Widget |
| getViewPath() | Возвращает директорию, содержащую файлы представлений для этого виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчики, прикреплённые к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует виджет. | yii\jui\Widget |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Рендерит виджет. | yii\jui\Accordion |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Срабатывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и выполняет его. | yii\base\Widget |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| registerClientEvents() | Регистрирует конкретные события виджета jQuery UI. | yii\jui\Widget |
| registerClientOptions() | Регистрирует конкретные параметры виджета jQuery UI. | yii\jui\Widget |
| registerWidget() | Регистрирует конкретный пакет ресурсов виджета jQuery UI, инициализирует его с помощью параметров клиента и регистрирует связанные события. | yii\jui\Widget |
| renderItems() | Рендерит элементы, как указано в $items. | yii\jui\Accordion |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| 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 |
Подробное описание свойств
$headerOptions открытое свойство
Список HTML-атрибутов для тегов контейнера заголовка элемента. Будет перезаписано параметрами "headerOptions", заданными в отдельных $items. Распознаются следующие специальные параметры:
- tag: строка, по умолчанию "h3", имя тега тегов контейнера элемента.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерятся атрибуты.
public array $headerOptions = []
$itemOptions открытое свойство
Список HTML-атрибутов для тегов контейнера элемента. Будет перезаписано параметрами "options", заданными в отдельных $items. Распознаются следующие специальные параметры:
- tag: строка, по умолчанию "div", имя тега тегов контейнера элемента.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерятся атрибуты.
public array $itemOptions = []
$items public property
Список раскрывающихся элементов. Каждый элемент может быть массивом следующей структуры:
[
'header' => 'Item header',
'content' => 'Item content',
// the HTML attributes of the item header container tag. This will overwrite "headerOptions".
'headerOptions' => [],
// the HTML attributes of the item container tag. This will overwrite "itemOptions".
'options' => [],
]
public array $items = []
$options public property
HTML атрибуты для тега контейнера виджета. Признаются следующие специальные опции:
- tag: строка, по умолчанию "div", имя тега контейнера этого виджета
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерятся атрибуты.
public array $options = []
Подробное описание методов
renderItems() protected method
Отображает раскрывающиеся элементы, как указано в $items.
| protected string renderItems ( ) | ||
|---|---|---|
| return | string |
Результат рендеринга. |
| throws | \yii\jui\InvalidConfigException. | |
run() public method
Отображает виджет.
| public void run ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-jui-accordion.html
