Class kartik\tree\Module
| Inheritance | kartik\tree\Module » kartik\base\Module » yii\base\Module » yii\di\ServiceLocator » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | kartik\base\BootstrapInterface, yii\base\Configurable |
| Uses Traits | kartik\base\BootstrapTrait, kartik\base\TranslationTrait |
| Available since version | 1.0 |
Module is the tree management module for Yii Framework 2.0 that enables the kartik\tree\TreeView widget functionality.
To use, configure the module named treemanager in the modules section of your Yii configuration file.
For example,
'modules' => [
'treemanager' => [
'class' => '\kartik\tree\Module',
// other module settings, refer detailed documentation
]
]
Public Properties
| Property | Type | Description | Defined 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 |
| $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 |
| $dataStructure | array | The configuration of additional data attributes for the tree | kartik\tree\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 |
| $defaultRoute | string | The default route of this module. | yii\base\Module |
| $dropdownClass | string | Bootstrap dropdown class name based on currently configured bootstrap version (readonly property available via getter method getDropdownClass()) | kartik\base\BootstrapTrait |
| $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 |
| $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 |
| $treeBehaviorName | string | The name to identify the nested set behavior name in the kartik\tree\models\Tree model. | kartik\tree\Module |
| $treeEncryptSalt | string | A random salt that will be used to generate a hash signature for tree configuration. | kartik\tree\Module |
| $treeStructure | array | The configuration of nested set attributes structure. | kartik\tree\Module |
| $treeViewSettings | array | The default configuration settings for the tree view widget | kartik\tree\Module |
| $uniqueId | string | The unique ID of the module. | yii\base\Module |
| $unsetAjaxBundles | array | The list of asset bundles that would be unset when rendering the node detail form via ajax | kartik\tree\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
| Property | Type | Description | Defined 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\base\TranslationTrait |
Public Methods
| Method | Description | Defined 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\tree\Module |
| initI18N() | Yii i18n messages configuration for generating translations | kartik\base\TranslationTrait |
| 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
| Method | Description | Defined 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
| Event | Type | Description | Defined 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
| Constant | Value | Description | Defined By |
|---|---|---|---|
| MODULE | 'treemanager' | kartik\tree\Module | |
| NODE_MANAGE | 'manage' | kartik\tree\Module | |
| NODE_MOVE | 'move' | kartik\tree\Module | |
| NODE_REMOVE | 'remove' | kartik\tree\Module | |
| NODE_SAVE | 'save' | kartik\tree\Module | |
| VIEW_PART_1 | 1 | kartik\tree\Module | |
| VIEW_PART_2 | 2 | kartik\tree\Module | |
| VIEW_PART_3 | 3 | kartik\tree\Module | |
| VIEW_PART_4 | 4 | kartik\tree\Module | |
| VIEW_PART_5 | 5 | kartik\tree\Module |
Property Details
The configuration of additional data attributes for the tree
The name to identify the nested set behavior name in the kartik\tree\models\Tree model.
A random salt that will be used to generate a hash signature for tree configuration.
The configuration of nested set attributes structure.
The default configuration settings for the tree view widget
public array $treeViewSettings = [
'nodeView' => '@kvtree/views/_form', 'nodeAddlViews' => [self::VIEW_PART_1 => '',
self::VIEW_PART_2 => '',
self::VIEW_PART_3 => '',
self::VIEW_PART_4 => '',
self::VIEW_PART_5 => '']
]
'nodeView' => '@kvtree/views/_form', 'nodeAddlViews' => [self::VIEW_PART_1 => '',
self::VIEW_PART_2 => '',
self::VIEW_PART_3 => '',
self::VIEW_PART_4 => '',
self::VIEW_PART_5 => '']
]
The list of asset bundles that would be unset when rendering the node detail form via ajax
public array $unsetAjaxBundles = [
'yii\web\YiiAsset', 'yii\web\JqueryAsset', 'yii\widgets\ActiveFormAsset', 'yii\validators\ValidationAsset'
]
'yii\web\YiiAsset', 'yii\web\JqueryAsset', 'yii\widgets\ActiveFormAsset', 'yii\validators\ValidationAsset'
]
Method Details
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 | |