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="")
	ilTable2GUI 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, $a_select_all_on_top=false)
	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	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	FILTER_CHECKBOX = 9

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...

	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
	$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
	$ctrl

	$tpl

	$parent_obj

	$parent_cmd

	$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 = []

	$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

	$select_all_on_top = false

	$sel_buttons = []

Protected Attributes inherited from ilTableGUI
	$tpl

	$lng

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 17 of file class.ilObjectRolePermissionTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Returns

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

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

     {
         global $DIC;
 
         $ilCtrl = $DIC['ilCtrl'];
         $rbacreview = $DIC['rbacreview'];
         $tpl = $DIC['tpl'];
         $tree = $DIC['tree'];
         
         parent::__construct($a_parent_obj, $a_parent_cmd);
         
         $this->lng->loadLanguageModule('rbac');
         
         $this->ref_id = $a_ref_id;
         $this->tree_path_ids = $tree->getPathId($this->ref_id);
         
         $this->setId('objroleperm_' . $this->ref_id);
 
         $tpl->addJavaScript('./Services/AccessControl/js/ilPermSelect.js');
 
         $this->setTitle($this->lng->txt('permission_settings'));
         $this->setEnableHeader(true);
         $this->disable('sort');
         $this->setFormAction($ilCtrl->getFormAction($a_parent_obj, $a_parent_cmd));
         $this->disable('numinfo');
         $this->setRowTemplate("tpl.obj_role_perm_row.html", "Services/AccessControl");
         $this->setLimit(100);
         $this->setShowRowsSelector(false);
         $this->setDisableFilterHiding(true);
         $this->setNoEntriesText($this->lng->txt('msg_no_roles_of_type'));
         
         $this->addCommandButton('savePermissions', $this->lng->txt('save'));
         
         $this->initFilter();
     }

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 115 of file class.ilObjectRolePermissionTableGUI.php.

Referenced by parse().

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

Here is the caller graph for this function:

◆ createTitle()

ilObjectRolePermissionTableGUI::createTitle ( $role )

protected

Create (linked) title.

Parameters

array $role

Returns

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

References $DIC, $ilCtrl, $type, ilObjRole\_getTranslation(), ilObject\_lookupType(), ilObjRole\_removeObjectId(), getRefId(), and ilObjectPlugin\lookupTxtById().

Referenced by initColumns().

     {
         global $DIC;
 
         $ilCtrl = $DIC['ilCtrl'];
         $objDefinition = $DIC['objDefinition'];
         
         include_once './Services/AccessControl/classes/class.ilObjRole.php';
         $role_title = ilObjRole::_getTranslation($role['title']);
         
         // No local policies
         if ($role['parent'] != $this->getRefId()) {
             return $role_title;
         }
 
         $type = ilObject::_lookupType($this->getRefId(), true);
         if ($objDefinition->isPlugin($type)) {
             if (preg_match("/^il_./", $role["title"])) {
                 $role_title = ilObjectPlugin::lookupTxtById($type, ilObjRole::_removeObjectId($role["title"]));
             }
         }
 
         if ($role['blocked']) {
             return $role_title;
         }
         $ilCtrl->setParameterByClass('ilobjrolegui', 'obj_id', $role['obj_id']);
         
         return '<a class="tblheader" href="' . $ilCtrl->getLinkTargetByClass('ilobjrolegui', '') . '" >' . $role_title . '</a>';
     }

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 557 of file class.ilObjectRolePermissionTableGUI.php.

References $DIC, $tree, $type, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), getRefId(), and ilObjectPlugin\lookupTxtById().

Referenced by initColumns().

     {
         global $DIC;
 
         $rbacreview = $DIC['rbacreview'];
         $tree = $DIC['tree'];
         $objDefinition = $DIC['objDefinition'];
         
         #vd($role);
         $protected_status = $rbacreview->isProtected($role['parent'], $role['obj_id']) ? 'protected_' : '';
         if ($role['role_type'] == 'global') {
             $tp = $this->lng->txt('perm_' . $protected_status . 'global_role');
         } else {
             $tp = $this->lng->txt('perm_' . $protected_status . 'local_role');
         }
 
         $inheritance_seperator = ': ';
         
         // Show create at info
         if (
             ($role['assign'] == 'y' and $role['role_type'] != 'global') or
             ($role['assign'] == 'n' and $role['role_type'] != 'global')
         ) {
             $tp .= ': ';
 
             $obj = $rbacreview->getObjectOfRole($role['obj_id']);
             if ($obj) {
                 $type = ilObject::_lookupType($this->getRefId(), true);
                 if ($objDefinition->isPlugin($type)) {
                     $type_text = ilObjectPlugin::lookupTxtById($type, 'obj_' . $type);
                 } else {
                     $type_text = $this->lng->txt('obj_' . ilObject::_lookupType($obj));
                 }
 
                 $tp .= sprintf(
                     $this->lng->txt('perm_role_path_info_created'),
                     $type_text,
                     ilObject::_lookupTitle($obj)
                 );
                 $inheritance_seperator = ', ';
             }
         }
 
         $path_hierarchy = $rbacreview->getObjectsWithStopedInheritance(
             $role['obj_id'],
             $tree->getPathId($this->getRefId())
         );
 
         $reduced_path_hierarchy = (array) array_diff(
             $path_hierarchy,
             array(
                 $this->getRefId(),
                 $rbacreview->getObjectReferenceOfRole($role['obj_id'])
             )
         );
 
 
         // Inheritance
         if ($role['assign'] == 'n' and count($reduced_path_hierarchy)) {
             $tp .= $inheritance_seperator;
 
             $parent = end($reduced_path_hierarchy);
             $p_type = ilObject::_lookupType(ilObject::_lookupObjId($parent));
             $p_title = ilObject::_lookupTitle(ilObject::_lookupObjId($parent));
             $tp .= sprintf($this->lng->txt('perm_role_path_info_inheritance'), $this->lng->txt('obj_' . $p_type), $p_title);
         }
         
         return $tp;
     }

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

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

References $DIC, $row, ilTable2GUI\getFormName(), getObjType(), getRefId(), getVisibleRoles(), ilPlugin\langExitsById(), and ilObjectPlugin\lookupTxtById().

     {
         global $DIC;
 
         $objDefinition = $DIC['objDefinition'];
         
         
         // local policy
         if (isset($row['show_local_policy_row'])) {
             foreach ($row['roles'] as $role_id => $role_info) {
                 $this->tpl->setCurrentBlock('role_option');
                 $this->tpl->setVariable('INHERIT_ROLE_ID', $role_id);
                 $this->tpl->setVariable('INHERIT_CHECKED', $role_info['local_policy'] ? 'checked=checked' : '');
                 $this->tpl->setVariable('INHERIT_DISABLED', ($role_info['protected'] or $role_info['isLocal'] or $role_info['blocked']) ? 'disabled="disabled"' : '');
                 $this->tpl->setVariable('TXT_INHERIT', $this->lng->txt('rbac_local_policy'));
                 $this->tpl->setVariable('INHERIT_LONG', $this->lng->txt('perm_use_local_policy_desc'));
                 $this->tpl->parseCurrentBlock();
             }
             return true;
         }
         // protected
         if (isset($row['show_protected_row'])) {
             foreach ($row['roles'] as $role_id => $role_info) {
                 $this->tpl->setCurrentBlock('role_protect');
                 $this->tpl->setVariable('PROTECT_ROLE_ID', $role_id);
                 $this->tpl->setVariable('PROTECT_CHECKED', $role_info['protected_status'] ? 'checked=checked' : '');
                 $this->tpl->setVariable('PROTECT_DISABLED', $role_info['protected_allowed'] ? '' : 'disabled="disabled"');
                 $this->tpl->setVariable('TXT_PROTECT', $this->lng->txt('role_protect_permissions'));
                 $this->tpl->setVariable('PROTECT_LONG', $this->lng->txt('role_protect_permissions_desc'));
                 $this->tpl->parseCurrentBlock();
             }
             return true;
         }
         
         // block role
         if (isset($row['show_block_row'])) {
             foreach ($this->getVisibleRoles() as $counter => $role_info) {
                 $this->tpl->setCurrentBlock('role_block');
                 $this->tpl->setVariable('BLOCK_ROLE_ID', $role_info['obj_id']);
                 $this->tpl->setVariable('TXT_BLOCK', $this->lng->txt('role_block_role'));
                 $this->tpl->setVariable('BLOCK_LONG', $this->lng->txt('role_block_role_desc'));
                 if ($role_info['blocked']) {
                     $this->tpl->setVariable('BLOCK_CHECKED', 'checked="checked"');
                 }
                 if (
                     ($role_info['protected'] == 'y') ||
                     ($role_info['assign'] == 'y' and ($role_info['parent'] == $this->getRefId()))
                 ) {
                     $this->tpl->setVariable('BLOCK_DISABLED', 'disabled="disabled');
                 }
                 
                 $this->tpl->parseCurrentBlock();
             }
             return true;
         }
 
         // Select all
         if (isset($row['show_select_all'])) {
             foreach ($this->getVisibleRoles() as $role) {
                 $this->tpl->setCurrentBlock('role_select_all');
                 $this->tpl->setVariable('JS_ROLE_ID', $role['obj_id']);
                 $this->tpl->setVariable('JS_SUBID', $row['subtype']);
                 $this->tpl->setVariable('JS_ALL_PERMS', "['" . implode("','", $row['ops']) . "']");
                 $this->tpl->setVariable('JS_FORM_NAME', $this->getFormName());
                 $this->tpl->setVariable('TXT_SEL_ALL', $this->lng->txt('select_all'));
                 $this->tpl->parseCurrentBlock();
             }
             return true;
         }
 
         // Object permissions
         if (isset($row['show_start_info'])) {
             $this->tpl->setCurrentBlock('section_info');
             $this->tpl->setVariable('SECTION_TITLE', $this->lng->txt('perm_class_object'));
             $this->tpl->setVariable('SECTION_DESC', $this->lng->txt('perm_class_object_desc'));
             $this->tpl->parseCurrentBlock();
             
             return true;
         }
 
         if (isset($row['show_create_info'])) {
             $this->tpl->setCurrentBlock('section_info');
             $this->tpl->setVariable('SECTION_TITLE', $this->lng->txt('perm_class_create'));
             $this->tpl->setVariable('SECTION_DESC', $this->lng->txt('perm_class_create_desc'));
             $this->tpl->parseCurrentBlock();
             
             return true;
         }
 
         foreach ((array) $row['roles'] as $role_id => $role_info) {
             $perm = "";
             $this->tpl->setCurrentBlock('role_td');
             $this->tpl->setVariable('PERM_ROLE_ID', $role_id);
             $this->tpl->setVariable('PERM_PERM_ID', $row['perm']['ops_id']);
             
             
             if (substr($row['perm']['operation'], 0, 6) == 'create') {
                 if ($objDefinition->isPlugin(substr($row['perm']['operation'], 7))) {
                     $perm = ilObjectPlugin::lookupTxtById(
                         substr($row['perm']['operation'], 7),
                         "obj_" . substr($row['perm']['operation'], 7)
                     );
                 } else {
                     $perm = $this->lng->txt('obj_' . substr($row['perm']['operation'], 7));
                 }
             } else {
                 if ($objDefinition->isPlugin($this->getObjType())) {
                     if (ilPlugin::langExitsById($this->getObjType(), $row['perm']['operation'])) {
                         $perm = ilObjectPlugin::lookupTxtById($this->getObjType(), $row['perm']['operation']);
                     }
                 }
 
                 if (!$perm) {
                     if ($this->lng->exists($this->getObjType() . '_' . $row['perm']['operation'] . '_short')) {
                         $perm = $this->lng->txt($this->getObjType() . '_' . $row['perm']['operation'] . '_short');
                     } else {
                         $perm = $this->lng->txt($row['perm']['operation']);
                     }
                 }
             }
             
             $this->tpl->setVariable('TXT_PERM', $perm);
             
             if ($objDefinition->isPlugin($this->getObjType())) {
                 $this->tpl->setVariable('PERM_LONG', ilObjectPlugin::lookupTxtById(
                     $this->getObjType(),
                     $this->getObjType() . "_" . $row['perm']['operation']
                 ));
             } elseif (substr($row['perm']['operation'], 0, 6) == 'create') {
                 $this->tpl->setVariable('PERM_LONG', $this->lng->txt('rbac_' . $row['perm']['operation']));
             } else {
                 $this->tpl->setVariable('PERM_LONG', $this->lng->txt($this->getObjType() . '_' . $row['perm']['operation']));
             }
             
             if ($role_info['protected'] || $role_info['blocked']) {
                 $this->tpl->setVariable('PERM_DISABLED', 'disabled="disabled"');
             }
             if ($role_info['permission_set']) {
                 $this->tpl->setVariable('PERM_CHECKED', 'checked="checked"');
             }
 
             $this->tpl->parseCurrentBlock();
         }
     }

Here is the call graph for this function:

◆ getActiveOperations()

ilObjectRolePermissionTableGUI::getActiveOperations ( )

get active operations

Returns

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

References $activeOperations.

     {
         return (array) $this->activeOperations;
     }

◆ getObjId()

ilObjectRolePermissionTableGUI::getObjId ( )

Get obj id.

Returns

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

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

Referenced by getObjType().

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

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 105 of file class.ilObjectRolePermissionTableGUI.php.

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

Referenced by fillRow(), and parse().

     {
         return ilObject::_lookupType($this->getObjId());
     }

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

References $tree_path_ids.

     {
         return (array) $this->tree_path_ids;
     }

◆ getRefId()

ilObjectRolePermissionTableGUI::getRefId ( )

Get ref id of current object.

Returns

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

References $ref_id.

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

     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getVisibleRoles()

ilObjectRolePermissionTableGUI::getVisibleRoles ( )

get visible roles

Returns

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

References $visible_roles.

Referenced by fillRow(), and parse().

     {
         return $this->visible_roles;
     }

Here is the caller graph for this function:

◆ initColumns()

ilObjectRolePermissionTableGUI::initColumns ( )

protected

init Columns

Returns

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

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

Referenced by parse().

     {
         global $DIC;
 
         $rbacreview = $DIC['rbacreview'];
         $ilCtrl = $DIC['ilCtrl'];
         
         $roles = $rbacreview->getParentRoleIds($this->getRefId());
         $roles = $this->getParentObject()->applyRoleFilter(
             $roles,
             $this->getFilterItemByPostVar('role')->getValue()
         );
         
         $possible_roles = array();
         foreach ($roles as $role) {
             if ($rbacreview->isBlockedInUpperContext($role['obj_id'], $this->getRefId())) {
                 ilLoggerFactory::getLogger('ac')->debug('Ignoring blocked role: ' . $role['obj_id']);
                 continue;
             }
             $possible_roles[] = $role;
         }
         
         
         if (count($possible_roles)) {
             $column_width = 100 / count($possible_roles);
             $column_width .= '%';
         } else {
             $column_widht = "0%";
         }
         
         $all_roles = array();
         foreach ($possible_roles as $role) {
             if ($role['obj_id'] == SYSTEM_ROLE_ID) {
                 continue;
             }
             
             $role['blocked'] = (bool) $rbacreview->isBlockedAtPosition($role['obj_id'], $this->getRefId());
             $role['role_type'] = $rbacreview->isGlobalRole($role['obj_id']) ? 'global' : 'local';
             
             // TODO check filter
             $this->addColumn(
                 $this->createTitle($role),
                 $role['obj_id'],
                 '',
                 '',
                 false,
                 $this->createTooltip($role)
             );
             $all_roles[] = $role;
         }
 
         $this->setVisibleRoles($all_roles);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFilter()

ilObjectRolePermissionTableGUI::initFilter ( )

Init role filter.

Returns

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

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

Referenced by __construct().

     {
         global $DIC;
 
         $tree = $DIC['tree'];
         
         $roles = $this->addFilterItemByMetaType(
             'role',
             ilTable2GUI::FILTER_SELECT
         );
         
         // Limit filter to local roles only for objects with group or course in path
         if (!$roles->getValue()) {
             if ($tree->checkForParentType($this->getRefId(), 'crs') or
                 $tree->checkForParentType($this->getRefId(), 'grp')) {
                 $roles->setValue(self::ROLE_FILTER_LOCAL);
             } else {
                 $roles->setValue(self::ROLE_FILTER_ALL);
             }
         }
         
         
         $roles->setOptions(
             array(
                 self::ROLE_FILTER_ALL => $this->lng->txt('filter_all_roles'),
                 self::ROLE_FILTER_GLOBAL => $this->lng->txt('filter_global_roles'),
                 self::ROLE_FILTER_LOCAL => $this->lng->txt('filter_local_roles'),
                 self::ROLE_FILTER_LOCAL_POLICY => $this->lng->txt('filter_roles_local_policy'),
                 self::ROLE_FILTER_LOCAL_OBJECT => $this->lng->txt('filter_local_roles_object')
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse()

ilObjectRolePermissionTableGUI::parse ( )

Parse.

Returns

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

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

     {
         global $DIC;
 
         $rbacreview = $DIC['rbacreview'];
         $objDefinition = $DIC['objDefinition'];
         
         $this->initColumns();
 
         $perms = array();
         $roles = array();
         
         if (!count($this->getVisibleRoles())) {
             return $this->setData(array());
         }
         
         // Read operations of role
         $operations = array();
         foreach ($this->getVisibleRoles() as $role_data) {
             $operations[$role_data['obj_id']] = $rbacreview->getActiveOperationsOfRole($this->getRefId(), $role_data['obj_id']);
         }
         
         $counter = 0;
         
         // Local policy
         if (ilPermissionGUI::hasContainerCommands($this->getObjType())) {
             $roles = array();
             $local_roles = $rbacreview->getRolesOfObject($this->getRefId());
             foreach ($this->getVisibleRoles() as $role_id => $role_data) {
                 $roles[$role_data['obj_id']] = array(
                     'blocked' => $role_data['blocked'],
                     'protected' => $role_data['protected'],
                     'local_policy' => in_array($role_data['obj_id'], $local_roles),
                     'isLocal' => ($this->getRefId() == $role_data['parent']) && $role_data['assign'] == 'y'
                 );
             }
             $perms[$counter]['roles'] = $roles;
             $perms[$counter]['show_local_policy_row'] = 1;
             
             $counter++;
         }
         
         // Protect permissions
         if (ilPermissionGUI::hasContainerCommands($this->getObjType())) {
             $roles = array();
             foreach ($this->getVisibleRoles() as $role_id => $role_data) {
                 $roles[$role_data['obj_id']] = array(
                     'blocked' => $role_data['blocked'],
                     'protected_allowed' => $rbacreview->isAssignable($role_data['obj_id'], $this->getRefId()),
                     'protected_status' => $rbacreview->isProtected($role_data['parent'], $role_data['obj_id']),
                     'isLocal' => ($this->getRefId() == $role_data['parent']) && $role_data['assign'] == 'y'
                 );
             }
             $perms[$counter]['roles'] = $roles;
             $perms[$counter]['show_protected_row'] = 1;
             
             $counter++;
         }
         // Block role
         if (ilPermissionGUI::hasContainerCommands($this->getObjType())) {
             $perms[$counter++]['show_block_row'] = 1;
         }
         
 
         if (ilPermissionGUI::hasContainerCommands($this->getObjType())) {
             $perms[$counter++]['show_start_info'] = true;
         }
 
         // no creation permissions
         $no_creation_operations = array();
         foreach ($rbacreview->getOperationsByTypeAndClass($this->getObjType(), 'object') as $operation) {
             $this->addActiveOperation($operation);
             $no_creation_operations[] = $operation;
 
             $roles = array();
             foreach ($this->getVisibleRoles() as $role_data) {
                 $roles[$role_data['obj_id']] =
                     array(
                         'blocked' => $role_data['blocked'],
                         'protected' => $role_data['protected'],
                         'permission_set' => in_array($operation, (array) $operations[$role_data['obj_id']]),
                         'isLocal' => ($this->getRefId() == $role_data['parent']) && $role_data['assign'] == 'y'
                     );
             }
             
             $op = $rbacreview->getOperation($operation);
 
             $perms[$counter]['roles'] = $roles;
             $perms[$counter]['perm'] = $op;
             $counter++;
         }
         
         /*
          * Select all
          */
         if ($no_creation_operations) {
             $perms[$counter]['show_select_all'] = 1;
             $perms[$counter]['ops'] = $no_creation_operations;
             $perms[$counter]['subtype'] = 'nocreation';
             $counter++;
         }
         
         
         if ($objDefinition->isContainer($this->getObjType())) {
             $perms[$counter++]['show_create_info'] = true;
         }
 
         // Get creatable objects
         $objects = $objDefinition->getCreatableSubObjects($this->getObjType());
         $ops_ids = ilRbacReview::lookupCreateOperationIds(array_keys($objects));
         $creation_operations = array();
         foreach ($objects as $type => $info) {
             $ops_id = $ops_ids[$type];
             
             if (!$ops_id) {
                 continue;
             }
             
             $this->addActiveOperation($ops_id);
             $creation_operations[] = $ops_id;
             
             $roles = array();
             foreach ($this->getVisibleRoles() as $role_data) {
                 $roles[$role_data['obj_id']] =
                     array(
                         'blocked' => $role_data['blocked'],
                         'protected' => $role_data['protected'],
                         'permission_set' => in_array($ops_id, (array) $operations[$role_data['obj_id']]),
                         'isLocal' => ($this->getRefId() == $role_data['parent']) && $role_data['assign'] == 'y'
                         
                     );
             }
             
             $op = $rbacreview->getOperation($ops_id);
 
             $perms[$counter]['roles'] = $roles;
             $perms[$counter]['perm'] = $op;
             $counter++;
         }
     
         
         
         // Select all
         if (count($creation_operations)) {
             $perms[$counter]['show_select_all'] = 1;
             $perms[$counter]['ops'] = $creation_operations;
             $perms[$counter]['subtype'] = 'creation';
             $counter++;
         }
 
         $this->setData($perms);
     }

Here is the call graph for this function:

◆ setVisibleRoles()

ilObjectRolePermissionTableGUI::setVisibleRoles ( $a_ar )

Set Visible roles.

Parameters

object $a_ar

Returns

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

Referenced by initColumns().

     {
         $this->visible_roles = $a_ar;
     }

Here is the caller graph for this function:

Field Documentation

◆ $activeOperations

ilObjectRolePermissionTableGUI::$activeOperations = array()

private

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

Referenced by getActiveOperations().

◆ $ref_id

ilObjectRolePermissionTableGUI::$ref_id = null

private

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

Referenced by getRefId().

◆ $roles

ilObjectRolePermissionTableGUI::$roles = array()

private

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

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

◆ $tree_path_ids

ilObjectRolePermissionTableGUI::$tree_path_ids = array()

private

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

Referenced by getPathIds().

◆ $visible_roles

ilObjectRolePermissionTableGUI::$visible_roles = array()

private

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

Referenced by getVisibleRoles().

◆ ROLE_FILTER_ALL

const ilObjectRolePermissionTableGUI::ROLE_FILTER_ALL = 1

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

Referenced by ilPermissionGUI\applyRoleFilter().

◆ ROLE_FILTER_GLOBAL

const ilObjectRolePermissionTableGUI::ROLE_FILTER_GLOBAL = 2

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

Referenced by ilPermissionGUI\applyRoleFilter().

◆ ROLE_FILTER_LOCAL

const ilObjectRolePermissionTableGUI::ROLE_FILTER_LOCAL = 3

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

Referenced by ilPermissionGUI\applyRoleFilter().

◆ ROLE_FILTER_LOCAL_OBJECT

const ilObjectRolePermissionTableGUI::ROLE_FILTER_LOCAL_OBJECT = 5

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

Referenced by ilPermissionGUI\applyRoleFilter().

◆ ROLE_FILTER_LOCAL_POLICY

const ilObjectRolePermissionTableGUI::ROLE_FILTER_LOCAL_POLICY = 4

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

Referenced by ilPermissionGUI\applyRoleFilter().

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

Services/AccessControl/classes/class.ilObjectRolePermissionTableGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addActiveOperation()

◆ createTitle()

◆ createTooltip()

◆ fillRow()

◆ getActiveOperations()

◆ getObjId()

◆ getObjType()

◆ getPathIds()

◆ getRefId()

◆ getVisibleRoles()

◆ initColumns()

◆ initFilter()

◆ parse()

◆ setVisibleRoles()

Field Documentation

◆ $activeOperations

◆ $ref_id

◆ $roles

◆ $tree_path_ids

◆ $visible_roles

◆ ROLE_FILTER_ALL

◆ ROLE_FILTER_GLOBAL

◆ ROLE_FILTER_LOCAL

◆ ROLE_FILTER_LOCAL_OBJECT

◆ ROLE_FILTER_LOCAL_POLICY