ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
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, ilCertificateUserForObjectPreloader $preloader=null)
 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, $a_select_all_on_top=false)
 Set the name of the checkbox that should be toggled with a select all button. More...
 
 setExternalSorting ($a_val)
 Set external sorting. More...
 
 getExternalSorting ()
 Get external sorting. More...
 
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 setDefaultFilterVisiblity ($a_status)
 Set default filter visiblity. More...
 
 getDefaultFilterVisibility ()
 Get default filter visibility. More...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButtonBase $a_button)
 Add Command button instance. More...
 
 addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button. More...
 
 addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button for selected items. More...
 
 setCloseCommand ($a_link)
 Add command for closing table. More...
 
 addMultiCommand ($a_cmd, $a_text)
 Add Command button. More...
 
 addHiddenInput ($a_name, $a_value)
 Add Hidden Input field. More...
 
 addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
 Add Header Command (Link) (Image needed for now) More...
 
 setTopCommands ($a_val)
 Set top commands (display command buttons on top of table, too) More...
 
 getTopCommands ()
 Get top commands (display command buttons on top of table, too) More...
 
 addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
 Add a column to the header. More...
 
 getNavParameter ()
 
 setOrderLink ($sort_field, $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order. More...
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 render ()
 render table @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
 
 $select_all_on_top = false
 
 $sel_buttons = []
 
- Protected Attributes inherited from ilTableGUI
 $tpl
 
 $lng
 

Private Attributes

 $preLoader
 

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,
ilCertificateUserForObjectPreloader  $preloader = null 
)

Constructor.

@access public

Parameters

param ilObject $rep_object

Parameters
bool$a_show_learning_progress
bool$a_show_timings
bool$a_show_lp_status_sync
ilCertificateUserForObjectPreloader | null$preloader

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

43 {
44 global $DIC;
45
46 $lng = $DIC['lng'];
47 $ilCtrl = $DIC['ilCtrl'];
48
49 $this->show_learning_progress = $a_show_learning_progress;
50 if ($this->show_learning_progress) {
51 include_once './Services/Tracking/classes/class.ilLPStatus.php';
52 }
53
54 if (null === $preloader) {
56 }
57 $this->preLoader = $preloader;
58
59 $this->show_timings = $a_show_timings;
60 $this->show_lp_status_sync = $a_show_lp_status_sync;
61
62 $this->rep_object = $rep_object;
63
64 // #13208
65 include_once("Services/Tracking/classes/class.ilObjUserTracking.php");
67 $this->show_lp_status_sync = false;
68 }
69
70 $this->lng = $lng;
71 $this->lng->loadLanguageModule('crs');
72 $this->lng->loadLanguageModule('trac');
73 $this->lng->loadLanguageModule('rbac');
74 $this->lng->loadLanguageModule('mmbr');
75 $this->lng->loadLanguageModule('cert');
76
77 $this->ctrl = $ilCtrl;
78
79 include_once('./Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
80 $this->privacy = ilPrivacySettings::_getInstance();
81
82 include_once './Services/Membership/classes/class.ilParticipants.php';
83 $this->participants = ilParticipants::getInstanceByObjId($this->getRepositoryObject()->getId());
84
85
86 // required before constructor for columns
87 $this->setId('crs_' . $this->getRepositoryObject()->getId());
88 parent::__construct($a_parent_obj, 'participants');
89
90 $this->initSettings();
91
92 $this->setFormName('participants');
93
94 $this->addColumn('', 'f', '1', true);
95 $this->addColumn($this->lng->txt('name'), 'name', '20%');
96
97 $all_cols = $this->getSelectableColumns();
98 foreach ($this->getSelectedColumns() as $col) {
99 $this->addColumn($all_cols[$col]['txt'], $col);
100 }
101
102 if ($this->show_learning_progress) {
103 $this->addColumn($this->lng->txt('learning_progress'), 'progress');
104 }
105
106 if ($this->privacy->enabledCourseAccessTimes()) {
107 $this->addColumn($this->lng->txt('last_access'), 'access_ut', '16em');
108 }
109
110 $this->addColumn($this->lng->txt('crs_member_passed'), 'passed');
111 if ($this->show_lp_status_sync) {
112 $this->addColumn($this->lng->txt('crs_member_passed_status_changed'), 'passed_info');
113 }
114
115
116 $this->setSelectAllCheckbox('participants', true);
117 $this->addColumn($this->lng->txt('crs_mem_contact'), 'contact');
118 $this->addColumn($this->lng->txt('crs_blocked'), 'blocked');
119 $this->addColumn($this->lng->txt('crs_notification_list_title'), 'notification');
120
121 $this->addColumn($this->lng->txt(''), 'optional');
122
123 $this->setRowTemplate("tpl.show_participants_row.html", "Modules/Course");
124
125 $this->setDefaultOrderField('roles');
126 $this->enable('sort');
127 $this->enable('header');
128 $this->enable('numinfo');
129 $this->enable('select_all');
130
131 $this->setEnableNumInfo(true);
132 $this->setExternalSegmentation(false);
133
134 $this->getItems();
135 $this->setTopCommands(true);
136 $this->setEnableHeader(true);
137 $this->setEnableTitle(true);
138 $this->initFilter();
139
140 $this->setShowRowsSelector(true);
141
143
144 $lng->loadLanguageModule('certificate');
145
146 $this->addMultiCommand('editParticipants', $this->lng->txt('edit'));
147 $this->addMultiCommand('confirmDeleteParticipants', $this->lng->txt('remove'));
148 $this->addMultiCommand('sendMailToSelectedUsers', $this->lng->txt('mmbr_btn_mail_selected_users'));
149 $this->lng->loadLanguageModule('user');
150 $this->addMultiCommand('addToClipboard', $this->lng->txt('clipboard_add_btn'));
151
152 $this->addCommandButton('updateParticipantsStatus', $this->lng->txt('save'));
153 }
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.
setSelectAllCheckbox($a_select_all_checkbox, $a_select_all_on_top=false)
Set the name of the checkbox that should be toggled with a select all button.
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.
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
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
$DIC
Definition: xapitoken.php:46

References $DIC, $ilCtrl, ilTableGUI\$lng, ilParticipantTableGUI\$rep_object, ILIAS\GlobalScreen\Provider\__construct(), 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(), 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 169 of file class.ilCourseParticipantsTableGUI.php.

170 {
171 global $DIC;
172
173 $ilAccess = $DIC['ilAccess'];
174
175 $this->tpl->setVariable('VAL_ID', $a_set['usr_id']);
176 $this->tpl->setVariable('VAL_NAME', $a_set['lastname'] . ', ' . $a_set['firstname']);
177
178 if (!$ilAccess->checkAccessOfUser($a_set['usr_id'], 'read', '', $this->getRepositoryObject()->getRefId()) and
179 is_array($info = $ilAccess->getInfo())) {
180 $this->tpl->setCurrentBlock('access_warning');
181 $this->tpl->setVariable('PARENT_ACCESS', $info[0]['text']);
182 $this->tpl->parseCurrentBlock();
183 }
184
185 if (!ilObjUser::_lookupActive($a_set['usr_id'])) {
186 $this->tpl->setCurrentBlock('access_warning');
187 $this->tpl->setVariable('PARENT_ACCESS', $this->lng->txt('usr_account_inactive'));
188 $this->tpl->parseCurrentBlock();
189 }
190
191 foreach ($this->getSelectedColumns() as $field) {
192 switch ($field) {
193 case 'gender':
194 $a_set['gender'] = $a_set['gender'] ? $this->lng->txt('gender_' . $a_set['gender']) : '';
195 $this->tpl->setCurrentBlock('custom_fields');
196 $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
197 $this->tpl->parseCurrentBlock();
198 break;
199
200 case 'birthday':
201 $a_set['birthday'] = $a_set['birthday'] ? ilDatePresentation::formatDate(new ilDate($a_set['birthday'], IL_CAL_DATE)) : $this->lng->txt('no_date');
202 $this->tpl->setCurrentBlock('custom_fields');
203 $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
204 $this->tpl->parseCurrentBlock();
205 break;
206
207 case 'consultation_hour':
208 $this->tpl->setCurrentBlock('custom_fields');
209 $dts = array();
210 foreach ((array) $a_set['consultation_hours'] as $ch) {
212 new ilDateTime($ch['dt'], IL_CAL_UNIX),
213 new ilDateTime($ch['dtend'], IL_CAL_UNIX)
214 );
215 if ($ch['explanation']) {
216 $tmp .= ' ' . $ch['explanation'];
217 }
218 $dts[] = $tmp;
219 }
220 $dt_string = implode('<br />', $dts);
221 $this->tpl->setVariable('VAL_CUST', $dt_string);
222 $this->tpl->parseCurrentBlock();
223 break;
224
225 case 'prtf':
226 $tmp = array();
227 if (is_array($a_set['prtf'])) {
228 foreach ($a_set['prtf'] as $prtf_url => $prtf_txt) {
229 $tmp[] = '<a href="' . $prtf_url . '">' . $prtf_txt . '</a>';
230 }
231 }
232 $this->tpl->setCurrentBlock('custom_fields');
233 $this->tpl->setVariable('VAL_CUST', (string) implode('<br />', $tmp)) ;
234 $this->tpl->parseCurrentBlock();
235 break;
236
237
238 case 'odf_last_update':
239 $this->tpl->setCurrentBlock('custom_fields');
240 $this->tpl->setVariable('VAL_CUST', (string) $a_set['odf_info_txt']);
241 $this->tpl->parseCurrentBlock();
242 break;
243
244 case 'roles':
245 $this->tpl->setCurrentBlock('custom_fields');
246 $this->tpl->setVariable('VAL_CUST', (string) $a_set['roles_label']);
247 $this->tpl->parseCurrentBlock();
248 break;
249
250 case 'org_units':
251 $this->tpl->setCurrentBlock('custom_fields');
252 include_once './Modules/OrgUnit/classes/PathStorage/class.ilOrgUnitPathStorage.php';
253 $this->tpl->setVariable('VAL_CUST', (string) ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($a_set['usr_id']));
254 $this->tpl->parseCurrentBlock();
255 break;
256
257 default:
258 $this->tpl->setCurrentBlock('custom_fields');
259 $this->tpl->setVariable('VAL_CUST', isset($a_set[$field]) ? (string) $a_set[$field] : '');
260 $this->tpl->parseCurrentBlock();
261 break;
262 }
263 }
264
265 if ($this->privacy->enabledCourseAccessTimes()) {
266 $this->tpl->setVariable('VAL_ACCESS', $a_set['access_time']);
267 }
268 if ($this->show_learning_progress) {
269 $this->tpl->setCurrentBlock('lp');
270 switch ($a_set['progress']) {
272 $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt($a_set['progress']));
273 $this->tpl->setVariable('LP_STATUS_PATH', ilUtil::getImagePath('scorm/complete.svg'));
274 break;
275
277 $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt($a_set['progress']));
278 $this->tpl->setVariable('LP_STATUS_PATH', ilUtil::getImagePath('scorm/incomplete.svg'));
279 break;
280
282 $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt($a_set['progress']));
283 $this->tpl->setVariable('LP_STATUS_PATH', ilUtil::getImagePath('scorm/not_attempted.svg'));
284 break;
285
287 $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt($a_set['progress']));
288 $this->tpl->setVariable('LP_STATUS_PATH', ilUtil::getImagePath('scorm/failed.svg'));
289 break;
290 }
291 $this->tpl->parseCurrentBlock();
292 }
293
294 $this->tpl->setVariable('VAL_POSTNAME', 'participants');
295
296 if ($ilAccess->checkAccess("grade", "", $this->rep_object->getRefId())) {
297 $this->tpl->setCurrentBlock('grade');
298 $this->tpl->setVariable('VAL_PASSED_ID', $a_set['usr_id']);
299 $this->tpl->setVariable('VAL_PASSED_CHECKED', ($a_set['passed'] ? 'checked="checked"' : ''));
300 $this->tpl->parseCurrentBlock();
301 } else {
302 $this->tpl->setVariable('VAL_PASSED_TXT', ($a_set['passed']
303 ? $this->lng->txt("yes")
304 : $this->lng->txt("no")));
305 }
306
307 if (
308 $this->getParticipants()->isAdmin($a_set['usr_id']) ||
309 $this->getParticipants()->isTutor($a_set['usr_id'])
310 ) {
311 // cognos-blu-patch: begin
312 $this->tpl->setCurrentBlock('with_contact');
313 $this->tpl->setVariable('VAL_CONTACT_ID', $a_set['usr_id']);
314 $this->tpl->setVariable('VAL_CONTACT_CHECKED', $a_set['contact'] ? 'checked="checked"' : '');
315 $this->tpl->parseCurrentBlock();
316 // cognos-blu-patch: end
317
318 $this->tpl->setCurrentBlock('with_notification');
319 $this->tpl->setVariable('VAL_NOTIFICATION_ID', $a_set['usr_id']);
320 $this->tpl->setVariable('VAL_NOTIFICATION_CHECKED', ($a_set['notification'] ? 'checked="checked"' : ''));
321 $this->tpl->parseCurrentBlock();
322 }
323
324 // blocked only for real members
325 if (
326 !$this->getParticipants()->isAdmin($a_set['usr_id']) &&
327 !$this->getParticipants()->isTutor($a_set['usr_id'])
328 ) {
329 $this->tpl->setCurrentBlock('with_blocked');
330 $this->tpl->setVariable('VAL_BLOCKED_ID', $a_set['usr_id']);
331 $this->tpl->setVariable('VAL_BLOCKED_CHECKED', ($a_set['blocked'] ? 'checked="checked"' : ''));
332 $this->tpl->parseCurrentBlock();
333 }
334
335
336 if ($this->show_lp_status_sync) {
337 $this->tpl->setVariable('PASSED_INFO', $a_set["passed_info"]);
338 }
339
340 $this->showActionLinks($a_set);
341
342 $isPreloaded = $this->preLoader->isPreloaded($this->getRepositoryObject()->getId(), $a_set['usr_id']);
343 if (true === $isPreloaded) {
344 $this->tpl->setCurrentBlock('link');
345 $this->tpl->setVariable('LINK_NAME', $this->ctrl->getLinkTarget($this->parent_obj, 'deliverCertificate'));
346 $this->tpl->setVariable('LINK_TXT', $this->lng->txt('download_certificate'));
347 $this->tpl->parseCurrentBlock();
348 }
349 $this->ctrl->clearParameters($this->parent_obj);
350
351 if ($this->show_timings) {
352 $this->ctrl->setParameterByClass('ilcoursecontentgui', 'member_id', $a_set['usr_id']);
353 $this->tpl->setCurrentBlock('link');
354 $this->tpl->setVariable('LINK_NAME', $this->ctrl->getLinkTargetByClass('ilcoursecontentgui', 'showUserTimings'));
355 $this->tpl->setVariable('LINK_TXT', $this->lng->txt('timings_timings'));
356 $this->tpl->parseCurrentBlock();
357 }
358 }
const IL_CAL_DATE
const IL_CAL_UNIX
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false, $include_seconds=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)

References $DIC, ilObjUser\_lookupActive(), ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilTable2GUI\getId(), ilUtil\getImagePath(), ilParticipantTableGUI\getParticipants(), ilParticipantTableGUI\getRepositoryObject(), 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 157 of file class.ilCourseParticipantsTableGUI.php.

158 {
159 }

Referenced by __construct().

+ Here is the caller graph for this function:

◆ parse()

ilCourseParticipantsTableGUI::parse ( )

Parse data.

Returns

@global ilRbacReview $rbacreview

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

367 {
368 global $DIC;
369
370 $rbacreview = $DIC['rbacreview'];
371
372 $this->determineOffsetAndOrder(true);
373
374 include_once './Services/User/classes/class.ilUserQuery.php';
375
376 $additional_fields = $this->getSelectedColumns();
377 unset($additional_fields["firstname"]);
378 unset($additional_fields["lastname"]);
379 unset($additional_fields["last_login"]);
380 unset($additional_fields["access_until"]);
381 unset($additional_fields['consultation_hour']);
382 unset($additional_fields['prtf']);
383 unset($additional_fields['roles']);
384 unset($additional_fields['org_units']);
385
386 $part = $this->participants->getParticipants();
387
388 $part = $GLOBALS['DIC']->access()->filterUserIdsByRbacOrPositionOfCurrentUser(
389 'manage_members',
390 'manage_members',
391 $this->getRepositoryObject()->getRefId(),
392 $part
393 );
394
395
396 if (!$part) {
397 $this->setData(array());
398 return;
399 }
400
401 $udf_ids = $usr_data_fields = $odf_ids = array();
402 foreach ($additional_fields as $field) {
403 if (substr($field, 0, 3) == 'udf') {
404 $udf_ids[] = substr($field, 4);
405 continue;
406 }
407 if (substr($field, 0, 3) == 'odf') {
408 $odf_ids[] = substr($field, 4);
409 continue;
410 }
411
412 $usr_data_fields[] = $field;
413 }
414
416 '',
417 '',
418 0,
419 9999,
420 $this->current_filter['login'],
421 '',
422 null,
423 false,
424 false,
425 0,
426 0,
427 null,
428 $usr_data_fields,
429 $part
430 );
431 // filter by array
432 $usr_ids = array();
433 $local_roles = $this->getParentObject()->getLocalRoles();
434 foreach ((array) $usr_data['set'] as $user) {
435 if ($this->current_filter['roles']) {
436 if (!$GLOBALS['DIC']['rbacreview']->isAssigned($user['usr_id'], $this->current_filter['roles'])) {
437 continue;
438 }
439 }
440 if ($this->current_filter['org_units']) {
441 $org_unit = $this->current_filter['org_units'];
442
443 include_once './Modules/OrgUnit/classes/class.ilObjOrgUnitTree.php';
444 $assigned = ilObjOrgUnitTree::_getInstance()->getOrgUnitOfUser($user['usr_id']);
445 if (!in_array($org_unit, $assigned)) {
446 continue;
447 }
448 }
449
450
451 $usr_ids[] = $user['usr_id'];
452 }
453
454 // merge course data
455 $course_user_data = $this->getParentObject()->readMemberData(
456 $usr_ids,
457 $this->getSelectedColumns()
458 );
459 $a_user_data = array();
460 foreach ((array) $usr_data['set'] as $ud) {
461 $user_id = $ud['usr_id'];
462
463 if (!in_array($user_id, $usr_ids)) {
464 continue;
465 }
466 // #15434
467 if (!$this->checkAcceptance($user_id)) {
468 $ud = array();
469 }
470
471 $a_user_data[$user_id] = array_merge($ud, $course_user_data[$user_id]);
472
473
474 $roles = array();
475 foreach ($local_roles as $role_id => $role_name) {
476 // @todo fix performance
477 if ($GLOBALS['DIC']['rbacreview']->isAssigned($user_id, $role_id)) {
478 $roles[] = $role_name;
479 }
480 }
481
482 $a_user_data[$user_id]['name'] = ($a_user_data[$user_id]['lastname'] . ', ' . $a_user_data[$user_id]['firstname']);
483 $a_user_data[$user_id]['roles_label'] = implode('<br />', $roles);
484 $a_user_data[$user_id]['roles'] = $this->participants->setRoleOrderPosition($user_id);
485
486
487 if ($this->show_lp_status_sync) {
488 // #9912 / #13208
489 $passed_info = "";
490 if ($a_user_data[$user_id]["passed_info"]) {
491 $pinfo = $a_user_data[$user_id]["passed_info"];
492 if ($pinfo["user_id"]) {
493 if ($pinfo["user_id"] < 0) {
494 $passed_info = $this->lng->txt("crs_passed_status_system");
495 } elseif ($pinfo["user_id"] > 0) {
496 $name = ilObjUser::_lookupName($pinfo["user_id"]);
497 $passed_info = $this->lng->txt("crs_passed_status_manual_by") . ": " . $name["login"];
498 }
499 }
500 if ($pinfo["timestamp"]) {
501 $passed_info .= "<br />" . ilDatePresentation::formatDate($pinfo["timestamp"]);
502 }
503 }
504 $a_user_data[$user_id]["passed_info"] = $passed_info;
505 }
506 }
507
508 // Custom user data fields
509 if ($udf_ids) {
510 include_once './Services/User/classes/class.ilUserDefinedData.php';
511 $data = ilUserDefinedData::lookupData($usr_ids, $udf_ids);
512 foreach ($data as $usr_id => $fields) {
513 if (!$this->checkAcceptance($usr_id)) {
514 continue;
515 }
516
517 foreach ($fields as $field_id => $value) {
518 $a_user_data[$usr_id]['udf_' . $field_id] = $value;
519 }
520 }
521 }
522 // Object specific user data fields
523 if ($odf_ids) {
524 include_once './Modules/Course/classes/Export/class.ilCourseUserData.php';
526 foreach ($data as $usr_id => $fields) {
527 // #7264: as we get data for all course members filter against user data
528 if (!$this->checkAcceptance($usr_id) || !in_array($usr_id, $usr_ids)) {
529 continue;
530 }
531
532 foreach ($fields as $field_id => $value) {
533 $a_user_data[$usr_id]['odf_' . $field_id] = $value;
534 }
535 }
536
537
538 // add last edit date
539 include_once './Services/Membership/classes/class.ilObjectCustomUserFieldHistory.php';
540 foreach (ilObjectCustomUserFieldHistory::lookupEntriesByObjectId($this->getRepositoryObject()->getId()) as $usr_id => $edit_info) {
541 if (!isset($a_user_data[$usr_id])) {
542 continue;
543 }
544
545 include_once './Services/PrivacySecurity/classes/class.ilPrivacySettings.php';
546 if ($usr_id == $edit_info['update_user']) {
547 $a_user_data[$usr_id]['odf_last_update'] = '';
548 $a_user_data[$usr_id]['odf_info_txt'] = $GLOBALS['DIC']['lng']->txt('cdf_edited_by_self');
549 if (ilPrivacySettings::_getInstance()->enabledAccessTimesByType($this->getRepositoryObject()->getType())) {
550 $a_user_data[$usr_id]['odf_last_update'] .= ('_' . $edit_info['editing_time']->get(IL_CAL_UNIX));
551 $a_user_data[$usr_id]['odf_info_txt'] .= (', ' . ilDatePresentation::formatDate($edit_info['editing_time']));
552 }
553 } else {
554 $a_user_data[$usr_id]['odf_last_update'] = $edit_info['update_user'];
555 $a_user_data[$usr_id]['odf_last_update'] .= ('_' . $edit_info['editing_time']->get(IL_CAL_UNIX));
556
557 $name = ilObjUser::_lookupName($edit_info['update_user']);
558 $a_user_data[$usr_id]['odf_info_txt'] = ($name['firstname'] . ' ' . $name['lastname'] . ', ' . ilDatePresentation::formatDate($edit_info['editing_time']));
559 }
560 }
561 }
562
563 // consultation hours
564 if ($this->isColumnSelected('consultation_hour')) {
565 include_once './Services/Booking/classes/class.ilBookingEntry.php';
566 foreach (ilBookingEntry::lookupManagedBookingsForObject($this->getRepositoryObject()->getId(), $GLOBALS['DIC']['ilUser']->getId()) as $buser => $booking) {
567 if (isset($a_user_data[$buser])) {
568 $a_user_data[$buser]['consultation_hour'] = $booking[0]['dt'];
569 $a_user_data[$buser]['consultation_hour_end'] = $booking[0]['dtend'];
570 $a_user_data[$buser]['consultation_hours'] = $booking;
571 }
572 }
573 }
574
575 // always sort by name first
576 $a_user_data = ilUtil::sortArray(
577 $a_user_data,
578 'name',
579 $this->getOrderDirection()
580 );
581
582 return $this->setData($a_user_data);
583 }
if(!defined('PATH_SEPARATOR')) $GLOBALS['_PEAR_default_error_mode']
Definition: PEAR.php:64
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
if($format !==null) $name
Definition: metadata.php:230

References ilTableGUI\$data, $DIC, $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

◆ $preLoader

ilCourseParticipantsTableGUI::$preLoader
private

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

◆ $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: