ilTrMatrixTableGUI Class Reference
name table More...
Inheritance diagram for ilTrMatrixTableGUI:
Collaboration diagram for ilTrMatrixTableGUI:
Public Member Functions | |
| __construct (?object $a_parent_obj, string $a_parent_cmd, int $ref_id) | |
| Constructor. More... | |
| initFilter () | |
| numericOrdering ($a_field) | |
| getSelectableColumns () | |
| Get selectable columns. More... | |
| getItems (array $a_user_fields, ?array $a_privary_fields=null) | |
| Public Member Functions inherited from ilLPTableBaseGUI | |
| __construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="") | |
| executeCommand () | |
| searchFilterListener (int $a_ref_id, array $a_data) | |
| Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED @access public. More... | |
| initBaseFilter (bool $a_split_learning_resources=false, bool $a_include_no_status_filter=true) | |
| Init filter. More... | |
| getCurrentFilter (bool $as_query=false) | |
| getIconVariant () | |
| Gets the variant of LP icons that is shown in the table. More... | |
| setIconVariant (int $variant) | |
| Sets the variant of LP icons that is shown in the table. More... | |
| Public Member Functions inherited from ilTable2GUI | |
| __construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="") | |
| setOpenFormTag (bool $a_val) | |
| getOpenFormTag () | |
| setCloseFormTag (bool $a_val) | |
| getCloseFormTag () | |
| determineLimit () | |
| getSelectableColumns () | |
| Get selectable columns. More... | |
| determineSelectedColumns () | |
| isColumnSelected (string $col) | |
| getSelectedColumns () | |
| resetOffset (bool $a_in_determination=false) | |
| initFilter () | |
| getParentObject () | |
| getParentCmd () | |
| setTopAnchor (string $a_val) | |
| getTopAnchor () | |
| setNoEntriesText (string $a_text) | |
| getNoEntriesText () | |
| setIsDataTable (bool $a_val) | |
| getIsDataTable () | |
| setEnableTitle (bool $a_enabletitle) | |
| getEnableTitle () | |
| setEnableHeader (bool $a_enableheader) | |
| getEnableHeader () | |
| setEnableNumInfo (bool $a_val) | |
| getEnableNumInfo () | |
| setTitle (string $a_title, string $a_icon="", string $a_icon_alt="") | |
| setDescription (string $a_val) | |
| getDescription () | |
| setOrderField (string $a_order_field) | |
| getOrderField () | |
| setData (array $a_data) | |
| Set table data. More... | |
| getData () | |
| dataExists () | |
| setPrefix (string $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) More... | |
| getPrefix () | |
| addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false) | |
| addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="") | |
| Add filter by standard type. More... | |
| getFilterItems (bool $a_optionals=false) | |
| getFilterItemByPostVar (string $a_post_var) | |
| setFilterCols (int $a_val) | |
| getFilterCols () | |
| setDisableFilterHiding (bool $a_val=true) | |
| getDisableFilterHiding () | |
| isFilterSelected (string $a_col) | |
| Is given filter selected? More... | |
| getSelectedFilters () | |
| determineSelectedFilters () | |
| setCustomPreviousNext (string $a_prev_link, string $a_next_link) | |
| setFormAction (string $a_form_action, bool $a_multipart=false) | |
| getFormAction () | |
| setFormName (string $a_name="") | |
| getFormName () | |
| get the name of the parent form More... | |
| setId (string $a_val) | |
| getId () | |
| setDisplayAsBlock (bool $a_val) | |
| getDisplayAsBlock () | |
| setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false) | |
| setExternalSorting (bool $a_val) | |
| getExternalSorting () | |
| setFilterCommand (string $a_val, string $a_caption="") | |
| getFilterCommand () | |
| setResetCommand (string $a_val, string $a_caption="") | |
| getResetCommand () | |
| setExternalSegmentation (bool $a_val) | |
| getExternalSegmentation () | |
| setRowTemplate (string $a_template, string $a_template_dir="") | |
| Set row template. More... | |
| setDefaultOrderField (string $a_defaultorderfield) | |
| getDefaultOrderField () | |
| setDefaultOrderDirection (string $a_defaultorderdirection) | |
| getDefaultOrderDirection () | |
| setDefaultFilterVisiblity (bool $a_status) | |
| getDefaultFilterVisibility () | |
| clearCommandButtons () | |
| addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="") | |
| addCommandButtonInstance (ilButtonBase $a_button) | |
| addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='') | |
| setCloseCommand (string $a_link) | |
| addMultiCommand (string $a_cmd, string $a_text) | |
| addHiddenInput (string $a_name, string $a_value) | |
| addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="") | |
| setTopCommands (bool $a_val) | |
| getTopCommands () | |
| addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false) | |
| getNavParameter () | |
| setOrderLink (string $key, string $order_dir) | |
| fillHeader () | |
| determineOffsetAndOrder (bool $a_omit_offset=false) | |
| storeNavParameter () | |
| getHTML () | |
| Get HTML. More... | |
| numericOrdering (string $a_field) | |
| Should this field be sorted numeric? More... | |
| render () | |
| writeFilterToSession () | |
| resetFilter () | |
| fillFooter () | |
| getLinkbar (string $a_num) | |
| fillHiddenRow () | |
| fillActionRow () | |
| setHeaderHTML (string $html) | |
| storeProperty (string $type, string $value) | |
| loadProperty (string $type) | |
| getCurrentState () | |
| get current settings for order, limit, columns and filter More... | |
| setContext (string $id) | |
| getContext () | |
| setShowRowsSelector (bool $a_value) | |
| Toggle rows-per-page selector. More... | |
| getShowRowsSelector () | |
| getLimit () | |
| getOffset () | |
| setExportFormats (array $formats) | |
| Set available export formats. More... | |
| setPrintMode (bool $a_value=false) | |
| getPrintMode () | |
| getExportMode () | |
| exportData (int $format, bool $send=false) | |
| Export and optionally send current table data. More... | |
| setEnableAllCommand (bool $a_value) | |
| setRowSelectorLabel (string $row_selector_label) | |
| getRowSelectorLabel () | |
| setPreventDoubleSubmission (bool $a_val) | |
| getPreventDoubleSubmission () | |
| setLimit (int $a_limit=0, int $a_default_limit=0) | |
| set max. More... | |
| Public Member Functions inherited from ilTableGUI | |
| __construct (array $a_data=[], bool $a_global_tpl=true) | |
| setTemplate (ilTemplate $a_tpl) | |
| getTemplateObject () | |
| setData (array $a_data) | |
| Set table data. More... | |
| getData () | |
| setTitle (string $a_title, string $a_icon="", string $a_icon_alt="") | |
| setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="") | |
| setHeaderNames (array $a_header_names) | |
| getColumnCount () | |
| setHeaderVars (array $a_header_vars, array $a_header_params=[]) | |
| setColumnWidth (array $a_column_width) | |
| set table column widths More... | |
| setOneColumnWidth (string $a_column_width, int $a_column_number) | |
| setMaxCount (int $a_max_count) | |
| set max. More... | |
| setLimit (int $a_limit=0, int $a_default_limit=0) | |
| set max. More... | |
| getLimit () | |
| setPrefix (string $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) More... | |
| setOffset (int $a_offset) | |
| set dataset offset More... | |
| getOffset () | |
| setOrderColumn (string $a_order_column="", string $a_default_column="") | |
| getOrderColumn () | |
| setOrderDirection (string $a_order_direction) | |
| getOrderDirection () | |
| setFooter (string $a_style, string $a_previous="", string $a_next="") | |
| enable (string $a_module_name) | |
| disable (string $a_module_name) | |
| sortData () | |
| render () | |
| renderHeader () | |
| setOrderLink (string $key, string $order_dir) | |
| setStyle (string $a_element, string $a_style) | |
| getStyle (string $a_element) | |
| setBase (string $a_base) | |
| getBase () | |
| getFormName () | |
| get the name of the parent form More... | |
| setFormName (string $a_name="cmd") | |
| getSelectAllCheckbox () | |
| get the name of the checkbox that should be toggled with a select all button More... | |
| setSelectAllCheckbox (string $a_select_all_checkbox) | |
| clearActionButtons () | |
| addActionButton (string $btn_name, string $btn_value) | |
Protected Member Functions | |
| fillRow (array $a_set) | |
| Standard Version of Fill Row. More... | |
| fillHeaderExcel (ilExcel $a_excel, int &$a_row) | |
| Excel Version of Fill Header. More... | |
| fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set) | |
| Excel Version of Fill Row. More... | |
| fillHeaderCSV (ilCSVWriter $a_csv) | |
| CSV Version of Fill Header. More... | |
| fillRowCSV (ilCSVWriter $a_csv, array $a_set) | |
| CSV Version of Fill Row. More... | |
| Protected Member Functions inherited from ilLPTableBaseGUI | |
| initItemIdFromPost () | |
| initUidFromPost () | |
| findReferencesForObjId (int $a_obj_id) | |
| sendMail (array $a_user_ids, $a_parent_obj, string $a_parent_cmd) | |
| searchObjects (array $filter, string $permission, ?array $preset_obj_ids=null, bool $a_check_lp_activation=true) | |
| Search objects that match current filters. More... | |
| isForwardingToFormDispatcher () | |
| initRepositoryFilter (array $filter) | |
| buildPath (array $ref_ids) | |
| getPossibleTypes (bool $a_split_learning_resources=false, bool $a_include_digilib=false, bool $a_allow_undefined_lp=false) | |
| parseValue (string $id, ?string $value, string $type) | |
| isPercentageAvailable (int $a_obj_id) | |
| parseTitle (int $a_obj_id, string $action, int $a_user_id=0) | |
| getExportMeta () | |
| Build export meta data. More... | |
| fillMetaExcel (ilExcel $a_excel, int &$a_row) | |
| Add meta information to excel export. More... | |
| fillMetaCSV (ilCSVWriter $a_csv) | |
| Add meta information to csv export. More... | |
| showTimingsWarning (int $a_ref_id, int $a_user_id) | |
| formatSeconds (int $seconds, bool $a_shorten_zero=false) | |
| anonymizeValue ($a_value, bool $a_force_number=false) | |
| buildValueScale (int $a_max_value, bool $a_anonymize=false, bool $a_format_seconds=false) | |
| getMonthsFilter ($a_short=false) | |
| getMonthsYear ($a_year=null, $a_short=false) | |
| getSelectableUserColumns (int $a_in_course=0, int $a_in_group=0) | |
| addToClipboard () | |
| Add selected users to clipboard. More... | |
| Protected Member Functions inherited from ilTable2GUI | |
| getRequestedValues () | |
| 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, ilTableFilterItem $a_element) | |
| Check if filter element is based on adv md. More... | |
| fillRow (array $a_set) | |
| Standard Version of Fill Row. More... | |
| getFilterValue (ilTableFilterItem $a_item) | |
| Get current filter value. More... | |
| setFilterValue (ilTableFilterItem $a_item, $a_value) | |
| fillMetaExcel (ilExcel $a_excel, int &$a_row) | |
| Add meta information to excel export. More... | |
| fillHeaderExcel (ilExcel $a_excel, int &$a_row) | |
| Excel Version of Fill Header. More... | |
| fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set) | |
| Excel Version of Fill Row. More... | |
| fillMetaCSV (ilCSVWriter $a_csv) | |
| Add meta information to csv export. More... | |
| fillHeaderCSV (ilCSVWriter $a_csv) | |
| CSV Version of Fill Header. More... | |
| fillRowCSV (ilCSVWriter $a_csv, array $a_set) | |
| CSV Version of Fill Row. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ilTable2GUI | |
| static | getAllCommandLimit () |
| Static Public Member Functions inherited from ilTableGUI | |
| static | linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='') |
| Data Fields inherited from ilLPTableBaseGUI | |
| const | HIT_LIMIT = 5000 |
| 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 | |
| string | $title = "" |
| string | $icon = "" |
| string | $icon_alt = "" |
| string | $help_page = "" |
| string | $help_icon = "" |
| string | $help_icon_alt = "" |
| array | $header_names = [] |
| array | $header_vars = [] |
| array | $linkbar_vars = [] |
| array | $data = [] |
| int | $column_count = 0 |
| array | $column_width = [] |
| int | $max_count = 0 |
| int | $limit = 0 |
| bool | $max_limit = false |
| int | $offset = 0 |
| string | $order_column = "" |
| string | $order_direction = "" |
| string | $footer_style = "" |
| string | $footer_previous = "" |
| string | $footer_next = "" |
| bool | $lang_support = true |
| bool | $global_tpl = false |
| string | $form_name = "" |
| string | $select_all_checkbox = "" |
| array | $action_buttons = [] |
| string | $prefix = "" |
| string | $base = "" |
| array | $enabled |
| array | $styles |
Detailed Description
Constructor & Destructor Documentation
◆ __construct()
| ilTrMatrixTableGUI::__construct | ( | ?object | $a_parent_obj, |
| string | $a_parent_cmd, | ||
| int | $ref_id | ||
| ) |
Constructor.
Definition at line 53 of file class.ilTrMatrixTableGUI.php.
57 {
58 global $DIC;
59
60 $this->tree = $DIC->repositoryTree();
61 $this->rbacsystem = $DIC->rbac()->system();
63
65 $this->ref_id = $ref_id;
68
69 $this->in_group_ref_id = $this->tree->checkForParentType($this->ref_id, "grp");
70 if ($this->in_group_ref_id) {
71 $this->in_group = ilObject::_lookupObjId($this->in_group_ref_id);
72 } else {
73 $this->in_course_ref_id = $this->tree->checkForParentType(
74 $this->ref_id,
75 "crs"
76 );
77 if ($this->in_course_ref_id) {
78 $this->in_course = ilObject::_lookupObjId($this->in_course_ref_id);
79 }
80 }
81
82 $this->lng = $DIC->language();
83 $this->http = $DIC->http();
84 $this->refinery = $DIC->refinery();
85 $this->initFilter();
86 parent::__construct($a_parent_obj, $a_parent_cmd);
87
90 $this->setFormAction(
91 $this->ctrl->getFormActionByClass(get_class($this))
92 );
93 $this->setRowTemplate(
94 "tpl.user_object_matrix_row.html",
95 "components/ILIAS/Tracking"
96 );
99
100 // see ilObjCourseGUI::addMailToMemberButton()
102 if ($this->rbacsystem->checkAccess(
103 "internal_mail",
104 $mail->getMailObjectReferenceId()
105 )) {
106 $this->addMultiCommand(
107 "mailselectedusers",
109 );
110 }
111
113 $this->addMultiCommand(
114 'addToClipboard',
116 );
118 $this->has_multi = true;
119
121
122 $labels = $this->getSelectableColumns();
123 $selected = $this->getSelectedColumns();
126
129 }
130
131 $tooltip = array();
135 if (sizeof($selected) > 5) {
136 $tooltip[] = $title;
138 } else {
140 }
143 }
144 }
145
148 } else {
149 // list cannot be sorted by udf fields (separate query)
151 }
152
153 $this->addColumn(
154 $title,
155 $sort_id,
156 "",
157 false,
158 "",
159 implode(" - ", $tooltip)
160 );
161 }
162 $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
164 }
parseTitle(int $a_obj_id, string $action, int $a_user_id=0)
Definition: class.ilLPTableBaseGUI.php:777
Definition: class.ilMail.php:29
static _lookupType(int $id, bool $reference=false)
Definition: class.ilObject.php:1101
addMultiCommand(string $a_cmd, string $a_text)
Definition: class.ilTable2GUI.php:926
setFormAction(string $a_form_action, bool $a_multipart=false)
Definition: class.ilTable2GUI.php:736
addColumn(string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
Definition: class.ilTable2GUI.php:956
setEnableHeader(bool $a_enableheader)
Definition: class.ilTable2GUI.php:418
setDefaultOrderField(string $a_defaultorderfield)
Definition: class.ilTable2GUI.php:850
setSelectAllCheckbox(string $a_select_all_checkbox, bool $a_select_all_on_top=false)
Definition: class.ilTable2GUI.php:785
setRowTemplate(string $a_template, string $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:844
setDefaultOrderDirection(string $a_defaultorderdirection)
Definition: class.ilTable2GUI.php:861
References $c, $DIC, ilTableGUI\$icon, $ref_id, ilTableGUI\$title, ILIAS\GlobalScreen\Provider\__construct(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ILIAS\FileDelivery\http(), initFilter(), ILIAS\Repository\lng(), ilLPTableBaseGUI\parseTitle(), ILIAS\Repository\refinery(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setSelectAllCheckbox().
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
-
ilCSVWriter $a_csv current file
Reimplemented from ilTable2GUI.
Definition at line 745 of file class.ilTrMatrixTableGUI.php.
745 : void
746 {
747 global $DIC;
748
750
752
753 $labels = $this->getSelectableColumns();
757
760 $type_text = ilObjectPlugin::lookupTxtById(
761 $type,
763 );
764 } else {
766 }
767
769
771 $a_csv->addColumn(
773 );
774 }
775 } else {
777 }
778 }
779
780 $a_csv->addRow();
781 }
static lookupTxtById(string $plugin_id, string $lang_var)
Definition: class.ilObjectPlugin.php:55
ilObjectDataCache $ilObjDataCache
Definition: class.ilTrMatrixTableGUI.php:48
References $c, $DIC, ilCSVWriter\addColumn(), ilCSVWriter\addRow(), ILIAS\Repository\lng(), 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 644 of file class.ilTrMatrixTableGUI.php.
644 : void
645 {
646 global $DIC;
647
649
651
652 $labels = $this->getSelectableColumns();
653 $cnt = 1;
657
660 $type_text = ilObjectPlugin::lookupTxtById(
661 $type,
663 );
664 } else {
666 }
667
668 $a_excel->setCell(
669 $a_row,
670 $cnt,
672 );
673
675 $cnt++;
676 $a_excel->setCell(
677 $a_row,
678 $cnt,
679 $this->lng->txt(
680 "trac_percentage"
681 ) . " (%)"
682 );
683 }
684 } else {
686 }
687 $cnt++;
688 }
689
690 $a_excel->setBold(
692 );
693 }
setCell(int $a_row, int $col, $value, ?string $datatype=null, bool $disable_strip_tags_for_strings=false)
Set cell value.
Definition: class.ilExcel.php:291
References $c, $DIC, ilExcel\getColumnCoord(), ILIAS\Repository\lng(), ilObjectPlugin\lookupTxtById(), ilExcel\setBold(), and ilExcel\setCell().
Here is the call graph for this function:
◆ fillRow()
|
protected |
Standard Version of Fill Row.
Most likely to be overwritten by derived class.
- Parameters
-
array<string,mixed> $a_set data array
Reimplemented from ilTable2GUI.
Definition at line 506 of file class.ilTrMatrixTableGUI.php.
506 : void
507 {
508 if ($this->has_multi) {
509 $this->tpl->setVariable("USER_ID", $a_set["usr_id"]);
510 }
511
516
517 // object without read-lp-permission
519 ($a_set["privacy_conflict"] ?? false)) {
520 $this->tpl->setCurrentBlock("objects");
521 $this->tpl->setVariable("VAL_STATUS", " ");
522 $this->tpl->parseCurrentBlock();
523 continue 2;
524 }
525
526 $status = isset($a_set[$c])
531 : null;
532
534 $timing = $this->showTimingsWarning(
535 $this->ref_ids[$obj_id],
536 $a_set["usr_id"]
537 );
538 if ($timing) {
539 if ($timing !== true) {
542 );
543 } else {
544 $timing = "";
545 }
546 $this->tpl->setCurrentBlock('warning_img');
547 $this->tpl->setVariable(
548 'WARNING_IMG',
549 ilUtil::getImagePath(
550 'media/time_warn.svg'
551 )
552 );
553 $this->tpl->setVariable(
554 'WARNING_ALT',
555 $this->lng->txt(
556 'trac_time_passed'
557 ) . $timing
558 );
559 $this->tpl->parseCurrentBlock();
560 }
561 }
562
563 $this->tpl->setCurrentBlock("objects");
564 $this->tpl->setVariable(
565 "VAL_STATUS",
566 $this->parseValue(
567 "status",
568 (string) $status,
569 ""
570 )
571 );
572 $this->tpl->setVariable(
573 "VAL_PERCENTAGE",
574 $this->parseValue(
575 "percentage",
576 (string) $percentage,
577 ""
578 )
579 );
580 $this->tpl->parseCurrentBlock();
581 break;
582
586 $status = isset($a_set[$c])
589
590 $this->tpl->setCurrentBlock("objects");
591 if (!($a_set["privacy_conflict"] ?? false)) {
592 $this->tpl->setVariable(
593 "VAL_STATUS",
594 $this->parseValue(
595 "status",
596 (string) $status,
597 ""
598 )
599 );
600 } else {
601 $this->tpl->setVariable("VAL_STATUS", " ");
602 }
603 $this->tpl->parseCurrentBlock();
604 break;
605
606 default:
607 $this->tpl->setCurrentBlock("user_field");
608 if (!($a_set["privacy_conflict"] ?? false)) {
609 $this->tpl->setVariable(
610 "VAL_UF",
611 $this->parseValue(
612 $c,
614 ""
615 )
616 );
617 } else {
618 $this->tpl->setVariable("VAL_UF", " ");
619 }
620 $this->tpl->parseCurrentBlock();
621 break;
622 }
623 }
624
625 // #7694
626 if (!$a_set["active"] || ($a_set["privacy_conflict"] ?? false)) {
627 $mess = array();
628 if ($a_set["privacy_conflict"] ?? false) {
630 } elseif (!$a_set["active"]) {
632 }
633 $this->tpl->setCurrentBlock('inactive_bl');
634 $this->tpl->setVariable('TXT_INACTIVE', implode(", ", $mess));
635 $this->tpl->parseCurrentBlock();
636 }
637
638 $login = !($a_set["privacy_conflict"] ?? false)
639 ? $a_set["login"]
640 : " ";
641 $this->tpl->setVariable("VAL_LOGIN", $login);
642 }
static formatDate(ilDateTime $date, bool $a_skip_day=false, bool $a_include_wd=false, bool $include_seconds=false, ?ilObjUser $user=null,)
Definition: class.ilDatePresentation.php:82
const LP_STATUS_NOT_ATTEMPTED_NUM
Definition: class.ilLPStatus.php:42
showTimingsWarning(int $a_ref_id, int $a_user_id)
Definition: class.ilLPTableBaseGUI.php:895
parseValue(string $id, ?string $value, string $type)
Definition: class.ilLPTableBaseGUI.php:558
static getImagePath(string $image_name, string $module_path="", string $mode="output", bool $offline=false)
get image path (for images located in a template directory)
Definition: class.ilUtil.php:68
References $c, ilDatePresentation\formatDate(), ilUtil\getImagePath(), IL_CAL_UNIX, ILIAS\Repository\int(), ILIAS\Repository\lng(), ilLPStatus\LP_STATUS_COMPLETED_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.
Here is the call graph for this function:
◆ fillRowCSV()
|
protected |
CSV Version of Fill Row.
Most likely to be overwritten by derived class.
- Parameters
-
ilCSVWriter $a_csv current file array $a_set data array
Reimplemented from ilTable2GUI.
Definition at line 783 of file class.ilTrMatrixTableGUI.php.
783 : void
784 {
786
791 $val = ilLearningProgressBaseGUI::_getStatusText(
793 );
794 $a_csv->addColumn($val);
795
797 $perc = null;
800 }
802 }
803 break;
804
808 $val = ilLearningProgressBaseGUI::_getStatusText(
810 );
811 $a_csv->addColumn($val);
812 break;
813
814 /* #14142
815 case "last_access":
816 case "spent_seconds":
817 case "status_changed":
818 */
819 default:
821 $a_csv->addColumn($val);
822 break;
823 }
824 }
825
826 $a_csv->addRow();
827 }
static _getStatusText(int $a_status, ?ilLanguage $a_lng=null)
Get status alt text.
Definition: class.ilLearningProgressBaseGUI.php:318
References $c, ilLearningProgressBaseGUI\_getStatusText(), ilCSVWriter\addColumn(), ilCSVWriter\addRow(), and ILIAS\Repository\int().
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 695 of file class.ilTrMatrixTableGUI.php.
699 : void {
701
702 $cnt = 1;
707 $val = ilLearningProgressBaseGUI::_getStatusText(
709 );
710 $a_excel->setCell($a_row, $cnt, $val);
711
713 $cnt++;
715 $perc = !$perc
716 ? null
717 : $perc . "%";
718 $a_excel->setCell($a_row, $cnt, $perc);
719 }
720 break;
721
725 $val = ilLearningProgressBaseGUI::_getStatusText(
727 );
728 $a_excel->setCell($a_row, $cnt, $val);
729 break;
730
731 /* #14142
732 case "last_access":
733 case "spent_seconds":
734 case "status_changed":
735 */
736 default:
738 $a_excel->setCell($a_row, $cnt, $val);
739 break;
740 }
741 $cnt++;
742 }
743 }
References $c, ilLearningProgressBaseGUI\_getStatusText(), ILIAS\Repository\int(), 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 327 of file class.ilTrMatrixTableGUI.php.
330 : array {
331
332 // #17081
333 if ($this->restore_filter) {
334 $name = $this->restore_filter_values["name"];
335 $this->setFilterValue($this->filters[0], $name);
337 }
338
339 $collection = ilTrQuery::getObjectIds(
340 $this->obj_id,
341 $this->ref_id,
342 true
343 );
344 if ($collection["object_ids"]) {
345 // we need these for the timing warnings
346 $this->ref_ids = $collection["ref_ids"];
347
348 // only if object is [part of] course/group
349 $check_agreement = false;
350 if ($this->in_course) {
351 // privacy (if course agreement is activated)
352 $privacy = ilPrivacySettings::getInstance();
353 if ($privacy->courseConfirmationRequired()) {
354 $check_agreement = $this->in_course;
355 }
356 } elseif ($this->in_group) {
357 // privacy (if group agreement is activated)
358 $privacy = ilPrivacySettings::getInstance();
359 if ($privacy->groupConfirmationRequired()) {
360 $check_agreement = $this->in_group;
361 }
362 }
364 $this->ref_id,
365 $collection["object_ids"],
367 $a_user_fields,
368 $a_privary_fields,
369 $check_agreement
370 );
372 // sub-items: learning objectives
374 $collection["objectives_parent_id"],
376 );
377
378 $this->objective_ids = array();
379
382 foreach ($inner_objectives as $objective_id => $status) {
385
387 $this->objective_ids[$objective_id] = ilCourseObjective::lookupObjectiveTitle(
388 $objective_id
389 );
390 }
391 }
392 }
393 }
394 }
395
396 // sub-items: SCOs
398 $this->sco_ids = array();
400 foreach ($collection["scorm"]["scos"] as $sco) {
401 if (!in_array($sco, $this->sco_ids)) {
402 $this->sco_ids[$sco] = $collection["scorm"]["scos_title"][$sco];
403 }
404
405 // alex, 5 Nov 2011: we got users being in failed and in
406 // completed status, I changed the setting in: first check failed
407 // then check completed since failed should superseed completed
408 // (before completed has been checked before failed)
409 $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
410 if (in_array(
411 $user_id,
412 $collection["scorm"]["failed"][$sco]
413 )) {
414 $status = ilLPStatus::LP_STATUS_FAILED_NUM;
415 } elseif (in_array(
416 $user_id,
417 $collection["scorm"]["completed"][$sco]
418 )) {
419 $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
420 } elseif (in_array(
421 $user_id,
422 $collection["scorm"]["in_progress"][$sco]
423 )) {
424 $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
425 }
426
429 }
430 }
431 }
432
433 // sub-items: generic, e.g. lm chapter
436 foreach ($collection["subitems"]["items"] as $item_id) {
437 $this->subitem_ids[$item_id] = $collection["subitems"]["item_titles"][$item_id];
438
439 $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
440 if (isset(
441 $collection["subitems"]["completed"]
442 ) && in_array(
443 $user_id,
444 $collection["subitems"]["completed"][$item_id]
445 )) {
446 $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
447 } elseif (isset(
448 $collection["subitems"]["in_progress"]
449 ) &&
450 in_array(
451 $user_id,
452 $collection["subitems"]["in_progress"][$item_id]
453 )) {
454 $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
455 }
456
459 }
460 }
461 }
462
463 // percentage export
465 $this->perc_map = array();
471
472 // #18673
474 !(int) $value) {
476 } else {
478 }
479 }
480 }
481 }
482 }
483
484 /*
485 * ilTrQuery does not read out any information about org units
486 * (nor should it), so it needs to be added here.
487 */
488 if (in_array('org_units', $a_user_fields)) {
490 if (!isset($usr_data['usr_id'])) {
491 continue;
492 }
494 $org_units = ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($usr_id);
496 }
497 }
498
501 return $collection["object_ids"] ?? [];
502 }
503 return [];
504 }
static lookupObjectiveTitle(int $a_objective_id, bool $a_add_description=false)
Definition: class.ilCourseObjective.php:97
const LP_STATUS_IN_PROGRESS_NUM
Definition: class.ilLPStatus.php:43
isPercentageAvailable(int $a_obj_id)
Definition: class.ilLPTableBaseGUI.php:747
setFilterValue(ilTableFilterItem $a_item, $a_value)
Definition: class.ilTable2GUI.php:2356
static getUserObjectiveMatrix(int $a_parent_obj_id, array $a_users)
Definition: class.ilTrQuery.php:1795
static getObjectIds(int $a_parent_obj_id, int $a_parent_ref_id, bool $use_collection=true, bool $a_refresh_status=true, ?array $a_user_ids=null)
Get (sub)objects for given object, also handles learning objectives (course only)
Definition: class.ilTrQuery.php:1469
static getUserObjectMatrix(int $a_parent_ref_id, array $a_obj_ids, ?string $a_user_filter=null, ?array $a_additional_fields=null, ?array $a_privacy_fields=null, ?int $a_check_agreement=null)
Get status matrix for users on objects.
Definition: class.ilTrQuery.php:1669
filter(string $filter_id, $class_path, string $cmd, bool $activated=true, bool $expanded=true)
Definition: trait.GlobalDICGUIServices.php:178
References ILIAS\Repository\filter(), and ilTable2GUI\setFilterValue().
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 191 of file class.ilTrMatrixTableGUI.php.
191 : array
192 {
193 $user_cols = $this->getSelectableUserColumns(
194 $this->in_course_ref_id,
195 $this->in_group_ref_id
196 );
197 $columns = [];
198 if ($this->obj_ids === null) {
199 // we cannot use the selected columns because they are not ready yet
200 // so we use all available columns, should be ok anyways
201 $this->obj_ids = $this->getItems(
202 array_keys($user_cols[0]),
203 $user_cols[1]
204 );
205 }
206 $parent = [];
207 if (isset($this->obj_ids)) {
208 $tmp_cols = array();
212 "default" => true
213 );
214 } else {
215 $no_perm = false;
216
220 'read_learning_progress',
221 $ref_id
222 )) {
223 $no_perm = true;
224 $this->privacy_cols[] = $obj_id;
225 }
226
232 $title = $sess->getPresentationTitle();
233 }
234
235 // BT 35475: set titles of referenced objects correctly
236 if (
239 ) {
241 }
242
243 // #16453
244 $relpath = null;
249 }
250
255 "default" => true,
256 "no_permission" => $no_perm,
257 "path" => $relpath
258 );
259 }
260 }
261 if (sizeof($this->objective_ids)) {
263 $tmp_cols[strtolower(
264 $title
266 "default" => true
267 );
268 }
269 }
270 if (sizeof($this->sco_ids)) {
273 $tmp_cols[strtolower(
274 $title
277 "default" => true
278 );
279 }
280 }
281 if (sizeof($this->subitem_ids)) {
284 $obj_id,
285 "tiny",
287 $this->obj_id
288 )
289 );
290 $tmp_cols[strtolower(
291 $title
294 "default" => true
295 );
296 }
297 }
298
299 // alex, 5 Nov 2011: Do not sort SCORM items or "chapters"
300 if (!sizeof($this->sco_ids) && !sizeof($this->subitem_ids)) {
301 ksort($tmp_cols);
302 }
305 $columns[$id[1]] = $def;
306 }
307 unset($tmp_cols);
308
309 if ($parent) {
311 }
312 }
313
314 unset($user_cols[0]["status"]);
315 unset($user_cols[0]["login"]);
316 foreach ($user_cols[0] as $col_id => $col_def) {
317 if (!isset($columns[$col_id])) {
318 // these are all additional fields, no default
319 $col_def["default"] = false;
320 $columns[$col_id] = $col_def;
321 }
322 }
323
324 return $columns;
325 }
static _lookupTargetTitle(int $a_obj_id)
Definition: class.ilContainerReference.php:93
getSelectableUserColumns(int $a_in_course=0, int $a_in_group=0)
Definition: class.ilLPTableBaseGUI.php:1026
static checkPermission(string $a_permission, int $a_ref_id, ?int $a_user_id=null)
wrapper for rbac access checks
Definition: class.ilLearningProgressAccess.php:30
Definition: class.ilObjSession.php:30
static _getIcon(int $obj_id=0, string $size="big", string $type="", bool $offline=false)
Get icon for repository item.
Definition: class.ilObject.php:1908
Definition: class.ilPathGUI.php:22
getItems(array $a_user_fields, ?array $a_privary_fields=null)
Definition: class.ilTrMatrixTableGUI.php:327
static getSubItemType(int $a_parent_obj_id)
Get sub-item object type for parent.
Definition: class.ilTrQuery.php:683
References ilTableGUI\$icon, ilTable2GUI\$id, $obj_id, $path, $ref_id, ilTableGUI\$title, $type, ilObject\_getIcon(), ilContainerReference\_lookupTargetTitle(), ilLearningProgressAccess\checkPermission(), getItems(), ilLPTableBaseGUI\getSelectableUserColumns(), ilTrQuery\getSubItemType(), and ILIAS\Repository\lng().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ initFilter()
| ilTrMatrixTableGUI::initFilter | ( | ) |
Reimplemented from ilTable2GUI.
Definition at line 166 of file class.ilTrMatrixTableGUI.php.
166 : void
167 {
168 $item = $this->addFilterItemByMetaType(
169 "name",
171 false,
173 );
175
176 // #14949 - is called before constructor, so we have to do it ourselves
180 }
181 }
addFilterItemByMetaType(string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
Add filter by standard type.
Definition: class.ilTable2GUI.php:517
References ilTable2GUI\addFilterItemByMetaType(), ILIAS\Repository\filter(), ilTable2GUI\FILTER_TEXT, ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ilTable2GUI\setFilterValue().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ numericOrdering()
| ilTrMatrixTableGUI::numericOrdering | ( | $a_field | ) |
Definition at line 183 of file class.ilTrMatrixTableGUI.php.
183 : bool
184 {
185 if ($a_field === 'read_count' || $a_field === 'spent_seconds') {
186 return true;
187 }
188 return false;
189 }
Field Documentation
◆ $has_multi
|
protected |
Definition at line 44 of file class.ilTrMatrixTableGUI.php.
◆ $ilObjDataCache
|
protected |
Definition at line 48 of file class.ilTrMatrixTableGUI.php.
◆ $in_course
|
protected |
Definition at line 37 of file class.ilTrMatrixTableGUI.php.
◆ $in_course_ref_id
|
protected |
Definition at line 39 of file class.ilTrMatrixTableGUI.php.
◆ $in_group
|
protected |
Definition at line 38 of file class.ilTrMatrixTableGUI.php.
◆ $in_group_ref_id
|
protected |
Definition at line 40 of file class.ilTrMatrixTableGUI.php.
◆ $obj_id
|
protected |
Definition at line 32 of file class.ilTrMatrixTableGUI.php.
Referenced by getSelectableColumns().
◆ $obj_ids
|
protected |
Definition at line 33 of file class.ilTrMatrixTableGUI.php.
◆ $objective_ids
|
protected |
Definition at line 34 of file class.ilTrMatrixTableGUI.php.
◆ $perc_map
|
protected |
Definition at line 43 of file class.ilTrMatrixTableGUI.php.
◆ $privacy_cols
|
protected |
Definition at line 42 of file class.ilTrMatrixTableGUI.php.
◆ $privacy_fields
|
protected |
Definition at line 41 of file class.ilTrMatrixTableGUI.php.
◆ $rbacsystem
|
protected |
Definition at line 47 of file class.ilTrMatrixTableGUI.php.
◆ $ref_id
|
protected |
Definition at line 29 of file class.ilTrMatrixTableGUI.php.
Referenced by __construct(), and getSelectableColumns().
◆ $ref_ids
|
protected |
Definition at line 30 of file class.ilTrMatrixTableGUI.php.
◆ $sco_ids
|
protected |
Definition at line 35 of file class.ilTrMatrixTableGUI.php.
◆ $subitem_ids
|
protected |
Definition at line 36 of file class.ilTrMatrixTableGUI.php.
◆ $tree
|
protected |
Definition at line 46 of file class.ilTrMatrixTableGUI.php.
◆ $type
|
protected |
Definition at line 31 of file class.ilTrMatrixTableGUI.php.
Referenced by getSelectableColumns().
The documentation for this class was generated from the following file:
- components/ILIAS/Tracking/classes/repository_statistics/class.ilTrMatrixTableGUI.php
