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, $a_select_all_on_top=false) | |
| Set the name of the checkbox that should be toggled with a select all button. More... | |
| setExternalSorting ($a_val) | |
| Set external sorting. More... | |
| getExternalSorting () | |
| Get external sorting. More... | |
| setFilterCommand ($a_val, $a_caption=null) | |
| Set filter command. More... | |
| getFilterCommand () | |
| Get filter command. More... | |
| setResetCommand ($a_val, $a_caption=null) | |
| Set reset filter command. More... | |
| getResetCommand () | |
| Get reset filter command. More... | |
| setExternalSegmentation ($a_val) | |
| Set external segmentation. More... | |
| getExternalSegmentation () | |
| Get external segmentation. More... | |
| setRowTemplate ($a_template, $a_template_dir="") | |
| Set row template. More... | |
| setDefaultOrderField ($a_defaultorderfield) | |
| Set Default order field. More... | |
| getDefaultOrderField () | |
| Get Default order field. More... | |
| setDefaultOrderDirection ($a_defaultorderdirection) | |
| Set Default order direction. More... | |
| getDefaultOrderDirection () | |
| Get Default order direction. More... | |
| setDefaultFilterVisiblity ($a_status) | |
| Set default filter visiblity. More... | |
| getDefaultFilterVisibility () | |
| Get default filter visibility. More... | |
| clearCommandButtons () | |
| addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null) | |
| Add Command button. More... | |
| addCommandButtonInstance (ilButtonBase $a_button) | |
| Add Command button instance. More... | |
| addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='') | |
| Add Selection List + Command button. More... | |
| addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='') | |
| Add Selection List + Command button for selected items. More... | |
| setCloseCommand ($a_link) | |
| Add command for closing table. More... | |
| addMultiCommand ($a_cmd, $a_text) | |
| Add Command button. More... | |
| addHiddenInput ($a_name, $a_value) | |
| Add Hidden Input field. More... | |
| addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="") | |
| Add Header Command (Link) (Image needed for now) More... | |
| setTopCommands ($a_val) | |
| Set top commands (display command buttons on top of table, too) More... | |
| getTopCommands () | |
| Get top commands (display command buttons on top of table, too) More... | |
| addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false) | |
| Add a column to the header. More... | |
| getNavParameter () | |
| setOrderLink ($sort_field, $order_dir) | |
| fillHeader () | |
| determineOffsetAndOrder ($a_omit_offset=false) | |
| Determine offset and order. More... | |
| storeNavParameter () | |
| getHTML () | |
| Get HTML. More... | |
| numericOrdering ($a_field) | |
| Should this field be sorted numeric? More... | |
| render () | |
| render table @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 {
31 global $DIC;
32
38
40 $this->ref_id = $ref_id;
41 $this->obj_id = ilObject::_lookupObjId($ref_id);
43
44 $this->in_group = $tree->checkForParentType($this->ref_id, "grp");
45 if ($this->in_group) {
46 $this->in_group = ilObject::_lookupObjId($this->in_group);
47 } else {
48 $this->in_course = $tree->checkForParentType($this->ref_id, "crs");
49 if ($this->in_course) {
50 $this->in_course = ilObject::_lookupObjId($this->in_course);
51 }
52 }
53
54 // has to be before constructor to work
55 $this->initFilter();
56
57 parent::__construct($a_parent_obj, $a_parent_cmd);
58
60
67
68 // see ilObjCourseGUI::addMailToMemberButton()
69 include_once "Services/Mail/classes/class.ilMail.php";
71 if ($rbacsystem->checkAccess("internal_mail", $mail->getMailObjectReferenceId())) {
73 }
74
75 $this->lng->loadLanguageModule('user');
76 $this->addMultiCommand(
77 'addToClipboard',
78 $this->lng->txt('clipboard_add_btn')
79 );
81 $this->has_multi = true;
82
84
85 $labels = $this->getSelectableColumns();
86 $selected = $this->getSelectedColumns();
89
92 }
93
94 $tooltip = array();
98 if (sizeof($selected) > 5) {
99 $tooltip[] = $title;
101 } else {
103 }
106 }
107 }
108
111 } else {
112 // list cannot be sorted by udf fields (separate query)
114 }
115
117 }
118
119 $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
120 }
parseTitle($a_obj_id, $action, $a_user_id=false)
Definition: class.ilLPTableBaseGUI.php:615
Definition: class.ilMail.php:11
setRowTemplate($a_template, $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:1127
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
Definition: class.ilTable2GUI.php:1138
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:1328
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
Definition: class.ilTable2GUI.php:936
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
Definition: class.ilTable2GUI.php:1158
References Vendor\Package\$c, $DIC, ilTableGUI\$icon, $ilCtrl, $ilUser, ilTableGUI\$lng, ilTableGUI\$title, ILIAS\GlobalScreen\Provider\__construct(), 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 554 of file class.ilTrMatrixTableGUI.php.
555 {
556 global $DIC;
557
559
560 $a_csv->addColumn($this->lng->txt("login"));
561
562 $labels = $this->getSelectableColumns();
565 $obj_id = substr($c, 4);
566
567 $type = $ilObjDataCache->lookupType($obj_id);
570 } else {
571 $type_text = $this->lng->txt($type);
572 }
573
575
576 if (is_array($this->perc_map) && $this->perc_map[$obj_id]) {
577 $a_csv->addColumn($this->lng->txt("trac_percentage") . " (%)");
578 }
579 } else {
581 }
582 }
583
584 $a_csv->addRow();
585 }
static lookupTxtById($plugin_id, $lang_var)
Definition: class.ilObjectPlugin.php:99
References Vendor\Package\$c, $DIC, $type, getSelectableColumns(), ilTable2GUI\getSelectedColumns(), and ilObjectPlugin\lookupTxtById().
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 474 of file class.ilTrMatrixTableGUI.php.
475 {
476 global $DIC;
477
479
481
482 $labels = $this->getSelectableColumns();
483 $cnt = 1;
486 $obj_id = substr($c, 4);
487
488 $type = $ilObjDataCache->lookupType($obj_id);
491 } else {
492 $type_text = $this->lng->txt($type);
493 }
494
496
497 if (is_array($this->perc_map) && $this->perc_map[$obj_id]) {
498 $cnt++;
500 }
501 } else {
503 }
504 $cnt++;
505 }
506
508 }
References Vendor\Package\$c, $DIC, $type, ilExcel\getColumnCoord(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ilObjectPlugin\lookupTxtById(), 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 374 of file class.ilTrMatrixTableGUI.php.
375 {
376 global $DIC;
377
379
380 if ($this->has_multi) {
381 $this->tpl->setVariable("USER_ID", $a_set["usr_id"]);
382 }
383
387 $obj_id = substr($c, 4);
388
389 // object without read-lp-permission
390 if (in_array($obj_id, $this->privacy_cols) ||
391 $a_set["privacy_conflict"]) {
392 $this->tpl->setCurrentBlock("objects");
393 $this->tpl->setVariable("VAL_STATUS", " ");
394 $this->tpl->parseCurrentBlock();
395 break;
396 }
397
398 $status = isset($a_set[$c])
399 ? (int) $a_set[$c]
403 : null;
404
407 if ($timing) {
408 if ($timing !== true) {
410 } else {
411 $timing = "";
412 }
413 $this->tpl->setCurrentBlock('warning_img');
415 $this->tpl->setVariable('WARNING_ALT', $this->lng->txt('trac_time_passed') . $timing);
416 $this->tpl->parseCurrentBlock();
417 }
418 }
419
420 $this->tpl->setCurrentBlock("objects");
423 $this->tpl->parseCurrentBlock();
424 break;
425
426
430 $status = isset($a_set[$c])
431 ? (int) $a_set[$c]
433
434 $this->tpl->setCurrentBlock("objects");
435 if (!$a_set["privacy_conflict"]) {
437 } else {
438 $this->tpl->setVariable("VAL_STATUS", " ");
439 }
440 $this->tpl->parseCurrentBlock();
441 break;
442
443 default:
444 $this->tpl->setCurrentBlock("user_field");
445 if (!$a_set["privacy_conflict"]) {
447 } else {
448 $this->tpl->setVariable("VAL_UF", " ");
449 }
450 $this->tpl->parseCurrentBlock();
451 break;
452 }
453 }
454
455 // #7694
456 if (!$a_set["active"] || $a_set["privacy_conflict"]) {
457 $mess = array();
458 if ($a_set["privacy_conflict"]) {
460 } elseif (!$a_set["active"]) {
462 }
463 $this->tpl->setCurrentBlock('inactive_bl');
464 $this->tpl->setVariable('TXT_INACTIVE', implode(", ", $mess));
465 $this->tpl->parseCurrentBlock();
466 }
467
469 ? $a_set["login"]
470 : " ";
472 }
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false, $include_seconds=false)
Format a date @access public.
Definition: class.ilDatePresentation.php:127
const LP_STATUS_NOT_ATTEMPTED_NUM
Definition: class.ilLPStatus.php:28
showTimingsWarning($a_ref_id, $a_user_id)
Definition: class.ilLPTableBaseGUI.php:707
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
Definition: class.ilUtil.php:80
References Vendor\Package\$c, $DIC, ilTableGUI\$lng, $login, 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 587 of file class.ilTrMatrixTableGUI.php.
588 {
589 $a_csv->addColumn($a_set["login"]);
590
594 $obj_id = substr($c, 4);
596 $a_csv->addColumn($val);
597
598 if (is_array($this->perc_map) && $this->perc_map[$obj_id]) {
600 if (!$perc) {
601 $perc = null;
602 }
603 $a_csv->addColumn($perc);
604 }
605 break;
606
611 $a_csv->addColumn($val);
612 break;
613
614 /* #14142
615 case "last_access":
616 case "spent_seconds":
617 case "status_changed":
618 */
619 default:
621 $a_csv->addColumn($val);
622 break;
623
624 }
625 }
626
627 $a_csv->addRow();
628 }
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
Definition: class.ilLearningProgressBaseGUI.php:376
References Vendor\Package\$c, 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 510 of file class.ilTrMatrixTableGUI.php.
511 {
513
514 $cnt = 1;
518 $obj_id = substr($c, 4);
520 $a_excel->setCell($a_row, $cnt, $val);
521
522 if (is_array($this->perc_map) && $this->perc_map[$obj_id]) {
523 $cnt++;
525 $perc = !$perc
526 ? null
527 : $perc . "%";
528 $a_excel->setCell($a_row, $cnt, $perc);
529 }
530 break;
531
536 $a_excel->setCell($a_row, $cnt, $val);
537 break;
538
539 /* #14142
540 case "last_access":
541 case "spent_seconds":
542 case "status_changed":
543 */
544 default:
546 $a_excel->setCell($a_row, $cnt, $val);
547 break;
548
549 }
550 $cnt++;
551 }
552 }
References Vendor\Package\$c, 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 243 of file class.ilTrMatrixTableGUI.php.
244 {
245 // #17081
246 if ($this->restore_filter) {
250 }
251
252 include_once("./Services/Tracking/classes/class.ilTrQuery.php");
254 if ($collection["object_ids"]) {
255 // we need these for the timing warnings
256 $this->ref_ids = $collection["ref_ids"];
257
258 // only if object is [part of] course/group
259 $check_agreement = false;
260 if ($this->in_course) {
261 // privacy (if course agreement is activated)
262 include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
263 $privacy = ilPrivacySettings::_getInstance();
264 if ($privacy->courseConfirmationRequired()) {
265 $check_agreement = $this->in_course;
266 }
267 } elseif ($this->in_group) {
268 // privacy (if group agreement is activated)
269 include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
270 $privacy = ilPrivacySettings::_getInstance();
271 if ($privacy->groupConfirmationRequired()) {
272 $check_agreement = $this->in_group;
273 }
274 }
275
276 $data = ilTrQuery::getUserObjectMatrix($this->ref_id, $collection["object_ids"], $this->filter["name"], $a_user_fields, $a_privary_fields, $check_agreement);
278 // sub-items: learning objectives
279 $objectives = ilTrQuery::getUserObjectiveMatrix($collection["objectives_parent_id"], $data["users"]);
280
281 $this->objective_ids = array();
282
283 foreach ($objectives as $user_id => $objectives) {
285 foreach ($objectives as $objective_id => $status) {
286 $obj_id = "objtv_" . $objective_id;
288
289 if (!in_array($obj_id, $this->objective_ids)) {
290 $this->objective_ids[$objective_id] = ilCourseObjective::lookupObjectiveTitle($objective_id);
291 }
292 }
293 }
294 }
295 }
296
297 // sub-items: SCOs
299 $this->sco_ids = array();
301 foreach ($collection["scorm"]["scos"] as $sco) {
302 if (!in_array($sco, $this->sco_ids)) {
303 $this->sco_ids[$sco] = $collection["scorm"]["scos_title"][$sco];
304 }
305
306 // alex, 5 Nov 2011: we got users being in failed and in
307 // completed status, I changed the setting in: first check failed
308 // then check completed since failed should superseed completed
309 // (before completed has been checked before failed)
310 $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
311 if (in_array($user_id, $collection["scorm"]["failed"][$sco])) {
312 $status = ilLPStatus::LP_STATUS_FAILED_NUM;
313 } elseif (in_array($user_id, $collection["scorm"]["completed"][$sco])) {
314 $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
315 } elseif (in_array($user_id, $collection["scorm"]["in_progress"][$sco])) {
316 $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
317 }
318
319 $obj_id = "objsco_" . $sco;
321 }
322 }
323 }
324
325 // sub-items: generic, e.g. lm chapter
328 foreach ($collection["subitems"]["items"] as $item_id) {
329 $this->subitem_ids[$item_id] = $collection["subitems"]["item_titles"][$item_id];
330
331 $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
332 if (in_array($user_id, $collection["subitems"]["completed"][$item_id])) {
333 $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
334 } elseif (is_array($collection["subitems"]["in_progress"]) &&
335 in_array($user_id, $collection["subitems"]["in_progress"][$item_id])) {
336 $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
337 }
338
339 $obj_id = "objsub_" . $item_id;
341 }
342 }
343 }
344
345 // percentage export
347 $this->perc_map = array();
349 foreach ($row as $column => $value) {
350 if (substr($column, -5) == "_perc") {
351 $obj_id = explode("_", $column);
352 $obj_id = (int) $obj_id[1];
353
354 // #18673
356 !(int) $value) {
358 } else {
359 $this->perc_map[$obj_id] = true;
360 }
361 }
362 }
363 }
364 }
365
368
369 return $collection["object_ids"];
370 }
371 return false;
372 }
static lookupObjectiveTitle($a_objective_id, $a_add_description=false)
Definition: class.ilCourseObjective.php:105
const LP_STATUS_IN_PROGRESS_NUM
Definition: class.ilLPStatus.php:29
isPercentageAvailable($a_obj_id)
Definition: class.ilLPTableBaseGUI.php:593
SetFilterValue(ilFormPropertyGUI $a_item, $a_value)
Set current filter value.
Definition: class.ilTable2GUI.php:2902
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:1400
static getUserObjectiveMatrix($a_parent_obj_id, $a_users)
Definition: class.ilTrQuery.php:1495
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:1203
References ilTableGUI\$data, $in_course, $in_group, $name, 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 138 of file class.ilTrMatrixTableGUI.php.
139 {
140 global $DIC;
141
144
145 $user_cols = $this->getSelectableUserColumns($this->in_course, $this->in_group);
146
147 if ($this->obj_ids === null) {
148 // we cannot use the selected columns because they are not ready yet
149 // so we use all available columns, should be ok anyways
150 $this->obj_ids = $this->getItems(array_keys($user_cols[0]), $user_cols[1]);
151 }
152 if (is_array($this->obj_ids)) {
153 $tmp_cols = array();
154 foreach ($this->obj_ids as $obj_id) {
155 if ($obj_id == $this->obj_id) {
156 $parent = array("txt" => $this->lng->txt("status"),
157 "default" => true);
158 } else {
159 $no_perm = false;
160
161 $ref_id = $this->ref_ids[$obj_id];
162 include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
163 if ($ref_id &&
165 $no_perm = true;
166 $this->privacy_cols[] = $obj_id;
167 }
168
169 $title = $ilObjDataCache->lookupTitle($obj_id);
170 $type = $ilObjDataCache->lookupType($obj_id);
173 include_once "Modules/Session/classes/class.ilObjSession.php";
176 }
177
178 // #16453
179 $relpath = null;
180 include_once './Services/Tree/classes/class.ilPathGUI.php';
182 $path = $path->getPath($this->ref_id, $ref_id);
183 if ($path) {
184 $relpath = $this->lng->txt('path') . ': ' . $path;
185 }
186
191 "default" => true,
192 "no_permission" => $no_perm,
193 "path" => $relpath);
194 }
195 }
196 if (sizeof($this->objective_ids)) {
198 $tmp_cols[strtolower($title) . "#~#objtv_" . $obj_id] = array("txt" => $title, "default" => true);
199 }
200 }
201 if (sizeof($this->sco_ids)) {
204 $tmp_cols[strtolower($title) . "#~#objsco_" . $obj_id] = array("txt" => $title, "icon" => $icon, "default" => true);
205 }
206 }
207 if (sizeof($this->subitem_ids)) {
209 include_once("./Services/Tracking/classes/class.ilTrQuery.php");
211 $tmp_cols[strtolower($title) . "#~#objsub_" . $obj_id] = array("txt" => $title, "icon" => $icon, "default" => true);
212 }
213 }
214
215 // alex, 5 Nov 2011: Do not sort SCORM items or "chapters"
216 if (!sizeof($this->sco_ids) && !sizeof($this->subitem_ids)) {
217 ksort($tmp_cols);
218 }
219 foreach ($tmp_cols as $id => $def) {
220 $id = explode('#~#', $id);
221 $columns[$id[1]] = $def;
222 }
223 unset($tmp_cols);
224
225 if ($parent) {
227 }
228 }
229
230 unset($user_cols[0]["status"]);
231 unset($user_cols[0]["login"]);
232 foreach ($user_cols[0] as $col_id => $col_def) {
234 // these are all additional fields, no default
235 $col_def["default"] = false;
236 $columns[$col_id] = $col_def;
237 }
238 }
239
241 }
getSelectableUserColumns($a_in_course=false, $a_in_group=false)
Definition: class.ilLPTableBaseGUI.php:842
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
getItems(array $a_user_fields, array $a_privary_fields=null)
Definition: class.ilTrMatrixTableGUI.php:243
static getSubItemType($a_parent_obj_id)
Get sub-item object type for parent.
Definition: class.ilTrQuery.php:558
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:64
References $columns, $DIC, ilTableGUI\$icon, $sess, ilTableGUI\$title, $type, 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 122 of file class.ilTrMatrixTableGUI.php.
123 {
124 global $DIC;
125
127
129 $this->filter["name"] = $item->getValue();
130
131 // #14949 - is called before constructor, so we have to do it ourselves
133 $this->filter["name"] = null;
135 }
136 }
addFilterItemByMetaType($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)
Add filter by standard type.
Definition: class.ilTable2GUI.php:665
References $_GET, $DIC, 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
