ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilRoleDesktopItemSelector Class Reference
+ Inheritance diagram for ilRoleDesktopItemSelector:
+ Collaboration diagram for ilRoleDesktopItemSelector:

Public Member Functions

 __construct ($a_target, $role_desk_item_obj)
 Constructor public. More...
 
 buildLinkTarget ($a_node_id, $a_type)
 
 buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
 
 isClickable ($a_type, $a_ref_id=0)
 
 showChilds ($a_ref_id)
 
 formatHeader ($tpl, $a_obj_id, $a_option)
 overwritten method from base class public More...
 
- Public Member Functions inherited from ilExplorer
 __construct ($a_target)
 Constructor 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 public More...
 
 setOrderDirection ($a_direction)
 set the order direction public More...
 
 setTargetGet ($a_target_get)
 set the varname in Get-string public More...
 
 setParamsGet ($a_params_get)
 set additional params to be passed in Get-string 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 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 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 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 private. More...
 
 setFrameTarget ($a_target)
 set target frame or not frame? More...
 
 createLines ($a_depth)
 Creates lines for explorer view private. More...
 
 is_in_array ($a_start, $a_depth)
 DESCRIPTION MISSING private. More...
 
 getIndex ($a_data)
 get index of format_options array from specific ref_id,parent_id private More...
 
 addFilter ($a_item)
 adds item to the filter public More...
 
 delFilter ($a_item)
 removes item from the filter 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,...) private More...
 
 forceExpandAll ($a_mode, $a_show_minus=true)
 force expandAll. More...
 
 setFiltered ($a_bool)
 active/deactivate the filter public More...
 
 checkFilter ($a_item)
 check if item is in filter private More...
 
 sortNodes ($a_nodes, $a_parent_obj_id)
 sort nodes and put adm object to the end of sorted array private More...
 

Data Fields

 $role_desk_obj = null
 
 $root_id
 
 $output
 
 $ctrl
 
 $selectable_type
 
 $ref_id
 
- Data Fields inherited from ilExplorer
 $id
 
 $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
 

Additional Inherited Members

- Protected Attributes inherited from ilExplorer
 $obj_definition
 
 $error
 
 $rbacsystem
 
 $tpl
 
 $lng
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilRoleDesktopItemSelector::__construct (   $a_target,
  $role_desk_item_obj 
)

Constructor public.

Parameters
stringscriptname
intuser_id

Definition at line 38 of file class.ilRoleDesktopItemSelector.php.

References $DIC, $ilCtrl, ilExplorer\$tree, ilExplorer\addFilter(), IL_FM_NEGATIVE, ilExplorer\setFiltered(), ilExplorer\setFilterMode(), ilExplorer\setSessionExpandVariable(), ilExplorer\setTitleLength(), and ilObject\TITLE_LENGTH.

39  {
40  global $DIC;
41 
42  $tree = $DIC['tree'];
43  $ilCtrl = $DIC['ilCtrl'];
44 
45  $this->ctrl = $ilCtrl;
46 
47  $this->role_desk_obj = &$role_desk_item_obj;
48 
49  parent::__construct($a_target);
50  $this->tree = $tree;
51  $this->root_id = $this->tree->readRootId();
52  $this->order_column = "title";
53 
54  $this->setSessionExpandVariable("role_desk_item_link_expand");
55 
56  $this->addFilter("adm");
57  $this->addFilter("rolf");
58  #$this->addFilter("chat");
59  #$this->addFilter('fold');
60 
62  $this->setFiltered(true);
63 
65  }
setFilterMode($a_mode=IL_FM_NEGATIVE)
set filter mode
global $DIC
Definition: saml.php:7
const TITLE_LENGTH
max length of object title
setTitleLength($a_length)
Set max title length.
setFiltered($a_bool)
active/deactivate the filter public
global $ilCtrl
Definition: ilias.php:18
setSessionExpandVariable($a_var_name="expand")
set name of expand session variable
addFilter($a_item)
adds item to the filter public
const IL_FM_NEGATIVE
+ Here is the call graph for this function:

Member Function Documentation

◆ buildFrameTarget()

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

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

74  {
75  return '';
76  }

◆ buildLinkTarget()

ilRoleDesktopItemSelector::buildLinkTarget (   $a_node_id,
  $a_type 
)

Definition at line 67 of file class.ilRoleDesktopItemSelector.php.

68  {
69  $this->ctrl->setParameterByClass('ilobjrolegui', 'item_id', $a_node_id);
70  return $this->ctrl->getLinkTargetByClass('ilobjrolegui', 'assignDesktopItem');
71  }

◆ formatHeader()

ilRoleDesktopItemSelector::formatHeader (   $tpl,
  $a_obj_id,
  $a_option 
)

overwritten method from base class public

Parameters
integerobj_id
integerarray options
Returns
string

Definition at line 107 of file class.ilRoleDesktopItemSelector.php.

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

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

◆ isClickable()

ilRoleDesktopItemSelector::isClickable (   $a_type,
  $a_ref_id = 0 
)

Definition at line 78 of file class.ilRoleDesktopItemSelector.php.

References $DIC, and ilExplorer\$rbacsystem.

79  {
80  global $DIC;
81 
82  $rbacsystem = $DIC['rbacsystem'];
83 
84  return $rbacsystem->checkAccess('write', $a_ref_id) and !$this->role_desk_obj->isAssigned($a_ref_id);
85  }
global $DIC
Definition: saml.php:7

◆ showChilds()

ilRoleDesktopItemSelector::showChilds (   $a_ref_id)

Definition at line 87 of file class.ilRoleDesktopItemSelector.php.

References $DIC, and ilExplorer\$rbacsystem.

88  {
89  global $DIC;
90 
91  $rbacsystem = $DIC['rbacsystem'];
92 
93  if ($a_ref_id) {
94  return $rbacsystem->checkAccess('read', $a_ref_id);
95  }
96  return true;
97  }
global $DIC
Definition: saml.php:7

Field Documentation

◆ $ctrl

ilRoleDesktopItemSelector::$ctrl

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

◆ $output

ilRoleDesktopItemSelector::$output

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

◆ $ref_id

ilRoleDesktopItemSelector::$ref_id

Definition at line 31 of file class.ilRoleDesktopItemSelector.php.

◆ $role_desk_obj

ilRoleDesktopItemSelector::$role_desk_obj = null

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

◆ $root_id

ilRoleDesktopItemSelector::$root_id

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

◆ $selectable_type

ilRoleDesktopItemSelector::$selectable_type

Definition at line 30 of file class.ilRoleDesktopItemSelector.php.


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