ILIAS  release_4-4 Revision
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)
 
 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="")
 
 executeCommand ()
 
 searchFilterListener ($a_ref_id, $a_data)
 Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED public. More...
 
 initFilter ($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="")
 Constructor. More...
 
 setOpenFormTag ($a_val)
 Set open form tag. More...
 
 getOpenFormTag ()
 Get open form tag. More...
 
 setCloseFormTag ($a_val)
 Set close form tag. More...
 
 getCloseFormTag ()
 Get close form tag. More...
 
 determineLimit ()
 Determine the limit. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 Determine selected columns. More...
 
 isColumnSelected ($a_col)
 Is given column selected? More...
 
 getSelectedColumns ()
 Get selected columns. More...
 
executeCommand ()
 Execute command. More...
 
 resetOffset ($a_in_determination=false)
 Reset offset. More...
 
 initFilter ()
 Init filter. More...
 
 getParentObject ()
 Get parent object. More...
 
 getParentCmd ()
 Get parent command. More...
 
 setTopAnchor ($a_val)
 Set top anchor. More...
 
 getTopAnchor ()
 Get top anchor. More...
 
 setNoEntriesText ($a_text)
 Set text for an empty table. More...
 
 getNoEntriesText ()
 Get text for an empty table. More...
 
 setIsDataTable ($a_val)
 Set is data table. More...
 
 getIsDataTable ()
 Get is data table. More...
 
 setEnableTitle ($a_enabletitle)
 Set Enable Title. More...
 
 getEnableTitle ()
 Get Enable Title. More...
 
 setEnableHeader ($a_enableheader)
 Set Enable Header. More...
 
 getEnableHeader ()
 Get Enable Header. More...
 
 setEnableNumInfo ($a_val)
 Set enable num info. More...
 
 getEnableNumInfo ()
 Get enable num info. More...
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setOrderField ($a_order_field)
 set order column More...
 
 getOrderField ()
 
 setData ($a_data)
 
 getData ()
 
 dataExists ()
 
 setPrefix ($a_prefix)
 
 getPrefix ()
 
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item. More...
 
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
 Add filter by standard type. More...
 
 getFilterItems ($a_optionals=false)
 Get filter items. More...
 
 getFilterItemByPostVar ($a_post_var)
 
 setFilterCols ($a_val)
 Set filter columns. More...
 
 getFilterCols ()
 Get filter columns. More...
 
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding. More...
 
 getDisableFilterHiding ()
 Get disable filter hiding. More...
 
 isFilterSelected ($a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 Get selected filters. More...
 
 determineSelectedFilters ()
 Determine selected filters. More...
 
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links. More...
 
 setFormAction ($a_form_action)
 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)
 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)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val)
 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...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="")
 Add Command button. 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="")
 Add a column to the header. More...
 
 getNavParameter ()
 
 setOrderLink ($sort_field, $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order. More...
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 render ()
 render table public More...
 
 writeFilterToSession ()
 Write filter values to session. More...
 
 resetFilter ()
 Reset filter. More...
 
 fillFooter ()
 Fill footer row. More...
 
 getLinkbar ($a_num)
 Get previous/next linkbar. More...
 
 fillHiddenRow ()
 
 fillActionRow ()
 Fill Action Row. More...
 
 setHeaderHTML ($html)
 set header html More...
 
 storeProperty ($type, $value)
 Store table property. More...
 
 loadProperty ($type)
 Load table property. More...
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext ($id)
 Set context. More...
 
 getContext ()
 Get context. More...
 
 setShowRowsSelector ($a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 Get rows-per-page selector state. More...
 
 setShowTemplates ($a_value)
 Toggle templates. More...
 
 getShowTemplates ()
 Get template state. More...
 
 restoreTemplate ($a_name)
 Restore state from template. More...
 
 saveTemplate ($a_name)
 Save current state as template. More...
 
 deleteTemplate ($a_name)
 Delete template. More...
 
 getLimit ()
 Get limit. More...
 
 getOffset ()
 Get offset. More...
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode ($a_value=false)
 Toogle print mode. More...
 
 getPrintMode ()
 Get print mode. More...
 
 getExportMode ()
 Was export activated? More...
 
 exportData ($format, $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result. More...
 
 setRowSelectorLabel ($row_selector_label)
 
 getRowSelectorLabel ()
 
- Public Member Functions inherited from ilTableGUI
 ilTableGUI ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate (&$a_tpl)
 set template public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page public More...
 
 setHeaderNames ($a_header_names)
 set table header names public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars public More...
 
 setColumnWidth ($a_column_width)
 set table column widths public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width public More...
 
 setMaxCount ($a_max_count)
 set max. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
 getLimit ()
 Get limit. More...
 
 setPrefix ($a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) public More...
 
 setOffset ($a_offset)
 set dataset offset public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction public More...
 
 enable ($a_module_name)
 enables particular modules of table More...
 
 disable ($a_module_name)
 diesables particular modules of table More...
 
 sortData ()
 
 render ()
 render table public More...
 
 renderHeader ()
 
 setOrderLink ($key, $order_dir)
 
 setStyle ($a_element, $a_style)
 
 getStyle ($a_element)
 
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds). More...
 
 getBase ()
 Get Base script name (deprecated, only use this for workarounds). More...
 
 getFormName ()
 
 setFormName ($a_name="cmd")
 
 getSelectAllCheckbox ()
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton ($btn_name, $btn_value)
 

Protected Member Functions

 getDetailItems ($a_obj_id)
 
 initRow (&$a_row)
 
 fillRow ($a_set)
 Fill table row. More...
 
 initLearningProgressDetailsLayer ()
 
- Protected Member Functions inherited from ilLPTableBaseGUI
 searchObjects (array $filter, $permission, array $preset_obj_ids=null)
 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 ($worksheet, &$a_row)
 
 fillMetaCSV ($a_csv)
 
 showTimingsWarning ($a_ref_id, $a_user_id)
 
 formatSeconds ($seconds, $a_shorten_zero=false)
 
 anonymizeValue ($a_value, $a_force_number=false)
 
 buildValueScale ($a_max_value, $a_anonymize=false, $a_format_seconds=false)
 
 getMonthsFilter ($a_short=false)
 
 getMonthsYear ($a_year=null, $a_short=false)
 
 getSelectableUserColumns ($a_in_course=false, $a_in_group=false)
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. 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 ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Row. More...
 
 fillRowExcel ($a_worksheet, &$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
 $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 = null
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = 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
 
 $row_selector_label
 

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

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.

References ilTableGUI\$icon, $ilCtrl, $lng, $path, $status, 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(), ilTableGUI\setLimit(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTitle().

31  {
32  global $ilCtrl, $lng;
33 
34  $this->preselected = $a_preselect;
35  $this->is_chart = (bool)$a_is_chart;
36  $this->is_details = (bool)$a_is_details;
37 
38  $this->setId("lpobjstatlptbl");
39 
40  parent::__construct($a_parent_obj, $a_parent_cmd);
41 
42  if(!$this->is_details)
43  {
44  $this->setShowRowsSelector(true);
45  // $this->setLimit(ilSearchSettings::getInstance()->getMaxHits());
46 
47  $this->addColumn("", "", "1%", true);
48  $this->addColumn($lng->txt("trac_title"), "title");
49  $this->addColumn($lng->txt("object_id"), "obj_id");
50  }
51  else
52  {
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  {
62  foreach($this->getMonthsYear($this->filter["yearmonth"]) as $num => $caption)
63  {
64  $this->addColumn($caption, "month_".$num, "", false, "ilRight");
65  }
66  }
67  else
68  {
69  foreach($this->types as $type)
70  {
71  if($type != "avg")
72  {
73  $caption = " ".$this->lng->txt("trac_object_stat_lp_".$type);
74  }
75  else
76  {
77  $caption = " Ø";
78  }
79  $this->addColumn($lng->txt("trac_members_short").$caption, "mem_cnt_".$type, "", false, "ilRight");
80  }
81 
82  include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
83  foreach($this->status as $status)
84  {
87  $icon = ilUtil::img($path, $text);
88 
89  foreach($this->types as $type)
90  {
91  if($type != "avg")
92  {
93  $caption = $icon.$this->lng->txt("trac_object_stat_lp_".$type);
94  }
95  else
96  {
97  $caption = $icon." Ø";
98  }
99  $this->addColumn($caption, $status."_".$type, "", false, "ilRight");
100  }
101  }
102  }
103 
104  if(!$this->is_details)
105  {
106  $this->setTitle($this->lng->txt("trac_object_stat_lp"));
107 
108  // $this->setSelectAllCheckbox("item_id");
109  $this->addMultiCommand("showLearningProgressGraph", $lng->txt("trac_show_graph"));
110  $this->setResetCommand("resetLearningProgressFilter");
111  $this->setFilterCommand("applyLearningProgressFilter");
112  }
113 
114  $this->setFormAction($ilCtrl->getFormAction($a_parent_obj, $a_parent_cmd));
115  $this->setRowTemplate("tpl.lp_object_statistics_lp_row.html", "Services/Tracking");
116  $this->setEnableHeader(true);
117  $this->setEnableNumInfo(true);
118  $this->setEnableTitle(true);
119  $this->setDefaultOrderField("title");
120  $this->setDefaultOrderDirection("asc");
121 
122  $this->status_map = array(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM => "not_attempted",
123  ilLPStatus::LP_STATUS_IN_PROGRESS_NUM => "in_progress",
124  ilLPStatus::LP_STATUS_COMPLETED_NUM => "completed",
125  ilLPStatus::LP_STATUS_FAILED_NUM => "failed");
126 
127  if($a_load_items)
128  {
129  if($this->is_details)
130  {
131  $this->getDetailItems($this->preselected[0]);
132  }
133  else
134  {
136  $this->getItems();
137  }
138  }
139  }
const LP_STATUS_COMPLETED_NUM
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
static img($a_src, $a_alt="", $a_width="", $a_height="", $a_border=0, $a_id="")
Build img tag.
setFilterCommand($a_val)
Set filter command.
setEnableNumInfo($a_val)
Set enable num info.
getMonthsYear($a_year=null, $a_short=false)
const LP_STATUS_IN_PROGRESS_NUM
_getImagePathForStatus($a_status)
Get image path for status.
setId($a_val)
Set id.
_getStatusText($a_status)
Get status alt text.
global $ilCtrl
Definition: ilias.php:18
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
setLimit($a_limit=0, $a_default_limit=0)
set max.
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="")
Add a column to the header.
addMultiCommand($a_cmd, $a_text)
Add Command button.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
const LP_STATUS_NOT_ATTEMPTED_NUM
global $lng
Definition: privfeed.php:40
$path
Definition: index.php:22
setFormAction($a_form_action)
Set Form action parameter.
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
setEnableHeader($a_enableheader)
Set Enable Header.
setEnableTitle($a_enabletitle)
Set Enable Title.
setResetCommand($a_val)
Set reset filter command.
const LP_STATUS_FAILED_NUM
+ Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilLPObjectStatisticsLPTableGUI::fillRow (   $a_set)
protected

Fill table row.

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

References $ilCtrl, $status, ilObject\_getIcon(), ilObject\_lookupType(), ilLPTableBaseGUI\anonymizeValue(), and ilLPTableBaseGUI\getMonthsYear().

411  {
412  global $ilCtrl;
413 
414  if(!$this->is_details)
415  {
416  $type = ilObject::_lookupType($a_set["obj_id"]);
417 
418  // ajax details layer link
419  if(strpos($this->filter["yearmonth"], "-") === false)
420  {
421  $ilCtrl->setParameter($this->parent_obj, "item_id", $a_set["obj_id"]);
422  $url = $ilCtrl->getLinkTarget($this->parent_obj, "showLearningProgressDetails");
423  $a_set["title"] .= " (<a href=\"#\" onclick=\"ilObjStat.showLPDetails(event, '".$url."');\">Details</a>)";
424  $ilCtrl->setParameter($this->parent_obj, "item_id", "");
425  }
426 
427  $this->tpl->setCurrentBlock("checkbox");
428  $this->tpl->setVariable("OBJ_ID", $a_set["obj_id"]);
429  $this->tpl->setVariable("ICON_SRC", ilObject::_getIcon("", "tiny", $type));
430  $this->tpl->setVariable("ICON_ALT", $this->lng->txt($type));
431  $this->tpl->setVariable("TITLE_TEXT", $a_set["title"]);
432  if($this->preselected && in_array($a_set["obj_id"], $this->preselected))
433  {
434  $this->tpl->setVariable("CHECKBOX_STATE", " checked=\"checked\"");
435  }
436  $this->tpl->parseCurrentBlock();
437  }
438  else
439  {
440  $this->tpl->setCurrentBlock("details");
441  $this->tpl->setVariable("TXT_FIGURE", $a_set["figure"]);
442  $this->tpl->parseCurrentBlock();
443  }
444 
445  $this->tpl->setCurrentBlock("item");
446 
447  if(strpos($this->filter["yearmonth"], "-") === false)
448  {
449  foreach(array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $num)
450  {
451  $value = $this->anonymizeValue((int)$a_set["month_".$num]);
452  $this->tpl->setVariable("ITEM_VALUE", $value);
453  $this->tpl->parseCurrentBlock();
454  }
455  }
456  else
457  {
458  foreach($this->types as $type)
459  {
460  $this->tpl->setVariable("ITEM_VALUE", $this->anonymizeValue((int)$a_set["mem_cnt_".$type]));
461  $this->tpl->parseCurrentBlock();
462  }
463  foreach($this->status as $status)
464  {
465  foreach($this->types as $type)
466  {
467  $this->tpl->setVariable("ITEM_VALUE", $this->anonymizeValue((int)$a_set[$status."_".$type]));
468  $this->tpl->parseCurrentBlock();
469  }
470  }
471  }
472  }
anonymizeValue($a_value, $a_force_number=false)
static _getIcon($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
Get icon for repository item.
getMonthsYear($a_year=null, $a_short=false)
global $ilCtrl
Definition: ilias.php:18
static _lookupType($a_id, $a_reference=false)
lookup object type
+ Here is the call graph for this function:

◆ getDetailItems()

ilLPObjectStatisticsLPTableGUI::getDetailItems (   $a_obj_id)
protected

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

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

Referenced by __construct().

331  {
332  $data = array();
333  $all_status = array_merge(array("mem_cnt"), $this->status);
334 
335  include_once "Services/Tracking/classes/class.ilTrQuery.php";
336  foreach(ilTrQuery::getObjectLPStatistics(array($a_obj_id), $this->filter["yearmonth"]) as $item)
337  {
338  $month = "month_".$item["yyyy"]."-".str_pad($item["mm"], 2, "0", STR_PAD_LEFT);
339 
340  foreach($all_status as $status)
341  {
342  // status-id to field name
343  if($status != "mem_cnt")
344  {
345  $field = $this->status_map[$status];
346  }
347  else
348  {
349  $field = $status;
350  }
351  // aggregated fields
352  foreach($this->types as $type)
353  {
354  $value = $item[$field."_".$type];
355  $idx = $item["yyyy"]."-".str_pad($item["mm"], 2, "0", STR_PAD_LEFT);
356  $data[$status."_".$type]["month_".$idx] = $value;
357  }
358  }
359  }
360 
361  // add captions
362  foreach(array_keys($data) as $figure)
363  {
364  $status = substr($figure, 0, -4);
365  $type = substr($figure, -3);
366 
367  if($status != "mem_cnt")
368  {
370  $text = ilLearningProgressBaseGUI::_getStatusText((int)$status);
371  $icon = ilUtil::img($path, $text);
372  $text = $icon." ".$text;
373  }
374  else
375  {
376  $text = $this->lng->txt("members");
377  }
378  if($type != "avg")
379  {
380  $caption = $text." ".$this->lng->txt("trac_object_stat_lp_".$type);
381  }
382  else
383  {
384  $caption = $text." &#216;";
385  }
386  $data[$figure]["figure"] = $caption;
387  }
388 
389  $this->setData($data);
390  }
static getObjectLPStatistics(array $a_obj_ids, $a_year, $a_month=null, $a_group_by_day=false)
static img($a_src, $a_alt="", $a_width="", $a_height="", $a_border=0, $a_id="")
Build img tag.
_getImagePathForStatus($a_status)
Get image path for status.
_getStatusText($a_status)
Get status alt text.
$path
Definition: index.php:22
+ 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 474 of file class.ilLPObjectStatisticsLPTableGUI.php.

References $lng, $status, ilLearningProgressBaseGUI\_getStatusText(), ilLPTableBaseGUI\anonymizeValue(), ilLPTableBaseGUI\buildValueScale(), ilLPTableBaseGUI\getMonthsYear(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

475  {
476  global $lng;
477 
478  $a_graph_items = array(array_pop($a_graph_items));
479 
480  include_once "Services/Chart/classes/class.ilChart.php";
481  $chart = new ilChart("objstlp", 700, 500);
482 
483  $legend = new ilChartLegend();
484  $chart->setLegend($legend);
485 
486  // needed for correct stacking
487  $custom_order = array(
488  ilLPStatus::LP_STATUS_IN_PROGRESS_NUM => array("#f7d408", "#fffa00"),
489  ilLPStatus::LP_STATUS_FAILED_NUM => array("#cf0202", "#f15b5b"),
490  ilLPStatus::LP_STATUS_COMPLETED_NUM => array("#17aa0e", "#6ce148"),
491  ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM => array("#a4a4a4", "#c4c4c4")
492  );
493 
494  $chart->setColors(array());
495 
496  $max_value = 0;
497  foreach($this->chart_data as $object_id => $days)
498  {
499  if(in_array($object_id, $a_graph_items))
500  {
501  $series = array();
502  foreach($custom_order as $status => $colors)
503  {
504  /*
505  if(strpos($this->filter["yearmonth"], "-") === false)
506  {
507  $series[$status] = new ilChartData("lines");
508  $series[$status]->setLineSteps(true);
509  }
510  else
511  {
512  $series[$status] = new ilChartData("bars");
513  $series[$status]->setBarOptions(0.75);
514  $series[$status]->setFill(true, $colors[1]);
515  }
516  $series[$status]->setStackingId($object_id);
517  */
518  $series[$status] = new ilChartData("lines");
519 
521  $chart_colors[] = $colors[0];
522  }
523  $chart->setColors($chart_colors);
524 
525  if(strpos($this->filter["yearmonth"], "-") === false)
526  {
527  $x_axis = $this->lng->txt("month");
528 
529  $counter = 0;
530  foreach(array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $month)
531  {
532  for($loop = 1; $loop<32; $loop++)
533  {
534  $item_day = $month."-".str_pad($loop, 2, "0", STR_PAD_LEFT);
535  foreach(array_keys($custom_order) as $status)
536  {
537  if(isset($days[$item_day]))
538  {
539  // as there is only 1 entry per day, avg == sum
540  $value = (int)$days[$item_day][$this->status_map[$status]."_avg"];
541  }
542  else
543  {
544  $value = 0;
545  }
546  $max_value = max($max_value, $value);
547  $value = $this->anonymizeValue($value, true);
548  $series[$status]->addPoint($counter, $value);
549  }
550  $counter++;
551  }
552  }
553  }
554  else
555  {
556  $x_axis = $this->lng->txt("day");
557  for($loop = 1; $loop<32; $loop++)
558  {
559  foreach(array_keys($custom_order) as $status)
560  {
561  if(isset($days[$loop]))
562  {
563  // as there is only 1 entry per day, avg == sum
564  $value = (int)$days[$loop][$this->status_map[$status]."_avg"];
565  }
566  else
567  {
568  $value = 0;
569  }
570  $max_value = max($max_value, $value);
571  $value = $this->anonymizeValue($value, true);
572  $series[$status]->addPoint($loop, $value);
573  }
574  }
575  }
576 
577  foreach(array_keys($custom_order) as $status)
578  {
579  $chart->addData($series[$status]);
580  }
581  }
582  }
583 
584  $value_ticks = $this->buildValueScale($max_value, true);
585 
586  $labels = array();
587  if(strpos($this->filter["yearmonth"], "-") === false)
588  {
589  $counter = 0;
590  foreach($this->getMonthsYear($this->filter["yearmonth"], true) as $caption)
591  {
592  $labels[$counter] = $caption;
593  $counter += 31;
594  }
595  }
596  else
597  {
598  for($loop = 1; $loop<32; $loop++)
599  {
600  $labels[$loop] = $loop.".";
601  }
602  }
603  $chart->setTicks($labels, $value_ticks, true);
604 
605  return $chart->getHTML();
606  }
const LP_STATUS_COMPLETED_NUM
anonymizeValue($a_value, $a_force_number=false)
Chart legend.
getMonthsYear($a_year=null, $a_short=false)
const LP_STATUS_IN_PROGRESS_NUM
Chart generator.
_getStatusText($a_status)
Get status alt text.
buildValueScale($a_max_value, $a_anonymize=false, $a_format_seconds=false)
const LP_STATUS_NOT_ATTEMPTED_NUM
global $lng
Definition: privfeed.php:40
Chart data series.
const LP_STATUS_FAILED_NUM
+ Here is the call graph for this function:

◆ getItems()

ilLPObjectStatisticsLPTableGUI::getItems ( )

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

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

Referenced by __construct().

224  {
225  $data = array();
226  $all_status = array_merge(array("mem_cnt"), $this->status);
227 
228  $objects = $this->searchObjects($this->getCurrentFilter(true), "read");
229  if($objects)
230  {
231  $objects = array_keys($objects);
232 
233  include_once "Services/Tracking/classes/class.ilTrQuery.php";
234 
235  $yearmonth = explode("-", $this->filter["yearmonth"]);
236  if(sizeof($yearmonth) == 1)
237  {
238  foreach(ilTrQuery::getObjectLPStatistics($objects, $yearmonth[0]) as $item)
239  {
240  $obj_id = $item["obj_id"];
241  if(!isset($data[$obj_id]))
242  {
243  $data[$obj_id]["obj_id"] = $obj_id;
244  $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
245  }
246 
247  $measure_type = substr($this->filter["measure"], -3);
248  $measure_field = substr($this->filter["measure"], 0, -4);
249  $value = $item[$measure_field."_".$measure_type];
250  $idx = $item["yyyy"]."-".str_pad($item["mm"], 2, "0", STR_PAD_LEFT);
251  $data[$obj_id]["month_".$idx] = $value;
252  }
253 
254  if($this->is_chart)
255  {
256  // get data for single days (used in chart display)
257  foreach(array_keys($this->getMonthsYear($yearmonth[0])) as $num)
258  {
259  $num = (int)array_pop(explode("-", $num));
260  foreach(ilTrQuery::getObjectLPStatistics($objects, $yearmonth[0], $num, true) as $item)
261  {
262  $idx = $yearmonth[0].
263  "-".str_pad($num, 2, "0", STR_PAD_LEFT).
264  "-".str_pad($item["dd"], 2, "0", STR_PAD_LEFT);
265  $this->chart_data[$item["obj_id"]][$idx] = $item;
266  }
267  }
268  }
269  }
270  else
271  {
272  // get data aggregated for month
273  foreach(ilTrQuery::getObjectLPStatistics($objects, $yearmonth[0], (int)$yearmonth[1]) as $item)
274  {
275  $obj_id = $item["obj_id"];
276  if(!isset($data[$obj_id]))
277  {
278  $data[$obj_id]["obj_id"] = $obj_id;
279  $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
280  $this->initRow($data[$obj_id]);
281  }
282 
283  foreach($all_status as $status)
284  {
285  // status-id to field name
286  if(is_numeric($status))
287  {
288  $field = $this->status_map[$status];
289  }
290  else
291  {
292  $field = $status;
293  }
294 
295  // aggregated fields
296  foreach($this->types as $type)
297  {
298  $value = $item[$field."_".$type];
299  $data[$obj_id][$status."_".$type] = $value;
300  }
301  }
302  }
303 
304  if($this->is_chart)
305  {
306  // get data for single days (used in chart display)
307  foreach(ilTrQuery::getObjectLPStatistics($objects, $yearmonth[0], (int)$yearmonth[1], true) as $item)
308  {
309  $this->chart_data[$item["obj_id"]][$item["dd"]] = $item;
310  }
311  }
312  }
313 
314  // add objects with no usage data
315  foreach($objects as $obj_id)
316  {
317  if(!isset($data[$obj_id]))
318  {
319  $data[$obj_id]["obj_id"] = $obj_id;
320  $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
321  }
322  }
323  }
324 
325  $this->setData($data);
326 
327  include_once "./Services/Link/classes/class.ilLink.php";
328  }
static getObjectLPStatistics(array $a_obj_ids, $a_year, $a_month=null, $a_group_by_day=false)
getMonthsYear($a_year=null, $a_short=false)
static _lookupTitle($a_id)
lookup object title
searchObjects(array $filter, $permission, array $preset_obj_ids=null)
Search objects that match current filters.
getCurrentFilter($as_query=false)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initFilter()

ilLPObjectStatisticsLPTableGUI::initFilter ( )

Init filter.

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

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

Referenced by __construct().

154  {
155  global $lng;
156 
157  $this->setDisableFilterHiding(true);
158 
159  // object type selection
160  include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
161  /*
162  $si = new ilSelectInputGUI($lng->txt("obj_type"), "type");
163  $options = $this->getPossibleTypes(true);
164  $si->setOptions($options);
165  $this->addFilterItem($si);
166  $si->readFromSession();
167  if(!$si->getValue())
168  {
169  $si->setValue("crs");
170  }
171  $this->filter["type"] = $si->getValue();
172 
173  $this->filter_captions[] = $options[$this->filter["type"]];
174  */
175  $this->filter["type"] = "crs";
176 
177 
178  // title/description
179  include_once("./Services/Form/classes/class.ilTextInputGUI.php");
180  $ti = new ilTextInputGUI($lng->txt("trac_title_description"), "query");
181  $ti->setMaxLength(64);
182  $ti->setSize(20);
183  $this->addFilterItem($ti);
184  $ti->readFromSession();
185  $this->filter["query"] = $ti->getValue();
186 
187  // year/month
188  $si = new ilSelectInputGUI($lng->txt("year")." / ".$lng->txt("month"), "yearmonth");
189  $si->setOptions($this->getMonthsFilter());
190  $this->addFilterItem($si);
191  $si->readFromSession();
192  if(!$si->getValue())
193  {
194  $si->setValue(date("Y-m"));
195  }
196  $this->filter["yearmonth"] = $si->getValue();
197 
198  if(!strpos($this->filter["yearmonth"], "-"))
199  {
200  $si = new ilSelectInputGUI($lng->txt("trac_figure"), "figure");
201  $options = array(
202  "mem_cnt_max" => $lng->txt("members")." ".$lng->txt("trac_object_stat_lp_max"),
203  "mem_cnt_avg" => $lng->txt("members")." &#216;",
204  // we are using the db column names here (not the lp constants)!
205  "in_progress_max" => ilLearningProgressBaseGUI::_getStatusText(ilLPStatus::LP_STATUS_IN_PROGRESS_NUM)." ".$lng->txt("trac_object_stat_lp_max"),
207  $si->setOptions($options);
208  $this->addFilterItem($si);
209  $si->readFromSession();
210  if(!$si->getValue())
211  {
212  $si->setValue("mem_cnt_max");
213  }
214  $this->filter["measure"] = $si->getValue();
215  }
216 
217  if($this->is_details)
218  {
219  $this->filters = array();
220  }
221  }
This class represents a selection list property in a property form.
const LP_STATUS_IN_PROGRESS_NUM
addFilterItem($a_input_item, $a_optional=false)
Add filter item.
_getStatusText($a_status)
Get status alt text.
if(!is_array($argv)) $options
setDisableFilterHiding($a_val=true)
Set disable filter hiding.
This class represents a text property in a property form.
setMaxLength($a_maxlength)
Set Max Length.
getMonthsFilter($a_short=false)
global $lng
Definition: privfeed.php:40
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initLearningProgressDetailsLayer()

ilLPObjectStatisticsLPTableGUI::initLearningProgressDetailsLayer ( )
protected

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

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

Referenced by __construct().

609  {
610  global $tpl;
611 
612  include_once("./Services/YUI/classes/class.ilYuiUtil.php");
614  include_once("./Services/jQuery/classes/class.iljQueryUtil.php");
616 
617  $tpl->addJavascript("./Services/Tracking/js/ilObjStat.js");
618  }
if(isset($_FILES['img_file']['size']) && $_FILES['img_file']['size'] > 0) $tpl
static initPanel($a_resize=false)
Init yui panel.
static initjQuery($a_tpl=null)
Init jQuery.
+ 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 392 of file class.ilLPObjectStatisticsLPTableGUI.php.

References $status.

Referenced by getItems().

393  {
394  foreach($this->types as $type)
395  {
396  $a_row["mem_cnt_".$type] = null;
397  }
398  foreach($this->status as $status)
399  {
400  foreach($this->types as $type)
401  {
402  $a_row[$status."_".$type] = null;
403  }
404  }
405  }
+ Here is the caller graph for this function:

◆ numericOrdering()

ilLPObjectStatisticsLPTableGUI::numericOrdering (   $a_field)

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

142  {
143  if($a_field != "title")
144  {
145  return true;
146  }
147  return false;
148  }

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: