Class kartik\grid\CheckboxColumn
| Inheritance | kartik\grid\CheckboxColumn » yii\grid\CheckboxColumn » yii\grid\Column » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Uses Traits | kartik\grid\ColumnTrait |
| Available since version | 1.0 |
The CheckboxColumn displays a column of checkboxes in a grid view and extends the yii\grid\CheckboxColumn with various enhancements.
To add a CheckboxColumn to the gridview, add it to the columns configuration as follows:
'columns' => [
// ...
[
'class' => CheckboxColumn::class,
// you may configure additional properties here
],
]
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $attribute | string | The model attribute to be used in rendering the checkbox input. | kartik\grid\CheckboxColumn |
| $checkboxOptions | array|Closure | The HTML attributes for checkboxes. | yii\grid\CheckboxColumn |
| $columnKey | string | An unique identifier for the Column. | kartik\grid\ColumnTrait |
| $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. | kartik\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 |
| $hAlign | string | The horizontal alignment of each column. | kartik\grid\ColumnTrait |
| $header | string|null | The header cell content. | yii\grid\Column |
| $headerOptions | array | The HTML attributes for the header cell tag. | yii\grid\Column |
| $hidePageSummary | boolean | Whether to just hide the page summary display but still calculate the summary based on $pageSummary settings | kartik\grid\ColumnTrait |
| $mergeHeader | boolean | Whether to merge the header title row and the filter row. | kartik\grid\ColumnTrait |
| $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 |
| $noWrap | boolean | Whether to force no wrapping on all table cells in the column | kartik\grid\ColumnTrait |
| $options | array | The HTML attributes for the column group tag. | yii\grid\Column |
| $pageSummary | boolean|string|Closure | The page summary that is displayed above the footer. | kartik\grid\ColumnTrait |
| $pageSummaryFormat | string|array|Closure | In which format should the value of each data model be displayed as (e.g. "raw", "text", "html",
['date', 'php:Y-m-d']). |
kartik\grid\ColumnTrait |
| $pageSummaryFunc | string|Closure | The summary function that will be used to calculate the page summary for the column. | kartik\grid\ColumnTrait |
| $pageSummaryOptions | array | HTML attributes for the page summary cell. | kartik\grid\ColumnTrait |
| $rowHighlight | boolean | Highlight current row if checkbox is checked | kartik\grid\CheckboxColumn |
| $rowSelectedClass | string | Highlight CSS class to be applied for highlighting the row. | kartik\grid\CheckboxColumn |
| $stripTagsFromExport | boolean | Whether to strip HTML tags from the column during export. | kartik\grid\ColumnTrait |
| $vAlign | string | The vertical alignment of each column. | kartik\grid\ColumnTrait |
| $visible | boolean | Whether this column is visible. | yii\grid\Column |
| $width | string | The width of each column (matches the CSS width property). | kartik\grid\ColumnTrait |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $_clientScript | string | The internally generated client script to initialize | kartik\grid\ColumnTrait |
| $_rows | array | Collection of row data for the column for the current page | kartik\grid\ColumnTrait |
| $_view | yii\web\View | The view instance | kartik\grid\ColumnTrait |
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() | Initializes the object. | kartik\grid\CheckboxColumn |
| initColumnSettings() | Initialize column settings | kartik\grid\ColumnTrait |
| parseExcelFormats() | Parses Excel Cell Formats for export | kartik\grid\ColumnTrait |
| registerClientScript() | Registers the needed JavaScript. | yii\grid\CheckboxColumn |
| renderDataCell() | Renders a data cell. | kartik\grid\CheckboxColumn |
| renderFilterCell() | Renders the filter cell. | kartik\grid\ColumnTrait |
| renderFooterCell() | Renders the footer cell. | yii\grid\Column |
| renderHeaderCell() | Renders the header cell. | kartik\grid\ColumnTrait |
| renderPageSummaryCell() | Renders the page summary cell. | kartik\grid\ColumnTrait |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| calculateSummary() | Calculates the summary of an input data based on page summary aggregration function. | kartik\grid\ColumnTrait |
| checkValidFilters() | Checks if the filter input types are valid | kartik\grid\ColumnTrait |
| fetchContentOptions() | Parses and fetches updated content options for grid visibility and format | kartik\grid\ColumnTrait |
| getFooterCellContent() | Get the raw footer cell content. | kartik\grid\ColumnTrait |
| getHeaderCellLabel() | Returns header cell label. | yii\grid\Column |
| getHeaderCheckBoxName() | Returns header checkbox name. | yii\grid\CheckboxColumn |
| getPageSummaryCellContent() | Gets the raw page summary cell content. | kartik\grid\ColumnTrait |
| initColumnKey() | Initializes the column key | kartik\grid\ColumnTrait |
| initGrouping() | Initializes grid grouping | kartik\grid\ColumnTrait |
| initPjax() | Initialize column specific JS functionality whenever pjax request completes | kartik\grid\ColumnTrait |
| isValidAlignment() | Check if the alignment provided is valid | kartik\grid\ColumnTrait |
| parseFormat() | Parses and formats a grid column | kartik\grid\ColumnTrait |
| parseGrouping() | Parses grid grouping and sets data attributes | kartik\grid\ColumnTrait |
| parseVal() | Parses a value if Closure and returns the right value | kartik\grid\ColumnTrait |
| parseVisibility() | Checks hidden property and hides the column from display |
kartik\grid\ColumnTrait |
| renderDataCellContent() | Renders the data cell content. | 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 |
| renderPageSummaryCellContent() | Renders the page summary cell content. | kartik\grid\ColumnTrait |
| setPageRows() | Store all rows for the column for the current page | kartik\grid\ColumnTrait |
Property Details
The model attribute to be used in rendering the checkbox input.
The css class that will be used to find the checkboxes.
Highlight current row if checkbox is checked
Highlight CSS class to be applied for highlighting the row. Defaults to GridView::TYPE_DANGER.
Method Details
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. |
|---|---|---|
Renders a data cell.
| public string renderDataCell ( $model, $key, $index ) | ||
| $model | mixed | The data model being rendered |
| $key | mixed | The key associated with the data model |
| $index | integer | The zero-based index of the data item among the item array returned by kartik\grid\GridView::$dataProvider. |
| return | string | The rendering result |
|---|---|---|