Table for object role permissions. More...

Inheritance diagram for ilObjectRolePermissionTableGUI:

Collaboration diagram for ilObjectRolePermissionTableGUI:

Public Member Functions
	__construct (ilPermissionGUI $a_parent_obj, string $a_parent_cmd, int $a_ref_id)

	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 (int $a_ops_id)
	Add active operation. More...

	getActiveOperations ()
	get active operations More...

	setVisibleRoles (array $a_ar)

	getVisibleRoles ()
	get visible roles More...

	initFilter ()
	Init role filter. More...

	parse ()
	Parse. More...

Public Member Functions inherited from ilTable2GUI
	__construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")

	setOpenFormTag (bool $a_val)

	getOpenFormTag ()

	setCloseFormTag (bool $a_val)

	getCloseFormTag ()

	determineLimit ()

	getSelectableColumns ()
	Get selectable columns. More...

	determineSelectedColumns ()

	isColumnSelected (string $col)

	getSelectedColumns ()

	resetOffset (bool $a_in_determination=false)

	initFilter ()

	getParentObject ()

	getParentCmd ()

	setTopAnchor (string $a_val)

	getTopAnchor ()

	setNoEntriesText (string $a_text)

	getNoEntriesText ()

	setIsDataTable (bool $a_val)

	getIsDataTable ()

	setEnableTitle (bool $a_enabletitle)

	getEnableTitle ()

	setEnableHeader (bool $a_enableheader)

	getEnableHeader ()

	setEnableNumInfo (bool $a_val)

	getEnableNumInfo ()

	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")

	setDescription (string $a_val)

	getDescription ()

	setOrderField (string $a_order_field)

	getOrderField ()

	setData (array $a_data)

	getData ()

	dataExists ()

	setPrefix (string $a_prefix)

	getPrefix ()

	addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)

	addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
	Add filter by standard type. More...

	getFilterItems (bool $a_optionals=false)

	getFilterItemByPostVar (string $a_post_var)

	setFilterCols (int $a_val)

	getFilterCols ()

	setDisableFilterHiding (bool $a_val=true)

	getDisableFilterHiding ()

	isFilterSelected (string $a_col)
	Is given filter selected? More...

	getSelectedFilters ()

	determineSelectedFilters ()

	setCustomPreviousNext (string $a_prev_link, string $a_next_link)

	setFormAction (string $a_form_action, bool $a_multipart=false)

	getFormAction ()

	setFormName (string $a_name="")

	getFormName ()

	setId (string $a_val)

	getId ()

	setDisplayAsBlock (bool $a_val)

	getDisplayAsBlock ()

	setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)

	setExternalSorting (bool $a_val)

	getExternalSorting ()

	setFilterCommand (string $a_val, string $a_caption="")

	getFilterCommand ()

	setResetCommand (string $a_val, string $a_caption="")

	getResetCommand ()

	setExternalSegmentation (bool $a_val)

	getExternalSegmentation ()

	setRowTemplate (string $a_template, string $a_template_dir="")
	Set row template. More...

	setDefaultOrderField (string $a_defaultorderfield)

	getDefaultOrderField ()

	setDefaultOrderDirection (string $a_defaultorderdirection)

	getDefaultOrderDirection ()

	setDefaultFilterVisiblity (bool $a_status)

	getDefaultFilterVisibility ()

	clearCommandButtons ()

	addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")

	addCommandButtonInstance (ilButtonBase $a_button)

	addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')

	setCloseCommand (string $a_link)

	addMultiCommand (string $a_cmd, string $a_text)

	addHiddenInput (string $a_name, string $a_value)

	addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")

	setTopCommands (bool $a_val)

	getTopCommands ()

	addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)

	getNavParameter ()

	setOrderLink (string $key, string $order_dir)

	fillHeader ()

	determineOffsetAndOrder (bool $a_omit_offset=false)

	storeNavParameter ()

	getHTML ()
	Get HTML. More...

	numericOrdering (string $a_field)
	Should this field be sorted numeric? More...

	render ()

	writeFilterToSession ()

	resetFilter ()

	fillFooter ()

	getLinkbar (string $a_num)

	fillHiddenRow ()

	fillActionRow ()

	setHeaderHTML (string $html)

	storeProperty (string $type, string $value)

	loadProperty (string $type)

	getCurrentState ()
	get current settings for order, limit, columns and filter More...

	setContext (string $id)

	getContext ()

	setShowRowsSelector (bool $a_value)
	Toggle rows-per-page selector. More...

	getShowRowsSelector ()

	getLimit ()

	getOffset ()

	setExportFormats (array $formats)
	Set available export formats. More...

	setPrintMode (bool $a_value=false)

	getPrintMode ()

	getExportMode ()

	exportData (int $format, bool $send=false)
	Export and optionally send current table data. More...

	setEnableAllCommand (bool $a_value)

	setRowSelectorLabel (string $row_selector_label)

	getRowSelectorLabel ()

	setPreventDoubleSubmission (bool $a_val)

	getPreventDoubleSubmission ()

	setLimit (int $a_limit=0, int $a_default_limit=0)

Public Member Functions inherited from ilTableGUI
	__construct (array $a_data=[], bool $a_global_tpl=true)

	setTemplate (ilTemplate $a_tpl)

	getTemplateObject ()

	setData (array $a_data)
	Set table data. More...

	getData ()

	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")

	setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")

	setHeaderNames (array $a_header_names)

	getColumnCount ()

	setHeaderVars (array $a_header_vars, array $a_header_params=[])

	setColumnWidth (array $a_column_width)
	set table column widths More...

	setOneColumnWidth (string $a_column_width, int $a_column_number)

	setMaxCount (int $a_max_count)
	set max. More...

	setLimit (int $a_limit=0, int $a_default_limit=0)
	set max. More...

	getLimit ()

	setPrefix (string $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) More...

	setOffset (int $a_offset)
	set dataset offset More...

	getOffset ()

	setOrderColumn (string $a_order_column="", string $a_default_column="")

	getOrderColumn ()

	setOrderDirection (string $a_order_direction)

	getOrderDirection ()

	setFooter (string $a_style, string $a_previous="", string $a_next="")

	enable (string $a_module_name)

	disable (string $a_module_name)

	sortData ()

	render ()

	renderHeader ()

	setOrderLink (string $key, string $order_dir)

	setStyle (string $a_element, string $a_style)

	getStyle (string $a_element)

	setBase (string $a_base)

	getBase ()

	getFormName ()
	get the name of the parent form More...

	setFormName (string $a_name="cmd")

	getSelectAllCheckbox ()
	get the name of the checkbox that should be toggled with a select all button More...

	setSelectAllCheckbox (string $a_select_all_checkbox)

	clearActionButtons ()

	addActionButton (string $btn_name, string $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
string	$title = ""

string	$icon = ""

string	$icon_alt = ""

string	$help_page = ""

string	$help_icon = ""

string	$help_icon_alt = ""

array	$header_names = []

array	$header_vars = []

array	$linkbar_vars = []

array	$data = []

int	$column_count = 0

array	$column_width = []

int	$max_count = 0

int	$limit = 0

bool	$max_limit = false

int	$offset = 0

string	$order_column = ""

string	$order_direction = ""

string	$footer_style = ""

string	$footer_previous = ""

string	$footer_next = ""

bool	$lang_support = true

bool	$global_tpl = false

string	$form_name = ""

string	$select_all_checkbox = ""

array	$action_buttons = []

string	$prefix = ""

string	$base = ""

array	$enabled

array	$styles

Protected Member Functions
	fillRow (array $a_set)

	initColumns ()

	createTooltip (array $role)
	Create a linked title for roles with local policy. More...

	createTitle (array $role)
	Create (linked) title. More...

Protected Member Functions inherited from ilTable2GUI
	getRequestedValues ()

	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, ilTableFilterItem $a_element)
	Check if filter element is based on adv md. More...

	fillRow (array $a_set)
	Standard Version of Fill Row. More...

	getFilterValue (ilTableFilterItem $a_item)
	Get current filter value. More...

	setFilterValue (ilTableFilterItem $a_item, $a_value)

	fillMetaExcel (ilExcel $a_excel, int &$a_row)
	Add meta information to excel export. More...

	fillHeaderExcel (ilExcel $a_excel, int &$a_row)
	Excel Version of Fill Header. More...

	fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
	Excel Version of Fill Row. More...

	fillMetaCSV (ilCSVWriter $a_csv)
	Add meta information to csv export. More...

	fillHeaderCSV (ilCSVWriter $a_csv)
	CSV Version of Fill Header. More...

	fillRowCSV (ilCSVWriter $a_csv, array $a_set)
	CSV Version of Fill Row. More...

Protected Attributes
ilTree	$tree

ilRbacReview	$review

ilObjectDefinition	$objDefinition

Protected Attributes inherited from ilTable2GUI
string	$requested_nav_par2 = ""

string	$requested_nav_par = ""

string	$requested_nav_par1 = ""

ILIAS Table TableGUIRequest	$table_request = null

array	$selected_columns = []

ilCtrl	$ctrl

object	$parent_obj = null

string	$parent_cmd = ""

string	$close_command = ""

string	$top_anchor = "il_table_top"

array	$filters = array()

array	$optional_filters = array()

string	$filter_cmd = 'applyFilter'

string	$reset_cmd = 'resetFilter'

int	$filter_cols = 5

bool	$ext_sort = false

bool	$ext_seg = false

string	$context = ""

array	$mi_sel_buttons = []

bool	$disable_filter_hiding = false

bool	$top_commands = true

array	$selectable_columns = array()

array	$selected_column = array()

bool	$show_rows_selector = true

bool	$rows_selector_off = false

bool	$nav_determined = false

bool	$limit_determined = false

bool	$filters_determined = false

bool	$columns_determined = false

bool	$open_form_tag = true

bool	$close_form_tag = true

array	$export_formats = []

int	$export_mode = 0

bool	$print_mode = false

bool	$enable_command_for_all = false

bool	$restore_filter = false

array	$restore_filter_values = []

bool	$default_filter_visibility = false

array	$sortable_fields = array()

bool	$prevent_double_submission = true

string	$row_selector_label = ""

bool	$select_all_on_top = false

array	$sel_buttons = []

string	$nav_value = ''

string	$noentriestext = ''

string	$css_row = ''

bool	$display_as_block = false

string	$description = ''

string	$id = ""

bool	$custom_prev_next = false

string	$reset_cmd_txt = ""

string	$defaultorderfield = ""

string	$defaultorderdirection = ""

array	$column = []

bool	$datatable = false

bool	$num_info = false

bool	$form_multipart = false

array	$row_data = []

string	$order_field = ""

array	$selected_filter = []

string	$form_action = ""

string	$formname = ""

string	$sort_order = ""

array	$buttons = []

array	$multi = []

array	$hidden_inputs = []

array	$header_commands = []

string	$row_template = ""

string	$row_template_dir = ""

string	$filter_cmd_txt = ""

string	$custom_prev = ""

string	$custom_next = ""

array	$raw_post_data = null

ilGlobalTemplateInterface	$main_tpl

Protected Attributes inherited from ilTableGUI
string	$sort_order

string	$link_params

array	$header_params

	$tpl

ilLanguage	$lng

Private Attributes
int	$ref_id

array	$tree_path_ids = []

array	$activeOperations = []

array	$visible_roles = []

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()

Static Public Member Functions inherited from ilTableGUI
static	linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='')

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectRolePermissionTableGUI::__construct	(	ilPermissionGUI	$a_parent_obj,
		string	$a_parent_cmd,
		int	$a_ref_id
	)

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

References $DIC, ilTableGUI\$tpl, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addCommandButton(), ILIAS\Repository\ctrl(), ilTableGUI\disable(), initFilter(), ILIAS\Repository\lng(), ilTable2GUI\setDisableFilterHiding(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setNoEntriesText(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTitle().

     {
         global $DIC;
 
         $this->objDefinition = $DIC['objDefinition'];
         $this->review = $DIC->rbac()->review();
 
         $this->ref_id = $a_ref_id;
         $this->setId('objroleperm_' . $this->ref_id);
         parent::__construct($a_parent_obj, $a_parent_cmd);
 
         $this->lng->loadLanguageModule('rbac');
 
         $this->tree = $DIC->repositoryTree();
         $this->tree_path_ids = $this->tree->getPathId($this->ref_id);
 
         $tpl = $DIC->ui()->mainTemplate();
         $tpl->addJavaScript('assets/js/ilPermSelect.js');
 
         $this->setTitle($this->lng->txt('permission_settings'));
         $this->setEnableHeader(true);
         $this->disable('sort');
         $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, $a_parent_cmd));
         $this->disable('numinfo');
         $this->setRowTemplate("tpl.obj_role_perm_row.html", "components/ILIAS/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 ( int $a_ops_id )

Add active operation.

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

Referenced by parse().

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

Here is the caller graph for this function:

◆ createTitle()

ilObjectRolePermissionTableGUI::createTitle ( array $role )

protected

Create (linked) title.

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

References ilObjRole\_getTranslation(), ilObject\_lookupType(), ilObjRole\_removeObjectId(), ILIAS\Repository\ctrl(), getRefId(), and ilObjectPlugin\lookupTxtById().

Referenced by initColumns().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createTooltip()

ilObjectRolePermissionTableGUI::createTooltip ( array $role )

protected

Create a linked title for roles with local policy.

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

References ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), getRefId(), ILIAS\Repository\lng(), and ilObjectPlugin\lookupTxtById().

Referenced by initColumns().

                                                  : string
     {
         $protected_status = $this->review->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' && $role['role_type'] != 'global' || $role['assign'] == 'n' && $role['role_type'] != 'global'
         ) {
             $tp .= ': ';
 
             $obj = $this->review->getObjectOfRole($role['obj_id']);
             if ($obj) {
                 $type = ilObject::_lookupType($this->getRefId(), true);
                 if ($this->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 = $this->review->getObjectsWithStopedInheritance(
             $role['obj_id'],
             $this->tree->getPathId($this->getRefId())
         );
 
         $reduced_path_hierarchy = array_diff(
             $path_hierarchy,
             [
                 $this->getRefId(),
                 $this->review->getObjectReferenceOfRole($role['obj_id'])
             ]
         );
 
         // Inheritance
         if ($role['assign'] == 'n' && 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 ( array $a_set )

protected

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

References ilTable2GUI\getFormName(), getObjType(), getRefId(), getVisibleRoles(), ilObjectPlugin\langExitsById(), ILIAS\Repository\lng(), and ilObjectPlugin\lookupTxtById().

                                             : void
     {
         // local policy
         if (isset($a_set['show_local_policy_row'])) {
             foreach ($a_set['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'] || $role_info['isLocal'] || $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;
         }
         // protected
         if (isset($a_set['show_protected_row'])) {
             foreach ($a_set['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;
         }
 
         // block role
         if (isset($a_set['show_block_row'])) {
             foreach ($this->getVisibleRoles() as $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' && $role_info['parent'] == $this->getRefId())
                 ) {
                     $this->tpl->setVariable('BLOCK_DISABLED', 'disabled="disabled');
                 }
 
                 $this->tpl->parseCurrentBlock();
             }
             return;
         }
 
         // Select all
         if (isset($a_set['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', $a_set['subtype']);
                 $this->tpl->setVariable('JS_ALL_PERMS', "['" . implode("','", $a_set['ops']) . "']");
                 $this->tpl->setVariable('JS_FORM_NAME', $this->getFormName());
                 $this->tpl->setVariable('TXT_SEL_ALL', $this->lng->txt('select_all'));
                 $this->tpl->parseCurrentBlock();
             }
             return;
         }
 
         // Object permissions
         if (isset($a_set['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;
         }
 
         if (isset($a_set['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;
         }
 
         foreach ((array) $a_set['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', $a_set['perm']['ops_id']);
 
             if (substr($a_set['perm']['operation'], 0, 6) == 'create') {
                 if ($this->objDefinition->isPlugin(substr($a_set['perm']['operation'], 7))) {
                     $perm = ilObjectPlugin::lookupTxtById(
                         substr($a_set['perm']['operation'], 7),
                         "obj_" . substr($a_set['perm']['operation'], 7)
                     );
                 } else {
                     $perm = $this->lng->txt('obj_' . substr($a_set['perm']['operation'], 7));
                 }
             } else {
                 if ($this->objDefinition->isPlugin($this->getObjType())) {
                     if (ilObjectPlugin::langExitsById($this->getObjType(), $a_set['perm']['operation'])) {
                         $perm = ilObjectPlugin::lookupTxtById($this->getObjType(), $a_set['perm']['operation']);
                     }
                 }
 
                 if (!$perm) {
                     if ($this->lng->exists($this->getObjType() . '_' . $a_set['perm']['operation'] . '_short')) {
                         $perm = $this->lng->txt($this->getObjType() . '_' . $a_set['perm']['operation'] . '_short');
                     } else {
                         $perm = $this->lng->txt($a_set['perm']['operation']);
                     }
                 }
             }
 
             $this->tpl->setVariable('TXT_PERM', $perm);
 
             if ($this->objDefinition->isPlugin($this->getObjType())) {
                 $this->tpl->setVariable('PERM_LONG', ilObjectPlugin::lookupTxtById(
                     $this->getObjType(),
                     $this->getObjType() . "_" . $a_set['perm']['operation']
                 ));
             } elseif (substr($a_set['perm']['operation'], 0, 6) == 'create') {
                 if ($this->objDefinition->isPlugin(substr($a_set['perm']['operation'], 7))) {
                     $this->tpl->setVariable('PERM_LONG', ilObjectPlugin::lookupTxtById(
                         substr($a_set['perm']['operation'], 7),
                         $this->getObjType() . "_" . $a_set['perm']['operation']
                     ));
                 } else {
                     $this->tpl->setVariable('PERM_LONG', $this->lng->txt('rbac_' . $a_set['perm']['operation']));
                 }
             } else {
                 $this->tpl->setVariable(
                     'PERM_LONG',
                     $this->lng->txt($this->getObjType() . '_' . $a_set['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: int[]

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

References $activeOperations.

                                          : array
     {
         return $this->activeOperations;
     }

◆ getObjId()

ilObjectRolePermissionTableGUI::getObjId ( )

Get obj id.

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

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

Referenced by getObjType().

                               : int
     {
         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

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

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

Referenced by fillRow(), and parse().

                                 : string
     {
         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.

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

References $tree_path_ids.

                                 : array
     {
         return $this->tree_path_ids;
     }

◆ getRefId()

ilObjectRolePermissionTableGUI::getRefId ( )

Get ref id of current object.

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

References $ref_id.

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

                               : int
     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getVisibleRoles()

ilObjectRolePermissionTableGUI::getVisibleRoles ( )

get visible roles

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

References $visible_roles.

Referenced by fillRow(), and parse().

                                      : array
     {
         return $this->visible_roles;
     }

Here is the caller graph for this function:

◆ initColumns()

ilObjectRolePermissionTableGUI::initColumns ( )

protected

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

References ilTableGUI\$column_width, $DIC, ilTable2GUI\addColumn(), createTitle(), createTooltip(), ilTable2GUI\getFilterItemByPostVar(), ilLoggerFactory\getLogger(), ilTable2GUI\getParentObject(), getRefId(), ILIAS\UI\Implementation\Component\Input\getValue(), ILIAS\Repository\int(), setVisibleRoles(), and SYSTEM_ROLE_ID.

Referenced by parse().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFilter()

ilObjectRolePermissionTableGUI::initFilter ( )

Init role filter.

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

References $DIC, ilTable2GUI\addFilterItemByMetaType(), ilTree\checkForParentType(), ilTable2GUI\FILTER_SELECT, and ILIAS\Repository\lng().

Referenced by __construct().

                                 : void
     {
         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') || $tree->checkForParentType($this->getRefId(), 'grp')) {
                 $roles->setValue(self::ROLE_FILTER_LOCAL);
             } else {
                 $roles->setValue(self::ROLE_FILTER_ALL);
             }
         }
 
         $roles->setOptions(
             [
                 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.

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

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

                            : void
     {
         $this->initColumns();
 
         $perms = [];
         $roles = [];
 
         if ($this->getVisibleRoles() === []) {
             $this->setData([]);
             return;
         }
 
         // Read operations of role
         $operations = [];
         foreach ($this->getVisibleRoles() as $role_data) {
             $operations[$role_data['obj_id']] = $this->review->getActiveOperationsOfRole(
                 $this->getRefId(),
                 $role_data['obj_id']
             );
         }
 
         $counter = 0;
 
         // Local policy
         if (ilPermissionGUI::hasContainerCommands($this->getObjType())) {
             $roles = [];
             $local_roles = $this->review->getRolesOfObject($this->getRefId());
             foreach ($this->getVisibleRoles() as $role_data) {
                 $roles[$role_data['obj_id']] = [
                     '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 = [];
             foreach ($this->getVisibleRoles() as $role_data) {
                 $roles[$role_data['obj_id']] = [
                     'blocked' => $role_data['blocked'],
                     'protected_allowed' => $this->review->isAssignable($role_data['obj_id'], $this->getRefId()),
                     'protected_status' => $this->review->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 = [];
         foreach ($this->review->getOperationsByTypeAndClass($this->getObjType(), 'object') as $operation) {
             $this->addActiveOperation($operation);
             $no_creation_operations[] = $operation;
 
             $roles = [];
             foreach ($this->getVisibleRoles() as $role_data) {
                 $roles[$role_data['obj_id']] =
                     [
                         '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 = $this->review->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 ($this->objDefinition->isContainer($this->getObjType())) {
             $perms[$counter++]['show_create_info'] = true;
         }
 
         // Get creatable objects
         $objects = $this->objDefinition->getCreatableSubObjects($this->getObjType());
         $ops_ids = ilRbacReview::lookupCreateOperationIds(array_keys($objects));
         $creation_operations = [];
         foreach ($objects as $type => $info) {
             $ops_id = $ops_ids[$type] ?? null;
 
             if (!$ops_id) {
                 continue;
             }
 
             $this->addActiveOperation($ops_id);
             $creation_operations[] = $ops_id;
 
             $roles = [];
             foreach ($this->getVisibleRoles() as $role_data) {
                 $roles[$role_data['obj_id']] =
                     [
                         '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 = $this->review->getOperation($ops_id);
 
             $perms[$counter]['roles'] = $roles;
             $perms[$counter]['perm'] = $op;
             $counter++;
         }
 
         // Select all
         if ($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 ( array $a_ar )

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

Referenced by initColumns().

                                                 : void
     {
         $this->visible_roles = $a_ar;
     }

Here is the caller graph for this function:

Field Documentation

◆ $activeOperations

array ilObjectRolePermissionTableGUI::$activeOperations = []

private

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

Referenced by getActiveOperations().

◆ $objDefinition

ilObjectDefinition ilObjectRolePermissionTableGUI::$objDefinition

protected

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

◆ $ref_id

int ilObjectRolePermissionTableGUI::$ref_id

private

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

Referenced by getRefId().

◆ $review

ilRbacReview ilObjectRolePermissionTableGUI::$review

protected

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

◆ $tree

ilTree ilObjectRolePermissionTableGUI::$tree

protected

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

◆ $tree_path_ids

array ilObjectRolePermissionTableGUI::$tree_path_ids = []

private

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

Referenced by getPathIds().

◆ $visible_roles

array ilObjectRolePermissionTableGUI::$visible_roles = []

private

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

Referenced by getVisibleRoles().

◆ ROLE_FILTER_ALL

const ilObjectRolePermissionTableGUI::ROLE_FILTER_ALL = 1

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

Referenced by ilPermissionGUI\applyRoleFilter().

◆ ROLE_FILTER_GLOBAL

const ilObjectRolePermissionTableGUI::ROLE_FILTER_GLOBAL = 2

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

Referenced by ilPermissionGUI\applyRoleFilter().

◆ ROLE_FILTER_LOCAL

const ilObjectRolePermissionTableGUI::ROLE_FILTER_LOCAL = 3

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

Referenced by ilPermissionGUI\applyRoleFilter().

◆ ROLE_FILTER_LOCAL_OBJECT

const ilObjectRolePermissionTableGUI::ROLE_FILTER_LOCAL_OBJECT = 5

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

Referenced by ilPermissionGUI\applyRoleFilter().

◆ ROLE_FILTER_LOCAL_POLICY

const ilObjectRolePermissionTableGUI::ROLE_FILTER_LOCAL_POLICY = 4

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

Referenced by ilPermissionGUI\applyRoleFilter().

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

components/ILIAS/AccessControl/classes/class.ilObjectRolePermissionTableGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

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

◆ $objDefinition

◆ $ref_id

◆ $review

◆ $tree

◆ $tree_path_ids

◆ $visible_roles

◆ ROLE_FILTER_ALL

◆ ROLE_FILTER_GLOBAL

◆ ROLE_FILTER_LOCAL

◆ ROLE_FILTER_LOCAL_OBJECT

◆ ROLE_FILTER_LOCAL_POLICY