ILIAS  release_4-4 Revision
•All Data Structures Namespaces Files Functions Variables Modules Pages
Public Member Functions | Protected Member Functions | Protected Attributes
ilTrMatrixTableGUI Class Reference

name table More...

+ Inheritance diagram for ilTrMatrixTableGUI:
+ Collaboration diagram for ilTrMatrixTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $ref_id)
 Constructor. More...
 
 initFilter ()
 
 getSelectableColumns ()
 
 getItems (array $a_user_fields, array $a_privary_fields=null)
 
 fillRow (array $a_set)
 
- 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)
 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)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val)
 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="")
 Add Command button. 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 ()
 
- 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

 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 Row. 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...
 

Protected Attributes

 $obj_ids = NULL
 
 $objective_ids = NULL
 
 $sco_ids = NULL
 
 $subitem_ids = NULL
 
 $in_course
 
 $in_group
 
 $privacy_fields
 
- 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 = 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
 
 $row_selector_label
 

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
 

Detailed Description

name table

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

Definition at line 14 of file class.ilTrMatrixTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTrMatrixTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $ref_id 
)

Constructor.

Definition at line 27 of file class.ilTrMatrixTableGUI.php.

References ilTableGUI\$icon, $ilCtrl, $lng, $ref_id, ilTableGUI\$title, ilObject\_lookupObjId(), ilTable2GUI\addColumn(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), initFilter(), ilLPTableBaseGUI\parseTitle(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTableGUI\setLimit(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setShowTemplates().

28  {
29  global $ilCtrl, $lng, $tree;
30 
31  $this->setId("trsmtx_".$ref_id);
32  $this->ref_id = $ref_id;
33  $this->obj_id = ilObject::_lookupObjId($ref_id);
34 
35  $this->in_group = $tree->checkForParentType($this->ref_id, "grp");
36  if($this->in_group)
37  {
38  $this->in_group = ilObject::_lookupObjId($this->in_group);
39  }
40  else
41  {
42  $this->in_course = $tree->checkForParentType($this->ref_id, "crs");
43  if($this->in_course)
44  {
45  $this->in_course = ilObject::_lookupObjId($this->in_course);
46  }
47  }
48 
49  $this->initFilter();
50 
51  parent::__construct($a_parent_obj, $a_parent_cmd);
52  $this->setLimit(9999);
53  $this->parseTitle($this->obj_id, "trac_matrix");
54 
55  $this->setEnableHeader(true);
56  $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
57  $this->setRowTemplate("tpl.user_object_matrix_row.html", "Services/Tracking");
58  $this->setDefaultOrderField("login");
59  $this->setDefaultOrderDirection("asc");
60  $this->setShowTemplates(true);
61 
62  $this->addColumn($this->lng->txt("login"), "login");
63 
64  $labels = $this->getSelectableColumns();
65  $selected = $this->getSelectedColumns();
66  foreach ($selected as $c)
67  {
68  $title = $labels[$c]["txt"];
69  $tooltip = "";
70  if(isset($labels[$c]["icon"]))
71  {
72  $alt = $lng->txt($labels[$c]["type"]);
73  $icon = '<img src="'.$labels[$c]["icon"].'" alt="'.$alt.'" />';
74  if(sizeof($selected) > 5)
75  {
76  $tooltip = $title;
77  $title = $icon;
78  }
79  else
80  {
81  $title = $icon.' '.$title;
82  }
83  }
84 
85  if(isset($labels[$c]["id"]))
86  {
87  $sort_id = $labels[$c]["id"];
88  }
89  else
90  {
91  // list cannot be sorted by udf fields (separate query)
92  $sort_id = (substr($c, 0, 4) == "udf_") ? "" : $c;
93  }
94 
95  $this->addColumn($title, $sort_id, "", false, "", $tooltip);
96  }
97 
98  $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
99  }
ilTable2GUI\setDefaultOrderField
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
Definition: class.ilTable2GUI.php:1115
ilTable2GUI\setExportFormats
setExportFormats(array $formats)
Set available export formats.
Definition: class.ilTable2GUI.php:2979
ilTable2GUI\setShowTemplates
setShowTemplates($a_value)
Toggle templates.
Definition: class.ilTable2GUI.php:2848
ilLPTableBaseGUI\parseTitle
parseTitle($a_obj_id, $action, $a_user_id=false)
Definition: class.ilLPTableBaseGUI.php:591
ilTable2GUI\setId
setId($a_val)
Set id.
Definition: class.ilTable2GUI.php:959
$ilCtrl
global $ilCtrl
Definition: ilias.php:18
ilTable2GUI\setDefaultOrderDirection
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
Definition: class.ilTable2GUI.php:1135
ilTableGUI\setLimit
setLimit($a_limit=0, $a_default_limit=0)
set max.
Definition: class.ilTableGUI.php:286
ilTable2GUI\addColumn
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="")
Add a column to the header.
Definition: class.ilTable2GUI.php:1276
ilObject\_lookupObjId
static _lookupObjId($a_id)
Definition: class.ilObject.php:1028
ilTable2GUI\getSelectedColumns
getSelectedColumns()
Get selected columns.
Definition: class.ilTable2GUI.php:293
ilTable2GUI\setRowTemplate
setRowTemplate($a_template, $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:1104
$ref_id
$ref_id
Definition: sahs_server.php:39
$lng
global $lng
Definition: privfeed.php:40
ilTable2GUI\setFormAction
setFormAction($a_form_action)
Set Form action parameter.
Definition: class.ilTable2GUI.php:919
ilTable2GUI\setEnableHeader
setEnableHeader($a_enableheader)
Set Enable Header.
Definition: class.ilTable2GUI.php:461
+ Here is the call graph for this function:

Member Function Documentation

◆ fillHeaderCSV()

ilTrMatrixTableGUI::fillHeaderCSV (   $a_csv)
protected

Definition at line 511 of file class.ilTrMatrixTableGUI.php.

References getSelectableColumns(), and ilTable2GUI\getSelectedColumns().

512  {
513  global $ilObjDataCache;
514 
515  $a_csv->addColumn($this->lng->txt("login"));
516 
517  $labels = $this->getSelectableColumns();
518  foreach ($this->getSelectedColumns() as $c)
519  {
520  if(substr($c, 0, 4) == "obj_")
521  {
522  $obj_id = substr($c, 4);
523  $type = $ilObjDataCache->lookupType($obj_id);
524  $a_csv->addColumn("(".$this->lng->txt($type).") ".$labels[$c]["txt"]);
525 
526  if(is_array($this->perc_map) && $this->perc_map[$obj_id])
527  {
528  $a_csv->addColumn($this->lng->txt("trac_percentage")." (%)");
529  }
530  }
531  else
532  {
533  $a_csv->addColumn($labels[$c]["txt"]);
534  }
535  }
536 
537  $a_csv->addRow();
538  }
ilTable2GUI\getSelectedColumns
getSelectedColumns()
Get selected columns.
Definition: class.ilTable2GUI.php:293
+ Here is the call graph for this function:

◆ fillHeaderExcel()

ilTrMatrixTableGUI::fillHeaderExcel (   $worksheet,
&  $a_row 
)
protected

Definition at line 432 of file class.ilTrMatrixTableGUI.php.

References getSelectableColumns(), and ilTable2GUI\getSelectedColumns().

433  {
434  global $ilObjDataCache;
435 
436  $worksheet->write($a_row, 0, $this->lng->txt("login"));
437 
438  $labels = $this->getSelectableColumns();
439  $cnt = 1;
440  foreach ($this->getSelectedColumns() as $c)
441  {
442  if(substr($c, 0, 4) == "obj_")
443  {
444  $obj_id = substr($c, 4);
445  $type = $ilObjDataCache->lookupType($obj_id);
446  $worksheet->write($a_row, $cnt, "(".$this->lng->txt($type).") ".$labels[$c]["txt"]);
447 
448  if(is_array($this->perc_map) && $this->perc_map[$obj_id])
449  {
450  $cnt++;
451  $worksheet->write($a_row, $cnt, $this->lng->txt("trac_percentage")." (%)");
452  }
453  }
454  else
455  {
456  $worksheet->write($a_row, $cnt, $labels[$c]["txt"]);
457  }
458  $cnt++;
459  }
460  }
ilTable2GUI\getSelectedColumns
getSelectedColumns()
Get selected columns.
Definition: class.ilTable2GUI.php:293
+ Here is the call graph for this function:

◆ fillRow()

ilTrMatrixTableGUI::fillRow ( array  $a_set)

Definition at line 346 of file class.ilTrMatrixTableGUI.php.

References ilTableGUI\$data, $lng, ilUtil\getImagePath(), ilTable2GUI\getSelectedColumns(), IL_CAL_UNIX, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPTableBaseGUI\parseValue(), and ilLPTableBaseGUI\showTimingsWarning().

347  {
348  global $lng;
349 
350  // #7694
351  if(!$a_set["active"])
352  {
353  $this->tpl->setCurrentBlock('inactive_bl');
354  $this->tpl->setVariable('TXT_INACTIVE', $lng->txt("inactive"));
355  $this->tpl->parseCurrentBlock();
356  }
357 
358  $this->tpl->setVariable("VAL_LOGIN", $a_set["login"]);
359 
360  foreach ($this->getSelectedColumns() as $c)
361  {
362  switch($c)
363  {
364  case (substr($c, 0, 4) == "obj_"):
365  $obj_id = substr($c, 4);
366  if(!isset($a_set["objects"][$obj_id]))
367  {
368  $data = array("status"=>0);
369  }
370  else
371  {
372  $data = $a_set["objects"][$obj_id];
373  if($data["percentage"] == "0")
374  {
375  $data["percentage"] = NULL;
376  }
377  }
378 
379  if($data['status'] != ilLPStatus::LP_STATUS_COMPLETED_NUM)
380  {
381  $timing = $this->showTimingsWarning($this->ref_ids[$obj_id], $a_set["usr_id"]);
382  if($timing)
383  {
384  if($timing !== true)
385  {
386  $timing = ": ".ilDatePresentation::formatDate(new ilDate($timing, IL_CAL_UNIX));
387  }
388  else
389  {
390  $timing = "";
391  }
392  $this->tpl->setCurrentBlock('warning_img');
393  $this->tpl->setVariable('WARNING_IMG', ilUtil::getImagePath('time_warn.png'));
394  $this->tpl->setVariable('WARNING_ALT', $this->lng->txt('trac_time_passed').$timing);
395  $this->tpl->parseCurrentBlock();
396  }
397  }
398 
399  $this->tpl->setCurrentBlock("objects");
400  $this->tpl->setVariable("VAL_STATUS", $this->parseValue("status", $data["status"], ""));
401  $this->tpl->setVariable("VAL_PERCENTAGE", $this->parseValue("percentage", $data["percentage"], ""));
402  $this->tpl->parseCurrentBlock();
403  break;
404 
405 
406  case (substr($c, 0, 6) == "objtv_"):
407  case (substr($c, 0, 7) == "objsco_"):
408  case (substr($c, 0, 7) == "objsub_"):
409  $obj_id = $c;
410  if(!isset($a_set["objects"][$obj_id]))
411  {
412  $data = array("status"=>0);
413  }
414  else
415  {
416  $data = $a_set["objects"][$obj_id];
417  }
418  $this->tpl->setCurrentBlock("objects");
419  $this->tpl->setVariable("VAL_STATUS", $this->parseValue("status", $data["status"], ""));
420  $this->tpl->parseCurrentBlock();
421  break;
422 
423  default:
424  $this->tpl->setCurrentBlock("user_field");
425  $this->tpl->setVariable("VAL_UF", $this->parseValue($c, $a_set[$c], ""));
426  $this->tpl->parseCurrentBlock();
427  break;
428  }
429  }
430  }
ilLPStatus\LP_STATUS_COMPLETED_NUM
const LP_STATUS_COMPLETED_NUM
Definition: class.ilLPStatus.php:30
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:11
ilLPTableBaseGUI\parseValue
parseValue($id, $value, $type)
Definition: class.ilLPTableBaseGUI.php:384
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:107
ilTable2GUI\getSelectedColumns
getSelectedColumns()
Get selected columns.
Definition: class.ilTable2GUI.php:293
$lng
global $lng
Definition: privfeed.php:40
ilLPTableBaseGUI\showTimingsWarning
showTimingsWarning($a_ref_id, $a_user_id)
Definition: class.ilLPTableBaseGUI.php:678
+ Here is the call graph for this function:

◆ fillRowCSV()

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

Definition at line 540 of file class.ilTrMatrixTableGUI.php.

References ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\getSelectedColumns(), and ilLPTableBaseGUI\parseValue().

541  {
542  $a_csv->addColumn($a_set["login"]);
543 
544  foreach ($this->getSelectedColumns() as $c)
545  {
546  switch($c)
547  {
548  case (substr($c, 0, 4) == "obj_"):
549  $obj_id = substr($c, 4);
550  $val = ilLearningProgressBaseGUI::_getStatusText((int)$a_set["objects"][$obj_id]["status"]);
551  $a_csv->addColumn($val);
552 
553  if(is_array($this->perc_map) && $this->perc_map[$obj_id])
554  {
555  $perc = (int)$a_set["objects"][$obj_id]["percentage"];
556  if(!$perc)
557  {
558  $perc = null;
559  }
560  $a_csv->addColumn($perc);
561  }
562  break;
563 
564  case (substr($c, 0, 6) == "objtv_"):
565  case (substr($c, 0, 7) == "objsco_"):
566  case (substr($c, 0, 7) == "objsub_"):
567  $obj_id = $c;
568  $val = ilLearningProgressBaseGUI::_getStatusText((int)$a_set["objects"][$obj_id]["status"]);
569  $a_csv->addColumn($val);
570  break;
571 
572  /* #14142
573  case "last_access":
574  case "spent_seconds":
575  case "status_changed":
576  */
577  default:
578  $val = $this->parseValue($c, $a_set[$c], "user");
579  $a_csv->addColumn($val);
580  break;
581 
582  }
583  }
584 
585  $a_csv->addRow();
586  }
ilLPTableBaseGUI\parseValue
parseValue($id, $value, $type)
Definition: class.ilLPTableBaseGUI.php:384
ilLearningProgressBaseGUI\_getStatusText
_getStatusText($a_status)
Get status alt text.
Definition: class.ilLearningProgressBaseGUI.php:361
ilTable2GUI\getSelectedColumns
getSelectedColumns()
Get selected columns.
Definition: class.ilTable2GUI.php:293
+ Here is the call graph for this function:

◆ fillRowExcel()

ilTrMatrixTableGUI::fillRowExcel (   $worksheet,
&  $a_row,
  $a_set 
)
protected

Definition at line 462 of file class.ilTrMatrixTableGUI.php.

References ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\getSelectedColumns(), and ilLPTableBaseGUI\parseValue().

463  {
464  $worksheet->write($a_row, 0, $a_set["login"]);
465 
466  $cnt = 1;
467  foreach ($this->getSelectedColumns() as $c)
468  {
469  switch($c)
470  {
471  case (substr($c, 0, 4) == "obj_"):
472  $obj_id = substr($c, 4);
473  $val = ilLearningProgressBaseGUI::_getStatusText((int)$a_set["objects"][$obj_id]["status"]);
474  $worksheet->write($a_row, $cnt, $val);
475 
476  if(is_array($this->perc_map) && $this->perc_map[$obj_id])
477  {
478  $cnt++;
479  $perc = (int)$a_set["objects"][$obj_id]["percentage"];
480  if(!$perc)
481  {
482  $perc = null;
483  }
484  $worksheet->write($a_row, $cnt, $perc);
485  }
486  break;
487 
488  case (substr($c, 0, 6) == "objtv_"):
489  case (substr($c, 0, 7) == "objsco_"):
490  case (substr($c, 0, 7) == "objsub_"):
491  $obj_id = $c;
492  $val = ilLearningProgressBaseGUI::_getStatusText((int)$a_set["objects"][$obj_id]["status"]);
493  $worksheet->write($a_row, $cnt, $val);
494  break;
495 
496  /* #14142
497  case "last_access":
498  case "spent_seconds":
499  case "status_changed":
500  */
501  default:
502  $val = $this->parseValue($c, $a_set[$c], "user");
503  $worksheet->write($a_row, $cnt, $val);
504  break;
505 
506  }
507  $cnt++;
508  }
509  }
ilLPTableBaseGUI\parseValue
parseValue($id, $value, $type)
Definition: class.ilLPTableBaseGUI.php:384
ilLearningProgressBaseGUI\_getStatusText
_getStatusText($a_status)
Get status alt text.
Definition: class.ilLearningProgressBaseGUI.php:361
ilTable2GUI\getSelectedColumns
getSelectedColumns()
Get selected columns.
Definition: class.ilTable2GUI.php:293
+ Here is the call graph for this function:

◆ getItems()

ilTrMatrixTableGUI::getItems ( array  $a_user_fields,
array  $a_privary_fields = null 
)

Definition at line 202 of file class.ilTrMatrixTableGUI.php.

References ilTableGUI\$data, $in_course, $in_group, $row, ilPrivacySettings\_getInstance(), ilTrQuery\getObjectIds(), ilTrQuery\getUserObjectiveMatrix(), ilTrQuery\getUserObjectMatrix(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ilTable2GUI\setData(), and ilTableGUI\setMaxCount().

Referenced by getSelectableColumns().

203  {
204  include_once("./Services/Tracking/classes/class.ilTrQuery.php");
205  $collection = ilTrQuery::getObjectIds($this->obj_id, $this->ref_id, true);
206  if($collection["object_ids"])
207  {
208  // we need these for the timing warnings
209  $this->ref_ids = $collection["ref_ids"];
210 
211  // only if object is [part of] course/group
212  $check_agreement = false;
213  if($this->in_course)
214  {
215  // privacy (if course agreement is activated)
216  include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
217  $privacy = ilPrivacySettings::_getInstance();
218  if($privacy->courseConfirmationRequired())
219  {
220  $check_agreement = $this->in_course;
221  }
222  }
223  else if($this->in_group)
224  {
225  // privacy (if group agreement is activated)
226  include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
227  $privacy = ilPrivacySettings::_getInstance();
228  if($privacy->groupConfirmationRequired())
229  {
230  $check_agreement = $this->in_group;
231  }
232  }
233 
234  $data = ilTrQuery::getUserObjectMatrix($this->ref_id, $collection["object_ids"], $this->filter["name"], $a_user_fields, $a_privary_fields, $check_agreement);
235  if($collection["objectives_parent_id"] && $data["users"])
236  {
237  $objectives = ilTrQuery::getUserObjectiveMatrix($collection["objectives_parent_id"], $data["users"]);
238  if($objectives["cnt"])
239  {
240  $this->objective_ids = array();
241  $objective_columns = array();
242  foreach($objectives["set"] as $row)
243  {
244  if(isset($data["set"][$row["usr_id"]]))
245  {
246  $obj_id = "objtv_".$row["obj_id"];
247  $data["set"][$row["usr_id"]]["objects"][$obj_id] = array("status"=>$row["status"]);
248 
249  if(!in_array($obj_id, $this->objective_ids))
250  {
251  $this->objective_ids[$obj_id] = $row["title"];
252  }
253  }
254  }
255  }
256  }
257 
258  if($collection["scorm"] && $data["set"])
259  {
260  $this->sco_ids = array();
261  foreach(array_keys($data["set"]) as $user_id)
262  {
263  foreach($collection["scorm"]["scos"] as $sco)
264  {
265  if(!in_array($sco, $this->sco_ids))
266  {
267  $this->sco_ids[$sco] = $collection["scorm"]["scos_title"][$sco];
268  }
269 
270  // alex, 5 Nov 2011: we got users being in failed and in
271  // completed status, I changed the setting in: first check failed
272  // then check completed since failed should superseed completed
273  // (before completed has been checked before failed)
274  $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
275  if(in_array($user_id, $collection["scorm"]["failed"][$sco]))
276  {
277  $status = ilLPStatus::LP_STATUS_FAILED_NUM;
278  }
279  else if(in_array($user_id, $collection["scorm"]["completed"][$sco]))
280  {
281  $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
282  }
283  else if(in_array($user_id, $collection["scorm"]["in_progress"][$sco]))
284  {
285  $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
286  }
287 
288  $obj_id = "objsco_".$sco;
289  $data["set"][$user_id]["objects"][$obj_id] = array("status"=>$status);
290  }
291  }
292  }
293 
294  if($collection["subitems"] && $data["set"])
295  {
296  foreach(array_keys($data["set"]) as $user_id)
297  {
298  foreach($collection["subitems"]["items"] as $item_id)
299  {
300  $this->subitem_ids[$item_id] = $collection["subitems"]["item_titles"][$item_id];
301 
302  $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
303  if(in_array($user_id, $collection["subitems"]["completed"][$item_id]))
304  {
305  $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
306  }
307  else if(is_array($collection["subitems"]["in_progress"]) &&
308  in_array($user_id, $collection["subitems"]["in_progress"][$item_id]))
309  {
310  $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
311  }
312 
313  $obj_id = "objsub_".$item_id;
314  $data["set"][$user_id]["objects"][$obj_id] = array("status"=>$status);
315  }
316  }
317  }
318 
319  // percentage export
320  if($data["set"])
321  {
322  $this->perc_map = array();
323  foreach($data["set"] as $item)
324  {
325  if(is_array($item["objects"]))
326  {
327  foreach($item["objects"] as $obj_id => $obj_data)
328  {
329  if((int)$obj_data["percentage"] > 0)
330  {
331  $this->perc_map[$obj_id] = true;
332  }
333  }
334  }
335  }
336  }
337 
338  $this->setMaxCount($data["cnt"]);
339  $this->setData($data["set"]);
340 
341  return $collection["object_ids"];
342  }
343  return false;
344  }
ilLPStatus\LP_STATUS_COMPLETED_NUM
const LP_STATUS_COMPLETED_NUM
Definition: class.ilLPStatus.php:30
ilLPStatus\LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_IN_PROGRESS_NUM
Definition: class.ilLPStatus.php:29
ilTrQuery\getObjectIds
static getObjectIds($a_parent_obj_id, $a_parent_ref_id=false, $use_collection=true, $a_refresh_status=true, $a_user_ids=null)
Get (sub)objects for given object, also handles learning objectives (course only) ...
Definition: class.ilTrQuery.php:1224
ilTrQuery\getUserObjectiveMatrix
static getUserObjectiveMatrix($a_parent_obj_id, $a_users)
Definition: class.ilTrQuery.php:1526
ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM
Definition: class.ilLPStatus.php:28
ilTrQuery\getUserObjectMatrix
static getUserObjectMatrix($a_parent_ref_id, $a_obj_ids, $a_user_filter=NULL, array $a_additional_fields=null, array $a_privacy_fields=null, $a_check_agreement=null)
Get status matrix for users on objects.
Definition: class.ilTrQuery.php:1446
ilPrivacySettings\_getInstance
static _getInstance()
Get instance of ilPrivacySettings.
Definition: class.ilPrivacySettings.php:77
ilTableGUI\setMaxCount
setMaxCount($a_max_count)
set max.
Definition: class.ilTableGUI.php:270
ilLPStatus\LP_STATUS_FAILED_NUM
const LP_STATUS_FAILED_NUM
Definition: class.ilLPStatus.php:31
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSelectableColumns()

ilTrMatrixTableGUI::getSelectableColumns ( )

Definition at line 109 of file class.ilTrMatrixTableGUI.php.

References $columns, ilTableGUI\$icon, $sess, ilTableGUI\$title, ilObject\_getIcon(), getItems(), ilLPTableBaseGUI\getSelectableUserColumns(), and ilUtil\getTypeIconPath().

Referenced by __construct(), fillHeaderCSV(), and fillHeaderExcel().

110  {
111  global $ilObjDataCache;
112 
113  $user_cols = $this->getSelectableUserColumns($this->in_course, $this->in_group);
114 
115  if($this->obj_ids === NULL)
116  {
117  // we cannot use the selected columns because they are not ready yet
118  // so we use all available columns, should be ok anyways
119  $this->obj_ids = $this->getItems(array_keys($user_cols[0]), $user_cols[1]);
120  }
121  if($this->obj_ids)
122  {
123  $tmp_cols = array();
124  foreach($this->obj_ids as $obj_id)
125  {
126  if($obj_id == $this->obj_id)
127  {
128  $parent = array("txt" => $this->lng->txt("status"),
129  "default" => true);
130  }
131  else
132  {
133  $title = $ilObjDataCache->lookupTitle($obj_id);
134  $type = $ilObjDataCache->lookupType($obj_id);
135  $icon = ilObject::_getIcon("", "tiny", $type);
136  if($type == "sess")
137  {
138  include_once "Modules/Session/classes/class.ilObjSession.php";
139  $sess = new ilObjSession($obj_id, false);
140  $title = $sess->getPresentationTitle();
141  }
142  $tmp_cols[strtolower($title)."#~#obj_".$obj_id] = array("txt" => $title, "icon" => $icon, "type" => $type, "default" => true);
143  }
144  }
145  if(sizeof($this->objective_ids))
146  {
147  foreach($this->objective_ids as $obj_id => $title)
148  {
149  $tmp_cols[strtolower($title)."#~#objtv_".$obj_id] = array("txt" => $title, "default" => true);
150  }
151  }
152  if(sizeof($this->sco_ids))
153  {
154  foreach($this->sco_ids as $obj_id => $title)
155  {
156  $icon = ilUtil::getTypeIconPath("sco", $obj_id, "tiny");
157  $tmp_cols[strtolower($title)."#~#objsco_".$obj_id] = array("txt" => $title, "icon"=>$icon, "default" => true);
158  }
159  }
160  if(sizeof($this->subitem_ids))
161  {
162  foreach($this->subitem_ids as $obj_id => $title)
163  {
164  $icon = ilUtil::getTypeIconPath("st", $obj_id, "tiny");
165  $tmp_cols[strtolower($title)."#~#objsub_".$obj_id] = array("txt" => $title, "icon"=>$icon, "default" => true);
166  }
167  }
168 
169  // alex, 5 Nov 2011: Do not sort SCORM items or "chapters"
170  if(!sizeof($this->sco_ids) && !sizeof($this->subitem_ids))
171  {
172  ksort($tmp_cols);
173  }
174  foreach($tmp_cols as $id => $def)
175  {
176  $id = explode('#~#', $id);
177  $columns[$id[1]] = $def;
178  }
179  unset($tmp_cols);
180 
181  if($parent)
182  {
183  $columns["obj_".$this->obj_id] = $parent;
184  }
185  }
186 
187  unset($user_cols[0]["status"]);
188  unset($user_cols[0]["login"]);
189  foreach($user_cols[0] as $col_id => $col_def)
190  {
191  if(!isset($columns[$col_id]))
192  {
193  // these are all additional fields, no default
194  $col_def["default"] = false;
195  $columns[$col_id] = $col_def;
196  }
197  }
198 
199  return $columns;
200  }
ilLPTableBaseGUI\getSelectableUserColumns
getSelectableUserColumns($a_in_course=false, $a_in_group=false)
Definition: class.ilLPTableBaseGUI.php:839
ilObject\_getIcon
static _getIcon($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
Get icon for repository item.
Definition: class.ilObject.php:1930
ilUtil\getTypeIconPath
static getTypeIconPath($a_type, $a_obj_id, $a_size='small')
Get type icon path path Return image path for icon_xxx.pngs Or (if enabled) path to custom icon...
Definition: class.ilUtil.php:55
ilTrMatrixTableGUI\getItems
getItems(array $a_user_fields, array $a_privary_fields=null)
Definition: class.ilTrMatrixTableGUI.php:202
$sess
$sess
Definition: inc.setup_header.php:115
$columns
if(! $in) $columns
Definition: Utf8Test.php:46
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initFilter()

ilTrMatrixTableGUI::initFilter ( )

Definition at line 101 of file class.ilTrMatrixTableGUI.php.

References $lng, ilTable2GUI\addFilterItemByMetaType(), and ilTable2GUI\FILTER_TEXT.

Referenced by __construct().

102  {
103  global $lng;
104 
105  $item = $this->addFilterItemByMetaType("name", ilTable2GUI::FILTER_TEXT);
106  $this->filter["name"] = $item->getValue();
107  }
ilTable2GUI\addFilterItemByMetaType
addFilterItemByMetaType($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
Add filter by standard type.
Definition: class.ilTable2GUI.php:631
$lng
global $lng
Definition: privfeed.php:40
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $in_course

ilTrMatrixTableGUI::$in_course
protected

Definition at line 20 of file class.ilTrMatrixTableGUI.php.

Referenced by getItems().

◆ $in_group

ilTrMatrixTableGUI::$in_group
protected

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

Referenced by getItems().

◆ $obj_ids

ilTrMatrixTableGUI::$obj_ids = NULL
protected

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

◆ $objective_ids

ilTrMatrixTableGUI::$objective_ids = NULL
protected

Definition at line 17 of file class.ilTrMatrixTableGUI.php.

◆ $privacy_fields

ilTrMatrixTableGUI::$privacy_fields
protected

Definition at line 22 of file class.ilTrMatrixTableGUI.php.

◆ $sco_ids

ilTrMatrixTableGUI::$sco_ids = NULL
protected

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

◆ $subitem_ids

ilTrMatrixTableGUI::$subitem_ids = NULL
protected

Definition at line 19 of file class.ilTrMatrixTableGUI.php.

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