ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilLMMenuObjectSelector Class Reference

LM Menu Object Selector. More...

+ Inheritance diagram for ilLMMenuObjectSelector:
+ Collaboration diagram for ilLMMenuObjectSelector:

Public Member Functions

 ilLMMenuObjectSelector ($a_target, &$a_gui_obj)
 Constructor @access public. More...
 
 setSelectableTypes ($a_types)
 
 setRefId ($a_ref_id)
 
 buildLinkTarget ($a_node_id, $a_type)
 get link target (may be overwritten by derived classes) More...
 
 buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
 get frame target (may be overwritten by derived classes) More...
 
 isClickable ($a_type, $a_ref_id)
 check if links for certain object type are activated More...
 
 showChilds ($a_ref_id)
 determines wether the childs of an object should be shown or not note: this standard implementation always returns true but it could be overwritten by derived classes (e.g. More...
 
 formatHeader ($a_obj_id, $a_option)
 overwritten method from base class @access public More...
 
- Public Member Functions inherited from ilExplorer
 ilExplorer ($a_target)
 Constructor @access public. More...
 
 setId ($a_val)
 Set id. More...
 
 getId ()
 Get id. More...
 
 setAsynchExpanding ($a_val)
 Set asynch expanding. More...
 
 getAsynchExpanding ()
 Get asynch expanding. More...
 
 initItemCounter ($a_number)
 Init item counter. More...
 
 setTitle ($a_val)
 Set title. More...
 
 setTitleLength ($a_length)
 Set max title length. More...
 
 getTitleLength ()
 Get max title length. More...
 
 getTitle ()
 Get title. More...
 
 setRoot ($a_root_id)
 Set root node. More...
 
 getRoot ()
 get root id More...
 
 setOrderColumn ($a_column)
 set the order column @access public More...
 
 setOrderDirection ($a_direction)
 set the order direction @access public More...
 
 setTargetGet ($a_target_get)
 set the varname in Get-string @access public More...
 
 setParamsGet ($a_params_get)
 set additional params to be passed in Get-string @access public More...
 
 setExpandTarget ($a_exp_target)
 target script for expand icons More...
 
 setFrameUpdater ($a_up_frame, $a_up_script, $a_params="")
 Set Explorer Updater. More...
 
 highlightNode ($a_id)
 set highlighted node More...
 
 checkPermissions ($a_check)
 check permissions via rbac More...
 
 setSessionExpandVariable ($a_var_name="expand")
 set name of expand session variable More...
 
 outputIcons ($a_icons)
 output icons More...
 
 setClickable ($a_type, $a_clickable)
 (de-)activates links for a certain object type More...
 
 isVisible ($a_ref_id, $a_type)
 
 setTreeLead ($a_val)
 Set tree leading content. More...
 
 getTreeLead ()
 Get tree leading content. More...
 
 isClickable ($a_type, $a_ref_id=0)
 check if links for certain object type are activated More...
 
 setPostSort ($a_sort)
 process post sorting More...
 
 setFilterMode ($a_mode=IL_FM_NEGATIVE)
 set filter mode More...
 
 getFilterMode ()
 get filter mode More...
 
 setUseStandardFrame ($a_val)
 Set use standard frame. More...
 
 getUseStandardFrame ()
 Get use standard explorer frame. More...
 
 getChildsOfNode ($a_parent_id)
 Get childs of node. More...
 
 setOutput ($a_parent_id, $a_depth=1, $a_obj_id=0, $a_highlighted_subtree=false)
 Creates output for explorer view in admin menue recursive method @access public. More...
 
 modifyChilds ($a_parent_id, $a_objects)
 
 showChilds ($a_parent_id)
 determines wether the childs of an object should be shown or not note: this standard implementation always returns true but it could be overwritten by derived classes (e.g. More...
 
 forceExpanded ($a_obj_id)
 force expansion of node More...
 
 getMaximumTreeDepth ()
 Get maximum tree depth. More...
 
 getOutput ()
 Creates output recursive method @access public. More...
 
 handleListEndTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
 handle list end tags ( and ) More...
 
 handleListStartTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
 handle list start tags ( More...
 
 formatHeader (&$tpl, $a_obj_id, $a_option)
 Creates output for header (is empty here but can be overwritten in derived classes) More...
 
 formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
 Creates output recursive method @access private. More...
 
 getImage ($a_name, $a_type="", $a_obj_id="")
 get image path (may be overwritten by derived classes) More...
 
 getImageAlt ($a_default_text, $a_type="", $a_obj_id="")
 get image alt text More...
 
 getNodeStyleClass ($a_id, $a_type)
 get style class for node More...
 
 buildLinkTarget ($a_node_id, $a_type)
 get link target (may be overwritten by derived classes) More...
 
 buildOnClick ($a_node_id, $a_type, $a_title)
 get onclick event handling (may be overwritten by derived classes) More...
 
 buildTitle ($a_title, $a_id, $a_type)
 standard implementation for title, may be overwritten by derived classes More...
 
 buildDescription ($a_desc, $a_id, $a_type)
 standard implementation for description, may be overwritten by derived classes More...
 
 buildSelect ($a_node_id, $a_type)
 standard implementation for adding an option select box between image and title More...
 
 buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
 get frame target (may be overwritten by derived classes) More...
 
 createTarget ($a_type, $a_node_id, $a_highlighted_subtree=false, $a_append_anch=true)
 Creates Get Parameter @access private. More...
 
 setFrameTarget ($a_target)
 set target frame or not frame? More...
 
 createLines ($a_depth)
 Creates lines for explorer view @access private. More...
 
 is_in_array ($a_start, $a_depth)
 DESCRIPTION MISSING @access private. More...
 
 getIndex ($a_data)
 get index of format_options array from specific ref_id,parent_id @access private More...
 
 addFilter ($a_item)
 adds item to the filter @access public More...
 
 delFilter ($a_item)
 removes item from the filter @access public More...
 
 setExpand ($a_node_id)
 set the expand option this value is stored in a SESSION variable to save it different view (lo view, frm view,...) @access private More...
 
 forceExpandAll ($a_mode, $a_show_minus=true)
 force expandAll. More...
 
 setFiltered ($a_bool)
 active/deactivate the filter @access public More...
 
 checkFilter ($a_item)
 check if item is in filter @access private More...
 
 sortNodes ($a_nodes, $a_parent_obj_id)
 sort nodes and put adm object to the end of sorted array @access private More...
 

Data Fields

 $root_id
 
 $output
 
 $ctrl
 
 $selectable_type
 
 $ref_id
 
- Data Fields inherited from ilExplorer
 $id
 
 $ilias
 
 $output
 
 $format_options
 
 $tree
 
 $target
 
 $target_get
 
 $params_get
 
 $expanded
 
 $order_column
 
 $order_direction = "asc"
 
 $expand_target
 
 $rbac_check
 
 $output_icons
 
 $expand_variable
 
 $is_clickable
 
 $post_sort
 
 $filtered = false
 
 $filter_mode
 
 $expand_all = false
 
 $root_id = null
 
 $use_standard_frame = false
 

Detailed Description

LM Menu Object Selector.

Author
Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de
Version
$Id$

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

Member Function Documentation

◆ buildFrameTarget()

ilLMMenuObjectSelector::buildFrameTarget (   $a_type,
  $a_child = 0,
  $a_obj_id = 0 
)

get frame target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 79 of file class.ilLMMenuObjectSelector.php.

80 {
81 return '';
82 }

◆ buildLinkTarget()

ilLMMenuObjectSelector::buildLinkTarget (   $a_node_id,
  $a_type 
)

get link target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 63 of file class.ilLMMenuObjectSelector.php.

64 {
65 if(in_array($a_type,$this->selectable_types))
66 {
67 $this->ctrl->setParameter($this->gui_obj,'link_ref_id',$a_node_id);
68 if ($_GET["menu_entry"] > 0)
69 {
70 return $this->ctrl->getLinkTarget($this->gui_obj,'editMenuEntry');
71 }
72 else
73 {
74 return $this->ctrl->getLinkTarget($this->gui_obj,'addMenuEntry');
75 }
76 }
77 }
$_GET["client_id"]

References $_GET.

◆ formatHeader()

ilLMMenuObjectSelector::formatHeader (   $a_obj_id,
  $a_option 
)

overwritten method from base class @access public

Parameters
integerobj_id
integerarray options
Returns
string

Definition at line 116 of file class.ilLMMenuObjectSelector.php.

117 {
118 global $lng, $ilias;
119
120 $tpl = new ilTemplate("tpl.tree.html", true, true, "Services/UIComponent/Explorer");
121
122 $tpl->setCurrentBlock("text");
123 $tpl->setVariable("OBJ_TITLE", $lng->txt("repository"));
124 $tpl->parseCurrentBlock();
125
126// $tpl->setCurrentBlock("row");
127// $tpl->parseCurrentBlock();
128
129 $this->output[] = $tpl->get();
130 }
global $tpl
Definition: ilias.php:8
special template class to simplify handling of ITX/PEAR
global $lng
Definition: privfeed.php:40

References ilExplorer\$ilias, $lng, and $tpl.

◆ ilLMMenuObjectSelector()

ilLMMenuObjectSelector::ilLMMenuObjectSelector (   $a_target,
$a_gui_obj 
)

Constructor @access public.

Parameters
stringscriptname
intuser_id

Definition at line 35 of file class.ilLMMenuObjectSelector.php.

36 {
37 global $tree,$ilCtrl;
38
39 $this->ctrl = $ilCtrl;
40
41 $this->gui_obj = $a_gui_obj;
42
43 parent::ilExplorer($a_target);
44 $this->tree = $tree;
45 $this->root_id = $this->tree->readRootId();
46 $this->order_column = "title";
47 $this->setSessionExpandVariable("lm_menu_expand");
48 $this->addFilter("rolf");
49 $this->addFilter("adm");
50 }
setSessionExpandVariable($a_var_name="expand")
set name of expand session variable
addFilter($a_item)
adds item to the filter @access public
global $ilCtrl
Definition: ilias.php:18

References $ilCtrl, ilExplorer\$tree, ilExplorer\addFilter(), and ilExplorer\setSessionExpandVariable().

+ Here is the call graph for this function:

◆ isClickable()

ilLMMenuObjectSelector::isClickable (   $a_type,
  $a_ref_id 
)

check if links for certain object type are activated

Parameters
string$a_typeobject type
Returns
boolean true if linking is activated

Reimplemented from ilExplorer.

Definition at line 84 of file class.ilLMMenuObjectSelector.php.

85 {//return true;
86 return in_array($a_type,$this->selectable_types) and $a_ref_id != $this->ref_id;
87 }

References $ref_id.

◆ setRefId()

ilLMMenuObjectSelector::setRefId (   $a_ref_id)

Definition at line 57 of file class.ilLMMenuObjectSelector.php.

58 {
59 $this->ref_id = $a_ref_id;
60 }

◆ setSelectableTypes()

ilLMMenuObjectSelector::setSelectableTypes (   $a_types)

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

53 {
54 $this->selectable_types = $a_types;
55 }

◆ showChilds()

ilLMMenuObjectSelector::showChilds (   $a_parent_id)

determines wether the childs of an object should be shown or not note: this standard implementation always returns true but it could be overwritten by derived classes (e.g.

ilRepositoryExplorerGUI)

Reimplemented from ilExplorer.

Definition at line 89 of file class.ilLMMenuObjectSelector.php.

90 {
91 global $rbacsystem;
92
93 if ($a_ref_id == 0)
94 {
95 return true;
96 }
97
98 if ($rbacsystem->checkAccess("read", $a_ref_id))
99 {
100 return true;
101 }
102 else
103 {
104 return false;
105 }
106 }

Field Documentation

◆ $ctrl

ilLMMenuObjectSelector::$ctrl

Definition at line 25 of file class.ilLMMenuObjectSelector.php.

◆ $output

ilLMMenuObjectSelector::$output

Definition at line 24 of file class.ilLMMenuObjectSelector.php.

◆ $ref_id

ilLMMenuObjectSelector::$ref_id

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

Referenced by isClickable().

◆ $root_id

ilLMMenuObjectSelector::$root_id

Definition at line 23 of file class.ilLMMenuObjectSelector.php.

◆ $selectable_type

ilLMMenuObjectSelector::$selectable_type

Definition at line 26 of file class.ilLMMenuObjectSelector.php.


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