antonyz89/yii2-toggle-column

1.0.0 2022-01-07 04:03 UTC

Requires

• php: >=7.2
• yiisoft/yii2: ^2

BSD-3-Clause

• Antony Gabriel

• extension
• grid
• widget
• column
• toggle
• yii2
• gridview
• toggle column
• antonyz89

README

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist antonyz89/yii2-toggle-column dev-main
composer require antonyz89/yii2-toggle-column dev-main

or add

"antonyz89/yii2-toggle-column": "dev-main"

to the require section of your composer.json file.

USAGE

⚠️ In some cases you may need to add /toggle-column/parse/save to your urlManager.

common/config/main.php

use antonyz89\togglecolumn\Module as ToggleColumnModule;
use yii\i18n\PhpMessageSource;

return [
    // ...
    'modules' => [
        'toggle-column' => [
            'class' => ToggleColumnModule::class,
        ],
    ],
    'i18n' => [
        'translations' => [
            'tc' => [ // Toggle Column
                'class' => PhpMessageSource::class,
                'basePath' => '@antonyz89/togglecolumn/messages',
            ],
        ],
    ],
    // ...
];

After you downloaded, the last thing you need to do is updating your database schema by applying the migration:

$ php yii migrate/up --migrationPath=@antonyz89/togglecolumns/migrations

or copy the file migrations/m220105_225647_create_toggle_column_table.php to your console/migrations directory.

Example

<?php

$columns = [
    'code',
    [
        'attribute' => 'partner_id',
        'value' => 'partner',
        'visible' => false // will not be displayed in ToggleColumn widget either
    ],
    [
        'attribute' => 'customer',
    ],
    [
        'attribute' => 'status',
        'value' => 'statusAsText'
    ],
];

?>

<?=
GridView::widget([
    // ...
    'toolbar' => [
        ToggleColumn::widget([
            'model' => Reserve::class,
            'columns' => $columns,
        ]),
    ],
    // ...
])
?>