ILIAS  release_7 Revision v7.30-3-g800a261c036
All Data Structures Namespaces Files Functions Variables Modules Pages
ilTrUserObjectsPropsTableGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

+ Inheritance diagram for ilTrUserObjectsPropsTableGUI:
+ Collaboration diagram for ilTrUserObjectsPropsTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $a_user_id, $a_obj_id, $a_ref_id, $a_print_view=false)
 Constructor. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 getItems ()
 Get user items. More...
 
 initFilter ()
 Init filter. More...
 
- Public Member Functions inherited from ilLPTableBaseGUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 
 executeCommand ()
 
 searchFilterListener ($a_ref_id, $a_data)
 Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED public. More...
 
 initBaseFilter ($a_split_learning_resources=false, $a_include_no_status_filter=true)
 Init filter. More...
 
 getCurrentFilter ($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 ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 ilTable2GUI constructor. More...
 
 setOpenFormTag ($a_val)
 Set open form tag. More...
 
 getOpenFormTag ()
 Get open form tag. More...
 
 setCloseFormTag ($a_val)
 Set close form tag. More...
 
 getCloseFormTag ()
 Get close form tag. More...
 
 determineLimit ()
 Determine the limit. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 Determine selected columns. More...
 
 isColumnSelected ($a_col)
 Is given column selected? More...
 
 getSelectedColumns ()
 Get selected columns. More...
 
 executeCommand ()
 Execute command. More...
 
 resetOffset ($a_in_determination=false)
 Reset offset. More...
 
 initFilter ()
 Init filter. More...
 
 getParentObject ()
 Get parent object. More...
 
 getParentCmd ()
 Get parent command. More...
 
 setTopAnchor ($a_val)
 Set top anchor. More...
 
 getTopAnchor ()
 Get top anchor. More...
 
 setNoEntriesText ($a_text)
 Set text for an empty table. More...
 
 getNoEntriesText ()
 Get text for an empty table. More...
 
 setIsDataTable ($a_val)
 Set is data table. More...
 
 getIsDataTable ()
 Get is data table. More...
 
 setEnableTitle ($a_enabletitle)
 Set Enable Title. More...
 
 getEnableTitle ()
 Get Enable Title. More...
 
 setEnableHeader ($a_enableheader)
 Set Enable Header. More...
 
 getEnableHeader ()
 Get Enable Header. More...
 
 setEnableNumInfo ($a_val)
 Set enable num info. More...
 
 getEnableNumInfo ()
 Get enable num info. More...
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setOrderField ($a_order_field)
 set order column More...
 
 getOrderField ()
 
 setData ($a_data)
 
 getData ()
 
 dataExists ()
 
 setPrefix ($a_prefix)
 
 getPrefix ()
 
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item. More...
 
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)
 Add filter by standard type. More...
 
 getFilterItems ($a_optionals=false)
 Get filter items. More...
 
 getFilterItemByPostVar ($a_post_var)
 
 setFilterCols ($a_val)
 Set filter columns. More...
 
 getFilterCols ()
 Get filter columns. More...
 
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding. More...
 
 getDisableFilterHiding ()
 Get disable filter hiding. More...
 
 isFilterSelected ($a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 Get selected filters. More...
 
 determineSelectedFilters ()
 Determine selected filters. More...
 
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links. More...
 
 setFormAction ($a_form_action, $a_multipart=false)
 Set Form action parameter. More...
 
 getFormAction ()
 Get Form action parameter. More...
 
 setFormName ($a_formname="")
 Set Form name. More...
 
 getFormName ()
 Get Form name. More...
 
 setId ($a_val)
 Set id. More...
 
 getId ()
 Get element id. More...
 
 setDisplayAsBlock ($a_val)
 Set display as block. More...
 
 getDisplayAsBlock ()
 Get display as block. More...
 
 getSelectAllCheckbox ()
 Get the name of the checkbox that should be toggled with a select all button. More...
 
 setSelectAllCheckbox ($a_select_all_checkbox, $a_select_all_on_top=false)
 Set the name of the checkbox that should be toggled with a select all button. More...
 
 setExternalSorting ($a_val)
 Set external sorting. More...
 
 getExternalSorting ()
 Get external sorting. More...
 
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 setDefaultFilterVisiblity ($a_status)
 Set default filter visiblity. More...
 
 getDefaultFilterVisibility ()
 Get default filter visibility. More...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButtonBase $a_button)
 Add Command button instance. More...
 
 addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button. More...
 
 addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button for selected items. More...
 
 setCloseCommand ($a_link)
 Add command for closing table. More...
 
 addMultiCommand ($a_cmd, $a_text)
 Add Command button. More...
 
 addHiddenInput ($a_name, $a_value)
 Add Hidden Input field. More...
 
 addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
 Add Header Command (Link) (Image needed for now) More...
 
 setTopCommands ($a_val)
 Set top commands (display command buttons on top of table, too) More...
 
 getTopCommands ()
 Get top commands (display command buttons on top of table, too) More...
 
 addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
 Add a column to the header. More...
 
 getNavParameter ()
 
 setOrderLink ($sort_field, $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order. More...
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 render ()
 render table public More...
 
 writeFilterToSession ()
 Write filter values to session. More...
 
 resetFilter ()
 Reset filter. More...
 
 fillFooter ()
 Fill footer row. More...
 
 getLinkbar ($a_num)
 Get previous/next linkbar. More...
 
 fillHiddenRow ()
 
 fillActionRow ()
 Fill Action Row. More...
 
 setHeaderHTML ($html)
 set header html More...
 
 storeProperty ($type, $value)
 Store table property. More...
 
 loadProperty ($type)
 Load table property. More...
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext ($id)
 Set context. More...
 
 getContext ()
 Get context. More...
 
 setShowRowsSelector ($a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 Get rows-per-page selector state. More...
 
 setShowTemplates ($a_value)
 Toggle templates. More...
 
 getShowTemplates ()
 Get template state. More...
 
 restoreTemplate ($a_name)
 Restore state from template. More...
 
 saveTemplate ($a_name)
 Save current state as template. More...
 
 deleteTemplate ($a_name)
 Delete template. More...
 
 getLimit ()
 Get limit. More...
 
 getOffset ()
 Get offset. More...
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode ($a_value=false)
 Toogle print mode. More...
 
 getPrintMode ()
 Get print mode. More...
 
 getExportMode ()
 Was export activated? More...
 
 exportData ($format, $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result. More...
 
 setRowSelectorLabel ($row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission ($a_val)
 Set prevent double submission. More...
 
 getPreventDoubleSubmission ()
 Get prevent double submission. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 
- Public Member Functions inherited from ilTableGUI
 __construct ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate ($a_tpl)
 set template public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page public More...
 
 setHeaderNames ($a_header_names)
 set table header names public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars public More...
 
 setColumnWidth ($a_column_width)
 set table column widths public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width public More...
 
 setMaxCount ($a_max_count)
 set max. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
 getLimit ()
 Get limit. More...
 
 setPrefix ($a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) public More...
 
 setOffset ($a_offset)
 set dataset offset public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction public More...
 
 enable ($a_module_name)
 enables particular modules of table More...
 
 disable ($a_module_name)
 diesables particular modules of table More...
 
 sortData ()
 
 render ()
 render table public More...
 
 renderHeader ()
 
 setOrderLink ($key, $order_dir)
 
 setStyle ($a_element, $a_style)
 
 getStyle ($a_element)
 
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds). More...
 
 getBase ()
 Get Base script name (deprecated, only use this for workarounds). More...
 
 getFormName ()
 
 setFormName ($a_name="cmd")
 
 getSelectAllCheckbox ()
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton ($btn_name, $btn_value)
 

Protected Member Functions

 fillRow ($data)
 Fill table row. More...
 
 fillHeaderExcel (ilExcel $a_excel, &$a_row)
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
 
 fillHeaderCSV ($a_csv)
 
 fillRowCSV ($a_csv, $a_set)
 
- Protected Member Functions inherited from ilLPTableBaseGUI
 sendMail (array $a_user_ids, $a_parent_obj, $a_parent_cmd)
 
 searchObjects (array $filter, $permission, array $preset_obj_ids=null, $a_check_lp_activation=true)
 Search objects that match current filters. More...
 
 buildPath ($ref_ids)
 Build path with deep-link. More...
 
 getPossibleTypes ($a_split_learning_resources=false, $a_include_digilib=false, $a_allow_undefined_lp=false)
 Get possible subtypes. More...
 
 parseValue ($id, $value, $type)
 
 isPercentageAvailable ($a_obj_id)
 
 parseTitle ($a_obj_id, $action, $a_user_id=false)
 
 getExportMeta ()
 Build export meta data. More...
 
 fillMetaExcel (ilExcel $a_excel, &$a_row)
 
 fillMetaCSV ($a_csv)
 
 showTimingsWarning ($a_ref_id, $a_user_id)
 
 formatSeconds ($seconds, $a_shorten_zero=false)
 
 anonymizeValue ($a_value, $a_force_number=false)
 
 buildValueScale ($a_max_value, $a_anonymize=false, $a_format_seconds=false)
 
 getMonthsFilter ($a_short=false)
 
 getMonthsYear ($a_year=null, $a_short=false)
 
 getSelectableUserColumns ($a_in_course=false, $a_in_group=false)
 
 addToClipboard ()
 Add selected users to clipboard. More...
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 isFilterVisible ()
 Check if filter is visible: manually shown (session, db) or default value set. More...
 
 isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel (ilExcel $a_excel, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel (ilExcel $a_excel, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- Data Fields inherited from 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
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 
- Protected Attributes inherited from ilLPTableBaseGUI
 $filter
 
 $anonymized
 
 $icon_variant = ilLPStatusIcons::ICON_VARIANT_LONG
 
- Protected Attributes inherited from ilTable2GUI
 $ctrl
 
 $tpl
 
 $parent_obj
 
 $parent_cmd
 
 $close_command = ""
 
 $top_anchor = "il_table_top"
 
 $filters = array()
 
 $optional_filters = array()
 
 $filter_cmd = 'applyFilter'
 
 $reset_cmd = 'resetFilter'
 
 $filter_cols = 5
 
 $ext_sort = false
 
 $ext_seg = false
 
 $context = ""
 
 $mi_sel_buttons = []
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $rows_selector_off = false
 
 $nav_determined = false
 
 $limit_determined = false
 
 $filters_determined = false
 
 $columns_determined = false
 
 $open_form_tag = true
 
 $close_form_tag = true
 
 $export_formats = []
 
 $export_mode
 
 $print_mode
 
 $enable_command_for_all
 
 $restore_filter
 
 $restore_filter_values
 
 $default_filter_visibility = false
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 
 $select_all_on_top = false
 
 $sel_buttons = []
 
- Protected Attributes inherited from ilTableGUI
 $tpl
 
 $lng
 

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Build table list for objects of given user

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

ilTrUserObjectsPropsTableGUI: ilFormPropertyDispatchGUI

Definition at line 29 of file class.ilTrUserObjectsPropsTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTrUserObjectsPropsTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $a_user_id,
  $a_obj_id,
  $a_ref_id,
  $a_print_view = false 
)

Constructor.

Definition at line 34 of file class.ilTrUserObjectsPropsTableGUI.php.

References $c, $DIC, ilTableGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), getItems(), ilTable2GUI\getPrintMode(), ilTable2GUI\getSelectedColumns(), initFilter(), ilLPTableBaseGUI\parseTitle(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExportFormats(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setPrintMode(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setShowTemplates().

35  {
36  global $DIC;
37 
38  $ilCtrl = $DIC['ilCtrl'];
39  $lng = $DIC['lng'];
40  $ilAccess = $DIC['ilAccess'];
41  $lng = $DIC['lng'];
42  $rbacsystem = $DIC['rbacsystem'];
43 
44  $this->setId("truop");
45  $this->user_id = $a_user_id;
46  $this->obj_id = $a_obj_id;
47  $this->ref_id = $a_ref_id;
48 
49  parent::__construct($a_parent_obj, $a_parent_cmd);
50  $this->setLimit(9999);
51 
52  $this->parseTitle($this->obj_id, "details", $this->user_id);
53 
54  if ($a_print_view) {
55  $this->setPrintMode(true);
56  }
57 
58  $this->addColumn($this->lng->txt("title"), "title");
59 
60  foreach ($this->getSelectedColumns() as $c) {
61  $l = $c;
62  if (in_array($l, array("last_access", "first_access", "read_count", "spent_seconds", "mark", "status", "percentage"))) {
63  $l = "trac_" . $l;
64  }
65  if ($l == "u_comment") {
66  $l = "trac_comment";
67  }
68  $this->addColumn($this->lng->txt($l), $c);
69  }
70 
71  if (!$this->getPrintMode()) {
72  $this->addColumn($this->lng->txt("actions"), "");
73  }
74 
75  $this->setExternalSorting(true);
76  $this->setExternalSegmentation(true);
77  $this->setEnableHeader(true);
78  $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
79  $this->setRowTemplate("tpl.user_objects_props_row.html", "Services/Tracking");
80  $this->setEnableTitle(true);
81  $this->setDefaultOrderField("title");
82  $this->setDefaultOrderDirection("asc");
83  $this->setShowTemplates(true);
84 
85  $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
86 
87  $this->initFilter();
88 
89  $this->getItems();
90  }
setExternalSorting($a_val)
Set external sorting.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
setExportFormats(array $formats)
Set available export formats.
$c
Definition: cli.php:37
setPrintMode($a_value=false)
Toogle print mode.
setShowTemplates($a_value)
Toggle templates.
setExternalSegmentation($a_val)
Set external segmentation.
parseTitle($a_obj_id, $action, $a_user_id=false)
setId($a_val)
Set id.
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
global $DIC
Definition: goto.php:24
getSelectedColumns()
Get selected columns.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
__construct(Container $dic, ilPlugin $plugin)
addColumn( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
getPrintMode()
Get print mode.
setEnableHeader($a_enableheader)
Set Enable Header.
setEnableTitle($a_enabletitle)
Set Enable Title.
setLimit($a_limit=0, $a_default_limit=0)
+ Here is the call graph for this function:

Member Function Documentation

◆ fillHeaderCSV()

ilTrUserObjectsPropsTableGUI::fillHeaderCSV (   $a_csv)
protected

Definition at line 453 of file class.ilTrUserObjectsPropsTableGUI.php.

References $c, getSelectableColumns(), and ilTable2GUI\getSelectedColumns().

454  {
455  $a_csv->addColumn($this->lng->txt("type"));
456  $a_csv->addColumn($this->lng->txt("title"));
457 
458  $labels = $this->getSelectableColumns();
459  foreach ($this->getSelectedColumns() as $c) {
460  $a_csv->addColumn($labels[$c]["txt"]);
461  }
462 
463  $a_csv->addRow();
464  }
$c
Definition: cli.php:37
getSelectedColumns()
Get selected columns.
+ Here is the call graph for this function:

◆ fillHeaderExcel()

ilTrUserObjectsPropsTableGUI::fillHeaderExcel ( ilExcel  $a_excel,
$a_row 
)
protected

Definition at line 423 of file class.ilTrUserObjectsPropsTableGUI.php.

References $c, ilExcel\getColumnCoord(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ilExcel\setBold(), and ilExcel\setCell().

424  {
425  $a_excel->setCell($a_row, 0, $this->lng->txt("type"));
426  $a_excel->setCell($a_row, 1, $this->lng->txt("title"));
427 
428  $labels = $this->getSelectableColumns();
429  $cnt = 2;
430  foreach ($this->getSelectedColumns() as $c) {
431  $a_excel->setCell($a_row, $cnt++, $labels[$c]["txt"]);
432  }
433 
434  $a_excel->setBold("A" . $a_row . ":" . $a_excel->getColumnCoord($cnt - 1) . $a_row);
435  }
$c
Definition: cli.php:37
getColumnCoord($a_col)
Get column "name" from number.
setBold($a_coords)
Set cell(s) to bold.
getSelectedColumns()
Get selected columns.
setCell($a_row, $a_col, $a_value, $a_datatype=null)
Set cell value.
+ Here is the call graph for this function:

◆ fillRow()

ilTrUserObjectsPropsTableGUI::fillRow (   $data)
protected

Fill table row.

Definition at line 268 of file class.ilTrUserObjectsPropsTableGUI.php.

References $_GET, $c, ilTableGUI\$data, $DIC, ilTableGUI\$lng, $url, ilObject\_getIcon(), ilLearningProgressAccess\checkPermission(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilLPStatusIcons\getInstance(), ilTable2GUI\getPrintMode(), ilTable2GUI\getSelectedColumns(), ilLPStatusIcons\ICON_VARIANT_LONG, IL_CAL_DATETIME, IL_CAL_UNIX, ilLPTableBaseGUI\isPercentageAvailable(), ilDatePresentation\secondsToString(), ilLPTableBaseGUI\showTimingsWarning(), ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

269  {
270  global $DIC;
272 
273  $ilCtrl = $DIC['ilCtrl'];
274  $lng = $DIC['lng'];
275  $rbacsystem = $DIC['rbacsystem'];
276 
277  if (!$this->isPercentageAvailable($data["obj_id"])) {
278  $data["percentage"] = null;
279  }
280 
281  foreach ($this->getSelectedColumns() as $c) {
282  if (!$data["privacy_conflict"]) {
283  $val = (trim($data[$c]) == "")
284  ? " "
285  : $data[$c];
286 
287  if ($data[$c] != "" || $c == "status") {
288  switch ($c) {
289  case "first_access":
291  break;
292 
293  case "last_access":
295  break;
296 
297  case "status":
298  $val = $icons->renderIconForStatus((int) $data[$c]);
299 
300  if ($data["ref_id"] &&
301  $data["type"] != "lobj" &&
302  $data["type"] != "sco" &&
303  $data["type"] != "st" &&
304  $data["type"] != "mob") {
305  $timing = $this->showTimingsWarning($data["ref_id"], $this->user_id);
306  if ($timing) {
307  if ($timing !== true) {
308  $timing = ": " . ilDatePresentation::formatDate(new ilDate($timing, IL_CAL_UNIX));
309  } else {
310  $timing = "";
311  }
312  $this->tpl->setCurrentBlock('warning_img');
313  $this->tpl->setVariable('WARNING_IMG', ilUtil::getImagePath('time_warn.svg'));
314  $this->tpl->setVariable('WARNING_ALT', $this->lng->txt('trac_time_passed') . $timing);
315  $this->tpl->parseCurrentBlock();
316  }
317  }
318  break;
319 
320  case "spent_seconds":
321  if (!ilObjectLP::supportsSpentSeconds($data["type"])) {
322  $val = "-";
323  } else {
324  $val = ilDatePresentation::secondsToString($data[$c], ($data[$c] < 3600 ? true : false)); // #14858
325  }
326  break;
327 
328  case "percentage":
329  $val = $data[$c] . "%";
330  break;
331 
332  }
333  }
334  if ($c == "mark" &&
335  !ilObjectLP::supportsMark($this->type)) {
336  $val = "-";
337  }
338  if ($c == "spent_seconds" &&
339  !ilObjectLP::supportsSpentSeconds($this->type)) {
340  $val = "-";
341  }
342  if ($c == "percentage" &&
343  !$this->isPercentageAvailable($data["obj_id"])) {
344  $val = "-";
345  }
346  } else {
347  $val = "&nbsp;";
348  }
349 
350  $this->tpl->setCurrentBlock("user_field");
351  $this->tpl->setVariable("VAL_UF", $val);
352  $this->tpl->parseCurrentBlock();
353  }
354 
355  if ($data["privacy_conflict"]) {
356  $this->tpl->setCurrentBlock("permission_bl");
357  $this->tpl->setVariable("TXT_NO_PERMISSION", $lng->txt("status_no_permission"));
358  $this->tpl->parseCurrentBlock();
359  }
360 
361  if ($data["title"] == "") {
362  $data["title"] = "--" . $lng->txt("none") . "--";
363  }
364  $this->tpl->setVariable("ICON", ilObject::_getIcon("", "tiny", $data["type"]));
365  $this->tpl->setVariable("ICON_ALT", $lng->txt($data["type"]));
366 
367  if (in_array($data['type'], array('fold', 'grp')) && $data['obj_id'] != $this->obj_id) {
368  if ($data['type'] == 'fold') {
369  $object_gui = 'ilobjfoldergui';
370  } else {
371  $object_gui = 'ilobjgroupgui';
372  }
373  $this->tpl->setCurrentBlock('title_linked');
374 
375  // link structure gets too complicated
376  if ($_GET["baseClass"] != "ilDashboardGUI" && $_GET["baseClass"] != "ilAdministrationGUI") {
377  $old = $ilCtrl->getParameterArrayByClass('illplistofobjectsgui');
378  $ilCtrl->setParameterByClass('illplistofobjectsgui', 'ref_id', $data["ref_id"]);
379  $ilCtrl->setParameterByClass('illplistofobjectsgui', 'details_id', $data["ref_id"]);
380  $ilCtrl->setParameterByClass('illplistofobjectsgui', 'user_id', $this->user_id);
381  $url = $ilCtrl->getLinkTargetByClass(array('ilrepositorygui', $object_gui, 'illearningprogressgui', 'illplistofobjectsgui'), 'userdetails');
382  $ilCtrl->setParameterByClass('illplistofobjectsgui', 'ref_id', $old["ref_id"]);
383  $ilCtrl->setParameterByClass('illplistofobjectsgui', 'details_id', $old["details_id"]);
384  $ilCtrl->setParameterByClass('illplistofobjectsgui', 'user_id', $old["user_id"]);
385  } else {
386  $url = "#";
387  }
388 
389  $this->tpl->setVariable("URL_TITLE", $url);
390  $this->tpl->setVariable("VAL_TITLE", $data["title"]);
391  $this->tpl->parseCurrentBlock();
392  } else {
393  $this->tpl->setCurrentBlock('title_plain');
394  $this->tpl->setVariable("VAL_TITLE", $data["title"]);
395  $this->tpl->parseCurrentBlock();
396  }
397 
398  // #16453 / #17163
399  if ($data['ref_id']) {
400  include_once './Services/Tree/classes/class.ilPathGUI.php';
401  $path = new ilPathGUI();
402  $path = $path->getPath($this->ref_id, $data['ref_id']);
403  if ($path) {
404  $this->tpl->setVariable('COLL_PATH', $this->lng->txt('path') . ': ' . $path);
405  }
406  }
407 
408  // #13807 / #17069
409  include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
410  if ($data["ref_id"] &&
411  ilLearningProgressAccess::checkPermission('edit_learning_progress', $data['ref_id'])) {
412  if (!in_array($data["type"], array("sco", "lobj")) && !$this->getPrintMode()) {
413  $this->tpl->setCurrentBlock("item_command");
414  $ilCtrl->setParameterByClass("illplistofobjectsgui", "userdetails_id", $data["ref_id"]);
415  $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass("illplistofobjectsgui", 'edituser'));
416  $this->tpl->setVariable("TXT_COMMAND", $lng->txt('edit'));
417  $ilCtrl->setParameterByClass("illplistofobjectsgui", "userdetails_id", "");
418  $this->tpl->parseCurrentBlock();
419  }
420  }
421  }
static _getIcon( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
Get icon for repository item.
Creates a path for a start and endnode.
const IL_CAL_DATETIME
$c
Definition: cli.php:37
$_GET["client_id"]
static getInstance(int $variant=ilLPStatusIcons::ICON_VARIANT_DEFAULT, ?\ILIAS\UI\Renderer $renderer=null, ?\ILIAS\UI\Factory $factory=null)
const IL_CAL_UNIX
static checkPermission($a_permission, $a_ref_id, $a_user_id=null)
wrapper for rbac access checks
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false, $include_seconds=false)
Format a date public.
static secondsToString($seconds, $force_with_seconds=false, $a_lng=null)
converts seconds to string: Long: 7 days 4 hour(s) ...
Class for single dates.
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
global $DIC
Definition: goto.php:24
getSelectedColumns()
Get selected columns.
static supportsMark($a_obj_type)
static supportsSpentSeconds($a_obj_type)
showTimingsWarning($a_ref_id, $a_user_id)
getPrintMode()
Get print mode.
$url
+ Here is the call graph for this function:

◆ fillRowCSV()

ilTrUserObjectsPropsTableGUI::fillRowCSV (   $a_csv,
  $a_set 
)
protected

Definition at line 466 of file class.ilTrUserObjectsPropsTableGUI.php.

References $c, ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\getSelectedColumns(), and ilLPTableBaseGUI\parseValue().

467  {
468  $a_csv->addColumn($this->lng->txt($a_set["type"]));
469  $a_csv->addColumn($a_set["title"]);
470 
471  foreach ($this->getSelectedColumns() as $c) {
472  if ($c != 'status') {
473  $val = $this->parseValue($c, $a_set[$c], $this->type);
474  } else {
475  $val = ilLearningProgressBaseGUI::_getStatusText((int) $a_set[$c]);
476  }
477  $a_csv->addColumn($val);
478  }
479 
480  $a_csv->addRow();
481  }
$c
Definition: cli.php:37
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
parseValue($id, $value, $type)
getSelectedColumns()
Get selected columns.
+ Here is the call graph for this function:

◆ fillRowExcel()

ilTrUserObjectsPropsTableGUI::fillRowExcel ( ilExcel  $a_excel,
$a_row,
  $a_set 
)
protected

Definition at line 437 of file class.ilTrUserObjectsPropsTableGUI.php.

References $c, ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\getSelectedColumns(), ilLPTableBaseGUI\parseValue(), and ilExcel\setCell().

438  {
439  $a_excel->setCell($a_row, 0, $this->lng->txt($a_set["type"]));
440  $a_excel->setCell($a_row, 1, $a_set["title"]);
441 
442  $cnt = 2;
443  foreach ($this->getSelectedColumns() as $c) {
444  if ($c != 'status') {
445  $val = $this->parseValue($c, $a_set[$c], $this->type);
446  } else {
447  $val = ilLearningProgressBaseGUI::_getStatusText((int) $a_set[$c]);
448  }
449  $a_excel->setCell($a_row, $cnt++, $val);
450  }
451  }
$c
Definition: cli.php:37
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
parseValue($id, $value, $type)
getSelectedColumns()
Get selected columns.
setCell($a_row, $a_col, $a_value, $a_datatype=null)
Set cell value.
+ Here is the call graph for this function:

◆ getItems()

ilTrUserObjectsPropsTableGUI::getItems ( )

Get user items.

Definition at line 149 of file class.ilTrUserObjectsPropsTableGUI.php.

References $DIC, ilLearningProgressAccess\checkPermission(), ilTable2GUI\determineOffsetAndOrder(), filter(), ilTable2GUI\getLimit(), ilTrQuery\getObjectsDataForUser(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\getSelectedColumns(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), and ilUtil\stripSlashes().

Referenced by __construct().

150  {
151  global $DIC;
152 
153  $rbacsystem = $DIC['rbacsystem'];
154 
155  $this->determineOffsetAndOrder();
156 
157  $additional_fields = $this->getSelectedColumns();
158 
159  include_once("./Services/Tracking/classes/class.ilTrQuery.php");
160 
162  $this->user_id,
163  $this->obj_id,
164  $this->ref_id,
168  ilUtil::stripSlashes($this->getLimit()),
169  $this->filter,
170  $additional_fields,
171  $this->filter["view_mode"]
172  );
173 
174  if (count($tr_data["set"]) == 0 && $this->getOffset() > 0) {
175  $this->resetOffset();
177  $this->user_id,
178  $this->obj_id,
179  $this->ref_id,
183  ilUtil::stripSlashes($this->getLimit()),
184  $this->filter,
185  $additional_fields,
186  $this->filter["view_mode"]
187  );
188  }
189 
190  // #13807
191  foreach ($tr_data["set"] as $idx => $row) {
192  include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
193  if ($row["ref_id"] &&
194  !ilLearningProgressAccess::checkPermission('read_learning_progress', $row['ref_id'])) {
195  foreach (array_keys($row) as $col_id) {
196  if (!in_array($col_id, array("type", "obj_id", "ref_id", "title", "sort_title"))) {
197  $tr_data["set"][$idx][$col_id] = null;
198  }
199  }
200  $tr_data["set"][$idx]["privacy_conflict"] = true;
201  }
202  }
203 
204  $this->setMaxCount($tr_data["cnt"]);
205 
206  if ($this->getOrderField() == "title") {
207  // sort alphabetically, move parent object to 1st position
208  $set = array();
209  $parent = false;
210  foreach ($tr_data["set"] as $idx => $row) {
211  if ($row['obj_id'] == $this->obj_id) {
212  $parent = $row;
213  } elseif (isset($row["sort_title"])) {
214  $set[strtolower($row["sort_title"]) . "__" . $idx] = $row;
215  } else {
216  $set[strtolower($row["title"]) . "__" . $idx] = $row;
217  }
218  }
219  unset($tr_data["set"]);
220  if ($this->getOrderDirection() == "asc") {
221  ksort($set);
222  } else {
223  krsort($set);
224  }
225  $set = array_values($set);
226  if ($parent) {
227  array_unshift($set, $parent);
228  }
229 
230  $this->setData($set);
231  } else {
232  $this->setData($tr_data["set"]);
233  }
234  }
resetOffset($a_in_determination=false)
Reset offset.
getOrderDirection()
Get order direction.
static checkPermission($a_permission, $a_ref_id, $a_user_id=null)
wrapper for rbac access checks
getOffset()
Get offset.
global $DIC
Definition: goto.php:24
getSelectedColumns()
Get selected columns.
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
static getObjectsDataForUser( $a_user_id, $a_parent_obj_id, $a_parent_ref_id, $a_order_field="", $a_order_dir="", $a_offset=0, $a_limit=9999, array $a_filters=null, array $a_additional_fields=null, $use_collection=true)
Get all object-based tracking data for user and parent object.
getLimit()
Get limit.
filter()
Definition: filter.php:2
setMaxCount($a_max_count)
set max.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSelectableColumns()

ilTrUserObjectsPropsTableGUI::getSelectableColumns ( )

Get selectable columns.

Parameters

Definition at line 98 of file class.ilTrUserObjectsPropsTableGUI.php.

References $cols, $DIC, ilTableGUI\$lng, ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, ilObjUserTracking\EXTENDED_DATA_READ_COUNT, and ilObjUserTracking\EXTENDED_DATA_SPENT_SECONDS.

Referenced by fillHeaderCSV(), and fillHeaderExcel().

99  {
100  global $DIC;
101 
102  $lng = $DIC['lng'];
103 
104  // default fields
105  $cols = array();
106 
107  include_once 'Services/Tracking/classes/class.ilObjUserTracking.php';
108  $tracking = new ilObjUserTracking();
109  if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS)) {
110  $cols["first_access"] = array(
111  "txt" => $lng->txt("trac_first_access"),
112  "default" => true);
113  $cols["last_access"] = array(
114  "txt" => $lng->txt("trac_last_access"),
115  "default" => true);
116  }
117  if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_READ_COUNT)) {
118  $cols["read_count"] = array(
119  "txt" => $lng->txt("trac_read_count"),
120  "default" => true);
121  }
122  if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS)) {
123  $cols["spent_seconds"] = array(
124  "txt" => $lng->txt("trac_spent_seconds"),
125  "default" => true);
126  }
127 
128  // #15334 - parent object does not matter, sub-objects may have percentage
129  $cols["percentage"] = array(
130  "txt" => $lng->txt("trac_percentage"),
131  "default" => true);
132 
133  $cols["status"] = array(
134  "txt" => $lng->txt("trac_status"),
135  "default" => true);
136  $cols["mark"] = array(
137  "txt" => $lng->txt("trac_mark"),
138  "default" => true);
139  $cols["u_comment"] = array(
140  "txt" => $lng->txt("trac_comment"),
141  "default" => false);
142 
143  return $cols;
144  }
global $DIC
Definition: goto.php:24
$cols
Definition: xhr_table.php:11
+ Here is the caller graph for this function:

◆ initFilter()

ilTrUserObjectsPropsTableGUI::initFilter ( )

Init filter.

Definition at line 239 of file class.ilTrUserObjectsPropsTableGUI.php.

References $DIC, ilTableGUI\$lng, ilTable2GUI\addFilterItem(), ilRadioGroupInputGUI\addOption(), filter(), and ilObjectLP\getInstance().

Referenced by __construct().

240  {
241  global $DIC;
242 
243  $lng = $DIC['lng'];
244 
245  // for scorm and objectives this filter does not make sense / is not implemented
246  include_once './Services/Object/classes/class.ilObjectLP.php';
247  $olp = ilObjectLP::getInstance($this->obj_id);
248  $collection = $olp->getCollectionInstance();
249  if ($collection instanceof ilLPCollectionOfRepositoryObjects) {
250  include_once("./Services/Form/classes/class.ilSubEnabledFormPropertyGUI.php");
251  include_once("./Services/Table/interfaces/interface.ilTableFilterItem.php");
252 
253  // show collection only/all
254  include_once("./Services/Form/classes/class.ilRadioGroupInputGUI.php");
255  include_once("./Services/Form/classes/class.ilRadioOption.php");
256  $ti = new ilRadioGroupInputGUI($lng->txt("trac_view_mode"), "view_mode");
257  $ti->addOption(new ilRadioOption($lng->txt("trac_view_mode_all"), ""));
258  $ti->addOption(new ilRadioOption($lng->txt("trac_view_mode_collection"), "coll"));
259  $this->addFilterItem($ti);
260  $ti->readFromSession();
261  $this->filter["view_mode"] = $ti->getValue();
262  }
263  }
This class represents an option in a radio group.
addFilterItem($a_input_item, $a_optional=false)
Add filter item.
This class represents a property in a property form.
addOption($a_option)
Add Option.
global $DIC
Definition: goto.php:24
filter()
Definition: filter.php:2
static getInstance($a_obj_id)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

The documentation for this class was generated from the following file: