Spec-Zone.ru › Yii 2.0

Класс yii\bootstrap\Carousel

Все классы | Свойства | Методы | События
Наследование yii\bootstrap\Carousel » 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/Carousel.php

Carousel отображает компонент карусели Bootstrap javascript.

Например:

echo Carousel::widget([
    'items' => [
        // the item contains only the image
        '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-01.jpg"/>',
        // equivalent to the above
        ['content' => '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-02.jpg"/>'],
        // the item contains both the image and the caption
        [
            'content' => '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-03.jpg"/>',
            'caption' => '<h4>This is title</h4><p>This is the caption text</p>',
            'options' => [...],
        ],
    ]
]);

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

Публичные свойства

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

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

Метод Описание Определено в
registerClientEvents() Регистрирует обработчики событий JavaScript, перечисленные в $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

Подробности свойств

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

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

public array|boolean $controls = ['&lsaquo;', '&rsaquo;']

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

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

[
    // required, slide content (HTML), such as an image tag
    'content' => '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-01.jpg"/>',
    // optional, the caption (HTML) of the slide
    'caption' => '<h4>This is title</h4><p>This is the caption text</p>',
    // optional the HTML attributes of the slide container
    'options' => [],
]
public array $items = []

$showIndicators public property

Если значение false, индикаторы карусели (тег

    с якорями к элементам) не будут отображаться.

public boolean $showIndicators = true

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

init() public method

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

public void init ( )

renderControls() public method

Отображает кнопки управления предыдущим и следующим элементом.

public void renderControls ( )
throws yii\base\InvalidConfigException

если $controls имеет недопустимое значение.

renderIndicators() public method

Отображает индикаторы карусели.

public string renderIndicators ( )
return string

Результат отображения

renderItem() public method

Отображает один элемент карусели

public string renderItem ( $item, $index )
$item string|array

Один элемент из $items

$index integer

Индекс элемента, первый элемент должен быть установлен на active

return string

Результат отображения

throws yii\base\InvalidConfigException

если элемент недопустим

renderItems() public method

Отображает элементы карусели, как указано в $items.

public string renderItems ( )
return string

Результат отображения

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-bootstrap-carousel.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API