ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilWorkspaceExplorerGUI Class Reference

Explorer for selecting a personal workspace item. More...

+ Inheritance diagram for ilWorkspaceExplorerGUI:
+ Collaboration diagram for ilWorkspaceExplorerGUI:

Public Member Functions

 __construct (int $a_user_id, $a_parent_obj, string $a_parent_cmd, $a_select_gui, string $a_select_cmd, string $a_select_par="sel_wsp_obj")
 ilWorkspaceExplorerGUI constructor. More...
 
 setLinkToNodeClass (bool $a_val)
 
 getLinkToNodeClass ()
 
 setActivateHighlighting (bool $a_val)
 
 getActivateHighlighting ()
 
 setSelectableTypes (array $a_val)
 
 getSelectableTypes ()
 
 setCustomLinkTarget (string $a_val)
 
 getCustomLinkTarget ()
 
 getNodeHref ($a_node)
 @inheritcoc More...
 
 getNodeContent ($a_node)
 @inheritcoc More...
 
 isNodeClickable ($a_node)
 @inheritcoc More...
 
 getNodeIcon ($a_node)
 @inheritcoc More...
 
 isNodeHighlighted ($a_node)
 @inheritcoc More...
 
- 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
 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 Member Functions

 isNodeSelectable ($a_node)
 @inheritcoc More...
 
- 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

ilWorkspaceAccessHandler $access_handler
 
bool $link_to_node_class = false
 
string $custom_link_target = ""
 
 $select_gui = null
 
string $select_cmd = ""
 
string $select_par = ""
 
array $selectable_types = array()
 
bool $activate_highlighting = false
 
StandardGUIRequest $request
 
- 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)
 
- 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

Explorer for selecting a personal workspace item.

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

Definition at line 26 of file class.ilWorkspaceExplorerGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilWorkspaceExplorerGUI::__construct ( int  $a_user_id,
  $a_parent_obj,
string  $a_parent_cmd,
  $a_select_gui,
string  $a_select_cmd,
string  $a_select_par = "sel_wsp_obj" 
)

ilWorkspaceExplorerGUI constructor.

Parameters
object | array$a_parent_obj
string | object$a_select_gui

Definition at line 46 of file class.ilWorkspaceExplorerGUI.php.

53 {
54 global $DIC;
55
56 $this->ctrl = $DIC->ctrl();
57 $this->lng = $DIC->language();
58
59 $this->select_gui = (is_object($a_select_gui))
60 ? strtolower(get_class($a_select_gui))
61 : $a_select_gui;
62 $this->select_cmd = $a_select_cmd;
63 $this->select_par = $a_select_par;
64
65 $this->request = new StandardGUIRequest(
66 $DIC->http(),
67 $DIC->refinery()
68 );
69
70 $this->tree = new ilWorkspaceTree($a_user_id);
71 $this->root_id = $this->tree->readRootId();
72 $this->access_handler = new ilWorkspaceAccessHandler($this->tree);
73
74 parent::__construct("wsp_sel", $a_parent_obj, $a_parent_cmd, $this->tree);
75 $this->setSkipRootNode(false);
76 $this->setAjax(true);
77 $this->setPathOpen($this->root_id);
78
79 $this->setTypeWhiteList(array("wsrt", "wfld"));
80 }
setPathOpen($a_id)
Set node path to be opened.
setTypeWhiteList(array $a_val)
Set type white list.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
global $DIC
Definition: shib_login.php:26

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilExplorerBaseGUI\setAjax(), ilTreeExplorerGUI\setPathOpen(), ilExplorerBaseGUI\setSkipRootNode(), and ilTreeExplorerGUI\setTypeWhiteList().

+ Here is the call graph for this function:

Member Function Documentation

◆ getActivateHighlighting()

ilWorkspaceExplorerGUI::getActivateHighlighting ( )

Definition at line 97 of file class.ilWorkspaceExplorerGUI.php.

97 : bool
98 {
100 }

References $activate_highlighting.

Referenced by isNodeHighlighted().

+ Here is the caller graph for this function:

◆ getCustomLinkTarget()

ilWorkspaceExplorerGUI::getCustomLinkTarget ( )

Definition at line 117 of file class.ilWorkspaceExplorerGUI.php.

117 : string
118 {
120 }

References $custom_link_target.

Referenced by getNodeHref().

+ Here is the caller graph for this function:

◆ getLinkToNodeClass()

ilWorkspaceExplorerGUI::getLinkToNodeClass ( )

Definition at line 87 of file class.ilWorkspaceExplorerGUI.php.

87 : bool
88 {
90 }

References $link_to_node_class.

Referenced by getNodeHref().

+ Here is the caller graph for this function:

◆ getNodeContent()

ilWorkspaceExplorerGUI::getNodeContent (   $a_node)

@inheritcoc

Reimplemented from ilExplorerBaseGUI.

Definition at line 171 of file class.ilWorkspaceExplorerGUI.php.

171 : string
172 {
174
175 if ($a_node["child"] == $this->tree->getRootId()) {
176 return $lng->txt("personal_resources");
177 }
178
179 return $a_node["title"];
180 }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...

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

+ Here is the call graph for this function:

◆ getNodeHref()

ilWorkspaceExplorerGUI::getNodeHref (   $a_node)

@inheritcoc

Reimplemented from ilExplorerBaseGUI.

Definition at line 125 of file class.ilWorkspaceExplorerGUI.php.

125 : string
126 {
127 if ($this->select_postvar != "") {
128 return "";
129 }
130 if ($this->getCustomLinkTarget() != "") {
131 return $this->getCustomLinkTarget() . "&" . $this->select_par . "=" . $a_node["child"];
132 }
133
134 $ilCtrl = $this->ctrl;
135
136 $target_class = $this->select_gui;
137 if (is_object($this->parent_obj)) {
138 $target_path = [get_class($this->parent_obj)];
139 } else {
140 $target_path = $this->parent_obj;
141 }
142 $target_path = $target_path + [$target_class];
143
144 if ($this->getLinkToNodeClass()) {
145 switch ($a_node["type"]) {
146 case "wsrt":
147 $target_class = "ilobjworkspacerootfoldergui";
148 $target_path = ["ilDashboardGUI", "ilPersonalWorkspaceGUI", "ilobjworkspacerootfoldergui"];
149 break;
150 case "wfld":
151 $target_class = "ilobjworkspacefoldergui";
152 break;
153 }
154 }
155
156 /*var_dump($target_path);
157 var_dump($target_class);
158 var_dump($this->select_par);
159 var_dump($a_node);*/
160 $ilCtrl->setParameterByClass($target_class, $this->select_par, $a_node["child"]);
161 $ret = $ilCtrl->getLinkTargetByClass($target_path, $this->select_cmd);
162 /*var_dump($ret);
163 exit;*/
164 $ilCtrl->setParameterByClass($target_class, $this->select_par, $this->request->getSelectPar());
165 return $ret;
166 }

References ilExplorerBaseGUI\$ctrl, ilExplorerBaseGUI\$parent_obj, $select_gui, getCustomLinkTarget(), and getLinkToNodeClass().

+ Here is the call graph for this function:

◆ getNodeIcon()

ilWorkspaceExplorerGUI::getNodeIcon (   $a_node)

@inheritcoc

Reimplemented from ilExplorerBaseGUI.

Definition at line 207 of file class.ilWorkspaceExplorerGUI.php.

207 : string
208 {
209 $t = $a_node["type"];
210 if (in_array($t, array("sktr"))) {
211 return ilUtil::getImagePath("standard/icon_skll.svg");
212 }
213 return ilUtil::getImagePath("standard/icon_" . $t . ".svg");
214 }
static getImagePath(string $image_name, string $module_path="", string $mode="output", bool $offline=false)
get image path (for images located in a template directory)

References ilUtil\getImagePath().

+ Here is the call graph for this function:

◆ getSelectableTypes()

ilWorkspaceExplorerGUI::getSelectableTypes ( )

Definition at line 107 of file class.ilWorkspaceExplorerGUI.php.

107 : array
108 {
110 }

References $selectable_types.

Referenced by isNodeClickable(), and isNodeSelectable().

+ Here is the caller graph for this function:

◆ isNodeClickable()

ilWorkspaceExplorerGUI::isNodeClickable (   $a_node)

@inheritcoc

Reimplemented from ilExplorerBaseGUI.

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

185 : bool
186 {
187 if (in_array($a_node["type"], $this->getSelectableTypes())) {
188 return true;
189 }
190 return false;
191 }

References getSelectableTypes().

+ Here is the call graph for this function:

◆ isNodeHighlighted()

ilWorkspaceExplorerGUI::isNodeHighlighted (   $a_node)

@inheritcoc

Reimplemented from ilExplorerBaseGUI.

Definition at line 219 of file class.ilWorkspaceExplorerGUI.php.

219 : bool
220 {
221 $wsp_id = $this->request->getWspId();
222 if ($this->getActivateHighlighting() &&
223 ((int) $a_node["child"] == $wsp_id || $wsp_id == 0 && $a_node["child"] == $this->getRootId())) {
224 return true;
225 }
226 return false;
227 }

References getActivateHighlighting(), and ilTreeExplorerGUI\getRootId().

+ Here is the call graph for this function:

◆ isNodeSelectable()

ilWorkspaceExplorerGUI::isNodeSelectable (   $a_node)
protected

@inheritcoc

Reimplemented from ilExplorerBaseGUI.

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

196 : bool
197 {
198 if (in_array($a_node["type"], $this->getSelectableTypes())) {
199 return true;
200 }
201 return false;
202 }

References getSelectableTypes().

+ Here is the call graph for this function:

◆ setActivateHighlighting()

ilWorkspaceExplorerGUI::setActivateHighlighting ( bool  $a_val)

Definition at line 92 of file class.ilWorkspaceExplorerGUI.php.

92 : void
93 {
94 $this->activate_highlighting = $a_val;
95 }

◆ setCustomLinkTarget()

ilWorkspaceExplorerGUI::setCustomLinkTarget ( string  $a_val)

Definition at line 112 of file class.ilWorkspaceExplorerGUI.php.

112 : void
113 {
114 $this->custom_link_target = $a_val;
115 }

◆ setLinkToNodeClass()

ilWorkspaceExplorerGUI::setLinkToNodeClass ( bool  $a_val)

Definition at line 82 of file class.ilWorkspaceExplorerGUI.php.

82 : void
83 {
84 $this->link_to_node_class = $a_val;
85 }

◆ setSelectableTypes()

ilWorkspaceExplorerGUI::setSelectableTypes ( array  $a_val)

Definition at line 102 of file class.ilWorkspaceExplorerGUI.php.

102 : void
103 {
104 $this->selectable_types = $a_val;
105 }

Field Documentation

◆ $access_handler

ilWorkspaceAccessHandler ilWorkspaceExplorerGUI::$access_handler
protected

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

◆ $activate_highlighting

bool ilWorkspaceExplorerGUI::$activate_highlighting = false
protected

Definition at line 38 of file class.ilWorkspaceExplorerGUI.php.

Referenced by getActivateHighlighting().

◆ $custom_link_target

string ilWorkspaceExplorerGUI::$custom_link_target = ""
protected

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

Referenced by getCustomLinkTarget().

◆ $link_to_node_class

bool ilWorkspaceExplorerGUI::$link_to_node_class = false
protected

Definition at line 29 of file class.ilWorkspaceExplorerGUI.php.

Referenced by getLinkToNodeClass().

◆ $request

StandardGUIRequest ilWorkspaceExplorerGUI::$request
protected

Definition at line 39 of file class.ilWorkspaceExplorerGUI.php.

◆ $select_cmd

string ilWorkspaceExplorerGUI::$select_cmd = ""
protected

Definition at line 35 of file class.ilWorkspaceExplorerGUI.php.

◆ $select_gui

ilWorkspaceExplorerGUI::$select_gui = null
protected

Definition at line 34 of file class.ilWorkspaceExplorerGUI.php.

Referenced by getNodeHref().

◆ $select_par

string ilWorkspaceExplorerGUI::$select_par = ""
protected

Definition at line 36 of file class.ilWorkspaceExplorerGUI.php.

◆ $selectable_types

array ilWorkspaceExplorerGUI::$selectable_types = array()
protected

Definition at line 37 of file class.ilWorkspaceExplorerGUI.php.

Referenced by getSelectableTypes().


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