ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
All Data Structures Namespaces Files Functions Variables Modules Pages
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...
 
 initFilter ($a_split_learning_resources=false, $a_include_no_status_filter=true)
 Init filter. More...
 
 getCurrentFilter ($as_query=false)
 
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 Constructor. More...
 
 setOpenFormTag ($a_val)
 Set open form tag. More...
 
 getOpenFormTag ()
 Get open form tag. More...
 
 setCloseFormTag ($a_val)
 Set close form tag. More...
 
 getCloseFormTag ()
 Get close form tag. More...
 
 determineLimit ()
 Determine the limit. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 Determine selected columns. More...
 
 isColumnSelected ($a_col)
 Is given column selected? More...
 
 getSelectedColumns ()
 Get selected columns. More...
 
executeCommand ()
 Execute command. More...
 
 resetOffset ($a_in_determination=false)
 Reset offset. More...
 
 initFilter ()
 Init filter. More...
 
 getParentObject ()
 Get parent object. More...
 
 getParentCmd ()
 Get parent command. More...
 
 setTopAnchor ($a_val)
 Set top anchor. More...
 
 getTopAnchor ()
 Get top anchor. More...
 
 setNoEntriesText ($a_text)
 Set text for an empty table. More...
 
 getNoEntriesText ()
 Get text for an empty table. More...
 
 setIsDataTable ($a_val)
 Set is data table. More...
 
 getIsDataTable ()
 Get is data table. More...
 
 setEnableTitle ($a_enabletitle)
 Set Enable Title. More...
 
 getEnableTitle ()
 Get Enable Title. More...
 
 setEnableHeader ($a_enableheader)
 Set Enable Header. More...
 
 getEnableHeader ()
 Get Enable Header. More...
 
 setEnableNumInfo ($a_val)
 Set enable num info. More...
 
 getEnableNumInfo ()
 Get enable num info. More...
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setOrderField ($a_order_field)
 set order column More...
 
 getOrderField ()
 
 setData ($a_data)
 
 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...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButton $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="")
 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...
 
- Public Member Functions inherited from ilTableGUI
 ilTableGUI ($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 ($worksheet, &$a_row)
 
 fillRowExcel ($worksheet, &$a_row, $a_set)
 
 fillHeaderCSV ($a_csv)
 
 fillRowCSV ($a_csv, $a_set)
 
- Protected Member Functions inherited from ilLPTableBaseGUI
 searchObjects (array $filter, $permission, array $preset_obj_ids=null)
 Search objects that match current filters. More...
 
 buildPath ($ref_ids)
 Build path with deep-link. More...
 
 getPossibleTypes ($a_split_learning_resources=false, $a_include_digilib=false, $a_allow_undefined_lp=false)
 Get possible subtypes. More...
 
 parseValue ($id, $value, $type)
 
 isPercentageAvailable ($a_obj_id)
 
 parseTitle ($a_obj_id, $action, $a_user_id=false)
 
 getExportMeta ()
 Build export meta data. More...
 
 fillMetaExcel ($worksheet, &$a_row)
 
 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)
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel ($a_worksheet, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- Data Fields inherited from ilTable2GUI
const FILTER_TEXT = 1
 
const FILTER_SELECT = 2
 
const FILTER_DATE = 3
 
const FILTER_LANGUAGE = 4
 
const FILTER_NUMBER_RANGE = 5
 
const FILTER_DATE_RANGE = 6
 
const FILTER_DURATION_RANGE = 7
 
const FILTER_DATETIME_RANGE = 8
 
const EXPORT_EXCEL = 1
 
const EXPORT_CSV = 2
 
const ACTION_ALL_LIMIT = 1000
 
- Data Fields inherited from ilTableGUI
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 
- Protected Attributes inherited from ilLPTableBaseGUI
 $filter
 
 $anonymized
 
- Protected Attributes inherited from ilTable2GUI
 $close_command = ""
 
 $top_anchor = "il_table_top"
 
 $filters = array()
 
 $optional_filters = array()
 
 $filter_cmd = 'applyFilter'
 
 $reset_cmd = 'resetFilter'
 
 $filter_cols = 5
 
 $ext_sort = false
 
 $ext_seg = false
 
 $context = ""
 
 $mi_sel_buttons = null
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $nav_determined = false
 
 $limit_determined = false
 
 $filters_determined = false
 
 $columns_determined = false
 
 $open_form_tag = true
 
 $close_form_tag = true
 
 $export_formats
 
 $export_mode
 
 $print_mode
 
 $enable_command_for_all
 
 $restore_filter
 
 $restore_filter_values
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

Detailed Description

TableGUI class for learning progress.

Author
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(), ilObjectLP\getInstance(), getItems(), ilTable2GUI\initFilter(), ilLPObjSettings\LP_MODE_SCORM, ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTableGUI\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->initFilter();
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  }
initFilter()
Init filter.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
setExportFormats(array $formats)
Set available export formats.
setShowTemplates($a_value)
Toggle templates.
setEnableNumInfo($a_val)
Set enable num info.
setId($a_val)
Set id.
global $ilCtrl
Definition: ilias.php:18
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
setLimit($a_limit=0, $a_default_limit=0)
set max.
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="")
Add a column to the header.
addMultiCommand($a_cmd, $a_text)
Add Command button.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
global $ilUser
Definition: imgupload.php:15
global $lng
Definition: privfeed.php:40
setEnableHeader($a_enableheader)
Set Enable Header.
setSelectAllCheckbox($a_select_all_checkbox)
Set the name of the checkbox that should be toggled with a select all button.
setEnableTitle($a_enabletitle)
Set Enable Title.
static getInstance($a_obj_id)
+ Here is the call graph for this function:

Member Function Documentation

◆ fillHeaderCSV()

ilLPProgressTableGUI::fillHeaderCSV (   $a_csv)
protected

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

367  {
368  $a_csv->addColumn($this->lng->txt("type"));
369  $a_csv->addColumn($this->lng->txt("trac_title"));
370  $a_csv->addColumn($this->lng->txt("status"));
371  $a_csv->addColumn($this->lng->txt("trac_status_changed"));
372  $a_csv->addColumn($this->lng->txt("trac_percentage"));
373  $a_csv->addColumn($this->lng->txt("trac_mark"));
374  $a_csv->addColumn($this->lng->txt("comment"));
375  $a_csv->addColumn($this->lng->txt("trac_mode"));
376  // $a_csv->addColumn($this->lng->txt("path"));
377  $a_csv->addRow();
378  }

◆ fillHeaderExcel()

ilLPProgressTableGUI::fillHeaderExcel (   $worksheet,
$a_row 
)
protected

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

323  {
324  $worksheet->write($a_row, 0, $this->lng->txt("type"));
325  $worksheet->write($a_row, 1, $this->lng->txt("trac_title"));
326  $worksheet->write($a_row, 2, $this->lng->txt("status"));
327  $worksheet->write($a_row, 3, $this->lng->txt("trac_status_changed"));
328  $worksheet->write($a_row, 4, $this->lng->txt("trac_percentage"));
329  $worksheet->write($a_row, 5, $this->lng->txt("trac_mark"));
330  $worksheet->write($a_row, 6, $this->lng->txt("comment"));
331  $worksheet->write($a_row, 7, $this->lng->txt("trac_mode"));
332  // $worksheet->write($a_row, 7, $this->lng->txt("path"));
333  }

◆ fillRow()

ilLPProgressTableGUI::fillRow (   $a_set)
protected

Fill table row.

Definition at line 204 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, ilLPTableBaseGUI\isPercentageAvailable(), ilLPObjSettings\LP_MODE_SCORM, ilLPStatus\LP_STATUS_COMPLETED_NUM, and ilLPTableBaseGUI\showTimingsWarning().

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

◆ fillRowCSV()

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

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

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

381  {
382  $a_csv->addColumn($this->lng->txt($a_set["type"]));
383  $a_csv->addColumn($a_set["title"]);
384  $a_csv->addColumn(ilLearningProgressBaseGUI::_getStatusText($a_set["status"]));
385 
387  $a_csv->addColumn(ilDatePresentation::formatDate(new ilDateTime($a_set['status_changed'],IL_CAL_DATETIME)));
389 
390  $a_csv->addColumn(sprintf("%d%%", $a_set["percentage"]));
391  $a_csv->addColumn($a_set["mark"]);
392  $a_csv->addColumn($a_set["comment"]);
393  $a_csv->addColumn(ilLPObjSettings::_mode2Text($a_set["u_mode"]));
394 
395  /*
396  // path
397  $path = $this->buildPath($a_set["ref_ids"]);
398  if($path)
399  {
400  $col = 7;
401  foreach($path as $path_item)
402  {
403  $a_csv->addColumn(strip_tags($path_item));
404  $col++;
405  }
406  }
407  */
408 
409  $a_csv->addRow();
410  }
const IL_CAL_DATETIME
static resetToDefaults()
reset to defaults
static setUseRelativeDates($a_status)
set use relative dates
_getStatusText($a_status)
Get status alt text.
static formatDate(ilDateTime $date)
Format a date public.
Date and time handling
static _mode2Text($a_mode)
+ Here is the call graph for this function:

◆ fillRowExcel()

ilLPProgressTableGUI::fillRowExcel (   $worksheet,
$a_row,
  $a_set 
)
protected

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

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

336  {
337  $worksheet->write($a_row, 0, $this->lng->txt($a_set["type"]));
338  $worksheet->write($a_row, 1, $a_set["title"]);
339  $worksheet->write($a_row, 2, ilLearningProgressBaseGUI::_getStatusText($a_set["status"]));
340 
342  $worksheet->write($a_row, 3, ilDatePresentation::formatDate(new ilDateTime($a_set['status_changed'],IL_CAL_DATETIME)));
344 
345  $worksheet->write($a_row, 4, sprintf("%d%%", $a_set["percentage"]));
346  $worksheet->write($a_row, 5, $a_set["mark"]);
347  $worksheet->write($a_row, 6, $a_set["comment"]);
348  $worksheet->write($a_row, 7, ilLPObjSettings::_mode2Text($a_set["u_mode"]));
349 
350  /*
351  // path
352  $path = $this->buildPath($a_set["ref_ids"]);
353  if($path)
354  {
355  $col = 7;
356  foreach($path as $path_item)
357  {
358  $worksheet->write($a_row, $col, strip_tags($path_item));
359  $col++;
360  }
361  }
362  */
363 
364  }
const IL_CAL_DATETIME
static resetToDefaults()
reset to defaults
static setUseRelativeDates($a_status)
set use relative dates
_getStatusText($a_status)
Get status alt text.
static formatDate(ilDateTime $date)
Format a date public.
Date and time handling
static _mode2Text($a_mode)
+ Here is the call graph for this function:

◆ getItems()

ilLPProgressTableGUI::getItems ( )

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

References ilTableGUI\$data, ilParticipants\_getMembershipByType(), ilLPTableBaseGUI\getCurrentFilter(), ilTrQuery\getObjectivesStatusForUser(), ilTrQuery\getObjectsStatusForUser(), ilTrQuery\getSCOsStatusForUser(), ilTrQuery\getSubItemsStatusForUser(), ilLearningProgressBaseGUI\isObjectOffline(), ilLearningProgressBaseGUI\LP_CONTEXT_ORG_UNIT, ilLPObjSettings\LP_MODE_COLLECTION_MANUAL, 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  // restrict courses/groups to objects where current user is member
144  $membership_ids = null;
145  if($this->filter["type"] == "crs" || $this->filter["type"] == "grp")
146  {
147  include_once "Services/Membership/classes/class.ilParticipants.php";
148  $membership_ids = ilParticipants::_getMembershipByType($this->tracked_user->getId(),
149  $this->filter["type"]);
150  }
151  if($membership_ids === null || sizeof($membership_ids))
152  {
153  switch($this->lp_context)
154  {
156  $obj_ids = $this->searchObjects($this->getCurrentFilter(true),null,$membership_ids);
157  break;
158  default:
159  $obj_ids = $this->searchObjects($this->getCurrentFilter(true),"read",$membership_ids);
160  break;
161  }
162  }
163  }
164  if($obj_ids)
165  {
166  include_once("./Services/Tracking/classes/class.ilTrQuery.php");
167  switch($this->mode)
168  {
170  $data = ilTrQuery::getSCOsStatusForUser($this->tracked_user->getId(), $this->parent_obj_id, $obj_ids);
171  break;
172 
174  $data = ilTrQuery::getObjectivesStatusForUser($this->tracked_user->getId(), $obj_ids);
175  break;
176 
179  $data = ilTrQuery::getSubItemsStatusForUser($this->tracked_user->getId(), $this->parent_obj_id, $obj_ids);
180  break;
181 
182  default:
183  $data = ilTrQuery::getObjectsStatusForUser($this->tracked_user->getId(), $obj_ids);
184  foreach($data as $idx => $item)
185  {
186  if(!$item["status"] && !$this->filter["status"] && !$this->details)
187  {
188  unset($data[$idx]);
189  }
190  else
191  {
192  $data[$idx]["offline"] = ilLearningProgressBaseGUI::isObjectOffline($item["obj_id"], $item["type"]);
193  }
194  }
195  break;
196  }
197  $this->setData($data);
198  }
199  }
getObjectivesStatusForUser($a_user_id, array $a_objective_ids)
getSCOsStatusForUser($a_user_id, $a_parent_obj_id, array $a_sco_ids)
static _getMembershipByType($a_usr_id, $a_type, $a_only_member_role=false)
get membership by type Get course or group membership
static isObjectOffline($a_obj_id, $a_type=null)
searchObjects(array $filter, $permission, array $preset_obj_ids=null)
Search objects that match current filters.
getObjectsStatusForUser($a_user_id, array $obj_refs)
getCurrentFilter($as_query=false)
getSubItemsStatusForUser($a_user_id, $a_parent_obj_id, array $a_item_ids)
+ 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: