ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilRoleTableGUI Class Reference

TableGUI for the presentation og roles and role templates. More...

+ Inheritance diagram for ilRoleTableGUI:
+ Collaboration diagram for ilRoleTableGUI:

Public Member Functions

 __construct ($a_parent_gui, $a_parent_cmd)
 Constructor. More...
 
 setType ($a_type)
 Set table type. More...
 
 setRoleTitleFilter ($a_filter)
 Set role title filter. More...
 
 getRoleTitleFilter ()
 Get role title filter. More...
 
 getType ()
 Get table type. More...
 
 init ()
 Init table. More...
 
 initFilter ()
 Init filter. More...
 
 fillRow ($set)
 
 parse ($role_folder_id)
 Parse role list. More...
 
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 Constructor. More...
 
 setOpenFormTag ($a_val)
 Set open form tag. More...
 
 getOpenFormTag ()
 Get open form tag. More...
 
 setCloseFormTag ($a_val)
 Set close form tag. More...
 
 getCloseFormTag ()
 Get close form tag. More...
 
 determineLimit ()
 Determine the limit. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 Determine selected columns. More...
 
 isColumnSelected ($a_col)
 Is given column selected? More...
 
 getSelectedColumns ()
 Get selected columns. More...
 
 executeCommand ()
 Execute command. More...
 
 resetOffset ($a_in_determination=false)
 Reset offset. More...
 
 initFilter ()
 Init filter. More...
 
 getParentObject ()
 Get parent object. More...
 
 getParentCmd ()
 Get parent command. More...
 
 setTopAnchor ($a_val)
 Set top anchor. More...
 
 getTopAnchor ()
 Get top anchor. More...
 
 setNoEntriesText ($a_text)
 Set text for an empty table. More...
 
 getNoEntriesText ()
 Get text for an empty table. More...
 
 setIsDataTable ($a_val)
 Set is data table. More...
 
 getIsDataTable ()
 Get is data table. More...
 
 setEnableTitle ($a_enabletitle)
 Set Enable Title. More...
 
 getEnableTitle ()
 Get Enable Title. More...
 
 setEnableHeader ($a_enableheader)
 Set Enable Header. More...
 
 getEnableHeader ()
 Get Enable Header. More...
 
 setEnableNumInfo ($a_val)
 Set enable num info. More...
 
 getEnableNumInfo ()
 Get enable num info. More...
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setOrderField ($a_order_field)
 set order column More...
 
 getOrderField ()
 
 setData ($a_data)
 
 getData ()
 
 dataExists ()
 
 setPrefix ($a_prefix)
 
 getPrefix ()
 
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item. More...
 
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
 Add filter by standard type. More...
 
 getFilterItems ($a_optionals=false)
 Get filter items. More...
 
 getFilterItemByPostVar ($a_post_var)
 
 setFilterCols ($a_val)
 Set filter columns. More...
 
 getFilterCols ()
 Get filter columns. More...
 
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding. More...
 
 getDisableFilterHiding ()
 Get disable filter hiding. More...
 
 isFilterSelected ($a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 Get selected filters. More...
 
 determineSelectedFilters ()
 Determine selected filters. More...
 
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links. More...
 
 setFormAction ($a_form_action, $a_multipart=false)
 Set Form action parameter. More...
 
 getFormAction ()
 Get Form action parameter. More...
 
 setFormName ($a_formname="")
 Set Form name. More...
 
 getFormName ()
 Get Form name. More...
 
 setId ($a_val)
 Set id. More...
 
 getId ()
 Get element id. More...
 
 setDisplayAsBlock ($a_val)
 Set display as block. More...
 
 getDisplayAsBlock ()
 Get display as block. More...
 
 getSelectAllCheckbox ()
 Get the name of the checkbox that should be toggled with a select all button. More...
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 Set the name of the checkbox that should be toggled with a select all button. More...
 
 setExternalSorting ($a_val)
 Set external sorting. More...
 
 getExternalSorting ()
 Get external sorting. More...
 
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 setDefaultFilterVisiblity ($a_status)
 Set default filter visiblity. More...
 
 getDefaultFilterVisibility ()
 Get default filter visibility. More...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButtonBase $a_button)
 Add Command button instance. More...
 
 addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button. More...
 
 addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button for selected items. More...
 
 setCloseCommand ($a_link)
 Add command for closing table. More...
 
 addMultiCommand ($a_cmd, $a_text)
 Add Command button. More...
 
 addHiddenInput ($a_name, $a_value)
 Add Hidden Input field. More...
 
 addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
 Add Header Command (Link) (Image needed for now) More...
 
 setTopCommands ($a_val)
 Set top commands (display command buttons on top of table, too) More...
 
 getTopCommands ()
 Get top commands (display command buttons on top of table, too) More...
 
 addColumn ($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
 Add a column to the header. More...
 
 getNavParameter ()
 
 setOrderLink ($sort_field, $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order. More...
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 render ()
 render table public More...
 
 writeFilterToSession ()
 Write filter values to session. More...
 
 resetFilter ()
 Reset filter. More...
 
 fillFooter ()
 Fill footer row. More...
 
 getLinkbar ($a_num)
 Get previous/next linkbar. More...
 
 fillHiddenRow ()
 
 fillActionRow ()
 Fill Action Row. More...
 
 setHeaderHTML ($html)
 set header html More...
 
 storeProperty ($type, $value)
 Store table property. More...
 
 loadProperty ($type)
 Load table property. More...
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext ($id)
 Set context. More...
 
 getContext ()
 Get context. More...
 
 setShowRowsSelector ($a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 Get rows-per-page selector state. More...
 
 setShowTemplates ($a_value)
 Toggle templates. More...
 
 getShowTemplates ()
 Get template state. More...
 
 restoreTemplate ($a_name)
 Restore state from template. More...
 
 saveTemplate ($a_name)
 Save current state as template. More...
 
 deleteTemplate ($a_name)
 Delete template. More...
 
 getLimit ()
 Get limit. More...
 
 getOffset ()
 Get offset. More...
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode ($a_value=false)
 Toogle print mode. More...
 
 getPrintMode ()
 Get print mode. More...
 
 getExportMode ()
 Was export activated? More...
 
 exportData ($format, $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result. More...
 
 setRowSelectorLabel ($row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission ($a_val)
 Set prevent double submission. More...
 
 getPreventDoubleSubmission ()
 Get prevent double submission. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 
- Public Member Functions inherited from ilTableGUI
 __construct ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate ($a_tpl)
 set template public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page public More...
 
 setHeaderNames ($a_header_names)
 set table header names public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars public More...
 
 setColumnWidth ($a_column_width)
 set table column widths public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width public More...
 
 setMaxCount ($a_max_count)
 set max. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
 getLimit ()
 Get limit. More...
 
 setPrefix ($a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) public More...
 
 setOffset ($a_offset)
 set dataset offset public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction public More...
 
 enable ($a_module_name)
 enables particular modules of table More...
 
 disable ($a_module_name)
 diesables particular modules of table More...
 
 sortData ()
 
 render ()
 render table public More...
 
 renderHeader ()
 
 setOrderLink ($key, $order_dir)
 
 setStyle ($a_element, $a_style)
 
 getStyle ($a_element)
 
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds). More...
 
 getBase ()
 Get Base script name (deprecated, only use this for workarounds). More...
 
 getFormName ()
 
 setFormName ($a_name="cmd")
 
 getSelectAllCheckbox ()
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton ($btn_name, $btn_value)
 

Data Fields

const TYPE_GLOBAL_AU = 1
 
const TYPE_GLOBAL_UD = 2
 
const TYPE_LOCAL_AU = 3
 
const TYPE_LOCAL_UD = 4
 
const TYPE_ROLT_AU = 5
 
const TYPE_ROLT_UD = 6
 
const TYPE_VIEW = 1
 
const TYPE_SEARCH = 2
 
- Data Fields inherited from ilTable2GUI
const FILTER_TEXT = 1
 
const FILTER_SELECT = 2
 
const FILTER_DATE = 3
 
const FILTER_LANGUAGE = 4
 
const FILTER_NUMBER_RANGE = 5
 
const FILTER_DATE_RANGE = 6
 
const FILTER_DURATION_RANGE = 7
 
const FILTER_DATETIME_RANGE = 8
 
const EXPORT_EXCEL = 1
 
const EXPORT_CSV = 2
 
const ACTION_ALL_LIMIT = 1000
 
- Data Fields inherited from ilTableGUI
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 

Protected Member Functions

 getPathGUI ()
 Get path gui. More...
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 isFilterVisible ()
 Check if filter is visible: manually shown (session, db) or default value set. More...
 
 isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel (ilExcel $a_excel, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel (ilExcel $a_excel, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

Private Attributes

 $path_gui = null
 
 $type = self::TYPE_VIEW
 
 $role_title_filter = ''
 
 $role_folder_id = 0
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- Protected Attributes inherited from ilTable2GUI
 $close_command = ""
 
 $top_anchor = "il_table_top"
 
 $filters = array()
 
 $optional_filters = array()
 
 $filter_cmd = 'applyFilter'
 
 $reset_cmd = 'resetFilter'
 
 $filter_cols = 5
 
 $ext_sort = false
 
 $ext_seg = false
 
 $context = ""
 
 $mi_sel_buttons = null
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $rows_selector_off = false
 
 $nav_determined = false
 
 $limit_determined = false
 
 $filters_determined = false
 
 $columns_determined = false
 
 $open_form_tag = true
 
 $close_form_tag = true
 
 $export_formats
 
 $export_mode
 
 $print_mode
 
 $enable_command_for_all
 
 $restore_filter
 
 $restore_filter_values
 
 $default_filter_visibility = false
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

Detailed Description

TableGUI for the presentation og roles and role templates.

Author
Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 14 of file class.ilRoleTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilRoleTableGUI::__construct (   $a_parent_gui,
  $a_parent_cmd 
)

Constructor.

Parameters
object$a_parent_gui
string$a_parent_cmd

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

References $ilCtrl, and ilTable2GUI\setId().

39  {
40  global $ilCtrl;
41 
42  $this->ctrl = $ilCtrl;
43 
44  $this->setId('rolf_role_tbl');
45 
46  parent::__construct($a_parent_gui, $a_parent_cmd);
47  $this->lng->loadLanguageModule('rbac');
48  $this->lng->loadLanguageModule('search');
49  }
setId($a_val)
Set id.
global $ilCtrl
Definition: ilias.php:18
+ Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilRoleTableGUI::fillRow (   $set)
Parameters
array$set

if((substr($set['title_orig'],0,3) == 'il_') and ($set['type'] == 'rolt')) { $this->tpl->setVariable('VAL_PRE',$this->lng->txt('predefined_template')); }

Definition at line 212 of file class.ilRoleTableGUI.php.

References $GLOBALS, ilTable2GUI\getParentObject(), getPathGUI(), and getType().

213  {
214  global $rbacreview,$tree;
215 
216  if($set['type'] == 'role')
217  {
218  if($set['parent'] != ROLE_FOLDER_ID)
219  {
220  $this->ctrl->setParameterByClass(
221  "ilobjrolegui",
222  "rolf_ref_id",
223  $set['parent']
224  );
225  }
226 
227  $this->ctrl->setParameterByClass("ilobjrolegui", "obj_id", $set["obj_id"]);
228  $link = $this->ctrl->getLinkTargetByClass("ilobjrolegui", "perm");
229  $this->ctrl->setParameterByClass("ilobjrolegui", "rolf_ref_id", "");
230  }
231  else
232  {
233  $this->ctrl->setParameterByClass("ilobjroletemplategui", "obj_id", $set["obj_id"]);
234  $link = $this->ctrl->getLinkTargetByClass("ilobjroletemplategui", "perm");
235  }
236 
237  switch($set['rtype'])
238  {
239  case self::TYPE_GLOBAL_AU:
240  $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_auto_global'));
241  break;
242  case self::TYPE_GLOBAL_UD:
243  $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_ud_global'));
244  break;
245  case self::TYPE_LOCAL_AU:
246  $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_auto_local'));
247  break;
248  case self::TYPE_LOCAL_UD:
249  $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_ud_local'));
250  break;
251  case self::TYPE_ROLT_AU:
252  $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_auto_rolt'));
253  break;
254  case self::TYPE_ROLT_UD:
255  $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_ud_rolt'));
256  break;
257  }
258 
259 
260 
261  if(
262  ($set['obj_id'] != ANONYMOUS_ROLE_ID and
263  $set['obj_id'] != SYSTEM_ROLE_ID and
264  substr($set['title_orig'],0,3) != 'il_') or
265  $this->getType() == self::TYPE_SEARCH)
266  {
267  $this->tpl->setVariable('VAL_ID', $set['obj_id']);
268  }
269  $this->tpl->setVariable('VAL_TITLE_LINKED', $set['title']);
270  $this->tpl->setVariable('VAL_LINK', $link);
271  if(strlen($set['description']))
272  {
273  $this->tpl->setVariable('VAL_DESC', $set['description']);
274  }
275 
283  $ref = $set['parent'];
284  if($ref == ROLE_FOLDER_ID)
285  {
286  $this->tpl->setVariable('CONTEXT', $this->lng->txt('rbac_context_global'));
287  }
288  else
289  {
290  $this->tpl->setVariable(
291  'CONTEXT',
292  (string) $this->getPathGUI()->getPath(ROOT_FOLDER_ID,$ref)
293  );
294  }
295 
296  if($this->getType() == self::TYPE_VIEW and $set['obj_id'] != SYSTEM_ROLE_ID)
297  {
298  if($GLOBALS['rbacsystem']->checkAccess('write',$this->role_folder_id))
299  {
300  // Copy role
301  $this->tpl->setVariable('COPY_TEXT',$this->lng->txt('rbac_role_rights_copy'));
302  $this->ctrl->setParameter($this->getParentObject(), "copy_source", $set["obj_id"]);
303  $link = $this->ctrl->getLinkTarget($this->getParentObject(),'roleSearch');
304  $this->tpl->setVariable(
305  'COPY_LINK',
306  $link
307  );
308  }
309  }
310 
311  }
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
getParentObject()
Get parent object.
getType()
Get table type.
getPathGUI()
Get path gui.
+ Here is the call graph for this function:

◆ getPathGUI()

ilRoleTableGUI::getPathGUI ( )
protected

Get path gui.

Returns
ilPathGUI $path

Definition at line 90 of file class.ilRoleTableGUI.php.

References $path_gui.

Referenced by fillRow(), and init().

91  {
92  return $this->path_gui;
93  }
+ Here is the caller graph for this function:

◆ getRoleTitleFilter()

ilRoleTableGUI::getRoleTitleFilter ( )

Get role title filter.

Returns
string

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

References $role_title_filter.

Referenced by parse().

74  {
76  }
+ Here is the caller graph for this function:

◆ getType()

ilRoleTableGUI::getType ( )

Get table type.

Definition at line 81 of file class.ilRoleTableGUI.php.

References $type.

Referenced by fillRow(), init(), initFilter(), and parse().

82  {
83  return $this->type;
84  }
+ Here is the caller graph for this function:

◆ init()

ilRoleTableGUI::init ( )

Init table.

Definition at line 100 of file class.ilRoleTableGUI.php.

References $GLOBALS, ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ilTableGUI\disable(), ilTable2GUI\getParentObject(), getPathGUI(), getType(), initFilter(), object, ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFormAction(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTitle().

101  {
102  $this->addColumn('','f','1px');
103 
104  switch($this->getType())
105  {
106  case self::TYPE_VIEW:
107  $this->setShowRowsSelector(true);
108  $this->setDefaultOrderField('title');
109  $this->setDefaultOrderDirection('asc');
110  //$this->setId('rolf_role_tbl');
111  $this->addColumn($this->lng->txt('search_title_description'),'title','30%');
112  $this->addColumn($this->lng->txt('type'),'rtype','20%');
113  $this->addColumn($this->lng->txt('context'),'','40%');
114  $this->addColumn($this->lng->txt('actions'),'','10%');
115  $this->setTitle($this->lng->txt('objs_role'));
116 
117  if($GLOBALS['rbacsystem']->checkAccess('delete', $this->getParentObject()->object->getRefId()))
118  {
119  $this->addMultiCommand('confirmDelete',$this->lng->txt('delete'));
120  }
121  break;
122 
123  case self::TYPE_SEARCH:
124  $this->setShowRowsSelector(true);
125  $this->disable('sort');
126  //$this->setId('rolf_role_search_tbl');
127  $this->addColumn($this->lng->txt('search_title_description'),'title','30%');
128  $this->addColumn($this->lng->txt('type'),'rtype','20%');
129  $this->addColumn($this->lng->txt('context'),'','50%');
130  $this->setTitle($this->lng->txt('rbac_role_rights_copy'));
131  $this->addMultiCommand('chooseCopyBehaviour',$this->lng->txt('btn_next'));
132  $this->addCommandButton('roleSearch', $this->lng->txt('btn_previous'));
133  break;
134  }
135 
136 
137  $this->setRowTemplate('tpl.role_row.html','Services/AccessControl');
138  $this->setFormAction($this->ctrl->getFormAction($this->getParentObject()));
139  $this->setSelectAllCheckbox('roles');
140 
141  include_once './Services/Tree/classes/class.ilPathGUI.php';
142  $this->path_gui = new ilPathGUI();
143  $this->getPathGUI()->enableTextOnly(false);
144  $this->getPathGUI()->enableHideLeaf(FALSE);
145 
146 
147  // Filter initialisation
148 
149  if($this->getType() == self::TYPE_VIEW)
150  {
151  $this->initFilter();
152  }
153  }
addCommandButton($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
Add Command button.
Creates a path for a start and endnode.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
getParentObject()
Get parent object.
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
addMultiCommand($a_cmd, $a_text)
Add Command button.
getType()
Get table type.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
disable($a_module_name)
diesables particular modules of table
initFilter()
Init filter.
Create new PHPExcel object
obj_idprivate
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
setSelectAllCheckbox($a_select_all_checkbox)
Set the name of the checkbox that should be toggled with a select all button.
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
getPathGUI()
Get path gui.
+ Here is the call graph for this function:

◆ initFilter()

ilRoleTableGUI::initFilter ( )

Init filter.

Definition at line 158 of file class.ilRoleTableGUI.php.

References ilTableGUI\$title, ilTable2GUI\addFilterItem(), ilRbacReview\FILTER_ALL, ilRbacReview\FILTER_ALL_GLOBAL, ilRbacReview\FILTER_ALL_LOCAL, ilRbacReview\FILTER_INTERNAL, ilRbacReview\FILTER_NOT_INTERNAL, ilRbacReview\FILTER_TEMPLATES, getType(), ilTable2GUI\setDisableFilterHiding(), and ilSelectInputGUI\setOptions().

Referenced by init().

159  {
160  $this->setDisableFilterHiding(true);
161 
162  switch($this->getType())
163  {
164  case self::TYPE_VIEW:
165  $action[ilRbacReview::FILTER_ALL] = $this->lng->txt('all_roles');
166  $action[ilRbacReview::FILTER_ALL_GLOBAL] = $this->lng->txt('all_global_roles');
167  $action[ilRbacReview::FILTER_ALL_LOCAL] = $this->lng->txt('all_local_roles');
168  $action[ilRbacReview::FILTER_INTERNAL] = $this->lng->txt('internal_local_roles_only');
169  $action[ilRbacReview::FILTER_NOT_INTERNAL] = $this->lng->txt('non_internal_local_roles_only');
170  $action[ilRbacReview::FILTER_TEMPLATES] = $this->lng->txt('role_templates_only');
171  break;
172 
173  case self::TYPE_SEARCH:
174  $action[ilRbacReview::FILTER_ALL] = $this->lng->txt('all_roles');
175  $action[ilRbacReview::FILTER_ALL_GLOBAL] = $this->lng->txt('all_global_roles');
176  $action[ilRbacReview::FILTER_ALL_LOCAL] = $this->lng->txt('all_local_roles');
177  $action[ilRbacReview::FILTER_INTERNAL] = $this->lng->txt('internal_local_roles_only');
178  $action[ilRbacReview::FILTER_NOT_INTERNAL] = $this->lng->txt('non_internal_local_roles_only');
179  break;
180  }
181 
182  include_once './Services/Form/classes/class.ilSelectInputGUI.php';
183  $roles = new ilSelectInputGUI($this->lng->txt('rbac_role_selection'), 'role_type');
184 
185  $roles->setOptions($action);
186 
187  $this->addFilterItem($roles);
188 
189  $roles->readFromSession();
190  if(!$roles->getValue())
191  {
192  $roles->setValue(ilRbacReview::FILTER_ALL_GLOBAL);
193  }
194 
195  // title filter
196  include_once './Services/Form/classes/class.ilTextInputGUI.php';
197  $title = new ilTextInputGUI($this->lng->txt('title'), 'role_title');
198  $title->setSize(16);
199  $title->setMaxLength(64);
200 
201  $this->addFilterItem($title);
202  $title->readFromSession();
203 
204  $this->filter['role_type'] = $roles->getValue();
205  $this->filter['role_title'] = $title->getValue();
206  }
This class represents a selection list property in a property form.
addFilterItem($a_input_item, $a_optional=false)
Add filter item.
setDisableFilterHiding($a_val=true)
Set disable filter hiding.
This class represents a text property in a property form.
getType()
Get table type.
setOptions($a_options)
Set Options.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parse()

ilRoleTableGUI::parse (   $role_folder_id)

Parse role list.

Parameters
array$role_list

Definition at line 317 of file class.ilRoleTableGUI.php.

References $counter, $GLOBALS, $ilUser, $role_folder_id, ilTableGUI\$title, $type, ilObjRole\_getTranslation(), array, ilRbacReview\FILTER_ALL, ilRbacReview\FILTER_INTERNAL, ilTable2GUI\getFilterItemByPostVar(), getRoleTitleFilter(), getType(), ilTable2GUI\setData(), and ilTableGUI\setMaxCount().

318  {
319  global $rbacreview,$ilUser;
320 
321  $this->role_folder_id = $role_folder_id;
322 
323  include_once './Services/AccessControl/classes/class.ilObjRole.php';
324 
325  if($this->getType() == self::TYPE_VIEW)
326  {
327  $filter_orig = $filter = $this->getFilterItemByPostVar('role_title')->getValue();
328  $type = $this->getFilterItemByPostVar('role_type')->getValue();
329  }
330  else
331  {
332  $filter_orig = $filter = $this->getRoleTitleFilter();
334  }
335 
336 
337  // the translation must be filtered
339  {
340  // roles like il_crs_... are filtered manually
341  $filter = '';
342  }
343 
344  $role_list = $rbacreview->getRolesByFilter(
345  $type,
346  0,
347  $filter
348  );
349 
350  $counter = 0;
351  $rows = array();
352  foreach((array) $role_list as $role)
353  {
354  if(
355  $role['parent'] and
356  (
357  $GLOBALS['tree']->isDeleted($role['parent']) or
358  !$GLOBALS['tree']->isInTree($role['parent'])
359  )
360  )
361  {
362  continue;
363  }
364 
365  $title = ilObjRole::_getTranslation($role['title']);
367  {
368  if(strlen($filter_orig))
369  {
370  if(stristr($title, $filter_orig) == FALSE)
371  {
372  continue;
373  }
374  }
375  }
376 
377 
378  $rows[$counter]['title_orig'] = $role['title'];
379  $rows[$counter]['title'] = $title;
380  $rows[$counter]['description'] = $role['description'];
381  $rows[$counter]['obj_id'] = $role['obj_id'];
382  $rows[$counter]['parent'] = $role['parent'];
383  $rows[$counter]['type'] = $role['type'];
384 
385  $auto = (substr($role['title'], 0, 3) == 'il_' ? true : false);
386 
387 
388  // Role templates
389  if($role['type'] == 'rolt')
390  {
391  $rows[$counter]['rtype'] = $auto ? self::TYPE_ROLT_AU : self::TYPE_ROLT_UD;
392  }
393  else
394  {
395  // Roles
396  if($role['parent'] == ROLE_FOLDER_ID)
397  {
398  if($role['obj_id'] == ANONYMOUS_ROLE_ID or $role['obj_id'] == SYSTEM_ROLE_ID)
399  {
400  $rows[$counter]['rtype'] = self::TYPE_GLOBAL_AU;
401  }
402  else
403  {
404  $rows[$counter]['rtype'] = self::TYPE_GLOBAL_UD;
405  }
406  }
407  else
408  {
409  $rows[$counter]['rtype'] = $auto ? self::TYPE_LOCAL_AU : self::TYPE_LOCAL_UD;
410  }
411  }
412 
413  ++$counter;
414  }
415  $this->setMaxCount(count($rows));
416  $this->setData($rows);
417  }
getRoleTitleFilter()
Get role title filter.
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
getFilterItemByPostVar($a_post_var)
$counter
$ilUser
Definition: imgupload.php:18
getType()
Get table type.
static _getTranslation($a_role_title)
Create styles array
The data for the language used.
setMaxCount($a_max_count)
set max.
+ Here is the call graph for this function:

◆ setRoleTitleFilter()

ilRoleTableGUI::setRoleTitleFilter (   $a_filter)

Set role title filter.

Parameters
string$a_filter

Definition at line 64 of file class.ilRoleTableGUI.php.

65  {
66  $this->role_title_filter = $a_filter;
67  }

◆ setType()

ilRoleTableGUI::setType (   $a_type)

Set table type.

Parameters
int$a_type

Definition at line 55 of file class.ilRoleTableGUI.php.

References $a_type.

56  {
57  $this->type = $a_type;
58  }
$a_type
Definition: workflow.php:93

Field Documentation

◆ $path_gui

ilRoleTableGUI::$path_gui = null
private

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

Referenced by getPathGUI().

◆ $role_folder_id

ilRoleTableGUI::$role_folder_id = 0
private

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

Referenced by parse().

◆ $role_title_filter

ilRoleTableGUI::$role_title_filter = ''
private

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

Referenced by getRoleTitleFilter().

◆ $type

ilRoleTableGUI::$type = self::TYPE_VIEW
private

Definition at line 29 of file class.ilRoleTableGUI.php.

Referenced by getType(), and parse().

◆ TYPE_GLOBAL_AU

const ilRoleTableGUI::TYPE_GLOBAL_AU = 1

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

◆ TYPE_GLOBAL_UD

const ilRoleTableGUI::TYPE_GLOBAL_UD = 2

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

◆ TYPE_LOCAL_AU

const ilRoleTableGUI::TYPE_LOCAL_AU = 3

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

◆ TYPE_LOCAL_UD

const ilRoleTableGUI::TYPE_LOCAL_UD = 4

Definition at line 19 of file class.ilRoleTableGUI.php.

◆ TYPE_ROLT_AU

const ilRoleTableGUI::TYPE_ROLT_AU = 5

Definition at line 20 of file class.ilRoleTableGUI.php.

◆ TYPE_ROLT_UD

const ilRoleTableGUI::TYPE_ROLT_UD = 6

Definition at line 21 of file class.ilRoleTableGUI.php.

◆ TYPE_SEARCH

const ilRoleTableGUI::TYPE_SEARCH = 2

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

Referenced by ilObjRoleFolderGUI\roleSearchListObject().

◆ TYPE_VIEW

const ilRoleTableGUI::TYPE_VIEW = 1

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


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