Class yii\grid\ActionColumn

所有类 | 属性 | 方法

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

 

ActionColumn是网格 yii\grid\GridView显示数据表格的列小部件显示按钮用于查看和操作的项目。

添加一个ActionColumn gridview,将其添加到列配置如下:

'columns' => [
    // ...
    [
        'class' => ActionColumn::className(),
        // you may configure additional properties here
    ],
]

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

公共属性

隐藏继承属性

属性	类型	描述	定义在
$buttonOptions	array	Html选项适用于默认按钮。	yii\grid\ActionColumn
$buttons	array	按钮呈现回调。	yii\grid\ActionColumn
$controller	string	控制器应该处理的ID指定的动作	yii\grid\ActionColumn
$headerOptions			yii\grid\ActionColumn
$template	string	模板用于写操作列中的每个单元格。	yii\grid\ActionColumn
$urlCreator	callable	一个回调URL创建一个按钮使用指定的模型信息。	yii\grid\ActionColumn
$visibleButtons	array	为每个按钮可见性条件	yii\grid\ActionColumn

公共方法

隐藏继承方法

方法	描述	定义在
createUrl()	为给定的行动和创建一个URL模式。	yii\grid\ActionColumn
init()		yii\grid\ActionColumn

受保护的方法

隐藏继承方法

方法	描述	定义在
initDefaultButton()	初始化默认按钮呈现单一按钮回调	yii\grid\ActionColumn
initDefaultButtons()	初始化默认按钮呈现回调.	yii\grid\ActionColumn
renderDataCellContent()		yii\grid\ActionColumn

属性详情

$buttonOptions public property （可用自版本 2.0.4）

Html选项适用于默认按钮。

public array $buttonOptions = []

$buttons public property

按钮呈现回调。数组键按钮名称(没有花括号),并呈现回调函数值对应的按钮。回调应使用以下签名:

function ($url, $model, $key) {
    // return the button HTML code
}

$urll的url的列创建按钮,$model是模型对象被呈现为当前行,关键是 $key模型的数据提供商数组

您可以添加进一步条件按钮,例如只显示,当模型是可编辑(这里假设你有一个状态字段表明):

[
    'update' => function ($url, $model, $key) {
        return $model->status === 'editable' ? Html::a('Update', $url) : '';
    },
],

public array $buttons = []

$controller public property

The ID of The控制办公室应handle The actions适于出版物。世界性考试和测验科,将使用目前积极控制办公室。这说明这一财产$urlCreator,创造URLs各行动。这一法律中对每项prefixed剥夺财产要to The form公路采取行动。

public string $controller = null

$headerOptions public property

public $headerOptions = ['class' => 'action-column']

$template public property

模板用于写操作列中的每个单元格。令牌在花括号被当作控制器动作id(也称为按钮名称的行动列)。他们将被相应的按钮取代美元呈现回调函数中指定的按钮。例如,令牌} {视图将被回调的结果取代按钮(“视图”)。如果不能找到一个回调,令牌将被替换为一个空字符串。

作为一个例子,只有视图,并更新按钮可以添加ActionColumn显示数据表格列如下:

['class' => 'yii\grid\ActionColumn', 'template' => '{view} {update}'],

参见 $buttons.

public string $template = '{view} {update} {delete}'

$urlCreator public property

一个回调URL创建一个按钮使用指定的模型信息。回调的签名应该一样createUrl 2.0.10以来()它可以接受额外的参数,指列实例本身:

function (string $action, mixed $model, mixed $key, integer $index, ActionColumn $this) {
    //return string;
}

如果不设置这个属性,按钮将创建url使用 createUrl().

public callable $urlCreator = null

$visibleButtons public property （可用自版本 2.0.7）

为每个按钮可见性条件。数组键按钮名称(没有花括号),和布尔值是true / false或匿名函数。当按钮名称没有指定在这个数组默认将显示。回调函数必须使用下面的签名:

function ($model, $key, $index) {
    return $model->status === 'editable';
}

Or you can pass a boolean value:

[
    'update' => \Yii::$app->user->can('update'),
],

public array $visibleButtons = []

方法详情

createUrl() public 方法

为给定的行动和创建一个URL模式。

调用此方法对于每一个按钮,每一行.

public string createUrl ( $action, $model, $key, $index )
$action	string	按钮的名称(或动作ID)
$model	yii\db\ActiveRecord	数据模型
$key	mixed	与数据模型相关联的关键
$index	integer	当前行索引
return	string	创建URL

init() public 方法

 

public void init ( )

initDefaultButton() protected 方法 （可用自版本 2.0.11）

初始化默认按钮呈现单一按钮回调

protected void initDefaultButton ( $name, $iconName, $additionalOptions = [] )
$name	string	按钮的名字写在模板
$iconName	string	引导glyphicon类,使它的独一无二的
$additionalOptions	array	补充备选办法的结论

initDefaultButtons() protected 方法

初始化默认按钮呈现回调。

protected void initDefaultButtons ( )

renderDataCellContent() protected 方法

 

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

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