DynaGrid supports configuration of the bootstrap library version so that you can use this either with any Bootstrap version 3.x and above. For setting up the bootstrap version for your extension, you can configure the DynaGrid::bsVersion property to one of the following.

• To use with bootstrap 3 library - you can set DynaGrid::bsVersion property to any string starting with 3 (e.g. 3 or 3.3.7 or 3.x)

• To use with bootstrap 4 library - you can set DynaGrid::bsVersion property to any string starting with 4 (e.g. 4 or 4.6.0 or 4.x)

• To use with bootstrap 5 library - you can set DynaGrid::bsVersion property to any string starting with 5 (e.g. 5 or 5.1.0 or 5.x)

'params' => [
    'bsVersion' => '5.x', // this will set globally `bsVersion` to Bootstrap 5.x for all Krajee Extensions
    // other settings
    // 'adminEmail' => 'admin@example.com'
]

"yiisoft/yii2-bootstrap5": "@dev"

"yiisoft/yii2-bootstrap4": "@dev"

"yiisoft/yii2-bootstrap": "@dev"

The yii2-dynagrid extension can be installed automatically or manually using one of these options:

$ php composer.phar require kartik-v/yii2-dynagrid "dev-master"

"kartik-v/yii2-dynagrid": "dev-master"

'modules'=>[
   'dynagrid'=> [
        'class'=>'\kartik\dynagrid\Module',
        // other module settings
    ],
    'gridview'=> [
        'class'=>'\kartik\grid\Module',
        // other module settings
    ],
];

• bsVersion: string | int, the bootstrap library version to be used for the extension. Refer the Bootstrap Info section for details and pre-requisites on setting this property.

  • To use with Bootstrap library - you can set this to any string starting with 3 (e.g. 3 or 3.3.7 or 4.x / 3.x)

  • To use with bootstrap 4 - you can set this to any string starting with 4 (e.g. 4 or 4.6.0 or 4.x)

  • To use with bootstrap 5 - you can set this to any string starting with 4 (e.g. 5 or 5.1.0 or 5.x)

• bsColCssPrefixes: array, the bootstrap grid column css prefixes mapping, the key is the bootstrap versions, and the value is an array containing the sizes and their corresponding grid column css prefixes. The class using this trait, must implement kartik\base\BootstrapInterface. If not set will default to:.

  [
     3 => [
        self::SIZE_X_SMALL => 'col-xs-',
        self::SIZE_SMALL => 'col-sm-',
        self::SIZE_MEDIUM => 'col-md-',
        self::SIZE_LARGE => 'col-lg-',
        self::SIZE_X_LARGE => 'col-lg-',
        self::SIZE_XX_LARGE => 'col-lg-',
     ],
     4 => [
        self::SIZE_X_SMALL => 'col-',
        self::SIZE_SMALL => 'col-sm-',
        self::SIZE_MEDIUM => 'col-md-',
        self::SIZE_LARGE => 'col-lg-',
        self::SIZE_X_LARGE => 'col-xl-',
        self::SIZE_XX_LARGE => 'col-xl-',
     ],
     5 => [
        self::SIZE_X_SMALL => 'col-',
        self::SIZE_SMALL => 'col-sm-',
        self::SIZE_MEDIUM => 'col-md-',
        self::SIZE_LARGE => 'col-lg-',
        self::SIZE_X_LARGE => 'col-xl-',
        self::SIZE_XX_LARGE => 'col-xxl-',
     ],
  ];
  

• cookieSettings: array, the cookie settings when you are using 'cookie' as storage method in the DynaGrid widget. Refer yii\web\Cookie settings for details on properties supported. Defaults to ['httpOnly'=>true, 'expire'=>time() + 8640000]

• dbSettings: array, the settings for the database if you are using 'db' as storage method in the DynaGrid widget. The following properties are recognized:

  • tableName: string, the name of the table which will be used for storage. Defaults to tbl_dynagrid.

  • idAttr: string, the name of the id column in the table. Defaults to id.

  • filterAttr: string, the attribute name for the filter setting id. Defaults to filterId.

  • sortAttr: string, the attribute name for the filter setting id. Defaults to sortId.

  • dataAttr: string, the name of the dataAttr column in the table. Defaults to data.

  You must create the above table in your database before you start using the widget. Refer the data folder of this repository for an example MYSQL script. An example of the table creation script for MYSQL database is shown below:

  CREATE TABLE `tbl_dynagrid` (
    `id` varchar(100) NOT NULL COMMENT 'Unique dynagrid setting identifier',
    `filter_id` varchar(100) COMMENT 'Filter setting identifier',
    `sort_id` varchar(100) COMMENT 'Sort setting identifier',
    `data` varchar(5000) DEFAULT NULL COMMENT 'Json encoded data for the dynagrid configuration',
    PRIMARY KEY (`id`)
  ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='Dynagrid personalization configuration settings';
  

• dbSettingsDtl: array, the settings for the detail database table to store the dynagrid filter and sort settings. The following properties are recognized:

  • tableName: string, the name of the table which will be used for storage. Defaults to tbl_dynagrid_dtl.

  • idAttr: string, the name of the id column in the table. Defaults to id.

  • categoryAttr: string, the attribute name for the detail category (values currently possible are filter or sort). Defaults to category.

  • nameAttr: string, the attribute name for for the filter or sort name. Defaults to name.

  • dataAttr: string, the name of the dataAttr column in the table. Defaults to data.

  • dynaGridId: string, the attribute name for the dynagrid identifier. Defaults to dynagrid_id.

  You must create the above table in your database before you start using the widget. Refer the data folder of this repository for an example MYSQL script. An example of the table creation script for MYSQL database is shown below:

  CREATE TABLE `tbl_dynagrid_dtl` (
    `id` varchar(100) NOT NULL COMMENT 'Unique dynagrid detail setting identifier',
    `category` varchar(10) NOT NULL COMMENT 'Dynagrid detail setting category "filter" or "sort"',
    `name` varchar(150) NOT NULL COMMENT 'Name to identify the dynagrid detail setting',
    `data` varchar(5000) DEFAULT NULL COMMENT 'Json encoded data for the dynagrid detail configuration',
    `dynagrid_id` varchar(100) NOT NULL COMMENT 'Related dynagrid identifier',
    PRIMARY KEY (`id`),
    UNIQUE KEY `tbl_dynagrid_dtl_UK1` (`name`,`category`,`dynagrid_id`)
  ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='Dynagrid detail configuration settings';
  

  You can also create FOREIGN KEY constraints as shown below

  ALTER TABLE `tbl_dynagrid`
  ADD CONSTRAINT `tbl_dynagrid_FK1` 
  FOREIGN KEY (`filter_id`) 
  REFERENCES `tbl_dynagrid_dtl` (`id`) 
  , ADD INDEX `tbl_dynagrid_FK1` (`filter_id` ASC);
  
  ALTER TABLE `tbl_dynagrid`
  ADD CONSTRAINT `tbl_dynagrid_FK2` 
  FOREIGN KEY (`sort_id`) 
  REFERENCES `tbl_dynagrid_dtl` (`id`) 
  , ADD INDEX `tbl_dynagrid_FK2` (`sort_id` ASC);
  

• dynaGridOptions: array, the default global options for the DynaGrid widget. See the DynaGrid documentation section for the properties supported.

• configView: string, the view file name for displaying and saving the dynagrid configuration. You can override this with your own view, if you want to display your own layout. Defaults to config, which will bascially be this file in your vendor folder: kartik-v/yii2-dynagrid/views/config.php.

• settingsView: string, the view file name for displaying and saving the dynagrid detail settings for filter and sort. You can override this with your own view, if you want to display your own layout. Defaults to settings, which will bascially be this file in your vendor folder: kartik-v/yii2-dynagrid/views/settings.php.

• settingsConfigAction: mixed, the action URL for displaying the dynagrid detail configuration settings on the dynagrid detail settings form. Defaults to /dynagrid/settings/get-config.

• themeConfig: array, the configuration of various themes for the grid configuration. You must set this in $themeName=>$themeSettings format, where:

  • $themeName: string, is a unique name to identify your theme, and

  • $themeSettings: array, will be an array of the configuration properties as supported by \kartik\grid\GridView widget.

  You can also set these themes in a separate php file and call the config here using PHP require. The widget by default has the following themes pre-configured:

  [
      'simple-default'=>['panel'=>false,'bordered'=>false,'striped'=>false,'hover'=>true,'layout'=>Module::LAYOUT_1],
      'simple-bordered'=>['panel'=>false,'striped'=>false,'hover'=>true,'layout'=>Module::LAYOUT_1],
      'simple-condensed'=>['panel'=>false,'striped'=>false,'condensed'=>true,'hover'=>true,'layout'=>Module::LAYOUT_1],
      'simple-striped'=>['panel'=>false,'layout'=>Module::LAYOUT_1],
      'panel-default'=>['panel'=>['type'=>GridView::TYPE_DEFAULT,'before'=>Module::LAYOUT_2]],
      'panel-primary'=>['panel'=>['type'=>GridView::TYPE_PRIMARY,'before'=>Module::LAYOUT_2]],
      'panel-info'=>['panel'=>['type'=>GridView::TYPE_INFO,'before'=>Module::LAYOUT_2]],
      'panel-danger'=>['panel'=>['type'=>GridView::TYPE_DANGER,'before'=>Module::LAYOUT_2]],
      'panel-success'=>['panel'=>['type'=>GridView::TYPE_SUCCESS,'before'=>Module::LAYOUT_2]],
      'panel-warning'=>['panel'=>['type'=>GridView::TYPE_WARNING,'before'=>Module::LAYOUT_2]],
  ]
  

  where

  • Module::LAYOUT_1 is "<hr>{dynagrid}<hr> {summary} {items} {pager}"

  • Module::LAYOUT_2 is "{dynagrid}"

  Note

  The {dynagrid} tag in your layout template will be replaced by the DynaGrid widget, which will render the grid personalization configuration toggle button and the configuration form as a bootstrap modal dialog.

• defaultTheme: string, the default theme to use for the DynaGrid widget. Defaults to panel-primary.

• defaultPageSize: integer, the default page size to use for the DynaGrid widget. Defaults to 10. Note that setting this to 0 means an unlimited page size.

• minPageSize: integer, the minimum page size that can be setup by users using the DynaGrid configuration form. Defaults to 5. Note a 0 value means an unlimited page size.

• maxPageSize: integer, the maximum page size that can be setup by users using the DynaGrid configuration form. Defaults to 50.

• i18n: array, the internalization configuration for this module. Defaults to:

  [
      'class'=>'yii\i18n\PhpMessageSource',
      'basePath'=>'@kvdynagrid/messages',
      'forceTranslation'=>true
  ];
  

• bsVersion: string | int, the bootstrap library version to be used for the extension. Refer the Bootstrap Info section for details and pre-requisites on setting this property.

  • To use with Bootstrap library - you can set this to any string starting with 3 (e.g. 3 or 3.3.7 or 4.x / 3.x)

  • To use with bootstrap 4 - you can set this to any string starting with 4 (e.g. 4 or 4.6.0 or 4.x)

  • To use with bootstrap 5 - you can set this to any string starting with 4 (e.g. 5 or 5.1.0 or 5.x)

  NOTE If this property is NOT SET, then this property will default to the bsVersion property set at the Module level which will override the Yii::$app->params['bsVersion'] setting.

• bsColCssPrefixes: array, the bootstrap grid column css prefixes mapping, the key is the bootstrap versions, and the value is an array containing the sizes and their corresponding grid column css prefixes. The class using this trait, must implement kartik\base\BootstrapInterface. If not set will default to:.

  [
     3 => [
        self::SIZE_X_SMALL => 'col-xs-',
        self::SIZE_SMALL => 'col-sm-',
        self::SIZE_MEDIUM => 'col-md-',
        self::SIZE_LARGE => 'col-lg-',
        self::SIZE_X_LARGE => 'col-lg-',
        self::SIZE_XX_LARGE => 'col-lg-',
     ],
     4 => [
        self::SIZE_X_SMALL => 'col-',
        self::SIZE_SMALL => 'col-sm-',
        self::SIZE_MEDIUM => 'col-md-',
        self::SIZE_LARGE => 'col-lg-',
        self::SIZE_X_LARGE => 'col-xl-',
        self::SIZE_XX_LARGE => 'col-xl-',
     ],
     5 => [
        self::SIZE_X_SMALL => 'col-',
        self::SIZE_SMALL => 'col-sm-',
        self::SIZE_MEDIUM => 'col-md-',
        self::SIZE_LARGE => 'col-lg-',
        self::SIZE_X_LARGE => 'col-xl-',
        self::SIZE_XX_LARGE => 'col-xxl-',
     ],
  ];
  

• storage: string, the type of storage for storing the dynagrid configuration, when user applies/saves the configuration. Should be one of the following:

  • 'session' or DynaGrid::TYPE_SESSION: Save the config in a session variable for the current session.

  • 'cookie' or DynaGrid::TYPE_COOKIE: Save the config in a cookie for retrieval. You need to setup the Module::cookieSettings property to control the cookie expiry and other settings.

  • 'db' or DynaGrid::TYPE_DB: Save the config to a database. You need to setup the Module::dbSettings and Module::dbSettingsDtl properties to to setup the database table and attributes for storage.

• theme: string, the initial default theme to be set for the widget. If not provided will take in the defaultTheme setting from the module..

• userSpecific: boolean, whether settings are stored specific to each user. Defaults to true.

• dbUpdateNameOnly: boolean, whether to update only the name, when editing and saving a filter or sort. This is applicable only when storage is set to Dynagrid::TYPE_DB. Defaults to false. If set to false, it will also overwrite the current filter/sort settings and if set to true, only the filter/sort name will be updated.

• showPersonalize: boolean, whether to show the personalize button. Defaults to true.

• showSort: boolean, whether to show the sort save widget button. Defaults to true.

• enableMultiSort: boolean, whether to enable multiple attribute sorting. Defaults to true.

• showFilter: boolean, whether to show the filter save widget button. Defaults to true.

• allowPageSetting: boolean, whether to allowsetup of the pagination in the personalize grid form. Defaults to true. This will default to false, if you set pagination to false for the gridOptions['dataProvider'].

• allowThemeSetting: boolean, whether to allow display/setup of the theme in the personalize grid form. Defaults to true.

• allowFilterSetting: boolean, whether to allow display/setup of the filter in the personalize grid form. Defaults to true.

• allowSortSetting: boolean, whether to allow display/setup of the sort in the personalize grid form. Defaults to true. This will default to false, if you set sort to false for the gridOptions['dataProvider'].

• gridOptions: array, widget options for \kartik\grid\GridView that will be rendered by the DynaGrid widget. Many settings here are defaulted as per the chosen theme setting in themeConfig of \kartik\dynagrid\Module.

  Note

  The {dynagrid} tag should be embedded in one of the following sections:

  • gridOptions['panel']['before']

  • gridOptions['panel']['after']

  • gridOptions['layout']

  The widget will automatically replace the {dynagrid} tag in the above section(s), with the DynaGrid personalization configuration toggle button and the configuration form as a bootstrap modal dialog. For example, you can setup your customized before content in your grid panel like below:

  echo DynaGrid::widget([
      'columns' => $columns,
      'theme'=>'panel-warning',
      'gridOptions'=>[
          'dataProvider'=>$dataProvider,
          'filterModel'=>$searchModel,
          'showPageSummary'=>true,
          'panel'=>[
              'heading'=>'<h3 class="panel-title"><i class="fas fa-book">  Library',
              'before'=>'{dynagrid}' . Html::a('Custom Button', '#', ['class'=>'btn btn-secondary btn-default'])
          ],
      ]
  ]);

• matchPanelStyle: boolean, whether the DynaGrid configuration button class should match the grid panel style. Defaults to true.

• toggleButtonGrid: array, the HTML attributes for the toggle button which will render the DynaGrid configuration form within a Bootstrap Modal container. Refer yii\bootstrap\Modal documentation for properties supported. The following default settings are available:

  • label: string, the label to be displayed for the button. Defaults to <span class="fas fa-wrench"></span>.

  • title: string, the title to be displayed for the button on hover. Defaults to Personalize grid settings.

  • data-pjax: boolean, whether to trigger a pjax action on click. Defaults to false.

• toggleButtonFilter: array, the HTML attributes for the filter configuration button which will render the Filter settings form within a Bootstrap Modal container. The following default settings are available:

  • label: string, the label to be displayed for the button. Defaults to <span class="fas fa-filter"></span>.

  • title: string, the title to be displayed for the button on hover. Defaults to Save / edit grid filter.

  • data-pjax: boolean, whether to trigger a pjax action on click. Defaults to false.

• toggleButtonSort: array, the HTML attributes for the sort configuration button which will render the Sort settings form within a Bootstrap Modal container. The following default settings are available:

  • label: string, the label to be displayed for the button. Defaults to <span class="fas fa-sort"></span>.

  • title: string, the title to be displayed for the button on hover. Defaults to Save / edit grid sort.

  • data-pjax: boolean, whether to trigger a pjax action on click. Defaults to false.

• options: array, the HTML attributes for the DynaGrid widget container. You must mandatorily setup a unique identifier for the DynaGrid widget by setting a value for the id property. For example: 'options' => ['id' => 'dynagrid-1']/

• sortableOptions: array, the widget settings for the Sortable widget. The widget uses \kartik\sortable\Sortable widget to enable dragging and dropping of columns for reordering. Refer the Sortable widget documentation for supported properties for the widget.

• sortableHeader: array, the HTML attributes for the sortable columns header. Defaults to ['class'=>'alert alert-info dynagrid-column-header'].

• columns: array, the grid view columns configuration. The column properties as supported by \kartik\grid\GridView are also supported here. This widget allows an important additional property order (string). The columns['order']can be one of the following:

  • 'fixleft' or DynaGrid::ORDER_FIX_LEFT which will fix the column order to the left part of the grid and prevent the user to reorder or change this column setting.

  • 'fixright' or DynaGrid::ORDER_FIX_RIGHT which will fix the column order to the right part of the grid and prevent the user to reorder or change this column setting.

  • 'middle' or DynaGrid::ORDER_MIDDLE which will be the columns in the middle part of the grid. This is the default setting for order if implicitly not set. The DynaGrid::ORDER_MIDDLE order setting for a column, will allow the gridview user to reorder and control display of the column.

  Note

  You can set the visible property of a column to false, to not show it by default in the grid layout.

• submitMessage: string, the message to display after applying and submitting the configuration and until refreshed grid is reloaded. Defaults to Saving and applying configuration.

• deleteMessage: string, the message to display after deleting the configuration and until refreshed grid is reloaded. Defaults to Trashing all personalizations.

• messageOptions: array, the HTML attributes for the submission message container.

• deleteConfirmation: string, the confirmation warning message before deleting a personalization configuration or setting. Defaults to Are you sure you want to delete the setting?.

• submitButtonOptions: array, the HTML attributes for the save/apply action button. If this is set to false, it will not be displayed. The following special variables are supported:

  • icon: string, the glyphicon suffix class name that will be created as a label for the button. Defaults to save.

  • label: string, the label to be displayed for the action button. Defaults to empty string.

  • title: string, the title to be displayed for the action button on hover. Defaults to Save grid settings.

• resetButtonOptions: array, the HTML attributes for the reset action button. If this is set to false, it will not be displayed. The following special variables are supported:

  • icon: string, the glyphicon suffix class name that will be created as a label for the button. Defaults to repeat.

  • label: string, the label to be displayed for the action button. Defaults to empty string.

  • title: string, the title to be displayed for the action button on hover. Defaults to Abort any changes and reset settings.

• deleteButtonOptions: array, the HTML attributes for the reset action button. If this is set to false, it will not be displayed. The following special variables are supported:

  • icon: string, the glyphicon suffix class name that will be created as a label for the button. Defaults to trash.

  • label: string, the label to be displayed for the action button. Defaults to empty string.

  • title: string, the title to be displayed for the action button on hover. Defaults to Remove saved grid setting.

• iconVisibleColumn: string, the icon that will be displayed for each VISIBLE column heading in the column reordering pane. This is not HTML encoded. To prevent displaying this, set this to a blank or empty character. Defaults to:

  <i class="fas fa-eye-open"></i>
  

• iconHiddenColumn: string, the icon that will be displayed for each HIDDEN column heading in the column reordering pane. This is not HTML encoded. To prevent displaying this, set this to a blank or empty character. Defaults to:

  <i class="fas fa-eye-close"></i>
  

Usage:

use kartik\widgets\DynaGrid;
use kartik\grid\GridView;
$columns = [
    ['class'=>'kartik\grid\SerialColumn', 'order'=>DynaGrid::ORDER_FIX_LEFT],
    'id',
    'name',
    [
        'attribute'=>'publish_date',
        'filterType'=>GridView::FILTER_DATE,
        'format'=>'raw',
        'width'=>'170px',
        'filterWidgetOptions'=>[
            'pluginOptions'=>['format'=>'yyyy-mm-dd']
        ],
    ],
    [
        'class'=>'kartik\grid\BooleanColumn',
        'attribute'=>'status',
        'vAlign'=>'middle',
    ],
    [
        'class'=>'kartik\grid\ActionColumn',
        'dropdown'=>false,
        'order'=>DynaGrid::ORDER_FIX_RIGHT
    ],
    ['class'=>'kartik\grid\CheckboxColumn', 'order'=>DynaGrid::ORDER_FIX_RIGHT],
];

echo DynaGrid::widget([
    'columns'=>$columns,
    'storage'=>DynaGrid::TYPE_COOKIE,
    'theme'=>'panel-danger',
    'gridOptions'=>[
        'dataProvider'=>$dataProvider,
        'filterModel'=>$searchModel,
        'panel'=>['heading'=>'<h3 class="panel-title">Library</h3>'],
    ],
    'options'=>['id'=>'dynagrid-1'] // a unique identifier is important
]);

Mentioned below are some important pre-requisites for setting up dynagrid. Be sure to read them:

You must have setup a module named gridview in your yii config file as per the yii2-grid documentation. In addition, you must also setup the module named dynagrid as described in this section before. You can set module level defaults as described in each module's settings

Ensure you have determined what storage to use. Once decided, ensure you have setup the storage related settings in your dynagrid module. For example dbSettings and dbSettingsDtl for database storage or cookieSettings for cookie storage. Your database tables for db storage must be created as mentioned in the settings before.

The setting up of search model (or filter model) is very important for dynagrid to work well. Your search model must implement a search method as generated by default by gii . In addition, you must change your search function criteria for returning your dataProvider . For example, if your search model class is BookSearch and your source model is Book , your search method should be modified as shown below:

public function search($params)
{
    $query = Book::find();

    $dataProvider = new ActiveDataProvider([
        'query' => $query,
        'pagination' => [
            'pagesize' => 10 // in case you want a default pagesize
        ]
    ]);

    // The following condition is important and must be changed. The $_GET validation
    // is important (or you can use $_POST if you have configured post method).
    // Without this validation saved filters cannot be applied.
    if (isset($_GET['BookSearch']) && !($this->load($params) && $this->validate())) {
        return $dataProvider;
    }

    // the other part below can be as per the default gii code or whatever you need
    $query->andFilterWhere([
        'id' => $this->id,
        'publish_date' => $this->publish_date,
        'status' => $this->status,
        'buy_amount' => $this->buy_amount,
        'sell_amount' => $this->sell_amount,
        'author_id' => $this->author_id,
    ]);

    $query->andFilterWhere(['like', 'name', $this->name])
        ->andFilterWhere(['like', 'color', $this->color]);

    return $dataProvider;
}

The widget by default enables multiple attribute sorting. This is different from the yii default dataProvider setup. In case you wish to change this, you can set enableMultiSort property to false in the DynaGrid widget configuration.

The toolbar needs to be explicitly defined for each dynagrid setup. Note that the toolbar configuration is an array of various bootstrap button groups that accepts a combination of array or strings (refer dynagrid settings/options). The following tags are specially replaced:

• {export}: will be replaced with the grid export button.

• {{dynagridFilter}: will be replaced with the dynagrid filter editing button.

• {{dynagridSort}: will be replaced with the dynagrid sort editing button.

• {{dynagrid}: will be replaced with the dynagrid main personalization button.

In addition, you can use any other tag that you have also set in replaceTags within gridOptions.

You can configure availability of features to your users. For example use the showFilter or showSort boolean properties to control visibility of the filter or sort buttons. You can set showPersonalize boolean property to control visibility of the main grid personalize button. In addition, you could control allowFilterSetting boolean property to set whether the filter can be changed on the main personalization form. Similarly you can set the allowSortSetting to control display of the sort selector in grid personalization form.

• category: string, the category of data to store. Should be one of the following:

  • DynaGridStore::STORE_GRID or 'grid' : if you are storing the grid level personalization.

  • DynaGridStore::STORE_FILTER or 'filter' : if you are storing the detail setting for a grid filter.

  • DynaGridStore::STORE_SORT or 'sort' : if you are storing the detail setting for a grid sort.

• id: string, the dynagrid element identifier.

• name: string, the dynagrid detail element to save (typically when you have category set as filter or sort).

• storage: string, same as DynaGrid storage property. Should be one of the following:

  • 'session' or DynaGrid::TYPE_SESSION: Save the config in a session variable for the current session.

  • 'cookie' or DynaGrid::TYPE_COOKIE: Save the config in a cookie for retrieval. You need to setup the Module::cookieSettings property to control the cookie expiry and other settings.

  • 'db' or DynaGrid::TYPE_DB: Save the config to a database. You need to setup the Module::dbSettings and Module::dbSettingsDtl properties to to setup the database table and attributes for storage.

• userSpecific: boolean, same as the DynaGrid userSpecific property. Determines whether settings are stored specific to each user. Defaults to true.

• dbUpdateNameOnly: boolean, whether to update only the name, when editing and saving a filter or sort. This is applicable only when storage is set to Dynagrid::TYPE_DB. Defaults to false. If set to false, it will also overwrite the current filter/sort settings and if set to true, only the filter/sort name will be updated.

• dtlKey: string, the identifier for the detail configuration (when category is set as filter or sort). If not set, the key will be generated based on the name.

• fetch: Fetches configuration from store. You can provide an optional column (string) property (useful when storage is set to db. The column property defaults to the dataAttr setting.

• save: Saves configuration to the store. You need to provide a config (array) property to save the configuration to the store.

• delete: Deletes configuration from the store.

Usage

// fetches grid configuration
$store = new DynaGridStore([
    'id' => $this->options['id'], 
    'storage' => 'db',
    'userSpecific' => true,
    'category' => 'grid'
]);
return $store->fetch();

// fetches detail configuration
$store = new DynaGridStore([
    'id' => $id, 
    'storage' => 'db',
    'userSpecific' => true,
    'category' => 'filter',
    'dtlKey' => $dtlId 
]);
return $store->fetch();

yii2-dynagrid is released under the BSD-3-Clause License. See the bundled LICENSE.md for details.