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

Inheritance diagram for ilRoleTableGUI:

Collaboration diagram for ilRoleTableGUI:

Public Member Functions
	__construct ($a_parent_gui, $a_parent_cmd)
	Constructor. More...

	setType ($a_type)
	Set table type. More...

	setRoleTitleFilter ($a_filter)
	Set role title filter. More...

	getRoleTitleFilter ()
	Get role title filter. More...

	getType ()
	Get table type. More...

	init ()
	Init table. More...

	initFilter ()
	Init filter. More...

	fillRow ($set)

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

Public Member Functions inherited from ilTable2GUI
	__construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
	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)
	set table data @access public More...

	getData ()

	dataExists ()

	setPrefix ($a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More...

	getPrefix ()

	addFilterItem ($a_input_item, $a_optional=false)
	Add filter item. More...

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

	getFilterItems ($a_optionals=false)
	Get filter items. More...

	getFilterItemByPostVar ($a_post_var)

	setFilterCols ($a_val)
	Set filter columns. More...

	getFilterCols ()
	Get filter columns. More...

	setDisableFilterHiding ($a_val=true)
	Set disable filter hiding. More...

	getDisableFilterHiding ()
	Get disable filter hiding. More...

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

	getSelectedFilters ()
	Get selected filters. More...

	determineSelectedFilters ()
	Determine selected filters. More...

	setCustomPreviousNext ($a_prev_link, $a_next_link)
	Set custom previous/next links. More...

	setFormAction ($a_form_action, $a_multipart=false)
	Set Form action parameter. More...

	getFormAction ()
	Get Form action parameter. More...

	setFormName ($a_formname="")
	Set Form name. More...

	getFormName ()
	Get Form name. More...

	setId ($a_val)
	Set id. More...

	getId ()
	Get element id. More...

	setDisplayAsBlock ($a_val)
	Set display as block. More...

	getDisplayAsBlock ()
	Get display as block. More...

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

	setSelectAllCheckbox ($a_select_all_checkbox, $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 @access public More...

	writeFilterToSession ()
	Write filter values to session. More...

	resetFilter ()
	Reset filter. More...

	fillFooter ()
	Fill footer row. More...

	getLinkbar ($a_num)
	Get previous/next linkbar. More...

	fillHiddenRow ()

	fillActionRow ()
	Fill Action Row. More...

	setHeaderHTML ($html)
	set header html More...

	storeProperty ($type, $value)
	Store table property. More...

	loadProperty ($type)
	Load table property. More...

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

	setContext ($id)
	Set context. More...

	getContext ()
	Get context. More...

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

	getShowRowsSelector ()
	Get rows-per-page selector state. More...

	setShowTemplates ($a_value)
	Toggle templates. More...

	getShowTemplates ()
	Get template state. More...

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

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

	deleteTemplate ($a_name)
	Delete template. More...

	getLimit ()
	Get limit. More...

	getOffset ()
	Get offset. More...

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

	setPrintMode ($a_value=false)
	Toogle print mode. More...

	getPrintMode ()
	Get print mode. More...

	getExportMode ()
	Was export activated? More...

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

	setEnableAllCommand ($a_value)
	Enable actions for all entries in current result. More...

	setRowSelectorLabel ($row_selector_label)

	getRowSelectorLabel ()

	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...

	getPreventDoubleSubmission ()
	Get prevent double submission. More...

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

Public Member Functions inherited from ilTableGUI
	__construct ($a_data=0, $a_global_tpl=true)
	Constructor. More...

	setTemplate ($a_tpl)
	set template @access public More...

&	getTemplateObject ()

	setData ($a_data)
	set table data @access public More...

	getData ()

	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	set table title @access public More...

	setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
	set table help page @access public More...

	setHeaderNames ($a_header_names)
	set table header names @access public More...

	getColumnCount ()
	Returns the column count based on the number of the header row columns @access public. More...

	setHeaderVars ($a_header_vars, $a_header_params=0)
	set table header vars @access public More...

	setColumnWidth ($a_column_width)
	set table column widths @access public More...

	setOneColumnWidth ($a_column_width, $a_column_number)
	set one table column width @access public More...

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

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

	getLimit ()
	Get limit. More...

	setPrefix ($a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More...

	setOffset ($a_offset)
	set dataset offset @access public More...

	getOffset ()
	Get offset. More...

	setOrderColumn ($a_order_column=0, $a_default_column=0)
	set order column @access public More...

	getOrderColumn ()
	Get order column. More...

	setOrderDirection ($a_order_direction)
	set order direction @access public More...

	getOrderDirection ()
	Get order direction. More...

	setFooter ($a_style, $a_previous=0, $a_next=0)
	set order direction @access public More...

	enable ($a_module_name)
	enables particular modules of table More...

	disable ($a_module_name)
	diesables particular modules of table More...

	sortData ()

	render ()
	render table @access public More...

	renderHeader ()

	setOrderLink ($key, $order_dir)

	setStyle ($a_element, $a_style)

	getStyle ($a_element)

	setBase ($a_base)
	Set Base script name (deprecated, only use this for workarounds). More...

	getBase ()
	Get Base script name (deprecated, only use this for workarounds). More...

	getFormName ()

	setFormName ($a_name="cmd")

	getSelectAllCheckbox ()

	setSelectAllCheckbox ($a_select_all_checkbox)

	clearActionButtons ()

	addActionButton ($btn_name, $btn_value)

Data Fields
const	TYPE_GLOBAL_AU = 1

const	TYPE_GLOBAL_UD = 2

const	TYPE_LOCAL_AU = 3

const	TYPE_LOCAL_UD = 4

const	TYPE_ROLT_AU = 5

const	TYPE_ROLT_UD = 6

const	TYPE_VIEW = 1

const	TYPE_SEARCH = 2

Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1

const	FILTER_SELECT = 2

const	FILTER_DATE = 3

const	FILTER_LANGUAGE = 4

const	FILTER_NUMBER_RANGE = 5

const	FILTER_DATE_RANGE = 6

const	FILTER_DURATION_RANGE = 7

const	FILTER_DATETIME_RANGE = 8

const	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
	getPathGUI ()
	Get path gui. 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
	$path_gui = null

	$type = self::TYPE_VIEW

	$role_title_filter = ''

	$role_folder_id = 0

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

TableGUI for the presentation og roles and role templates.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilRoleTableGUI::__construct	(	$a_parent_gui,
		$a_parent_cmd
	)

Constructor.

Parameters

object	$a_parent_gui
string	$a_parent_cmd

Reimplemented from ilTableGUI.

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

    {
        global $DIC;
 
        $ilCtrl = $DIC['ilCtrl'];
 
        $this->ctrl = $ilCtrl;
 
        $this->setId('rolf_role_tbl');
        
        parent::__construct($a_parent_gui, $a_parent_cmd);
        $this->lng->loadLanguageModule('rbac');
        $this->lng->loadLanguageModule('search');
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilRoleTableGUI::fillRow ( $set )

Parameters

array $set

if((substr($set['title_orig'],0,3) == 'il_') and ($set['type'] == 'rolt')) { $this->tpl->setVariable('VAL_PRE',$this->lng->txt('predefined_template')); }

Reimplemented from ilTable2GUI.

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

    {
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
        $tree = $DIC['tree'];
 
        if ($set['type'] == 'role') {
            if ($set['parent'] != ROLE_FOLDER_ID) {
                $this->ctrl->setParameterByClass(
                    "ilobjrolegui",
                    "rolf_ref_id",
                    $set['parent']
                );
            }
 
            $this->ctrl->setParameterByClass("ilobjrolegui", "obj_id", $set["obj_id"]);
            $link = $this->ctrl->getLinkTargetByClass("ilobjrolegui", "perm");
            $this->ctrl->setParameterByClass("ilobjrolegui", "rolf_ref_id", "");
        } else {
            $this->ctrl->setParameterByClass("ilobjroletemplategui", "obj_id", $set["obj_id"]);
            $link = $this->ctrl->getLinkTargetByClass("ilobjroletemplategui", "perm");
        }
 
        switch ($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 (
            ($set['obj_id'] != ANONYMOUS_ROLE_ID and
            $set['obj_id'] != SYSTEM_ROLE_ID and
            substr($set['title_orig'], 0, 3) != 'il_') or
            $this->getType() == self::TYPE_SEARCH) {
            $this->tpl->setVariable('VAL_ID', $set['obj_id']);
        }
        $this->tpl->setVariable('VAL_TITLE_LINKED', $set['title']);
        $this->tpl->setVariable('VAL_LINK', $link);
        if (strlen($set['description'])) {
            $this->tpl->setVariable('VAL_DESC', $set['description']);
        }
 
        $ref = $set['parent'];
        if ($ref == ROLE_FOLDER_ID) {
            $this->tpl->setVariable('CONTEXT', $this->lng->txt('rbac_context_global'));
        } else {
            $this->tpl->setVariable(
                'CONTEXT',
                (string) $this->getPathGUI()->getPath(ROOT_FOLDER_ID, $ref)
            );
        }
 
        if ($this->getType() == self::TYPE_VIEW and $set['obj_id'] != SYSTEM_ROLE_ID) {
            if ($GLOBALS['DIC']['rbacsystem']->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", $set["obj_id"]);
                $link = $this->ctrl->getLinkTarget($this->getParentObject(), 'roleSearch');
                $this->tpl->setVariable(
                    'COPY_LINK',
                    $link
                );
            }
        }
    }

References $DIC, $GLOBALS, ilTable2GUI\getParentObject(), getPathGUI(), getType(), TYPE_GLOBAL_AU, TYPE_GLOBAL_UD, TYPE_LOCAL_AU, TYPE_LOCAL_UD, TYPE_ROLT_AU, and TYPE_ROLT_UD.

Here is the call graph for this function:

◆ getPathGUI()

ilRoleTableGUI::getPathGUI ( )

protected

Get path gui.

Returns: ilPathGUI $path

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

    {
        return $this->path_gui;
    }

References $path_gui.

Referenced by fillRow(), and init().

Here is the caller graph for this function:

◆ getRoleTitleFilter()

ilRoleTableGUI::getRoleTitleFilter ( )

Get role title filter.

Returns: string

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

    {
        return $this->role_title_filter;
    }

References $role_title_filter.

Referenced by parse().

Here is the caller graph for this function:

◆ getType()

ilRoleTableGUI::getType ( )

Get table type.

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

    {
        return $this->type;
    }

References $type.

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

Here is the caller graph for this function:

◆ init()

ilRoleTableGUI::init ( )

Init table.

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

    {
        $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()->object->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');
 
        include_once './Services/Tree/classes/class.ilPathGUI.php';
        $this->path_gui = new ilPathGUI();
        $this->getPathGUI()->enableTextOnly(false);
        $this->getPathGUI()->enableHideLeaf(false);
        
 
        // Filter initialisation
 
        if ($this->getType() == self::TYPE_VIEW) {
            $this->initFilter();
        }
    }

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

Here is the call graph for this function:

◆ initFilter()

ilRoleTableGUI::initFilter ( )

Init filter.

Reimplemented from ilTable2GUI.

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

    {
        $this->setDisableFilterHiding(true);
 
        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;
        }
 
        include_once './Services/Form/classes/class.ilSelectInputGUI.php';
        $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
        include_once './Services/Form/classes/class.ilTextInputGUI.php';
        $title = new ilTextInputGUI($this->lng->txt('title'), 'role_title');
        $title->setSize(16);
        $title->setMaxLength(64);
 
        $this->addFilterItem($title);
        $title->readFromSession();
 
        $this->filter['role_type'] = $roles->getValue();
        $this->filter['role_title'] = $title->getValue();
    }

References ilTableGUI\$title, ilTable2GUI\addFilterItem(), ilRbacReview\FILTER_ALL, ilRbacReview\FILTER_ALL_GLOBAL, ilRbacReview\FILTER_ALL_LOCAL, ilRbacReview\FILTER_INTERNAL, ilRbacReview\FILTER_NOT_INTERNAL, ilRbacReview\FILTER_TEMPLATES, getType(), ilTable2GUI\setDisableFilterHiding(), TYPE_SEARCH, and TYPE_VIEW.

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse()

ilRoleTableGUI::parse ( $role_folder_id )

Parse role list.

Parameters

array $role_list

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

    {
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
        $ilUser = $DIC['ilUser'];
        
        $this->role_folder_id = $role_folder_id;
 
        include_once './Services/AccessControl/classes/class.ilObjRole.php';
        
        if ($this->getType() == self::TYPE_VIEW) {
            $filter_orig = $filter = $this->getFilterItemByPostVar('role_title')->getValue();
            $type = $this->getFilterItemByPostVar('role_type')->getValue();
        } else {
            $filter_orig = $filter = $this->getRoleTitleFilter();
            $type = ilRbacReview::FILTER_ALL;
        }
 
        
        // the translation must be filtered
        if ($type == ilRbacReview::FILTER_INTERNAL or $type == ilRbacReview::FILTER_ALL) {
            // roles like il_crs_... are filtered manually
            $filter = '';
        }
 
        $role_list = $rbacreview->getRolesByFilter(
            $type,
            0,
            $filter
        );
        
        $counter = 0;
        $rows = array();
        foreach ((array) $role_list as $role) {
            if (
                $role['parent'] and
                    (
                        $GLOBALS['DIC']['tree']->isDeleted($role['parent']) or
                        !$GLOBALS['DIC']['tree']->isInTree($role['parent'])
                    )
            ) {
                continue;
            }
            
            $title = ilObjRole::_getTranslation($role['title']);
            if ($type == ilRbacReview::FILTER_INTERNAL or $type == ilRbacReview::FILTER_ALL) {
                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_' ? true : false);
 
 
            // Role templates
            if ($role['type'] == 'rolt') {
                $rows[$counter]['rtype'] = $auto ? self::TYPE_ROLT_AU : self::TYPE_ROLT_UD;
            } else {
                // Roles
                if ($role['parent'] == ROLE_FOLDER_ID) {
                    if ($role['obj_id'] == ANONYMOUS_ROLE_ID or $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);
    }

References $DIC, $GLOBALS, $ilUser, $role_folder_id, $rows, ilTableGUI\$title, $type, ilObjRole\_getTranslation(), ilRbacReview\FILTER_ALL, ilRbacReview\FILTER_INTERNAL, ilTable2GUI\getFilterItemByPostVar(), getRoleTitleFilter(), getType(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), TYPE_GLOBAL_AU, TYPE_GLOBAL_UD, TYPE_LOCAL_AU, TYPE_LOCAL_UD, TYPE_ROLT_AU, and TYPE_ROLT_UD.

Here is the call graph for this function:

◆ setRoleTitleFilter()

ilRoleTableGUI::setRoleTitleFilter ( $a_filter )

Set role title filter.

Parameters

string $a_filter

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

    {
        $this->role_title_filter = $a_filter;
    }

◆ setType()

ilRoleTableGUI::setType ( $a_type )

Set table type.

Parameters

int $a_type

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

    {
        $this->type = $a_type;
    }

References $a_type.

Field Documentation

◆ $path_gui

ilRoleTableGUI::$path_gui = null

private

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

Referenced by getPathGUI().

◆ $role_folder_id

ilRoleTableGUI::$role_folder_id = 0

private

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

Referenced by parse().

◆ $role_title_filter

ilRoleTableGUI::$role_title_filter = ''

private

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

Referenced by getRoleTitleFilter().

◆ $type

ilRoleTableGUI::$type = self::TYPE_VIEW

private

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

Referenced by getType(), and parse().

◆ TYPE_GLOBAL_AU

const ilRoleTableGUI::TYPE_GLOBAL_AU = 1

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

Referenced by fillRow(), and parse().

◆ TYPE_GLOBAL_UD

const ilRoleTableGUI::TYPE_GLOBAL_UD = 2

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

Referenced by fillRow(), and parse().

◆ TYPE_LOCAL_AU

const ilRoleTableGUI::TYPE_LOCAL_AU = 3

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

Referenced by fillRow(), and parse().

◆ TYPE_LOCAL_UD

const ilRoleTableGUI::TYPE_LOCAL_UD = 4

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

Referenced by fillRow(), and parse().

◆ TYPE_ROLT_AU

const ilRoleTableGUI::TYPE_ROLT_AU = 5

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

Referenced by fillRow(), and parse().

◆ TYPE_ROLT_UD

const ilRoleTableGUI::TYPE_ROLT_UD = 6

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

Referenced by fillRow(), and parse().

◆ TYPE_SEARCH

const ilRoleTableGUI::TYPE_SEARCH = 2

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

Referenced by init(), initFilter(), and ilObjRoleFolderGUI\roleSearchListObject().

◆ TYPE_VIEW

const ilRoleTableGUI::TYPE_VIEW = 1

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

Referenced by init(), and initFilter().

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

◆ $path_gui

◆ $role_folder_id

◆ $role_title_filter

◆ $type

◆ TYPE_GLOBAL_AU

◆ TYPE_GLOBAL_UD

◆ TYPE_LOCAL_AU

◆ TYPE_LOCAL_UD

◆ TYPE_ROLT_AU

◆ TYPE_ROLT_UD

◆ TYPE_SEARCH

◆ TYPE_VIEW