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

	setMainTemplate (ilTemplate $a_main_tpl=null)
	Set main template (that is responsible for adding js/css) More...

	getRootNode ()
	Get root node. More...

	getChildsOfNode ($a_parent_node_id)
	Get childs of node. More...

	getNodeContent ($a_node)
	Get content of a node. More...

	getNodeId ($a_node)
	Get id of a node. More...

	getNodeHref ($a_node)
	Get href for node. More...

	nodeHasVisibleChilds ($a_node)
	Node has childs? More...

	sortChilds ($a_childs, $a_parent_node_id)
	Sort childs. More...

	getNodeIcon ($a_node)
	Get node icon path. More...

	getNodeIconAlt ($a_node)
	Get node icon alt attribute. More...

	getNodeTarget ($a_node)
	Get node target (frame) attribute. More...

	getNodeOnClick ($a_node)
	Get node onclick attribute. More...

	isNodeVisible ($a_node)
	Is node visible? More...

	isNodeHighlighted ($a_node)
	Is node highlighted? More...

	isNodeClickable ($a_node)
	Is node clickable? More...

	getId ()
	Get id of explorer element. More...

	setSkipRootNode ($a_val)
	Set skip root node. More...

	getSkipRootNode ()
	Get skip root node. More...

	setAjax ($a_val)
	Set ajax. More...

	getAjax ()
	Get ajax. More...

	setSecondaryHighlightedNodes ($a_val)
	Set secondary (background) highlighted nodes. More...

	getSecondaryHighlightedNodes ()
	Get secondary (background) highlighted nodes. More...

	setNodeOpen ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour) More...

	setSelectMode ($a_postvar, $a_multi=false)
	Set select mode (to deactivate, pass an empty string as postvar) More...

	setNodeSelected ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour) More...

	setOfflineMode ($a_val)
	Set offline mode. More...

	getOfflineMode ()
	Get offline mode. More...

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

	getContainerId ()
	Get container id. More...

	openNode ()
	Open node. More...

	closeNode ()
	Close node. More...

	getNodeAsync ()
	Get node asynchronously. More...

	beforeRendering ()
	Before rendering. More...

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

	getHTML ()
	Get HTML. More...

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

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

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

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

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

	listItemEnd ($tpl)
	List item end. More...

	listStart ($tpl)
	List start. More...

	listEnd ($tpl)
	List end. More...

	isNodeOnclickEnabled ()

	setNodeOnclickEnabled ($nodeOnclickEnabled)

	isEnableDnd ()

	setEnableDnd ($enable_dnd)
	Enable Drag & Drop functionality. More...

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 ($a_main_tpl=null)
	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
	$log

	$ctrl

	$tpl

	$skip_root_node = false

	$ajax = false

	$custom_open_nodes = array()

	$selected_nodes = array()

	$select_postvar = ""

	$offline_mode = false

	$sec_highl_nodes = array()

	$enable_dnd = false

Static Protected Attributes
static	$js_tree_path = "./libs/bower/bower_components/jstree/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.

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

References $DIC, and array.

     {
         global $DIC;
 
         $this->log = $DIC["ilLog"];
         $this->ctrl = $DIC->ctrl();
         $this->tpl = $DIC["tpl"];
         $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.

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

Referenced by getHTML(), and getNodeAsync().

540 {

541 }

Here is the caller graph for this function:

◆ closeNode()

ilExplorerBaseGUI::closeNode ( )

Close node.

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

References $_GET, $id, $ilLog, $log, exit, and getNodeIdForDomNodeId().

     {
         $ilLog = $this->log;
         
         $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;
     }

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 104 of file class.ilExplorerBaseGUI.php.

References getChildsOfNode(), getNodeContent(), getNodeId(), getRootNode(), and ilUtil\makeDirParents().

Referenced by ilObjContentObject\exportHTML().

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

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 343 of file class.ilExplorerBaseGUI.php.

References $ajax.

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

     {
         return $this->ajax;
     }

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

Referenced by createHTMLExportDirs(), getHTML(), ilKSDocumentationExplorerGUI\getRootNode(), nodeHasVisibleChilds(), and renderChilds().

Here is the caller graph for this function:

◆ getContainerId()

ilExplorerBaseGUI::getContainerId ( )

Get container id.

Parameters

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

References getId().

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

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

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

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

References getId().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilExplorerBaseGUI::getHTML ( )

Get HTML.

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

References $ctrl, $ilCtrl, $tpl, beforeRendering(), getChildsOfNode(), getContainerId(), getId(), getNodeId(), getOnLoadCode(), getRootNode(), getSkipRootNode(), isNodeVisible(), listEnd(), listStart(), renderNode(), and sortChilds().

     {
         $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, "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;
     }

Here is the call graph for this function:

◆ getId()

ilExplorerBaseGUI::getId ( )

Get id of explorer element.

Returns: integer id

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

References $id.

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

     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getJSTreePlugins()

ilExplorerBaseGUI::getJSTreePlugins ( )

protected

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

References array, and isEnableDnd().

Referenced by getOnLoadCode().

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

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 86 of file class.ilExplorerBaseGUI.php.

Referenced by ilGroupUserActionProvider\getJsScripts(), and ilObjContentObject\getSupplyingExportFiles().

     {
         return self::$js_expl_path;
     }

Here is the caller graph for this function:

◆ getLocalJsTreeJsPath()

static ilExplorerBaseGUI::getLocalJsTreeJsPath ( )

static

Get local path of jsTree js.

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

Referenced by ilGroupUserActionProvider\getJsScripts(), and ilObjContentObject\getSupplyingExportFiles().

     {
         return self::$js_tree_path;
     }

Here is the caller graph for this function:

◆ getNodeAsync()

ilExplorerBaseGUI::getNodeAsync ( )

Get node asynchronously.

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

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

     {
         $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;
     }

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

Referenced by createHTMLExportDirs(), and 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

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

Referenced by renderNode().

     {
         return "#";
     }

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

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

Referenced by renderNode().

     {
         return "";
     }

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

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

Referenced by renderNode().

     {
         return "";
     }

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

Referenced by createHTMLExportDirs(), 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

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

References $i, and getId().

Referenced by closeNode(), getNodeAsync(), ilObjStudyProgrammeTreeExplorerGUI\openCertainNode(), and openNode().

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

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

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

References getSelectOnClick().

Referenced by renderNode().

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

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

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

Referenced by renderNode().

     {
         return "";
     }

Here is the caller graph for this function:

◆ getNodeToggleOnClick()

ilExplorerBaseGUI::getNodeToggleOnClick ( $a_node )

finalprotected

Get onclick attribute for node toggling.

Parameters

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

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

Referenced by ilBookmarkBlockExplorerGUI\getNodeOnClick().

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

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 447 of file class.ilExplorerBaseGUI.php.

References $offline_mode.

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

     {
         return $this->offline_mode;
     }

Here is the caller graph for this function:

◆ getOnLoadCode()

ilExplorerBaseGUI::getOnLoadCode ( )

Get on load code.

Parameters

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

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

Referenced by getHTML().

     {
         $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 {
                 $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) . ');';
     }

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

Referenced by createHTMLExportDirs(), 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 363 of file class.ilExplorerBaseGUI.php.

References $sec_highl_nodes.

     {
         return $this->sec_highl_nodes;
     }

◆ getSelectOnClick()

ilExplorerBaseGUI::getSelectOnClick ( $a_node )

finalprotected

Get onclick attribute for selecting radio/checkbox.

Parameters

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

References getDomNodeIdForNodeId(), and getNodeId().

Referenced by getNodeOnClick().

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

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 323 of file class.ilExplorerBaseGUI.php.

References $skip_root_node.

Referenced by getHTML().

     {
         return $this->skip_root_node;
     }

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 461 of file class.ilExplorerBaseGUI.php.

References $_GET, array, and getContainerId().

     {
         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;
     }

Here is the call graph for this function:

◆ init()

static ilExplorerBaseGUI::init ( $a_main_tpl = null )

static

Init JS.

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

References $DIC, $tpl, and iljQueryUtil\initjQuery().

Referenced by ilInternalLinkGUI\getInitHTML().

     {
         global $DIC;
 
         if ($a_main_tpl == null) {
             $tpl = $DIC["tpl"];
         } else {
             $tpl = $a_main_tpl;
         }
 
         include_once("./Services/jQuery/classes/class.iljQueryUtil.php");
         iljQueryUtil::initjQuery($tpl);
 
         $tpl->addJavascript(self::getLocalExplorerJsPath());
         $tpl->addJavascript(self::getLocalJsTreeJsPath());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEnableDnd()

ilExplorerBaseGUI::isEnableDnd ( )

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

References $enable_dnd.

Referenced by getJSTreePlugins().

     {
         return $this->enable_dnd;
     }

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

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

Referenced by renderNode().

     {
         return true;
     }

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

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

Referenced by renderNode().

     {
         return false;
     }

Here is the caller graph for this function:

◆ isNodeOnclickEnabled()

ilExplorerBaseGUI::isNodeOnclickEnabled ( )

Returns: boolean

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

References $nodeOnclickEnabled.

Referenced by renderNode().

     {
         return $this->nodeOnclickEnabled;
     }

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

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

Referenced by renderNode().

     {
         return true;
     }

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

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

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

     {
         return true;
     }

Here is the caller graph for this function:

◆ listEnd()

ilExplorerBaseGUI::listEnd ( $tpl )

List end.

Parameters

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

References $tpl.

Referenced by getHTML(), and renderChilds().

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

Here is the caller graph for this function:

◆ listItemEnd()

ilExplorerBaseGUI::listItemEnd ( $tpl )

List item end.

Parameters

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

References $tpl.

Referenced by renderNode().

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

Here is the caller graph for this function:

◆ listItemStart()

ilExplorerBaseGUI::listItemStart	(	$tpl,
		$a_node
	)

List item start.

Parameters

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

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

Referenced by renderNode().

     {
         $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");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listStart()

ilExplorerBaseGUI::listStart ( $tpl )

List start.

Parameters

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

References $tpl.

Referenced by getHTML(), and renderChilds().

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

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

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ openNode()

ilExplorerBaseGUI::openNode ( )

Open node.

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

References $_GET, $id, $ilLog, $log, exit, and getNodeIdForDomNodeId().

     {
         $ilLog = $this->log;
         
         $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;
     }

Here is the call graph for this function:

◆ renderChilds()

ilExplorerBaseGUI::renderChilds	(	$a_node_id,
		$tpl
	)

final

Render childs.

Parameters

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

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

Referenced by getNodeAsync(), and renderNode().

     {
         $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);
             }
         }
     }

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

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

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

Referenced by getHTML(), and renderChilds().

     {
         $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);
     }

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 333 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 908 of file class.ilExplorerBaseGUI.php.

References $enable_dnd.

Referenced by ilObjStudyProgrammeTreeExplorerGUI\__construct().

     {
         $this->enable_dnd = $enable_dnd;
     }

Here is the caller graph for this function:

◆ setMainTemplate()

ilExplorerBaseGUI::setMainTemplate ( ilTemplate $a_main_tpl = null )

Set main template (that is responsible for adding js/css)

Parameters

ilTemplate | null $a_main_tpl

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

     {
         $this->tpl = $a_main_tpl;
     }

◆ setNodeOnclickEnabled()

ilExplorerBaseGUI::setNodeOnclickEnabled ( $nodeOnclickEnabled )

Parameters

boolean $nodeOnclickEnabled

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

References $nodeOnclickEnabled.

     {
         $this->nodeOnclickEnabled = $nodeOnclickEnabled;
     }

◆ setNodeOpen()

ilExplorerBaseGUI::setNodeOpen ( $a_id )

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

Parameters

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

Referenced by ilLMTableOfContentsExplorerGUI\__construct(), ilPublicSectionExplorerGUI\beforeRendering(), ilForumExplorerGUI\getHTML(), ilKSDocumentationExplorerGUI\openNodesRecursively(), and ilTreeExplorerGUI\setPathOpen().

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

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

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

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

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

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 437 of file class.ilExplorerBaseGUI.php.

Referenced by ilKSDocumentationExplorerGUI\__construct().

     {
         $this->offline_mode = $a_val;
     }

Here is the caller graph for this function:

◆ setSecondaryHighlightedNodes()

ilExplorerBaseGUI::setSecondaryHighlightedNodes ( $a_val )

Set secondary (background) highlighted nodes.

Parameters

array $a_val array of node ids

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

Referenced by ilLMTOCExplorerGUI\__construct().

     {
         $this->sec_highl_nodes = $a_val;
     }

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 413 of file class.ilExplorerBaseGUI.php.

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

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

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

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

Referenced by getHTML(), and renderChilds().

     {
         return $a_childs;
     }

Here is the caller graph for this function:

Field Documentation

◆ $ajax

ilExplorerBaseGUI::$ajax = false

protected

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

Referenced by getAjax().

◆ $ctrl

ilExplorerBaseGUI::$ctrl

protected

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

Referenced by getHTML(), ilMaterialExplorer\getNodeHref(), ilMediaPoolExplorerGUI\getNodeHref(), ilSCORM2004EditorExplorerGUI\getNodeHref(), ilLMEditorExplorerGUI\getNodeHref(), and getOnLoadCode().

◆ $custom_open_nodes

ilExplorerBaseGUI::$custom_open_nodes = array()

protected

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

◆ $enable_dnd

ilExplorerBaseGUI::$enable_dnd = false

protected

Definition at line 42 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 34 of file class.ilExplorerBaseGUI.php.

◆ $js_tree_path

ilExplorerBaseGUI::$js_tree_path = "./libs/bower/bower_components/jstree/jquery.jstree.js"

staticprotected

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

◆ $log

ilExplorerBaseGUI::$log

protected

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

Referenced by closeNode(), and openNode().

◆ $nodeOnclickEnabled

ilExplorerBaseGUI::$nodeOnclickEnabled

private

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

Referenced by isNodeOnclickEnabled(), and setNodeOnclickEnabled().

◆ $offline_mode

ilExplorerBaseGUI::$offline_mode = false

protected

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

Referenced by getOfflineMode().

◆ $sec_highl_nodes

ilExplorerBaseGUI::$sec_highl_nodes = array()

protected

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

Referenced by getSecondaryHighlightedNodes().

◆ $select_postvar

ilExplorerBaseGUI::$select_postvar = ""

protected

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

Referenced by ilSkillSelectorGUI\getSelectedSkills().

◆ $selected_nodes

ilExplorerBaseGUI::$selected_nodes = array()

protected

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

◆ $skip_root_node

ilExplorerBaseGUI::$skip_root_node = false

protected

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

Referenced by getSkipRootNode().

◆ $tpl

ilExplorerBaseGUI::$tpl

protected

Definition at line 31 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:

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

◆ setMainTemplate()

◆ setNodeOnclickEnabled()

◆ setNodeOpen()

◆ setNodeSelected()

◆ setOfflineMode()

◆ setSecondaryHighlightedNodes()

◆ setSelectMode()

◆ setSkipRootNode()

◆ sortChilds()

Field Documentation

◆ $ajax

◆ $ctrl

◆ $custom_open_nodes

◆ $enable_dnd

◆ $js_expl_path

◆ $js_tree_path

◆ $log

◆ $nodeOnclickEnabled

◆ $offline_mode

◆ $sec_highl_nodes

◆ $select_postvar

◆ $selected_nodes

◆ $skip_root_node

◆ $tpl