Класс yii\grid\ActionColumn

ActionColumn — это столбец для виджета yii\grid\GridView, который отображает кнопки для просмотра и управления элементами.

Чтобы добавить ActionColumn в gridview, добавьте его в конфигурацию columns следующим образом:

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

Дополнительную информацию и сведения об использовании ActionColumn см. в статье руководства по виджетам данных.

Публичные свойства

Публичные методы

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

Подробное описание свойств

$buttonOptions общее свойство (доступно с версии 2.0.4)

Параметры HTML, применяемые к кнопке по умолчанию.

public array $buttonOptions = []

$buttons общее свойство

Обратные вызовы для отображения кнопок. Ключи массива — имена кнопок (без фигурных скобок), а значения — соответствующие обратные вызовы для отображения кнопок. Обратные вызовы должны иметь следующий вид:

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

где $url — URL, созданный столбцом для кнопки, $model — объект модели, отображаемый для текущей строки, и $key — ключ модели в массиве поставщика данных.

Вы можете добавить дополнительные условия для кнопки, например, отображать её только при редактировании модели (предполагается, что у вас есть поле статуса, которое это указывает):

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

public array $buttons = []

$controller общее свойство

ID контроллера, который должен обрабатывать указанные здесь действия. Если не указано, будет использован текущий активный контроллер. Это свойство в основном используется $urlCreator для создания URL-адресов для различных действий. Значение этого свойства будет добавлено как префикс к каждому имени действия для формирования маршрута действия.

public string $controller = null

$headerOptions общее свойство

Атрибуты HTML для тега ячейки заголовка.

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

$template общее свойство

Шаблон, используемый для составления каждой ячейки в столбце действий. Токены, заключенные в фигурные скобки, интерпретируются как идентификаторы действий контроллера (также называемые *именами кнопок* в контексте столбца действий). Они будут заменены соответствующими обратными вызовами для отображения кнопок, указанными в $buttons. Например, токен {view} будет заменён результатом обратного вызова buttons['view']. Если обратный вызов не найден, токен будет заменён пустой строкой.

Например, чтобы отобразить только кнопки «Просмотр» и «Редактировать», вы можете добавить ActionColumn в столбцы GridView следующим образом:

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

См. также $buttons.

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

$urlCreator общее свойство

Обратный вызов, создающий 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 общее свойство (доступно с версии 2.0.7)

Условия видимости каждой кнопки. Ключи массива — имена кнопок (без фигурных скобок), а значения — булево значение true/false или анонимная функция. Если имя кнопки не указано в этом массиве, она будет отображаться по умолчанию. Обратные вызовы должны иметь следующий вид:

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

Или вы можете передать булево значение:

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

public array $visibleButtons = []

Подробное описание методов