ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
All Data Structures Namespaces Files Functions Variables Modules Pages
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...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButton $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="")
 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...
 
- Public Member Functions inherited from ilTableGUI
 ilTableGUI ($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...
 
 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 ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel ($a_worksheet, &$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 = ''
 

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
 
 $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
 
 $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 37 of file class.ilRoleTableGUI.php.

References $ilCtrl, and ilTable2GUI\setId().

38  {
39  global $ilCtrl;
40 
41  $this->ctrl = $ilCtrl;
42 
43  $this->setId('rolf_role_tbl');
44 
45  parent::__construct($a_parent_gui, $a_parent_cmd);
46  $this->lng->loadLanguageModule('rbac');
47  $this->lng->loadLanguageModule('search');
48  }
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 207 of file class.ilRoleTableGUI.php.

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

208  {
209  global $rbacreview,$tree;
210 
211  if($set['type'] == 'role')
212  {
213  if($set['parent'] != ROLE_FOLDER_ID)
214  {
215  $this->ctrl->setParameterByClass(
216  "ilobjrolegui",
217  "rolf_ref_id",
218  $set['parent']
219  );
220  }
221 
222  $this->ctrl->setParameterByClass("ilobjrolegui", "obj_id", $set["obj_id"]);
223  $link = $this->ctrl->getLinkTargetByClass("ilobjrolegui", "perm");
224  $this->ctrl->setParameterByClass("ilobjrolegui", "rolf_ref_id", "");
225  }
226  else
227  {
228  $this->ctrl->setParameterByClass("ilobjroletemplategui", "obj_id", $set["obj_id"]);
229  $link = $this->ctrl->getLinkTargetByClass("ilobjroletemplategui", "perm");
230  }
231 
232  switch($set['rtype'])
233  {
234  case self::TYPE_GLOBAL_AU:
235  $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_auto_global'));
236  break;
237  case self::TYPE_GLOBAL_UD:
238  $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_ud_global'));
239  break;
240  case self::TYPE_LOCAL_AU:
241  $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_auto_local'));
242  break;
243  case self::TYPE_LOCAL_UD:
244  $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_ud_local'));
245  break;
246  case self::TYPE_ROLT_AU:
247  $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_auto_rolt'));
248  break;
249  case self::TYPE_ROLT_UD:
250  $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_ud_rolt'));
251  break;
252  }
253 
254 
255 
256  if(
257  ($set['obj_id'] != ANONYMOUS_ROLE_ID and
258  $set['obj_id'] != SYSTEM_ROLE_ID and
259  substr($set['title_orig'],0,3) != 'il_') or
260  $this->getType() == self::TYPE_SEARCH)
261  {
262  $this->tpl->setVariable('VAL_ID', $set['obj_id']);
263  }
264  $this->tpl->setVariable('VAL_TITLE_LINKED', $set['title']);
265  $this->tpl->setVariable('VAL_LINK', $link);
266  if(strlen($set['description']))
267  {
268  $this->tpl->setVariable('VAL_DESC', $set['description']);
269  }
270 
278  $ref = $set['parent'];
279  if($ref == ROLE_FOLDER_ID)
280  {
281  $this->tpl->setVariable('CONTEXT', $this->lng->txt('rbac_context_global'));
282  }
283  else
284  {
285  $this->tpl->setVariable(
286  'CONTEXT',
287  (string) $this->getPathGUI()->getPath(ROOT_FOLDER_ID,$ref)
288  );
289  }
290 
291  if($this->getType() == self::TYPE_VIEW and $set['obj_id'] != SYSTEM_ROLE_ID)
292  {
293  // Copy role
294  $this->tpl->setVariable('COPY_TEXT',$this->lng->txt('rbac_role_rights_copy'));
295  $this->ctrl->setParameter($this->getParentObject(), "copy_source", $set["obj_id"]);
296  $link = $this->ctrl->getLinkTarget($this->getParentObject(),'roleSearch');
297  $this->tpl->setVariable(
298  'COPY_LINK',
299  $link
300  );
301  }
302 
303  }
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 89 of file class.ilRoleTableGUI.php.

References $path_gui.

Referenced by fillRow(), and init().

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

◆ getRoleTitleFilter()

ilRoleTableGUI::getRoleTitleFilter ( )

Get role title filter.

Returns
string

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

References $role_title_filter.

Referenced by parse().

73  {
75  }
+ Here is the caller graph for this function:

◆ getType()

ilRoleTableGUI::getType ( )

Get table type.

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

References $type.

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

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

◆ init()

ilRoleTableGUI::init ( )

Init table.

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

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

100  {
101  $this->addColumn('','f','1px');
102 
103  switch($this->getType())
104  {
105  case self::TYPE_VIEW:
106  $this->setShowRowsSelector(true);
107  $this->setDefaultOrderField('title');
108  $this->setDefaultOrderDirection('asc');
109  //$this->setId('rolf_role_tbl');
110  $this->addColumn($this->lng->txt('search_title_description'),'title','30%');
111  $this->addColumn($this->lng->txt('type'),'rtype','20%');
112  $this->addColumn($this->lng->txt('context'),'','40%');
113  $this->addColumn($this->lng->txt('actions'),'','10%');
114  $this->setTitle($this->lng->txt('objs_role'));
115  $this->addMultiCommand('confirmDelete',$this->lng->txt('delete'));
116  break;
117 
118  case self::TYPE_SEARCH:
119  $this->setShowRowsSelector(true);
120  $this->disable('sort');
121  //$this->setId('rolf_role_search_tbl');
122  $this->addColumn($this->lng->txt('search_title_description'),'title','30%');
123  $this->addColumn($this->lng->txt('type'),'rtype','20%');
124  $this->addColumn($this->lng->txt('context'),'','50%');
125  $this->setTitle($this->lng->txt('rbac_role_rights_copy'));
126  $this->addMultiCommand('chooseCopyBehaviour',$this->lng->txt('btn_next'));
127  $this->addCommandButton('roleSearch', $this->lng->txt('btn_previous'));
128  break;
129  }
130 
131 
132  $this->setRowTemplate('tpl.role_row.html','Services/AccessControl');
133  $this->setFormAction($this->ctrl->getFormAction($this->getParentObject()));
134  $this->setSelectAllCheckbox('roles');
135 
136  include_once './Services/Tree/classes/class.ilPathGUI.php';
137  $this->path_gui = new ilPathGUI();
138  $this->getPathGUI()->enableTextOnly(false);
139  $this->getPathGUI()->enableHideLeaf(FALSE);
140 
141 
142  // Filter initialisation
143 
144  if($this->getType() == self::TYPE_VIEW)
145  {
146  $this->initFilter();
147  }
148  }
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.
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="")
Add a column to the header.
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.
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.
getPathGUI()
Get path gui.
+ Here is the call graph for this function:

◆ initFilter()

ilRoleTableGUI::initFilter ( )

Init filter.

Definition at line 153 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().

154  {
155  $this->setDisableFilterHiding(true);
156 
157  switch($this->getType())
158  {
159  case self::TYPE_VIEW:
160  $action[ilRbacReview::FILTER_ALL] = $this->lng->txt('all_roles');
161  $action[ilRbacReview::FILTER_ALL_GLOBAL] = $this->lng->txt('all_global_roles');
162  $action[ilRbacReview::FILTER_ALL_LOCAL] = $this->lng->txt('all_local_roles');
163  $action[ilRbacReview::FILTER_INTERNAL] = $this->lng->txt('internal_local_roles_only');
164  $action[ilRbacReview::FILTER_NOT_INTERNAL] = $this->lng->txt('non_internal_local_roles_only');
165  $action[ilRbacReview::FILTER_TEMPLATES] = $this->lng->txt('role_templates_only');
166  break;
167 
168  case self::TYPE_SEARCH:
169  $action[ilRbacReview::FILTER_ALL] = $this->lng->txt('all_roles');
170  $action[ilRbacReview::FILTER_ALL_GLOBAL] = $this->lng->txt('all_global_roles');
171  $action[ilRbacReview::FILTER_ALL_LOCAL] = $this->lng->txt('all_local_roles');
172  $action[ilRbacReview::FILTER_INTERNAL] = $this->lng->txt('internal_local_roles_only');
173  $action[ilRbacReview::FILTER_NOT_INTERNAL] = $this->lng->txt('non_internal_local_roles_only');
174  break;
175  }
176 
177  include_once './Services/Form/classes/class.ilSelectInputGUI.php';
178  $roles = new ilSelectInputGUI($this->lng->txt('rbac_role_selection'), 'role_type');
179 
180  $roles->setOptions($action);
181 
182  $this->addFilterItem($roles);
183 
184  $roles->readFromSession();
185  if(!$roles->getValue())
186  {
187  $roles->setValue(ilRbacReview::FILTER_ALL_GLOBAL);
188  }
189 
190  // title filter
191  include_once './Services/Form/classes/class.ilTextInputGUI.php';
192  $title = new ilTextInputGUI($this->lng->txt('title'), 'role_title');
193  $title->setSize(16);
194  $title->setMaxLength(64);
195 
196  $this->addFilterItem($title);
197  $title->readFromSession();
198 
199  $this->filter['role_type'] = $roles->getValue();
200  $this->filter['role_title'] = $title->getValue();
201  }
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 309 of file class.ilRoleTableGUI.php.

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

310  {
311  global $rbacreview,$ilUser;
312 
313  include_once './Services/AccessControl/classes/class.ilObjRole.php';
314 
315  if($this->getType() == self::TYPE_VIEW)
316  {
317  $filter_orig = $filter = $this->getFilterItemByPostVar('role_title')->getValue();
318  $type = $this->getFilterItemByPostVar('role_type')->getValue();
319  }
320  else
321  {
322  $filter_orig = $filter = $this->getRoleTitleFilter();
324  }
325 
326 
327  // the translation must be filtered
329  {
330  // roles like il_crs_... are filtered manually
331  $filter = '';
332  }
333 
334  $role_list = $rbacreview->getRolesByFilter(
335  $type,
336  0,
337  $filter
338  );
339 
340  $counter = 0;
341  $rows = array();
342  foreach((array) $role_list as $role)
343  {
344  if(
345  $role['parent'] and
346  (
347  $GLOBALS['tree']->isDeleted($role['parent']) or
348  !$GLOBALS['tree']->isInTree($role['parent'])
349  )
350  )
351  {
352  continue;
353  }
354 
355  $title = ilObjRole::_getTranslation($role['title']);
357  {
358  if(strlen($filter_orig))
359  {
360  if(stristr($title, $filter_orig) == FALSE)
361  {
362  continue;
363  }
364  }
365  }
366 
367 
368  $rows[$counter]['title_orig'] = $role['title'];
369  $rows[$counter]['title'] = $title;
370  $rows[$counter]['description'] = $role['description'];
371  $rows[$counter]['obj_id'] = $role['obj_id'];
372  $rows[$counter]['parent'] = $role['parent'];
373  $rows[$counter]['type'] = $role['type'];
374 
375  $auto = (substr($role['title'], 0, 3) == 'il_' ? true : false);
376 
377 
378  // Role templates
379  if($role['type'] == 'rolt')
380  {
381  $rows[$counter]['rtype'] = $auto ? self::TYPE_ROLT_AU : self::TYPE_ROLT_UD;
382  }
383  else
384  {
385  // Roles
386  if($role['parent'] == ROLE_FOLDER_ID)
387  {
388  if($role['obj_id'] == ANONYMOUS_ROLE_ID or $role['obj_id'] == SYSTEM_ROLE_ID)
389  {
390  $rows[$counter]['rtype'] = self::TYPE_GLOBAL_AU;
391  }
392  else
393  {
394  $rows[$counter]['rtype'] = self::TYPE_GLOBAL_UD;
395  }
396  }
397  else
398  {
399  $rows[$counter]['rtype'] = $auto ? self::TYPE_LOCAL_AU : self::TYPE_LOCAL_UD;
400  }
401  }
402 
403  ++$counter;
404  }
405  $this->setMaxCount(count($rows));
406  $this->setData($rows);
407  }
getRoleTitleFilter()
Get role title filter.
_getTranslation($a_role_title)
getFilterItemByPostVar($a_post_var)
$GLOBALS['ct_recipient']
getType()
Get table type.
global $ilUser
Definition: imgupload.php:15
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 63 of file class.ilRoleTableGUI.php.

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

◆ setType()

ilRoleTableGUI::setType (   $a_type)

Set table type.

Parameters
int$a_type

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

55  {
56  $this->type = $a_type;
57  }

Field Documentation

◆ $path_gui

ilRoleTableGUI::$path_gui = null
private

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

Referenced by getPathGUI().

◆ $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: