Class yii\grid\CheckboxColumn
| Inheritance | yii\grid\CheckboxColumn » yii\grid\Column » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/grid/CheckboxColumn.php |
CheckboxColumn displays a column of checkboxes in a grid view.
To add a CheckboxColumn to the yii\grid\GridView, add it to the columns configuration as follows:
'columns' => [
// ...
[
'class' => 'yii\grid\CheckboxColumn',
// you may configure additional properties here
],
]
Users may click on the checkboxes to select rows of the grid. The selected rows may be obtained by calling the following JavaScript code:
var keys = $('#grid').yiiGridView('getSelectedRows');
// keys is an array consisting of the keys associated with the selected rows
For more details and usage information on CheckboxColumn, see the guide article on data widgets.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $checkboxOptions | array|Closure | The HTML attributes for checkboxes. | yii\grid\CheckboxColumn |
| $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 |
| $cssClass | string | The css class that will be used to find the checkboxes. | yii\grid\CheckboxColumn |
| $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 |
| $multiple | boolean | Whether it is possible to select multiple rows. | yii\grid\CheckboxColumn |
| $name | string | The name of the input checkbox input fields. | yii\grid\CheckboxColumn |
| $options | array | The HTML attributes for the column group tag. | yii\grid\Column |
| $visible | boolean | Whether this column is visible. | yii\grid\Column |
Public Methods
| Method | Description | Defined 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() | {@inheritdoc} | yii\grid\CheckboxColumn |
| registerClientScript() | Registers the needed JavaScript. | yii\grid\CheckboxColumn |
| 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
| Method | Description | Defined By |
|---|---|---|
| getHeaderCellLabel() | Returns header cell label. | yii\grid\Column |
| getHeaderCheckBoxName() | Returns header checkbox name. | yii\grid\CheckboxColumn |
| renderDataCellContent() | {@inheritdoc} | yii\grid\CheckboxColumn |
| 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\CheckboxColumn |
Property Details
The HTML attributes for checkboxes. This can either be an array of
attributes or an anonymous function (Closure) that returns such an array.
The signature of the function should be the following: 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\CheckboxColumn 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 checkbox
you can use this option in the following way (in this example using the name attribute of the model):
'checkboxOptions' => function ($model, $key, $index, $column) {
return ['value' => $model->name];
}
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
The css class that will be used to find the checkboxes.
Whether it is possible to select multiple rows. Defaults to true.
The name of the input checkbox input fields. This will be appended with [] to ensure it is an array.
Method Details
Returns header checkbox name.
| protected string getHeaderCheckBoxName ( ) | ||
| return | string | Header checkbox name |
|---|---|---|
{@inheritdoc}
| public void init ( ) | ||
| throws | yii\base\InvalidConfigException | if $name is not set. |
|---|---|---|
Registers the needed JavaScript.
| public void registerClientScript ( ) |
{@inheritdoc}
| protected void renderDataCellContent ( $model, $key, $index ) | ||
| $model | ||
| $key | ||
| $index | ||
Renders the header cell content.
The default implementation simply renders $header. This method may be overridden to customize the rendering of the header cell.
| protected string renderHeaderCellContent ( ) | ||
| return | string | The rendering result |
|---|---|---|