ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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="")
 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...
 
 initFilter ($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="")
 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...
 
 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
 ilTableGUI ($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 ($worksheet, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel ($worksheet, &$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 ($worksheet, &$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)
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. 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 ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel ($a_worksheet, &$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 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
 $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 = null
 
 $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
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

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 {
36 $this->setPrintMode(true);
37 }
38
39 $this->addColumn($this->lng->txt("title"), "title");
40
41 foreach ($this->getSelectedColumns() as $c)
42 {
43 $l = $c;
44 if (in_array($l, array("last_access", "first_access", "read_count", "spent_seconds", "mark", "status", "percentage")))
45 {
46 $l = "trac_".$l;
47 }
48 if ($l == "u_comment")
49 {
50 $l = "trac_comment";
51 }
52 $this->addColumn($this->lng->txt($l), $c);
53 }
54
55 if(!$this->getPrintMode())
56 {
57 $this->addColumn($this->lng->txt("actions"), "");
58 }
59
60 $this->setExternalSorting(true);
61 $this->setExternalSegmentation(true);
62 $this->setEnableHeader(true);
63 $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
64 $this->setRowTemplate("tpl.user_objects_props_row.html", "Services/Tracking");
65 $this->setEnableTitle(true);
66 $this->setDefaultOrderField("title");
67 $this->setDefaultOrderDirection("asc");
68 $this->setShowTemplates(true);
69
70 $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
71
72 $this->initFilter();
73
74 $this->getItems();
75 }
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.
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.
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.
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
global $lng
Definition: privfeed.php:40

References $ilCtrl, $l, $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 489 of file class.ilTrUserObjectsPropsTableGUI.php.

490 {
491 $a_csv->addColumn($this->lng->txt("type"));
492 $a_csv->addColumn($this->lng->txt("title"));
493
494 $labels = $this->getSelectableColumns();
495 foreach ($this->getSelectedColumns() as $c)
496 {
497 $a_csv->addColumn($labels[$c]["txt"]);
498 }
499
500 $a_csv->addRow();
501 }

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

+ Here is the call graph for this function:

◆ fillHeaderExcel()

ilTrUserObjectsPropsTableGUI::fillHeaderExcel (   $worksheet,
$a_row 
)
protected

Excel Version of Fill Header.

Likely to be overwritten by derived class.

Parameters
object$a_worksheetcurrent sheet
int$a_rowrow counter

Reimplemented from ilTable2GUI.

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

455 {
456 $worksheet->write($a_row, 0, $this->lng->txt("type"));
457 $worksheet->write($a_row, 1, $this->lng->txt("title"));
458
459 $labels = $this->getSelectableColumns();
460 $cnt = 2;
461 foreach ($this->getSelectedColumns() as $c)
462 {
463 $worksheet->write($a_row, $cnt, $labels[$c]["txt"]);
464 $cnt++;
465 }
466 }

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

+ Here is the call graph for this function:

◆ fillRow()

ilTrUserObjectsPropsTableGUI::fillRow (   $data)
protected

Fill table row.

Reimplemented from ilTable2GUI.

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

268 {
269 global $ilCtrl, $lng, $rbacsystem;
270
271 if(!$this->isPercentageAvailable($data["obj_id"]))
272 {
273 $data["percentage"] = NULL;
274 }
275
276 foreach ($this->getSelectedColumns() as $c)
277 {
278 if(!$data["privacy_conflict"])
279 {
280 $val = (trim($data[$c]) == "")
281 ? " "
282 : $data[$c];
283
284 if ($data[$c] != "" || $c == "status")
285 {
286 switch ($c)
287 {
288 case "first_access":
290 break;
291
292 case "last_access":
294 break;
295
296 case "status":
297 include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
300 $val = ilUtil::img($path, $text);
301
302 if($data["ref_id"] &&
303 $data["type"] != "lobj" &&
304 $data["type"] != "sco" &&
305 $data["type"] != "st" &&
306 $data["type"] != "mob")
307 {
308 $timing = $this->showTimingsWarning($data["ref_id"], $this->user_id);
309 if($timing)
310 {
311 if($timing !== true)
312 {
313 $timing = ": ".ilDatePresentation::formatDate(new ilDate($timing, IL_CAL_UNIX));
314 }
315 else
316 {
317 $timing = "";
318 }
319 $this->tpl->setCurrentBlock('warning_img');
320 $this->tpl->setVariable('WARNING_IMG', ilUtil::getImagePath('time_warn.svg'));
321 $this->tpl->setVariable('WARNING_ALT', $this->lng->txt('trac_time_passed').$timing);
322 $this->tpl->parseCurrentBlock();
323 }
324 }
325 break;
326
327 case "spent_seconds":
329 {
330 $val = "-";
331 }
332 else
333 {
334 include_once("./Services/Utilities/classes/class.ilFormat.php");
335 $val = ilFormat::_secondsToString($data[$c], ($data[$c] < 3600 ? true : false)); // #14858
336 }
337 break;
338
339 case "percentage":
340 $val = $data[$c]."%";
341 break;
342
343 }
344 }
345 if ($c == "mark" &&
346 !ilObjectLP::supportsMark($this->type))
347 {
348 $val = "-";
349 }
350 if ($c == "spent_seconds" &&
352 {
353 $val = "-";
354 }
355 if ($c == "percentage" &&
356 !$this->isPercentageAvailable($data["obj_id"]))
357 {
358 $val = "-";
359 }
360 }
361 else
362 {
363 $val = "&nbsp;";
364 }
365
366 $this->tpl->setCurrentBlock("user_field");
367 $this->tpl->setVariable("VAL_UF", $val);
368 $this->tpl->parseCurrentBlock();
369 }
370
371 if($data["privacy_conflict"])
372 {
373 $this->tpl->setCurrentBlock("permission_bl");
374 $this->tpl->setVariable("TXT_NO_PERMISSION", $lng->txt("status_no_permission"));
375 $this->tpl->parseCurrentBlock();
376 }
377
378 if($data["title"] == "")
379 {
380 $data["title"] = "--".$lng->txt("none")."--";
381 }
382 $this->tpl->setVariable("ICON",ilObject::_getIcon("", "tiny", $data["type"]));
383 $this->tpl->setVariable("ICON_ALT", $lng->txt($data["type"]));
384
385 if(in_array($data['type'], array('fold', 'grp')) && $data['obj_id'] != $this->obj_id)
386 {
387 if($data['type'] == 'fold')
388 {
389 $object_gui = 'ilobjfoldergui';
390 }
391 else
392 {
393 $object_gui = 'ilobjgroupgui';
394 }
395 $this->tpl->setCurrentBlock('title_linked');
396
397 // link structure gets too complicated
398 if($_GET["baseClass"] != "ilPersonalDesktopGUI" && $_GET["baseClass"] != "ilAdministrationGUI")
399 {
400 $old = $ilCtrl->getParameterArrayByClass('illplistofobjectsgui');
401 $ilCtrl->setParameterByClass('illplistofobjectsgui', 'ref_id', $data["ref_id"]);
402 $ilCtrl->setParameterByClass('illplistofobjectsgui', 'details_id', $data["ref_id"]);
403 $ilCtrl->setParameterByClass('illplistofobjectsgui', 'user_id', $this->user_id);
404 $url = $ilCtrl->getLinkTargetByClass(array('ilrepositorygui', $object_gui, 'illearningprogressgui', 'illplistofobjectsgui'), 'userdetails');
405 $ilCtrl->setParameterByClass('illplistofobjectsgui', 'ref_id', $old["ref_id"]);
406 $ilCtrl->setParameterByClass('illplistofobjectsgui', 'details_id', $old["details_id"]);
407 $ilCtrl->setParameterByClass('illplistofobjectsgui', 'user_id', $old["user_id"]);
408 }
409 else
410 {
411 $url = "#";
412 }
413
414 $this->tpl->setVariable("URL_TITLE", $url);
415 $this->tpl->setVariable("VAL_TITLE", $data["title"]);
416 $this->tpl->parseCurrentBlock();
417 }
418 else
419 {
420 $this->tpl->setCurrentBlock('title_plain');
421 $this->tpl->setVariable("VAL_TITLE", $data["title"]);
422 $this->tpl->parseCurrentBlock();
423 }
424
425 // #16453 / #17163
426 if($data['ref_id'])
427 {
428 include_once './Services/Tree/classes/class.ilPathGUI.php';
429 $path = new ilPathGUI();
430 $path = $path->getPath($this->ref_id, $data['ref_id']);
431 if($path)
432 {
433 $this->tpl->setVariable('COLL_PATH', $this->lng->txt('path').': '.$path);
434 }
435 }
436
437 // #13807 / #17069
438 include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
439 if($data["ref_id"] &&
440 ilLearningProgressAccess::checkPermission('edit_learning_progress', $data['ref_id']))
441 {
442 if(!in_array($data["type"], array("sco", "lobj")) && !$this->getPrintMode())
443 {
444 $this->tpl->setCurrentBlock("item_command");
445 $ilCtrl->setParameterByClass("illplistofobjectsgui", "userdetails_id", $data["ref_id"]);
446 $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass("illplistofobjectsgui", 'edituser'));
447 $this->tpl->setVariable("TXT_COMMAND", $lng->txt('edit'));
448 $ilCtrl->setParameterByClass("illplistofobjectsgui", "userdetails_id", "");
449 $this->tpl->parseCurrentBlock();
450 }
451 }
452 }
$_GET["client_id"]
const IL_CAL_UNIX
const IL_CAL_DATETIME
static formatDate(ilDateTime $date)
Format a date @access public.
@classDescription Date and time handling
Class for single dates.
_secondsToString($seconds, $force_with_seconds=false, $a_lng=null)
converts seconds to string: Long: 7 days 4 hour(s) ...
showTimingsWarning($a_ref_id, $a_user_id)
static checkPermission($a_permission, $a_ref_id, $a_user_id=null)
wrapper for rbac access checks
_getImagePathForStatus($a_status)
Get image path for status.
_getStatusText($a_status, $a_lng=null)
Get status alt text.
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)
$text
$url
Definition: shib_logout.php:72
$path
Definition: index.php:22

References $_GET, ilTableGUI\$data, $ilCtrl, $lng, $path, $text, $url, ilObject\_getIcon(), ilLearningProgressBaseGUI\_getImagePathForStatus(), ilLearningProgressBaseGUI\_getStatusText(), ilFormat\_secondsToString(), ilLearningProgressAccess\checkPermission(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilTable2GUI\getPrintMode(), ilTable2GUI\getSelectedColumns(), IL_CAL_DATETIME, IL_CAL_UNIX, ilUtil\img(), ilLPTableBaseGUI\isPercentageAvailable(), 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 503 of file class.ilTrUserObjectsPropsTableGUI.php.

504 {
505 $a_csv->addColumn($this->lng->txt($a_set["type"]));
506 $a_csv->addColumn($a_set["title"]);
507
508 foreach ($this->getSelectedColumns() as $c)
509 {
510 if($c != 'status')
511 {
512 $val = $this->parseValue($c, $a_set[$c], $this->type);
513 }
514 else
515 {
516 $val = ilLearningProgressBaseGUI::_getStatusText((int)$a_set[$c]);
517 }
518 $a_csv->addColumn($val);
519 }
520
521 $a_csv->addRow();
522 }
parseValue($id, $value, $type)

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

+ Here is the call graph for this function:

◆ fillRowExcel()

ilTrUserObjectsPropsTableGUI::fillRowExcel (   $a_worksheet,
$a_row,
  $a_set 
)
protected

Excel Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
object$a_worksheetcurrent sheet
int$a_rowrow counter
array$a_setdata array

Reimplemented from ilTable2GUI.

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

469 {
470 $worksheet->write($a_row, 0, $this->lng->txt($a_set["type"]));
471 $worksheet->write($a_row, 1, $a_set["title"]);
472
473 $cnt = 2;
474 foreach ($this->getSelectedColumns() as $c)
475 {
476 if($c != 'status')
477 {
478 $val = $this->parseValue($c, $a_set[$c], $this->type);
479 }
480 else
481 {
482 $val = ilLearningProgressBaseGUI::_getStatusText((int)$a_set[$c]);
483 }
484 $worksheet->write($a_row, $cnt, $val);
485 $cnt++;
486 }
487 }

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

+ Here is the call graph for this function:

◆ getItems()

ilTrUserObjectsPropsTableGUI::getItems ( )

Get user items.

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

136 {
137 global $rbacsystem;
138
140
141 $additional_fields = $this->getSelectedColumns();
142
143 include_once("./Services/Tracking/classes/class.ilTrQuery.php");
144
146 $this->user_id,
147 $this->obj_id,
148 $this->ref_id,
153 $this->filter,
154 $additional_fields,
155 $this->filter["view_mode"]);
156
157 if (count($tr_data["set"]) == 0 && $this->getOffset() > 0)
158 {
159 $this->resetOffset();
161 $this->user_id,
162 $this->obj_id,
163 $this->ref_id,
168 $this->filter,
169 $additional_fields,
170 $this->filter["view_mode"]);
171 }
172
173 // #13807
174 foreach($tr_data["set"] as $idx => $row)
175 {
176 include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
177 if($row["ref_id"] &&
178 !ilLearningProgressAccess::checkPermission('read_learning_progress', $row['ref_id']))
179 {
180 foreach(array_keys($row) as $col_id)
181 {
182 if(!in_array($col_id, array("type", "obj_id", "ref_id", "title", "sort_title")))
183 {
184 $tr_data["set"][$idx][$col_id] = null;
185 }
186 }
187 $tr_data["set"][$idx]["privacy_conflict"] = true;
188 }
189 }
190
191 $this->setMaxCount($tr_data["cnt"]);
192
193 if($this->getOrderField() == "title")
194 {
195 // sort alphabetically, move parent object to 1st position
196 $set = array();
197 $parent = false;
198 foreach($tr_data["set"] as $idx => $row)
199 {
200 if($row['obj_id'] == $this->obj_id)
201 {
202 $parent = $row;
203 }
204 else if(isset($row["sort_title"]))
205 {
206 $set[strtolower($row["sort_title"])."__".$idx] = $row;
207 }
208 else
209 {
210 $set[strtolower($row["title"])."__".$idx] = $row;
211 }
212 }
213 unset($tr_data["set"]);
214 if($this->getOrderDirection() == "asc")
215 {
216 ksort($set);
217 }
218 else
219 {
220 krsort($set);
221 }
222 $set = array_values($set);
223 if($parent)
224 {
225 array_unshift($set, $parent);
226 }
227
228 $this->setData($set);
229 }
230 else
231 {
232 $this->setData($tr_data["set"]);
233 }
234 }
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 83 of file class.ilTrUserObjectsPropsTableGUI.php.

84 {
85 global $lng;
86
87 // default fields
88 $cols = array();
89
90 include_once 'Services/Tracking/classes/class.ilObjUserTracking.php';
91 $tracking = new ilObjUserTracking();
92 if($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS))
93 {
94 $cols["first_access"] = array(
95 "txt" => $lng->txt("trac_first_access"),
96 "default" => true);
97 $cols["last_access"] = array(
98 "txt" => $lng->txt("trac_last_access"),
99 "default" => true);
100 }
101 if($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_READ_COUNT))
102 {
103 $cols["read_count"] = array(
104 "txt" => $lng->txt("trac_read_count"),
105 "default" => true);
106 }
107 if($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS))
108 {
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 }

References $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 239 of file class.ilTrUserObjectsPropsTableGUI.php.

240 {
241 global $lng;
242
243 // for scorm and objectives this filter does not make sense / is not implemented
244 include_once './Services/Object/classes/class.ilObjectLP.php';
245 $olp = ilObjectLP::getInstance($this->obj_id);
246 $collection = $olp->getCollectionInstance();
247 if($collection instanceof ilLPCollectionOfRepositoryObjects)
248 {
249 include_once("./Services/Form/classes/class.ilSubEnabledFormPropertyGUI.php");
250 include_once("./Services/Table/interfaces/interface.ilTableFilterItem.php");
251
252 // show collection only/all
253 include_once("./Services/Form/classes/class.ilRadioGroupInputGUI.php");
254 include_once("./Services/Form/classes/class.ilRadioOption.php");
255 $ti = new ilRadioGroupInputGUI($lng->txt("trac_view_mode"), "view_mode");
256 $ti->addOption(new ilRadioOption($lng->txt("trac_view_mode_all"), ""));
257 $ti->addOption(new ilRadioOption($lng->txt("trac_view_mode_collection"), "coll"));
258 $this->addFilterItem($ti);
259 $ti->readFromSession();
260 $this->filter["view_mode"] = $ti->getValue();
261 }
262 }
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 $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: