DataColumn

API reference › yii › grid › DataColumn

class	yii\grid\DataColumn
Extends	Column » yii\base\BaseObject
Implements	yii\base\Configurable
Since	2.0
Source	framework/grid/DataColumn.php

1 subclass

• yii\debug\widgets\DebugDataColumn

DataColumn is the default column type for the 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.

Properties

Property	Type	Description	Defined by
$attribute	string	The attribute name associated with this column. Default: null.	DataColumn
$content	callable	This is a callable that will be used to generate the content of each cell. Default: null.	Column
$contentOptions	array|Closure	The HTML attributes for the data cell tag. Default: [].	Column
$enableSorting	bool	Whether to allow sorting by this column. Default: true.	DataColumn
$encodeLabel	bool	Whether the header label should be HTML-encoded. Default: true. Available since 2.0.1.	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. Default: null.	DataColumn
$filterAttribute	string|null	The attribute name of the GridView::$filterModel associated with this column. Default: null. Available since 2.0.41.	DataColumn
$filterInputOptions	array	The HTML attributes for the filter input fields. Default: ['id' => null].	DataColumn
$filterOptions	array	The HTML attributes for the filter cell tag. Default: [].	Column
$footer	string	The footer cell content. Default: null.	Column
$footerOptions	array	The HTML attributes for the footer cell tag. Default: [].	Column
$format	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']). Default: 'text'.	DataColumn
$grid	GridView	The grid view object that owns this column. Default: null.	Column
$header	string|null	The header cell content. Default: null.	Column
$headerOptions	array	The HTML attributes for the header cell tag. Default: [].	Column
$label	string|null	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. Default: null.	DataColumn
$options	array	The HTML attributes for the column group tag. Default: [].	Column
$sortLinkOptions	array	The HTML attributes for the link tag in the header cell generated by Sort::link() when sorting is enabled for this column. Default: [].	DataColumn
$value	string|Closure|null	An anonymous function or a string that is used to determine the value to display in the current column. Default: null.	DataColumn
$visible	bool	Whether this column is visible. Default: true.	Column

Methods

Method	Description	Defined by
__construct()	Constructor.	yii\base\BaseObject
__call()	Calls the named method which is not a class method.	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() static	Returns the fully qualified name of this class.	yii\base\BaseObject
getDataCellValue()	Returns the data cell value.	DataColumn
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.	DataColumn
renderDataCell()	Renders a data cell.	Column
renderFilterCell()	Renders the filter cell.	Column
renderFooterCell()	Renders the footer cell.	Column
renderHeaderCell()	Renders the header cell.	Column
getHeaderCellLabel() protected	Returns header cell label.	DataColumn
renderDataCellContent() protected	Renders the data cell content.	DataColumn
renderFilterCellContent() protected	Renders the filter cell content.	DataColumn
renderFooterCellContent() protected	Renders the footer cell content.	Column
renderHeaderCellContent() protected	Renders the header cell content.	DataColumn

Property details

$attribute

public string $attribute = null

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.

$enableSorting

public bool $enableSorting = true

Whether to allow sorting by this column.

If true and $attribute is found in the sort definition of GridView::$dataProvider, then the header cell of this column will contain a link that may trigger the sorting when being clicked.

$filter

public string|array|null|false $filter = null

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 GridView::$filterModel is set.

• If this property is not set, a text field will be generated as the filter input with attributes defined with $filterInputOptions. See BaseHtml::activeInput() for details on how an active input tag is generated.
• 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.

$filterAttribute

public string|null $filterAttribute = null

The attribute name of the GridView::$filterModel associated with this column.

If not set, will have the same value as $attribute.

Since

2.0.41

$filterInputOptions

public array $filterInputOptions = ['id' => null]

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.

Empty id in the default value ensures that id would not be obtained from the model attribute thus providing better performance.

$format

public string|array|Closure $format = 'text'

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 GridView. Default format is “text” which will format the value as an HTML-encoded plain text when Formatter is used as the formatter of the GridView.

$label

public string|null $label = null

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 ActiveRecord, the label will be determined using ActiveRecord::getAttributeLabel(). Otherwise Inflector::camel2words() will be used to get a label.

$value

public string|Closure|null $value = null

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 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

getDataCellValue()

public function getDataCellValue(mixed $model, mixed $key, int $index): string|null

Returns the data cell value.

Parameters

Parameter	Type	Description
$model	mixed	The data model
$key	mixed	The key associated with the data model
$index	int	The zero-based index of the data model among the models array returned by GridView::$dataProvider.

Returns

string|null: The data cell value

init()

public function init(): mixed

Initializes the object.

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

Returns

mixed

getHeaderCellLabel()

protected function getHeaderCellLabel(): string

Returns header cell label.

This method may be overridden to customize the label of the header cell.

Returns

string: Label

Since

2.0.8

renderDataCellContent()

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

Renders the data cell content.

Parameters

Parameter	Type	Description
$model	mixed	The data model
$key	mixed	The key associated with the data model
$index	mixed	The zero-based index of the data model among the models array returned by GridView::$dataProvider.

Returns

string: The rendering result

renderFilterCellContent()

protected function renderFilterCellContent(): string

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).

Returns

string: The rendering result

renderHeaderCellContent()

protected function renderHeaderCellContent(): string

Renders the header cell content.

The default implementation simply renders $header. This method may be overridden to customize the rendering of the header cell.

Returns

string: The rendering result