ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
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="")
 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)
 
 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, $a_select_all_on_top=false)
 Set the name of the checkbox that should be toggled with a select all button. More...
 
 setExternalSorting ($a_val)
 Set external sorting. More...
 
 getExternalSorting ()
 Get external sorting. More...
 
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 setDefaultFilterVisiblity ($a_status)
 Set default filter visiblity. More...
 
 getDefaultFilterVisibility ()
 Get default filter visibility. More...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButtonBase $a_button)
 Add Command button instance. More...
 
 addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button. More...
 
 addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button for selected items. More...
 
 setCloseCommand ($a_link)
 Add command for closing table. More...
 
 addMultiCommand ($a_cmd, $a_text)
 Add Command button. More...
 
 addHiddenInput ($a_name, $a_value)
 Add Hidden Input field. More...
 
 addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
 Add Header Command (Link) (Image needed for now) More...
 
 setTopCommands ($a_val)
 Set top commands (display command buttons on top of table, too) More...
 
 getTopCommands ()
 Get top commands (display command buttons on top of table, too) More...
 
 addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
 Add a column to the header. More...
 
 getNavParameter ()
 
 setOrderLink ($sort_field, $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order. More...
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 render ()
 render table 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 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
 
 $select_all_on_top = false
 
 $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$

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 $DIC, $ilCtrl, $ilUser, ilTableGUI\$lng, $user, 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(), and ilTable2GUI\setTitle().

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

Member Function Documentation

◆ fillHeaderCSV()

ilLPProgressTableGUI::fillHeaderCSV (   $a_csv)
protected

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

334  {
335  $a_csv->addColumn($this->lng->txt("type"));
336  $a_csv->addColumn($this->lng->txt("trac_title"));
337  $a_csv->addColumn($this->lng->txt("status"));
338  $a_csv->addColumn($this->lng->txt("trac_status_changed"));
339  $a_csv->addColumn($this->lng->txt("trac_percentage"));
340  $a_csv->addColumn($this->lng->txt("trac_mark"));
341  $a_csv->addColumn($this->lng->txt("comment"));
342  $a_csv->addColumn($this->lng->txt("trac_mode"));
343  // $a_csv->addColumn($this->lng->txt("path"));
344  $a_csv->addRow();
345  }

◆ fillHeaderExcel()

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

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

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

301  {
302  $a_excel->setCell($a_row, 0, $this->lng->txt("type"));
303  $a_excel->setCell($a_row, 1, $this->lng->txt("trac_title"));
304  $a_excel->setCell($a_row, 2, $this->lng->txt("status"));
305  $a_excel->setCell($a_row, 3, $this->lng->txt("trac_status_changed"));
306  $a_excel->setCell($a_row, 4, $this->lng->txt("trac_percentage"));
307  $a_excel->setCell($a_row, 5, $this->lng->txt("trac_mark"));
308  $a_excel->setCell($a_row, 6, $this->lng->txt("comment"));
309  $a_excel->setCell($a_row, 7, $this->lng->txt("trac_mode"));
310  // $a_excel->setCell($a_row, 7, $this->lng->txt("path"));
311 
312  $a_excel->setBold("A" . $a_row . ":H" . $a_row);
313  }
setBold($a_coords)
Set cell(s) to bold.
setCell($a_row, $a_col, $a_value, $a_datatype=null)
Set cell value.
+ Here is the call graph for this function:

◆ fillRow()

ilLPProgressTableGUI::fillRow (   $a_set)
protected

Fill table row.

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

References $DIC, $ilCtrl, $path, 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().

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

◆ fillRowCSV()

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

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

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

348  {
349  $a_csv->addColumn($this->lng->txt($a_set["type"]));
350  $a_csv->addColumn($a_set["title"]);
351  $a_csv->addColumn(ilLearningProgressBaseGUI::_getStatusText($a_set["status"]));
352 
354  $a_csv->addColumn(ilDatePresentation::formatDate(new ilDateTime($a_set['status_changed'], IL_CAL_DATETIME)));
356 
357  if (!$this->isPercentageAvailable($a_set['obj_id'])) {
358  $a_csv->addColumn('-');
359  } else {
360  $a_csv->addColumn(sprintf("%d%%", $a_set["percentage"]));
361  }
362  $a_csv->addColumn($a_set["mark"]);
363  $a_csv->addColumn($a_set["comment"]);
364  $a_csv->addColumn(ilLPObjSettings::_mode2Text($a_set["u_mode"]));
365 
366  $a_csv->addRow();
367  }
const IL_CAL_DATETIME
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
static resetToDefaults()
reset to defaults
static setUseRelativeDates($a_status)
set use relative dates
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false, $include_seconds=false)
Format a date public.
Date and time handling
static _mode2Text($a_mode)
+ Here is the call graph for this function:

◆ fillRowExcel()

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

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

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

316  {
317  $a_excel->setCell($a_row, 0, $this->lng->txt($a_set["type"]));
318  $a_excel->setCell($a_row, 1, $a_set["title"]);
319  $a_excel->setCell($a_row, 2, ilLearningProgressBaseGUI::_getStatusText($a_set["status"]));
320 
321  $a_excel->setCell($a_row, 3, new ilDateTime($a_set['status_changed'], IL_CAL_DATETIME));
322 
323  if (!$this->isPercentageAvailable($a_row['obj_id'])) {
324  $a_excel->setCell($a_row, 4, '-');
325  } else {
326  $a_excel->setCell($a_row, 4, $a_set["percentage"] . "%");
327  }
328  $a_excel->setCell($a_row, 5, $a_set["mark"]);
329  $a_excel->setCell($a_row, 6, $a_set["comment"]);
330  $a_excel->setCell($a_row, 7, ilLPObjSettings::_mode2Text($a_set["u_mode"]));
331  }
const IL_CAL_DATETIME
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
Date and time handling
setCell($a_row, $a_col, $a_value, $a_datatype=null)
Set cell value.
static _mode2Text($a_mode)
+ Here is the call graph for this function:

◆ getItems()

ilLPProgressTableGUI::getItems ( )

Definition at line 132 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().

133  {
134  $obj_ids = $this->obj_ids;
135  if (!$obj_ids && !$this->details) {
136  switch ($this->lp_context) {
138  $obj_ids = $this->searchObjects($this->getCurrentFilter(true), null);
139  break;
140 
141  default:
142  $obj_ids = $this->searchObjects($this->getCurrentFilter(true), "read");
143 
144  // check for LP relevance
145  include_once "Services/Object/classes/class.ilObjectLP.php";
146  foreach (ilObjectLP::getLPMemberships($this->tracked_user->getId(), $obj_ids, null, true) as $obj_id => $status) {
147  if (!$status) {
148  unset($obj_ids[$obj_id]);
149  }
150  }
151  break;
152  }
153  }
154  if ($obj_ids) {
155  include_once("./Services/Tracking/classes/class.ilTrQuery.php");
156  switch ($this->mode) {
158  $data = ilTrQuery::getSCOsStatusForUser($this->tracked_user->getId(), $this->parent_obj_id, $obj_ids);
159  break;
160 
162  $data = ilTrQuery::getObjectivesStatusForUser($this->tracked_user->getId(), $this->parent_obj_id, $obj_ids);
163  break;
164 
168  $data = ilTrQuery::getSubItemsStatusForUser($this->tracked_user->getId(), $this->parent_obj_id, $obj_ids);
169  break;
170 
171  default:
172  $data = ilTrQuery::getObjectsStatusForUser($this->tracked_user->getId(), $obj_ids);
173  foreach ($data as $idx => $item) {
174  if (!$item["status"] && !$this->filter["status"] && !$this->details) {
175  unset($data[$idx]);
176  } else {
177  $data[$idx]["offline"] = ilLearningProgressBaseGUI::isObjectOffline($item["obj_id"], $item["type"]);
178  }
179  }
180  break;
181  }
182 
183  // #15334
184  foreach ($data as $idx => $row) {
185  if (!$this->isPercentageAvailable($row["obj_id"])) {
186  // #17000 - enable proper (numeric) sorting
187  $data[$idx]["percentage"] = -1;
188  }
189  }
190 
191  $this->setData($data);
192  }
193  }
searchObjects(array $filter, $permission, array $preset_obj_ids=null, $a_check_lp_activation=true)
Search objects that match current filters.
static getObjectsStatusForUser($a_user_id, array $obj_refs)
static getSCOsStatusForUser($a_user_id, $a_parent_obj_id, array $a_sco_ids)
static getSubItemsStatusForUser($a_user_id, $a_parent_obj_id, array $a_item_ids)
Get subitems status.
static isObjectOffline($a_obj_id, $a_type=null)
$row
static getObjectivesStatusForUser($a_user_id, $a_obj_id, array $a_objective_ids)
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)
getCurrentFilter($as_query=false)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ numericOrdering()

ilLPProgressTableGUI::numericOrdering (   $a_field)

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

128  {
129  return ($a_field == "percentage"); // #15041
130  }

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