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)
	Constructor.
	getItems ()
	Get user items.
	initFilter ()
	Init filter.
Public Member Functions inherited from ilTable2GUI
&	executeCommand ()
	Execute command.
	resetOffset ($a_in_determination=false)
	Reset offset.
	getParentObject ()
	Get parent object.
	getParentCmd ()
	Get parent command.
	setTopAnchor ($a_val)
	Set top anchor.
	getTopAnchor ()
	Get top anchor.
	setNoEntriesText ($a_text)
	Set text for an empty table.
	getNoEntriesText ()
	Get text for an empty table.
	setIsDataTable ($a_val)
	Set is data table.
	getIsDataTable ()
	Get is data table.
	setEnableTitle ($a_enabletitle)
	Set Enable Title.
	getEnableTitle ()
	Get Enable Title.
	setEnableHeader ($a_enableheader)
	Set Enable Header.
	getEnableHeader ()
	Get Enable Header.
	setEnableNumInfo ($a_val)
	Set enable num info.
	getEnableNumInfo ()
	Get enable num info.
	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	Set title and title icon.
	setDescription ($a_val)
	Set description.
	getDescription ()
	Get description.
	setOrderField ($a_order_field)
	set order column
	getOrderField ()
	setData ($a_data)
	set table data public
	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) public
	getPrefix ()
	addFilterItem ($a_input_item, $a_optional=false)
	Add filter item.
	getFilterItems ($a_optionals=false)
	Get filter items.
	getFilterItemByPostVar ($a_post_var)
	setFilterCols ($a_val)
	Set filter columns.
	getFilterCols ()
	Get filter columns.
	setDisableFilterHiding ($a_val=true)
	Set disable filter hiding.
	getDisableFilterHiding ()
	Get disable filter hiding disable filter hiding.
	setCustomPreviousNext ($a_prev_link, $a_next_link)
	Set custom previous/next links.
	setFormAction ($a_form_action)
	Set Form action parameter.
	getFormAction ()
	Get Form action parameter.
	setFormName ($a_formname)
	Set Form name.
	getFormName ()
	Get Form name.
	setId ($a_val)
	Set id.
	getId ()
	Get element id.
	setDisplayAsBlock ($a_val)
	Set display as block.
	getDisplayAsBlock ()
	Get display as block.
	getSelectAllCheckbox ()
	Get the name of the checkbox that should be toggled with a select all button.
	setSelectAllCheckbox ($a_select_all_checkbox)
	Set the name of the checkbox that should be toggled with a select all button.
	setExternalSorting ($a_val)
	Set external sorting.
	getExternalSorting ()
	Get external sorting.
	setFilterCommand ($a_val)
	Set filter command.
	getFilterCommand ()
	Get filter command.
	setResetCommand ($a_val)
	Set reset filter command.
	getResetCommand ()
	Get reset filter command.
	setExternalSegmentation ($a_val)
	Set external segmentation.
	getExternalSegmentation ()
	Get external segmentation.
	setRowTemplate ($a_template, $a_template_dir="")
	Set row template.
	setDefaultOrderField ($a_defaultorderfield)
	Set Default order field.
	getDefaultOrderField ()
	Get Default order field.
	setDefaultOrderDirection ($a_defaultorderdirection)
	Set Default order direction.
	getDefaultOrderDirection ()
	Get Default order direction.
	clearCommandButtons ()
	addCommandButton ($a_cmd, $a_text, $a_onclick= '')
	Add Command button.
	addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection= '')
	Add Selection List + Command button.
	addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection= '')
	Add Selection List + Command button for selected items.
	setCloseCommand ($a_link)
	Add command for closing table.
	addMultiCommand ($a_cmd, $a_text)
	Add Command button.
	addHiddenInput ($a_name, $a_value)
	Add Hidden Input field.
	addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
	Add Header Command (Link) (Image needed for now)
	setTopCommands ($a_val)
	Set top commands (display command buttons on top of table, too)
	getTopCommands ()
	Get top commands (display command buttons on top of table, too)
	addColumn ($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="")
	Add a column to the header.
	getNavParameter ()
	setOrderLink ($sort_field, $order_dir)
	fillHeader ()
	determineOffsetAndOrder ($a_omit_offset=false)
	Determine offset and order.
	storeNavParameter ()
	getHTML ()
	Get HTML.
	numericOrdering ($a_field)
	Should this field be sorted numeric?
	render ()
	render table public
	writeFilterToSession ()
	Write filter values to session.
	resetFilter ()
	Reset filter.
	fillFooter ()
	Fill footer row.
	getLinkbar ($a_num)
	Get previous/next linkbar.
	fillHiddenRow ()
	fillActionRow ()
	Fill Action Row.
	setHeaderHTML ($html)
	set header html
Public Member Functions inherited from ilTableGUI
	ilTableGUI ($a_data=0, $a_global_tpl=true)
	Constructor.
	setTemplate (&$a_tpl)
	set template public
&	getTemplateObject ()
	setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
	set table help page public
	setHeaderNames ($a_header_names)
	set table header names public
	getColumnCount ()
	Returns the column count based on the number of the header row columns public.
	setHeaderVars ($a_header_vars, $a_header_params=0)
	set table header vars public
	setColumnWidth ($a_column_width)
	set table column widths public
	setOneColumnWidth ($a_column_width, $a_column_number)
	set one table column width public
	setMaxCount ($a_max_count)
	set max.
	setLimit ($a_limit=0, $a_default_limit=0)
	set max.
	getLimit ()
	Get limit.
	setOffset ($a_offset)
	set dataset offset public
	getOffset ()
	Get offset.
	setOrderColumn ($a_order_column=0, $a_default_column=0)
	set order column public
	getOrderColumn ()
	Get order column.
	setOrderDirection ($a_order_direction)
	set order direction public
	getOrderDirection ()
	Get order direction.
	setFooter ($a_style, $a_previous=0, $a_next=0)
	set order direction public
	enable ($a_module_name)
	enables particular modules of table
	disable ($a_module_name)
	diesables particular modules of table
	sortData ()
	renderHeader ()
	setStyle ($a_element, $a_style)
	getStyle ($a_element)
	setBase ($a_base)
	Set Base script name (deprecated, only use this for workarounds).
	getBase ()
	Get Base script name (deprecated, only use this for workarounds).
	clearActionButtons ()
	addActionButton ($btn_name, $btn_value)

Protected Member Functions
	fillRow ($user)
	Fill table row.
Protected Member Functions inherited from ilTable2GUI
	prepareOutput ()
	Anything that must be done before HTML is generated.

Additional Inherited Members
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 Attributes inherited from ilTable2GUI
	$close_command = ""
	$top_anchor = "il_table_top"
	$filters = array()
	$optional_filters = array()
	$filter_cmd = 'applyFilter'
	$reset_cmd = 'resetFilter'
	$filter_cols = 4
	$ext_sort = false
	$ext_seg = false
	$mi_sel_buttons = null
	$disable_filter_hiding = false
	$top_commands = false

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

ilUserTableGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd
	)

Constructor.

Reimplemented from ilTable2GUI.

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

References $ilCtrl, $lng, ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), getItems(), initFilter(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setTopCommands().

        {
                global $ilCtrl, $lng, $ilAccess, $lng, $rbacsystem;
                
                $this->setId("user");
                
                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", "17%");
                $this->addColumn($this->lng->txt("firstname"), "firstname", "17%");
                $this->addColumn($this->lng->txt("lastname"), "lastname", "17%");
                $this->addColumn($this->lng->txt("email"), "email", "17%");
                $this->addColumn($this->lng->txt("access_until"), "access_until", "17%");
                $this->addColumn($this->lng->txt("last_login"), "last_login", "17%");
                
                $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 ($rbacsystem->checkAccess('delete', $a_parent_obj->object->getRefId()))
                {
                        $this->addMultiCommand("deleteUsers", $lng->txt("delete"));
                }
                $this->addMultiCommand("activateUsers", $lng->txt("activate"));
                $this->addMultiCommand("deactivateUsers", $lng->txt("deactivate"));
                $this->addMultiCommand("restrictAccess", $lng->txt("accessRestrict"));
                $this->addMultiCommand("freeAccess", $lng->txt("accessFree"));
                $this->addMultiCommand("exportUsers", $lng->txt("export"));
                $this->addCommandButton("importUserForm", $lng->txt("import_users"));
                $this->addCommandButton("addUser", $lng->txt("usr_add"));
                
                $this->getItems();
        }

Here is the call graph for this function:

Member Function Documentation

ilUserTableGUI::fillRow (   $user )

protected

Fill table row.

Reimplemented from ilTable2GUI.

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

References $ilCtrl, $lng, $user, ilDatePresentation\formatDate(), and IL_CAL_DATETIME.

        {
                global $ilCtrl, $lng;

                if ($user["usr_id"] != 6)
                {
                        $this->tpl->setCurrentBlock("checkb");
                        $this->tpl->setVariable("ID", $user["usr_id"]);
                        $this->tpl->parseCurrentBlock();
                }
                
                $this->tpl->setVariable("VAL_LOGIN", $user["login"]);
                $this->tpl->setVariable("VAL_FIRSTNAME", $user["firstname"]);
                $this->tpl->setVariable("VAL_LASTNAME", $user["lastname"]);
                $this->tpl->setVariable("VAL_EMAIL", $user["email"]);
                $this->tpl->setVariable("VAL_LAST_LOGIN",
                        ilDatePresentation::formatDate(new ilDateTime($user['last_login'],IL_CAL_DATETIME)));
                $this->tpl->setVariable("VAL_ACCESS_UNTIL", $user["access_until"]);
                $this->tpl->setVariable("CLASS_ACCESS_UNTIL", $user["access_class"]);
                $ilCtrl->setParameterByClass("ilobjusergui", "obj_id", $user["usr_id"]);
                $this->tpl->setVariable("HREF_LOGIN",
                        $ilCtrl->getLinkTargetByClass("ilobjusergui", "view"));
                $ilCtrl->setParameterByClass("ilobjusergui", "obj_id", "");
        }

Here is the call graph for this function:

ilUserTableGUI::getItems

(

)

Get user items.

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

References $lng, $user, ilTable2GUI\determineOffsetAndOrder(), elseif(), ilDatePresentation\formatDate(), ilTableGUI\getLimit(), ilTableGUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilUserQuery\getUserListData(), IL_CAL_UNIX, ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), and ilUtil\stripSlashes().

Referenced by __construct().

        {
                global $lng;
                
                $this->determineOffsetAndOrder();
                
                include_once("./Services/User/classes/class.ilUserQuery.php");

                $usr_data = ilUserQuery::getUserListData(
                        ilUtil::stripSlashes($this->getOrderField()),
                        ilUtil::stripSlashes($this->getOrderDirection()),
                        ilUtil::stripSlashes($this->getOffset()),
                        ilUtil::stripSlashes($this->getLimit()),
                        $this->filter["query"],
                        $this->filter["activation"],
                        $this->filter["last_login"],
                        $this->filter["limited_access"],
                        $this->filter["no_courses"],
                        $this->filter["course_group"],
                        $this->filter["global_role"]
                        );
                        
                if (count($usr_data["set"]) == 0 && $this->getOffset() > 0)
                {
                        $this->resetOffset();
                        $usr_data = ilUserQuery::getUserListData(
                                ilUtil::stripSlashes($this->getOrderField()),
                                ilUtil::stripSlashes($this->getOrderDirection()),
                                ilUtil::stripSlashes($this->getOffset()),
                                ilUtil::stripSlashes($this->getLimit()),
                                $this->filter["query"],
                                $this->filter["activation"],
                                $this->filter["last_login"],
                                $this->filter["limited_access"],
                                $this->filter["no_courses"],
                                $this->filter["course_group"],
                                $this->filter["global_role"]
                                );
                }

                foreach ($usr_data["set"] as $k => $user)
                {
                        $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:

ilUserTableGUI::initFilter

(

)

Init filter.

Reimplemented from ilTable2GUI.

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

References $lng, ilTable2GUI\addFilterItem(), IL_CAL_DAY, IL_CAL_UNIX, ilDateTimeInputGUI\setDate(), ilTextInputGUI\setMaxLength(), ilSelectInputGUI\setOptions(), and ilRepositorySelectorInputGUI\setSelectText().

Referenced by __construct().

        {
                global $lng, $rbacreview, $ilUser;
                
                // title/description
                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();

                // 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();
                
                // 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();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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