This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilExplorerBaseGUI:

Collaboration diagram for ilExplorerBaseGUI:

Public Member Functions
	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)

Static Public Member Functions
static	getLocalExplorerJsPath ()

static	getLocalJsTreeJsPath ()

static	getLocalJsTreeCssPath ()

static	createHTMLExportDirs (string $a_target_dir)

static	init (?ilGlobalTemplateInterface $a_main_tpl=null)

Protected Member Functions
	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
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

Static Protected Attributes
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 = "assets/js/Explorer2.js"

Private Attributes
bool	$nodeOnclickEnabled

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning The class is supposed to work on a hierarchie of nodes that are identified by IDs. Whether nodes are represented by associative arrays or objects is not defined by this abstract class.

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

Deprecated:: with ILIAS 12

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

Member Function Documentation

◆ beforeRendering()

ilExplorerBaseGUI::beforeRendering ( )

Before rendering.

Reimplemented in ilLMExplorerGUI.

Definition at line 504 of file class.ilExplorerBaseGUI.php.

                                     : void
    {
    }

Referenced by getHTML(), and getNodeAsync().

Here is the caller graph for this function:

◆ closeNode()

ilExplorerBaseGUI::closeNode ( )

Close node.

Definition at line 465 of file class.ilExplorerBaseGUI.php.

                               : void
    {
        $id = $this->getNodeIdForDomNodeId($this->requested_node_id);
        if (in_array($id, $this->open_nodes)) {
            $k = array_search($id, $this->open_nodes);
            unset($this->open_nodes[$k]);
        }
        $this->store->set("on_" . $this->id, serialize($this->open_nodes));
        exit;
    }

References $id, exit, and getNodeIdForDomNodeId().

Here is the call graph for this function:

◆ createHTMLExportDirs()

static ilExplorerBaseGUI::createHTMLExportDirs ( string $a_target_dir )

static

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

                                                                     : void
    {
        ilFileUtils::makeDirParents($a_target_dir . "/components/ILIAS/UIComponent/Explorer2/lib/jstree-v.pre1.0");
        ilFileUtils::makeDirParents($a_target_dir . "/components/ILIAS/UIComponent/Explorer2/js");
    }

References ilFileUtils\makeDirParents().

Here is the call graph for this function:

◆ getAjax()

ilExplorerBaseGUI::getAjax ( )

Definition at line 338 of file class.ilExplorerBaseGUI.php.

                             : bool
    {
        return $this->ajax;
    }

References $ajax.

Referenced by getOnLoadCode(), listItemStart(), and renderNode().

Here is the caller graph for this function:

◆ getChildLimit()

ilExplorerBaseGUI::getChildLimit ( )

Definition at line 104 of file class.ilExplorerBaseGUI.php.

                                   : int
    {
        return $this->child_limit;
    }

References $child_limit.

Referenced by renderChilds().

Here is the caller graph for this function:

◆ getChildsOfNode()

ilExplorerBaseGUI::getChildsOfNode ( $a_parent_node_id )

abstract

Get children of node.

Parameters

string $a_parent_node_id

Returns: array

Reimplemented in ilAdministrationExplorerGUI, ilForumExplorerGUI, ilLSTOCGUI, ilOrgUnitExplorerGUI, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, ilPersonalSkillExplorerGUI, ilSkillTemplateTreeExplorerGUI, ilVirtualSkillTreeExplorerGUI, and ilTreeExplorerGUI.

Referenced by getHTML(), nodeHasVisibleChilds(), and renderChilds().

Here is the caller graph for this function:

◆ getContainerId()

ilExplorerBaseGUI::getContainerId ( )

Definition at line 444 of file class.ilExplorerBaseGUI.php.

                                    : string
    {
        return "il_expl2_jstree_cont_" . $this->getId();
    }

References getId().

Referenced by getHTML(), getNodeToggleOnClick(), getOnLoadCode(), and handleCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDomNodeIdForNodeId()

ilExplorerBaseGUI::getDomNodeIdForNodeId ( $a_node_id )

Get DOM node id for node id.

Parameters

string $a_node_id

Reimplemented in ilVirtualSkillTreeExplorerGUI.

Definition at line 825 of file class.ilExplorerBaseGUI.php.

                                                     : string
    {
        return "exp_node_" . $this->getId() . "_" . $a_node_id;
    }

References getId().

Referenced by getNodeToggleOnClick(), getOnLoadCode(), getSelectOnClick(), isNodeRequested(), and listItemStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilExplorerBaseGUI::getHTML ( )

Reimplemented in ilVirtualSkillTreeExplorerGUI.

Definition at line 613 of file class.ilExplorerBaseGUI.php.

                             : string
    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
 
        $root = $this->getNodeId($this->getRootNode());
        if (!in_array($root, $this->open_nodes)) {
            $this->open_nodes[] = $root;
        }
 
        $this->beforeRendering();
 
        self::init($tpl);
        $container_id = $this->getContainerId();
        $container_outer_id = "il_expl2_jstree_cont_out_" . $this->getId();
 
        if (!$ilCtrl->isAsynch()) {
            $tpl->addOnLoadCode($this->getOnLoadCode());
        }
 
        $etpl = new ilTemplate("tpl.explorer2.html", true, true, "components/ILIAS/UIComponent/Explorer2");
 
        if (!$this->ajax) {
            // render childs
            $root_node = $this->getRootNode();
 
            if (!$this->getSkipRootNode() &&
                $this->isNodeVisible($this->getRootNode())) {
                $this->listStart($etpl);
                $this->renderNode($this->getRootNode(), $etpl);
                $this->listEnd($etpl);
            } else {
                $childs = $this->getChildsOfNode($this->getNodeId($root_node));
                $childs = $this->sortChilds($childs, $this->getNodeId($root_node));
                $any = false;
                foreach ($childs as $child_node) {
                    if ($this->isNodeVisible($child_node)) {
                        if (!$any) {
                            $this->listStart($etpl);
                            $any = true;
                        }
                        $this->renderNode($child_node, $etpl);
                    }
                }
                if ($any) {
                    $this->listEnd($etpl);
                }
            }
        }
 
        $etpl->setVariable("CONTAINER_ID", $container_id);
        $etpl->setVariable("CONTAINER_OUTER_ID", $container_outer_id);
 
        $add = "";
        if ($ilCtrl->isAsynch()) {
            $add = "<script>" . $this->getOnLoadCode() . "</script>";
        }
 
        $content = $etpl->get();
        //echo $content.$add; exit;
        return $content . $add;
    }

References $ctrl, $tpl, ILIAS\UICore\GlobalTemplate\addOnLoadCode(), beforeRendering(), getChildsOfNode(), getContainerId(), getId(), getNodeId(), getOnLoadCode(), getRootNode(), getSkipRootNode(), init(), isNodeVisible(), listEnd(), listStart(), renderNode(), and sortChilds().

Here is the call graph for this function:

◆ getId()

ilExplorerBaseGUI::getId ( )

Get id of explorer element.

Returns: string id

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

                           : string
    {
        return $this->id;
    }

References $id.

Referenced by getContainerId(), getDomNodeIdForNodeId(), getHTML(), getNodeIdForDomNodeId(), and getOnLoadCode().

Here is the caller graph for this function:

◆ getJSTreePlugins()

ilExplorerBaseGUI::getJSTreePlugins ( )

protected

Definition at line 587 of file class.ilExplorerBaseGUI.php.

                                         : array
    {
        $plugins = array("html_data", "themes", "json_data");
        if ($this->isEnableDnd()) {
            $plugins[] = "dnd";
        }
        return $plugins;
    }

References isEnableDnd().

Referenced by getOnLoadCode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocalExplorerJsPath()

static ilExplorerBaseGUI::getLocalExplorerJsPath ( )

static

Definition at line 124 of file class.ilExplorerBaseGUI.php.

                                                   : string
    {
        return self::$js_expl_path;
    }

References $js_expl_path.

Referenced by ilGroupUserActionProvider\getJsScripts(), and ILIAS\LearningModule\Export\LMHtmlExport\getSupplyingExportFiles().

Here is the caller graph for this function:

◆ getLocalJsTreeCssPath()

static ilExplorerBaseGUI::getLocalJsTreeCssPath ( )

static

Definition at line 134 of file class.ilExplorerBaseGUI.php.

                                                  : string
    {
        return self::$js_tree_path_css;
    }

References $js_tree_path_css.

Referenced by ILIAS\LearningModule\Export\LMHtmlExport\getSupplyingExportFiles().

Here is the caller graph for this function:

◆ getLocalJsTreeJsPath()

static ilExplorerBaseGUI::getLocalJsTreeJsPath ( )

static

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

                                                 : string
    {
        return self::$js_tree_path;
    }

References $js_tree_path.

Referenced by ilGroupUserActionProvider\getJsScripts(), and ILIAS\LearningModule\Export\LMHtmlExport\getSupplyingExportFiles().

Here is the caller graph for this function:

◆ getNodeAsync()

ilExplorerBaseGUI::getNodeAsync ( )

Get node asynchronously.

Definition at line 479 of file class.ilExplorerBaseGUI.php.

                                  : string
    {
        $this->beforeRendering();
 
        $etpl = new ilTemplate("tpl.explorer2.html", true, true, "components/ILIAS/UIComponent/Explorer2");
 
        $root = $this->getNodeId($this->getRootNode());
        if (!in_array($root, $this->open_nodes)) {
            $this->open_nodes[] = $root;
        }
        $this->setSearchTerm(ilUtil::stripSlashes($this->requested_searchterm));
        if ($this->requested_node_id !== "") {
            $id = $this->getNodeIdForDomNodeId($this->requested_node_id);
            $this->renderChilds($id, $etpl);
        } else {
            $this->getNodeId($this->getRootNode());
            $this->renderNode($this->getRootNode(), $etpl);
        }
        echo $etpl->get("tag");
        exit;
    }

References $id, beforeRendering(), exit, getNodeId(), getNodeIdForDomNodeId(), getRootNode(), renderChilds(), renderNode(), setSearchTerm(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ getNodeContent()

ilExplorerBaseGUI::getNodeContent ( $a_node )

abstract

Get content of a node.

Parameters

object | array $a_node node array or object

Returns: string content of the node

Reimplemented in ilAdministrationExplorerGUI, ilTaxonomyClassificationExplorerGUI, ilForumExplorerGUI, ilLMExplorerGUI, ilLMTOCExplorerGUI, ilLSTOCGUI, ilMailExplorer, ilMediaPoolExplorerGUI, ilOrgUnitExplorerGUI, ilWorkspaceExplorerGUI, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, ilPersonalSkillExplorerGUI, ilSkillTemplateTreeExplorerGUI, ilSkillTreeExplorerGUI, ilVirtualSkillTreeExplorerGUI, and ilTaxonomyExplorerGUI.

Referenced by renderNode().

Here is the caller graph for this function:

◆ getNodeHref()

ilExplorerBaseGUI::getNodeHref ( $a_node )

Get href for node.

Parameters

object | array $a_node

Returns: string href attribute

Reimplemented in ilAdministrationExplorerGUI, ilPoolSelectorGUI, ilIntLinkRepItemExplorerGUI, ilLinkTargetObjectExplorerGUI, ilPCFileItemFileSelectorGUI, ilForumExplorerGUI, ilGroupActionTargetExplorerGUI, ilLMEditorExplorerGUI, ilLMTOCExplorerGUI, ilLSTOCGUI, ilMailExplorer, ilMediaPoolExplorerGUI, ilOrgUnitExplorerGUI, ilWorkspaceExplorerGUI, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, ilPersonalSkillExplorerGUI, ilSkillSelectorGUI, ilSkillTemplateTreeExplorerGUI, ilSkillTreeExplorerGUI, ilVirtualSkillTreeExplorerGUI, and ilTaxonomyExplorerGUI.

Definition at line 191 of file class.ilExplorerBaseGUI.php.

                                        : string
    {
        return "#";
    }

Referenced by renderNode().

Here is the caller graph for this function:

◆ getNodeIcon()

ilExplorerBaseGUI::getNodeIcon ( $a_node )

Get node icon path.

Parameters

object | array $a_node

Returns: string image file path

Reimplemented in ilAdministrationExplorerGUI, ilForumExplorerGUI, ilLMEditorExplorerGUI, ilLMTOCExplorerGUI, ilLSTOCGUI, ilMailExplorer, ilMediaPoolExplorerGUI, ilOrgUnitExplorerGUI, ilWorkspaceExplorerGUI, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, ilPersonalSkillExplorerGUI, ilSkillTemplateTreeExplorerGUI, ilSkillTreeExplorerGUI, ilVirtualSkillTreeExplorerGUI, and ilTaxonomyExplorerGUI.

Definition at line 231 of file class.ilExplorerBaseGUI.php.

                                        : string
    {
        return "";
    }

Referenced by renderNode().

Here is the caller graph for this function:

◆ getNodeIconAlt()

ilExplorerBaseGUI::getNodeIconAlt ( $a_node )

Get node icon alt attribute.

Parameters

object | array $a_node

Returns: string image alt attribute

Reimplemented in ilAdministrationExplorerGUI, ilLMEditorExplorerGUI, ilLMTOCExplorerGUI, ilMailExplorer, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, ilPersonalSkillExplorerGUI, ilSkillTemplateTreeExplorerGUI, ilVirtualSkillTreeExplorerGUI, and ilTreeExplorerGUI.

Definition at line 241 of file class.ilExplorerBaseGUI.php.

                                           : string
    {
        return "";
    }

Referenced by renderNode().

Here is the caller graph for this function:

◆ getNodeId()

ilExplorerBaseGUI::getNodeId ( $a_node )

abstract

Get id of a node.

Parameters

object | array $a_node node array or object

Returns: string id of node

Reimplemented in ilForumExplorerGUI, ilLSTOCGUI, ilVirtualSkillTreeExplorerGUI, and ilTreeExplorerGUI.

Referenced by getHTML(), getNodeAsync(), getNodeToggleOnClick(), getOnLoadCode(), getSelectOnClick(), isNodeOpen(), isNodeRequested(), listItemStart(), nodeHasVisibleChilds(), and renderNode().

Here is the caller graph for this function:

◆ getNodeIdForDomNodeId()

ilExplorerBaseGUI::getNodeIdForDomNodeId ( string $a_dom_node_id )

Get node id for dom node id.

Reimplemented in ilVirtualSkillTreeExplorerGUI.

Definition at line 833 of file class.ilExplorerBaseGUI.php.

                                                                : string
    {
        $i = strlen("exp_node_" . $this->getId() . "_");
        return substr($a_dom_node_id, $i);
    }

References getId().

Referenced by closeNode(), getNodeAsync(), and openNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNodeOnClick()

ilExplorerBaseGUI::getNodeOnClick ( $a_node )

Get node onclick attribute.

Parameters

object | array $a_node node

Returns: string onclick value

Reimplemented in ilIntLinkRepItemExplorerGUI, ilLinkTargetObjectExplorerGUI, ilGroupActionTargetExplorerGUI, and ilTaxonomyExplorerGUI.

Definition at line 261 of file class.ilExplorerBaseGUI.php.

                                           : string
    {
        if ($this->select_postvar !== "") {
            return $this->getSelectOnClick($a_node);
        }
        return "";
    }

References getSelectOnClick().

Referenced by renderNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNodeTarget()

ilExplorerBaseGUI::getNodeTarget ( $a_node )

Get node target (frame) attribute.

Parameters

object | array $a_node node

Returns: string target

Definition at line 251 of file class.ilExplorerBaseGUI.php.

                                          : string
    {
        return "";
    }

Referenced by renderNode().

Here is the caller graph for this function:

◆ getNodeToggleOnClick()

ilExplorerBaseGUI::getNodeToggleOnClick ( $a_node )

finalprotected

Get onclick attribute for node toggling.

Parameters

object | array $a_node

Definition at line 374 of file class.ilExplorerBaseGUI.php.

                                                          : string
    {
        return "$('#" . $this->getContainerId() . "').jstree('toggle_node' , '#" .
            $this->getDomNodeIdForNodeId($this->getNodeId($a_node)) . "'); return false;";
    }

References getContainerId(), getDomNodeIdForNodeId(), and getNodeId().

Here is the call graph for this function:

◆ getOfflineMode()

ilExplorerBaseGUI::getOfflineMode ( )

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

                                    : bool
    {
        return $this->offline_mode;
    }

References $offline_mode.

Referenced by ilLMTOCExplorerGUI\__construct(), ilLMExplorerGUI\__construct(), ilLMExplorerGUI\beforeRendering(), and getOnLoadCode().

Here is the caller graph for this function:

◆ getOnLoadCode()

ilExplorerBaseGUI::getOnLoadCode ( )

Get on load code.

Definition at line 523 of file class.ilExplorerBaseGUI.php.

                                   : string
    {
        $ilCtrl = $this->ctrl;
 
        $container_id = $this->getContainerId();
        $container_outer_id = "il_expl2_jstree_cont_out_" . $this->getId();
 
        // collect open nodes
        $open_nodes = array($this->getDomNodeIdForNodeId($this->getNodeId($this->getRootNode())));
        foreach ($this->open_nodes as $nid) {
            $open_nodes[] = $this->getDomNodeIdForNodeId($nid);
        }
        foreach ($this->custom_open_nodes as $nid) {
            $dnode = $this->getDomNodeIdForNodeId($nid);
            if (!in_array($dnode, $open_nodes)) {
                $open_nodes[] = $dnode;
            }
        }
        // ilias config options
        $url = "";
        if (!$this->getOfflineMode()) {
            if (is_object($this->parent_obj)) {
                $url = $ilCtrl->getLinkTarget($this->parent_obj, $this->parent_cmd, "", true);
            } else {
                if (!is_null($this->parent_obj)) {
                    $url = $ilCtrl->getLinkTargetByClass($this->parent_obj, $this->parent_cmd, "", true);
                }
            }
        }
 
        // secondary highlighted nodes
        $shn = array();
        foreach ($this->sec_highl_nodes as $sh) {
            $shn[] = $this->getDomNodeIdForNodeId($sh);
        }
        $config = array(
            "container_id" => $container_id,
            "container_outer_id" => $container_outer_id,
            "url" => $url,
            "second_hnodes" => $shn,
            "ajax" => $this->getAjax(),
            "node_par_name" => $this->node_parameter_name
        );
 
 
        // jstree config options
        $js_tree_config = array(
            "core" => array(
                "animation" => 0,
                "initially_open" => $open_nodes,
                "open_parents" => false,
                "strings" => array("loading" => "Loading ...", "new_node" => "New node"),
                "themes" => array("dots" => false, "icons" => false, "theme" => "")
            ),
            "plugins" => $this->getJSTreePlugins(),
            "html_data" => array()
        );
        return (
            'il.Explorer2.init(' .
            json_encode($config, JSON_THROW_ON_ERROR) . ', ' .
            json_encode($js_tree_config, JSON_THROW_ON_ERROR) . ');'
        );
    }

References $ctrl, $open_nodes, $url, getAjax(), getContainerId(), getDomNodeIdForNodeId(), getId(), getJSTreePlugins(), getNodeId(), getOfflineMode(), and getRootNode().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRootNode()

ilExplorerBaseGUI::getRootNode ( )

abstract

Get root node.

Please note that the class does not make any requirements how nodes are represented (array or object)

Returns: object|array|null

Reimplemented in ilLMTOCExplorerGUI, ilLSTOCGUI, ilMailExplorer, ilOrgUnitExplorerGUI, ilRepositoryExplorerGUI, ilSkillTemplateTreeExplorerGUI, ilVirtualSkillTreeExplorerGUI, and ilTreeExplorerGUI.

Referenced by getHTML(), getNodeAsync(), getOnLoadCode(), isNodeOpen(), isNodeRequested(), and renderNode().

Here is the caller graph for this function:

◆ getSearchTerm()

ilExplorerBaseGUI::getSearchTerm ( )

Definition at line 114 of file class.ilExplorerBaseGUI.php.

                                   : string
    {
        return $this->search_term;
    }

References $search_term.

Referenced by renderChilds().

Here is the caller graph for this function:

◆ getSecondaryHighlightedNodes()

ilExplorerBaseGUI::getSecondaryHighlightedNodes ( )

Get secondary (background) highlighted nodes.

Definition at line 354 of file class.ilExplorerBaseGUI.php.

                                                  : array
    {
        return $this->sec_highl_nodes;
    }

References $sec_highl_nodes.

◆ getSelectOnClick()

ilExplorerBaseGUI::getSelectOnClick ( $a_node )

finalprotected

Get onclick attribute for selecting radio/checkbox.

Parameters

object | array $a_node

Definition at line 384 of file class.ilExplorerBaseGUI.php.

                                                      : string
    {
        $dn_id = $this->getDomNodeIdForNodeId($this->getNodeId($a_node));
        $oc = "il.Explorer2.selectOnClick(event, '" . $dn_id . "'); return false;";
        return $oc;
    }

References getDomNodeIdForNodeId(), and getNodeId().

Referenced by getNodeOnClick().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSkipRootNode()

ilExplorerBaseGUI::getSkipRootNode ( )

Definition at line 328 of file class.ilExplorerBaseGUI.php.

                                     : bool
    {
        return $this->skip_root_node;
    }

References $skip_root_node.

Referenced by getHTML(), ilVirtualSkillTreeExplorerGUI\getTreeComponent(), and renderNode().

Here is the caller graph for this function:

◆ handleCommand()

ilExplorerBaseGUI::handleCommand ( )

Handle explorer internal command.

Definition at line 430 of file class.ilExplorerBaseGUI.php.

                                   : bool
    {
        if ($this->requested_exp_cmd !== "" &&
            $this->requested_exp_cont === $this->getContainerId()) {
            $cmd = $this->requested_exp_cmd;
            if (in_array($cmd, array("openNode", "closeNode", "getNodeAsync"))) {
                $this->$cmd();
            }
 
            return true;
        }
        return false;
    }

References $requested_exp_cmd, and getContainerId().

Here is the call graph for this function:

◆ init()

static ilExplorerBaseGUI::init ( ?ilGlobalTemplateInterface $a_main_tpl = null )

static

Definition at line 598 of file class.ilExplorerBaseGUI.php.

                                                                              : void
    {
        global $DIC;
 
        $tpl = $a_main_tpl ?? $DIC["tpl"];
 
        ilYuiUtil::initConnection();
        iljQueryUtil::initjQuery($tpl);
 
        $tpl->addJavaScript(self::getLocalExplorerJsPath());
        $tpl->addJavaScript(self::getLocalJsTreeJsPath());
        $tpl->addCss(self::getLocalJsTreeCssPath());
    }

References $DIC, $tpl, ILIAS\UICore\GlobalTemplate\addCss(), ILIAS\UICore\GlobalTemplate\addJavaScript(), ilYuiUtil\initConnection(), and iljQueryUtil\initjQuery().

Referenced by getHTML(), ilInternalLinkGUI\getInitHTML(), ILIAS\Repository\Provider\RepositoryMainBarProvider\getStaticSubItems(), and ilObjStudyProgrammeGUI\initTreeJS().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEnableDnd()

ilExplorerBaseGUI::isEnableDnd ( )

Definition at line 889 of file class.ilExplorerBaseGUI.php.

                                 : bool
    {
        return $this->enable_dnd;
    }

References $enable_dnd.

Referenced by getJSTreePlugins().

Here is the caller graph for this function:

◆ isNodeClickable()

ilExplorerBaseGUI::isNodeClickable ( $a_node )

Is node clickable?

Parameters

object | array $a_node node

Returns: bool node clickable true/false

Reimplemented in ilAdministrationExplorerGUI, ilConditionSelector, ilLinkTargetObjectExplorerGUI, ilPCFileItemFileSelectorGUI, ilForumMoveTopicsExplorer, ilGroupActionTargetExplorerGUI, ilLMTOCExplorerGUI, ilLSTOCGUI, ilOrgUnitExplorerGUI, ilWorkspaceExplorerGUI, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, ilPersonalSkillExplorerGUI, ilSkillSelectorGUI, ilSkillTreeExplorerGUI, ilVirtualSkillTreeExplorerGUI, and ilTestQuestionPoolSelectorExplorer.

Definition at line 294 of file class.ilExplorerBaseGUI.php.

                                            : bool
    {
        return true;
    }

Referenced by renderNode().

Here is the caller graph for this function:

◆ isNodeHighlighted()

ilExplorerBaseGUI::isNodeHighlighted ( $a_node )

Is node highlighted?

Parameters

object | array $a_node node

Returns: bool node highlighted true/false

Reimplemented in ilAdministrationExplorerGUI, ilConditionSelector, ilLMExplorerGUI, ilLMTOCExplorerGUI, ilLSTOCGUI, ilMediaPoolExplorerGUI, ilWorkspaceExplorerGUI, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, ilSkillTemplateTreeExplorerGUI, ilSkillTreeExplorerGUI, and ilTaxonomyExplorerGUI.

Definition at line 284 of file class.ilExplorerBaseGUI.php.

                                              : bool
    {
        return false;
    }

Referenced by renderNode().

Here is the caller graph for this function:

◆ isNodeOnclickEnabled()

ilExplorerBaseGUI::isNodeOnclickEnabled ( )

Definition at line 879 of file class.ilExplorerBaseGUI.php.

                                          : bool
    {
        return $this->nodeOnclickEnabled;
    }

References $nodeOnclickEnabled.

Referenced by renderNode().

Here is the caller graph for this function:

◆ isNodeOpen()

ilExplorerBaseGUI::isNodeOpen ( $node_id )

protected

Get all open nodes.

Parameters

string $node_id

Definition at line 512 of file class.ilExplorerBaseGUI.php.

                                           : bool
    {
        return ($this->getNodeId($this->getRootNode()) == $node_id
            || in_array($node_id, $this->open_nodes)
            || in_array($node_id, $this->custom_open_nodes));
    }

References getNodeId(), and getRootNode().

Referenced by listItemStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isNodeRequested()

ilExplorerBaseGUI::isNodeRequested ( string $a_node_id )

protected

Definition at line 815 of file class.ilExplorerBaseGUI.php.

                                                         : bool
    {
        return ($this->requested_node_id === $this->getDomNodeIdForNodeId($a_node_id) ||
            ($this->requested_node_id === "" && $a_node_id == $this->getNodeId($this->getRootNode())));
    }

References getDomNodeIdForNodeId(), getNodeId(), and getRootNode().

Referenced by renderChilds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isNodeSelectable()

ilExplorerBaseGUI::isNodeSelectable ( $a_node )

protected

Is node selectable?

Parameters

object | array $a_node node

Returns: bool node selectable true/false

Reimplemented in ilForumMoveTopicsExplorer, ilOrgUnitExplorerGUI, ilWorkspaceExplorerGUI, ilRepositorySelectorExplorerGUI, and ilSkillSelectorGUI.

Definition at line 304 of file class.ilExplorerBaseGUI.php.

                                                : bool
    {
        return true;
    }

Referenced by renderNode().

Here is the caller graph for this function:

◆ isNodeVisible()

ilExplorerBaseGUI::isNodeVisible ( $a_node )

Is node visible?

Parameters

object | array $a_node node

Returns: bool node visible true/false

Reimplemented in ilAdministrationExplorerGUI, ilConditionSelector, ilStandardGlossarySelectorGUI, ilLMTOCExplorerGUI, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, and ilTestQuestionPoolSelectorExplorer.

Definition at line 274 of file class.ilExplorerBaseGUI.php.

                                          : bool
    {
        return true;
    }

Referenced by getHTML(), nodeHasVisibleChilds(), and renderChilds().

Here is the caller graph for this function:

◆ listEnd()

ilExplorerBaseGUI::listEnd ( ilTemplate $tpl )

Definition at line 873 of file class.ilExplorerBaseGUI.php.

                                            : void
    {
        $tpl->touchBlock("list_end");
        $tpl->touchBlock("tag");
    }

References $tpl, and ILIAS\UICore\GlobalTemplate\touchBlock().

Referenced by getHTML(), and renderChilds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listItemEnd()

ilExplorerBaseGUI::listItemEnd ( ilTemplate $tpl )

Definition at line 861 of file class.ilExplorerBaseGUI.php.

                                                : void
    {
        $tpl->touchBlock("list_item_end");
        $tpl->touchBlock("tag");
    }

References $tpl, and ILIAS\UICore\GlobalTemplate\touchBlock().

Referenced by renderNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listItemStart()

ilExplorerBaseGUI::listItemStart	(	ilTemplate	$tpl,
			$a_node
	)

List item start.

Parameters

object | array $a_node

Definition at line 843 of file class.ilExplorerBaseGUI.php.

                                                           : void
    {
        $tpl->setCurrentBlock("list_item_start");
        if ($this->getAjax() && $this->nodeHasVisibleChilds($a_node) && !$this->isNodeOpen($this->getNodeId($a_node))) {
            $tpl->touchBlock("li_closed");
        }
        if ($this->isNodeOpen($this->getNodeId($a_node))) {
            $tpl->touchBlock("li_opened");
        }
 
        $tpl->setVariable(
            "DOM_NODE_ID",
            $this->getDomNodeIdForNodeId($this->getNodeId($a_node))
        );
        $tpl->parseCurrentBlock();
        $tpl->touchBlock("tag");
    }

References $tpl, getAjax(), getDomNodeIdForNodeId(), getNodeId(), isNodeOpen(), nodeHasVisibleChilds(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), ILIAS\UICore\GlobalTemplate\setVariable(), and ILIAS\UICore\GlobalTemplate\touchBlock().

Referenced by renderNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listStart()

ilExplorerBaseGUI::listStart ( ilTemplate $tpl )

Definition at line 867 of file class.ilExplorerBaseGUI.php.

                                              : void
    {
        $tpl->touchBlock("list_start");
        $tpl->touchBlock("tag");
    }

References $tpl, and ILIAS\UICore\GlobalTemplate\touchBlock().

Referenced by getHTML(), and renderChilds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nodeHasVisibleChilds()

ilExplorerBaseGUI::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.

Parameters

object | array $a_node

Returns: bool

Reimplemented in ilRepositoryExplorerGUI.

Definition at line 203 of file class.ilExplorerBaseGUI.php.

                                                 : bool
    {
        $childs = $this->getChildsOfNode($this->getNodeId($a_node));
 
        foreach ($childs as $child) {
            if ($this->isNodeVisible($child)) {
                return true;
            }
        }
        return false;
    }

References getChildsOfNode(), getNodeId(), and isNodeVisible().

Referenced by listItemStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ openNode()

ilExplorerBaseGUI::openNode ( )

Open node.

Definition at line 452 of file class.ilExplorerBaseGUI.php.

                              : void
    {
        $id = $this->getNodeIdForDomNodeId($this->requested_node_id);
        if (!in_array($id, $this->open_nodes)) {
            $this->open_nodes[] = $id;
        }
        $this->store->set("on_" . $this->id, serialize($this->open_nodes));
        exit;
    }

References $id, exit, and getNodeIdForDomNodeId().

Here is the call graph for this function:

◆ renderChilds()

ilExplorerBaseGUI::renderChilds	(		$a_node_id,
		ilTemplate	$tpl
	)

final

Render childs.

Parameters

string $a_node_id

Definition at line 759 of file class.ilExplorerBaseGUI.php.

                                                                   : void
    {
        $childs = $this->getChildsOfNode($a_node_id);
        $childs = $this->sortChilds($childs, $a_node_id);
 
        if (count($childs) > 0 || ($this->getSearchTerm() !== "" && $this->isNodeRequested($a_node_id))) {
            // collect visible childs
 
            $visible_childs = [];
            $cnt_child = 0;
 
            foreach ($childs as $child) {
                $cnt_child++;
                if ($this->getChildLimit() > 0 && $this->getChildLimit() < $cnt_child) {
                    continue;
                }
 
                if ($this->isNodeVisible($child)) {
                    $visible_childs[] = $child;
                }
            }
 
            // search field, if too many childs
            $any = false;
            if (($this->getChildLimit() > 0 && $this->getChildLimit() < $cnt_child) || ($this->getSearchTerm() !== "" && $this->isNodeRequested($a_node_id))) {
                $this->listStart($tpl);
                $any = true;
 
                $tpl->setCurrentBlock("list_search");
                $tpl->setVariable("SEARCH_CONTAINER_ID", $a_node_id);
                if ($this->isNodeRequested($a_node_id)) {
                    $tpl->setVariable("SEARCH_VAL", $this->getSearchTerm());
                }
                $tpl->parseCurrentBlock();
                $tpl->touchBlock("tag");
            }
 
            // render visible childs
            foreach ($visible_childs as $child) {
                // check child limit
                $cnt_child++;
 
                if ($this->isNodeVisible($child)) {
                    if (!$any) {
                        $this->listStart($tpl);
                        $any = true;
                    }
                    $this->renderNode($child, $tpl);
                }
            }
            if ($any) {
                $this->listEnd($tpl);
            }
        }
    }

References $tpl, getChildLimit(), getChildsOfNode(), getSearchTerm(), isNodeRequested(), isNodeVisible(), listEnd(), listStart(), ilTemplate\parseCurrentBlock(), renderNode(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), ILIAS\UICore\GlobalTemplate\setVariable(), sortChilds(), and ILIAS\UICore\GlobalTemplate\touchBlock().

Referenced by getNodeAsync(), and renderNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderNode()

ilExplorerBaseGUI::renderNode	(		$a_node,
		ilTemplate	$tpl
	)

Render node.

Parameters

object | array $a_node

Definition at line 680 of file class.ilExplorerBaseGUI.php.

                                                        : void
    {
        $skip = ($this->getSkipRootNode()
            && $this->getNodeId($this->getRootNode()) == $this->getNodeId($a_node));
        if (!$skip) {
            $this->listItemStart($tpl, $a_node);
 
            // select mode?
            if ($this->select_postvar !== "" && $this->isNodeSelectable($a_node)) {
                if ($this->select_multi) {
                    $tpl->setCurrentBlock("cb");
                    if (in_array($this->getNodeId($a_node), $this->selected_nodes)) {
                        $tpl->setVariable("CHECKED", 'checked="checked"');
                    }
                    $tpl->setVariable("CB_VAL", $this->getNodeId($a_node));
                    $tpl->setVariable("CB_NAME", $this->select_postvar . "[]");
                } else {
                    $tpl->setCurrentBlock("rd");
                    if (in_array($this->getNodeId($a_node), $this->selected_nodes)) {
                        $tpl->setVariable("SELECTED", 'checked="checked"');
                    }
                    $tpl->setVariable("RD_VAL", $this->getNodeId($a_node));
                    $tpl->setVariable("RD_NAME", $this->select_postvar);
                }
                $tpl->parseCurrentBlock();
            }
 
 
            if ($this->isNodeHighlighted($a_node)) {
                $tpl->touchBlock("hl");
            }
            $tpl->setCurrentBlock("content");
            if ($this->getNodeIcon($a_node) !== "") {
                $tpl->setVariable("ICON", ilUtil::img($this->getNodeIcon($a_node), $this->getNodeIconAlt($a_node)) . " ");
            }
            $tpl->setVariable("CONTENT", $this->getNodeContent($a_node));
            if ($this->isNodeClickable($a_node)) {
                $tpl->setVariable("HREF", $this->getNodeHref($a_node));
            }
            $target = $this->getNodeTarget($a_node);
            if ($target !== "") {
                $targetRelatedParams = array(
                    'target="' . $target . '"'
                );
 
                if ('_blank' === $target) {
                    $targetRelatedParams[] = 'rel="noopener"';
                }
 
                $tpl->setVariable('TARGET', implode(' ', $targetRelatedParams));
            }
            if (!$this->isNodeOnclickEnabled() || !$this->isNodeClickable($a_node)) {
                $tpl->setVariable("ONCLICK", 'onclick="return false;"');
                $tpl->setVariable("A_CLASS", 'class="disabled"');
            } else {
                $onclick = $this->getNodeOnClick($a_node);
                if ($onclick !== "") {
                    $tpl->setVariable("ONCLICK", 'onclick="' . $onclick . '"');
                }
            }
            $tpl->parseCurrentBlock();
 
            $tpl->touchBlock("tag");
        }
 
        if (!$this->getAjax() || in_array($this->getNodeId($a_node), $this->open_nodes)
            || in_array($this->getNodeId($a_node), $this->custom_open_nodes)) {
            $this->renderChilds($this->getNodeId($a_node), $tpl);
        }
 
        if (!$skip) {
            $this->listItemEnd($tpl);
        }
    }

References $tpl, getAjax(), getNodeContent(), getNodeHref(), getNodeIcon(), getNodeIconAlt(), getNodeId(), getNodeOnClick(), getNodeTarget(), getRootNode(), getSkipRootNode(), ilUtil\img(), isNodeClickable(), isNodeHighlighted(), isNodeOnclickEnabled(), isNodeSelectable(), listItemEnd(), listItemStart(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), renderChilds(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), ILIAS\UICore\GlobalTemplate\setVariable(), and ILIAS\UICore\GlobalTemplate\touchBlock().

Referenced by getHTML(), getNodeAsync(), and renderChilds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAjax()

ilExplorerBaseGUI::setAjax ( bool $a_val )

Definition at line 333 of file class.ilExplorerBaseGUI.php.

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

Referenced by ilPoolSelectorGUI\__construct(), ilConditionSelector\__construct(), ilLMExplorerGUI\__construct(), ilOrgUnitExplorerGUI\__construct(), ilSkillTemplateTreeExplorerGUI\__construct(), ilSkillTreeExplorerGUI\__construct(), ilMailExplorer\__construct(), ilWorkspaceExplorerGUI\__construct(), ilMediaPoolExplorerGUI\__construct(), ilForumExplorerGUI\__construct(), ilVirtualSkillTreeExplorerGUI\__construct(), ilAdministrationExplorerGUI\__construct(), and ilLMExplorerGUI\beforeRendering().

Here is the caller graph for this function:

◆ setChildLimit()

ilExplorerBaseGUI::setChildLimit ( int $a_val )

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

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

◆ setEnableDnd()

ilExplorerBaseGUI::setEnableDnd ( bool $enable_dnd )

Definition at line 895 of file class.ilExplorerBaseGUI.php.

                                                  : void
    {
        $this->enable_dnd = $enable_dnd;
    }

References $enable_dnd.

◆ setMainTemplate()

ilExplorerBaseGUI::setMainTemplate ( ?ilGlobalTemplateInterface $a_main_tpl = null )

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

                                                                                  : void
    {
        $this->tpl = $a_main_tpl;
    }

◆ setNodeOnclickEnabled()

ilExplorerBaseGUI::setNodeOnclickEnabled ( bool $nodeOnclickEnabled )

Definition at line 884 of file class.ilExplorerBaseGUI.php.

                                                                   : void
    {
        $this->nodeOnclickEnabled = $nodeOnclickEnabled;
    }

References $nodeOnclickEnabled.

Referenced by ilLSTOCGUI\__construct().

Here is the caller graph for this function:

◆ setNodeOpen()

ilExplorerBaseGUI::setNodeOpen ( $a_id )

Set node to be opened (additional custom opened node, not standard expand behaviour)

Parameters

string $a_id

Definition at line 363 of file class.ilExplorerBaseGUI.php.

                                      : void
    {
        if (!in_array($a_id, $this->custom_open_nodes)) {
            $this->custom_open_nodes[] = $a_id;
        }
    }

Referenced by ilMediaPoolExplorerGUI\__construct(), and ilForumExplorerGUI\__construct().

Here is the caller graph for this function:

◆ setNodeSelected()

ilExplorerBaseGUI::setNodeSelected ( $a_id )

Set node to be opened (additional custom opened node, not standard expand behaviour)

Parameters

string $a_id

Definition at line 406 of file class.ilExplorerBaseGUI.php.

                                          : void
    {
        if (!in_array($a_id, $this->selected_nodes)) {
            $this->selected_nodes[] = $a_id;
        }
    }

Referenced by ilSkillSelectorGUI\setSkillSelected().

Here is the caller graph for this function:

◆ setOfflineMode()

ilExplorerBaseGUI::setOfflineMode ( bool $a_val )

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

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

◆ setSearchTerm()

ilExplorerBaseGUI::setSearchTerm ( string $a_val )

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

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

Referenced by getNodeAsync().

Here is the caller graph for this function:

◆ setSecondaryHighlightedNodes()

ilExplorerBaseGUI::setSecondaryHighlightedNodes ( array $a_val )

Set secondary (background) highlighted nodes.

Definition at line 346 of file class.ilExplorerBaseGUI.php.

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

Referenced by ilLMTOCExplorerGUI\__construct().

Here is the caller graph for this function:

◆ setSelectMode()

ilExplorerBaseGUI::setSelectMode	(	string	$a_postvar,
		bool	$a_multi = `false`
	)

Set select mode (to deactivate, pass an empty string as postvar)

Parameters

string	$a_postvar	variable used for post, a "[]" is added automatically
bool	$a_multi	multi select (checkboxes) or not (radio)

Definition at line 396 of file class.ilExplorerBaseGUI.php.

                                                                           : void
    {
        $this->select_postvar = $a_postvar;
        $this->select_multi = $a_multi;
    }

Referenced by ilForumMoveTopicsExplorer\__construct(), and ilTestQuestionPoolSelectorExplorer\__construct().

Here is the caller graph for this function:

◆ setSkipRootNode()

ilExplorerBaseGUI::setSkipRootNode ( bool $a_val )

Definition at line 323 of file class.ilExplorerBaseGUI.php.

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

Referenced by ilPersonalSkillExplorerGUI\__construct(), ilSkillSelectorGUI\__construct(), ilLMExplorerGUI\__construct(), ilSkillTemplateTreeExplorerGUI\__construct(), ilSkillTreeExplorerGUI\__construct(), ilMailExplorer\__construct(), ilWorkspaceExplorerGUI\__construct(), ilLSTOCGUI\__construct(), ilMediaPoolExplorerGUI\__construct(), ilForumExplorerGUI\__construct(), ilVirtualSkillTreeExplorerGUI\__construct(), and ilAdministrationExplorerGUI\__construct().

Here is the caller graph for this function:

◆ sortChilds()

ilExplorerBaseGUI::sortChilds	(	array	$a_childs,
			$a_parent_node_id
	)

Sort childs.

Parameters

array	$a_childs	array of child nodes
string	$a_parent_node_id	parent node

Returns: array array of childs nodes

Reimplemented in ilAdministrationExplorerGUI, ilRepositoryExplorerGUI, and ilRepositorySelectorExplorerGUI.

Definition at line 221 of file class.ilExplorerBaseGUI.php.

                                                                  : array
    {
        return $a_childs;
    }

Referenced by getHTML(), and renderChilds().

Here is the caller graph for this function:

Field Documentation

◆ $ajax

bool ilExplorerBaseGUI::$ajax = false

protected

Definition at line 40 of file class.ilExplorerBaseGUI.php.

Referenced by getAjax().

◆ $child_limit

int ilExplorerBaseGUI::$child_limit = 0

protected

Definition at line 56 of file class.ilExplorerBaseGUI.php.

Referenced by getChildLimit().

◆ $ctrl

ilCtrl ilExplorerBaseGUI::$ctrl

protected

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

◆ $custom_open_nodes

array ilExplorerBaseGUI::$custom_open_nodes = array()

protected

Definition at line 41 of file class.ilExplorerBaseGUI.php.

◆ $enable_dnd

bool ilExplorerBaseGUI::$enable_dnd = false

protected

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

Referenced by isEnableDnd(), and setEnableDnd().

◆ $id

string ilExplorerBaseGUI::$id

protected

Definition at line 64 of file class.ilExplorerBaseGUI.php.

Referenced by closeNode(), getId(), getNodeAsync(), ilVirtualSkillTreeExplorerGUI\getNodeIdForDomNodeId(), and openNode().

◆ $js_expl_path

string ilExplorerBaseGUI::$js_expl_path = "assets/js/Explorer2.js"

staticprotected

Definition at line 38 of file class.ilExplorerBaseGUI.php.

Referenced by getLocalExplorerJsPath().

◆ $js_tree_path

string ilExplorerBaseGUI::$js_tree_path = "./node_modules/jstree/dist/jstree.js"

staticprotected

Definition at line 35 of file class.ilExplorerBaseGUI.php.

Referenced by getLocalJsTreeJsPath().

◆ $js_tree_path_css

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

staticprotected

Definition at line 36 of file class.ilExplorerBaseGUI.php.

Referenced by getLocalJsTreeCssPath().

◆ $log

ilLogger ilExplorerBaseGUI::$log

protected

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

◆ $node_parameter_name

string ilExplorerBaseGUI::$node_parameter_name

protected

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

◆ $nodeOnclickEnabled

bool ilExplorerBaseGUI::$nodeOnclickEnabled

private

Definition at line 57 of file class.ilExplorerBaseGUI.php.

Referenced by isNodeOnclickEnabled(), and setNodeOnclickEnabled().

◆ $offline_mode

bool ilExplorerBaseGUI::$offline_mode = false

protected

Definition at line 44 of file class.ilExplorerBaseGUI.php.

Referenced by getOfflineMode().

◆ $open_nodes

array ilExplorerBaseGUI::$open_nodes = []

protected

Definition at line 48 of file class.ilExplorerBaseGUI.php.

Referenced by getOnLoadCode().

◆ $parent_cmd

string ilExplorerBaseGUI::$parent_cmd = ''

protected

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

Referenced by ilTaxonomyClassificationExplorerGUI\__construct().

◆ $parent_obj

ilExplorerBaseGUI::$parent_obj

protected

Definition at line 55 of file class.ilExplorerBaseGUI.php.

Referenced by ilTaxonomyClassificationExplorerGUI\__construct(), ilLMExplorerGUI\beforeRendering(), and ilWorkspaceExplorerGUI\getNodeHref().

◆ $requested_exp_cmd

string ilExplorerBaseGUI::$requested_exp_cmd = ""

protected

Definition at line 60 of file class.ilExplorerBaseGUI.php.

Referenced by handleCommand().

◆ $requested_exp_cont

string ilExplorerBaseGUI::$requested_exp_cont = ""

protected

Definition at line 61 of file class.ilExplorerBaseGUI.php.

◆ $requested_node_id

string ilExplorerBaseGUI::$requested_node_id = ""

protected

Definition at line 63 of file class.ilExplorerBaseGUI.php.

◆ $requested_searchterm

string ilExplorerBaseGUI::$requested_searchterm = ""

protected

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

◆ $search_term

string ilExplorerBaseGUI::$search_term = ""

protected

Definition at line 47 of file class.ilExplorerBaseGUI.php.

Referenced by getSearchTerm().

◆ $sec_highl_nodes

array ilExplorerBaseGUI::$sec_highl_nodes = array()

protected

Definition at line 45 of file class.ilExplorerBaseGUI.php.

Referenced by getSecondaryHighlightedNodes().

◆ $select_multi

bool ilExplorerBaseGUI::$select_multi = false

protected

Definition at line 50 of file class.ilExplorerBaseGUI.php.

◆ $select_postvar

string ilExplorerBaseGUI::$select_postvar = ""

protected

Definition at line 43 of file class.ilExplorerBaseGUI.php.

◆ $selected_nodes

array ilExplorerBaseGUI::$selected_nodes = array()

protected

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

Referenced by ilOrgUnitExplorerGUI\isNodeSelectable().

◆ $skip_root_node

bool ilExplorerBaseGUI::$skip_root_node = false

protected

Definition at line 39 of file class.ilExplorerBaseGUI.php.

Referenced by getSkipRootNode().

◆ $store

ilSessionIStorage ilExplorerBaseGUI::$store

protected

Definition at line 49 of file class.ilExplorerBaseGUI.php.

◆ $tpl

ilGlobalTemplateInterface ilExplorerBaseGUI::$tpl

protected

Definition at line 33 of file class.ilExplorerBaseGUI.php.

Referenced by getHTML(), init(), listEnd(), listItemEnd(), listItemStart(), listStart(), renderChilds(), and renderNode().

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

components/ILIAS/UIComponent/Explorer2/classes/class.ilExplorerBaseGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ beforeRendering()

◆ closeNode()

◆ createHTMLExportDirs()

◆ getAjax()

◆ getChildLimit()

◆ getChildsOfNode()

◆ getContainerId()

◆ getDomNodeIdForNodeId()

◆ getHTML()

◆ getId()

◆ getJSTreePlugins()

◆ getLocalExplorerJsPath()

◆ getLocalJsTreeCssPath()

◆ getLocalJsTreeJsPath()

◆ getNodeAsync()

◆ getNodeContent()

◆ getNodeHref()

◆ getNodeIcon()

◆ getNodeIconAlt()

◆ getNodeId()

◆ getNodeIdForDomNodeId()

◆ getNodeOnClick()

◆ getNodeTarget()

◆ getNodeToggleOnClick()

◆ getOfflineMode()

◆ getOnLoadCode()

◆ getRootNode()

◆ getSearchTerm()

◆ getSecondaryHighlightedNodes()

◆ getSelectOnClick()

◆ getSkipRootNode()

◆ handleCommand()

◆ init()

◆ isEnableDnd()

◆ isNodeClickable()

◆ isNodeHighlighted()

◆ isNodeOnclickEnabled()

◆ isNodeOpen()

◆ isNodeRequested()

◆ isNodeSelectable()

◆ isNodeVisible()

◆ listEnd()

◆ listItemEnd()

◆ listItemStart()

◆ listStart()

◆ nodeHasVisibleChilds()

◆ openNode()

◆ renderChilds()

◆ renderNode()

◆ setAjax()

◆ setChildLimit()

◆ setEnableDnd()

◆ setMainTemplate()

◆ setNodeOnclickEnabled()

◆ setNodeOpen()

◆ setNodeSelected()

◆ setOfflineMode()

◆ setSearchTerm()

◆ setSecondaryHighlightedNodes()

◆ setSelectMode()

◆ setSkipRootNode()

◆ sortChilds()

Field Documentation

◆ $ajax

◆ $child_limit

◆ $ctrl

◆ $custom_open_nodes

◆ $enable_dnd

◆ $id

◆ $js_expl_path

◆ $js_tree_path

◆ $js_tree_path_css