Class yii\grid\DataColumn
| Inheritance | yii\grid\DataColumn » yii\grid\Column » yii\base\Object |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/grid/DataColumn.php |
DataColumn is the default column type for the yii\grid\GridView widget.
It is used to show data columns and allows sorting and filtering them.
A simple data column definition refers to an attribute in the data model of the GridView's data provider. The name of the attribute is specified by $attribute.
By setting $value and $label, the header and cell content can be customized.
A data column differentiates between the data cell value and the data cell content. The cell value is an un-formatted value that may be used for calculation, while the actual cell content is a formatted version of that value which may contain HTML markup.
For more details and usage information on DataColumn, see the guide article on data widgets.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $attribute | string | The attribute name associated with this column. | yii\grid\DataColumn |
| $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 |
| $enableSorting | boolean | Whether to allow sorting by this column. | yii\grid\DataColumn |
| $encodeLabel | boolean | Whether the header label should be HTML-encoded. | yii\grid\DataColumn |
| $filter | string|array|null|false | The HTML code representing a filter input (e.g. a text field, a dropdown list) that is used for this data column. | yii\grid\DataColumn |
| $filterInputOptions | array | The HTML attributes for the filter input fields. | yii\grid\DataColumn |
| $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 |
| $format | string|array | In which format should the value of each data model be displayed as (e.g. "raw", "text", "html",
['date', 'php:Y-m-d']). |
yii\grid\DataColumn |
| $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 |
| $label | string | Label to be displayed in the header cell and also to be used as the sorting link label when sorting is enabled for this column. | yii\grid\DataColumn |
| $options | array | The HTML attributes for the column group tag. | yii\grid\Column |
| $sortLinkOptions | array | The HTML attributes for the link tag in the header cell generated by yii\data\Sort::link() when sorting is enabled for this column. | yii\grid\DataColumn |
| $value | string|Closure | An anonymous function or a string that is used to determine the value to display in the current column. | yii\grid\DataColumn |
| $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\Object |
| __construct() | Constructor. | yii\base\Object |
| __get() | Returns the value of an object property. | yii\base\Object |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
| __set() | Sets value of an object property. | yii\base\Object |
| __unset() | Sets an object property to null. | yii\base\Object |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Object |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| getDataCellValue() | Returns the data cell value. | yii\grid\DataColumn |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Object |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
| init() | Initializes the object. | yii\base\Object |
| 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\DataColumn |
| renderDataCellContent() | Renders the data cell content. | yii\grid\DataColumn |
| renderFilterCellContent() | Renders the filter cell content. | yii\grid\DataColumn |
| renderFooterCellContent() | Renders the footer cell content. | yii\grid\Column |
| renderHeaderCellContent() | Renders the header cell content. | yii\grid\DataColumn |
Property Details
The attribute name associated with this column. When neither $content nor $value is specified, the value of the specified attribute will be retrieved from each data model and displayed.
Also, if $label is not specified, the label associated with the attribute will be displayed.
Whether to allow sorting by this column. If true and $attribute is found in the sort definition of yii\grid\GridView::$dataProvider, then the header cell of this column will contain a link that may trigger the sorting when being clicked.
Whether the header label should be HTML-encoded.
See also $label.
The HTML code representing a filter input (e.g. a text field, a dropdown list) that is used for this data column. This property is effective only when yii\grid\GridView::$filterModel is set.
- If this property is not set, a text field will be generated as the filter input;
- If this property is an array, a dropdown list will be generated that uses this property value as the list options.
- If you don't want a filter for this data column, set this value to be false.
The HTML attributes for the filter input fields. This property is used in combination with the $filter property. When $filter is not set or is an array, this property will be used to render the HTML attributes for the generated filter input fields.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
In which format should the value of each data model be displayed as (e.g. "raw", "text", "html",
['date', 'php:Y-m-d']). Supported formats are determined by the formatter used by
the yii\grid\GridView. Default format is "text" which will format the value as an HTML-encoded plain text when
yii\i18n\Formatter is used as the formatter of the GridView.
Label to be displayed in the header cell and also to be used as the sorting link label when sorting is enabled for this column. If it is not set and the models provided by the GridViews data provider are instances of yii\db\ActiveRecord, the label will be determined using yii\db\ActiveRecord::getAttributeLabel(). Otherwise yii\helpers\Inflector::camel2words() will be used to get a label.
The HTML attributes for the link tag in the header cell generated by yii\data\Sort::link() when sorting is enabled for this column.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
An anonymous function or a string that is used to determine the value to display in the current column.
If this is an anonymous function, it will be called for each row and the return value will be used as the value to
display for every data model. The signature of this function should be: 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\DataColumn object.
You may also set this property to a string representing the attribute name to be displayed in this column. This can be used when the attribute to be displayed is different from the $attribute that is used for sorting and filtering.
If this is not set, $model[$attribute] will be used to obtain the value, where $attribute is the value of $attribute.
Method Details
Returns the data cell value.
| public string getDataCellValue ( $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 data cell value |
|---|---|---|
Returns header cell label.
This method may be overridden to customize the label of the header cell.
| protected string getHeaderCellLabel ( ) | ||
| return | string | Label |
|---|---|---|
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 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 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 |
|---|---|---|