ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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)
 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="")
 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...
 
 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)
 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)
 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 (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
 ilTableGUI ($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

 fillRow ($a_set)
 Fill table row. More...
 
 fillMetaExcel ()
 
 fillRowExcel ($a_worksheet, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ()
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 
- 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 ($worksheet, &$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)
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. 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 ($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
 
 $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
 
 $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$

@ilCtrl_Calls 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.

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 }
getMonthsYear($a_year=null, $a_short=false)
setEnableHeader($a_enableheader)
Set Enable Header.
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.
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
setExportFormats(array $formats)
Set available export formats.
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.
addMultiCommand($a_cmd, $a_text)
Add Command button.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
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.
global $ilCtrl
Definition: ilias.php:18
global $lng
Definition: privfeed.php:40

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().

+ Here is the call graph for this function:

Member Function Documentation

◆ fillMetaCSV()

ilLPObjectStatisticsTableGUI::fillMetaCSV ( )
protected

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

356 {
357
358 }

◆ fillMetaExcel()

ilLPObjectStatisticsTableGUI::fillMetaExcel ( )
protected

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

316 {
317
318 }

◆ fillRow()

ilLPObjectStatisticsTableGUI::fillRow (   $a_set)
protected

Fill table row.

Reimplemented from ilTable2GUI.

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

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

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

+ Here is the call graph for this function:

◆ fillRowCSV()

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

CSV Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
object$a_csvcurrent file
array$a_setdata array

Reimplemented from ilTable2GUI.

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

361 {
362 $a_csv->addColumn(ilObject::_lookupTitle($a_set["obj_id"]));
363 $a_csv->addColumn($a_set["obj_id"]);
364
365 if(strpos($this->filter["yearmonth"], "-") === false)
366 {
367 foreach(array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $num)
368 {
369 $value = (int)$a_set["month_".$num];
370 if($this->filter["measure"] != "spent_seconds")
371 {
372 $value = $this->anonymizeValue($value);
373 }
374
375 $a_csv->addColumn($value);
376 }
377 }
378
379 if($this->filter["measure"] == "spent_seconds")
380 {
381 // keep seconds
382 // $sum = $this->formatSeconds((int)$a_set["total"]);
383 $sum = (int)$a_set["total"];
384 }
385 else
386 {
387 $sum = $this->anonymizeValue((int)$a_set["total"]);
388 }
389 $a_csv->addColumn($sum);
390
391 $a_csv->addRow();
392 }
static _lookupTitle($a_id)
lookup object title

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

+ Here is the call graph for this function:

◆ fillRowExcel()

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

Excel Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
object$a_worksheetcurrent sheet
int$a_rowrow counter
array$a_setdata array

Reimplemented from ilTable2GUI.

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

321 {
322 $a_worksheet->write($a_row, 0, ilObject::_lookupTitle($a_set["obj_id"]));
323 $a_worksheet->write($a_row, 1, $a_set["obj_id"]);
324
325 $col = 1;
326 if(strpos($this->filter["yearmonth"], "-") === false)
327 {
328 foreach(array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $num)
329 {
330 $value = (int)$a_set["month_".$num];
331 if($this->filter["measure"] != "spent_seconds")
332 {
333 $value = $this->anonymizeValue($value);
334 }
335
336 $col++;
337 $a_worksheet->write($a_row, $col, $value);
338 }
339 }
340
341 if($this->filter["measure"] == "spent_seconds")
342 {
343 // keep seconds
344 // $sum = $this->formatSeconds((int)$a_set["total"]);
345 $sum = (int)$a_set["total"];
346 }
347 else
348 {
349 $sum = $this->anonymizeValue((int)$a_set["total"]);
350 }
351 $col++;
352 $a_worksheet->write($a_row, $col, $sum);
353 }

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

+ Here is the call graph for this function:

◆ getGraph()

ilLPObjectStatisticsTableGUI::getGraph ( array  $a_graph_items)

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

243 {
244 global $lng;
245
246 include_once "Services/Chart/classes/class.ilChart.php";
248 $chart->setSize(700, 500);
249
250 $legend = new ilChartLegend();
251 $chart->setLegend($legend);
252
253 $max_value = 0;
254 foreach($this->getData() as $object)
255 {
256 if(in_array($object["obj_id"], $a_graph_items))
257 {
258 $series = $chart->getDataInstance(ilChartGrid::DATA_LINES);
259 $series->setLabel(ilObject::_lookupTitle($object["obj_id"]));
260
261 if(strpos($this->filter["yearmonth"], "-") === false)
262 {
263 foreach(array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $idx => $num)
264 {
265 $value = (int)$object["month_".$num];
266 $max_value = max($max_value, $value);
267 if($this->filter["measure"] != "spent_seconds")
268 {
269 $value = $this->anonymizeValue($value, true);
270 }
271 $series->addPoint($idx, $value);
272 }
273 }
274 else
275 {
276 for($loop = 1; $loop<32; $loop++)
277 {
278 $value = (int)$object["day_".$loop];
279 $max_value = max($max_value, $value);
280 if($this->filter["measure"] != "spent_seconds")
281 {
282 $value = $this->anonymizeValue($value, true);
283 }
284 $series->addPoint($loop, $value);
285 }
286 }
287
288 $chart->addData($series);
289 }
290 }
291
292 $value_ticks = $this->buildValueScale($max_value, ($this->filter["measure"] != "spent_seconds"),
293 ($this->filter["measure"] == "spent_seconds"));
294
295 $labels = array();
296 if(strpos($this->filter["yearmonth"], "-") === false)
297 {
298 foreach(array_values($this->getMonthsYear($this->filter["yearmonth"], true)) as $idx => $caption)
299 {
300 $labels[$idx] = $caption;
301 }
302 }
303 else
304 {
305 for($loop = 1; $loop<32; $loop++)
306 {
307 $labels[$loop] = $loop.".";
308 }
309 }
310 $chart->setTicks($labels, $value_ticks, true);
311
312 return $chart->getHTML();
313 }
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 $legend, $lng, ilObject\_lookupTitle(), ilLPTableBaseGUI\anonymizeValue(), ilLPTableBaseGUI\buildValueScale(), ilChartGrid\DATA_LINES, ilTable2GUI\getData(), ilChart\getInstanceByType(), ilLPTableBaseGUI\getMonthsYear(), and ilChart\TYPE_GRID.

+ Here is the call graph for this function:

◆ getItems()

ilLPObjectStatisticsTableGUI::getItems ( )

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

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

References ilTableGUI\$data, ilObject\_lookupTitle(), ilLPTableBaseGUI\getCurrentFilter(), ilTrQuery\getObjectAccessStatistics(), 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()

ilLPObjectStatisticsTableGUI::initFilter ( )

Init filter.

Reimplemented from ilTable2GUI.

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

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 }
getMonthsFilter($a_short=false)
getPossibleTypes($a_split_learning_resources=false, $a_include_digilib=false, $a_allow_undefined_lp=false)
Get possible subtypes.
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 $lng, $si, ilTable2GUI\addFilterItem(), ilLPTableBaseGUI\getMonthsFilter(), ilLPTableBaseGUI\getPossibleTypes(), and ilTable2GUI\setDisableFilterHiding().

Referenced by __construct().

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

◆ numericOrdering()

ilLPObjectStatisticsTableGUI::numericOrdering (   $a_field)

Should this field be sorted numeric?

Returns
boolean numeric ordering; default is false

Reimplemented from ilTable2GUI.

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: