Class yii\grid\RadioButtonColumn

Inheritanceyii\grid\RadioButtonColumn » yii\grid\Column » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0.11
Source Code https://github.com/yiisoft/yii2/blob/master/framework/grid/RadioButtonColumn.php

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

To add a RadioButtonColumn to the yii\grid\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
             ];
         }
    ],
]

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$content callable This is a callable that will be used to generate the content of each cell. yii\grid\Column
$contentOptions array|Closure The HTML attributes for the data cell tag. yii\grid\Column
$filterOptions array The HTML attributes for the filter cell tag. yii\grid\Column
$footer string The footer cell content. yii\grid\Column
$footerOptions array The HTML attributes for the footer cell tag. yii\grid\Column
$grid yii\grid\GridView The grid view object that owns this column. yii\grid\Column
$header string The header cell content. yii\grid\Column
$headerOptions array The HTML attributes for the header cell tag. yii\grid\Column
$name string The name of the input radio button input fields. yii\grid\RadioButtonColumn
$options array The HTML attributes for the column group tag. yii\grid\Column
$radioOptions array|Closure The HTML attributes for the radio buttons. yii\grid\RadioButtonColumn
$visible boolean Whether this column is visible. yii\grid\Column

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. 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() 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. yii\grid\RadioButtonColumn
renderDataCell() Renders a data cell. yii\grid\Column
renderFilterCell() Renders the filter cell. yii\grid\Column
renderFooterCell() Renders the footer cell. yii\grid\Column
renderHeaderCell() Renders the header cell. yii\grid\Column

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getHeaderCellLabel() Returns header cell label. yii\grid\Column
renderDataCellContent() Renders the data cell content. yii\grid\RadioButtonColumn
renderFilterCellContent() Renders the filter cell content. yii\grid\Column
renderFooterCellContent() Renders the footer cell content. yii\grid\Column
renderHeaderCellContent() Renders the header cell content. yii\grid\Column

Property Details

$name public property

The name of the input radio button input fields.

public string $name 'radioButtonSelection'
$radioOptions public property

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 yii\grid\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): `php 'radioOptions' => function ($model, $key, $index, $column) {

return ['value' => $model->attribute];

} `

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

Method Details

init() public method

Initializes the object.

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

public void init ( )
throws yii\base\InvalidConfigException

if $name is not set.

renderDataCellContent() protected method

Renders the data cell content.

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

The data model

$key mixed

The key associated with the data model

$index integer

The zero-based index of the data model among the models array returned by yii\grid\GridView::$dataProvider.

return string

The rendering result