Administration explorer GUI class. More...

Inheritance diagram for ilAdministrationExplorerGUI:

Collaboration diagram for ilAdministrationExplorerGUI:

Public Member Functions
	__construct (string $a_parent_obj, string $a_parent_cmd)

	getNodeContent ($a_node)

	getNodeIcon ($a_node)

	getNodeIconAlt ($a_node)

	isNodeHighlighted ($a_node)

	getNodeHref ($a_node)

	isNodeVisible ($a_node)

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

	getChildsOfNode ($a_parent_node_id)

	isNodeClickable ($a_node)

Public Member Functions inherited from ilTreeExplorerGUI
	__construct (string $a_expl_id, $a_parent_obj, string $a_parent_cmd, ilTree $a_tree, string $a_node_parameter_name="node_id")

	getTree ()

	setOrderField (string $a_val, bool $a_numeric=false)

	getOrderField ()

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

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

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

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

	setPreloadChilds (bool $a_val)

	getPreloadChilds ()

	getSuccessorNode ( $a_node_id, string $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 ($record, $environment=null)
	Get a list of records (that list can also be empty). More...

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

	getTreeLabel ()

	getTreeComponent ()

	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
	setChildLimit (int $a_val)

	getChildLimit ()

	setSearchTerm (string $a_val)

	getSearchTerm ()

	setMainTemplate (?ilGlobalTemplateInterface $a_main_tpl=null)

	getRootNode ()
	Get root node. More...

	getChildsOfNode ($a_parent_node_id)
	Get children 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 children Please note that this standard method may not be optimal depending on what a derived class does in isNodeVisible. More...

	sortChilds (array $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 (bool $a_val)

	getSkipRootNode ()

	setAjax (bool $a_val)

	getAjax ()

	setSecondaryHighlightedNodes (array $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 (string $a_postvar, bool $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 (bool $a_val)

	getOfflineMode ()

	handleCommand ()
	Handle explorer internal command. More...

	getContainerId ()

	openNode ()
	Open node. More...

	closeNode ()
	Close node. More...

	getNodeAsync ()
	Get node asynchronously. More...

	beforeRendering ()
	Before rendering. More...

	getOnLoadCode ()
	Get on load code. More...

	getHTML ()

	renderNode ($a_node, ilTemplate $tpl)
	Render node. More...

	renderChilds ($a_node_id, ilTemplate $tpl)
	Render childs. More...

	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id. More...

	getNodeIdForDomNodeId (string $a_dom_node_id)
	Get node id for dom node id. More...

	listItemStart (ilTemplate $tpl, $a_node)
	List item start. More...

	listItemEnd (ilTemplate $tpl)

	listStart (ilTemplate $tpl)

	listEnd (ilTemplate $tpl)

	isNodeOnclickEnabled ()

	setNodeOnclickEnabled (bool $nodeOnclickEnabled)

	isEnableDnd ()

	setEnableDnd (bool $enable_dnd)

Public Member Functions inherited from ILIAS\UI\Component\Tree\TreeRecursion
	build (Node\Factory $factory, $record, $environment=null)
	Build and return a Node. More...

Protected Attributes
ilSetting	$settings

ilObjectDefinition	$obj_definition

ilRbacSystem	$rbacsystem

ilDBInterface	$db

ilObjUser	$user

ilAccessHandler	$access

array	$type_grps = array()

array	$session_materials = array()

AdminGUIRequest	$request

int	$cur_ref_id

int	$top_node_id

Protected Attributes inherited from ilTreeExplorerGUI
ilLanguage	$lng

Psr Http Message ServerRequestInterface	$httpRequest

ilTree	$tree = null

string	$tree_label = ""

string	$order_field = ""

bool	$order_field_numeric = false

array	$type_white_list = array()

array	$type_black_list = array()

array	$childs = array()

bool	$preloaded = false

bool	$preload_childs = false

array	$root_node_data = null

array	$all_childs = array()

	$root_id = 0

ILIAS DI UIServices	$ui

Protected Attributes inherited from ilExplorerBaseGUI
string	$node_parameter_name

ilLogger	$log

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

bool	$skip_root_node = false

bool	$ajax = false

array	$custom_open_nodes = array()

array	$selected_nodes = array()

string	$select_postvar = ""

bool	$offline_mode = false

array	$sec_highl_nodes = array()

bool	$enable_dnd = false

string	$search_term = ""

array	$open_nodes = []

ilSessionIStorage	$store

bool	$select_multi = false

	$parent_obj

int	$child_limit = 0

string	$parent_cmd = ''

string	$requested_exp_cmd = ""

string	$requested_exp_cont = ""

string	$requested_searchterm = ""

string	$requested_node_id = ""

string	$id

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()

static	getLocalJsTreeJsPath ()

static	getLocalJsTreeCssPath ()

static	createHTMLExportDirs (string $a_target_dir)

static	init (?ilGlobalTemplateInterface $a_main_tpl=null)

Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()

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

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

	isNodeRequested (string $a_node_id)

Static Protected Attributes inherited from ilExplorerBaseGUI
static string	$js_tree_path = "./node_modules/jstree/dist/jstree.js"

static string	$js_tree_path_css = "./node_modules/jstree/dist/themes/default/style.min.css"

static string	$js_expl_path = "assets/js/Explorer2.js"

Detailed Description

Administration explorer GUI class.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilAdministrationExplorerGUI::__construct	(	string	$a_parent_obj,
		string	$a_parent_cmd
	)

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

References $DIC, ilTreeExplorerGUI\$tree, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Administration\AdminGUIRequest\getRefId(), ILIAS\Repository\lng(), ilExplorerBaseGUI\setAjax(), ilTreeExplorerGUI\setOrderField(), ilTreeExplorerGUI\setPathOpen(), ilExplorerBaseGUI\setSkipRootNode(), ILIAS\Repository\settings(), ilTreeExplorerGUI\setTypeWhiteList(), and ILIAS\Repository\user().

       {
         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();
         $objDefinition = $DIC["objDefinition"];
         $this->request = new AdminGUIRequest(
             $DIC->http(),
             $DIC->refinery()
         );
 
         $this->cur_ref_id = $this->request->getRefId();
 
         $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 ($this->cur_ref_id > 0) {
             $this->setPathOpen($this->cur_ref_id);
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ getChildsOfNode()

ilAdministrationExplorerGUI::getChildsOfNode ( $a_parent_node_id )

Parameters

int | string $a_parent_node_id parent id

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

References $rbacsystem, and ilRbacSystem\checkAccess().

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

Here is the call graph for this function:

◆ getNodeContent()

ilAdministrationExplorerGUI::getNodeContent ( $a_node )

Parameters

object | array $a_node node array or object

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

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

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

Here is the call graph for this function:

◆ getNodeHref()

ilAdministrationExplorerGUI::getNodeHref ( $a_node )

Parameters

object | array $a_node node array or object

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

References ilExplorerBaseGUI\$ctrl, $obj_definition, and ilObjectDefinition\getClassName().

                                         : string
     {
         $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", $this->cur_ref_id);
 
         return $link;
     }

Here is the call graph for this function:

◆ getNodeIcon()

ilAdministrationExplorerGUI::getNodeIcon ( $a_node )

Parameters

object | array $a_node node array or object

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

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

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

Here is the call graph for this function:

◆ getNodeIconAlt()

ilAdministrationExplorerGUI::getNodeIconAlt ( $a_node )

Parameters

object | array $a_node node array or object

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

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

                                            : string
     {
         $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);
     }

Here is the call graph for this function:

◆ isNodeClickable()

ilAdministrationExplorerGUI::isNodeClickable ( $a_node )

Parameters

object | array $a_node node array or object

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

                                             : bool
     {
         return $this->rbacsystem->checkAccess('read', (int) $a_node["child"]);
     }

◆ isNodeHighlighted()

ilAdministrationExplorerGUI::isNodeHighlighted ( $a_node )

Parameters

object | array $a_node node array or object

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

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

                                               : bool
     {
         return $a_node["child"] == $this->cur_ref_id ||
             ($this->cur_ref_id === 0 && $a_node["child"] == $this->getNodeId($this->getRootNode()));
     }

Here is the call graph for this function:

◆ isNodeVisible()

ilAdministrationExplorerGUI::isNodeVisible ( $a_node )

Parameters

object | array $a_node node array or object

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

References $rbacsystem, ilRbacSystem\checkAccess(), and ROLE_FOLDER_ID.

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

Here is the call graph for this function:

◆ sortChilds()

ilAdministrationExplorerGUI::sortChilds	(	array	$a_childs,
			$a_parent_node_id
	)

Sort childs.

Parameters

int | string $a_parent_node_id parent id

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

References ilTreeExplorerGUI\$childs, $obj_definition, ilContainerSorting\_getInstance(), ilObject\_lookupObjId(), ilObject\_lookupType(), and null.

                                                                   : array
     {
         $objDefinition = $this->obj_definition;
 
         $parent_obj_id = ilObject::_lookupObjId((int) $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 === null || $g === "") {
                 $g = $child["type"];
             }
             $group[$g][] = $child;
         }
 
         $childs = array();
         foreach ($this->type_grps[$parent_type] as $t => $g) {
             if (isset($group[$t])) {
                 // do we have to sort this group??
                 $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;
     }