Explorer base GUI class. More...

Inheritance diagram for ilExplorerBaseGUI:

Collaboration diagram for ilExplorerBaseGUI:

Public Member Functions
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor. 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...

Static Public Member Functions
static	getLocalExplorerJsPath ()
	Get local path of explorer js. More...

static	getLocalJsTreeJsPath ()
	Get local path of jsTree js. More...

static	createHTMLExportDirs ($a_target_dir)
	Create html export directories. More...

static	init ()
	Init JS. More...

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

	getJSTreePlugins ()

Protected Attributes
	$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

Static Protected Attributes
static	$js_tree_path = "./Services/UIComponent/Explorer2/lib/jstree-v.pre1.0/jquery.jstree.js"

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

Private Attributes
	$nodeOnclickEnabled

Detailed Description

Explorer base GUI class.

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: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilExplorerBaseGUI::__construct	(	$a_expl_id,
		$a_parent_obj,
		$a_parent_cmd
	)

Constructor.

Reimplemented in ilVirtualSkillTreeExplorerGUI, ilPublicSectionExplorerGUI, ilMediaPoolExplorerGUI, ilMaterialExplorer, ilSCORM2004EditorExplorerGUI, ilMailExplorer, ilBookmarkBlockExplorerGUI, and ilBookmarkExplorerGUI.

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

        {
                $this->id = $a_expl_id;
                $this->parent_obj = $a_parent_obj;
                $this->parent_cmd = $a_parent_cmd;
 
                // get open nodes
                include_once("./Services/Authentication/classes/class.ilSessionIStorage.php");
                $this->store = new ilSessionIStorage("expl2");
                $open_nodes = $this->store->get("on_".$this->id);
                $this->open_nodes = unserialize($open_nodes);
                if (!is_array($this->open_nodes))
                {
                        $this->open_nodes = array();
                }
 
                $this->nodeOnclickEnabled = true;
        }

Member Function Documentation

◆ beforeRendering()

ilExplorerBaseGUI::beforeRendering ( )

Before rendering.

Reimplemented in ilLMExplorerGUI, and ilPublicSectionExplorerGUI.

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

        {
 
        }

Referenced by getHTML(), and getNodeAsync().

Here is the caller graph for this function:

◆ closeNode()

ilExplorerBaseGUI::closeNode ( )

Close node.

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

        {
                global $ilLog;
                
                $id = $this->getNodeIdForDomNodeId($_GET["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 $_GET, $ilLog, exit, and getNodeIdForDomNodeId().

Here is the call graph for this function:

◆ createHTMLExportDirs()

static ilExplorerBaseGUI::createHTMLExportDirs ( $a_target_dir )

static

Create html export directories.

Parameters

string $a_target_dir target directory

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

        {
                ilUtil::makeDirParents($a_target_dir."/Services/UIComponent/Explorer2/lib/jstree-v.pre1.0");
                ilUtil::makeDirParents($a_target_dir."/Services/UIComponent/Explorer2/js");
        }

References ilUtil\makeDirParents().

Referenced by ilObjContentObject\exportHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAjax()

ilExplorerBaseGUI::getAjax ( )

Get ajax.

Returns: boolean ajax

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

        {
                return $this->ajax;
        }

References $ajax.

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

Here is the caller graph for this function:

◆ getChildsOfNode()

ilExplorerBaseGUI::getChildsOfNode ( $a_parent_node_id )

abstract

Get childs of node.

Parameters

string $a_parent_id parent node id

Returns: array childs

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

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

Here is the caller graph for this function:

◆ getContainerId()

ilExplorerBaseGUI::getContainerId ( )

Get container id.

Parameters

return

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

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

Referenced by ilObjStudyProgrammeTreeExplorerGUI\getHTML(), getHTML(), getOnLoadCode(), and handleCommand().

Here is the caller graph for this function:

◆ getDomNodeIdForNodeId()

ilExplorerBaseGUI::getDomNodeIdForNodeId ( $a_node_id )

Get DOM node id for node id.

Parameters

return

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

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

Referenced by getNodeToggleOnClick(), getOnLoadCode(), getSelectOnClick(), ilObjStudyProgrammeTreeExplorerGUI\listItemStart(), and listItemStart().

Here is the caller graph for this function:

◆ getHTML()

ilExplorerBaseGUI::getHTML ( )

Get HTML.

Reimplemented in ilObjStudyProgrammeTreeExplorerGUI, and ilTreeExplorerGUI.

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

        {
                global $tpl, $ilCtrl;
 
                $this->beforeRendering();
 
                self::init();
                $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, "Services/UIComponent/Explorer2");
 
                // 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>";
                }
 
                return $etpl->get().$add;
        }

References $ilCtrl, $tpl, beforeRendering(), getChildsOfNode(), getContainerId(), 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: integer id

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

        {
                return $this->id;
        }

Referenced by getNodeIdForDomNodeId().

Here is the caller graph for this function:

◆ getJSTreePlugins()

ilExplorerBaseGUI::getJSTreePlugins ( )

protected

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

                                              {
                $plugins = array("html_data", "themes", "json_data");
                if($this->isEnableDnd()) {
                        $plugins[] = "crrm";
                        $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

Get local path of explorer js.

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

        {
                return self::$js_expl_path;
        }

References $js_expl_path.

Referenced by ilObjContentObject\getSupplyingExportFiles().

Here is the caller graph for this function:

◆ getLocalJsTreeJsPath()

static ilExplorerBaseGUI::getLocalJsTreeJsPath ( )

static

Get local path of jsTree js.

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

        {
                return self::$js_tree_path;
        }

References $js_tree_path.

Referenced by ilObjContentObject\getSupplyingExportFiles().

Here is the caller graph for this function:

◆ getNodeAsync()

ilExplorerBaseGUI::getNodeAsync ( )

Get node asynchronously.

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

        {
                $this->beforeRendering();
 
                if ($_GET["node_id"] != "")
                {
                        $id = $this->getNodeIdForDomNodeId($_GET["node_id"]);
                }
                else
                {
                        $id = $this->getNodeId($this->getRootNode());
                }
                
                $etpl = new ilTemplate("tpl.explorer2.html", true, true, "Services/UIComponent/Explorer2");
                $this->renderChilds($id, $etpl);
                echo $etpl->get("tag");
                exit;
        }

References $_GET, beforeRendering(), exit, getNodeId(), getNodeIdForDomNodeId(), getRootNode(), and renderChilds().

Here is the call graph for this function:

◆ getNodeContent()

ilExplorerBaseGUI::getNodeContent ( $a_node )

abstract

Get content of a node.

Parameters

mixed $a_node node array or object

Returns: string content of the node

Reimplemented in ilLMExplorerGUI, ilLMTOCExplorerGUI, ilPublicSectionExplorerGUI, ilMediaPoolExplorerGUI, ilSCORM2004EditorExplorerGUI, ilMaterialExplorer, ilAdministrationExplorerGUI, ilBookmarkExplorerGUI, ilMailExplorer, ilPaymentObjectSelector, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, ilPersonalSkillExplorerGUI, ilSkillTemplateTreeExplorerGUI, ilSkillTreeExplorerGUI, ilVirtualSkillTreeExplorerGUI, ilTaxonomyExplorerGUI, ilOrgUnitExplorerGUI, and ilObjStudyProgrammeTreeExplorerGUI.

Referenced by renderNode().

Here is the caller graph for this function:

◆ getNodeHref()

ilExplorerBaseGUI::getNodeHref ( $a_node )

Get href for node.

Parameters

mixed $a_node node object/array

Returns: string href attribute

Reimplemented in ilLMEditorExplorerGUI, ilLMTOCExplorerGUI, ilMediaPoolExplorerGUI, ilSCORM2004EditorExplorerGUI, ilMaterialExplorer, ilAdministrationExplorerGUI, ilBookmarkBlockExplorerGUI, ilBookmarkExplorerGUI, ilBookmarkMoveExplorerGUI, ilPoolSelectorGUI, ilIntLinkRepItemExplorerGUI, ilMailExplorer, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, ilPersonalSkillExplorerGUI, ilSkillSelectorGUI, ilSkillTemplateTreeExplorerGUI, ilSkillTreeExplorerGUI, ilVirtualSkillTreeExplorerGUI, ilTaxonomyExplorerGUI, ilOrgUnitExplorerGUI, ilObjStudyProgrammeTreeExplorerGUI, and ilPaymentObjectSelector.

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

        {
                return "#";
        }

Referenced by renderNode().

Here is the caller graph for this function:

◆ getNodeIcon()

ilExplorerBaseGUI::getNodeIcon ( $a_node )

Get node icon path.

Parameters

mixed $a_node node object/array

Returns: string image file path

Reimplemented in ilLMEditorExplorerGUI, ilLMTOCExplorerGUI, ilPublicSectionExplorerGUI, ilMediaPoolExplorerGUI, ilOrgUnitExplorerGUI, ilSCORM2004EditorExplorerGUI, ilObjStudyProgrammeTreeExplorerGUI, ilMaterialExplorer, ilAdministrationExplorerGUI, ilBookmarkExplorerGUI, ilMailExplorer, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, ilPersonalSkillExplorerGUI, ilSkillTemplateTreeExplorerGUI, ilSkillTreeExplorerGUI, ilVirtualSkillTreeExplorerGUI, and ilTaxonomyExplorerGUI.

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

        {
                return "";
        }

Referenced by renderNode().

Here is the caller graph for this function:

◆ getNodeIconAlt()

ilExplorerBaseGUI::getNodeIconAlt ( $a_node )

Get node icon alt attribute.

Parameters

mixed $a_node node object/array

Returns: string image alt attribute

Reimplemented in ilLMEditorExplorerGUI, ilLMTOCExplorerGUI, ilSCORM2004EditorExplorerGUI, ilAdministrationExplorerGUI, ilBookmarkExplorerGUI, ilMailExplorer, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, and ilTreeExplorerGUI.

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

        {
                return "";
        }

Referenced by renderNode().

Here is the caller graph for this function:

◆ getNodeId()

ilExplorerBaseGUI::getNodeId ( $a_node )

abstract

Get id of a node.

Parameters

mixed $a_node node array or object

Returns: string id of node

Reimplemented in ilObjStudyProgrammeTreeExplorerGUI, ilVirtualSkillTreeExplorerGUI, and ilTreeExplorerGUI.

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

Here is the caller graph for this function:

◆ getNodeIdForDomNodeId()

ilExplorerBaseGUI::getNodeIdForDomNodeId ( $a_dom_node_id )

Get node id for dom node id.

Parameters

return

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

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

References getId().

Referenced by closeNode(), getNodeAsync(), ilObjStudyProgrammeTreeExplorerGUI\openCertainNode(), 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

mixed $a_node node object/array

Returns: string onclick value

Reimplemented in ilBookmarkBlockExplorerGUI, ilIntLinkRepItemExplorerGUI, ilLinkTargetObjectExplorerGUI, and ilTaxonomyExplorerGUI.

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

        {
                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

mixed $a_node node object/array

Returns: string target

Reimplemented in ilBookmarkBlockExplorerGUI.

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

        {
                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

return

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

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

References getDomNodeIdForNodeId(), and getNodeId().

Referenced by ilBookmarkBlockExplorerGUI\getNodeOnClick().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOfflineMode()

ilExplorerBaseGUI::getOfflineMode ( )

Get offline mode.

Returns: bool offline mode

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

        {
                return $this->offline_mode;
        }

References $offline_mode.

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

Here is the caller graph for this function:

◆ getOnLoadCode()

ilExplorerBaseGUI::getOnLoadCode ( )

Get on load code.

Parameters

return

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

        {
                global $ilCtrl;
 
                $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
                        {
                                $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(),
                );
 
 
                // jstree config options
                $js_tree_config = array(
                        "core" => array(
                                "animation" => 300,
                                "initially_open" => $open_nodes,
                                "open_parents" => false,
                                "strings" => array("loading" => "Loading ...", "new_node" => "New node")
                        ),
                        "plugins" => $this->getJSTreePlugins(),
                        "themes" => array("dots" => false, "icons" => false, "theme" => ""),
                        "html_data" => array()
                );
 
                return 'il.Explorer2.init('.json_encode($config).', '.json_encode($js_tree_config).');';
        }

References $ilCtrl, $url, getAjax(), getContainerId(), getDomNodeIdForNodeId(), 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: mixed root node object/array

Reimplemented in ilLMTOCExplorerGUI, ilOrgUnitExplorerGUI, ilObjStudyProgrammeTreeExplorerGUI, ilRepositoryExplorerGUI, ilSkillTemplateTreeExplorerGUI, ilVirtualSkillTreeExplorerGUI, and ilTreeExplorerGUI.

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

Here is the caller graph for this function:

◆ getSecondaryHighlightedNodes()

ilExplorerBaseGUI::getSecondaryHighlightedNodes ( )

Get secondary (background) highlighted nodes.

Returns: array array of node ids

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

        {
                return $this->sec_highl_nodes;
        }

References $sec_highl_nodes.

◆ getSelectOnClick()

ilExplorerBaseGUI::getSelectOnClick ( $a_node )

finalprotected

Get onclick attribute for selecting radio/checkbox.

Parameters

return

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

        {
                $dn_id = $this->getDomNodeIdForNodeId($this->getNodeId($a_node));
                $oc = "il.Explorer2.selectOnClick('".$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 ( )

Get skip root node.

Returns: boolean skip root node

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

        {
                return $this->skip_root_node;
        }

References $skip_root_node.

Referenced by getHTML().

Here is the caller graph for this function:

◆ handleCommand()

ilExplorerBaseGUI::handleCommand ( )

Handle explorer internal command.

Returns: boolean true, if an internal command has been performed.

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

        {
                if ($_GET["exp_cmd"] != "" &&
                        $_GET["exp_cont"] == $this->getContainerId())
                {
                        $cmd = $_GET["exp_cmd"];
                        if (in_array($cmd, array("openNode", "closeNode", "getNodeAsync")))
                        {
                                $this->$cmd();
                        }
                        
                        return true;
                }
                return false;
        }

References $_GET, $cmd, and getContainerId().

Here is the call graph for this function:

◆ init()

static ilExplorerBaseGUI::init ( )

static

Init JS.

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

        {
                global $tpl;
 
                include_once("./Services/jQuery/classes/class.iljQueryUtil.php");
                iljQueryUtil::initjQuery();
 
                $tpl->addJavascript(self::getLocalExplorerJsPath());
                $tpl->addJavascript(self::getLocalJsTreeJsPath());
        }

References $tpl, and iljQueryUtil\initjQuery().

Referenced by getHTML(), and ilInternalLinkGUI\getInitHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEnableDnd()

ilExplorerBaseGUI::isEnableDnd ( )

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

                                      {
                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

mixed $a_node node object/array

Returns: boolean node clickable true/false

Reimplemented in ilLMTOCExplorerGUI, ilPublicSectionExplorerGUI, ilOrgUnitExplorerGUI, ilObjStudyProgrammeTreeExplorerGUI, ilMaterialExplorer, ilConditionSelector, ilAdministrationExplorerGUI, ilLinkTargetObjectExplorerGUI, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, ilPersonalSkillExplorerGUI, ilSkillSelectorGUI, ilSkillTreeExplorerGUI, ilVirtualSkillTreeExplorerGUI, and ilPaymentObjectSelector.

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

        {
                return true;
        }

Referenced by renderNode().

Here is the caller graph for this function:

◆ isNodeHighlighted()

ilExplorerBaseGUI::isNodeHighlighted ( $a_node )

Is node highlighted?

Parameters

mixed $a_node node object/array

Returns: boolean node highlighted true/false

Reimplemented in ilLMExplorerGUI, ilLMTOCExplorerGUI, ilMediaPoolExplorerGUI, ilSCORM2004EditorExplorerGUI, ilConditionSelector, ilAdministrationExplorerGUI, ilBookmarkBlockExplorerGUI, ilBookmarkExplorerGUI, ilBookmarkMoveExplorerGUI, ilMailExplorer, ilRepositoryExplorerGUI, ilRepositorySelectorExplorerGUI, ilSkillTemplateTreeExplorerGUI, ilSkillTreeExplorerGUI, and ilTaxonomyExplorerGUI.

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

        {
                return false;
        }

Referenced by renderNode().

Here is the caller graph for this function:

◆ isNodeOnclickEnabled()

ilExplorerBaseGUI::isNodeOnclickEnabled ( )

Returns: boolean

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

        {
                return $this->nodeOnclickEnabled;
        }

References $nodeOnclickEnabled.

Referenced by renderNode().

Here is the caller graph for this function:

◆ isNodeSelectable()

ilExplorerBaseGUI::isNodeSelectable ( $a_node )

protected

Is node selectable?

Parameters

mixed $a_node node object/array

Returns: boolean node selectable true/false

Reimplemented in ilSkillSelectorGUI.

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

        {
                return true;
        }

Referenced by renderNode().

Here is the caller graph for this function:

◆ isNodeVisible()

ilExplorerBaseGUI::isNodeVisible ( $a_node )

Is node visible?

Parameters

mixed $a_node node object/array

Returns: boolean node visible true/false

Reimplemented in ilForumMoveTopicsExplorer, ilLMTOCExplorerGUI, ilConditionSelector, ilAdministrationExplorerGUI, ilPoolSelectorGUI, ilRepositoryExplorerGUI, and ilRepositorySelectorExplorerGUI.

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

        {
                return true;
        }

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

Here is the caller graph for this function:

◆ listEnd()

ilExplorerBaseGUI::listEnd ( $tpl )

List end.

Parameters

return

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

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

References $tpl.

Referenced by getHTML(), and renderChilds().

Here is the caller graph for this function:

◆ listItemEnd()

ilExplorerBaseGUI::listItemEnd ( $tpl )

List item end.

Parameters

return

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

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

References $tpl.

Referenced by renderNode().

Here is the caller graph for this function:

◆ listItemStart()

ilExplorerBaseGUI::listItemStart	(	$tpl,
		$a_node
	)

List item start.

Parameters

return

Reimplemented in ilObjStudyProgrammeTreeExplorerGUI.

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

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

References $tpl, getAjax(), getDomNodeIdForNodeId(), getNodeId(), and nodeHasVisibleChilds().

Referenced by renderNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listStart()

ilExplorerBaseGUI::listStart ( $tpl )

List start.

Parameters

return

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

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

References $tpl.

Referenced by getHTML(), and renderChilds().

Here is the caller graph for this function:

◆ nodeHasVisibleChilds()

ilExplorerBaseGUI::nodeHasVisibleChilds ( $a_node )

Node has childs?

Please note that this standard method may not be optimal depending on what a derived class does in isNodeVisible.

Parameters

return

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

        {
                $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 ilObjStudyProgrammeTreeExplorerGUI\listItemStart(), and 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 466 of file class.ilExplorerBaseGUI.php.

        {
                global $ilLog;
                
                $id = $this->getNodeIdForDomNodeId($_GET["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 $_GET, $ilLog, exit, and getNodeIdForDomNodeId().

Here is the call graph for this function:

◆ renderChilds()

ilExplorerBaseGUI::renderChilds	(	$a_node_id,
		$tpl
	)

final

Render childs.

Parameters

return

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

        {
                $childs = $this->getChildsOfNode($a_node_id);
                $childs = $this->sortChilds($childs, $a_node_id);
 
                if (count($childs) > 0)
                {
                        $any = false;
                        foreach ($childs as $child)
                        {
                                if ($this->isNodeVisible($child))
                                {
                                        if (!$any)
                                        {
                                                $this->listStart($tpl);
                                                $any = true;
                                        }
                                        $this->renderNode($child, $tpl);
                                }
                        }
                        if ($any)
                        {
                                $this->listEnd($tpl);
                        }
                }
        }

References $tpl, getChildsOfNode(), isNodeVisible(), listEnd(), listStart(), renderNode(), and sortChilds().

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,
		$tpl
	)

Render node.

Parameters

return

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

        {
                $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."[]");
                                $tpl->parseCurrentBlock();
                        }
                        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));
                $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);
                }
                
                $this->listItemEnd($tpl);
        }

References $tpl, getAjax(), getNodeContent(), getNodeHref(), getNodeIcon(), getNodeIconAlt(), getNodeId(), getNodeOnClick(), getNodeTarget(), ilUtil\img(), isNodeClickable(), isNodeHighlighted(), isNodeOnclickEnabled(), isNodeSelectable(), listItemEnd(), listItemStart(), and renderChilds().

Referenced by getHTML(), and renderChilds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAjax()

ilExplorerBaseGUI::setAjax ( $a_val )

Set ajax.

Parameters

boolean $a_val ajax

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

        {
                $this->ajax = $a_val;
        }

Here is the caller graph for this function:

◆ setEnableDnd()

ilExplorerBaseGUI::setEnableDnd ( $enable_dnd )

Enable Drag & Drop functionality.

Parameters

boolean $enable_dnd

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

                                                  {
                $this->enable_dnd = $enable_dnd;
        }

References $enable_dnd.

Referenced by ilObjStudyProgrammeTreeExplorerGUI\__construct().

Here is the caller graph for this function:

◆ setNodeOnclickEnabled()

ilExplorerBaseGUI::setNodeOnclickEnabled ( $nodeOnclickEnabled )

Parameters

boolean $nodeOnclickEnabled

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

        {
                $this->nodeOnclickEnabled = $nodeOnclickEnabled;
        }

References $nodeOnclickEnabled.

◆ setNodeOpen()

ilExplorerBaseGUI::setNodeOpen ( $a_id )

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

Parameters

return

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

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

Referenced by ilLMTableOfContentsExplorerGUI\__construct(), ilPublicSectionExplorerGUI\beforeRendering(), and ilTreeExplorerGUI\setPathOpen().

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

return

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

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

Referenced by ilPublicSectionExplorerGUI\beforeRendering(), and ilSkillSelectorGUI\setSkillSelected().

Here is the caller graph for this function:

◆ setOfflineMode()

ilExplorerBaseGUI::setOfflineMode ( $a_val )

Set offline mode.

Parameters

bool $a_val offline mode

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

        {
                $this->offline_mode = $a_val;
        }

◆ setSecondaryHighlightedNodes()

ilExplorerBaseGUI::setSecondaryHighlightedNodes ( $a_val )

Set secondary (background) highlighted nodes.

Parameters

array $a_val array of node ids

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

        {
                $this->sec_highl_nodes = $a_val;
        }

Referenced by ilLMTOCExplorerGUI\__construct().

Here is the caller graph for this function:

◆ setSelectMode()

ilExplorerBaseGUI::setSelectMode	(	$a_postvar,
		$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
boolean	$a_multi	multi select (checkboxes) or not (radio)

Returns

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

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

Referenced by ilForumMoveTopicsExplorer\__construct().

Here is the caller graph for this function:

◆ setSkipRootNode()

ilExplorerBaseGUI::setSkipRootNode ( $a_val )

Set skip root node.

If set to false, the top node will not be displayed.

Parameters

boolean $a_val skip root node

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

        {
                $this->skip_root_node = $a_val;
        }

Here is the caller graph for this function:

◆ sortChilds()

ilExplorerBaseGUI::sortChilds	(	$a_childs,
		$a_parent_node_id
	)

Sort childs.

Parameters

array	$a_childs	array of child nodes
mixed	$a_parent_node	parent node

Returns: array array of childs nodes

Reimplemented in ilOrgUnitExplorerGUI, ilAdministrationExplorerGUI, ilRepositoryExplorerGUI, and ilRepositorySelectorExplorerGUI.

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

        {
                return $a_childs;
        }

Referenced by getHTML(), and renderChilds().

Here is the caller graph for this function:

Field Documentation

◆ $ajax

ilExplorerBaseGUI::$ajax = false

protected

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

Referenced by getAjax().

◆ $custom_open_nodes

ilExplorerBaseGUI::$custom_open_nodes = array()

protected

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

◆ $enable_dnd

ilExplorerBaseGUI::$enable_dnd = false

protected

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

Referenced by isEnableDnd(), and setEnableDnd().

◆ $js_expl_path

ilExplorerBaseGUI::$js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js"

staticprotected

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

Referenced by getLocalExplorerJsPath().

◆ $js_tree_path

ilExplorerBaseGUI::$js_tree_path = "./Services/UIComponent/Explorer2/lib/jstree-v.pre1.0/jquery.jstree.js"

staticprotected

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

Referenced by getLocalJsTreeJsPath().

◆ $nodeOnclickEnabled

ilExplorerBaseGUI::$nodeOnclickEnabled

private

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

Referenced by isNodeOnclickEnabled(), and setNodeOnclickEnabled().

◆ $offline_mode

ilExplorerBaseGUI::$offline_mode = false

protected

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

Referenced by getOfflineMode().

◆ $sec_highl_nodes

ilExplorerBaseGUI::$sec_highl_nodes = array()

protected

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

Referenced by getSecondaryHighlightedNodes().

◆ $select_postvar

ilExplorerBaseGUI::$select_postvar = ""

protected

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

Referenced by ilSkillSelectorGUI\getSelectedSkills().

◆ $selected_nodes

ilExplorerBaseGUI::$selected_nodes = array()

protected

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

◆ $skip_root_node

ilExplorerBaseGUI::$skip_root_node = false

protected

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

Referenced by getSkipRootNode().

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

Services/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

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ beforeRendering()

◆ closeNode()

◆ createHTMLExportDirs()

◆ getAjax()

◆ getChildsOfNode()

◆ getContainerId()

◆ getDomNodeIdForNodeId()

◆ getHTML()

◆ getId()

◆ getJSTreePlugins()

◆ getLocalExplorerJsPath()

◆ getLocalJsTreeJsPath()

◆ getNodeAsync()

◆ getNodeContent()

◆ getNodeHref()

◆ getNodeIcon()

◆ getNodeIconAlt()

◆ getNodeId()

◆ getNodeIdForDomNodeId()

◆ getNodeOnClick()

◆ getNodeTarget()

◆ getNodeToggleOnClick()

◆ getOfflineMode()

◆ getOnLoadCode()

◆ getRootNode()

◆ getSecondaryHighlightedNodes()

◆ getSelectOnClick()

◆ getSkipRootNode()

◆ handleCommand()

◆ init()

◆ isEnableDnd()

◆ isNodeClickable()

◆ isNodeHighlighted()

◆ isNodeOnclickEnabled()

◆ isNodeSelectable()

◆ isNodeVisible()

◆ listEnd()

◆ listItemEnd()

◆ listItemStart()

◆ listStart()

◆ nodeHasVisibleChilds()

◆ openNode()

◆ renderChilds()

◆ renderNode()

◆ setAjax()

◆ setEnableDnd()

◆ setNodeOnclickEnabled()

◆ setNodeOpen()

◆ setNodeSelected()

◆ setOfflineMode()

◆ setSecondaryHighlightedNodes()

◆ setSelectMode()

◆ setSkipRootNode()

◆ sortChilds()

Field Documentation

◆ $ajax

◆ $custom_open_nodes

◆ $enable_dnd

◆ $js_expl_path

◆ $js_tree_path

◆ $nodeOnclickEnabled

◆ $offline_mode

◆ $sec_highl_nodes

◆ $select_postvar

◆ $selected_nodes

◆ $skip_root_node