ilTrSummaryTableGUI Class Reference

Inheritance diagram for ilTrSummaryTableGUI:

Collaboration diagram for ilTrSummaryTableGUI:

Public Member Functions
	__construct (?object $a_parent_obj, string $a_parent_cmd, int $a_ref_id, bool $a_print_mode=false)
	Constructor. More...
	getSelectableColumns ()
	Get selectable columns. More...
	initFilter ()
	getSelCountryCodes ()
	getItems (int $a_object_id, int $a_ref_id)
	Build summary item rows for given object and filter(s. More...
	numericOrdering (string $a_field)
	Should this field be sorted numeric? More...
	isStatusShown ()
Public Member Functions inherited from ilLPTableBaseGUI
	__construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")
	executeCommand ()
	searchFilterListener (int $a_ref_id, array $a_data)
	Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED @access public. More...
	initBaseFilter (bool $a_split_learning_resources=false, bool $a_include_no_status_filter=true)
	Init filter. More...
	getCurrentFilter (bool $as_query=false)
	getIconVariant ()
	Gets the variant of LP icons that is shown in the table. More...
	setIconVariant (int $variant)
	Sets the variant of LP icons that is shown in the table. More...
Public Member Functions inherited from ilTable2GUI
	__construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")
	setOpenFormTag (bool $a_val)
	getOpenFormTag ()
	setCloseFormTag (bool $a_val)
	getCloseFormTag ()
	determineLimit ()
	getSelectableColumns ()
	Get selectable columns. More...
	determineSelectedColumns ()
	isColumnSelected (string $col)
	getSelectedColumns ()
	resetOffset (bool $a_in_determination=false)
	initFilter ()
	getParentObject ()
	getParentCmd ()
	setTopAnchor (string $a_val)
	getTopAnchor ()
	setNoEntriesText (string $a_text)
	getNoEntriesText ()
	setIsDataTable (bool $a_val)
	getIsDataTable ()
	setEnableTitle (bool $a_enabletitle)
	getEnableTitle ()
	setEnableHeader (bool $a_enableheader)
	getEnableHeader ()
	setEnableNumInfo (bool $a_val)
	getEnableNumInfo ()
	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
	setDescription (string $a_val)
	getDescription ()
	setOrderField (string $a_order_field)
	getOrderField ()
	setData (array $a_data)
	Set table data. More...
	getData ()
	dataExists ()
	setPrefix (string $a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...
	getPrefix ()
	addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)
	addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
	Add filter by standard type. More...
	getFilterItems (bool $a_optionals=false)
	getFilterItemByPostVar (string $a_post_var)
	setFilterCols (int $a_val)
	getFilterCols ()
	setDisableFilterHiding (bool $a_val=true)
	getDisableFilterHiding ()
	isFilterSelected (string $a_col)
	Is given filter selected? More...
	getSelectedFilters ()
	determineSelectedFilters ()
	setCustomPreviousNext (string $a_prev_link, string $a_next_link)
	setFormAction (string $a_form_action, bool $a_multipart=false)
	getFormAction ()
	setFormName (string $a_name="")
	getFormName ()
	get the name of the parent form More...
	setId (string $a_val)
	getId ()
	setDisplayAsBlock (bool $a_val)
	getDisplayAsBlock ()
	setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)
	setExternalSorting (bool $a_val)
	getExternalSorting ()
	setFilterCommand (string $a_val, string $a_caption="")
	getFilterCommand ()
	setResetCommand (string $a_val, string $a_caption="")
	getResetCommand ()
	setExternalSegmentation (bool $a_val)
	getExternalSegmentation ()
	setRowTemplate (string $a_template, string $a_template_dir="")
	Set row template. More...
	setDefaultOrderField (string $a_defaultorderfield)
	getDefaultOrderField ()
	setDefaultOrderDirection (string $a_defaultorderdirection)
	getDefaultOrderDirection ()
	setDefaultFilterVisiblity (bool $a_status)
	getDefaultFilterVisibility ()
	clearCommandButtons ()
	addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
	addCommandButtonInstance (ilButtonBase $a_button)
	addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')
	setCloseCommand (string $a_link)
	addMultiCommand (string $a_cmd, string $a_text)
	addHiddenInput (string $a_name, string $a_value)
	addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")
	setTopCommands (bool $a_val)
	getTopCommands ()
	addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
	getNavParameter ()
	setOrderLink (string $key, string $order_dir)
	fillHeader ()
	determineOffsetAndOrder (bool $a_omit_offset=false)
	storeNavParameter ()
	getHTML ()
	Get HTML. More...
	numericOrdering (string $a_field)
	Should this field be sorted numeric? More...
	render ()
	writeFilterToSession ()
	resetFilter ()
	fillFooter ()
	getLinkbar (string $a_num)
	fillHiddenRow ()
	fillActionRow ()
	setHeaderHTML (string $html)
	storeProperty (string $type, string $value)
	loadProperty (string $type)
	getCurrentState ()
	get current settings for order, limit, columns and filter More...
	setContext (string $id)
	getContext ()
	setShowRowsSelector (bool $a_value)
	Toggle rows-per-page selector. More...
	getShowRowsSelector ()
	setShowTemplates (bool $a_value)
	getShowTemplates ()
	restoreTemplate (string $a_name)
	Restore state from template. More...
	saveTemplate (string $a_name)
	Save current state as template. More...
	deleteTemplate (string $a_name)
	getLimit ()
	getOffset ()
	setExportFormats (array $formats)
	Set available export formats. More...
	setPrintMode (bool $a_value=false)
	getPrintMode ()
	getExportMode ()
	exportData (int $format, bool $send=false)
	Export and optionally send current table data. More...
	setEnableAllCommand (bool $a_value)
	setRowSelectorLabel (string $row_selector_label)
	getRowSelectorLabel ()
	setPreventDoubleSubmission (bool $a_val)
	getPreventDoubleSubmission ()
	setLimit (int $a_limit=0, int $a_default_limit=0)
	set max. More...
Public Member Functions inherited from ilTableGUI
	__construct (array $a_data=[], bool $a_global_tpl=true)
	setTemplate (ilTemplate $a_tpl)
	getTemplateObject ()
	setData (array $a_data)
	Set table data. More...
	getData ()
	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
	setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")
	setHeaderNames (array $a_header_names)
	getColumnCount ()
	setHeaderVars (array $a_header_vars, array $a_header_params=[])
	setColumnWidth (array $a_column_width)
	set table column widths More...
	setOneColumnWidth (string $a_column_width, int $a_column_number)
	setMaxCount (int $a_max_count)
	set max. More...
	setLimit (int $a_limit=0, int $a_default_limit=0)
	set max. More...
	getLimit ()
	setPrefix (string $a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...
	setOffset (int $a_offset)
	set dataset offset More...
	getOffset ()
	setOrderColumn (string $a_order_column="", string $a_default_column="")
	getOrderColumn ()
	setOrderDirection (string $a_order_direction)
	getOrderDirection ()
	setFooter (string $a_style, string $a_previous="", string $a_next="")
	enable (string $a_module_name)
	disable (string $a_module_name)
	sortData ()
	render ()
	renderHeader ()
	setOrderLink (string $key, string $order_dir)
	setStyle (string $a_element, string $a_style)
	getStyle (string $a_element)
	setBase (string $a_base)
	getBase ()
	getFormName ()
	get the name of the parent form More...
	setFormName (string $a_name="cmd")
	getSelectAllCheckbox ()
	get the name of the checkbox that should be toggled with a select all button More...
	setSelectAllCheckbox (string $a_select_all_checkbox)
	clearActionButtons ()
	addActionButton (string $btn_name, string $btn_value)

Protected Member Functions
	getItemsPercentages ( $data=null, int $overall=0, array $value_map=null, $limit=3)
	Render data as needed for summary list (based on grouped values) More...
	getItemsPercentagesStatus ( $data=null, int $overall=0, array $value_map=null)
	Render status data as needed for summary list (based on grouped values) More...
	parseValue (string $id, ?string $value, string $type)
	fillRow (array $a_set)
	Fill table row. More...
	renderPercentages (string $id, array $data)
	isArrayColumn (string $a_name)
	fillHeaderExcel (ilExcel $a_excel, int &$a_row)
	Excel Version of Fill Header. More...
	fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
	Excel Version of Fill Row. More...
	fillHeaderCSV (ilCSVWriter $a_csv)
	CSV Version of Fill Header. More...
	fillRowCSV (ilCSVWriter $a_csv, array $a_set)
	CSV Version of Fill Row. More...
Protected Member Functions inherited from ilLPTableBaseGUI
	initItemIdFromPost ()
	initUidFromPost ()
	findReferencesForObjId (int $a_obj_id)
	sendMail (array $a_user_ids, $a_parent_obj, string $a_parent_cmd)
	searchObjects (array $filter, string $permission, ?array $preset_obj_ids=null, bool $a_check_lp_activation=true)
	Search objects that match current filters. More...
	isForwardingToFormDispatcher ()
	initRepositoryFilter (array $filter)
	buildPath (array $ref_ids)
	getPossibleTypes (bool $a_split_learning_resources=false, bool $a_include_digilib=false, bool $a_allow_undefined_lp=false)
	parseValue (string $id, ?string $value, string $type)
	isPercentageAvailable (int $a_obj_id)
	parseTitle (int $a_obj_id, string $action, int $a_user_id=0)
	getExportMeta ()
	Build export meta data. More...
	fillMetaExcel (ilExcel $a_excel, int &$a_row)
	Add meta information to excel export. More...
	fillMetaCSV (ilCSVWriter $a_csv)
	Add meta information to csv export. More...
	showTimingsWarning (int $a_ref_id, int $a_user_id)
	formatSeconds (int $seconds, bool $a_shorten_zero=false)
	anonymizeValue ($a_value, bool $a_force_number=false)
	buildValueScale (int $a_max_value, bool $a_anonymize=false, bool $a_format_seconds=false)
	getMonthsFilter ($a_short=false)
	getMonthsYear ($a_year=null, $a_short=false)
	getSelectableUserColumns (int $a_in_course=0, int $a_in_group=0)
	addToClipboard ()
	Add selected users to clipboard. More...
Protected Member Functions inherited from ilTable2GUI
	getRequestedValues ()
	prepareOutput ()
	Anything that must be done before HTML is generated. More...
	isFilterVisible ()
	Check if filter is visible: manually shown (session, db) or default value set. More...
	isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, ilTableFilterItem $a_element)
	Check if filter element is based on adv md. More...
	fillRow (array $a_set)
	Standard Version of Fill Row. More...
	getFilterValue (ilTableFilterItem $a_item)
	Get current filter value. More...
	setFilterValue (ilTableFilterItem $a_item, $a_value)
	fillMetaExcel (ilExcel $a_excel, int &$a_row)
	Add meta information to excel export. More...
	fillHeaderExcel (ilExcel $a_excel, int &$a_row)
	Excel Version of Fill Header. More...
	fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
	Excel Version of Fill Row. More...
	fillMetaCSV (ilCSVWriter $a_csv)
	Add meta information to csv export. More...
	fillHeaderCSV (ilCSVWriter $a_csv)
	CSV Version of Fill Header. More...
	fillRowCSV (ilCSVWriter $a_csv, array $a_set)
	CSV Version of Fill Row. More...

Protected Attributes
ilObjectLP	$olp = null
bool	$is_root
bool	$is_in_course = false
bool	$is_in_group = false
int	$ref_id
string	$type = null
int	$obj_id
ilAccessHandler	$access
ilRbacSystem	$rbacsystem
Protected Attributes inherited from ilLPTableBaseGUI
RefineryFactory	$refinery
HttpService	$http
array	$filter = []
bool	$anonymized = true
int	$icon_variant = ilLPStatusIcons::ICON_VARIANT_LONG
ilSetting	$setting
ilObjectDataCache	$ilObjDataCache
ilObjectDefinition	$objDefinition
ilTree	$tree
ilGlobalTemplateInterface	$main_tpl
Protected Attributes inherited from ilTable2GUI
string	$requested_tmpl_delete
string	$requested_tmpl_create
string	$requested_nav_par2 = ""
string	$requested_nav_par = ""
string	$requested_nav_par1 = ""
ILIAS Table TableGUIRequest	$table_request = null
array	$selected_columns = []
ilCtrl	$ctrl
object	$parent_obj = null
string	$parent_cmd = ""
string	$close_command = ""
string	$top_anchor = "il_table_top"
array	$filters = array()
array	$optional_filters = array()
string	$filter_cmd = 'applyFilter'
string	$reset_cmd = 'resetFilter'
int	$filter_cols = 5
bool	$ext_sort = false
bool	$ext_seg = false
string	$context = ""
array	$mi_sel_buttons = []
bool	$disable_filter_hiding = false
bool	$top_commands = true
array	$selectable_columns = array()
array	$selected_column = array()
bool	$show_templates = false
bool	$show_rows_selector = true
bool	$rows_selector_off = false
bool	$nav_determined = false
bool	$limit_determined = false
bool	$filters_determined = false
bool	$columns_determined = false
bool	$open_form_tag = true
bool	$close_form_tag = true
array	$export_formats = []
int	$export_mode = 0
bool	$print_mode = false
bool	$enable_command_for_all = false
bool	$restore_filter = false
array	$restore_filter_values = []
bool	$default_filter_visibility = false
array	$sortable_fields = array()
bool	$prevent_double_submission = true
string	$row_selector_label = ""
bool	$select_all_on_top = false
array	$sel_buttons = []
string	$nav_value = ''
string	$noentriestext = ''
string	$css_row = ''
bool	$display_as_block = false
string	$description = ''
string	$id = ""
bool	$custom_prev_next = false
string	$reset_cmd_txt = ""
string	$defaultorderfield = ""
string	$defaultorderdirection = ""
array	$column = []
bool	$datatable = false
bool	$num_info = false
bool	$form_multipart = false
array	$row_data = []
string	$order_field = ""
array	$selected_filter = []
string	$form_action = ""
string	$formname = ""
string	$sort_order = ""
array	$buttons = []
array	$multi = []
array	$hidden_inputs = []
array	$header_commands = []
string	$row_template = ""
string	$row_template_dir = ""
string	$filter_cmd_txt = ""
string	$custom_prev = ""
string	$custom_next = ""
array	$raw_post_data = null
ilGlobalTemplateInterface	$main_tpl
Protected Attributes inherited from ilTableGUI
string	$sort_order
string	$link_params
array	$header_params
	$tpl
ilLanguage	$lng

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()
Static Public Member Functions inherited from ilTableGUI
static	linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='')
Data Fields inherited from ilLPTableBaseGUI
const	HIT_LIMIT = 5000
Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1
const	FILTER_SELECT = 2
const	FILTER_DATE = 3
const	FILTER_LANGUAGE = 4
const	FILTER_NUMBER_RANGE = 5
const	FILTER_DATE_RANGE = 6
const	FILTER_DURATION_RANGE = 7
const	FILTER_DATETIME_RANGE = 8
const	FILTER_CHECKBOX = 9
const	EXPORT_EXCEL = 1
const	EXPORT_CSV = 2
const	ACTION_ALL_LIMIT = 1000
Data Fields inherited from ilTableGUI
string	$title = ""
string	$icon = ""
string	$icon_alt = ""
string	$help_page = ""
string	$help_icon = ""
string	$help_icon_alt = ""
array	$header_names = []
array	$header_vars = []
array	$linkbar_vars = []
array	$data = []
int	$column_count = 0
array	$column_width = []
int	$max_count = 0
int	$limit = 0
bool	$max_limit = false
int	$offset = 0
string	$order_column = ""
string	$order_direction = ""
string	$footer_style = ""
string	$footer_previous = ""
string	$footer_next = ""
bool	$lang_support = true
bool	$global_tpl = false
string	$form_name = ""
string	$select_all_checkbox = ""
array	$action_buttons = []
string	$prefix = ""
string	$base = ""
array	$enabled
array	$styles

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilTrSummaryTableGUI::__construct	(	?object	$a_parent_obj,
		string	$a_parent_cmd,
		int	$a_ref_id,
		bool	$a_print_mode = false
	)

Constructor.

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

      {
        global $DIC;
        $this->objDefinition = $DIC['objDefinition'];
        $this->rbacsystem = $DIC->rbac()->system();
        $this->access = $DIC->access();
        $this->ref_id = $a_ref_id;
        $this->obj_id = ilObject::_lookupObjId($a_ref_id);
        $this->is_root = ($a_ref_id == ROOT_FOLDER_ID);
 
        $this->setId("trsmy");
 
        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 (!$this->objDefinition->isContainer($type)) {
                $this->type = $type;
                $this->olp = ilObjectLP::getInstance($this->obj_id);
            }
        }
 
        if (
            !$this->is_root &&
            $DIC->repositoryTree()->checkForParentType($this->ref_id, 'grp')
        ) {
            $this->is_in_group = true;
        } elseif (
            !$this->is_root &&
            $DIC->repositoryTree()->checkForParentType($this->ref_id, 'crs')
        ) {
            $this->is_in_course = true;
        }
 
        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) {
            // see bug #35119; these column list percentage lists and are not sortable
            if (in_array($c, ["status", "mark", "language", "country", "gender", "city", "sel_country"])) {
                $this->addColumn($labels[$c]["txt"]);
            } else {
                $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(
            $this->ctrl->getFormActionByClass(get_class($this))
        );
        $this->setRowTemplate("tpl.trac_summary_row.html", "Services/Tracking");
        $this->initFilter();
 
        $this->getItems($a_parent_obj->getObjId(), $a_ref_id);
    }

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

Here is the call graph for this function:

Member Function Documentation

fillHeaderCSV()

ilTrSummaryTableGUI::fillHeaderCSV ( ilCSVWriter  $a_csv )

protected

CSV Version of Fill Header.

Likely to be overwritten by derived class.

Parameters

ilCSVWriter

$a_csv

current file

Reimplemented from ilTable2GUI.

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

                                                        : void
    {
        $a_csv->addColumn($this->lng->txt("title"));
 
        $labels = $this->getSelectableColumns();
        foreach ($this->getSelectedColumns() as $c) {
            $label = $labels[$c]["txt"];
            $label = str_replace(
                "Ø",
                $this->lng->txt("trac_average"),
                $label
            );
            $label = str_replace(
                "∑",
                $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
                    $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();
    }

References $c, ilLearningProgressBaseGUI\_getStatusText(), ilCSVWriter\addColumn(), ilCSVWriter\addRow(), ILIAS\Repository\lng(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

Here is the call graph for this function:

fillHeaderExcel()

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

protected

Excel Version of Fill Header.

Likely to be overwritten by derived class.

Parameters

ilExcel	$a_excel	excel wrapper
int	$a_row	row counter

Reimplemented from ilTable2GUI.

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

                                                                     : void
    {
        $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(
                "Ø",
                $this->lng->txt("trac_average"),
                $label
            );
            $label = str_replace(
                "∑",
                $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
                    $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
        );
    }

References $c, ilLearningProgressBaseGUI\_getStatusText(), ilExcel\getColumnCoord(), ILIAS\Repository\lng(), 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().

Here is the call graph for this function:

fillRow()

ilTrSummaryTableGUI::fillRow ( array  $a_set )

protected

Fill table row.

Reimplemented from ilTable2GUI.

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

                                            : void
    {
        $this->tpl->setVariable(
            "ICON",
            ilObject::_getIcon(
                (int) $a_set["obj_id"],
                "tiny",
                $a_set["type"]
            )
        );
        $this->tpl->setVariable("ICON_ALT", $this->lng->txt($a_set["type"]));
        $this->tpl->setVariable("TITLE", $a_set["title"]);
 
        if ($a_set["offline"] || ($a_set["privacy_conflict"] ?? null)) {
            $mess = array();
            if ($a_set["offline"]) {
                $mess[] = $this->lng->txt("offline");
            }
            if ($a_set["privacy_conflict"] ?? null) {
                $mess[] = $this->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"]);
            if ($path) {
                $this->tpl->setCurrentBlock("item_path");
                foreach ($path as $ref_id => $path_item) {
                    $this->tpl->setVariable("PATH_ITEM", $path_item);
 
                    if (!$this->anonymized) {
                        $this->ctrl->setParameterByClass(
                            $this->ctrl->getCmdClass(),
                            'details_id',
                            $ref_id
                        );
                        $this->tpl->setVariable(
                            "URL_DETAILS",
                            $this->ctrl->getLinkTargetByClass(
                                $this->ctrl->getCmdClass(),
                                'details'
                            )
                        );
                        $this->ctrl->setParameterByClass(
                            $this->ctrl->getCmdClass(),
                            'details_id',
                            ''
                        );
                        $this->tpl->setVariable(
                            "TXT_DETAILS",
                            $this->lng->txt(
                                'trac_participants'
                            )
                        );
                    } else {
                        $this->tpl->setVariable(
                            "URL_DETAILS",
                            ilLink::_getLink(
                                $ref_id,
                                $a_set["type"]
                            )
                        );
                        $this->tpl->setVariable(
                            "TXT_DETAILS",
                            $this->lng->txt('view')
                        );
                    }
 
                    $this->tpl->parseCurrentBlock();
                }
            }
 
            $this->tpl->setCurrentBlock("item_command");
            $this->ctrl->setParameterByClass(
                get_class($this),
                'hide',
                $a_set["obj_id"]
            );
            $this->tpl->setVariable(
                "HREF_COMMAND",
                $this->ctrl->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
            $path = new ilPathGUI();
            $path = $path->getPath(
                $this->ref_id,
                (int) array_pop($a_set["ref_ids"])
            );
            if ($path) {
                $this->tpl->setVariable(
                    'COLL_PATH',
                    $this->lng->txt('path') . ': ' . $path
                );
            }
        }
    }

References $c, $path, $ref_id, ilObject\_getIcon(), ilLink\_getLink(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

fillRowCSV()

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

protected

CSV Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

ilCSVWriter	$a_csv	current file
array	$a_set	data array

Reimplemented from ilTable2GUI.

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

                                                                   : void
    {
        $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((string) $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();
    }

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

Here is the call graph for this function:

fillRowExcel()

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

protected

Excel Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

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

Reimplemented from ilTable2GUI.

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

     : void {
        $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++;
                    }
                }
            }
        }
    }

References $c, and ilExcel\setCell().

Here is the call graph for this function:

getItems()

ilTrSummaryTableGUI::getItems	(	int	$a_object_id,
		int	$a_ref_id
	)

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

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

                                                             : void
    {
        // 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
        $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
        $this->lng->loadLanguageModule("meta");
        $languages = array();
        foreach ($this->lng->getInstalledLanguages() as $lang_key) {
            $languages[$lang_key] = $this->lng->txt("meta_l_" . $lang_key);
        }
 
        $rows = array();
        foreach ($data["set"] as $idx => $result) {
            // sessions have no title
            if ($result["title"] == "" && $result["type"] == "sess") {
                $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) {
                    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" => $this->lng->txt("gender_n"),
                "m" => $this->lng->txt("gender_m"),
                "f" => $this->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] =
                        $result['status'][ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM] ?? 0 + $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"]);
    }

References ilTableGUI\$data, ilLPTableBaseGUI\$filter, $olp, $rows, $valid, ilObject\_lookupObjId(), ilLearningProgressAccess\checkPermission(), ilObjectLP\getCollectionInstance(), ilLPTableBaseGUI\getCurrentFilter(), ilObjectLP\getCurrentMode(), 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(), ILIAS\Repository\lng(), 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().

Here is the call graph for this function:

Here is the caller graph for this function:

getItemsPercentages()

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

protected

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

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

     : array {
        if (!$overall) {
            return [];
        }
 
        $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 = $this->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 . "  " . $this->lng->txt(
                        "trac_others"
                    ),
                    "absolute" => $others_sum,
                    // ." ".($others_sum > 1 ? $lng->txt("users") : $lng->txt("user")),
                    "percentage" => $perc
                );
            }
        }
 
        return $result;
    }

Referenced by getItems().

Here is the caller graph for this function:

getItemsPercentagesStatus()

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

protected

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

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

     : array {
        $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;
    }

References $data, and $id.

Referenced by getItems().

Here is the caller graph for this function:

getSelCountryCodes()

ilTrSummaryTableGUI::getSelCountryCodes

(

)

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

                                        : array
    {
        $options = array();
        foreach (ilCountry::getCountryCodes() as $c) {
            $options[$c] = $this->lng->txt("meta_c_" . $c);
        }
        asort($options);
        return $options;
    }

References $c, ilCountry\getCountryCodes(), and ILIAS\Repository\lng().

Referenced by getItems().

Here is the call graph for this function:

Here is the caller graph for this function:

getSelectableColumns()

ilTrSummaryTableGUI::getSelectableColumns

(

)

Get selectable columns.

Returns

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

Reimplemented from ilTable2GUI.

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

                                          : array
    {
        $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
        $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 (
                ($this->is_in_course && $this->setting->get("usr_settings_course_export_" . $field)) ||
                ($this->is_in_group && $this->setting->get("usr_settings_group_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 = "Ø ";
            } elseif (substr($l, -3) == "sum" || $l == "user_total") {
                $prefix = "∑ ";
            }
 
            if (isset($lng_map[$l])) {
                $l = $lng_map[$l];
            }
 
            $txt = $prefix . $this->lng->txt($l);
 
            if (in_array(
                $column,
                array("read_count_avg",
                               "spent_seconds_avg",
                               "percentage_avg"
            )
            )) {
                $txt .= " / " . $this->lng->txt("user");
            }
 
            $columns[$column] = array(
                "txt" => $txt,
                "default" => (in_array($column, $default) ? true : false)
            );
        }
        return $columns;
    }

References ilTable2GUI\$column, ilTableGUI\$prefix, $txt, ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, ilObjUserTracking\EXTENDED_DATA_READ_COUNT, ilObjUserTracking\EXTENDED_DATA_SPENT_SECONDS, ilLPTableBaseGUI\isPercentageAvailable(), ILIAS\Repository\lng(), ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

initFilter()

ilTrSummaryTableGUI::initFilter

(

)

Reimplemented from ilTable2GUI.

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

                                : void
    {
        if ($this->is_root) {
            parent::initBaseFilter(true, false);
            return;
        }
 
        // show only if extended data was activated in lp settings
        $tracking = new ilObjUserTracking();
 
        $item = $this->addFilterItemByMetaType(
            "user_total",
            ilTable2GUI::FILTER_NUMBER_RANGE,
            true,
            "∑ " . $this->lng->txt("users")
        );
        $this->filter["user_total"] = $item->getValue();
 
        if ($tracking->hasExtendedData(
            ilObjUserTracking::EXTENDED_DATA_READ_COUNT
        )) {
            $item = $this->addFilterItemByMetaType(
                "read_count_sum",
                ilTable2GUI::FILTER_NUMBER_RANGE,
                true,
                "∑ " . $this->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,
                    "Ø " . $this->lng->txt(
                        "trac_spent_seconds"
                    ) . " / " . $this->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,
                "Ø " . $this->lng->txt(
                    "trac_percentage"
                ) . " / " . $this->lng->txt("user")
            );
            $this->filter["percentage"] = $item->getValue();
        }
 
        if ($this->is_root || !$this->olp || $this->olp->isActive()) {
            $item = $this->addFilterItemByMetaType(
                "status",
                ilTable2GUI::FILTER_SELECT,
                true
            );
            $item->setOptions(
                array("" => $this->lng->txt("trac_all"),
                      ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM + 1 => $this->lng->txt(
                          ilLPStatus::LP_STATUS_NOT_ATTEMPTED
                      ),
                      ilLPStatus::LP_STATUS_IN_PROGRESS_NUM + 1 => $this->lng->txt(
                          ilLPStatus::LP_STATUS_IN_PROGRESS
                      ),
                      ilLPStatus::LP_STATUS_COMPLETED_NUM + 1 => $this->lng->txt(
                          ilLPStatus::LP_STATUS_COMPLETED
                      ),
                      ilLPStatus::LP_STATUS_FAILED_NUM + 1 => $this->lng->txt(
                          ilLPStatus::LP_STATUS_FAILED
                      )
                )
            );
            $this->filter["status"] = $item->getValue();
            if ($this->filter["status"]) {
                $this->filter["status"]--;
            }
 
            $item = $this->addFilterItemByMetaType(
                "status_changed_max",
                ilTable2GUI::FILTER_DATE_RANGE,
                true,
                $this->lng->txt("trac_status_changed")
            );
            $this->filter["status_changed"] = $item->getDate();
        }
 
        if ($this->is_root || !$this->type || ilObjectLP::supportsMark(
            $this->type
        )) {
            $item = $this->addFilterItemByMetaType(
                "mark",
                ilTable2GUI::FILTER_TEXT,
                true,
                $this->lng->txt("trac_mark")
            );
            $this->filter["mark"] = $item->getValue();
        }
 
        if ($this->setting->get("usr_settings_course_export_gender")) {
            $item = $this->addFilterItemByMetaType(
                "gender",
                ilTable2GUI::FILTER_SELECT,
                true
            );
            $item->setOptions(
                array(
                    "" => $this->lng->txt("trac_all"),
                    "n" => $this->lng->txt("gender_n"),
                    "m" => $this->lng->txt("gender_m"),
                    "f" => $this->lng->txt("gender_f"),
                )
            );
            $this->filter["gender"] = $item->getValue();
        }
 
        if ($this->setting->get("usr_settings_course_export_city")) {
            $item = $this->addFilterItemByMetaType(
                "city",
                ilTable2GUI::FILTER_TEXT,
                true
            );
            $this->filter["city"] = $item->getValue();
        }
 
        if ($this->setting->get("usr_settings_course_export_country")) {
            $item = $this->addFilterItemByMetaType(
                "country",
                ilTable2GUI::FILTER_TEXT,
                true
            );
            $this->filter["country"] = $item->getValue();
        }
 
        if ($this->setting->get("usr_settings_course_export_sel_country")) {
            $item = $this->addFilterItemByMetaType(
                "sel_country",
                ilTable2GUI::FILTER_SELECT,
                true
            );
            $item->setOptions(
                array("" => $this->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(
                "first_access_min",
                ilTable2GUI::FILTER_DATETIME_RANGE,
                true,
                $this->lng->txt("trac_first_access")
            );
            $this->filter["first_access"] = $item->getDate();
 
            $item = $this->addFilterItemByMetaType(
                "last_access_max",
                ilTable2GUI::FILTER_DATETIME_RANGE,
                true,
                $this->lng->txt("trac_last_access")
            );
            $this->filter["last_access"] = $item->getDate();
        }
 
        $item = $this->addFilterItemByMetaType(
            "registration_filter",
            ilTable2GUI::FILTER_DATE_RANGE,
            true
        );
        $this->filter["registration"] = $item->getDate();
    }

References ilTable2GUI\addFilterItemByMetaType(), ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, ilObjUserTracking\EXTENDED_DATA_READ_COUNT, ilObjUserTracking\EXTENDED_DATA_SPENT_SECONDS, ILIAS\UI\examples\Symbol\Glyph\Filter\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, ilLPTableBaseGUI\isPercentageAvailable(), ILIAS\Repository\lng(), 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().

Here is the call graph for this function:

Here is the caller graph for this function:

isArrayColumn()

ilTrSummaryTableGUI::isArrayColumn ( string  $a_name )

protected

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

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

isStatusShown()

ilTrSummaryTableGUI::isStatusShown

(

)

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

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

numericOrdering()

ilTrSummaryTableGUI::numericOrdering

(

string

$a_field

)

Should this field be sorted numeric?

Reimplemented from ilTable2GUI.

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

                                                    : bool
    {
        $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 ( string  $id, ?string  $value, string  $type  )

protected

Reimplemented from ilLPTableBaseGUI.

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

     : string {
        // 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 "--" . $this->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(
                        (int) $value,
                        $value < 3600
                    ); // #14858
                }
                break;
 
            case "percentage":
                if (false /* $this->isPercentageAvailable() */) {
                    $value = "-";
                } else {
                    $value = $value . "%";
                }
                break;
 
            case "mark":
                if (!ilObjectLP::supportsMark($type)) {
                    $value = "-";
                }
                break;
        }
 
        return $value;
    }

References $id.

renderPercentages()

ilTrSummaryTableGUI::renderPercentages ( string  $id, array  $data  )

protected

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

                                                                 : void
    {
        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);
        }
    }

References $data, and $id.

Field Documentation

$access

ilAccessHandler ilTrSummaryTableGUI::$access

protected

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

$is_in_course

bool ilTrSummaryTableGUI::$is_in_course = false

protected

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

$is_in_group

bool ilTrSummaryTableGUI::$is_in_group = false

protected

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

$is_root

bool ilTrSummaryTableGUI::$is_root

protected

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

$obj_id

int ilTrSummaryTableGUI::$obj_id

protected

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

$olp

ilObjectLP ilTrSummaryTableGUI::$olp = null

protected

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

Referenced by getItems().

$rbacsystem

ilRbacSystem ilTrSummaryTableGUI::$rbacsystem

protected

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

$ref_id

int ilTrSummaryTableGUI::$ref_id

protected

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

$type

string ilTrSummaryTableGUI::$type = null

protected

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

Referenced by __construct().

---

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

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