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

Inheritance diagram for ilTreeExplorerGUI:

Collaboration diagram for ilTreeExplorerGUI:

Public Member Functions
	__construct (string $a_expl_id, $a_parent_obj, string $a_parent_cmd, ilTree $a_tree, string $a_node_parameter_name="node_id")

	getTree ()

	setOrderField (string $a_val, bool $a_numeric=false)

	getOrderField ()

	setTypeWhiteList (array $a_val)
	Set type white list. More...

	getTypeWhiteList ()
	Get type white list. More...

	setTypeBlackList (array $a_val)
	Set type black list. More...

	getTypeBlackList ()
	Get type black list. More...

	setPreloadChilds (bool $a_val)

	getPreloadChilds ()

	getSuccessorNode ( $a_node_id, string $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 ($record, $environment=null)
	Get a list of records (that list can also be empty). More...

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

	getTreeLabel ()

	getTreeComponent ()

	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
	setChildLimit (int $a_val)

	getChildLimit ()

	setSearchTerm (string $a_val)

	getSearchTerm ()

	setMainTemplate (ilGlobalTemplateInterface $a_main_tpl=null)

	getRootNode ()
	Get root node. More...

	getChildsOfNode ($a_parent_node_id)
	Get children 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 children Please note that this standard method may not be optimal depending on what a derived class does in isNodeVisible. More...

	sortChilds (array $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 (bool $a_val)

	getSkipRootNode ()

	setAjax (bool $a_val)

	getAjax ()

	setSecondaryHighlightedNodes (array $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 (string $a_postvar, bool $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 (bool $a_val)

	getOfflineMode ()

	handleCommand ()
	Handle explorer internal command. More...

	getContainerId ()

	openNode ()
	Open node. More...

	closeNode ()
	Close node. More...

	getNodeAsync ()
	Get node asynchronously. More...

	beforeRendering ()
	Before rendering. More...

	getOnLoadCode ()
	Get on load code. More...

	getHTML ()

	renderNode ($a_node, ilTemplate $tpl)
	Render node. More...

	renderChilds ($a_node_id, ilTemplate $tpl)
	Render childs. More...

	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id. More...

	getNodeIdForDomNodeId (string $a_dom_node_id)
	Get node id for dom node id. More...

	listItemStart (ilTemplate $tpl, $a_node)
	List item start. More...

	listItemEnd (ilTemplate $tpl)

	listStart (ilTemplate $tpl)

	listEnd (ilTemplate $tpl)

	isNodeOnclickEnabled ()

	setNodeOnclickEnabled (bool $nodeOnclickEnabled)

	isEnableDnd ()

	setEnableDnd (bool $enable_dnd)

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 ()

	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 ()

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 ()

	isNodeRequested (string $a_node_id)

Protected Attributes
ilLanguage	$lng

Psr Http Message ServerRequestInterface	$httpRequest

ilTree	$tree = null

string	$tree_label = ""

string	$order_field = ""

bool	$order_field_numeric = false

array	$type_white_list = array()

array	$type_black_list = array()

array	$childs = array()

bool	$preloaded = false

bool	$preload_childs = false

array	$root_node_data = null

array	$all_childs = array()

	$root_id = 0

ILIAS DI UIServices	$ui

Protected Attributes inherited from ilExplorerBaseGUI
string	$node_parameter_name

ilLogger	$log

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

bool	$skip_root_node = false

bool	$ajax = false

array	$custom_open_nodes = array()

array	$selected_nodes = array()

string	$select_postvar = ""

bool	$offline_mode = false

array	$sec_highl_nodes = array()

bool	$enable_dnd = false

string	$search_term = ""

array	$open_nodes = []

ilSessionIStorage	$store

bool	$select_multi = false

	$parent_obj

int	$child_limit = 0

string	$parent_cmd = ''

string	$requested_exp_cmd = ""

string	$requested_exp_cont = ""

string	$requested_searchterm = ""

string	$requested_node_id = ""

string	$id

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()

static	getLocalJsTreeJsPath ()

static	getLocalJsTreeCssPath ()

static	createHTMLExportDirs (string $a_target_dir)

static	init (ilGlobalTemplateInterface $a_main_tpl=null)

Static Protected Attributes inherited from ilExplorerBaseGUI
static string	$js_tree_path = "./node_modules/jstree/dist/jstree.js"

static string	$js_tree_path_css = "./node_modules/jstree/dist/themes/default/style.min.css"

static string	$js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js"

Detailed Description

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

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Deprecated:: 10

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

Constructor & Destructor Documentation

◆ __construct()

ilTreeExplorerGUI::__construct	(	string	$a_expl_id,
			$a_parent_obj,
		string	$a_parent_cmd,
		ilTree	$a_tree,
		string	$a_node_parameter_name = `"node_id"`
	)

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\lng(), and ILIAS\Repository\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, $a_node_parameter_name);
         $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 377 of file class.ilTreeExplorerGUI.php.

References ilExplorerBaseGUI\$id, $url, createNode(), ILIAS\Repository\ctrl(), ilExplorerBaseGUI\getNodeHref(), getNodeId(), getNodeStateToggleCmdClasses(), and ilExplorerBaseGUI\isNodeOpen().

      : \ILIAS\UI\Component\Tree\Node\Node {
         $node = $this->createNode($factory, $record);
 
         $href = $this->getNodeHref($record);
         if ($href !== '' && '#' !== $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) && $cmdClass !== '') {
             $node = $node->withAdditionalOnLoadCode(function ($id) use ($record, $nodeStateToggleCmdClasses, $cmdClass): string {
                 $serverNodeId = $this->getNodeId($record);
 
                 $this->ctrl->setParameterByClass($cmdClass, $this->node_parameter_name, $serverNodeId);
                 $url = $this->ctrl->getLinkTargetByClass($nodeStateToggleCmdClasses, 'toggleExplorerNodeState', '', true, false);
                 $this->ctrl->setParameterByClass($cmdClass, $this->node_parameter_name, null);
 
                 $javascript = "il.UI.tree.registerToggleNodeAsyncAction('$id', '$url', 'prior_state');";
 
                 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 348 of file class.ilTreeExplorerGUI.php.

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

Referenced by build().

      : \ILIAS\UI\Component\Tree\Node\Node {
         $nodeIconPath = $this->getNodeIcon($record);
 
         $icon = null;
         if ($nodeIconPath !== '') {
             $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	(	$record,
		$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.

Implements ILIAS\UI\Component\Tree\TreeRecursion.

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

References getChildsOfNode().

Referenced by ilLMTOCExplorerGUI\renderLSTocNode().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildsOfNode()

ilTreeExplorerGUI::getChildsOfNode ( $a_parent_node_id )

Get childs of node.

Parameters

int | string $a_parent_node_id parent id

Returns: array childs

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

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

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

                                                       : array
     {
         if ($this->preloaded && $this->getSearchTerm() === "") {
             if (isset($this->childs[$a_parent_node_id]) && is_array($this->childs[$a_parent_node_id])) {
                 return $this->childs[$a_parent_node_id];
             }
             return array();
         }
 
         $wl = $this->getTypeWhiteList();
         if (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, true) && ($this->matches($c) || !$this->isNodeRequested($a_parent_node_id))) {
                     $bl_childs[$k] = $c;
                 }
             }
             return $bl_childs;
         }
 
         $final_childs = [];
         foreach ($childs as $k => $c) {
             if ($this->matches($c) || !$this->isNodeRequested($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 327 of file class.ilTreeExplorerGUI.php.

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

                                          : string
     {
         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

object | array $a_node node

Returns: string image alt attribute

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

References $lng, and ilLanguage\txt().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNodeId()

ilTreeExplorerGUI::getNodeId ( $a_node )

Get id for node.

Parameters

object | array $a_node

Returns: string

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

Referenced by build(), ilTaxonomyClassificationExplorerGUI\createNode(), ilPublicSectionExplorerGUI\getAllNodes(), ilMediaPoolExplorerGUI\getNodeContent(), ilAdministrationExplorerGUI\getNodeContent(), ilLMExplorerGUI\getNodeContent(), ilRepositoryExplorerGUI\getNodeContent(), ilRepositorySelectorExplorerGUI\getNodeContent(), ilMailExplorer\getNodeContent(), ilLMTOCExplorerGUI\getNodeContent(), ilMailExplorer\getNodeHref(), ilLMEditorExplorerGUI\getNodeIcon(), ilPublicSectionExplorerGUI\getNodeIcon(), ilMediaPoolExplorerGUI\getNodeIcon(), ilMailExplorer\getNodeIcon(), ilAdministrationExplorerGUI\getNodeIconAlt(), ilRepositoryExplorerGUI\getNodeIconAlt(), ilRepositorySelectorExplorerGUI\getNodeIconAlt(), ilMediaPoolExplorerGUI\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 372 of file class.ilTreeExplorerGUI.php.

Referenced by build().

Here is the caller graph for this function:

◆ getOrderField()

ilTreeExplorerGUI::getOrderField ( )

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

References $order_field.

Referenced by getChildsOfNode().

                                    : string
     {
         return $this->order_field;
     }

Here is the caller graph for this function:

◆ getPreloadChilds()

ilTreeExplorerGUI::getPreloadChilds ( )

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

References $preload_childs.

Referenced by getHTML().

                                       : bool
     {
         return $this->preload_childs;
     }

Here is the caller graph for this function:

◆ getRootId()

ilTreeExplorerGUI::getRootId ( )

protected

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

References getTree().

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

                                   : int
     {
         return $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: object|array node

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

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

Referenced by ilPublicSectionExplorerGUI\getAllNodes(), ilTaxonomyClassificationExplorerGUI\getNodeContent(), ilMediaPoolExplorerGUI\getNodeContent(), ilTaxonomyExplorerGUI\getNodeContent(), ilAdministrationExplorerGUI\getNodeContent(), ilLMExplorerGUI\getNodeContent(), ilRepositorySelectorExplorerGUI\getNodeContent(), ilLMEditorExplorerGUI\getNodeIcon(), ilPublicSectionExplorerGUI\getNodeIcon(), ilMediaPoolExplorerGUI\getNodeIcon(), ilAdministrationExplorerGUI\getNodeIconAlt(), ilRepositorySelectorExplorerGUI\getNodeIconAlt(), ilTaxonomyClassificationExplorerGUI\getTreeComponent(), getTreeComponent(), ilMediaPoolExplorerGUI\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,
		string	$a_type = `""`
	)

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

Parameters

int | string $a_node_id node id

Returns: mixed node id or false

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

References 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) {
                 // do nothing
             }
             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 ( )

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

References $tree.

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

                              : ilTree
     {
         return $this->tree;
     }

Here is the caller graph for this function:

◆ getTreeComponent()

ilTreeExplorerGUI::getTreeComponent ( )

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

References $data, Vendor\Package\$f, $tree, ilExplorerBaseGUI\getNodeContent(), ilTree\getNodeData(), getRootNode(), getTree(), getTreeLabel(), ilTree\readRootId(), and ILIAS\Repository\ui().

Referenced by render().

                                       : Tree
     {
         $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 ( )

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

References $tree_label.

Referenced by ilTaxonomyClassificationExplorerGUI\getTreeComponent(), and getTreeComponent().

                                   : string
     {
         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 111 of file class.ilTreeExplorerGUI.php.

References $type_black_list.

Referenced by getChildsOfNode(), and preloadChilds().

                                       : array
     {
         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 93 of file class.ilTreeExplorerGUI.php.

References $type_white_list.

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

                                       : array
     {
         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

object | array $node

Returns: bool

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

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

Referenced by getChildsOfNode().

                                      : bool
     {
         return (
             $this->getSearchTerm() === "" ||
             is_int(ilStr::striPos($this->getNodeContent($node), $this->getSearchTerm()))
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preloadChilds()

ilTreeExplorerGUI::preloadChilds ( )

protected

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

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

Referenced by getHTML().

                                       : void
     {
         $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] = ilArrayUtil::sortArray(
                     $childs,
                     $this->order_field,
                     "asc",
                     $this->order_field_numeric
                 );
             }
         }
 
         // sort childs and store prev/next reference
         if ($this->order_field === "") {
             $this->all_childs =
                 ilArrayUtil::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

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

References $r, getTreeComponent(), and ILIAS\Repository\ui().

Referenced by getHTML().

                                : string
     {
         $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	(	string	$a_val,
		bool	$a_numeric = `false`
	)

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

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

      : void {
         $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 314 of file class.ilTreeExplorerGUI.php.

References ilExplorerBaseGUI\$id, $path, getTree(), and ilExplorerBaseGUI\setNodeOpen().

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

                                       : void
     {
         $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 ( bool $a_val )

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

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

                                                  : void
     {
         $this->preload_childs = $a_val;
     }

Here is the caller graph for this function:

◆ setRootId()

ilTreeExplorerGUI::setRootId ( $a_root )

Parameters

int | string $a_root

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

                                       : void
     {
         $this->root_id = $a_root;
     }

◆ setTypeBlackList()

ilTreeExplorerGUI::setTypeBlackList ( array $a_val )

Set type black list.

Parameters

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

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

                                                   : void
     {
         $this->type_black_list = $a_val;
     }

◆ setTypeWhiteList()

ilTreeExplorerGUI::setTypeWhiteList ( array $a_val )

Set type white list.

Parameters

array $a_val array of strings of node types that should be retrieved

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

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

                                                   : void
     {
         $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 442 of file class.ilTreeExplorerGUI.php.

References ILIAS\LTI\ToolProvider\$key, ilExplorerBaseGUI\$node_parameter_name, exit, and ILIAS\Repository\int().

Referenced by ilObjForumGUI\toggleExplorerNodeStateObject().

                                              : void
     {
         $nodeId = (int) ($this->httpRequest->getQueryParams()[$this->node_parameter_name] ?? 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();
     }