PHPTime

Как настроить кнопки CButtonColumn в CGridView на Yii 1.1

В Yii 1.1 столбец CButtonColumn выводит действия для каждой строки CGridView. Разберём, как менять встроенные кнопки, добавлять свои и передавать нужный идентификатор в контроллер. Для удаления отдельно покажем вариант с POST-формой и CSRF-защитой.

Где настраивается столбец действий

Добавьте конфигурацию с 'class' => 'CButtonColumn' в массив columns виджета CGridView. Положение элемента в массиве определяет место столбца в таблице. По умолчанию внутри столбца идут три действия: {view}, {update} и {delete}. Первые два открывают страницы просмотра и редактирования, а встроенный обработчик удаления отправляет AJAX-запрос методом POST.

CButtonColumn относится к Yii 1.1. На конец 2026 года при работе с PHP 8.3–8.5 проверяйте конкретную версию фреймворка, расширения и код приложения на той версии PHP, которая используется в окружении. В примерах конфигурация представления использует короткий синтаксис массивов и замыкания. В отдельном PHP-файле контроллера можно включить declare(strict_types=1) и объявить тип возвращаемого значения. Параметры HTTP-запроса при этом по-прежнему нужно валидировать явно.

Как поменять порядок, подписи и внешний вид

Свойство template задаёт порядок действий. Чтобы убрать просмотр, исключите {view} из шаблона. Для одной-двух правок встроенной кнопки достаточно свойств с её префиксом. У update это updateButtonLabel, updateButtonImageUrl, updateButtonOptions и updateButtonUrl. У просмотра и удаления используются префиксы viewButton и deleteButton.

PHP
[
    'class' => 'CButtonColumn',
    'header' => 'Действия',
    'template' => '{update} {view}',
    // Пустой путь включает текстовую ссылку.
    'updateButtonImageUrl' => false,
    'updateButtonLabel' => 'Редактировать',
    'updateButtonOptions' => ['class' => 'update grid-action'],
    'viewButtonImageUrl' => false,
    'viewButtonLabel' => 'Открыть',
],

Этот фрагмент вставляется как элемент массива columns. Атрибуты из updateButtonOptions относятся к ссылке, а для оформления ячеек служит htmlOptions самого столбца. Если у действия задано изображение, label становится его альтернативным текстом. Подсказку для ссылки задавайте через options['title']. Короткая видимая подпись удобна и без наведения.

Как добавить свою кнопку через buttons

Задайте идентификатор действия в template и добавьте запись с тем же ключом в buttons. Через этот массив можно переопределять и стандартные действия: например, добавить visible для update. В следующем примере контроллер orders обслуживает таблицу заказов, а actionHistory показывает историю выбранной записи.

PHP
[
    'class' => 'CButtonColumn',
    'template' => '{view} {history}',
    'buttons' => [
        'history' => [
            'label' => 'История',
            'url' => static function (int $row, Order $data): string {
                // Ключ записи сохраняется при сортировке и пагинации.
                return Yii::app()->createUrl('orders/history', [
                    'id' => $data->getPrimaryKey(),
                ]);
            },
            'visible' => static fn (int $row, Order $data): bool =>
                Yii::app()->user->checkAccess('viewOrderHistory', ['order' => $data]),
            'options' => ['class' => 'grid-action'],
        ],
    ],
],

Для этого примера нужен CActiveDataProvider с моделью Order и настроенное разрешение viewOrderHistory. В обратные вызовы url и visible столбец передаёт номер строки $row и сами данные $data. У CSqlDataProvider строка представлена массивом, а у CArrayDataProvider форма строки зависит от переданного набора. Если провайдер отдаёт массивы, используйте параметр array $data и обращение $data['id']. Номер строки зависит от вывода таблицы, поэтому для маршрута берите первичный ключ. Для модели с составным ключом передавайте его поля отдельными параметрами маршрута.

В Yii 1.1 настройки url и visible также принимают строковые PHP-выражения. В новом коде замыкания позволяют IDE и статическому анализатору видеть типы и обращения к модели. Скрытие ссылки через visible управляет интерфейсом. Контроллер истории должен самостоятельно проверить право на просмотр перед выдачей данных.

Как подтверждать удаление

Для встроенного удаления задайте deleteConfirmation в конфигурации столбца, например строкой 'Удалить заказ?'. Она применяется ко всем строкам и передаётся клиентскому обработчику. Если нужен номер заказа, поместите его в data-* атрибут строки или элемента действия и прочитайте в обработчике. Порядок ячеек при этом можно менять без поломки подтверждения. Одинарные и двойные кавычки в пользовательских данных обрабатывайте средствами HTML- или JSON-кодирования при выводе, без подстановки значений в исходный JavaScript.

У произвольного действия параметр click принимает JavaScript-функцию в виде строки. Для более сложного поведения удобнее подключить обработчик в отдельном JS-файле и делегировать событие стабильному контейнеру. CGridView может перерисовать таблицу после фильтрации или перелистывания, поэтому прямые обработчики на старых элементах пропадут. При замене встроенного click у delete за отправку и обработку результата отвечает ваш код.

Как удалить запись через POST с CSRF-защитой

Встроенная кнопка отправляет POST, но при включённой CSRF-защите запросу также нужен токен. Если для удаления достаточно обычной отправки формы с возвратом к списку, выведите отдельный столбец CDataColumn рядом с CButtonColumn. Уберите {delete} из шаблона последнего. При включённом request.enableCsrfValidation метод CHtml::form() добавит скрытое поле с токеном в POST-форму.

PHP
[
    'class' => 'CDataColumn',
    'header' => 'Удаление',
    'type' => 'raw',
    'value' => static function (Order $data, int $row): string {
        if (!Yii::app()->user->checkAccess('deleteOrder', ['order' => $data])) {
            return '';
        }

        // CHtml формирует HTML и экранирует значения атрибутов.
        return CHtml::form(['orders/delete'], 'post')
            . CHtml::hiddenField('id', (string) $data->getPrimaryKey(), ['id' => false])
            . CHtml::submitButton('Удалить', ['class' => 'order-delete'])
            . CHtml::endForm();
    },
],

У выражения CDataColumn::value данные идут первым аргументом, а номер строки вторым. Формы внутри строк подходят для таблицы, которая сама находится вне формы. Подтверждение для этого варианта подключается к событию submit формы. Так оно сработает и при отправке с клавиатуры.

В контроллере проверьте HTTP-метод, идентификатор и право на конкретную запись. Пример рассчитан на модель Order с положительным целочисленным ключом. При включённой CSRF-валидации Yii проверит токен до вызова действия.

PHP
<?php

declare(strict_types=1);

class OrdersController extends Controller
{
    public function actionDelete(): void
    {
        $request = Yii::app()->request;
        if (!$request->getIsPostRequest()) {
            header('Allow: POST');
            throw new CHttpException(405, 'Используйте POST.');
        }

        $input = $request->getPost('id');
        $id = is_string($input)
            ? filter_var($input, FILTER_VALIDATE_INT, ['options' => ['min_range' => 1]])
            : false;
        if ($id === false) {
            throw new CHttpException(400, 'Некорректный номер заказа.');
        }

        $order = Order::model()->findByPk($id);
        if ($order === null) {
            throw new CHttpException(404, 'Заказ не найден.');
        }
        if (!Yii::app()->user->checkAccess('deleteOrder', ['order' => $order])) {
            throw new CHttpException(403, 'Удаление недоступно.');
        }

        // Модель может отменить удаление в beforeDelete().
        if (!$order->delete()) {
            throw new CHttpException(409, 'Не удалось удалить заказ.');
        }
        $this->redirect(['index']);
    }
}

Чек-лист перед выпуском

  • Проверьте порядок действий и совпадение ключей template и buttons. Для каждой иконки задайте понятную подпись.
  • Откройте действие после сортировки, фильтрации и перехода на следующую страницу. Оно должно работать с ключом выбранной записи.
  • Проверьте таблицу под пользователями с разными правами и убедитесь, что контроллер отклоняет прямой запрос без разрешения.
  • Для удаления проверьте обычный POST, запрос без CSRF-токена, GET и попытку удалить отсутствующую запись.
  • Повторите проверку на целевой версии PHP с включённым журналом ошибок. Особое внимание уделите сигнатурам замыканий и типам данных от провайдера.

Частые вопросы

Как убрать кнопку удаления из CButtonColumn?

Укажите шаблон {view} {update}. Для скрытия только в отдельных строках задайте видимость через buttons['delete']['visible'] и сохраните проверку прав в контроллере.

Почему своя кнопка CButtonColumn не отображается?

Проверьте совпадение её идентификатора в template и buttons. Если задан visible, проверьте его результат для текущей строки и тип данных, который возвращает провайдер.

Почему после включения CSRF кнопка удаления возвращает ошибку 400?

Проверьте, передаёт ли обработчик удаления CSRF-токен в POST. Если используется обычная форма, CHtml::form() добавляет токен при включённой CSRF-валидации.

Справка по теме

Ещё в разделе «Yii»

Расширения Yii 2: где искать и как устанавливать через Composer

Где искать расширения Yii 2, как проверить совместимость с PHP 8.3–8.5 и выбрать пакет. Установка через Composer, настройка и примеры популярных расширений.

7 мин

Yii 2 сегодня: установка, PHP 8.x и выбор фреймворка

Как установить Yii 2 на PHP 8.3–8.5, выбрать шаблон Basic или Advanced, проверить зависимости и решить, когда перейти на Yii 3 или Laravel.

6 мин

Миграция с Yii 1.1 на Yii 2: как перенести действующий проект

Как перенести проект с Yii 1.1 на Yii 2: пространства имён, ActiveRecord, формы, виджеты и конфигурация. План миграции с тестами и откатом.

7 мин

Как настроить автодополнение scope-методов ActiveRecord в Yii2

Настройте автодополнение scope-методов Yii2 в PhpStorm: создайте класс ActiveQuery, типизируйте find() и используйте фильтры в связях hasOne и hasMany.

7 мин