Repository Explorer. More...

Inheritance diagram for ilConditionSelector:

Collaboration diagram for ilConditionSelector:

Public Member Functions
	__construct ( $a_parent_obj, $a_parent_cmd, $a_selection_gui=null, $a_selection_cmd="add", $a_selection_par="source_id")
	Construct. More...

	isNodeVisible ($a_node)
	Is node visible. More...

	isNodeClickable ($a_node)
	Is node clickable? More...

	setRefId ($a_ref_id)
	set ref id of target object More...

	getRefId ()
	get ref id of target object More...

	isNodeHighlighted ($a_node)
	Is node highlighted? 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 ()
	Get HTML. More...

Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor. More...

	setMainTemplate (ilTemplate $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...

Protected Attributes
	$highlighted_parent = null

	$clickable_types = array()

	$ref_id = null

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

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

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	createHTMLExportDirs ($a_target_dir)
	Create html export directories. More...

static	init ($a_main_tpl=null)
	Init JS. More...

Protected Member Functions inherited from ilRepositorySelectorExplorerGUI
	isNodeSelectable ($a_node)
	Is node selectable? More...

Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	Preload childs. More...

	getRootId ()

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

	getJSTreePlugins ()

Static Protected Attributes inherited from ilExplorerBaseGUI
static	$js_tree_path = "./libs/bower/bower_components/jstree/jquery.jstree.js"

static	$js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js"

Detailed Description

Repository Explorer.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilConditionSelector::__construct	(	$a_parent_obj,
		$a_parent_cmd,
		$a_selection_gui = `null`,
		$a_selection_cmd = `"add"`,
		$a_selection_par = `"source_id"`
	)

Construct.

Parameters

object	$a_parent_obj
string	$a_parent_cmd
object	$a_selection_gui
string	$a_selection_cmd
string	$a_selection_par

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

References ilExplorerBaseGUI\setAjax().

       {
         parent::__construct(
             $a_parent_obj,
             $a_parent_cmd,
             $a_selection_gui,
             $a_selection_cmd,
             $a_selection_par
         );
 
         $this->setAjax(true);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getRefId()

ilConditionSelector::getRefId ( )

get ref id of target object

Returns: mixed

Definition at line 110 of file class.ilConditionSelector.php.

References $ref_id.

Referenced by isNodeClickable(), and isNodeVisible().

     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ isNodeClickable()

ilConditionSelector::isNodeClickable ( $a_node )

Is node clickable?

Parameters

array $a_node node data

Returns: boolean node clickable true/false

Definition at line 73 of file class.ilConditionSelector.php.

References getRefId().

     {
         if (!parent::isNodeClickable($a_node)) {
             return false;
         }
 
         if ($a_node["child"] == $this->getRefId()) {
             return false;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ isNodeHighlighted()

ilConditionSelector::isNodeHighlighted ( $a_node )

Is node highlighted?

Parameters

mixed $a_node node object/array

Returns: boolean node visible true/false

Definition at line 121 of file class.ilConditionSelector.php.

     {
         //highlight parent if target object cant be highlighted
         if ($this->highlighted_parent == $a_node["child"]) {
             return true;
         }
 
         return parent::isNodeHighlighted($a_node);
     }

◆ isNodeVisible()

ilConditionSelector::isNodeVisible ( $a_node )

Is node visible.

Parameters

array $a_node node data

Returns: bool visible true/false

Definition at line 52 of file class.ilConditionSelector.php.

References ilTreeExplorerGUI\$tree, and getRefId().

     {
         global $ilAccess, $tree;
 
         if (!$ilAccess->checkAccess('read', '', $a_node["child"])) {
             return false;
         }
         //remove childs of target object
         if ($tree->getParentId($a_node["child"]) == $this->getRefId()) {
             return false;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ setRefId()

ilConditionSelector::setRefId ( $a_ref_id )

set ref id of target object

Parameters

$a_ref_id

Definition at line 91 of file class.ilConditionSelector.php.

References $target_type, ilTreeExplorerGUI\$tree, ilObject\_lookupType(), and ilTreeExplorerGUI\getTypeWhiteList().

     {
         global $tree;
 
         $this->ref_id = $a_ref_id;
 
         //can target object be highlighted?
         $target_type = ilObject::_lookupType($a_ref_id, true);
 
         if (!in_array($target_type, $this->getTypeWhiteList())) {
             $this->highlighted_parent = $tree->getParentId($a_ref_id);
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $clickable_types

ilConditionSelector::$clickable_types = array()

protected

Definition at line 16 of file class.ilConditionSelector.php.

◆ $highlighted_parent

ilConditionSelector::$highlighted_parent = null

protected

Definition at line 15 of file class.ilConditionSelector.php.

◆ $ref_id

ilConditionSelector::$ref_id = null

protected

Definition at line 17 of file class.ilConditionSelector.php.

Referenced by getRefId().

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

Services/AccessControl/classes/class.ilConditionSelector.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getRefId()

◆ isNodeClickable()

◆ isNodeHighlighted()

◆ isNodeVisible()

◆ setRefId()

Field Documentation

◆ $clickable_types

◆ $highlighted_parent

◆ $ref_id