Класс yii\bootstrap\ToggleButtonGroup
| Наследование | yii\bootstrap\ToggleButtonGroup » yii\bootstrap\InputWidget » yii\widgets\InputWidget » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Использует Трейты | yii\bootstrap\BootstrapWidgetTrait |
| Доступно с версии | 2.0.6 |
| Исходный код | https://github.com/yiisoft/yii2-bootstrap/blob/master/ToggleButtonGroup.php |
ToggleButtonGroup позволяет отображать группы переключателей Checkbox/Radio в формах.
Вы можете использовать этот виджет в \yii\bootstrap\yii\bootstrap\ActiveForm с помощью метода \yii\bootstrap\yii\widgets\ActiveField::widget(), например так:
<?= $form->field($model, 'item_id')->widget(\yii\bootstrap\ToggleButtonGroup::classname(), [
// configure additional widget properties here
]) ?>
См. также http://getbootstrap.com/javascript/#buttons-checkbox-radio.
Публичные Свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $attribute | string | Атрибут модели, с которым связан данный виджет. | yii\widgets\InputWidget |
| $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 | Нужно ли кодировать метки элементов HTML. | yii\bootstrap\ToggleButtonGroup |
| $field | yii\widgets\ActiveField | Активное поле ввода, вызывающее отображение этого виджета. | yii\widgets\InputWidget |
| $id | string | Идентификатор виджета. | yii\base\Widget |
| $items | array | Данные элемента, используемые для генерации флажков. | yii\bootstrap\ToggleButtonGroup |
| $labelOptions | \yii\bootstrap\array, | Атрибуты HTML для тега метки (кнопки). | yii\bootstrap\ToggleButtonGroup |
| $model | yii\base\Model | Модель данных, с которой связан данный виджет. | yii\widgets\InputWidget |
| $name | string | Имя поля ввода. | yii\widgets\InputWidget |
| $options | array | Атрибуты HTML для тега ввода. | yii\widgets\InputWidget |
| $stack | yii\base\Widget[] | Виджеты, которые в данный момент отображаются (не завершены). | yii\base\Widget |
| $type | string | Тип ввода, может быть: - 'checkbox' - 'radio' | yii\bootstrap\ToggleButtonGroup |
| $value | string | Значение ввода. | yii\widgets\InputWidget |
| $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\ToggleButtonGroup |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Отображает представление. | yii\base\Widget |
| renderFile() | Отображает файл представления. | yii\base\Widget |
| renderItem() | Стандартный обратный вызов для рендеринга элемента списка checkbox/radio. | yii\bootstrap\ToggleButtonGroup |
| run() | Выполняет виджет. | yii\bootstrap\ToggleButtonGroup |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| hasModel() | yii\widgets\InputWidget | |
| 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 |
Подробное описание свойств
$encodeLabels публичное свойство
Необходимо ли кодировать метки элементов HTML.
public boolean $encodeLabels = true
$items публичное свойство
Данные элементов, используемые для генерации чекбоксов. Значения массива — это метки, а ключи массива — соответствующие значения чекбоксов или радиокнопок.
public array $items = []
$labelOptions публичное свойство
Атрибуты тега label (кнопки).
См. также:
public \yii\bootstrap\array, $labelOptions = []
$type публичное свойство
Тип ввода, может быть:
- 'checkbox'
- 'radio'
public string $type = null
Подробное описание методов
init() public method
Инициализирует виджет.
Этот метод зарегистрирует пакет ресурсов bootstrap. Если вы переопределяете этот метод, убедитесь, что сначала вызываете родительскую реализацию.
| public void init ( ) |
|---|
renderItem() public method
Обработчик по умолчанию для рендеринга элементов списка checkbox/radio.
См. также:
| public string renderItem ( $index, $label, $name, $checked, $value ) | ||
|---|---|---|
| $index | integer |
Индекс элемента. |
| $label | string |
Текст метки элемента. |
| $name | string |
Имя элемента ввода. |
| $checked | boolean |
Флаг, указывающий, установлен ли флаг/выбран ли элемент. |
| $value | string |
Значение элемента ввода. |
| return | string |
Сгенерированный HTML. |
run() public method
Выполняет виджет.
| public string run ( ) | ||
|---|---|---|
| return | string |
Результат выполнения виджета для вывода. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-bootstrap-togglebuttongroup.html
