ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
class.ilSubscriberTableGUI.php
Go to the documentation of this file.
1<?php
2/*
3 +-----------------------------------------------------------------------------+
4 | ILIAS open source |
5 +-----------------------------------------------------------------------------+
6 | Copyright (c) 1998-2006 ILIAS open source, University of Cologne |
7 | |
8 | This program is free software; you can redistribute it and/or |
9 | modify it under the terms of the GNU General Public License |
10 | as published by the Free Software Foundation; either version 2 |
11 | of the License, or (at your option) any later version. |
12 | |
13 | This program is distributed in the hope that it will be useful, |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 | GNU General Public License for more details. |
17 | |
18 | You should have received a copy of the GNU General Public License |
19 | along with this program; if not, write to the Free Software |
20 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
21 +-----------------------------------------------------------------------------+
22*/
23
24include_once('./Services/Table/classes/class.ilTable2GUI.php');
25
26
36{
37 protected $subscribers = array();
38
42 protected $rep_object = null;
43
44 protected static $all_columns = null;
45 protected static $has_odf_definitions = false;
46 protected $show_subject = true;
47
48
56 public function __construct($a_parent_obj, $rep_object, $show_content = true, $show_subject = true)
57 {
58 global $lng,$ilCtrl;
59
60 $this->lng = $lng;
61 $this->lng->loadLanguageModule('grp');
62 $this->lng->loadLanguageModule('crs');
63 $this->ctrl = $ilCtrl;
64
65 $this->rep_object = $rep_object;
66
68
69 $this->setId('crs_sub_' . $this->getRepositoryObject()->getId());
70 parent::__construct($a_parent_obj, 'participants');
71
72 $this->setFormName('subscribers');
73 $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, 'participants'));
74
75 $this->addColumn('', 'f', "1");
76 $this->addColumn($this->lng->txt('name'), 'lastname', '20%');
77
78 $all_cols = $this->getSelectableColumns();
79 foreach ($this->getSelectedColumns() as $col) {
80 $this->addColumn($all_cols[$col]['txt'], $col);
81 }
82
83 $this->addColumn($this->lng->txt('application_date'), 'sub_time', "10%");
84
85 if ($this->getShowSubject()) {
86 $this->addColumn($this->lng->txt('subject'), 'subject', '15%');
87 }
88
89 $this->addColumn('', 'mail', '10%');
90
91 if ($this->getRepositoryObject()->getType() == "sess") {
92 $this->addMultiCommand('confirmAssignSubscribers', $this->lng->txt('sess_accept_request'));
93 } else {
94 $this->addMultiCommand('confirmAssignSubscribers', $this->lng->txt('assign'));
95 }
96
97 $this->addMultiCommand('confirmRefuseSubscribers', $this->lng->txt('refuse'));
98 $this->addMultiCommand('sendMailToSelectedUsers', $this->lng->txt('crs_mem_send_mail'));
99
100
101 $this->setPrefix('subscribers');
102 $this->setSelectAllCheckbox('subscribers');
103 $this->setRowTemplate("tpl.show_subscribers_row.html", "Services/Membership");
104
105 if ($show_content) {
106 $this->enable('sort');
107 $this->enable('header');
108 $this->enable('numinfo');
109 $this->enable('select_all');
110 } else {
111 $this->disable('content');
112 $this->disable('header');
113 $this->disable('footer');
114 $this->disable('numinfo');
115 $this->disable('select_all');
116 }
117
118 $this->setExternalSegmentation(true);
119
120 include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
121 self::$has_odf_definitions = ilCourseDefinedFieldDefinition::_hasFields($this->getRepositoryObject()->getId());
122 }
123
127 protected function getRepositoryObject()
128 {
129 return $this->rep_object;
130 }
131
136 public function getSelectableColumns()
137 {
138 if (self::$all_columns) {
139 return self::$all_columns;
140 }
141
142 include_once './Services/PrivacySecurity/classes/class.ilExportFieldsInfo.php';
144 self::$all_columns = $ef->getSelectableFieldsInfo($this->getRepositoryObject()->getId());
145
146 // #25215
147 if (
148 is_array(self::$all_columns) &&
149 array_key_exists('consultation_hour', self::$all_columns)
150 ) {
151 unset(self::$all_columns['consultation_hour']);
152 }
153 return self::$all_columns;
154 }
155
156
164 public function fillRow($a_set)
165 {
166 global $ilUser;
167
168
169 include_once './Modules/Course/classes/class.ilObjCourseGrouping.php';
172 $prefix = $this->getRepositoryObject()->getType();
173 $this->tpl->setVariable(
174 'ALERT_MSG',
175 sprintf(
176 $this->lng->txt($prefix . '_lim_assigned'),
177 ilObject::_lookupTitle(current($ids))
178 )
179 );
180 }
181
182 $this->tpl->setVariable('VAL_ID', $a_set['usr_id']);
183 $this->tpl->setVariable('VAL_NAME', $a_set['lastname'] . ', ' . $a_set['firstname']);
184
185 foreach ($this->getSelectedColumns() as $field) {
186 switch ($field) {
187 case 'gender':
188 $a_set['gender'] = $a_set['gender'] ? $this->lng->txt('gender_' . $a_set['gender']) : '';
189 $this->tpl->setCurrentBlock('custom_fields');
190 $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
191 $this->tpl->parseCurrentBlock();
192 break;
193
194 case 'birthday':
195 $a_set['birthday'] = $a_set['birthday'] ? ilDatePresentation::formatDate(new ilDate($a_set['birthday'], IL_CAL_DATE)) : $this->lng->txt('no_date');
196 $this->tpl->setCurrentBlock('custom_fields');
197 $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
198 $this->tpl->parseCurrentBlock();
199 break;
200
201 case 'odf_last_update':
202 $this->tpl->setVariable('VAL_CUST', (string) $a_set['odf_info_txt']);
203 break;
204
205 case 'org_units':
206 $this->tpl->setCurrentBlock('custom_fields');
207 include_once './Modules/OrgUnit/classes/PathStorage/class.ilOrgUnitPathStorage.php';
208 $this->tpl->setVariable('VAL_CUST', (string) ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($a_set['usr_id']));
209 $this->tpl->parseCurrentBlock();
210 break;
211
212 default:
213 $this->tpl->setCurrentBlock('custom_fields');
214 $this->tpl->setVariable('VAL_CUST', isset($a_set[$field]) ? (string) $a_set[$field] : '');
215 $this->tpl->parseCurrentBlock();
216 break;
217 }
218 }
219
220
221 $this->tpl->setVariable('VAL_SUBTIME', ilDatePresentation::formatDate(new ilDateTime($a_set['sub_time'], IL_CAL_UNIX)));
222
223
224 $this->showActionLinks($a_set);
225
226
227 if ($this->getShowSubject()) {
228 if (strlen($a_set['subject'])) {
229 $this->tpl->setCurrentBlock('subject');
230 $this->tpl->setVariable('VAL_SUBJECT', '"' . $a_set['subject'] . '"');
231 $this->tpl->parseCurrentBlock();
232 } else {
233 $this->tpl->touchBlock('subject');
234 }
235 }
236 }
237
242 public function showActionLinks($a_set)
243 {
244 if (!self::$has_odf_definitions) {
245 $this->ctrl->setParameterByClass(get_class($this->getParentObject()), 'member_id', $a_set['usr_id']);
246 $link = $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'sendMailToSelectedUsers');
247 $this->tpl->setVariable('MAIL_LINK', $link);
248 $this->tpl->setVariable('MAIL_TITLE', $this->lng->txt('crs_mem_send_mail'));
249 return true;
250 }
251
252 // show action menu
253 include_once './Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php';
255 $list->setSelectionHeaderClass('small');
256 $list->setItemLinkClass('small');
257 $list->setId('actl_' . $a_set['usr_id'] . '_' . $this->getId());
258 $list->setListTitle($this->lng->txt('actions'));
259
260 $this->ctrl->setParameterByClass(get_class($this->getParentObject()), 'member_id', $a_set['usr_id']);
261 $this->ctrl->setParameter($this->parent_obj, 'member_id', $a_set['usr_id']);
262 $trans = $this->lng->txt($this->getRepositoryObject()->getType() . '_mem_send_mail');
263 $link = $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'sendMailToSelectedUsers');
264 $list->addItem($trans, '', $link, 'sendMailToSelectedUsers');
265
266 $this->ctrl->setParameterByClass('ilobjectcustomuserfieldsgui', 'member_id', $a_set['usr_id']);
267 $trans = $this->lng->txt($this->getRepositoryObject()->getType() . '_cdf_edit_member');
268 $list->addItem($trans, '', $this->ctrl->getLinkTargetByClass('ilobjectcustomuserfieldsgui', 'editMember'));
269
270 $this->tpl->setVariable('ACTION_USER', $list->getHTML());
271 }
272
273
281 public function readSubscriberData(array $a_subscriber_ids)
282 {
284 $sub_ids = [];
285 foreach ($a_subscriber_ids as $usr_id) {
286 $sub_ids[] = $usr_id;
287 $sub_data[$usr_id] = $subscriber_data[$usr_id];
288 }
289
291
292 include_once './Services/User/classes/class.ilUserQuery.php';
293
294 $additional_fields = $this->getSelectedColumns();
295 unset($additional_fields["firstname"]);
296 unset($additional_fields["lastname"]);
297 unset($additional_fields["last_login"]);
298 unset($additional_fields["access_until"]);
299 unset($additional_fields['org_units']);
300
301 $udf_ids = $usr_data_fields = $odf_ids = array();
302 foreach ($additional_fields as $field) {
303 if (substr($field, 0, 3) == 'udf') {
304 $udf_ids[] = substr($field, 4);
305 continue;
306 }
307 if (substr($field, 0, 3) == 'odf') {
308 $odf_ids[] = substr($field, 4);
309 continue;
310 }
311
312 $usr_data_fields[] = $field;
313 }
314
316 $this->getOrderField(),
317 $this->getOrderDirection(),
318 $this->getOffset(),
319 $this->getLimit(),
320 '',
321 '',
322 null,
323 false,
324 false,
325 0,
326 0,
327 null,
328 $usr_data_fields,
329 $sub_ids
330 );
331
332 foreach ((array) $usr_data['set'] as $user) {
333 $usr_ids[] = $user['usr_id'];
334 }
335
336 // merge course data
337 $course_user_data = $this->getParentObject()->readMemberData($usr_ids, array());
338 $a_user_data = array();
339 foreach ((array) $usr_data['set'] as $ud) {
340 $a_user_data[$ud['usr_id']] = array_merge($ud, (array) $course_user_data[$ud['usr_id']]);
341 }
342
343 // Custom user data fields
344 if ($udf_ids) {
345 include_once './Services/User/classes/class.ilUserDefinedData.php';
346 $data = ilUserDefinedData::lookupData($usr_ids, $udf_ids);
347 foreach ($data as $usr_id => $fields) {
348 if (!$this->checkAcceptance($usr_id)) {
349 continue;
350 }
351
352 foreach ($fields as $field_id => $value) {
353 $a_user_data[$usr_id]['udf_' . $field_id] = $value;
354 }
355 }
356 }
357 // Object specific user data fields
358 if ($odf_ids) {
359 include_once './Modules/Course/classes/Export/class.ilCourseUserData.php';
361 foreach ($data as $usr_id => $fields) {
362 // #7264: as we get data for all course members filter against user data
363 if (!$this->checkAcceptance($usr_id) || !in_array($usr_id, $usr_ids)) {
364 continue;
365 }
366
367 foreach ($fields as $field_id => $value) {
368 $a_user_data[$usr_id]['odf_' . $field_id] = $value;
369 }
370 }
371
372 // add last edit date
373 include_once './Services/Membership/classes/class.ilObjectCustomUserFieldHistory.php';
374 foreach (ilObjectCustomUserFieldHistory::lookupEntriesByObjectId($this->getRepositoryObject()->getId()) as $usr_id => $edit_info) {
375 if (!isset($a_user_data[$usr_id])) {
376 continue;
377 }
378
379 include_once './Services/PrivacySecurity/classes/class.ilPrivacySettings.php';
380 if ($usr_id == $edit_info['update_user']) {
381 $a_user_data[$usr_id]['odf_last_update'] = '';
382 $a_user_data[$usr_id]['odf_info_txt'] = $GLOBALS['lng']->txt('cdf_edited_by_self');
383 if (ilPrivacySettings::_getInstance()->enabledAccessTimesByType($this->getRepositoryObject()->getType())) {
384 $a_user_data[$usr_id]['odf_last_update'] .= ('_' . $edit_info['editing_time']->get(IL_CAL_UNIX));
385 $a_user_data[$usr_id]['odf_info_txt'] .= (', ' . ilDatePresentation::formatDate($edit_info['editing_time']));
386 }
387 } else {
388 $a_user_data[$usr_id]['odf_last_update'] = $edit_info['update_user'];
389 $a_user_data[$usr_id]['odf_last_update'] .= ('_' . $edit_info['editing_time']->get(IL_CAL_UNIX));
390
391 $name = ilObjUser::_lookupName($edit_info['update_user']);
392 $a_user_data[$usr_id]['odf_info_txt'] = ($name['firstname'] . ' ' . $name['lastname'] . ', ' . ilDatePresentation::formatDate($edit_info['editing_time']));
393 }
394 }
395 }
396
397 foreach ($usr_data['set'] as $user) {
398 // Check acceptance
399 if (!$this->checkAcceptance($user['usr_id'])) {
400 continue;
401 }
402 // DONE: accepted
403 foreach ($usr_data_fields as $field) {
404 $a_user_data[$user['usr_id']][$field] = $user[$field] ? $user[$field] : '';
405 }
406 }
407
408 // Waiting list subscription
409 foreach ($sub_data as $usr_id => $usr_data) {
410 if (!in_array($usr_id, $usr_ids)) {
411 continue;
412 }
413 $a_user_data[$usr_id]['sub_time'] = $usr_data['time'];
414 $a_user_data[$usr_id]['subject'] = $usr_data['subject'];
415 }
416
417 $this->setMaxCount(count($sub_ids));
418 return $this->setData($a_user_data);
419 }
420
421 protected function checkAcceptance()
422 {
423 return true;
424 }
425
426 public function setShowSubject($a_value)
427 {
428 $this->show_subject = (bool) $a_value;
429 }
430
431 public function getShowSubject()
432 {
433 return $this->show_subject;
434 }
435}
sprintf('%.4f', $callTime)
An exception for terminatinating execution or to throw for unit testing.
const IL_CAL_DATE
const IL_CAL_UNIX
User interface class for advanced drop-down selection lists.
static _hasFields($a_container_id)
Check if there are any define fields.
static _getValuesByObjId($a_obj_id)
Get values by obj_id (for all users)
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false)
Format a date @access public.
@classDescription Date and time handling
Class for single dates.
static _getInstanceByType($a_type)
Get Singleton Instance.
static _checkGroupingDependencies(&$container_obj, $a_user_id=null)
static getAssignedObjects()
Alway call checkGroupingDependencies before.
static _lookupName($a_user_id)
lookup user name
static lookupEntriesByObjectId($a_obj_id)
Get entries by obj_id @global type $ilDB.
static _lookupTitle($a_id)
lookup object title
static lookupSubscribersData($a_obj_id)
static _getInstance()
Get instance of ilPrivacySettings.
GUI class for course/group subscriptions.
getSelectableColumns()
Get selectable columns.
readSubscriberData(array $a_subscriber_ids)
read data
showActionLinks($a_set)
Show action links (mail ; edit crs|grp data)
__construct($a_parent_obj, $rep_object, $show_content=true, $show_subject=true)
Constructor.
Class ilTable2GUI.
getSelectedColumns()
Get selected columns.
getParentObject()
Get parent object.
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...
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
getId()
Get element id.
setData($a_data)
set table data @access public
getLimit()
Get limit.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
addMultiCommand($a_cmd, $a_text)
Add Command button.
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.
getOffset()
Get offset.
setExternalSegmentation($a_val)
Set external segmentation.
setId($a_val)
Set id.
setFormName($a_formname="")
Set Form name.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
getOrderDirection()
Get order direction.
setMaxCount($a_max_count)
set max.
disable($a_module_name)
diesables particular modules of table
enable($a_module_name)
enables particular modules of table
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.
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
global $ilCtrl
Definition: ilias.php:18
if($format !==null) $name
Definition: metadata.php:146
if(isset($_REQUEST['delete'])) $list
Definition: registry.php:41
$ilUser
Definition: imgupload.php:18