ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Public Member Functions | Protected Member Functions
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)
 
 getItems ()
 
- Public Member Functions inherited from ilLPTableBaseGUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 
 executeCommand ()
 
 searchFilterListener ($a_ref_id, $a_data)
 Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED public. More...
 
 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="")
 Constructor. More...
 
 setOpenFormTag ($a_val)
 Set open form tag. More...
 
 getOpenFormTag ()
 Get open form tag. More...
 
 setCloseFormTag ($a_val)
 Set close form tag. More...
 
 getCloseFormTag ()
 Get close form tag. More...
 
 determineLimit ()
 Determine the limit. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 Determine selected columns. More...
 
 isColumnSelected ($a_col)
 Is given column selected? More...
 
 getSelectedColumns ()
 Get selected columns. More...
 
 executeCommand ()
 Execute command. More...
 
 resetOffset ($a_in_determination=false)
 Reset offset. More...
 
 initFilter ()
 Init filter. More...
 
 getParentObject ()
 Get parent object. More...
 
 getParentCmd ()
 Get parent command. More...
 
 setTopAnchor ($a_val)
 Set top anchor. More...
 
 getTopAnchor ()
 Get top anchor. More...
 
 setNoEntriesText ($a_text)
 Set text for an empty table. More...
 
 getNoEntriesText ()
 Get text for an empty table. More...
 
 setIsDataTable ($a_val)
 Set is data table. More...
 
 getIsDataTable ()
 Get is data table. More...
 
 setEnableTitle ($a_enabletitle)
 Set Enable Title. More...
 
 getEnableTitle ()
 Get Enable Title. More...
 
 setEnableHeader ($a_enableheader)
 Set Enable Header. More...
 
 getEnableHeader ()
 Get Enable Header. More...
 
 setEnableNumInfo ($a_val)
 Set enable num info. More...
 
 getEnableNumInfo ()
 Get enable num info. More...
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setOrderField ($a_order_field)
 set order column More...
 
 getOrderField ()
 
 setData ($a_data)
 
 getData ()
 
 dataExists ()
 
 setPrefix ($a_prefix)
 
 getPrefix ()
 
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item. More...
 
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
 Add filter by standard type. More...
 
 getFilterItems ($a_optionals=false)
 Get filter items. More...
 
 getFilterItemByPostVar ($a_post_var)
 
 setFilterCols ($a_val)
 Set filter columns. More...
 
 getFilterCols ()
 Get filter columns. More...
 
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding. More...
 
 getDisableFilterHiding ()
 Get disable filter hiding. More...
 
 isFilterSelected ($a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 Get selected filters. More...
 
 determineSelectedFilters ()
 Determine selected filters. More...
 
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links. More...
 
 setFormAction ($a_form_action, $a_multipart=false)
 Set Form action parameter. More...
 
 getFormAction ()
 Get Form action parameter. More...
 
 setFormName ($a_formname="")
 Set Form name. More...
 
 getFormName ()
 Get Form name. More...
 
 setId ($a_val)
 Set id. More...
 
 getId ()
 Get element id. More...
 
 setDisplayAsBlock ($a_val)
 Set display as block. More...
 
 getDisplayAsBlock ()
 Get display as block. More...
 
 getSelectAllCheckbox ()
 Get the name of the checkbox that should be toggled with a select all button. More...
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 Set the name of the checkbox that should be toggled with a select all button. More...
 
 setExternalSorting ($a_val)
 Set external sorting. More...
 
 getExternalSorting ()
 Get external sorting. More...
 
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 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 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)
 
- Public Member Functions inherited from ilTableGUI
 __construct ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate ($a_tpl)
 set template public More...
 
& getTemplateObject ()
 
 setData ($a_data)
 set table data public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page public More...
 
 setHeaderNames ($a_header_names)
 set table header names public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars public More...
 
 setColumnWidth ($a_column_width)
 set table column widths public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width public More...
 
 setMaxCount ($a_max_count)
 set max. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
 getLimit ()
 Get limit. More...
 
 setPrefix ($a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) public More...
 
 setOffset ($a_offset)
 set dataset offset public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction public More...
 
 enable ($a_module_name)
 enables particular modules of table More...
 
 disable ($a_module_name)
 diesables particular modules of table More...
 
 sortData ()
 
 render ()
 render table public More...
 
 renderHeader ()
 
 setOrderLink ($key, $order_dir)
 
 setStyle ($a_element, $a_style)
 
 getStyle ($a_element)
 
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds). More...
 
 getBase ()
 Get Base script name (deprecated, only use this for workarounds). More...
 
 getFormName ()
 
 setFormName ($a_name="cmd")
 
 getSelectAllCheckbox ()
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton ($btn_name, $btn_value)
 

Protected Member Functions

 fillRow ($a_set)
 Fill table row. More...
 
 fillHeaderExcel (ilExcel $a_excel, &$a_row)
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
 
 fillHeaderCSV ($a_csv)
 
 fillRowCSV ($a_csv, $a_set)
 
- 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)
 
 fillMetaCSV ($a_csv)
 
 showTimingsWarning ($a_ref_id, $a_user_id)
 
 formatSeconds ($seconds, $a_shorten_zero=false)
 
 anonymizeValue ($a_value, $a_force_number=false)
 
 buildValueScale ($a_max_value, $a_anonymize=false, $a_format_seconds=false)
 
 getMonthsFilter ($a_short=false)
 
 getMonthsYear ($a_year=null, $a_short=false)
 
 getSelectableUserColumns ($a_in_course=false, $a_in_group=false)
 
 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 EXPORT_EXCEL = 1
 
const EXPORT_CSV = 2
 
const ACTION_ALL_LIMIT = 1000
 
- Data Fields inherited from ilTableGUI
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 
- Protected Attributes inherited from ilLPTableBaseGUI
 $filter
 
 $anonymized
 
- Protected Attributes inherited from ilTable2GUI
 $close_command = ""
 
 $top_anchor = "il_table_top"
 
 $filters = array()
 
 $optional_filters = array()
 
 $filter_cmd = 'applyFilter'
 
 $reset_cmd = 'resetFilter'
 
 $filter_cols = 5
 
 $ext_sort = false
 
 $ext_seg = false
 
 $context = ""
 
 $mi_sel_buttons = null
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $rows_selector_off = false
 
 $nav_determined = false
 
 $limit_determined = false
 
 $filters_determined = false
 
 $columns_determined = false
 
 $open_form_tag = true
 
 $close_form_tag = true
 
 $export_formats
 
 $export_mode
 
 $print_mode
 
 $enable_command_for_all
 
 $restore_filter
 
 $restore_filter_values
 
 $default_filter_visibility = false
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

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$

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.

References $ilCtrl, $ilUser, $lng, ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), array, 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(), and ilTable2GUI\setTitle().

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  {
34  // #15042 - needed for export meta
35  $this->obj_id = $this->parent_obj_id;
36  $this->ref_id = $a_parent_ref_id;
37  }
38 
39  $this->setId("lpprgtbl");
40 
41  parent::__construct($a_parent_obj, $a_parent_cmd);
42 
43  $this->setLimit(9999);
44 
45  if(!$this->details)
46  {
47  $this->has_object_subitems = true;
48 
49  $user = $this->tracked_user;
50  if(!$user)
51  {
52  $user = $ilUser;
53  }
54 
55  $this->addColumn("", "", "1", true);
56  $this->addColumn($this->lng->txt("trac_title"), "title", "26%");
57  $this->addColumn($this->lng->txt("status"), "status", "7%");
58  $this->addColumn($this->lng->txt('trac_status_changed'),'status_changed','10%');
59  $this->addColumn($this->lng->txt("trac_percentage"), "percentage", "7%");
60  $this->addColumn($this->lng->txt("trac_mark"), "", "5%");
61  $this->addColumn($this->lng->txt("comment"), "", "10%");
62  $this->addColumn($this->lng->txt("trac_mode"), "", "20%");
63  $this->addColumn($this->lng->txt("path"), "", "20%");
64  $this->addColumn($this->lng->txt("actions"), "", "5%");
65 
66  $this->setTitle(sprintf($this->lng->txt("trac_learning_progress_of"), $user->getFullName()));
67  $this->initBaseFilter();
68 
69  $this->setSelectAllCheckbox("item_id");
70  $this->addMultiCommand("hideSelected", $lng->txt("trac_hide_selected"));
71 
72  $this->setShowTemplates(true);
73  }
74  else
75  {
76  include_once './Services/Object/classes/class.ilObjectLP.php';
77  $olp = ilObjectLP::getInstance($this->parent_obj_id);
78  $collection = $olp->getCollectionInstance();
79  $this->has_object_subitems = ($collection instanceof ilLPCollectionOfRepositoryObjects);
80 
81  /*
82  if(!$personal_only)
83  {
84  $this->parseTitle($a_parent_obj->details_obj_id, "trac_subitems");
85  }
86  else
87  {
88  $this->parseTitle($a_parent_obj->details_obj_id, "trac_progress");
89  }
90  */
91  $this->setTitle($this->lng->txt("details")); // #15247
92 
93  $this->addColumn($this->lng->txt("trac_title"), "title", "31%");
94  $this->addColumn($this->lng->txt("status"), "status", "7%");
95 
96  if($this->mode == ilLPObjSettings::LP_MODE_SCORM)
97  {
98  $this->lng->loadLanguageModule('content');
99  $this->addColumn($this->lng->txt('cont_score'),'score','10%');
100  }
101  else if($this->has_object_subitems)
102  {
103  $this->addColumn($this->lng->txt('trac_status_changed'),'status_changed','10%');
104  $this->addColumn($this->lng->txt("trac_percentage"), "percentage", "7%");
105  $this->addColumn($this->lng->txt("trac_mark"), "", "5%");
106  $this->addColumn($this->lng->txt("comment"), "", "10%");
107  $this->addColumn($this->lng->txt("trac_mode"), "", "20%");
108  $this->addColumn($this->lng->txt("path"), "", "20%");
109  }
110  }
111 
112  $this->setEnableHeader(true);
113  $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
114  $this->setRowTemplate("tpl.lp_progress_list_row.html", "Services/Tracking");
115  $this->setEnableHeader(true);
116  $this->setEnableNumInfo(false);
117  $this->setEnableTitle(true);
118  $this->setDefaultOrderField("title");
119  $this->setDefaultOrderDirection("asc");
120 
121  if($this->has_object_subitems)
122  {
123  $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
124  }
125 
126  // area selector gets in the way
127  if($this->tracked_user)
128  {
129  $this->getItems();
130  }
131  }
ilTable2GUI\setDefaultOrderField
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
Definition: class.ilTable2GUI.php:1138
ilTable2GUI\setExportFormats
setExportFormats(array $formats)
Set available export formats.
Definition: class.ilTable2GUI.php:3154
ilTable2GUI\setShowTemplates
setShowTemplates($a_value)
Toggle templates.
Definition: class.ilTable2GUI.php:3021
ilTable2GUI\setEnableNumInfo
setEnableNumInfo($a_val)
Set enable num info.
Definition: class.ilTable2GUI.php:495
ilTable2GUI\setId
setId($a_val)
Set id.
Definition: class.ilTable2GUI.php:978
$ilCtrl
global $ilCtrl
Definition: ilias.php:18
ilLPTableBaseGUI\initBaseFilter
initBaseFilter($a_split_learning_resources=false, $a_include_no_status_filter=true)
Init filter.
Definition: class.ilLPTableBaseGUI.php:283
ilTable2GUI\setDefaultOrderDirection
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
Definition: class.ilTable2GUI.php:1158
ilTable2GUI\setTitle
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
Definition: class.ilTable2GUI.php:513
ilTable2GUI\addMultiCommand
addMultiCommand($a_cmd, $a_text)
Add Command button.
Definition: class.ilTable2GUI.php:1273
$ilUser
$ilUser
Definition: imgupload.php:18
ilTable2GUI\setRowTemplate
setRowTemplate($a_template, $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:1127
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
ilTable2GUI\setFormAction
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
Definition: class.ilTable2GUI.php:937
$lng
global $lng
Definition: privfeed.php:17
ilTable2GUI\setEnableHeader
setEnableHeader($a_enableheader)
Set Enable Header.
Definition: class.ilTable2GUI.php:475
ilTable2GUI\setSelectAllCheckbox
setSelectAllCheckbox($a_select_all_checkbox)
Set the name of the checkbox that should be toggled with a select all button.
Definition: class.ilTable2GUI.php:1032
ilTable2GUI\setEnableTitle
setEnableTitle($a_enabletitle)
Set Enable Title.
Definition: class.ilTable2GUI.php:455
ilObjectLP\getInstance
static getInstance($a_obj_id)
Definition: class.ilObjectLP.php:27
ilTable2GUI\addColumn
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.
Definition: class.ilTable2GUI.php:1328
ilTable2GUI\setLimit
setLimit($a_limit=0, $a_default_limit=0)
Definition: class.ilTable2GUI.php:3465
+ Here is the call graph for this function:

Member Function Documentation

◆ fillHeaderCSV()

ilLPProgressTableGUI::fillHeaderCSV (   $a_csv)
protected

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

379  {
380  $a_csv->addColumn($this->lng->txt("type"));
381  $a_csv->addColumn($this->lng->txt("trac_title"));
382  $a_csv->addColumn($this->lng->txt("status"));
383  $a_csv->addColumn($this->lng->txt("trac_status_changed"));
384  $a_csv->addColumn($this->lng->txt("trac_percentage"));
385  $a_csv->addColumn($this->lng->txt("trac_mark"));
386  $a_csv->addColumn($this->lng->txt("comment"));
387  $a_csv->addColumn($this->lng->txt("trac_mode"));
388  // $a_csv->addColumn($this->lng->txt("path"));
389  $a_csv->addRow();
390  }

◆ fillHeaderExcel()

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

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

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

335  {
336  $a_excel->setCell($a_row, 0, $this->lng->txt("type"));
337  $a_excel->setCell($a_row, 1, $this->lng->txt("trac_title"));
338  $a_excel->setCell($a_row, 2, $this->lng->txt("status"));
339  $a_excel->setCell($a_row, 3, $this->lng->txt("trac_status_changed"));
340  $a_excel->setCell($a_row, 4, $this->lng->txt("trac_percentage"));
341  $a_excel->setCell($a_row, 5, $this->lng->txt("trac_mark"));
342  $a_excel->setCell($a_row, 6, $this->lng->txt("comment"));
343  $a_excel->setCell($a_row, 7, $this->lng->txt("trac_mode"));
344  // $a_excel->setCell($a_row, 7, $this->lng->txt("path"));
345 
346  $a_excel->setBold("A".$a_row.":H".$a_row);
347  }
ilExcel\setBold
setBold($a_coords)
Set cell(s) to bold.
Definition: class.ilExcel.php:503
ilExcel\setCell
setCell($a_row, $a_col, $a_value)
Set cell value.
Definition: class.ilExcel.php:281
+ Here is the call graph for this function:

◆ fillRow()

ilLPProgressTableGUI::fillRow (   $a_set)
protected

Fill table row.

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

References $ilCtrl, $path, $ref_id, 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, and ilLPTableBaseGUI\showTimingsWarning().

217  {
218  global $ilCtrl;
219 
220  if(!$this->details)
221  {
222  $this->tpl->setCurrentBlock("column_checkbox");
223  $this->tpl->setVariable("OBJ_ID", $a_set["obj_id"]);
224  $this->tpl->parseCurrentBlock();
225  }
226 
227  $this->tpl->setVariable("ICON_SRC", ilObject::_getIcon("", "tiny", $a_set["type"]));
228  $this->tpl->setVariable("ICON_ALT", $this->lng->txt($a_set["type"]));
229  $this->tpl->setVariable("TITLE_TEXT", $a_set["title"]);
230 
231  if($a_set["offline"])
232  {
233  $this->tpl->setCurrentBlock("offline");
234  $this->tpl->setVariable("TEXT_STATUS", $this->lng->txt("status"));
235  $this->tpl->setVariable("TEXT_OFFLINE", $this->lng->txt("offline"));
236  $this->tpl->parseCurrentBlock();
237  }
238 
239  $this->tpl->setVariable("STATUS_ALT", ilLearningProgressBaseGUI::_getStatusText($a_set["status"]));
240  $this->tpl->setVariable("STATUS_IMG", ilLearningProgressBaseGUI::_getImagePathForStatus($a_set["status"]));
241 
242  if($this->mode == ilLPObjSettings::LP_MODE_SCORM)
243  {
244  $this->tpl->setVariable('SCORE_VAL', $a_set["score"]);
245  }
246  else if($this->has_object_subitems)
247  {
248  $this->tpl->setCurrentBlock("status_details");
249 
250  $this->tpl->setVariable('STATUS_CHANGED_VAL', ilDatePresentation::formatDate(new ilDateTime($a_set['status_changed'],IL_CAL_DATETIME)));
251 
252  $olp = ilObjectLP::getInstance($a_set["obj_id"]);
253  $this->tpl->setVariable("MODE_TEXT", $olp->getModeText($a_set["u_mode"]));
254  $this->tpl->setVariable("MARK_VALUE", $a_set["mark"]);
255  $this->tpl->setVariable("COMMENT_TEXT", $a_set["comment"]);
256 
257  if($a_set["percentage"] < 0)
258  {
259  $this->tpl->setVariable("PERCENTAGE_VALUE", "");
260  }
261  else
262  {
263  $this->tpl->setVariable("PERCENTAGE_VALUE", sprintf("%d%%", $a_set["percentage"]));
264  }
265 
266  // path
267  $path = $this->buildPath($a_set["ref_ids"]);
268  if($path)
269  {
270  $this->tpl->setCurrentBlock("item_path");
271  foreach($path as $path_item)
272  {
273  $this->tpl->setVariable("PATH_ITEM", $path_item);
274  $this->tpl->parseCurrentBlock();
275  }
276  }
277 
278  $this->tpl->parseCurrentBlock();
279  }
280 
281  // not for objectives/scos
282  if(!$this->mode)
283  {
284  // tlt warning
285  if($a_set["status"] != ilLPStatus::LP_STATUS_COMPLETED_NUM && $a_set["ref_ids"])
286  {
287  $ref_id = $a_set["ref_ids"];
288  $ref_id = array_shift($ref_id);
289  $timing = $this->showTimingsWarning($ref_id, $this->tracked_user->getId());
290  if($timing)
291  {
292  if($timing !== true)
293  {
294  $timing = ": ".ilDatePresentation::formatDate(new ilDate($timing, IL_CAL_UNIX));
295  }
296  else
297  {
298  $timing = "";
299  }
300  $this->tpl->setCurrentBlock('warning_img');
301  $this->tpl->setVariable('WARNING_IMG', ilUtil::getImagePath('time_warn.svg'));
302  $this->tpl->setVariable('WARNING_ALT', $this->lng->txt('trac_time_passed').$timing);
303  $this->tpl->parseCurrentBlock();
304  }
305  }
306 
307  // hide / unhide?!
308  if(!$this->details)
309  {
310  $this->tpl->setCurrentBlock("item_command");
311  $ilCtrl->setParameterByClass(get_class($this),'hide', $a_set["obj_id"]);
312  $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass(get_class($this),'hide'));
313  $this->tpl->setVariable("TXT_COMMAND", $this->lng->txt('trac_hide'));
314  $this->tpl->parseCurrentBlock();
315 
316  $olp = ilObjectLP::getInstance($a_set["obj_id"]);
317  if($olp->getCollectionInstance() && $a_set["ref_ids"])
318  {
319  $ref_id = $a_set["ref_ids"];
320  $ref_id = array_shift($ref_id);
321  $ilCtrl->setParameterByClass($ilCtrl->getCmdClass(), 'details_id', $ref_id);
322  $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass($ilCtrl->getCmdClass(), 'details'));
323  $ilCtrl->setParameterByClass($ilCtrl->getCmdClass(), 'details_id', '');
324  $this->tpl->setVariable("TXT_COMMAND", $this->lng->txt('trac_subitems'));
325  $this->tpl->parseCurrentBlock();
326  }
327 
328  $this->tpl->setCurrentBlock("column_action");
329  $this->tpl->parseCurrentBlock();
330  }
331  }
332  }
ilLPStatus\LP_STATUS_COMPLETED_NUM
const LP_STATUS_COMPLETED_NUM
Definition: class.ilLPStatus.php:30
ilLPTableBaseGUI\buildPath
buildPath($ref_ids)
Build path with deep-link.
Definition: class.ilLPTableBaseGUI.php:365
ilObject\_getIcon
static _getIcon($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
Get icon for repository item.
Definition: class.ilObject.php:1872
$path
$path
Definition: aliased.php:25
IL_CAL_DATETIME
const IL_CAL_DATETIME
Definition: class.ilDateTime.php:9
ilLearningProgressBaseGUI\_getImagePathForStatus
static _getImagePathForStatus($a_status)
Get image path for status.
Definition: class.ilLearningProgressBaseGUI.php:319
ilLearningProgressBaseGUI\_getStatusText
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
Definition: class.ilLearningProgressBaseGUI.php:358
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:11
$ilCtrl
global $ilCtrl
Definition: ilias.php:18
ilDate
Class for single dates.
Definition: class.ilDate.php:36
ilUtil\getImagePath
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
Definition: class.ilUtil.php:71
ilDatePresentation\formatDate
static formatDate(ilDateTime $date)
Format a date public.
Definition: class.ilDatePresentation.php:113
ilDateTime
Date and time handling
Definition: class.ilDateTime.php:32
$ref_id
$ref_id
Definition: sahs_server.php:39
ilLPTableBaseGUI\showTimingsWarning
showTimingsWarning($a_ref_id, $a_user_id)
Definition: class.ilLPTableBaseGUI.php:762
ilObjectLP\getInstance
static getInstance($a_obj_id)
Definition: class.ilObjectLP.php:27
+ Here is the call graph for this function:

◆ fillRowCSV()

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

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

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

393  {
394  $a_csv->addColumn($this->lng->txt($a_set["type"]));
395  $a_csv->addColumn($a_set["title"]);
396  $a_csv->addColumn(ilLearningProgressBaseGUI::_getStatusText($a_set["status"]));
397 
398  ilDatePresentation::setUseRelativeDates(false);
399  $a_csv->addColumn(ilDatePresentation::formatDate(new ilDateTime($a_set['status_changed'],IL_CAL_DATETIME)));
400  ilDatePresentation::resetToDefaults();
401 
402  $a_csv->addColumn(sprintf("%d%%", $a_set["percentage"]));
403  $a_csv->addColumn($a_set["mark"]);
404  $a_csv->addColumn($a_set["comment"]);
405  $a_csv->addColumn(ilLPObjSettings::_mode2Text($a_set["u_mode"]));
406 
407  /*
408  // path
409  $path = $this->buildPath($a_set["ref_ids"]);
410  if($path)
411  {
412  $col = 7;
413  foreach($path as $path_item)
414  {
415  $a_csv->addColumn(strip_tags($path_item));
416  $col++;
417  }
418  }
419  */
420 
421  $a_csv->addRow();
422  }
IL_CAL_DATETIME
const IL_CAL_DATETIME
Definition: class.ilDateTime.php:9
ilLearningProgressBaseGUI\_getStatusText
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
Definition: class.ilLearningProgressBaseGUI.php:358
ilDatePresentation\resetToDefaults
static resetToDefaults()
reset to defaults
Definition: class.ilDatePresentation.php:96
ilDatePresentation\setUseRelativeDates
static setUseRelativeDates($a_status)
set use relative dates
Definition: class.ilDatePresentation.php:50
ilDatePresentation\formatDate
static formatDate(ilDateTime $date)
Format a date public.
Definition: class.ilDatePresentation.php:113
ilDateTime
Date and time handling
Definition: class.ilDateTime.php:32
ilLPObjSettings\_mode2Text
static _mode2Text($a_mode)
Definition: class.ilLPObjSettings.php:325
+ Here is the call graph for this function:

◆ fillRowExcel()

ilLPProgressTableGUI::fillRowExcel ( ilExcel  $a_excel,
&  $a_row,
  $a_set 
)
protected

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

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

350  {
351  $a_excel->setCell($a_row, 0, $this->lng->txt($a_set["type"]));
352  $a_excel->setCell($a_row, 1, $a_set["title"]);
353  $a_excel->setCell($a_row, 2, ilLearningProgressBaseGUI::_getStatusText($a_set["status"]));
354 
355  $a_excel->setCell($a_row, 3, new ilDateTime($a_set['status_changed'],IL_CAL_DATETIME));
356 
357  $a_excel->setCell($a_row, 4, $a_set["percentage"]."%");
358  $a_excel->setCell($a_row, 5, $a_set["mark"]);
359  $a_excel->setCell($a_row, 6, $a_set["comment"]);
360  $a_excel->setCell($a_row, 7, ilLPObjSettings::_mode2Text($a_set["u_mode"]));
361 
362  /*
363  // path
364  $path = $this->buildPath($a_set["ref_ids"]);
365  if($path)
366  {
367  $col = 7;
368  foreach($path as $path_item)
369  {
370  $worksheet->write($a_row, $col, strip_tags($path_item));
371  $col++;
372  }
373  }
374  */
375 
376  }
IL_CAL_DATETIME
const IL_CAL_DATETIME
Definition: class.ilDateTime.php:9
ilLearningProgressBaseGUI\_getStatusText
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
Definition: class.ilLearningProgressBaseGUI.php:358
ilDateTime
Date and time handling
Definition: class.ilDateTime.php:32
ilExcel\setCell
setCell($a_row, $a_col, $a_value)
Set cell value.
Definition: class.ilExcel.php:281
ilLPObjSettings\_mode2Text
static _mode2Text($a_mode)
Definition: class.ilLPObjSettings.php:325
+ Here is the call graph for this function:

◆ getItems()

ilLPProgressTableGUI::getItems ( )

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

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

139  {
140  $obj_ids = $this->obj_ids;
141  if(!$obj_ids && !$this->details)
142  {
143  switch($this->lp_context)
144  {
145  case ilLearningProgressGUI::LP_CONTEXT_ORG_UNIT:
146  $obj_ids = $this->searchObjects($this->getCurrentFilter(true), null);
147  break;
148 
149  default:
150  $obj_ids = $this->searchObjects($this->getCurrentFilter(true), "read");
151 
152  // check for LP relevance
153  include_once "Services/Object/classes/class.ilObjectLP.php";
154  foreach(ilObjectLP::getLPMemberships($this->tracked_user->getId(), $obj_ids, null, true) as $obj_id => $status)
155  {
156  if(!$status)
157  {
158  unset($obj_ids[$obj_id]);
159  }
160  }
161  break;
162  }
163  }
164  if($obj_ids)
165  {
166  include_once("./Services/Tracking/classes/class.ilTrQuery.php");
167  switch($this->mode)
168  {
169  case ilLPObjSettings::LP_MODE_SCORM:
170  $data = ilTrQuery::getSCOsStatusForUser($this->tracked_user->getId(), $this->parent_obj_id, $obj_ids);
171  break;
172 
173  case ilLPObjSettings::LP_MODE_OBJECTIVES:
174  $data = ilTrQuery::getObjectivesStatusForUser($this->tracked_user->getId(), $this->parent_obj_id, $obj_ids);
175  break;
176 
177  case ilLPObjSettings::LP_MODE_COLLECTION_MANUAL:
178  case ilLPObjSettings::LP_MODE_COLLECTION_TLT:
179  case ilLPObjSettings::LP_MODE_COLLECTION_MOBS:
180  $data = ilTrQuery::getSubItemsStatusForUser($this->tracked_user->getId(), $this->parent_obj_id, $obj_ids);
181  break;
182 
183  default:
184  $data = ilTrQuery::getObjectsStatusForUser($this->tracked_user->getId(), $obj_ids);
185  foreach($data as $idx => $item)
186  {
187  if(!$item["status"] && !$this->filter["status"] && !$this->details)
188  {
189  unset($data[$idx]);
190  }
191  else
192  {
193  $data[$idx]["offline"] = ilLearningProgressBaseGUI::isObjectOffline($item["obj_id"], $item["type"]);
194  }
195  }
196  break;
197  }
198 
199  // #15334
200  foreach($data as $idx => $row)
201  {
202  if(!$this->isPercentageAvailable($row["obj_id"]))
203  {
204  // #17000 - enable proper (numeric) sorting
205  $data[$idx]["percentage"] = -1;
206  }
207  }
208 
209  $this->setData($data);
210  }
211  }
ilLPTableBaseGUI\searchObjects
searchObjects(array $filter, $permission, array $preset_obj_ids=null, $a_check_lp_activation=true)
Search objects that match current filters.
Definition: class.ilLPTableBaseGUI.php:186
ilTrQuery\getObjectsStatusForUser
static getObjectsStatusForUser($a_user_id, array $obj_refs)
Definition: class.ilTrQuery.php:14
ilTrQuery\getSCOsStatusForUser
static getSCOsStatusForUser($a_user_id, $a_parent_obj_id, array $a_sco_ids)
Definition: class.ilTrQuery.php:121
ilTrQuery\getSubItemsStatusForUser
static getSubItemsStatusForUser($a_user_id, $a_parent_obj_id, array $a_item_ids)
Get subitems status.
Definition: class.ilTrQuery.php:197
ilLearningProgressBaseGUI\isObjectOffline
static isObjectOffline($a_obj_id, $a_type=null)
Definition: class.ilLearningProgressBaseGUI.php:799
ilTrQuery\getObjectivesStatusForUser
static getObjectivesStatusForUser($a_user_id, $a_obj_id, array $a_objective_ids)
Definition: class.ilTrQuery.php:91
ilObjectLP\getLPMemberships
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)
Definition: class.ilObjectLP.php:550
ilLPTableBaseGUI\getCurrentFilter
getCurrentFilter($as_query=false)
Definition: class.ilLPTableBaseGUI.php:558
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ numericOrdering()

ilLPProgressTableGUI::numericOrdering (   $a_field)

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

134  {
135  return ($a_field == "percentage"); // #15041
136  }
The documentation for this class was generated from the following file: