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

Data Fields

 $root_id
 $output
 $ctrl
 $selectable_type
 $ref_id
- Data Fields inherited from ilExplorer
 $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:
class.ilLMMenuObjectSelector.php 12658 2006-11-29 08:51:48Z akill

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

Member Function Documentation

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 91 of file class.ilLMMenuObjectSelector.php.

{
return '';
}
ilLMMenuObjectSelector::buildLinkTarget (   $a_node_id,
  $a_type 
)

get link target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

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

{
if(in_array($a_type,$this->selectable_types))
{
$this->ctrl->setParameter($this->gui_obj,'link_ref_id',$a_node_id);
return $this->ctrl->getLinkTarget($this->gui_obj,'addMenuEntry');
}
}
ilLMMenuObjectSelector::formatHeader (   $a_obj_id,
  $a_option 
)

overwritten method from base class public

Parameters
integerobj_id
integerarray options
Returns
string

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

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

{
global $lng, $ilias;
$tpl = new ilTemplate("tpl.tree.html", true, true);
$tpl->setCurrentBlock("text");
$tpl->setVariable("OBJ_TITLE", $lng->txt("repository"));
$tpl->parseCurrentBlock();
$tpl->setCurrentBlock("row");
$tpl->parseCurrentBlock();
$this->output[] = $tpl->get();
}
ilLMMenuObjectSelector::ilLMMenuObjectSelector (   $a_target,
$a_gui_obj 
)

Constructor public.

Parameters
stringscriptname
intuser_id

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

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

{
global $tree,$ilCtrl;
$this->ctrl = $ilCtrl;
$this->gui_obj = $a_gui_obj;
parent::ilExplorer($a_target);
$this->tree = $tree;
$this->root_id = $this->tree->readRootId();
$this->order_column = "title";
$this->setSessionExpandVariable("lm_menu_expand");
$this->addFilter("rolf");
$this->addFilter("adm");
}

+ Here is the call graph for this function:

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 96 of file class.ilLMMenuObjectSelector.php.

References $ref_id.

{//return true;
return in_array($a_type,$this->selectable_types) and $a_ref_id != $this->ref_id;
}
ilLMMenuObjectSelector::setRefId (   $a_ref_id)

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

{
$this->ref_id = $a_ref_id;
}
ilLMMenuObjectSelector::setSelectableTypes (   $a_types)

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

{
$this->selectable_types = $a_types;
}
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 101 of file class.ilLMMenuObjectSelector.php.

{
global $rbacsystem;
if ($a_ref_id == 0)
{
return true;
}
if ($rbacsystem->checkAccess("read", $a_ref_id))
{
return true;
}
else
{
return false;
}
}

Field Documentation

ilLMMenuObjectSelector::$ctrl

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

ilLMMenuObjectSelector::$output

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

ilLMMenuObjectSelector::$ref_id

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

Referenced by isClickable().

ilLMMenuObjectSelector::$root_id

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

ilLMMenuObjectSelector::$selectable_type

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


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