ILIAS  trunk Revision v11.0_alpha-1831-g8615d53dadb
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ilForumMoveTopicsExplorer Class Reference

ilForumMoveTopicsExplorer More...

+ Inheritance diagram for ilForumMoveTopicsExplorer:
+ Collaboration diagram for ilForumMoveTopicsExplorer:

Public Member Functions

 __construct (ilObjForumGUI $a_parent_obj, string $a_parent_cmd)
 
 getCurrentFrmRefId ()
 
 setCurrentFrmRefId (int $current_frm_ref_id)
 
 isNodeClickable ($a_node)
 
- Public Member Functions inherited from ilRepositorySelectorExplorerGUI
 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 ilRepositorySelectorExplorerGUI
 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

int $current_frm_ref_id = 0
 
- Protected Attributes inherited from ilRepositorySelectorExplorerGUI
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
 

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

Constructor & Destructor Documentation

◆ __construct()

ilForumMoveTopicsExplorer::__construct ( ilObjForumGUI  $a_parent_obj,
string  $a_parent_cmd 
)

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

References ILIAS\GlobalScreen\Provider\__construct(), ilExplorerBaseGUI\setSelectMode(), and ilTreeExplorerGUI\setTypeWhiteList().

30  {
31  parent::__construct($a_parent_obj, $a_parent_cmd);
32  $this->setTypeWhiteList(['root', 'cat', 'fold', 'crs', 'grp', 'frm']);
33  $this->setSelectMode('frm_ref_id');
34  }
setTypeWhiteList(array $a_val)
Set type white list.
setSelectMode(string $a_postvar, bool $a_multi=false)
Set select mode (to deactivate, pass an empty string as postvar)
__construct(Container $dic, ilPlugin $plugin)
+ Here is the call graph for this function:

Member Function Documentation

◆ getCurrentFrmRefId()

ilForumMoveTopicsExplorer::getCurrentFrmRefId ( )

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

References $current_frm_ref_id.

Referenced by isNodeClickable(), and isNodeSelectable().

36  : int
37  {
39  }
+ Here is the caller graph for this function:

◆ isNodeClickable()

ilForumMoveTopicsExplorer::isNodeClickable (   $a_node)

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

References $DIC, and getCurrentFrmRefId().

46  : bool
47  {
48  global $DIC;
49 
50  if ($a_node['type'] === 'frm') {
51  if ($this->getCurrentFrmRefId() && $this->getCurrentFrmRefId() === $a_node['child']) {
52  return false;
53  }
54 
55  return $DIC->access()->checkAccess(
56  'moderate_frm',
57  '',
58  (int) $a_node['child']
59  ) && parent::isNodeClickable($a_node);
60  }
61 
62  return false;
63  }
global $DIC
Definition: shib_login.php:22
+ Here is the call graph for this function:

◆ isNodeSelectable()

ilForumMoveTopicsExplorer::isNodeSelectable (   $a_node)
protected

Definition at line 65 of file class.ilForumMoveTopicsExplorer.php.

References $DIC, and getCurrentFrmRefId().

65  : bool
66  {
67  global $DIC;
68 
69  if ($a_node['type'] === 'frm') {
70  if ($this->getCurrentFrmRefId() && $this->getCurrentFrmRefId() === $a_node['child']) {
71  return false;
72  }
73 
74  return $DIC->access()->checkAccess(
75  'moderate_frm',
76  '',
77  (int) $a_node['child']
78  ) && parent::isNodeSelectable($a_node);
79  }
80 
81  return false;
82  }
global $DIC
Definition: shib_login.php:22
+ Here is the call graph for this function:

◆ setCurrentFrmRefId()

ilForumMoveTopicsExplorer::setCurrentFrmRefId ( int  $current_frm_ref_id)

Definition at line 41 of file class.ilForumMoveTopicsExplorer.php.

References $current_frm_ref_id.

41  : void
42  {
43  $this->current_frm_ref_id = $current_frm_ref_id;
44  }

Field Documentation

◆ $current_frm_ref_id

int ilForumMoveTopicsExplorer::$current_frm_ref_id = 0
protected

Definition at line 27 of file class.ilForumMoveTopicsExplorer.php.

Referenced by getCurrentFrmRefId(), and setCurrentFrmRefId().


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