ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilObjectSelector Class Reference
+ Inheritance diagram for ilObjectSelector:
+ Collaboration diagram for ilObjectSelector:

Public Member Functions

 ilObjectSelector ($a_target)
 
 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

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

Member Function Documentation

◆ buildFrameTarget()

ilObjectSelector::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 68 of file class.ilObjectSelector.php.

69 {
70 return '';
71 }

◆ buildLinkTarget()

ilObjectSelector::buildLinkTarget (   $a_node_id,
  $a_type 
)

get link target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

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

55 {
56 if($a_type == $this->selectable_type)
57 {
58 $this->ctrl->setParameterByClass('ilpaymentobjectgui','source_id',$a_node_id);
59 return $this->ctrl->getLinkTargetByClass('ilpaymentobjectgui','linkChilds');
60 }
61 else
62 {
63 $this->ctrl->setParameterByClass('ilrepositorygui',"ref_id",$this->ref_id);
64 return $this->ctrl->getLinkTargetByClass('ilrepositorygui','linkSelector');
65 }
66 }

◆ formatHeader()

ilObjectSelector::formatHeader (   $a_obj_id,
  $a_option 
)

overwritten method from base class @access public

Parameters
integera_obj_id
integerarray options
Returns
string

Definition at line 105 of file class.ilObjectSelector.php.

106 {
107 global $lng;
108
109 $tpl = new ilTemplate("tpl.tree.html", true, true, "Services/UIComponent/Explorer");
110
111 $tpl->setCurrentBlock("text");
112 $tpl->setVariable("OBJ_TITLE", $lng->txt("repository"));
113 $tpl->parseCurrentBlock();
114
115 $tpl->setCurrentBlock("row");
116 $tpl->parseCurrentBlock();
117
118 $this->output[] = $tpl->get();
119 }
global $tpl
Definition: ilias.php:8
special template class to simplify handling of ITX/PEAR
global $lng
Definition: privfeed.php:40

References $lng, and $tpl.

◆ ilObjectSelector()

ilObjectSelector::ilObjectSelector (   $a_target)
Parameters
$a_target

Definition at line 33 of file class.ilObjectSelector.php.

34 {
35 global $tree, $ilCtrl;
36
37 $this->ctrl = $ilCtrl;
38
39 parent::ilExplorer($a_target);
40 $this->tree = $tree;
41 $this->root_id = $this->tree->readRootId();
42 $this->order_column = "title";
43
44 $this->setSessionExpandVariable("paya_link_expand");
45
46 // add here all container objects
47 #$this->addFilter("root");
48 #$this->addFilter("cat");
49
50 #$this->setFilterMode(IL_FM_NEGATIVE);
51 $this->setFiltered(false);
52 }
setSessionExpandVariable($a_var_name="expand")
set name of expand session variable
setFiltered($a_bool)
active/deactivate the filter @access public
global $ilCtrl
Definition: ilias.php:18

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

+ Here is the call graph for this function:

◆ isClickable()

ilObjectSelector::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 73 of file class.ilObjectSelector.php.

74 {
75 return $a_type == $this->selectable_type and $a_ref_id != $this->ref_id;
76 }

References $ref_id.

◆ showChilds()

ilObjectSelector::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 78 of file class.ilObjectSelector.php.

79 {
80 global $rbacsystem;
81
82 if ($a_ref_id == 0)
83 {
84 return true;
85 }
86
87 if ($rbacsystem->checkAccess("read", $a_ref_id))
88 {
89 return true;
90 }
91 else
92 {
93 return false;
94 }
95 }

Field Documentation

◆ $ctrl

ilObjectSelector::$ctrl

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

◆ $output

ilObjectSelector::$output

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

◆ $ref_id

ilObjectSelector::$ref_id

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

Referenced by isClickable().

◆ $root_id

ilObjectSelector::$root_id

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

◆ $selectable_type

ilObjectSelector::$selectable_type

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


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