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

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- Data Fields inherited from ilTable2GUI
const FILTER_TEXT = 1
 
const FILTER_SELECT = 2
 
const FILTER_DATE = 3
 
const FILTER_LANGUAGE = 4
 
const FILTER_NUMBER_RANGE = 5
 
const FILTER_DATE_RANGE = 6
 
const FILTER_DURATION_RANGE = 7
 
const FILTER_DATETIME_RANGE = 8
 
const FILTER_CHECKBOX = 9
 
const EXPORT_EXCEL = 1
 
const EXPORT_CSV = 2
 
const ACTION_ALL_LIMIT = 1000
 
- Data Fields inherited from ilTableGUI
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 
- 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
 
 $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$

@ilCtrl_Calls 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.

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

References $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().

+ Here is the call graph for this function:

Member Function Documentation

◆ fillHeaderCSV()

ilTrUserObjectsPropsTableGUI::fillHeaderCSV (   $a_csv)
protected

CSV Version of Fill Header.

Likely to be overwritten by derived class.

Parameters
object$a_csvcurrent file

Reimplemented from ilTable2GUI.

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

426 {
427 $a_csv->addColumn($this->lng->txt("type"));
428 $a_csv->addColumn($this->lng->txt("title"));
429
430 $labels = $this->getSelectableColumns();
431 foreach ($this->getSelectedColumns() as $c) {
432 $a_csv->addColumn($labels[$c]["txt"]);
433 }
434
435 $a_csv->addRow();
436 }

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

+ Here is the call graph for this function:

◆ fillHeaderExcel()

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

Excel Version of Fill Header.

Likely to be overwritten by derived class.

Parameters
ilExcel$a_excelexcel wrapper
int$a_rowrow counter

Reimplemented from ilTable2GUI.

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

396 {
397 $a_excel->setCell($a_row, 0, $this->lng->txt("type"));
398 $a_excel->setCell($a_row, 1, $this->lng->txt("title"));
399
400 $labels = $this->getSelectableColumns();
401 $cnt = 2;
402 foreach ($this->getSelectedColumns() as $c) {
403 $a_excel->setCell($a_row, $cnt++, $labels[$c]["txt"]);
404 }
405
406 $a_excel->setBold("A" . $a_row . ":" . $a_excel->getColumnCoord($cnt-1) . $a_row);
407 }
setCell($a_row, $a_col, $a_value, $a_datatype=null)
Set cell value.
setBold($a_coords)
Set cell(s) to bold.
getColumnCoord($a_col)
Get column "name" from number.

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

+ Here is the call graph for this function:

◆ fillRow()

ilTrUserObjectsPropsTableGUI::fillRow (   $data)
protected

Fill table row.

Reimplemented from ilTable2GUI.

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

243 {
244 global $ilCtrl, $lng, $rbacsystem;
245
246 if (!$this->isPercentageAvailable($data["obj_id"])) {
247 $data["percentage"] = null;
248 }
249
250 foreach ($this->getSelectedColumns() as $c) {
251 if (!$data["privacy_conflict"]) {
252 $val = (trim($data[$c]) == "")
253 ? " "
254 : $data[$c];
255
256 if ($data[$c] != "" || $c == "status") {
257 switch ($c) {
258 case "first_access":
260 break;
261
262 case "last_access":
264 break;
265
266 case "status":
267 include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
270 $val = ilUtil::img($path, $text);
271
272 if ($data["ref_id"] &&
273 $data["type"] != "lobj" &&
274 $data["type"] != "sco" &&
275 $data["type"] != "st" &&
276 $data["type"] != "mob") {
277 $timing = $this->showTimingsWarning($data["ref_id"], $this->user_id);
278 if ($timing) {
279 if ($timing !== true) {
280 $timing = ": " . ilDatePresentation::formatDate(new ilDate($timing, IL_CAL_UNIX));
281 } else {
282 $timing = "";
283 }
284 $this->tpl->setCurrentBlock('warning_img');
285 $this->tpl->setVariable('WARNING_IMG', ilUtil::getImagePath('time_warn.svg'));
286 $this->tpl->setVariable('WARNING_ALT', $this->lng->txt('trac_time_passed') . $timing);
287 $this->tpl->parseCurrentBlock();
288 }
289 }
290 break;
291
292 case "spent_seconds":
294 $val = "-";
295 } else {
296 $val = ilDatePresentation::secondsToString($data[$c], ($data[$c] < 3600 ? true : false)); // #14858
297 }
298 break;
299
300 case "percentage":
301 $val = $data[$c] . "%";
302 break;
303
304 }
305 }
306 if ($c == "mark" &&
307 !ilObjectLP::supportsMark($this->type)) {
308 $val = "-";
309 }
310 if ($c == "spent_seconds" &&
311 !ilObjectLP::supportsSpentSeconds($this->type)) {
312 $val = "-";
313 }
314 if ($c == "percentage" &&
315 !$this->isPercentageAvailable($data["obj_id"])) {
316 $val = "-";
317 }
318 } else {
319 $val = "&nbsp;";
320 }
321
322 $this->tpl->setCurrentBlock("user_field");
323 $this->tpl->setVariable("VAL_UF", $val);
324 $this->tpl->parseCurrentBlock();
325 }
326
327 if ($data["privacy_conflict"]) {
328 $this->tpl->setCurrentBlock("permission_bl");
329 $this->tpl->setVariable("TXT_NO_PERMISSION", $lng->txt("status_no_permission"));
330 $this->tpl->parseCurrentBlock();
331 }
332
333 if ($data["title"] == "") {
334 $data["title"] = "--" . $lng->txt("none") . "--";
335 }
336 $this->tpl->setVariable("ICON", ilObject::_getIcon("", "tiny", $data["type"]));
337 $this->tpl->setVariable("ICON_ALT", $lng->txt($data["type"]));
338
339 if (in_array($data['type'], array('fold', 'grp')) && $data['obj_id'] != $this->obj_id) {
340 if ($data['type'] == 'fold') {
341 $object_gui = 'ilobjfoldergui';
342 } else {
343 $object_gui = 'ilobjgroupgui';
344 }
345 $this->tpl->setCurrentBlock('title_linked');
346
347 // link structure gets too complicated
348 if ($_GET["baseClass"] != "ilPersonalDesktopGUI" && $_GET["baseClass"] != "ilAdministrationGUI") {
349 $old = $ilCtrl->getParameterArrayByClass('illplistofobjectsgui');
350 $ilCtrl->setParameterByClass('illplistofobjectsgui', 'ref_id', $data["ref_id"]);
351 $ilCtrl->setParameterByClass('illplistofobjectsgui', 'details_id', $data["ref_id"]);
352 $ilCtrl->setParameterByClass('illplistofobjectsgui', 'user_id', $this->user_id);
353 $url = $ilCtrl->getLinkTargetByClass(array('ilrepositorygui', $object_gui, 'illearningprogressgui', 'illplistofobjectsgui'), 'userdetails');
354 $ilCtrl->setParameterByClass('illplistofobjectsgui', 'ref_id', $old["ref_id"]);
355 $ilCtrl->setParameterByClass('illplistofobjectsgui', 'details_id', $old["details_id"]);
356 $ilCtrl->setParameterByClass('illplistofobjectsgui', 'user_id', $old["user_id"]);
357 } else {
358 $url = "#";
359 }
360
361 $this->tpl->setVariable("URL_TITLE", $url);
362 $this->tpl->setVariable("VAL_TITLE", $data["title"]);
363 $this->tpl->parseCurrentBlock();
364 } else {
365 $this->tpl->setCurrentBlock('title_plain');
366 $this->tpl->setVariable("VAL_TITLE", $data["title"]);
367 $this->tpl->parseCurrentBlock();
368 }
369
370 // #16453 / #17163
371 if ($data['ref_id']) {
372 include_once './Services/Tree/classes/class.ilPathGUI.php';
373 $path = new ilPathGUI();
374 $path = $path->getPath($this->ref_id, $data['ref_id']);
375 if ($path) {
376 $this->tpl->setVariable('COLL_PATH', $this->lng->txt('path') . ': ' . $path);
377 }
378 }
379
380 // #13807 / #17069
381 include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
382 if ($data["ref_id"] &&
383 ilLearningProgressAccess::checkPermission('edit_learning_progress', $data['ref_id'])) {
384 if (!in_array($data["type"], array("sco", "lobj")) && !$this->getPrintMode()) {
385 $this->tpl->setCurrentBlock("item_command");
386 $ilCtrl->setParameterByClass("illplistofobjectsgui", "userdetails_id", $data["ref_id"]);
387 $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass("illplistofobjectsgui", 'edituser'));
388 $this->tpl->setVariable("TXT_COMMAND", $lng->txt('edit'));
389 $ilCtrl->setParameterByClass("illplistofobjectsgui", "userdetails_id", "");
390 $this->tpl->parseCurrentBlock();
391 }
392 }
393 }
$_GET["client_id"]
const IL_CAL_UNIX
const IL_CAL_DATETIME
static secondsToString($seconds, $force_with_seconds=false, $a_lng=null)
converts seconds to string: Long: 7 days 4 hour(s) ...
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false)
Format a date @access public.
@classDescription Date and time handling
Class for single dates.
showTimingsWarning($a_ref_id, $a_user_id)
static checkPermission($a_permission, $a_ref_id, $a_user_id=null)
wrapper for rbac access checks
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
static _getImagePathForStatus($a_status)
Get image path for status.
static supportsMark($a_obj_type)
static supportsSpentSeconds($a_obj_type)
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.
static img($a_src, $a_alt="", $a_width="", $a_height="", $a_border=0, $a_id="", $a_class="")
Build img tag.
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
$url
$old
$text
Definition: errorreport.php:18

References $_GET, ilTableGUI\$data, $ilCtrl, ilTableGUI\$lng, $old, $path, $text, $url, ilObject\_getIcon(), 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().

+ Here is the call graph for this function:

◆ fillRowCSV()

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

CSV Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
object$a_csvcurrent file
array$a_setdata array

Reimplemented from ilTable2GUI.

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

439 {
440 $a_csv->addColumn($this->lng->txt($a_set["type"]));
441 $a_csv->addColumn($a_set["title"]);
442
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_csv->addColumn($val);
450 }
451
452 $a_csv->addRow();
453 }
parseValue($id, $value, $type)

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

+ Here is the call graph for this function:

◆ fillRowExcel()

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

Excel Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
ilExcel$a_excelexcel wrapper
int$a_rowrow counter
array$a_setdata array

Reimplemented from ilTable2GUI.

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

410 {
411 $a_excel->setCell($a_row, 0, $this->lng->txt($a_set["type"]));
412 $a_excel->setCell($a_row, 1, $a_set["title"]);
413
414 $cnt = 2;
415 foreach ($this->getSelectedColumns() as $c) {
416 if ($c != 'status') {
417 $val = $this->parseValue($c, $a_set[$c], $this->type);
418 } else {
419 $val = ilLearningProgressBaseGUI::_getStatusText((int) $a_set[$c]);
420 }
421 $a_excel->setCell($a_row, $cnt++, $val);
422 }
423 }

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

+ Here is the call graph for this function:

◆ getItems()

ilTrUserObjectsPropsTableGUI::getItems ( )

Get user items.

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

128 {
129 global $rbacsystem;
130
132
133 $additional_fields = $this->getSelectedColumns();
134
135 include_once("./Services/Tracking/classes/class.ilTrQuery.php");
136
138 $this->user_id,
139 $this->obj_id,
140 $this->ref_id,
145 $this->filter,
146 $additional_fields,
147 $this->filter["view_mode"]
148 );
149
150 if (count($tr_data["set"]) == 0 && $this->getOffset() > 0) {
151 $this->resetOffset();
153 $this->user_id,
154 $this->obj_id,
155 $this->ref_id,
160 $this->filter,
161 $additional_fields,
162 $this->filter["view_mode"]
163 );
164 }
165
166 // #13807
167 foreach ($tr_data["set"] as $idx => $row) {
168 include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
169 if ($row["ref_id"] &&
170 !ilLearningProgressAccess::checkPermission('read_learning_progress', $row['ref_id'])) {
171 foreach (array_keys($row) as $col_id) {
172 if (!in_array($col_id, array("type", "obj_id", "ref_id", "title", "sort_title"))) {
173 $tr_data["set"][$idx][$col_id] = null;
174 }
175 }
176 $tr_data["set"][$idx]["privacy_conflict"] = true;
177 }
178 }
179
180 $this->setMaxCount($tr_data["cnt"]);
181
182 if ($this->getOrderField() == "title") {
183 // sort alphabetically, move parent object to 1st position
184 $set = array();
185 $parent = false;
186 foreach ($tr_data["set"] as $idx => $row) {
187 if ($row['obj_id'] == $this->obj_id) {
188 $parent = $row;
189 } elseif (isset($row["sort_title"])) {
190 $set[strtolower($row["sort_title"]) . "__" . $idx] = $row;
191 } else {
192 $set[strtolower($row["title"]) . "__" . $idx] = $row;
193 }
194 }
195 unset($tr_data["set"]);
196 if ($this->getOrderDirection() == "asc") {
197 ksort($set);
198 } else {
199 krsort($set);
200 }
201 $set = array_values($set);
202 if ($parent) {
203 array_unshift($set, $parent);
204 }
205
206 $this->setData($set);
207 } else {
208 $this->setData($tr_data["set"]);
209 }
210 }
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
setData($a_data)
set table data @access public
getLimit()
Get limit.
resetOffset($a_in_determination=false)
Reset offset.
getOffset()
Get offset.
getOrderDirection()
Get order direction.
setMaxCount($a_max_count)
set max.
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.
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled

References $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().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSelectableColumns()

ilTrUserObjectsPropsTableGUI::getSelectableColumns ( )

Get selectable columns.

Parameters

return

Reimplemented from ilTable2GUI.

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

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

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

Referenced by fillHeaderCSV(), and fillHeaderExcel().

+ Here is the caller graph for this function:

◆ initFilter()

ilTrUserObjectsPropsTableGUI::initFilter ( )

Init filter.

Reimplemented from ilTable2GUI.

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

216 {
217 global $lng;
218
219 // for scorm and objectives this filter does not make sense / is not implemented
220 include_once './Services/Object/classes/class.ilObjectLP.php';
221 $olp = ilObjectLP::getInstance($this->obj_id);
222 $collection = $olp->getCollectionInstance();
223 if ($collection instanceof ilLPCollectionOfRepositoryObjects) {
224 include_once("./Services/Form/classes/class.ilSubEnabledFormPropertyGUI.php");
225 include_once("./Services/Table/interfaces/interface.ilTableFilterItem.php");
226
227 // show collection only/all
228 include_once("./Services/Form/classes/class.ilRadioGroupInputGUI.php");
229 include_once("./Services/Form/classes/class.ilRadioOption.php");
230 $ti = new ilRadioGroupInputGUI($lng->txt("trac_view_mode"), "view_mode");
231 $ti->addOption(new ilRadioOption($lng->txt("trac_view_mode_all"), ""));
232 $ti->addOption(new ilRadioOption($lng->txt("trac_view_mode_collection"), "coll"));
233 $this->addFilterItem($ti);
234 $ti->readFromSession();
235 $this->filter["view_mode"] = $ti->getValue();
236 }
237 }
static getInstance($a_obj_id)
This class represents a property in a property form.
This class represents an option in a radio group.
addFilterItem($a_input_item, $a_optional=false)
Add filter item.

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

Referenced by __construct().

+ 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: