thrieu/yii2-grid-view-state

Save filters from GridView to session, keep the filter state between pages.

yii2-grid-view-state

Save filters from GridView to session, keep filter state between pages., _(*1)

Features

1. Very flexible. Separate setting and getting.
2. Setting via behavior.
3. Determines uniqueness by action's route and a customizable ID.

Installation

To install, either run, _(*2)

php composer.phar require --prefer-dist thrieu/yii2-grid-view-state "dev-master"

or add, _(*3)

"thrieu/yii2-grid-view-state": "dev-master"

to the require section of your composer.json file and then run composer update., _(*4)

Usage

Step 1

Create \app\widgets\Gridview.php, _(*5)

Extend GridView class, simply implement FilterStateInterface and FilterStateTrait., _(*6)

namespace \app\widgets;

use thrieu\grid\FilterStateInterface;
use thrieu\grid\FilterStateTrait;

class GridView extends \yii\grid\GridView implements FilterStateInterface {
    use FilterStateTrait;
}

Step 2

Attach the filter behavior to your GridView widget., _(*7)

use \app\widgets\Gridview;
...

GridView::widget([
...
    'as filterBehavior' => \thrieu\grid\FilterStateBehavior::className(),
...
]);

Step 3

Update \app\models\xxxSearch.php, _(*8)

To get the params which is merged with GridView state params and GET query params, and then set it to filter model and DataProvider., _(*9)

// DataProvider
$dataProvider = new ActiveDataProvider([
    'query' => $query,
    'pagination' => [
        'params' => \app\widgets\GridView::getMergedFilterStateParams(),
    ],
    'sort' => [
        'params' => \app\widgets\GridView::getMergedFilterStateParams(),
    ],
]);
// Filter model
$this->load(\app\widgets\GridView::getMergedFilterStateParams());

Enjoy it., _(*10)

Clear state

Update \app\controllers\xxxController.php, _(*11)

Add ClearFilterStateBehavior to behaviors() of your controller., _(*12)

    public function behaviors()
    {
        return [
            ...
            'clearFilterState' => \thrieu\grid\ClearFilterStateBehavior::className(),
            ...
        ];
    }

And then add a form to your frontend page., _(*13)

        $form = Html::beginForm();
        $form .= Html::hiddenInput('clear-state', '1');
        $form .= Html::hiddenInput('redirect-to', '');
        $form .= Button::widget([
            'label' => Yii::t('app', 'Reset filter'),
        ]);
        $form .= Html::endForm();
        echo $form;

get filter settings by route

$filterData = GridView::getMergedFilterStateParams(null, null, 'delivery/cmd-delivery/index');
$model->load($filterData);

Prev Next model for view screens

for gridview set usepreview = true, _(*14)

use \app\widgets\Gridview;
...

GridView::widget([
...
    'as filterBehavior' => \thrieu\grid\FilterStateBehavior::class,
    'usePrevNext' => true,
...
]);

for prev next buttons easy get previousa nd next model keys values, _(*15)

        $prevNext = new PrevNextPage('cars/in-way/index');

        if ($prevId = $prevNext->getPrevPage($model->id)) {
            echo ThButton::widget([
                    'tooltip' => Yii::t('blankonthema', 'Previous record'),
                    'link' => [
                        'view',
                        'id' => $prevId,
                    ],
                    'icon' => 'arrow-left',
                    'type' => ThButton::TYPE_DEFAULT
                ]);
        }
        if ($nextId = $prevNext->getNextPage($this->id)) {
            echo ThButton::widget([
                'tooltip' => Yii::t('blankonthema', 'Next record'),
                'link' => [
                    'view',
                    'id' => $nextId,
                ],
                'icon' => 'arrow-right',
                'type' => ThButton::TYPE_DEFAULT
            ]);
        }