ILIAS  release_4-4 Revision
ilCourseParticipantsTableGUI Class Reference
+ Inheritance diagram for ilCourseParticipantsTableGUI:
+ Collaboration diagram for ilCourseParticipantsTableGUI:

Public Member Functions

 __construct ( $a_parent_obj, $a_type='admin', $show_content=true, $a_show_learning_progress=false, $a_show_timings=false, $a_show_edit_link=true, $a_role_id=0, $a_show_lp_status_sync=false)
 Constructor. More...
 
 setRoleId ($a_role_id)
 Set current role id. More...
 
 getRoleId ()
 Get current role id. More...
 
 getItems ()
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 fillRow ($a_set)
 fill row More...
 
 parse ()
 Parse data. More...
 
 checkAcceptance ($a_usr_id)
 
 initAcceptedAgreements ()
 Init acceptance. More...
 
- 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)
 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)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="")
 Add Command button. 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="")
 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 ()
 
- Public Member Functions inherited from ilTableGUI
 ilTableGUI ($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 Attributes

 $type = 'admin'
 
 $show_learning_progress = false
 
 $show_timings = false
 
 $show_edit_link = true
 
 $role_id = 0
 
- 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 = 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
 
 $row_selector_label
 

Static Protected Attributes

static $export_allowed = false
 
static $confirmation_required = true
 
static $accepted_ids = null
 
static $all_columns = null
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- Data Fields inherited from ilTable2GUI
const FILTER_TEXT = 1
 
const FILTER_SELECT = 2
 
const FILTER_DATE = 3
 
const FILTER_LANGUAGE = 4
 
const FILTER_NUMBER_RANGE = 5
 
const FILTER_DATE_RANGE = 6
 
const FILTER_DURATION_RANGE = 7
 
const FILTER_DATETIME_RANGE = 8
 
const EXPORT_EXCEL = 1
 
const EXPORT_CSV = 2
 
const ACTION_ALL_LIMIT = 1000
 
- Data Fields inherited from ilTableGUI
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Row. More...
 
 fillRowExcel ($a_worksheet, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

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 34 of file class.ilCourseParticipantsTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCourseParticipantsTableGUI::__construct (   $a_parent_obj,
  $a_type = 'admin',
  $show_content = true,
  $a_show_learning_progress = false,
  $a_show_timings = false,
  $a_show_edit_link = true,
  $a_role_id = 0,
  $a_show_lp_status_sync = false 
)

Constructor.

public

Parameters

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

References $ilCtrl, $lng, ilObjUserTracking\_enabledLearningProgress(), ilPrivacySettings\_getInstance(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTableGUI\disable(), ilTableGUI\enable(), getItems(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), initAcceptedAgreements(), ilTable2GUI\initFilter(), ilCertificate\isActive(), ilCertificate\isObjectActive(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setFormName(), ilTable2GUI\setId(), setRoleId(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTopCommands().

63  {
64  global $lng, $ilCtrl;
65 
66  $this->show_learning_progress = $a_show_learning_progress;
67  $this->show_timings = $a_show_timings;
68  $this->show_edit_link = $a_show_edit_link;
69  $this->show_lp_status_sync = $a_show_lp_status_sync;
70 
71  // #13208
72  include_once("Services/Tracking/classes/class.ilObjUserTracking.php");
74  {
75  $this->show_lp_status_sync = false;
76  }
77 
78  $this->lng = $lng;
79  $this->lng->loadLanguageModule('crs');
80  $this->lng->loadLanguageModule('trac');
81  $this->ctrl = $ilCtrl;
82 
83  $this->type = $a_type;
84  $this->setRoleId($a_role_id);
85 
86  include_once('./Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
87  $this->privacy = ilPrivacySettings::_getInstance();
88 
89  // required before constructor for columns
90  $this->setId('crs_' . $a_type . '_' . $a_role_id.'_'. $a_parent_obj->object->getId());
91  parent::__construct($a_parent_obj, 'members');
92 
93  $this->initAcceptedAgreements();
94 
95  $this->setFormName('participants');
96 
97  $this->addColumn('', 'f', "1");
98  $this->addColumn($this->lng->txt('name'), 'lastname', '20%');
99 
100  $all_cols = $this->getSelectableColumns();
101  foreach($this->getSelectedColumns() as $col)
102  {
103  $this->addColumn($all_cols[$col]['txt'], $col);
104  }
105 
106  if($this->show_learning_progress)
107  {
108  $this->addColumn($this->lng->txt('learning_progress'), 'progress');
109  }
110 
111  if($this->privacy->enabledCourseAccessTimes())
112  {
113  $this->addColumn($this->lng->txt('last_access'), 'access_ut', '16em');
114  }
115 
116  $this->addColumn($this->lng->txt('crs_member_passed'), 'passed');
117  if($this->show_lp_status_sync)
118  {
119  $this->addColumn($this->lng->txt('crs_member_passed_status_changed'), 'passed_info');
120  }
121 
122  if($this->type == 'admin')
123  {
124  $this->setSelectAllCheckbox('admins');
125  $this->addColumn($this->lng->txt('crs_notification_list_title'), 'notification');
126  $this->addCommandButton('updateAdminStatus', $this->lng->txt('save'));
127  }
128  elseif($this->type == 'tutor')
129  {
130  $this->setSelectAllCheckbox('tutors');
131  $this->addColumn($this->lng->txt('crs_notification_list_title'), 'notification');
132  $this->addCommandButton('updateTutorStatus', $this->lng->txt('save'));
133  }
134  elseif($this->type == 'member')
135  {
136  $this->setSelectAllCheckbox('members');
137  $this->addColumn($this->lng->txt('crs_blocked'), 'blocked');
138  $this->addCommandButton('updateMemberStatus', $this->lng->txt('save'));
139  }
140  else
141  {
142  $this->setSelectAllCheckbox('roles');
143  $this->addColumn($this->lng->txt('crs_blocked'), 'blocked');
144  $this->addCommandButton('updateRoleStatus', $this->lng->txt('save'));
145 
146  }
147  $this->addColumn($this->lng->txt(''), 'optional');
148 
149  $this->setRowTemplate("tpl.show_participants_row.html", "Modules/Course");
150 
151  if($show_content)
152  {
153  $this->setDefaultOrderField('lastname');
154  $this->enable('sort');
155  $this->enable('header');
156  $this->enable('numinfo');
157  $this->enable('select_all');
158  }
159  else
160  {
161  $this->disable('content');
162  $this->disable('header');
163  $this->disable('footer');
164  $this->disable('numinfo');
165  $this->disable('select_all');
166  }
167 
168  $this->setEnableNumInfo(true);
169  $this->setExternalSegmentation(true);
170 
171  $this->getItems();
172  $this->setTopCommands(true);
173  $this->setEnableHeader(true);
174  $this->setEnableTitle(true);
175  $this->initFilter();
176 
177  $this->setShowRowsSelector(true);
178 
179  include_once "Services/Certificate/classes/class.ilCertificate.php";
180  $this->enable_certificates = ilCertificate::isActive();
181  if($this->enable_certificates)
182  {
183  $this->enable_certificates = ilCertificate::isObjectActive($a_parent_obj->object->getId());
184  }
185  if($this->enable_certificates)
186  {
187  $lng->loadLanguageModule('certificate');
188  }
189  }
initFilter()
Init filter.
setFormName($a_formname)
Set Form name.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
setEnableNumInfo($a_val)
Set enable num info.
setExternalSegmentation($a_val)
Set external segmentation.
setId($a_val)
Set id.
global $ilCtrl
Definition: ilias.php:18
static _enabledLearningProgress()
check wether learing progress is enabled or not
setTopCommands($a_val)
Set top commands (display command buttons on top of table, too)
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="")
Add a column to the header.
setRoleId($a_role_id)
Set current role id.
enable($a_module_name)
enables particular modules of table
getSelectedColumns()
Get selected columns.
addCommandButton($a_cmd, $a_text, $a_onclick='', $a_id="")
Add Command button.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
static isObjectActive($a_obj_id)
disable($a_module_name)
diesables particular modules of table
global $lng
Definition: privfeed.php:40
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
setEnableHeader($a_enableheader)
Set Enable Header.
static _getInstance()
Get instance of ilPrivacySettings.
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.
+ Here is the call graph for this function:

Member Function Documentation

◆ checkAcceptance()

ilCourseParticipantsTableGUI::checkAcceptance (   $a_usr_id)

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

Referenced by parse().

593  {
594  if(!self::$confirmation_required)
595  {
596  return true;
597  }
598  if(!self::$export_allowed)
599  {
600  return false;
601  }
602  return in_array($a_usr_id, self::$accepted_ids);
603  }
+ Here is the caller graph for this function:

◆ fillRow()

ilCourseParticipantsTableGUI::fillRow (   $a_set)

fill row

public

Parameters

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

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

250  {
251  global $ilAccess;
252 
253  $this->tpl->setVariable('VAL_ID', $a_set['usr_id']);
254  $this->tpl->setVariable('VAL_NAME', $a_set['lastname'] . ', ' . $a_set['firstname']);
255 
256  if(!$ilAccess->checkAccessOfUser($a_set['usr_id'], 'read', '', $this->getParentObject()->object->getRefId()) and
257  is_array($info = $ilAccess->getInfo()))
258  {
259  $this->tpl->setCurrentBlock('access_warning');
260  $this->tpl->setVariable('PARENT_ACCESS', $info[0]['text']);
261  $this->tpl->parseCurrentBlock();
262  }
263 
264  if(!ilObjUser::_lookupActive($a_set['usr_id']))
265  {
266  $this->tpl->setCurrentBlock('access_warning');
267  $this->tpl->setVariable('PARENT_ACCESS', $this->lng->txt('usr_account_inactive'));
268  $this->tpl->parseCurrentBlock();
269  }
270 
271 
272  foreach($this->getSelectedColumns() as $field)
273  {
274  switch($field)
275  {
276  case 'gender':
277  $a_set['gender'] = $a_set['gender'] ? $this->lng->txt('gender_' . $a_set['gender']) : '';
278  $this->tpl->setCurrentBlock('custom_fields');
279  $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
280  $this->tpl->parseCurrentBlock();
281  break;
282 
283  case 'birthday':
284  $a_set['birthday'] = $a_set['birthday'] ? ilDatePresentation::formatDate(new ilDate($a_set['birthday'], IL_CAL_DATE)) : $this->lng->txt('no_date');
285  $this->tpl->setCurrentBlock('custom_fields');
286  $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
287  $this->tpl->parseCurrentBlock();
288  break;
289 
290  case 'consultation_hour':
291  $this->tpl->setCurrentBlock('custom_fields');
292  $dts = array();
293  foreach((array) $a_set['consultation_hours'] as $ch)
294  {
296  new ilDateTime($ch['dt'],IL_CAL_UNIX),
297  new ilDateTime($ch['dtend'],IL_CAL_UNIX)
298  );
299  if($ch['explanation'])
300  {
301  $tmp .= ' ' . $ch['explanation'];
302  }
303  $dts[] = $tmp;
304  }
305  $dt_string = implode('<br />', $dts);
306  $this->tpl->setVariable('VAL_CUST',$dt_string);
307  $this->tpl->parseCurrentBlock();
308  break;
309 
310  case 'prtf':
311  $tmp = array();
312  if(is_array($a_set['prtf']))
313  {
314  foreach($a_set['prtf'] as $prtf_url => $prtf_txt)
315  {
316  $tmp[] = '<a href="'.$prtf_url.'">'.$prtf_txt.'</a>';
317  }
318  }
319  $this->tpl->setVariable('VAL_CUST', implode('<br />', $tmp)) ;
320  break;
321 
322  default:
323  $this->tpl->setCurrentBlock('custom_fields');
324  $this->tpl->setVariable('VAL_CUST', isset($a_set[$field]) ? (string) $a_set[$field] : '');
325  $this->tpl->parseCurrentBlock();
326  break;
327  }
328  }
329 
330  if($this->privacy->enabledCourseAccessTimes())
331  {
332  $this->tpl->setVariable('VAL_ACCESS', $a_set['access_time']);
333  }
334  if($this->show_learning_progress)
335  {
336  $this->tpl->setCurrentBlock('lp');
337  switch($a_set['progress'])
338  {
340  $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt($a_set['progress']));
341  $this->tpl->setVariable('LP_STATUS_PATH', ilUtil::getImagePath('scorm/complete.png'));
342  break;
343 
345  $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt($a_set['progress']));
346  $this->tpl->setVariable('LP_STATUS_PATH', ilUtil::getImagePath('scorm/incomplete.png'));
347  break;
348 
350  $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt($a_set['progress']));
351  $this->tpl->setVariable('LP_STATUS_PATH', ilUtil::getImagePath('scorm/not_attempted.png'));
352  break;
353 
355  $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt($a_set['progress']));
356  $this->tpl->setVariable('LP_STATUS_PATH', ilUtil::getImagePath('scorm/failed.png'));
357  break;
358  }
359  $this->tpl->parseCurrentBlock();
360  }
361  if($this->type == 'admin')
362  {
363  $this->tpl->setVariable('VAL_POSTNAME', 'admins');
364  $this->tpl->setVariable('VAL_NOTIFICATION_ID', $a_set['usr_id']);
365  $this->tpl->setVariable('VAL_NOTIFICATION_CHECKED', ($a_set['notification'] ? 'checked="checked"' : ''));
366  }
367  elseif($this->type == 'tutor')
368  {
369  $this->tpl->setVariable('VAL_POSTNAME', 'tutors');
370  $this->tpl->setVariable('VAL_NOTIFICATION_ID', $a_set['usr_id']);
371  $this->tpl->setVariable('VAL_NOTIFICATION_CHECKED', ($a_set['notification'] ? 'checked="checked"' : ''));
372  }
373  elseif($this->type == 'member')
374  {
375  $this->tpl->setCurrentBlock('blocked');
376  $this->tpl->setVariable('VAL_POSTNAME','members');
377  $this->tpl->setVariable('VAL_BLOCKED_ID',$a_set['usr_id']);
378  $this->tpl->setVariable('VAL_BLOCKED_CHECKED',($a_set['blocked'] ? 'checked="checked"' : ''));
379  $this->tpl->parseCurrentBlock();
380  }
381  else
382  {
383  $this->tpl->setCurrentBlock('blocked');
384  $this->tpl->setVariable('VAL_BLOCKED_ID', $a_set['usr_id']);
385  $this->tpl->setVariable('VAL_BLOCKED_CHECKED', ($a_set['blocked'] ? 'checked="checked"' : ''));
386  $this->tpl->parseCurrentBlock();
387 
388  $this->tpl->setVariable('VAL_POSTNAME','roles');
389  }
390 
391  $this->tpl->setVariable('VAL_PASSED_ID',$a_set['usr_id']);
392  $this->tpl->setVariable('VAL_PASSED_CHECKED',($a_set['passed'] ? 'checked="checked"' : ''));
393 
394  if($this->show_lp_status_sync)
395  {
396  $this->tpl->setVariable('PASSED_INFO', $a_set["passed_info"]);
397  }
398 
399  $this->ctrl->setParameter($this->parent_obj, 'member_id', $a_set['usr_id']);
400  if($this->show_edit_link)
401  {
402  $this->tpl->setCurrentBlock('link');
403  $this->tpl->setVariable('LINK_NAME', $this->ctrl->getLinkTarget($this->parent_obj, 'editMember'));
404  $this->tpl->setVariable('LINK_TXT', $this->lng->txt('edit'));
405  $this->tpl->parseCurrentBlock();
406  }
407  if($a_set['passed'] && $this->enable_certificates)
408  {
409  $this->tpl->setCurrentBlock('link');
410  $this->tpl->setVariable('LINK_NAME', $this->ctrl->getLinkTarget($this->parent_obj, 'deliverCertificate'));
411  $this->tpl->setVariable('LINK_TXT', $this->lng->txt('download_certificate'));
412  $this->tpl->parseCurrentBlock();
413  }
414  $this->ctrl->clearParameters($this->parent_obj);
415 
416  if($this->show_timings)
417  {
418  $this->ctrl->setParameterByClass('ilcoursecontentgui', 'member_id', $a_set['usr_id']);
419  $this->tpl->setCurrentBlock('link');
420  $this->tpl->setVariable('LINK_NAME', $this->ctrl->getLinkTargetByClass('ilcoursecontentgui', 'showUserTimings'));
421  $this->tpl->setVariable('LINK_TXT', $this->lng->txt('timings_timings'));
422  $this->tpl->parseCurrentBlock();
423  }
424  }
const LP_STATUS_NOT_ATTEMPTED
static formatPeriod(ilDateTime $start, ilDateTime $end)
Format a period of two date Shows: 14.
const IL_CAL_UNIX
const LP_STATUS_IN_PROGRESS
const LP_STATUS_FAILED
Class for single dates.
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
static formatDate(ilDateTime $date)
Format a date public.
Date and time handling
getSelectedColumns()
Get selected columns.
_lookupActive($a_usr_id)
Check user account active.
const IL_CAL_DATE
const LP_STATUS_COMPLETED
+ Here is the call graph for this function:

◆ getItems()

ilCourseParticipantsTableGUI::getItems ( )

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

Referenced by __construct().

209  {
210 
211  }
+ Here is the caller graph for this function:

◆ getRoleId()

ilCourseParticipantsTableGUI::getRoleId ( )

Get current role id.

Returns
int

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

References $role_id.

Referenced by parse().

+ Here is the caller graph for this function:

◆ getSelectableColumns()

ilCourseParticipantsTableGUI::getSelectableColumns ( )

Get selectable columns.

Returns

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

References $ilSetting, ilExportFieldsInfo\_getInstanceByType(), and ilTable2GUI\getParentObject().

Referenced by __construct().

218  {
219  global $ilSetting;
220 
221  if(self::$all_columns)
222  {
223  #return self::$all_columns;
224  }
225 
226  include_once './Services/PrivacySecurity/classes/class.ilExportFieldsInfo.php';
227  $ef = ilExportFieldsInfo::_getInstanceByType($this->getParentObject()->object->getType());
228  self::$all_columns = $ef->getSelectableFieldsInfo($this->getParentObject()->object->getId());
229 
230  if ($this->type == 'member' &&
231  $ilSetting->get('user_portfolios'))
232  {
233  self::$all_columns['prtf'] = array(
234  'txt' => $this->lng->txt('obj_prtf'),
235  'default' => false
236  );
237  }
238 
239  return self::$all_columns;
240  }
getParentObject()
Get parent object.
static _getInstanceByType($a_type)
Get Singleton Instance.
global $ilSetting
Definition: privfeed.php:40
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initAcceptedAgreements()

ilCourseParticipantsTableGUI::initAcceptedAgreements ( )

Init acceptance.

Returns

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

References ilPrivacySettings\_getInstance(), ilTable2GUI\getParentObject(), and ilMemberAgreement\lookupAcceptedAgreements().

Referenced by __construct().

610  {
611  if(self::$accepted_ids !== NULL)
612  {
613  return true;
614  }
615 
616  self::$export_allowed = ilPrivacySettings::_getInstance()->checkExportAccess($this->getParentObject()->object->getRefId());
617  self::$confirmation_required = ilPrivacySettings::_getInstance()->courseConfirmationRequired();
618 
619  include_once 'Services/Membership/classes/class.ilMemberAgreement.php';
620  self::$accepted_ids = ilMemberAgreement::lookupAcceptedAgreements($this->getParentObject()->object->getId());
621  }
getParentObject()
Get parent object.
static _getInstance()
Get instance of ilPrivacySettings.
static lookupAcceptedAgreements($a_obj_id)
Lookup users who have accepted the agreement.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parse()

ilCourseParticipantsTableGUI::parse ( )

Parse data.

Returns

ilRbacReview $rbacreview

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

References ilTableGUI\$data, $GLOBALS, $usr_id, ilCourseUserData\_getValuesByObjId(), ilObjUser\_lookupName(), checkAcceptance(), ilTable2GUI\determineOffsetAndOrder(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\getParentObject(), getRoleId(), ilTable2GUI\getSelectedColumns(), ilUserQuery\getUserListData(), ilTable2GUI\isColumnSelected(), ilUserDefinedData\lookupData(), ilBookingEntry\lookupManagedBookingsForObject(), ilTable2GUI\setData(), and ilTableGUI\setMaxCount().

433  {
434  global $rbacreview;
435 
436  $this->determineOffsetAndOrder();
437 
438  include_once './Services/User/classes/class.ilUserQuery.php';
439 
440  $additional_fields = $this->getSelectedColumns();
441  unset($additional_fields["firstname"]);
442  unset($additional_fields["lastname"]);
443  unset($additional_fields["last_login"]);
444  unset($additional_fields["access_until"]);
445  unset($additional_fields['consultation_hour']);
446  unset($additional_fields['prtf']);
447 
448  $udf_ids = $usr_data_fields = $odf_ids = array();
449  foreach($additional_fields as $field)
450  {
451  if(substr($field, 0, 3) == 'udf')
452  {
453  $udf_ids[] = substr($field, 4);
454  continue;
455  }
456  if(substr($field, 0, 3) == 'odf')
457  {
458  $odf_ids[] = substr($field, 4);
459  continue;
460  }
461 
462  $usr_data_fields[] = $field;
463  }
464 
465  $usr_data = ilUserQuery::getUserListData(
466  $this->getOrderField(),
467  $this->getOrderDirection(),
468  $this->getOffset(),
469  $this->getLimit(),
470  '',
471  '',
472  null,
473  false,
474  false,
475  0,
476  $this->getRoleId(),
477  null,
478  $usr_data_fields,
479  $part
480  );
481  foreach((array) $usr_data['set'] as $user)
482  {
483  $usr_ids[] = $user['usr_id'];
484  }
485 
486  // merge course data
487  $course_user_data = $this->getParentObject()->readMemberData($usr_ids,
488  $this->type == 'admin',
489  $this->getSelectedColumns());
490  $a_user_data = array();
491  foreach((array) $usr_data['set'] as $ud)
492  {
493  $a_user_data[$ud['usr_id']] = array_merge($ud,$course_user_data[$ud['usr_id']]);
494 
495  if($this->show_lp_status_sync)
496  {
497  // #9912 / #13208
498  $passed_info = "";
499  if($a_user_data[$ud['usr_id']]["passed_info"])
500  {
501  $pinfo = $a_user_data[$ud['usr_id']]["passed_info"];
502  if($pinfo["user_id"])
503  {
504  if($pinfo["user_id"] < 0)
505  {
506  $passed_info = $this->lng->txt("crs_passed_status_system");
507  }
508  else if($pinfo["user_id"] > 0)
509  {
510  $name = ilObjUser::_lookupName($pinfo["user_id"]);
511  $passed_info = $this->lng->txt("crs_passed_status_manual_by").": ".$name["login"];
512  }
513  }
514  if($pinfo["timestamp"])
515  {
516  $passed_info .= "<br />".ilDatePresentation::formatDate($pinfo["timestamp"]);
517  }
518  }
519  $a_user_data[$ud['usr_id']]["passed_info"] = $passed_info;
520  }
521  }
522 
523  // Custom user data fields
524  if($udf_ids)
525  {
526  include_once './Services/User/classes/class.ilUserDefinedData.php';
527  $data = ilUserDefinedData::lookupData($usr_ids, $udf_ids);
528  foreach($data as $usr_id => $fields)
529  {
530  if(!$this->checkAcceptance($usr_id))
531  {
532  continue;
533  }
534 
535  foreach($fields as $field_id => $value)
536  {
537  $a_user_data[$usr_id]['udf_' . $field_id] = $value;
538  }
539  }
540  }
541  // Object specific user data fields
542  if($odf_ids)
543  {
544  include_once './Modules/Course/classes/Export/class.ilCourseUserData.php';
545  $data = ilCourseUserData::_getValuesByObjId($this->getParentObject()->object->getId());
546  foreach($data as $usr_id => $fields)
547  {
548  // #7264: as we get data for all course members filter against user data
549  if(!$this->checkAcceptance($usr_id) || !in_array($usr_id, $usr_ids))
550  {
551  continue;
552  }
553 
554  foreach($fields as $field_id => $value)
555  {
556  $a_user_data[$usr_id]['odf_' . $field_id] = $value;
557  }
558  }
559  }
560 
561  foreach($usr_data['set'] as $user)
562  {
563  // Check acceptance
564  if(!$this->checkAcceptance($user['usr_id']))
565  {
566  continue;
567  }
568  // DONE: accepted
569  foreach($usr_data_fields as $field)
570  {
571  $a_user_data[$user['usr_id']][$field] = $user[$field] ? $user[$field] : '';
572  }
573  }
574  // consultation hours
575  if($this->isColumnSelected('consultation_hour'))
576  {
577  include_once './Services/Booking/classes/class.ilBookingEntry.php';
578  foreach(ilBookingEntry::lookupManagedBookingsForObject($this->getParentObject()->object->getId(), $GLOBALS['ilUser']->getId()) as $buser => $booking)
579  {
580  if(isset($a_user_data[$buser]))
581  {
582  $a_user_data[$buser]['consultation_hour'] = $booking[0]['dt'];
583  $a_user_data[$buser]['consultation_hour_end'] = $booking[0]['dtend'];
584  $a_user_data[$buser]['consultation_hours'] = $booking;
585  }
586  }
587  }
588  $this->setMaxCount($usr_data['cnt'] ? $usr_data['cnt'] : 0);
589  return $this->setData($a_user_data);
590  }
static _lookupName($a_user_id)
lookup user name
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="")
Get data for user administration list.
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)
getOrderDirection()
Get order direction.
getParentObject()
Get parent object.
static lookupData($a_user_ids, $a_field_ids)
Lookup data.
$GLOBALS['ct_recipient']
getOffset()
Get offset.
getSelectedColumns()
Get selected columns.
isColumnSelected($a_col)
Is given column selected?
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
getLimit()
Get limit.
setMaxCount($a_max_count)
set max.
+ Here is the call graph for this function:

◆ setRoleId()

ilCourseParticipantsTableGUI::setRoleId (   $a_role_id)

Set current role id.

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

Referenced by __construct().

195  {
196  $this->role_id = $a_role_id;
197  }
+ Here is the caller graph for this function:

Field Documentation

◆ $accepted_ids

ilCourseParticipantsTableGUI::$accepted_ids = null
staticprotected

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

◆ $all_columns

ilCourseParticipantsTableGUI::$all_columns = null
staticprotected

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

◆ $confirmation_required

ilCourseParticipantsTableGUI::$confirmation_required = true
staticprotected

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

◆ $export_allowed

ilCourseParticipantsTableGUI::$export_allowed = false
staticprotected

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

◆ $role_id

ilCourseParticipantsTableGUI::$role_id = 0
protected

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

Referenced by getRoleId().

◆ $show_edit_link

ilCourseParticipantsTableGUI::$show_edit_link = true
protected

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

◆ $show_learning_progress

ilCourseParticipantsTableGUI::$show_learning_progress = false
protected

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

◆ $show_timings

ilCourseParticipantsTableGUI::$show_timings = false
protected

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

◆ $type

ilCourseParticipantsTableGUI::$type = 'admin'
protected

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


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