Class yii\grid\DataColumn

所有类 | 属性 | 方法

继承	yii\grid\DataColumn » yii\grid\Column » yii\base\Object
可用自版本	2.0

上是默认的列类型的网格yii\grid\GridView 数据表格小部件。

它是用来显示数据列和允许排序和过滤。

一个简单的数据列定义是指一个属性GridView的数据模型的数据提供者。属性的名称是由美元指定 $attribute.

通过设置$value和$label,标题和细胞内容可以定制。

数据列数据单元之间的区别值和数据单元的内容。细胞值是一个un-formatted值可以用于计算,而实际的细胞内容是一个值的格式的版本可能包含HTML标记。

更多细节和使用上的信息,请参阅指南文章数据窗口小部件。

公共属性

隐藏继承属性

属性	类型	描述	定义在
$attribute	string	与这一列相关联的属性名称	yii\grid\DataColumn
$enableSorting	boolean	是否允许排序的列。	yii\grid\DataColumn
$encodeLabel	boolean	是否应该HTML-encoded标题标签。	yii\grid\DataColumn
$filter	string|array|null|false	HTML代码代表的滤波器输入文本字段(例如,dropdown list),使用这个日期列。	yii\grid\DataColumn
$filterInputOptions	array	输入字段的HTML属性过滤器	yii\grid\DataColumn
$format	string|array	格式的每个数据模型的价值应该显示为(例如“生”、“文本”、“html”(“日期”、“php:Y-m-d”))。	yii\grid\DataColumn
$label	string	标签显示在网格\yii\grid\header也用作排序链接标签启用排序时,这一列。	yii\grid\DataColumn
$sortLinkOptions	array	属性生成的链接标签标题单元格yii\data\Sort::link()启用排序时这一列。	yii\grid\DataColumn
$value	string|Closure	一个匿名函数或一个字符串,用于确定该值显示在当前的列。	yii\grid\DataColumn

公共方法

隐藏继承方法

方法	描述	定义在
getDataCellValue()	返回数据单元的值。	yii\grid\DataColumn

受保护的方法

隐藏继承方法

方法	描述	定义在
getHeaderCellLabel()		yii\grid\DataColumn
renderDataCellContent()		yii\grid\DataColumn
renderFilterCellContent()		yii\grid\DataColumn
renderHeaderCellContent()		yii\grid\DataColumn

属性详情

$attribute public property

与这一列相关联的属性名称。当网格\ yii \ \内容和美元值被指定,指定属性的值将从每个数据检索模型和显示.

同样,如果没有指定标签$label,标签将显示相关属性。

public string $attribute = null

$enableSorting public property

是否允许排序的列。如果找到真正和$attribute类型定义的网格 yii\grid\GridView::dataProvider,那么标题单元格的列将包含一个链接,可能会触发排序时被点击。

public boolean $enableSorting = true

$encodeLabel public property （可用自版本 2.0.1）

是否应该HTML-encoded标题标签。

参见 $label.

public boolean $encodeLabel = true

$filter public property

代表一个过滤器的HTML代码输入(例如一个文本框、下拉列表),用于此数据列。这个属性是有效的只有当网格 yii\grid\GridView::$filterModel设置。

• 如果不设置这个属性,将生成一个文本字段作为滤波器的输入;
• 如果这个属性是一个数组,会产生一个下拉列表,使用这个属性值列表选项。
• 如果你不想要一个过滤器对于这些数据列,设置这个值是错误的。

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

$filterInputOptions public property

输入字段的HTML属性过滤器。此属性用于结合$filter财产。当$filter没有设置或者是一个数组,该属性将被用来渲染生成的HTML属性过滤输入字段

参见 yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $filterInputOptions = ['class' => 'form-control', 'id' => null]

$format public property

格式的每个数据模型的价值应该显示为(e.g. "raw", "text", "html", ['date', 'php:Y-m-d']).。支持的格式取决于使用的格式化程序网格yii\grid\GridView数据表格。默认格式是“文本”格式将价值作为HTML-encoded纯文本当 yii\i18n\Formatter 化程序用作GridView的格式化程序。

public string|array $format = 'text'

$label public property

标签显示在网格\yii\grid\header也用作排序链接标签启用排序时,这一列。如果不设置和显示数据表格数据提供商提供的模型实例yii\db\ActiveRecord,标签将会决定使用yii\db\ActiveRecord::getAttributeLabel()。否则yii\helpers\Inflector::camel2words()将被用来获得一个标签。

public string $label = null

$sortLinkOptions public property

标签的HTML属性链接标题单元格由yii \ data \::链接()启用排序时,这一列。

参见 yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $sortLinkOptions = []

$value public property

一个匿名函数或一个字符串,用于确定该值显示在当前的列。

如果这是一个匿名函数,它将要求每一行并返回值将被用作值显示为每一个数据模型。这个函数的签名应该是:function ($model, $key, $index, $column).。$model, $key, and $indexrrefer模型,目前呈现键和索引的行,列网格yii\grid\DataColumn 引用对象。

所以，你可能将此属性设置为表示要在此列中显示的属性名称的字符串。这可以用时要显示的属性是不同于用于排序和筛选 $attribute.

如果没有设置,$model[$attribute]]美元将用于获取值,$attribute 的值是属性$attribute.。

public string|Closure $value = null

方法详情

getDataCellValue() public 方法

返回数据单元的值。

public string getDataCellValue ( $model, $key, $index )
$model	mixed	数据模型
$key	mixed	与数据模型相关联的关键
$index	integer	从零开始的索引返回的数组中数据模型的模型网格 yii\grid\GridView::dataProvider.
return	string	数据单元的值

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

 

protected void getHeaderCellLabel ( )

renderDataCellContent() protected 方法

 

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

renderFilterCellContent() protected 方法

 

protected void renderFilterCellContent ( )

renderHeaderCellContent() protected 方法

 

protected void renderHeaderCellContent ( )

转载于:https://my.oschina.net/u/3359744/blog/860815