ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
All Data Structures Namespaces Files Functions Variables Modules Pages
ilLPObjectStatisticsTableGUI Class Reference

TableGUI class for learning progress. More...

+ Inheritance diagram for ilLPObjectStatisticsTableGUI:
+ Collaboration diagram for ilLPObjectStatisticsTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, array $a_preselect=null, $a_load_items=true)
 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, $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)
 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...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButton $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="")
 Add a column to the header. More...
 
 getNavParameter ()
 
 setOrderLink ($sort_field, $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order. More...
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 render ()
 render table public More...
 
 writeFilterToSession ()
 Write filter values to session. More...
 
 resetFilter ()
 Reset filter. More...
 
 fillFooter ()
 Fill footer row. More...
 
 getLinkbar ($a_num)
 Get previous/next linkbar. More...
 
 fillHiddenRow ()
 
 fillActionRow ()
 Fill Action Row. More...
 
 setHeaderHTML ($html)
 set header html More...
 
 storeProperty ($type, $value)
 Store table property. More...
 
 loadProperty ($type)
 Load table property. More...
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext ($id)
 Set context. More...
 
 getContext ()
 Get context. More...
 
 setShowRowsSelector ($a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 Get rows-per-page selector state. More...
 
 setShowTemplates ($a_value)
 Toggle templates. More...
 
 getShowTemplates ()
 Get template state. More...
 
 restoreTemplate ($a_name)
 Restore state from template. More...
 
 saveTemplate ($a_name)
 Save current state as template. More...
 
 deleteTemplate ($a_name)
 Delete template. More...
 
 getLimit ()
 Get limit. More...
 
 getOffset ()
 Get offset. More...
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode ($a_value=false)
 Toogle print mode. More...
 
 getPrintMode ()
 Get print mode. More...
 
 getExportMode ()
 Was export activated? More...
 
 exportData ($format, $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result. More...
 
 setRowSelectorLabel ($row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission ($a_val)
 Set prevent double submission. More...
 
 getPreventDoubleSubmission ()
 Get prevent double submission. More...
 
- 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

 fillRow ($a_set)
 Fill table row. More...
 
 fillMetaExcel ()
 
 fillRowExcel ($a_worksheet, &$a_row, $a_set)
 
 fillMetaCSV ()
 
 fillRowCSV ($a_csv, $a_set)
 
- 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 Header. 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...
 

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
 
- 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 = true
 
 $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
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

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$

ilLPObjectStatisticsTableGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilLPObjectStatisticsTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
array  $a_preselect = null,
  $a_load_items = true 
)

Constructor.

Definition at line 20 of file class.ilLPObjectStatisticsTableGUI.php.

References $ilCtrl, $lng, ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), getItems(), ilLPTableBaseGUI\getMonthsYear(), initFilter(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTitle().

21  {
22  global $ilCtrl, $lng;
23 
24  $this->preselected = $a_preselect;
25 
26  $this->setId("lpobjstattbl");
27 
28  parent::__construct($a_parent_obj, $a_parent_cmd);
29 
30  $this->setShowRowsSelector(true);
31  // $this->setLimit(ilSearchSettings::getInstance()->getMaxHits());
32  $this->initFilter();
33 
34  $this->addColumn("", "", "1", true);
35  $this->addColumn($lng->txt("trac_title"), "title");
36  $this->addColumn($lng->txt("object_id"), "obj_id");
37  if(strpos($this->filter["yearmonth"], "-") === false)
38  {
39  foreach($this->getMonthsYear($this->filter["yearmonth"]) as $num => $caption)
40  {
41  $this->addColumn($caption, "month_".$num, "", false, "ilRight");
42  }
43  }
44  $this->addColumn($lng->txt("total"), "total", "", false, "ilRight");
45 
46  $this->setTitle($this->lng->txt("trac_object_stat_access"));
47 
48  // $this->setSelectAllCheckbox("item_id");
49  $this->addMultiCommand("showAccessGraph", $lng->txt("trac_show_graph"));
50  $this->setResetCommand("resetAccessFilter");
51  $this->setFilterCommand("applyAccessFilter");
52 
53  $this->setFormAction($ilCtrl->getFormAction($a_parent_obj, $a_parent_cmd));
54  $this->setRowTemplate("tpl.lp_object_statistics_row.html", "Services/Tracking");
55  $this->setEnableHeader(true);
56  $this->setEnableNumInfo(true);
57  $this->setEnableTitle(true);
58  $this->setDefaultOrderField("title");
59  $this->setDefaultOrderDirection("asc");
60 
61  $this->setExportFormats(array(self::EXPORT_EXCEL, self::EXPORT_CSV));
62 
63  if($a_load_items)
64  {
65  $this->getItems();
66  }
67  }
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
setExportFormats(array $formats)
Set available export formats.
setEnableNumInfo($a_val)
Set enable num info.
getMonthsYear($a_year=null, $a_short=false)
setId($a_val)
Set id.
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.
setResetCommand($a_val, $a_caption=null)
Set reset filter command.
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.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
global $lng
Definition: privfeed.php:40
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
setEnableHeader($a_enableheader)
Set Enable Header.
setEnableTitle($a_enabletitle)
Set Enable Title.
setFilterCommand($a_val, $a_caption=null)
Set filter command.
+ Here is the call graph for this function:

Member Function Documentation

◆ fillMetaCSV()

ilLPObjectStatisticsTableGUI::fillMetaCSV ( )
protected

Definition at line 350 of file class.ilLPObjectStatisticsTableGUI.php.

351  {
352 
353  }

◆ fillMetaExcel()

ilLPObjectStatisticsTableGUI::fillMetaExcel ( )
protected

Definition at line 310 of file class.ilLPObjectStatisticsTableGUI.php.

311  {
312 
313  }

◆ fillRow()

ilLPObjectStatisticsTableGUI::fillRow (   $a_set)
protected

Fill table row.

Definition at line 190 of file class.ilLPObjectStatisticsTableGUI.php.

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

191  {
192  global $ilCtrl;
193 
194  $type = ilObject::_lookupType($a_set["obj_id"]);
195 
196  $this->tpl->setVariable("OBJ_ID", $a_set["obj_id"]);
197  $this->tpl->setVariable("ICON_SRC", ilObject::_getIcon("", "tiny", $type));
198  $this->tpl->setVariable("ICON_ALT", $this->lng->txt($type));
199  $this->tpl->setVariable("TITLE_TEXT", $a_set["title"]);
200 
201  if($this->preselected && in_array($a_set["obj_id"], $this->preselected))
202  {
203  $this->tpl->setVariable("CHECKBOX_STATE", " checked=\"checked\"");
204  }
205 
206  $sum = 0;
207  if(strpos($this->filter["yearmonth"], "-") === false)
208  {
209  $this->tpl->setCurrentBlock("month");
210  foreach(array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $num)
211  {
212  $value = (int)$a_set["month_".$num];
213  if($this->filter["measure"] != "spent_seconds")
214  {
215  $value = $this->anonymizeValue($value);
216  }
217  else
218  {
219  $value = $this->formatSeconds($value, true);
220  }
221  $this->tpl->setVariable("MONTH_VALUE", $value);
222  $this->tpl->parseCurrentBlock();
223  }
224  }
225 
226  if($this->filter["measure"] == "spent_seconds")
227  {
228  $sum = $this->formatSeconds((int)$a_set["total"], true);
229  }
230  else
231  {
232  $sum = $this->anonymizeValue((int)$a_set["total"]);
233  }
234  $this->tpl->setVariable("TOTAL", $sum);
235  }
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
formatSeconds($seconds, $a_shorten_zero=false)
+ Here is the call graph for this function:

◆ fillRowCSV()

ilLPObjectStatisticsTableGUI::fillRowCSV (   $a_csv,
  $a_set 
)
protected

Definition at line 355 of file class.ilLPObjectStatisticsTableGUI.php.

References ilObject\_lookupTitle(), ilLPTableBaseGUI\anonymizeValue(), and ilLPTableBaseGUI\getMonthsYear().

356  {
357  $a_csv->addColumn(ilObject::_lookupTitle($a_set["obj_id"]));
358  $a_csv->addColumn($a_set["obj_id"]);
359 
360  if(strpos($this->filter["yearmonth"], "-") === false)
361  {
362  foreach(array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $num)
363  {
364  $value = (int)$a_set["month_".$num];
365  if($this->filter["measure"] != "spent_seconds")
366  {
367  $value = $this->anonymizeValue($value);
368  }
369 
370  $a_csv->addColumn($value);
371  }
372  }
373 
374  if($this->filter["measure"] == "spent_seconds")
375  {
376  // keep seconds
377  // $sum = $this->formatSeconds((int)$a_set["total"]);
378  $sum = (int)$a_set["total"];
379  }
380  else
381  {
382  $sum = $this->anonymizeValue((int)$a_set["total"]);
383  }
384  $a_csv->addColumn($sum);
385 
386  $a_csv->addRow();
387  }
anonymizeValue($a_value, $a_force_number=false)
getMonthsYear($a_year=null, $a_short=false)
static _lookupTitle($a_id)
lookup object title
+ Here is the call graph for this function:

◆ fillRowExcel()

ilLPObjectStatisticsTableGUI::fillRowExcel (   $a_worksheet,
$a_row,
  $a_set 
)
protected

Definition at line 315 of file class.ilLPObjectStatisticsTableGUI.php.

References ilObject\_lookupTitle(), ilLPTableBaseGUI\anonymizeValue(), and ilLPTableBaseGUI\getMonthsYear().

316  {
317  $a_worksheet->write($a_row, 0, ilObject::_lookupTitle($a_set["obj_id"]));
318  $a_worksheet->write($a_row, 1, $a_set["obj_id"]);
319 
320  $col = 1;
321  if(strpos($this->filter["yearmonth"], "-") === false)
322  {
323  foreach(array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $num)
324  {
325  $value = (int)$a_set["month_".$num];
326  if($this->filter["measure"] != "spent_seconds")
327  {
328  $value = $this->anonymizeValue($value);
329  }
330 
331  $col++;
332  $a_worksheet->write($a_row, $col, $value);
333  }
334  }
335 
336  if($this->filter["measure"] == "spent_seconds")
337  {
338  // keep seconds
339  // $sum = $this->formatSeconds((int)$a_set["total"]);
340  $sum = (int)$a_set["total"];
341  }
342  else
343  {
344  $sum = $this->anonymizeValue((int)$a_set["total"]);
345  }
346  $col++;
347  $a_worksheet->write($a_row, $col, $sum);
348  }
anonymizeValue($a_value, $a_force_number=false)
getMonthsYear($a_year=null, $a_short=false)
static _lookupTitle($a_id)
lookup object title
+ Here is the call graph for this function:

◆ getGraph()

ilLPObjectStatisticsTableGUI::getGraph ( array  $a_graph_items)

Definition at line 237 of file class.ilLPObjectStatisticsTableGUI.php.

References $lng, ilObject\_lookupTitle(), ilLPTableBaseGUI\anonymizeValue(), ilLPTableBaseGUI\buildValueScale(), ilChartGrid\DATA_LINES, ilTable2GUI\getData(), ilChart\getInstanceByType(), ilLPTableBaseGUI\getMonthsYear(), and ilChart\TYPE_GRID.

238  {
239  global $lng;
240 
241  include_once "Services/Chart/classes/class.ilChart.php";
242  $chart = ilChart::getInstanceByType(ilChart::TYPE_GRID, "objstacc");
243  $chart->setSize(700, 500);
244 
245  $legend = new ilChartLegend();
246  $chart->setLegend($legend);
247 
248  $max_value = 0;
249  foreach($this->getData() as $object)
250  {
251  if(in_array($object["obj_id"], $a_graph_items))
252  {
253  $series = $chart->getDataInstance(ilChartGrid::DATA_LINES);
254  $series->setLabel(ilObject::_lookupTitle($object["obj_id"]));
255 
256  if(strpos($this->filter["yearmonth"], "-") === false)
257  {
258  foreach(array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $idx => $num)
259  {
260  $value = (int)$object["month_".$num];
261  $max_value = max($max_value, $value);
262  if($this->filter["measure"] != "spent_seconds")
263  {
264  $value = $this->anonymizeValue($value, true);
265  }
266  $series->addPoint($idx, $value);
267  }
268  }
269  else
270  {
271  for($loop = 1; $loop<32; $loop++)
272  {
273  $value = (int)$object["day_".$loop];
274  $max_value = max($max_value, $value);
275  if($this->filter["measure"] != "spent_seconds")
276  {
277  $value = $this->anonymizeValue($value, true);
278  }
279  $series->addPoint($loop, $value);
280  }
281  }
282 
283  $chart->addData($series);
284  }
285  }
286 
287  $value_ticks = $this->buildValueScale($max_value, ($this->filter["measure"] != "spent_seconds"),
288  ($this->filter["measure"] == "spent_seconds"));
289 
290  $labels = array();
291  if(strpos($this->filter["yearmonth"], "-") === false)
292  {
293  foreach(array_values($this->getMonthsYear($this->filter["yearmonth"], true)) as $idx => $caption)
294  {
295  $labels[$idx] = $caption;
296  }
297  }
298  else
299  {
300  for($loop = 1; $loop<32; $loop++)
301  {
302  $labels[$loop] = $loop.".";
303  }
304  }
305  $chart->setTicks($labels, $value_ticks, true);
306 
307  return $chart->getHTML();
308  }
anonymizeValue($a_value, $a_force_number=false)
Chart legend.
getMonthsYear($a_year=null, $a_short=false)
static _lookupTitle($a_id)
lookup object title
buildValueScale($a_max_value, $a_anonymize=false, $a_format_seconds=false)
const TYPE_GRID
global $lng
Definition: privfeed.php:40
static getInstanceByType($a_type, $a_id)
Get type instance.
+ Here is the call graph for this function:

◆ getItems()

ilLPObjectStatisticsTableGUI::getItems ( )

Definition at line 133 of file class.ilLPObjectStatisticsTableGUI.php.

References ilTableGUI\$data, ilObject\_lookupTitle(), ilLPTableBaseGUI\getCurrentFilter(), ilTrQuery\getObjectAccessStatistics(), ilLPTableBaseGUI\searchObjects(), and ilTable2GUI\setData().

Referenced by __construct().

134  {
135  $data = array();
136 
137  $objects = $this->searchObjects($this->getCurrentFilter(true), "read");
138  if($objects)
139  {
140  include_once "Services/Tracking/classes/class.ilTrQuery.php";
141 
142  $yearmonth = explode("-", $this->filter["yearmonth"]);
143  if(sizeof($yearmonth) == 1)
144  {
145  foreach(ilTrQuery::getObjectAccessStatistics($objects, $yearmonth[0]) as $obj_id => $months)
146  {
147  $data[$obj_id]["obj_id"] = $obj_id;
148  $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
149 
150  foreach($months as $month => $values)
151  {
152  $idx = $yearmonth[0]."-".str_pad($month, 2, "0", STR_PAD_LEFT);
153  $data[$obj_id]["month_".$idx] = (int)$values[$this->filter["measure"]];
154  $data[$obj_id]["total"] += (int)$values[$this->filter["measure"]];
155  }
156  }
157  }
158  else
159  {
160  foreach(ilTrQuery::getObjectAccessStatistics($objects, $yearmonth[0], (int)$yearmonth[1]) as $obj_id => $days)
161  {
162  $data[$obj_id]["obj_id"] = $obj_id;
163  $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
164 
165  foreach($days as $day => $values)
166  {
167  $data[$obj_id]["day_".$day] = (int)$values[$this->filter["measure"]];
168  $data[$obj_id]["total"] += (int)$values[$this->filter["measure"]];
169  }
170  }
171  }
172 
173  // add objects with no usage data
174  foreach(array_keys($objects) as $obj_id)
175  {
176  if(!isset($data[$obj_id]))
177  {
178  $data[$obj_id]["obj_id"] = $obj_id;
179  $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
180  }
181  }
182  }
183 
184  $this->setData($data);
185  }
static _lookupTitle($a_id)
lookup object title
static getObjectAccessStatistics(array $a_ref_ids, $a_year, $a_month=null)
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()

ilLPObjectStatisticsTableGUI::initFilter ( )

Init filter.

Definition at line 81 of file class.ilLPObjectStatisticsTableGUI.php.

References $lng, $si, ilTable2GUI\addFilterItem(), ilLPTableBaseGUI\getMonthsFilter(), ilLPTableBaseGUI\getPossibleTypes(), ilTable2GUI\setDisableFilterHiding(), and ilTextInputGUI\setMaxLength().

Referenced by __construct().

82  {
83  global $lng;
84 
85  $this->setDisableFilterHiding(true);
86 
87  // object type selection
88  include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
89  $si = new ilSelectInputGUI($lng->txt("obj_type"), "type");
90  $si->setOptions($this->getPossibleTypes(true, false, true));
91  $this->addFilterItem($si);
92  $si->readFromSession();
93  if(!$si->getValue())
94  {
95  $si->setValue("crs");
96  }
97  $this->filter["type"] = $si->getValue();
98 
99  // title/description
100  include_once("./Services/Form/classes/class.ilTextInputGUI.php");
101  $ti = new ilTextInputGUI($lng->txt("trac_title_description"), "query");
102  $ti->setMaxLength(64);
103  $ti->setSize(20);
104  $this->addFilterItem($ti);
105  $ti->readFromSession();
106  $this->filter["query"] = $ti->getValue();
107 
108  // read_count/spent_seconds
109  $si = new ilSelectInputGUI($lng->txt("trac_figure"), "figure");
110  $si->setOptions(array("read_count"=>$lng->txt("trac_read_count"),
111  "spent_seconds"=>$lng->txt("trac_spent_seconds"),
112  "users"=>$lng->txt("users")));
113  $this->addFilterItem($si);
114  $si->readFromSession();
115  if(!$si->getValue())
116  {
117  $si->setValue("read_count");
118  }
119  $this->filter["measure"] = $si->getValue();
120 
121  // year/month
122  $si = new ilSelectInputGUI($lng->txt("year")." / ".$lng->txt("month"), "yearmonth");
123  $si->setOptions($this->getMonthsFilter());
124  $this->addFilterItem($si);
125  $si->readFromSession();
126  if(!$si->getValue())
127  {
128  $si->setValue(date("Y-m"));
129  }
130  $this->filter["yearmonth"] = $si->getValue();
131  }
This class represents a selection list property in a property form.
addFilterItem($a_input_item, $a_optional=false)
Add filter item.
getPossibleTypes($a_split_learning_resources=false, $a_include_digilib=false, $a_allow_undefined_lp=false)
Get possible subtypes.
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:

◆ numericOrdering()

ilLPObjectStatisticsTableGUI::numericOrdering (   $a_field)

Definition at line 69 of file class.ilLPObjectStatisticsTableGUI.php.

70  {
71  if($a_field != "title")
72  {
73  return true;
74  }
75  return false;
76  }

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