ilUserTableGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilUserTableGUI:

Collaboration diagram for ilUserTableGUI:

Public Member Functions
	readUserDefinedFieldsDefinitions ()
	Read user defined fields definitions. More...
	getUserDefinedField (string $a_key)
	Get user defined field. More...
	isUdfColumn (string $a_key)
	getSelectableColumns ()
	Get selectable columns. More...
	getItems ()
	addFilterItemValue ($filter, $value)
	getUserIdsForFilter ()
	initFilter ()
	addFilterItemByUdfType (string $id, int $type, bool $a_optional=false, ?string $caption=null, array $a_options=array())
	Add filter by standard type. 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)
	Set table data. More...
	getData ()
	dataExists ()
	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...
	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 ()
	get the name of the parent form More...
	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)
	set max. More...
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	MODE_USER_FOLDER = 1
const	MODE_LOCAL_USER = 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
	setMode (int $a_mode)
	getMode ()
	getUserFolderId ()
	buildUserQuery ()
	fillRow (array $a_set)
	Standard Version of Fill Row. 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
ILIAS User StandardGUIRequest	$user_request
array	$udf_fields = []
array	$filter = []
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

Private Attributes
int	$mode = null
int	$user_folder_id = 0
bool	$with_write_access = false

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning TableGUI class for user administration

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilUserTableGUI: ilFormPropertyDispatchGUI

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

Member Function Documentation

addFilterItemByUdfType()

ilUserTableGUI::addFilterItemByUdfType	(	string	$id,
		int	$type,
		bool	$a_optional = false,
		?string	$caption = null,
		array	$a_options = array()
	)

Add filter by standard type.

Definition at line 561 of file class.ilUserTableGUI.php.

     : ?ilFormPropertyGUI {
        global $DIC;
 
        $lng = $DIC['lng'];
 
        if (!$caption) {
            $caption = $lng->txt($id);
        }
 
        switch ($type) {
            case UDF_TYPE_SELECT:
                $item = new ilSelectInputGUI($caption, $id);
                $sel_options = array("" => $this->lng->txt("user_all"));
                foreach ($a_options as $o) {
                    $sel_options[$o] = $o;
                }
                $item->setOptions($sel_options);
                break;
 
            case UDF_TYPE_TEXT:
                $item = new ilTextInputGUI($caption, $id);
                $item->setMaxLength(64);
                $item->setSize(20);
                // $item->setSubmitFormOnEnter(true);
                break;
 
            default:
                return null;
        }
 
        if ($item) {
            $this->addFilterItem($item, $a_optional);
            $item->readFromSession();
            $this->filter[$id] = $item->getValue();
        }
        return $item;
    }

References ilTable2GUI\$id, ilTableGUI\$lng, and ilLanguage\txt().

Referenced by initFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

addFilterItemValue()

ilUserTableGUI::addFilterItemValue	(		$filter,
			$value
	)

Definition at line 370 of file class.ilUserTableGUI.php.

                                                       : void // Missing parameter types.
    {
        $this->filter[$filter] = $value;
    }

References $filter, and ILIAS\UI\examples\Symbol\Glyph\Filter\filter().

Here is the call graph for this function:

buildUserQuery()

ilUserTableGUI::buildUserQuery ( )

protected

Definition at line 253 of file class.ilUserTableGUI.php.

                                       : ilUserQuery
    {
        $query = new ilUserQuery();
        $query->setOffset($this->getOffset());
        $query->setLimit($this->getLimit());
        $query->setTextFilter($this->filter['query'] ?? '');
        $query->setActionFilter($this->filter['activation'] ?? '');
        $query->setLastLogin($this->filter['last_login'] ?? null);
        $query->setLimitedAccessFilter($this->filter['limited_access'] ?? false);
        $query->setNoCourseFilter($this->filter['no_courses'] ?? false);
        $query->setNoGroupFilter($this->filter['no_groups'] ?? false);
        $query->setCourseGroupFilter($this->filter['course_group'] ?? 0);
        $query->setRoleFilter((int) ($this->filter['global_role'] ?? 0));
        $query->setUserFilter($this->filter['user_ids'] ?? []);
        $query->setFirstLetterLastname($this->user_request->getLetter());
        $query->setAuthenticationFilter($this->filter['authentication'] ?? '');
        return $query;
    }

References $query, ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilTable2GUI\getLimit(), and ilTable2GUI\getOffset().

Referenced by getItems(), and getUserIdsForFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

fillRow()

ilUserTableGUI::fillRow ( array  $a_set )

protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

array

$a_set

data array

Reimplemented from ilTable2GUI.

Definition at line 605 of file class.ilUserTableGUI.php.

                                            : void // Missing array type.
    {
        global $DIC;
 
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
 
        $ilCtrl->setParameterByClass("ilobjusergui", "letter", $this->user_request->getLetter());
 
        foreach ($this->getSelectedColumns() as $c) {
            if ($c == "access_until") {
                $this->tpl->setCurrentBlock("access_until");
                $this->tpl->setVariable("VAL_ACCESS_UNTIL", $a_set["access_until"]);
                $this->tpl->setVariable("CLASS_ACCESS_UNTIL", $a_set["access_class"]);
            } elseif ($c == "last_login") {
                $this->tpl->setCurrentBlock("last_login");
                $this->tpl->setVariable(
                    "VAL_LAST_LOGIN",
                    ilDatePresentation::formatDate(new ilDateTime($a_set['last_login'], IL_CAL_DATETIME))
                );
            } elseif (in_array($c, array("firstname", "lastname"))) {
                $this->tpl->setCurrentBlock($c);
                $this->tpl->setVariable("VAL_" . strtoupper($c), (string) $a_set[$c]);
            } elseif ($c == 'auth_mode') {
                $this->tpl->setCurrentBlock('user_field');
                $this->tpl->setVariable('VAL_UF', ilAuthUtils::getAuthModeTranslation(ilAuthUtils::_getAuthMode($a_set['auth_mode'])));
                $this->tpl->parseCurrentBlock();
            } else {    // all other fields
                $this->tpl->setCurrentBlock("user_field");
                $val = (trim($a_set[$c]) == "")
                    ? " "
                    : $a_set[$c];
                if ($a_set[$c] != "") {
                    switch ($c) {
                        case "birthday":
                            $val = ilDatePresentation::formatDate(new ilDate($val, IL_CAL_DATE));
                            break;
 
                        case "gender":
                            $val = $lng->txt("gender_" . $a_set[$c]);
                            break;
 
                        case "create_date":
                        case "agree_date":
                        case "approve_date":
                            // $val = ilDatePresentation::formatDate(new ilDateTime($val,IL_CAL_DATETIME));
                            $val = ilDatePresentation::formatDate(new ilDate($val, IL_CAL_DATE));
                            break;
                    }
                }
                $this->tpl->setVariable("VAL_UF", $val);
            }
 
            $this->tpl->parseCurrentBlock();
        }
 
        if ($a_set["usr_id"] != 6
            && ($this->getMode() == self::MODE_USER_FOLDER || $a_set['time_limit_owner'] == $this->getUserFolderId())) {
            $this->tpl->setCurrentBlock("checkb");
            $this->tpl->setVariable("ID", $a_set["usr_id"]);
            $this->tpl->parseCurrentBlock();
        }
 
        if ($this->with_write_access
            && ($this->getMode() == self::MODE_USER_FOLDER
                || $a_set['time_limit_owner'] == $this->getUserFolderId())) {
            $this->tpl->setVariable("VAL_LOGIN", $a_set["login"]);
            $ilCtrl->setParameterByClass("ilobjusergui", "obj_id", $a_set["usr_id"]);
            $this->tpl->setVariable(
                "HREF_LOGIN",
                $ilCtrl->getLinkTargetByClass("ilobjusergui", "view")
            );
            $ilCtrl->setParameterByClass("ilobjusergui", "obj_id", "");
        } else {
            $this->tpl->setVariable('VAL_LOGIN_PLAIN', $a_set['login']);
        }
 
        if ($this->getMode() == self::MODE_LOCAL_USER) {
            $this->tpl->setCurrentBlock('context');
            $this->tpl->setVariable(
                'VAL_CONTEXT',
                ilObject::_lookupTitle(ilObject::_lookupObjId($a_set['time_limit_owner']))
            );
            $this->tpl->parseCurrentBlock();
 
            $this->tpl->setCurrentBlock('roles');
            $ilCtrl->setParameter($this->getParentObject(), 'obj_id', $a_set['usr_id']);
            $this->tpl->setVariable('ROLE_LINK', $ilCtrl->getLinkTarget($this->getParentObject(), 'assignRoles'));
            $this->tpl->setVariable('TXT_ROLES', $this->lng->txt('edit'));
            $ilCtrl->clearParameters($this->getParentObject());
            $this->tpl->parseCurrentBlock();
        }
    }

References $c, $DIC, $lng, ilAuthUtils\_getAuthMode(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilDatePresentation\formatDate(), ilAuthUtils\getAuthModeTranslation(), IL_CAL_DATE, IL_CAL_DATETIME, and ILIAS\Repository\lng().

Here is the call graph for this function:

getItems()

ilUserTableGUI::getItems

(

)

Definition at line 272 of file class.ilUserTableGUI.php.

                              : void
    {
        global $DIC;
 
        $lng = $DIC['lng'];
 
        $this->determineOffsetAndOrder();
        if ($this->getMode() == self::MODE_USER_FOLDER) {
            // All accessible users
            $user_filter = ilLocalUser::_getFolderIds(true);
        } else {
            if ($this->filter['time_limit_owner'] ?? null) {
                $user_filter = array($this->filter['time_limit_owner']);
            } else {
                // All accessible users
                $user_filter = ilLocalUser::_getFolderIds();
            }
        }
 
 
 
        //#13221 don't show all users if user filter is empty!
        if (!count($user_filter)) {
            $this->setMaxCount(0);
            $this->setData([]);
            return;
        }
 
        if (isset($this->filter['user_ids']) && is_array($this->filter['user_ids']) && !count($this->filter['user_ids'])) {
            $this->setMaxCount(0);
            $this->setData([]);
            return;
        }
 
        $additional_fields = $this->getSelectedColumns();
        unset(
            $additional_fields["firstname"],
            $additional_fields["lastname"],
            $additional_fields["email"],
            $additional_fields["second_email"],
            $additional_fields["last_login"],
            $additional_fields["access_until"],
            $additional_fields['org_units']
        );
 
        $udf_filter = array();
        foreach ($this->filter as $k => $v) {
            if (strpos($k, "udf_") === 0) {
                $udf_filter[$k] = $v;
            }
        }
 
        $query = $this->buildUserQuery();
        $order_field = $this->getOrderField();
        if (strpos($order_field, "udf_") !== 0 || isset($additional_fields[$order_field])) {
            $query->setOrderField($order_field);
            $query->setOrderDirection($this->getOrderDirection());
        }
        $query->setAdditionalFields($additional_fields);
        $query->setUserFolder($user_filter);
        $query->setUdfFilter($udf_filter);
        $usr_data = $query->query();
 
        if (count($usr_data["set"]) == 0 && $this->getOffset() > 0) {
            $this->resetOffset();
            $query->setOffset($this->getOffset());
            $usr_data = $query->query();
        }
 
        foreach ($usr_data["set"] as $k => $user) {
            if (in_array('org_units', $this->getSelectedColumns())) {
                $usr_data['set'][$k]['org_units'] = ilObjUser::lookupOrgUnitsRepresentation($user['usr_id']);
            }
 
 
            $current_time = time();
            if ($user['active']) {
                if ($user["time_limit_unlimited"]) {
                    $txt_access = $lng->txt("access_unlimited");
                    $usr_data["set"][$k]["access_class"] = "smallgreen";
                } elseif ($user["time_limit_until"] < $current_time) {
                    $txt_access = $lng->txt("access_expired");
                    $usr_data["set"][$k]["access_class"] = "smallred";
                } else {
                    $txt_access = ilDatePresentation::formatDate(new ilDateTime($user["time_limit_until"], IL_CAL_UNIX));
                    $usr_data["set"][$k]["access_class"] = "small";
                }
            } else {
                $txt_access = $lng->txt("inactive");
                $usr_data["set"][$k]["access_class"] = "smallred";
            }
            $usr_data["set"][$k]["access_until"] = $txt_access;
        }
 
        $this->setMaxCount($usr_data["cnt"]);
        $this->setData($usr_data["set"]);
    }

References $DIC, ilTableGUI\$lng, ilTable2GUI\$order_field, $query, ilLocalUser\_getFolderIds(), buildUserQuery(), ilTable2GUI\determineOffsetAndOrder(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilDatePresentation\formatDate(), getMode(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\getSelectedColumns(), IL_CAL_UNIX, ilObjUser\lookupOrgUnitsRepresentation(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), and ilLanguage\txt().

Here is the call graph for this function:

getMode()

ilUserTableGUI::getMode ( )

protected

Definition at line 123 of file class.ilUserTableGUI.php.

                                : int
    {
        return $this->mode;
    }

References $mode.

Referenced by getItems(), getSelectableColumns(), getUserIdsForFilter(), and initFilter().

Here is the caller graph for this function:

getSelectableColumns()

ilUserTableGUI::getSelectableColumns

(

)

Get selectable columns.

Returns

array key: column id, val: true/false -> default on/off

LTI, showing depending by mode user?

Reimplemented from ilTable2GUI.

Definition at line 171 of file class.ilUserTableGUI.php.

                                          : array // Missing array type.
    {
        global $DIC;
 
        $lng = $DIC['lng'];
 
        $up = new ilUserProfile();
        $up->skipGroup("preferences");
        $up->skipGroup("interests");
        $up->skipGroup("settings");
 
        // default fields
        $cols = array();
 
        // first and last name cannot be hidden
        $cols["firstname"] = array(
            "txt" => $lng->txt("firstname"),
            "default" => true);
        $cols["lastname"] = array(
            "txt" => $lng->txt("lastname"),
            "default" => true);
        if ($this->getMode() == self::MODE_USER_FOLDER) {
            $ufs = $up->getStandardFields();
 
            $cols["access_until"] = array(
                "txt" => $lng->txt("access_until"),
                "default" => true);
            $cols["last_login"] = array(
                "txt" => $lng->txt("last_login"),
                "default" => true);
 
            // #13967
            $cols["create_date"] = array(
                "txt" => $lng->txt("create_date"));
            $cols["approve_date"] = array(
                "txt" => $lng->txt("approve_date"));
            $cols["agree_date"] = array(
                "txt" => $lng->txt("agree_date"));
        } else {
            $ufs = $up->getLocalUserAdministrationFields();
        }
 
        // email should be the 1st "optional" field (can be hidden)
        if (isset($ufs["email"])) {
            $cols["email"] = array(
                "txt" => $lng->txt("email"),
                "default" => true);
        }
        if (isset($ufs["second_email"])) {
            $cols["second_email"] = array(
                "txt" => $lng->txt("second_email"),
                "default" => true);
        }
        // other user profile fields
        foreach ($ufs as $f => $fd) {
            if (!isset($cols[$f]) && (!isset($fd["lists_hide"]) || !$fd["lists_hide"])) {
                // #18795
                $caption = $fd["lang_var"] ?? $f;
                $cols[$f] = array(
                    "txt" => $lng->txt($caption),
                    "default" => false);
            }
        }
 
 
        $cols["auth_mode"] = array(
            "txt" => $lng->txt("auth_mode"),
            "default" => false);
 
        foreach ($this->udf_fields as $k => $field) {
            $cols[$k] = $field;
        }
 
        // fields that are always shown
        unset($cols["username"]);
 
        return $cols;
    }

References $cols, $DIC, Vendor\Package\$f, ilTableGUI\$lng, getMode(), and ilLanguage\txt().

Here is the call graph for this function:

getUserDefinedField()

ilUserTableGUI::getUserDefinedField

(

string

$a_key

)

Get user defined field.

Definition at line 158 of file class.ilUserTableGUI.php.

                                                      : array // Missing array type.
    {
        return $this->udf_fields[$a_key] ?? array();
    }

getUserFolderId()

ilUserTableGUI::getUserFolderId ( )

protected

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

                                        : int
    {
        return $this->user_folder_id;
    }

References $user_folder_id.

Referenced by initFilter().

Here is the caller graph for this function:

getUserIdsForFilter()

ilUserTableGUI::getUserIdsForFilter

(

)

Definition at line 375 of file class.ilUserTableGUI.php.

                                         : array // Missing array type.
    {
        if ($this->getMode() == self::MODE_USER_FOLDER) {
            // All accessible users
            $user_filter = ilLocalUser::_getFolderIds(true);
        } else {
            if ($this->filter['time_limit_owner']) {
                $user_filter = array($this->filter['time_limit_owner']);
            } else {
                // All accessible users
                $user_filter = ilLocalUser::_getFolderIds();
            }
        }
 
        if (!isset($this->filter['user_ids'])) {
            $this->filter['user_ids'] = null;
        }
 
        $query = $this->buildUserQuery();
        $query->setUserFolder($user_filter);
        if ($this->getOrderField()) {
            $query->setOrderField(ilUtil::stripSlashes($this->getOrderField()));
            $query->setOrderDirection(ilUtil::stripSlashes($this->getOrderDirection()));
        }
        $usr_data = $query->query();
 
        $user_ids = array();
 
        foreach ($usr_data["set"] as $item) {
            // #11632
            if ($item["usr_id"] != SYSTEM_USER_ID) {
                $user_ids[] = $item["usr_id"];
            }
        }
        return $user_ids;
    }

References $query, ilLocalUser\_getFolderIds(), buildUserQuery(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), getMode(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilUtil\stripSlashes(), and SYSTEM_USER_ID.

Here is the call graph for this function:

initFilter()

ilUserTableGUI::initFilter

(

)

Reimplemented from ilTable2GUI.

Definition at line 412 of file class.ilUserTableGUI.php.

                                : void
    {
        global $DIC;
 
        $lng = $DIC['lng'];
        $rbacreview = $DIC['rbacreview'];
        $ilUser = $DIC['ilUser'];
        $ilCtrl = $DIC['ilCtrl'];
 
 
        // Show context filter
        if ($this->getMode() == self::MODE_LOCAL_USER) {
            $parent_ids = ilLocalUser::_getFolderIds();
 
            if (count($parent_ids) > 1) {
                $co = new ilSelectInputGUI($lng->txt('context'), 'time_limit_owner');
 
                $ref_id = $this->getUserFolderId();
 
                $opt[0] = $this->lng->txt('all_users');
                $opt[$this->getUserFolderId()] = $lng->txt('users') . ' (' . ilObject::_lookupTitle(ilObject::_lookupObjId($this->getUserFolderId())) . ')';
 
                foreach ($parent_ids as $parent_id) {
                    if ($parent_id == $this->getUserFolderId()) {
                        continue;
                    }
                    switch ($parent_id) {
                        case USER_FOLDER_ID:
                            $opt[USER_FOLDER_ID] = $lng->txt('global_user');
                            break;
 
                        default:
                            $opt[$parent_id] = $lng->txt('users') . ' (' . ilObject::_lookupTitle(ilObject::_lookupObjId($parent_id)) . ')';
                            break;
                    }
                }
                $co->setOptions($opt);
                $this->addFilterItem($co);
                $co->readFromSession();
                $this->filter['time_limit_owner'] = $co->getValue();
            }
        }
 
        // User name, login, email filter
        $ul = new ilTextInputGUI($lng->txt("login") . "/" . $lng->txt("email") . "/" .
            $lng->txt("name"), "query");
        $ul->setDataSource($ilCtrl->getLinkTarget(
            $this->getParentObject(),
            "addUserAutoComplete",
            "",
            true
        ));
        $ul->setSize(20);
        $ul->setSubmitFormOnEnter(true);
        $this->addFilterItem($ul);
        $ul->readFromSession();
        $this->filter["query"] = $ul->getValue();
 
 
        // activation
        $options = array(
            "" => $lng->txt("user_all"),
            "active" => $lng->txt("active"),
            "inactive" => $lng->txt("inactive"),
            );
        $si = new ilSelectInputGUI($this->lng->txt("user_activation"), "activation");
        $si->setOptions($options);
        $this->addFilterItem($si);
        $si->readFromSession();
        $this->filter["activation"] = $si->getValue();
 
        // limited access
        $cb = new ilCheckboxInputGUI($this->lng->txt("user_limited_access"), "limited_access");
        $this->addFilterItem($cb);
        $cb->readFromSession();
        $this->filter["limited_access"] = $cb->getChecked();
 
        // last login
        $di = new ilDateTimeInputGUI($this->lng->txt("user_last_login_before"), "last_login");
        $default_date = new ilDateTime(time(), IL_CAL_UNIX);
        $default_date->increment(IL_CAL_DAY, 1);
        $di->setDate($default_date);
        $this->addFilterItem($di);
        $di->readFromSession();
        $this->filter["last_login"] = $di->getDate();
 
        if ($this->getMode() == self::MODE_USER_FOLDER) {
            // no assigned courses
            $cb = new ilCheckboxInputGUI($this->lng->txt("user_no_courses"), "no_courses");
            $this->addFilterItem($cb);
            $cb->readFromSession();
            $this->filter["no_courses"] = $cb->getChecked();
 
            // no assigned groups
            $ng = new ilCheckboxInputGUI($this->lng->txt("user_no_groups"), "no_groups");
            $this->addFilterItem($ng);
            $ng->readFromSession();
            $this->filter['no_groups'] = $ng->getChecked();
 
            // course/group members
            $rs = new ilRepositorySelectorInputGUI($lng->txt("user_member_of_course_group"), "course_group");
            $rs->setSelectText($lng->txt("user_select_course_group"));
            $rs->setHeaderMessage($lng->txt("user_please_select_course_group"));
            $rs->setClickableTypes(array("crs", "grp"));
            $this->addFilterItem($rs);
            $rs->readFromSession();
            $this->filter["course_group"] = $rs->getValue();
        }
 
        // global roles
        $options = array(
            "" => $lng->txt("user_any"),
            );
        foreach ($rbacreview->getRolesByFilter(2, $ilUser->getId()) as $role) {
            $options[$role["rol_id"]] = $role["title"];
        }
        $si = new ilSelectInputGUI($this->lng->txt("user_global_role"), "global_role");
        $si->setOptions($options);
        $this->addFilterItem($si);
        $si->readFromSession();
        $this->filter["global_role"] = $si->getValue();
 
        // authentication mode
        $auth_methods = ilAuthUtils::_getActiveAuthModes();
        $options = array(
            "" => $lng->txt("user_any"),
        );
        foreach ($auth_methods as $method => $value) {
            if ($method == 'default') {
                $options[$method] = $this->lng->txt('auth_' . $method) . " (" . $this->lng->txt('auth_' . ilAuthUtils::_getAuthModeName($value)) . ")";
            } else {
                $options[$method] = ilAuthUtils::getAuthModeTranslation($value);
            }
        }
        $si = new ilSelectInputGUI($this->lng->txt("auth_mode"), "authentication_method");
        $si->setOptions($options);
        $this->addFilterItem($si);
        $si->readFromSession();
        $this->filter["authentication"] = $si->getValue();
 
        // udf fields
        foreach ($this->udf_fields as $id => $f) {
            $this->addFilterItemByUdfType($id, $f["type"], true, $f["txt"], $f["options"]);
        }
    }

References $DIC, Vendor\Package\$f, ilTable2GUI\$id, $ilUser, ilTableGUI\$lng, $ref_id, ilAuthUtils\_getActiveAuthModes(), ilAuthUtils\_getAuthModeName(), ilLocalUser\_getFolderIds(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilTable2GUI\addFilterItem(), addFilterItemByUdfType(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilAuthUtils\getAuthModeTranslation(), getMode(), getUserFolderId(), IL_CAL_DAY, IL_CAL_UNIX, ILIAS\Repository\lng(), ilLanguage\txt(), and USER_FOLDER_ID.

Here is the call graph for this function:

isUdfColumn()

ilUserTableGUI::isUdfColumn

(

string

$a_key

)

Definition at line 163 of file class.ilUserTableGUI.php.

                                              : bool
    {
        if (strpos($a_key, "udf_") === 0) {
            return true;
        }
        return false;
    }

readUserDefinedFieldsDefinitions()

ilUserTableGUI::readUserDefinedFieldsDefinitions

(

)

Read user defined fields definitions.

Definition at line 136 of file class.ilUserTableGUI.php.

                                                      : void
    {
        $user_defined_fields = ilUserDefinedFields::_getInstance();
        foreach ($user_defined_fields->getDefinitions() as $field => $definition) {
            if ($this->mode === self::MODE_LOCAL_USER
                && $definition['visib_lua'] === '0') {
                continue;
            }
 
            $this->udf_fields["udf_" . $field] = array(
                "txt" => $definition["field_name"],
                "default" => false,
                "options" => $definition["field_values"],
                "type" => $definition["field_type"],
                "sortable" => in_array($definition["field_type"], array(UDF_TYPE_TEXT, UDF_TYPE_SELECT)),
            );
        }
    }

References ilUserDefinedFields\_getInstance(), UDF_TYPE_SELECT, and UDF_TYPE_TEXT.

Here is the call graph for this function:

setMode()

ilUserTableGUI::setMode ( int  $a_mode )

protected

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

                                           : void
    {
        $this->mode = $a_mode;
    }

Field Documentation

$filter

array ilUserTableGUI::$filter = []

protected

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

Referenced by addFilterItemValue().

$mode

int ilUserTableGUI::$mode = null

private

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

Referenced by getMode().

$udf_fields

array ilUserTableGUI::$udf_fields = []

protected

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

$user_folder_id

int ilUserTableGUI::$user_folder_id = 0

private

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

Referenced by getUserFolderId().

$user_request

ILIAS User StandardGUIRequest ilUserTableGUI::$user_request

protected

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

$with_write_access

bool ilUserTableGUI::$with_write_access = false

private

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

MODE_LOCAL_USER

const ilUserTableGUI::MODE_LOCAL_USER = 2

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

Referenced by ilLocalUserGUI\applyFilter(), ilObjCategoryGUI\applyFilterObject(), ilLocalUserGUI\index(), ilObjCategoryGUI\listUsersObject(), ilLocalUserGUI\resetFilter(), and ilObjCategoryGUI\resetFilterObject().

MODE_USER_FOLDER

const ilUserTableGUI::MODE_USER_FOLDER = 1

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

Referenced by ilObjUserFolderGUI\getActionUserIds().

---

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

• Services/User/classes/class.ilUserTableGUI.php