ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilOrgUnitExplorerGUI Class Reference

Class ilOrgUnitExplorerGUI. More...

+ 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...
 
- 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...
 
 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...
 
 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 ()
 
- Protected Member Functions inherited from ilTreeExplorerGUI
 preloadChilds ()
 Preload childs. More...
 
- 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...
 
 getJSTreePlugins ()
 

Protected Attributes

 $stay_with_command = array( "", "render", "view", "infoScreen", "showStaff", "performPaste", "cut" )
 
 $tree = null
 
- Protected Attributes inherited from ilTreeExplorerGUI
 $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
 $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
 

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 createHTMLExportDirs ($a_target_dir)
 Create html export directories. More...
 
static init ()
 Init JS. More...
 
- Static Protected Attributes inherited from ilExplorerBaseGUI
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"
 

Detailed Description

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

Reimplemented from ilTreeExplorerGUI.

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

30 {
31 parent::__construct($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree);
32 $this->setAjax(true);
33 $this->setTypeWhiteList(array( "orgu" ));
34 $this->tree->initLangCode();
35 }
setTypeWhiteList($a_val)
Set type white list.

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

+ 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

@global ilAccessHandler $ilAccess

Reimplemented from ilTreeExplorerGUI.

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

124 {
125 global $ilAccess;
126
127 $wl = $this->getTypeWhiteList();
128 if (is_array($wl) && count($wl) > 0) {
129 $childs = $this->tree->getChildsByTypeFilter($a_parent_node_id, $wl, $this->getOrderField());
130 } else {
131 $childs = $this->tree->getChilds($a_parent_node_id, $this->getOrderField());
132 }
133
134 // apply black list filter
135 $bl = $this->getTypeBlackList();
136 if (is_array($bl) && count($bl) > 0) {
137 $bl_childs = array();
138 foreach ($childs as $k => $c) {
139 if (!in_array($c["type"], $bl)) {
140 $bl_childs[$k] = $c;
141 }
142 }
143
144 return $bl_childs;
145 }
146
147 //Check Access
148 foreach ($childs as $key => $child) {
149 if (!$ilAccess->checkAccess('visible', '', $child['ref_id'])) {
150 unset($childs[$key]);
151 }
152 }
153
154 return $childs;
155 }
getTypeWhiteList()
Get type white list.
getTypeBlackList()
Get type black list.
getOrderField()
Get order field.

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

+ Here is the call graph for this function:

◆ getLinkTarget()

ilOrgUnitExplorerGUI::getLinkTarget ( )
protected
Returns
string

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

105 {
106 global $ilCtrl;
107
108 if ($ilCtrl->getCmdClass() == "ilobjorgunitgui" AND in_array($ilCtrl->getCmd(), $this->stay_with_command)) {
109 return $ilCtrl->getLinkTargetByClass($ilCtrl->getCmdClass(), $ilCtrl->getCmd());
110 } else {
111 return $ilCtrl->getLinkTargetByClass("ilobjorgunitgui", "view");
112 }
113 }
global $ilCtrl
Definition: ilias.php:18

References $ilCtrl.

Referenced by getNodeHref().

+ Here is the caller graph for this function:

◆ getNodeContent()

ilOrgUnitExplorerGUI::getNodeContent (   $node)
Parameters
mixed$node
Returns
string

Reimplemented from ilExplorerBaseGUI.

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

43 {
44 global $lng;
45 if ($node["title"] == "__OrgUnitAdministration") {
46 $node["title"] = $lng->txt("objs_orgu");
47 }
48 if ($node["child"] == $_GET["ref_id"]) {
49 return "<span class='ilExp2NodeContent ilHighlighted'>" . $node["title"] . "</span>";
50 } else {
51 return $node["title"];
52 }
53 }
$_GET["client_id"]
global $lng
Definition: privfeed.php:40

References $_GET, and $lng.

◆ getNodeHref()

ilOrgUnitExplorerGUI::getNodeHref (   $node)
Parameters
mixed$node
Returns
string

Reimplemented from ilExplorerBaseGUI.

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

91 {
92 global $ilCtrl;
93 if ($ilCtrl->getCmd() == "performPaste") {
94 $ilCtrl->setParameterByClass("ilObjOrgUnitGUI", "target_node", $node["child"]);
95 }
96 $ilCtrl->setParameterByClass("ilObjOrgUnitGUI", "ref_id", $node["child"]);
97
98 return $this->getLinkTarget();
99 }

References $ilCtrl, and getLinkTarget().

+ 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

Reimplemented from ilExplorerBaseGUI.

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

72 {
73 global $ilias;
74 if ($ilias->getSetting('custom_icons')) {
75 $icons_cache = ilObjOrgUnit::getIconsCache();
76 $obj_id = ilObject::_lookupObjId($a_node["child"]);
77 if (isset($icons_cache[$obj_id])) {
78 return $icons_cache[$obj_id];
79 }
80 }
81
82 return ilObject::_getIcon($obj_id, "tiny", $a_node["type"]);
83 }
static _lookupObjId($a_id)
static _getIcon($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
Get icon for repository item.

References ilObject\_getIcon(), and ilObject\_lookupObjId().

+ Here is the call graph for this function:

◆ getRootNode()

ilOrgUnitExplorerGUI::getRootNode ( )
Returns
mixed

Reimplemented from ilTreeExplorerGUI.

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

59 {
60 return $this->getTree()->getNodeData(ilObjOrgUnit::getRootOrgRefId());
61 }
static getRootOrgRefId()

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

+ Here is the call graph for this function:

◆ isNodeClickable()

ilOrgUnitExplorerGUI::isNodeClickable (   $a_node)

Is node clickable?

Parameters
mixed$a_nodenode object/array

@global ilAccessHandler $ilAccess

Returns
boolean node clickable true/false

Reimplemented from ilExplorerBaseGUI.

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

194 {
195 global $ilAccess;
196
197 if ($ilAccess->checkAccess('read', '', $a_node['ref_id'])) {
198 return true;
199 }
200
201 return false;
202 }

◆ sortbyTitle()

ilOrgUnitExplorerGUI::sortbyTitle (   $a,
  $b 
)
Parameters
$a
$b
Returns
int

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

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

◆ sortChilds()

ilOrgUnitExplorerGUI::sortChilds (   $a_childs,
  $a_parent_node_id 
)

Sort childs.

Parameters
array$a_childsarray of child nodes
$a_parent_node_id

Reimplemented from ilExplorerBaseGUI.

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

168 {
169 usort($a_childs, array( __CLASS__, "sortbyTitle" ));
170
171 return $a_childs;
172 }

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.

◆ $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: