Class kartik\dynagrid\Module

All Classes | Properties | Methods | Events | Constants
Inheritancekartik\dynagrid\Module » kartik\base\Module » yii\base\Module » yii\di\ServiceLocator » yii\base\Component » yii\base\BaseObject
Implementskartik\base\BootstrapInterface, yii\base\Configurable
Uses Traitskartik\base\BootstrapTrait, kartik\base\TranslationTrait

Module for configuring and enabling the dynamic grid functionality for Yii2.

Setup the module in your Yii configuration file with a name dynagrid as shown below. In addition, you must also register the gridview module as described in the yii2-dynagrid documentation and yii2-grid documentation.

'modules'=>[
   'dynagrid'=>[
        'class'=>'\kartik\dynagrid\Module',
        // other settings (refer documentation)
    ],
    'gridview'=>[
        'class'=>'\kartik\grid\Module',
        // other module settings
    ],
],

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$aliases array List of path aliases to be defined. The array keys are alias names (must start with @) and the array values are the corresponding paths or aliases. See setAliases() for an example. yii\base\Module
$basePath string The root directory of the module. yii\base\Module
$behaviors yii\base\Behavior[] List of behaviors attached to this component. yii\base\Component
$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. kartik\base\BootstrapTrait
$bsCssMap array CSS conversion mappings across bootstrap library versions. kartik\base\BootstrapTrait
$bsExtBasename integer The yii2 bootstrap extension base name (readonly property available via getter method getBsExtBasename()) kartik\base\BootstrapTrait
$bsVer integer Bootstrap version number currently set (readonly property available via getter method getBsVer()) kartik\base\BootstrapTrait
$bsVersion integer|string The bootstrap library version that you wish to use for this specific extension / widget. kartik\base\BootstrapTrait
$components array The list of the component definitions or the loaded component instances (ID => definition or instance). yii\di\ServiceLocator
$configEncryptSalt string A random salt that will be used to generate a hash signature for tree configuration. kartik\dynagrid\Module
$configView string The view for displaying and saving the dynagrid configuration kartik\dynagrid\Module
$controllerMap array Mapping from controller ID to controller configurations. yii\base\Module
$controllerNamespace string|null The namespace that controller classes are in. yii\base\Module
$controllerPath string The directory that contains the controller classes. yii\base\Module
$cookieSettings array The settings for the web cookie object (yii\web\Cookie) to be used in saving the dynagrid setup. kartik\dynagrid\Module
$dbSettings array The settings for the database table to store the dynagrid setup. kartik\dynagrid\Module
$dbSettingsDtl array The settings for the detail database table to store the dynagrid filter and sort settings. kartik\dynagrid\Module
$defaultBtnCss string Default bootstrap button CSS (readonly property available via getter method getDefaultBtnCss()) kartik\base\BootstrapTrait
$defaultIconPrefix string Default icon prefix (readonly property available via getter method getDefaultIconPrefix()) kartik\base\BootstrapTrait
$defaultPageSize integer The default pagesize for the gridview. kartik\dynagrid\Module
$defaultRoute string The default route of this module. yii\base\Module
$defaultTheme integer The default theme for the gridview. kartik\dynagrid\Module
$dropdownClass string Bootstrap dropdown class name based on currently configured bootstrap version (readonly property available via getter method getDropdownClass()) kartik\base\BootstrapTrait
$dynaGridOptions array The default global configuration for the kartik\dynagrid\DynaGrid widget kartik\dynagrid\Module
$i18n array The the internalization configuration for this widget. kartik\base\TranslationTrait
$id string An ID that uniquely identifies this module among other modules which have the same parent. yii\base\Module
$layout string|boolean|null The layout that should be applied for views within this module. yii\base\Module
$layoutPath string The root directory of layout files. Defaults to "$viewPath/layouts". yii\base\Module
$maxPageSize integer The maximum pagesize for the gridview. kartik\dynagrid\Module
$minPageSize integer The minimum pagesize for the gridview. kartik\dynagrid\Module
$module yii\base\Module|null The parent module of this module. yii\base\Module
$modules array The modules (indexed by their IDs). yii\base\Module
$params array Custom module parameters (name => value). yii\base\Module
$settingsConfigAction mixed The action URL for displaying the dynagrid detail configuration settings on the dynagrid detail settings form. kartik\dynagrid\Module
$settingsView string The view for displaying and saving the dynagrid detail settings for filter and sort kartik\dynagrid\Module
$themeConfig array The theme configuration for the gridview kartik\dynagrid\Module
$uniqueId string The unique ID of the module. yii\base\Module
$version string The version of this module. Note that the type of this property differs in getter and setter. See getVersion() and setVersion() for details. yii\base\Module
$viewPath string The root directory of view files. Defaults to "$basePath/views". yii\base\Module

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$_bsVer integer Current bootstrap version number kartik\base\BootstrapTrait
$_defaultBtnCss string Default bootstrap button CSS kartik\base\BootstrapTrait
$_defaultIconPrefix string Default icon CSS prefix kartik\base\BootstrapTrait
$_isBs4 boolean Flag to detect whether bootstrap 4. kartik\base\BootstrapTrait
$_msgCat string Translation message file category name for i18n. kartik\dynagrid\Module

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\Module
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
addCssClass() Adds bootstrap CSS class to options by parsing the bootstrap version for the specified Bootstrap CSS type. kartik\base\BootstrapTrait
afterAction() This method is invoked right after an action within this module is executed. yii\base\Module
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeAction() This method is invoked right before an action within this module is executed. yii\base\Module
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\BaseObject
clear() Removes the component from the locator. yii\di\ServiceLocator
createController() Creates a controller instance based on the given route. yii\base\Module
createControllerByID() Creates a controller based on the given controller ID. yii\base\Module
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
get() Returns the component instance with the specified ID. yii\base\Module
getBSClass() Gets the respective Bootstrap class based on currently configured bootstrap version. kartik\base\BootstrapTrait
getBasePath() Returns the root directory of the module. yii\base\Module
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getBsVer() Gets the current set bootstrap version number. kartik\base\BootstrapTrait
getComponents() Returns the list of the component definitions or the loaded component instances. yii\di\ServiceLocator
getControllerPath() Returns the directory that contains the controller classes according to $controllerNamespace. yii\base\Module
getCssClass() Gets bootstrap css class by parsing the bootstrap version for the specified BS CSS type. kartik\base\BootstrapTrait
getDefaultBtnCss() Gets the default button CSS kartik\base\BootstrapTrait
getDefaultIconPrefix() Gets the default icon css prefix kartik\base\BootstrapTrait
getDropdownClass() Gets the respective bootstrap dropdown class name based on currently configured bootstrap version. kartik\base\BootstrapTrait
getInstance() Returns the currently requested instance of this module class. yii\base\Module
getLayoutPath() Returns the directory that contains layout view files for this module. yii\base\Module
getModule() Retrieves the child module of the specified ID. yii\base\Module
getModules() Returns the sub-modules in this module. yii\base\Module
getUniqueId() Returns an ID that uniquely identifies this module among all modules within the current application. yii\base\Module
getVersion() Returns current module version. yii\base\Module
getViewPath() Returns the directory that contains the view files for this module. yii\base\Module
has() Returns a value indicating whether the locator has the specified component definition or has instantiated the component. yii\base\Module
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasModule() Checks whether the child module of the specified ID exists. yii\base\Module
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the module. kartik\dynagrid\Module
initI18N() Yii i18n messages configuration for generating translations kartik\base\TranslationTrait
initSettings() Initialize module level settings kartik\dynagrid\Module
initThemeConfig() Initialize theme configuration kartik\dynagrid\Module
isBs() Validate Bootstrap version kartik\base\BootstrapTrait
isBs4() Validate if Bootstrap 4.x version. kartik\base\BootstrapTrait
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
removeCssClass() Removes bootstrap CSS class from options by parsing the bootstrap version for the specified Bootstrap CSS type. kartik\base\BootstrapTrait
runAction() Runs a controller action specified by a route. yii\base\Module
set() Registers a component definition with this locator. yii\di\ServiceLocator
setAliases() Defines path aliases. yii\base\Module
setBasePath() Sets the root directory of the module. yii\base\Module
setComponents() Registers a set of component definitions in this locator. yii\di\ServiceLocator
setControllerPath() Sets the directory that contains the controller classes. yii\base\Module
setInstance() Sets the currently requested instance of this module class. yii\base\Module
setLayoutPath() Sets the directory that contains the layout files. yii\base\Module
setModule() Adds a sub-module to this module. yii\base\Module
setModules() Registers sub-modules in the current module. yii\base\Module
setVersion() Sets current module version. yii\base\Module
setViewPath() Sets the directory that contains the view files. yii\base\Module
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
configureBsVersion() Configures the bootstrap version settings kartik\base\BootstrapTrait
defaultVersion() Returns default module version. yii\base\Module
getBsExtBasename() The yii2-bootstrap extension base name. kartik\base\BootstrapTrait
initBsVersion() Initializes bootstrap versions for the widgets and asset bundles. kartik\base\BootstrapTrait
isSameVersion() Compares two versions and checks if they are of the same major BS version. kartik\base\BootstrapTrait
parseVer() Parses and returns the major BS version kartik\base\BootstrapTrait

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_ACTION yii\base\ActionEvent An event raised after executing a controller action. yii\base\Module
EVENT_BEFORE_ACTION yii\base\ActionEvent An event raised before executing a controller action. yii\base\Module

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
LAYOUT_1 "
{dynagrid}
\n{summary}\n{items}\n{pager}"		 kartik\dynagrid\Module
LAYOUT_2 " " kartik\dynagrid\Module
MODULE 'dynagrid' kartik\dynagrid\Module

Property Details

$_msgCat protected property

Translation message file category name for i18n.

protected string $_msgCat = 'kvdynagrid'
$configEncryptSalt public property

A random salt that will be used to generate a hash signature for tree configuration.

public string $configEncryptSalt = 'SET_A_SALT_FOR_YII2_DYNAGRID'
$configView public property

The view for displaying and saving the dynagrid configuration

public string $configView = 'config'
$cookieSettings public property

The settings for the web cookie object (yii\web\Cookie) to be used in saving the dynagrid setup.

See also yii\web\Cookie.

public array $cookieSettings = []
$dbSettings public property

The settings for the database table to store the dynagrid setup. The following parameters are supported:

  • tableName: string, the name of the database table, that will store the dynagrid settings. Defaults to tbl_dynagrid.
  • idAttr: string, the attribute name for the configuration id . Defaults to id.
  • filterAttr: string, the attribute name for the filter setting id. Defaults to filter_id.
  • sortAttr: string, the attribute name for the filter setting id. Defaults to sort_id.
  • dataAttr: string, the attribute name for grid column data configuration. Defaults to data.
public array $dbSettings = []
$dbSettingsDtl public property

The settings for the detail database table to store the dynagrid filter and sort settings. The following parameters are supported:

  • tableName: string, the name of the database table, that will store the dynagrid detail settings. Defaults to tbl_dynagrid_dtl.
  • idAttr: string, the attribute name for the detail configuration id. 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 the filter or sort name. Defaults to name.
  • dataAttr: string, the attribute name for grid detail (filter/sort) configuration. Defaults to data.
  • dynaGridIdAttr: string, the attribute name for the dynagrid identifier. Defaults to dynagrid_id.
public array $dbSettingsDtl = []
$defaultPageSize public property

The default pagesize for the gridview.

public integer $defaultPageSize = 10
$defaultTheme public property

The default theme for the gridview.

public integer $defaultTheme = 'panel-primary'
$dynaGridOptions public property

The default global configuration for the kartik\dynagrid\DynaGrid widget

public array $dynaGridOptions = []
$maxPageSize public property

The maximum pagesize for the gridview.

public integer $maxPageSize = 50
$minPageSize public property

The minimum pagesize for the gridview. Setting pagesize to 0 will display all rows.

public integer $minPageSize = 0
$settingsConfigAction public property

The action URL for displaying the dynagrid detail configuration settings on the dynagrid detail settings form. If this is not set it will default to <moduleId>/settings/get-config, where <moduleId> is the module identifier for the dynagrid module.

public mixed $settingsConfigAction = null
$settingsView public property

The view for displaying and saving the dynagrid detail settings for filter and sort

public string $settingsView = 'settings'
$themeConfig public property

The theme configuration for the gridview

public array $themeConfig = null

Method Details

init() public method

Initializes the module.

This method is called after the module is created and initialized with property values given in configuration. The default implementation will initialize $controllerNamespace if it is not set.

If you override this method, please make sure you call the parent implementation.

public void init ( )
throws yii\base\InvalidConfigException
throws ReflectionException
initSettings() public method

Initialize module level settings

public void initSettings ( )
initThemeConfig() public method

Initialize theme configuration

public void initThemeConfig ( )
throws Exception