PHP Класс yii\grid\ActionColumn

To add an ActionColumn to the gridview, add it to the [[GridView::columns|columns]] configuration as follows: php 'columns' => [ ... [ 'class' => 'yii\grid\ActionColumn', you may configure additional properties here ], ]
С версии: 2.0
Автор: Qiang Xue ([email protected])
Наследование: extends Column
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$buttonOptions html options to be applied to the [[initDefaultButton()|default button]].
$buttons button rendering callbacks. The array keys are the button names (without curly brackets), and the values are the corresponding button rendering callbacks. The callbacks should use the following signature: php function ($url, $model, $key) { return the button HTML code } where $url is the URL that the column creates for the button, $model is the model object being rendered for the current row, and $key is the key of the model in the data provider array. You can add further conditions to the button, for example only display it, when the model is editable (here assuming you have a status field that indicates that): php [ 'update' => function ($url, $model, $key) { return $model->status === 'editable' ? Html::a('Update', $url) : ''; }, ],
$controller the ID of the controller that should handle the actions specified here. If not set, it will use the currently active controller. This property is mainly used by [[urlCreator]] to create URLs for different actions. The value of this property will be prefixed to each action name to form the route of the action.
$headerOptions
$template the template used for composing each cell in the action column. Tokens enclosed within curly brackets are treated as controller action IDs (also called *button names* in the context of action column). They will be replaced by the corresponding button rendering callbacks specified in [[buttons]]. For example, the token {view} will be replaced by the result of the callback buttons['view']. If a callback cannot be found, the token will be replaced with an empty string. As an example, to only have the view, and update button you can add the ActionColumn to your GridView columns as follows: php ['class' => 'yii\grid\ActionColumn', 'template' => '{view} {update}'],
$urlCreator a callback that creates a button URL using the specified model information. The signature of the callback should be the same as that of ActionColumn::createUrl Since 2.0.10 it can accept additional parameter, which refers to the column instance itself: php function (string $action, mixed $model, mixed $key, integer $index, ActionColumn $this) { return string; } If this property is not set, button URLs will be created using ActionColumn::createUrl.
$visibleButtons visibility conditions for each button. The array keys are the button names (without curly brackets), and the values are the boolean true/false or the anonymous function. When the button name is not specified in this array it will be shown by default. The callbacks must use the following signature: php function ($model, $key, $index) { return $model->status === 'editable'; } Or you can pass a boolean value: php [ 'update' => \Yii::$app->user->can('update'), ],

Открытые методы

Метод Описание
createUrl ( string $action, ActiveRecord $model, mixed $key, integer $index ) : string Creates a URL for the given action and model.
init ( )

Защищенные методы

Метод Описание
initDefaultButton ( string $name, string $iconName, array $additionalOptions = [] ) Initializes the default button rendering callback for single button
initDefaultButtons ( ) Initializes the default button rendering callbacks.
renderDataCellContent ( $model, $key, $index )

Описание методов

createUrl() публичный Метод

This method is called for each button and each row.
public createUrl ( string $action, ActiveRecord $model, mixed $key, integer $index ) : string
$action string the button name (or action ID)
$model yii\db\ActiveRecord the data model
$key mixed the key associated with the data model
$index integer the current row index
Результат string the created URL

init() публичный Метод

public init ( )

initDefaultButton() защищенный Метод

Initializes the default button rendering callback for single button
С версии: 2.0.11
protected initDefaultButton ( string $name, string $iconName, array $additionalOptions = [] )
$name string Button name as it's written in template
$iconName string The part of Bootstrap glyphicon class that makes it unique
$additionalOptions array Array of additional options

initDefaultButtons() защищенный Метод

Initializes the default button rendering callbacks.
protected initDefaultButtons ( )

renderDataCellContent() защищенный Метод

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

Описание свойств

$buttonOptions публичное свойство

html options to be applied to the [[initDefaultButton()|default button]].
С версии: 2.0.4
public $buttonOptions

$buttons публичное свойство

button rendering callbacks. The array keys are the button names (without curly brackets), and the values are the corresponding button rendering callbacks. The callbacks should use the following signature: php function ($url, $model, $key) { return the button HTML code } where $url is the URL that the column creates for the button, $model is the model object being rendered for the current row, and $key is the key of the model in the data provider array. You can add further conditions to the button, for example only display it, when the model is editable (here assuming you have a status field that indicates that): php [ 'update' => function ($url, $model, $key) { return $model->status === 'editable' ? Html::a('Update', $url) : ''; }, ],
public $buttons

$controller публичное свойство

the ID of the controller that should handle the actions specified here. If not set, it will use the currently active controller. This property is mainly used by [[urlCreator]] to create URLs for different actions. The value of this property will be prefixed to each action name to form the route of the action.
public $controller

$headerOptions публичное свойство

public $headerOptions

$template публичное свойство

the template used for composing each cell in the action column. Tokens enclosed within curly brackets are treated as controller action IDs (also called *button names* in the context of action column). They will be replaced by the corresponding button rendering callbacks specified in [[buttons]]. For example, the token {view} will be replaced by the result of the callback buttons['view']. If a callback cannot be found, the token will be replaced with an empty string. As an example, to only have the view, and update button you can add the ActionColumn to your GridView columns as follows: php ['class' => 'yii\grid\ActionColumn', 'template' => '{view} {update}'],
См. также: buttons
public $template

$urlCreator публичное свойство

a callback that creates a button URL using the specified model information. The signature of the callback should be the same as that of ActionColumn::createUrl Since 2.0.10 it can accept additional parameter, which refers to the column instance itself: php function (string $action, mixed $model, mixed $key, integer $index, ActionColumn $this) { return string; } If this property is not set, button URLs will be created using ActionColumn::createUrl.
public $urlCreator

$visibleButtons публичное свойство

visibility conditions for each button. The array keys are the button names (without curly brackets), and the values are the boolean true/false or the anonymous function. When the button name is not specified in this array it will be shown by default. The callbacks must use the following signature: php function ($model, $key, $index) { return $model->status === 'editable'; } Or you can pass a boolean value: php [ 'update' => \Yii::$app->user->can('update'), ],
С версии: 2.0.7
public $visibleButtons