ilUserTableGUI Class Reference

TableGUI class for user administration. More...

Inheritance diagram for ilUserTableGUI:

Collaboration diagram for ilUserTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_mode=self::MODE_USER_FOLDER, $a_load_items=true)
	Constructor. More...
	readUserDefinedFieldsDefinitions ()
	Read user defined fields definitions. More...
	getUserDefinedField ($a_key)
	Get user defined field. More...
	isUdfColumn ($a_key)
	Field key. More...
	getSelectableColumns ()
	Get selectable columns. More...
	getItems ()
	Get user items. More...
	getUserIdsForFilter ()
	initFilter ()
	Init filter. More...
	addFilterItemByUdfType ($id, $type, $a_optional=false, $caption=null, $a_options=array())
	Add filter by standard type. More...
Public Member Functions inherited from ilTable2GUI
	__construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
	ilTable2GUI constructor. More...
	setOpenFormTag ($a_val)
	Set open form tag. More...
	getOpenFormTag ()
	Get open form tag. More...
	setCloseFormTag ($a_val)
	Set close form tag. More...
	getCloseFormTag ()
	Get close form tag. More...
	determineLimit ()
	Determine the limit. More...
	getSelectableColumns ()
	Get selectable columns. More...
	determineSelectedColumns ()
	Determine selected columns. More...
	isColumnSelected ($a_col)
	Is given column selected? More...
	getSelectedColumns ()
	Get selected columns. More...
	executeCommand ()
	Execute command. More...
	resetOffset ($a_in_determination=false)
	Reset offset. More...
	initFilter ()
	Init filter. More...
	getParentObject ()
	Get parent object. More...
	getParentCmd ()
	Get parent command. More...
	setTopAnchor ($a_val)
	Set top anchor. More...
	getTopAnchor ()
	Get top anchor. More...
	setNoEntriesText ($a_text)
	Set text for an empty table. More...
	getNoEntriesText ()
	Get text for an empty table. More...
	setIsDataTable ($a_val)
	Set is data table. More...
	getIsDataTable ()
	Get is data table. More...
	setEnableTitle ($a_enabletitle)
	Set Enable Title. More...
	getEnableTitle ()
	Get Enable Title. More...
	setEnableHeader ($a_enableheader)
	Set Enable Header. More...
	getEnableHeader ()
	Get Enable Header. More...
	setEnableNumInfo ($a_val)
	Set enable num info. More...
	getEnableNumInfo ()
	Get enable num info. More...
	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	Set title and title icon. More...
	setDescription ($a_val)
	Set description. More...
	getDescription ()
	Get description. More...
	setOrderField ($a_order_field)
	set order column More...
	getOrderField ()
	setData ($a_data)
	getData ()
	dataExists ()
	setPrefix ($a_prefix)
	getPrefix ()
	addFilterItem ($a_input_item, $a_optional=false)
	Add filter item. More...
	addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)
	Add filter by standard type. More...
	getFilterItems ($a_optionals=false)
	Get filter items. More...
	getFilterItemByPostVar ($a_post_var)
	setFilterCols ($a_val)
	Set filter columns. More...
	getFilterCols ()
	Get filter columns. More...
	setDisableFilterHiding ($a_val=true)
	Set disable filter hiding. More...
	getDisableFilterHiding ()
	Get disable filter hiding. More...
	isFilterSelected ($a_col)
	Is given filter selected? More...
	getSelectedFilters ()
	Get selected filters. More...
	determineSelectedFilters ()
	Determine selected filters. More...
	setCustomPreviousNext ($a_prev_link, $a_next_link)
	Set custom previous/next links. More...
	setFormAction ($a_form_action, $a_multipart=false)
	Set Form action parameter. More...
	getFormAction ()
	Get Form action parameter. More...
	setFormName ($a_formname="")
	Set Form name. More...
	getFormName ()
	Get Form name. More...
	setId ($a_val)
	Set id. More...
	getId ()
	Get element id. More...
	setDisplayAsBlock ($a_val)
	Set display as block. More...
	getDisplayAsBlock ()
	Get display as block. More...
	getSelectAllCheckbox ()
	Get the name of the checkbox that should be toggled with a select all button. More...
	setSelectAllCheckbox ($a_select_all_checkbox, $a_select_all_on_top=false)
	Set the name of the checkbox that should be toggled with a select all button. More...
	setExternalSorting ($a_val)
	Set external sorting. More...
	getExternalSorting ()
	Get external sorting. More...
	setFilterCommand ($a_val, $a_caption=null)
	Set filter command. More...
	getFilterCommand ()
	Get filter command. More...
	setResetCommand ($a_val, $a_caption=null)
	Set reset filter command. More...
	getResetCommand ()
	Get reset filter command. More...
	setExternalSegmentation ($a_val)
	Set external segmentation. More...
	getExternalSegmentation ()
	Get external segmentation. More...
	setRowTemplate ($a_template, $a_template_dir="")
	Set row template. More...
	setDefaultOrderField ($a_defaultorderfield)
	Set Default order field. More...
	getDefaultOrderField ()
	Get Default order field. More...
	setDefaultOrderDirection ($a_defaultorderdirection)
	Set Default order direction. More...
	getDefaultOrderDirection ()
	Get Default order direction. More...
	setDefaultFilterVisiblity ($a_status)
	Set default filter visiblity. More...
	getDefaultFilterVisibility ()
	Get default filter visibility. More...
	clearCommandButtons ()
	addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
	Add Command button. More...
	addCommandButtonInstance (ilButtonBase $a_button)
	Add Command button instance. More...
	addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
	Add Selection List + Command button. More...
	addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
	Add Selection List + Command button for selected items. More...
	setCloseCommand ($a_link)
	Add command for closing table. More...
	addMultiCommand ($a_cmd, $a_text)
	Add Command button. More...
	addHiddenInput ($a_name, $a_value)
	Add Hidden Input field. More...
	addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
	Add Header Command (Link) (Image needed for now) More...
	setTopCommands ($a_val)
	Set top commands (display command buttons on top of table, too) More...
	getTopCommands ()
	Get top commands (display command buttons on top of table, too) More...
	addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
	Add a column to the header. More...
	getNavParameter ()
	setOrderLink ($sort_field, $order_dir)
	fillHeader ()
	determineOffsetAndOrder ($a_omit_offset=false)
	Determine offset and order. More...
	storeNavParameter ()
	getHTML ()
	Get HTML. More...
	numericOrdering ($a_field)
	Should this field be sorted numeric? More...
	render ()
	render table public More...
	writeFilterToSession ()
	Write filter values to session. More...
	resetFilter ()
	Reset filter. More...
	fillFooter ()
	Fill footer row. More...
	getLinkbar ($a_num)
	Get previous/next linkbar. More...
	fillHiddenRow ()
	fillActionRow ()
	Fill Action Row. More...
	setHeaderHTML ($html)
	set header html More...
	storeProperty ($type, $value)
	Store table property. More...
	loadProperty ($type)
	Load table property. More...
	getCurrentState ()
	get current settings for order, limit, columns and filter More...
	setContext ($id)
	Set context. More...
	getContext ()
	Get context. More...
	setShowRowsSelector ($a_value)
	Toggle rows-per-page selector. More...
	getShowRowsSelector ()
	Get rows-per-page selector state. More...
	setShowTemplates ($a_value)
	Toggle templates. More...
	getShowTemplates ()
	Get template state. More...
	restoreTemplate ($a_name)
	Restore state from template. More...
	saveTemplate ($a_name)
	Save current state as template. More...
	deleteTemplate ($a_name)
	Delete template. More...
	getLimit ()
	Get limit. More...
	getOffset ()
	Get offset. More...
	setExportFormats (array $formats)
	Set available export formats. More...
	setPrintMode ($a_value=false)
	Toogle print mode. More...
	getPrintMode ()
	Get print mode. More...
	getExportMode ()
	Was export activated? More...
	exportData ($format, $send=false)
	Export and optionally send current table data. More...
	setEnableAllCommand ($a_value)
	Enable actions for all entries in current result. More...
	setRowSelectorLabel ($row_selector_label)
	getRowSelectorLabel ()
	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...
	getPreventDoubleSubmission ()
	Get prevent double submission. More...
	setLimit ($a_limit=0, $a_default_limit=0)
Public Member Functions inherited from ilTableGUI
	__construct ($a_data=0, $a_global_tpl=true)
	Constructor. More...
	setTemplate ($a_tpl)
	set template public More...
&	getTemplateObject ()
	setData ($a_data)
	set table data public More...
	getData ()
	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	set table title public More...
	setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
	set table help page public More...
	setHeaderNames ($a_header_names)
	set table header names public More...
	getColumnCount ()
	Returns the column count based on the number of the header row columns public. More...
	setHeaderVars ($a_header_vars, $a_header_params=0)
	set table header vars public More...
	setColumnWidth ($a_column_width)
	set table column widths public More...
	setOneColumnWidth ($a_column_width, $a_column_number)
	set one table column width public More...
	setMaxCount ($a_max_count)
	set max. More...
	setLimit ($a_limit=0, $a_default_limit=0)
	set max. More...
	getLimit ()
	Get limit. More...
	setPrefix ($a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) public More...
	setOffset ($a_offset)
	set dataset offset public More...
	getOffset ()
	Get offset. More...
	setOrderColumn ($a_order_column=0, $a_default_column=0)
	set order column public More...
	getOrderColumn ()
	Get order column. More...
	setOrderDirection ($a_order_direction)
	set order direction public More...
	getOrderDirection ()
	Get order direction. More...
	setFooter ($a_style, $a_previous=0, $a_next=0)
	set order direction public More...
	enable ($a_module_name)
	enables particular modules of table More...
	disable ($a_module_name)
	diesables particular modules of table More...
	sortData ()
	render ()
	render table public More...
	renderHeader ()
	setOrderLink ($key, $order_dir)
	setStyle ($a_element, $a_style)
	getStyle ($a_element)
	setBase ($a_base)
	Set Base script name (deprecated, only use this for workarounds). More...
	getBase ()
	Get Base script name (deprecated, only use this for workarounds). More...
	getFormName ()
	setFormName ($a_name="cmd")
	getSelectAllCheckbox ()
	setSelectAllCheckbox ($a_select_all_checkbox)
	clearActionButtons ()
	addActionButton ($btn_name, $btn_value)

Data Fields
const	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
	$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
	setMode ($a_mode)
	getMode ()
	getUserFolderId ()
	fillRow ($user)
	Fill table row. 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...

Protected Attributes
	$udf_fields = array()
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

Private Attributes
	$mode = null
	$user_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...

Detailed Description

TableGUI class for user administration.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

ilUserTableGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

__construct()

ilUserTableGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd,
			$a_mode = self::MODE_USER_FOLDER,
			$a_load_items = true
	)

Constructor.

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

References $c, $DIC, $f, $ilCtrl, ilTableGUI\$lng, ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), getItems(), getMode(), ilTable2GUI\getSelectedColumns(), getUserDefinedField(), getUserFolderId(), initFilter(), isUdfColumn(), readUserDefinedFieldsDefinitions(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableAllCommand(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), setMode(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTopCommands().

    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
        $ilAccess = $DIC['ilAccess'];
        $lng = $DIC['lng'];
        $rbacsystem = $DIC['rbacsystem'];
        
        $this->user_folder_id = $a_parent_obj->object->getRefId();

        $this->setMode($a_mode);
        $this->setId("user" . $this->getUserFolderId());
        $this->readUserDefinedFieldsDefinitions();
        
        parent::__construct($a_parent_obj, $a_parent_cmd);
        //              $this->setTitle($this->lng->txt("users"));
        
        $this->addColumn("", "", "1", true);
        $this->addColumn($this->lng->txt("login"), "login");
        
        foreach ($this->getSelectedColumns() as $c) {
            if ($this->isUdfColumn($c)) {
                $f = $this->getUserDefinedField($c);
                $this->addColumn($f["txt"], $f["sortable"] ? $c : "");
            } else {    // usual column
                $this->addColumn($this->lng->txt($c), $c);
            }
        }
                
        if ($this->getMode() == self::MODE_LOCAL_USER) {
            $this->addColumn($this->lng->txt('context'), 'time_limit_owner');
            $this->addColumn($this->lng->txt('role_assignment'));
        }

        $this->setShowRowsSelector(true);
        $this->setExternalSorting(true);
        $this->setExternalSegmentation(true);
        $this->setEnableHeader(true);

        $this->setFormAction($ilCtrl->getFormAction($this->parent_obj, "applyFilter"));
        $this->setRowTemplate("tpl.user_list_row.html", "Services/User");
        //$this->disable("footer");
        $this->setEnableTitle(true);
        $this->initFilter();
        $this->setFilterCommand("applyFilter");
        $this->setDefaultOrderField("login");
        $this->setDefaultOrderDirection("asc");

        $this->setSelectAllCheckbox("id[]");
        $this->setTopCommands(true);

        
        if ($this->getMode() == self::MODE_USER_FOLDER) {
            $this->setEnableAllCommand(true);
            
            $cmds = $a_parent_obj->getUserMultiCommands();
            foreach ($cmds as $cmd => $caption) {
                $this->addMultiCommand($cmd, $caption);
            }
        } else {
            $this->addMultiCommand("deleteUsers", $lng->txt("delete"));
        }
        
        if ($a_load_items) {
            $this->getItems();
        }
    }

Here is the call graph for this function:

Member Function Documentation

addFilterItemByUdfType()

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

Add filter by standard type.

Parameters

string	$id
int	$type
bool	$a_optional
string	$caption

Returns

object

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

References $DIC, $id, ilTableGUI\$lng, $type, ilTable2GUI\addFilterItem(), UDF_TYPE_SELECT, and UDF_TYPE_TEXT.

Referenced by initFilter().

    {
        global $DIC;

        $lng = $DIC['lng'];

        if (!$caption) {
            $caption = $lng->txt($id);
        }

        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");

        switch ($type) {
            case UDF_TYPE_SELECT:
                include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
                $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:
                include_once("./Services/Form/classes/class.ilTextInputGUI.php");
                $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillRow()

ilUserTableGUI::fillRow (   $user )

protected

Fill table row.

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

References $_GET, $c, $DIC, $ilCtrl, ilTableGUI\$lng, $user, ilAuthUtils\_getAuthMode(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilDatePresentation\formatDate(), ilAuthUtils\getAuthModeTranslation(), getMode(), ilTable2GUI\getParentObject(), ilTable2GUI\getSelectedColumns(), getUserFolderId(), IL_CAL_DATE, and IL_CAL_DATETIME.

    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];

        $ilCtrl->setParameterByClass("ilobjusergui", "letter", $_GET["letter"]);
        
        foreach ($this->getSelectedColumns() as $c) {
            if ($c == "access_until") {
                $this->tpl->setCurrentBlock("access_until");
                $this->tpl->setVariable("VAL_ACCESS_UNTIL", $user["access_until"]);
                $this->tpl->setVariable("CLASS_ACCESS_UNTIL", $user["access_class"]);
            } elseif ($c == "last_login") {
                $this->tpl->setCurrentBlock("last_login");
                $this->tpl->setVariable(
                    "VAL_LAST_LOGIN",
                    ilDatePresentation::formatDate(new ilDateTime($user['last_login'], IL_CAL_DATETIME))
                );
            } elseif (in_array($c, array("firstname", "lastname"))) {
                $this->tpl->setCurrentBlock($c);
                $this->tpl->setVariable("VAL_" . strtoupper($c), (string) $user[$c]);
            } elseif ($c == 'auth_mode') {
                $this->tpl->setCurrentBlock('user_field');
                $this->tpl->setVariable('VAL_UF', ilAuthUtils::getAuthModeTranslation(ilAuthUtils::_getAuthMode($user['auth_mode'])));
                $this->tpl->parseCurrentBlock();
            } else {    // all other fields
                $this->tpl->setCurrentBlock("user_field");
                $val = (trim($user[$c]) == "")
                    ? " "
                    : $user[$c];
                if ($user[$c] != "") {
                    switch ($c) {
                        case "birthday":
                            $val = ilDatePresentation::formatDate(new ilDate($val, IL_CAL_DATE));
                            break;
                        
                        case "gender":
                            $val = $lng->txt("gender_" . $user[$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 ($user["usr_id"] != 6) {
            if ($this->getMode() == self::MODE_USER_FOLDER or $user['time_limit_owner'] == $this->getUserFolderId()) {
                $this->tpl->setCurrentBlock("checkb");
                $this->tpl->setVariable("ID", $user["usr_id"]);
                $this->tpl->parseCurrentBlock();
            }
        }

        if ($this->getMode() == self::MODE_USER_FOLDER or $user['time_limit_owner'] == $this->getUserFolderId()) {
            $this->tpl->setVariable("VAL_LOGIN", $user["login"]);
            $ilCtrl->setParameterByClass("ilobjusergui", "obj_id", $user["usr_id"]);
            $this->tpl->setVariable(
                "HREF_LOGIN",
                $ilCtrl->getLinkTargetByClass("ilobjusergui", "view")
            );
            $ilCtrl->setParameterByClass("ilobjusergui", "obj_id", "");
        } else {
            $this->tpl->setVariable('VAL_LOGIN_PLAIN', $user['login']);
        }

        if ($this->getMode() == self::MODE_LOCAL_USER) {
            $this->tpl->setCurrentBlock('context');
            $this->tpl->setVariable('VAL_CONTEXT', (string) ilObject::_lookupTitle(ilObject::_lookupObjId($user['time_limit_owner'])));
            $this->tpl->parseCurrentBlock();
            
            $this->tpl->setCurrentBlock('roles');
            $ilCtrl->setParameter($this->getParentObject(), 'obj_id', $user['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();
        }
    }

Here is the call graph for this function:

getItems()

ilUserTableGUI::getItems

(

)

Get user items.

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

References $_GET, $DIC, ilTableGUI\$lng, $query, $user, ilLocalUser\_getFolderIds(), ilTable2GUI\determineOffsetAndOrder(), ilDatePresentation\formatDate(), ilTable2GUI\getLimit(), getMode(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\getSelectedColumns(), IL_CAL_UNIX, ilObjUser\lookupOrgUnitsRepresentation(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), and ilUtil\stripSlashes().

Referenced by __construct().

    {
        global $DIC;

        $lng = $DIC['lng'];

        $this->determineOffsetAndOrder();
        if ($this->getMode() == self::MODE_USER_FOLDER) {
            // All accessible users
            include_once './Services/User/classes/class.ilLocalUser.php';
            $user_filter = ilLocalUser::_getFolderIds();
        } else {
            if ($this->filter['time_limit_owner']) {
                $user_filter = array($this->filter['time_limit_owner']);
            } else {
                // All accessible users
                include_once './Services/User/classes/class.ilLocalUser.php';
                $user_filter = ilLocalUser::_getFolderIds();
            }
        }

        //#13221 don't show all users if user filter is empty!
        if (!count($user_filter)) {
            $this->setMaxCount(0);
            $this->setData(array());
            return;
        }

        include_once("./Services/User/classes/class.ilUserQuery.php");
        
        $additional_fields = $this->getSelectedColumns();
        unset($additional_fields["firstname"]);
        unset($additional_fields["lastname"]);
        unset($additional_fields["email"]);
        unset($additional_fields["second_email"]);
        unset($additional_fields["last_login"]);
        unset($additional_fields["access_until"]);
        unset($additional_fields['org_units']);

        $udf_filter = array();
        foreach ($this->filter as $k => $v) {
            if (substr($k, 0, 4) == "udf_") {
                $udf_filter[$k] = $v;
            }
        }

        $query = new ilUserQuery();
        $query->setOrderField($this->getOrderField());
        $query->setOrderDirection($this->getOrderDirection());
        $query->setOffset($this->getOffset());
        $query->setLimit($this->getLimit());
        $query->setTextFilter($this->filter['query']);
        $query->setActionFilter($this->filter['activation']);
        $query->setLastLogin($this->filter['last_login']);
        $query->setLimitedAccessFilter($this->filter['limited_access']);
        $query->setNoCourseFilter($this->filter['no_courses']);
        $query->setNoGroupFilter($this->filter['no_groups']);
        $query->setCourseGroupFilter($this->filter['course_group']);
        $query->setRoleFilter($this->filter['global_role']);
        $query->setAdditionalFields($additional_fields);
        $query->setUserFolder($user_filter);
        $query->setUdfFilter($udf_filter);
        $query->setFirstLetterLastname(ilUtil::stripSlashes($_GET['letter']));
        $query->setAuthenticationFilter($this->filter['authentication']);
        $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"]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMode()

ilUserTableGUI::getMode ( )

protected

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

References $mode.

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

    {
        return $this->mode;
    }

Here is the caller graph for this function:

getSelectableColumns()

ilUserTableGUI::getSelectableColumns

(

)

Get selectable columns.

Parameters

LTI, showing depending by mode user?

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

References $cols, $DIC, $f, ilTableGUI\$lng, and getMode().

    {
        global $DIC;

        $lng = $DIC['lng'];
        
        include_once("./Services/User/classes/class.ilUserProfile.php");
        $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]) && !$fd["lists_hide"]) {
                // #18795
                $caption = $fd["lang_var"]
                    ? $fd["lang_var"]
                    : $f;
                $cols[$f] = array(
                    "txt" => $lng->txt($caption),
                    "default" => false);
            }
        }


        $cols["auth_mode"] = array(
            "txt" => $lng->txt("auth_mode"),
            "default" => false);

        
        // custom user fields
        if ($this->getMode() == self::MODE_USER_FOLDER) {
            foreach ($this->udf_fields as $k => $field) {
                $cols[$k] = $field;
            }
        }

        // fields that are always shown
        unset($cols["username"]);
        
        return $cols;
    }

Here is the call graph for this function:

getUserDefinedField()

ilUserTableGUI::getUserDefinedField

(

$a_key

)

Get user defined field.

Parameters

string

$a_key

field key

Returns

array

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

Referenced by __construct().

    {
        if (isset($this->udf_fields[$a_key])) {
            return $this->udf_fields[$a_key];
        }
        return array();
    }

Here is the caller graph for this function:

getUserFolderId()

ilUserTableGUI::getUserFolderId ( )

protected

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

References $user_folder_id.

Referenced by __construct(), fillRow(), and initFilter().

    {
        return $this->user_folder_id;
    }

Here is the caller graph for this function:

getUserIdsForFilter()

ilUserTableGUI::getUserIdsForFilter

(

)

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

References $_GET, $query, ilLocalUser\_getFolderIds(), ilTable2GUI\getLimit(), getMode(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), and ilUtil\stripSlashes().

    {
        if ($this->getMode() == self::MODE_USER_FOLDER) {
            // All accessible users
            include_once './Services/User/classes/class.ilLocalUser.php';
            $user_filter = ilLocalUser::_getFolderIds();
        } else {
            if ($this->filter['time_limit_owner']) {
                $user_filter = array($this->filter['time_limit_owner']);
            } else {
                // All accessible users
                include_once './Services/User/classes/class.ilLocalUser.php';
                $user_filter = ilLocalUser::_getFolderIds();
            }
        }
        
        include_once("./Services/User/classes/class.ilUserQuery.php");
        $query = new ilUserQuery();
        $query->setOffset($this->getOffset());
        $query->setLimit($this->getLimit());

        $query->setTextFilter($this->filter['query']);
        $query->setActionFilter($this->filter['activation']);
        $query->setAuthenticationFilter($this->filter['authentication']);
        $query->setLastLogin($this->filter['last_login']);
        $query->setLimitedAccessFilter($this->filter['limited_access']);
        $query->setNoCourseFilter($this->filter['no_courses']);
        $query->setNoGroupFilter($this->filter['no_groups']);
        $query->setCourseGroupFilter($this->filter['course_group']);
        $query->setRoleFilter($this->filter['global_role']);
        $query->setUserFolder($user_filter);
        $query->setFirstLetterLastname(ilUtil::stripSlashes($_GET['letter']));
        
        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;
    }

Here is the call graph for this function:

initFilter()

ilUserTableGUI::initFilter

(

)

Init filter.

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

References $DIC, $f, $id, $ilCtrl, $ilUser, ilTableGUI\$lng, PHPMailer\PHPMailer\$options, $si, ilAuthUtils\_getActiveAuthModes(), ilAuthUtils\_getAuthModeName(), ilLocalUser\_getFolderIds(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilTable2GUI\addFilterItem(), addFilterItemByUdfType(), ilAuthUtils\getAuthModeTranslation(), getMode(), getUserFolderId(), IL_CAL_DAY, IL_CAL_UNIX, ilTextInputGUI\setDataSource(), ilDateTimeInputGUI\setDate(), ilSelectInputGUI\setOptions(), ilRepositorySelectorInputGUI\setSelectText(), and USER_FOLDER_ID.

Referenced by __construct().

    {
        global $DIC;

        $lng = $DIC['lng'];
        $rbacreview = $DIC['rbacreview'];
        $ilUser = $DIC['ilUser'];
        $ilCtrl = $DIC['ilCtrl'];
        
        
        // Show context filter
        if ($this->getMode() == self::MODE_LOCAL_USER) {
            include_once './Services/User/classes/class.ilLocalUser.php';
            $parent_ids = ilLocalUser::_getFolderIds();

            if (count($parent_ids) > 1) {
                include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
                $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
        include_once("./Services/Form/classes/class.ilTextInputGUI.php");
        $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();

        /*
        include_once("./Services/Form/classes/class.ilTextInputGUI.php");
        $ti = new ilTextInputGUI($lng->txt("login")."/".$lng->txt("email")."/".$lng->txt("name"), "query");
        $ti->setMaxLength(64);
        $ti->setSize(20);
        $ti->setSubmitFormOnEnter(true);
        $this->addFilterItem($ti);
        $ti->readFromSession();
        $this->filter["query"] = $ti->getValue();
        */
        
        // activation
        include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
        $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
        include_once("./Services/Form/classes/class.ilCheckboxInputGUI.php");
        $cb = new ilCheckboxInputGUI($this->lng->txt("user_limited_access"), "limited_access");
        $this->addFilterItem($cb);
        $cb->readFromSession();
        $this->filter["limited_access"] = $cb->getChecked();
        
        // last login
        include_once("./Services/Form/classes/class.ilDateTimeInputGUI.php");
        $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
            include_once("./Services/Form/classes/class.ilCheckboxInputGUI.php");
            $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
            include_once("./Services/Form/classes/class.ilCheckboxInputGUI.php");
            $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
            include_once("./Services/Form/classes/class.ilRepositorySelectorInputGUI.php");
            $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"),
            );
        $roles = $rbacreview->getRolesByFilter(2, $ilUser->getId());
        foreach ($roles 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"]);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isUdfColumn()

ilUserTableGUI::isUdfColumn

(

$a_key

)

Field key.

Parameters

string

$a_key

field key

Returns

bool

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

Referenced by __construct().

    {
        if (substr($a_key, 0, 4) == "udf_") {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

readUserDefinedFieldsDefinitions()

ilUserTableGUI::readUserDefinedFieldsDefinitions

(

)

Read user defined fields definitions.

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

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

Referenced by __construct().

    {
        include_once './Services/User/classes/class.ilUserDefinedFields.php';
        $user_defined_fields = ilUserDefinedFields::_getInstance();
        foreach ($user_defined_fields->getDefinitions() as $field => $definition) {
            $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))
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setMode()

ilUserTableGUI::setMode (   $a_mode )

protected

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

Referenced by __construct().

    {
        $this->mode = $a_mode;
    }

Here is the caller graph for this function:

Field Documentation

$mode

ilUserTableGUI::$mode = null

private

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

Referenced by getMode().

$udf_fields

ilUserTableGUI::$udf_fields = array()

protected

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

$user_folder_id

ilUserTableGUI::$user_folder_id = 0

private

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

Referenced by getUserFolderId().

MODE_LOCAL_USER

const ilUserTableGUI::MODE_LOCAL_USER = 2

Definition at line 18 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 17 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