Learning progress table: One object, rows: users, columns: properties Example: A course, rows: members, columns: name, status, mark, ... PD, Personal Learning Progress -> UserObjectsProps PD, Learning Progress of Users -> UserAggObjectsProps Crs, Learnign Progress of Participants -> ObjectUsersProps Details -> UserObjectsProps More: PropUsersObjects (Grading Overview in Course) More...

Inheritance diagram for ilTrObjectUsersPropsTableGUI:

Collaboration diagram for ilTrObjectUsersPropsTableGUI:

Public Member Functions
	__construct (?object $a_parent_obj, string $a_parent_cmd, int $a_obj_id, int $a_ref_id, bool $a_print_view=false)
	Constructor. More...

	getSelectableColumns ()
	Get selectable columns. More...

	getItems ()
	Get user items. More...

	initFilter ()

Public Member Functions inherited from ilLPTableBaseGUI
	__construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")

	executeCommand ()

	searchFilterListener (int $a_ref_id, array $a_data)
	Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED @access public. More...

	initBaseFilter (bool $a_split_learning_resources=false, bool $a_include_no_status_filter=true)
	Init filter. More...

	getCurrentFilter (bool $as_query=false)

	getIconVariant ()
	Gets the variant of LP icons that is shown in the table. More...

	setIconVariant (int $variant)
	Sets the variant of LP icons that is shown in the table. 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)

Protected Member Functions
	fillRow (array $a_set)
	Standard Version of Fill Row. 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...

	fillHeaderCSV (ilCSVWriter $a_csv)
	CSV Version of Fill Header. More...

	fillRowCSV (ilCSVWriter $a_csv, array $a_set)
	CSV Version of Fill Row. More...

Protected Member Functions inherited from ilLPTableBaseGUI
	initItemIdFromPost ()

	initUidFromPost ()

	findReferencesForObjId (int $a_obj_id)

	sendMail (array $a_user_ids, $a_parent_obj, string $a_parent_cmd)

	searchObjects (array $filter, string $permission, ?array $preset_obj_ids=null, bool $a_check_lp_activation=true)
	Search objects that match current filters. More...

	isForwardingToFormDispatcher ()

	initRepositoryFilter (array $filter)

	buildPath (array $ref_ids)

	getPossibleTypes (bool $a_split_learning_resources=false, bool $a_include_digilib=false, bool $a_allow_undefined_lp=false)

	parseValue (string $id, ?string $value, string $type)

	isPercentageAvailable (int $a_obj_id)

	parseTitle (int $a_obj_id, string $action, int $a_user_id=0)

	getExportMeta ()
	Build export meta data. More...

	fillMetaExcel (ilExcel $a_excel, int &$a_row)
	Add meta information to excel export. More...

	fillMetaCSV (ilCSVWriter $a_csv)
	Add meta information to csv export. More...

	showTimingsWarning (int $a_ref_id, int $a_user_id)

	formatSeconds (int $seconds, bool $a_shorten_zero=false)

	anonymizeValue ($a_value, bool $a_force_number=false)

	buildValueScale (int $a_max_value, bool $a_anonymize=false, bool $a_format_seconds=false)

	getMonthsFilter ($a_short=false)

	getMonthsYear ($a_year=null, $a_short=false)

	getSelectableUserColumns (int $a_in_course=0, int $a_in_group=0)

	addToClipboard ()
	Add selected users to clipboard. 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
array	$user_fields

int	$in_course = 0

int	$in_group = 0

int	$in_course_ref_id = 0

int	$in_group_ref_id = 0

bool	$has_edit = false

bool	$has_collection = false

bool	$has_multi = false

int	$obj_id

int	$ref_id

string	$type

ilTree	$tree

ilRbacSystem	$rbacsystem

ilObjectDataCache	$ilObjDataCache

ilObjectDefinition	$objDefinition

Protected Attributes inherited from ilLPTableBaseGUI
RefineryFactory	$refinery

HttpService	$http

array	$filter = []

bool	$anonymized = true

int	$icon_variant = ilLPStatusIcons::ICON_VARIANT_LONG

ilSetting	$setting

ilObjectDataCache	$ilObjDataCache

ilObjectDefinition	$objDefinition

ilTree	$tree

ilGlobalTemplateInterface	$main_tpl

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

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

Data Fields inherited from ilLPTableBaseGUI
const	HIT_LIMIT = 5000

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

Detailed Description

Learning progress table: One object, rows: users, columns: properties Example: A course, rows: members, columns: name, status, mark, ... PD, Personal Learning Progress -> UserObjectsProps PD, Learning Progress of Users -> UserAggObjectsProps Crs, Learnign Progress of Participants -> ObjectUsersProps Details -> UserObjectsProps More: PropUsersObjects (Grading Overview in Course)

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

Version: $Id$ @ilCtrl_Calls ilTrObjectUsersPropsTableGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilTrObjectUsersPropsTableGUI::__construct	(	?object	$a_parent_obj,
		string	$a_parent_cmd,
		int	$a_obj_id,
		int	$a_ref_id,
		bool	$a_print_view = `false`
	)

Constructor.

Definition at line 58 of file class.ilTrObjectUsersPropsTableGUI.php.

      {
        global $DIC;
 
        $this->tree = $DIC->repositoryTree();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->ilObjDataCache = $DIC['ilObjDataCache'];
        $this->objDefinition = $DIC['objDefinition'];
 
        $this->setId("troup");
        $this->obj_id = $a_obj_id;
        $this->ref_id = $a_ref_id;
        $this->type = ilObject::_lookupType($a_obj_id);
 
        $this->in_group_ref_id = $this->tree->checkForParentType($this->ref_id, "grp");
        if ($this->in_group_ref_id) {
            $this->in_group = ilObject::_lookupObjId($this->in_group_ref_id);
        } else {
            $this->in_course_ref_id = $this->tree->checkForParentType(
                $this->ref_id,
                "crs"
            );
            if ($this->in_course_ref_id) {
                $this->in_course = ilObject::_lookupObjId($this->in_course_ref_id);
            }
        }
        parent::__construct($a_parent_obj, $a_parent_cmd);
        $this->parseTitle($a_obj_id, "trac_participants");
 
        if ($a_print_view) {
            $this->setPrintMode(true);
        }
 
        if (!$this->getPrintMode()) {
            // see ilObjCourseGUI::addMailToMemberButton()
            $mail = new ilMail($DIC->user()->getId());
            if ($this->rbacsystem->checkAccess(
                "internal_mail",
                $mail->getMailObjectReferenceId()
            )) {
                $this->addMultiCommand(
                    "mailselectedusers",
                    $this->lng->txt("send_mail")
                );
            }
            $this->lng->loadLanguageModule('user');
            $this->addMultiCommand(
                'addToClipboard',
                $this->lng->txt('clipboard_add_btn')
            );
            $this->addColumn("", "", 1);
            $this->has_multi = true;
        }
 
        $labels = $this->getSelectableColumns();
        $first = false;
        foreach ($this->getSelectedColumns() as $c) {
            $first = $c;
 
            // list cannot be sorted by udf fields (separate query)
            // because of pagination only core fields can be sorted
            $sort_id = (substr($c, 0, 4) == "udf_") ? "" : $c;
 
            $this->addColumn($labels[$c]["txt"], $sort_id);
        }
 
        if (!$this->getPrintMode()) {
            $this->addColumn($this->lng->txt("actions"), "");
        }
        $this->setSelectAllCheckbox('uid');
        $this->setExternalSorting(true);
        $this->setExternalSegmentation(true);
        $this->setEnableHeader(true);
        $this->setFormAction(
            $this->ctrl->getFormActionByClass(get_class($this))
        );
        $this->setRowTemplate(
            "tpl.object_users_props_row.html",
            "Services/Tracking"
        );
        $this->setEnableTitle(true);
        $this->setShowTemplates(true);
        $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
 
        if ($first) {
            $this->setDefaultOrderField($first);
            $this->setDefaultOrderDirection("asc");
        }
 
        $this->initFilter();
 
        $this->getItems();
 
        // #13807
        $this->has_edit = ilLearningProgressAccess::checkPermission(
            'edit_learning_progress',
            $this->ref_id
        );
    }

References $c, $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ilLearningProgressAccess\checkPermission(), ILIAS\Repository\ctrl(), getItems(), ilTable2GUI\getPrintMode(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), initFilter(), ILIAS\Repository\lng(), ilLPTableBaseGUI\parseTitle(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExportFormats(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setPrintMode(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setShowTemplates().

Here is the call graph for this function:

Member Function Documentation

◆ fillHeaderCSV()

ilTrObjectUsersPropsTableGUI::fillHeaderCSV ( ilCSVWriter $a_csv )

protected

CSV Version of Fill Header.

Likely to be overwritten by derived class.

Parameters

ilCSVWriter $a_csv current file

Reimplemented from ilTable2GUI.

Definition at line 550 of file class.ilTrObjectUsersPropsTableGUI.php.

                                                        : void
    {
        $labels = $this->getSelectableColumns();
        foreach ($this->getSelectedColumns() as $c) {
            $a_csv->addColumn($labels[$c]["txt"]);
        }
 
        $a_csv->addRow();
    }

References $c, ilCSVWriter\addColumn(), and ilCSVWriter\addRow().

Here is the call graph for this function:

◆ fillHeaderExcel()

ilTrObjectUsersPropsTableGUI::fillHeaderExcel	(	ilExcel	$a_excel,
		int &	$a_row
	)

protected

Excel Version of Fill Header.

Likely to be overwritten by derived class.

Parameters

ilExcel	$a_excel	excel wrapper
int	$a_row	row counter

Reimplemented from ilTable2GUI.

Definition at line 519 of file class.ilTrObjectUsersPropsTableGUI.php.

                                                                     : void
    {
        $labels = $this->getSelectableColumns();
        $cnt = 0;
        foreach ($this->getSelectedColumns() as $c) {
            $a_excel->setCell($a_row, $cnt++, $labels[$c]["txt"]);
        }
 
        $a_excel->setBold(
            "A" . $a_row . ":" . $a_excel->getColumnCoord($cnt - 1) . $a_row
        );
    }

References $c, ilExcel\getColumnCoord(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ilExcel\setBold(), and ilExcel\setCell().

Here is the call graph for this function:

◆ fillRow()

ilTrObjectUsersPropsTableGUI::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 408 of file class.ilTrObjectUsersPropsTableGUI.php.

                                            : void
    {
        if ($this->has_multi) {
            $this->tpl->setVariable("USER_ID", $a_set["usr_id"]);
        }
 
        foreach ($this->getSelectedColumns() as $c) {
            if (!(bool) ($a_set["privacy_conflict"] ?? null)) {
                if ($c == 'status' && $a_set[$c] != ilLPStatus::LP_STATUS_COMPLETED_NUM) {
                    $timing = $this->showTimingsWarning(
                        $this->ref_id,
                        $a_set["usr_id"]
                    );
                    if ($timing) {
                        if ($timing !== true) {
                            $timing = ": " . ilDatePresentation::formatDate(
                                new ilDate($timing, IL_CAL_UNIX)
                            );
                        } else {
                            $timing = "";
                        }
                        $this->tpl->setCurrentBlock('warning_img');
                        $this->tpl->setVariable(
                            'WARNING_IMG',
                            ilUtil::getImagePath(
                                'time_warn.svg'
                            )
                        );
                        $this->tpl->setVariable(
                            'WARNING_ALT',
                            $this->lng->txt(
                                'trac_time_passed'
                            ) . $timing
                        );
                        $this->tpl->parseCurrentBlock();
                    }
                }
 
                // #7694
                if ($c == 'login' && !$a_set["active"]) {
                    $this->tpl->setCurrentBlock('inactive_bl');
                    $this->tpl->setVariable(
                        'TXT_INACTIVE',
                        $this->lng->txt("inactive")
                    );
                    $this->tpl->parseCurrentBlock();
                }
 
                $val = $this->parseValue($c, $a_set[$c] ?? '', $this->type);
            } else {
                if ($c == 'login') {
                    $this->tpl->setCurrentBlock('inactive_bl');
                    $this->tpl->setVariable(
                        'TXT_INACTIVE',
                        $this->lng->txt(
                            "status_no_permission"
                        )
                    );
                    $this->tpl->parseCurrentBlock();
                }
 
                $val = "&nbsp;";
            }
 
            $this->tpl->setCurrentBlock("user_field");
            $this->tpl->setVariable("VAL_UF", $val);
            $this->tpl->parseCurrentBlock();
        }
 
        $this->ctrl->setParameterByClass(
            "illplistofobjectsgui",
            "user_id",
            $a_set["usr_id"]
        );
 
        if (!$this->getPrintMode() && !(bool) ($a_set["privacy_conflict"] ?? null)) {
            // details for containers and collections
            if ($this->has_collection ||
                $this->objDefinition->isContainer($this->type)) {
                $this->tpl->setCurrentBlock("item_command");
                $this->tpl->setVariable(
                    "HREF_COMMAND",
                    $this->ctrl->getLinkTargetByClass(
                        "illplistofobjectsgui",
                        "userdetails"
                    )
                );
                $this->tpl->setVariable(
                    "TXT_COMMAND",
                    $this->lng->txt('details')
                );
                $this->tpl->parseCurrentBlock();
            }
 
            if ($this->has_edit) {
                $this->tpl->setCurrentBlock("item_command");
                $this->tpl->setVariable(
                    "HREF_COMMAND",
                    $this->ctrl->getLinkTargetByClass(
                        "illplistofobjectsgui",
                        "edituser"
                    )
                );
                $this->tpl->setVariable("TXT_COMMAND", $this->lng->txt('edit'));
                $this->tpl->parseCurrentBlock();
            }
        }
 
        $this->ctrl->setParameterByClass("illplistofobjectsgui", 'user_id', '');
    }

References $c, ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilTable2GUI\getPrintMode(), ilTable2GUI\getSelectedColumns(), IL_CAL_UNIX, ILIAS\Repository\lng(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPTableBaseGUI\parseValue(), and ilLPTableBaseGUI\showTimingsWarning().

Here is the call graph for this function:

◆ fillRowCSV()

ilTrObjectUsersPropsTableGUI::fillRowCSV	(	ilCSVWriter	$a_csv,
		array	$a_set
	)

protected

CSV Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

ilCSVWriter	$a_csv	current file
array	$a_set	data array

Reimplemented from ilTable2GUI.

Definition at line 560 of file class.ilTrObjectUsersPropsTableGUI.php.

                                                                   : void
    {
        foreach ($this->getSelectedColumns() as $c) {
            if ($c != 'status') {
                $val = $this->parseValue($c, $a_set[$c], $this->type);
            } else {
                $val = ilLearningProgressBaseGUI::_getStatusText(
                    (int) $a_set[$c]
                );
            }
            $a_csv->addColumn($val);
        }
 
        $a_csv->addRow();
    }

References $c, ilLearningProgressBaseGUI\_getStatusText(), ilCSVWriter\addColumn(), and ilCSVWriter\addRow().

Here is the call graph for this function:

◆ fillRowExcel()

ilTrObjectUsersPropsTableGUI::fillRowExcel	(	ilExcel	$a_excel,
		int &	$a_row,
		array	$a_set
	)

protected

Excel Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

ilExcel	$a_excel	excel wrapper
int	$a_row	row counter
array	$a_set	data array

Reimplemented from ilTable2GUI.

Definition at line 532 of file class.ilTrObjectUsersPropsTableGUI.php.

     : void {
        $cnt = 0;
        foreach ($this->getSelectedColumns() as $c) {
            if ($c != 'status') {
                $val = $this->parseValue($c, $a_set[$c], $this->type);
            } else {
                $val = ilLearningProgressBaseGUI::_getStatusText(
                    (int) $a_set[$c]
                );
            }
            $a_excel->setCell($a_row, $cnt++, $val);
        }
    }

References $c, ilLearningProgressBaseGUI\_getStatusText(), ilLPTableBaseGUI\parseValue(), and ilExcel\setCell().

Here is the call graph for this function:

◆ getItems()

ilTrObjectUsersPropsTableGUI::getItems ( )

Get user items.

Definition at line 182 of file class.ilTrObjectUsersPropsTableGUI.php.

                              : void
    {
        $this->determineOffsetAndOrder();
        $additional_fields = $this->getSelectedColumns();
 
        // only if object is [part of] course/group
        $check_agreement = null;
        if ($this->in_course) {
            // privacy (if course agreement is activated)
            $privacy = ilPrivacySettings::getInstance();
            if ($privacy->courseConfirmationRequired()) {
                $check_agreement = $this->in_course;
            }
        } elseif ($this->in_group) {
            // privacy (if group agreement is activated)
            $privacy = ilPrivacySettings::getInstance();
            if ($privacy->groupConfirmationRequired()) {
                $check_agreement = $this->in_group;
            }
        }
        $tr_data = ilTrQuery::getUserDataForObject(
            $this->ref_id,
            ilUtil::stripSlashes($this->getOrderField()),
            ilUtil::stripSlashes($this->getOrderDirection()),
            ilUtil::stripSlashes($this->getOffset()),
            ilUtil::stripSlashes($this->getLimit()),
            $this->getCurrentFilter(),
            $additional_fields,
            $check_agreement,
            $this->user_fields
        );
        if (count($tr_data["set"]) == 0 && $this->getOffset() > 0) {
            $this->resetOffset();
            $tr_data = ilTrQuery::getUserDataForObject(
                $this->ref_id,
                ilUtil::stripSlashes($this->getOrderField()),
                ilUtil::stripSlashes($this->getOrderDirection()),
                ilUtil::stripSlashes($this->getOffset()),
                ilUtil::stripSlashes($this->getLimit()),
                $this->getCurrentFilter(),
                $additional_fields,
                $check_agreement,
                $this->user_fields
            );
        }
 
        /*
         * ilTrQuery does not read out any information about org units
         * (nor should it), so it needs to be added here.
         */
        if (in_array('org_units', $additional_fields)) {
            foreach (($tr_data['set'] ?? []) as $key => $data) {
                if (!isset($data['usr_id'])) {
                    continue;
                }
                $usr_id = (int) $data['usr_id'];
                $org_units = ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($usr_id);
                $tr_data["set"][$key]['org_units'] = $org_units;
            }
        }
 
        $this->setMaxCount($tr_data["cnt"]);
        $this->setData($tr_data["set"]);
    }

References ilTableGUI\$data, $in_course, $in_group, ILIAS\LTI\ToolProvider\$key, ilTable2GUI\determineOffsetAndOrder(), ilLPTableBaseGUI\getCurrentFilter(), ilPrivacySettings\getInstance(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\getSelectedColumns(), ilTrQuery\getUserDataForObject(), ILIAS\Repository\int(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), and ilUtil\stripSlashes().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectableColumns()

ilTrObjectUsersPropsTableGUI::getSelectableColumns ( )

Get selectable columns.

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

Reimplemented from ilTable2GUI.

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

                                          : array
    {
        if ($this->selectable_columns) {
            return $this->selectable_columns;
        }
 
        $cols = $this->getSelectableUserColumns(
            $this->in_course_ref_id,
            $this->in_group_ref_id
        );
        $this->user_fields = $cols[1];
        $this->selectable_columns = $cols[0];
 
        return $this->selectable_columns;
    }

References $cols, ilTable2GUI\$selectable_columns, and ilLPTableBaseGUI\getSelectableUserColumns().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFilter()

ilTrObjectUsersPropsTableGUI::initFilter ( )

Reimplemented from ilTable2GUI.

Definition at line 247 of file class.ilTrObjectUsersPropsTableGUI.php.

                                : void
    {
        foreach ($this->getSelectableColumns() as $column => $meta) {
            // no udf!
            switch ($column) {
                case "firstname":
                case "lastname":
                case "mark":
                case "u_comment":
                case "institution":
                case "department":
                case "title":
                case "street":
                case "zipcode":
                case "city":
                case "country":
                case "email":
                case "matriculation":
                case "login":
                    if ($column != "mark" ||
                        ilObjectLP::supportsMark($this->type)) {
                        $item = $this->addFilterItemByMetaType(
                            $column,
                            ilTable2GUI::FILTER_TEXT,
                            true,
                            $meta["txt"]
                        );
                        $this->filter[$column] = $item->getValue();
                    }
                    break;
 
                case "first_access":
                case "last_access":
                case "create_date":
                case 'status_changed':
                    $item = $this->addFilterItemByMetaType(
                        $column,
                        ilTable2GUI::FILTER_DATETIME_RANGE,
                        true,
                        $meta["txt"]
                    );
                    $this->filter[$column] = $item->getDate();
                    break;
 
                case "birthday":
                    $item = $this->addFilterItemByMetaType(
                        $column,
                        ilTable2GUI::FILTER_DATE_RANGE,
                        true,
                        $meta["txt"]
                    );
                    $this->filter[$column] = $item->getDate();
                    break;
 
                case "read_count":
                case "percentage":
                    $item = $this->addFilterItemByMetaType(
                        $column,
                        ilTable2GUI::FILTER_NUMBER_RANGE,
                        true,
                        $meta["txt"]
                    );
                    $this->filter[$column] = $item->getValue();
                    break;
 
                case "gender":
                    $item = $this->addFilterItemByMetaType(
                        "gender",
                        ilTable2GUI::FILTER_SELECT,
                        true,
                        $meta["txt"]
                    );
                    $item->setOptions(
                        array(
                            "" => $this->lng->txt("trac_all"),
                            "n" => $this->lng->txt("gender_n"),
                            "m" => $this->lng->txt("gender_m"),
                            "f" => $this->lng->txt("gender_f"),
                        )
                    );
                    $this->filter["gender"] = $item->getValue();
                    break;
 
                case "sel_country":
                    $item = $this->addFilterItemByMetaType(
                        "sel_country",
                        ilTable2GUI::FILTER_SELECT,
                        true,
                        $meta["txt"]
                    );
 
                    $options = array();
                    foreach (ilCountry::getCountryCodes() as $c) {
                        $options[$c] = $this->lng->txt("meta_c_" . $c);
                    }
                    asort($options);
                    $item->setOptions(
                        array("" => $this->lng->txt("trac_all")) + $options
                    );
 
                    $this->filter["sel_country"] = $item->getValue();
                    break;
 
                case "status":
                    $item = $this->addFilterItemByMetaType(
                        "status",
                        ilTable2GUI::FILTER_SELECT,
                        true,
                        $meta["txt"]
                    );
                    $item->setOptions(
                        array("" => $this->lng->txt("trac_all"),
                              ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM + 1 => $this->lng->txt(
                                  ilLPStatus::LP_STATUS_NOT_ATTEMPTED
                              ),
                              ilLPStatus::LP_STATUS_IN_PROGRESS_NUM + 1 => $this->lng->txt(
                                  ilLPStatus::LP_STATUS_IN_PROGRESS
                              ),
                              ilLPStatus::LP_STATUS_COMPLETED_NUM + 1 => $this->lng->txt(
                                  ilLPStatus::LP_STATUS_COMPLETED
                              ),
                              ilLPStatus::LP_STATUS_FAILED_NUM + 1 => $this->lng->txt(
                                  ilLPStatus::LP_STATUS_FAILED
                              )
                        )
                    );
                    $this->filter["status"] = $item->getValue();
                    if (is_numeric($this->filter["status"])) {
                        $this->filter["status"]--;
                    }
                    break;
 
                case "language":
                    $item = $this->addFilterItemByMetaType(
                        "language",
                        ilTable2GUI::FILTER_LANGUAGE,
                        true
                    );
                    $this->filter["language"] = $item->getValue();
                    break;
 
                case "spent_seconds":
                    if (ilObjectLP::supportsSpentSeconds($this->type)) {
                        $item = $this->addFilterItemByMetaType(
                            "spent_seconds",
                            ilTable2GUI::FILTER_DURATION_RANGE,
                            true,
                            $meta["txt"]
                        );
                        $this->filter["spent_seconds"]["from"] = $item->getCombinationItem(
                            "from"
                        )->getValueInSeconds();
                        $this->filter["spent_seconds"]["to"] = $item->getCombinationItem(
                            "to"
                        )->getValueInSeconds();
                    }
                    break;
            }
        }
    }