ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilLPProgressTableGUI Class Reference

TableGUI class for learning progress. More...

+ Inheritance diagram for ilLPProgressTableGUI:
+ Collaboration diagram for ilLPProgressTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $a_user="", $obj_ids=null, $details=false, $mode=null, $personal_only=false, $a_parent_id=null, $a_parent_ref_id=null, $lp_context=null)
 Constructor. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 getItems ()
 
- 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)
 
- 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)
 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...
 
 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...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. 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 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
 
- 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
 
 $sel_buttons = []
 
- Protected Attributes inherited from ilTableGUI
 $tpl
 
 $lng
 

Detailed Description

TableGUI class for learning progress.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

@ilCtrl_Calls ilLPProgressTableGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilLPProgressTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $a_user = "",
  $obj_ids = null,
  $details = false,
  $mode = null,
  $personal_only = false,
  $a_parent_id = null,
  $a_parent_ref_id = null,
  $lp_context = null 
)

Constructor.

Definition at line 21 of file class.ilLPProgressTableGUI.php.

22 {
23 global $ilCtrl, $lng, $ilUser;
24
25 $this->tracked_user = $a_user;
26 $this->obj_ids = $obj_ids;
27 $this->details = $details;
28 $this->mode = $mode;
29 $this->parent_obj_id = $a_parent_id;
30 $this->lp_context = $lp_context;
31
32 if ($a_parent_id) {
33 // #15042 - needed for export meta
34 $this->obj_id = $this->parent_obj_id;
35 $this->ref_id = $a_parent_ref_id;
36 }
37
38 $this->setId("lpprgtbl");
39
40 parent::__construct($a_parent_obj, $a_parent_cmd);
41
42 $this->setLimit(9999);
43
44 if (!$this->details) {
45 $this->has_object_subitems = true;
46
47 $user = $this->tracked_user;
48 if (!$user) {
49 $user = $ilUser;
50 }
51
52 $this->addColumn("", "", "1", true);
53 $this->addColumn($this->lng->txt("trac_title"), "title", "26%");
54 $this->addColumn($this->lng->txt("status"), "status", "7%");
55 $this->addColumn($this->lng->txt('trac_status_changed'), 'status_changed', '10%');
56 $this->addColumn($this->lng->txt("trac_percentage"), "percentage", "7%");
57 $this->addColumn($this->lng->txt("trac_mark"), "", "5%");
58 $this->addColumn($this->lng->txt("comment"), "", "10%");
59 $this->addColumn($this->lng->txt("trac_mode"), "", "20%");
60 $this->addColumn($this->lng->txt("path"), "", "20%");
61 $this->addColumn($this->lng->txt("actions"), "", "5%");
62
63 $this->setTitle(sprintf($this->lng->txt("trac_learning_progress_of"), $user->getFullName()));
64 $this->initBaseFilter();
65
66 $this->setSelectAllCheckbox("item_id");
67 $this->addMultiCommand("hideSelected", $lng->txt("trac_hide_selected"));
68
69 $this->setShowTemplates(true);
70 } else {
71 include_once './Services/Object/classes/class.ilObjectLP.php';
72 $olp = ilObjectLP::getInstance($this->parent_obj_id);
73 $collection = $olp->getCollectionInstance();
74 $this->has_object_subitems = ($collection instanceof ilLPCollectionOfRepositoryObjects);
75
76 /*
77 if(!$personal_only)
78 {
79 $this->parseTitle($a_parent_obj->details_obj_id, "trac_subitems");
80 }
81 else
82 {
83 $this->parseTitle($a_parent_obj->details_obj_id, "trac_progress");
84 }
85 */
86 $this->setTitle($this->lng->txt("details")); // #15247
87
88 $this->addColumn($this->lng->txt("trac_title"), "title", "31%");
89 $this->addColumn($this->lng->txt("status"), "status", "7%");
90
91 if ($this->mode == ilLPObjSettings::LP_MODE_SCORM) {
92 $this->lng->loadLanguageModule('content');
93 $this->addColumn($this->lng->txt('cont_score'), 'score', '10%');
94 } elseif ($this->has_object_subitems) {
95 $this->addColumn($this->lng->txt('trac_status_changed'), 'status_changed', '10%');
96 $this->addColumn($this->lng->txt("trac_percentage"), "percentage", "7%");
97 $this->addColumn($this->lng->txt("trac_mark"), "", "5%");
98 $this->addColumn($this->lng->txt("comment"), "", "10%");
99 $this->addColumn($this->lng->txt("trac_mode"), "", "20%");
100 $this->addColumn($this->lng->txt("path"), "", "20%");
101 }
102 }
103
104 $this->setEnableHeader(true);
105 $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
106 $this->setRowTemplate("tpl.lp_progress_list_row.html", "Services/Tracking");
107 $this->setEnableHeader(true);
108 $this->setEnableNumInfo(false);
109 $this->setEnableTitle(true);
110 $this->setDefaultOrderField("title");
111 $this->setDefaultOrderDirection("asc");
112
113 if ($this->has_object_subitems) {
114 $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
115 }
116
117 // area selector gets in the way
118 if ($this->tracked_user) {
119 $this->getItems();
120 }
121 }
sprintf('%.4f', $callTime)
initBaseFilter($a_split_learning_resources=false, $a_include_no_status_filter=true)
Init filter.
static getInstance($a_obj_id)
setEnableHeader($a_enableheader)
Set Enable Header.
setExportFormats(array $formats)
Set available export formats.
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
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.
setSelectAllCheckbox($a_select_all_checkbox)
Set the name of the checkbox that should be toggled with a select all button.
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.
setShowTemplates($a_value)
Toggle templates.
global $ilCtrl
Definition: ilias.php:18
$ilUser
Definition: imgupload.php:18

References $ilCtrl, $ilUser, ilTableGUI\$lng, ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ilObjectLP\getInstance(), getItems(), ilLPTableBaseGUI\initBaseFilter(), ilLPObjSettings\LP_MODE_SCORM, ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setShowTemplates(), ilTable2GUI\setTitle(), and sprintf.

+ Here is the call graph for this function:

Member Function Documentation

◆ fillHeaderCSV()

ilLPProgressTableGUI::fillHeaderCSV (   $a_csv)
protected

CSV Version of Fill Header.

Likely to be overwritten by derived class.

Parameters
object$a_csvcurrent file

Reimplemented from ilTable2GUI.

Definition at line 327 of file class.ilLPProgressTableGUI.php.

328 {
329 $a_csv->addColumn($this->lng->txt("type"));
330 $a_csv->addColumn($this->lng->txt("trac_title"));
331 $a_csv->addColumn($this->lng->txt("status"));
332 $a_csv->addColumn($this->lng->txt("trac_status_changed"));
333 $a_csv->addColumn($this->lng->txt("trac_percentage"));
334 $a_csv->addColumn($this->lng->txt("trac_mark"));
335 $a_csv->addColumn($this->lng->txt("comment"));
336 $a_csv->addColumn($this->lng->txt("trac_mode"));
337 // $a_csv->addColumn($this->lng->txt("path"));
338 $a_csv->addRow();
339 }

◆ fillHeaderExcel()

ilLPProgressTableGUI::fillHeaderExcel ( ilExcel  $a_excel,
$a_row 
)
protected

Excel Version of Fill Header.

Likely to be overwritten by derived class.

Parameters
ilExcel$a_excelexcel wrapper
int$a_rowrow counter

Reimplemented from ilTable2GUI.

Definition at line 294 of file class.ilLPProgressTableGUI.php.

295 {
296 $a_excel->setCell($a_row, 0, $this->lng->txt("type"));
297 $a_excel->setCell($a_row, 1, $this->lng->txt("trac_title"));
298 $a_excel->setCell($a_row, 2, $this->lng->txt("status"));
299 $a_excel->setCell($a_row, 3, $this->lng->txt("trac_status_changed"));
300 $a_excel->setCell($a_row, 4, $this->lng->txt("trac_percentage"));
301 $a_excel->setCell($a_row, 5, $this->lng->txt("trac_mark"));
302 $a_excel->setCell($a_row, 6, $this->lng->txt("comment"));
303 $a_excel->setCell($a_row, 7, $this->lng->txt("trac_mode"));
304 // $a_excel->setCell($a_row, 7, $this->lng->txt("path"));
305
306 $a_excel->setBold("A" . $a_row . ":H" . $a_row);
307 }
setCell($a_row, $a_col, $a_value, $a_datatype=null)
Set cell value.
setBold($a_coords)
Set cell(s) to bold.

References ilExcel\setBold(), and ilExcel\setCell().

+ Here is the call graph for this function:

◆ fillRow()

ilLPProgressTableGUI::fillRow (   $a_set)
protected

Fill table row.

Reimplemented from ilTable2GUI.

Definition at line 194 of file class.ilLPProgressTableGUI.php.

195 {
196 global $ilCtrl;
197
198 if (!$this->details) {
199 $this->tpl->setCurrentBlock("column_checkbox");
200 $this->tpl->setVariable("OBJ_ID", $a_set["obj_id"]);
201 $this->tpl->parseCurrentBlock();
202 }
203
204 $this->tpl->setVariable("ICON_SRC", ilObject::_getIcon("", "tiny", $a_set["type"]));
205 $this->tpl->setVariable("ICON_ALT", $this->lng->txt($a_set["type"]));
206 $this->tpl->setVariable("TITLE_TEXT", $a_set["title"]);
207
208 if ($a_set["offline"]) {
209 $this->tpl->setCurrentBlock("offline");
210 $this->tpl->setVariable("TEXT_STATUS", $this->lng->txt("status"));
211 $this->tpl->setVariable("TEXT_OFFLINE", $this->lng->txt("offline"));
212 $this->tpl->parseCurrentBlock();
213 }
214
215 $this->tpl->setVariable("STATUS_ALT", ilLearningProgressBaseGUI::_getStatusText($a_set["status"]));
216 $this->tpl->setVariable("STATUS_IMG", ilLearningProgressBaseGUI::_getImagePathForStatus($a_set["status"]));
217
218 if ($this->mode == ilLPObjSettings::LP_MODE_SCORM) {
219 $this->tpl->setVariable('SCORE_VAL', $a_set["score"]);
220 } elseif ($this->has_object_subitems) {
221 $this->tpl->setCurrentBlock("status_details");
222
223 $this->tpl->setVariable('STATUS_CHANGED_VAL', ilDatePresentation::formatDate(new ilDateTime($a_set['status_changed'], IL_CAL_DATETIME)));
224
225 $olp = ilObjectLP::getInstance($a_set["obj_id"]);
226 $this->tpl->setVariable("MODE_TEXT", $olp->getModeText($a_set["u_mode"]));
227 $this->tpl->setVariable("MARK_VALUE", $a_set["mark"]);
228 $this->tpl->setVariable("COMMENT_TEXT", $a_set["comment"]);
229
230 if ($a_set["percentage"] < 0) {
231 $this->tpl->setVariable("PERCENTAGE_VALUE", "");
232 } else {
233 $this->tpl->setVariable("PERCENTAGE_VALUE", sprintf("%d%%", $a_set["percentage"]));
234 }
235
236 // path
237 $path = $this->buildPath($a_set["ref_ids"]);
238 if ($path) {
239 $this->tpl->setCurrentBlock("item_path");
240 foreach ($path as $path_item) {
241 $this->tpl->setVariable("PATH_ITEM", $path_item);
242 $this->tpl->parseCurrentBlock();
243 }
244 }
245
246 $this->tpl->parseCurrentBlock();
247 }
248
249 // not for objectives/scos
250 if (!$this->mode) {
251 // tlt warning
252 if ($a_set["status"] != ilLPStatus::LP_STATUS_COMPLETED_NUM && $a_set["ref_ids"]) {
253 $ref_id = $a_set["ref_ids"];
254 $ref_id = array_shift($ref_id);
255 $timing = $this->showTimingsWarning($ref_id, $this->tracked_user->getId());
256 if ($timing) {
257 if ($timing !== true) {
258 $timing = ": " . ilDatePresentation::formatDate(new ilDate($timing, IL_CAL_UNIX));
259 } else {
260 $timing = "";
261 }
262 $this->tpl->setCurrentBlock('warning_img');
263 $this->tpl->setVariable('WARNING_IMG', ilUtil::getImagePath('time_warn.svg'));
264 $this->tpl->setVariable('WARNING_ALT', $this->lng->txt('trac_time_passed') . $timing);
265 $this->tpl->parseCurrentBlock();
266 }
267 }
268
269 // hide / unhide?!
270 if (!$this->details) {
271 $this->tpl->setCurrentBlock("item_command");
272 $ilCtrl->setParameterByClass(get_class($this), 'hide', $a_set["obj_id"]);
273 $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass(get_class($this), 'hide'));
274 $this->tpl->setVariable("TXT_COMMAND", $this->lng->txt('trac_hide'));
275 $this->tpl->parseCurrentBlock();
276
277 $olp = ilObjectLP::getInstance($a_set["obj_id"]);
278 if ($olp->getCollectionInstance() && $a_set["ref_ids"]) {
279 $ref_id = $a_set["ref_ids"];
280 $ref_id = array_shift($ref_id);
281 $ilCtrl->setParameterByClass($ilCtrl->getCmdClass(), 'details_id', $ref_id);
282 $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass($ilCtrl->getCmdClass(), 'details'));
283 $ilCtrl->setParameterByClass($ilCtrl->getCmdClass(), 'details_id', '');
284 $this->tpl->setVariable("TXT_COMMAND", $this->lng->txt('trac_subitems'));
285 $this->tpl->parseCurrentBlock();
286 }
287
288 $this->tpl->setCurrentBlock("column_action");
289 $this->tpl->parseCurrentBlock();
290 }
291 }
292 }
const IL_CAL_UNIX
const IL_CAL_DATETIME
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false)
Format a date @access public.
@classDescription Date and time handling
Class for single dates.
const LP_STATUS_COMPLETED_NUM
showTimingsWarning($a_ref_id, $a_user_id)
buildPath($ref_ids)
Build path with deep-link.
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
static _getImagePathForStatus($a_status)
Get image path for status.
static _getIcon( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
Get icon for repository item.
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)

References $ilCtrl, $path, ilObject\_getIcon(), ilLearningProgressBaseGUI\_getImagePathForStatus(), ilLearningProgressBaseGUI\_getStatusText(), ilLPTableBaseGUI\buildPath(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilObjectLP\getInstance(), IL_CAL_DATETIME, IL_CAL_UNIX, ilLPObjSettings\LP_MODE_SCORM, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPTableBaseGUI\showTimingsWarning(), and sprintf.

+ Here is the call graph for this function:

◆ fillRowCSV()

ilLPProgressTableGUI::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 341 of file class.ilLPProgressTableGUI.php.

342 {
343 $a_csv->addColumn($this->lng->txt($a_set["type"]));
344 $a_csv->addColumn($a_set["title"]);
345 $a_csv->addColumn(ilLearningProgressBaseGUI::_getStatusText($a_set["status"]));
346
348 $a_csv->addColumn(ilDatePresentation::formatDate(new ilDateTime($a_set['status_changed'], IL_CAL_DATETIME)));
350
351 if (!$this->isPercentageAvailable($a_set['obj_id'])) {
352 $a_csv->addColumn('-');
353 } else {
354 $a_csv->addColumn(sprintf("%d%%", $a_set["percentage"]));
355 }
356 $a_csv->addColumn($a_set["mark"]);
357 $a_csv->addColumn($a_set["comment"]);
358 $a_csv->addColumn(ilLPObjSettings::_mode2Text($a_set["u_mode"]));
359
360 $a_csv->addRow();
361 }
static resetToDefaults()
reset to defaults
static setUseRelativeDates($a_status)
set use relative dates
static _mode2Text($a_mode)

References ilLearningProgressBaseGUI\_getStatusText(), ilLPObjSettings\_mode2Text(), ilDatePresentation\formatDate(), IL_CAL_DATETIME, ilLPTableBaseGUI\isPercentageAvailable(), ilDatePresentation\resetToDefaults(), ilDatePresentation\setUseRelativeDates(), and sprintf.

+ Here is the call graph for this function:

◆ fillRowExcel()

ilLPProgressTableGUI::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 309 of file class.ilLPProgressTableGUI.php.

310 {
311 $a_excel->setCell($a_row, 0, $this->lng->txt($a_set["type"]));
312 $a_excel->setCell($a_row, 1, $a_set["title"]);
313 $a_excel->setCell($a_row, 2, ilLearningProgressBaseGUI::_getStatusText($a_set["status"]));
314
315 $a_excel->setCell($a_row, 3, new ilDateTime($a_set['status_changed'], IL_CAL_DATETIME));
316
317 if (!$this->isPercentageAvailable($a_row['obj_id'])) {
318 $a_excel->setCell($a_row, 4, '-');
319 } else {
320 $a_excel->setCell($a_row, 4, $a_set["percentage"] . "%");
321 }
322 $a_excel->setCell($a_row, 5, $a_set["mark"]);
323 $a_excel->setCell($a_row, 6, $a_set["comment"]);
324 $a_excel->setCell($a_row, 7, ilLPObjSettings::_mode2Text($a_set["u_mode"]));
325 }

References ilLearningProgressBaseGUI\_getStatusText(), ilLPObjSettings\_mode2Text(), IL_CAL_DATETIME, ilLPTableBaseGUI\isPercentageAvailable(), and ilExcel\setCell().

+ Here is the call graph for this function:

◆ getItems()

ilLPProgressTableGUI::getItems ( )

Definition at line 128 of file class.ilLPProgressTableGUI.php.

129 {
130 $obj_ids = $this->obj_ids;
131 if (!$obj_ids && !$this->details) {
132 switch ($this->lp_context) {
134 $obj_ids = $this->searchObjects($this->getCurrentFilter(true), null);
135 break;
136
137 default:
138 $obj_ids = $this->searchObjects($this->getCurrentFilter(true), "read");
139
140 // check for LP relevance
141 include_once "Services/Object/classes/class.ilObjectLP.php";
142 foreach (ilObjectLP::getLPMemberships($this->tracked_user->getId(), $obj_ids, null, true) as $obj_id => $status) {
143 if (!$status) {
144 unset($obj_ids[$obj_id]);
145 }
146 }
147 break;
148 }
149 }
150 if ($obj_ids) {
151 include_once("./Services/Tracking/classes/class.ilTrQuery.php");
152 switch ($this->mode) {
154 $data = ilTrQuery::getSCOsStatusForUser($this->tracked_user->getId(), $this->parent_obj_id, $obj_ids);
155 break;
156
158 $data = ilTrQuery::getObjectivesStatusForUser($this->tracked_user->getId(), $this->parent_obj_id, $obj_ids);
159 break;
160
164 $data = ilTrQuery::getSubItemsStatusForUser($this->tracked_user->getId(), $this->parent_obj_id, $obj_ids);
165 break;
166
167 default:
168 $data = ilTrQuery::getObjectsStatusForUser($this->tracked_user->getId(), $obj_ids);
169 foreach ($data as $idx => $item) {
170 if (!$item["status"] && !$this->filter["status"] && !$this->details) {
171 unset($data[$idx]);
172 } else {
173 $data[$idx]["offline"] = ilLearningProgressBaseGUI::isObjectOffline($item["obj_id"], $item["type"]);
174 }
175 }
176 break;
177 }
178
179 // #15334
180 foreach ($data as $idx => $row) {
181 if (!$this->isPercentageAvailable($row["obj_id"])) {
182 // #17000 - enable proper (numeric) sorting
183 $data[$idx]["percentage"] = -1;
184 }
185 }
186
187 $this->setData($data);
188 }
189 }
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 isObjectOffline($a_obj_id, $a_type=null)
static getLPMemberships($a_usr_id, array $a_obj_ids, $a_parent_ref_id=null, $a_mapped_ref_ids=false)
Get all objects where given user is member (from LP POV)
setData($a_data)
set table data @access public
static getObjectivesStatusForUser($a_user_id, $a_obj_id, array $a_objective_ids)
static getSubItemsStatusForUser($a_user_id, $a_parent_obj_id, array $a_item_ids)
Get subitems status.
static getObjectsStatusForUser($a_user_id, array $obj_refs)
static getSCOsStatusForUser($a_user_id, $a_parent_obj_id, array $a_sco_ids)

References ilTableGUI\$data, $row, ilLPTableBaseGUI\getCurrentFilter(), ilObjectLP\getLPMemberships(), ilTrQuery\getObjectivesStatusForUser(), ilTrQuery\getObjectsStatusForUser(), ilTrQuery\getSCOsStatusForUser(), ilTrQuery\getSubItemsStatusForUser(), ilLearningProgressBaseGUI\isObjectOffline(), ilLPTableBaseGUI\isPercentageAvailable(), ilLearningProgressBaseGUI\LP_CONTEXT_ORG_UNIT, ilLPObjSettings\LP_MODE_COLLECTION_MANUAL, ilLPObjSettings\LP_MODE_COLLECTION_MOBS, ilLPObjSettings\LP_MODE_COLLECTION_TLT, ilLPObjSettings\LP_MODE_OBJECTIVES, ilLPObjSettings\LP_MODE_SCORM, ilLPTableBaseGUI\searchObjects(), and ilTable2GUI\setData().

Referenced by __construct().

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

◆ numericOrdering()

ilLPProgressTableGUI::numericOrdering (   $a_field)

Should this field be sorted numeric?

Returns
boolean numeric ordering; default is false

Reimplemented from ilTable2GUI.

Definition at line 123 of file class.ilLPProgressTableGUI.php.

124 {
125 return ($a_field == "percentage"); // #15041
126 }

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