Inheritance diagram for ilOrgUnitExplorerGUI:

Collaboration diagram for ilOrgUnitExplorerGUI:

Public Member Functions
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree)

	getNodeContent ($node)

	getRootNode ()

	getNodeIcon ($a_node)
	Get node icon Return custom icon of OrgUnit type if existing. More...

	getNodeHref ($node)

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

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

	sortbyTitle ($a, $b)

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

	isNodeSelectable ($a_node)

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

	getTree ()
	Get tree. More...

	setOrderField ($a_val, $a_numeric=false)
	Set order field. More...

	getOrderField ()
	Get order field. More...

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

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

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

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

	setPreloadChilds ($a_val)
	Set preload childs. More...

	getPreloadChilds ()
	Get preload childs. More...

	getSuccessorNode ($a_node_id, $a_type="")
	Get successor node (currently only(!) based on lft/rgt tree values) More...

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

	getNodeId ($a_node)
	Get id for node. More...

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

	getRootNode ()
	Get root node. More...

	setRootId ($a_root)

	setPathOpen ($a_id)
	Set node path to be opened. More...

	getHTML ()
	Get HTML. More...

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

	getPluginLinkTarget ()

Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	Preload childs. More...

	matches ($node)
	Does a node match a search term (or is search term empty) More...

	getRootId ()

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
	$stay_with_command = array( "", "render", "view", "infoScreen", "showStaff", "performPaste", "cut" )

	$tree = null

Protected Attributes inherited from ilTreeExplorerGUI
	$lng

	$tree = null

	$order_field = ""

	$order_field_numeric = false

	$type_white_list = array()

	$type_black_list = array()

	$childs = array()

	$preloaded = false

	$preload_childs = false

	$root_node_data = null

	$all_childs = array()

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

Class ilOrgUnitExplorerGUI.

Author: : Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; : Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitExplorerGUI::__construct	(	$a_expl_id,
		$a_parent_obj,
		$a_parent_cmd,
		$a_tree
	)

Parameters

$a_expl_id
$a_parent_obj
$a_parent_cmd
$a_tree

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

References ilExplorerBaseGUI\setAjax(), and ilTreeExplorerGUI\setTypeWhiteList().

     {
         parent::__construct($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree);
         $this->setAjax(true);
         $this->setTypeWhiteList(array( "orgu" ));
         $this->tree->initLangCode();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getChildsOfNode()

ilOrgUnitExplorerGUI::getChildsOfNode ( $a_parent_node_id )

Get childs of node.

Parameters

$a_parent_node_id ilAccessHandler $ilAccess

Definition at line 149 of file class.ilOrgUnitExplorerGUI.php.

References $c, ilTreeExplorerGUI\$childs, $DIC, $key, ilTreeExplorerGUI\getOrderField(), ilTreeExplorerGUI\getTypeBlackList(), and ilTreeExplorerGUI\getTypeWhiteList().

     {
         global $DIC;
         $ilAccess = $DIC->access();
 
         $wl = $this->getTypeWhiteList();
         if (is_array($wl) && count($wl) > 0) {
             $childs = $this->tree->getChildsByTypeFilter($a_parent_node_id, $wl, $this->getOrderField());
         } else {
             $childs = $this->tree->getChilds($a_parent_node_id, $this->getOrderField());
         }
 
         // apply black list filter
         $bl = $this->getTypeBlackList();
         if (is_array($bl) && count($bl) > 0) {
             $bl_childs = array();
             foreach ($childs as $k => $c) {
                 if (!in_array($c["type"], $bl)) {
                     $bl_childs[$k] = $c;
                 }
             }
 
             return $bl_childs;
         }
 
         //Check Access
         foreach ($childs as $key => $child) {
             if (!$ilAccess->checkAccess('visible', '', $child['ref_id'])) {
                 unset($childs[$key]);
             }
         }
 
         return $childs;
     }

Here is the call graph for this function:

◆ getLinkTarget()

ilOrgUnitExplorerGUI::getLinkTarget ( )

protected

Returns: string

Definition at line 122 of file class.ilOrgUnitExplorerGUI.php.

References $DIC, and $stay_with_command.

Referenced by getNodeHref().

     {
         global $DIC;
         if ($DIC->ctrl()->getCmdClass() == "ilobjorgunitgui" and in_array($DIC->ctrl()->getCmd(), $this->stay_with_command)) {
             return $DIC->ctrl()->getLinkTargetByClass(array( "ilAdministrationGUI", $DIC->ctrl()->getCmdClass() ), $DIC->ctrl()->getCmd());
         } else {
             return $DIC->ctrl()->getLinkTargetByClass(array( "ilAdministrationGUI", "ilobjorgunitgui" ), "view");
         }
     }

Here is the caller graph for this function:

◆ getNodeContent()

ilOrgUnitExplorerGUI::getNodeContent ( $node )

Parameters

mixed $node

Returns: string

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

References $_GET, and $DIC.

     {
         global $DIC;
         if ($node["title"] == "__OrgUnitAdministration") {
             $node["title"] = $DIC->language()->txt("objs_orgu");
         }
         if ($node["child"] == $_GET["ref_id"]) {
             return "<span class='ilExp2NodeContent ilHighlighted'>" . $node["title"] . "</span>";
         } else {
             return $node["title"];
         }
     }

◆ getNodeHref()

ilOrgUnitExplorerGUI::getNodeHref ( $node )

Parameters

mixed $node

Returns: string

Definition at line 96 of file class.ilOrgUnitExplorerGUI.php.

References $DIC, getLinkTarget(), and getPluginLinkTarget().

     {
         global $DIC;
 
         if ($this->select_postvar) {
             return "#";
         }
 
         if ($DIC->ctrl()->getCmd() == "performPaste") {
             $DIC->ctrl()->setParameterByClass("ilObjOrgUnitGUI", "target_node", $node["child"]);
         }
         $array = $DIC->ctrl()->getParameterArrayByClass("ilObjOrgUnitGUI");
         $temp = $array['ref_id'];
 
         $DIC->ctrl()->setParameterByClass("ilObjOrgUnitGUI", "ref_id", $node["child"]);
         $DIC->ctrl()->setParameterByClass("ilObjPluginDispatchGUI", "ref_id", $node["child"]);
 
         $link_target = ($node['type'] == "orgu") ? $this->getLinkTarget() : $this->getPluginLinkTarget();
         $DIC->ctrl()->setParameterByClass("ilObjOrgUnitGUI", 'ref_id', $temp);
         return $link_target;
     }

Here is the call graph for this function:

◆ getNodeIcon()

ilOrgUnitExplorerGUI::getNodeIcon ( $a_node )

Get node icon Return custom icon of OrgUnit type if existing.

Parameters

array $a_node

Returns: string

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

References $DIC, and ilObject\_lookupObjId().

     {
         global $DIC;
         $ilias = $DIC['ilias'];
         if ($ilias->getSetting('custom_icons')) {
             $icons_cache = ilObjOrgUnit::getIconsCache();
             $obj_id = ilObject::_lookupObjId($a_node["child"]);
             if (isset($icons_cache[$obj_id])) {
                 return $icons_cache[$obj_id];
             }
         }
 
         return ilObject::_getIcon($obj_id, "tiny", $a_node["type"]);
     }

Here is the call graph for this function:

◆ getPluginLinkTarget()

ilOrgUnitExplorerGUI::getPluginLinkTarget ( )

protected

Definition at line 133 of file class.ilOrgUnitExplorerGUI.php.

References $DIC.

Referenced by getNodeHref().

     {
         global $DIC;
         return $DIC->ctrl()->getLinkTargetByClass("ilObjPluginDispatchGUI", "forward");
     }

Here is the caller graph for this function:

◆ getRootNode()

ilOrgUnitExplorerGUI::getRootNode ( )

Returns: mixed

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

References ilObjOrgUnit\getRootOrgRefId(), and ilTreeExplorerGUI\getTree().

     {
         return $this->getTree()->getNodeData(ilObjOrgUnit::getRootOrgRefId());
     }

Here is the call graph for this function:

◆ isNodeClickable()

ilOrgUnitExplorerGUI::isNodeClickable ( $a_node )

Is node clickable?

Parameters

mixed $a_node node object/array

ilAccessHandler $ilAccess

Returns: boolean node clickable true/false

Definition at line 223 of file class.ilOrgUnitExplorerGUI.php.

References $DIC.

     {
         global $DIC;
         $ilAccess = $DIC->access();
 
         if ($ilAccess->checkAccess('read', '', $a_node['ref_id'])) {
             return true;
         }
 
         return false;
     }

◆ isNodeSelectable()

ilOrgUnitExplorerGUI::isNodeSelectable ( $a_node )

Definition at line 238 of file class.ilOrgUnitExplorerGUI.php.

     {
         $current_node = filter_input(INPUT_GET, 'item_ref_id');
         if ($a_node['child'] == $current_node || $this->tree->isGrandChild($current_node, $a_node['child'])) {
             return false;
         }
         return true;
     }

◆ sortbyTitle()

ilOrgUnitExplorerGUI::sortbyTitle	(	$a,
		$b
	)

Parameters

$a
$b

Returns: int

Definition at line 209 of file class.ilOrgUnitExplorerGUI.php.

     {
         return strcmp($a["title"], $b["title"]);
     }

◆ sortChilds()

ilOrgUnitExplorerGUI::sortChilds	(	$a_childs,
		$a_parent_node_id
	)

Sort childs.

Parameters

array	$a_childs	array of child nodes
	$a_parent_node_id

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

     {
         usort($a_childs, array( __CLASS__, "sortbyTitle" ));
 
         return $a_childs;
     }

Field Documentation

◆ $stay_with_command

ilOrgUnitExplorerGUI::$stay_with_command = array( "", "render", "view", "infoScreen", "showStaff", "performPaste", "cut" )

protected

Definition at line 17 of file class.ilOrgUnitExplorerGUI.php.

Referenced by getLinkTarget().

◆ $tree

ilOrgUnitExplorerGUI::$tree = null

protected

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

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

Modules/OrgUnit/classes/class.ilOrgUnitExplorerGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getChildsOfNode()

◆ getLinkTarget()

◆ getNodeContent()

◆ getNodeHref()

◆ getNodeIcon()

◆ getPluginLinkTarget()

◆ getRootNode()

◆ isNodeClickable()

◆ isNodeSelectable()

◆ sortbyTitle()

◆ sortChilds()

Field Documentation

◆ $stay_with_command

◆ $tree