RadioButtonColumn

API reference › yii › grid › RadioButtonColumn

class	`yii\grid\RadioButtonColumn`
Extends	`Column` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0.11
Source	`framework/grid/RadioButtonColumn.php`

RadioButtonColumn displays a column of radio buttons in a grid view.

To add a RadioButtonColumn to the GridView, add it to the columns configuration as follows:

'columns' => [
    // ...
    [
        'class' => 'yii\grid\RadioButtonColumn',
        'radioOptions' => function ($model) {
             return [
                 'value' => $model['value'],
                 'checked' => $model['value'] == 2
             ];
         }
    ],
]

Properties

Property	Type	Description	Defined by
`$content`	`callable`	This is a callable that will be used to generate the content of each cell. Default: `null`.	`Column`
`$contentOptions`	`array\|Closure`	The HTML attributes for the data cell tag. Default: `[]`.	`Column`
`$filterOptions`	`array`	The HTML attributes for the filter cell tag. Default: `[]`.	`Column`
`$footer`	`string`	The footer cell content. Default: `null`.	`Column`
`$footerOptions`	`array`	The HTML attributes for the footer cell tag. Default: `[]`.	`Column`
`$grid`	`GridView`	The grid view object that owns this column. Default: `null`.	`Column`
`$header`	`string\|null`	The header cell content. Default: `null`.	`Column`
`$headerOptions`	`array`	The HTML attributes for the header cell tag. Default: `[]`.	`Column`
`$name`	`string`	The name of the input radio button input fields. Default: `'radioButtonSelection'`.	`RadioButtonColumn`
`$options`	`array`	The HTML attributes for the column group tag. Default: `[]`.	`Column`
`$radioOptions`	`array\|Closure`	The HTML attributes for the radio buttons. Default: `[]`.	`RadioButtonColumn`
`$visible`	`bool`	Whether this column is visible. Default: `true`.	`Column`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`init()`	Initializes the object.	`RadioButtonColumn`
`renderDataCell()`	Renders a data cell.	`Column`
`renderFilterCell()`	Renders the filter cell.	`Column`
`renderFooterCell()`	Renders the footer cell.	`Column`
`renderHeaderCell()`	Renders the header cell.	`Column`
`getHeaderCellLabel()` protected	Returns header cell label.	`Column`
`renderDataCellContent()` protected	Renders the data cell content.	`RadioButtonColumn`
`renderFilterCellContent()` protected	Renders the filter cell content.	`Column`
`renderFooterCellContent()` protected	Renders the footer cell content.	`Column`
`renderHeaderCellContent()` protected	Renders the header cell content.	`Column`

Property details

$radioOptions

public array|Closure $radioOptions = []

The HTML attributes for the radio buttons.

This can either be an array of attributes or an anonymous function (Closure) returning such an array.

The signature of the function should be as follows: function ($model, $key, $index, $column) where $model, $key, and $index refer to the model, key and index of the row currently being rendered and $column is a reference to the RadioButtonColumn object.

A function may be used to assign different attributes to different rows based on the data in that row. Specifically if you want to set a different value for the radio button you can use this option in the following way (in this example using the name attribute of the model):

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

Method details

init()

public function init(): mixed

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

Returns

mixed

Throws

yii\base\InvalidConfigException: if $name is not set.

renderDataCellContent()

protected function renderDataCellContent(mixed $model, mixed $key, mixed $index): string

Renders the data cell content.

Parameters

Parameter	Type	Description
`$model`	`mixed`	The data model
`$key`	`mixed`	The key associated with the data model
`$index`	`mixed`	The zero-based index of the data model among the models array returned by `GridView::$dataProvider`.

Returns

string: The rendering result