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

Inheritance diagram for ilRoleTableGUI:

Collaboration diagram for ilRoleTableGUI:

Public Member Functions
	__construct (object $a_parent_gui, string $a_parent_cmd)

	init ()
	Init table. More...

	getType ()

	setType (int $a_type)

	initFilter ()
	Init filter. More...

	parse (int $role_folder_id)
	Parse role list. More...

	getRoleTitleFilter ()

	setRoleTitleFilter (string $a_filter)

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 ()

	setShowTemplates (bool $a_value)

	getShowTemplates ()

	restoreTemplate (string $a_name)
	Restore state from template. More...

	saveTemplate (string $a_name)
	Save current state as template. More...

	deleteTemplate (string $a_name)

	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	TYPE_VIEW = 1

const	TYPE_SEARCH = 2

Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1

const	FILTER_SELECT = 2

const	FILTER_DATE = 3

const	FILTER_LANGUAGE = 4

const	FILTER_NUMBER_RANGE = 5

const	FILTER_DATE_RANGE = 6

const	FILTER_DURATION_RANGE = 7

const	FILTER_DATETIME_RANGE = 8

const	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)

	getPathGUI ()

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

Private Attributes
const	TYPE_GLOBAL_AU = 1

const	TYPE_GLOBAL_UD = 2

const	TYPE_LOCAL_AU = 3

const	TYPE_LOCAL_UD = 4

const	TYPE_ROLT_AU = 5

const	TYPE_ROLT_UD = 6

const	FILTER_ROLE_TYPE = 'role_type'

const	FILTER_TITLE = 'title'

ilPathGUI	$path_gui

int	$type = self::TYPE_VIEW

string	$role_title_filter = ''

int	$role_folder_id = 0

array	$filter = []

ilTree	$tree

ilRbacReview	$rbacreview

ilRbacSystem	$system

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='')

Protected Attributes inherited from ilTable2GUI
string	$requested_tmpl_delete

string	$requested_tmpl_create

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_templates = false

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

Detailed Description

TableGUI for the presentation og roles and role templates.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilRoleTableGUI::__construct	(	object	$a_parent_gui,
		string	$a_parent_cmd
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and ilTable2GUI\setId().

     {
         global $DIC;
 
         $this->rbacreview = $DIC->rbac()->review();
         $this->tree = $DIC->repositoryTree();
         $this->system = $DIC->rbac()->system();
 
         $this->setId('rolf_role_tbl');
         parent::__construct($a_parent_gui, $a_parent_cmd);
         $this->lng->loadLanguageModule('rbac');
         $this->lng->loadLanguageModule('search');
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilRoleTableGUI::fillRow ( array $a_set )

protected

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

References ANONYMOUS_ROLE_ID, ILIAS\Repository\ctrl(), ilTable2GUI\getParentObject(), getPathGUI(), getType(), ILIAS\Repository\lng(), ROLE_FOLDER_ID, ROOT_FOLDER_ID, and SYSTEM_ROLE_ID.

                                             : void
     {
         if ($a_set['type'] == 'role') {
             if ($a_set['parent'] != ROLE_FOLDER_ID) {
                 $this->ctrl->setParameterByClass(
                     "ilobjrolegui",
                     "rolf_ref_id",
                     $a_set['parent']
                 );
             }
 
             $this->ctrl->setParameterByClass("ilobjrolegui", "obj_id", $a_set["obj_id"]);
             $link = $this->ctrl->getLinkTargetByClass("ilobjrolegui", "perm");
             $this->ctrl->setParameterByClass("ilobjrolegui", "rolf_ref_id", "");
         } else {
             $this->ctrl->setParameterByClass("ilobjroletemplategui", "obj_id", $a_set["obj_id"]);
             $link = $this->ctrl->getLinkTargetByClass("ilobjroletemplategui", "perm");
         }
 
         switch ($a_set['rtype']) {
             case self::TYPE_GLOBAL_AU:
                 $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_auto_global'));
                 break;
             case self::TYPE_GLOBAL_UD:
                 $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_ud_global'));
                 break;
             case self::TYPE_LOCAL_AU:
                 $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_auto_local'));
                 break;
             case self::TYPE_LOCAL_UD:
                 $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_ud_local'));
                 break;
             case self::TYPE_ROLT_AU:
                 $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_auto_rolt'));
                 break;
             case self::TYPE_ROLT_UD:
                 $this->tpl->setVariable('ROLE_TYPE', $this->lng->txt('rbac_ud_rolt'));
                 break;
         }
 
         if (
             $a_set['obj_id'] != ANONYMOUS_ROLE_ID && $a_set['obj_id'] != SYSTEM_ROLE_ID && substr($a_set['title_orig'], 0, 3) != 'il_' || $this->getType() == self::TYPE_SEARCH) {
             $this->tpl->setVariable('VAL_ID', $a_set['obj_id']);
         }
         $this->tpl->setVariable('VAL_TITLE_LINKED', $a_set['title']);
         $this->tpl->setVariable('VAL_LINK', $link);
         if (strlen($a_set['description'])) {
             $this->tpl->setVariable('VAL_DESC', $a_set['description']);
         }
 
         $ref = $a_set['parent'];
         if ($ref == ROLE_FOLDER_ID) {
             $this->tpl->setVariable('CONTEXT', $this->lng->txt('rbac_context_global'));
         } else {
             $this->tpl->setVariable(
                 'CONTEXT',
                 $this->getPathGUI()->getPath(ROOT_FOLDER_ID, (int) $ref)
             );
         }
 
         if ($this->getType() == self::TYPE_VIEW and $a_set['obj_id'] != SYSTEM_ROLE_ID) {
             if ($this->system->checkAccess('write', $this->role_folder_id)) {
                 // Copy role
                 $this->tpl->setVariable('COPY_TEXT', $this->lng->txt('rbac_role_rights_copy'));
                 $this->ctrl->setParameter($this->getParentObject(), "csource", $a_set["obj_id"]);
                 $link = $this->ctrl->getLinkTarget($this->getParentObject(), 'roleSearch');
                 $this->tpl->setVariable(
                     'COPY_LINK',
                     $link
                 );
             }
         }
     }

Here is the call graph for this function:

◆ getPathGUI()

ilRoleTableGUI::getPathGUI ( )

protected

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

References $path_gui.

Referenced by fillRow(), and init().

                                    : ilPathGUI
     {
         return $this->path_gui;
     }

Here is the caller graph for this function:

◆ getRoleTitleFilter()

ilRoleTableGUI::getRoleTitleFilter ( )

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

References $role_title_filter.

Referenced by parse().

                                         : string
     {
         return $this->role_title_filter;
     }

Here is the caller graph for this function:

◆ getType()

ilRoleTableGUI::getType ( )

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

References $type.

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

                              : int
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ init()

ilRoleTableGUI::init ( )

Init table.

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

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

                           : void
     {
         $this->addColumn('', 'f', '1px');
 
         switch ($this->getType()) {
             case self::TYPE_VIEW:
                 $this->setShowRowsSelector(true);
                 $this->setDefaultOrderField('title');
                 $this->setDefaultOrderDirection('asc');
                 //$this->setId('rolf_role_tbl');
                 $this->addColumn($this->lng->txt('search_title_description'), 'title', '30%');
                 $this->addColumn($this->lng->txt('type'), 'rtype', '20%');
                 $this->addColumn($this->lng->txt('context'), '', '40%');
                 $this->addColumn($this->lng->txt('actions'), '', '10%');
                 $this->setTitle($this->lng->txt('objs_role'));
 
                 if ($GLOBALS['DIC']['rbacsystem']->checkAccess(
                     'delete',
                     $this->getParentObject()->getObject()->getRefId()
                 )) {
                     $this->addMultiCommand('confirmDelete', $this->lng->txt('delete'));
                 }
                 break;
 
             case self::TYPE_SEARCH:
                 $this->setShowRowsSelector(true);
                 $this->disable('sort');
                 //$this->setId('rolf_role_search_tbl');
                 $this->addColumn($this->lng->txt('search_title_description'), 'title', '30%');
                 $this->addColumn($this->lng->txt('type'), 'rtype', '20%');
                 $this->addColumn($this->lng->txt('context'), '', '50%');
                 $this->setTitle($this->lng->txt('rbac_role_rights_copy'));
                 $this->addMultiCommand('chooseCopyBehaviour', $this->lng->txt('btn_next'));
                 $this->addCommandButton('roleSearch', $this->lng->txt('btn_previous'));
                 break;
         }
 
         $this->setRowTemplate('tpl.role_row.html', 'Services/AccessControl');
         $this->setFormAction($this->ctrl->getFormAction($this->getParentObject()));
         $this->setSelectAllCheckbox('roles');
 
         $this->path_gui = new ilPathGUI();
         $this->getPathGUI()->enableTextOnly(false);
         $this->getPathGUI()->enableHideLeaf(false);
         $this->initFilter();
     }

Here is the call graph for this function:

◆ initFilter()

ilRoleTableGUI::initFilter ( )

Init filter.

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

References ilTableGUI\$title, ilTable2GUI\addFilterItem(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilRbacReview\FILTER_ALL, ilRbacReview\FILTER_ALL_GLOBAL, ilRbacReview\FILTER_ALL_LOCAL, ilRbacReview\FILTER_INTERNAL, ilRbacReview\FILTER_NOT_INTERNAL, ilRbacReview\FILTER_TEMPLATES, getType(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and ilTable2GUI\setDisableFilterHiding().

Referenced by init().

                                 : void
     {
         $this->setDisableFilterHiding(true);
 
         $action = [];
         switch ($this->getType()) {
             case self::TYPE_VIEW:
                 $action[ilRbacReview::FILTER_ALL] = $this->lng->txt('all_roles');
                 $action[ilRbacReview::FILTER_ALL_GLOBAL] = $this->lng->txt('all_global_roles');
                 $action[ilRbacReview::FILTER_ALL_LOCAL] = $this->lng->txt('all_local_roles');
                 $action[ilRbacReview::FILTER_INTERNAL] = $this->lng->txt('internal_local_roles_only');
                 $action[ilRbacReview::FILTER_NOT_INTERNAL] = $this->lng->txt('non_internal_local_roles_only');
                 $action[ilRbacReview::FILTER_TEMPLATES] = $this->lng->txt('role_templates_only');
                 break;
 
             case self::TYPE_SEARCH:
                 $action[ilRbacReview::FILTER_ALL] = $this->lng->txt('all_roles');
                 $action[ilRbacReview::FILTER_ALL_GLOBAL] = $this->lng->txt('all_global_roles');
                 $action[ilRbacReview::FILTER_ALL_LOCAL] = $this->lng->txt('all_local_roles');
                 $action[ilRbacReview::FILTER_INTERNAL] = $this->lng->txt('internal_local_roles_only');
                 $action[ilRbacReview::FILTER_NOT_INTERNAL] = $this->lng->txt('non_internal_local_roles_only');
                 break;
         }
 
         $roles = new ilSelectInputGUI($this->lng->txt('rbac_role_selection'), 'role_type');
         $roles->setOptions($action);
         $this->addFilterItem($roles);
         $roles->readFromSession();
 
         if (!$roles->getValue()) {
             $roles->setValue(ilRbacReview::FILTER_ALL_GLOBAL);
         }
 
         // title filter
         $title = new ilTextInputGUI($this->lng->txt('title'), self::FILTER_TITLE);
         $title->setSize(16);
         $title->setMaxLength(64);
         $this->addFilterItem($title);
         $title->readFromSession();
 
         $this->filter[self::FILTER_ROLE_TYPE] = (int) $roles->getValue();
         $this->filter[self::FILTER_TITLE] = (string) $title->getValue();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse()

ilRoleTableGUI::parse ( int $role_folder_id )

Parse role list.

Parameters

array $role_list

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

References $role_folder_id, $rows, ilTableGUI\$title, ilObjRole\_getTranslation(), ANONYMOUS_ROLE_ID, ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilRbacReview\FILTER_ALL, getRoleTitleFilter(), getType(), ROLE_FOLDER_ID, ilTable2GUI\setData(), ilTableGUI\setMaxCount(), and SYSTEM_ROLE_ID.

                                               : void
     {
         $this->role_folder_id = $role_folder_id;
 
         $filter_orig = '';
         if ($this->getType() == self::TYPE_VIEW) {
             $filter_orig = $this->filter[self::FILTER_TITLE];
             $type_filter = $this->filter[self::FILTER_ROLE_TYPE];
         } else {
             $filter_orig = $this->getRoleTitleFilter();
             $type_filter = ilRbacReview::FILTER_ALL;
         }
 
         $counter = 0;
         $rows = [];
         foreach ($this->rbacreview->getRolesByFilter($type_filter, 0, '') as $role) {
             if (
                 $role['parent'] and
                 (
                     $this->tree->isDeleted($role['parent']) ||
                     !$this->tree->isInTree($role['parent'])
                 )
             ) {
                 continue;
             }
             $title = ilObjRole::_getTranslation($role['title']);
             if (strlen($filter_orig)) {
                 if (stristr($title, $filter_orig) == false) {
                     continue;
                 }
             }
 
             $rows[$counter]['title_orig'] = $role['title'];
             $rows[$counter]['title'] = $title;
             $rows[$counter]['description'] = $role['description'];
             $rows[$counter]['obj_id'] = $role['obj_id'];
             $rows[$counter]['parent'] = $role['parent'];
             $rows[$counter]['type'] = $role['type'];
 
             $auto = substr($role['title'], 0, 3) == 'il_';
 
             // Role templates
             if ($role['type'] == 'rolt') {
                 $rows[$counter]['rtype'] = $auto ? self::TYPE_ROLT_AU : self::TYPE_ROLT_UD;
             } elseif ($role['parent'] == ROLE_FOLDER_ID) {
                 // Roles
                 if ($role['obj_id'] == ANONYMOUS_ROLE_ID || $role['obj_id'] == SYSTEM_ROLE_ID) {
                     $rows[$counter]['rtype'] = self::TYPE_GLOBAL_AU;
                 } else {
                     $rows[$counter]['rtype'] = self::TYPE_GLOBAL_UD;
                 }
             } else {
                 $rows[$counter]['rtype'] = $auto ? self::TYPE_LOCAL_AU : self::TYPE_LOCAL_UD;
             }
 
             ++$counter;
         }
         $this->setMaxCount(count($rows));
         $this->setData($rows);
     }

Here is the call graph for this function:

◆ setRoleTitleFilter()

ilRoleTableGUI::setRoleTitleFilter ( string $a_filter )

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

                                                         : void
     {
         $this->role_title_filter = $a_filter;
     }

◆ setType()

ilRoleTableGUI::setType ( int $a_type )

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

                                         : void
     {
         $this->type = $a_type;
     }

Field Documentation

◆ $filter

array ilRoleTableGUI::$filter = []

private

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

◆ $path_gui

ilPathGUI ilRoleTableGUI::$path_gui

private

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

Referenced by getPathGUI().

◆ $rbacreview

ilRbacReview ilRoleTableGUI::$rbacreview

private

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

◆ $role_folder_id

int ilRoleTableGUI::$role_folder_id = 0

private

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

Referenced by parse().

◆ $role_title_filter

string ilRoleTableGUI::$role_title_filter = ''

private

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

Referenced by getRoleTitleFilter().

◆ $system

ilRbacSystem ilRoleTableGUI::$system

private

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

◆ $tree

ilTree ilRoleTableGUI::$tree

private

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

◆ $type

int ilRoleTableGUI::$type = self::TYPE_VIEW

private

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

Referenced by getType().

◆ FILTER_ROLE_TYPE

const ilRoleTableGUI::FILTER_ROLE_TYPE = 'role_type'

private

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

◆ FILTER_TITLE

const ilRoleTableGUI::FILTER_TITLE = 'title'

private

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

◆ TYPE_GLOBAL_AU

const ilRoleTableGUI::TYPE_GLOBAL_AU = 1

private

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

◆ TYPE_GLOBAL_UD

const ilRoleTableGUI::TYPE_GLOBAL_UD = 2

private

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

◆ TYPE_LOCAL_AU

const ilRoleTableGUI::TYPE_LOCAL_AU = 3

private

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

◆ TYPE_LOCAL_UD

const ilRoleTableGUI::TYPE_LOCAL_UD = 4

private

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

◆ TYPE_ROLT_AU

const ilRoleTableGUI::TYPE_ROLT_AU = 5

private

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

◆ TYPE_ROLT_UD

const ilRoleTableGUI::TYPE_ROLT_UD = 6

private

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

◆ TYPE_SEARCH

const ilRoleTableGUI::TYPE_SEARCH = 2

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

Referenced by ilObjRoleFolderGUI\roleSearchListObject().

◆ TYPE_VIEW

const ilRoleTableGUI::TYPE_VIEW = 1

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

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

Services/AccessControl/classes/class.ilRoleTableGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fillRow()

◆ getPathGUI()

◆ getRoleTitleFilter()

◆ getType()

◆ init()

◆ initFilter()

◆ parse()

◆ setRoleTitleFilter()

◆ setType()

Field Documentation

◆ $filter

◆ $path_gui

◆ $rbacreview

◆ $role_folder_id

◆ $role_title_filter

◆ $system

◆ $tree

◆ $type

◆ FILTER_ROLE_TYPE

◆ FILTER_TITLE

◆ TYPE_GLOBAL_AU

◆ TYPE_GLOBAL_UD

◆ TYPE_LOCAL_AU

◆ TYPE_LOCAL_UD

◆ TYPE_ROLT_AU

◆ TYPE_ROLT_UD

◆ TYPE_SEARCH

◆ TYPE_VIEW