Class yii\grid\Column

继承yii\grid\Column » yii\base\BaseObject
实现yii\base\Configurable
子类yii\grid\ActionColumn, yii\grid\CheckboxColumn, yii\grid\DataColumn, yii\grid\RadioButtonColumn, yii\grid\SerialColumn
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/grid/Column.php

Column 是所有 yii\grid\GridView 列类的基类.

有关 Column 的更多详细信息和使用信息, 请参阅 权威指南 - 显示数据 - 数据小部件(Data Widgets).

公共属性

隐藏继承的属性

属性类型描述定义在
$content callable 这是一个可调用的函数, 将被用来生成每个单元格的内容. yii\grid\Column
$contentOptions array|Closure 数据单元格(tbody > tr > td)标签的 HTML 属性. yii\grid\Column
$filterOptions array 过滤器单元标签的 HTML 属性. yii\grid\Column
$footer string 页脚单元格内容. yii\grid\Column
$footerOptions array 页脚单元格(tfoot > tr > td)标签的 HTML 属性. yii\grid\Column
$grid yii\grid\GridView 拥有此列的网格视图对象. yii\grid\Column
$header string 标题单元格内容. yii\grid\Column
$headerOptions array 标题单元格(thead > tr > th)标签的 HTML 属性. yii\grid\Column
$options array 列组标记(colgroup 中对应列的 col 标签)的 HTML 属性. yii\grid\Column
$visible boolean 该列是否可见. yii\grid\Column

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的已命名方法. yii\base\BaseObject
__construct() 构造函数. yii\base\BaseObject
__get() 返回对象属性的值. yii\base\BaseObject
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\BaseObject
__set() 设置对象属性的值. yii\base\BaseObject
__unset() 将对象属性设置为null. yii\base\BaseObject
canGetProperty() 返回一个值, 指示属性是否可读. yii\base\BaseObject
canSetProperty() 返回一个值, 指示属性是否可写. yii\base\BaseObject
className() 返回此类的完全限定名称. yii\base\BaseObject
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\BaseObject
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\BaseObject
init() 初始化对象. yii\base\BaseObject
renderDataCell() 渲染数据单元格. yii\grid\Column
renderFilterCell() 渲染过滤器单元格. yii\grid\Column
renderFooterCell() 渲染页脚单元格. yii\grid\Column
renderHeaderCell() 渲染标题单元格. yii\grid\Column

受保护的方法

隐藏继承的方法

方法描述定义在
getHeaderCellLabel() 返回标题单元格标签. yii\grid\Column
renderDataCellContent() 渲染数据单元格内容. yii\grid\Column
renderFilterCellContent() 渲染过滤器单元格内容. yii\grid\Column
renderFooterCellContent() 渲染页脚单元格内容. yii\grid\Column
renderHeaderCellContent() 渲染标题单元格内容. yii\grid\Column

属性详情

$content public 属性

这是一个可调用的函数, 将被用来生成每个单元格的内容.

函数的签名应该是: function ($model, $key, $index, $column).

$model, $key$index分别指当前正在渲染的行的模型, 键和索引, $column是对 yii\grid\Column 对象的引用.

public callable $content null
$contentOptions public 属性

数据单元格(tbody > tr > td)标签的 HTML 属性.

这可以是一个属性数组, 也可以是一个返回这样的数组的 匿名函数.

函数的签名应该是: function ($model, $key, $index, $column).

$model, $key$index分别指当前正在渲染的行的模型, 键和索引, $column是对 yii\grid\Column 对象的引用.

可以使用函数根据该行中的数据将不同的属性分配给不同的行.

参见 yii\helpers\Html::renderTagAttributes() 有关如何渲染属性的详细信息.

$filterOptions public 属性

过滤器单元标签的 HTML 属性.

参见 yii\helpers\Html::renderTagAttributes() 有关如何渲染属性的详细信息.

public array $filterOptions = []
$footer public 属性

页脚单元格内容. 请注意, 它不会被 HTML 编码.

public string $footer null
$footerOptions public 属性

页脚单元格(tfoot > tr > td)标签的 HTML 属性.

参见 yii\helpers\Html::renderTagAttributes() 有关如何渲染属性的详细信息.

public array $footerOptions = []
$grid public 属性

拥有此列的网格视图对象.

public yii\grid\GridView $grid null
$header public 属性

标题单元格内容. 请注意, 它不会被 HTML 编码.

public string $header null
$headerOptions public 属性

标题单元格(thead > tr > th)标签的 HTML 属性.

参见 yii\helpers\Html::renderTagAttributes() 有关如何渲染属性的详细信息.

public array $headerOptions = []
$options public 属性

列组标记(colgroup 中对应列的 col 标签)的 HTML 属性.

参见 yii\helpers\Html::renderTagAttributes() 有关如何渲染属性的详细信息.

public array $options = []
$visible public 属性

该列是否可见. 默认为true.

public boolean $visible true

方法详情

getHeaderCellLabel() protected 方法 (可用自版本: 2.0.8)

返回标题单元格标签.

可以重写此方法来自定义标题单元格的标签.

protected string getHeaderCellLabel ( )
return string

Label

renderDataCell() public 方法

渲染数据单元格.

public string renderDataCell ( $model, $key, $index )
$model mixed

正在渲染的数据模型.

$key mixed

与数据模型关联的键.

$index integer

yii\grid\GridView::$dataProvider 返回的项目数组中的数据项的从0开始的索引.

return string

渲染结果.

renderDataCellContent() protected 方法

渲染数据单元格内容.

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

数据模型.

$key mixed

与数据模型关联的键.

$index integer

yii\grid\GridView::$dataProvider 返回的项目数组中的数据项的从0开始的索引.

return string

渲染结果.

renderFilterCell() public 方法

渲染过滤器单元格.

public void renderFilterCell ( )
renderFilterCellContent() protected 方法

渲染过滤器单元格内容.

默认实现只是渲染一个空格.

可以重写此方法以自定义过滤器单元的渲染(如果有的话).

protected string renderFilterCellContent ( )
return string

渲染结果.

renderFooterCell() public 方法

渲染页脚单元格.

public void renderFooterCell ( )
renderFooterCellContent() protected 方法

渲染页脚单元格内容.

默认实现只是渲染 $footer.

可以重写此方法来自定义页脚单元格的渲染.

protected string renderFooterCellContent ( )
return string

渲染结果.

renderHeaderCell() public 方法

渲染标题单元格.

public void renderHeaderCell ( )
renderHeaderCellContent() protected 方法

渲染标题单元格内容.

默认实现只是渲染 $header.

可以重写此方法来自定义标题单元格的渲染.

protected string renderHeaderCellContent ( )
return string

渲染结果.