Class yii\grid\Column
| Inheritance | yii\grid\Column » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Subclasses | yii\grid\ActionColumn, yii\grid\CheckboxColumn, yii\grid\DataColumn, yii\grid\RadioButtonColumn, yii\grid\SerialColumn |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/grid/Column.php |
Column is the base class of all yii\grid\GridView column classes.
For more details and usage information on Column, see the guide article on data widgets.
Public Properties
| Property | Type | Description | Defined 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 |
| $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() | Initializes the object. | yii\base\BaseObject |
| 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 |
| renderDataCellContent() | Renders the data cell content. | yii\grid\Column |
| 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
This is a callable that will be used to generate the content of each cell.
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\Column object.
The HTML attributes for the data cell tag. 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\Column object.
A function may be used to assign different attributes to different rows based on the data in that row.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
The HTML attributes for the filter cell tag.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
The footer cell content. Note that it will not be HTML-encoded.
The HTML attributes for the footer cell tag.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
The grid view object that owns this column.
The header cell content. Note that it will not be HTML-encoded.
The HTML attributes for the header cell tag.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
The HTML attributes for the column group tag.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
Whether this column is visible. Defaults to true.
Method Details
Returns header cell label.
This method may be overridden to customize the label of the header cell.
| protected string getHeaderCellLabel ( ) | ||
| return | string | Label |
|---|---|---|
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 yii\grid\GridView::$dataProvider. |
| return | string | The rendering result |
|---|---|---|
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 |
|---|---|---|
Renders the filter cell.
| public void renderFilterCell ( ) |
Renders the filter cell content.
The default implementation simply renders a space. This method may be overridden to customize the rendering of the filter cell (if any).
| protected string renderFilterCellContent ( ) | ||
| return | string | The rendering result |
|---|---|---|
Renders the footer cell.
| public void renderFooterCell ( ) |
Renders the footer cell content.
The default implementation simply renders $footer. This method may be overridden to customize the rendering of the footer cell.
| protected string renderFooterCellContent ( ) | ||
| return | string | The rendering result |
|---|---|---|
Renders the header cell.
| public void renderHeaderCell ( ) |
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 |
|---|---|---|
Signup or Login in order to comment.