ILIAS  release_7 Revision v7.30-3-g800a261c036
ilLPObjectStatisticsLPTableGUI Class Reference

TableGUI class for learning progress. More...

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

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, array $a_preselect=null, $a_load_items=true, $a_is_chart=false, $a_is_details=false)
 Constructor. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 initFilter ()
 Init filter. More...
 
 getItems ()
 
 getGraph (array $a_graph_items)
 
- Public Member Functions inherited from ilLPTableBaseGUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 ilTable2GUI constructor. More...
 
 executeCommand ()
 Execute command. More...
 
 searchFilterListener ($a_ref_id, $a_data)
 Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED @access public. More...
 
 initBaseFilter ($a_split_learning_resources=false, $a_include_no_status_filter=true)
 Init filter. More...
 
 getCurrentFilter ($as_query=false)
 
 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

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

Protected Attributes

 $types = array("min", "avg", "max")
 
 $status
 
 $is_chart = false
 
 $is_details = false
 
 $chart_data = array()
 
- Protected Attributes inherited from ilLPTableBaseGUI
 $filter
 
 $anonymized
 
 $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
 

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
 

Detailed Description

TableGUI class for learning progress.

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

@ilCtrl_Calls ilLPObjectStatisticsLPTableGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

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

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

References $DIC, ilTableGUI\$icon, ilTableGUI\$lng, $status, $type, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), filter(), getDetailItems(), ilLPStatusIcons\getInstance(), getItems(), ilLPTableBaseGUI\getMonthsYear(), ilLPStatusIcons\ICON_VARIANT_SHORT, initFilter(), initLearningProgressDetailsLayer(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTitle().

+ Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilLPObjectStatisticsLPTableGUI::fillRow (   $a_set)
protected

Fill table row.

Reimplemented from ilTable2GUI.

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

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

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

+ Here is the call graph for this function:

◆ getDetailItems()

ilLPObjectStatisticsLPTableGUI::getDetailItems (   $a_obj_id)
protected

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

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

References ilTableGUI\$data, ilTableGUI\$icon, $status, $type, ilLearningProgressBaseGUI\_getStatusText(), filter(), ilLPStatusIcons\getInstance(), ilTrQuery\getObjectLPStatistics(), ilLPStatusIcons\ICON_VARIANT_LONG, and ilTable2GUI\setData().

Referenced by __construct().

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

◆ getGraph()

ilLPObjectStatisticsLPTableGUI::getGraph ( array  $a_graph_items)

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

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

+ Here is the call graph for this function:

◆ getItems()

ilLPObjectStatisticsLPTableGUI::getItems ( )

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

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

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

Referenced by __construct().

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

◆ initFilter()

ilLPObjectStatisticsLPTableGUI::initFilter ( )

Init filter.

Reimplemented from ilTable2GUI.

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

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

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

Referenced by __construct().

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

◆ initLearningProgressDetailsLayer()

ilLPObjectStatisticsLPTableGUI::initLearningProgressDetailsLayer ( )
protected

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

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

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

Referenced by __construct().

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

◆ initRow()

ilLPObjectStatisticsLPTableGUI::initRow ( $a_row)
protected

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

348 {
349 foreach ($this->types as $type) {
350 $a_row["mem_cnt_" . $type] = null;
351 }
352 foreach ($this->status as $status) {
353 foreach ($this->types as $type) {
354 $a_row[$status . "_" . $type] = null;
355 }
356 }
357 }

References $status, and $type.

Referenced by getItems().

+ Here is the caller graph for this function:

◆ numericOrdering()

ilLPObjectStatisticsLPTableGUI::numericOrdering (   $a_field)

Should this field be sorted numeric?

Returns
boolean numeric ordering; default is false

Reimplemented from ilTable2GUI.

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

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

Field Documentation

◆ $chart_data

ilLPObjectStatisticsLPTableGUI::$chart_data = array()
protected

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

◆ $is_chart

ilLPObjectStatisticsLPTableGUI::$is_chart = false
protected

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

◆ $is_details

ilLPObjectStatisticsLPTableGUI::$is_details = false
protected

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

◆ $status

◆ $types

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

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


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