ILIAS  Release_4_4_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
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)
 Constructor.
 getNodeContent ($node)
 Get content of a node.
 getRootNode ()
 Get root node.
 getNodeIcon ($a_node)
 Get node icon.
 getNodeHref ($node)
 Get href for node.
 getChildsOfNode ($a_parent_node_id)
 Get childs of node.
 sortChilds ($a_childs, $a_parent_node_id)
 Sort childs.
 sortbyTitle ($a, $b)
 isNodeClickable ($a_node)
 Is node clickable?
- Public Member Functions inherited from ilTreeExplorerGUI
 getTree ()
 Get tree.
 setOrderField ($a_val, $a_numeric=false)
 Set order field.
 getOrderField ()
 Get order field.
 setTypeWhiteList ($a_val)
 Set type white list.
 getTypeWhiteList ()
 Get type white list.
 setTypeBlackList ($a_val)
 Set type black list.
 getTypeBlackList ()
 Get type black list.
 setPreloadChilds ($a_val)
 Set preload childs.
 getPreloadChilds ()
 Get preload childs.
 getSuccessorNode ($a_node_id, $a_type="")
 Get successor node (currently only(!) based on lft/rgt tree values)
 getNodeId ($a_node)
 Get id for node.
 getNodeIconAlt ($a_node)
 Get node icon alt attribute.
 setPathOpen ($a_id)
 Set node path to be opened.
 getHTML ()
 Get HTML.
- Public Member Functions inherited from ilExplorerBaseGUI
 __construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
 Constructor.
 nodeHasVisibleChilds ($a_node)
 Node has childs?
 getNodeTarget ($a_node)
 Get node target (frame) attribute.
 getNodeOnClick ($a_node)
 Get node onclick attribute.
 isNodeVisible ($a_node)
 Is node visible?
 isNodeHighlighted ($a_node)
 Is node highlighted?
 getId ()
 Get id of explorer element.
 setSkipRootNode ($a_val)
 Set skip root node.
 getSkipRootNode ()
 Get skip root node.
 setAjax ($a_val)
 Set ajax.
 getAjax ()
 Get ajax.
 setNodeOpen ($a_id)
 Set node to be opened (additional custom opened node, not standard expand behaviour)
 setSelectMode ($a_postvar, $a_multi=false)
 Set select mode (to deactivate, pass an empty string as postvar)
 setNodeSelected ($a_id)
 Set node to be opened (additional custom opened node, not standard expand behaviour)
 setOfflineMode ($a_val)
 Set offline mode.
 getOfflineMode ()
 Get offline mode.
 handleCommand ()
 Handle explorer internal command.
 getContainerId ()
 Get container id.
 openNode ()
 Open node.
 closeNode ()
 Close node.
 getNodeAsync ()
 Get node asynchronously.
 beforeRendering ()
 Before rendering.
 renderNode ($a_node, $tpl)
 Render node.
 renderChilds ($a_node_id, $tpl)
 Render childs.
 getDomNodeIdForNodeId ($a_node_id)
 Get DOM node id for node id.
 getNodeIdForDomNodeId ($a_dom_node_id)
 Get node id for dom node id.
 listItemStart ($tpl, $a_node)
 List item start.
 listItemEnd ($tpl)
 List item end.
 listStart ($tpl)
 List start.
 listEnd ($tpl)
 List end.

Protected Member Functions

 getLinkTarget ()
- Protected Member Functions inherited from ilTreeExplorerGUI
 preloadChilds ()
 Preload childs.
- Protected Member Functions inherited from ilExplorerBaseGUI
 getNodeToggleOnClick ($a_node)
 Get onclick attribute for node toggling.
 getSelectOnClick ($a_node)
 Get onclick attribute for selecting radio/checkbox.

Protected Attributes

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

Additional Inherited Members

- Static Public Member Functions inherited from ilExplorerBaseGUI
static getLocalExplorerJsPath ()
 Get local path of explorer js.
static getLocalJsTreeJsPath ()
 Get local path of jsTree js.
static createHTMLExportDirs ($a_target_dir)
 Create html export directories.
- 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

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

Constructor.

Reimplemented from ilTreeExplorerGUI.

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

References ilExplorerBaseGUI\setAjax().

{
parent::__construct($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree);
$this->setAjax(true);
}

+ Here is the call graph for this function:

Member Function Documentation

ilOrgUnitExplorerGUI::getChildsOfNode (   $a_parent_node_id)

Get childs of node.

Parameters
$a_parent_node_idilAccessHandler $ilAccess

Reimplemented from ilTreeExplorerGUI.

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

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

{
global $ilAccess;
$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:

ilOrgUnitExplorerGUI::getLinkTarget ( )
protected

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

References $ilCtrl, and $stay_with_command.

Referenced by getNodeHref().

{
global $ilCtrl;
if($ilCtrl->getCmdClass() == "ilobjorgunitgui" && in_array($ilCtrl->getCmd(), $this->stay_with_command))
{
return $ilCtrl->getLinkTargetByClass($ilCtrl->getCmdClass(), $ilCtrl->getCmd());
}
else
{
return $ilCtrl->getLinkTargetByClass("ilobjorgunitgui", "view");
}
}

+ Here is the caller graph for this function:

ilOrgUnitExplorerGUI::getNodeContent (   $a_node)

Get content of a node.

Parameters
mixed$a_nodenode array or object
Returns
string content of the node

Reimplemented from ilExplorerBaseGUI.

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

References $_GET, and $lng.

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

Get href for node.

Parameters
mixed$a_nodenode object/array
Returns
string href attribute

Reimplemented from ilExplorerBaseGUI.

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

References $ilCtrl, and getLinkTarget().

{
global $ilCtrl;
if($ilCtrl->getCmd() == "performPaste")
{
$ilCtrl->setParameterByClass("ilObjOrgUnitGUI","target_node",$node["child"]);
}
$ilCtrl->setParameterByClass("ilObjOrgUnitGUI", "ref_id", $node["child"]);
return $this->getLinkTarget();
}

+ Here is the call graph for this function:

ilOrgUnitExplorerGUI::getNodeIcon (   $a_node)

Get node icon.

Parameters
array
Returns

Reimplemented from ilExplorerBaseGUI.

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

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

{
$obj_id = ilObject::_lookupObjId($a_node["child"]);
return ilObject::_getIcon($obj_id, "tiny", $a_node["type"]);
}

+ Here is the call graph for this function:

ilOrgUnitExplorerGUI::getRootNode ( )

Get root node.

Returns
mixed node object/array

Reimplemented from ilTreeExplorerGUI.

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

ilOrgUnitExplorerGUI::isNodeClickable (   $a_node)

Is node clickable?

Parameters
mixed$a_nodenode object/array ilAccessHandler $ilAccess
Returns
boolean node clickable true/false

Reimplemented from ilExplorerBaseGUI.

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

{
global $ilAccess;
if($ilAccess->checkAccess('read', '', $a_node['ref_id']))
{
return true;
}
return false;
}
ilOrgUnitExplorerGUI::sortbyTitle (   $a,
  $b 
)

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

{
return strcmp($a["title"], $b["title"]);
}
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 133 of file class.ilOrgUnitExplorerGUI.php.

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

Field Documentation

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

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

Referenced by getLinkTarget().


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