yii2-grid
Simple extended yii\grid\GridView., (*1)
Features:, (*2)
- Wrapping GridView in Bootstrap3 Panel.
- Ability changing size of page.
- Column of 'Total' with ability using custom formulas.
- Hard-header.
- Custom tags of template the GridView.
- Ability disabling/enabling/sort visible columns of real-time.
- Ability resize width of columns.
- Keepping last modified page sizer.
, (*3)
, (*4)
, (*5)
Installation
The preferred way to install this extension is through composer., (*6)
Either run, (*7)
php composer.phar require --prefer-dist bupy7/yii2-grid "*"
or add, (*8)
"bupy7/yii2-grid": "*"
to the require section of your composer.json file., (*9)
Usage
Simple usage
use bupy7\grid\GridView;
echo GridView::widget([
'dataProvider' => $dataProvider,
'filterModel' => $searchModel,
'columns' => [
['class' => 'yii\grid\SerialColumn'],
['class' => 'yii\grid\CheckboxColumn'],
'attribute1',
'attribute2',
],
]);
Adding your view:, (*10)
use bupy7\grid\GridView;
$panelHeadingTemplate = <<<HTML
<div class="col-md-6">{controls}</div>
<div class="col-md-6 text-right">{pageSizer}</div>
<div class="clearfix"></div>
HTML;
echo GridView::widget([
'customTags' => [
'controls' => $this->render('_controls'),
],
'panelHeadingTemplate' => $panelHeadingTemplate,
'dataProvider' => $dataProvider,
'filterModel' => $searchModel,
'columns' => [
['class' => 'yii\grid\SerialColumn'],
['class' => 'yii\grid\CheckboxColumn'],
'attribute1',
'attribute2',
],
]);
Adding your _controls view:, (*11)
<?php
use yii\helpers\Html;
use yii\helpers\Json;
?>
<?= Html::a(Yii::t('app', 'DELETE'), ['delete'], [
'id' => 'all-delete',
'class' => 'btn btn-danger',
'title' => Yii::t('app', 'DELETE'),
]); ?>
<?php
$message = Json::encode(Yii::t('app', 'CONFIRM_DELETE_SELECTED_ITEMS'));
$js = <<<JS
var grid = $('#all-delete').closest('.grid-view');
$('#all-delete').on('click', function() {
th = $(this);
yii.confirm($message, function() {
$.post(th.attr('href'), {ids: grid.yiiGridView('getSelectedRows')});
});
return false;
});
JS;
$this->registerJs($js);
Adding your controller:, (*12)
public function actionDelete($id = null)
{
if ($id === null) {
$ids = (array)Yii::$app->request->post('ids');
} else {
$ids = (array)$id;
}
for ($i = 0; $i != count($ids); $i++) {
$this->findModel($ids[$i])->delete();
}
return $this->redirect(['index']);
}
Adding ability change visible columns
Via session
Override session component:, (*13)
use bupy7\grid\interfaces\StorageInterface;
/**
* @inheritdoc
*/
class Session extends \yii\web\Session implements StorageInterface
{
}
Adding your config of application:, (*14)
'components' => [
'gridManager' => [
'class' => 'bupy7\grid\components\Manager',
'storage' => 'session',
],
]
Adding your controller:, (*15)
use bupy7\grid\actions\VisibleColumnsAction;
use yii\helpers\Url;
public function actions()
{
return parent::actions() + [
'visible-columns' => [
'class' => VisibleColumnsAction::className(),
'gridId' => 'example-grid',
],
];
}
public function actionIndex()
{
Url::remember();
$searchModel = new ExampleSearch();
$dataProvider = $searchModel->search(Yii::$app->request->queryParams);
$visibleColumns = Yii::$app->gridManager->getVisibleColumns('example-grid');
if ($visibleColumns === false) {
$visibleColumns = array_keys($searchModel->gridColumnsList());
}
return $this->render('index', [
'searchModel' => $searchModel,
'dataProvider' => $dataProvider,
'visibleColumns' => $visibleColumns,
]);
}
Adding your search model:, (*16)
public function gridColumnsList()
{
return [
'attribute1' => 'Label of attribute1',
'attribute2' => 'Label of attribute2',
];
}
Adding your view:, (*17)
use bupy7\grid\GridView;
$panelHeadingTemplate = <<<HTML
<div class="col-md-6">{controls}</div>
<div class="col-md-6 text-right">{pageSizer}</div>
<div class="clearfix"></div>
HTML;
echo GridView::widget([
'customTags' => [
'controls' => $this->render('_controls', [
'visibleColumns' => $visibleColumns,
'searchModel' => $searchModel,
]),
],
'panelHeadingTemplate' => $panelHeadingTemplate,
'dataProvider' => $dataProvider,
'filterModel' => $searchModel,
'visibleColumns' => $visibleColumns,
'columns' => [
['class' => 'yii\grid\SerialColumn'],
'attribute1',
'attribute2',
],
]);
Adding your _controls view:, (*18)
use bupy7\grid\widgets\VisibleColumnsWidget;
= VisibleColumnsWidget::widget([
'gridId' => 'example-grid',
'modalOptions' => [
'header' => Yii::t('app', 'SELECT_COLUMNS'),
'toggleButton' => [
'label' => Yii::t('app', 'SELECT_COLUMNS'),
'class' => 'btn btn-default',
],
],
'actionForm' => ['visible-columns'],
'submitBtnLabel' => Yii::t('app', 'APPLY'),
'columnsList' => $searchModel->gridColumnsList(),
]); ?>
Adding ability resize width of columns
Via session
Override session component:, (*19)
use bupy7\grid\interfaces\StorageInterface;
/**
* @inheritdoc
*/
class Session extends \yii\web\Session implements StorageInterface
{
}
Adding your config of application:, (*20)
'components' => [
'gridManager' => [
'class' => 'bupy7\grid\components\Manager',
'storage' => 'session',
],
]
Adding your controller:, (*21)
use bupy7\grid\actions\ResizableColumnsAction;
use yii\helpers\Url;
public function actions()
{
return parent::actions() + [
'resizable-columns' => [
'class' => ResizableColumnsAction::className(),
'gridId' => 'example-grid',
],
];
}
public function actionIndex()
{
Url::remember();
$searchModel = new ExampleSearch();
$dataProvider = $searchModel->search(Yii::$app->request->queryParams);
$resizableColumns = Yii::$app->gridManager->getResizableColumns('example-grid');
return $this->render('index', [
'searchModel' => $searchModel,
'dataProvider' => $dataProvider,
'resizableColumns' => $resizableColumns,
'resizableColumnsUrl' => ['resizable-columns'],
]);
}
Adding your view:, (*22)
use bupy7\grid\GridView;
echo GridView::widget([
'resizableColumns' => $resizableColumns,
'resizableColumnsUrl' => $resizableColumnsUrl,
'dataProvider' => $dataProvider,
'filterModel' => $searchModel,
'columns' => [
['class' => 'yii\grid\SerialColumn'],
'attribute1',
'attribute2',
],
]);
Adding ability display all rows of grid
echo GridView::widget([
...
'pageSizer' => [
'availableSizes' => [20 => '20', 50 => '50', 100 => '100', -1 => Yii::t('app', 'ALL_PAGES')],
],
...
]);
And change $pageSizeLimit in your model:, (*23)
$dataProvider = new ActiveDataProvider([
'query' => $query,
'pagination' => [
'pageSizeLimit' => [-1, 100],
],
]);
More information to bupy7\grid\LinkPageSizer., (*24)
Adding total column of grid
Added sum total:, (*25)
[
'class' => 'bupy7\grid\TotalColumn',
'format' => 'currency',
'attribute' => 'total_cost',
]
More information to bupy7\grid\TotalColumn., (*26)
More information about GridView to bupy7\grid\GridView., (*27)
Keeping last modified the page sizer
By default this function disabled., (*28)
echo GridView::widget([
...
'id' => 'unique-id-of-this-grid',
'keepPageSizer' => true,
...
]);
You need to specify id as unique for correct work., (*29)
id and options[id] - not the same! id it identificator of widget, and
options[id] it HTML-identificator of grid view., (*30)
License
yii2-grid is released under the BSD 3-Clause License., (*31)
Wallogit.com
