Explorer example. More...

Inheritance diagram for ilKSDocumentationExplorerGUI:

Collaboration diagram for ilKSDocumentationExplorerGUI:

Public Member Functions
	__construct (ilSystemStyleDocumentationGUI $a_parent_obj, $a_parent_cmd, Entry\ComponentEntries $entries, $current_opened_node_id)
	ilKSDocumentationExplorerGUI constructor. More...

	getRootNode ()
	Get root node. More...

	getNodeById ($a_entry_id)

	getNodeContent ($entry)

	getNodeHref ($entry)

	isNodeHighlighted ($entry)

	getNodeId ($entry)

	getParentLink ()

	setParentLink ($parentLink)

	getEntries ()

	setEntries ($entries)

	getCurrentOpenedNodeId ()

	setCurrentOpenedNodeId ($current_opened_node_id)

	getCurrentOpenedNode ()

Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor. More...

	setChildLimit ($a_val)
	Set child limit. More...

	getChildLimit ()
	Get child limit. More...

	setSearchTerm ($a_val)
	Set search term. More...

	getSearchTerm ()
	Get search term. More...

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

Protected Member Functions
	openNodesRecursively ($id)

Protected Member Functions inherited from ilExplorerBaseGUI
	isNodeSelectable ($a_node)
	Is node selectable? More...

	getNodeToggleOnClick ($a_node)
	Get onclick attribute for node toggling. More...

	getSelectOnClick ($a_node)
	Get onclick attribute for selecting radio/checkbox. More...

	isNodeOpen ($node_id)
	Get all open nodes. More...

	getJSTreePlugins ()

Protected Attributes
	$ctrl

	$id = "ksDocumentationExplorer"

	$parentLink = ""

	$entries = null

	$current_opened_node_id = ""

Protected Attributes inherited from ilExplorerBaseGUI
	$log

	$ctrl

	$tpl

	$skip_root_node = false

	$ajax = false

	$custom_open_nodes = array()

	$selected_nodes = array()

	$select_postvar = ""

	$offline_mode = false

	$sec_highl_nodes = array()

	$enable_dnd = false

	$search_term = ""

	$child_limit = 0

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()
	Get local path of explorer js. More...

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

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

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

static	init ($a_main_tpl=null)
	Init JS. More...

Static Protected Attributes inherited from ilExplorerBaseGUI
static	$js_tree_path = "./libs/bower/bower_components/jstree/dist/jstree.js"

static	$js_tree_path_css = "./libs/bower/bower_components/jstree/dist/themes/default/style.min.css"

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

Detailed Description

Explorer example.

Definition at line 11 of file class.ilKSDocumentationExplorerGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilKSDocumentationExplorerGUI::__construct	(	ilSystemStyleDocumentationGUI	$a_parent_obj,
			$a_parent_cmd,
		Entry\ComponentEntries	$entries,
			$current_opened_node_id
	)

ilKSDocumentationExplorerGUI constructor.

Parameters

ilSystemStyleDocumentationGUI	$a_parent_obj
	$a_parent_cmd
Entry\ComponentEntries	$entries
	$current_opened_node_id

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

References $current_opened_node_id, $DIC, getCurrentOpenedNodeId(), getEntries(), openNodesRecursively(), setCurrentOpenedNodeId(), setEntries(), ilExplorerBaseGUI\setOfflineMode(), and setParentLink().

     {
         global $DIC;
         $this->ctrl = $DIC->ctrl();
 
         parent::__construct($this->id, $a_parent_obj, $a_parent_cmd);
 
         $this->setParentLink($this->ctrl->getLinkTarget($this->parent_obj, $this->parent_cmd));
 
         $this->setEntries($entries);
         $this->setOfflineMode(true);
 
         if (!$current_opened_node_id) {
             $this->setCurrentOpenedNodeId($this->getEntries()->getRootEntryId());
         } else {
             $this->setCurrentOpenedNodeId($current_opened_node_id);
         }
 
         $this->openNodesRecursively($this->getCurrentOpenedNodeId());
     }

Here is the call graph for this function:

Member Function Documentation

◆ getCurrentOpenedNode()

ilKSDocumentationExplorerGUI::getCurrentOpenedNode ( )

Returns: Entry

Exceptions

ilSystemStyleException

Definition at line 204 of file class.ilKSDocumentationExplorerGUI.php.

References getCurrentOpenedNodeId(), and getEntries().

Referenced by isNodeHighlighted().

     {
         return $this->getEntries()->getEntryById($this->getCurrentOpenedNodeId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentOpenedNodeId()

ilKSDocumentationExplorerGUI::getCurrentOpenedNodeId ( )

Returns: string

Definition at line 187 of file class.ilKSDocumentationExplorerGUI.php.

References $current_opened_node_id.

Referenced by __construct(), and getCurrentOpenedNode().

     {
         return $this->current_opened_node_id;
     }

Here is the caller graph for this function:

◆ getEntries()

ilKSDocumentationExplorerGUI::getEntries ( )

Returns: Entry

Definition at line 171 of file class.ilKSDocumentationExplorerGUI.php.

References $entries.

Referenced by __construct(), getCurrentOpenedNode(), getNodeById(), getRootNode(), and openNodesRecursively().

     {
         return $this->entries;
     }

Here is the caller graph for this function:

◆ getNodeById()

ilKSDocumentationExplorerGUI::getNodeById ( $a_entry_id )

Parameters

$a_entry_id

Returns: Entry

Exceptions

Definition at line 112 of file class.ilKSDocumentationExplorerGUI.php.

References getEntries().

     {
         return $this->getEntries()->getEntryById($a_entry_id);
     }

Here is the call graph for this function:

◆ getNodeContent()

ilKSDocumentationExplorerGUI::getNodeContent ( $entry )

Parameters

mixed $entry

Returns: Entry

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

     {
         return $entry->getTitle();
     }

◆ getNodeHref()

ilKSDocumentationExplorerGUI::getNodeHref ( $entry )

Parameters

Entry\ComponentEntry $entry

Returns: string

Definition at line 130 of file class.ilKSDocumentationExplorerGUI.php.

References getParentLink().

     {
         return $this->getParentLink() . "&node_id=" . $entry->getId();
     }

Here is the call graph for this function:

◆ getNodeId()

ilKSDocumentationExplorerGUI::getNodeId ( $entry )

Parameters

Entry\ComponentEntry $entry

Returns: mixed

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

     {
         return $entry->getId();
     }

◆ getParentLink()

ilKSDocumentationExplorerGUI::getParentLink ( )

Returns: string

Definition at line 155 of file class.ilKSDocumentationExplorerGUI.php.

References $parentLink.

Referenced by getNodeHref().

     {
         return $this->parentLink;
     }

Here is the caller graph for this function:

◆ getRootNode()

ilKSDocumentationExplorerGUI::getRootNode ( )

Get root node.

Returns: mixed root node object/array

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

References ilExplorerBaseGUI\getChildsOfNode(), and getEntries().

     {
         return $this->getEntries()->getRootEntry();
     }

Here is the call graph for this function:

◆ isNodeHighlighted()

ilKSDocumentationExplorerGUI::isNodeHighlighted ( $entry )

Parameters

Entry\ComponentEntry $entry

Returns: bool

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

References getCurrentOpenedNode().

     {
         return $entry->getId() == $this->getCurrentOpenedNode()->getId();
     }

Here is the call graph for this function:

◆ openNodesRecursively()

ilKSDocumentationExplorerGUI::openNodesRecursively ( $id )

protected

Parameters

$id

Exceptions

Definition at line 70 of file class.ilKSDocumentationExplorerGUI.php.

References $id, getEntries(), and ilExplorerBaseGUI\setNodeOpen().

Referenced by __construct().

     {
         $this->setNodeOpen($id);
         $parent_id = $this->getEntries()->getEntryById($id)->getParent();
 
         if ($parent_id) {
             $this->openNodesRecursively($parent_id);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentOpenedNodeId()

ilKSDocumentationExplorerGUI::setCurrentOpenedNodeId ( $current_opened_node_id )

Parameters

string $current_opened_node_id

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

References $current_opened_node_id.

Referenced by __construct().

     {
         $this->current_opened_node_id = $current_opened_node_id;
     }

Here is the caller graph for this function:

◆ setEntries()

ilKSDocumentationExplorerGUI::setEntries ( $entries )

Parameters

Entry\ComponentEntries $entries

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

References $entries.

Referenced by __construct().

     {
         $this->entries = $entries;
     }

Here is the caller graph for this function:

◆ setParentLink()

ilKSDocumentationExplorerGUI::setParentLink ( $parentLink )

Parameters

string $parentLink

Definition at line 163 of file class.ilKSDocumentationExplorerGUI.php.

References $parentLink.

Referenced by __construct().

     {
         $this->parentLink = $parentLink;
     }

Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilCtrl ilKSDocumentationExplorerGUI::$ctrl

protected

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

◆ $current_opened_node_id

ilKSDocumentationExplorerGUI::$current_opened_node_id = ""

protected

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

Referenced by __construct(), getCurrentOpenedNodeId(), and setCurrentOpenedNodeId().

◆ $entries

ilKSDocumentationExplorerGUI::$entries = null

protected

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

Referenced by getEntries(), and setEntries().

◆ $id

ilKSDocumentationExplorerGUI::$id = "ksDocumentationExplorer"

protected

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

Referenced by openNodesRecursively().

◆ $parentLink

ilKSDocumentationExplorerGUI::$parentLink = ""

protected

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

Referenced by getParentLink(), and setParentLink().

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

Services/Style/System/classes/Documentation/class.ilKSDocumentationExplorerGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getCurrentOpenedNode()

◆ getCurrentOpenedNodeId()

◆ getEntries()

◆ getNodeById()

◆ getNodeContent()

◆ getNodeHref()

◆ getNodeId()

◆ getParentLink()

◆ getRootNode()

◆ isNodeHighlighted()

◆ openNodesRecursively()

◆ setCurrentOpenedNodeId()

◆ setEntries()

◆ setParentLink()

Field Documentation

◆ $ctrl

◆ $current_opened_node_id

◆ $entries

◆ $id

◆ $parentLink