ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilTrObjectUsersPropsTableGUI Class Reference

Learning progress table: One object, rows: users, columns: properties Example: A course, rows: members, columns: name, status, mark, ... More...

+ Inheritance diagram for ilTrObjectUsersPropsTableGUI:
+ Collaboration diagram for ilTrObjectUsersPropsTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $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="")
 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)
 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...
 

Protected Attributes

 $user_fields
 
 $filter
 
 $in_course
 
 $in_group
 
 $has_edit
 
 $has_collection
 
 $has_multi
 
- 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
 
 $default_filter_visibility = false
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

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
 

Detailed Description

Learning progress table: One object, rows: users, columns: properties Example: A course, rows: members, columns: name, status, mark, ...

PD, Personal Learning Progress -> UserObjectsProps PD, Learning Progress of Users -> UserAggObjectsProps Crs, Learnign Progress of Participants -> ObjectUsersProps Details -> UserObjectsProps

More: PropUsersObjects (Grading Overview in Course)

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

ilTrObjectUsersPropsTableGUI: ilFormPropertyDispatchGUI

Definition at line 23 of file class.ilTrObjectUsersPropsTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Definition at line 36 of file class.ilTrObjectUsersPropsTableGUI.php.

References $ilCtrl, $ilUser, ilObject\_lookupObjId(), ilObject\_lookupType(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), array, ilLearningProgressAccess\checkPermission(), getItems(), ilTable2GUI\getPrintMode(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), initFilter(), ilLPTableBaseGUI\parseTitle(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExportFormats(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setPrintMode(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setShowTemplates().

37  {
38  global $ilCtrl, $ilUser, $tree, $rbacsystem;
39 
40  $this->setId("troup");
41  $this->obj_id = $a_obj_id;
42  $this->ref_id = $a_ref_id;
43  $this->type = ilObject::_lookupType($a_obj_id);
44 
45  $this->in_group = $tree->checkForParentType($this->ref_id, "grp");
46  if($this->in_group)
47  {
48  $this->in_group = ilObject::_lookupObjId($this->in_group);
49  }
50  else
51  {
52  $this->in_course = $tree->checkForParentType($this->ref_id, "crs");
53  if($this->in_course)
54  {
55  $this->in_course = ilObject::_lookupObjId($this->in_course);
56  }
57  }
58 
59  parent::__construct($a_parent_obj, $a_parent_cmd);
60 
61  $this->parseTitle($a_obj_id, "trac_participants");
62 
63  if($a_print_view)
64  {
65  $this->setPrintMode(true);
66  }
67 
68  if(!$this->getPrintMode())
69  {
70  // see ilObjCourseGUI::addMailToMemberButton()
71  include_once "Services/Mail/classes/class.ilMail.php";
72  $mail = new ilMail($ilUser->getId());
73  if($rbacsystem->checkAccess("internal_mail", $mail->getMailObjectReferenceId()))
74  {
75  $this->addMultiCommand("mailselectedusers", $this->lng->txt("send_mail"));
76  }
77  $this->lng->loadLanguageModule('user');
78  $this->addMultiCommand(
79  'addToClipboard',
80  $this->lng->txt('clipboard_add_btn')
81  );
82  $this->addColumn("", "", 1);
83  $this->has_multi = true;
84  }
85 
86  $labels = $this->getSelectableColumns();
87  foreach ($this->getSelectedColumns() as $c)
88  {
89  $first = $c;
90 
91  // list cannot be sorted by udf fields (separate query)
92  // because of pagination only core fields can be sorted
93  $sort_id = (substr($c, 0, 4) == "udf_") ? "" : $c;
94 
95  $this->addColumn($labels[$c]["txt"], $sort_id);
96  }
97 
98  if(!$this->getPrintMode())
99  {
100  $this->addColumn($this->lng->txt("actions"), "");
101  }
102  $this->setSelectAllCheckbox('uid');
103  $this->setExternalSorting(true);
104  $this->setExternalSegmentation(true);
105  $this->setEnableHeader(true);
106  $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
107  $this->setRowTemplate("tpl.object_users_props_row.html", "Services/Tracking");
108  $this->setEnableTitle(true);
109  $this->setShowTemplates(true);
110  $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
111 
112  if($first)
113  {
114  $this->setDefaultOrderField($first);
115  $this->setDefaultOrderDirection("asc");
116  }
117 
118  $this->initFilter();
119 
120  $this->getItems();
121 
122  // #13807
123  include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
124  $this->has_edit = ilLearningProgressAccess::checkPermission('edit_learning_progress', $this->ref_id);
125 
126  /* currently not active, needs to be revised
127  include_once "Services/Object/classes/class.ilObjectLP.php";
128  include_once "Services/Tracking/classes/collection/class.ilLPCollection.php";
129  $objlp = ilObjectLP::getInstance($this->obj_id);
130  $this->has_collection = in_array($objlp->getCurrentMode(), ilLPCollection::getCollectionModes());
131  */
132  }
setExternalSorting($a_val)
Set external sorting.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
setExportFormats(array $formats)
Set available export formats.
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)
static checkPermission($a_permission, $a_ref_id, $a_user_id=null)
wrapper for rbac access checks
setId($a_val)
Set id.
global $ilCtrl
Definition: ilias.php:18
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
This class handles base functions for mail handling.
static _lookupObjId($a_id)
addMultiCommand($a_cmd, $a_text)
Add Command button.
$ilUser
Definition: imgupload.php:18
getSelectedColumns()
Get selected columns.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
Create styles array
The data for the language used.
static _lookupType($a_id, $a_reference=false)
lookup object type
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
getPrintMode()
Get print mode.
setEnableHeader($a_enableheader)
Set Enable Header.
setSelectAllCheckbox($a_select_all_checkbox)
Set the name of the checkbox that should be toggled with a select all button.
setEnableTitle($a_enabletitle)
Set Enable Title.
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.
+ Here is the call graph for this function:

Member Function Documentation

◆ fillHeaderCSV()

ilTrObjectUsersPropsTableGUI::fillHeaderCSV (   $a_csv)
protected

Definition at line 447 of file class.ilTrObjectUsersPropsTableGUI.php.

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

448  {
449  $labels = $this->getSelectableColumns();
450  foreach ($this->getSelectedColumns() as $c)
451  {
452  $a_csv->addColumn($labels[$c]["txt"]);
453  }
454 
455  $a_csv->addRow();
456  }
getSelectedColumns()
Get selected columns.
+ Here is the call graph for this function:

◆ fillHeaderExcel()

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

Definition at line 418 of file class.ilTrObjectUsersPropsTableGUI.php.

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

419  {
420  $labels = $this->getSelectableColumns();
421  $cnt = 0;
422  foreach ($this->getSelectedColumns() as $c)
423  {
424  $a_excel->setCell($a_row, $cnt++, $labels[$c]["txt"]);
425  }
426 
427  $a_excel->setBold("A".$a_row.":".$a_excel->getColumnCoord($cnt-1).$a_row);
428  }
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)
Set cell value.
+ Here is the call graph for this function:

◆ fillRow()

ilTrObjectUsersPropsTableGUI::fillRow (   $data)
protected

Fill table row.

Definition at line 332 of file class.ilTrObjectUsersPropsTableGUI.php.

References ilTableGUI\$data, $ilCtrl, $lng, ilUtil\getImagePath(), ilTable2GUI\getPrintMode(), ilTable2GUI\getSelectedColumns(), IL_CAL_UNIX, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPTableBaseGUI\parseValue(), and ilLPTableBaseGUI\showTimingsWarning().

333  {
334  global $ilCtrl, $lng, $objDefinition;
335 
336  if($this->has_multi)
337  {
338  $this->tpl->setVariable("USER_ID", $data["usr_id"]);
339  }
340 
341  foreach ($this->getSelectedColumns() as $c)
342  {
343  if(!(bool)$data["privacy_conflict"])
344  {
345  if($c == 'status' && $data[$c] != ilLPStatus::LP_STATUS_COMPLETED_NUM)
346  {
347  $timing = $this->showTimingsWarning($this->ref_id, $data["usr_id"]);
348  if($timing)
349  {
350  if($timing !== true)
351  {
352  $timing = ": ".ilDatePresentation::formatDate(new ilDate($timing, IL_CAL_UNIX));
353  }
354  else
355  {
356  $timing = "";
357  }
358  $this->tpl->setCurrentBlock('warning_img');
359  $this->tpl->setVariable('WARNING_IMG', ilUtil::getImagePath('time_warn.svg'));
360  $this->tpl->setVariable('WARNING_ALT', $this->lng->txt('trac_time_passed').$timing);
361  $this->tpl->parseCurrentBlock();
362  }
363  }
364 
365  // #7694
366  if($c == 'login' && !$data["active"])
367  {
368  $this->tpl->setCurrentBlock('inactive_bl');
369  $this->tpl->setVariable('TXT_INACTIVE', $lng->txt("inactive"));
370  $this->tpl->parseCurrentBlock();
371  }
372 
373  $val = $this->parseValue($c, $data[$c], $this->type);
374  }
375  else
376  {
377  if($c == 'login')
378  {
379  $this->tpl->setCurrentBlock('inactive_bl');
380  $this->tpl->setVariable('TXT_INACTIVE', $lng->txt("status_no_permission"));
381  $this->tpl->parseCurrentBlock();
382  }
383 
384  $val = " ";
385  }
386 
387  $this->tpl->setCurrentBlock("user_field");
388  $this->tpl->setVariable("VAL_UF", $val);
389  $this->tpl->parseCurrentBlock();
390  }
391 
392  $ilCtrl->setParameterByClass("illplistofobjectsgui", "user_id", $data["usr_id"]);
393 
394  if(!$this->getPrintMode() && !(bool)$data["privacy_conflict"])
395  {
396  // details for containers and collections
397  if($this->has_collection ||
398  $objDefinition->isContainer($this->type))
399  {
400  $this->tpl->setCurrentBlock("item_command");
401  $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass("illplistofobjectsgui", "userdetails"));
402  $this->tpl->setVariable("TXT_COMMAND", $lng->txt('details'));
403  $this->tpl->parseCurrentBlock();
404  }
405 
406  if($this->has_edit)
407  {
408  $this->tpl->setCurrentBlock("item_command");
409  $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass("illplistofobjectsgui", "edituser"));
410  $this->tpl->setVariable("TXT_COMMAND", $lng->txt('edit'));
411  $this->tpl->parseCurrentBlock();
412  }
413  }
414 
415  $ilCtrl->setParameterByClass("illplistofobjectsgui", 'user_id', '');
416  }
const LP_STATUS_COMPLETED_NUM
const IL_CAL_UNIX
parseValue($id, $value, $type)
global $ilCtrl
Definition: ilias.php:18
Class for single dates.
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
getSelectedColumns()
Get selected columns.
global $lng
Definition: privfeed.php:17
showTimingsWarning($a_ref_id, $a_user_id)
getPrintMode()
Get print mode.
+ Here is the call graph for this function:

◆ fillRowCSV()

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

Definition at line 458 of file class.ilTrObjectUsersPropsTableGUI.php.

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

459  {
460  foreach ($this->getSelectedColumns() as $c)
461  {
462  if($c != 'status')
463  {
464  $val = $this->parseValue($c, $a_set[$c], $this->type);
465  }
466  else
467  {
468  $val = ilLearningProgressBaseGUI::_getStatusText((int)$a_set[$c]);
469  }
470  $a_csv->addColumn($val);
471  }
472 
473  $a_csv->addRow();
474  }
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()

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

Definition at line 430 of file class.ilTrObjectUsersPropsTableGUI.php.

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

431  {
432  $cnt = 0;
433  foreach ($this->getSelectedColumns() as $c)
434  {
435  if($c != 'status')
436  {
437  $val = $this->parseValue($c, $a_set[$c], $this->type);
438  }
439  else
440  {
441  $val = ilLearningProgressBaseGUI::_getStatusText((int)$a_set[$c]);
442  }
443  $a_excel->setCell($a_row, $cnt++, $val);
444  }
445  }
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)
Set cell value.
+ Here is the call graph for this function:

◆ getItems()

ilTrObjectUsersPropsTableGUI::getItems ( )

Get user items.

Definition at line 157 of file class.ilTrObjectUsersPropsTableGUI.php.

References $in_course, $in_group, $lng, ilPrivacySettings\_getInstance(), ilTable2GUI\determineOffsetAndOrder(), ilLPTableBaseGUI\getCurrentFilter(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\getSelectedColumns(), ilTrQuery\getUserDataForObject(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), and ilUtil\stripSlashes().

Referenced by __construct().

158  {
159  global $lng;
160 
161  $this->determineOffsetAndOrder();
162 
163  include_once("./Services/Tracking/classes/class.ilTrQuery.php");
164 
165  $additional_fields = $this->getSelectedColumns();
166 
167  // only if object is [part of] course/group
168  $check_agreement = false;
169  if($this->in_course)
170  {
171  // privacy (if course agreement is activated)
172  include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
173  $privacy = ilPrivacySettings::_getInstance();
174  if($privacy->courseConfirmationRequired())
175  {
176  $check_agreement = $this->in_course;
177  }
178  }
179  else if($this->in_group)
180  {
181  // privacy (if group agreement is activated)
182  include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
183  $privacy = ilPrivacySettings::_getInstance();
184  if($privacy->groupConfirmationRequired())
185  {
186  $check_agreement = $this->in_group;
187  }
188  }
189 
191  $this->ref_id,
195  ilUtil::stripSlashes($this->getLimit()),
196  $this->getCurrentFilter(),
197  $additional_fields,
198  $check_agreement,
199  $this->user_fields
200  );
201 
202  if (count($tr_data["set"]) == 0 && $this->getOffset() > 0)
203  {
204  $this->resetOffset();
206  $this->ref_id,
210  ilUtil::stripSlashes($this->getLimit()),
211  $this->getCurrentFilter(),
212  $additional_fields,
213  $check_agreement,
214  $this->user_fields
215  );
216  }
217 
218  $this->setMaxCount($tr_data["cnt"]);
219  $this->setData($tr_data["set"]);
220  }
resetOffset($a_in_determination=false)
Reset offset.
getOrderDirection()
Get order direction.
getOffset()
Get offset.
getSelectedColumns()
Get selected columns.
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
static getUserDataForObject($a_ref_id, $a_order_field="", $a_order_dir="", $a_offset=0, $a_limit=9999, array $a_filters=NULL, array $a_additional_fields=NULL, $check_agreement=false, $privacy_fields=NULL)
Get all user-based tracking data for object.
global $lng
Definition: privfeed.php:17
getLimit()
Get limit.
static _getInstance()
Get instance of ilPrivacySettings.
setMaxCount($a_max_count)
set max.
getCurrentFilter($as_query=false)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSelectableColumns()

ilTrObjectUsersPropsTableGUI::getSelectableColumns ( )

Get selectable columns.

Parameters

Definition at line 140 of file class.ilTrObjectUsersPropsTableGUI.php.

References ilTable2GUI\$selectable_columns, and ilLPTableBaseGUI\getSelectableUserColumns().

Referenced by __construct(), fillHeaderCSV(), fillHeaderExcel(), and initFilter().

141  {
142  if($this->selectable_columns)
143  {
145  }
146 
147  $cols = $this->getSelectableUserColumns($this->in_course, $this->in_group);
148  $this->user_fields = $cols[1];
149  $this->selectable_columns = $cols[0];
150 
152  }
getSelectableUserColumns($a_in_course=false, $a_in_group=false)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initFilter()

ilTrObjectUsersPropsTableGUI::initFilter ( )

Init filter.

Definition at line 226 of file class.ilTrObjectUsersPropsTableGUI.php.

References $column, $lng, $options, ilTable2GUI\addFilterItemByMetaType(), array, ilTable2GUI\FILTER_DATE_RANGE, ilTable2GUI\FILTER_DATETIME_RANGE, ilTable2GUI\FILTER_DURATION_RANGE, ilTable2GUI\FILTER_LANGUAGE, ilTable2GUI\FILTER_NUMBER_RANGE, ilTable2GUI\FILTER_SELECT, ilTable2GUI\FILTER_TEXT, ilCountry\getCountryCodes(), getSelectableColumns(), ilLPStatus\LP_STATUS_COMPLETED, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

Referenced by __construct().

227  {
228  global $lng;
229 
230  foreach($this->getSelectableColumns() as $column => $meta)
231  {
232  // no udf!
233  switch($column)
234  {
235  case "firstname":
236  case "lastname":
237  case "mark":
238  case "u_comment":
239  case "institution":
240  case "department":
241  case "title":
242  case "street":
243  case "zipcode":
244  case "city":
245  case "country":
246  case "email":
247  case "matriculation":
248  case "login":
249  if($column != "mark" ||
250  ilObjectLP::supportsMark($this->type))
251  {
252  $item = $this->addFilterItemByMetaType($column, ilTable2GUI::FILTER_TEXT, true, $meta["txt"]);
253  $this->filter[$column] = $item->getValue();
254  }
255  break;
256 
257  case "first_access":
258  case "last_access":
259  case "create_date":
260  case 'status_changed':
261  $item = $this->addFilterItemByMetaType($column, ilTable2GUI::FILTER_DATETIME_RANGE, true, $meta["txt"]);
262  $this->filter[$column] = $item->getDate();
263  break;
264 
265  case "birthday":
266  $item = $this->addFilterItemByMetaType($column, ilTable2GUI::FILTER_DATE_RANGE, true, $meta["txt"]);
267  $this->filter[$column] = $item->getDate();
268  break;
269 
270  case "read_count":
271  case "percentage":
272  $item = $this->addFilterItemByMetaType($column, ilTable2GUI::FILTER_NUMBER_RANGE, true, $meta["txt"]);
273  $this->filter[$column] = $item->getValue();
274  break;
275 
276  case "gender":
277  $item = $this->addFilterItemByMetaType("gender", ilTable2GUI::FILTER_SELECT, true, $meta["txt"]);
278  $item->setOptions(array("" => $lng->txt("trac_all"), "m" => $lng->txt("gender_m"), "f" => $lng->txt("gender_f")));
279  $this->filter["gender"] = $item->getValue();
280  break;
281 
282  case "sel_country":
283  $item = $this->addFilterItemByMetaType("sel_country", ilTable2GUI::FILTER_SELECT, true, $meta["txt"]);
284 
285  $options = array();
286  include_once("./Services/Utilities/classes/class.ilCountry.php");
287  foreach (ilCountry::getCountryCodes() as $c)
288  {
289  $options[$c] = $lng->txt("meta_c_".$c);
290  }
291  asort($options);
292  $item->setOptions(array("" => $lng->txt("trac_all"))+$options);
293 
294  $this->filter["sel_country"] = $item->getValue();
295  break;
296 
297  case "status":
298  include_once "Services/Tracking/classes/class.ilLPStatus.php";
299  $item = $this->addFilterItemByMetaType("status", ilTable2GUI::FILTER_SELECT, true, $meta["txt"]);
300  $item->setOptions(array("" => $lng->txt("trac_all"),
305  $this->filter["status"] = $item->getValue();
306  if($this->filter["status"])
307  {
308  $this->filter["status"]--;
309  }
310  break;
311 
312  case "language":
313  $item = $this->addFilterItemByMetaType("language", ilTable2GUI::FILTER_LANGUAGE, true);
314  $this->filter["language"] = $item->getValue();
315  break;
316 
317  case "spent_seconds":
318  if(ilObjectLP::supportsSpentSeconds($this->type))
319  {
320  $item = $this->addFilterItemByMetaType("spent_seconds", ilTable2GUI::FILTER_DURATION_RANGE, true, $meta["txt"]);
321  $this->filter["spent_seconds"]["from"] = $item->getCombinationItem("from")->getValueInSeconds();
322  $this->filter["spent_seconds"]["to"] = $item->getCombinationItem("to")->getValueInSeconds();
323  }
324  break;
325  }
326  }
327  }
const LP_STATUS_COMPLETED_NUM
addFilterItemByMetaType($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
Add filter by standard type.
const LP_STATUS_NOT_ATTEMPTED
const LP_STATUS_IN_PROGRESS_NUM
const FILTER_NUMBER_RANGE
const LP_STATUS_IN_PROGRESS
const LP_STATUS_FAILED
const FILTER_DATETIME_RANGE
$column
Definition: 39dropdown.php:62
if(!is_array($argv)) $options
const FILTER_DURATION_RANGE
Create styles array
The data for the language used.
static supportsMark($a_obj_type)
const LP_STATUS_NOT_ATTEMPTED_NUM
static supportsSpentSeconds($a_obj_type)
global $lng
Definition: privfeed.php:17
static getCountryCodes()
Get country codes (DIN EN 3166-1)
const LP_STATUS_COMPLETED
const LP_STATUS_FAILED_NUM
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $filter

ilTrObjectUsersPropsTableGUI::$filter
protected

Definition at line 26 of file class.ilTrObjectUsersPropsTableGUI.php.

◆ $has_collection

ilTrObjectUsersPropsTableGUI::$has_collection
protected

Definition at line 30 of file class.ilTrObjectUsersPropsTableGUI.php.

◆ $has_edit

ilTrObjectUsersPropsTableGUI::$has_edit
protected

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

◆ $has_multi

ilTrObjectUsersPropsTableGUI::$has_multi
protected

Definition at line 31 of file class.ilTrObjectUsersPropsTableGUI.php.

◆ $in_course

ilTrObjectUsersPropsTableGUI::$in_course
protected

Definition at line 27 of file class.ilTrObjectUsersPropsTableGUI.php.

Referenced by getItems().

◆ $in_group

ilTrObjectUsersPropsTableGUI::$in_group
protected

Definition at line 28 of file class.ilTrObjectUsersPropsTableGUI.php.

Referenced by getItems().

◆ $user_fields

ilTrObjectUsersPropsTableGUI::$user_fields
protected

Definition at line 25 of file class.ilTrObjectUsersPropsTableGUI.php.


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