Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asaarashi/yii2-grid-view-state
Yii2 extension. Save filters from GridView to session, keep filter state between pages.
https://github.com/asaarashi/yii2-grid-view-state
gridview yii2
Last synced: 3 months ago
JSON representation
Yii2 extension. Save filters from GridView to session, keep filter state between pages.
- Host: GitHub
- URL: https://github.com/asaarashi/yii2-grid-view-state
- Owner: asaarashi
- License: apache-2.0
- Created: 2016-01-07T08:33:51.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-01-14T11:43:26.000Z (almost 5 years ago)
- Last Synced: 2024-09-27T14:21:00.121Z (3 months ago)
- Topics: gridview, yii2
- Language: PHP
- Homepage:
- Size: 30.3 KB
- Stars: 13
- Watchers: 5
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yii2-grid-view-state
Save filters from GridView to session, keep filter state between pages.
## 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
```
php composer.phar require --prefer-dist thrieu/yii2-grid-view-state "dev-master"
```
or add
```
"thrieu/yii2-grid-view-state": "dev-master"
```
to the require section of your `composer.json` file and then run `composer update`.
## Usage
### Step 1
Create \app\widgets\Gridview.php
Extend `GridView` class, simply implement `FilterStateInterface` and `FilterStateTrait`.
```php
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.
```php
use \app\widgets\Gridview;
...
GridView::widget([
...
'as filterBehavior' => \thrieu\grid\FilterStateBehavior::className(),
...
]);
```
### Step 3
Update \app\models\xxxSearch.php
To get the params which is merged with GridView state params and GET query params, and then set it to filter model and `DataProvider`.
```php
// 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.
### Clear state
Update \app\controllers\xxxController.php
Add `ClearFilterStateBehavior` to `behaviors()` of your controller.
```php
public function behaviors()
{
return [
...
'clearFilterState' => \thrieu\grid\ClearFilterStateBehavior::className(),
...
];
}
```
And then add a form to your frontend page.
```php
$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
```php
$filterData = GridView::getMergedFilterStateParams(null, null, 'delivery/cmd-delivery/index');
$model->load($filterData);
```
### Prev Next model for view screens
for gridview set usepreview = true
```php
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
```php
$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
]);
}
```