ILIAS  trunk Revision v12.0_alpha-1227-g7ff6d300864
class.ilTable2GUI.php
Go to the documentation of this file.
1<?php
2
26{
27 public const FILTER_TEXT = 1;
28 public const FILTER_SELECT = 2;
29 public const FILTER_DATE = 3;
30 public const FILTER_LANGUAGE = 4;
31 public const FILTER_NUMBER_RANGE = 5;
32 public const FILTER_DATE_RANGE = 6;
33 public const FILTER_DURATION_RANGE = 7;
34 public const FILTER_DATETIME_RANGE = 8;
35 public const FILTER_CHECKBOX = 9;
36 public const EXPORT_EXCEL = 1;
37 public const EXPORT_CSV = 2;
38 public const ACTION_ALL_LIMIT = 1000;
39 private \ILIAS\DI\UIServices $ui;
40 protected string $requested_nav_par2 = "";
41 protected string $requested_nav_par = "";
42 protected string $requested_nav_par1 = "";
44 protected array $selected_columns = [];
45
46 protected ilCtrl $ctrl;
47 protected ?object $parent_obj = null;
48 protected string $parent_cmd = "";
49 protected string $close_command = "";
50 private string $unique_id = "";
51 private string $headerHTML = "";
52 protected string $top_anchor = "il_table_top";
53 protected array $filters = array();
54 protected array $optional_filters = array();
55 protected string $filter_cmd = 'applyFilter';
56 protected string $reset_cmd = 'resetFilter';
57 protected int $filter_cols = 5;
58 protected bool $ext_sort = false;
59 protected bool $ext_seg = false;
60 protected string $context = "";
61
62 protected array $mi_sel_buttons = [];
63 protected bool $disable_filter_hiding = false;
64 protected bool $top_commands = true;
65 protected array $selectable_columns = array();
66 protected array $selected_column = array();
67 protected bool $show_rows_selector = true; // JF, 2014-10-27
68 protected bool $rows_selector_off = false;
69
70 protected bool $nav_determined = false;
71 protected bool $limit_determined = false;
72 protected bool $filters_determined = false;
73 protected bool $columns_determined = false;
74 protected bool $open_form_tag = true;
75 protected bool $close_form_tag = true;
76 protected array $export_formats = [];
77 protected int $export_mode = 0;
78 protected bool $print_mode = false;
79 protected bool $enable_command_for_all = false;
80 protected bool $restore_filter = false;
81 protected array $restore_filter_values = [];
82 protected bool $default_filter_visibility = false;
83 protected array $sortable_fields = array();
84 protected bool $prevent_double_submission = true;
85 protected string $row_selector_label = "";
86 protected bool $select_all_on_top = false;
87 protected array $sel_buttons = [];
88 protected string $nav_value = '';
89 protected string $noentriestext = '';
90 protected string $css_row = '';
91 protected bool $display_as_block = false;
92 protected string $description = '';
93 protected string $id = "";
94 protected bool $custom_prev_next = false;
95 protected string $reset_cmd_txt = "";
96 protected string $defaultorderfield = "";
97 protected string $defaultorderdirection = "";
98 protected array $column = [];
99 protected bool $datatable = false;
100 protected bool $num_info = false;
101 protected bool $form_multipart = false;
102 protected array $row_data = [];
103 protected string $order_field = "";
104 protected array $selected_filter = [];
105 protected string $form_action = "";
106 protected string $formname = "";
107 protected string $sort_order = "";
108 protected array $buttons = [];
109 protected array $multi = [];
110 protected array $hidden_inputs = [];
111 protected array $header_commands = [];
112 protected string $row_template = "";
113 protected string $row_template_dir = "";
114 protected string $filter_cmd_txt = "";
115 protected string $custom_prev = "";
116 protected string $custom_next = "";
117 protected ?array $raw_post_data = null;
118 protected \ilGlobalTemplateInterface $main_tpl;
119
123 public function __construct(
124 ?object $a_parent_obj,
125 string $a_parent_cmd = "",
126 string $a_template_context = ""
127 ) {
128 global $DIC;
129 $this->main_tpl = $DIC->ui()->mainTemplate();
130 $this->ui = $DIC->ui();
131
132 $this->lng = $DIC->language();
133 $this->ctrl = $DIC->ctrl();
134 $lng = $DIC->language();
135
136 if (isset($DIC["http"])) {
137 $this->table_request = new \ILIAS\Table\TableGUIRequest(
138 $DIC->http(),
139 $DIC->refinery()
140 );
141 }
142 $this->getRequestedValues();
143 parent::__construct([], false);
144 $this->unique_id = md5(uniqid('', true));
145 $this->parent_obj = $a_parent_obj;
146 $this->parent_cmd = $a_parent_cmd;
147 $this->buttons = array();
148 $this->header_commands = array();
149 $this->multi = array();
150 $this->hidden_inputs = array();
151 $this->formname = "table_" . $this->unique_id;
152 $this->tpl = new ilTemplate("tpl.table2.html", true, true, "components/ILIAS/Table");
153
154 $lng->loadLanguageModule('tbl');
155
156 if (!$a_template_context) {
157 $a_template_context = $this->getId();
158 }
159 $this->setContext($a_template_context);
160
161 // activate export mode
162 if (isset($this->table_request)) {
163 $this->export_mode = $this->table_request->getExportMode($this->prefix);
164 }
165
166 $this->determineLimit();
167 $this->setIsDataTable(true);
168 $this->setEnableNumInfo(true);
170
171 $this->raw_post_data = [];
172 if (isset($DIC["http"])) {
173 $this->raw_post_data = $DIC->http()->request()->getParsedBody();
174 }
175 }
176
177 protected function getRequestedValues(): void
178 {
179 if (is_null($this->table_request)) {
180 return;
181 }
182 $this->requested_nav_par = $this->table_request->getNavPar($this->getNavParameter());
183 $this->requested_nav_par1 = $this->table_request->getNavPar($this->getNavParameter(), 1);
184 $this->requested_nav_par2 = $this->table_request->getNavPar($this->getNavParameter(), 2);
185 }
186
187 public function setOpenFormTag(bool $a_val): void
188 {
189 $this->open_form_tag = $a_val;
190 }
191
192 public function getOpenFormTag(): bool
193 {
195 }
196
197 public function setCloseFormTag(bool $a_val): void
198 {
199 $this->close_form_tag = $a_val;
200 }
201
202 public function getCloseFormTag(): bool
203 {
205 }
206
207 public function determineLimit(): void
208 {
209 global $DIC;
210
211 $ilUser = null;
212 if (isset($DIC["ilUser"])) {
213 $ilUser = $DIC["ilUser"];
214 }
215
216 if ($this->limit_determined) {
217 return;
218 }
219
220 $limit = 0;
221 if (isset($this->table_request) && !is_null($this->table_request->getRows($this->prefix))) {
222 $this->storeProperty("rows", $this->table_request->getRows($this->prefix));
223 $limit = $this->table_request->getRows($this->prefix) ?? 0;
224 $this->resetOffset();
225 }
226
227 if ($limit == 0) {
228 $rows = (int) $this->loadProperty("rows");
229 if ($rows > 0) {
230 $limit = $rows;
231 } else {
232 $limit = 40;
233 }
234 }
235
236 $this->setLimit($limit);
237 $this->limit_determined = true;
238 }
239
244 public function getSelectableColumns(): array
245 {
246 return [];
247 }
248
249 public function determineSelectedColumns(): void
250 {
251 if ($this->columns_determined) {
252 return;
253 }
254
255 $old_sel = $this->loadProperty("selfields");
256 $sel_fields = [];
257 $stored = false;
258 if ($old_sel != "") {
259 $sel_fields = unserialize((string) $old_sel);
260 $stored = true;
261 }
262 if (!is_array($sel_fields)) {
263 $stored = false;
264 $sel_fields = array();
265 }
266
267 $this->selected_columns = array();
268 $set = false;
269
270 $fsh = false;
271 $fs = [];
272 if (isset($this->table_request)) {
273 $fs = $this->table_request->getFS($this->getId());
274 $fsh = $this->table_request->getFSH($this->getId());
275 }
276
277 foreach ($this->getSelectableColumns() as $k => $c) {
278 $this->selected_column[$k] = false;
279
280 $new_column = (!isset($sel_fields[$k]));
281
282 if ($fsh) {
283 $set = true;
284 if (in_array($k, $fs)) {
285 $this->selected_column[$k] = true;
286 }
287 } elseif ($stored && !$new_column) { // take stored values
288 $this->selected_column[$k] = $sel_fields[$k];
289 } else { // take default values
290 if ($new_column) {
291 $set = true;
292 }
293 if (isset($c["default"]) && $c["default"]) {
294 $this->selected_column[$k] = true;
295 }
296 }
297
298 // Optional filters
299 $ff = [];
300 if (isset($this->table_request)) {
301 $ff = $this->table_request->getFF($this->getId());
302 }
303 if (count($ff) > 0) {
304 $set = true;
305 if (in_array($k, $ff)) {
306 $this->selected_column[$k] = true;
307 }
308 }
309 }
310
311 if ($old_sel != serialize($this->selected_column) && $set) {
312 $this->storeProperty("selfields", serialize($this->selected_column));
313 }
314
315 $this->columns_determined = true;
316 }
317
318 public function isColumnSelected(string $col): bool
319 {
320 return $this->selected_column[$col] ?? false;
321 }
322
323 public function getSelectedColumns(): array
324 {
325 $scol = array();
326 foreach ($this->selected_column as $k => $v) {
327 if ($v) {
328 $scol[$k] = $k;
329 }
330 }
331 return $scol;
332 }
333
334 public function executeCommand(): bool
335 {
336 $ilCtrl = $this->ctrl;
337
338 $next_class = $ilCtrl->getNextClass($this);
339
340 switch ($next_class) {
341 case 'ilformpropertydispatchgui':
342 $form_prop_dispatch = new ilFormPropertyDispatchGUI();
343 $this->initFilter();
345 $item = $this->getFilterItemByPostVar(
346 $this->table_request->getPostVar()
347 );
348 $form_prop_dispatch->setItem($item);
349 return (bool) $ilCtrl->forwardCommand($form_prop_dispatch);
350 }
351 return false;
352 }
353
354 public function resetOffset(bool $a_in_determination = false): void
355 {
356 if (!$this->nav_determined && !$a_in_determination) {
358 }
359 $this->nav_value = $this->getOrderField() . ":" . $this->getOrderDirection() . ":0";
360 $this->requested_nav_par = $this->requested_nav_par1 = $this->nav_value;
361 $this->setOffset(0);
362 }
363
364 public function initFilter(): void
365 {
366 }
367
368 public function getParentObject(): ?object
369 {
370 return $this->parent_obj;
371 }
372
373 public function getParentCmd(): string
374 {
375 return $this->parent_cmd;
376 }
377
378 public function setTopAnchor(string $a_val): void
379 {
380 $this->top_anchor = $a_val;
381 }
382
383 public function getTopAnchor(): string
384 {
385 return $this->top_anchor;
386 }
387
388 public function setNoEntriesText(string $a_text): void
389 {
390 $this->noentriestext = $a_text;
391 }
392
393 public function getNoEntriesText(): string
394 {
396 }
397
398 public function setIsDataTable(bool $a_val): void
399 {
400 $this->datatable = $a_val;
401 }
402
403 public function getIsDataTable(): bool
404 {
405 return $this->datatable;
406 }
407
408 public function setEnableTitle(bool $a_enabletitle): void
409 {
410 $this->enabled["title"] = $a_enabletitle;
411 }
412
413 public function getEnableTitle(): bool
414 {
415 return $this->enabled["title"];
416 }
417
418 public function setEnableHeader(bool $a_enableheader): void
419 {
420 $this->enabled["header"] = $a_enableheader;
421 }
422
423 public function getEnableHeader(): bool
424 {
425 return $this->enabled["header"];
426 }
427
428 public function setEnableNumInfo(bool $a_val): void
429 {
430 $this->num_info = $a_val;
431 }
432
433 public function getEnableNumInfo(): bool
434 {
435 return $this->num_info;
436 }
437
438 final public function setTitle(
439 string $a_title,
440 string $a_icon = "",
441 string $a_icon_alt = ""
442 ): void {
443 parent::setTitle($a_title, $a_icon, $a_icon_alt);
444 }
445
446 public function setDescription(string $a_val): void
447 {
448 $this->description = $a_val;
449 }
450
451 public function getDescription(): string
452 {
453 return $this->description;
454 }
455
456 public function setOrderField(string $a_order_field): void
457 {
458 $this->order_field = $a_order_field;
459 }
460
461 public function getOrderField(): string
462 {
463 return $this->order_field;
464 }
465
466 final public function setData(array $a_data): void
467 {
468 $this->row_data = $a_data;
469 }
470
471 final public function getData(): array
472 {
473 return $this->row_data;
474 }
475
476 final public function dataExists(): bool
477 {
478 return count($this->row_data) > 0;
479 }
480
481 final public function setPrefix(string $a_prefix): void
482 {
483 $this->prefix = $a_prefix;
484 $this->getRequestedValues();
485 }
486
487 final public function getPrefix(): string
488 {
489 return $this->prefix;
490 }
491
492 final public function addFilterItem(
493 ilTableFilterItem $a_input_item,
494 bool $a_optional = false
495 ): void {
496 $a_input_item->setParentTable($this);
497 if (!$a_optional) {
498 $this->filters[] = $a_input_item;
499 } else {
500 $this->optional_filters[] = $a_input_item;
501 }
502
503 // restore filter values (from stored view)
504 if ($this->restore_filter) {
505 if (array_key_exists($a_input_item->getFieldId(), $this->restore_filter_values ?? [])) {
506 $this->setFilterValue($a_input_item, $this->restore_filter_values[$a_input_item->getFieldId()]);
507 } else {
508 $this->setFilterValue($a_input_item, null); // #14949
509 }
510 }
511 }
512
517 public function addFilterItemByMetaType(
518 string $id,
519 int $type = self::FILTER_TEXT,
520 bool $a_optional = false,
521 string $caption = ""
523 global $DIC;
524
525 $lng = $DIC->language(); // constructor may not be called here, if initFilter is being called in subclasses before parent::__construct
526
527 if (!$caption) {
528 $caption = $lng->txt($id);
529 }
530
531 switch ($type) {
532 case self::FILTER_CHECKBOX:
533 $item = new ilCheckboxInputGUI($caption, $id);
534 break;
535
536 case self::FILTER_SELECT:
537 $item = new ilSelectInputGUI($caption, $id);
538 break;
539
540 case self::FILTER_DATE:
541 $item = new ilDateTimeInputGUI($caption, $id);
542 break;
543
544 case self::FILTER_TEXT:
545 $item = new ilTextInputGUI($caption, $id);
546 $item->setMaxLength(64);
547 $item->setSize(20);
548 // $item->setSubmitFormOnEnter(true);
549 break;
550
551 case self::FILTER_LANGUAGE:
552 $lng->loadLanguageModule("meta");
553 $item = new ilSelectInputGUI($caption, $id);
554 $options = array("" => $lng->txt("trac_all"));
555 foreach ($lng->getInstalledLanguages() as $lang_key) {
556 $options[$lang_key] = $lng->txt("meta_l_" . $lang_key);
557 }
558 $item->setOptions($options);
559 break;
560
561 case self::FILTER_NUMBER_RANGE:
562 $item = new ilCombinationInputGUI($caption, $id);
563 $combi_item = new ilNumberInputGUI("", $id . "_from");
564 $combi_item->setSize(5);
565 $item->addCombinationItem("from", $combi_item, $lng->txt("from"));
566 $combi_item = new ilNumberInputGUI("", $id . "_to");
567 $combi_item->setSize(5);
568 $item->addCombinationItem("to", $combi_item, $lng->txt("to"));
569 $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);
570 //$item->setMaxLength(7);
571 //$item->setSize(20);
572 break;
573
574 case self::FILTER_DATE_RANGE:
575 $item = new ilCombinationInputGUI($caption, $id);
576 $combi_item = new ilDateTimeInputGUI("", $id . "_from");
577 $item->addCombinationItem("from", $combi_item, $lng->txt("from"));
578 $combi_item = new ilDateTimeInputGUI("", $id . "_to");
579 $item->addCombinationItem("to", $combi_item, $lng->txt("to"));
580 $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);
581 break;
582
583 case self::FILTER_DATETIME_RANGE:
584 $item = new ilCombinationInputGUI($caption, $id);
585 $combi_item = new ilDateTimeInputGUI("", $id . "_from");
586 $combi_item->setShowTime(true);
587 $item->addCombinationItem("from", $combi_item, $lng->txt("from"));
588 $combi_item = new ilDateTimeInputGUI("", $id . "_to");
589 $combi_item->setShowTime(true);
590 $item->addCombinationItem("to", $combi_item, $lng->txt("to"));
591 $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);
592 break;
593
594 case self::FILTER_DURATION_RANGE:
595 $lng->loadLanguageModule("form");
596 $item = new ilCombinationInputGUI($caption, $id);
597 $combi_item = new ilDurationInputGUI("", $id . "_from");
598 $combi_item->setShowMonths(false);
599 $combi_item->setShowDays(true);
600 $combi_item->setShowSeconds(true);
601 $item->addCombinationItem("from", $combi_item, $lng->txt("from"));
602 $combi_item = new ilDurationInputGUI("", $id . "_to");
603 $combi_item->setShowMonths(false);
604 $combi_item->setShowDays(true);
605 $combi_item->setShowSeconds(true);
606 $item->addCombinationItem("to", $combi_item, $lng->txt("to"));
607 $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);
608 break;
609
610 default:
611 return null;
612 }
613
614 $this->addFilterItem($item, $a_optional);
615 $item->readFromSession();
616 return $item;
617 }
618
619 final public function getFilterItems(bool $a_optionals = false): array
620 {
621 if (!$a_optionals) {
622 return $this->filters;
623 }
624 return $this->optional_filters;
625 }
626
627 final public function getFilterItemByPostVar(string $a_post_var): ?ilTableFilterItem
628 {
629 foreach ($this->getFilterItems() as $item) {
630 if ($item->getPostVar() == $a_post_var) {
631 return $item;
632 }
633 }
634 foreach ($this->getFilterItems(true) as $item) {
635 if ($item->getPostVar() == $a_post_var) {
636 return $item;
637 }
638 }
639 return null;
640 }
641
642 public function setFilterCols(int $a_val): void
643 {
644 $this->filter_cols = $a_val;
645 }
646
647 public function getFilterCols(): int
648 {
649 return $this->filter_cols;
650 }
651
652 public function setDisableFilterHiding(bool $a_val = true): void
653 {
654 $this->disable_filter_hiding = $a_val;
655 }
656
657 public function getDisableFilterHiding(): bool
658 {
659 return $this->disable_filter_hiding;
660 }
661
665 public function isFilterSelected(string $a_col): bool
666 {
667 return (bool) $this->selected_filter[$a_col];
668 }
669
670 public function getSelectedFilters(): array
671 {
672 $sfil = array();
673 foreach ($this->selected_filter as $k => $v) {
674 if ($v) {
675 $sfil[$k] = $k;
676 }
677 }
678 return $sfil;
679 }
680
681 public function determineSelectedFilters(): void
682 {
683 if ($this->filters_determined) {
684 return;
685 }
686
687 $old_sel = $this->loadProperty("selfilters");
688 $stored = false;
689 $sel_filters = null;
690 if ($old_sel != "") {
691 $sel_filters =
692 unserialize((string) $old_sel);
693 $stored = true;
694 }
695 if (!is_array($sel_filters)) {
696 $stored = false;
697 $sel_filters = array();
698 }
699
700 $this->selected_filter = array();
701 $set = false;
702 foreach ($this->getFilterItems(true) as $item) {
703 $k = $item->getPostVar();
704
705 $this->selected_filter[$k] = false;
706
707 if ($this->table_request->getFSF($this->getId())) {
708 $set = true;
709 if (in_array($k, $this->table_request->getFF($this->getId()))) {
710 $this->selected_filter[$k] = true;
711 } else {
712 $item->setValue(null);
713 $item->writeToSession();
714 }
715 } elseif ($stored) { // take stored values
716 $this->selected_filter[$k] = $sel_filters[$k] ?? "";
717 }
718 }
719
720 if ($old_sel != serialize($this->selected_filter) && $set) {
721 $this->storeProperty("selfilters", serialize($this->selected_filter));
722 }
723
724 $this->filters_determined = true;
725 }
726
727 public function setCustomPreviousNext(
728 string $a_prev_link,
729 string $a_next_link
730 ): void {
731 $this->custom_prev_next = true;
732 $this->custom_prev = $a_prev_link;
733 $this->custom_next = $a_next_link;
734 }
735
736 final public function setFormAction(
737 string $a_form_action,
738 bool $a_multipart = false
739 ): void {
740 $this->form_action = $a_form_action;
741 $this->form_multipart = $a_multipart;
742 }
743
744 final public function getFormAction(): string
745 {
746 return $this->form_action;
747 }
748
749 public function setFormName(string $a_name = ""): void
750 {
751 $this->formname = $a_name;
752 }
753
754 public function getFormName(): string
755 {
756 return $this->formname;
757 }
758
759 public function setId(string $a_val): void
760 {
761 $this->id = $a_val;
762 if ($this->getPrefix() == "") {
763 $this->setPrefix($a_val);
764 }
765 if (strlen($this->id) > 30) {
766 throw new ilException("Table ID to long (max. 30 char): " . $this->id);
767 }
768 }
769
770 public function getId(): string
771 {
772 return $this->id;
773 }
774
775 public function setDisplayAsBlock(bool $a_val): void
776 {
777 $this->display_as_block = $a_val;
778 }
779
780 public function getDisplayAsBlock(): bool
781 {
782 return $this->display_as_block;
783 }
784
785 public function setSelectAllCheckbox(
786 string $a_select_all_checkbox,
787 bool $a_select_all_on_top = false
788 ): void {
789 $this->select_all_checkbox = $a_select_all_checkbox;
790 $this->select_all_on_top = $a_select_all_on_top;
791 }
792
793 public function setExternalSorting(bool $a_val): void
794 {
795 $this->ext_sort = $a_val;
796 }
797
798 public function getExternalSorting(): bool
799 {
800 return $this->ext_sort;
801 }
802
803 public function setFilterCommand(
804 string $a_val,
805 string $a_caption = ""
806 ): void {
807 $this->filter_cmd = $a_val;
808 $this->filter_cmd_txt = $a_caption;
809 }
810
811 public function getFilterCommand(): string
812 {
813 return $this->filter_cmd;
814 }
815
816 public function setResetCommand(
817 string $a_val,
818 string $a_caption = ""
819 ): void {
820 $this->reset_cmd = $a_val;
821 $this->reset_cmd_txt = $a_caption;
822 }
823
824 public function getResetCommand(): string
825 {
826 return $this->reset_cmd;
827 }
828
829 public function setExternalSegmentation(bool $a_val): void
830 {
831 $this->ext_seg = $a_val;
832 }
833
834 public function getExternalSegmentation(): bool
835 {
836 return $this->ext_seg;
837 }
838
844 final public function setRowTemplate(string $a_template, string $a_template_dir = ""): void
845 {
846 $this->row_template = $a_template;
847 $this->row_template_dir = $a_template_dir;
848 }
849
850 public function setDefaultOrderField(string $a_defaultorderfield): void
851 {
852 $this->defaultorderfield = $a_defaultorderfield;
853 }
854
855 public function getDefaultOrderField(): string
856 {
857 return $this->defaultorderfield;
858 }
859
860
861 public function setDefaultOrderDirection(string $a_defaultorderdirection): void
862 {
863 $this->defaultorderdirection = $a_defaultorderdirection;
864 }
865
866 public function getDefaultOrderDirection(): string
867 {
868 return $this->defaultorderdirection;
869 }
870
871 public function setDefaultFilterVisiblity(bool $a_status): void
872 {
873 $this->default_filter_visibility = $a_status;
874 }
875
876 public function getDefaultFilterVisibility(): bool
877 {
878 return $this->default_filter_visibility;
879 }
880
881 public function clearCommandButtons(): void
882 {
883 $this->buttons = array();
884 }
885
886 public function addCommandButton(
887 string $a_cmd,
888 string $a_text,
889 string $a_onclick = '',
890 string $a_id = "",
891 string $a_class = ""
892 ): void {
893 $this->buttons[] = array("cmd" => $a_cmd, "text" => $a_text, 'onclick' => $a_onclick,
894 "id" => $a_id, "class" => $a_class);
895 }
896
897 public function addCommandButtonInstance(ilButtonBase $a_button): void
898 {
899 $this->buttons[] = $a_button;
900 }
901
911 string $a_sel_var,
912 array $a_options,
913 string $a_cmd,
914 string $a_text,
915 string $a_default_selection = ''
916 ): void {
917 $this->mi_sel_buttons[] = array("sel_var" => $a_sel_var, "options" => $a_options, "selected" => $a_default_selection, "cmd" => $a_cmd, "text" => $a_text);
918 $this->addHiddenInput("cmd_sv[" . $a_cmd . "]", $a_sel_var);
919 }
920
921 public function setCloseCommand(string $a_link): void
922 {
923 $this->close_command = $a_link;
924 }
925
926 public function addMultiCommand(string $a_cmd, string $a_text): void
927 {
928 $this->multi[] = array("cmd" => $a_cmd, "text" => $a_text);
929 }
930
931 public function addHiddenInput(string $a_name, string $a_value): void
932 {
933 $this->hidden_inputs[] = array("name" => $a_name, "value" => $a_value);
934 }
935
936 public function addHeaderCommand(
937 string $a_href,
938 string $a_text,
939 string $a_target = "",
940 string $a_img = ""
941 ): void {
942 $this->header_commands[] = array("href" => $a_href, "text" => $a_text,
943 "target" => $a_target, "img" => $a_img);
944 }
945
946 public function setTopCommands(bool $a_val): void
947 {
948 $this->top_commands = $a_val;
949 }
950
951 public function getTopCommands(): bool
952 {
953 return $this->top_commands;
954 }
955
956 final public function addColumn(
957 string $a_text,
958 string $a_sort_field = "",
959 string $a_width = "",
960 bool $a_is_checkbox_action_column = false,
961 string $a_class = "",
962 string $a_tooltip = "",
963 bool $a_tooltip_with_html = false
964 ): void {
965 $this->column[] = array(
966 "text" => $a_text,
967 "sort_field" => $a_sort_field,
968 "width" => $a_width,
969 "is_checkbox_action_column" => $a_is_checkbox_action_column,
970 "class" => $a_class,
971 "tooltip" => $a_tooltip,
972 "tooltip_html" => $a_tooltip_with_html
973 );
974 if ($a_sort_field != "") {
975 $this->sortable_fields[] = $a_sort_field;
976 }
977 $this->column_count = count($this->column);
978 }
979
980
981 final public function getNavParameter(): string
982 {
983 return $this->prefix . "_table_nav";
984 }
985
986 public function setOrderLink(string $key, string $order_dir): void
987 {
988 global $DIC;
989
990 $ilUser = $DIC->user();
991
992 $ilCtrl = $this->ctrl;
993
994 $hash = "";
995
996 $old = $this->requested_nav_par ?? '';
997
998 // set order link
999 $ilCtrl->setParameter(
1000 $this->parent_obj,
1001 $this->getNavParameter(),
1002 urlencode($key) . ":" . $order_dir . ":" . $this->offset
1003 );
1004 $this->tpl->setVariable(
1005 "TBL_ORDER_LINK",
1006 $ilCtrl->getLinkTarget($this->parent_obj, $this->parent_cmd) . $hash
1007 );
1008
1009 // set old value of nav variable
1010 $ilCtrl->setParameter(
1011 $this->parent_obj,
1012 $this->getNavParameter(),
1013 $old
1014 );
1015 }
1016
1017 public function fillHeader(): void
1018 {
1019 $lng = $this->lng;
1020
1021 $allcolumnswithwidth = true;
1022 foreach ($this->column as $idx => $column) {
1023 if (!strlen($column["width"])) {
1024 $allcolumnswithwidth = false;
1025 } elseif ($column["width"] == "1") {
1026 // IE does not like 1 but seems to work with 1%
1027 $this->column[$idx]["width"] = "1%";
1028 }
1029 }
1030 if ($allcolumnswithwidth) {
1031 foreach ($this->column as $column) {
1032 $this->tpl->setCurrentBlock("tbl_colgroup_column");
1033 $width = (is_numeric($column["width"]))
1034 ? $column["width"] . "px"
1035 : $column["width"];
1036 $this->tpl->setVariable("COLGROUP_COLUMN_WIDTH", " style=\"width:" . $width . "\"");
1037 $this->tpl->parseCurrentBlock();
1038 }
1039 }
1040 $ccnt = 0;
1041 foreach ($this->column as $column) {
1042 $ccnt++;
1043
1044 if ($column['is_checkbox_action_column'] && $this->select_all_on_top) {
1045 $this->tpl->setCurrentBlock('tbl_header_top_select_all');
1046 $this->tpl->setVariable("HEAD_SELECT_ALL_TXT_SELECT_ALL", $lng->txt("select_all"));
1047 $this->tpl->setVariable("HEAD_SELECT_ALL_CHECKBOX_NAME", $this->getSelectAllCheckbox());
1048 $this->tpl->setVariable("HEAD_SELECT_ALL_FORM_NAME", $this->getFormName());
1049 $this->tpl->setVariable("HEAD_CHECKBOXNAME", "chb_select_all_" . $this->unique_id . '_top');
1050 $this->tpl->parseCurrentBlock();
1051 continue;
1052 }
1053
1054 if ($column['is_checkbox_action_column'] && !$this->select_all_on_top) {
1055 $this->tpl->setCurrentBlock('tbl_header_top_select_column');
1056 if ($column["width"] != "") {
1057 $width = (is_numeric($column["width"]))
1058 ? $column["width"] . "px"
1059 : $column["width"];
1060 $this->tpl->setVariable("TBL_COLUMN_WIDTH", " style=\"width:" . $width . "\"");
1061 }
1062 $this->tpl->setVariable("TXT_SELECTION", $this->lng->txt("tbl_selection"));
1063 $this->tpl->parseCurrentBlock();
1064 continue;
1065 }
1066
1067 if (
1068 !$this->enabled["sort"] ||
1069 (($column["sort_field"] == "") &&
1070 !($column["is_checkbox_action_column"] && $this->select_all_on_top))
1071 ) {
1072 $this->tpl->setCurrentBlock("tbl_header_no_link");
1073 if ($column["width"] != "") {
1074 $width = (is_numeric($column["width"]))
1075 ? $column["width"] . "px"
1076 : $column["width"];
1077 $this->tpl->setVariable("TBL_COLUMN_WIDTH_NO_LINK", " style=\"width:" . $width . "\"");
1078 }
1079 if ($column["class"] != "") {
1080 $this->tpl->setVariable("TBL_COLUMN_CLASS_NO_LINK", " class=\"" . $column["class"] . "\"");
1081 }
1082 if (!$column["is_checkbox_action_column"]) {
1083 $this->tpl->setVariable(
1084 "TBL_HEADER_CELL_NO_LINK",
1085 $column["text"]
1086 );
1087 } else {
1088 $this->tpl->setVariable(
1089 "TBL_HEADER_CELL_NO_LINK",
1090 ilUtil::img(ilUtil::getImagePath("media/spacer.png"), $lng->txt("action"))
1091 );
1092 }
1093 $this->tpl->setVariable("HEAD_CELL_NL_ID", "thc_" . $this->getId() . "_" . $ccnt);
1094 if ($column["class"] != "") {
1095 $this->tpl->setVariable("TBL_HEADER_CLASS", " " . $column["class"]);
1096 }
1097 $this->tpl->parseCurrentBlock();
1098 $this->tpl->touchBlock("tbl_header_th");
1099 continue;
1100 }
1101 if (($column["sort_field"] == $this->order_field) && ($this->order_direction != "")) {
1102 $this->tpl->setCurrentBlock("tbl_order_image");
1103 if ($this->order_direction === "asc") {
1104 $this->tpl->setVariable("ORDER_CLASS", "glyphicon glyphicon-arrow-up");
1105 $this->tpl->setVariable("ORDER_TXT", $this->lng->txt("sorting_asc"));
1106 } else {
1107 $this->tpl->setVariable("ORDER_CLASS", "glyphicon glyphicon-arrow-down");
1108 $this->tpl->setVariable("ORDER_TXT", $this->lng->txt("sorting_desc"));
1109 }
1110 $this->tpl->setVariable("IMG_ORDER_ALT", $this->lng->txt("change_sort_direction"));
1111 $this->tpl->parseCurrentBlock();
1112 }
1113
1114 $this->tpl->setCurrentBlock("tbl_header_cell");
1115 $this->tpl->setVariable("TBL_HEADER_CELL", $column["text"]);
1116 $this->tpl->setVariable("HEAD_CELL_ID", "thc_" . $this->getId() . "_" . $ccnt);
1117
1118 // only set width if a value is given for that column
1119 if ($column["width"] != "") {
1120 $width = (is_numeric($column["width"]))
1121 ? $column["width"] . "px"
1122 : $column["width"];
1123 $this->tpl->setVariable("TBL_COLUMN_WIDTH", " style=\"width:" . $width . "\"");
1124 }
1125 if ($column["class"] != "") {
1126 $this->tpl->setVariable("TBL_COLUMN_CLASS", " class=\"" . $column["class"] . "\"");
1127 }
1128
1129 $lng_sort_column = $this->lng->txt("sort_by_this_column");
1130 $this->tpl->setVariable("TBL_ORDER_ALT", $lng_sort_column);
1131
1132 $order_dir = "asc";
1133
1134 if ($column["sort_field"] == $this->order_field) {
1135 $order_dir = $this->sort_order;
1136
1137 if ($order_dir === "asc") {
1138 $lng_change_sort = $this->lng->txt("sort_ascending_long");
1139 } else {
1140 $lng_change_sort = $this->lng->txt("sort_descending_long");
1141 }
1142 $this->tpl->setVariable("TBL_ORDER_ALT", $lng_change_sort);
1143 }
1144
1145 if ($column["class"] != "") {
1146 $this->tpl->setVariable("TBL_HEADER_CLASS", " " . $column["class"]);
1147 }
1148 $this->setOrderLink($column["sort_field"], $order_dir);
1149 $this->tpl->parseCurrentBlock();
1150 $this->tpl->touchBlock("tbl_header_th");
1151 }
1152
1153 $this->tpl->setCurrentBlock("tbl_header");
1154 $this->tpl->parseCurrentBlock();
1155 }
1156
1160 protected function prepareOutput(): void
1161 {
1162 }
1163
1164 public function determineOffsetAndOrder(bool $a_omit_offset = false): void
1165 {
1166 global $DIC;
1167
1168 $ilUser = null;
1169 if (isset($DIC["ilUser"])) {
1170 $ilUser = $DIC["ilUser"];
1171 }
1172
1173 if ($this->nav_determined) {
1174 return;
1175 }
1176
1177 if ($this->requested_nav_par1 != "") {
1178 if ($this->requested_nav_par1 != ($this->requested_nav_par ?? "")) {
1179 $this->nav_value = $this->requested_nav_par1;
1180 } elseif (
1181 $this->requested_nav_par2 != "" &&
1182 $this->requested_nav_par2 != $this->requested_nav_par
1183 ) {
1184 $this->nav_value = $this->requested_nav_par2;
1185 }
1186 } elseif ($this->requested_nav_par != "") {
1187 $this->nav_value = $this->requested_nav_par;
1188 }
1189
1190 if ($this->nav_value == "" && $this->getId() != "" && $ilUser->getId() != ANONYMOUS_USER_ID) {
1191 $order = $this->loadProperty("order");
1192 if (in_array($order, $this->sortable_fields)) {
1193 $direction = $this->loadProperty("direction");
1194 } else {
1195 $direction = $this->getDefaultOrderDirection();
1196 }
1197 // get order and direction from db
1198 $this->nav_value =
1199 $order . ":" .
1200 $direction . ":" .
1201 $this->loadProperty("offset");
1202 }
1203 $nav = explode(":", $this->nav_value);
1204
1205 // $nav[0] is order by
1206 $req_order_field = $nav[0] ?? "";
1207 $req_order_dir = $nav[1] ?? "";
1208 $req_offset = (int) ($nav[2] ?? 0);
1209 $this->setOrderField(($req_order_field != "") ? $req_order_field : $this->getDefaultOrderField());
1210 $this->setOrderDirection(($req_order_dir != "") ? $req_order_dir : $this->getDefaultOrderDirection());
1211
1212 if (!$a_omit_offset) {
1213 // #8904: offset must be discarded when no limit is given
1214 if (!$this->getExternalSegmentation() && $this->limit_determined && $this->limit == 9999) {
1215 $this->resetOffset(true);
1216 } elseif (!$this->getExternalSegmentation() && $req_offset >= $this->max_count) {
1217 $this->resetOffset(true);
1218 } else {
1219 $this->setOffset($req_offset);
1220 }
1221 }
1222
1223 if (!$a_omit_offset) {
1224 $this->nav_determined = true;
1225 }
1226 }
1227
1228 public function storeNavParameter(): void
1229 {
1230 if ($this->getOrderField() != "") {
1231 $this->storeProperty("order", $this->getOrderField());
1232 }
1233 if ($this->getOrderDirection() != "") {
1234 $this->storeProperty("direction", $this->getOrderDirection());
1235 }
1236 if ($this->getOffset() >= 0) {
1237 $this->storeProperty("offset", (string) $this->getOffset());
1238 }
1239 }
1240
1241
1245 public function getHTML(): string
1246 {
1247 global $DIC;
1248
1249 $ilUser = null;
1250 if (isset($DIC["ilUser"])) {
1251 $ilUser = $DIC["ilUser"];
1252 }
1253
1254 $lng = $this->lng;
1255 $ilCtrl = $this->ctrl;
1256
1257
1258 if ($this->getExportMode() > 0) {
1259 $this->exportData($this->getExportMode(), true);
1260 }
1261
1262 $this->prepareOutput();
1263
1264 if (is_object($ilCtrl) && is_object($this->getParentObject()) && $this->getId() == "") {
1265 $ilCtrl->saveParameter($this->getParentObject(), $this->getNavParameter());
1266 }
1267
1268 if (!$this->getPrintMode()) {
1269 // set form action
1270 if ($this->form_action != "" && $this->getOpenFormTag()) {
1271 $hash = "";
1272
1273 if ($this->form_multipart) {
1274 $this->tpl->touchBlock("form_multipart_bl");
1275 }
1276
1277 if ($this->getPreventDoubleSubmission()) {
1278 $this->tpl->touchBlock("pdfs");
1279 }
1280
1281 $this->tpl->setCurrentBlock("tbl_form_header");
1282 $this->tpl->setVariable("FORMACTION", $this->getFormAction() . $hash);
1283 $this->tpl->setVariable("FORMNAME", $this->getFormName());
1284 $this->tpl->parseCurrentBlock();
1285 }
1286
1287 if ($this->form_action != "" && $this->getCloseFormTag()) {
1288 $this->tpl->touchBlock("tbl_form_footer");
1289 }
1290 }
1291
1292 if (!$this->enabled['content']) {
1293 return $this->render();
1294 }
1295
1296 if (!$this->getExternalSegmentation()) {
1297 $this->setMaxCount(count($this->row_data));
1298 }
1299
1300 $this->determineOffsetAndOrder();
1301
1302 $this->setFooter("tblfooter", $this->lng->txt("previous"), $this->lng->txt("next"));
1303
1304 $data = $this->getData();
1305 if ($this->dataExists()) {
1306 // sort
1307 if (!$this->getExternalSorting() && $this->enabled["sort"]) {
1309 $data,
1310 $this->getOrderField(),
1311 $this->getOrderDirection(),
1312 $this->numericOrdering($this->getOrderField())
1313 );
1314 }
1315
1316 // slice
1317 if (!$this->getExternalSegmentation()) {
1318 $data = array_slice($data, $this->getOffset(), $this->getLimit());
1319 }
1320 }
1321
1322 // fill rows
1323 if ($this->dataExists()) {
1324 if ($this->getPrintMode()) {
1326 }
1327
1328 $this->tpl->addBlockFile(
1329 "TBL_CONTENT",
1330 "tbl_content",
1331 $this->row_template,
1332 $this->row_template_dir
1333 );
1334
1335 foreach ($data as $set) {
1336 $this->tpl->setCurrentBlock("tbl_content");
1337 $this->css_row = ($this->css_row !== "tblrow1")
1338 ? "tblrow1"
1339 : "tblrow2";
1340 $this->tpl->setVariable("CSS_ROW", $this->css_row);
1341
1342 $this->fillRow($set);
1343 $this->tpl->setCurrentBlock("tbl_content");
1344 $this->tpl->parseCurrentBlock();
1345 }
1346 } else {
1347 // add standard no items text (please tell me, if it messes something up, alex, 29.8.2008)
1348 $no_items_text = (trim($this->getNoEntriesText()) != '')
1349 ? $this->getNoEntriesText()
1350 : $lng->txt("no_items");
1351
1352 $this->css_row = ($this->css_row !== "tblrow1")
1353 ? "tblrow1"
1354 : "tblrow2";
1355
1356 $this->tpl->setCurrentBlock("tbl_no_entries");
1357 $this->tpl->setVariable('TBL_NO_ENTRY_CSS_ROW', $this->css_row);
1358 $this->tpl->setVariable('TBL_NO_ENTRY_COLUMN_COUNT', $this->column_count);
1359 $this->tpl->setVariable('TBL_NO_ENTRY_TEXT', trim($no_items_text));
1360 $this->tpl->parseCurrentBlock();
1361 }
1362
1363
1364 if (!$this->getPrintMode()) {
1365 $this->fillFooter();
1366
1367 $this->fillHiddenRow();
1368
1369 $this->fillActionRow();
1370
1371 $this->storeNavParameter();
1372 }
1373
1374 return $this->render();
1375 }
1376
1380 public function numericOrdering(string $a_field): bool
1381 {
1382 return false;
1383 }
1384
1385 public function render(): string
1386 {
1387 $lng = $this->lng;
1388
1389 $this->tpl->setVariable("CSS_TABLE", $this->getStyle("table"));
1390 if ($this->getId() != "") {
1391 $this->tpl->setVariable("ID", 'id="' . $this->getId() . '"');
1392 }
1393
1394 // description
1395 if ($this->getDescription() != "") {
1396 $this->tpl->setCurrentBlock("tbl_header_description");
1397 $this->tpl->setVariable("TBL_DESCRIPTION", $this->getDescription());
1398 $this->tpl->parseCurrentBlock();
1399 }
1400
1401 if (!$this->getPrintMode()) {
1402 $this->renderFilter();
1403 }
1404
1405 if ($this->getDisplayAsBlock()) {
1406 $this->tpl->touchBlock("outer_start_1");
1407 $this->tpl->touchBlock("outer_end_1");
1408 } else {
1409 $this->tpl->touchBlock("outer_start_2");
1410 $this->tpl->touchBlock("outer_end_2");
1411 }
1412
1413 // table title and icon
1414 if ($this->enabled["title"] && ($this->title != ""
1415 || $this->icon != "" || count($this->header_commands) > 0 ||
1416 $this->headerHTML != "" || $this->close_command != "")) {
1417 if ($this->enabled["icon"]) {
1418 $this->tpl->setCurrentBlock("tbl_header_title_icon");
1419 $this->tpl->setVariable("TBL_TITLE_IMG", ilUtil::getImagePath($this->icon));
1420 $this->tpl->setVariable("TBL_TITLE_IMG_ALT", $this->icon_alt);
1421 $this->tpl->parseCurrentBlock();
1422 }
1423
1424 if (!$this->getPrintMode()) {
1425 foreach ($this->header_commands as $command) {
1426 if ($command["img"] != "") {
1427 $this->tpl->setCurrentBlock("tbl_header_img_link");
1428 if ($command["target"] != "") {
1429 $this->tpl->setVariable(
1430 "TARGET_IMG_LINK",
1431 'target="' . $command["target"] . '"'
1432 );
1433 }
1434 $this->tpl->setVariable("ALT_IMG_LINK", $command["text"]);
1435 $this->tpl->setVariable("HREF_IMG_LINK", $command["href"]);
1436 $this->tpl->setVariable(
1437 "SRC_IMG_LINK",
1438 $command["img"]
1439 );
1440 } else {
1441 $this->tpl->setCurrentBlock("head_cmd");
1442 $this->tpl->setVariable("TXT_HEAD_CMD", $command["text"]);
1443 $this->tpl->setVariable("HREF_HEAD_CMD", $command["href"]);
1444 }
1445 $this->tpl->parseCurrentBlock();
1446 }
1447 }
1448
1449 if (isset($this->headerHTML)) {
1450 $this->tpl->setCurrentBlock("tbl_header_html");
1451 $this->tpl->setVariable("HEADER_HTML", $this->headerHTML);
1452 $this->tpl->parseCurrentBlock();
1453 }
1454
1455 // close command
1456 if ($this->close_command != "") {
1457 $this->tpl->setCurrentBlock("tbl_header_img_link");
1458 $this->tpl->setVariable("ALT_IMG_LINK", $lng->txt("close"));
1459 $this->tpl->setVariable("HREF_IMG_LINK", $this->close_command);
1460 $this->tpl->parseCurrentBlock();
1461 }
1462
1463 $this->tpl->setCurrentBlock("tbl_header_title");
1464 $this->tpl->setVariable("TBL_TITLE", $this->title);
1465 if ($this->getDisplayAsBlock()) {
1466 $this->tpl->setVariable("BLK_CLASS", "Block");
1467 }
1468 $this->tpl->parseCurrentBlock();
1469 }
1470
1471 // table header
1472 if ($this->enabled["header"]) {
1473 $this->fillHeader();
1474 }
1475
1476 $this->tpl->touchBlock("tbl_table_end");
1477
1478 return $this->tpl->get();
1479 }
1480
1484 private function renderFilter(): void
1485 {
1486 global $DIC;
1487
1488 $lng = $this->lng;
1489 $main_tpl = $DIC["tpl"];
1490
1491 $filter = $this->getFilterItems();
1492 $opt_filter = $this->getFilterItems(true);
1493
1494 $main_tpl->addJavascript("assets/js/ServiceTable.js");
1495
1496 if (count($filter) == 0 && count($opt_filter) == 0) {
1497 return;
1498 }
1499
1500 $ccnt = 0;
1501
1502 // render standard filter
1503 if (count($filter) > 0) {
1504 foreach ($filter as $item) {
1505 if ($ccnt >= $this->getFilterCols()) {
1506 $this->tpl->setCurrentBlock("filter_row");
1507 $this->tpl->parseCurrentBlock();
1508 $ccnt = 0;
1509 }
1510 $this->tpl->setCurrentBlock("filter_item");
1511 $this->tpl->setVariable(
1512 "OPTION_NAME",
1513 $item->getTitle()
1514 );
1515 $this->tpl->setVariable(
1516 "F_INPUT_ID",
1517 $item->getTableFilterLabelFor()
1518 );
1519 $this->tpl->setVariable(
1520 "INPUT_HTML",
1521 $item->getTableFilterHTML()
1522 );
1523 $this->tpl->parseCurrentBlock();
1524 $ccnt++;
1525 }
1526 }
1527
1528 // render optional filter
1529 if (count($opt_filter) > 0) {
1530 $this->determineSelectedFilters();
1531
1532 foreach ($opt_filter as $item) {
1533 if ($this->isFilterSelected($item->getPostVar())) {
1534 if ($ccnt >= $this->getFilterCols()) {
1535 $this->tpl->setCurrentBlock("filter_row");
1536 $this->tpl->parseCurrentBlock();
1537 $ccnt = 0;
1538 }
1539 $this->tpl->setCurrentBlock("filter_item");
1540 $this->tpl->setVariable(
1541 "OPTION_NAME",
1542 $item->getTitle()
1543 );
1544 $this->tpl->setVariable(
1545 "F_INPUT_ID",
1546 $item->getFieldId()
1547 );
1548 $this->tpl->setVariable(
1549 "INPUT_HTML",
1550 $item->getTableFilterHTML()
1551 );
1552 $this->tpl->parseCurrentBlock();
1553 $ccnt++;
1554 }
1555 }
1556
1557 // filter selection
1558 $items = array();
1559 foreach ($opt_filter as $item) {
1560 $k = $item->getPostVar();
1561 $items[$k] = array("txt" => $item->getTitle(),
1562 "selected" => $this->isFilterSelected($k));
1563 }
1564
1565 $cb_over = new ilCheckboxListOverlayGUI("tbl_filters_" . $this->getId());
1566 $cb_over->setLinkTitle($lng->txt("optional_filters"));
1567 $cb_over->setItems($items);
1568
1569 $cb_over->setFormCmd($this->getParentCmd());
1570 $cb_over->setFieldVar("tblff" . $this->getId());
1571 $cb_over->setHiddenVar("tblfsf" . $this->getId());
1572
1573 $cb_over->setSelectionHeaderClass("ilTableMenuItem");
1574 $this->tpl->setCurrentBlock("filter_select");
1575
1576 // apply should be the first submit because of enter/return, inserting hidden submit
1577 $this->tpl->setVariable("HIDDEN_CMD_APPLY", $this->filter_cmd);
1578
1579 $this->tpl->setVariable("FILTER_SELECTOR", $cb_over->getHTML(false));
1580 $this->tpl->parseCurrentBlock();
1581 }
1582
1583 // if any filter
1584 if ($ccnt > 0 || count($opt_filter) > 0) {
1585 $this->tpl->setVariable("TXT_FILTER", $lng->txt("filter"));
1586
1587 if ($ccnt > 0) {
1588 if ($ccnt < $this->getFilterCols()) {
1589 for ($i = $ccnt; $i <= $this->getFilterCols(); $i++) {
1590 $this->tpl->touchBlock("filter_empty_cell");
1591 }
1592 }
1593 $this->tpl->setCurrentBlock("filter_row");
1594 $this->tpl->parseCurrentBlock();
1595
1596 $this->tpl->setCurrentBlock("filter_buttons");
1597 $this->tpl->setVariable("CMD_APPLY", $this->filter_cmd);
1598 $this->tpl->setVariable("TXT_APPLY", $this->filter_cmd_txt
1599 ?: $lng->txt("apply_filter"));
1600 $this->tpl->setVariable("CMD_RESET", $this->reset_cmd);
1601 $this->tpl->setVariable("TXT_RESET", $this->reset_cmd_txt
1602 ?: $lng->txt("reset_filter"));
1603 } elseif (count($opt_filter) > 0) {
1604 $this->tpl->setCurrentBlock("optional_filter_hint");
1605 $this->tpl->setVariable('TXT_OPT_HINT', $lng->txt('optional_filter_hint'));
1606 $this->tpl->parseCurrentBlock();
1607 }
1608
1609 $this->tpl->setCurrentBlock("filter_section");
1610 $this->tpl->setVariable("FIL_ID", $this->getId());
1611 $this->tpl->parseCurrentBlock();
1612
1613 // (keep) filter hidden?
1614 if (!$this->isFilterVisible() && !$this->getDisableFilterHiding()) {
1615 $id = $this->getId();
1616 $this->main_tpl->addOnLoadCode("
1617 ilTableHideFilter['atfil_$id'] = true;
1618 ilTableHideFilter['tfil_$id'] = true;
1619 ilTableHideFilter['dtfil_$id'] = true;
1620 ");
1621 }
1622 /*
1623 * BT 35757: filter has to be initialized after it has a chance to get hidden,
1624 * moving this here from ServiceTable.js to avoid timing weirdness with onLoadCode.
1625 */
1626 $this->main_tpl->addOnLoadCode("ilInitTableFilters()");
1627 }
1628 }
1629
1633 protected function isFilterVisible(): bool
1634 {
1635 $prop = $this->loadProperty('filter');
1636 if ($prop === '0' || $prop === '1') {
1637 return (bool) $prop;
1638 }
1639 return $this->getDefaultFilterVisibility();
1640 }
1641
1645 protected function isAdvMDFilter(
1646 ilAdvancedMDRecordGUI $a_gui,
1647 ilTableFilterItem $a_element
1648 ): bool {
1649 foreach ($a_gui->getFilterElements(false) as $item) {
1650 if ($item === $a_element) {
1651 return true;
1652 }
1653 }
1654 return false;
1655 }
1656
1657 public function writeFilterToSession(): void
1658 {
1659 $advmd_record_gui = null;
1660 if (method_exists($this, "getAdvMDRecordGUI")) {
1661 $advmd_record_gui = $this->getAdvMDRecordGUI();
1662 }
1663
1664 foreach ($this->getFilterItems() as $item) {
1665 if ($advmd_record_gui &&
1666 $this->isAdvMDFilter($advmd_record_gui, $item)) {
1667 continue;
1668 }
1669
1670 if ($item->checkInput()) {
1671 $item->setValueByArray($this->raw_post_data);
1672 $item->writeToSession();
1673 }
1674 }
1675 foreach ($this->getFilterItems(true) as $item) {
1676 if ($advmd_record_gui &&
1677 $this->isAdvMDFilter($advmd_record_gui, $item)) {
1678 continue;
1679 }
1680
1681 if ($item->checkInput()) {
1682 $item->setValueByArray($this->raw_post_data);
1683 $item->writeToSession();
1684 }
1685 }
1686
1687 if ($advmd_record_gui) {
1688 $advmd_record_gui->importFilter();
1689 }
1690 }
1691
1692 public function resetFilter(): void
1693 {
1694 $filter = $this->getFilterItems();
1695 $opt_filter = $this->getFilterItems(true);
1696
1697 foreach ($filter as $item) {
1698 if ($item->checkInput()) {
1699 // see #26490
1700 $item->setValueByArray([]);
1701 $item->clearFromSession();
1702 }
1703 }
1704 foreach ($opt_filter as $item) {
1705 if ($item->checkInput()) {
1706 // see #26490
1707 $item->setValueByArray([]);
1708 $item->clearFromSession();
1709 }
1710 }
1711 }
1712
1718 protected function fillRow(array $a_set): void
1719 {
1720 foreach ($a_set as $key => $value) {
1721 $this->tpl->setVariable("VAL_" . strtoupper($key), $value);
1722 }
1723 }
1724
1725 public function fillFooter(): void
1726 {
1727 global $DIC;
1728
1729 $ilUser = null;
1730 if (isset($DIC["ilUser"])) {
1731 $ilUser = $DIC["ilUser"];
1732 }
1733
1734 $ui_factory = $this->ui->factory();
1735 $ui_renderer = $this->ui->renderer();
1736
1737 $lng = $this->lng;
1738 $ilCtrl = $this->ctrl;
1739
1740 $footer = false;
1741 $numinfo = '';
1742 $linkbar = '';
1743 $column_selector = '';
1744
1745 // select all checkbox
1746 if ((strlen($this->getFormName())) && (strlen($this->getSelectAllCheckbox())) && $this->dataExists()) {
1747 $this->tpl->setCurrentBlock("select_all_checkbox");
1748 $this->tpl->setVariable("SELECT_ALL_TXT_SELECT_ALL", $lng->txt("select_all"));
1749 $this->tpl->setVariable("SELECT_ALL_CHECKBOX_NAME", $this->getSelectAllCheckbox());
1750 $this->tpl->setVariable("SELECT_ALL_FORM_NAME", $this->getFormName());
1751 $this->tpl->setVariable("CHECKBOXNAME", "chb_select_all_" . $this->unique_id);
1752 $this->tpl->parseCurrentBlock();
1753 }
1754
1755 // table footer numinfo
1756 if ($this->enabled["numinfo"] && $this->enabled["footer"]) {
1757 $start = $this->offset + 1; // compute num info
1758 if (!$this->dataExists()) {
1759 $start = 0;
1760 }
1761 $end = $this->offset + $this->limit;
1762
1763 if ($end > $this->max_count or $this->limit == 0) {
1764 $end = $this->max_count;
1765 }
1766
1767 if ($this->max_count > 0) {
1768 if ($this->lang_support) {
1769 $numinfo = "(" . $start . " - " . $end . " " . strtolower($this->lng->txt("of")) . " " . $this->max_count . ")";
1770 } else {
1771 $numinfo = "(" . $start . " - " . $end . " of " . $this->max_count . ")";
1772 }
1773 }
1774 if ($this->max_count > 0) {
1775 if ($this->getEnableNumInfo()) {
1776 $this->tpl->setCurrentBlock("tbl_footer_numinfo");
1777 $this->tpl->setVariable("NUMINFO", $numinfo);
1778 $this->tpl->parseCurrentBlock();
1779 }
1780 }
1781 $footer = true;
1782 }
1783
1784 // table footer linkbar
1785 if ($this->enabled["linkbar"] && $this->enabled["footer"] && $this->limit != 0
1786 && $this->max_count > 0) {
1787 $linkbar = $this->getLinkbar("1");
1788 $this->tpl->setCurrentBlock("tbl_footer_linkbar");
1789 $this->tpl->setVariable("LINKBAR", $linkbar);
1790 $this->tpl->parseCurrentBlock();
1791 $linkbar = true;
1792 $footer = true;
1793 }
1794
1795 // column selector
1796 if (is_array($this->getSelectableColumns()) && count($this->getSelectableColumns()) > 0) {
1797 $items = array();
1798 foreach ($this->getSelectableColumns() as $k => $c) {
1799 $items[$k] = array("txt" => $c["txt"],
1800 "selected" => $this->isColumnSelected($k));
1801 }
1802 $cb_over = new ilCheckboxListOverlayGUI("tbl_" . $this->getId());
1803 $cb_over->setLinkTitle($lng->txt("columns"));
1804 $cb_over->setItems($items);
1805 //$cb_over->setUrl("./ilias.php?baseClass=ilTablePropertiesStorage&table_id=".
1806 // $this->getId()."&cmd=saveSelectedFields&user_id=".$ilUser->getId());
1807 $cb_over->setFormCmd($this->getParentCmd());
1808 $cb_over->setFieldVar("tblfs" . $this->getId());
1809 $cb_over->setHiddenVar("tblfsh" . $this->getId());
1810 $cb_over->setSelectionHeaderClass("ilTableMenuItem");
1811 $column_selector = $cb_over->getHTML();
1812 $footer = true;
1813 }
1814
1815 if ($footer) {
1816 $this->tpl->setCurrentBlock("tbl_footer");
1817 $this->tpl->setVariable("COLUMN_COUNT", $this->getColumnCount());
1818 if ($this->getDisplayAsBlock()) {
1819 $this->tpl->setVariable("BLK_CLASS", "Block");
1820 }
1821 $this->tpl->parseCurrentBlock();
1822
1823 // top navigation, if number info or linkbar given
1824 if ($numinfo != "" || $linkbar != "" || $column_selector != "" ||
1825 count($this->filters) > 0 || count($this->optional_filters) > 0) {
1826 if (is_object($ilUser) && (count($this->filters) || count($this->optional_filters))) {
1827 $this->tpl->setCurrentBlock("filter_activation");
1828 $this->tpl->setVariable("TXT_ACTIVATE_FILTER", $lng->txt("show_filter"));
1829 $this->tpl->setVariable("FILA_ID", $this->getId());
1830 if ($this->getId() != "") {
1831 $this->tpl->setVariable("SAVE_URLA", "./ilias.php?baseClass=ilTablePropertiesStorageGUI&table_id=" .
1832 $this->getId() . "&cmd=showFilter&user_id=" . $ilUser->getId());
1833 }
1834 $this->tpl->parseCurrentBlock();
1835
1836
1837 if (!$this->getDisableFilterHiding()) {
1838 $this->tpl->setCurrentBlock("filter_deactivation");
1839 $this->tpl->setVariable("TXT_HIDE", $lng->txt("hide_filter"));
1840 if ($this->getId() != "") {
1841 $this->tpl->setVariable("SAVE_URL", "./ilias.php?baseClass=ilTablePropertiesStorageGUI&table_id=" .
1842 $this->getId() . "&cmd=hideFilter&user_id=" . $ilUser->getId());
1843 $this->tpl->setVariable("FILD_ID", $this->getId());
1844 }
1845 $this->tpl->parseCurrentBlock();
1846 }
1847 }
1848
1849 if ($numinfo != "" && $this->getEnableNumInfo()) {
1850 $this->tpl->setCurrentBlock("top_numinfo");
1851 $this->tpl->setVariable("NUMINFO", $numinfo);
1852 $this->tpl->parseCurrentBlock();
1853 }
1854 if ($linkbar != "" && !$this->getDisplayAsBlock()) {
1855 $linkbar = $this->getLinkbar("2");
1856 $this->tpl->setCurrentBlock("top_linkbar");
1857 $this->tpl->setVariable("LINKBAR", $linkbar);
1858 $this->tpl->parseCurrentBlock();
1859 }
1860
1861 // column selector
1862 $this->tpl->setVariable("COLUMN_SELECTOR", $column_selector);
1863
1864 // row selector
1865 if ($this->getShowRowsSelector() &&
1866 is_object($ilUser) &&
1867 $this->getId() &&
1868 !$this->rows_selector_off) { // JF, 2014-10-27
1869 $actions = [];
1870
1871 $options = array(5 => 5, 10 => 10, 15 => 15, 20 => 20,
1872 30 => 30, 40 => 40, 50 => 50,
1873 100 => 100, 200 => 200, 400 => 400, 800 => 800);
1874 foreach ($options as $k => $v) {
1875 $ilCtrl->setParameter($this->parent_obj, $this->prefix . "_trows", $k);
1876 $actions[] = $ui_factory->link()->standard(
1877 $v,
1878 $ilCtrl->getLinkTarget($this->parent_obj, $this->parent_cmd)
1879 );
1880 $ilCtrl->setParameter($this->parent_obj, $this->prefix . "_trows", "");
1881 }
1882 $dd = $ui_factory->dropdown()->standard($actions)->withLabel(
1883 $this->getRowSelectorLabel() ?: $lng->txt("rows")
1884 );
1885 $this->tpl->setVariable("ROW_SELECTOR", $ui_renderer->render($dd));
1886 }
1887
1888 // export
1889 if (count($this->export_formats) > 0 && $this->dataExists()) {
1890 $actions = [];
1891 foreach ($this->export_formats as $format => $caption_lng_id) {
1892 $ilCtrl->setParameter($this->parent_obj, $this->prefix . "_xpt", $format);
1893 $url = $ilCtrl->getLinkTarget($this->parent_obj, $this->parent_cmd);
1894 $ilCtrl->setParameter($this->parent_obj, $this->prefix . "_xpt", "");
1895 $actions[] = $ui_factory->link()->standard(
1896 $lng->txt($caption_lng_id),
1897 $url
1898 );
1899 }
1900 $dd = $ui_factory->dropdown()->standard($actions)->withLabel($lng->txt("export"));
1901 $this->tpl->setVariable("EXPORT_SELECTOR", "&nbsp;" . $ui_renderer->render($dd));
1902 }
1903
1904 $this->tpl->setCurrentBlock("top_navigation");
1905 $this->tpl->setVariable("COLUMN_COUNT", $this->getColumnCount());
1906 if ($this->getDisplayAsBlock()) {
1907 $this->tpl->setVariable("BLK_CLASS", "Block");
1908 }
1909 $this->tpl->parseCurrentBlock();
1910 }
1911 }
1912 }
1913
1914 public function getLinkbar(string $a_num): ?string
1915 {
1916 global $DIC;
1917
1918 $ilUser = $DIC->user();
1919
1920 $ilCtrl = $this->ctrl;
1921 $lng = $this->lng;
1922
1923 $hash = "";
1924
1925 $link = $ilCtrl->getLinkTargetByClass(get_class($this->parent_obj), $this->parent_cmd) .
1926 "&" . $this->getNavParameter() . "=" .
1927 $this->getOrderField() . ":" . $this->getOrderDirection() . ":";
1928
1929 $LinkBar = "";
1930 $layout_prev = $lng->txt("previous");
1931 $layout_next = $lng->txt("next");
1932
1933 // if more entries then entries per page -> show link bar
1934 if ($this->max_count > $this->getLimit() || $this->custom_prev_next) {
1935 $sep = "<span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>";
1936
1937 // calculate number of pages
1938 $pages = intval($this->max_count / $this->getLimit());
1939
1940 // add a page if a rest remains
1941 if (($this->max_count % $this->getLimit())) {
1942 $pages++;
1943 }
1944
1945 // links to other pages
1946 $offset_arr = array();
1947 for ($i = 1 ;$i <= $pages ; $i++) {
1948 $newoffset = $this->getLimit() * ($i - 1);
1949
1950 $nav_value = $this->getOrderField() . ":" . $this->getOrderDirection() . ":" . $newoffset;
1951 $offset_arr[$nav_value] = $i;
1952 }
1953
1954 $sep = "<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>";
1955
1956 // previous link
1957 if ($this->custom_prev_next && $this->custom_prev != "") {
1958 $LinkBar .= "<a href=\"" . $this->custom_prev . $hash . "\">" . $layout_prev . "</a>";
1959 } elseif ($this->getOffset() >= 1 && !$this->custom_prev_next) {
1960 $prevoffset = $this->getOffset() - $this->getLimit();
1961 $LinkBar .= "<a href=\"" . $link . $prevoffset . $hash . "\">" . $layout_prev . "</a>";
1962 } else {
1963 $LinkBar .= '<span class="ilTableFootLight">' . $layout_prev . "</span>";
1964 }
1965
1966 // current value
1967 if ($a_num == "1") {
1968 $LinkBar .= '<input type="hidden" name="' . $this->getNavParameter() .
1969 '" value="' . $this->getOrderField() . ":" . $this->getOrderDirection() . ":" . $this->getOffset() . '" />';
1970 }
1971
1972 $sep = "<span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>";
1973
1974 // show next link (if not last page)
1975 $LinkBar .= $sep;
1976 if ($this->custom_prev_next && $this->custom_next != "") {
1977 $LinkBar .= "<a href=\"" . $this->custom_next . $hash . "\">" . $layout_next . "</a>";
1978 } elseif (!(($this->getOffset() / $this->getLimit()) == ($pages - 1)) && ($pages != 1) &&
1979 !$this->custom_prev_next) {
1980 $newoffset = $this->getOffset() + $this->getLimit();
1981 $LinkBar .= "<a href=\"" . $link . $newoffset . $hash . "\">" . $layout_next . "</a>";
1982 } else {
1983 $LinkBar .= '<span class="ilTableFootLight">' . $layout_next . "</span>";
1984 }
1985
1986 $sep = "<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>";
1987
1988 if (count($offset_arr) && !$this->getDisplayAsBlock() && !$this->custom_prev_next) {
1989 $LinkBar .= $sep;
1990
1991 $LinkBar .=
1992 '<label for="tab_page_sel_' . $a_num . '">' . $lng->txt("page") . '</label> ' .
1994 $this->nav_value,
1995 $this->getNavParameter() . $a_num,
1996 $offset_arr,
1997 false,
1998 true,
1999 0,
2000 "small",
2001 array("id" => "tab_page_sel_" . $a_num,
2002 "onchange" => "ilTablePageSelection(this, 'cmd[" . $this->parent_cmd . "]')")
2003 );
2004 }
2005
2006 return $LinkBar;
2007 } else {
2008 return null;
2009 }
2010 }
2011
2012 public function fillHiddenRow(): void
2013 {
2014 $hidden_row = false;
2015 if (count($this->hidden_inputs)) {
2016 foreach ($this->hidden_inputs as $hidden_input) {
2017 $this->tpl->setCurrentBlock("tbl_hidden_field");
2018 $this->tpl->setVariable("FIELD_NAME", $hidden_input["name"]);
2019 $this->tpl->setVariable("FIELD_VALUE", $hidden_input["value"]);
2020 $this->tpl->parseCurrentBlock();
2021 }
2022
2023 $this->tpl->setCurrentBlock("tbl_hidden_row");
2024 $this->tpl->parseCurrentBlock();
2025 }
2026 }
2027
2028 public function fillActionRow(): void
2029 {
2030 $lng = $this->lng;
2031
2032 // action row
2033 $action_row = false;
2034 $arrow = false;
2035 $txt = "";
2036 $cmd = "";
2037
2038 // add selection buttons
2039 if (count($this->sel_buttons) > 0) {
2040 foreach ($this->sel_buttons as $button) {
2041 $this->tpl->setCurrentBlock("sel_button");
2042 $this->tpl->setVariable(
2043 "SBUTTON_SELECT",
2045 $button["selected"],
2046 $button["sel_var"],
2047 $button["options"],
2048 false,
2049 true
2050 )
2051 );
2052 $this->tpl->setVariable("SBTN_NAME", $button["cmd"]);
2053 $this->tpl->setVariable("SBTN_VALUE", $button["text"]);
2054 $this->tpl->parseCurrentBlock();
2055
2056 if ($this->getTopCommands()) {
2057 $this->tpl->setCurrentBlock("sel_top_button");
2058 $this->tpl->setVariable(
2059 "SBUTTON_SELECT",
2061 $button["selected"],
2062 $button["sel_var"],
2063 $button["options"],
2064 false,
2065 true
2066 )
2067 );
2068 $this->tpl->setVariable("SBTN_NAME", $button["cmd"]);
2069 $this->tpl->setVariable("SBTN_VALUE", $button["text"]);
2070 $this->tpl->parseCurrentBlock();
2071 }
2072 }
2073 $buttons = true;
2074 $action_row = true;
2075 }
2076 $this->sel_buttons[] = array("options" => [], "cmd" => '', "text" => '');
2077
2078 // add buttons
2079 if (count($this->buttons) > 0) {
2080 foreach ($this->buttons as $button) {
2081 if (!is_array($button)) {
2082 if ($button instanceof ilButtonBase) {
2083 $this->tpl->setVariable('BUTTON_OBJ', $button->render());
2084
2085 // this will remove id - should be unique
2086 $button = clone $button;
2087
2088 $this->tpl->setVariable('BUTTON_TOP_OBJ', $button->render());
2089 }
2090 continue;
2091 }
2092
2093 if (strlen($button['onclick'])) {
2094 $this->tpl->setCurrentBlock('cmdonclick');
2095 $this->tpl->setVariable('CMD_ONCLICK', $button['onclick']);
2096 $this->tpl->parseCurrentBlock();
2097 }
2098 $this->tpl->setCurrentBlock("plain_button");
2099 if ($button["id"] != "") {
2100 $this->tpl->setVariable("PBID", ' id="' . $button["id"] . '" ');
2101 }
2102 if ($button["class"] != "") {
2103 $this->tpl->setVariable("PBBT_CLASS", ' ' . $button["class"]);
2104 }
2105 $this->tpl->setVariable("PBTN_NAME", $button["cmd"]);
2106 $this->tpl->setVariable("PBTN_VALUE", $button["text"]);
2107 $this->tpl->parseCurrentBlock();
2108
2109 if ($this->getTopCommands()) {
2110 if (strlen($button['onclick'])) {
2111 $this->tpl->setCurrentBlock('top_cmdonclick');
2112 $this->tpl->setVariable('CMD_ONCLICK', $button['onclick']);
2113 $this->tpl->parseCurrentBlock();
2114 }
2115 $this->tpl->setCurrentBlock("plain_top_button");
2116 $this->tpl->setVariable("PBTN_NAME", $button["cmd"]);
2117 $this->tpl->setVariable("PBTN_VALUE", $button["text"]);
2118 if ($button["class"] != "") {
2119 $this->tpl->setVariable("PBBT_CLASS", ' ' . $button["class"]);
2120 }
2121 $this->tpl->parseCurrentBlock();
2122 }
2123 }
2124
2125 $buttons = true;
2126 $action_row = true;
2127 }
2128
2129 // multi selection
2130 if (count($this->mi_sel_buttons)) {
2131 foreach ($this->mi_sel_buttons as $button) {
2132 $this->tpl->setCurrentBlock("mi_sel_button");
2133 $this->tpl->setVariable(
2134 "MI_BUTTON_SELECT",
2136 $button["selected"],
2137 $button["sel_var"],
2138 $button["options"],
2139 false,
2140 true
2141 )
2142 );
2143 $this->tpl->setVariable("MI_BTN_NAME", $button["cmd"]);
2144 $this->tpl->setVariable("MI_BTN_VALUE", $button["text"]);
2145 $this->tpl->parseCurrentBlock();
2146
2147 if ($this->getTopCommands()) {
2148 $this->tpl->setCurrentBlock("mi_top_sel_button");
2149 $this->tpl->setVariable(
2150 "MI_BUTTON_SELECT",
2152 $button["selected"],
2153 $button["sel_var"] . "_2",
2154 $button["options"],
2155 false,
2156 true
2157 )
2158 );
2159 $this->tpl->setVariable("MI_BTN_NAME", $button["cmd"]);
2160 $this->tpl->setVariable("MI_BTN_VALUE", $button["text"]);
2161 $this->tpl->parseCurrentBlock();
2162 }
2163 }
2164 $arrow = true;
2165 $action_row = true;
2166 }
2167
2168
2169 if (count($this->multi) > 1 && $this->dataExists()) {
2170 if ($this->enable_command_for_all && $this->max_count <= self::getAllCommandLimit()) {
2171 $this->tpl->setCurrentBlock("tbl_cmd_select_all");
2172 $this->tpl->setVariable("TXT_SELECT_CMD_ALL", $lng->txt("all_objects"));
2173 $this->tpl->parseCurrentBlock();
2174 }
2175
2176 $this->tpl->setCurrentBlock("tbl_cmd_select");
2177 $sel = array();
2178 foreach ($this->multi as $mc) {
2179 $sel[$mc["cmd"]] = $mc["text"];
2180 }
2181 $this->tpl->setVariable(
2182 "SELECT_CMDS",
2183 ilLegacyFormElementsUtil::formSelect("", "selected_cmd", $sel, false, true)
2184 );
2185 $this->tpl->setVariable("TXT_EXECUTE", $lng->txt("execute"));
2186 $this->tpl->parseCurrentBlock();
2187 $arrow = true;
2188 $action_row = true;
2189
2190 if ($this->getTopCommands()) {
2191 if ($this->enable_command_for_all && $this->max_count <= self::getAllCommandLimit()) {
2192 $this->tpl->setCurrentBlock("tbl_top_cmd_select_all");
2193 $this->tpl->setVariable("TXT_SELECT_CMD_ALL", $lng->txt("all_objects"));
2194 $this->tpl->parseCurrentBlock();
2195 }
2196
2197 $this->tpl->setCurrentBlock("tbl_top_cmd_select");
2198 $sel = array();
2199 foreach ($this->multi as $mc) {
2200 $sel[$mc["cmd"]] = $mc["text"];
2201 }
2202 $this->tpl->setVariable(
2203 "SELECT_CMDS",
2204 ilLegacyFormElementsUtil::formSelect("", "selected_cmd2", $sel, false, true)
2205 );
2206 $this->tpl->setVariable("TXT_EXECUTE", $lng->txt("execute"));
2207 $this->tpl->parseCurrentBlock();
2208 }
2209 } elseif (count($this->multi) == 1 && $this->dataExists()) {
2210 $this->tpl->setCurrentBlock("tbl_single_cmd");
2211 foreach ($this->multi as $mc) {
2212 $cmd = $mc['cmd'];
2213 $txt = $mc['text'];
2214 }
2215 $this->tpl->setVariable("TXT_SINGLE_CMD", $txt);
2216 $this->tpl->setVariable("SINGLE_CMD", $cmd);
2217 $this->tpl->parseCurrentBlock();
2218 $arrow = true;
2219 $action_row = true;
2220
2221 if ($this->getTopCommands()) {
2222 $this->tpl->setCurrentBlock("tbl_top_single_cmd");
2223 foreach ($this->multi as $mc) {
2224 $cmd = $mc['cmd'];
2225 $txt = $mc['text'];
2226 }
2227 $this->tpl->setVariable("TXT_SINGLE_CMD", $txt);
2228 $this->tpl->setVariable("SINGLE_CMD", $cmd);
2229 $this->tpl->parseCurrentBlock();
2230 }
2231 }
2232
2233 if ($arrow) {
2234 $this->tpl->setCurrentBlock("tbl_action_img_arrow");
2235 $this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("nav/arrow_downright.svg"));
2236 $this->tpl->setVariable("ALT_ARROW", $lng->txt("action"));
2237 $this->tpl->parseCurrentBlock();
2238
2239 if ($this->getTopCommands()) {
2240 $this->tpl->setCurrentBlock("tbl_top_action_img_arrow");
2241 $this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("nav/arrow_upright.svg"));
2242 $this->tpl->setVariable("ALT_ARROW", $lng->txt("action"));
2243 $this->tpl->parseCurrentBlock();
2244 }
2245 }
2246
2247 if ($action_row) {
2248 $this->tpl->setCurrentBlock("tbl_action_row");
2249 $this->tpl->parseCurrentBlock();
2250 if ($this->getTopCommands()) {
2251 $this->tpl->setCurrentBlock("tbl_top_action_row");
2252 $this->tpl->parseCurrentBlock();
2253 }
2254 }
2255 }
2256
2257 public function setHeaderHTML(string $html): void
2258 {
2259 $this->headerHTML = $html;
2260 }
2261
2262 public function storeProperty(string $type, string $value): void
2263 {
2264 global $DIC;
2265
2266 $ilUser = null;
2267 if (isset($DIC["ilUser"])) {
2268 $ilUser = $DIC["ilUser"];
2269 }
2270
2271 if (is_object($ilUser) && $this->getId() != "") {
2272 $tab_prop = new ilTablePropertiesStorageGUI();
2273
2274 $tab_prop->storeProperty($this->getId(), $ilUser->getId(), $type, $value);
2275 }
2276 }
2277
2278 public function loadProperty(string $type): ?string
2279 {
2280 global $DIC;
2281
2282 $ilUser = null;
2283 if (isset($DIC["ilUser"])) {
2284 $ilUser = $DIC["ilUser"];
2285 }
2286
2287 if (is_object($ilUser) && $this->getId() != "") {
2288 $tab_prop = new ilTablePropertiesStorageGUI();
2289
2290 return $tab_prop->getProperty($this->getId(), $ilUser->getId(), $type);
2291 }
2292 return null;
2293 }
2294
2298 public function getCurrentState(): array
2299 {
2300 $this->determineOffsetAndOrder();
2301 $this->determineLimit();
2302 $this->determineSelectedColumns();
2303 $this->determineSelectedFilters();
2304
2305 // "filter" show/hide is not saved
2306
2307 $result = array();
2308 $result["order"] = $this->getOrderField();
2309 $result["direction"] = $this->getOrderDirection();
2310 $result["offset"] = $this->getOffset();
2311 $result["rows"] = $this->getLimit();
2312 $result["selfilters"] = $this->getSelectedFilters();
2313
2314 // #9514 - $this->getSelectedColumns() will omit deselected, leading to
2315 // confusion on restoring template
2316 $result["selfields"] = $this->selected_column;
2317
2318 // gather filter values
2319 if ($this->filters) {
2320 foreach ($this->filters as $item) {
2321 $result["filter_values"][$item->getFieldId()] = $this->getFilterValue($item);
2322 }
2323 }
2324 if ($this->optional_filters && $result["selfilters"]) {
2325 foreach ($this->optional_filters as $item) {
2326 if (in_array($item->getFieldId(), $result["selfilters"])) {
2327 $result["filter_values"][$item->getFieldId()] = $this->getFilterValue($item);
2328 }
2329 }
2330 }
2331
2332 return $result;
2333 }
2334
2339 protected function getFilterValue(ilTableFilterItem $a_item)
2340 {
2341 if (method_exists($a_item, "getChecked")) {
2342 return (string) $a_item->getChecked();
2343 } elseif (method_exists($a_item, "getValue")) {
2344 return $a_item->getValue() ?: "";
2345 } elseif (method_exists($a_item, "getDate")) {
2346 return $a_item->getDate()?->get(IL_CAL_DATE) ?? "";
2347 }
2348 return "";
2349 }
2350
2355 protected function setFilterValue(ilTableFilterItem $a_item, $a_value): void
2356 {
2357 if (method_exists($a_item, "setChecked")) {
2358 $a_item->setChecked((bool) $a_value);
2359 } elseif (method_exists($a_item, "setValue")) {
2360 $a_item->setValue($a_value);
2361 } elseif (method_exists($a_item, "setDate")) {
2362 $a_item->setDate(new ilDate($a_value, IL_CAL_DATE));
2363 }
2364 $a_item->writeToSession();
2365 }
2366
2367 public function setContext(string $id): void
2368 {
2369 if (trim($id)) {
2370 $this->context = $id;
2371 }
2372 }
2373
2374 public function getContext(): string
2375 {
2376 return $this->context;
2377 }
2378
2382 public function setShowRowsSelector(bool $a_value): void
2383 {
2384 $this->show_rows_selector = $a_value;
2385 }
2386
2387 public function getShowRowsSelector(): bool
2388 {
2389 return $this->show_rows_selector;
2390 }
2391
2392 public function getLimit(): int
2393 {
2394 if ($this->getExportMode() || $this->getPrintMode()) {
2395 return 9999;
2396 }
2397 return parent::getLimit();
2398 }
2399
2400 public function getOffset(): int
2401 {
2402 if ($this->getExportMode() || $this->getPrintMode()) {
2403 return 0;
2404 }
2405 return parent::getOffset();
2406 }
2407
2411 public function setExportFormats(array $formats): void
2412 {
2413 $this->export_formats = array();
2414
2415 // #11339
2416 $valid = array(self::EXPORT_EXCEL => "tbl_export_excel",
2417 self::EXPORT_CSV => "tbl_export_csv");
2418
2419 foreach ($formats as $format) {
2420 if (array_key_exists($format, $valid)) {
2421 $this->export_formats[$format] = $valid[$format];
2422 }
2423 }
2424 }
2425
2426 public function setPrintMode(bool $a_value = false): void
2427 {
2428 $this->print_mode = $a_value;
2429 }
2430
2431 public function getPrintMode(): bool
2432 {
2433 return $this->print_mode;
2434 }
2435
2436 public function getExportMode(): int
2437 {
2438 return $this->export_mode;
2439 }
2440
2444 public function exportData(int $format, bool $send = false): void
2445 {
2446 if ($this->dataExists()) {
2447 // #9640: sort
2448 if (!$this->getExternalSorting() && $this->enabled["sort"]) {
2449 $this->determineOffsetAndOrder(true);
2450
2451 $this->row_data = ilArrayUtil::sortArray(
2452 $this->row_data,
2453 $this->getOrderField(),
2454 $this->getOrderDirection(),
2455 $this->numericOrdering($this->getOrderField())
2456 );
2457 }
2458
2459 $filename = "export";
2460 switch ($format) {
2461 case self::EXPORT_EXCEL:
2462 $excel = new ilExcel();
2463 $excel->addSheet($this->title
2464 ?: $this->lng->txt("export"));
2465 $row = 1;
2466
2467 ob_start();
2468 $this->fillMetaExcel($excel, $row); // row must be increment in fillMetaExcel()! (optional method)
2469
2470 // #14813
2471 $pre = $row;
2472 $this->fillHeaderExcel($excel, $row); // row should NOT be incremented in fillHeaderExcel()! (required method)
2473 if ($pre == $row) {
2474 $row++;
2475 }
2476
2477 foreach ($this->row_data as $set) {
2478 $this->fillRowExcel($excel, $row, $set);
2479 $row++; // #14760
2480 }
2481 ob_end_clean();
2482
2483 if ($send) {
2484 $excel->sendToClient($filename);
2485 } else {
2486 $excel->writeToFile($filename);
2487 }
2488 break;
2489
2490 case self::EXPORT_CSV:
2491 $csv = new ilCSVWriter();
2492 $csv->setSeparator(";");
2493
2494 ob_start();
2495 $this->fillMetaCSV($csv);
2496 $this->fillHeaderCSV($csv);
2497 foreach ($this->row_data as $set) {
2498 $this->fillRowCSV($csv, $set);
2499 }
2500 ob_end_clean();
2501
2502 if ($send) {
2503 $filename .= ".csv";
2504 header("Content-type: text/comma-separated-values");
2505 header("Content-Disposition: attachment; filename=\"" . $filename . "\"");
2506 header("Expires: 0");
2507 header("Cache-Control: must-revalidate, post-check=0,pre-check=0");
2508 header("Pragma: public");
2509 echo $csv->getCSVString();
2510 } else {
2511 file_put_contents($filename, $csv->getCSVString());
2512 }
2513 break;
2514 }
2515
2516 if ($send) {
2517 exit();
2518 }
2519 }
2520 }
2521
2528 protected function fillMetaExcel(ilExcel $a_excel, int &$a_row): void
2529 {
2530 }
2531
2538 protected function fillHeaderExcel(ilExcel $a_excel, int &$a_row): void
2539 {
2540 $col = 0;
2541 foreach ($this->column as $column) {
2542 $title = strip_tags($column["text"]);
2543 if ($title) {
2544 $a_excel->setCell($a_row, $col++, $title);
2545 }
2546 }
2547 $a_excel->setBold("A" . $a_row . ":" . $a_excel->getColumnCoord($col - 1) . $a_row);
2548 }
2549
2557 protected function fillRowExcel(ilExcel $a_excel, int &$a_row, array $a_set): void
2558 {
2559 $col = 0;
2560 foreach ($a_set as $value) {
2561 if (is_array($value)) {
2562 $value = implode(', ', $value);
2563 }
2564 $a_excel->setCell($a_row, $col++, $value);
2565 }
2566 }
2567
2573 protected function fillMetaCSV(ilCSVWriter $a_csv): void
2574 {
2575 }
2576
2582 protected function fillHeaderCSV(ilCSVWriter $a_csv): void
2583 {
2584 foreach ($this->column as $column) {
2585 $title = strip_tags($column["text"]);
2586 if ($title) {
2587 $a_csv->addColumn($title);
2588 }
2589 }
2590 $a_csv->addRow();
2591 }
2592
2599 protected function fillRowCSV(ilCSVWriter $a_csv, array $a_set): void
2600 {
2601 foreach ($a_set as $key => $value) {
2602 if (is_array($value)) {
2603 $value = implode(', ', $value);
2604 }
2605 $a_csv->addColumn(strip_tags($value));
2606 }
2607 $a_csv->addRow();
2608 }
2609
2610 public function setEnableAllCommand(bool $a_value): void
2611 {
2612 $this->enable_command_for_all = $a_value;
2613 }
2614
2615 public static function getAllCommandLimit(): int
2616 {
2617 global $DIC;
2618
2619 $ilClientIniFile = $DIC["ilClientIniFile"];
2620
2621 $limit = $ilClientIniFile->readVariable("system", "TABLE_ACTION_ALL_LIMIT");
2622 if (!$limit) {
2623 $limit = self::ACTION_ALL_LIMIT;
2624 }
2625
2626 return $limit;
2627 }
2628
2629 public function setRowSelectorLabel(string $row_selector_label): void
2630 {
2631 $this->row_selector_label = $row_selector_label;
2632 }
2633
2634 public function getRowSelectorLabel(): string
2635 {
2636 return $this->row_selector_label;
2637 }
2638
2639 public function setPreventDoubleSubmission(bool $a_val): void
2640 {
2641 $this->prevent_double_submission = $a_val;
2642 }
2643
2644 public function getPreventDoubleSubmission(): bool
2645 {
2646 return $this->prevent_double_submission;
2647 }
2648
2649 public function setLimit(int $a_limit = 0, int $a_default_limit = 0): void
2650 {
2651 parent::setLimit($a_limit, $a_default_limit);
2652
2653 // #17077 - if limit is set "manually" to 9999, force rows selector off
2654 if ($a_limit == 9999 &&
2655 $this->limit_determined) {
2656 $this->rows_selector_off = true;
2657 }
2658 }
2659}
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23
$filename
Definition: buildRTE.php:78
const IL_CAL_DATE
return true
static sortArray(array $array, string $a_array_sortby_key, string $a_array_sortorder="asc", bool $a_numeric=false, bool $a_keep_keys=false)
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
addColumn(string $a_col)
This class represents a checkbox property in a property form.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
This class represents a number property in a property form.
Class ilCtrl provides processing control methods.
getNextClass($a_gui_class=null)
@inheritDoc
static setUseRelativeDates(bool $a_status)
set use relative dates
This class represents a date/time property in a property form.
Class for single dates.
This class represents a duration (typical hh:mm:ss) property in a property form.
setBold(string $a_coords)
Set cell(s) to bold.
getColumnCoord(int $a_col)
Get column "name" from number.
setCell(int $a_row, int $col, $value, ?string $datatype=null)
Set cell value.
Base class for ILIAS Exception handling.
loadLanguageModule(string $a_module)
Load language module.
static formSelect( $selected, string $varname, array $options, bool $multiple=false, bool $direct_text=false, int $size=0, string $style_class="", array $attribs=[], bool $disabled=false)
Builds a select form field with options and shows the selected option first.
This class represents a number property in a property form.
This class represents a selection list property in a property form.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
string $defaultorderdirection
setTopAnchor(string $a_val)
isFilterSelected(string $a_col)
Is given filter selected?
isColumnSelected(string $col)
array $restore_filter_values
__construct(?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")
setOrderLink(string $key, string $order_dir)
bool $enable_command_for_all
setShowRowsSelector(bool $a_value)
Toggle rows-per-page selector.
setFilterCommand(string $a_val, string $a_caption="")
getFormName()
get the name of the parent form
prepareOutput()
Anything that must be done before HTML is generated.
setOrderField(string $a_order_field)
setPreventDoubleSubmission(bool $a_val)
getFilterItemByPostVar(string $a_post_var)
getHTML()
Get HTML.
loadProperty(string $type)
bool $disable_filter_hiding
setContext(string $id)
setEnableAllCommand(bool $a_value)
setLimit(int $a_limit=0, int $a_default_limit=0)
set max.
bool $prevent_double_submission
string $requested_nav_par1
fillRowCSV(ilCSVWriter $a_csv, array $a_set)
CSV Version of Fill Row.
setIsDataTable(bool $a_val)
setRowSelectorLabel(string $row_selector_label)
determineOffsetAndOrder(bool $a_omit_offset=false)
setCustomPreviousNext(string $a_prev_link, string $a_next_link)
setOpenFormTag(bool $a_val)
setTitle(string $a_title, string $a_icon="", string $a_icon_alt="")
string $row_selector_label
setEnableNumInfo(bool $a_val)
setExportFormats(array $formats)
Set available export formats.
setExternalSegmentation(bool $a_val)
addCommandButton(string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
addFilterItem(ilTableFilterItem $a_input_item, bool $a_optional=false)
setEnableTitle(bool $a_enabletitle)
setFormName(string $a_name="")
getLinkbar(string $a_num)
setDescription(string $a_val)
addHiddenInput(string $a_name, string $a_value)
addMultiCommand(string $a_cmd, string $a_text)
addFilterItemByMetaType(string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
Add filter by standard type.
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...
setFormAction(string $a_form_action, bool $a_multipart=false)
resetOffset(bool $a_in_determination=false)
setHeaderHTML(string $html)
string $defaultorderfield
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)
ILIAS Table TableGUIRequest $table_request
fillHeaderCSV(ilCSVWriter $a_csv)
CSV Version of Fill Header.
setEnableHeader(bool $a_enableheader)
renderFilter()
Render Filter section.
fillRowExcel(ilExcel $a_excel, int &$a_row, array $a_set)
Excel Version of Fill Row.
isFilterVisible()
Check if filter is visible: manually shown (session, db) or default value set.
addCommandButtonInstance(ilButtonBase $a_button)
setDefaultOrderField(string $a_defaultorderfield)
string $row_template_dir
ilGlobalTemplateInterface $main_tpl
setPrintMode(bool $a_value=false)
setDisplayAsBlock(bool $a_val)
fillRow(array $a_set)
Standard Version of Fill Row.
getCurrentState()
get current settings for order, limit, columns and filter
getSelectableColumns()
Get selectable columns.
addHeaderCommand(string $a_href, string $a_text, string $a_target="", string $a_img="")
static getAllCommandLimit()
setSelectAllCheckbox(string $a_select_all_checkbox, bool $a_select_all_on_top=false)
string $requested_nav_par
setDisableFilterHiding(bool $a_val=true)
numericOrdering(string $a_field)
Should this field be sorted numeric?
setNoEntriesText(string $a_text)
fillMetaExcel(ilExcel $a_excel, int &$a_row)
Add meta information to excel export.
setTopCommands(bool $a_val)
getFilterItems(bool $a_optionals=false)
setFilterValue(ilTableFilterItem $a_item, $a_value)
setExternalSorting(bool $a_val)
isAdvMDFilter(ilAdvancedMDRecordGUI $a_gui, ilTableFilterItem $a_element)
Check if filter element is based on adv md.
array $selectable_columns
const FILTER_DURATION_RANGE
string $requested_nav_par2
addMultiItemSelectionButton(string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')
setCloseCommand(string $a_link)
getFilterValue(ilTableFilterItem $a_item)
Get current filter value.
setRowTemplate(string $a_template, string $a_template_dir="")
Set row template.
setId(string $a_val)
bool $default_filter_visibility
setDefaultOrderDirection(string $a_defaultorderdirection)
setFilterCols(int $a_val)
setResetCommand(string $a_val, string $a_caption="")
storeProperty(string $type, string $value)
ILIAS DI UIServices $ui
setDefaultFilterVisiblity(bool $a_status)
setData(array $a_data)
Set table data.
const FILTER_NUMBER_RANGE
exportData(int $format, bool $send=false)
Export and optionally send current table data.
fillMetaCSV(ilCSVWriter $a_csv)
Add meta information to csv export.
fillHeaderExcel(ilExcel $a_excel, int &$a_row)
Excel Version of Fill Header.
setCloseFormTag(bool $a_val)
const FILTER_DATETIME_RANGE
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
ilLanguage $lng
setOffset(int $a_offset)
set dataset offset
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
special template class to simplify handling of ITX/PEAR
This class represents a text property in a property form.
static getImagePath(string $image_name, string $module_path="", string $mode="output", bool $offline=false)
get image path (for images located in a template directory)
static img(string $a_src, ?string $a_alt=null, $a_width="", $a_height="", $a_border=0, $a_id="", $a_class="")
Build img tag.
const ANONYMOUS_USER_ID
Definition: constants.php:27
$c
Definition: deliver.php:25
$valid
exit
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
global $lng
Definition: privfeed.php:31
global $DIC
Definition: shib_login.php:26
$url
Definition: shib_logout.php:70