name table More...

Inheritance diagram for ilTrMatrixTableGUI:

Collaboration diagram for ilTrMatrixTableGUI:

Public Member Functions
	__construct (?object $a_parent_obj, string $a_parent_cmd, int $ref_id)
	Constructor. More...

	initFilter ()

	numericOrdering ($a_field)

	getSelectableColumns ()

	getItems (array $a_user_fields, ?array $a_privary_fields=null)

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

	getData ()

	dataExists ()

	setPrefix (string $a_prefix)

	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 ()

	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 ()

	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)

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)

	fillHeaderExcel (ilExcel $a_excel, int &$a_row)

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

	fillHeaderCSV (ilCSVWriter $a_csv)

	fillRowCSV (ilCSVWriter $a_csv, array $a_set)

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)

	fillMetaCSV (ilCSVWriter $a_csv)

	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
int	$ref_id

array	$ref_ids = []

string	$type

int	$obj_id

array	$obj_ids = null

array	$objective_ids = []

array	$sco_ids = []

array	$subitem_ids = []

int	$in_course = 0

int	$in_group = 0

int	$in_course_ref_id = 0

int	$in_group_ref_id = 0

array	$privacy_fields = []

array	$privacy_cols = []

array	$perc_map = []

bool	$has_multi

ilTree	$tree

ilRbacSystem	$rbacsystem

ilObjectDataCache	$ilObjDataCache

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_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_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

name table

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$ /

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

Constructor & Destructor Documentation

◆ __construct()

ilTrMatrixTableGUI::__construct	(	?object	$a_parent_obj,
		string	$a_parent_cmd,
		int	$ref_id
	)

Constructor.

Definition at line 53 of file class.ilTrMatrixTableGUI.php.

References $c, $DIC, ilTableGUI\$icon, $ref_id, ilTableGUI\$title, ILIAS\GlobalScreen\Provider\__construct(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ILIAS\FileDelivery\http(), initFilter(), ILIAS\Repository\lng(), ilLPTableBaseGUI\parseTitle(), ILIAS\Repository\refinery(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setSelectAllCheckbox().

       {
         global $DIC;
 
         $this->tree = $DIC->repositoryTree();
         $this->rbacsystem = $DIC->rbac()->system();
         $this->ilObjDataCache = $DIC['ilObjDataCache'];
 
         $this->setId("trsmtx_" . $ref_id);
         $this->ref_id = $ref_id;
         $this->obj_id = ilObject::_lookupObjId($ref_id);
         $this->type = ilObject::_lookupType($this->obj_id); // #17188
 
         $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);
             }
         }
 
         $this->lng = $DIC->language();
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
         $this->initFilter();
         parent::__construct($a_parent_obj, $a_parent_cmd);
 
         $this->parseTitle($this->obj_id, "trac_matrix");
         $this->setEnableHeader(true);
         $this->setFormAction(
             $this->ctrl->getFormActionByClass(get_class($this))
         );
         $this->setRowTemplate(
             "tpl.user_object_matrix_row.html",
             "components/ILIAS/Tracking"
         );
         $this->setDefaultOrderField("login");
         $this->setDefaultOrderDirection("asc");
 
         // 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;
 
         $this->addColumn($this->lng->txt("login"), "login");
 
         $labels = $this->getSelectableColumns();
         $selected = $this->getSelectedColumns();
         foreach ($selected as $c) {
             $title = $labels[$c]["txt"];
 
             if (isset($labels[$c]["no_permission"]) && $labels[$c]["no_permission"]) {
                 $title .= " (" . $this->lng->txt("status_no_permission") . ")";
             }
 
             $tooltip = array();
             if (isset($labels[$c]["icon"])) {
                 $alt = $this->lng->txt($labels[$c]["type"] ?? "");
                 $icon = '<img class="ilListItemIcon" src="' . $labels[$c]["icon"] . '" alt="' . $alt . '" />';
                 if (sizeof($selected) > 5) {
                     $tooltip[] = $title;
                     $title = $icon;
                 } else {
                     $title = $icon . ' ' . $title;
                 }
                 if ($labels[$c]["path"] ?? false) {
                     $tooltip[] = $labels[$c]["path"];
                 }
             }
 
             if (isset($labels[$c]["id"])) {
                 $sort_id = $labels[$c]["id"];
             } else {
                 // list cannot be sorted by udf fields (separate query)
                 $sort_id = (substr($c, 0, 4) == "udf_") ? "" : $c;
             }
 
             $this->addColumn(
                 $title,
                 $sort_id,
                 "",
                 false,
                 "",
                 implode(" - ", $tooltip)
             );
         }
         $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
         $this->setSelectAllCheckbox('uid');
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillHeaderCSV()

ilTrMatrixTableGUI::fillHeaderCSV ( ilCSVWriter $a_csv )

protected

Definition at line 745 of file class.ilTrMatrixTableGUI.php.

References $c, $DIC, ilCSVWriter\addColumn(), ilCSVWriter\addRow(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ILIAS\Repository\lng(), and ilObjectPlugin\lookupTxtById().

                                                         : void
     {
         global $DIC;
 
         $ilObjDataCache = $DIC['ilObjDataCache'];
 
         $a_csv->addColumn($this->lng->txt("login"));
 
         $labels = $this->getSelectableColumns();
         foreach ($this->getSelectedColumns() as $c) {
             if (substr($c, 0, 4) == "obj_") {
                 $obj_id = substr($c, 4);
 
                 $type = $this->ilObjDataCache->lookupType((int) $obj_id);
                 if ($DIC['objDefinition']->isPlugin($type)) {
                     $type_text = ilObjectPlugin::lookupTxtById(
                         $type,
                         'obj_' . $type
                     );
                 } else {
                     $type_text = $this->lng->txt($type);
                 }
 
                 $a_csv->addColumn("(" . $type_text . ") " . $labels[$c]["txt"]);
 
                 if (isset($this->perc_map) && ($this->perc_map[$obj_id] ?? false)) {
                     $a_csv->addColumn(
                         $this->lng->txt("trac_percentage") . " (%)"
                     );
                 }
             } else {
                 $a_csv->addColumn($labels[$c]["txt"]);
             }
         }
 
         $a_csv->addRow();
     }

Here is the call graph for this function:

◆ fillHeaderExcel()

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

protected

Definition at line 644 of file class.ilTrMatrixTableGUI.php.

References $c, $DIC, ilExcel\getColumnCoord(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ILIAS\Repository\lng(), ilObjectPlugin\lookupTxtById(), ilExcel\setBold(), and ilExcel\setCell().

                                                                      : void
     {
         global $DIC;
 
         $ilObjDataCache = $DIC['ilObjDataCache'];
 
         $a_excel->setCell($a_row, 0, $this->lng->txt("login"));
 
         $labels = $this->getSelectableColumns();
         $cnt = 1;
         foreach ($this->getSelectedColumns() as $c) {
             if (substr($c, 0, 4) == "obj_") {
                 $obj_id = substr($c, 4);
 
                 $type = $this->ilObjDataCache->lookupType((int) $obj_id);
                 if ($DIC['objDefinition']->isPlugin($type)) {
                     $type_text = ilObjectPlugin::lookupTxtById(
                         $type,
                         'obj_' . $type
                     );
                 } else {
                     $type_text = $this->lng->txt($type);
                 }
 
                 $a_excel->setCell(
                     $a_row,
                     $cnt,
                     "(" . $type_text . ") " . $labels[$c]["txt"]
                 );
 
                 if (isset($this->perc_map) && ($this->perc_map[$obj_id] ?? false)) {
                     $cnt++;
                     $a_excel->setCell(
                         $a_row,
                         $cnt,
                         $this->lng->txt(
                             "trac_percentage"
                         ) . " (%)"
                     );
                 }
             } else {
                 $a_excel->setCell($a_row, $cnt, $labels[$c]["txt"]);
             }
             $cnt++;
         }
 
         $a_excel->setBold(
             "A" . $a_row . ":" . $a_excel->getColumnCoord($cnt) . $a_row
         );
     }

Here is the call graph for this function:

◆ fillRow()

ilTrMatrixTableGUI::fillRow ( array $a_set )

protected

Definition at line 506 of file class.ilTrMatrixTableGUI.php.

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

                                             : void
     {
         if ($this->has_multi) {
             $this->tpl->setVariable("USER_ID", $a_set["usr_id"]);
         }
 
         foreach ($this->getSelectedColumns() as $c) {
             switch ($c) {
                 case (substr($c, 0, 4) == "obj_"):
                     $obj_id = substr($c, 4);
 
                     // object without read-lp-permission
                     if (in_array($obj_id, $this->privacy_cols) ||
                         ($a_set["privacy_conflict"] ?? false)) {
                         $this->tpl->setCurrentBlock("objects");
                         $this->tpl->setVariable("VAL_STATUS", "&nbsp;");
                         $this->tpl->parseCurrentBlock();
                         continue 2;
                     }
 
                     $status = isset($a_set[$c])
                         ? (int) $a_set[$c]
                         : ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
                     $percentage = isset($a_set[$c . "_perc"])
                         ? (int) $a_set[$c . "_perc"]
                         : null;
 
                     if ($status != ilLPStatus::LP_STATUS_COMPLETED_NUM) {
                         $timing = $this->showTimingsWarning(
                             $this->ref_ids[$obj_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(
                                     'media/time_warn.svg'
                                 )
                             );
                             $this->tpl->setVariable(
                                 'WARNING_ALT',
                                 $this->lng->txt(
                                     'trac_time_passed'
                                 ) . $timing
                             );
                             $this->tpl->parseCurrentBlock();
                         }
                     }
 
                     $this->tpl->setCurrentBlock("objects");
                     $this->tpl->setVariable(
                         "VAL_STATUS",
                         $this->parseValue(
                             "status",
                             (string) $status,
                             ""
                         )
                     );
                     $this->tpl->setVariable(
                         "VAL_PERCENTAGE",
                         $this->parseValue(
                             "percentage",
                             (string) $percentage,
                             ""
                         )
                     );
                     $this->tpl->parseCurrentBlock();
                     break;
 
                 case (substr($c, 0, 6) == "objtv_"):
                 case (substr($c, 0, 7) == "objsco_"):
                 case (substr($c, 0, 7) == "objsub_"):
                     $status = isset($a_set[$c])
                         ? (int) $a_set[$c]
                         : ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
 
                     $this->tpl->setCurrentBlock("objects");
                     if (!($a_set["privacy_conflict"] ?? false)) {
                         $this->tpl->setVariable(
                             "VAL_STATUS",
                             $this->parseValue(
                                 "status",
                                 (string) $status,
                                 ""
                             )
                         );
                     } else {
                         $this->tpl->setVariable("VAL_STATUS", "&nbsp;");
                     }
                     $this->tpl->parseCurrentBlock();
                     break;
 
                 default:
                     $this->tpl->setCurrentBlock("user_field");
                     if (!($a_set["privacy_conflict"] ?? false)) {
                         $this->tpl->setVariable(
                             "VAL_UF",
                             $this->parseValue(
                                 $c,
                                 $a_set[$c] ?? "",
                                 ""
                             )
                         );
                     } else {
                         $this->tpl->setVariable("VAL_UF", "&nbsp;");
                     }
                     $this->tpl->parseCurrentBlock();
                     break;
             }
         }
 
         // #7694
         if (!$a_set["active"] || ($a_set["privacy_conflict"] ?? false)) {
             $mess = array();
             if ($a_set["privacy_conflict"] ?? false) {
                 $mess[] = $this->lng->txt("status_no_permission");
             } elseif (!$a_set["active"]) {
                 $mess[] = $this->lng->txt("inactive");
             }
             $this->tpl->setCurrentBlock('inactive_bl');
             $this->tpl->setVariable('TXT_INACTIVE', implode(", ", $mess));
             $this->tpl->parseCurrentBlock();
         }
 
         $login = !($a_set["privacy_conflict"] ?? false)
             ? $a_set["login"]
             : "&nbsp;";
         $this->tpl->setVariable("VAL_LOGIN", $login);
     }

Here is the call graph for this function:

◆ fillRowCSV()

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

protected

Definition at line 783 of file class.ilTrMatrixTableGUI.php.

References $c, ilLearningProgressBaseGUI\_getStatusText(), ilCSVWriter\addColumn(), ilCSVWriter\addRow(), ilTable2GUI\getSelectedColumns(), ILIAS\Repository\int(), null, and ilLPTableBaseGUI\parseValue().

                                                                    : void
     {
         $a_csv->addColumn($a_set["login"]);
 
         foreach ($this->getSelectedColumns() as $c) {
             switch ($c) {
                 case (substr($c, 0, 4) == "obj_"):
                     $obj_id = substr($c, 4);
                     $val = ilLearningProgressBaseGUI::_getStatusText(
                         (int) $a_set[$c]
                     );
                     $a_csv->addColumn($val);
 
                     if (isset($this->perc_map) && ($this->perc_map[$obj_id] ?? false)) {
                         $perc = (int) $a_set[$c . "_perc"];
                         if (!$perc) {
                             $perc = null;
                         }
                         $a_csv->addColumn((string) $perc);
                     }
                     break;
 
                 case (substr($c, 0, 6) == "objtv_"):
                 case (substr($c, 0, 7) == "objsco_"):
                 case (substr($c, 0, 7) == "objsub_"):
                     $val = ilLearningProgressBaseGUI::_getStatusText(
                         (int) $a_set[$c]
                     );
                     $a_csv->addColumn($val);
                     break;
 
                     /* #14142
                     case "last_access":
                     case "spent_seconds":
                     case "status_changed":
                     */
                 default:
                     $val = $this->parseValue($c, $a_set[$c] ?? '', "user");
                     $a_csv->addColumn($val);
                     break;
             }
         }
 
         $a_csv->addRow();
     }

Here is the call graph for this function:

◆ fillRowExcel()

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

protected

Definition at line 695 of file class.ilTrMatrixTableGUI.php.

References $c, ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\getSelectedColumns(), ILIAS\Repository\int(), null, ilLPTableBaseGUI\parseValue(), and ilExcel\setCell().

      : void {
         $a_excel->setCell($a_row, 0, $a_set["login"]);
 
         $cnt = 1;
         foreach ($this->getSelectedColumns() as $c) {
             switch ($c) {
                 case (substr($c, 0, 4) == "obj_"):
                     $obj_id = substr($c, 4);
                     $val = ilLearningProgressBaseGUI::_getStatusText(
                         (int) $a_set[$c]
                     );
                     $a_excel->setCell($a_row, $cnt, $val);
 
                     if (isset($this->perc_map) && ($this->perc_map[$obj_id] ?? false)) {
                         $cnt++;
                         $perc = (int) ($a_set[$c . "_perc"] ?? 0);
                         $perc = !$perc
                             ? null
                             : $perc . "%";
                         $a_excel->setCell($a_row, $cnt, $perc);
                     }
                     break;
 
                 case (substr($c, 0, 6) == "objtv_"):
                 case (substr($c, 0, 7) == "objsco_"):
                 case (substr($c, 0, 7) == "objsub_"):
                     $val = ilLearningProgressBaseGUI::_getStatusText(
                         (int) $a_set[$c]
                     );
                     $a_excel->setCell($a_row, $cnt, $val);
                     break;
 
                     /* #14142
                     case "last_access":
                     case "spent_seconds":
                     case "status_changed":
                     */
                 default:
                     $val = $this->parseValue($c, $a_set[$c] ?? '', "user");
                     $a_excel->setCell($a_row, $cnt, $val);
                     break;
             }
             $cnt++;
         }
     }

Here is the call graph for this function:

◆ getItems()

ilTrMatrixTableGUI::getItems	(	array	$a_user_fields,
		?array	$a_privary_fields = `null`
	)

Definition at line 327 of file class.ilTrMatrixTableGUI.php.

References ilTable2GUI\$column, ilTableGUI\$data, $in_course, $in_group, $obj_id, $objectives, $user_id, ILIAS\Repository\filter(), ilPrivacySettings\getInstance(), ilTrQuery\getObjectIds(), ilTrQuery\getUserObjectiveMatrix(), ilTrQuery\getUserObjectMatrix(), ILIAS\Repository\int(), ilLPTableBaseGUI\isPercentageAvailable(), ilCourseObjective\lookupObjectiveTitle(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ilTable2GUI\setData(), ilTable2GUI\setFilterValue(), and ilTableGUI\setMaxCount().

Referenced by getSelectableColumns().

      : array {
 
         // #17081
         if ($this->restore_filter) {
             $name = $this->restore_filter_values["name"];
             $this->setFilterValue($this->filters[0], $name);
             $this->filter["name"] = $name;
         }
 
         $collection = ilTrQuery::getObjectIds(
             $this->obj_id,
             $this->ref_id,
             true
         );
         if ($collection["object_ids"]) {
             // we need these for the timing warnings
             $this->ref_ids = $collection["ref_ids"];
 
             // only if object is [part of] course/group
             $check_agreement = false;
             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;
                 }
             }
             $data = ilTrQuery::getUserObjectMatrix(
                 $this->ref_id,
                 $collection["object_ids"],
                 $this->filter["name"] ?? '',
                 $a_user_fields,
                 $a_privary_fields,
                 $check_agreement
             );
             if ($collection["objectives_parent_id"] && $data["users"]) {
                 // sub-items: learning objectives
                 $objectives = ilTrQuery::getUserObjectiveMatrix(
                     $collection["objectives_parent_id"],
                     $data["users"]
                 );
 
                 $this->objective_ids = array();
 
                 foreach ($objectives as $user_id => $inner_objectives) {
                     if (isset($data["set"][$user_id])) {
                         foreach ($inner_objectives as $objective_id => $status) {
                             $obj_id = "objtv_" . $objective_id;
                             $data["set"][$user_id][$obj_id] = $status;
 
                             if (!in_array($obj_id, $this->objective_ids)) {
                                 $this->objective_ids[$objective_id] = ilCourseObjective::lookupObjectiveTitle(
                                     $objective_id
                                 );
                             }
                         }
                     }
                 }
             }
 
             // sub-items: SCOs
             if ($collection["scorm"] && $data["set"]) {
                 $this->sco_ids = array();
                 foreach (array_keys($data["set"]) as $user_id) {
                     foreach ($collection["scorm"]["scos"] as $sco) {
                         if (!in_array($sco, $this->sco_ids)) {
                             $this->sco_ids[$sco] = $collection["scorm"]["scos_title"][$sco];
                         }
 
                         // alex, 5 Nov 2011: we got users being in failed and in
                         // completed status, I changed the setting in: first check failed
                         // then check completed since failed should superseed completed
                         // (before completed has been checked before failed)
                         $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
                         if (in_array(
                             $user_id,
                             $collection["scorm"]["failed"][$sco]
                         )) {
                             $status = ilLPStatus::LP_STATUS_FAILED_NUM;
                         } elseif (in_array(
                             $user_id,
                             $collection["scorm"]["completed"][$sco]
                         )) {
                             $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
                         } elseif (in_array(
                             $user_id,
                             $collection["scorm"]["in_progress"][$sco]
                         )) {
                             $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
                         }
 
                         $obj_id = "objsco_" . $sco;
                         $data["set"][$user_id][$obj_id] = $status;
                     }
                 }
             }
 
             // sub-items: generic, e.g. lm chapter
             if ($collection["subitems"] && $data["set"]) {
                 foreach (array_keys($data["set"]) as $user_id) {
                     foreach ($collection["subitems"]["items"] as $item_id) {
                         $this->subitem_ids[$item_id] = $collection["subitems"]["item_titles"][$item_id];
 
                         $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
                         if (isset(
                             $collection["subitems"]["completed"]
                         ) && in_array(
                             $user_id,
                             $collection["subitems"]["completed"][$item_id]
                         )) {
                             $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
                         } elseif (isset(
                             $collection["subitems"]["in_progress"]
                         ) &&
                             in_array(
                                 $user_id,
                                 $collection["subitems"]["in_progress"][$item_id]
                             )) {
                             $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
                         }
 
                         $obj_id = "objsub_" . $item_id;
                         $data["set"][$user_id][$obj_id] = $status;
                     }
                 }
             }
 
             // percentage export
             if ($data["set"]) {
                 $this->perc_map = array();
                 foreach ($data["set"] as $row_idx => $row) {
                     foreach ($row as $column => $value) {
                         if (substr($column, -5) == "_perc") {
                             $obj_id = explode("_", $column);
                             $obj_id = (int) $obj_id[1];
 
                             // #18673
                             if (!$this->isPercentageAvailable($obj_id) ||
                                 !(int) $value) {
                                 unset($data["set"][$row_idx][$column]);
                             } else {
                                 $this->perc_map[$obj_id] = true;
                             }
                         }
                     }
                 }
             }
 
             /*
              * 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', $a_user_fields)) {
                 foreach (($data['set'] ?? []) as $key => $usr_data) {
                     if (!isset($usr_data['usr_id'])) {
                         continue;
                     }
                     $usr_id = (int) $usr_data['usr_id'];
                     $org_units = ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($usr_id);
                     $data["set"][$key]['org_units'] = $org_units;
                 }
             }
 
             $this->setMaxCount($data["cnt"] ?? 0);
             $this->setData($data["set"] ?? []);
             return $collection["object_ids"] ?? [];
         }
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectableColumns()

ilTrMatrixTableGUI::getSelectableColumns ( )

Definition at line 191 of file class.ilTrMatrixTableGUI.php.

References ilTableGUI\$icon, ilTable2GUI\$id, $obj_id, $path, ilTableGUI\$title, ilObject\_getIcon(), ilContainerReference\_lookupTargetTitle(), ilLearningProgressAccess\checkPermission(), getItems(), ilLPTableBaseGUI\getSelectableUserColumns(), ilTrQuery\getSubItemType(), ILIAS\Repository\lng(), and null.

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

                                           : array
     {
         $user_cols = $this->getSelectableUserColumns(
             $this->in_course_ref_id,
             $this->in_group_ref_id
         );
         $columns = [];
         if ($this->obj_ids === null) {
             // we cannot use the selected columns because they are not ready yet
             // so we use all available columns, should be ok anyways
             $this->obj_ids = $this->getItems(
                 array_keys($user_cols[0]),
                 $user_cols[1]
             );
         }
         $parent = [];
         if (isset($this->obj_ids)) {
             $tmp_cols = array();
             foreach ($this->obj_ids as $obj_id) {
                 if ($obj_id == $this->obj_id) {
                     $parent = array("txt" => $this->lng->txt("status"),
                                     "default" => true
                     );
                 } else {
                     $no_perm = false;
 
                     $ref_id = $this->ref_ids[$obj_id];
                     if ($ref_id &&
                         !ilLearningProgressAccess::checkPermission(
                             'read_learning_progress',
                             $ref_id
                         )) {
                         $no_perm = true;
                         $this->privacy_cols[] = $obj_id;
                     }
 
                     $title = $this->ilObjDataCache->lookupTitle((int) $obj_id);
                     $type = $this->ilObjDataCache->lookupType((int) $obj_id);
                     $icon = ilObject::_getIcon((int) $obj_id, "tiny", $type);
                     if ($type == "sess") {
                         $sess = new ilObjSession($obj_id, false);
                         $title = $sess->getPresentationTitle();
                     }
 
                     // BT 35475: set titles of referenced objects correctly
                     if (
                         $title == '' &&
                         ($type == 'catr' || $type == 'crsr' || $type == 'grpr')
                     ) {
                         $title = ilContainerReference::_lookupTargetTitle((int) $obj_id);
                     }
 
                     // #16453
                     $relpath = null;
                     $path = new ilPathGUI();
                     $path = $path->getPath($this->ref_id, $ref_id);
                     if ($path) {
                         $relpath = $this->lng->txt('path') . ': ' . $path;
                     }
 
                     $tmp_cols[strtolower($title) . "#~#obj_" . $obj_id] = array(
                         "txt" => $title,
                         "icon" => $icon,
                         "type" => $type,
                         "default" => true,
                         "no_permission" => $no_perm,
                         "path" => $relpath
                     );
                 }
             }
             if (sizeof($this->objective_ids)) {
                 foreach ($this->objective_ids as $obj_id => $title) {
                     $tmp_cols[strtolower(
                         $title
                     ) . "#~#objtv_" . $obj_id] = array("txt" => $title,
                                                        "default" => true
                     );
                 }
             }
             if (sizeof($this->sco_ids)) {
                 foreach ($this->sco_ids as $obj_id => $title) {
                     $icon = ilObject::_getIcon($obj_id, "tiny", "sco");
                     $tmp_cols[strtolower(
                         $title
                     ) . "#~#objsco_" . $obj_id] = array("txt" => $title,
                                                         "icon" => $icon,
                                                         "default" => true
                     );
                 }
             }
             if (sizeof($this->subitem_ids)) {
                 foreach ($this->subitem_ids as $obj_id => $title) {
                     $icon = ilObject::_getIcon(
                         $obj_id,
                         "tiny",
                         ilTrQuery::getSubItemType(
                             $this->obj_id
                         )
                     );
                     $tmp_cols[strtolower(
                         $title
                     ) . "#~#objsub_" . $obj_id] = array("txt" => $title,
                                                         "icon" => $icon,
                                                         "default" => true
                     );
                 }
             }
 
             // alex, 5 Nov 2011: Do not sort SCORM items or "chapters"
             if (!sizeof($this->sco_ids) && !sizeof($this->subitem_ids)) {
                 ksort($tmp_cols);
             }
             foreach ($tmp_cols as $id => $def) {
                 $id = explode('#~#', $id);
                 $columns[$id[1]] = $def;
             }
             unset($tmp_cols);
 
             if ($parent) {
                 $columns["obj_" . $this->obj_id] = $parent;
             }
         }
 
         unset($user_cols[0]["status"]);
         unset($user_cols[0]["login"]);
         foreach ($user_cols[0] as $col_id => $col_def) {
             if (!isset($columns[$col_id])) {
                 // these are all additional fields, no default
                 $col_def["default"] = false;
                 $columns[$col_id] = $col_def;
             }
         }
 
         return $columns;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFilter()

ilTrMatrixTableGUI::initFilter ( )

Definition at line 166 of file class.ilTrMatrixTableGUI.php.

References ilTable2GUI\addFilterItemByMetaType(), ILIAS\Repository\filter(), ilTable2GUI\FILTER_TEXT, ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), null, and ilTable2GUI\setFilterValue().

Referenced by __construct().

                                 : void
     {
         $item = $this->addFilterItemByMetaType(
             "name",
             ilTable2GUI::FILTER_TEXT,
             false,
             $this->lng->txt('login')
         );
         $this->filter["name"] = $item->getValue();
 
         // #14949 - is called before constructor, so we have to do it ourselves
         if ($this->http->wrapper()->query()->has($this->prefix . '_tpl')) {
             $this->filter["name"] = null;
             $this->setFilterValue($item, '');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ numericOrdering()

ilTrMatrixTableGUI::numericOrdering ( $a_field )

Definition at line 183 of file class.ilTrMatrixTableGUI.php.

                                              : bool
     {
         if ($a_field === 'read_count' || $a_field === 'spent_seconds') {
             return true;
         }
         return false;
     }