TableGUI class for learning progress. More...

Inheritance diagram for ilLPObjectStatisticsLPTableGUI:

Collaboration diagram for ilLPObjectStatisticsLPTableGUI:

Public Member Functions
	__construct (?object $a_parent_obj, string $a_parent_cmd, ?array $a_preselect=null, bool $a_is_chart=false, bool $a_is_details=false)
	Constructor. More...

	init ()

	loadItems ()

	getSelectableColumns ()

	numericOrdering (string $a_field)

	initFilter ()
	Init filter. More...

	getItems ()

	getGraph (array $a_graph_items)

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

	executeCommand ()

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

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

	getCurrentFilter (bool $as_query=false)

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

	setIconVariant (int $variant)
	Sets the variant of LP icons that is shown in the table. More...

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

	setOpenFormTag (bool $a_val)

	getOpenFormTag ()

	setCloseFormTag (bool $a_val)

	getCloseFormTag ()

	determineLimit ()

	getSelectableColumns ()
	Get selectable columns. More...

	determineSelectedColumns ()

	isColumnSelected (string $col)

	getSelectedColumns ()

	resetOffset (bool $a_in_determination=false)

	initFilter ()

	getParentObject ()

	getParentCmd ()

	setTopAnchor (string $a_val)

	getTopAnchor ()

	setNoEntriesText (string $a_text)

	getNoEntriesText ()

	setIsDataTable (bool $a_val)

	getIsDataTable ()

	setEnableTitle (bool $a_enabletitle)

	getEnableTitle ()

	setEnableHeader (bool $a_enableheader)

	getEnableHeader ()

	setEnableNumInfo (bool $a_val)

	getEnableNumInfo ()

	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")

	setDescription (string $a_val)

	getDescription ()

	setOrderField (string $a_order_field)

	getOrderField ()

	setData (array $a_data)

	getData ()

	dataExists ()

	setPrefix (string $a_prefix)

	getPrefix ()

	addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)

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

	getFilterItems (bool $a_optionals=false)

	getFilterItemByPostVar (string $a_post_var)

	setFilterCols (int $a_val)

	getFilterCols ()

	setDisableFilterHiding (bool $a_val=true)

	getDisableFilterHiding ()

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

	getSelectedFilters ()

	determineSelectedFilters ()

	setCustomPreviousNext (string $a_prev_link, string $a_next_link)

	setFormAction (string $a_form_action, bool $a_multipart=false)

	getFormAction ()

	setFormName (string $a_name="")

	getFormName ()

	setId (string $a_val)

	getId ()

	setDisplayAsBlock (bool $a_val)

	getDisplayAsBlock ()

	setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)

	setExternalSorting (bool $a_val)

	getExternalSorting ()

	setFilterCommand (string $a_val, string $a_caption="")

	getFilterCommand ()

	setResetCommand (string $a_val, string $a_caption="")

	getResetCommand ()

	setExternalSegmentation (bool $a_val)

	getExternalSegmentation ()

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

	setDefaultOrderField (string $a_defaultorderfield)

	getDefaultOrderField ()

	setDefaultOrderDirection (string $a_defaultorderdirection)

	getDefaultOrderDirection ()

	setDefaultFilterVisiblity (bool $a_status)

	getDefaultFilterVisibility ()

	clearCommandButtons ()

	addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")

	addCommandButtonInstance (ilButtonBase $a_button)

	addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')

	setCloseCommand (string $a_link)

	addMultiCommand (string $a_cmd, string $a_text)

	addHiddenInput (string $a_name, string $a_value)

	addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")

	setTopCommands (bool $a_val)

	getTopCommands ()

	addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)

	getNavParameter ()

	setOrderLink (string $key, string $order_dir)

	fillHeader ()

	determineOffsetAndOrder (bool $a_omit_offset=false)

	storeNavParameter ()

	getHTML ()
	Get HTML. More...

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

	render ()

	writeFilterToSession ()

	resetFilter ()

	fillFooter ()

	getLinkbar (string $a_num)

	fillHiddenRow ()

	fillActionRow ()

	setHeaderHTML (string $html)

	storeProperty (string $type, string $value)

	loadProperty (string $type)

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

	setContext (string $id)

	getContext ()

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

	getShowRowsSelector ()

	getLimit ()

	getOffset ()

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

	setPrintMode (bool $a_value=false)

	getPrintMode ()

	getExportMode ()

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

	setEnableAllCommand (bool $a_value)

	setRowSelectorLabel (string $row_selector_label)

	getRowSelectorLabel ()

	setPreventDoubleSubmission (bool $a_val)

	getPreventDoubleSubmission ()

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

Public Member Functions inherited from ilTableGUI
	__construct (array $a_data=[], bool $a_global_tpl=true)

	setTemplate (ilTemplate $a_tpl)

	getTemplateObject ()

	setData (array $a_data)
	Set table data. More...

	getData ()

	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")

	setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")

	setHeaderNames (array $a_header_names)

	getColumnCount ()

	setHeaderVars (array $a_header_vars, array $a_header_params=[])

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

	setOneColumnWidth (string $a_column_width, int $a_column_number)

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

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

	getLimit ()

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

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

	getOffset ()

	setOrderColumn (string $a_order_column="", string $a_default_column="")

	getOrderColumn ()

	setOrderDirection (string $a_order_direction)

	getOrderDirection ()

	setFooter (string $a_style, string $a_previous="", string $a_next="")

	enable (string $a_module_name)

	disable (string $a_module_name)

	sortData ()

	render ()

	renderHeader ()

	setOrderLink (string $key, string $order_dir)

	setStyle (string $a_element, string $a_style)

	getStyle (string $a_element)

	setBase (string $a_base)

	getBase ()

	getFormName ()
	get the name of the parent form More...

	setFormName (string $a_name="cmd")

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

	setSelectAllCheckbox (string $a_select_all_checkbox)

	clearActionButtons ()

	addActionButton (string $btn_name, string $btn_value)

Protected Member Functions
	isForwardingToFormDispatcher ()

	getDetailItems (int $a_obj_id)

	initRow (array &$a_row)

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

	initLearningProgressDetailsLayer ()

Protected Member Functions inherited from ilLPTableBaseGUI
	initItemIdFromPost ()

	initUidFromPost ()

	findReferencesForObjId (int $a_obj_id)

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

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

	isForwardingToFormDispatcher ()

	initRepositoryFilter (array $filter)

	buildPath (array $ref_ids)

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

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

	isPercentageAvailable (int $a_obj_id)

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

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

	fillMetaExcel (ilExcel $a_excel, int &$a_row)

	fillMetaCSV (ilCSVWriter $a_csv)

	showTimingsWarning (int $a_ref_id, int $a_user_id)

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

	anonymizeValue ($a_value, bool $a_force_number=false)

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

	getMonthsFilter ($a_short=false)

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

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

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

Protected Member Functions inherited from ilTable2GUI
	getRequestedValues ()

	prepareOutput ()
	Anything that must be done before HTML is generated. More...

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

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

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

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

	setFilterValue (ilTableFilterItem $a_item, $a_value)

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

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

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

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

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

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

Protected Attributes
array	$types = array("min", "avg", "max")

array	$status

bool	$is_chart = false

bool	$is_details = false

array	$chart_data = array()

array	$preselected

array	$status_map = []

Protected Attributes inherited from ilLPTableBaseGUI
RefineryFactory	$refinery

HttpService	$http

array	$filter = []

bool	$anonymized = true

int	$icon_variant = ilLPStatusIcons::ICON_VARIANT_LONG

ilSetting	$setting

ilObjectDataCache	$ilObjDataCache

ilObjectDefinition	$objDefinition

ilTree	$tree

ilGlobalTemplateInterface	$main_tpl

Protected Attributes inherited from ilTable2GUI
string	$requested_nav_par2 = ""

string	$requested_nav_par = ""

string	$requested_nav_par1 = ""

ILIAS Table TableGUIRequest	$table_request = null

array	$selected_columns = []

ilCtrl	$ctrl

object	$parent_obj = null

string	$parent_cmd = ""

string	$close_command = ""

string	$top_anchor = "il_table_top"

array	$filters = array()

array	$optional_filters = array()

string	$filter_cmd = 'applyFilter'

string	$reset_cmd = 'resetFilter'

int	$filter_cols = 5

bool	$ext_sort = false

bool	$ext_seg = false

string	$context = ""

array	$mi_sel_buttons = []

bool	$disable_filter_hiding = false

bool	$top_commands = true

array	$selectable_columns = array()

array	$selected_column = array()

bool	$show_rows_selector = true

bool	$rows_selector_off = false

bool	$nav_determined = false

bool	$limit_determined = false

bool	$filters_determined = false

bool	$columns_determined = false

bool	$open_form_tag = true

bool	$close_form_tag = true

array	$export_formats = []

int	$export_mode = 0

bool	$print_mode = false

bool	$enable_command_for_all = false

bool	$restore_filter = false

array	$restore_filter_values = []

bool	$default_filter_visibility = false

array	$sortable_fields = array()

bool	$prevent_double_submission = true

string	$row_selector_label = ""

bool	$select_all_on_top = false

array	$sel_buttons = []

string	$nav_value = ''

string	$noentriestext = ''

string	$css_row = ''

bool	$display_as_block = false

string	$description = ''

string	$id = ""

bool	$custom_prev_next = false

string	$reset_cmd_txt = ""

string	$defaultorderfield = ""

string	$defaultorderdirection = ""

array	$column = []

bool	$datatable = false

bool	$num_info = false

bool	$form_multipart = false

array	$row_data = []

string	$order_field = ""

array	$selected_filter = []

string	$form_action = ""

string	$formname = ""

string	$sort_order = ""

array	$buttons = []

array	$multi = []

array	$hidden_inputs = []

array	$header_commands = []

string	$row_template = ""

string	$row_template_dir = ""

string	$filter_cmd_txt = ""

string	$custom_prev = ""

string	$custom_next = ""

array	$raw_post_data = null

ilGlobalTemplateInterface	$main_tpl

Protected Attributes inherited from ilTableGUI
string	$sort_order

string	$link_params

array	$header_params

	$tpl

ilLanguage	$lng

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()

Static Public Member Functions inherited from ilTableGUI
static	linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='')

Data Fields inherited from ilLPTableBaseGUI
const	HIT_LIMIT = 5000

Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1

const	FILTER_SELECT = 2

const	FILTER_DATE = 3

const	FILTER_LANGUAGE = 4

const	FILTER_NUMBER_RANGE = 5

const	FILTER_DATE_RANGE = 6

const	FILTER_DURATION_RANGE = 7

const	FILTER_DATETIME_RANGE = 8

const	FILTER_CHECKBOX = 9

const	EXPORT_EXCEL = 1

const	EXPORT_CSV = 2

const	ACTION_ALL_LIMIT = 1000

Data Fields inherited from ilTableGUI
string	$title = ""

string	$icon = ""

string	$icon_alt = ""

string	$help_page = ""

string	$help_icon = ""

string	$help_icon_alt = ""

array	$header_names = []

array	$header_vars = []

array	$linkbar_vars = []

array	$data = []

int	$column_count = 0

array	$column_width = []

int	$max_count = 0

int	$limit = 0

bool	$max_limit = false

int	$offset = 0

string	$order_column = ""

string	$order_direction = ""

string	$footer_style = ""

string	$footer_previous = ""

string	$footer_next = ""

bool	$lang_support = true

bool	$global_tpl = false

string	$form_name = ""

string	$select_all_checkbox = ""

array	$action_buttons = []

string	$prefix = ""

string	$base = ""

array	$enabled

array	$styles

Detailed Description

TableGUI class for learning progress.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilLPObjectStatisticsLPTableGUI::__construct	(	?object	$a_parent_obj,
		string	$a_parent_cmd,
		?array	$a_preselect = `null`,
		bool	$a_is_chart = `false`,
		bool	$a_is_details = `false`
	)

Constructor.

Definition at line 44 of file class.ilLPObjectStatisticsLPTableGUI.php.

References ILIAS\GlobalScreen\Provider\__construct(), and ilTable2GUI\setId().

       {
         $this->preselected = $a_preselect;
         $this->is_chart = $a_is_chart;
         $this->is_details = $a_is_details;
 
         $this->setId("lpobjstatlptbl");
         parent::__construct($a_parent_obj, $a_parent_cmd);
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilLPObjectStatisticsLPTableGUI::fillRow ( array $a_set )

protected

Fill table row.

Definition at line 496 of file class.ilLPObjectStatisticsLPTableGUI.php.

References $DIC, $url, ilObject\_getIcon(), ilObject\_lookupType(), ilLPTableBaseGUI\anonymizeValue(), ILIAS\Repository\ctrl(), ILIAS\Repository\filter(), ilLPTableBaseGUI\getMonthsYear(), ilTable2GUI\isColumnSelected(), ILIAS\Repository\lng(), and ROOT_FOLDER_ID.

                                             : void
     {
         global $DIC;
 
         $ilCtrl = $DIC['ilCtrl'];
 
         if (!$this->is_details) {
             $type = ilObject::_lookupType($a_set["obj_id"]);
 
             // ajax details layer link
             if (strpos($this->filter["yearmonth"], "-") === false) {
                 $this->ctrl->setParameter(
                     $this->parent_obj,
                     "item_id",
                     $a_set["obj_id"]
                 );
                 $url = $this->ctrl->getLinkTarget(
                     $this->parent_obj,
                     "showLearningProgressDetails"
                 );
                 $a_set["title"] .= " (<a href=\"#\" onclick=\"ilObjStat.showLPDetails(event, '" . $url . "');\">Details</a>)";
                 $this->ctrl->setParameter($this->parent_obj, "item_id", "");
             }
 
             // optional columns before parsing outer "checkbox" block
             if ($this->isColumnSelected('obj_id')) {
                 $this->tpl->setVariable('OBJ_ID_COL_VALUE', (string) $a_set['obj_id']);
             }
             if ($this->isColumnSelected('reference_ids')) {
                 $this->tpl->setVariable('REF_IDS', implode(', ', $a_set['reference_ids']));
             }
             if ($this->isColumnSelected('paths')) {
                 $paths = [];
                 foreach ($a_set['reference_ids'] as $reference_id) {
                     $path_gui = new ilPathGUI();
                     $path_gui->enableTextOnly(false);
                     $path_gui->enableHideLeaf(false);
                     $path_gui->setUseImages(true);
                     $paths[] = $path_gui->getPath(ROOT_FOLDER_ID, $reference_id);
                 }
                 $this->tpl->setVariable('PATHS', implode('<br />', $paths));
             }
             $this->tpl->setCurrentBlock("checkbox");
             $this->tpl->setVariable("OBJ_ID", $a_set["obj_id"]);
             $this->tpl->setVariable(
                 "ICON_SRC",
                 ilObject::_getIcon(0, "tiny", $type)
             );
             $this->tpl->setVariable("ICON_ALT", $this->lng->txt($type));
             $this->tpl->setVariable("TITLE_TEXT", $a_set["title"]);
             if ($this->preselected && in_array(
                 $a_set["obj_id"],
                 $this->preselected
             )) {
                 $this->tpl->setVariable(
                     "CHECKBOX_STATE",
                     " checked=\"checked\""
                 );
             }
             $this->tpl->parseCurrentBlock();
         } else {
             $this->tpl->setCurrentBlock("details");
             $this->tpl->setVariable("TXT_FIGURE", $a_set["figure"]);
             $this->tpl->parseCurrentBlock();
         }
 
         $this->tpl->setCurrentBlock("item");
 
         if (strpos($this->filter["yearmonth"], "-") === false) {
             foreach (array_keys(
                 $this->getMonthsYear($this->filter["yearmonth"])
             ) as $num) {
                 $value = $this->anonymizeValue((int) ($a_set["month_" . $num] ?? 0));
                 $this->tpl->setVariable("ITEM_VALUE", $value);
                 $this->tpl->parseCurrentBlock();
             }
         } else {
             foreach ($this->types as $type) {
                 $this->tpl->setVariable(
                     "ITEM_VALUE",
                     $this->anonymizeValue(
                         (int) ($a_set["mem_cnt_" . $type] ?? 0)
                     )
                 );
                 $this->tpl->parseCurrentBlock();
             }
             foreach ($this->status as $status) {
                 foreach ($this->types as $type) {
                     $this->tpl->setVariable(
                         "ITEM_VALUE",
                         $this->anonymizeValue(
                             (int) ($a_set[$status . "_" . $type] ?? 0)
                         )
                     );
                     $this->tpl->parseCurrentBlock();
                 }
             }
         }
     }

Here is the call graph for this function:

◆ getDetailItems()

ilLPObjectStatisticsLPTableGUI::getDetailItems ( int $a_obj_id )

protected

Definition at line 415 of file class.ilLPObjectStatisticsLPTableGUI.php.

References ilTableGUI\$data, ilTableGUI\$icon, $status, ilLearningProgressBaseGUI\_getStatusText(), ILIAS\Repository\filter(), ilLPStatusIcons\getInstance(), ilTrQuery\getObjectLPStatistics(), ilLPStatusIcons\ICON_VARIANT_LONG, ILIAS\Repository\lng(), and ilTable2GUI\setData().

Referenced by loadItems().

                                                     : void
     {
         $data = array();
         $all_status = array_merge(array("mem_cnt"), $this->status);
 
         foreach (ilTrQuery::getObjectLPStatistics(
             array($a_obj_id),
             $this->filter["yearmonth"]
         ) as $item) {
             $month = "month_" . $item["yyyy"] . "-" . str_pad(
                 $item["mm"],
                 2,
                 "0",
                 STR_PAD_LEFT
             );
 
             foreach ($all_status as $status) {
                 // status-id to field name
                 if ($status != "mem_cnt") {
                     $field = $this->status_map[$status];
                 } else {
                     $field = $status;
                 }
                 // aggregated fields
                 foreach ($this->types as $type) {
                     $value = $item[$field . "_" . $type];
                     $idx = $item["yyyy"] . "-" . str_pad(
                         $item["mm"],
                         2,
                         "0",
                         STR_PAD_LEFT
                     );
                     $data[$status . "_" . $type]["month_" . $idx] = $value;
                 }
             }
         }
 
         $icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_LONG);
 
         // add captions
         foreach (array_keys($data) as $figure) {
             $status = substr($figure, 0, -4);
             $type = substr($figure, -3);
 
             if ($status != "mem_cnt") {
                 $text = ilLearningProgressBaseGUI::_getStatusText(
                     (int) $status
                 );
                 $icon = $icons->renderIconForStatus((int) $status);
                 $text = $icon . " " . $text;
             } else {
                 $text = $this->lng->txt("members");
             }
             if ($type != "avg") {
                 $caption = $text . " " . $this->lng->txt(
                     "trac_object_stat_lp_" . $type
                 );
             } else {
                 $caption = $text . " &#216;";
             }
             $data[$figure]["figure"] = $caption;
         }
 
         $this->setData($data);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGraph()

ilLPObjectStatisticsLPTableGUI::getGraph ( array $a_graph_items )

Definition at line 596 of file class.ilLPObjectStatisticsLPTableGUI.php.

References $status, ilLearningProgressBaseGUI\_getStatusText(), ilLPTableBaseGUI\anonymizeValue(), ilLPTableBaseGUI\buildValueScale(), ilChartGrid\DATA_LINES, ILIAS\Repository\filter(), ilChart\getInstanceByType(), ilLPTableBaseGUI\getMonthsYear(), ILIAS\Repository\int(), 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, and ilChart\TYPE_GRID.

                                                   : string
     {
         $a_graph_items = array(array_pop($a_graph_items));
 
         $chart = ilChart::getInstanceByType(ilChart::TYPE_GRID, "objstlp");
         $chart->setSize("700", "500");
 
         $legend = new ilChartLegend();
         $chart->setLegend($legend);
 
         // needed for correct stacking
         $custom_order = array(
             ilLPStatus::LP_STATUS_IN_PROGRESS_NUM => array("#f7d408",
                                                            "#fffa00"
             ),
             ilLPStatus::LP_STATUS_FAILED_NUM => array("#cf0202", "#f15b5b"),
             ilLPStatus::LP_STATUS_COMPLETED_NUM => array("#17aa0e", "#6ce148"),
             ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM => array("#a4a4a4",
                                                              "#c4c4c4"
             )
         );
 
         $chart->setColors(array());
 
         $max_value = 0;
         foreach ($this->chart_data as $object_id => $days) {
             if (in_array($object_id, $a_graph_items)) {
                 $series = array();
                 foreach ($custom_order as $status => $colors) {
                     $series[$status] = $chart->getDataInstance(
                         ilChartGrid::DATA_LINES
                     );
                     $series[$status]->setLabel(
                         ilLearningProgressBaseGUI::_getStatusText($status)
                     );
                     $chart_colors[] = $colors[0];
                 }
                 $chart->setColors($chart_colors);
 
                 if (strpos($this->filter["yearmonth"], "-") === false) {
                     $x_axis = $this->lng->txt("month");
 
                     $counter = 0;
                     foreach (array_keys(
                         $this->getMonthsYear(
                             $this->filter["yearmonth"]
                         )
                     ) as $month) {
                         for ($loop = 1; $loop < 32; $loop++) {
                             $item_day = $month . "-" . str_pad(
                                 (string) $loop,
                                 2,
                                 "0",
                                 STR_PAD_LEFT
                             );
                             foreach (array_keys($custom_order) as $status) {
                                 if (isset($days[$item_day])) {
                                     // as there is only 1 entry per day, avg == sum
                                     $value = (int) $days[$item_day][$this->status_map[$status] . "_avg"];
                                 } else {
                                     $value = 0;
                                 }
                                 $max_value = max($max_value, $value);
                                 $value = $this->anonymizeValue($value, true);
                                 $series[$status]->addPoint($counter, $value);
                             }
                             $counter++;
                         }
                     }
                 } else {
                     $x_axis = $this->lng->txt("day");
                     for ($loop = 1; $loop < 32; $loop++) {
                         foreach (array_keys($custom_order) as $status) {
                             if (isset($days[$loop])) {
                                 // as there is only 1 entry per day, avg == sum
                                 $value = (int) $days[$loop][$this->status_map[$status] . "_avg"];
                             } else {
                                 $value = 0;
                             }
                             $max_value = max($max_value, $value);
                             $value = $this->anonymizeValue($value, true);
                             $series[$status]->addPoint($loop, $value);
                         }
                     }
                 }
 
                 foreach (array_keys($custom_order) as $status) {
                     $chart->addData($series[$status]);
                 }
             }
         }
 
         $value_ticks = $this->buildValueScale($max_value, true);
 
         $labels = array();
         if (strpos($this->filter["yearmonth"], "-") === false) {
             $counter = 0;
             foreach ($this->getMonthsYear(
                 $this->filter["yearmonth"],
                 true
             ) as $caption) {
                 $labels[$counter] = $caption;
                 $counter += 31;
             }
         } else {
             for ($loop = 1; $loop < 32; $loop++) {
                 $labels[$loop] = $loop . ".";
             }
         }
         $chart->setTicks($labels, $value_ticks, true);
 
         return $chart->getHTML();
     }

Here is the call graph for this function:

◆ getItems()

ilLPObjectStatisticsLPTableGUI::getItems ( )

Definition at line 287 of file class.ilLPObjectStatisticsLPTableGUI.php.

References ilTableGUI\$data, $status, ilObject\_lookupTitle(), ILIAS\Repository\filter(), ilLPTableBaseGUI\findReferencesForObjId(), ilLPTableBaseGUI\getCurrentFilter(), ilLPTableBaseGUI\getMonthsYear(), ilTrQuery\getObjectLPStatistics(), initRow(), ILIAS\Repository\int(), null, ilLPTableBaseGUI\searchObjects(), and ilTable2GUI\setData().

Referenced by loadItems().

     {
         $data = array();
         $all_status = array_merge(array("mem_cnt"), $this->status);
 
         $objects = $this->searchObjects(
             $this->getCurrentFilter(true),
             "read",
             null,
             false
         );
         if ($objects) {
             $objects = array_keys($objects);
 
             $yearmonth = explode("-", $this->filter["yearmonth"]);
             if (sizeof($yearmonth) == 1) {
                 foreach (ilTrQuery::getObjectLPStatistics(
                     $objects,
                     $yearmonth[0]
                 ) as $item) {
                     $obj_id = $item["obj_id"];
                     if (!isset($data[$obj_id])) {
                         $data[$obj_id]["obj_id"] = $obj_id;
                         $data[$obj_id]["title"] = ilObject::_lookupTitle(
                             $obj_id
                         );
                         $data[$obj_id]['reference_ids'] = $this->findReferencesForObjId($obj_id);
                     }
                     $measure_type = substr($this->filter["measure"], -3);
                     $measure_field = substr($this->filter["measure"], 0, -4);
                     $value = $item[$measure_field . "_" . $measure_type];
                     $idx = $item["yyyy"] . "-" . str_pad(
                         $item["mm"],
                         2,
                         "0",
                         STR_PAD_LEFT
                     );
                     $data[$obj_id]["month_" . $idx] = $value;
                 }
 
                 if ($this->is_chart) {
                     // get data for single days (used in chart display)
                     foreach (array_keys(
                         $this->getMonthsYear($yearmonth[0])
                     ) as $num) {
                         $num_string = explode('-', $num);
                         $num = (int) array_pop($num_string);
                         foreach (ilTrQuery::getObjectLPStatistics(
                             $objects,
                             $yearmonth[0],
                             $num,
                             true
                         ) as $item) {
                             $idx = $yearmonth[0] .
                                 "-" . str_pad(
                                     (string) $num,
                                     2,
                                     "0",
                                     STR_PAD_LEFT
                                 ) .
                                 "-" . str_pad(
                                     $item["dd"],
                                     2,
                                     "0",
                                     STR_PAD_LEFT
                                 );
                             $this->chart_data[$item["obj_id"]][$idx] = $item;
                         }
                     }
                 }
             } else {
                 // get data aggregated for month
                 foreach (ilTrQuery::getObjectLPStatistics(
                     $objects,
                     $yearmonth[0],
                     (int) $yearmonth[1]
                 ) as $item) {
                     $obj_id = $item["obj_id"];
                     if (!isset($data[$obj_id])) {
                         $data[$obj_id]["obj_id"] = $obj_id;
                         $data[$obj_id]["title"] = ilObject::_lookupTitle(
                             $obj_id
                         );
                         $data[$obj_id]['reference_ids'] = $this->findReferencesForObjId($obj_id);
                         $this->initRow($data[$obj_id]);
                     }
 
                     foreach ($all_status as $status) {
                         // status-id to field name
                         if (is_numeric($status)) {
                             $field = $this->status_map[$status];
                         } else {
                             $field = $status;
                         }
 
                         // aggregated fields
                         foreach ($this->types as $type) {
                             $value = $item[$field . "_" . $type];
                             $data[$obj_id][$status . "_" . $type] = $value;
                         }
                     }
                 }
 
                 if ($this->is_chart) {
                     // get data for single days (used in chart display)
                     foreach (ilTrQuery::getObjectLPStatistics(
                         $objects,
                         $yearmonth[0],
                         (int) $yearmonth[1],
                         true
                     ) as $item) {
                         $this->chart_data[$item["obj_id"]][$item["dd"]] = $item;
                     }
                 }
             }
 
             // add objects with no usage data
             foreach ($objects as $obj_id) {
                 if (!isset($data[$obj_id])) {
                     $data[$obj_id]["obj_id"] = $obj_id;
                     $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
                     $data[$obj_id]['reference_ids'] = $this->findReferencesForObjId($obj_id);
                 }
             }
         }
         $this->setData($data);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectableColumns()

ilLPObjectStatisticsLPTableGUI::getSelectableColumns ( )

Definition at line 168 of file class.ilLPObjectStatisticsLPTableGUI.php.

References ILIAS\Repository\lng().

Referenced by init().

                                           : array
     {
         if ($this->is_details) {
             return [];
         }
         $columns = [];
         $columns['obj_id'] = [
             'field' => 'obj_id',
             'txt' => $this->lng->txt('object_id'),
             'default' => false,
             'optional' => true,
             'sortable' => true,
             'width' => '5%'
         ];
         $columns['reference_ids'] = [
             'field' => 'reference_ids',
             'txt' => $this->lng->txt('trac_reference_ids_column'),
             'default' => false,
             'optional' => true,
             'sortable' => true,
             'width' => '5%'
         ];
         $columns['paths'] = [
             'field' => 'paths',
             'txt' => $this->lng->txt('trac_paths'),
             'default' => false,
             'optional' => true,
             'sortable' => false,
             'width' => '25%'
         ];
         return $columns;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

ilLPObjectStatisticsLPTableGUI::init ( )

Definition at line 59 of file class.ilLPObjectStatisticsLPTableGUI.php.

References ilTableGUI\$icon, ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), ILIAS\Repository\filter(), ilLPStatusIcons\getInstance(), ilLPTableBaseGUI\getMonthsYear(), ilTable2GUI\getParentCmd(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ilLPStatusIcons\ICON_VARIANT_SHORT, initFilter(), 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, ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setLimit(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTitle().

                           : void
     {
         if (!$this->is_details) {
             $this->setShowRowsSelector(true);
             $this->addColumn("", "", "1%", true);
             $this->addColumn($this->lng->txt("trac_title"), "title");
             $all_columns = $this->getSelectableColumns();
             foreach ($this->getSelectedColumns() as $col_name => $col_info) {
                 $column_definition = $all_columns[$col_name];
                 $this->addColumn(
                     $column_definition['txt'],
                     $column_definition['sortable'] ? $column_definition['field'] : '',
                     $column_definition['width']
                 );
             }
         } else {
             $this->setLimit(20);
             $this->setShowRowsSelector(false);     // see #35492
             $this->addColumn($this->lng->txt("trac_figure"));
         }
         $this->initFilter();
 
         if (strpos($this->filter["yearmonth"], "-") === false) {
             foreach ($this->getMonthsYear(
                 $this->filter["yearmonth"]
             ) as $num => $caption) {
                 if ($this->is_details) {
                     $this->addColumn($caption);     // see #35492
                 } else {
                     $this->addColumn($caption, "month_" . $num);
                 }
             }
         } else {
             foreach ($this->types as $type) {
                 if ($type != "avg") {
                     $caption = " " . $this->lng->txt(
                         "trac_object_stat_lp_" . $type
                     );
                 } else {
                     $caption = " &#216;";
                 }
                 $this->addColumn(
                     $this->lng->txt("trac_members_short") . $caption,
                     "mem_cnt_" . $type
                 );
             }
 
             $icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_SHORT);
 
             foreach ($this->status as $status) {
                 $icon = $icons->renderIconForStatus($status);
 
                 foreach ($this->types as $type) {
                     if ($type != "avg") {
                         $caption = $icon . " " . $this->lng->txt(
                             "trac_object_stat_lp_" . $type
                         );
                     } else {
                         $caption = $icon . " &#216;";
                     }
                     $this->addColumn($caption, $status . "_" . $type);
                 }
             }
         }
 
         if (!$this->is_details) {
             $this->setTitle($this->lng->txt("trac_object_stat_lp"));
 
             // $this->setSelectAllCheckbox("item_id");
             $this->addMultiCommand(
                 "showLearningProgressGraph",
                 $this->lng->txt("trac_show_graph")
             );
             $this->setResetCommand("resetLearningProgressFilter");
             $this->setFilterCommand("applyLearningProgressFilter");
         }
 
         $this->setFormAction(
             $this->ctrl->getFormAction(
                 $this->getParentObject(),
                 $this->getParentCmd()
             )
         );
         $this->setRowTemplate(
             "tpl.lp_object_statistics_lp_row.html",
             "components/ILIAS/Tracking"
         );
         $this->setEnableHeader(true);
         $this->setEnableNumInfo(true);
         $this->setEnableTitle(true);
         $this->setDefaultOrderField("title");
         $this->setDefaultOrderDirection("asc");
 
         $this->status_map = array(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM => "not_attempted",
                                   ilLPStatus::LP_STATUS_IN_PROGRESS_NUM => "in_progress",
                                   ilLPStatus::LP_STATUS_COMPLETED_NUM => "completed",
                                   ilLPStatus::LP_STATUS_FAILED_NUM => "failed"
         );
     }

Here is the call graph for this function:

◆ initFilter()

ilLPObjectStatisticsLPTableGUI::initFilter ( )

Init filter.

Definition at line 222 of file class.ilLPObjectStatisticsLPTableGUI.php.

References ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\addFilterItem(), ILIAS\Repository\filter(), ilLPTableBaseGUI\getMonthsFilter(), ilLPTableBaseGUI\initRepositoryFilter(), ILIAS\Repository\lng(), ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilTable2GUI\setDisableFilterHiding(), and ilSelectInputGUI\setOptions().

Referenced by init().

                                 : void
     {
         $this->setDisableFilterHiding(true);
 
         // object type selection
         $this->filter["type"] = "crs";
 
         // title/description
         $ti = new ilTextInputGUI(
             $this->lng->txt("trac_title_description"),
             "query"
         );
         $ti->setMaxLength(64);
         $ti->setSize(20);
         $this->addFilterItem($ti);
         $ti->readFromSession();
         $this->filter["query"] = $ti->getValue();
 
         // year/month
         $si = new ilSelectInputGUI(
             $this->lng->txt("year") . " / " . $this->lng->txt("month"),
             "yearmonth"
         );
         $si->setOptions($this->getMonthsFilter());
         $this->addFilterItem($si);
         $si->readFromSession();
         if (!$si->getValue()) {
             $si->setValue(date("Y-m"));
         }
         $this->filter["yearmonth"] = $si->getValue();
 
         if (!strpos($this->filter["yearmonth"], "-")) {
             $si = new ilSelectInputGUI(
                 $this->lng->txt("trac_figure"),
                 "figure"
             );
             $options = array(
                 "mem_cnt_max" => $this->lng->txt(
                     "members"
                 ) . " " . $this->lng->txt("trac_object_stat_lp_max"),
                 "mem_cnt_avg" => $this->lng->txt("members") . " &#216;",
                 // we are using the db column names here (not the lp constants)!
                 "in_progress_max" => ilLearningProgressBaseGUI::_getStatusText(
                     ilLPStatus::LP_STATUS_IN_PROGRESS_NUM
                 ) . " " . $this->lng->txt("trac_object_stat_lp_max"),
                 "in_progress_avg" => ilLearningProgressBaseGUI::_getStatusText(
                     ilLPStatus::LP_STATUS_IN_PROGRESS_NUM
                 ) . " &#216;"
             );
             $si->setOptions($options);
             $this->addFilterItem($si);
             $si->readFromSession();
             if (!$si->getValue()) {
                 $si->setValue("mem_cnt_max");
             }
             $this->filter["measure"] = $si->getValue();
         }
 
         $this->filter = $this->initRepositoryFilter($this->filter);
 
         if ($this->is_details) {
             $this->filters = array();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initLearningProgressDetailsLayer()

ilLPObjectStatisticsLPTableGUI::initLearningProgressDetailsLayer ( )

protected

Definition at line 710 of file class.ilLPObjectStatisticsLPTableGUI.php.

References $DIC, ilTableGUI\$tpl, iljQueryUtil\initjQuery(), and ilYuiUtil\initOverlay().

Referenced by loadItems().

                                                          : void
     {
         global $DIC;
 
         $tpl = $DIC['tpl'];
 
         ilYuiUtil::initOverlay();
         iljQueryUtil::initjQuery();
 
         $tpl->addJavascript("assets/js/ilObjStat.js");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initRow()

ilLPObjectStatisticsLPTableGUI::initRow ( array & $a_row )

protected

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

References null.

Referenced by getItems().

                                              : void
     {
         foreach ($this->types as $type) {
             $a_row["mem_cnt_" . $type] = null;
         }
         foreach ($this->status as $status) {
             foreach ($this->types as $type) {
                 $a_row[$status . "_" . $type] = null;
             }
         }
     }

Here is the caller graph for this function:

◆ isForwardingToFormDispatcher()

ilLPObjectStatisticsLPTableGUI::isForwardingToFormDispatcher ( )

protected

Definition at line 213 of file class.ilLPObjectStatisticsLPTableGUI.php.

                                                      : bool
     {
         return true;
     }

◆ loadItems()

ilLPObjectStatisticsLPTableGUI::loadItems ( )

Definition at line 159 of file class.ilLPObjectStatisticsLPTableGUI.php.

References getDetailItems(), getItems(), and initLearningProgressDetailsLayer().

                                : void
     {
         if ($this->is_details) {
             $this->getDetailItems($this->preselected[0]);
         } else {
             $this->initLearningProgressDetailsLayer();
             $this->getItems();
         }
     }

Here is the call graph for this function:

◆ numericOrdering()

ilLPObjectStatisticsLPTableGUI::numericOrdering ( string $a_field )

Definition at line 202 of file class.ilLPObjectStatisticsLPTableGUI.php.

                                                     : bool
     {
         $alphabetic_ordering = [
             'title'
         ];
         if (!in_array($a_field, $alphabetic_ordering)) {
             return true;
         }
         return false;
     }

Field Documentation

◆ $chart_data

array ilLPObjectStatisticsLPTableGUI::$chart_data = array()

protected

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

◆ $is_chart

bool ilLPObjectStatisticsLPTableGUI::$is_chart = false

protected

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

◆ $is_details

bool ilLPObjectStatisticsLPTableGUI::$is_details = false

protected

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

◆ $preselected

array ilLPObjectStatisticsLPTableGUI::$preselected

protected

Definition at line 38 of file class.ilLPObjectStatisticsLPTableGUI.php.

◆ $status

array ilLPObjectStatisticsLPTableGUI::$status

protected

Initial value:

= array(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM,
                                    ilLPStatus::LP_STATUS_IN_PROGRESS_NUM,
                                    ilLPStatus::LP_STATUS_COMPLETED_NUM,
                                    ilLPStatus::LP_STATUS_FAILED_NUM
    )

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

Referenced by getDetailItems(), getGraph(), and getItems().

◆ $status_map

array ilLPObjectStatisticsLPTableGUI::$status_map = []

protected

Definition at line 39 of file class.ilLPObjectStatisticsLPTableGUI.php.

◆ $types

array ilLPObjectStatisticsLPTableGUI::$types = array("min", "avg", "max")

protected

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

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

components/ILIAS/Tracking/classes/object_statistics/class.ilLPObjectStatisticsLPTableGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fillRow()

◆ getDetailItems()

◆ getGraph()

◆ getItems()

◆ getSelectableColumns()

◆ init()

◆ initFilter()

◆ initLearningProgressDetailsLayer()

◆ initRow()

◆ isForwardingToFormDispatcher()

◆ loadItems()

◆ numericOrdering()

Field Documentation

◆ $chart_data

◆ $is_chart

◆ $is_details

◆ $preselected

◆ $status

◆ $status_map

◆ $types