Класс yii\grid\RadioButtonColumn
| Наследование | yii\grid\RadioButtonColumn » yii\grid\Column » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0.11 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/grid/RadioButtonColumn.php |
RadioButtonColumn отображает столбец радиокнопок в представлении сетки.
Чтобы добавить RadioButtonColumn в yii\grid\GridView, добавьте его в конфигурацию columns следующим образом:
'columns' => [
// ...
[
'class' => 'yii\grid\RadioButtonColumn',
'radioOptions' => function ($model) {
return [
'value' => $model['value'],
'checked' => $model['value'] == 2
];
}
],
]
Открытые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $content | callable | Это вызываемый объект, который будет использоваться для создания содержимого каждой ячейки. | yii\grid\Column |
| $contentOptions | массив|Замыкание | Атрибуты HTML для тега ячейки данных. | yii\grid\Column |
| $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 |
| $name | строка | Имя полей ввода радиокнопок. | yii\grid\RadioButtonColumn |
| $options | массив | Атрибуты HTML для тега группы столбцов. | yii\grid\Column |
| $radioOptions | массив|Замыкание | Атрибуты HTML для радиокнопок. | yii\grid\RadioButtonColumn |
| $visible | boolean | Видимость этого столбца. | 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\RadioButtonColumn |
| renderDataCell() | Отображает ячейку данных. | yii\grid\Column |
| renderFilterCell() | Отображает ячейку фильтра. | yii\grid\Column |
| renderFooterCell() | Отображает ячейку подвала. | yii\grid\Column |
| renderHeaderCell() | Отображает ячейку заголовка. | yii\grid\Column |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| getHeaderCellLabel() | Возвращает метку ячейки заголовка. | yii\grid\Column |
| renderDataCellContent() | Отображает содержимое ячейки данных. | yii\grid\RadioButtonColumn |
| renderFilterCellContent() | Отображает содержимое ячейки фильтра. | yii\grid\Column |
| renderFooterCellContent() | Отображает содержимое ячейки подвала. | yii\grid\Column |
| renderHeaderCellContent() | Отображает содержимое ячейки заголовка. | yii\grid\Column |
Подробности свойств
$name открытое свойство
Имя полей ввода радиокнопок.
public string $name = 'radioButtonSelection'
$radioOptions открытое свойство
Атрибуты HTML для радиокнопок. Это может быть либо массив атрибутов, либо анонимная функция (Замыкание), возвращающая такой массив.
Подпись функции должна быть следующей: function ($model, $key, $index, $column) где $model, $key, и $index относятся к модели, ключу и индексу строки, которая в данный момент отображается, и $column — ссылка на объект yii\grid\RadioButtonColumn.
Функция может использоваться для назначения различных атрибутов различным строкам в зависимости от данных в этой строке. В частности, если вы хотите установить разное значение для радиокнопки, вы можете использовать этот параметр следующим образом (в этом примере используется атрибут name модели): `php 'radioOptions' => function ($model, $key, $index, $column) {
return ['value' => $model->attribute];
} `
См. также yii\helpers\Html::renderTagAttributes() для получения подробностей о том, как отображаются атрибуты.
public array|Closure $radioOptions = []
Подробности методов
init() public method
Инициализирует объект.
Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.
| public void init ( ) | ||
|---|---|---|
| throws | yii\base\InvalidConfigException |
если $name не задан. |
renderDataCellContent() protected method
Отображает содержимое ячейки данных.
| protected string renderDataCellContent ( $model, $key, $index ) | ||
|---|---|---|
| $model | mixed |
Модель данных |
| $key | mixed |
Ключ, связанный с моделью данных |
| $index | integer |
Индекс (от нуля) модели данных среди массива моделей, возвращаемого yii\grid\GridView::$dataProvider. |
| return | string |
Результат отображения |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-grid-radiobuttoncolumn.html