yii2mod / yii2-toggle-column

Provides a toggle data column and action for Yii Framework 2.0

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Toggle Column Widget for Yii 2


Provides a toggle data column and action for Yii Framework 2.0

Latest Stable Version Total Downloads License Build Status

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist yii2mod/yii2-toggle-column "*"

or add

"yii2mod/yii2-toggle-column": "*"

to the require section of your composer.json file.

Usage

  1. In your GridView columns section:
[
    'class' => '\yii2mod\toggle\ToggleColumn',
    'attribute' => 'active',
],
  1. Add toggle action to your controller as follows:
public function actions()
{
   return [
        'toggle' => [
            'class' => \yii2mod\toggle\actions\ToggleAction::class,
            'modelClass' => 'path\to\your\Model',
            // if you want to use flash messages
            'setFlash' => true,
            'flashSuccess' => 'Success message',
            'flashError' => 'Error message',
            'redirect' => 'some-redirect-url',
            // if you want to use custom code before saving the model
            'preProcess' => function() {
                // your custom code
            }
        ],
    ];
}

About

Provides a toggle data column and action for Yii Framework 2.0

License:MIT License


Languages

Language:PHP 100.0%