ilForumMoveTopicsExplorer Class Reference

ilForumMoveTopicsExplorer More...

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")
	{Constructor. Parameters object $a_parent_obj parent gui object string $a_parent_cmd parent cmd that renders the explorer object/string $a_selection_gui gui class that should be called for the selection command string $a_selection_cmd selection command string $a_selection_par selection parameter }
	getCurrentFrmRefId ()
	setCurrentFrmRefId ($current_frm_ref_id)
	isNodeVisible ($a_node)
	{Is node visible. Parameters array $a_node node data Returns bool visible true/false }
	renderNode ($a_node, $tpl)
	{Render node. Parameters @return }
Public Member Functions inherited from ilRepositorySelectorExplorerGUI
	getNodeContent ($a_node)
	Get node content.
	getNodeIcon ($a_node)
	Get node icon.
	getNodeIconAlt ($a_node)
	Get node icon alt text.
	isNodeHighlighted ($a_node)
	Is node highlighted?
	getNodeHref ($a_node)
	Get href for node.
	sortChilds ($a_childs, $a_parent_node_id)
	Sort childs.
	getChildsOfNode ($a_parent_node_id)
	Get childs of node.
	isNodeClickable ($a_node)
	Is node clickable?
	setHighlightedNode ($a_value)
	set an alternate highlighted node if $_GET["ref_id"] is not set or wrong
	getHighlightedNode ()
	get an alternate highlighted node if $_GET["ref_id"] is not set or wrong Returns null if not set
	setClickableTypes ($a_types)
	set Whitelist for clickable items
	getClickableTypes ()
	get whitelist for clickable items
Public Member Functions inherited from ilTreeExplorerGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree)
	Constructor.
	getTree ()
	Get tree.
	setOrderField ($a_val, $a_numeric=false)
	Set order field.
	getOrderField ()
	Get order field.
	setTypeWhiteList ($a_val)
	Set type white list.
	getTypeWhiteList ()
	Get type white list.
	setTypeBlackList ($a_val)
	Set type black list.
	getTypeBlackList ()
	Get type black list.
	setPreloadChilds ($a_val)
	Set preload childs.
	getPreloadChilds ()
	Get preload childs.
	getSuccessorNode ($a_node_id, $a_type="")
	Get successor node (currently only(!) based on lft/rgt tree values)
	getNodeId ($a_node)
	Get id for node.
	getRootNode ()
	Get root node.
	setPathOpen ($a_id)
	Set node path to be opened.
	getHTML ()
	Get HTML.
Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor.
	nodeHasVisibleChilds ($a_node)
	Node has childs?
	getNodeTarget ($a_node)
	Get node target (frame) attribute.
	getNodeOnClick ($a_node)
	Get node onclick attribute.
	getId ()
	Get id of explorer element.
	setSkipRootNode ($a_val)
	Set skip root node.
	getSkipRootNode ()
	Get skip root node.
	setAjax ($a_val)
	Set ajax.
	getAjax ()
	Get ajax.
	setNodeOpen ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour)
	setSelectMode ($a_postvar, $a_multi=false)
	Set select mode (to deactivate, pass an empty string as postvar)
	setNodeSelected ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour)
	setOfflineMode ($a_val)
	Set offline mode.
	getOfflineMode ()
	Get offline mode.
	handleCommand ()
	Handle explorer internal command.
	getContainerId ()
	Get container id.
	openNode ()
	Open node.
	closeNode ()
	Close node.
	getNodeAsync ()
	Get node asynchronously.
	beforeRendering ()
	Before rendering.
	renderChilds ($a_node_id, $tpl)
	Render childs.
	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id.
	getNodeIdForDomNodeId ($a_dom_node_id)
	Get node id for dom node id.
	listItemStart ($tpl, $a_node)
	List item start.
	listItemEnd ($tpl)
	List item end.
	listStart ($tpl)
	List start.
	listEnd ($tpl)
	List end.

Protected Attributes
	$current_frm_ref_id = 0
Protected Attributes inherited from ilRepositorySelectorExplorerGUI
	$type_grps = array()
	$session_materials = array()
	$highlighted_node = null
	$clickable_types = array()
Protected Attributes inherited from ilTreeExplorerGUI
	$tree = null
	$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()
Protected Attributes inherited from ilExplorerBaseGUI
	$skip_root_node = false
	$ajax = false
	$custom_open_nodes = array()
	$selected_nodes = array()
	$select_postvar = ""
	$offline_mode = false

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()
	Get local path of explorer js.
static	getLocalJsTreeJsPath ()
	Get local path of jsTree js.
static	createHTMLExportDirs ($a_target_dir)
	Create html export directories.
Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	Preload childs.
Static Protected Attributes inherited from ilExplorerBaseGUI
static	$js_tree_path = "./Services/UIComponent/Explorer2/lib/jstree-v.pre1.0/jquery.jstree.js"
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 10 of file class.ilForumMoveTopicsExplorer.php.

Constructor & Destructor Documentation

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

{Constructor.

Parameters

object	$a_parent_obj	parent gui object
string	$a_parent_cmd	parent cmd that renders the explorer
	object/string	$a_selection_gui gui class that should be called for the selection command
string	$a_selection_cmd	selection command
string	$a_selection_par	selection parameter

}

Reimplemented from ilRepositorySelectorExplorerGUI.

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

References ilExplorerBaseGUI\setSelectMode(), and ilTreeExplorerGUI\setTypeWhiteList().

        {
                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');
        }

Here is the call graph for this function:

Member Function Documentation

ilForumMoveTopicsExplorer::getCurrentFrmRefId

(

)

Returns

int

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

References $current_frm_ref_id.

        {
                return $this->current_frm_ref_id;
        }

ilForumMoveTopicsExplorer::isNodeVisible

(

$a_node

)

{Is node visible.

Parameters

array

$a_node

node data

Returns

bool visible true/false

}

Reimplemented from ilRepositorySelectorExplorerGUI.

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

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

ilForumMoveTopicsExplorer::renderNode	(		$a_node,
			$tpl
	)

{Render node.

Parameters

@return

}

Reimplemented from ilExplorerBaseGUI.

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

References $tpl, and ilRepositorySelectorExplorerGUI\isNodeClickable().

        {
                $this->select_postvar = $this->isNodeClickable($a_node) ? 'frm_ref_id' : '';
                parent::renderNode($a_node, $tpl);
        }

Here is the call graph for this function:

ilForumMoveTopicsExplorer::setCurrentFrmRefId

(

$current_frm_ref_id

)

Parameters

int

$current_frm_ref_id

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

References $current_frm_ref_id.

        {
                $this->current_frm_ref_id = $current_frm_ref_id;
        }

Field Documentation

ilForumMoveTopicsExplorer::$current_frm_ref_id = 0

protected

Definition at line 15 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