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 () | |
| Init filter. More... | |
| getSelectableColumns () | |
| Get selectable columns. More... | |
| 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="") | |
| Constructor. More... | |
| executeCommand () | |
| Execute command. More... | |
| searchFilterListener ($a_ref_id, $a_data) | |
| Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED @access public. More... | |
| 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) | |
| set table data @access public More... | |
| getData () | |
| dataExists () | |
| setPrefix ($a_prefix) | |
| set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More... | |
| getPrefix () | |
| addFilterItem ($a_input_item, $a_optional=false) | |
| Add filter item. More... | |
| addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL) | |
| Add filter by standard type. More... | |
| getFilterItems ($a_optionals=false) | |
| Get filter items. More... | |
| getFilterItemByPostVar ($a_post_var) | |
| setFilterCols ($a_val) | |
| Set filter columns. More... | |
| getFilterCols () | |
| Get filter columns. More... | |
| setDisableFilterHiding ($a_val=true) | |
| Set disable filter hiding. More... | |
| getDisableFilterHiding () | |
| Get disable filter hiding More... | |
| isFilterSelected ($a_col) | |
| Is given filter selected? More... | |
| getSelectedFilters () | |
| Get selected filters. More... | |
| determineSelectedFilters () | |
| Determine selected filters. More... | |
| setCustomPreviousNext ($a_prev_link, $a_next_link) | |
| Set custom previous/next links. More... | |
| setFormAction ($a_form_action, $a_multipart=false) | |
| Set Form action parameter. More... | |
| getFormAction () | |
| Get Form action parameter. More... | |
| setFormName ($a_formname) | |
| Set Form name. More... | |
| getFormName () | |
| Get Form name. More... | |
| setId ($a_val) | |
| Set id. More... | |
| getId () | |
| Get element id. More... | |
| setDisplayAsBlock ($a_val) | |
| Set display as block. More... | |
| getDisplayAsBlock () | |
| Get display as block. More... | |
| getSelectAllCheckbox () | |
| Get the name of the checkbox that should be toggled with a select all button. More... | |
| setSelectAllCheckbox ($a_select_all_checkbox) | |
| Set the name of the checkbox that should be toggled with a select all button. More... | |
| setExternalSorting ($a_val) | |
| Set external sorting. More... | |
| getExternalSorting () | |
| Get external sorting. More... | |
| setFilterCommand ($a_val, $a_caption=null) | |
| Set filter command. More... | |
| getFilterCommand () | |
| Get filter command. More... | |
| setResetCommand ($a_val, $a_caption=null) | |
| Set reset filter command. More... | |
| getResetCommand () | |
| Get reset filter command. More... | |
| setExternalSegmentation ($a_val) | |
| Set external segmentation. More... | |
| getExternalSegmentation () | |
| Get external segmentation. More... | |
| setRowTemplate ($a_template, $a_template_dir="") | |
| Set row template. More... | |
| setDefaultOrderField ($a_defaultorderfield) | |
| Set Default order field. More... | |
| getDefaultOrderField () | |
| Get Default order field. More... | |
| setDefaultOrderDirection ($a_defaultorderdirection) | |
| Set Default order direction. More... | |
| getDefaultOrderDirection () | |
| Get Default order direction. More... | |
| clearCommandButtons () | |
| addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null) | |
| Add Command button. More... | |
| addCommandButtonInstance (ilButtonBase $a_button) | |
| Add Command button instance. More... | |
| addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='') | |
| Add Selection List + Command button. More... | |
| addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='') | |
| Add Selection List + Command button for selected items. More... | |
| setCloseCommand ($a_link) | |
| Add command for closing table. More... | |
| addMultiCommand ($a_cmd, $a_text) | |
| Add Command button. More... | |
| addHiddenInput ($a_name, $a_value) | |
| Add Hidden Input field. More... | |
| addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="") | |
| Add Header Command (Link) (Image needed for now) More... | |
| setTopCommands ($a_val) | |
| Set top commands (display command buttons on top of table, too) More... | |
| getTopCommands () | |
| Get top commands (display command buttons on top of table, too) More... | |
| addColumn ($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false) | |
| Add a column to the header. More... | |
| getNavParameter () | |
| setOrderLink ($sort_field, $order_dir) | |
| fillHeader () | |
| determineOffsetAndOrder ($a_omit_offset=false) | |
| Determine offset and order. More... | |
| storeNavParameter () | |
| getHTML () | |
| Get HTML. More... | |
| numericOrdering ($a_field) | |
| Should this field be sorted numeric? More... | |
| render () | |
| render table @access public More... | |
| writeFilterToSession () | |
| Write filter values to session. More... | |
| resetFilter () | |
| Reset filter. More... | |
| fillFooter () | |
| Fill footer row. More... | |
| getLinkbar ($a_num) | |
| Get previous/next linkbar. More... | |
| fillHiddenRow () | |
| fillActionRow () | |
| Fill Action Row. More... | |
| setHeaderHTML ($html) | |
| set header html More... | |
| storeProperty ($type, $value) | |
| Store table property. More... | |
| loadProperty ($type) | |
| Load table property. More... | |
| getCurrentState () | |
| get current settings for order, limit, columns and filter More... | |
| setContext ($id) | |
| Set context. More... | |
| getContext () | |
| Get context. More... | |
| setShowRowsSelector ($a_value) | |
| Toggle rows-per-page selector. More... | |
| getShowRowsSelector () | |
| Get rows-per-page selector state. More... | |
| setShowTemplates ($a_value) | |
| Toggle templates. More... | |
| getShowTemplates () | |
| Get template state. More... | |
| restoreTemplate ($a_name) | |
| Restore state from template. More... | |
| saveTemplate ($a_name) | |
| Save current state as template. More... | |
| deleteTemplate ($a_name) | |
| Delete template. More... | |
| getLimit () | |
| Get limit. More... | |
| getOffset () | |
| Get offset. More... | |
| setExportFormats (array $formats) | |
| Set available export formats. More... | |
| setPrintMode ($a_value=false) | |
| Toogle print mode. More... | |
| getPrintMode () | |
| Get print mode. More... | |
| getExportMode () | |
| Was export activated? More... | |
| exportData ($format, $send=false) | |
| Export and optionally send current table data. More... | |
| setEnableAllCommand ($a_value) | |
| Enable actions for all entries in current result. More... | |
| setRowSelectorLabel ($row_selector_label) | |
| getRowSelectorLabel () | |
| setPreventDoubleSubmission ($a_val) | |
| Set prevent double submission. More... | |
| getPreventDoubleSubmission () | |
| Get prevent double submission. More... | |
| setLimit ($a_limit=0, $a_default_limit=0) | |
| set max. More... | |
| Public Member Functions inherited from ilTableGUI | |
| ilTableGUI ($a_data=0, $a_global_tpl=true) | |
| Constructor. More... | |
| setTemplate (&$a_tpl) | |
| set template @access public More... | |
| & | getTemplateObject () |
| setData ($a_data) | |
| set table data @access public More... | |
| getData () | |
| setTitle ($a_title, $a_icon=0, $a_icon_alt=0) | |
| set table title @access public More... | |
| setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0) | |
| set table help page @access public More... | |
| setHeaderNames ($a_header_names) | |
| set table header names @access public More... | |
| getColumnCount () | |
| Returns the column count based on the number of the header row columns @access public. More... | |
| setHeaderVars ($a_header_vars, $a_header_params=0) | |
| set table header vars @access public More... | |
| setColumnWidth ($a_column_width) | |
| set table column widths @access public More... | |
| setOneColumnWidth ($a_column_width, $a_column_number) | |
| set one table column width @access public More... | |
| setMaxCount ($a_max_count) | |
| set max. More... | |
| setLimit ($a_limit=0, $a_default_limit=0) | |
| set max. More... | |
| getLimit () | |
| Get limit. More... | |
| setPrefix ($a_prefix) | |
| set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More... | |
| setOffset ($a_offset) | |
| set dataset offset @access public More... | |
| getOffset () | |
| Get offset. More... | |
| setOrderColumn ($a_order_column=0, $a_default_column=0) | |
| set order column @access public More... | |
| getOrderColumn () | |
| Get order column. More... | |
| setOrderDirection ($a_order_direction) | |
| set order direction @access public More... | |
| getOrderDirection () | |
| Get order direction. More... | |
| setFooter ($a_style, $a_previous=0, $a_next=0) | |
| set order direction @access public More... | |
| enable ($a_module_name) | |
| enables particular modules of table More... | |
| disable ($a_module_name) | |
| diesables particular modules of table More... | |
| sortData () | |
| render () | |
| render table @access public More... | |
| renderHeader () | |
| setOrderLink ($key, $order_dir) | |
| setStyle ($a_element, $a_style) | |
| getStyle ($a_element) | |
| setBase ($a_base) | |
| Set Base script name (deprecated, only use this for workarounds). More... | |
| getBase () | |
| Get Base script name (deprecated, only use this for workarounds). More... | |
| getFormName () | |
| setFormName ($a_name="cmd") | |
| getSelectAllCheckbox () | |
| setSelectAllCheckbox ($a_select_all_checkbox) | |
| clearActionButtons () | |
| addActionButton ($btn_name, $btn_value) | |
Protected Member Functions | |
| fillHeaderExcel ($worksheet, &$a_row) | |
| Excel Version of Fill Header. More... | |
| fillRowExcel ($worksheet, &$a_row, $a_set) | |
| Excel Version of Fill Row. More... | |
| fillHeaderCSV ($a_csv) | |
| CSV Version of Fill Header. More... | |
| fillRowCSV ($a_csv, $a_set) | |
| CSV Version of Fill Row. More... | |
| Protected Member Functions inherited from ilLPTableBaseGUI | |
| sendMail (array $a_user_ids, $a_parent_obj, $a_parent_cmd) | |
| searchObjects (array $filter, $permission, array $preset_obj_ids=null, $a_check_lp_activation=true) | |
| Search objects that match current filters. More... | |
| buildPath ($ref_ids) | |
| Build path with deep-link. More... | |
| getPossibleTypes ($a_split_learning_resources=false, $a_include_digilib=false, $a_allow_undefined_lp=false) | |
| Get possible subtypes. More... | |
| parseValue ($id, $value, $type) | |
| isPercentageAvailable ($a_obj_id) | |
| parseTitle ($a_obj_id, $action, $a_user_id=false) | |
| getExportMeta () | |
| Build export meta data. More... | |
| fillMetaExcel ($worksheet, &$a_row) | |
| Add meta information to excel export. More... | |
| fillMetaCSV ($a_csv) | |
| Add meta information to csv export. More... | |
| showTimingsWarning ($a_ref_id, $a_user_id) | |
| formatSeconds ($seconds, $a_shorten_zero=false) | |
| anonymizeValue ($a_value, $a_force_number=false) | |
| buildValueScale ($a_max_value, $a_anonymize=false, $a_format_seconds=false) | |
| getMonthsFilter ($a_short=false) | |
| getMonthsYear ($a_year=null, $a_short=false) | |
| getSelectableUserColumns ($a_in_course=false, $a_in_group=false) | |
| Protected Member Functions inherited from ilTable2GUI | |
| prepareOutput () | |
| Anything that must be done before HTML is generated. 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 ($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 | |
Detailed Description
Constructor & Destructor Documentation
◆ __construct()
| ilTrMatrixTableGUI::__construct | ( | $a_parent_obj, | |
| $a_parent_cmd, | |||
| $ref_id | |||
| ) |
Constructor.
Reimplemented from ilLPTableBaseGUI.
Definition at line 29 of file class.ilTrMatrixTableGUI.php.
30 {
32
34 $this->ref_id = $ref_id;
37
38 $this->in_group = $tree->checkForParentType($this->ref_id, "grp");
39 if($this->in_group)
40 {
41 $this->in_group = ilObject::_lookupObjId($this->in_group);
42 }
43 else
44 {
45 $this->in_course = $tree->checkForParentType($this->ref_id, "crs");
46 if($this->in_course)
47 {
48 $this->in_course = ilObject::_lookupObjId($this->in_course);
49 }
50 }
51
52 // has to be before constructor to work
53 $this->initFilter();
54
55 parent::__construct($a_parent_obj, $a_parent_cmd);
56
57 $this->setLimit(9999);
59
61 $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
66
67 // see ilObjCourseGUI::addMailToMemberButton()
68 include_once "Services/Mail/classes/class.ilMail.php";
70 if($rbacsystem->checkAccess("internal_mail", $mail->getMailObjectReferenceId()))
71 {
74 $this->has_multi = true;
75 }
76
78
79 $labels = $this->getSelectableColumns();
80 $selected = $this->getSelectedColumns();
81 foreach ($selected as $c)
82 {
84
85 if(isset($labels[$c]["no_permission"]) && (bool)$labels[$c]["no_permission"])
86 {
88 }
89
90 $tooltip = array();
91 if(isset($labels[$c]["icon"]))
92 {
95 if(sizeof($selected) > 5)
96 {
97 $tooltip[] = $title;
99 }
100 else
101 {
103 }
104 if($labels[$c]["path"])
105 {
106 $tooltip[] = $labels[$c]["path"];
107 }
108 }
109
110 if(isset($labels[$c]["id"]))
111 {
112 $sort_id = $labels[$c]["id"];
113 }
114 else
115 {
116 // list cannot be sorted by udf fields (separate query)
117 $sort_id = (substr($c, 0, 4) == "udf_") ? "" : $c;
118 }
119
121 }
122
123 $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
124 }
parseTitle($a_obj_id, $action, $a_user_id=false)
Definition: class.ilLPTableBaseGUI.php:657
Class Mail this class handles base functions for mail handling.
Definition: class.ilMail.php:110
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
Definition: class.ilTable2GUI.php:1308
setRowTemplate($a_template, $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:1125
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
Definition: class.ilTable2GUI.php:1136
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
Definition: class.ilTable2GUI.php:935
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
Definition: class.ilTable2GUI.php:1156
References ilTableGUI\$icon, $ilCtrl, $ilUser, $lng, $ref_id, ilTableGUI\$title, ilObject\_lookupObjId(), ilObject\_lookupType(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), initFilter(), ilLPTableBaseGUI\parseTitle(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setShowTemplates().
Here is the call graph for this function:
Member Function Documentation
◆ fillHeaderCSV()
|
protected |
CSV Version of Fill Header.
Likely to be overwritten by derived class.
- Parameters
-
object $a_csv current file
Reimplemented from ilTable2GUI.
Definition at line 623 of file class.ilTrMatrixTableGUI.php.
624 {
625 global $ilObjDataCache;
626
627 $a_csv->addColumn($this->lng->txt("login"));
628
629 $labels = $this->getSelectableColumns();
631 {
632 if(substr($c, 0, 4) == "obj_")
633 {
634 $obj_id = substr($c, 4);
635 $type = $ilObjDataCache->lookupType($obj_id);
636 $a_csv->addColumn("(".$this->lng->txt($type).") ".$labels[$c]["txt"]);
637
638 if(is_array($this->perc_map) && $this->perc_map[$obj_id])
639 {
640 $a_csv->addColumn($this->lng->txt("trac_percentage")." (%)");
641 }
642 }
643 else
644 {
645 $a_csv->addColumn($labels[$c]["txt"]);
646 }
647 }
648
649 $a_csv->addRow();
650 }
References getSelectableColumns(), and ilTable2GUI\getSelectedColumns().
Here is the call graph for this function:
◆ fillHeaderExcel()
|
protected |
Excel Version of Fill Header.
Likely to be overwritten by derived class.
- Parameters
-
object $a_worksheet current sheet int $a_row row counter
Reimplemented from ilTable2GUI.
Definition at line 545 of file class.ilTrMatrixTableGUI.php.
546 {
547 global $ilObjDataCache;
548
549 $worksheet->write($a_row, 0, $this->lng->txt("login"));
550
551 $labels = $this->getSelectableColumns();
552 $cnt = 1;
554 {
555 if(substr($c, 0, 4) == "obj_")
556 {
557 $obj_id = substr($c, 4);
558 $type = $ilObjDataCache->lookupType($obj_id);
559 $worksheet->write($a_row, $cnt, "(".$this->lng->txt($type).") ".$labels[$c]["txt"]);
560
561 if(is_array($this->perc_map) && $this->perc_map[$obj_id])
562 {
563 $cnt++;
564 $worksheet->write($a_row, $cnt, $this->lng->txt("trac_percentage")." (%)");
565 }
566 }
567 else
568 {
569 $worksheet->write($a_row, $cnt, $labels[$c]["txt"]);
570 }
571 $cnt++;
572 }
573 }
References getSelectableColumns(), and ilTable2GUI\getSelectedColumns().
Here is the call graph for this function:
◆ fillRow()
| ilTrMatrixTableGUI::fillRow | ( | array | $a_set | ) |
Definition at line 428 of file class.ilTrMatrixTableGUI.php.
429 {
430 global $lng;
431
432 if($this->has_multi)
433 {
434 $this->tpl->setVariable("USER_ID", $a_set["usr_id"]);
435 }
436
438 {
439 switch($c)
440 {
441 case (substr($c, 0, 4) == "obj_"):
442 $obj_id = substr($c, 4);
443
444 // object without read-lp-permission
445 if(in_array($obj_id, $this->privacy_cols) ||
446 $a_set["privacy_conflict"])
447 {
448 $this->tpl->setCurrentBlock("objects");
449 $this->tpl->setVariable("VAL_STATUS", " ");
450 $this->tpl->parseCurrentBlock();
451 continue;
452 }
453
454 $status = isset($a_set[$c])
455 ? (int)$a_set[$c]
457 $percentage = isset($a_set[$c."_perc"])
458 ? (int)$a_set[$c."_perc"]
459 : null;
460
462 {
464 if($timing)
465 {
466 if($timing !== true)
467 {
469 }
470 else
471 {
472 $timing = "";
473 }
474 $this->tpl->setCurrentBlock('warning_img');
476 $this->tpl->setVariable('WARNING_ALT', $this->lng->txt('trac_time_passed').$timing);
477 $this->tpl->parseCurrentBlock();
478 }
479 }
480
481 $this->tpl->setCurrentBlock("objects");
484 $this->tpl->parseCurrentBlock();
485 break;
486
487
488 case (substr($c, 0, 6) == "objtv_"):
489 case (substr($c, 0, 7) == "objsco_"):
490 case (substr($c, 0, 7) == "objsub_"):
491 $status = isset($a_set[$c])
492 ? (int)$a_set[$c]
494
495 $this->tpl->setCurrentBlock("objects");
496 if(!$a_set["privacy_conflict"])
497 {
499 }
500 else
501 {
502 $this->tpl->setVariable("VAL_STATUS", " ");
503 }
504 $this->tpl->parseCurrentBlock();
505 break;
506
507 default:
508 $this->tpl->setCurrentBlock("user_field");
509 if(!$a_set["privacy_conflict"])
510 {
512 }
513 else
514 {
515 $this->tpl->setVariable("VAL_UF", " ");
516 }
517 $this->tpl->parseCurrentBlock();
518 break;
519 }
520 }
521
522 // #7694
523 if(!$a_set["active"] || $a_set["privacy_conflict"])
524 {
525 $mess = array();
526 if($a_set["privacy_conflict"])
527 {
529 }
530 else if(!$a_set["active"])
531 {
533 }
534 $this->tpl->setCurrentBlock('inactive_bl');
535 $this->tpl->setVariable('TXT_INACTIVE', implode(", ", $mess));
536 $this->tpl->parseCurrentBlock();
537 }
538
539 $login = !$a_set["privacy_conflict"]
540 ? $a_set["login"]
541 : " ";
542 $this->tpl->setVariable("VAL_LOGIN", $login);
543 }
const LP_STATUS_NOT_ATTEMPTED_NUM
Definition: class.ilLPStatus.php:28
showTimingsWarning($a_ref_id, $a_user_id)
Definition: class.ilLPTableBaseGUI.php:752
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
Definition: class.ilUtil.php:71
References $lng, ilUtil\getImagePath(), ilTable2GUI\getSelectedColumns(), IL_CAL_UNIX, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ilLPTableBaseGUI\parseValue(), and ilLPTableBaseGUI\showTimingsWarning().
Here is the call graph for this function:
◆ fillRowCSV()
|
protected |
CSV Version of Fill Row.
Most likely to be overwritten by derived class.
- Parameters
-
object $a_csv current file array $a_set data array
Reimplemented from ilTable2GUI.
Definition at line 652 of file class.ilTrMatrixTableGUI.php.
653 {
654 $a_csv->addColumn($a_set["login"]);
655
657 {
658 switch($c)
659 {
660 case (substr($c, 0, 4) == "obj_"):
661 $obj_id = substr($c, 4);
663 $a_csv->addColumn($val);
664
665 if(is_array($this->perc_map) && $this->perc_map[$obj_id])
666 {
667 $perc = (int)$a_set[$c."_perc"];
668 if(!$perc)
669 {
670 $perc = null;
671 }
672 $a_csv->addColumn($perc);
673 }
674 break;
675
676 case (substr($c, 0, 6) == "objtv_"):
677 case (substr($c, 0, 7) == "objsco_"):
678 case (substr($c, 0, 7) == "objsub_"):
680 $a_csv->addColumn($val);
681 break;
682
683 /* #14142
684 case "last_access":
685 case "spent_seconds":
686 case "status_changed":
687 */
688 default:
690 $a_csv->addColumn($val);
691 break;
692
693 }
694 }
695
696 $a_csv->addRow();
697 }
_getStatusText($a_status, $a_lng=null)
Get status alt text.
Definition: class.ilLearningProgressBaseGUI.php:349
References ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\getSelectedColumns(), and ilLPTableBaseGUI\parseValue().
Here is the call graph for this function:
◆ fillRowExcel()
|
protected |
Excel Version of Fill Row.
Most likely to be overwritten by derived class.
- Parameters
-
object $a_worksheet current sheet int $a_row row counter array $a_set data array
Reimplemented from ilTable2GUI.
Definition at line 575 of file class.ilTrMatrixTableGUI.php.
576 {
577 $worksheet->write($a_row, 0, $a_set["login"]);
578
579 $cnt = 1;
581 {
582 switch($c)
583 {
584 case (substr($c, 0, 4) == "obj_"):
585 $obj_id = substr($c, 4);
587 $worksheet->write($a_row, $cnt, $val);
588
589 if(is_array($this->perc_map) && $this->perc_map[$obj_id])
590 {
591 $cnt++;
592 $perc = (int)$a_set[$c."_perc"];
593 if(!$perc)
594 {
595 $perc = null;
596 }
597 $worksheet->write($a_row, $cnt, $perc);
598 }
599 break;
600
601 case (substr($c, 0, 6) == "objtv_"):
602 case (substr($c, 0, 7) == "objsco_"):
603 case (substr($c, 0, 7) == "objsub_"):
605 $worksheet->write($a_row, $cnt, $val);
606 break;
607
608 /* #14142
609 case "last_access":
610 case "spent_seconds":
611 case "status_changed":
612 */
613 default:
615 $worksheet->write($a_row, $cnt, $val);
616 break;
617
618 }
619 $cnt++;
620 }
621 }
References ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\getSelectedColumns(), and ilLPTableBaseGUI\parseValue().
Here is the call graph for this function:
◆ getItems()
| ilTrMatrixTableGUI::getItems | ( | array | $a_user_fields, |
| array | $a_privary_fields = null |
||
| ) |
Definition at line 263 of file class.ilTrMatrixTableGUI.php.
264 {
265 // #17081
266 if($this->restore_filter)
267 {
268 $name = $this->restore_filter_values["name"];
269 $this->SetFilterValue($this->filters[0], $name);
270 $this->filter["name"] = $name;
271 }
272
273 include_once("./Services/Tracking/classes/class.ilTrQuery.php");
275 if($collection["object_ids"])
276 {
277 // we need these for the timing warnings
278 $this->ref_ids = $collection["ref_ids"];
279
280 // only if object is [part of] course/group
281 $check_agreement = false;
282 if($this->in_course)
283 {
284 // privacy (if course agreement is activated)
285 include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
286 $privacy = ilPrivacySettings::_getInstance();
287 if($privacy->courseConfirmationRequired())
288 {
289 $check_agreement = $this->in_course;
290 }
291 }
292 else if($this->in_group)
293 {
294 // privacy (if group agreement is activated)
295 include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
296 $privacy = ilPrivacySettings::_getInstance();
297 if($privacy->groupConfirmationRequired())
298 {
299 $check_agreement = $this->in_group;
300 }
301 }
302
303 $data = ilTrQuery::getUserObjectMatrix($this->ref_id, $collection["object_ids"], $this->filter["name"], $a_user_fields, $a_privary_fields, $check_agreement);
305 {
306 // sub-items: learning objectives
307 $objectives = ilTrQuery::getUserObjectiveMatrix($collection["objectives_parent_id"], $data["users"]);
308
309 $this->objective_ids = array();
310
311 foreach($objectives as $user_id => $objectives)
312 {
314 {
315 foreach($objectives as $objective_id => $status)
316 {
317 $obj_id = "objtv_".$objective_id;
319
320 if(!in_array($obj_id, $this->objective_ids))
321 {
322 $this->objective_ids[$objective_id] = ilCourseObjective::lookupObjectiveTitle($objective_id);
323 }
324 }
325 }
326 }
327 }
328
329 // sub-items: SCOs
331 {
332 $this->sco_ids = array();
334 {
335 foreach($collection["scorm"]["scos"] as $sco)
336 {
337 if(!in_array($sco, $this->sco_ids))
338 {
339 $this->sco_ids[$sco] = $collection["scorm"]["scos_title"][$sco];
340 }
341
342 // alex, 5 Nov 2011: we got users being in failed and in
343 // completed status, I changed the setting in: first check failed
344 // then check completed since failed should superseed completed
345 // (before completed has been checked before failed)
346 $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
347 if(in_array($user_id, $collection["scorm"]["failed"][$sco]))
348 {
349 $status = ilLPStatus::LP_STATUS_FAILED_NUM;
350 }
351 else if(in_array($user_id, $collection["scorm"]["completed"][$sco]))
352 {
353 $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
354 }
355 else if(in_array($user_id, $collection["scorm"]["in_progress"][$sco]))
356 {
357 $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
358 }
359
360 $obj_id = "objsco_".$sco;
362 }
363 }
364 }
365
366 // sub-items: generic, e.g. lm chapter
368 {
370 {
371 foreach($collection["subitems"]["items"] as $item_id)
372 {
373 $this->subitem_ids[$item_id] = $collection["subitems"]["item_titles"][$item_id];
374
375 $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
376 if(in_array($user_id, $collection["subitems"]["completed"][$item_id]))
377 {
378 $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
379 }
380 else if(is_array($collection["subitems"]["in_progress"]) &&
381 in_array($user_id, $collection["subitems"]["in_progress"][$item_id]))
382 {
383 $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
384 }
385
386 $obj_id = "objsub_".$item_id;
388 }
389 }
390 }
391
392 // percentage export
394 {
395 $this->perc_map = array();
397 {
399 {
400 if(substr($column, -5) == "_perc")
401 {
402 $obj_id = explode("_", $column);
403 $obj_id = (int)$obj_id[1];
404
405 // #18673
407 !(int)$value)
408 {
410 }
411 else
412 {
413 $this->perc_map[$obj_id] = true;
414 }
415 }
416 }
417 }
418 }
419
422
423 return $collection["object_ids"];
424 }
425 return false;
426 }
static lookupObjectiveTitle($a_objective_id, $a_add_description=false)
Definition: class.ilCourseObjective.php:97
const LP_STATUS_IN_PROGRESS_NUM
Definition: class.ilLPStatus.php:29
isPercentageAvailable($a_obj_id)
Definition: class.ilLPTableBaseGUI.php:640
SetFilterValue(ilFormPropertyGUI $a_item, $a_value)
Set current filter value.
Definition: class.ilTable2GUI.php:2921
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:1542
static getUserObjectiveMatrix($a_parent_obj_id, $a_users)
Definition: class.ilTrQuery.php:1639
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:1324
References ilTableGUI\$data, $in_course, $in_group, $row, ilPrivacySettings\_getInstance(), ilTrQuery\getObjectIds(), ilTrQuery\getUserObjectiveMatrix(), ilTrQuery\getUserObjectMatrix(), ilLPTableBaseGUI\isPercentageAvailable(), ilCourseObjective\lookupObjectiveTitle(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ilTable2GUI\setData(), ilTable2GUI\SetFilterValue(), and ilTableGUI\setMaxCount().
Referenced by getSelectableColumns().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getSelectableColumns()
| ilTrMatrixTableGUI::getSelectableColumns | ( | ) |
Get selectable columns.
- Returns
- array key: column id, val: true/false -> default on/off
Reimplemented from ilTable2GUI.
Definition at line 141 of file class.ilTrMatrixTableGUI.php.
142 {
143 global $ilObjDataCache, $rbacsystem;
144
145 $user_cols = $this->getSelectableUserColumns($this->in_course, $this->in_group);
146
147 if($this->obj_ids === NULL)
148 {
149 // we cannot use the selected columns because they are not ready yet
150 // so we use all available columns, should be ok anyways
151 $this->obj_ids = $this->getItems(array_keys($user_cols[0]), $user_cols[1]);
152 }
153 if($this->obj_ids)
154 {
155 $tmp_cols = array();
156 foreach($this->obj_ids as $obj_id)
157 {
158 if($obj_id == $this->obj_id)
159 {
160 $parent = array("txt" => $this->lng->txt("status"),
161 "default" => true);
162 }
163 else
164 {
165 $no_perm = false;
166
167 $ref_id = $this->ref_ids[$obj_id];
168 include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
171 {
172 $no_perm = true;
173 $this->privacy_cols[] = $obj_id;
174 }
175
176 $title = $ilObjDataCache->lookupTitle($obj_id);
177 $type = $ilObjDataCache->lookupType($obj_id);
179 if($type == "sess")
180 {
181 include_once "Modules/Session/classes/class.ilObjSession.php";
184 }
185
186 // #16453
187 $relpath = null;
188 include_once './Services/Tree/classes/class.ilPathGUI.php';
192 {
194 }
195
199 "type" => $type,
200 "default" => true,
201 "no_permission" => $no_perm,
202 "path" => $relpath);
203 }
204 }
205 if(sizeof($this->objective_ids))
206 {
208 {
210 }
211 }
212 if(sizeof($this->sco_ids))
213 {
215 {
217 $tmp_cols[strtolower($title)."#~#objsco_".$obj_id] = array("txt" => $title, "icon"=>$icon, "default" => true);
218 }
219 }
220 if(sizeof($this->subitem_ids))
221 {
223 {
224 include_once("./Services/Tracking/classes/class.ilTrQuery.php");
226 $tmp_cols[strtolower($title)."#~#objsub_".$obj_id] = array("txt" => $title, "icon"=>$icon, "default" => true);
227 }
228 }
229
230 // alex, 5 Nov 2011: Do not sort SCORM items or "chapters"
231 if(!sizeof($this->sco_ids) && !sizeof($this->subitem_ids))
232 {
233 ksort($tmp_cols);
234 }
235 foreach($tmp_cols as $id => $def)
236 {
237 $id = explode('#~#', $id);
238 $columns[$id[1]] = $def;
239 }
240 unset($tmp_cols);
241
242 if($parent)
243 {
245 }
246 }
247
248 unset($user_cols[0]["status"]);
249 unset($user_cols[0]["login"]);
250 foreach($user_cols[0] as $col_id => $col_def)
251 {
253 {
254 // these are all additional fields, no default
255 $col_def["default"] = false;
256 $columns[$col_id] = $col_def;
257 }
258 }
259
261 }
getSelectableUserColumns($a_in_course=false, $a_in_group=false)
Definition: class.ilLPTableBaseGUI.php:913
static checkPermission($a_permission, $a_ref_id, $a_user_id=null)
wrapper for rbac access checks
Definition: class.ilLearningProgressAccess.php:38
Definition: class.ilObjSession.php:17
static _getIcon($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
Get icon for repository item.
Definition: class.ilObject.php:1900
getItems(array $a_user_fields, array $a_privary_fields=null)
Definition: class.ilTrMatrixTableGUI.php:263
static getSubItemType($a_parent_obj_id)
Get sub-item object type for parent.
Definition: class.ilTrQuery.php:639
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 Depre...
Definition: class.ilUtil.php:55
References $columns, ilTableGUI\$icon, $path, $ref_id, $sess, ilTableGUI\$title, ilObject\_getIcon(), ilLearningProgressAccess\checkPermission(), getItems(), ilLPTableBaseGUI\getSelectableUserColumns(), ilTrQuery\getSubItemType(), and ilUtil\getTypeIconPath().
Referenced by __construct(), fillHeaderCSV(), and fillHeaderExcel().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ initFilter()
| ilTrMatrixTableGUI::initFilter | ( | ) |
Init filter.
Overwrite this to initialize all filter input property objects.
Reimplemented from ilTable2GUI.
Definition at line 126 of file class.ilTrMatrixTableGUI.php.
127 {
128 global $lng;
129
131 $this->filter["name"] = $item->getValue();
132
133 // #14949 - is called before constructor, so we have to do it ourselves
135 {
136 $this->filter["name"] = null;
138 }
139 }
addFilterItemByMetaType($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
Add filter by standard type.
Definition: class.ilTable2GUI.php:646
References $_GET, $lng, ilTable2GUI\addFilterItemByMetaType(), ilTable2GUI\FILTER_TEXT, and ilTable2GUI\SetFilterValue().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:
Field Documentation
◆ $has_multi
|
protected |
Definition at line 24 of file class.ilTrMatrixTableGUI.php.
◆ $in_course
|
protected |
Definition at line 20 of file class.ilTrMatrixTableGUI.php.
Referenced by getItems().
◆ $in_group
|
protected |
Definition at line 21 of file class.ilTrMatrixTableGUI.php.
Referenced by getItems().
◆ $obj_ids
|
protected |
Definition at line 16 of file class.ilTrMatrixTableGUI.php.
◆ $objective_ids
|
protected |
Definition at line 17 of file class.ilTrMatrixTableGUI.php.
◆ $privacy_cols
|
protected |
Definition at line 23 of file class.ilTrMatrixTableGUI.php.
◆ $privacy_fields
|
protected |
Definition at line 22 of file class.ilTrMatrixTableGUI.php.
◆ $sco_ids
|
protected |
Definition at line 18 of file class.ilTrMatrixTableGUI.php.
◆ $subitem_ids
|
protected |
Definition at line 19 of file class.ilTrMatrixTableGUI.php.
The documentation for this class was generated from the following file:
- Services/Tracking/classes/repository_statistics/class.ilTrMatrixTableGUI.php
