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

Protected Member Functions

 fillRow ($a_set)
 Fill table row. More...
 
 fillMetaExcel (ilExcel $a_excel, &$a_row)
 Add meta information to excel export. More...
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 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 (ilExcel $a_excel, &$a_row)
 Add meta information to excel export. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 showTimingsWarning ($a_ref_id, $a_user_id)
 
 formatSeconds ($seconds, $a_shorten_zero=false)
 
 anonymizeValue ($a_value, $a_force_number=false)
 
 buildValueScale ($a_max_value, $a_anonymize=false, $a_format_seconds=false)
 
 getMonthsFilter ($a_short=false)
 
 getMonthsYear ($a_year=null, $a_short=false)
 
 getSelectableUserColumns ($a_in_course=false, $a_in_group=false)
 
 addToClipboard ()
 Add selected users to clipboard. More...
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 isFilterVisible ()
 Check if filter is visible: manually shown (session, db) or default value set. More...
 
 isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel (ilExcel $a_excel, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel (ilExcel $a_excel, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

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 ilLPTableBaseGUI
const HIT_LIMIT = 5000
 
- Data Fields inherited from ilTable2GUI
const FILTER_TEXT = 1
 
const FILTER_SELECT = 2
 
const FILTER_DATE = 3
 
const FILTER_LANGUAGE = 4
 
const FILTER_NUMBER_RANGE = 5
 
const FILTER_DATE_RANGE = 6
 
const FILTER_DURATION_RANGE = 7
 
const FILTER_DATETIME_RANGE = 8
 
const FILTER_CHECKBOX = 9
 
const EXPORT_EXCEL = 1
 
const EXPORT_CSV = 2
 
const ACTION_ALL_LIMIT = 1000
 
- Data Fields inherited from ilTableGUI
 $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
 
 $icon_variant = ilLPStatusIcons::ICON_VARIANT_LONG
 
- Protected Attributes inherited from ilTable2GUI
 $ctrl
 
 $tpl
 
 $parent_obj
 
 $parent_cmd
 
 $close_command = ""
 
 $top_anchor = "il_table_top"
 
 $filters = array()
 
 $optional_filters = array()
 
 $filter_cmd = 'applyFilter'
 
 $reset_cmd = 'resetFilter'
 
 $filter_cols = 5
 
 $ext_sort = false
 
 $ext_seg = false
 
 $context = ""
 
 $mi_sel_buttons = []
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $rows_selector_off = false
 
 $nav_determined = false
 
 $limit_determined = false
 
 $filters_determined = false
 
 $columns_determined = false
 
 $open_form_tag = true
 
 $close_form_tag = true
 
 $export_formats = []
 
 $export_mode
 
 $print_mode
 
 $enable_command_for_all
 
 $restore_filter
 
 $restore_filter_values
 
 $default_filter_visibility = false
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 
 $select_all_on_top = false
 
 $sel_buttons = []
 
- Protected Attributes inherited from ilTableGUI
 $tpl
 
 $lng
 

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 $DIC;
23
24 $ilCtrl = $DIC['ilCtrl'];
25 $lng = $DIC['lng'];
26
27 $this->preselected = $a_preselect;
28
29 $this->setId("lpobjstattbl");
30
31 parent::__construct($a_parent_obj, $a_parent_cmd);
32
33 $this->setShowRowsSelector(true);
34 // $this->setLimit(ilSearchSettings::getInstance()->getMaxHits());
35 $this->initFilter();
36
37 $this->addColumn("", "", "1", true);
38 $this->addColumn($lng->txt("trac_title"), "title");
39 $this->addColumn($lng->txt("object_id"), "obj_id");
40 if (strpos($this->filter["yearmonth"], "-") === false) {
41 foreach ($this->getMonthsYear($this->filter["yearmonth"]) as $num => $caption) {
42 $this->addColumn($caption, "month_" . $num);
43 }
44 }
45 $this->addColumn($lng->txt("total"), "total");
46
47 $this->setTitle($this->lng->txt("trac_object_stat_access"));
48
49 // $this->setSelectAllCheckbox("item_id");
50 $this->addMultiCommand("showAccessGraph", $lng->txt("trac_show_graph"));
51 $this->setResetCommand("resetAccessFilter");
52 $this->setFilterCommand("applyAccessFilter");
53
54 $this->setFormAction($ilCtrl->getFormAction($a_parent_obj, $a_parent_cmd));
55 $this->setRowTemplate("tpl.lp_object_statistics_row.html", "Services/Tracking");
56 $this->setEnableHeader(true);
57 $this->setEnableNumInfo(true);
58 $this->setEnableTitle(true);
59 $this->setDefaultOrderField("title");
60 $this->setDefaultOrderDirection("asc");
61
62 $this->setExportFormats(array(self::EXPORT_EXCEL, self::EXPORT_CSV));
63
64 if ($a_load_items) {
65 $this->getItems();
66 }
67 }
getMonthsYear($a_year=null, $a_short=false)
setEnableHeader($a_enableheader)
Set Enable 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.
addColumn( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
setId($a_val)
Set id.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
setFilterCommand($a_val, $a_caption=null)
Set filter command.
filter()
Definition: filter.php:2
global $DIC
Definition: goto.php:24
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc

References $DIC, ilTableGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), filter(), 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 (   $a_csv)
protected

Add meta information to csv export.

Likely to be overwritten by derived class.

Parameters
object$a_csvcurrent file

Reimplemented from ilLPTableBaseGUI.

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

331 {
332 }

◆ fillMetaExcel()

ilLPObjectStatisticsTableGUI::fillMetaExcel ( ilExcel  $a_excel,
$a_row 
)
protected

Add meta information to excel export.

Likely to be overwritten by derived class.

Parameters
ilExcel$a_excelexcel wrapper
int$a_rowrow counter

Reimplemented from ilLPTableBaseGUI.

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

300 {
301 }

◆ fillRow()

ilLPObjectStatisticsTableGUI::fillRow (   $a_set)
protected

Fill table row.

Reimplemented from ilTable2GUI.

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

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

References $DIC, $type, ilObject\_getIcon(), ilObject\_lookupType(), ilLPTableBaseGUI\anonymizeValue(), filter(), 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 334 of file class.ilLPObjectStatisticsTableGUI.php.

335 {
336 $a_csv->addColumn(ilObject::_lookupTitle($a_set["obj_id"]));
337 $a_csv->addColumn($a_set["obj_id"]);
338
339 if (strpos($this->filter["yearmonth"], "-") === false) {
340 foreach (array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $num) {
341 $value = (int) $a_set["month_" . $num];
342 if ($this->filter["measure"] != "spent_seconds") {
343 $value = $this->anonymizeValue($value);
344 }
345
346 $a_csv->addColumn($value);
347 }
348 }
349
350 if ($this->filter["measure"] == "spent_seconds") {
351 // keep seconds
352 // $sum = $this->formatSeconds((int)$a_set["total"]);
353 $sum = (int) $a_set["total"];
354 } else {
355 $sum = $this->anonymizeValue((int) $a_set["total"]);
356 }
357 $a_csv->addColumn($sum);
358
359 $a_csv->addRow();
360 }
static _lookupTitle($a_id)
lookup object title

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

+ Here is the call graph for this function:

◆ fillRowExcel()

ilLPObjectStatisticsTableGUI::fillRowExcel ( ilExcel  $a_excel,
$a_row,
  $a_set 
)
protected

Excel Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
ilExcel$a_excelexcel wrapper
int$a_rowrow counter
array$a_setdata array

Reimplemented from ilTable2GUI.

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

304 {
305 $a_excel->setCell($a_row, 0, ilObject::_lookupTitle($a_set["obj_id"]));
306 $a_excel->setCell($a_row, 1, $a_set["obj_id"]);
307
308 $col = 1;
309 if (strpos($this->filter["yearmonth"], "-") === false) {
310 foreach (array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $num) {
311 $value = (int) $a_set["month_" . $num];
312 if ($this->filter["measure"] != "spent_seconds") {
313 $value = $this->anonymizeValue($value);
314 }
315
316 $a_excel->setCell($a_row, ++$col, $value);
317 }
318 }
319
320 if ($this->filter["measure"] == "spent_seconds") {
321 // keep seconds
322 // $sum = $this->formatSeconds((int)$a_set["total"]);
323 $sum = (int) $a_set["total"];
324 } else {
325 $sum = $this->anonymizeValue((int) $a_set["total"]);
326 }
327 $a_excel->setCell($a_row, ++$col, $sum);
328 }
setCell($a_row, $a_col, $a_value, $a_datatype=null)
Set cell value.

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

+ Here is the call graph for this function:

◆ getGraph()

ilLPObjectStatisticsTableGUI::getGraph ( array  $a_graph_items)

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

236 {
237 global $DIC;
238
239 $lng = $DIC['lng'];
240
241 include_once "Services/Chart/classes/class.ilChart.php";
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 if (in_array($object["obj_id"], $a_graph_items)) {
251 $series = $chart->getDataInstance(ilChartGrid::DATA_LINES);
252 $series->setLabel(ilObject::_lookupTitle($object["obj_id"]));
253
254 if (strpos($this->filter["yearmonth"], "-") === false) {
255 foreach (array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $idx => $num) {
256 $value = (int) $object["month_" . $num];
257 $max_value = max($max_value, $value);
258 if ($this->filter["measure"] != "spent_seconds") {
259 $value = $this->anonymizeValue($value, true);
260 }
261 $series->addPoint($idx, $value);
262 }
263 } else {
264 for ($loop = 1; $loop < 32; $loop++) {
265 $value = (int) $object["day_" . $loop];
266 $max_value = max($max_value, $value);
267 if ($this->filter["measure"] != "spent_seconds") {
268 $value = $this->anonymizeValue($value, true);
269 }
270 $series->addPoint($loop, $value);
271 }
272 }
273
274 $chart->addData($series);
275 }
276 }
277
278 $value_ticks = $this->buildValueScale(
279 $max_value,
280 ($this->filter["measure"] != "spent_seconds"),
281 ($this->filter["measure"] == "spent_seconds")
282 );
283
284 $labels = array();
285 if (strpos($this->filter["yearmonth"], "-") === false) {
286 foreach (array_values($this->getMonthsYear($this->filter["yearmonth"], true)) as $idx => $caption) {
287 $labels[$idx] = $caption;
288 }
289 } else {
290 for ($loop = 1; $loop < 32; $loop++) {
291 $labels[$loop] = $loop . ".";
292 }
293 }
294 $chart->setTicks($labels, $value_ticks, true);
295
296 return $chart->getHTML();
297 }
static getInstanceByType($a_type, $a_id)
Get type instance.
const TYPE_GRID
buildValueScale($a_max_value, $a_anonymize=false, $a_format_seconds=false)

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

+ Here is the call graph for this function:

◆ getItems()

ilLPObjectStatisticsTableGUI::getItems ( )

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

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

References ilTableGUI\$data, ilObject\_lookupTitle(), filter(), ilLPTableBaseGUI\getCurrentFilter(), ilTrQuery\getObjectAccessStatistics(), ilTrQuery\getPortfolios(), ilTrQuery\getWorkspaceBlogs(), 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 80 of file class.ilLPObjectStatisticsTableGUI.php.

81 {
82 global $DIC;
83
84 $lng = $DIC['lng'];
85
86 $this->setDisableFilterHiding(true);
87
88 // object type selection
89 include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
90 $si = new ilSelectInputGUI($lng->txt("obj_type"), "type");
91 $si->setOptions($this->getPossibleTypes(true, false, true));
92 $this->addFilterItem($si);
93 $si->readFromSession();
94 if (!$si->getValue()) {
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 $si->setValue("read_count");
117 }
118 $this->filter["measure"] = $si->getValue();
119
120 // year/month
121 $si = new ilSelectInputGUI($lng->txt("year") . " / " . $lng->txt("month"), "yearmonth");
122 $si->setOptions($this->getMonthsFilter());
123 $this->addFilterItem($si);
124 $si->readFromSession();
125 if (!$si->getValue()) {
126 $si->setValue(date("Y-m"));
127 }
128 $this->filter["yearmonth"] = $si->getValue();
129 }
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 $DIC, ilTableGUI\$lng, $si, ilTable2GUI\addFilterItem(), filter(), 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 return true;
73 }
74 return false;
75 }

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