Класс yii\bootstrap\ButtonGroup

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

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

ButtonGroup отображает компонент группы кнопок Bootstrap.

Например,

// a button group with items configuration
echo ButtonGroup::widget([
    'buttons' => [
        ['label' => 'A'],
        ['label' => 'B'],
        ['label' => 'C', 'visible' => false],
    ]
]);

// button group with an item as a string
echo ButtonGroup::widget([
    'buttons' => [
        Button::widget(['label' => 'A']),
        ['label' => 'B'],
    ]
]);

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

См. также:

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

Свойство	Тип	Описание	Определено в
$autoIdPrefix	string	Префикс для автоматически сгенерированных идентификаторов виджетов.	yii\base\Widget
$behaviors	yii\base\Behavior[]	Список поведений, прикрепленных к этому компоненту	yii\base\Component
$buttons	массив	Список кнопок.	yii\bootstrap\ButtonGroup
$clientEvents	массив	Обработчики событий для базового плагина Bootstrap JS.	yii\bootstrap\BootstrapWidgetTrait
$clientOptions	массив	Параметры для базового плагина Bootstrap JS.	yii\bootstrap\BootstrapWidgetTrait
$counter	целое число	Счетчик, используемый для генерации $id для виджетов.	yii\base\Widget
$encodeLabels	логическое значение	Нужно ли кодировать метки кнопок с помощью HTML.	yii\bootstrap\ButtonGroup
$id	строка	Идентификатор виджета.	yii\base\Widget
$options	массив	Атрибуты HTML для тега контейнера виджета.	yii\bootstrap\Widget
$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()	Возвращает ID виджета.	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\ButtonGroup
off()	Отсоединяет существующий обработчик событий от этого компонента.	yii\base\Component
on()	Присоединяет обработчик событий к событию.	yii\base\Component
render()	Отображает представление.	yii\base\Widget
renderFile()	Отображает файл представления.	yii\base\Widget
run()	Отображает виджет.	yii\bootstrap\ButtonGroup
setId()	Устанавливает ID виджета.	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
renderButtons()	Генерирует кнопки, которые составляют группу, как указано в $buttons.	yii\bootstrap\ButtonGroup

События

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

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

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

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

label: строка, обязательное поле, текст кнопки.
options: массив, необязательное поле, HTML-атрибуты кнопки.
visible: логическое значение, необязательное поле, показывает ли эта кнопка. По умолчанию true.

public array $buttons = []

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

Нужно ли кодировать метки кнопок в HTML.

public boolean $encodeLabels = true

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

init() метод public

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

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

public void init ( )

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

Генерирует кнопки, составляющие группу, как указано в $buttons.

protected string renderButtons ( )
return	string	Результат рендеринга.

run() метод public

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

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-buttongroup.html