ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilTrUserObjectsPropsTableGUI Class Reference

Build table list for objects of given user. 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)
 
- 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 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
 
- 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

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 15 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 20 of file class.ilTrUserObjectsPropsTableGUI.php.

References $c, $DIC, $ilCtrl, $l, ilTableGUI\$lng, 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().

21  {
22  global $DIC;
23 
24  $ilCtrl = $DIC['ilCtrl'];
25  $lng = $DIC['lng'];
26  $ilAccess = $DIC['ilAccess'];
27  $lng = $DIC['lng'];
28  $rbacsystem = $DIC['rbacsystem'];
29 
30  $this->setId("truop");
31  $this->user_id = $a_user_id;
32  $this->obj_id = $a_obj_id;
33  $this->ref_id = $a_ref_id;
34 
35  parent::__construct($a_parent_obj, $a_parent_cmd);
36  $this->setLimit(9999);
37 
38  $this->parseTitle($this->obj_id, "details", $this->user_id);
39 
40  if ($a_print_view) {
41  $this->setPrintMode(true);
42  }
43 
44  $this->addColumn($this->lng->txt("title"), "title");
45 
46  foreach ($this->getSelectedColumns() as $c) {
47  $l = $c;
48  if (in_array($l, array("last_access", "first_access", "read_count", "spent_seconds", "mark", "status", "percentage"))) {
49  $l = "trac_" . $l;
50  }
51  if ($l == "u_comment") {
52  $l = "trac_comment";
53  }
54  $this->addColumn($this->lng->txt($l), $c);
55  }
56 
57  if (!$this->getPrintMode()) {
58  $this->addColumn($this->lng->txt("actions"), "");
59  }
60 
61  $this->setExternalSorting(true);
62  $this->setExternalSegmentation(true);
63  $this->setEnableHeader(true);
64  $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
65  $this->setRowTemplate("tpl.user_objects_props_row.html", "Services/Tracking");
66  $this->setEnableTitle(true);
67  $this->setDefaultOrderField("title");
68  $this->setDefaultOrderDirection("asc");
69  $this->setShowTemplates(true);
70 
71  $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
72 
73  $this->initFilter();
74 
75  $this->getItems();
76  }
setExternalSorting($a_val)
Set external sorting.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
setExportFormats(array $formats)
Set available export formats.
global $DIC
Definition: saml.php:7
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.
global $ilCtrl
Definition: ilias.php:18
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
getSelectedColumns()
Get selected columns.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
global $l
Definition: afr.php:30
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 441 of file class.ilTrUserObjectsPropsTableGUI.php.

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

442  {
443  $a_csv->addColumn($this->lng->txt("type"));
444  $a_csv->addColumn($this->lng->txt("title"));
445 
446  $labels = $this->getSelectableColumns();
447  foreach ($this->getSelectedColumns() as $c) {
448  $a_csv->addColumn($labels[$c]["txt"]);
449  }
450 
451  $a_csv->addRow();
452  }
getSelectedColumns()
Get selected columns.
+ Here is the call graph for this function:

◆ fillHeaderExcel()

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

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

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

412  {
413  $a_excel->setCell($a_row, 0, $this->lng->txt("type"));
414  $a_excel->setCell($a_row, 1, $this->lng->txt("title"));
415 
416  $labels = $this->getSelectableColumns();
417  $cnt = 2;
418  foreach ($this->getSelectedColumns() as $c) {
419  $a_excel->setCell($a_row, $cnt++, $labels[$c]["txt"]);
420  }
421 
422  $a_excel->setBold("A" . $a_row . ":" . $a_excel->getColumnCoord($cnt - 1) . $a_row);
423  }
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 254 of file class.ilTrUserObjectsPropsTableGUI.php.

References $_GET, $c, ilTableGUI\$data, $DIC, $ilCtrl, ilTableGUI\$lng, $path, $text, $url, ilLearningProgressBaseGUI\_getImagePathForStatus(), ilLearningProgressBaseGUI\_getStatusText(), ilLearningProgressAccess\checkPermission(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilTable2GUI\getPrintMode(), ilTable2GUI\getSelectedColumns(), IL_CAL_DATETIME, IL_CAL_UNIX, ilUtil\img(), ilLPTableBaseGUI\isPercentageAvailable(), ilDatePresentation\secondsToString(), ilLPTableBaseGUI\showTimingsWarning(), ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

255  {
256  global $DIC;
257 
258  $ilCtrl = $DIC['ilCtrl'];
259  $lng = $DIC['lng'];
260  $rbacsystem = $DIC['rbacsystem'];
261 
262  if (!$this->isPercentageAvailable($data["obj_id"])) {
263  $data["percentage"] = null;
264  }
265 
266  foreach ($this->getSelectedColumns() as $c) {
267  if (!$data["privacy_conflict"]) {
268  $val = (trim($data[$c]) == "")
269  ? " "
270  : $data[$c];
271 
272  if ($data[$c] != "" || $c == "status") {
273  switch ($c) {
274  case "first_access":
276  break;
277 
278  case "last_access":
280  break;
281 
282  case "status":
283  include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
286  $val = ilUtil::img($path, $text);
287 
288  if ($data["ref_id"] &&
289  $data["type"] != "lobj" &&
290  $data["type"] != "sco" &&
291  $data["type"] != "st" &&
292  $data["type"] != "mob") {
293  $timing = $this->showTimingsWarning($data["ref_id"], $this->user_id);
294  if ($timing) {
295  if ($timing !== true) {
296  $timing = ": " . ilDatePresentation::formatDate(new ilDate($timing, IL_CAL_UNIX));
297  } else {
298  $timing = "";
299  }
300  $this->tpl->setCurrentBlock('warning_img');
301  $this->tpl->setVariable('WARNING_IMG', ilUtil::getImagePath('time_warn.svg'));
302  $this->tpl->setVariable('WARNING_ALT', $this->lng->txt('trac_time_passed') . $timing);
303  $this->tpl->parseCurrentBlock();
304  }
305  }
306  break;
307 
308  case "spent_seconds":
309  if (!ilObjectLP::supportsSpentSeconds($data["type"])) {
310  $val = "-";
311  } else {
312  $val = ilDatePresentation::secondsToString($data[$c], ($data[$c] < 3600 ? true : false)); // #14858
313  }
314  break;
315 
316  case "percentage":
317  $val = $data[$c] . "%";
318  break;
319 
320  }
321  }
322  if ($c == "mark" &&
323  !ilObjectLP::supportsMark($this->type)) {
324  $val = "-";
325  }
326  if ($c == "spent_seconds" &&
327  !ilObjectLP::supportsSpentSeconds($this->type)) {
328  $val = "-";
329  }
330  if ($c == "percentage" &&
331  !$this->isPercentageAvailable($data["obj_id"])) {
332  $val = "-";
333  }
334  } else {
335  $val = "&nbsp;";
336  }
337 
338  $this->tpl->setCurrentBlock("user_field");
339  $this->tpl->setVariable("VAL_UF", $val);
340  $this->tpl->parseCurrentBlock();
341  }
342 
343  if ($data["privacy_conflict"]) {
344  $this->tpl->setCurrentBlock("permission_bl");
345  $this->tpl->setVariable("TXT_NO_PERMISSION", $lng->txt("status_no_permission"));
346  $this->tpl->parseCurrentBlock();
347  }
348 
349  if ($data["title"] == "") {
350  $data["title"] = "--" . $lng->txt("none") . "--";
351  }
352  $this->tpl->setVariable("ICON", ilObject::_getIcon("", "tiny", $data["type"]));
353  $this->tpl->setVariable("ICON_ALT", $lng->txt($data["type"]));
354 
355  if (in_array($data['type'], array('fold', 'grp')) && $data['obj_id'] != $this->obj_id) {
356  if ($data['type'] == 'fold') {
357  $object_gui = 'ilobjfoldergui';
358  } else {
359  $object_gui = 'ilobjgroupgui';
360  }
361  $this->tpl->setCurrentBlock('title_linked');
362 
363  // link structure gets too complicated
364  if ($_GET["baseClass"] != "ilPersonalDesktopGUI" && $_GET["baseClass"] != "ilAdministrationGUI") {
365  $old = $ilCtrl->getParameterArrayByClass('illplistofobjectsgui');
366  $ilCtrl->setParameterByClass('illplistofobjectsgui', 'ref_id', $data["ref_id"]);
367  $ilCtrl->setParameterByClass('illplistofobjectsgui', 'details_id', $data["ref_id"]);
368  $ilCtrl->setParameterByClass('illplistofobjectsgui', 'user_id', $this->user_id);
369  $url = $ilCtrl->getLinkTargetByClass(array('ilrepositorygui', $object_gui, 'illearningprogressgui', 'illplistofobjectsgui'), 'userdetails');
370  $ilCtrl->setParameterByClass('illplistofobjectsgui', 'ref_id', $old["ref_id"]);
371  $ilCtrl->setParameterByClass('illplistofobjectsgui', 'details_id', $old["details_id"]);
372  $ilCtrl->setParameterByClass('illplistofobjectsgui', 'user_id', $old["user_id"]);
373  } else {
374  $url = "#";
375  }
376 
377  $this->tpl->setVariable("URL_TITLE", $url);
378  $this->tpl->setVariable("VAL_TITLE", $data["title"]);
379  $this->tpl->parseCurrentBlock();
380  } else {
381  $this->tpl->setCurrentBlock('title_plain');
382  $this->tpl->setVariable("VAL_TITLE", $data["title"]);
383  $this->tpl->parseCurrentBlock();
384  }
385 
386  // #16453 / #17163
387  if ($data['ref_id']) {
388  include_once './Services/Tree/classes/class.ilPathGUI.php';
389  $path = new ilPathGUI();
390  $path = $path->getPath($this->ref_id, $data['ref_id']);
391  if ($path) {
392  $this->tpl->setVariable('COLL_PATH', $this->lng->txt('path') . ': ' . $path);
393  }
394  }
395 
396  // #13807 / #17069
397  include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
398  if ($data["ref_id"] &&
399  ilLearningProgressAccess::checkPermission('edit_learning_progress', $data['ref_id'])) {
400  if (!in_array($data["type"], array("sco", "lobj")) && !$this->getPrintMode()) {
401  $this->tpl->setCurrentBlock("item_command");
402  $ilCtrl->setParameterByClass("illplistofobjectsgui", "userdetails_id", $data["ref_id"]);
403  $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass("illplistofobjectsgui", 'edituser'));
404  $this->tpl->setVariable("TXT_COMMAND", $lng->txt('edit'));
405  $ilCtrl->setParameterByClass("illplistofobjectsgui", "userdetails_id", "");
406  $this->tpl->parseCurrentBlock();
407  }
408  }
409  }
Creates a path for a start and endnode.
$path
Definition: aliased.php:25
const IL_CAL_DATETIME
static _getImagePathForStatus($a_status)
Get image path for status.
global $DIC
Definition: saml.php:7
$_GET["client_id"]
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
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.
global $ilCtrl
Definition: ilias.php:18
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)
$text
Definition: errorreport.php:18
Date and time handling
getSelectedColumns()
Get selected columns.
static img($a_src, $a_alt=null, $a_width="", $a_height="", $a_border=0, $a_id="", $a_class="")
Build img tag.
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 454 of file class.ilTrUserObjectsPropsTableGUI.php.

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

455  {
456  $a_csv->addColumn($this->lng->txt($a_set["type"]));
457  $a_csv->addColumn($a_set["title"]);
458 
459  foreach ($this->getSelectedColumns() as $c) {
460  if ($c != 'status') {
461  $val = $this->parseValue($c, $a_set[$c], $this->type);
462  } else {
463  $val = ilLearningProgressBaseGUI::_getStatusText((int) $a_set[$c]);
464  }
465  $a_csv->addColumn($val);
466  }
467 
468  $a_csv->addRow();
469  }
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 425 of file class.ilTrUserObjectsPropsTableGUI.php.

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

426  {
427  $a_excel->setCell($a_row, 0, $this->lng->txt($a_set["type"]));
428  $a_excel->setCell($a_row, 1, $a_set["title"]);
429 
430  $cnt = 2;
431  foreach ($this->getSelectedColumns() as $c) {
432  if ($c != 'status') {
433  $val = $this->parseValue($c, $a_set[$c], $this->type);
434  } else {
435  $val = ilLearningProgressBaseGUI::_getStatusText((int) $a_set[$c]);
436  }
437  $a_excel->setCell($a_row, $cnt++, $val);
438  }
439  }
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 135 of file class.ilTrUserObjectsPropsTableGUI.php.

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

Referenced by __construct().

136  {
137  global $DIC;
138 
139  $rbacsystem = $DIC['rbacsystem'];
140 
141  $this->determineOffsetAndOrder();
142 
143  $additional_fields = $this->getSelectedColumns();
144 
145  include_once("./Services/Tracking/classes/class.ilTrQuery.php");
146 
148  $this->user_id,
149  $this->obj_id,
150  $this->ref_id,
154  ilUtil::stripSlashes($this->getLimit()),
155  $this->filter,
156  $additional_fields,
157  $this->filter["view_mode"]
158  );
159 
160  if (count($tr_data["set"]) == 0 && $this->getOffset() > 0) {
161  $this->resetOffset();
163  $this->user_id,
164  $this->obj_id,
165  $this->ref_id,
169  ilUtil::stripSlashes($this->getLimit()),
170  $this->filter,
171  $additional_fields,
172  $this->filter["view_mode"]
173  );
174  }
175 
176  // #13807
177  foreach ($tr_data["set"] as $idx => $row) {
178  include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
179  if ($row["ref_id"] &&
180  !ilLearningProgressAccess::checkPermission('read_learning_progress', $row['ref_id'])) {
181  foreach (array_keys($row) as $col_id) {
182  if (!in_array($col_id, array("type", "obj_id", "ref_id", "title", "sort_title"))) {
183  $tr_data["set"][$idx][$col_id] = null;
184  }
185  }
186  $tr_data["set"][$idx]["privacy_conflict"] = true;
187  }
188  }
189 
190  $this->setMaxCount($tr_data["cnt"]);
191 
192  if ($this->getOrderField() == "title") {
193  // sort alphabetically, move parent object to 1st position
194  $set = array();
195  $parent = false;
196  foreach ($tr_data["set"] as $idx => $row) {
197  if ($row['obj_id'] == $this->obj_id) {
198  $parent = $row;
199  } elseif (isset($row["sort_title"])) {
200  $set[strtolower($row["sort_title"]) . "__" . $idx] = $row;
201  } else {
202  $set[strtolower($row["title"]) . "__" . $idx] = $row;
203  }
204  }
205  unset($tr_data["set"]);
206  if ($this->getOrderDirection() == "asc") {
207  ksort($set);
208  } else {
209  krsort($set);
210  }
211  $set = array_values($set);
212  if ($parent) {
213  array_unshift($set, $parent);
214  }
215 
216  $this->setData($set);
217  } else {
218  $this->setData($tr_data["set"]);
219  }
220  }
global $DIC
Definition: saml.php:7
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.
getSelectedColumns()
Get selected columns.
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
$row
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.
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 84 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().

85  {
86  global $DIC;
87 
88  $lng = $DIC['lng'];
89 
90  // default fields
91  $cols = array();
92 
93  include_once 'Services/Tracking/classes/class.ilObjUserTracking.php';
94  $tracking = new ilObjUserTracking();
95  if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS)) {
96  $cols["first_access"] = array(
97  "txt" => $lng->txt("trac_first_access"),
98  "default" => true);
99  $cols["last_access"] = array(
100  "txt" => $lng->txt("trac_last_access"),
101  "default" => true);
102  }
103  if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_READ_COUNT)) {
104  $cols["read_count"] = array(
105  "txt" => $lng->txt("trac_read_count"),
106  "default" => true);
107  }
108  if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS)) {
109  $cols["spent_seconds"] = array(
110  "txt" => $lng->txt("trac_spent_seconds"),
111  "default" => true);
112  }
113 
114  // #15334 - parent object does not matter, sub-objects may have percentage
115  $cols["percentage"] = array(
116  "txt" => $lng->txt("trac_percentage"),
117  "default" => true);
118 
119  $cols["status"] = array(
120  "txt" => $lng->txt("trac_status"),
121  "default" => true);
122  $cols["mark"] = array(
123  "txt" => $lng->txt("trac_mark"),
124  "default" => true);
125  $cols["u_comment"] = array(
126  "txt" => $lng->txt("trac_comment"),
127  "default" => false);
128 
129  return $cols;
130  }
global $DIC
Definition: saml.php:7
$cols
Definition: xhr_table.php:11
+ Here is the caller graph for this function:

◆ initFilter()

ilTrUserObjectsPropsTableGUI::initFilter ( )

Init filter.

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

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

Referenced by __construct().

226  {
227  global $DIC;
228 
229  $lng = $DIC['lng'];
230 
231  // for scorm and objectives this filter does not make sense / is not implemented
232  include_once './Services/Object/classes/class.ilObjectLP.php';
233  $olp = ilObjectLP::getInstance($this->obj_id);
234  $collection = $olp->getCollectionInstance();
235  if ($collection instanceof ilLPCollectionOfRepositoryObjects) {
236  include_once("./Services/Form/classes/class.ilSubEnabledFormPropertyGUI.php");
237  include_once("./Services/Table/interfaces/interface.ilTableFilterItem.php");
238 
239  // show collection only/all
240  include_once("./Services/Form/classes/class.ilRadioGroupInputGUI.php");
241  include_once("./Services/Form/classes/class.ilRadioOption.php");
242  $ti = new ilRadioGroupInputGUI($lng->txt("trac_view_mode"), "view_mode");
243  $ti->addOption(new ilRadioOption($lng->txt("trac_view_mode_all"), ""));
244  $ti->addOption(new ilRadioOption($lng->txt("trac_view_mode_collection"), "coll"));
245  $this->addFilterItem($ti);
246  $ti->readFromSession();
247  $this->filter["view_mode"] = $ti->getValue();
248  }
249  }
This class represents an option in a radio group.
global $DIC
Definition: saml.php:7
addFilterItem($a_input_item, $a_optional=false)
Add filter item.
This class represents a property in a property form.
addOption($a_option)
Add Option.
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: