PHP Class yii\grid\DataColumn

It is used to show data columns and allows [[enableSorting|sorting]] and [[filter|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 [[getDataCellValue|data cell value]] and the [[renderDataCellContent|data cell content]]. The cell value is an un-formatted value that may be used for calculation, while the actual cell content is a [[format|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.
Since: 2.0
Author: Qiang Xue ([email protected])
Inheritance: extends Column
Datei anzeigen Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property Type Description
$attribute 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 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.
$encodeLabel whether the header label should be HTML-encoded.
$filter 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; - 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.
$filterInputOptions 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.
$format 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 [[GridView::formatter|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 [[GridView::$formatter|formatter]] of the GridView.
$label label to be displayed in the [[header|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 [[\yii\db\ActiveRecord::getAttributeLabel()]]. Otherwise [[\yii\helpers\Inflector::camel2words()]] will be used to get a label.
$sortLinkOptions the HTML attributes for the link tag in the header cell generated by [[\yii\data\Sort::link]] when sorting is enabled for this column.
$value 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]].

Public Methods

Method Description
getDataCellValue ( mixed $model, mixed $key, integer $index ) : string Returns the data cell value.

Protected Methods

Method Description
getHeaderCellLabel ( )
renderDataCellContent ( $model, $key, $index )
renderFilterCellContent ( )
renderHeaderCellContent ( )

Method Details

getDataCellValue() public method

Returns the data cell value.
public getDataCellValue ( mixed $model, mixed $key, integer $index ) : string
$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 [[GridView::dataProvider]].
return string the data cell value

getHeaderCellLabel() protected method

Since: 2.0.8
protected getHeaderCellLabel ( )

renderDataCellContent() protected method

protected renderDataCellContent ( $model, $key, $index )

renderFilterCellContent() protected method

protected renderFilterCellContent ( )

renderHeaderCellContent() protected method

protected renderHeaderCellContent ( )

Property Details

$attribute public_oe property

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.
public $attribute

$enableSorting public_oe property

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.
public $enableSorting

$encodeLabel public_oe property

whether the header label should be HTML-encoded.
See also: label
Since: 2.0.1
public $encodeLabel

$filter public_oe property

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; - 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.
public $filter

$filterInputOptions public_oe property

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.
public $filterInputOptions

$format public_oe property

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 [[GridView::formatter|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 [[GridView::$formatter|formatter]] of the GridView.
public $format

$label public_oe property

label to be displayed in the [[header|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 [[\yii\db\ActiveRecord::getAttributeLabel()]]. Otherwise [[\yii\helpers\Inflector::camel2words()]] will be used to get a label.
public $label

$sortLinkOptions public_oe property

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.
public $sortLinkOptions

$value public_oe property

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]].
public $value