Spec-Zone.ru › Yii 2.0

Класс yii\grid\CheckboxColumn

Все классы | Свойства | Методы
Наследование yii\grid\CheckboxColumn » yii\grid\Column » yii\base\Object
Реализует yii\base\Configurable
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2/blob/master/framework/grid/CheckboxColumn.php

CheckboxColumn отображает столбец с флажками в представлении таблицы.

Чтобы добавить CheckboxColumn в yii\grid\GridView, добавьте его в конфигурацию columns следующим образом:

'columns' => [
    // ...
    [
        'class' => 'yii\grid\CheckboxColumn',
        // you may configure additional properties here
    ],
]

Пользователи могут нажимать на флажки, чтобы выбрать строки таблицы. Выбранные строки можно получить, используя следующий JavaScript-код:

var keys = $('#grid').yiiGridView('getSelectedRows');
// keys is an array consisting of the keys associated with the selected rows

Для получения более подробной информации и справок по использованию CheckboxColumn, см. статью руководства по виджетам данных.

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

Свойство Тип Описание Определено в
$checkboxOptions массив|Closure Атрибуты HTML для флажков. yii\grid\CheckboxColumn
$content callable Это вызываемый объект, который будет использоваться для генерации содержимого каждой ячейки. yii\grid\Column
$contentOptions массив|Closure Атрибуты HTML для тега ячейки с данными. yii\grid\Column
$cssClass строка CSS-класс, который будет использоваться для поиска флажков. yii\grid\CheckboxColumn
$filterOptions массив Атрибуты HTML для тега ячейки фильтра. yii\grid\Column
$footer строка Содержимое ячейки подвала. yii\grid\Column
$footerOptions массив Атрибуты HTML для тега ячейки подвала. yii\grid\Column
$grid yii\grid\GridView Объект представления таблицы, владеющий этим столбцом. yii\grid\Column
$header строка Содержимое ячейки заголовка. yii\grid\Column
$headerOptions массив Атрибуты HTML для тега ячейки заголовка. yii\grid\Column
$multiple булево Можно ли выбрать несколько строк. yii\grid\CheckboxColumn
$name строка Имя входных полей флажков. yii\grid\CheckboxColumn
$options массив Атрибуты HTML для тега группы столбцов. yii\grid\Column
$visible булево Этот столбец отображается. yii\grid\Column

Публичные методы

Метод Описание Определено в
__call() Вызывает метод, который не является методом класса. yii\base\Object
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства объекта. yii\base\Object
__isset() Проверяет, установлено ли свойство, т. е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства объекта. yii\base\Object
__unset() Устанавливает свойство объекта в null. yii\base\Object
canGetProperty() Возвращает значение, указывающее, можно ли прочитать свойство. yii\base\Object
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Object
className() Возвращает полное имя этого класса. yii\base\Object
hasMethod() Возвращает значение, указывающее, определен ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует объект. yii\grid\CheckboxColumn
registerClientScript() Регистрирует необходимый JavaScript. yii\grid\CheckboxColumn
renderDataCell() Отображает ячейку данных. yii\grid\Column
renderFilterCell() Отображает ячейку фильтра. yii\grid\Column
renderFooterCell() Отображает ячейку подвала. yii\grid\Column
renderHeaderCell() Отображает ячейку заголовка. yii\grid\Column

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

Метод Описание Определено в
getHeaderCellLabel() Возвращает метку ячейки заголовка. yii\grid\Column
getHeaderCheckBoxName() Возвращает имя флажка заголовка. yii\grid\CheckboxColumn
renderDataCellContent() Отображает содержимое ячейки данных. yii\grid\CheckboxColumn
renderFilterCellContent() Отображает содержимое ячейки фильтра. yii\grid\Column
renderFooterCellContent() Отображает содержимое ячейки подвала. yii\grid\Column
renderHeaderCellContent() Отображает содержимое ячейки заголовка. yii\grid\CheckboxColumn

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

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

Атрибуты HTML для флажков. Это может быть массив атрибутов или анонимная функция (Closure), возвращающая такой массив. Подпись функции должна быть следующей: function ($model, $key, $index, $column). Где $model, $key, и $index относятся к модели, ключу и индексу текущей строки, а $column — ссылка на объект yii\grid\CheckboxColumn. Функция может использоваться для назначения различных атрибутов разным строкам на основе данных в этой строке. В частности, если вы хотите установить другое значение для флажка, вы можете использовать этот параметр следующим образом (в этом примере с использованием атрибута name модели):

'checkboxOptions' => function ($model, $key, $index, $column) {
    return ['value' => $model->name];
}

См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как отображаются атрибуты.

public array|Closure $checkboxOptions = []

$cssClass общественное свойство (доступно с версии 2.0.9)

Класс CSS, который будет использоваться для поиска флажков.

public string $cssClass = null

$multiple общественное свойство

Можно ли выбирать несколько строк. По умолчанию true.

public boolean $multiple = true

$name общественное свойство

Имя поля ввода флажка. К нему будет добавлен [] для обеспечения того, что это массив.

public string $name = 'selection'

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

getHeaderCheckBoxName() защищённый метод (доступен с версии 2.0.8)

Возвращает имя флажка заголовка

защищённый строка getHeaderCheckBoxName ( )
возвращает строка

Имя флажка заголовка

init() общественный метод

Инициализирует объект.

Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.

общественный void init ( )
бросает yii\base\InvalidConfigException

если $name не задан.

registerClientScript() общественный метод (доступен с версии 2.0.8)

Регистрирует необходимый JavaScript

общественный void registerClientScript ( )

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

Отображает содержимое ячейки данных.

защищённый строка renderDataCellContent ( $model, $key, $index )
$model смешанный тип

Модель данных

$key смешанный тип

Ключ, связанный с моделью данных

$index целое число

Индекс с нуля модели данных среди массива моделей, возвращаемого yii\grid\GridView::$dataProvider.

возвращает строка

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

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

Отображает содержимое ячейки заголовка.

По умолчанию просто отображает $header. Этот метод может быть переопределен для настройки отображения ячейки заголовка.

защищённый строка renderHeaderCellContent ( )
возвращает строка

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

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-grid-checkboxcolumn.html

Spec-Zone.ru

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