ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilCourseParticipantsTableGUI Class Reference
+ Inheritance diagram for ilCourseParticipantsTableGUI:
+ Collaboration diagram for ilCourseParticipantsTableGUI:

Public Member Functions

 __construct ( $a_parent_obj, ilObject $rep_object, $a_show_learning_progress=false, $a_show_timings=false, $a_show_lp_status_sync=false)
 Constructor. More...
 
 getItems ()
 
 fillRow ($a_set)
 fill row More...
 
 parse ()
 Parse data. More...
 
- Public Member Functions inherited from ilParticipantTableGUI
 initFilter ()
 Init table filter. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 checkAcceptance ($a_usr_id)
 Check acceptance. More...
 
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 ilTable2GUI constructor. More...
 
 setOpenFormTag ($a_val)
 Set open form tag. More...
 
 getOpenFormTag ()
 Get open form tag. More...
 
 setCloseFormTag ($a_val)
 Set close form tag. More...
 
 getCloseFormTag ()
 Get close form tag. More...
 
 determineLimit ()
 Determine the limit. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 Determine selected columns. More...
 
 isColumnSelected ($a_col)
 Is given column selected? More...
 
 getSelectedColumns ()
 Get selected columns. More...
 
 executeCommand ()
 Execute command. More...
 
 resetOffset ($a_in_determination=false)
 Reset offset. More...
 
 initFilter ()
 Init filter. More...
 
 getParentObject ()
 Get parent object. More...
 
 getParentCmd ()
 Get parent command. More...
 
 setTopAnchor ($a_val)
 Set top anchor. More...
 
 getTopAnchor ()
 Get top anchor. More...
 
 setNoEntriesText ($a_text)
 Set text for an empty table. More...
 
 getNoEntriesText ()
 Get text for an empty table. More...
 
 setIsDataTable ($a_val)
 Set is data table. More...
 
 getIsDataTable ()
 Get is data table. More...
 
 setEnableTitle ($a_enabletitle)
 Set Enable Title. More...
 
 getEnableTitle ()
 Get Enable Title. More...
 
 setEnableHeader ($a_enableheader)
 Set Enable Header. More...
 
 getEnableHeader ()
 Get Enable Header. More...
 
 setEnableNumInfo ($a_val)
 Set enable num info. More...
 
 getEnableNumInfo ()
 Get enable num info. More...
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setOrderField ($a_order_field)
 set order column More...
 
 getOrderField ()
 
 setData ($a_data)
 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 Attributes

 $show_learning_progress = false
 
 $show_timings = false
 
 $show_lp_status_sync = false
 
- Protected Attributes inherited from ilParticipantTableGUI
 $participants = null
 
 $current_filter = array()
 
 $rep_object
 
- 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
 

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 Member Functions inherited from ilParticipantTableGUI
 getRepositoryObject ()
 
 getParticipants ()
 Get participants. More...
 
 initSettings ()
 Init acceptance. More...
 
 showActionLinks ($a_set)
 show edit links 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...
 
- Static Protected Attributes inherited from ilParticipantTableGUI
static $export_allowed = false
 
static $confirmation_required = true
 
static $accepted_ids = null
 
static $all_columns = null
 
static $has_odf_definitions = false
 

Detailed Description

Author
Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 13 of file class.ilCourseParticipantsTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCourseParticipantsTableGUI::__construct (   $a_parent_obj,
ilObject  $rep_object,
  $a_show_learning_progress = false,
  $a_show_timings = false,
  $a_show_lp_status_sync = false 
)

Constructor.

@access public

Parameters

return

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

33 {
34 global $lng, $ilCtrl;
35
36 $this->show_learning_progress = $a_show_learning_progress;
37 if ($this->show_learning_progress) {
38 include_once './Services/Tracking/classes/class.ilLPStatus.php';
39 }
40
41 $this->show_timings = $a_show_timings;
42 $this->show_lp_status_sync = $a_show_lp_status_sync;
43
44 $this->rep_object = $rep_object;
45
46 // #13208
47 include_once("Services/Tracking/classes/class.ilObjUserTracking.php");
49 $this->show_lp_status_sync = false;
50 }
51
52 $this->lng = $lng;
53 $this->lng->loadLanguageModule('crs');
54 $this->lng->loadLanguageModule('trac');
55 $this->lng->loadLanguageModule('rbac');
56 $this->lng->loadLanguageModule('mmbr');
57
58 $this->ctrl = $ilCtrl;
59
60 include_once('./Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
61 $this->privacy = ilPrivacySettings::_getInstance();
62
63 include_once './Services/Membership/classes/class.ilParticipants.php';
64 $this->participants = ilParticipants::getInstanceByObjId($this->getRepositoryObject()->getId());
65
66
67 // required before constructor for columns
68 $this->setId('crs_' . $this->getRepositoryObject()->getId());
69 parent::__construct($a_parent_obj, 'participants');
70
71 $this->initSettings();
72
73 $this->setFormName('participants');
74
75 $this->addColumn('', 'f', "1");
76 $this->addColumn($this->lng->txt('name'), 'name', '20%');
77
78 $all_cols = $this->getSelectableColumns();
79 foreach ($this->getSelectedColumns() as $col) {
80 $this->addColumn($all_cols[$col]['txt'], $col);
81 }
82
83 if ($this->show_learning_progress) {
84 $this->addColumn($this->lng->txt('learning_progress'), 'progress');
85 }
86
87 if ($this->privacy->enabledCourseAccessTimes()) {
88 $this->addColumn($this->lng->txt('last_access'), 'access_ut', '16em');
89 }
90
91 $this->addColumn($this->lng->txt('crs_member_passed'), 'passed');
92 if ($this->show_lp_status_sync) {
93 $this->addColumn($this->lng->txt('crs_member_passed_status_changed'), 'passed_info');
94 }
95
96
97 $this->setSelectAllCheckbox('participants');
98 $this->addColumn($this->lng->txt('crs_mem_contact'), 'contact');
99 $this->addColumn($this->lng->txt('crs_blocked'), 'blocked');
100 $this->addColumn($this->lng->txt('crs_notification_list_title'), 'notification');
101
102 $this->addColumn($this->lng->txt(''), 'optional');
103
104 $this->setRowTemplate("tpl.show_participants_row.html", "Modules/Course");
105
106 $this->setDefaultOrderField('roles');
107 $this->enable('sort');
108 $this->enable('header');
109 $this->enable('numinfo');
110 $this->enable('select_all');
111
112 $this->setEnableNumInfo(true);
113 $this->setExternalSegmentation(false);
114
115 $this->getItems();
116 $this->setTopCommands(true);
117 $this->setEnableHeader(true);
118 $this->setEnableTitle(true);
119 $this->initFilter();
120
121 $this->setShowRowsSelector(true);
122
123 include_once "Services/Certificate/classes/class.ilCertificate.php";
124 $this->enable_certificates = ilCertificate::isActive();
125 if ($this->enable_certificates) {
126 $this->enable_certificates = ilCertificate::isObjectActive($this->getRepositoryObject()->getId());
127 }
128 if ($this->enable_certificates) {
129 $lng->loadLanguageModule('certificate');
130 }
131
132 $this->addMultiCommand('editParticipants', $this->lng->txt('edit'));
133 $this->addMultiCommand('confirmDeleteParticipants', $this->lng->txt('remove'));
134 $this->addMultiCommand('sendMailToSelectedUsers', $this->lng->txt('mmbr_btn_mail_selected_users'));
135 $this->lng->loadLanguageModule('user');
136 $this->addMultiCommand('addToClipboard', $this->lng->txt('clipboard_add_btn'));
137
138 $this->addCommandButton('updateParticipantsStatus', $this->lng->txt('save'));
139 }
static isObjectActive($a_obj_id)
static _enabledLearningProgress()
check wether learing progress is enabled or not
getSelectableColumns()
Get selectable columns.
static getInstanceByObjId($a_obj_id)
Get instance by obj type.
static _getInstance()
Get instance of ilPrivacySettings.
getSelectedColumns()
Get selected columns.
setTopCommands($a_val)
Set top commands (display command buttons on top of table, too)
setEnableHeader($a_enableheader)
Set Enable Header.
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
getId()
Get element id.
setEnableTitle($a_enabletitle)
Set Enable Title.
setEnableNumInfo($a_val)
Set enable num info.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
addMultiCommand($a_cmd, $a_text)
Add Command button.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
setSelectAllCheckbox($a_select_all_checkbox)
Set the name of the checkbox that should be toggled with a select all button.
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.
setExternalSegmentation($a_val)
Set external segmentation.
setId($a_val)
Set id.
setFormName($a_formname="")
Set Form name.
addCommandButton($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
Add Command button.
enable($a_module_name)
enables particular modules of table
global $ilCtrl
Definition: ilias.php:18

References $ilCtrl, ilTableGUI\$lng, ilParticipantTableGUI\$rep_object, ilObjUserTracking\_enabledLearningProgress(), ilPrivacySettings\_getInstance(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ilTableGUI\enable(), ilTable2GUI\getId(), ilParticipants\getInstanceByObjId(), getItems(), ilParticipantTableGUI\getRepositoryObject(), ilParticipantTableGUI\getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ilParticipantTableGUI\initFilter(), ilParticipantTableGUI\initSettings(), ilCertificate\isActive(), ilCertificate\isObjectActive(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setFormName(), ilTable2GUI\setId(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTopCommands().

+ Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilCourseParticipantsTableGUI::fillRow (   $a_set)

fill row

@access public

Parameters

return

Reimplemented from ilTable2GUI.

Definition at line 155 of file class.ilCourseParticipantsTableGUI.php.

156 {
157 global $ilAccess;
158
159 $this->tpl->setVariable('VAL_ID', $a_set['usr_id']);
160 $this->tpl->setVariable('VAL_NAME', $a_set['lastname'] . ', ' . $a_set['firstname']);
161
162 if (!$ilAccess->checkAccessOfUser($a_set['usr_id'], 'read', '', $this->getRepositoryObject()->getRefId()) and
163 is_array($info = $ilAccess->getInfo())) {
164 $this->tpl->setCurrentBlock('access_warning');
165 $this->tpl->setVariable('PARENT_ACCESS', $info[0]['text']);
166 $this->tpl->parseCurrentBlock();
167 }
168
169 if (!ilObjUser::_lookupActive($a_set['usr_id'])) {
170 $this->tpl->setCurrentBlock('access_warning');
171 $this->tpl->setVariable('PARENT_ACCESS', $this->lng->txt('usr_account_inactive'));
172 $this->tpl->parseCurrentBlock();
173 }
174
175 foreach ($this->getSelectedColumns() as $field) {
176 switch ($field) {
177 case 'gender':
178 $a_set['gender'] = $a_set['gender'] ? $this->lng->txt('gender_' . $a_set['gender']) : '';
179 $this->tpl->setCurrentBlock('custom_fields');
180 $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
181 $this->tpl->parseCurrentBlock();
182 break;
183
184 case 'birthday':
185 $a_set['birthday'] = $a_set['birthday'] ? ilDatePresentation::formatDate(new ilDate($a_set['birthday'], IL_CAL_DATE)) : $this->lng->txt('no_date');
186 $this->tpl->setCurrentBlock('custom_fields');
187 $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
188 $this->tpl->parseCurrentBlock();
189 break;
190
191 case 'consultation_hour':
192 $this->tpl->setCurrentBlock('custom_fields');
193 $dts = array();
194 foreach ((array) $a_set['consultation_hours'] as $ch) {
196 new ilDateTime($ch['dt'], IL_CAL_UNIX),
197 new ilDateTime($ch['dtend'], IL_CAL_UNIX)
198 );
199 if ($ch['explanation']) {
200 $tmp .= ' ' . $ch['explanation'];
201 }
202 $dts[] = $tmp;
203 }
204 $dt_string = implode('<br />', $dts);
205 $this->tpl->setVariable('VAL_CUST', $dt_string);
206 $this->tpl->parseCurrentBlock();
207 break;
208
209 case 'prtf':
210 $tmp = array();
211 if (is_array($a_set['prtf'])) {
212 foreach ($a_set['prtf'] as $prtf_url => $prtf_txt) {
213 $tmp[] = '<a href="' . $prtf_url . '">' . $prtf_txt . '</a>';
214 }
215 }
216 $this->tpl->setCurrentBlock('custom_fields');
217 $this->tpl->setVariable('VAL_CUST', (string) implode('<br />', $tmp)) ;
218 $this->tpl->parseCurrentBlock();
219 break;
220
221
222 case 'odf_last_update':
223 $this->tpl->setCurrentBlock('custom_fields');
224 $this->tpl->setVariable('VAL_CUST', (string) $a_set['odf_info_txt']);
225 $this->tpl->parseCurrentBlock();
226 break;
227
228 case 'roles':
229 $this->tpl->setCurrentBlock('custom_fields');
230 $this->tpl->setVariable('VAL_CUST', (string) $a_set['roles_label']);
231 $this->tpl->parseCurrentBlock();
232 break;
233
234 case 'org_units':
235 $this->tpl->setCurrentBlock('custom_fields');
236 include_once './Modules/OrgUnit/classes/PathStorage/class.ilOrgUnitPathStorage.php';
237 $this->tpl->setVariable('VAL_CUST', (string) ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($a_set['usr_id']));
238 $this->tpl->parseCurrentBlock();
239 break;
240
241 default:
242 $this->tpl->setCurrentBlock('custom_fields');
243 $this->tpl->setVariable('VAL_CUST', isset($a_set[$field]) ? (string) $a_set[$field] : '');
244 $this->tpl->parseCurrentBlock();
245 break;
246 }
247 }
248
249 if ($this->privacy->enabledCourseAccessTimes()) {
250 $this->tpl->setVariable('VAL_ACCESS', $a_set['access_time']);
251 }
252 if ($this->show_learning_progress) {
253 $this->tpl->setCurrentBlock('lp');
254 switch ($a_set['progress']) {
256 $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt($a_set['progress']));
257 $this->tpl->setVariable('LP_STATUS_PATH', ilUtil::getImagePath('scorm/complete.svg'));
258 break;
259
261 $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt($a_set['progress']));
262 $this->tpl->setVariable('LP_STATUS_PATH', ilUtil::getImagePath('scorm/incomplete.svg'));
263 break;
264
266 $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt($a_set['progress']));
267 $this->tpl->setVariable('LP_STATUS_PATH', ilUtil::getImagePath('scorm/not_attempted.svg'));
268 break;
269
271 $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt($a_set['progress']));
272 $this->tpl->setVariable('LP_STATUS_PATH', ilUtil::getImagePath('scorm/failed.svg'));
273 break;
274 }
275 $this->tpl->parseCurrentBlock();
276 }
277
278 $this->tpl->setVariable('VAL_POSTNAME', 'participants');
279
280 if ($ilAccess->checkAccess("grade", "", $this->rep_object->getRefId())) {
281 $this->tpl->setCurrentBlock('grade');
282 $this->tpl->setVariable('VAL_PASSED_ID', $a_set['usr_id']);
283 $this->tpl->setVariable('VAL_PASSED_CHECKED', ($a_set['passed'] ? 'checked="checked"' : ''));
284 $this->tpl->parseCurrentBlock();
285 } else {
286 $this->tpl->setVariable('VAL_PASSED_TXT', ($a_set['passed']
287 ? $this->lng->txt("yes")
288 : $this->lng->txt("no")));
289 }
290
291 if (
292 $this->getParticipants()->isAdmin($a_set['usr_id']) ||
293 $this->getParticipants()->isTutor($a_set['usr_id'])
294 ) {
295 // cognos-blu-patch: begin
296 $this->tpl->setCurrentBlock('with_contact');
297 $this->tpl->setVariable('VAL_CONTACT_ID', $a_set['usr_id']);
298 $this->tpl->setVariable('VAL_CONTACT_CHECKED', $a_set['contact'] ? 'checked="checked"' : '');
299 $this->tpl->parseCurrentBlock();
300 // cognos-blu-patch: end
301
302 $this->tpl->setCurrentBlock('with_notification');
303 $this->tpl->setVariable('VAL_NOTIFICATION_ID', $a_set['usr_id']);
304 $this->tpl->setVariable('VAL_NOTIFICATION_CHECKED', ($a_set['notification'] ? 'checked="checked"' : ''));
305 $this->tpl->parseCurrentBlock();
306 }
307
308 // blocked only for real members
309 if (
310 !$this->getParticipants()->isAdmin($a_set['usr_id']) &&
311 !$this->getParticipants()->isTutor($a_set['usr_id'])
312 ) {
313 $this->tpl->setCurrentBlock('with_blocked');
314 $this->tpl->setVariable('VAL_BLOCKED_ID', $a_set['usr_id']);
315 $this->tpl->setVariable('VAL_BLOCKED_CHECKED', ($a_set['blocked'] ? 'checked="checked"' : ''));
316 $this->tpl->parseCurrentBlock();
317 }
318
319
320 if ($this->show_lp_status_sync) {
321 $this->tpl->setVariable('PASSED_INFO', $a_set["passed_info"]);
322 }
323
324 $this->showActionLinks($a_set);
325
326 if ($a_set['passed'] && $this->enable_certificates) {
327 $this->tpl->setCurrentBlock('link');
328 $this->tpl->setVariable('LINK_NAME', $this->ctrl->getLinkTarget($this->parent_obj, 'deliverCertificate'));
329 $this->tpl->setVariable('LINK_TXT', $this->lng->txt('download_certificate'));
330 $this->tpl->parseCurrentBlock();
331 }
332 $this->ctrl->clearParameters($this->parent_obj);
333
334 if ($this->show_timings) {
335 $this->ctrl->setParameterByClass('ilcoursecontentgui', 'member_id', $a_set['usr_id']);
336 $this->tpl->setCurrentBlock('link');
337 $this->tpl->setVariable('LINK_NAME', $this->ctrl->getLinkTargetByClass('ilcoursecontentgui', 'showUserTimings'));
338 $this->tpl->setVariable('LINK_TXT', $this->lng->txt('timings_timings'));
339 $this->tpl->parseCurrentBlock();
340 }
341 }
const IL_CAL_DATE
const IL_CAL_UNIX
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false)
Format a date @access public.
static formatPeriod(ilDateTime $start, ilDateTime $end, $a_skip_starting_day=false)
Format a period of two date Shows: 14.
@classDescription Date and time handling
Class for single dates.
const LP_STATUS_COMPLETED
const LP_STATUS_FAILED
const LP_STATUS_NOT_ATTEMPTED
const LP_STATUS_IN_PROGRESS
static _lookupActive($a_usr_id)
Check user account active.
showActionLinks($a_set)
show edit links
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
$info
Definition: index.php:5

References $info, ilObjUser\_lookupActive(), ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilUtil\getImagePath(), ilParticipantTableGUI\getParticipants(), ilTable2GUI\getSelectedColumns(), IL_CAL_DATE, IL_CAL_UNIX, ilLPStatus\LP_STATUS_COMPLETED, ilLPStatus\LP_STATUS_FAILED, ilLPStatus\LP_STATUS_IN_PROGRESS, ilLPStatus\LP_STATUS_NOT_ATTEMPTED, and ilParticipantTableGUI\showActionLinks().

+ Here is the call graph for this function:

◆ getItems()

ilCourseParticipantsTableGUI::getItems ( )

Definition at line 143 of file class.ilCourseParticipantsTableGUI.php.

144 {
145 }

Referenced by __construct().

+ Here is the caller graph for this function:

◆ parse()

ilCourseParticipantsTableGUI::parse ( )

Parse data.

Returns

@global ilRbacReview $rbacreview

Definition at line 349 of file class.ilCourseParticipantsTableGUI.php.

350 {
351 global $rbacreview;
352
353 $this->determineOffsetAndOrder(true);
354
355 include_once './Services/User/classes/class.ilUserQuery.php';
356
357 $additional_fields = $this->getSelectedColumns();
358 unset($additional_fields["firstname"]);
359 unset($additional_fields["lastname"]);
360 unset($additional_fields["last_login"]);
361 unset($additional_fields["access_until"]);
362 unset($additional_fields['consultation_hour']);
363 unset($additional_fields['prtf']);
364 unset($additional_fields['roles']);
365 unset($additional_fields['org_units']);
366
367 $part = $this->participants->getParticipants();
368
369 $part = $GLOBALS['DIC']->access()->filterUserIdsByRbacOrPositionOfCurrentUser(
370 'manage_members',
371 'manage_members',
372 $this->getRepositoryObject()->getRefId(),
373 $part
374 );
375
376
377 if (!$part) {
378 $this->setData(array());
379 return;
380 }
381
382 $udf_ids = $usr_data_fields = $odf_ids = array();
383 foreach ($additional_fields as $field) {
384 if (substr($field, 0, 3) == 'udf') {
385 $udf_ids[] = substr($field, 4);
386 continue;
387 }
388 if (substr($field, 0, 3) == 'odf') {
389 $odf_ids[] = substr($field, 4);
390 continue;
391 }
392
393 $usr_data_fields[] = $field;
394 }
395
397 '',
398 '',
399 0,
400 9999,
401 $this->current_filter['login'],
402 '',
403 null,
404 false,
405 false,
406 0,
407 0,
408 null,
409 $usr_data_fields,
410 $part
411 );
412 // filter by array
413 $usr_ids = array();
414 $local_roles = $this->getParentObject()->getLocalRoles();
415 foreach ((array) $usr_data['set'] as $user) {
416 if ($this->current_filter['roles']) {
417 if (!$GLOBALS['rbacreview']->isAssigned($user['usr_id'], $this->current_filter['roles'])) {
418 continue;
419 }
420 }
421 if ($this->current_filter['org_units']) {
422 $org_unit = $this->current_filter['org_units'];
423
424 include_once './Modules/OrgUnit/classes/class.ilObjOrgUnitTree.php';
425 $assigned = ilObjOrgUnitTree::_getInstance()->getOrgUnitOfUser($user['usr_id']);
426 if (!in_array($org_unit, $assigned)) {
427 continue;
428 }
429 }
430
431
432 $usr_ids[] = $user['usr_id'];
433 }
434
435 // merge course data
436 $course_user_data = $this->getParentObject()->readMemberData(
437 $usr_ids,
438 $this->getSelectedColumns()
439 );
440 $a_user_data = array();
441 foreach ((array) $usr_data['set'] as $ud) {
442 $user_id = $ud['usr_id'];
443
444 if (!in_array($user_id, $usr_ids)) {
445 continue;
446 }
447 // #15434
448 if (!$this->checkAcceptance($user_id)) {
449 $ud = array();
450 }
451
452 $a_user_data[$user_id] = array_merge($ud, $course_user_data[$user_id]);
453
454
455 $roles = array();
456 foreach ($local_roles as $role_id => $role_name) {
457 // @todo fix performance
458 if ($GLOBALS['rbacreview']->isAssigned($user_id, $role_id)) {
459 $roles[] = $role_name;
460 }
461 }
462
463 $a_user_data[$user_id]['name'] = ($a_user_data[$user_id]['lastname'] . ', ' . $a_user_data[$user_id]['firstname']);
464 $a_user_data[$user_id]['roles_label'] = implode('<br />', $roles);
465 $a_user_data[$user_id]['roles'] = $this->participants->setRoleOrderPosition($user_id);
466
467
468 if ($this->show_lp_status_sync) {
469 // #9912 / #13208
470 $passed_info = "";
471 if ($a_user_data[$user_id]["passed_info"]) {
472 $pinfo = $a_user_data[$user_id]["passed_info"];
473 if ($pinfo["user_id"]) {
474 if ($pinfo["user_id"] < 0) {
475 $passed_info = $this->lng->txt("crs_passed_status_system");
476 } elseif ($pinfo["user_id"] > 0) {
477 $name = ilObjUser::_lookupName($pinfo["user_id"]);
478 $passed_info = $this->lng->txt("crs_passed_status_manual_by") . ": " . $name["login"];
479 }
480 }
481 if ($pinfo["timestamp"]) {
482 $passed_info .= "<br />" . ilDatePresentation::formatDate($pinfo["timestamp"]);
483 }
484 }
485 $a_user_data[$user_id]["passed_info"] = $passed_info;
486 }
487 }
488
489 // Custom user data fields
490 if ($udf_ids) {
491 include_once './Services/User/classes/class.ilUserDefinedData.php';
492 $data = ilUserDefinedData::lookupData($usr_ids, $udf_ids);
493 foreach ($data as $usr_id => $fields) {
494 if (!$this->checkAcceptance($usr_id)) {
495 continue;
496 }
497
498 foreach ($fields as $field_id => $value) {
499 $a_user_data[$usr_id]['udf_' . $field_id] = $value;
500 }
501 }
502 }
503 // Object specific user data fields
504 if ($odf_ids) {
505 include_once './Modules/Course/classes/Export/class.ilCourseUserData.php';
507 foreach ($data as $usr_id => $fields) {
508 // #7264: as we get data for all course members filter against user data
509 if (!$this->checkAcceptance($usr_id) || !in_array($usr_id, $usr_ids)) {
510 continue;
511 }
512
513 foreach ($fields as $field_id => $value) {
514 $a_user_data[$usr_id]['odf_' . $field_id] = $value;
515 }
516 }
517
518
519 // add last edit date
520 include_once './Services/Membership/classes/class.ilObjectCustomUserFieldHistory.php';
521 foreach (ilObjectCustomUserFieldHistory::lookupEntriesByObjectId($this->getRepositoryObject()->getId()) as $usr_id => $edit_info) {
522 if (!isset($a_user_data[$usr_id])) {
523 continue;
524 }
525
526 include_once './Services/PrivacySecurity/classes/class.ilPrivacySettings.php';
527 if ($usr_id == $edit_info['update_user']) {
528 $a_user_data[$usr_id]['odf_last_update'] = '';
529 $a_user_data[$usr_id]['odf_info_txt'] = $GLOBALS['lng']->txt('cdf_edited_by_self');
530 if (ilPrivacySettings::_getInstance()->enabledAccessTimesByType($this->getRepositoryObject()->getType())) {
531 $a_user_data[$usr_id]['odf_last_update'] .= ('_' . $edit_info['editing_time']->get(IL_CAL_UNIX));
532 $a_user_data[$usr_id]['odf_info_txt'] .= (', ' . ilDatePresentation::formatDate($edit_info['editing_time']));
533 }
534 } else {
535 $a_user_data[$usr_id]['odf_last_update'] = $edit_info['update_user'];
536 $a_user_data[$usr_id]['odf_last_update'] .= ('_' . $edit_info['editing_time']->get(IL_CAL_UNIX));
537
538 $name = ilObjUser::_lookupName($edit_info['update_user']);
539 $a_user_data[$usr_id]['odf_info_txt'] = ($name['firstname'] . ' ' . $name['lastname'] . ', ' . ilDatePresentation::formatDate($edit_info['editing_time']));
540 }
541 }
542 }
543
544 // consultation hours
545 if ($this->isColumnSelected('consultation_hour')) {
546 include_once './Services/Booking/classes/class.ilBookingEntry.php';
547 foreach (ilBookingEntry::lookupManagedBookingsForObject($this->getRepositoryObject()->getId(), $GLOBALS['ilUser']->getId()) as $buser => $booking) {
548 if (isset($a_user_data[$buser])) {
549 $a_user_data[$buser]['consultation_hour'] = $booking[0]['dt'];
550 $a_user_data[$buser]['consultation_hour_end'] = $booking[0]['dtend'];
551 $a_user_data[$buser]['consultation_hours'] = $booking;
552 }
553 }
554 }
555
556 // always sort by name first
557 $a_user_data = ilUtil::sortArray(
558 $a_user_data,
559 'name',
560 $this->getOrderDirection()
561 );
562
563 return $this->setData($a_user_data);
564 }
static lookupManagedBookingsForObject($a_obj_id, $a_usr_id)
Lookup bookings for own and managed consultation hours of an object.
static _getValuesByObjId($a_obj_id)
Get values by obj_id (for all users)
static _lookupName($a_user_id)
lookup user name
static lookupEntriesByObjectId($a_obj_id)
Get entries by obj_id @global type $ilDB.
checkAcceptance($a_usr_id)
Check acceptance.
getParentObject()
Get parent object.
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
setData($a_data)
set table data @access public
isColumnSelected($a_col)
Is given column selected?
getOrderDirection()
Get order direction.
static lookupData($a_user_ids, $a_field_ids)
Lookup data.
static getUserListData( $a_order_field, $a_order_dir, $a_offset, $a_limit, $a_string_filter="", $a_activation_filter="", $a_last_login_filter=null, $a_limited_access_filter=false, $a_no_courses_filter=false, $a_course_group_filter=0, $a_role_filter=0, $a_user_folder_filter=null, $a_additional_fields='', $a_user_filter=null, $a_first_letter="", $a_authentication_filter=null)
Get data for user administration list.
static sortArray( $array, $a_array_sortby, $a_array_sortorder=0, $a_numeric=false, $a_keep_keys=false)
sortArray
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
if($format !==null) $name
Definition: metadata.php:146

References ilTableGUI\$data, $GLOBALS, $name, ilObjOrgUnitTree\_getInstance(), ilPrivacySettings\_getInstance(), ilCourseUserData\_getValuesByObjId(), ilObjUser\_lookupName(), ilParticipantTableGUI\checkAcceptance(), ilTable2GUI\determineOffsetAndOrder(), ilDatePresentation\formatDate(), ilTable2GUI\getId(), ilTableGUI\getOrderDirection(), ilTable2GUI\getParentObject(), ilParticipantTableGUI\getRepositoryObject(), ilTable2GUI\getSelectedColumns(), ilUserQuery\getUserListData(), IL_CAL_UNIX, ilTable2GUI\isColumnSelected(), ilUserDefinedData\lookupData(), ilObjectCustomUserFieldHistory\lookupEntriesByObjectId(), ilBookingEntry\lookupManagedBookingsForObject(), ilTable2GUI\setData(), and ilUtil\sortArray().

+ Here is the call graph for this function:

Field Documentation

◆ $show_learning_progress

ilCourseParticipantsTableGUI::$show_learning_progress = false
protected

Definition at line 15 of file class.ilCourseParticipantsTableGUI.php.

◆ $show_lp_status_sync

ilCourseParticipantsTableGUI::$show_lp_status_sync = false
protected

Definition at line 17 of file class.ilCourseParticipantsTableGUI.php.

◆ $show_timings

ilCourseParticipantsTableGUI::$show_timings = false
protected

Definition at line 16 of file class.ilCourseParticipantsTableGUI.php.


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