ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilObjectRolePermissionTableGUI Class Reference

Table for object role permissions. More...

+ Inheritance diagram for ilObjectRolePermissionTableGUI:
+ Collaboration diagram for ilObjectRolePermissionTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $a_ref_id)
 Constructor. More...
 
 getPathIds ()
 Get tree path ids. More...
 
 getRefId ()
 Get ref id of current object. More...
 
 getObjId ()
 Get obj id. More...
 
 getObjType ()
 get obj type More...
 
 addActiveOperation ($a_ops_id)
 Add active operation. More...
 
 getActiveOperations ()
 get active operations More...
 
 setVisibleRoles ($a_ar)
 Set Visible roles. More...
 
 getVisibleRoles ()
 get visible roles More...
 
 initFilter ()
 Init role filter. More...
 
 fillRow ($row)
 Fill one permission row. More...
 
 parse ()
 Parse. 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)
 set table data @access public More...
 
 getData ()
 
 dataExists ()
 
 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) @access public More...
 
 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 (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 @access 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)
 set max. More...
 
- Public Member Functions inherited from ilTableGUI
 ilTableGUI ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate (&$a_tpl)
 set template @access public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data @access public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title @access public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page @access public More...
 
 setHeaderNames ($a_header_names)
 set table header names @access public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns @access public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars @access public More...
 
 setColumnWidth ($a_column_width)
 set table column widths @access public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width @access 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) @access public More...
 
 setOffset ($a_offset)
 set dataset offset @access public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column @access public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction @access public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction @access 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 @access 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 ROLE_FILTER_ALL = 1
 
const ROLE_FILTER_GLOBAL = 2
 
const ROLE_FILTER_LOCAL = 3
 
const ROLE_FILTER_LOCAL_POLICY = 4
 
const ROLE_FILTER_LOCAL_OBJECT = 5
 
- 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

 initColumns ()
 init Columns More...
 
 createTooltip ($role)
 Create a linked title for roles with local policy. More...
 
 createTitle ($role)
 Create (linked) title. More...
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. 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 ($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

 $ref_id = null
 
 $roles = array()
 
 $tree_path_ids = array()
 
 $activeOperations = array()
 
 $visible_roles = array()
 

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
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

Detailed Description

Table for object role permissions.

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectRolePermissionTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $a_ref_id 
)

Constructor.

Returns

Reimplemented from ilTable2GUI.

Definition at line 36 of file class.ilObjectRolePermissionTableGUI.php.

37 {
38 global $ilCtrl,$rbacreview,$tpl,$tree;
39
40 parent::__construct($a_parent_obj,$a_parent_cmd);
41
42 $this->lng->loadLanguageModule('rbac');
43
44 $this->ref_id = $a_ref_id;
45 $this->tree_path_ids = $tree->getPathId($this->ref_id);
46
47 $this->setId('objroleperm_'.$this->ref_id);
48
49 $tpl->addJavaScript('./Services/AccessControl/js/ilPermSelect.js');
50
51 $this->setTitle($this->lng->txt('permission_settings'));
52 $this->setEnableHeader(true);
53 $this->disable('sort');
54 $this->setFormAction($ilCtrl->getFormAction($a_parent_obj, $a_parent_cmd));
55 $this->disable('numinfo');
56 $this->setRowTemplate("tpl.obj_role_perm_row.html", "Services/AccessControl");
57 $this->setLimit(100);
58 $this->setShowRowsSelector(false);
59 $this->setDisableFilterHiding(true);
60 $this->setNoEntriesText($this->lng->txt('msg_no_roles_of_type'));
61
62 $this->addCommandButton('savePermissions', $this->lng->txt('save'));
63
64 $this->initFilter();
65 }
global $tpl
Definition: ilias.php:8
setEnableHeader($a_enableheader)
Set Enable Header.
setDisableFilterHiding($a_val=true)
Set disable filter hiding.
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
setNoEntriesText($a_text)
Set text for an empty table.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
setLimit($a_limit=0, $a_default_limit=0)
set max.
setId($a_val)
Set id.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
addCommandButton($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
Add Command button.
disable($a_module_name)
diesables particular modules of table
global $ilCtrl
Definition: ilias.php:18

References $ilCtrl, $tpl, ilTable2GUI\addCommandButton(), ilTableGUI\disable(), initFilter(), ilTable2GUI\setDisableFilterHiding(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setNoEntriesText(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTitle().

+ Here is the call graph for this function:

Member Function Documentation

◆ addActiveOperation()

ilObjectRolePermissionTableGUI::addActiveOperation (   $a_ops_id)

Add active operation.

Parameters
int$a_ops_id
Returns

Definition at line 109 of file class.ilObjectRolePermissionTableGUI.php.

110 {
111 $this->activeOperations[] = $a_ops_id;
112 }

Referenced by parse().

+ Here is the caller graph for this function:

◆ createTitle()

ilObjectRolePermissionTableGUI::createTitle (   $role)
protected

Create (linked) title.

Parameters
array$role
Returns

Definition at line 657 of file class.ilObjectRolePermissionTableGUI.php.

658 {
659 global $ilCtrl;
660
661 include_once './Services/AccessControl/classes/class.ilObjRole.php';
662 $role['title'] = ilObjRole::_getTranslation($role['title']);
663
664 // No local policies
665 if($role['parent'] != $this->getRefId())
666 {
667 return $role['title'];
668 }
669 if($role['blocked'])
670 {
671 return $role['title'];
672 }
673 $ilCtrl->setParameterByClass('ilobjrolegui', 'obj_id', $role['obj_id']);
674
675 return '<a class="tblheader" href="'.$ilCtrl->getLinkTargetByClass('ilobjrolegui','').'" >'.$role['title'].'</a>';
676 }
_getTranslation($a_role_title)

References $ilCtrl, ilObjRole\_getTranslation(), and getRefId().

Referenced by initColumns().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ createTooltip()

ilObjectRolePermissionTableGUI::createTooltip (   $role)
protected

Create a linked title for roles with local policy.

Parameters
object$role
Returns

Definition at line 588 of file class.ilObjectRolePermissionTableGUI.php.

589 {
590 global $rbacreview,$tree;
591
592 #vd($role);
593 $protected_status = $rbacreview->isProtected($role['parent'], $role['obj_id']) ? 'protected_' : '';
594 if($role['role_type'] == 'global')
595 {
596 $tp = $this->lng->txt('perm_'.$protected_status.'global_role');
597 }
598 else
599 {
600 $tp = $this->lng->txt('perm_'.$protected_status.'local_role');
601 }
602
603 $inheritance_seperator = ': ';
604
605 // Show create at info
606 if(
607 ($role['assign'] == 'y' and $role['role_type'] != 'global') or
608 ($role['assign'] == 'n' and $role['role_type'] != 'global')
609 )
610 {
611 $tp .= ': ';
612
613 $obj = $rbacreview->getObjectOfRole($role['obj_id']);
614 if($obj)
615 {
616 $tp .= sprintf(
617 $this->lng->txt('perm_role_path_info_created'),
618 $this->lng->txt('obj_'.ilObject::_lookupType($obj)),ilObject::_lookupTitle($obj)
619 );
620 $inheritance_seperator = ', ';
621 }
622 }
623
624 $path_hierarchy = $rbacreview->getObjectsWithStopedInheritance(
625 $role['obj_id'],
626 $tree->getPathId($this->getRefId())
627 );
628
629 $reduced_path_hierarchy = (array) array_diff(
630 $path_hierarchy,
631 array(
632 $this->getRefId(),
633 $rbacreview->getObjectReferenceOfRole($role['obj_id'])
634 )
635 );
636
637
638 // Inheritance
639 if($role['assign'] == 'n' and count($reduced_path_hierarchy))
640 {
641 $tp .= $inheritance_seperator;
642
643 $parent = end($reduced_path_hierarchy);
646 $tp .= sprintf($this->lng->txt('perm_role_path_info_inheritance'),$this->lng->txt('obj_'.$p_type),$p_title);
647 }
648
649 return $tp;
650 }
static _lookupObjId($a_id)
static _lookupTitle($a_id)
lookup object title
static _lookupType($a_id, $a_reference=false)
lookup object type

References ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), and getRefId().

Referenced by initColumns().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillRow()

ilObjectRolePermissionTableGUI::fillRow (   $row)

Fill one permission row.

Parameters
object$row
Returns

Reimplemented from ilTable2GUI.

Definition at line 187 of file class.ilObjectRolePermissionTableGUI.php.

188 {
189 global $objDefinition;
190
191
192 // local policy
193 if(isset($row['show_local_policy_row']))
194 {
195 foreach($row['roles'] as $role_id => $role_info)
196 {
197 $this->tpl->setCurrentBlock('role_option');
198 $this->tpl->setVariable('INHERIT_ROLE_ID',$role_id);
199 $this->tpl->setVariable('INHERIT_CHECKED',$role_info['local_policy'] ? 'checked=checked' : '');
200 $this->tpl->setVariable('INHERIT_DISABLED',($role_info['protected'] or $role_info['isLocal'] or $role_info['blocked']) ? 'disabled="disabled"' : '');
201 $this->tpl->setVariable('TXT_INHERIT',$this->lng->txt('rbac_local_policy'));
202 $this->tpl->setVariable('INHERIT_LONG',$this->lng->txt('perm_use_local_policy_desc'));
203 $this->tpl->parseCurrentBlock();
204 }
205 return true;
206 }
207 // protected
208 if(isset($row['show_protected_row']))
209 {
210 foreach($row['roles'] as $role_id => $role_info)
211 {
212 $this->tpl->setCurrentBlock('role_protect');
213 $this->tpl->setVariable('PROTECT_ROLE_ID',$role_id);
214 $this->tpl->setVariable('PROTECT_CHECKED',$role_info['protected_status'] ? 'checked=checked' : '');
215 $this->tpl->setVariable('PROTECT_DISABLED',$role_info['protected_allowed'] ? '' : 'disabled="disabled"');
216 $this->tpl->setVariable('TXT_PROTECT',$this->lng->txt('role_protect_permissions'));
217 $this->tpl->setVariable('PROTECT_LONG',$this->lng->txt('role_protect_permissions_desc'));
218 $this->tpl->parseCurrentBlock();
219 }
220 return true;
221 }
222
223 // block role
224 if(isset($row['show_block_row']))
225 {
226 foreach($this->getVisibleRoles() as $counter => $role_info)
227 {
228 $this->tpl->setCurrentBlock('role_block');
229 $this->tpl->setVariable('BLOCK_ROLE_ID',$role_info['obj_id']);
230 $this->tpl->setVariable('TXT_BLOCK',$this->lng->txt('role_block_role'));
231 $this->tpl->setVariable('BLOCK_LONG',$this->lng->txt('role_block_role_desc'));
232 if($role_info['blocked'])
233 {
234 $this->tpl->setVariable('BLOCK_CHECKED','checked="checked"');
235 }
236 ilLoggerFactory::getLogger('ac')->debug(print_r($role_info,TRUE));
237 if(
238 ($role_info['protected'] == 'y') ||
239 ($role_info['assign'] == 'y' and ($role_info['parent'] == $this->getRefId()))
240 )
241 {
242 $this->tpl->setVariable('BLOCK_DISABLED','disabled="disabled');
243 }
244
245 $this->tpl->parseCurrentBlock();
246 }
247 return true;
248 }
249
250 // Select all
251 if(isset($row['show_select_all']))
252 {
253 foreach($this->getVisibleRoles() as $role)
254 {
255 $this->tpl->setCurrentBlock('role_select_all');
256 $this->tpl->setVariable('JS_ROLE_ID',$role['obj_id']);
257 $this->tpl->setVariable('JS_SUBID',$row['subtype']);
258 $this->tpl->setVariable('JS_ALL_PERMS',"['".implode("','",$row['ops'])."']");
259 $this->tpl->setVariable('JS_FORM_NAME',$this->getFormName());
260 $this->tpl->setVariable('TXT_SEL_ALL',$this->lng->txt('select_all'));
261 $this->tpl->parseCurrentBlock();
262 }
263 return true;
264 }
265
266 // Object permissions
267 if(isset($row['show_start_info']))
268 {
269 $this->tpl->setCurrentBlock('section_info');
270 $this->tpl->setVariable('SECTION_TITLE',$this->lng->txt('perm_class_object'));
271 $this->tpl->setVariable('SECTION_DESC',$this->lng->txt('perm_class_object_desc'));
272 $this->tpl->parseCurrentBlock();
273
274 return true;
275 }
276
277 if(isset($row['show_create_info']))
278 {
279 $this->tpl->setCurrentBlock('section_info');
280 $this->tpl->setVariable('SECTION_TITLE',$this->lng->txt('perm_class_create'));
281 $this->tpl->setVariable('SECTION_DESC',$this->lng->txt('perm_class_create_desc'));
282 $this->tpl->parseCurrentBlock();
283
284 return true;
285 }
286
287 foreach((array) $row['roles'] as $role_id => $role_info)
288 {
289 $this->tpl->setCurrentBlock('role_td');
290 $this->tpl->setVariable('PERM_ROLE_ID',$role_id);
291 $this->tpl->setVariable('PERM_PERM_ID',$row['perm']['ops_id']);
292
293
294 if(substr($row['perm']['operation'],0,6) == 'create')
295 {
296 if ($objDefinition->isPlugin(substr($row['perm']['operation'],7)))
297 {
298 $perm = ilPlugin::lookupTxt("rep_robj", substr($row['perm']['operation'],7),
299 "obj_".substr($row['perm']['operation'],7));
300 }
301 else
302 {
303 $perm = $this->lng->txt('obj_'.substr($row['perm']['operation'],7));
304 }
305 }
306 else
307 {
308 if($this->lng->exists($this->getObjType().'_'.$row['perm']['operation'].'_short'))
309 {
310 $perm = $this->lng->txt($this->getObjType().'_'.$row['perm']['operation'].'_short');
311 }
312 else
313 {
314 $perm = $this->lng->txt($row['perm']['operation']);
315 }
316 }
317
318 $this->tpl->setVariable('TXT_PERM',$perm);
319
320 if ($objDefinition->isPlugin($this->getObjType()))
321 {
322 $this->tpl->setVariable('PERM_LONG',ilPlugin::lookupTxt("rep_robj", $this->getObjType(),
323 $this->getObjType()."_".$row['perm']['operation']));
324 }
325 elseif(substr($row['perm']['operation'],0,6) == 'create')
326 {
327 $this->tpl->setVariable('PERM_LONG',$this->lng->txt('rbac_'.$row['perm']['operation']));
328 }
329 else
330 {
331 $this->tpl->setVariable('PERM_LONG',$this->lng->txt($this->getObjType().'_'.$row['perm']['operation']));
332 }
333
334 if($role_info['protected'] || $role_info['blocked'])
335 {
336 $this->tpl->setVariable('PERM_DISABLED','disabled="disabled"');
337 }
338 if($role_info['permission_set'])
339 {
340 $this->tpl->setVariable('PERM_CHECKED','checked="checked"');
341 }
342
343 $this->tpl->parseCurrentBlock();
344 }
345 }
static getLogger($a_component_id)
Get component logger.
static lookupTxt($a_mod_prefix, $a_pl_id, $a_lang_var)
Lookup language text.
getFormName()
Get Form name.

References $row, ilTable2GUI\getFormName(), ilLoggerFactory\getLogger(), getObjType(), getRefId(), getVisibleRoles(), and ilPlugin\lookupTxt().

+ Here is the call graph for this function:

◆ getActiveOperations()

ilObjectRolePermissionTableGUI::getActiveOperations ( )

get active operations

Returns

Definition at line 118 of file class.ilObjectRolePermissionTableGUI.php.

References $activeOperations.

◆ getObjId()

ilObjectRolePermissionTableGUI::getObjId ( )

Get obj id.

Returns

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

91 {
92 return ilObject::_lookupObjId($this->getRefId());
93 }

References ilObject\_lookupObjId(), and getRefId().

Referenced by getObjType().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getObjType()

ilObjectRolePermissionTableGUI::getObjType ( )

get obj type

Returns

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

References ilObject\_lookupType(), and getObjId().

Referenced by fillRow(), and parse().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getPathIds()

ilObjectRolePermissionTableGUI::getPathIds ( )

Get tree path ids.

Returns
array

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

References $tree_path_ids.

◆ getRefId()

ilObjectRolePermissionTableGUI::getRefId ( )

Get ref id of current object.

Returns

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

References $ref_id.

Referenced by createTitle(), createTooltip(), fillRow(), getObjId(), initColumns(), and parse().

+ Here is the caller graph for this function:

◆ getVisibleRoles()

ilObjectRolePermissionTableGUI::getVisibleRoles ( )

get visible roles

Returns

Definition at line 137 of file class.ilObjectRolePermissionTableGUI.php.

References $visible_roles.

Referenced by fillRow(), and parse().

+ Here is the caller graph for this function:

◆ initColumns()

ilObjectRolePermissionTableGUI::initColumns ( )
protected

init Columns

Returns

Definition at line 524 of file class.ilObjectRolePermissionTableGUI.php.

525 {
526 global $rbacreview,$ilCtrl;
527
528 $roles = $rbacreview->getParentRoleIds($this->getRefId());
529 $roles = $this->getParentObject()->applyRoleFilter(
530 $roles,
531 $this->getFilterItemByPostVar('role')->getValue()
532 );
533
534 $possible_roles = array();
535 foreach($roles as $role)
536 {
537 if($rbacreview->isBlockedInUpperContext($role['obj_id'],$this->getRefId()))
538 {
539 ilLoggerFactory::getLogger('ac')->debug('Ignoring blocked role: ' . $role['obj_id']);
540 continue;
541 }
542 $possible_roles[] = $role;
543 }
544
545
546 if(count($possible_roles))
547 {
548 $column_width = 100/count($possible_roles);
549 $column_width .= '%';
550 }
551 else
552 {
553 $column_widht = "0%";
554 }
555
556 $all_roles = array();
557 foreach($possible_roles as $role)
558 {
559 if($role['obj_id'] == SYSTEM_ROLE_ID)
560 {
561 continue;
562 }
563
564 $role['blocked'] = (bool) $rbacreview->isBlockedAtPosition($role['obj_id'],$this->getRefId());
565 $role['role_type'] = $rbacreview->isGlobalRole($role['obj_id']) ? 'global' : 'local';
566
567 // TODO check filter
568 $this->addColumn(
569 $this->createTitle($role),
570 $role['obj_id'],
571 '',
572 '',
573 false,
574 $this->createTooltip($role)
575 );
576 $all_roles[] = $role;
577 }
578
579 $this->setVisibleRoles($all_roles);
580 return true;
581 }
createTooltip($role)
Create a linked title for roles with local policy.
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.
getParentObject()
Get parent object.
getFilterItemByPostVar($a_post_var)

References ilTableGUI\$column_width, $ilCtrl, $roles, ilTable2GUI\addColumn(), createTitle(), createTooltip(), ilTable2GUI\getFilterItemByPostVar(), ilLoggerFactory\getLogger(), ilTable2GUI\getParentObject(), getRefId(), and setVisibleRoles().

Referenced by parse().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initFilter()

ilObjectRolePermissionTableGUI::initFilter ( )

Init role filter.

Returns

Reimplemented from ilTable2GUI.

Definition at line 146 of file class.ilObjectRolePermissionTableGUI.php.

147 {
148 global $tree;
149
151 'role',
153 );
154
155 // Limit filter to local roles only for objects with group or course in path
156 if(!$roles->getValue())
157 {
158 if ($tree->checkForParentType($this->getRefId(), 'crs') or
159 $tree->checkForParentType($this->getRefId(), 'grp'))
160 {
161 $roles->setValue(self::ROLE_FILTER_LOCAL);
162 }
163 else
164 {
165 $roles->setValue(self::ROLE_FILTER_ALL);
166 }
167 }
168
169
170 $roles->setOptions(
171 array(
172 self::ROLE_FILTER_ALL => $this->lng->txt('filter_all_roles'),
173 self::ROLE_FILTER_GLOBAL => $this->lng->txt('filter_global_roles'),
174 self::ROLE_FILTER_LOCAL => $this->lng->txt('filter_local_roles'),
175 self::ROLE_FILTER_LOCAL_POLICY => $this->lng->txt('filter_roles_local_policy'),
176 self::ROLE_FILTER_LOCAL_OBJECT => $this->lng->txt('filter_local_roles_object')
177 )
178 );
179
180 }
addFilterItemByMetaType($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
Add filter by standard type.

References $roles, ilTable2GUI\addFilterItemByMetaType(), and ilTable2GUI\FILTER_SELECT.

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parse()

ilObjectRolePermissionTableGUI::parse ( )

Parse.

Returns

Definition at line 352 of file class.ilObjectRolePermissionTableGUI.php.

353 {
354 global $rbacreview,$objDefinition;
355
356 $this->initColumns();
357
358 $perms = array();
359 $roles = array();
360
361 if(!count($this->getVisibleRoles()))
362 {
363 return $this->setData(array());
364 }
365
366 // Read operations of role
367 $operations = array();
368 foreach($this->getVisibleRoles() as $role_data)
369 {
370 $operations[$role_data['obj_id']] = $rbacreview->getActiveOperationsOfRole($this->getRefId(), $role_data['obj_id']);
371 }
372
373 $counter = 0;
374
375 // Local policy
377 {
378 $roles = array();
379 $local_roles = $rbacreview->getRolesOfObject($this->getRefId());
380 foreach($this->getVisibleRoles() as $role_id => $role_data)
381 {
382 $roles[$role_data['obj_id']] = array(
383 'blocked' => $role_data['blocked'],
384 'protected' => $role_data['protected'],
385 'local_policy' => in_array($role_data['obj_id'],$local_roles),
386 'isLocal' => ($this->getRefId() == $role_data['parent']) && $role_data['assign'] == 'y'
387 );
388 }
389 $perms[$counter]['roles'] = $roles;
390 $perms[$counter]['show_local_policy_row'] = 1;
391
392 $counter++;
393 }
394
395 // Protect permissions
397 {
398 $roles = array();
399 foreach($this->getVisibleRoles() as $role_id => $role_data)
400 {
401 $roles[$role_data['obj_id']] = array(
402 'blocked' => $role_data['blocked'],
403 'protected_allowed' => $rbacreview->isAssignable($role_data['obj_id'],$this->getRefId()),
404 'protected_status' => $rbacreview->isProtected($role_data['parent'], $role_data['obj_id']),
405 'isLocal' => ($this->getRefId() == $role_data['parent']) && $role_data['assign'] == 'y'
406 );
407 }
408 $perms[$counter]['roles'] = $roles;
409 $perms[$counter]['show_protected_row'] = 1;
410
411 $counter++;
412 }
413 // Block role
415 {
416 $perms[$counter++]['show_block_row'] = 1;
417 }
418
419
421 {
422 $perms[$counter++]['show_start_info'] = true;
423 }
424
425 // no creation permissions
426 $no_creation_operations = array();
427 foreach($rbacreview->getOperationsByTypeAndClass($this->getObjType(),'object') as $operation)
428 {
429 $this->addActiveOperation($operation);
430 $no_creation_operations[] = $operation;
431
432 $roles = array();
433 foreach($this->getVisibleRoles() as $role_data)
434 {
435 $roles[$role_data['obj_id']] =
436 array(
437 'blocked' => $role_data['blocked'],
438 'protected' => $role_data['protected'],
439 'permission_set' => in_array($operation,(array) $operations[$role_data['obj_id']]),
440 'isLocal' => ($this->getRefId() == $role_data['parent']) && $role_data['assign'] == 'y'
441 );
442 }
443
444 $op = $rbacreview->getOperation($operation);
445
446 $perms[$counter]['roles'] = $roles;
447 $perms[$counter]['perm'] = $op;
448 $counter++;
449
450 }
451
452 /*
453 * Select all
454 */
455 if($no_creation_operations)
456 {
457 $perms[$counter]['show_select_all'] = 1;
458 $perms[$counter]['ops'] = $no_creation_operations;
459 $perms[$counter]['subtype'] = 'nocreation';
460 $counter++;
461 }
462
463
464 if($objDefinition->isContainer($this->getObjType()))
465 {
466 $perms[$counter++]['show_create_info'] = true;
467 }
468
469 // Get creatable objects
470 $objects = $objDefinition->getCreatableSubObjects($this->getObjType());
471 $ops_ids = ilRbacReview::lookupCreateOperationIds(array_keys($objects));
472 $creation_operations = array();
473 foreach($objects as $type => $info)
474 {
475 $ops_id = $ops_ids[$type];
476
477 if(!$ops_id)
478 {
479 continue;
480 }
481
482 $this->addActiveOperation($ops_id);
483 $creation_operations[] = $ops_id;
484
485 $roles = array();
486 foreach($this->getVisibleRoles() as $role_data)
487 {
488 $roles[$role_data['obj_id']] =
489 array(
490 'blocked' => $role_data['blocked'],
491 'protected' => $role_data['protected'],
492 'permission_set' => in_array($ops_id,(array) $operations[$role_data['obj_id']]),
493 'isLocal' => ($this->getRefId() == $role_data['parent']) && $role_data['assign'] == 'y'
494
495 );
496 }
497
498 $op = $rbacreview->getOperation($ops_id);
499
500 $perms[$counter]['roles'] = $roles;
501 $perms[$counter]['perm'] = $op;
502 $counter++;
503
504 }
505
506
507
508 // Select all
509 if(count($creation_operations))
510 {
511 $perms[$counter]['show_select_all'] = 1;
512 $perms[$counter]['ops'] = $creation_operations;
513 $perms[$counter]['subtype'] = 'creation';
514 $counter++;
515 }
516
517 $this->setData($perms);
518 }
addActiveOperation($a_ops_id)
Add active operation.
static hasContainerCommands($a_type)
Check if container commands are possible for the current object type.
static lookupCreateOperationIds($a_type_arr)
Lookup operation ids.
setData($a_data)
set table data @access public
$info
Definition: example_052.php:80

References $info, $roles, addActiveOperation(), getObjType(), getRefId(), getVisibleRoles(), ilPermissionGUI\hasContainerCommands(), initColumns(), ilRbacReview\lookupCreateOperationIds(), and ilTable2GUI\setData().

+ Here is the call graph for this function:

◆ setVisibleRoles()

ilObjectRolePermissionTableGUI::setVisibleRoles (   $a_ar)

Set Visible roles.

Parameters
object$a_ar
Returns

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

129 {
130 $this->visible_roles = $a_ar;
131 }

Referenced by initColumns().

+ Here is the caller graph for this function:

Field Documentation

◆ $activeOperations

ilObjectRolePermissionTableGUI::$activeOperations = array()
private

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

Referenced by getActiveOperations().

◆ $ref_id

ilObjectRolePermissionTableGUI::$ref_id = null
private

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

Referenced by getRefId().

◆ $roles

ilObjectRolePermissionTableGUI::$roles = array()
private

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

Referenced by initColumns(), initFilter(), and parse().

◆ $tree_path_ids

ilObjectRolePermissionTableGUI::$tree_path_ids = array()
private

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

Referenced by getPathIds().

◆ $visible_roles

ilObjectRolePermissionTableGUI::$visible_roles = array()
private

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

Referenced by getVisibleRoles().

◆ ROLE_FILTER_ALL

const ilObjectRolePermissionTableGUI::ROLE_FILTER_ALL = 1

◆ ROLE_FILTER_GLOBAL

const ilObjectRolePermissionTableGUI::ROLE_FILTER_GLOBAL = 2

◆ ROLE_FILTER_LOCAL

const ilObjectRolePermissionTableGUI::ROLE_FILTER_LOCAL = 3

◆ ROLE_FILTER_LOCAL_OBJECT

const ilObjectRolePermissionTableGUI::ROLE_FILTER_LOCAL_OBJECT = 5

◆ ROLE_FILTER_LOCAL_POLICY

const ilObjectRolePermissionTableGUI::ROLE_FILTER_LOCAL_POLICY = 4

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