ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilLPObjectStatisticsLPTableGUI Class Reference

TableGUI class for learning progress. More...

+ Inheritance diagram for ilLPObjectStatisticsLPTableGUI:
+ Collaboration diagram for ilLPObjectStatisticsLPTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, array $a_preselect=null, $a_load_items=true, $a_is_chart=false, $a_is_details=false)
 Constructor. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 initFilter ()
 Init filter. More...
 
 getItems ()
 
 getGraph (array $a_graph_items)
 
- Public Member Functions inherited from ilLPTableBaseGUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 ilTable2GUI constructor. More...
 
 executeCommand ()
 Execute command. More...
 
 searchFilterListener ($a_ref_id, $a_data)
 Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED @access public. More...
 
 initBaseFilter ($a_split_learning_resources=false, $a_include_no_status_filter=true)
 Init filter. More...
 
 getCurrentFilter ($as_query=false)
 
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 ilTable2GUI constructor. More...
 
 setOpenFormTag ($a_val)
 Set open form tag. More...
 
 getOpenFormTag ()
 Get open form tag. More...
 
 setCloseFormTag ($a_val)
 Set close form tag. More...
 
 getCloseFormTag ()
 Get close form tag. More...
 
 determineLimit ()
 Determine the limit. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 Determine selected columns. More...
 
 isColumnSelected ($a_col)
 Is given column selected? More...
 
 getSelectedColumns ()
 Get selected columns. More...
 
 executeCommand ()
 Execute command. More...
 
 resetOffset ($a_in_determination=false)
 Reset offset. More...
 
 initFilter ()
 Init filter. More...
 
 getParentObject ()
 Get parent object. More...
 
 getParentCmd ()
 Get parent command. More...
 
 setTopAnchor ($a_val)
 Set top anchor. More...
 
 getTopAnchor ()
 Get top anchor. More...
 
 setNoEntriesText ($a_text)
 Set text for an empty table. More...
 
 getNoEntriesText ()
 Get text for an empty table. More...
 
 setIsDataTable ($a_val)
 Set is data table. More...
 
 getIsDataTable ()
 Get is data table. More...
 
 setEnableTitle ($a_enabletitle)
 Set Enable Title. More...
 
 getEnableTitle ()
 Get Enable Title. More...
 
 setEnableHeader ($a_enableheader)
 Set Enable Header. More...
 
 getEnableHeader ()
 Get Enable Header. More...
 
 setEnableNumInfo ($a_val)
 Set enable num info. More...
 
 getEnableNumInfo ()
 Get enable num info. More...
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setOrderField ($a_order_field)
 set order column More...
 
 getOrderField ()
 
 setData ($a_data)
 set table data @access public More...
 
 getData ()
 
 dataExists ()
 
 setPrefix ($a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More...
 
 getPrefix ()
 
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item. More...
 
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)
 Add filter by standard type. More...
 
 getFilterItems ($a_optionals=false)
 Get filter items. More...
 
 getFilterItemByPostVar ($a_post_var)
 
 setFilterCols ($a_val)
 Set filter columns. More...
 
 getFilterCols ()
 Get filter columns. More...
 
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding. More...
 
 getDisableFilterHiding ()
 Get disable filter hiding. More...
 
 isFilterSelected ($a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 Get selected filters. More...
 
 determineSelectedFilters ()
 Determine selected filters. More...
 
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links. More...
 
 setFormAction ($a_form_action, $a_multipart=false)
 Set Form action parameter. More...
 
 getFormAction ()
 Get Form action parameter. More...
 
 setFormName ($a_formname="")
 Set Form name. More...
 
 getFormName ()
 Get Form name. More...
 
 setId ($a_val)
 Set id. More...
 
 getId ()
 Get element id. More...
 
 setDisplayAsBlock ($a_val)
 Set display as block. More...
 
 getDisplayAsBlock ()
 Get display as block. More...
 
 getSelectAllCheckbox ()
 Get the name of the checkbox that should be toggled with a select all button. More...
 
 setSelectAllCheckbox ($a_select_all_checkbox, $a_select_all_on_top=false)
 Set the name of the checkbox that should be toggled with a select all button. More...
 
 setExternalSorting ($a_val)
 Set external sorting. More...
 
 getExternalSorting ()
 Get external sorting. More...
 
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 setDefaultFilterVisiblity ($a_status)
 Set default filter visiblity. More...
 
 getDefaultFilterVisibility ()
 Get default filter visibility. More...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButtonBase $a_button)
 Add Command button instance. More...
 
 addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button. More...
 
 addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button for selected items. More...
 
 setCloseCommand ($a_link)
 Add command for closing table. More...
 
 addMultiCommand ($a_cmd, $a_text)
 Add Command button. More...
 
 addHiddenInput ($a_name, $a_value)
 Add Hidden Input field. More...
 
 addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
 Add Header Command (Link) (Image needed for now) More...
 
 setTopCommands ($a_val)
 Set top commands (display command buttons on top of table, too) More...
 
 getTopCommands ()
 Get top commands (display command buttons on top of table, too) More...
 
 addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
 Add a column to the header. More...
 
 getNavParameter ()
 
 setOrderLink ($sort_field, $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order. More...
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 render ()
 render table @access public More...
 
 writeFilterToSession ()
 Write filter values to session. More...
 
 resetFilter ()
 Reset filter. More...
 
 fillFooter ()
 Fill footer row. More...
 
 getLinkbar ($a_num)
 Get previous/next linkbar. More...
 
 fillHiddenRow ()
 
 fillActionRow ()
 Fill Action Row. More...
 
 setHeaderHTML ($html)
 set header html More...
 
 storeProperty ($type, $value)
 Store table property. More...
 
 loadProperty ($type)
 Load table property. More...
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext ($id)
 Set context. More...
 
 getContext ()
 Get context. More...
 
 setShowRowsSelector ($a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 Get rows-per-page selector state. More...
 
 setShowTemplates ($a_value)
 Toggle templates. More...
 
 getShowTemplates ()
 Get template state. More...
 
 restoreTemplate ($a_name)
 Restore state from template. More...
 
 saveTemplate ($a_name)
 Save current state as template. More...
 
 deleteTemplate ($a_name)
 Delete template. More...
 
 getLimit ()
 Get limit. More...
 
 getOffset ()
 Get offset. More...
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode ($a_value=false)
 Toogle print mode. More...
 
 getPrintMode ()
 Get print mode. More...
 
 getExportMode ()
 Was export activated? More...
 
 exportData ($format, $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result. More...
 
 setRowSelectorLabel ($row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission ($a_val)
 Set prevent double submission. More...
 
 getPreventDoubleSubmission ()
 Get prevent double submission. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
- Public Member Functions inherited from ilTableGUI
 __construct ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate ($a_tpl)
 set template @access public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data @access public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title @access public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page @access public More...
 
 setHeaderNames ($a_header_names)
 set table header names @access public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns @access public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars @access public More...
 
 setColumnWidth ($a_column_width)
 set table column widths @access public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width @access public More...
 
 setMaxCount ($a_max_count)
 set max. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
 getLimit ()
 Get limit. More...
 
 setPrefix ($a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More...
 
 setOffset ($a_offset)
 set dataset offset @access public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column @access public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction @access public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction @access public More...
 
 enable ($a_module_name)
 enables particular modules of table More...
 
 disable ($a_module_name)
 diesables particular modules of table More...
 
 sortData ()
 
 render ()
 render table @access public More...
 
 renderHeader ()
 
 setOrderLink ($key, $order_dir)
 
 setStyle ($a_element, $a_style)
 
 getStyle ($a_element)
 
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds). More...
 
 getBase ()
 Get Base script name (deprecated, only use this for workarounds). More...
 
 getFormName ()
 
 setFormName ($a_name="cmd")
 
 getSelectAllCheckbox ()
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton ($btn_name, $btn_value)
 

Protected Member Functions

 getDetailItems ($a_obj_id)
 
 initRow (&$a_row)
 
 fillRow ($a_set)
 Fill table row. More...
 
 initLearningProgressDetailsLayer ()
 
- Protected Member Functions inherited from ilLPTableBaseGUI
 sendMail (array $a_user_ids, $a_parent_obj, $a_parent_cmd)
 
 searchObjects (array $filter, $permission, array $preset_obj_ids=null, $a_check_lp_activation=true)
 Search objects that match current filters. More...
 
 buildPath ($ref_ids)
 Build path with deep-link. More...
 
 getPossibleTypes ($a_split_learning_resources=false, $a_include_digilib=false, $a_allow_undefined_lp=false)
 Get possible subtypes. More...
 
 parseValue ($id, $value, $type)
 
 isPercentageAvailable ($a_obj_id)
 
 parseTitle ($a_obj_id, $action, $a_user_id=false)
 
 getExportMeta ()
 Build export meta data. More...
 
 fillMetaExcel (ilExcel $a_excel, &$a_row)
 Add meta information to excel export. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 showTimingsWarning ($a_ref_id, $a_user_id)
 
 formatSeconds ($seconds, $a_shorten_zero=false)
 
 anonymizeValue ($a_value, $a_force_number=false)
 
 buildValueScale ($a_max_value, $a_anonymize=false, $a_format_seconds=false)
 
 getMonthsFilter ($a_short=false)
 
 getMonthsYear ($a_year=null, $a_short=false)
 
 getSelectableUserColumns ($a_in_course=false, $a_in_group=false)
 
 addToClipboard ()
 Add selected users to clipboard. More...
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 isFilterVisible ()
 Check if filter is visible: manually shown (session, db) or default value set. More...
 
 isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel (ilExcel $a_excel, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel (ilExcel $a_excel, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

Protected Attributes

 $types = array("min", "avg", "max")
 
 $status
 
 $is_chart = false
 
 $is_details = false
 
 $chart_data = array()
 
- Protected Attributes inherited from ilLPTableBaseGUI
 $filter
 
 $anonymized
 
- Protected Attributes inherited from ilTable2GUI
 $ctrl
 
 $tpl
 
 $parent_obj
 
 $parent_cmd
 
 $close_command = ""
 
 $top_anchor = "il_table_top"
 
 $filters = array()
 
 $optional_filters = array()
 
 $filter_cmd = 'applyFilter'
 
 $reset_cmd = 'resetFilter'
 
 $filter_cols = 5
 
 $ext_sort = false
 
 $ext_seg = false
 
 $context = ""
 
 $mi_sel_buttons = []
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $rows_selector_off = false
 
 $nav_determined = false
 
 $limit_determined = false
 
 $filters_determined = false
 
 $columns_determined = false
 
 $open_form_tag = true
 
 $close_form_tag = true
 
 $export_formats = []
 
 $export_mode
 
 $print_mode
 
 $enable_command_for_all
 
 $restore_filter
 
 $restore_filter_values
 
 $default_filter_visibility = false
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 
 $select_all_on_top = false
 
 $sel_buttons = []
 
- Protected Attributes inherited from ilTableGUI
 $tpl
 
 $lng
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- Data Fields inherited from ilTable2GUI
const FILTER_TEXT = 1
 
const FILTER_SELECT = 2
 
const FILTER_DATE = 3
 
const FILTER_LANGUAGE = 4
 
const FILTER_NUMBER_RANGE = 5
 
const FILTER_DATE_RANGE = 6
 
const FILTER_DURATION_RANGE = 7
 
const FILTER_DATETIME_RANGE = 8
 
const FILTER_CHECKBOX = 9
 
const EXPORT_EXCEL = 1
 
const EXPORT_CSV = 2
 
const ACTION_ALL_LIMIT = 1000
 
- Data Fields inherited from ilTableGUI
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 

Detailed Description

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

@ilCtrl_Calls ilLPObjectStatisticsLPTableGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilLPObjectStatisticsLPTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
array  $a_preselect = null,
  $a_load_items = true,
  $a_is_chart = false,
  $a_is_details = false 
)

Constructor.

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

31 {
32 global $DIC;
33
34 $ilCtrl = $DIC['ilCtrl'];
35 $lng = $DIC['lng'];
36
37 $this->preselected = $a_preselect;
38 $this->is_chart = (bool) $a_is_chart;
39 $this->is_details = (bool) $a_is_details;
40
41 $this->setId("lpobjstatlptbl");
42
43 parent::__construct($a_parent_obj, $a_parent_cmd);
44
45 if (!$this->is_details) {
46 $this->setShowRowsSelector(true);
47 // $this->setLimit(ilSearchSettings::getInstance()->getMaxHits());
48
49 $this->addColumn("", "", "1%", true);
50 $this->addColumn($lng->txt("trac_title"), "title");
51 $this->addColumn($lng->txt("object_id"), "obj_id");
52 } else {
53 $this->setLimit(20);
54
55 $this->addColumn($lng->txt("trac_figure"));
56 }
57
58 $this->initFilter();
59
60 if (strpos($this->filter["yearmonth"], "-") === false) {
61 foreach ($this->getMonthsYear($this->filter["yearmonth"]) as $num => $caption) {
62 $this->addColumn($caption, "month_" . $num);
63 }
64 } else {
65 foreach ($this->types as $type) {
66 if ($type != "avg") {
67 $caption = " " . $this->lng->txt("trac_object_stat_lp_" . $type);
68 } else {
69 $caption = " Ø";
70 }
71 $this->addColumn($lng->txt("trac_members_short") . $caption, "mem_cnt_" . $type);
72 }
73
74 include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
75 foreach ($this->status as $status) {
79
80 foreach ($this->types as $type) {
81 if ($type != "avg") {
82 $caption = $icon . $this->lng->txt("trac_object_stat_lp_" . $type);
83 } else {
84 $caption = $icon . " Ø";
85 }
86 $this->addColumn($caption, $status . "_" . $type);
87 }
88 }
89 }
90
91 if (!$this->is_details) {
92 $this->setTitle($this->lng->txt("trac_object_stat_lp"));
93
94 // $this->setSelectAllCheckbox("item_id");
95 $this->addMultiCommand("showLearningProgressGraph", $lng->txt("trac_show_graph"));
96 $this->setResetCommand("resetLearningProgressFilter");
97 $this->setFilterCommand("applyLearningProgressFilter");
98 }
99
100 $this->setFormAction($ilCtrl->getFormAction($a_parent_obj, $a_parent_cmd));
101 $this->setRowTemplate("tpl.lp_object_statistics_lp_row.html", "Services/Tracking");
102 $this->setEnableHeader(true);
103 $this->setEnableNumInfo(true);
104 $this->setEnableTitle(true);
105 $this->setDefaultOrderField("title");
106 $this->setDefaultOrderDirection("asc");
107
108 $this->status_map = array(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM => "not_attempted",
112
113 if ($a_load_items) {
114 if ($this->is_details) {
115 $this->getDetailItems($this->preselected[0]);
116 } else {
118 $this->getItems();
119 }
120 }
121 }
$path
Definition: aliased.php:25
const LP_STATUS_COMPLETED_NUM
const LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM
const LP_STATUS_FAILED_NUM
getMonthsYear($a_year=null, $a_short=false)
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
static _getImagePathForStatus($a_status)
Get image path for status.
setEnableHeader($a_enableheader)
Set Enable Header.
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
setResetCommand($a_val, $a_caption=null)
Set reset filter command.
setEnableTitle($a_enabletitle)
Set Enable Title.
setEnableNumInfo($a_val)
Set enable num info.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
setLimit($a_limit=0, $a_default_limit=0)
set max.
addMultiCommand($a_cmd, $a_text)
Add Command button.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
addColumn( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
setId($a_val)
Set id.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
setFilterCommand($a_val, $a_caption=null)
Set filter command.
static img($a_src, $a_alt=null, $a_width="", $a_height="", $a_border=0, $a_id="", $a_class="")
Build img tag.
global $ilCtrl
Definition: ilias.php:18
$type
global $DIC
Definition: saml.php:7
$text
Definition: errorreport.php:18

References $DIC, ilTableGUI\$icon, $ilCtrl, ilTableGUI\$lng, $path, $status, $text, $type, ilLearningProgressBaseGUI\_getImagePathForStatus(), ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), getDetailItems(), getItems(), ilLPTableBaseGUI\getMonthsYear(), ilUtil\img(), initFilter(), initLearningProgressDetailsLayer(), 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\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTitle().

+ Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilLPObjectStatisticsLPTableGUI::fillRow (   $a_set)
protected

Fill table row.

Reimplemented from ilTable2GUI.

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

359 {
360 global $DIC;
361
362 $ilCtrl = $DIC['ilCtrl'];
363
364 if (!$this->is_details) {
365 $type = ilObject::_lookupType($a_set["obj_id"]);
366
367 // ajax details layer link
368 if (strpos($this->filter["yearmonth"], "-") === false) {
369 $ilCtrl->setParameter($this->parent_obj, "item_id", $a_set["obj_id"]);
370 $url = $ilCtrl->getLinkTarget($this->parent_obj, "showLearningProgressDetails");
371 $a_set["title"] .= " (<a href=\"#\" onclick=\"ilObjStat.showLPDetails(event, '" . $url . "');\">Details</a>)";
372 $ilCtrl->setParameter($this->parent_obj, "item_id", "");
373 }
374
375 $this->tpl->setCurrentBlock("checkbox");
376 $this->tpl->setVariable("OBJ_ID", $a_set["obj_id"]);
377 $this->tpl->setVariable("ICON_SRC", ilObject::_getIcon("", "tiny", $type));
378 $this->tpl->setVariable("ICON_ALT", $this->lng->txt($type));
379 $this->tpl->setVariable("TITLE_TEXT", $a_set["title"]);
380 if ($this->preselected && in_array($a_set["obj_id"], $this->preselected)) {
381 $this->tpl->setVariable("CHECKBOX_STATE", " checked=\"checked\"");
382 }
383 $this->tpl->parseCurrentBlock();
384 } else {
385 $this->tpl->setCurrentBlock("details");
386 $this->tpl->setVariable("TXT_FIGURE", $a_set["figure"]);
387 $this->tpl->parseCurrentBlock();
388 }
389
390 $this->tpl->setCurrentBlock("item");
391
392 if (strpos($this->filter["yearmonth"], "-") === false) {
393 foreach (array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $num) {
394 $value = $this->anonymizeValue((int) $a_set["month_" . $num]);
395 $this->tpl->setVariable("ITEM_VALUE", $value);
396 $this->tpl->parseCurrentBlock();
397 }
398 } else {
399 foreach ($this->types as $type) {
400 $this->tpl->setVariable("ITEM_VALUE", $this->anonymizeValue((int) $a_set["mem_cnt_" . $type]));
401 $this->tpl->parseCurrentBlock();
402 }
403 foreach ($this->status as $status) {
404 foreach ($this->types as $type) {
405 $this->tpl->setVariable("ITEM_VALUE", $this->anonymizeValue((int) $a_set[$status . "_" . $type]));
406 $this->tpl->parseCurrentBlock();
407 }
408 }
409 }
410 }
anonymizeValue($a_value, $a_force_number=false)
static _lookupType($a_id, $a_reference=false)
lookup object type
$url

References $DIC, $ilCtrl, $status, $type, $url, ilObject\_lookupType(), ilLPTableBaseGUI\anonymizeValue(), and ilLPTableBaseGUI\getMonthsYear().

+ Here is the call graph for this function:

◆ getDetailItems()

ilLPObjectStatisticsLPTableGUI::getDetailItems (   $a_obj_id)
protected

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

295 {
296 $data = array();
297 $all_status = array_merge(array("mem_cnt"), $this->status);
298
299 include_once "Services/Tracking/classes/class.ilTrQuery.php";
300 foreach (ilTrQuery::getObjectLPStatistics(array($a_obj_id), $this->filter["yearmonth"]) as $item) {
301 $month = "month_" . $item["yyyy"] . "-" . str_pad($item["mm"], 2, "0", STR_PAD_LEFT);
302
303 foreach ($all_status as $status) {
304 // status-id to field name
305 if ($status != "mem_cnt") {
306 $field = $this->status_map[$status];
307 } else {
308 $field = $status;
309 }
310 // aggregated fields
311 foreach ($this->types as $type) {
312 $value = $item[$field . "_" . $type];
313 $idx = $item["yyyy"] . "-" . str_pad($item["mm"], 2, "0", STR_PAD_LEFT);
314 $data[$status . "_" . $type]["month_" . $idx] = $value;
315 }
316 }
317 }
318
319 // add captions
320 foreach (array_keys($data) as $figure) {
321 $status = substr($figure, 0, -4);
322 $type = substr($figure, -3);
323
324 if ($status != "mem_cnt") {
328 $text = $icon . " " . $text;
329 } else {
330 $text = $this->lng->txt("members");
331 }
332 if ($type != "avg") {
333 $caption = $text . " " . $this->lng->txt("trac_object_stat_lp_" . $type);
334 } else {
335 $caption = $text . " &#216;";
336 }
337 $data[$figure]["figure"] = $caption;
338 }
339
340 $this->setData($data);
341 }
setData($a_data)
set table data @access public
static getObjectLPStatistics(array $a_obj_ids, $a_year, $a_month=null, $a_group_by_day=false)

References ilTableGUI\$data, ilTableGUI\$icon, $path, $status, $text, $type, ilLearningProgressBaseGUI\_getImagePathForStatus(), ilLearningProgressBaseGUI\_getStatusText(), ilTrQuery\getObjectLPStatistics(), ilUtil\img(), and ilTable2GUI\setData().

Referenced by __construct().

+ 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 412 of file class.ilLPObjectStatisticsLPTableGUI.php.

413 {
414 global $DIC;
415
416 $lng = $DIC['lng'];
417
418 $a_graph_items = array(array_pop($a_graph_items));
419
420 include_once "Services/Chart/classes/class.ilChart.php";
422 $chart->setsize(700, 500);
423
424 $legend = new ilChartLegend();
425 $chart->setLegend($legend);
426
427 // needed for correct stacking
428 $custom_order = array(
429 ilLPStatus::LP_STATUS_IN_PROGRESS_NUM => array("#f7d408", "#fffa00"),
430 ilLPStatus::LP_STATUS_FAILED_NUM => array("#cf0202", "#f15b5b"),
431 ilLPStatus::LP_STATUS_COMPLETED_NUM => array("#17aa0e", "#6ce148"),
432 ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM => array("#a4a4a4", "#c4c4c4")
433 );
434
435 $chart->setColors(array());
436
437 $max_value = 0;
438 foreach ($this->chart_data as $object_id => $days) {
439 if (in_array($object_id, $a_graph_items)) {
440 $series = array();
441 foreach ($custom_order as $status => $colors) {
442 /*
443 if(strpos($this->filter["yearmonth"], "-") === false)
444 {
445 $series[$status] = new ilChartData("lines");
446 $series[$status]->setLineSteps(true);
447 }
448 else
449 {
450 $series[$status] = new ilChartData("bars");
451 $series[$status]->setBarOptions(0.75);
452 $series[$status]->setFill(true, $colors[1]);
453 }
454 $series[$status]->setStackingId($object_id);
455 */
456 $series[$status] = $chart->getDataInstance(ilChartGrid::DATA_LINES);
457
459 $chart_colors[] = $colors[0];
460 }
461 $chart->setColors($chart_colors);
462
463 if (strpos($this->filter["yearmonth"], "-") === false) {
464 $x_axis = $this->lng->txt("month");
465
466 $counter = 0;
467 foreach (array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $month) {
468 for ($loop = 1; $loop < 32; $loop++) {
469 $item_day = $month . "-" . str_pad($loop, 2, "0", STR_PAD_LEFT);
470 foreach (array_keys($custom_order) as $status) {
471 if (isset($days[$item_day])) {
472 // as there is only 1 entry per day, avg == sum
473 $value = (int) $days[$item_day][$this->status_map[$status] . "_avg"];
474 } else {
475 $value = 0;
476 }
477 $max_value = max($max_value, $value);
478 $value = $this->anonymizeValue($value, true);
479 $series[$status]->addPoint($counter, $value);
480 }
481 $counter++;
482 }
483 }
484 } else {
485 $x_axis = $this->lng->txt("day");
486 for ($loop = 1; $loop < 32; $loop++) {
487 foreach (array_keys($custom_order) as $status) {
488 if (isset($days[$loop])) {
489 // as there is only 1 entry per day, avg == sum
490 $value = (int) $days[$loop][$this->status_map[$status] . "_avg"];
491 } else {
492 $value = 0;
493 }
494 $max_value = max($max_value, $value);
495 $value = $this->anonymizeValue($value, true);
496 $series[$status]->addPoint($loop, $value);
497 }
498 }
499 }
500
501 foreach (array_keys($custom_order) as $status) {
502 $chart->addData($series[$status]);
503 }
504 }
505 }
506
507 $value_ticks = $this->buildValueScale($max_value, true);
508
509 $labels = array();
510 if (strpos($this->filter["yearmonth"], "-") === false) {
511 $counter = 0;
512 foreach ($this->getMonthsYear($this->filter["yearmonth"], true) as $caption) {
513 $labels[$counter] = $caption;
514 $counter += 31;
515 }
516 } else {
517 for ($loop = 1; $loop < 32; $loop++) {
518 $labels[$loop] = $loop . ".";
519 }
520 }
521 $chart->setTicks($labels, $value_ticks, true);
522
523 return $chart->getHTML();
524 }
static getInstanceByType($a_type, $a_id)
Get type instance.
const TYPE_GRID
buildValueScale($a_max_value, $a_anonymize=false, $a_format_seconds=false)
$legend

References $DIC, $legend, ilTableGUI\$lng, $status, ilLearningProgressBaseGUI\_getStatusText(), ilLPTableBaseGUI\anonymizeValue(), ilLPTableBaseGUI\buildValueScale(), ilChartGrid\DATA_LINES, ilChart\getInstanceByType(), ilLPTableBaseGUI\getMonthsYear(), 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.

+ Here is the call graph for this function:

◆ getItems()

ilLPObjectStatisticsLPTableGUI::getItems ( )

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

203 {
204 $data = array();
205 $all_status = array_merge(array("mem_cnt"), $this->status);
206
207 $objects = $this->searchObjects(
208 $this->getCurrentFilter(true),
209 "read",
210 null,
211 false
212 );
213 if ($objects) {
214 $objects = array_keys($objects);
215
216 include_once "Services/Tracking/classes/class.ilTrQuery.php";
217
218 $yearmonth = explode("-", $this->filter["yearmonth"]);
219 if (sizeof($yearmonth) == 1) {
220 foreach (ilTrQuery::getObjectLPStatistics($objects, $yearmonth[0]) as $item) {
221 $obj_id = $item["obj_id"];
222 if (!isset($data[$obj_id])) {
223 $data[$obj_id]["obj_id"] = $obj_id;
224 $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
225 }
226
227 $measure_type = substr($this->filter["measure"], -3);
228 $measure_field = substr($this->filter["measure"], 0, -4);
229 $value = $item[$measure_field . "_" . $measure_type];
230 $idx = $item["yyyy"] . "-" . str_pad($item["mm"], 2, "0", STR_PAD_LEFT);
231 $data[$obj_id]["month_" . $idx] = $value;
232 }
233
234 if ($this->is_chart) {
235 // get data for single days (used in chart display)
236 foreach (array_keys($this->getMonthsYear($yearmonth[0])) as $num) {
237 $num = (int) array_pop(explode("-", $num));
238 foreach (ilTrQuery::getObjectLPStatistics($objects, $yearmonth[0], $num, true) as $item) {
239 $idx = $yearmonth[0] .
240 "-" . str_pad($num, 2, "0", STR_PAD_LEFT) .
241 "-" . str_pad($item["dd"], 2, "0", STR_PAD_LEFT);
242 $this->chart_data[$item["obj_id"]][$idx] = $item;
243 }
244 }
245 }
246 } else {
247 // get data aggregated for month
248 foreach (ilTrQuery::getObjectLPStatistics($objects, $yearmonth[0], (int) $yearmonth[1]) as $item) {
249 $obj_id = $item["obj_id"];
250 if (!isset($data[$obj_id])) {
251 $data[$obj_id]["obj_id"] = $obj_id;
252 $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
253 $this->initRow($data[$obj_id]);
254 }
255
256 foreach ($all_status as $status) {
257 // status-id to field name
258 if (is_numeric($status)) {
259 $field = $this->status_map[$status];
260 } else {
261 $field = $status;
262 }
263
264 // aggregated fields
265 foreach ($this->types as $type) {
266 $value = $item[$field . "_" . $type];
267 $data[$obj_id][$status . "_" . $type] = $value;
268 }
269 }
270 }
271
272 if ($this->is_chart) {
273 // get data for single days (used in chart display)
274 foreach (ilTrQuery::getObjectLPStatistics($objects, $yearmonth[0], (int) $yearmonth[1], true) as $item) {
275 $this->chart_data[$item["obj_id"]][$item["dd"]] = $item;
276 }
277 }
278 }
279
280 // add objects with no usage data
281 foreach ($objects as $obj_id) {
282 if (!isset($data[$obj_id])) {
283 $data[$obj_id]["obj_id"] = $obj_id;
284 $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
285 }
286 }
287 }
288
289 $this->setData($data);
290
291 include_once "./Services/Link/classes/class.ilLink.php";
292 }
getCurrentFilter($as_query=false)
searchObjects(array $filter, $permission, array $preset_obj_ids=null, $a_check_lp_activation=true)
Search objects that match current filters.
static _lookupTitle($a_id)
lookup object title

References ilTableGUI\$data, $status, $type, ilObject\_lookupTitle(), ilLPTableBaseGUI\getCurrentFilter(), ilLPTableBaseGUI\getMonthsYear(), ilTrQuery\getObjectLPStatistics(), initRow(), ilLPTableBaseGUI\searchObjects(), and ilTable2GUI\setData().

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initFilter()

ilLPObjectStatisticsLPTableGUI::initFilter ( )

Init filter.

Reimplemented from ilTable2GUI.

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

135 {
136 global $DIC;
137
138 $lng = $DIC['lng'];
139
140 $this->setDisableFilterHiding(true);
141
142 // object type selection
143 include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
144 /*
145 $si = new ilSelectInputGUI($lng->txt("obj_type"), "type");
146 $options = $this->getPossibleTypes(true);
147 $si->setOptions($options);
148 $this->addFilterItem($si);
149 $si->readFromSession();
150 if(!$si->getValue())
151 {
152 $si->setValue("crs");
153 }
154 $this->filter["type"] = $si->getValue();
155
156 $this->filter_captions[] = $options[$this->filter["type"]];
157 */
158 $this->filter["type"] = "crs";
159
160
161 // title/description
162 include_once("./Services/Form/classes/class.ilTextInputGUI.php");
163 $ti = new ilTextInputGUI($lng->txt("trac_title_description"), "query");
164 $ti->setMaxLength(64);
165 $ti->setSize(20);
166 $this->addFilterItem($ti);
167 $ti->readFromSession();
168 $this->filter["query"] = $ti->getValue();
169
170 // year/month
171 $si = new ilSelectInputGUI($lng->txt("year") . " / " . $lng->txt("month"), "yearmonth");
172 $si->setOptions($this->getMonthsFilter());
173 $this->addFilterItem($si);
174 $si->readFromSession();
175 if (!$si->getValue()) {
176 $si->setValue(date("Y-m"));
177 }
178 $this->filter["yearmonth"] = $si->getValue();
179
180 if (!strpos($this->filter["yearmonth"], "-")) {
181 $si = new ilSelectInputGUI($lng->txt("trac_figure"), "figure");
182 $options = array(
183 "mem_cnt_max" => $lng->txt("members") . " " . $lng->txt("trac_object_stat_lp_max"),
184 "mem_cnt_avg" => $lng->txt("members") . " &#216;",
185 // we are using the db column names here (not the lp constants)!
186 "in_progress_max" => ilLearningProgressBaseGUI::_getStatusText(ilLPStatus::LP_STATUS_IN_PROGRESS_NUM) . " " . $lng->txt("trac_object_stat_lp_max"),
188 $si->setOptions($options);
189 $this->addFilterItem($si);
190 $si->readFromSession();
191 if (!$si->getValue()) {
192 $si->setValue("mem_cnt_max");
193 }
194 $this->filter["measure"] = $si->getValue();
195 }
196
197 if ($this->is_details) {
198 $this->filters = array();
199 }
200 }
getMonthsFilter($a_short=false)
This class represents a selection list property in a property form.
setDisableFilterHiding($a_val=true)
Set disable filter hiding.
addFilterItem($a_input_item, $a_optional=false)
Add filter item.
This class represents a text property in a property form.

References $DIC, ilTableGUI\$lng, PHPMailer\PHPMailer\$options, $si, ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\addFilterItem(), ilLPTableBaseGUI\getMonthsFilter(), ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilTable2GUI\setDisableFilterHiding().

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initLearningProgressDetailsLayer()

ilLPObjectStatisticsLPTableGUI::initLearningProgressDetailsLayer ( )
protected

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

527 {
528 global $DIC;
529
530 $tpl = $DIC['tpl'];
531
532 include_once("./Services/YUI/classes/class.ilYuiUtil.php");
534 include_once("./Services/jQuery/classes/class.iljQueryUtil.php");
536
537 $tpl->addJavascript("./Services/Tracking/js/ilObjStat.js");
538 }
static initPanel($a_resize=false, ilTemplate $a_main_tpl=null)
Init yui panel.
static initjQuery($a_tpl=null)
inits and adds the jQuery JS-File to the global or a passed template

References $DIC, ilTable2GUI\$tpl, iljQueryUtil\initjQuery(), and ilYuiUtil\initPanel().

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initRow()

ilLPObjectStatisticsLPTableGUI::initRow ( $a_row)
protected

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

344 {
345 foreach ($this->types as $type) {
346 $a_row["mem_cnt_" . $type] = null;
347 }
348 foreach ($this->status as $status) {
349 foreach ($this->types as $type) {
350 $a_row[$status . "_" . $type] = null;
351 }
352 }
353 }

References $status, and $type.

Referenced by getItems().

+ Here is the caller graph for this function:

◆ numericOrdering()

ilLPObjectStatisticsLPTableGUI::numericOrdering (   $a_field)

Should this field be sorted numeric?

Returns
boolean numeric ordering; default is false

Reimplemented from ilTable2GUI.

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

124 {
125 if ($a_field != "title") {
126 return true;
127 }
128 return false;
129 }

Field Documentation

◆ $chart_data

ilLPObjectStatisticsLPTableGUI::$chart_data = array()
protected

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

◆ $is_chart

ilLPObjectStatisticsLPTableGUI::$is_chart = false
protected

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

◆ $is_details

ilLPObjectStatisticsLPTableGUI::$is_details = false
protected

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

◆ $status

◆ $types

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

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


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