ilTreeExplorerGUI Class Reference

Explorer class that works on tree objects (Services/Tree) More...

Inheritance diagram for ilTreeExplorerGUI:

Collaboration diagram for ilTreeExplorerGUI:

Public Member Functions
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree)
	Constructor. More...
	getTree ()
	Get tree. More...
	setOrderField ($a_val, $a_numeric=false)
	Set order field. More...
	getOrderField ()
	Get order field. More...
	setTypeWhiteList ($a_val)
	Set type white list. More...
	getTypeWhiteList ()
	Get type white list. More...
	setTypeBlackList ($a_val)
	Set type black list. More...
	getTypeBlackList ()
	Get type black list. More...
	setPreloadChilds ($a_val)
	Set preload childs. More...
	getPreloadChilds ()
	Get preload childs. More...
	getSuccessorNode ($a_node_id, $a_type="")
	Get successor node (currently only(!) based on lft/rgt tree values) More...
	getChildsOfNode ($a_parent_node_id)
	Get childs of node. More...
	getNodeId ($a_node)
	Get id for node. More...
	getNodeIconAlt ($a_node)
	Get node icon alt attribute. More...
	getRootNode ()
	Get root node. More...
	setRootId ($a_root)
	setPathOpen ($a_id)
	Set node path to be opened. More...
	getHTML ($new=false)
	Get HTML. More...
	getChildren ($node, $environment=null)
	Get a list of records (that list can also be empty).Each record will be relayed to $this->build to retrieve a Node. Also, each record will be asked for Sub-Nodes using this function. Returns array More...
	build (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record, $environment=null)
	getTreeLabel ()
	getTreeComponent ()
	Get Tree UI. More...
	toggleExplorerNodeState ()
	Should be called by an ilCtrl-enabled command class if a tree node toggle action should be processed. More...
Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor. More...
	setChildLimit ($a_val)
	Set child limit. More...
	getChildLimit ()
	Get child limit. More...
	setSearchTerm ($a_val)
	Set search term. More...
	getSearchTerm ()
	Get search term. More...
	setMainTemplate ($a_main_tpl=null)
	Set main template (that is responsible for adding js/css) More...
	getRootNode ()
	Get root node. More...
	getChildsOfNode ($a_parent_node_id)
	Get childs of node. More...
	getNodeContent ($a_node)
	Get content of a node. More...
	getNodeId ($a_node)
	Get id of a node. More...
	getNodeHref ($a_node)
	Get href for node. More...
	nodeHasVisibleChilds ($a_node)
	Node has childs? More...
	sortChilds ($a_childs, $a_parent_node_id)
	Sort childs. More...
	getNodeIcon ($a_node)
	Get node icon path. More...
	getNodeIconAlt ($a_node)
	Get node icon alt attribute. More...
	getNodeTarget ($a_node)
	Get node target (frame) attribute. More...
	getNodeOnClick ($a_node)
	Get node onclick attribute. More...
	isNodeVisible ($a_node)
	Is node visible? More...
	isNodeHighlighted ($a_node)
	Is node highlighted? More...
	isNodeClickable ($a_node)
	Is node clickable? More...
	getId ()
	Get id of explorer element. More...
	setSkipRootNode ($a_val)
	Set skip root node. More...
	getSkipRootNode ()
	Get skip root node. More...
	setAjax ($a_val)
	Set ajax. More...
	getAjax ()
	Get ajax. More...
	setSecondaryHighlightedNodes ($a_val)
	Set secondary (background) highlighted nodes. More...
	getSecondaryHighlightedNodes ()
	Get secondary (background) highlighted nodes. More...
	setNodeOpen ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour) More...
	setSelectMode ($a_postvar, $a_multi=false)
	Set select mode (to deactivate, pass an empty string as postvar) More...
	setNodeSelected ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour) More...
	setOfflineMode ($a_val)
	Set offline mode. More...
	getOfflineMode ()
	Get offline mode. More...
	handleCommand ()
	Handle explorer internal command. More...
	getContainerId ()
	Get container id. More...
	openNode ()
	Open node. More...
	closeNode ()
	Close node. More...
	getNodeAsync ()
	Get node asynchronously. More...
	beforeRendering ()
	Before rendering. More...
	getOnLoadCode ()
	Get on load code. More...
	getHTML ()
	Get HTML. More...
	renderNode ($a_node, $tpl)
	Render node. More...
	renderChilds ($a_node_id, $tpl)
	Render childs. More...
	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id. More...
	getNodeIdForDomNodeId ($a_dom_node_id)
	Get node id for dom node id. More...
	listItemStart ($tpl, $a_node)
	List item start. More...
	listItemEnd ($tpl)
	List item end. More...
	listStart ($tpl)
	List start. More...
	listEnd ($tpl)
	List end. More...
	isNodeOnclickEnabled ()
	setNodeOnclickEnabled ($nodeOnclickEnabled)
	isEnableDnd ()
	setEnableDnd ($enable_dnd)
	Enable Drag & Drop functionality. More...
Public Member Functions inherited from ILIAS\UI\Component\Tree\TreeRecursion
	build (Node\Factory $factory, $record, $environment=null)
	Build and return a Node. More...

Protected Member Functions
	preloadChilds ()
	Preload childs. More...
	matches ($node)
	Does a node match a search term (or is search term empty) More...
	getRootId ()
	createNode (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record)
	Creates at tree node, can be overwritten in derivatives if another node type should be used. More...
	getNodeStateToggleCmdClasses ($record)
	Should return an array of ilCtrl-enabled command classes which should be used to build the URL for the expand/collapse actions applied on a tree node. More...
	render ()
	Render tree. More...
Protected Member Functions inherited from ilExplorerBaseGUI
	isNodeSelectable ($a_node)
	Is node selectable? More...
	getNodeToggleOnClick ($a_node)
	Get onclick attribute for node toggling. More...
	getSelectOnClick ($a_node)
	Get onclick attribute for selecting radio/checkbox. More...
	isNodeOpen ($node_id)
	Get all open nodes. More...
	getJSTreePlugins ()

Protected Attributes
	$lng
	$httpRequest
	$tree = null
	$tree_label = ""
	$order_field = ""
	$order_field_numeric = false
	$type_white_list = array()
	$type_black_list = array()
	$childs = array()
	$preloaded = false
	$preload_childs = false
	$root_node_data = null
	$all_childs = array()
	$ui
Protected Attributes inherited from ilExplorerBaseGUI
	$log
	$ctrl
	$tpl
	$skip_root_node = false
	$ajax = false
	$custom_open_nodes = array()
	$selected_nodes = array()
	$select_postvar = ""
	$offline_mode = false
	$sec_highl_nodes = array()
	$enable_dnd = false
	$search_term = ""
	$open_nodes = []
	$store
	$parent_obj
	$child_limit = 0
	$parent_cmd = ''

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()
	Get local path of explorer js. More...
static	getLocalJsTreeJsPath ()
	Get local path of jsTree js. More...
static	getLocalJsTreeCssPath ()
	Get local path of jsTree js. More...
static	createHTMLExportDirs ($a_target_dir)
	Create html export directories. More...
static	init ($a_main_tpl=null)
	Init JS. More...
Static Protected Attributes inherited from ilExplorerBaseGUI
static	$js_tree_path = "./libs/bower/bower_components/jstree/dist/jstree.js"
static	$js_tree_path_css = "./libs/bower/bower_components/jstree/dist/themes/default/style.min.css"
static	$js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js"

Detailed Description

Explorer class that works on tree objects (Services/Tree)

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 14 of file class.ilTreeExplorerGUI.php.

Constructor & Destructor Documentation

__construct()

ilTreeExplorerGUI::__construct	(		$a_expl_id,
			$a_parent_obj,
			$a_parent_cmd,
			$a_tree
	)

Constructor.

Definition at line 42 of file class.ilTreeExplorerGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ui().

    {
        global $DIC;

        $this->httpRequest = $DIC->http()->request();
        $this->ui = $DIC->ui();
        $this->lng = $DIC->language();
        parent::__construct($a_expl_id, $a_parent_obj, $a_parent_cmd);
        $this->tree = $a_tree;
    }

Here is the call graph for this function:

Member Function Documentation

build()

ilTreeExplorerGUI::build	(	\ILIAS\UI\Component\Tree\Node\Factory	$factory,
			$record,
			$environment = null
	)

Definition at line 399 of file class.ilTreeExplorerGUI.php.

References $url, createNode(), ilExplorerBaseGUI\getNodeHref(), getNodeId(), getNodeStateToggleCmdClasses(), ILIAS_HTTP_PATH, and ilExplorerBaseGUI\isNodeOpen().

      : \ILIAS\UI\Component\Tree\Node\Node {
        $node = $this->createNode($factory, $record);

        $href = $this->getNodeHref($record);
        if (is_string($href) && strlen($href) > 0 && '#' !== $href) {
            $node = $node->withLink(new \ILIAS\Data\URI(ILIAS_HTTP_PATH . '/' . $href));
        }

        if ($this->isNodeOpen((int) $this->getNodeId($record))) {
            $node = $node->withExpanded(true);
        }

        $nodeStateToggleCmdClasses = $this->getNodeStateToggleCmdClasses($record);
        $cmdClass = end($nodeStateToggleCmdClasses);

        if (is_string($cmdClass) && strlen($cmdClass) > 0) {
            $node = $node->withAdditionalOnLoadCode(function ($id) use ($record, $nodeStateToggleCmdClasses, $cmdClass) {
                $serverNodeId = $this->getNodeId($record);

                $this->ctrl->setParameterByClass($cmdClass, 'node_id', $serverNodeId);
                $url = $this->ctrl->getLinkTargetByClass($nodeStateToggleCmdClasses, 'toggleExplorerNodeState', '', true, false);
                $this->ctrl->setParameterByClass($cmdClass, 'node_id', null);

                $javascript = "$('#$id').on('click', function(event) {
                                        let node = $(this);
        
                                        if (node.hasClass('expandable')) {
                                                il.UI.tree.toggleNodeState(event, '$url', 'prior_state', node.hasClass('expanded'));
                                                event.preventDefault();
                                                event.stopPropagation();
                                        }
                                });";

                return $javascript;
            });
        }

        return $node;
    }

Here is the call graph for this function:

createNode()

ilTreeExplorerGUI::createNode ( \ILIAS\UI\Component\Tree\Node\Factory  $factory,   $record  )

protected

Creates at tree node, can be overwritten in derivatives if another node type should be used.

Definition at line 367 of file class.ilTreeExplorerGUI.php.

References ilExplorerBaseGUI\getNodeContent(), ilExplorerBaseGUI\getNodeIcon(), getNodeIconAlt(), and ui().

Referenced by build().

      : \ILIAS\UI\Component\Tree\Node\Node {
        $nodeIconPath = $this->getNodeIcon($record);

        $icon = null;
        if (is_string($nodeIconPath) && strlen($nodeIconPath) > 0) {
            $icon = $this->ui
                ->factory()
                ->symbol()
                ->icon()
                ->custom($nodeIconPath, $this->getNodeIconAlt($record));
        }

        return $factory->simple($this->getNodeContent($record), $icon);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getChildren()

ilTreeExplorerGUI::getChildren	(		$node,
			$environment = null
	)

Get a list of records (that list can also be empty).Each record will be relayed to $this->build to retrieve a Node. Also, each record will be asked for Sub-Nodes using this function.

Returns

array

Implements ILIAS\UI\Component\Tree\TreeRecursion.

Definition at line 359 of file class.ilTreeExplorerGUI.php.

References getChildsOfNode().

                                                            : array
    {
        return $this->getChildsOfNode($node["child"]);
    }

Here is the call graph for this function:

getChildsOfNode()

ilTreeExplorerGUI::getChildsOfNode

(

$a_parent_node_id

)

Get childs of node.

Parameters

int

$a_parent_node_id

parent id

Returns

array childs

Definition at line 222 of file class.ilTreeExplorerGUI.php.

References Vendor\Package\$c, $childs, ilExplorerBaseGUI\getDomNodeIdForNodeId(), getOrderField(), ilExplorerBaseGUI\getSearchTerm(), getTypeBlackList(), getTypeWhiteList(), and matches().

Referenced by ilPublicSectionExplorerGUI\getAllNodes(), and getChildren().

    {
        if ($this->preloaded && $this->getSearchTerm() == "") {
            if (is_array($this->childs[$a_parent_node_id])) {
                return $this->childs[$a_parent_node_id];
            }
            return array();
        }

        $wl = $this->getTypeWhiteList();
        if (is_array($wl) && count($wl) > 0) {
            $childs = $this->tree->getChildsByTypeFilter($a_parent_node_id, $wl, $this->getOrderField());
        } else {
            $childs = $this->tree->getChilds($a_parent_node_id, $this->getOrderField());
        }
        
        // apply black list filter
        $bl = $this->getTypeBlackList();
        if (is_array($bl) && count($bl) > 0) {
            $bl_childs = array();
            foreach ($childs as $k => $c) {
                if (!in_array($c["type"], $bl) && ($this->matches($c) || $this->requested_node_id != $this->getDomNodeIdForNodeId($a_parent_node_id))) {
                    $bl_childs[$k] = $c;
                }
            }
            return $bl_childs;
        }

        $final_childs = [];
        foreach ($childs as $k => $c) {
            if ($this->matches($c) || $this->requested_node_id != $this->getDomNodeIdForNodeId($a_parent_node_id)) {
                $final_childs[$k] = $c;
            }
        }
        
        return $final_childs;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

ilTreeExplorerGUI::getHTML

(

$new = false

)

Get HTML.

Returns

string html

Definition at line 343 of file class.ilTreeExplorerGUI.php.

References getPreloadChilds(), preloadChilds(), and render().

    {
        if ($this->getPreloadChilds()) {
            $this->preloadChilds();
        }
        if (!$new) {
            return parent::getHTML();
        }
        return $this->render();
    }

Here is the call graph for this function:

getNodeIconAlt()

ilTreeExplorerGUI::getNodeIconAlt

(

$a_node

)

Get node icon alt attribute.

Parameters

mixed

$a_node

node object/array

Returns

string image alt attribute

Definition at line 293 of file class.ilTreeExplorerGUI.php.

References $lng.

Referenced by ilForumExplorerGUI\createNode(), and createNode().

    {
        $lng = $this->lng;
        
        return $lng->txt("icon") . " " . $lng->txt("obj_" . $a_node["type"]);
    }

Here is the caller graph for this function:

getNodeId()

ilTreeExplorerGUI::getNodeId

(

$a_node

)

Get id for node.

Parameters

mixed

$a_node

node object/array

Returns

string id

Definition at line 282 of file class.ilTreeExplorerGUI.php.

Referenced by build(), ilPublicSectionExplorerGUI\getAllNodes(), ilMediaPoolExplorerGUI\getNodeContent(), ilSCORM2004EditorExplorerGUI\getNodeContent(), ilLMExplorerGUI\getNodeContent(), ilMailExplorer\getNodeContent(), ilAdministrationExplorerGUI\getNodeContent(), ilRepositoryExplorerGUI\getNodeContent(), ilRepositorySelectorExplorerGUI\getNodeContent(), ilLMTOCExplorerGUI\getNodeContent(), ilSCORM2004EditorExplorerGUI\getNodeHref(), ilMailExplorer\getNodeHref(), ilLMEditorExplorerGUI\getNodeIcon(), ilPublicSectionExplorerGUI\getNodeIcon(), ilMediaPoolExplorerGUI\getNodeIcon(), ilSCORM2004EditorExplorerGUI\getNodeIcon(), ilMailExplorer\getNodeIcon(), ilSCORM2004EditorExplorerGUI\getNodeIconAlt(), ilMailExplorer\getNodeIconAlt(), ilAdministrationExplorerGUI\getNodeIconAlt(), ilRepositoryExplorerGUI\getNodeIconAlt(), ilRepositorySelectorExplorerGUI\getNodeIconAlt(), ilMediaPoolExplorerGUI\isNodeHighlighted(), ilSCORM2004EditorExplorerGUI\isNodeHighlighted(), ilLMExplorerGUI\isNodeHighlighted(), ilAdministrationExplorerGUI\isNodeHighlighted(), ilRepositoryExplorerGUI\isNodeHighlighted(), and ilRepositorySelectorExplorerGUI\isNodeHighlighted().

    {
        return $a_node["child"];
    }

Here is the caller graph for this function:

getNodeStateToggleCmdClasses()

ilTreeExplorerGUI::getNodeStateToggleCmdClasses (   $record )

protected

Should return an array of ilCtrl-enabled command classes which should be used to build the URL for the expand/collapse actions applied on a tree node.

Parameters

$record

Returns

array

Definition at line 391 of file class.ilTreeExplorerGUI.php.

Referenced by build().

                                                             : array
    {
        return [];
    }

Here is the caller graph for this function:

getOrderField()

ilTreeExplorerGUI::getOrderField

(

)

Get order field.

Returns

string order field key

Definition at line 79 of file class.ilTreeExplorerGUI.php.

References $order_field.

Referenced by getChildsOfNode().

    {
        return $this->order_field;
    }

Here is the caller graph for this function:

getPreloadChilds()

ilTreeExplorerGUI::getPreloadChilds

(

)

Get preload childs.

Returns

boolean preload childs

Definition at line 139 of file class.ilTreeExplorerGUI.php.

References $preload_childs.

Referenced by getHTML().

    {
        return $this->preload_childs;
    }

Here is the caller graph for this function:

getRootId()

ilTreeExplorerGUI::getRootId ( )

protected

Definition at line 318 of file class.ilTreeExplorerGUI.php.

References getTree().

Referenced by getRootNode(), and ilWorkspaceExplorerGUI\isNodeHighlighted().

    {
        return $this->root_id
            ? $this->root_id
            : $this->getTree()->readRootId();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRootNode()

ilTreeExplorerGUI::getRootNode

(

)

Get root node.

Returns

mixed node object/array

Definition at line 305 of file class.ilTreeExplorerGUI.php.

References $root_node_data, getRootId(), and getTree().

Referenced by ilPublicSectionExplorerGUI\getAllNodes(), ilMediaPoolExplorerGUI\getNodeContent(), ilSCORM2004EditorExplorerGUI\getNodeContent(), ilTaxonomyExplorerGUI\getNodeContent(), ilLMExplorerGUI\getNodeContent(), ilMailExplorer\getNodeContent(), ilAdministrationExplorerGUI\getNodeContent(), ilRepositorySelectorExplorerGUI\getNodeContent(), ilSCORM2004EditorExplorerGUI\getNodeHref(), ilMailExplorer\getNodeHref(), ilLMEditorExplorerGUI\getNodeIcon(), ilPublicSectionExplorerGUI\getNodeIcon(), ilMediaPoolExplorerGUI\getNodeIcon(), ilSCORM2004EditorExplorerGUI\getNodeIcon(), ilMailExplorer\getNodeIcon(), ilSCORM2004EditorExplorerGUI\getNodeIconAlt(), ilMailExplorer\getNodeIconAlt(), ilAdministrationExplorerGUI\getNodeIconAlt(), ilRepositorySelectorExplorerGUI\getNodeIconAlt(), getTreeComponent(), ilMediaPoolExplorerGUI\isNodeHighlighted(), ilSCORM2004EditorExplorerGUI\isNodeHighlighted(), ilLMExplorerGUI\isNodeHighlighted(), ilAdministrationExplorerGUI\isNodeHighlighted(), ilRepositorySelectorExplorerGUI\isNodeHighlighted(), and preloadChilds().

    {
        if (!isset($this->root_node_data)) {
            $this->root_node_data = $this->getTree()->getNodeData($this->getRootId());
        }
        return $this->root_node_data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSuccessorNode()

ilTreeExplorerGUI::getSuccessorNode	(		$a_node_id,
			$a_type = ""
	)

Get successor node (currently only(!) based on lft/rgt tree values)

Parameters

integer	$a_node_id	node id
string	$a_type	node type

Returns

mixed node id or false

Definition at line 196 of file class.ilTreeExplorerGUI.php.

References $a_type, and getTree().

Referenced by ilLMTOCExplorerGUI\isNodeClickable().

    {
        if ($this->order_field != "") {
            die("ilTreeExplorerGUI::getSuccessorNode not implemented for order field " . $this->order_field);
        }

        if ($this->preloaded) {
            $next_id = $a_node_id;
            while (($next_id = $this->all_childs[$next_id]["next_node_id"]) && $a_type != "" &&
                $this->all_childs[$next_id]["type"] != $a_type);
            if ($next_id) {
                return $this->all_childs[$next_id];
            }
            return false;
        }
        return $this->getTree()->fetchSuccessorNode($a_node_id, $a_type);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTree()

ilTreeExplorerGUI::getTree

(

)

Get tree.

Returns

object tree object

Definition at line 58 of file class.ilTreeExplorerGUI.php.

References $tree.

Referenced by ilLMTOCExplorerGUI\getNodeHref(), getRootId(), ilSkillTemplateTreeExplorerGUI\getRootNode(), ilOrgUnitExplorerGUI\getRootNode(), ilRepositoryExplorerGUI\getRootNode(), ilLMTOCExplorerGUI\getRootNode(), getRootNode(), getSuccessorNode(), getTreeComponent(), ilLMTOCExplorerGUI\isNodeClickable(), and setPathOpen().

    {
        return $this->tree;
    }

Here is the caller graph for this function:

getTreeComponent()

ilTreeExplorerGUI::getTreeComponent

(

)

Get Tree UI.

Returns

|object

Definition at line 456 of file class.ilTreeExplorerGUI.php.

References $data, Vendor\Package\$f, $tree, ilExplorerBaseGUI\getNodeContent(), getRootNode(), getTree(), getTreeLabel(), and ui().

Referenced by render().

    {
        $f = $this->ui->factory();
        $tree = $this->getTree();

        $data = array(
            $tree->getNodeData($tree->readRootId())
        );

        $label = $this->getTreeLabel();
        if ($this->getTreeLabel() == "" && $this->getNodeContent($this->getRootNode())) {
            $label = $this->getNodeContent($this->getRootNode());
        }

        $tree = $f->tree()->expandable($label, $this)
            ->withData($data)
            ->withHighlightOnNodeClick(true);

        return $tree;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTreeLabel()

ilTreeExplorerGUI::getTreeLabel

(

)

Returns

string

Definition at line 446 of file class.ilTreeExplorerGUI.php.

References $tree_label.

Referenced by getTreeComponent().

    {
        return $this->tree_label;
    }

Here is the caller graph for this function:

getTypeBlackList()

ilTreeExplorerGUI::getTypeBlackList

(

)

Get type black list.

Returns

array array of strings of node types that should be filtered out

Definition at line 119 of file class.ilTreeExplorerGUI.php.

References $type_black_list.

Referenced by getChildsOfNode(), and preloadChilds().

    {
        return $this->type_black_list;
    }

Here is the caller graph for this function:

getTypeWhiteList()

ilTreeExplorerGUI::getTypeWhiteList

(

)

Get type white list.

Returns

array array of strings of node types that should be retrieved

Definition at line 99 of file class.ilTreeExplorerGUI.php.

References $type_white_list.

Referenced by ilIntLinkRepItemExplorerGUI\__construct(), getChildsOfNode(), preloadChilds(), ilConditionSelector\setRefId(), and ilRepositorySelectorExplorerGUI\sortChilds().

    {
        return $this->type_white_list;
    }

Here is the caller graph for this function:

matches()

ilTreeExplorerGUI::matches (   $node )

protected

Does a node match a search term (or is search term empty)

Parameters

array

Returns

bool

Definition at line 266 of file class.ilTreeExplorerGUI.php.

References ilExplorerBaseGUI\getNodeContent(), and ilExplorerBaseGUI\getSearchTerm().

Referenced by getChildsOfNode().

                                      : bool
    {
        if ($this->getSearchTerm() == "" ||
            is_int(stripos($this->getNodeContent($node), $this->getSearchTerm()))) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

preloadChilds()

ilTreeExplorerGUI::preloadChilds ( )

protected

Preload childs.

Definition at line 147 of file class.ilTreeExplorerGUI.php.

References Vendor\Package\$c, $childs, getRootNode(), getTypeBlackList(), getTypeWhiteList(), and ilUtil\sortArray().

Referenced by getHTML().

    {
        $subtree = $this->tree->getSubTree($this->getRootNode());
        foreach ($subtree as $s) {
            $wl = $this->getTypeWhiteList();
            if (is_array($wl) && count($wl) > 0 && !in_array($s["type"], $wl)) {
                continue;
            }
            $bl = $this->getTypeBlackList();
            if (is_array($bl) && count($bl) > 0 && in_array($s["type"], $bl)) {
                continue;
            }
            $this->childs[$s["parent"]][] = $s;
            $this->all_childs[$s["child"]] = $s;
        }

        if ($this->order_field != "") {
            foreach ($this->childs as $k => $childs) {
                $this->childs[$k] = ilUtil::sortArray($childs, $this->order_field, "asc", $this->order_field_numeric);
            }
        }

        // sort childs and store prev/next reference
        if ($this->order_field == "") {
            $this->all_childs =
                ilUtil::sortArray($this->all_childs, "lft", "asc", true, true);
            $prev = false;
            foreach ($this->all_childs as $k => $c) {
                if ($prev) {
                    $this->all_childs[$prev]["next_node_id"] = $k;
                }
                $this->all_childs[$k]["prev_node_id"] = $prev;
                $this->all_childs[$k]["next_node_id"] = false;
                $prev = $k;
            }
        }

        $this->preloaded = true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

render()

ilTreeExplorerGUI::render ( )

protected

Render tree.

Returns

string

Definition at line 503 of file class.ilTreeExplorerGUI.php.

References getTreeComponent(), and ui().

Referenced by getHTML().

    {
        $r = $this->ui->renderer();

        return $r->render([
            $this->getTreeComponent()
        ]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setOrderField()

ilTreeExplorerGUI::setOrderField	(		$a_val,
			$a_numeric = false
	)

Set order field.

Parameters

string

$a_val

order field key

Definition at line 68 of file class.ilTreeExplorerGUI.php.

Referenced by ilMediaPoolExplorerGUI\__construct(), ilTaxonomyExplorerGUI\__construct(), ilMailExplorer\__construct(), ilSkillTemplateTreeExplorerGUI\__construct(), ilAdministrationExplorerGUI\__construct(), ilRepositoryExplorerGUI\__construct(), and ilRepositorySelectorExplorerGUI\__construct().

    {
        $this->order_field = $a_val;
        $this->order_field_numeric = $a_numeric;
    }

Here is the caller graph for this function:

setPathOpen()

ilTreeExplorerGUI::setPathOpen

(

$a_id

)

Set node path to be opened.

Parameters

string

$a_id

node id

Definition at line 330 of file class.ilTreeExplorerGUI.php.

References getTree(), and ilExplorerBaseGUI\setNodeOpen().

Referenced by ilGroupActionTargetExplorerGUI\__construct(), ilLMExplorerGUI\__construct(), ilWorkspaceExplorerGUI\__construct(), ilAdministrationExplorerGUI\__construct(), ilRepositoryExplorerGUI\__construct(), and ilRepositorySelectorExplorerGUI\__construct().

    {
        $path = $this->getTree()->getPathId($a_id);
        foreach ($path as $id) {
            $this->setNodeOpen($id);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setPreloadChilds()

ilTreeExplorerGUI::setPreloadChilds

(

$a_val

)

Set preload childs.

Parameters

boolean

$a_val

preload childs

Definition at line 129 of file class.ilTreeExplorerGUI.php.

Referenced by ilTaxonomyExplorerGUI\__construct(), ilLMExplorerGUI\__construct(), and ilForumExplorerGUI\__construct().

    {
        $this->preload_childs = $a_val;
    }

Here is the caller graph for this function:

setRootId()

ilTreeExplorerGUI::setRootId

(

$a_root

)

Definition at line 313 of file class.ilTreeExplorerGUI.php.

    {
        $this->root_id = $a_root;
    }

setTypeBlackList()

ilTreeExplorerGUI::setTypeBlackList

(

$a_val

)

Set type black list.

Parameters

array

$a_val

array of strings of node types that should be filtered out

Definition at line 109 of file class.ilTreeExplorerGUI.php.

    {
        $this->type_black_list = $a_val;
    }

setTypeWhiteList()

ilTreeExplorerGUI::setTypeWhiteList

(

$a_val

)

Set type white list.

Parameters

array

$a_val

array of strings of node types that should be retrieved

Definition at line 89 of file class.ilTreeExplorerGUI.php.

Referenced by ilTestQuestionPoolSelectorExplorer\__construct(), ilForumMoveTopicsExplorer\__construct(), ilPCFileItemFileSelectorGUI\__construct(), ilIntLinkRepItemExplorerGUI\__construct(), ilMediaPoolExplorerGUI\__construct(), ilSkillTemplateTreeExplorerGUI\__construct(), ilMaterialExplorer\__construct(), ilOrgUnitExplorerGUI\__construct(), ilAdministrationExplorerGUI\__construct(), ilWorkspaceExplorerGUI\__construct(), ilRepositoryExplorerGUI\__construct(), ilLMTOCExplorerGUI\__construct(), ilRepositorySelectorExplorerGUI\__construct(), ilPersonalSkillsGUI\assignMaterial(), ilWorkspaceGSToolProvider\getTree(), ilObjWorkspaceFolderGUI\render(), ilExSubmissionObjectGUI\renderWorkspaceExplorer(), and ilObjWorkspaceFolderGUI\showMoveIntoObjectTree().

    {
        $this->type_white_list = $a_val;
    }

Here is the caller graph for this function:

toggleExplorerNodeState()

ilTreeExplorerGUI::toggleExplorerNodeState

(

)

Should be called by an ilCtrl-enabled command class if a tree node toggle action should be processed.

Definition at line 480 of file class.ilTreeExplorerGUI.php.

References exit.

Referenced by ilMailGUI\toggleExplorerNodeState(), and ilObjForumGUI\toggleExplorerNodeStateObject().

                                              : void
    {
        $nodeId = (int) ($this->httpRequest->getQueryParams()['node_id'] ?? 0);
        $priorState = (int) ($this->httpRequest->getQueryParams()['prior_state'] ?? 0);

        if ($nodeId > 0) {
            if (0 === $priorState && !in_array($nodeId, $this->open_nodes)) {
                $this->open_nodes[] = $nodeId;
            } elseif (1 === $priorState && in_array($nodeId, $this->open_nodes)) {
                $key = array_search($nodeId, $this->open_nodes);
                unset($this->open_nodes[$key]);
            }

            $this->store->set('on_' . $this->id, serialize($this->open_nodes));
        }
        exit();
    }

Here is the caller graph for this function:

Field Documentation

$all_childs

ilTreeExplorerGUI::$all_childs = array()

protected

Definition at line 32 of file class.ilTreeExplorerGUI.php.

$childs

ilTreeExplorerGUI::$childs = array()

protected

Definition at line 28 of file class.ilTreeExplorerGUI.php.

Referenced by ilSkillTemplateTreeExplorerGUI\getChildsOfNode(), ilPersonalSkillExplorerGUI\getChildsOfNode(), getChildsOfNode(), ilRepositoryExplorerGUI\getChildsOfNode(), preloadChilds(), ilAdministrationExplorerGUI\sortChilds(), ilRepositorySelectorExplorerGUI\sortChilds(), and ilRepositoryExplorerGUI\sortChilds().

$httpRequest

ilTreeExplorerGUI::$httpRequest

protected

Definition at line 20 of file class.ilTreeExplorerGUI.php.

$lng

ilTreeExplorerGUI::$lng

protected

Definition at line 17 of file class.ilTreeExplorerGUI.php.

Referenced by ilMediaPoolExplorerGUI\getNodeContent(), ilSCORM2004EditorExplorerGUI\getNodeContent(), ilLMEditorExplorerGUI\getNodeIconAlt(), ilSCORM2004EditorExplorerGUI\getNodeIconAlt(), and getNodeIconAlt().

$order_field

ilTreeExplorerGUI::$order_field = ""

protected

Definition at line 24 of file class.ilTreeExplorerGUI.php.

Referenced by getOrderField().

$order_field_numeric

ilTreeExplorerGUI::$order_field_numeric = false

protected

Definition at line 25 of file class.ilTreeExplorerGUI.php.

$preload_childs

ilTreeExplorerGUI::$preload_childs = false

protected

Definition at line 30 of file class.ilTreeExplorerGUI.php.

Referenced by getPreloadChilds().

$preloaded

ilTreeExplorerGUI::$preloaded = false

protected

Definition at line 29 of file class.ilTreeExplorerGUI.php.

$root_node_data

ilTreeExplorerGUI::$root_node_data = null

protected

Definition at line 31 of file class.ilTreeExplorerGUI.php.

Referenced by getRootNode().

$tree

ilTreeExplorerGUI::$tree = null

protected

Definition at line 22 of file class.ilTreeExplorerGUI.php.

Referenced by ilPublicSectionExplorerGUI\__construct(), ilSCORM2004EditorExplorerGUI\__construct(), ilLMExplorerGUI\__construct(), ilSkillTemplateTreeExplorerGUI\__construct(), ilMaterialExplorer\__construct(), ilAdministrationExplorerGUI\__construct(), ilRepositoryExplorerGUI\__construct(), ilRepositorySelectorExplorerGUI\__construct(), ilRepositoryExplorerGUI\getTopNodeForRefId(), getTree(), ilMailExplorer\getTreeComponent(), ilForumExplorerGUI\getTreeComponent(), getTreeComponent(), ilAdministrationExplorerGUI\isNodeClickable(), ilRepositoryExplorerGUI\isNodeClickable(), ilConditionSelector\isNodeVisible(), ilRepositoryExplorerGUI\isNodeVisible(), and ilConditionSelector\setRefId().

$tree_label

ilTreeExplorerGUI::$tree_label = ""

protected

Definition at line 23 of file class.ilTreeExplorerGUI.php.

Referenced by getTreeLabel().

$type_black_list

ilTreeExplorerGUI::$type_black_list = array()

protected

Definition at line 27 of file class.ilTreeExplorerGUI.php.

Referenced by getTypeBlackList().

$type_white_list

ilTreeExplorerGUI::$type_white_list = array()

protected

Definition at line 26 of file class.ilTreeExplorerGUI.php.

Referenced by getTypeWhiteList().

$ui

ilTreeExplorerGUI::$ui

protected

Definition at line 37 of file class.ilTreeExplorerGUI.php.

---

The documentation for this class was generated from the following file:

• Services/UIComponent/Explorer2/classes/class.ilTreeExplorerGUI.php