Inheritance diagram for ilForumMoveTopicsExplorer:

Collaboration diagram for ilForumMoveTopicsExplorer:

Public Member Functions

__construct ( $a_parent_obj, $a_parent_cmd, $a_selection_gui=null, $a_selection_cmd="selectObject", $a_selection_par="sel_ref_id")

{} More...

getCurrentFrmRefId ()

setCurrentFrmRefId ($current_frm_ref_id)

isNodeClickable ($a_node)

{Is node clickable?

Parameters

array $a_node node data

Returns: boolean node clickable true/false

} More...

isNodeVisible ($a_node)

{Is node visible.

Parameters

array $a_node node data

Returns: bool visible true/false

} More...

Public Member Functions inherited from ilRepositorySelectorExplorerGUI

__construct ( $a_parent_obj, $a_parent_cmd, $a_selection_gui=null, $a_selection_cmd="selectObject", $a_selection_par="sel_ref_id", $a_id="rep_exp_sel")

Constructor. More...

setNodeContentModifier (callable $a_val)

Set node content modifier. More...

getNodeContentModifier ()

Get node content modifier. 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...

getChildsOfNode ($a_parent_node_id)

Get childs of node. More...

isNodeClickable ($a_node)

Is node clickable? More...

setHighlightedNode ($a_value)

set an alternate highlighted node if $_GET["ref_id"] is not set or wrong More...

getHighlightedNode ()

get an alternate highlighted node if $_GET["ref_id"] is not set or wrong Returns null if not set More...

setClickableTypes ($a_types)

set Whitelist for clickable items More...

getClickableTypes ()

get whitelist for clickable items More...

setSelectableTypes ($a_types)

Get HTML. More...

getSelectableTypes ()

get whitelist for clickable items 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.

Returns: array

More...

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...

Protected Member Functions

isNodeSelectable ($a_node)

{Is node selectable?

Parameters

mixed $a_node node object/array

Returns: boolean node selectable true/false

} More...

isNodeSelectable ($a_node)

Is node selectable? 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
	$current_frm_ref_id = 0

Protected Attributes inherited from ilRepositorySelectorExplorerGUI
	$obj_definition

	$lng

	$type_grps = array()

	$session_materials = array()

	$highlighted_node = null

	$clickable_types = array()

	$ctrl

	$access

	$nc_modifier = null

	$selection_gui = null

	$selection_par

	$selection_cmd

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 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...

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"

Detailed Description

ilForumMoveTopicsExplorer

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

◆ __construct()

ilForumMoveTopicsExplorer::__construct	(	$a_parent_obj,
		$a_parent_cmd,
		$a_selection_gui = `null`,
		$a_selection_cmd = `"selectObject"`,
		$a_selection_par = `"sel_ref_id"`
	)

{}

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

      {
        parent::__construct($a_parent_obj, $a_parent_cmd, $a_selection_gui, $a_selection_cmd, $a_selection_par);
        $this->setTypeWhiteList(array('root', 'cat', 'fold', 'crs', 'grp', 'frm'));
        $this->setSelectMode('frm_ref_id');
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getCurrentFrmRefId()

ilForumMoveTopicsExplorer::getCurrentFrmRefId ( )

Returns: int

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

    {
        return $this->current_frm_ref_id;
    }

References $current_frm_ref_id.

Referenced by isNodeClickable(), and isNodeSelectable().

Here is the caller graph for this function:

◆ isNodeClickable()

ilForumMoveTopicsExplorer::isNodeClickable ( $a_node )

{Is node clickable?

Parameters

array $a_node node data

Returns: boolean node clickable true/false

}

Reimplemented from ilRepositorySelectorExplorerGUI.

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

    {
        global $DIC;
 
        if ($a_node['type'] == 'frm') {
            if ($this->getCurrentFrmRefId() && $this->getCurrentFrmRefId() == $a_node['child']) {
                return false;
            }
 
            return $DIC->access()->checkAccess('moderate_frm', '', $a_node['child']) && parent::isNodeClickable($a_node);
        }
 
        return false;
    }

References $DIC, and getCurrentFrmRefId().

Here is the call graph for this function:

◆ isNodeSelectable()

ilForumMoveTopicsExplorer::isNodeSelectable ( $a_node )

protected

{Is node selectable?

Parameters

mixed $a_node node object/array

Returns: boolean node selectable true/false

}

Reimplemented from ilRepositorySelectorExplorerGUI.

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

    {
        global $DIC;
        
        if ($a_node['type'] == 'frm') {
            if ($this->getCurrentFrmRefId() && $this->getCurrentFrmRefId() == $a_node['child']) {
                return false;
            }
 
            return $DIC->access()->checkAccess('moderate_frm', '', $a_node['child']) && parent::isNodeSelectable($a_node);
        }
 
        return false;
    }

References $DIC, and getCurrentFrmRefId().

Here is the call graph for this function:

◆ isNodeVisible()

ilForumMoveTopicsExplorer::isNodeVisible ( $a_node )

{Is node visible.

Parameters

array $a_node node data

Returns: bool visible true/false

}

Reimplemented from ilRepositorySelectorExplorerGUI.

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

    {
        return parent::isNodeVisible($a_node);
    }

◆ setCurrentFrmRefId()

ilForumMoveTopicsExplorer::setCurrentFrmRefId ( $current_frm_ref_id )

Parameters

int $current_frm_ref_id

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

    {
        $this->current_frm_ref_id = $current_frm_ref_id;
    }

References $current_frm_ref_id.

Field Documentation

◆ $current_frm_ref_id

ilForumMoveTopicsExplorer::$current_frm_ref_id = 0

protected

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

Referenced by getCurrentFrmRefId(), and setCurrentFrmRefId().

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

Modules/Forum/classes/class.ilForumMoveTopicsExplorer.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getCurrentFrmRefId()

◆ isNodeClickable()

◆ isNodeSelectable()

◆ isNodeVisible()

◆ setCurrentFrmRefId()

Field Documentation

◆ $current_frm_ref_id