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 ($a_set) | |
| Standard Version of Fill Row. More... | |
| Public Member Functions inherited from ilLPTableBaseGUI | |
| __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="") | |
| ilTable2GUI 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... | |
| 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) | |
| 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... | |
| 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 @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 | |
| __construct ($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 (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... | |
| 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 (ilExcel $a_excel, &$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) | |
| 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 | |
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;
35 $this->obj_id = ilObject::_lookupObjId($ref_id);
37
38 $this->in_group = $tree->checkForParentType($this->ref_id, "grp");
39 if ($this->in_group) {
40 $this->in_group = ilObject::_lookupObjId($this->in_group);
41 } else {
42 $this->in_course = $tree->checkForParentType($this->ref_id, "crs");
43 if ($this->in_course) {
44 $this->in_course = ilObject::_lookupObjId($this->in_course);
45 }
46 }
47
48 // has to be before constructor to work
49 $this->initFilter();
50
51 parent::__construct($a_parent_obj, $a_parent_cmd);
52
54
56 $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
61
62 // see ilObjCourseGUI::addMailToMemberButton()
63 include_once "Services/Mail/classes/class.ilMail.php";
65 if ($rbacsystem->checkAccess("internal_mail", $mail->getMailObjectReferenceId())) {
67 }
68
69 $this->lng->loadLanguageModule('user');
70 $this->addMultiCommand(
71 'addToClipboard',
72 $this->lng->txt('clipboard_add_btn')
73 );
75 $this->has_multi = true;
76
78
79 $labels = $this->getSelectableColumns();
80 $selected = $this->getSelectedColumns();
81 foreach ($selected as $c) {
83
84 if (isset($labels[$c]["no_permission"]) && (bool) $labels[$c]["no_permission"]) {
86 }
87
88 $tooltip = array();
89 if (isset($labels[$c]["icon"])) {
92 if (sizeof($selected) > 5) {
93 $tooltip[] = $title;
95 } else {
97 }
98 if ($labels[$c]["path"]) {
99 $tooltip[] = $labels[$c]["path"];
100 }
101 }
102
103 if (isset($labels[$c]["id"])) {
104 $sort_id = $labels[$c]["id"];
105 } else {
106 // list cannot be sorted by udf fields (separate query)
107 $sort_id = (substr($c, 0, 4) == "udf_") ? "" : $c;
108 }
109
111 }
112
113 $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
114 }
parseTitle($a_obj_id, $action, $a_user_id=false)
Definition: class.ilLPTableBaseGUI.php:588
setRowTemplate($a_template, $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:1108
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
Definition: class.ilTable2GUI.php:1119
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:1309
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
Definition: class.ilTable2GUI.php:919
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
Definition: class.ilTable2GUI.php:1139
References ilTableGUI\$icon, $ilCtrl, $ilUser, ilTableGUI\$lng, 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\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 532 of file class.ilTrMatrixTableGUI.php.
533 {
534 global $ilObjDataCache;
535
536 $a_csv->addColumn($this->lng->txt("login"));
537
538 $labels = $this->getSelectableColumns();
540 if (substr($c, 0, 4) == "obj_") {
541 $obj_id = substr($c, 4);
542 $type = $ilObjDataCache->lookupType($obj_id);
544
545 if (is_array($this->perc_map) && $this->perc_map[$obj_id]) {
546 $a_csv->addColumn($this->lng->txt("trac_percentage") . " (%)");
547 }
548 } else {
549 $a_csv->addColumn($labels[$c]["txt"]);
550 }
551 }
552
553 $a_csv->addRow();
554 }
References $type, 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
-
ilExcel $a_excel excel wrapper int $a_row row counter
Reimplemented from ilTable2GUI.
Definition at line 461 of file class.ilTrMatrixTableGUI.php.
462 {
463 global $ilObjDataCache;
464
466
467 $labels = $this->getSelectableColumns();
468 $cnt = 1;
470 if (substr($c, 0, 4) == "obj_") {
471 $obj_id = substr($c, 4);
472 $type = $ilObjDataCache->lookupType($obj_id);
474
475 if (is_array($this->perc_map) && $this->perc_map[$obj_id]) {
476 $cnt++;
478 }
479 } else {
481 }
482 $cnt++;
483 }
484
486 }
References $type, ilExcel\getColumnCoord(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ilExcel\setBold(), and ilExcel\setCell().
Here is the call graph for this function:
◆ fillRow()
| ilTrMatrixTableGUI::fillRow | ( | $a_set | ) |
Standard Version of Fill Row.
Most likely to be overwritten by derived class.
- Parameters
-
array $a_set data array
Reimplemented from ilTable2GUI.
Definition at line 363 of file class.ilTrMatrixTableGUI.php.
364 {
365 global $lng;
366
367 if ($this->has_multi) {
368 $this->tpl->setVariable("USER_ID", $a_set["usr_id"]);
369 }
370
372 switch ($c) {
373 case (substr($c, 0, 4) == "obj_"):
374 $obj_id = substr($c, 4);
375
376 // object without read-lp-permission
377 if (in_array($obj_id, $this->privacy_cols) ||
378 $a_set["privacy_conflict"]) {
379 $this->tpl->setCurrentBlock("objects");
380 $this->tpl->setVariable("VAL_STATUS", " ");
381 $this->tpl->parseCurrentBlock();
382 continue;
383 }
384
385 $status = isset($a_set[$c])
386 ? (int) $a_set[$c]
388 $percentage = isset($a_set[$c . "_perc"])
389 ? (int) $a_set[$c . "_perc"]
390 : null;
391
394 if ($timing) {
395 if ($timing !== true) {
397 } else {
398 $timing = "";
399 }
400 $this->tpl->setCurrentBlock('warning_img');
402 $this->tpl->setVariable('WARNING_ALT', $this->lng->txt('trac_time_passed') . $timing);
403 $this->tpl->parseCurrentBlock();
404 }
405 }
406
407 $this->tpl->setCurrentBlock("objects");
410 $this->tpl->parseCurrentBlock();
411 break;
412
413
414 case (substr($c, 0, 6) == "objtv_"):
415 case (substr($c, 0, 7) == "objsco_"):
416 case (substr($c, 0, 7) == "objsub_"):
417 $status = isset($a_set[$c])
418 ? (int) $a_set[$c]
420
421 $this->tpl->setCurrentBlock("objects");
422 if (!$a_set["privacy_conflict"]) {
424 } else {
425 $this->tpl->setVariable("VAL_STATUS", " ");
426 }
427 $this->tpl->parseCurrentBlock();
428 break;
429
430 default:
431 $this->tpl->setCurrentBlock("user_field");
432 if (!$a_set["privacy_conflict"]) {
434 } else {
435 $this->tpl->setVariable("VAL_UF", " ");
436 }
437 $this->tpl->parseCurrentBlock();
438 break;
439 }
440 }
441
442 // #7694
443 if (!$a_set["active"] || $a_set["privacy_conflict"]) {
444 $mess = array();
445 if ($a_set["privacy_conflict"]) {
447 } elseif (!$a_set["active"]) {
449 }
450 $this->tpl->setCurrentBlock('inactive_bl');
451 $this->tpl->setVariable('TXT_INACTIVE', implode(", ", $mess));
452 $this->tpl->parseCurrentBlock();
453 }
454
455 $login = !$a_set["privacy_conflict"]
456 ? $a_set["login"]
457 : " ";
458 $this->tpl->setVariable("VAL_LOGIN", $login);
459 }
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false)
Format a date @access public.
Definition: class.ilDatePresentation.php:123
const LP_STATUS_NOT_ATTEMPTED_NUM
Definition: class.ilLPStatus.php:28
showTimingsWarning($a_ref_id, $a_user_id)
Definition: class.ilLPTableBaseGUI.php:671
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
Definition: class.ilUtil.php:79
References ilTableGUI\$lng, ilDatePresentation\formatDate(), 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 556 of file class.ilTrMatrixTableGUI.php.
557 {
558 $a_csv->addColumn($a_set["login"]);
559
561 switch ($c) {
562 case (substr($c, 0, 4) == "obj_"):
563 $obj_id = substr($c, 4);
565 $a_csv->addColumn($val);
566
567 if (is_array($this->perc_map) && $this->perc_map[$obj_id]) {
568 $perc = (int) $a_set[$c . "_perc"];
569 if (!$perc) {
570 $perc = null;
571 }
572 $a_csv->addColumn($perc);
573 }
574 break;
575
576 case (substr($c, 0, 6) == "objtv_"):
577 case (substr($c, 0, 7) == "objsco_"):
578 case (substr($c, 0, 7) == "objsub_"):
580 $a_csv->addColumn($val);
581 break;
582
583 /* #14142
584 case "last_access":
585 case "spent_seconds":
586 case "status_changed":
587 */
588 default:
590 $a_csv->addColumn($val);
591 break;
592
593 }
594 }
595
596 $a_csv->addRow();
597 }
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
Definition: class.ilLearningProgressBaseGUI.php:380
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
-
ilExcel $a_excel excel wrapper int $a_row row counter array $a_set data array
Reimplemented from ilTable2GUI.
Definition at line 488 of file class.ilTrMatrixTableGUI.php.
489 {
491
492 $cnt = 1;
494 switch ($c) {
495 case (substr($c, 0, 4) == "obj_"):
496 $obj_id = substr($c, 4);
498 $a_excel->setCell($a_row, $cnt, $val);
499
500 if (is_array($this->perc_map) && $this->perc_map[$obj_id]) {
501 $cnt++;
502 $perc = (int) $a_set[$c . "_perc"];
503 $perc = !$perc
504 ? null
505 : $perc . "%";
506 $a_excel->setCell($a_row, $cnt, $perc);
507 }
508 break;
509
510 case (substr($c, 0, 6) == "objtv_"):
511 case (substr($c, 0, 7) == "objsco_"):
512 case (substr($c, 0, 7) == "objsub_"):
514 $a_excel->setCell($a_row, $cnt, $val);
515 break;
516
517 /* #14142
518 case "last_access":
519 case "spent_seconds":
520 case "status_changed":
521 */
522 default:
524 $a_excel->setCell($a_row, $cnt, $val);
525 break;
526
527 }
528 $cnt++;
529 }
530 }
References ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\getSelectedColumns(), ilLPTableBaseGUI\parseValue(), and ilExcel\setCell().
Here is the call graph for this function:
◆ getItems()
| ilTrMatrixTableGUI::getItems | ( | array | $a_user_fields, |
| array | $a_privary_fields = null |
||
| ) |
Definition at line 232 of file class.ilTrMatrixTableGUI.php.
233 {
234 // #17081
235 if ($this->restore_filter) {
239 }
240
241 include_once("./Services/Tracking/classes/class.ilTrQuery.php");
243 if ($collection["object_ids"]) {
244 // we need these for the timing warnings
245 $this->ref_ids = $collection["ref_ids"];
246
247 // only if object is [part of] course/group
248 $check_agreement = false;
249 if ($this->in_course) {
250 // privacy (if course agreement is activated)
251 include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
252 $privacy = ilPrivacySettings::_getInstance();
253 if ($privacy->courseConfirmationRequired()) {
254 $check_agreement = $this->in_course;
255 }
256 } elseif ($this->in_group) {
257 // privacy (if group agreement is activated)
258 include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
259 $privacy = ilPrivacySettings::_getInstance();
260 if ($privacy->groupConfirmationRequired()) {
261 $check_agreement = $this->in_group;
262 }
263 }
264
265 $data = ilTrQuery::getUserObjectMatrix($this->ref_id, $collection["object_ids"], $this->filter["name"], $a_user_fields, $a_privary_fields, $check_agreement);
267 // sub-items: learning objectives
268 $objectives = ilTrQuery::getUserObjectiveMatrix($collection["objectives_parent_id"], $data["users"]);
269
270 $this->objective_ids = array();
271
272 foreach ($objectives as $user_id => $objectives) {
274 foreach ($objectives as $objective_id => $status) {
275 $obj_id = "objtv_" . $objective_id;
277
278 if (!in_array($obj_id, $this->objective_ids)) {
279 $this->objective_ids[$objective_id] = ilCourseObjective::lookupObjectiveTitle($objective_id);
280 }
281 }
282 }
283 }
284 }
285
286 // sub-items: SCOs
288 $this->sco_ids = array();
290 foreach ($collection["scorm"]["scos"] as $sco) {
291 if (!in_array($sco, $this->sco_ids)) {
292 $this->sco_ids[$sco] = $collection["scorm"]["scos_title"][$sco];
293 }
294
295 // alex, 5 Nov 2011: we got users being in failed and in
296 // completed status, I changed the setting in: first check failed
297 // then check completed since failed should superseed completed
298 // (before completed has been checked before failed)
299 $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
300 if (in_array($user_id, $collection["scorm"]["failed"][$sco])) {
301 $status = ilLPStatus::LP_STATUS_FAILED_NUM;
302 } elseif (in_array($user_id, $collection["scorm"]["completed"][$sco])) {
303 $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
304 } elseif (in_array($user_id, $collection["scorm"]["in_progress"][$sco])) {
305 $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
306 }
307
308 $obj_id = "objsco_" . $sco;
310 }
311 }
312 }
313
314 // sub-items: generic, e.g. lm chapter
317 foreach ($collection["subitems"]["items"] as $item_id) {
318 $this->subitem_ids[$item_id] = $collection["subitems"]["item_titles"][$item_id];
319
320 $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
321 if (in_array($user_id, $collection["subitems"]["completed"][$item_id])) {
322 $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
323 } elseif (is_array($collection["subitems"]["in_progress"]) &&
324 in_array($user_id, $collection["subitems"]["in_progress"][$item_id])) {
325 $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
326 }
327
328 $obj_id = "objsub_" . $item_id;
330 }
331 }
332 }
333
334 // percentage export
336 $this->perc_map = array();
341 $obj_id = (int) $obj_id[1];
342
343 // #18673
345 !(int) $value) {
347 } else {
348 $this->perc_map[$obj_id] = true;
349 }
350 }
351 }
352 }
353 }
354
357
358 return $collection["object_ids"];
359 }
360 return false;
361 }
static lookupObjectiveTitle($a_objective_id, $a_add_description=false)
Definition: class.ilCourseObjective.php:99
const LP_STATUS_IN_PROGRESS_NUM
Definition: class.ilLPStatus.php:29
isPercentageAvailable($a_obj_id)
Definition: class.ilLPTableBaseGUI.php:573
SetFilterValue(ilFormPropertyGUI $a_item, $a_value)
Set current filter value.
Definition: class.ilTable2GUI.php:2858
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:1369
static getUserObjectiveMatrix($a_parent_obj_id, $a_users)
Definition: class.ilTrQuery.php:1463
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:1176
References $column, ilTableGUI\$data, $in_course, $in_group, $name, $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 130 of file class.ilTrMatrixTableGUI.php.
131 {
132 global $ilObjDataCache, $rbacsystem;
133
134 $user_cols = $this->getSelectableUserColumns($this->in_course, $this->in_group);
135
136 if ($this->obj_ids === null) {
137 // we cannot use the selected columns because they are not ready yet
138 // so we use all available columns, should be ok anyways
139 $this->obj_ids = $this->getItems(array_keys($user_cols[0]), $user_cols[1]);
140 }
141 if (is_array($this->obj_ids)) {
142 $tmp_cols = array();
143 foreach ($this->obj_ids as $obj_id) {
144 if ($obj_id == $this->obj_id) {
145 $parent = array("txt" => $this->lng->txt("status"),
146 "default" => true);
147 } else {
148 $no_perm = false;
149
150 $ref_id = $this->ref_ids[$obj_id];
151 include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
152 if ($ref_id &&
154 $no_perm = true;
155 $this->privacy_cols[] = $obj_id;
156 }
157
158 $title = $ilObjDataCache->lookupTitle($obj_id);
159 $type = $ilObjDataCache->lookupType($obj_id);
162 include_once "Modules/Session/classes/class.ilObjSession.php";
165 }
166
167 // #16453
168 $relpath = null;
169 include_once './Services/Tree/classes/class.ilPathGUI.php';
174 }
175
180 "default" => true,
181 "no_permission" => $no_perm,
182 "path" => $relpath);
183 }
184 }
185 if (sizeof($this->objective_ids)) {
187 $tmp_cols[strtolower($title) . "#~#objtv_" . $obj_id] = array("txt" => $title, "default" => true);
188 }
189 }
190 if (sizeof($this->sco_ids)) {
193 $tmp_cols[strtolower($title) . "#~#objsco_" . $obj_id] = array("txt" => $title, "icon"=>$icon, "default" => true);
194 }
195 }
196 if (sizeof($this->subitem_ids)) {
198 include_once("./Services/Tracking/classes/class.ilTrQuery.php");
200 $tmp_cols[strtolower($title) . "#~#objsub_" . $obj_id] = array("txt" => $title, "icon"=>$icon, "default" => true);
201 }
202 }
203
204 // alex, 5 Nov 2011: Do not sort SCORM items or "chapters"
205 if (!sizeof($this->sco_ids) && !sizeof($this->subitem_ids)) {
206 ksort($tmp_cols);
207 }
211 }
212 unset($tmp_cols);
213
214 if ($parent) {
216 }
217 }
218
219 unset($user_cols[0]["status"]);
220 unset($user_cols[0]["login"]);
221 foreach ($user_cols[0] as $col_id => $col_def) {
223 // these are all additional fields, no default
224 $col_def["default"] = false;
225 $columns[$col_id] = $col_def;
226 }
227 }
228
230 }
getSelectableUserColumns($a_in_course=false, $a_in_group=false)
Definition: class.ilLPTableBaseGUI.php:802
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:1914
getItems(array $a_user_fields, array $a_privary_fields=null)
Definition: class.ilTrMatrixTableGUI.php:232
static getSubItemType($a_parent_obj_id)
Get sub-item object type for parent.
Definition: class.ilTrQuery.php:548
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:63
References $columns, $def, ilTableGUI\$icon, $id, $path, $sess, ilTableGUI\$title, $type, 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 116 of file class.ilTrMatrixTableGUI.php.
117 {
118 global $lng;
119
121 $this->filter["name"] = $item->getValue();
122
123 // #14949 - is called before constructor, so we have to do it ourselves
125 $this->filter["name"] = null;
127 }
128 }
addFilterItemByMetaType($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)
Add filter by standard type.
Definition: class.ilTable2GUI.php:648
References $_GET, ilTableGUI\$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
