Administration explorer GUI class. More...

Inheritance diagram for ilAdministrationExplorerGUI:

Collaboration diagram for ilAdministrationExplorerGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd)
	Constructor. More...

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

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

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

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

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

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

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

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

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

	setRootId ($a_root)

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

	getHTML ($new=false)
	Get HTML. More...

	getChildren ($node, $environment=null)
	Get a list of records (that list can also be empty).Each record will be relayed to $this->build to retrieve a Node. Also, each record will be asked for Sub-Nodes using this function. Returns array More...

	build (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record, $environment=null)

	getTreeLabel ()

	getTreeComponent ()
	Get Tree UI. More...

	toggleExplorerNodeState ()
	Should be called by an ilCtrl-enabled command class if a tree node toggle action should be processed. 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 ($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...

Public Member Functions inherited from ILIAS\UI\Component\Tree\TreeRecursion
	getChildren ( $record, $environment=null)
	Get a list of records (that list can also be empty). More...

	build (Node\Factory $factory, $record, $environment=null)
	Build and return a Node. More...

Protected Attributes
	$settings

	$obj_definition

	$lng

	$ctrl

	$rbacsystem

	$db

	$user

	$access

	$type_grps = array()

	$session_materials = array()

Protected Attributes inherited from ilTreeExplorerGUI
	$lng

	$httpRequest

	$tree = null

	$tree_label = ""

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

	$ui

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 = ""

	$open_nodes = []

	$store

	$parent_obj

	$child_limit = 0

	$parent_cmd = ''

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

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

	createNode (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record)
	Creates at tree node, can be overwritten in derivatives if another node type should be used. More...

	getNodeStateToggleCmdClasses ($record)
	Should return an array of ilCtrl-enabled command classes which should be used to build the URL for the expand/collapse actions applied on a tree node. More...

	render ()
	Render tree. 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...

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

	getJSTreePlugins ()

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

Administration explorer GUI class.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Todo:: : isClickable, top node id

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

Constructor & Destructor Documentation

◆ __construct()

ilAdministrationExplorerGUI::__construct	(	$a_parent_obj,
		$a_parent_cmd
	)

Constructor.

Definition at line 64 of file class.ilAdministrationExplorerGUI.php.

    {
        global $DIC;
 
        $this->tree = $DIC->repositoryTree();
        $this->settings = $DIC->settings();
        $this->obj_definition = $DIC["objDefinition"];
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->db = $DIC->database();
        $this->user = $DIC->user();
        $this->access = $DIC->access();
        $tree = $DIC->repositoryTree();
        $ilSetting = $DIC->settings();
        $objDefinition = $DIC["objDefinition"];
 
        $this->cur_ref_id = (int) $_GET["ref_id"];
        
        $this->top_node_id = 0;
        parent::__construct("adm_exp", $a_parent_obj, $a_parent_cmd, $tree);
 
        $this->setSkipRootNode(false);
        $this->setAjax(true);
        $this->setOrderField("title");
 
        $white = array();
        foreach ($objDefinition->getSubObjectsRecursively("root") as $rtype) {
            if ($rtype["name"] != "itgr" && !$objDefinition->isSideBlock($rtype["name"])) {
                $white[] = $rtype["name"];
            }
        }
        $this->setTypeWhiteList($white);
 
        if ((int) $_GET["ref_id"] > 0) {
            $this->setPathOpen((int) $_GET["ref_id"]);
        }
    }

References $_GET, $DIC, $ilSetting, ilTreeExplorerGUI\$tree, ILIAS\GlobalScreen\Provider\__construct(), ilExplorerBaseGUI\setAjax(), ilTreeExplorerGUI\setOrderField(), ilTreeExplorerGUI\setPathOpen(), ilExplorerBaseGUI\setSkipRootNode(), settings(), ilTreeExplorerGUI\setTypeWhiteList(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ getChildsOfNode()

ilAdministrationExplorerGUI::getChildsOfNode ( $a_parent_node_id )

Get childs of node.

Parameters

return

Reimplemented from ilTreeExplorerGUI.

Definition at line 272 of file class.ilAdministrationExplorerGUI.php.

    {
        $rbacsystem = $this->rbacsystem;
        
        if (!$rbacsystem->checkAccess("read", $a_parent_node_id)) {
            return array();
        }
 
        return parent::getChildsOfNode($a_parent_node_id);
    }

References $rbacsystem.

◆ getNodeContent()

ilAdministrationExplorerGUI::getNodeContent ( $a_node )

Get node content.

Parameters

array

Returns

Reimplemented from ilExplorerBaseGUI.

Definition at line 109 of file class.ilAdministrationExplorerGUI.php.

    {
        $lng = $this->lng;
        
        $title = $a_node["title"];
        if ($a_node["child"] == $this->getNodeId($this->getRootNode())) {
            if ($title == "ILIAS") {
                $title = $lng->txt("repository");
            }
        }
 
        return $title;
    }

References $lng, ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

Here is the call graph for this function:

◆ getNodeHref()

ilAdministrationExplorerGUI::getNodeHref ( $a_node )

Get href for node.

Parameters

mixed $a_node node object/array

Returns: string href attribute

Reimplemented from ilExplorerBaseGUI.

Definition at line 178 of file class.ilAdministrationExplorerGUI.php.

    {
        $ilCtrl = $this->ctrl;
        $objDefinition = $this->obj_definition;
        
        $class_name = $objDefinition->getClassName($a_node["type"]);
        $class = strtolower("ilObj" . $class_name . "GUI");
        $ilCtrl->setParameterByClass($class, "ref_id", $a_node["child"]);
        $link = $ilCtrl->getLinkTargetByClass($class, "view");
        $ilCtrl->setParameterByClass($class, "ref_id", $_GET["ref_id"]);
        
        return $link;
    }

References $_GET, $ctrl, $ilCtrl, and $obj_definition.

◆ getNodeIcon()

ilAdministrationExplorerGUI::getNodeIcon ( $a_node )

Get node icon.

Parameters

array

Returns

Reimplemented from ilExplorerBaseGUI.

Definition at line 129 of file class.ilAdministrationExplorerGUI.php.

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

References ilObject\_lookupObjId().

Here is the call graph for this function:

◆ getNodeIconAlt()

ilAdministrationExplorerGUI::getNodeIconAlt ( $a_node )

Get node icon alt text.

Parameters

array node array

Returns: string alt text

Reimplemented from ilTreeExplorerGUI.

Definition at line 141 of file class.ilAdministrationExplorerGUI.php.

    {
        $lng = $this->lng;
 
        if ($a_node["child"] == $this->getNodeId($this->getRootNode())) {
            $title = $a_node["title"];
            if ($title == "ILIAS") {
                $title = $lng->txt("repository");
            }
            return $lng->txt("icon") . " " . $title;
        }
 
        
        return parent::getNodeIconAlt($a_node);
    }

References $lng, ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

Here is the call graph for this function:

◆ isNodeClickable()

ilAdministrationExplorerGUI::isNodeClickable ( $a_node )

Is node clickable?

Parameters

mixed $a_node node object/array

Returns: boolean node clickable true/false

Reimplemented from ilExplorerBaseGUI.

Definition at line 289 of file class.ilAdministrationExplorerGUI.php.

    {
        $rbacsystem = $this->rbacsystem;
        $tree = $this->tree;
        $ilDB = $this->db;
        $ilUser = $this->user;
        $ilAccess = $this->access;
        
        return $rbacsystem->checkAccess('read', $a_node["child"]);
    }

References $access, $db, $ilDB, $ilUser, $rbacsystem, ilTreeExplorerGUI\$tree, and $user.

◆ isNodeHighlighted()

ilAdministrationExplorerGUI::isNodeHighlighted ( $a_node )

Is node highlighted?

Parameters

mixed $a_node node object/array

Returns: boolean node visible true/false

Reimplemented from ilExplorerBaseGUI.

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

    {
        if ($a_node["child"] == $_GET["ref_id"] ||
            ($_GET["ref_id"] == "" && $a_node["child"] == $this->getNodeId($this->getRootNode()))) {
            return true;
        }
        return false;
    }

References $_GET, ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

Here is the call graph for this function:

◆ isNodeVisible()

ilAdministrationExplorerGUI::isNodeVisible ( $a_node )

Is node visible.

Parameters

return

Reimplemented from ilExplorerBaseGUI.

Definition at line 198 of file class.ilAdministrationExplorerGUI.php.

    {
        $rbacsystem = $this->rbacsystem;
 
        $visible = $rbacsystem->checkAccess('visible', $a_node["child"]);
        if ($a_node["type"] == "rolf" && $a_node["child"] != ROLE_FOLDER_ID) {
            return false;
        }
        return $visible;
    }

References $rbacsystem.

◆ sortChilds()

ilAdministrationExplorerGUI::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

Reimplemented from ilExplorerBaseGUI.

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

    {
        $objDefinition = $this->obj_definition;
 
        $parent_obj_id = ilObject::_lookupObjId($a_parent_node_id);
        
        if ($parent_obj_id > 0) {
            $parent_type = ilObject::_lookupType($parent_obj_id);
        } else {
            $parent_type = "dummy";
            $this->type_grps["dummy"] = array("root" => "dummy");
        }
 
        if (empty($this->type_grps[$parent_type])) {
            $this->type_grps[$parent_type] =
                $objDefinition->getGroupedRepositoryObjectTypes($parent_type);
        }
        $group = array();
        
        foreach ($a_childs as $child) {
            $g = $objDefinition->getGroupOfObj($child["type"]);
            if ($g == "") {
                $g = $child["type"];
            }
            $group[$g][] = $child;
        }
 
        $childs = array();
        foreach ($this->type_grps[$parent_type] as $t => $g) {
            if (is_array($group[$t])) {
                // do we have to sort this group??
                include_once("./Services/Container/classes/class.ilContainer.php");
                include_once("./Services/Container/classes/class.ilContainerSorting.php");
                $sort = ilContainerSorting::_getInstance($parent_obj_id);
                $group = $sort->sortItems($group);
                
                // need extra session sorting here
                if ($t == "sess") {
                }
                
                foreach ($group[$t] as $k => $item) {
                    $childs[] = $item;
                }
            }
        }
        
        return $childs;
    }