Class dmstr\modules\pages\models\Tree

All Classes | Properties | Methods | Constants
Inheritancedmstr\modules\pages\models\Tree » kartik\tree\models\Tree » yii\db\ActiveRecord
Uses Traitskartik\tree\models\TreeTrait

This is the tree model class, extended from \kartik\tree\models\Tree

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$boolAttribs array The list of boolean value attributes kartik\tree\models\TreeTrait
$encodeNodeNames bool Whether to HTML encode the tree node names. kartik\tree\models\Tree
$falseAttribs array The default list of boolean attributes with initial value = false kartik\tree\models\TreeTrait
$nodeActivationErrors array Activation errors for the node kartik\tree\models\Tree
$nodeRemovalErrors array Node removal errors kartik\tree\models\Tree
$purifyNodeIcons bool Whether to HTML purify the tree node icon content before saving. kartik\tree\models\Tree
$treeQueryClass string The classname for the TreeQuery that implements the NestedSetQueryBehavior. kartik\tree\models\Tree

Public Methods

Hide inherited methods

MethodDescriptionDefined By
activateNode() Activates a node (for undoing a soft deletion scenario) kartik\tree\models\TreeTrait
attributeLabels() kartik\tree\models\TreeTrait
behaviors() dmstr\modules\pages\models\Tree
createQuery() kartik\tree\models\TreeTrait
createUrl() dmstr\modules\pages\models\Tree
find() kartik\tree\models\TreeTrait
getMenuItems() dmstr\modules\pages\models\Tree
getSluggedUrl() Get relative url from tree leave dmstr\modules\pages\models\Tree
hasRoute() Check if a tree route and view are set dmstr\modules\pages\models\Tree
initDefaults() Initialize default values kartik\tree\models\TreeTrait
isActive() Validate if the node is active kartik\tree\models\TreeTrait
isCollapsed() Validate if the node is collapsed kartik\tree\models\TreeTrait
isDisabled() Override isDisabled method if you need as shown in the example below. You can override similarly other methods like isActive, isMovable etc. dmstr\modules\pages\models\Tree
isMovable() Validate if the node is movable kartik\tree\models\TreeTrait
isReadonly() Validate if the node is readonly kartik\tree\models\TreeTrait
isRemovable() Validate if the node is removable kartik\tree\models\TreeTrait
isRemovableAll() Validate if the node is removable with descendants kartik\tree\models\TreeTrait
isSelected() Validate if the node is selected kartik\tree\models\TreeTrait
isVisible() Validate if the node is visible kartik\tree\models\TreeTrait
optsAccessDomain() dmstr\modules\pages\models\Tree
optsRoute() TODO which routes will be provided by default ? dmstr\modules\pages\models\Tree
optsView() Get all configured dmstr\modules\pages\models\Tree
removeNode() Removes a node kartik\tree\models\TreeTrait
rules() dmstr\modules\pages\models\Tree
tableName() dmstr\modules\pages\models\Tree
transactions() kartik\tree\models\TreeTrait

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
parse() Parses an attribute value if set - else returns the default kartik\tree\models\TreeTrait
setDefault() Sets default value of a model attribute kartik\tree\models\TreeTrait

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
ACTIVE 1 dmstr\modules\pages\models\Tree
ATTR_ACCESS_DOMAIN 'access_domain' dmstr\modules\pages\models\Tree
ATTR_ACTIVE 'active' dmstr\modules\pages\models\Tree
ATTR_COLLAPSED 'collapsed' dmstr\modules\pages\models\Tree
ATTR_DISABLED 'disabled' dmstr\modules\pages\models\Tree
ATTR_ICON 'icon' dmstr\modules\pages\models\Tree
ATTR_ICON_TYPE 'icon_type' dmstr\modules\pages\models\Tree
ATTR_ID 'id' Attribute names dmstr\modules\pages\models\Tree
ATTR_NAME_ID 'name_id' dmstr\modules\pages\models\Tree
ATTR_READ_ONLY 'readonly' dmstr\modules\pages\models\Tree
ATTR_REQUEST_PARAMS 'request_params' dmstr\modules\pages\models\Tree
ATTR_ROUTE 'route' dmstr\modules\pages\models\Tree
ATTR_SELECTED 'selected' dmstr\modules\pages\models\Tree
ATTR_VIEW 'view' dmstr\modules\pages\models\Tree
ATTR_VISIBLE 'visible' dmstr\modules\pages\models\Tree
COLLAPSED 1 dmstr\modules\pages\models\Tree
DISABLED 1 dmstr\modules\pages\models\Tree
ICON_TYPE_CSS 1 Constants useful for frontend actions dmstr\modules\pages\models\Tree
ICON_TYPE_RAW 2 dmstr\modules\pages\models\Tree
NOT_ACTIVE 0 dmstr\modules\pages\models\Tree
NOT_COLLAPSED 0 dmstr\modules\pages\models\Tree
NOT_DISABLED 0 dmstr\modules\pages\models\Tree
NOT_READ_ONLY 0 dmstr\modules\pages\models\Tree
NOT_SELECTED 0 dmstr\modules\pages\models\Tree
NOT_VISIBLE 0 dmstr\modules\pages\models\Tree
READ_ONLY 1 dmstr\modules\pages\models\Tree
SELECTED 1 dmstr\modules\pages\models\Tree
VISIBLE 1 dmstr\modules\pages\models\Tree

Method Details

behaviors() public method

public array behaviors ( )
createUrl() public method

public null|string createUrl ( $additionalParams = [] )
$additionalParams array
getMenuItems() public static method

public static array getMenuItems ( $rootName )
$rootName

The name of the root node
getSluggedUrl() public static method

Get relative url from tree leave

public static null|string getSluggedUrl ( $leave )
$leave
hasRoute() public method

Check if a tree route and view are set

public bool hasRoute ( )
isDisabled() public method

Override isDisabled method if you need as shown in the example below. You can override similarly other methods like isActive, isMovable etc.

public void isDisabled ( )
optsAccessDomain() public static method

public static array optsAccessDomain ( )
optsRoute() public static method

TODO which routes will be provided by default ?

public static array optsRoute ( )
optsView() public static method

Get all configured

public static array optsView ( )
return array

List of options
rules() public method

public void rules ( )
tableName() public static method

public static void tableName ( )