Explorer for selecting repository items. More...

Inheritance diagram for ilRepositorySelectorExplorerGUI:

Collaboration diagram for ilRepositorySelectorExplorerGUI:

Public Member Functions
	setNodeContentModifier (Closure $a_val)

	getNodeContentModifier ()

	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)

	getChildsOfNode ($a_parent_node_id)

	setClickablePermission (string $rbac_perm)

	isNodeClickable ($a_node)

	setHighlightedNode (string $a_value)

	getHighlightedNode ()

	setClickableTypes (array $a_types)

	getClickableTypes ()

	setSelectableTypes (array $a_types)

	getSelectableTypes ()

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 Member Functions
	isNodeSelectable ($a_node)

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)

Protected Attributes
ilObjectDefinition	$obj_definition

array	$type_grps = []

array	$session_materials = []

string	$highlighted_node = ""

array	$clickable_types = []

array	$selectable_types = []

ilAccessHandler	$access

Closure	$nc_modifier = null

string	$selection_gui = null

string	$selection_par

string	$selection_cmd

StandardGUIRequest	$request

int	$cur_ref_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

Private Attributes
string	$clickable_permission = 'read'

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)

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 = "./Services/UIComponent/Explorer2/js/Explorer2.js"

Detailed Description

Explorer for selecting repository items.

The implementation starts as a replacement for the often (ab)used ilSearchRootSelector class. Clicking items triggers a "selection" command. However ajax/checkbox/radio and use in an inputgui class should be implemented in the future, too.

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

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

Member Function Documentation

◆ getChildsOfNode()

ilRepositorySelectorExplorerGUI::getChildsOfNode ( $a_parent_node_id )

Definition at line 245 of file class.ilRepositorySelectorExplorerGUI.php.

References $access.

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

◆ getClickableTypes()

ilRepositorySelectorExplorerGUI::getClickableTypes ( )

Definition at line 290 of file class.ilRepositorySelectorExplorerGUI.php.

References $clickable_types.

Referenced by isNodeClickable().

                                        : array
     {
         return $this->clickable_types;
     }

Here is the caller graph for this function:

◆ getHighlightedNode()

ilRepositorySelectorExplorerGUI::getHighlightedNode ( )

Definition at line 280 of file class.ilRepositorySelectorExplorerGUI.php.

References $highlighted_node.

Referenced by isNodeHighlighted().

                                         : string
     {
         return $this->highlighted_node;
     }

Here is the caller graph for this function:

◆ getNodeContent()

ilRepositorySelectorExplorerGUI::getNodeContent ( $a_node )

Definition at line 116 of file class.ilRepositorySelectorExplorerGUI.php.

References Vendor\Package\$c, ilTreeExplorerGUI\$lng, getNodeContentModifier(), ilTreeExplorerGUI\getNodeId(), ilTreeExplorerGUI\getRootNode(), and ilLanguage\txt().

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

Here is the call graph for this function:

◆ getNodeContentModifier()

ilRepositorySelectorExplorerGUI::getNodeContentModifier ( )

Definition at line 111 of file class.ilRepositorySelectorExplorerGUI.php.

References $nc_modifier.

Referenced by getNodeContent().

                                             : ?Closure
     {
         return $this->nc_modifier;
     }

Here is the caller graph for this function:

◆ getNodeHref()

ilRepositorySelectorExplorerGUI::getNodeHref ( $a_node )

Definition at line 170 of file class.ilRepositorySelectorExplorerGUI.php.

References ilExplorerBaseGUI\$ctrl, and ilCtrl\setParameterByClass().

                                         : string
     {
         $ilCtrl = $this->ctrl;
 
         if ($this->select_postvar === "") {
             $ilCtrl->setParameterByClass($this->selection_gui, $this->selection_par, $a_node["child"]);
             $link = $ilCtrl->getLinkTargetByClass($this->selection_gui, $this->selection_cmd);
             $ilCtrl->setParameterByClass($this->selection_gui, $this->selection_par, "");
         } else {
             return "#";
         }
 
         return $link;
     }

Here is the call graph for this function:

◆ getNodeIcon()

ilRepositorySelectorExplorerGUI::getNodeIcon ( $a_node )

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

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

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

Here is the call graph for this function:

◆ getNodeIconAlt()

ilRepositorySelectorExplorerGUI::getNodeIconAlt ( $a_node )

Definition at line 139 of file class.ilRepositorySelectorExplorerGUI.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:

◆ getSelectableTypes()

ilRepositorySelectorExplorerGUI::getSelectableTypes ( )

Definition at line 300 of file class.ilRepositorySelectorExplorerGUI.php.

References $selectable_types.

Referenced by isNodeSelectable().

                                         : array
     {
         return $this->selectable_types;
     }

Here is the caller graph for this function:

◆ isNodeClickable()

ilRepositorySelectorExplorerGUI::isNodeClickable ( $a_node )

Definition at line 260 of file class.ilRepositorySelectorExplorerGUI.php.

References $access, and getClickableTypes().

                                             : bool
     {
         $ilAccess = $this->access;
 
         if (!$ilAccess->hasUserRBACorAnyPositionAccess($this->clickable_permission, $a_node["child"])) {
             return false;
         }
 
         if (is_array($this->getClickableTypes()) && count($this->getClickableTypes()) > 0) {
             return in_array($a_node["type"], $this->getClickableTypes(), true);
         }
 
         return true;
     }

Here is the call graph for this function:

◆ isNodeHighlighted()

ilRepositorySelectorExplorerGUI::isNodeHighlighted ( $a_node )

Definition at line 154 of file class.ilRepositorySelectorExplorerGUI.php.

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

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

Here is the call graph for this function:

◆ isNodeSelectable()

ilRepositorySelectorExplorerGUI::isNodeSelectable ( $a_node )

protected

Definition at line 305 of file class.ilRepositorySelectorExplorerGUI.php.

References getSelectableTypes().

                                                 : bool
     {
         if (count($this->getSelectableTypes())) {
             return in_array($a_node['type'], $this->getSelectableTypes(), true);
         }
         return true;
     }

Here is the call graph for this function:

◆ isNodeVisible()

ilRepositorySelectorExplorerGUI::isNodeVisible ( $a_node )

Definition at line 185 of file class.ilRepositorySelectorExplorerGUI.php.

References $access.

                                           : bool
     {
         $ilAccess = $this->access;
 
         if (!$ilAccess->checkAccess('visible', '', $a_node["child"])) {
             return false;
         }
 
         return true;
     }

◆ setClickablePermission()

ilRepositorySelectorExplorerGUI::setClickablePermission ( string $rbac_perm )

Definition at line 255 of file class.ilRepositorySelectorExplorerGUI.php.

                                                              : void
     {
         $this->clickable_permission = $rbac_perm;
     }

◆ setClickableTypes()

ilRepositorySelectorExplorerGUI::setClickableTypes ( array $a_types )

Definition at line 285 of file class.ilRepositorySelectorExplorerGUI.php.

Referenced by ilStandardGlossarySelectorGUI\__construct(), ilPCFileItemFileSelectorGUI\__construct(), and ilTestQuestionPoolSelectorExplorer\__construct().

                                                      : void
     {
         $this->clickable_types = $a_types;
     }

Here is the caller graph for this function:

◆ setHighlightedNode()

ilRepositorySelectorExplorerGUI::setHighlightedNode ( string $a_value )

Definition at line 275 of file class.ilRepositorySelectorExplorerGUI.php.

                                                        : void
     {
         $this->highlighted_node = $a_value;
     }

◆ setNodeContentModifier()

ilRepositorySelectorExplorerGUI::setNodeContentModifier ( Closure $a_val )

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

                                                           : void
     {
         $this->nc_modifier = $a_val;
     }

◆ setSelectableTypes()

ilRepositorySelectorExplorerGUI::setSelectableTypes ( array $a_types )

Definition at line 295 of file class.ilRepositorySelectorExplorerGUI.php.

                                                       : void
     {
         $this->selectable_types = $a_types;
     }

◆ sortChilds()

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

Definition at line 196 of file class.ilRepositorySelectorExplorerGUI.php.

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

                                                                   : 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"] = ["root" => "dummy"];
         }
 
         if (empty($this->type_grps[$parent_type])) {
             $this->type_grps[$parent_type] =
                 $objDefinition::getGroupedRepositoryObjectTypes($parent_type);
         }
         $group = [];
 
         foreach ($a_childs as $child) {
             $g = $objDefinition->getGroupOfObj($child["type"]);
             if ($g == "") {
                 $g = $child["type"];
             }
             $group[$g][] = $child;
         }
 
         // #14587 - $objDefinition->getGroupedRepositoryObjectTypes does NOT include side blocks!
         $wl = $this->getTypeWhiteList();
         if (is_array($wl) && in_array("poll", $wl, true)) {
             $this->type_grps[$parent_type]["poll"] = [];
         }
 
         $childs = [];
         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);
 
                 foreach ($group[$t] as $k => $item) {
                     $childs[] = $item;
                 }
             }
         }
 
         return $childs;
     }