ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilConditionSelector Class Reference

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.
 isNodeVisible ($a_node)
 Is node visible.
 isNodeClickable ($a_node)
 Is node clickable?
 setRefId ($a_ref_id)
 set ref id of target object
 getRefId ()
 get ref id of target object
 isNodeHighlighted ($a_node)
 Is node highlighted?
- 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.
 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.
 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.
 setSecondaryHighlightedNodes ($a_val)
 Set secondary (background) highlighted nodes.
 getSecondaryHighlightedNodes ()
 Get secondary (background) highlighted nodes.
 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.
 getOnLoadCode ()
 Get on load code.
 renderNode ($a_node, $tpl)
 Render node.
 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

 $highlighted_parent = null
 $clickable_types = array()
 $ref_id = null
- 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
 $sec_highl_nodes = array()

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.
static init ()
 Init JS.
- 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

Repository Explorer.

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
Id:
class.ilConditionSelector.php 56517 2014-12-17 11:23:38Z fwolf

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

Constructor & Destructor Documentation

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

Reimplemented from ilRepositorySelectorExplorerGUI.

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

ilConditionSelector::getRefId ( )

get ref id of target object

Returns
mixed

Definition at line 105 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:

ilConditionSelector::isNodeClickable (   $a_node)

Is node clickable?

Parameters
array$a_nodenode data
Returns
boolean node clickable true/false

Reimplemented from ilRepositorySelectorExplorerGUI.

Definition at line 67 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:

ilConditionSelector::isNodeHighlighted (   $a_node)

Is node highlighted?

Parameters
mixed$a_nodenode object/array
Returns
boolean node visible true/false

Reimplemented from ilRepositorySelectorExplorerGUI.

Definition at line 116 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);
}
ilConditionSelector::isNodeVisible (   $a_node)

Is node visible.

Parameters
array$a_nodenode data
Returns
bool visible true/false

Reimplemented from ilRepositorySelectorExplorerGUI.

Definition at line 44 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:

ilConditionSelector::setRefId (   $a_ref_id)

set ref id of target object

Parameters
$a_ref_id

Definition at line 85 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?
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

ilConditionSelector::$clickable_types = array()
protected

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

ilConditionSelector::$highlighted_parent = null
protected

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

ilConditionSelector::$ref_id = null
protected

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

Referenced by getRefId().


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