name table More...

Inheritance diagram for ilTrSummaryTableGUI:

Collaboration diagram for ilTrSummaryTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_ref_id, $a_print_mode=false)
	Constructor. More...

	getSelectableColumns ()

	initFilter ()
	Init filter. More...

	getSelCountryCodes ()

	getItems ($a_object_id, $a_ref_id)
	Build summary item rows for given object and filter(s. More...

	numericOrdering ($a_field)

	isStatusShown ()

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

	executeCommand ()

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

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

	getCurrentFilter ($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 ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
	ilTable2GUI constructor. More...

	setOpenFormTag ($a_val)
	Set open form tag. More...

	getOpenFormTag ()
	Get open form tag. More...

	setCloseFormTag ($a_val)
	Set close form tag. More...

	getCloseFormTag ()
	Get close form tag. More...

	determineLimit ()
	Determine the limit. More...

	getSelectableColumns ()
	Get selectable columns. More...

	determineSelectedColumns ()
	Determine selected columns. More...

	isColumnSelected ($a_col)
	Is given column selected? More...

	getSelectedColumns ()
	Get selected columns. More...

	executeCommand ()
	Execute command. More...

	resetOffset ($a_in_determination=false)
	Reset offset. More...

	initFilter ()
	Init filter. More...

	getParentObject ()
	Get parent object. More...

	getParentCmd ()
	Get parent command. More...

	setTopAnchor ($a_val)
	Set top anchor. More...

	getTopAnchor ()
	Get top anchor. More...

	setNoEntriesText ($a_text)
	Set text for an empty table. More...

	getNoEntriesText ()
	Get text for an empty table. More...

	setIsDataTable ($a_val)
	Set is data table. More...

	getIsDataTable ()
	Get is data table. More...

	setEnableTitle ($a_enabletitle)
	Set Enable Title. More...

	getEnableTitle ()
	Get Enable Title. More...

	setEnableHeader ($a_enableheader)
	Set Enable Header. More...

	getEnableHeader ()
	Get Enable Header. More...

	setEnableNumInfo ($a_val)
	Set enable num info. More...

	getEnableNumInfo ()
	Get enable num info. More...

	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	Set title and title icon. More...

	setDescription ($a_val)
	Set description. More...

	getDescription ()
	Get description. More...

	setOrderField ($a_order_field)
	set order column More...

	getOrderField ()

	setData ($a_data)

	getData ()

	dataExists ()

	setPrefix ($a_prefix)

	getPrefix ()

	addFilterItem ($a_input_item, $a_optional=false)
	Add filter item. More...

	addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)
	Add filter by standard type. More...

	getFilterItems ($a_optionals=false)
	Get filter items. More...

	getFilterItemByPostVar ($a_post_var)

	setFilterCols ($a_val)
	Set filter columns. More...

	getFilterCols ()
	Get filter columns. More...

	setDisableFilterHiding ($a_val=true)
	Set disable filter hiding. More...

	getDisableFilterHiding ()
	Get disable filter hiding. More...

	isFilterSelected ($a_col)
	Is given filter selected? More...

	getSelectedFilters ()
	Get selected filters. More...

	determineSelectedFilters ()
	Determine selected filters. More...

	setCustomPreviousNext ($a_prev_link, $a_next_link)
	Set custom previous/next links. More...

	setFormAction ($a_form_action, $a_multipart=false)
	Set Form action parameter. More...

	getFormAction ()
	Get Form action parameter. More...

	setFormName ($a_formname="")
	Set Form name. More...

	getFormName ()
	Get Form name. More...

	setId ($a_val)
	Set id. More...

	getId ()
	Get element id. More...

	setDisplayAsBlock ($a_val)
	Set display as block. More...

	getDisplayAsBlock ()
	Get display as block. More...

	getSelectAllCheckbox ()
	Get the name of the checkbox that should be toggled with a select all button. More...

	setSelectAllCheckbox ($a_select_all_checkbox, $a_select_all_on_top=false)
	Set the name of the checkbox that should be toggled with a select all button. More...

	setExternalSorting ($a_val)
	Set external sorting. More...

	getExternalSorting ()
	Get external sorting. More...

	setFilterCommand ($a_val, $a_caption=null)
	Set filter command. More...

	getFilterCommand ()
	Get filter command. More...

	setResetCommand ($a_val, $a_caption=null)
	Set reset filter command. More...

	getResetCommand ()
	Get reset filter command. More...

	setExternalSegmentation ($a_val)
	Set external segmentation. More...

	getExternalSegmentation ()
	Get external segmentation. More...

	setRowTemplate ($a_template, $a_template_dir="")
	Set row template. More...

	setDefaultOrderField ($a_defaultorderfield)
	Set Default order field. More...

	getDefaultOrderField ()
	Get Default order field. More...

	setDefaultOrderDirection ($a_defaultorderdirection)
	Set Default order direction. More...

	getDefaultOrderDirection ()
	Get Default order direction. More...

	setDefaultFilterVisiblity ($a_status)
	Set default filter visiblity. More...

	getDefaultFilterVisibility ()
	Get default filter visibility. More...

	clearCommandButtons ()

	addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
	Add Command button. More...

	addCommandButtonInstance (ilButtonBase $a_button)
	Add Command button instance. More...

	addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
	Add Selection List + Command button. More...

	addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
	Add Selection List + Command button for selected items. More...

	setCloseCommand ($a_link)
	Add command for closing table. More...

	addMultiCommand ($a_cmd, $a_text)
	Add Command button. More...

	addHiddenInput ($a_name, $a_value)
	Add Hidden Input field. More...

	addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
	Add Header Command (Link) (Image needed for now) More...

	setTopCommands ($a_val)
	Set top commands (display command buttons on top of table, too) More...

	getTopCommands ()
	Get top commands (display command buttons on top of table, too) More...

	addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
	Add a column to the header. More...

	getNavParameter ()

	setOrderLink ($sort_field, $order_dir)

	fillHeader ()

	determineOffsetAndOrder ($a_omit_offset=false)
	Determine offset and order. More...

	storeNavParameter ()

	getHTML ()
	Get HTML. More...

	numericOrdering ($a_field)
	Should this field be sorted numeric? More...

	render ()
	render table public More...

	writeFilterToSession ()
	Write filter values to session. More...

	resetFilter ()
	Reset filter. More...

	fillFooter ()
	Fill footer row. More...

	getLinkbar ($a_num)
	Get previous/next linkbar. More...

	fillHiddenRow ()

	fillActionRow ()
	Fill Action Row. More...

	setHeaderHTML ($html)
	set header html More...

	storeProperty ($type, $value)
	Store table property. More...

	loadProperty ($type)
	Load table property. More...

	getCurrentState ()
	get current settings for order, limit, columns and filter More...

	setContext ($id)
	Set context. More...

	getContext ()
	Get context. More...

	setShowRowsSelector ($a_value)
	Toggle rows-per-page selector. More...

	getShowRowsSelector ()
	Get rows-per-page selector state. More...

	setShowTemplates ($a_value)
	Toggle templates. More...

	getShowTemplates ()
	Get template state. More...

	restoreTemplate ($a_name)
	Restore state from template. More...

	saveTemplate ($a_name)
	Save current state as template. More...

	deleteTemplate ($a_name)
	Delete template. More...

	getLimit ()
	Get limit. More...

	getOffset ()
	Get offset. More...

	setExportFormats (array $formats)
	Set available export formats. More...

	setPrintMode ($a_value=false)
	Toogle print mode. More...

	getPrintMode ()
	Get print mode. More...

	getExportMode ()
	Was export activated? More...

	exportData ($format, $send=false)
	Export and optionally send current table data. More...

	setEnableAllCommand ($a_value)
	Enable actions for all entries in current result. More...

	setRowSelectorLabel ($row_selector_label)

	getRowSelectorLabel ()

	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...

	getPreventDoubleSubmission ()
	Get prevent double submission. More...

	setLimit ($a_limit=0, $a_default_limit=0)

Public Member Functions inherited from ilTableGUI
	__construct ($a_data=0, $a_global_tpl=true)
	Constructor. More...

	setTemplate ($a_tpl)
	set template public More...

&	getTemplateObject ()

	setData ($a_data)
	set table data public More...

	getData ()

	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	set table title public More...

	setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
	set table help page public More...

	setHeaderNames ($a_header_names)
	set table header names public More...

	getColumnCount ()
	Returns the column count based on the number of the header row columns public. More...

	setHeaderVars ($a_header_vars, $a_header_params=0)
	set table header vars public More...

	setColumnWidth ($a_column_width)
	set table column widths public More...

	setOneColumnWidth ($a_column_width, $a_column_number)
	set one table column width public More...

	setMaxCount ($a_max_count)
	set max. More...

	setLimit ($a_limit=0, $a_default_limit=0)
	set max. More...

	getLimit ()
	Get limit. More...

	setPrefix ($a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) public More...

	setOffset ($a_offset)
	set dataset offset public More...

	getOffset ()
	Get offset. More...

	setOrderColumn ($a_order_column=0, $a_default_column=0)
	set order column public More...

	getOrderColumn ()
	Get order column. More...

	setOrderDirection ($a_order_direction)
	set order direction public More...

	getOrderDirection ()
	Get order direction. More...

	setFooter ($a_style, $a_previous=0, $a_next=0)
	set order direction public More...

	enable ($a_module_name)
	enables particular modules of table More...

	disable ($a_module_name)
	diesables particular modules of table More...

	sortData ()

	render ()
	render table public More...

	renderHeader ()

	setOrderLink ($key, $order_dir)

	setStyle ($a_element, $a_style)

	getStyle ($a_element)

	setBase ($a_base)
	Set Base script name (deprecated, only use this for workarounds). More...

	getBase ()
	Get Base script name (deprecated, only use this for workarounds). More...

	getFormName ()

	setFormName ($a_name="cmd")

	getSelectAllCheckbox ()

	setSelectAllCheckbox ($a_select_all_checkbox)

	clearActionButtons ()

	addActionButton ($btn_name, $btn_value)

Protected Member Functions
	getItemsPercentages (array $data=null, $overall, array $value_map=null, $limit=3)
	Render data as needed for summary list (based on grouped values) More...

	getItemsPercentagesStatus (array $data=null, $overall, array $value_map=null)
	Render status data as needed for summary list (based on grouped values) More...

	parseValue ($id, $value, $type)

	fillRow ($a_set)
	Fill table row. More...

	renderPercentages ($id, $data)

	isArrayColumn ($a_name)

	fillHeaderExcel (ilExcel $a_excel, &$a_row)

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

	fillHeaderCSV ($a_csv)

	fillRowCSV ($a_csv, $a_set)

Protected Member Functions inherited from ilLPTableBaseGUI
	sendMail (array $a_user_ids, $a_parent_obj, $a_parent_cmd)

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

	buildPath ($ref_ids)
	Build path with deep-link. More...

	getPossibleTypes ($a_split_learning_resources=false, $a_include_digilib=false, $a_allow_undefined_lp=false)
	Get possible subtypes. More...

	parseValue ($id, $value, $type)

	isPercentageAvailable ($a_obj_id)

	parseTitle ($a_obj_id, $action, $a_user_id=false)

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

	fillMetaExcel (ilExcel $a_excel, &$a_row)

	fillMetaCSV ($a_csv)

	showTimingsWarning ($a_ref_id, $a_user_id)

	formatSeconds ($seconds, $a_shorten_zero=false)

	anonymizeValue ($a_value, $a_force_number=false)

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

	getMonthsFilter ($a_short=false)

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

	getSelectableUserColumns ($a_in_course=false, $a_in_group=false)

	addToClipboard ()
	Add selected users to clipboard. More...

Protected Member Functions inherited from ilTable2GUI
	prepareOutput ()
	Anything that must be done before HTML is generated. More...

	isFilterVisible ()
	Check if filter is visible: manually shown (session, db) or default value set. More...

	isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element)
	Check if filter element is based on adv md. More...

	fillRow ($a_set)
	Standard Version of Fill Row. More...

	getFilterValue (ilFormPropertyGUI $a_item)
	Get current filter value. More...

	SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
	Set current filter value. More...

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

	fillHeaderExcel (ilExcel $a_excel, &$a_row)
	Excel Version of Fill Header. More...

	fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
	Excel Version of Fill Row. More...

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

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

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

Protected Attributes
	$dic

Protected Attributes inherited from ilLPTableBaseGUI
	$filter

	$anonymized

	$icon_variant = ilLPStatusIcons::ICON_VARIANT_LONG

Protected Attributes inherited from ilTable2GUI
	$ctrl

	$tpl

	$parent_obj

	$parent_cmd

	$close_command = ""

	$top_anchor = "il_table_top"

	$filters = array()

	$optional_filters = array()

	$filter_cmd = 'applyFilter'

	$reset_cmd = 'resetFilter'

	$filter_cols = 5

	$ext_sort = false

	$ext_seg = false

	$context = ""

	$mi_sel_buttons = []

	$disable_filter_hiding = false

	$selected_filter = false

	$top_commands = true

	$selectable_columns = array()

	$selected_column = array()

	$show_templates = false

	$show_rows_selector = true

	$rows_selector_off = false

	$nav_determined = false

	$limit_determined = false

	$filters_determined = false

	$columns_determined = false

	$open_form_tag = true

	$close_form_tag = true

	$export_formats = []

	$export_mode

	$print_mode

	$enable_command_for_all

	$restore_filter

	$restore_filter_values

	$default_filter_visibility = false

	$sortable_fields = array()

	$prevent_double_submission = true

	$row_selector_label

	$select_all_on_top = false

	$sel_buttons = []

Protected Attributes inherited from ilTableGUI
	$tpl

	$lng

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()
	Get maximum number of entries to enable actions for all. More...

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

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$

ilTrSummaryTableGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilTrSummaryTableGUI::__construct	(	$a_parent_obj,
		$a_parent_cmd,
		$a_ref_id,
		$a_print_mode = `false`
	)

Constructor.

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

References $c, $DIC, $type, ILIAS\GlobalScreen\Provider\__construct(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilTable2GUI\addColumn(), ilObjectLP\getInstance(), getItems(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), initFilter(), ilLPTableBaseGUI\parseTitle(), ROOT_FOLDER_ID, ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setPrintMode(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setShowTemplates().

     {
         global $DIC;
 
         $ilCtrl = $DIC['ilCtrl'];
         $objDefinition = $DIC['objDefinition'];
 
         $this->setId("trsmy");
         $this->dic = $DIC;
         $this->ref_id = $a_ref_id;
         $this->obj_id = ilObject::_lookupObjId($a_ref_id);
         $this->is_root = ($a_ref_id == ROOT_FOLDER_ID);
         
         if (!$this->is_root) {
             // #17084 - are we multi-object or not?
             //  we cannot parse type filter (too complicated)
             $type = ilObject::_lookupType($this->obj_id);
             if (!$objDefinition->isContainer($type)) {
                 $this->type = $type;
                 include_once './Services/Object/classes/class.ilObjectLP.php';
                 $this->olp = ilObjectLP::getInstance($this->obj_id);
             }
         }
 
         parent::__construct($a_parent_obj, $a_parent_cmd);
 
         if ($a_print_mode) {
             $this->setPrintMode(true);
         }
 
         $this->parseTitle($this->obj_id, "trac_summary");
         $this->setLimit(9999);
         $this->setShowTemplates(true);
         $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
 
         $this->addColumn($this->lng->txt("title"), "title");
         $this->setDefaultOrderField("title");
         
         $labels = $this->getSelectableColumns();
         foreach ($this->getSelectedColumns() as $c) {
             $this->addColumn($labels[$c]["txt"], $c);
         }
 
         if ($this->is_root) {
             $this->addColumn($this->lng->txt("path"));
             $this->addColumn($this->lng->txt("action"));
         }
         
         
         // $this->setExternalSorting(true);
         $this->setEnableHeader(true);
         $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
         $this->setRowTemplate("tpl.trac_summary_row.html", "Services/Tracking");
         $this->initFilter();
         
         $this->getItems($a_parent_obj->getObjId(), $a_ref_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillHeaderCSV()

ilTrSummaryTableGUI::fillHeaderCSV ( $a_csv )

protected

Definition at line 855 of file class.ilTrSummaryTableGUI.php.

References $c, ilLearningProgressBaseGUI\_getStatusText(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), isArrayColumn(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

     {
         $a_csv->addColumn($this->lng->txt("title"));
 
         $labels = $this->getSelectableColumns();
         foreach ($this->getSelectedColumns() as $c) {
             $label = $labels[$c]["txt"];
             $label = str_replace("&#216;", $this->lng->txt("trac_average"), $label);
             $label = str_replace("&#8721;", $this->lng->txt("trac_sum"), $label);
 
             if (!$this->isArrayColumn($c)) {
                 $a_csv->addColumn($label);
             } else {
                 if ($c != "status") {
                     $a_csv->addColumn($label . " #1");
                     $a_csv->addColumn($label . " #1");
                     $a_csv->addColumn($label . " #1 %");
                     $a_csv->addColumn($label . " #2");
                     $a_csv->addColumn($label . " #2");
                     $a_csv->addColumn($label . " #2 %");
                     $a_csv->addColumn($label . " #3");
                     $a_csv->addColumn($label . " #3");
                     $a_csv->addColumn($label . " #3 %");
                     $a_csv->addColumn($label . " " . $this->lng->txt("trac_others"));
                     $a_csv->addColumn($label . " " . $this->lng->txt("trac_others"));
                     $a_csv->addColumn($label . " " . $this->lng->txt("trac_others") . " %");
                 } else {
                     // build status to image map
                     include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
                     include_once("./Services/Tracking/classes/class.ilLPStatus.php");
                     $valid_status = array(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM,
                         ilLPStatus::LP_STATUS_IN_PROGRESS_NUM,
                         ilLPStatus::LP_STATUS_COMPLETED_NUM,
                         ilLPStatus::LP_STATUS_FAILED_NUM);
                     foreach ($valid_status as $status) {
                         $text = ilLearningProgressBaseGUI::_getStatusText($status);
                         $a_csv->addColumn($text);
                         $a_csv->addColumn($text . " %");
                     }
                 }
             }
         }
 
         $a_csv->addRow();
     }

Here is the call graph for this function:

◆ fillHeaderExcel()

ilTrSummaryTableGUI::fillHeaderExcel	(	ilExcel	$a_excel,
		&	$a_row
	)

protected

Definition at line 771 of file class.ilTrSummaryTableGUI.php.

References $c, ilLearningProgressBaseGUI\_getStatusText(), ilExcel\getColumnCoord(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), isArrayColumn(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ilExcel\setBold(), and ilExcel\setCell().

     {
         $a_excel->setCell($a_row, 0, $this->lng->txt("title"));
 
         $labels = $this->getSelectableColumns();
         $cnt = 1;
         foreach ($this->getSelectedColumns() as $c) {
             $label = $labels[$c]["txt"];
             $label = str_replace("&#216;", $this->lng->txt("trac_average"), $label);
             $label = str_replace("&#8721;", $this->lng->txt("trac_sum"), $label);
             
             if (!$this->isArrayColumn($c)) {
                 $a_excel->setCell($a_row, $cnt, $label);
                 $cnt++;
             } else {
                 if ($c != "status") {
                     $a_excel->setCell($a_row, $cnt, $label . " #1");
                     $a_excel->setCell($a_row, ++$cnt, $label . " #1");
                     $a_excel->setCell($a_row, ++$cnt, $label . " #1 %");
                     $a_excel->setCell($a_row, ++$cnt, $label . " #2");
                     $a_excel->setCell($a_row, ++$cnt, $label . " #2");
                     $a_excel->setCell($a_row, ++$cnt, $label . " #2 %");
                     $a_excel->setCell($a_row, ++$cnt, $label . " #3");
                     $a_excel->setCell($a_row, ++$cnt, $label . " #3");
                     $a_excel->setCell($a_row, ++$cnt, $label . " #3 %");
                     $a_excel->setCell($a_row, ++$cnt, $label . " " . $this->lng->txt("trac_others"));
                     $a_excel->setCell($a_row, ++$cnt, $label . " " . $this->lng->txt("trac_others"));
                     $a_excel->setCell($a_row, ++$cnt, $label . " " . $this->lng->txt("trac_others") . " %");
                 } else {
                     // build status to image map
                     include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
                     include_once("./Services/Tracking/classes/class.ilLPStatus.php");
                     $valid_status = array(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM,
                         ilLPStatus::LP_STATUS_IN_PROGRESS_NUM,
                         ilLPStatus::LP_STATUS_COMPLETED_NUM,
                         ilLPStatus::LP_STATUS_FAILED_NUM);
                     $cnt--;
                     foreach ($valid_status as $status) {
                         $text = ilLearningProgressBaseGUI::_getStatusText($status);
                         $a_excel->setCell($a_row, ++$cnt, $text);
                         $a_excel->setCell($a_row, ++$cnt, $text . " %");
                     }
                 }
                 $cnt++;
             }
         }
         
         $a_excel->setBold("A" . $a_row . ":" . $a_excel->getColumnCoord($cnt) . $a_row);
     }

Here is the call graph for this function:

◆ fillRow()

ilTrSummaryTableGUI::fillRow ( $a_set )

protected

Fill table row.

Definition at line 641 of file class.ilTrSummaryTableGUI.php.

References $c, $DIC, ilTableGUI\$lng, ilObject\_getIcon(), ilLink\_getLink(), ilLPTableBaseGUI\buildPath(), ilTable2GUI\getSelectedColumns(), ilLPTableBaseGUI\isPercentageAvailable(), parseValue(), and renderPercentages().

     {
         global $DIC;
 
         $lng = $DIC['lng'];
         $ilCtrl = $DIC['ilCtrl'];
         
         $this->tpl->setVariable("ICON", ilObject::_getIcon($a_set["obj_id"], "tiny", $a_set["type"]));
         $this->tpl->setVariable("ICON_ALT", $lng->txt($a_set["type"]));
         $this->tpl->setVariable("TITLE", $a_set["title"]);
 
         if ($a_set["offline"] || $a_set["privacy_conflict"]) {
             $mess = array();
             if ($a_set["offline"]) {
                 $mess[] = $lng->txt("offline");
             }
             if ($a_set["privacy_conflict"]) {
                 $mess[] = $lng->txt("status_no_permission");
             }
             $this->tpl->setCurrentBlock("status_bl");
             $this->tpl->setVariable("TEXT_STATUS", implode(", ", $mess));
             $this->tpl->parseCurrentBlock();
         }
 
         foreach ($this->getSelectedColumns() as $c) {
             switch ($c) {
                 case "country":
                 case "gender":
                 case "city":
                 case "language":
                 case "status":
                 case "mark":
                 case "sel_country":
                     $this->renderPercentages($c, $a_set[$c]);
                     break;
 
                 case "percentage_avg":
                     if ((int) $a_set[$c] === 0 || !$this->isPercentageAvailable($a_set["obj_id"])) {
                         $this->tpl->setVariable(strtoupper($c), "");
                         break;
                     }
                     
                     // no break
                 default:
                     $value = $this->parseValue($c, $a_set[$c], $a_set["type"]);
                     $this->tpl->setVariable(strtoupper($c), $value);
                     break;
             }
         }
         
         if ($this->is_root) {
             $path = $this->buildPath($a_set["ref_ids"], false, true);
             if ($path) {
                 $this->tpl->setCurrentBlock("item_path");
                 foreach ($path as $ref_id => $path_item) {
                     $this->tpl->setVariable("PATH_ITEM", $path_item);
                     
                     if (!$this->anonymized) {
                         $ilCtrl->setParameterByClass($ilCtrl->getCmdClass(), 'details_id', $ref_id);
                         $this->tpl->setVariable("URL_DETAILS", $ilCtrl->getLinkTargetByClass($ilCtrl->getCmdClass(), 'details'));
                         $ilCtrl->setParameterByClass($ilCtrl->getCmdClass(), 'details_id', '');
                         $this->tpl->setVariable("TXT_DETAILS", $lng->txt('trac_participants'));
                     } else {
                         $this->tpl->setVariable("URL_DETAILS", ilLink::_getLink($ref_id, $a_set["type"]));
                         $this->tpl->setVariable("TXT_DETAILS", $lng->txt('view'));
                     }
                     
                     $this->tpl->parseCurrentBlock();
                 }
             }
 
             $this->tpl->setCurrentBlock("item_command");
             $ilCtrl->setParameterByClass(get_class($this), 'hide', $a_set["obj_id"]);
             $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass(get_class($this), 'hide'));
             $this->tpl->setVariable("TXT_COMMAND", $this->lng->txt('trac_hide'));
             $this->tpl->parseCurrentBlock();
             
             $this->tpl->touchBlock("path_action");
         } elseif ($a_set["ref_ids"]) { // #18446
             // #16453
             include_once './Services/Tree/classes/class.ilPathGUI.php';
             $path = new ilPathGUI();
             $path = $path->getPath($this->ref_id, array_pop($a_set["ref_ids"]));
             if ($path) {
                 $this->tpl->setVariable('COLL_PATH', $this->lng->txt('path') . ': ' . $path);
             }
         }
     }

Here is the call graph for this function:

◆ fillRowCSV()

ilTrSummaryTableGUI::fillRowCSV	(	$a_csv,
		$a_set
	)

protected

Definition at line 901 of file class.ilTrSummaryTableGUI.php.

References $c, ilTable2GUI\getSelectedColumns(), isArrayColumn(), and parseValue().

     {
         $a_csv->addColumn($a_set["title"]);
 
         foreach ($this->getSelectedColumns() as $c) {
             if (!$this->isArrayColumn($c)) {
                 $val = $this->parseValue($c, $a_set[$c], $a_set["type"]);
                 $a_csv->addColumn($val);
             } else {
                 foreach ((array) $a_set[$c] as $idx => $value) {
                     if ($c != "status") {
                         $a_csv->addColumn($value["caption"]);
                     }
                     $a_csv->addColumn((int) $value["absolute"]);
                     $a_csv->addColumn($value["percentage"]);
                 }
                 if (sizeof($a_set[$c]) < 4 && $c != "status") {
                     for ($loop = 4; $loop > sizeof($a_set[$c]); $loop--) {
                         $a_csv->addColumn("");
                         $a_csv->addColumn("");
                         $a_csv->addColumn("");
                     }
                 }
             }
         }
 
         $a_csv->addRow();
     }

Here is the call graph for this function:

◆ fillRowExcel()

ilTrSummaryTableGUI::fillRowExcel	(	ilExcel	$a_excel,
		&	$a_row,
			$a_set
	)

protected

Definition at line 821 of file class.ilTrSummaryTableGUI.php.

References $c, ilTable2GUI\getSelectedColumns(), isArrayColumn(), parseValue(), and ilExcel\setCell().

     {
         $a_excel->setCell($a_row, 0, $a_set["title"]);
 
         $cnt = 1;
         foreach ($this->getSelectedColumns() as $c) {
             if (!$this->isArrayColumn($c)) {
                 $val = $this->parseValue($c, $a_set[$c], $a_set["type"]);
                 $a_excel->setCell($a_row, $cnt, $val);
                 $cnt++;
             } else {
                 foreach ((array) $a_set[$c] as $idx => $value) {
                     if ($c == "status") {
                         $a_excel->setCell($a_row, $cnt, (int) $value["absolute"]);
                         $a_excel->setCell($a_row, ++$cnt, $value["percentage"] . "%");
                     } else {
                         $a_excel->setCell($a_row, $cnt, $value["caption"]);
                         $a_excel->setCell($a_row, ++$cnt, (int) $value["absolute"]);
                         $a_excel->setCell($a_row, ++$cnt, $value["percentage"] . "%");
                     }
                     $cnt++;
                 }
                 if (sizeof($a_set[$c]) < 4 && $c != "status") {
                     for ($loop = 4; $loop > sizeof($a_set[$c]); $loop--) {
                         $a_excel->setCell($a_row, $cnt, "");
                         $a_excel->setCell($a_row, ++$cnt, "");
                         $a_excel->setCell($a_row, ++$cnt, "");
                         $cnt++;
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

◆ getItems()

ilTrSummaryTableGUI::getItems	(	$a_object_id,
		$a_ref_id
	)

Build summary item rows for given object and filter(s.

Parameters

int	$a_object_id
int	$a_ref_id

Definition at line 338 of file class.ilTrSummaryTableGUI.php.

References ilTableGUI\$data, $DIC, ilLPTableBaseGUI\$filter, ilTableGUI\$lng, $result, $rows, $valid, ilObject\_lookupObjId(), ilLearningProgressAccess\checkPermission(), ilLPTableBaseGUI\getCurrentFilter(), ilObjectLP\getInstance(), ilLPStatusIcons\getInstance(), getItemsPercentages(), getItemsPercentagesStatus(), ilTable2GUI\getLimit(), ilTrQuery\getObjectsSummaryForObject(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), getSelCountryCodes(), ilTable2GUI\getSelectedColumns(), ilLPStatusIcons\ICON_VARIANT_SHORT, ilLearningProgressBaseGUI\isObjectOffline(), ilLPTableBaseGUI\isPercentageAvailable(), ilLPObjSettings\LP_MODE_COLLECTION, ilLPObjSettings\LP_MODE_COLLECTION_MANUAL, ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ilLPTableBaseGUI\searchObjects(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), and ilUtil\stripSlashes().

Referenced by __construct().

     {
         global $DIC;
 
         $lng = $DIC['lng'];
         $rbacsystem = $DIC['rbacsystem'];
         
         include_once("./Services/Tracking/classes/class.ilTrQuery.php");
         
         // show only selected subobjects for lp mode
         $preselected_obj_ids = $filter = null;
 
         $olp = ilObjectLP::getInstance(ilObject::_lookupObjId($a_ref_id));
         if (
             $olp->getCurrentMode() == ilLPObjSettings::LP_MODE_COLLECTION_MANUAL ||
             $olp->getCurrentMode() == ilLPObjSettings::LP_MODE_COLLECTION ||
             $olp->getCurrentMode() == ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR
         ) {
             $collection = $olp->getCollectionInstance();
             $preselected_obj_ids[$a_object_id][] = $a_ref_id;
             foreach ($collection->getItems() as $item => $item_info) {
                 $tmp_lp = ilObjectLP::getInstance(ilObject::_lookupObjId($item_info));
                 if ($tmp_lp->isActive()) {
                     $preselected_obj_ids[ilObject::_lookupObjId($item_info)][] = $item_info;
                 }
             }
             $filter = $this->getCurrentFilter();
         } elseif ($this->is_root) {
             // using search to get all relevant objects
             // #8498/#8499: restrict to objects with at least "read_learning_progress" access
             $preselected_obj_ids = $this->searchObjects($this->getCurrentFilter(true), "read_learning_progress");
         } else {
             // using summary filters
             $filter = $this->getCurrentFilter();
         }
 
         
         
         $data = ilTrQuery::getObjectsSummaryForObject(
             $a_object_id,
             $a_ref_id,
             ilUtil::stripSlashes($this->getOrderField()),
             ilUtil::stripSlashes($this->getOrderDirection()),
             ilUtil::stripSlashes($this->getOffset()),
             ilUtil::stripSlashes($this->getLimit()),
             $filter,
             $this->getSelectedColumns(),
             $preselected_obj_ids
         );
         
         // build status to image map
         include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
         include_once("./Services/Tracking/classes/class.ilLPStatus.php");
         $valid_status = array(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM,
             ilLPStatus::LP_STATUS_IN_PROGRESS_NUM,
             ilLPStatus::LP_STATUS_COMPLETED_NUM,
             ilLPStatus::LP_STATUS_FAILED_NUM);
         $status_map = array();
         $status_icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_SHORT);
         foreach ($valid_status as $status) {
             $status_map[$status] = $status_icons->renderIconForStatus($status);
         }
         
         // language map
         $lng->loadLanguageModule("meta");
         $languages = array();
         foreach ($lng->getInstalledLanguages() as $lang_key) {
             $languages[$lang_key] = $lng->txt("meta_l_" . $lang_key);
         }
 
         $rows = array();
         foreach ($data["set"] as $idx => $result) {
             // sessions have no title
             if ($result["title"] == "" && $result["type"] == "sess") {
                 include_once "Modules/Session/classes/class.ilObjSession.php";
                 $sess = new ilObjSession($result["obj_id"], false);
                 $data["set"][$idx]["title"] = $sess->getFirstAppointment()->appointmentToString();
             }
 
             $data["set"][$idx]["offline"] = ilLearningProgressBaseGUI::isObjectOffline($result["obj_id"], $result["type"]);
             
             // #13807
             if ($result["ref_ids"]) {
                 $valid = false;
                 foreach ($result["ref_ids"] as $check_ref_id) {
                     include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
                     if (ilLearningProgressAccess::checkPermission('read_learning_progress', $check_ref_id)) {
                         $valid = true;
                         break;
                     }
                 }
                 if (!$valid) {
                     foreach (array_keys($data["set"][$idx]) as $col_id) {
                         if (!in_array($col_id, array("type", "title", "obj_id", "ref_id", "offline"))) {
                             $data["set"][$idx][$col_id] = null;
                         }
                     }
                     $data["set"][$idx]["privacy_conflict"] = true;
                     continue;
                 }
             }
             
             // percentages
             $users_no = $result["user_total"];
             $data["set"][$idx]["country"] = $this->getItemsPercentages($result["country"], $users_no);
             $data["set"][$idx]["gender"] = $this->getItemsPercentages($result["gender"], $users_no, array(
                 "n" => $lng->txt("gender_n"),
                 "m" => $lng->txt("gender_m"),
                 "f" => $lng->txt("gender_f"),
             ));
             $data["set"][$idx]["city"] = $this->getItemsPercentages($result["city"], $users_no);
             $data["set"][$idx]["sel_country"] = $this->getItemsPercentages($result["sel_country"], $users_no, $this->getSelCountryCodes());
             $data["set"][$idx]["mark"] = $this->getItemsPercentages($result["mark"], $users_no);
             $data["set"][$idx]["language"] = $this->getItemsPercentages($result["language"], $users_no, $languages);
 
             // if we encounter any invalid status codes, e.g. null, map them to not attempted instead
             foreach ($result["status"] as $status_code => $status_counter) {
                 // null is cast to ""
                 if ($status_code === "" || !in_array($status_code, $valid_status)) {
                     $result["status"][ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM] += $status_counter;
                     unset($result["status"][$status_code]);
                 }
             }
             $data["set"][$idx]["status"] = $this->getItemsPercentagesStatus($result["status"], $users_no, $status_map);
 
             if (!$this->isPercentageAvailable($result["obj_id"])) {
                 $data["set"][$idx]["percentage_avg"] = null;
             }
         }
 
         $this->setMaxCount($data["cnt"]);
         $this->setData($data["set"]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemsPercentages()

ilTrSummaryTableGUI::getItemsPercentages	(	array	$data = `null`,
			$overall,
		array	$value_map = `null`,
			$limit = `3`
	)

protected

Render data as needed for summary list (based on grouped values)

Parameters

array	$data	rows data
int	$overall	overall number of entries
array	$value_map	labels for values
int	$limit	summarize all entries beyond limit

Returns: array

Definition at line 481 of file class.ilTrSummaryTableGUI.php.

References ilTableGUI\$data, $DIC, ilTableGUI\$limit, ilTableGUI\$lng, and $result.

Referenced by getItems().

     {
         global $DIC;
 
         $lng = $DIC['lng'];
 
         if (!$overall) {
             return false;
         }
 
         $result = [];
 
         if ($data) {
             if (is_array($data) && count($data) < $limit) {
                 $limit = count($data);
             }
             if (is_array($data) && (count($data) == $limit + 1)) {
                 ++$limit;
             }
             $counter = $others_counter = 0;
             $others_sum = $overall;
             $all_sum = 0;
             foreach ($data as $id => $count) {
                 $counter++;
                 $all_sum += $count;
                 if ($counter <= $limit) {
                     $caption = $id;
 
                     if ($value_map && isset($value_map[$id])) {
                         $caption = $value_map[$id];
                     }
                     if ($caption == "") {
                         $caption = $lng->txt("none");
                     }
                     if (
                         $counter == $limit &&
                         $all_sum < $overall
                     ) {
                         ++$others_counter;
                         continue;
                     }
                     $perc = round($count / $overall * 100);
                     $result[] = array(
                         "caption" => $caption,
                         "absolute" => $count, // ." ".($count > 1 ? $lng->txt("users") : $lng->txt("user")),
                         "percentage" => $perc
                         );
                     $others_sum -= $count;
                 } else {
                     $others_counter++;
                 }
             }
 
             if ($others_counter) {
                 $perc = round($others_sum / $overall * 100);
                 $result[] = array(
                     "caption" => $others_counter . "  " . $lng->txt("trac_others"),
                     "absolute" => $others_sum, // ." ".($others_sum > 1 ? $lng->txt("users") : $lng->txt("user")),
                     "percentage" => $perc
                     );
             }
         }
 
         return $result;
     }

Here is the caller graph for this function:

◆ getItemsPercentagesStatus()

ilTrSummaryTableGUI::getItemsPercentagesStatus	(	array	$data = `null`,
			$overall,
		array	$value_map = `null`
	)

protected

Render status data as needed for summary list (based on grouped values)

Parameters

array	$data	rows data
int	$overall	overall number of entries
array	$value_map	labels for values

Returns: array

Definition at line 555 of file class.ilTrSummaryTableGUI.php.

References ilTableGUI\$data, $DIC, ilTableGUI\$lng, and $result.

Referenced by getItems().

     {
         global $DIC;
 
         $lng = $DIC['lng'];
 
         $result = array();
         foreach ($value_map as $id => $caption) {
             $count = 0;
             if (isset($data[$id])) {
                 $count = $data[$id];
             }
             $perc = round($count / $overall * 100);
             
             $result[] = array(
                 "caption" => $caption,
                 "absolute" => $count,
                 "percentage" => $perc
                 );
         }
 
         return $result;
     }

Here is the caller graph for this function:

◆ getSelCountryCodes()

ilTrSummaryTableGUI::getSelCountryCodes ( )

Definition at line 317 of file class.ilTrSummaryTableGUI.php.

References $c, $DIC, ilTableGUI\$lng, and ilCountry\getCountryCodes().

Referenced by getItems(), and initFilter().

     {
         global $DIC;
 
         $lng = $DIC['lng'];
         
         include_once("./Services/Utilities/classes/class.ilCountry.php");
         $options = array();
         foreach (ilCountry::getCountryCodes() as $c) {
             $options[$c] = $lng->txt("meta_c_" . $c);
         }
         asort($options);
         return $options;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectableColumns()

ilTrSummaryTableGUI::getSelectableColumns ( )

Definition at line 84 of file class.ilTrSummaryTableGUI.php.

References $columns, $DIC, $ilSetting, ilTableGUI\$lng, ilTableGUI\$prefix, $txt, ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, ilObjUserTracking\EXTENDED_DATA_READ_COUNT, ilObjUserTracking\EXTENDED_DATA_SPENT_SECONDS, ilLPTableBaseGUI\isPercentageAvailable(), ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

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

     {
         global $DIC;
 
         $lng = $DIC['lng'];
         $ilSetting = $DIC['ilSetting'];
 
         $lng_map = array("user_total" => "users", "first_access_min" => "trac_first_access",
             "last_access_max" => "trac_last_access", "mark" => "trac_mark", "status" => "trac_status",
             'status_changed_max' => 'trac_status_changed',
             "spent_seconds_avg" => "trac_spent_seconds", "percentage_avg" => "trac_percentage",
             "read_count_sum" => "trac_read_count", "read_count_avg" => "trac_read_count",
             "read_count_spent_seconds_avg" => "trac_read_count_spent_seconds"
             );
 
         
         $all = array("user_total");
         $default = array();
         
         // show only if extended data was activated in lp settings
         include_once 'Services/Tracking/classes/class.ilObjUserTracking.php';
         $tracking = new ilObjUserTracking();
         if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_READ_COUNT)) {
             $all[] = "read_count_sum";
             $all[] = "read_count_avg";
             $default[] = "read_count_sum";
         }
         if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS)) {
             if ($this->is_root || !$this->type || ilObjectLP::supportsSpentSeconds($this->type)) {
                 $all[] = "spent_seconds_avg";
                 $default[] = "spent_seconds_avg";
             }
         }
         if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_READ_COUNT) &&
             $tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS)) {
             if ($this->is_root || !$this->type || ilObjectLP::supportsSpentSeconds($this->type)) {
                 $all[] = "read_count_spent_seconds_avg";
                 // $default[] = "read_count_spent_seconds_avg";
             }
         }
 
         
         if ($this->is_root || !$this->type || $this->isPercentageAvailable($this->obj_id)) {
             $all[] = "percentage_avg";
         }
         
         if ($this->is_root || !$this->olp || $this->olp->isActive()) {
             $all[] = "status";
             $all[] = 'status_changed_max';
         }
         
         if ($this->is_root || !$this->type || ilObjectLP::supportsMark($this->type)) {
             $all[] = "mark";
         }
         
         $privacy = array("gender", "city", "country", "sel_country");
         foreach ($privacy as $field) {
             if ($ilSetting->get("usr_settings_course_export_" . $field)) {
                 $all[] = $field;
             }
         }
         
         $all[] = "language";
         
         $default[] = "percentage_avg";
         $default[] = "status";
         $default[] = "mark";
     
         if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS)) {
             $all[] = "first_access_min";
             $all[] = "last_access_max";
         }
 
         $all[] = "create_date_min";
         $all[] = "create_date_max";
 
         $columns = array();
         foreach ($all as $column) {
             $l = $column;
             
             $prefix = false;
             if (substr($l, -3) == "avg") {
                 $prefix = "&#216; ";
             } elseif (substr($l, -3) == "sum" || $l == "user_total") {
                 $prefix = "&#8721; ";
             }
     
             if (isset($lng_map[$l])) {
                 $l = $lng_map[$l];
             }
             
             $txt = $prefix . $lng->txt($l);
             
             if (in_array($column, array("read_count_avg", "spent_seconds_avg", "percentage_avg"))) {
                 $txt .= " / " . $lng->txt("user");
             }
 
             $columns[$column] = array(
                 "txt" => $txt,
                 "default" => (in_array($column, $default) ? true :false)
             );
         }
         return $columns;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFilter()

ilTrSummaryTableGUI::initFilter ( )

Init filter.

Definition at line 192 of file class.ilTrSummaryTableGUI.php.

References $DIC, $ilSetting, ilTableGUI\$lng, ilTable2GUI\addFilterItemByMetaType(), ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, ilObjUserTracking\EXTENDED_DATA_READ_COUNT, ilObjUserTracking\EXTENDED_DATA_SPENT_SECONDS, filter(), ilTable2GUI\FILTER_DATE_RANGE, ilTable2GUI\FILTER_DATETIME_RANGE, ilTable2GUI\FILTER_DURATION_RANGE, ilTable2GUI\FILTER_LANGUAGE, ilTable2GUI\FILTER_NUMBER_RANGE, ilTable2GUI\FILTER_SELECT, ilTable2GUI\FILTER_TEXT, getSelCountryCodes(), ilLPTableBaseGUI\isPercentageAvailable(), ilLPStatus\LP_STATUS_COMPLETED, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

Referenced by __construct().

     {
         global $DIC;
 
         $lng = $DIC['lng'];
         $ilSetting = $DIC['ilSetting'];
         
         if ($this->is_root) {
             return parent::initBaseFilter(true, false);
         }
         
         // show only if extended data was activated in lp settings
         include_once 'Services/Tracking/classes/class.ilObjUserTracking.php';
         $tracking = new ilObjUserTracking();
 
         $item = $this->addFilterItemByMetaType(
             "user_total",
             ilTable2GUI::FILTER_NUMBER_RANGE,
             true,
             "&#8721; " . $lng->txt("users")
         );
         $this->filter["user_total"] = $item->getValue();
 
         if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_READ_COUNT)) {
             $item = $this->addFilterItemByMetaType(
                 "read_count",
                 ilTable2GUI::FILTER_NUMBER_RANGE,
                 true,
                 "&#8721; " . $lng->txt("trac_read_count")
             );
             $this->filter["read_count"] = $item->getValue();
         }
 
         if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS)) {
             if ($this->is_root || !$this->type || ilObjectLP::supportsSpentSeconds($this->type)) {
                 $item = $this->addFilterItemByMetaType(
                     "spent_seconds",
                     ilTable2GUI::FILTER_DURATION_RANGE,
                     true,
                     "&#216; " . $lng->txt("trac_spent_seconds") . " / " . $lng->txt("user")
                 );
                 $this->filter["spent_seconds"]["from"] = $item->getCombinationItem("from")->getValueInSeconds();
                 $this->filter["spent_seconds"]["to"] = $item->getCombinationItem("to")->getValueInSeconds();
             }
         }
 
         if ($this->is_root || !$this->type || $this->isPercentageAvailable($this->obj_id)) {
             $item = $this->addFilterItemByMetaType(
                 "percentage",
                 ilTable2GUI::FILTER_NUMBER_RANGE,
                 true,
                 "&#216; " . $lng->txt("trac_percentage") . " / " . $lng->txt("user")
             );
             $this->filter["percentage"] = $item->getValue();
         }
     
         if ($this->is_root || !$this->olp || $this->olp->isActive()) {
             include_once "Services/Tracking/classes/class.ilLPStatus.php";
             $item = $this->addFilterItemByMetaType("status", ilTable2GUI::FILTER_SELECT, true);
             $item->setOptions(array("" => $lng->txt("trac_all"),
                 ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM + 1 => $lng->txt(ilLPStatus::LP_STATUS_NOT_ATTEMPTED),
                 ilLPStatus::LP_STATUS_IN_PROGRESS_NUM + 1 => $lng->txt(ilLPStatus::LP_STATUS_IN_PROGRESS),
                 ilLPStatus::LP_STATUS_COMPLETED_NUM + 1 => $lng->txt(ilLPStatus::LP_STATUS_COMPLETED),
                 ilLPStatus::LP_STATUS_FAILED_NUM + 1 => $lng->txt(ilLPStatus::LP_STATUS_FAILED)));
             $this->filter["status"] = $item->getValue();
             if ($this->filter["status"]) {
                 $this->filter["status"]--;
             }
         
             $item = $this->addFilterItemByMetaType("trac_status_changed", ilTable2GUI::FILTER_DATE_RANGE, true);
             $this->filter["status_changed"] = $item->getDate();
         }
     
         if ($this->is_root || !$this->type || ilObjectLP::supportsMark($this->type)) {
             $item = $this->addFilterItemByMetaType(
                 "mark",
                 ilTable2GUI::FILTER_TEXT,
                 true,
                 $lng->txt("trac_mark")
             );
             $this->filter["mark"] = $item->getValue();
         }
 
         if ($ilSetting->get("usr_settings_course_export_gender")) {
             $item = $this->addFilterItemByMetaType("gender", ilTable2GUI::FILTER_SELECT, true);
             $item->setOptions(array(
                 "" => $lng->txt("trac_all"),
                 "n" => $lng->txt("gender_n"),
                 "m" => $lng->txt("gender_m"),
                 "f" => $lng->txt("gender_f"),
             ));
             $this->filter["gender"] = $item->getValue();
         }
 
         if ($ilSetting->get("usr_settings_course_export_city")) {
             $item = $this->addFilterItemByMetaType("city", ilTable2GUI::FILTER_TEXT, true);
             $this->filter["city"] = $item->getValue();
         }
 
         if ($ilSetting->get("usr_settings_course_export_country")) {
             $item = $this->addFilterItemByMetaType("country", ilTable2GUI::FILTER_TEXT, true);
             $this->filter["country"] = $item->getValue();
         }
 
         if ($ilSetting->get("usr_settings_course_export_sel_country")) {
             $item = $this->addFilterItemByMetaType("sel_country", ilTable2GUI::FILTER_SELECT, true);
             $item->setOptions(array("" => $lng->txt("trac_all")) + $this->getSelCountryCodes());
             $this->filter["sel_country"] = $item->getValue();
         }
 
         $item = $this->addFilterItemByMetaType("language", ilTable2GUI::FILTER_LANGUAGE, true);
         $this->filter["language"] = $item->getValue();
 
         if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS)) {
             $item = $this->addFilterItemByMetaType("trac_first_access", ilTable2GUI::FILTER_DATETIME_RANGE, true);
             $this->filter["first_access"] = $item->getDate();
 
             $item = $this->addFilterItemByMetaType("trac_last_access", ilTable2GUI::FILTER_DATETIME_RANGE, true);
             $this->filter["last_access"] = $item->getDate();
         }
         
         $item = $this->addFilterItemByMetaType("registration_filter", ilTable2GUI::FILTER_DATE_RANGE, true);
         $this->filter["registration"] = $item->getDate();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isArrayColumn()

ilTrSummaryTableGUI::isArrayColumn ( $a_name )

protected

Definition at line 746 of file class.ilTrSummaryTableGUI.php.

Referenced by fillHeaderCSV(), fillHeaderExcel(), fillRowCSV(), and fillRowExcel().

     {
         if (in_array($a_name, array("country", "gender", "city", "language", "status", "mark", 'sel_country'))) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ isStatusShown()

ilTrSummaryTableGUI::isStatusShown ( )

Definition at line 766 of file class.ilTrSummaryTableGUI.php.

References ilTable2GUI\getSelectedColumns().

                                     : bool
     {
         return in_array('status', $this->getSelectedColumns());
     }

Here is the call graph for this function:

◆ numericOrdering()

ilTrSummaryTableGUI::numericOrdering ( $a_field )

Definition at line 754 of file class.ilTrSummaryTableGUI.php.

     {
         $pos = strrpos($a_field, "_");
         if ($pos !== false) {
             $function = strtoupper(substr($a_field, $pos + 1));
             if (in_array($function, array("MIN", "MAX", "SUM", "AVG", "COUNT", "TOTAL"))) {
                 return true;
             }
         }
         return false;
     }

◆ parseValue()

ilTrSummaryTableGUI::parseValue	(	$id,
		$value,
		$type
	)

protected

Definition at line 579 of file class.ilTrSummaryTableGUI.php.

References $DIC, ilTableGUI\$lng, $type, ilDatePresentation\formatDate(), IL_CAL_DATETIME, IL_CAL_UNIX, ilDatePresentation\secondsToString(), ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

Referenced by fillRow(), fillRowCSV(), and fillRowExcel().

     {
         global $DIC;
 
         $lng = $DIC['lng'];
         
         // get rid of aggregation
         $pos = strrpos($id, "_");
         if ($pos !== false) {
             $function = strtoupper(substr($id, $pos + 1));
             if (in_array($function, array("MIN", "MAX", "SUM", "AVG", "COUNT"))) {
                 $id = substr($id, 0, $pos);
             }
         }
         
         if (trim($value) == "") {
             if ($id == "title") {
                 return "--" . $lng->txt("none") . "--";
             }
             return "";
         }
         switch ($id) {
             case 'status_changed':
             case "first_access":
             case "create_date":
                 $value = ilDatePresentation::formatDate(new ilDateTime($value, IL_CAL_DATETIME));
                 break;
 
             case "last_access":
                 $value = ilDatePresentation::formatDate(new ilDateTime($value, IL_CAL_UNIX));
                 break;
 
             case "spent_seconds":
             case "read_count_spent_seconds":
                 if (!ilObjectLP::supportsSpentSeconds($type)) {
                     $value = "-";
                 } else {
                     $value = ilDatePresentation::secondsToString($value, ($value < 3600 ? true : false)); // #14858
                 }
                 break;
 
             case "percentage":
                 if (false /* $this->isPercentageAvailable() */) {
                     $value = "-";
                 } else {
                     $value = $value . "%";
                 }
                 break;
 
             case "mark":
                 if (!ilObjectLP::supportsMark($type)) {
                     $value = "-";
                 }
                 break;
         }
 
         return $value;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderPercentages()

ilTrSummaryTableGUI::renderPercentages	(	$id,
		$data
	)

protected

Definition at line 730 of file class.ilTrSummaryTableGUI.php.

References ilTableGUI\$data.

Referenced by fillRow().

     {
         if ($data) {
             foreach ($data as $item) {
                 $this->tpl->setCurrentBlock($id . "_row");
                 $this->tpl->setVariable("CAPTION", $item["caption"]);
                 $this->tpl->setVariable("ABSOLUTE", $item["absolute"]);
                 $this->tpl->setVariable("PERCENTAGE", $item["percentage"]);
                 $this->tpl->parseCurrentBlock();
             }
         } else {
             $this->tpl->touchBlock($id);
             ;
         }
     }

Here is the caller graph for this function:

Field Documentation

◆ $dic

ilTrSummaryTableGUI::$dic

protected

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

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

Services/Tracking/classes/repository_statistics/class.ilTrSummaryTableGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fillHeaderCSV()

◆ fillHeaderExcel()

◆ fillRow()

◆ fillRowCSV()

◆ fillRowExcel()

◆ getItems()

◆ getItemsPercentages()

◆ getItemsPercentagesStatus()

◆ getSelCountryCodes()

◆ getSelectableColumns()

◆ initFilter()

◆ isArrayColumn()

◆ isStatusShown()

◆ numericOrdering()

◆ parseValue()

◆ renderPercentages()

Field Documentation

◆ $dic