|
ILIAS
release_7 Revision v7.30-3-g800a261c036
|
Repository explorer GUI class. More...
Inheritance diagram for ilRepositoryExplorerGUI:
Collaboration diagram for ilRepositoryExplorerGUI:Public Member Functions | |
| __construct ($a_parent_obj, $a_parent_cmd) | |
| Constructor. More... | |
| getRootNode () | |
| Get root node. 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... | |
| nodeHasVisibleChilds ($a_node) | |
| Node has 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.
| |
| 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... | |
Static Public Member Functions | |
| static | getTopNodeForRefId (int $ref_id) |
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 | |
| getParentCourseOrGroup ($node_id) | |
| Get upper course or group. 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 () | |
Protected Attributes | |
| $settings | |
| $obj_definition | |
| $lng | |
| $ctrl | |
| $access | |
| $rbacsystem | |
| $db | |
| $user | |
| $type_grps = array() | |
| $session_materials = array() | |
| $parent_node_id = [] | |
| $node_data = [] | |
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 Protected Attributes inherited from ilExplorerBaseGUI | |
| static | $js_tree_path = "./node_modules/jstree/dist/jstree.js" |
| static | $js_tree_path_css = "./node_modules/jstree/dist/themes/default/style.min.css" |
| static | $js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js" |
Repository explorer GUI class.
Definition at line 16 of file class.ilRepositoryExplorerGUI.php.
| ilRepositoryExplorerGUI::__construct | ( | $a_parent_obj, | |
| $a_parent_cmd | |||
| ) |
Constructor.
Definition at line 67 of file class.ilRepositoryExplorerGUI.php.
References $_GET, $DIC, $ilSetting, ilTreeExplorerGUI\$tree, ILIAS\GlobalScreen\Provider\__construct(), getTopNodeForRefId(), ilExplorerBaseGUI\setAjax(), ilExplorerBaseGUI\setChildLimit(), ilExplorerBaseGUI\setNodeOpen(), ilTreeExplorerGUI\setOrderField(), ilTreeExplorerGUI\setPathOpen(), ilExplorerBaseGUI\setSkipRootNode(), settings(), ilTreeExplorerGUI\setTypeWhiteList(), and user().
Here is the call graph for this function:| ilRepositoryExplorerGUI::getChildsOfNode | ( | $a_parent_node_id | ) |
Get childs of node.
return
Reimplemented from ilTreeExplorerGUI.
Definition at line 522 of file class.ilRepositoryExplorerGUI.php.
References $c, ilTreeExplorerGUI\$childs, $rbacsystem, ilConditionHandler\_checkAllConditionsOfTarget(), and ilObject\_lookupObjId().
Here is the call graph for this function:| ilRepositoryExplorerGUI::getNodeContent | ( | $a_node | ) |
Get node content.
| array |
Reimplemented from ilExplorerBaseGUI.
Definition at line 135 of file class.ilRepositoryExplorerGUI.php.
References $lng, ilSessionAppointment\_appointmentToString(), ilSessionAppointment\_lookupAppointment(), ilTreeExplorerGUI\getNodeId(), and getRootNode().
Referenced by getNodeIconAlt().
Here is the call graph for this function:
Here is the caller graph for this function:| ilRepositoryExplorerGUI::getNodeHref | ( | $a_node | ) |
Get href for node.
| mixed | $a_node | node object/array |
Reimplemented from ilExplorerBaseGUI.
Definition at line 210 of file class.ilRepositoryExplorerGUI.php.
References $_GET, $ctrl, and ilLink\_getStaticLink().
Here is the call graph for this function:| ilRepositoryExplorerGUI::getNodeIcon | ( | $a_node | ) |
Get node icon.
| array |
Reimplemented from ilExplorerBaseGUI.
Definition at line 161 of file class.ilRepositoryExplorerGUI.php.
References ilObject\_getIcon(), and ilObject\_lookupObjId().
Here is the call graph for this function:| ilRepositoryExplorerGUI::getNodeIconAlt | ( | $a_node | ) |
Get node icon alt text.
| array | node array |
Reimplemented from ilTreeExplorerGUI.
Definition at line 173 of file class.ilRepositoryExplorerGUI.php.
References $lng, getNodeContent(), ilTreeExplorerGUI\getNodeId(), and getRootNode().
Here is the call graph for this function:
|
protected |
Get upper course or group.
| int | $node_id |
Definition at line 328 of file class.ilRepositoryExplorerGUI.php.
References $parent_node_id.
Referenced by isNodeVisible().
Here is the caller graph for this function:| ilRepositoryExplorerGUI::getRootNode | ( | ) |
Get root node.
return
Reimplemented from ilTreeExplorerGUI.
Definition at line 118 of file class.ilRepositoryExplorerGUI.php.
References ilTreeExplorerGUI\getTree().
Referenced by getNodeContent(), getNodeIconAlt(), and isNodeHighlighted().
Here is the call graph for this function:
Here is the caller graph for this function:
|
static |
Definition at line 653 of file class.ilRepositoryExplorerGUI.php.
References $DIC, $n, ilTreeExplorerGUI\$tree, ilObject\_lookupObjId(), and ilObject\_lookupType().
Referenced by __construct(), and ILIAS\Repository\Provider\RepositoryMainBarProvider\getStaticSubItems().
Here is the call graph for this function:
Here is the caller graph for this function:| ilRepositoryExplorerGUI::isNodeClickable | ( | $a_node | ) |
Is node clickable?
| mixed | $a_node | node object/array |
Reimplemented from ilExplorerBaseGUI.
Definition at line 551 of file class.ilRepositoryExplorerGUI.php.
References $access, $db, $ilDB, $ilUser, $query, $rbacsystem, $res, ilTreeExplorerGUI\$tree, $user, ilConditionHandler\_checkAllConditionsOfTarget(), ilContainerReferenceAccess\_isAccessible(), ilObject\_lookupObjectId(), ilObject\_lookupObjId(), ilObjGlossary\_lookupOnline(), and ilDBConstants\FETCHMODE_OBJECT.
Here is the call graph for this function:| ilRepositoryExplorerGUI::isNodeHighlighted | ( | $a_node | ) |
Is node highlighted?
| mixed | $a_node | node object/array |
Reimplemented from ilExplorerBaseGUI.
Definition at line 195 of file class.ilRepositoryExplorerGUI.php.
References $_GET, ilTreeExplorerGUI\getNodeId(), and getRootNode().
Here is the call graph for this function:| ilRepositoryExplorerGUI::isNodeVisible | ( | $a_node | ) |
Is node visible.
return
Reimplemented from ilExplorerBaseGUI.
Definition at line 287 of file class.ilRepositoryExplorerGUI.php.
References $access, $ilSetting, $settings, ilTreeExplorerGUI\$tree, ilEventItems\_getItemsOfContainer(), and getParentCourseOrGroup().
Here is the call graph for this function:| ilRepositoryExplorerGUI::nodeHasVisibleChilds | ( | $a_node | ) |
Node has childs?
Please note that this standard method may not be optimal depending on what a derived class does in isNodeVisible.
return
Reimplemented from ilExplorerBaseGUI.
Definition at line 508 of file class.ilRepositoryExplorerGUI.php.
| ilRepositoryExplorerGUI::sortChilds | ( | $a_childs, | |
| $a_parent_node_id | |||
| ) |
Sort childs.
| array | $a_childs | array of child nodes |
| mixed | $a_parent_node | parent node |
Reimplemented from ilExplorerBaseGUI.
Definition at line 350 of file class.ilRepositoryExplorerGUI.php.
References $access, ilTreeExplorerGUI\$childs, $obj_definition, ilContainerSorting\_getInstance(), ilSessionAppointment\_lookupAppointment(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilObjectActivation\getItemsByItemGroup(), and ilUtil\sortArray().
Here is the call graph for this function:
|
protected |
Definition at line 41 of file class.ilRepositoryExplorerGUI.php.
Referenced by isNodeClickable(), isNodeVisible(), and sortChilds().
|
protected |
Definition at line 36 of file class.ilRepositoryExplorerGUI.php.
Referenced by getNodeHref().
|
protected |
Definition at line 51 of file class.ilRepositoryExplorerGUI.php.
Referenced by isNodeClickable().
|
protected |
Definition at line 31 of file class.ilRepositoryExplorerGUI.php.
Referenced by getNodeContent(), and getNodeIconAlt().
|
protected |
Definition at line 62 of file class.ilRepositoryExplorerGUI.php.
|
protected |
Definition at line 26 of file class.ilRepositoryExplorerGUI.php.
Referenced by sortChilds().
|
protected |
Definition at line 61 of file class.ilRepositoryExplorerGUI.php.
Referenced by getParentCourseOrGroup().
|
protected |
Definition at line 46 of file class.ilRepositoryExplorerGUI.php.
Referenced by getChildsOfNode(), and isNodeClickable().
|
protected |
Definition at line 59 of file class.ilRepositoryExplorerGUI.php.
|
protected |
Definition at line 21 of file class.ilRepositoryExplorerGUI.php.
Referenced by isNodeVisible().
|
protected |
Definition at line 58 of file class.ilRepositoryExplorerGUI.php.
|
protected |
Definition at line 56 of file class.ilRepositoryExplorerGUI.php.
Referenced by isNodeClickable().