ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
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 $DIC;
59
60 $lng = $DIC['lng'];
61 $ilCtrl = $DIC['ilCtrl'];
62
63 $this->lng = $lng;
64 $this->lng->loadLanguageModule('grp');
65 $this->lng->loadLanguageModule('crs');
66 $this->ctrl = $ilCtrl;
67
68 $this->rep_object = $rep_object;
69
71
72 $this->setId('crs_sub_' . $this->getRepositoryObject()->getId());
73 parent::__construct($a_parent_obj, 'participants');
74
75 $this->setFormName('subscribers');
76 $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, 'participants'));
77
78 $this->addColumn('', 'f', "1%", true);
79 $this->addColumn($this->lng->txt('name'), 'lastname', '20%');
80
81 $all_cols = $this->getSelectableColumns();
82 foreach ($this->getSelectedColumns() as $col) {
83 $this->addColumn(
84 $all_cols[$col]['txt'],
85 $col,
86 array_key_exists('width', $all_cols[$col]) ? $all_cols[$col]['width'] : null
87 );
88 }
89
90
91 if ($this->getShowSubject()) {
92 $this->addColumn($this->lng->txt('application_date'), 'sub_time', "20%");
93 $this->addColumn($this->lng->txt('subject'), 'subject', '60%');
94 } else {
95 $this->addColumn($this->lng->txt('application_date'), 'sub_time', "60%");
96 }
97
98 $this->addColumn('', 'mail', '20%');
99
100 if ($this->getRepositoryObject()->getType() == "sess") {
101 $this->addMultiCommand('confirmAssignSubscribers', $this->lng->txt('sess_accept_request'));
102 } else {
103 $this->addMultiCommand('confirmAssignSubscribers', $this->lng->txt('assign'));
104 }
105
106 $this->addMultiCommand('confirmRefuseSubscribers', $this->lng->txt('refuse'));
107 $this->addMultiCommand('sendMailToSelectedUsers', $this->lng->txt('crs_mem_send_mail'));
108
109
110 $this->setPrefix('subscribers');
111 $this->setSelectAllCheckbox('subscribers', true);
112 $this->setRowTemplate("tpl.show_subscribers_row.html", "Services/Membership");
113
114 if ($show_content) {
115 $this->enable('sort');
116 $this->enable('header');
117 $this->enable('numinfo');
118 $this->enable('select_all');
119 } else {
120 $this->disable('content');
121 $this->disable('header');
122 $this->disable('footer');
123 $this->disable('numinfo');
124 $this->disable('select_all');
125 }
126
127 $this->setExternalSegmentation(true);
128
129 include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
130 self::$has_odf_definitions = ilCourseDefinedFieldDefinition::_hasFields($this->getRepositoryObject()->getId());
131 }
132
136 protected function getRepositoryObject()
137 {
138 return $this->rep_object;
139 }
140
145 public function getSelectableColumns()
146 {
147 if (self::$all_columns) {
148 return self::$all_columns;
149 }
150
151 if ($this->getRepositoryObject()->getType() == 'sess') {
152 self::$all_columns['login'] = [
153 'txt' => $this->lng->txt('login'),
154 'width' => '15%',
155 'default' => 1
156 ];
157 return self::$all_columns;
158 }
159
160
161 include_once './Services/PrivacySecurity/classes/class.ilExportFieldsInfo.php';
163 self::$all_columns = $ef->getSelectableFieldsInfo($this->getRepositoryObject()->getId());
164
165 // #25215
166 if (
167 is_array(self::$all_columns) &&
168 array_key_exists('consultation_hour', self::$all_columns)
169 ) {
170 unset(self::$all_columns['consultation_hour']);
171 }
172 return self::$all_columns;
173 }
174
175
183 public function fillRow($a_set)
184 {
185 global $DIC;
186
187 $ilUser = $DIC['ilUser'];
188
189
190 include_once './Modules/Course/classes/class.ilObjCourseGrouping.php';
193 $prefix = $this->getRepositoryObject()->getType();
194 $this->tpl->setVariable(
195 'ALERT_MSG',
196 sprintf(
197 $this->lng->txt($prefix . '_lim_assigned'),
198 ilObject::_lookupTitle(current($ids))
199 )
200 );
201 }
202
203 $this->tpl->setVariable('VAL_ID', $a_set['usr_id']);
204 $this->tpl->setVariable('VAL_NAME', $a_set['lastname'] . ', ' . $a_set['firstname']);
205
206 foreach ($this->getSelectedColumns() as $field) {
207 switch ($field) {
208 case 'gender':
209 $a_set['gender'] = $a_set['gender'] ? $this->lng->txt('gender_' . $a_set['gender']) : '';
210 $this->tpl->setCurrentBlock('custom_fields');
211 $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
212 $this->tpl->parseCurrentBlock();
213 break;
214
215 case 'birthday':
216 $a_set['birthday'] = $a_set['birthday'] ? ilDatePresentation::formatDate(new ilDate($a_set['birthday'], IL_CAL_DATE)) : $this->lng->txt('no_date');
217 $this->tpl->setCurrentBlock('custom_fields');
218 $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
219 $this->tpl->parseCurrentBlock();
220 break;
221
222 case 'odf_last_update':
223 $this->tpl->setVariable('VAL_CUST', (string) $a_set['odf_info_txt']);
224 break;
225
226 case 'org_units':
227 $this->tpl->setCurrentBlock('custom_fields');
228 include_once './Modules/OrgUnit/classes/PathStorage/class.ilOrgUnitPathStorage.php';
229 $this->tpl->setVariable('VAL_CUST', (string) ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($a_set['usr_id']));
230 $this->tpl->parseCurrentBlock();
231 break;
232
233 default:
234 $this->tpl->setCurrentBlock('custom_fields');
235 $this->tpl->setVariable('VAL_CUST', isset($a_set[$field]) ? (string) $a_set[$field] : '');
236 $this->tpl->parseCurrentBlock();
237 break;
238 }
239 }
240
241
242 $this->tpl->setVariable('VAL_SUBTIME', ilDatePresentation::formatDate(new ilDateTime($a_set['sub_time'], IL_CAL_UNIX)));
243
244
245 $this->showActionLinks($a_set);
246
247
248 if ($this->getShowSubject()) {
249 if (strlen($a_set['subject'])) {
250 $this->tpl->setCurrentBlock('subject');
251 $this->tpl->setVariable('VAL_SUBJECT', '"' . $a_set['subject'] . '"');
252 $this->tpl->parseCurrentBlock();
253 } else {
254 $this->tpl->touchBlock('subject');
255 }
256 }
257 }
258
263 public function showActionLinks($a_set)
264 {
265 if (!self::$has_odf_definitions) {
266 $this->ctrl->setParameterByClass(get_class($this->getParentObject()), 'member_id', $a_set['usr_id']);
267 $link = $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'sendMailToSelectedUsers');
268 $this->tpl->setVariable('MAIL_LINK', $link);
269 $this->tpl->setVariable('MAIL_TITLE', $this->lng->txt('crs_mem_send_mail'));
270 return true;
271 }
272
273 // show action menu
274 include_once './Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php';
276 $list->setSelectionHeaderClass('small');
277 $list->setItemLinkClass('small');
278 $list->setId('actl_' . $a_set['usr_id'] . '_' . $this->getId());
279 $list->setListTitle($this->lng->txt('actions'));
280
281 $this->ctrl->setParameterByClass(get_class($this->getParentObject()), 'member_id', $a_set['usr_id']);
282 $this->ctrl->setParameter($this->parent_obj, 'member_id', $a_set['usr_id']);
283 $trans = $this->lng->txt($this->getRepositoryObject()->getType() . '_mem_send_mail');
284 $link = $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'sendMailToSelectedUsers');
285 $list->addItem($trans, '', $link, 'sendMailToSelectedUsers');
286
287 $this->ctrl->setParameterByClass('ilobjectcustomuserfieldsgui', 'member_id', $a_set['usr_id']);
288 $trans = $this->lng->txt($this->getRepositoryObject()->getType() . '_cdf_edit_member');
289 $list->addItem($trans, '', $this->ctrl->getLinkTargetByClass('ilobjectcustomuserfieldsgui', 'editMember'));
290
291 $this->tpl->setVariable('ACTION_USER', $list->getHTML());
292 }
293
294
302 public function readSubscriberData(array $a_subscriber_ids)
303 {
305 $sub_ids = [];
306 foreach ($a_subscriber_ids as $usr_id) {
307 $sub_ids[] = $usr_id;
308 $sub_data[$usr_id] = $subscriber_data[$usr_id];
309 }
310
312
313 include_once './Services/User/classes/class.ilUserQuery.php';
314
315 $additional_fields = $this->getSelectedColumns();
316 unset($additional_fields["firstname"]);
317 unset($additional_fields["lastname"]);
318 unset($additional_fields["last_login"]);
319 unset($additional_fields["access_until"]);
320 unset($additional_fields['org_units']);
321
322 $udf_ids = $usr_data_fields = $odf_ids = array();
323 foreach ($additional_fields as $field) {
324 if (substr($field, 0, 3) == 'udf') {
325 $udf_ids[] = substr($field, 4);
326 continue;
327 }
328 if (substr($field, 0, 3) == 'odf') {
329 $odf_ids[] = substr($field, 4);
330 continue;
331 }
332
333 $usr_data_fields[] = $field;
334 }
335
337 $this->getOrderField(),
338 $this->getOrderDirection(),
339 $this->getOffset(),
340 $this->getLimit(),
341 '',
342 '',
343 null,
344 false,
345 false,
346 0,
347 0,
348 null,
349 $usr_data_fields,
350 $sub_ids
351 );
352
353 foreach ((array) $usr_data['set'] as $user) {
354 $usr_ids[] = $user['usr_id'];
355 }
356
357 // merge course data
358 $course_user_data = $this->getParentObject()->readMemberData($usr_ids, array());
359 $a_user_data = array();
360 foreach ((array) $usr_data['set'] as $ud) {
361 $a_user_data[$ud['usr_id']] = array_merge($ud, (array) $course_user_data[$ud['usr_id']]);
362 }
363
364 // Custom user data fields
365 if ($udf_ids) {
366 include_once './Services/User/classes/class.ilUserDefinedData.php';
367 $data = ilUserDefinedData::lookupData($usr_ids, $udf_ids);
368 foreach ($data as $usr_id => $fields) {
369 if (!$this->checkAcceptance($usr_id)) {
370 continue;
371 }
372
373 foreach ($fields as $field_id => $value) {
374 $a_user_data[$usr_id]['udf_' . $field_id] = $value;
375 }
376 }
377 }
378 // Object specific user data fields
379 if ($odf_ids) {
380 include_once './Modules/Course/classes/Export/class.ilCourseUserData.php';
382 foreach ($data as $usr_id => $fields) {
383 // #7264: as we get data for all course members filter against user data
384 if (!$this->checkAcceptance($usr_id) || !in_array($usr_id, $usr_ids)) {
385 continue;
386 }
387
388 foreach ($fields as $field_id => $value) {
389 $a_user_data[$usr_id]['odf_' . $field_id] = $value;
390 }
391 }
392
393 // add last edit date
394 include_once './Services/Membership/classes/class.ilObjectCustomUserFieldHistory.php';
395 foreach (ilObjectCustomUserFieldHistory::lookupEntriesByObjectId($this->getRepositoryObject()->getId()) as $usr_id => $edit_info) {
396 if (!isset($a_user_data[$usr_id])) {
397 continue;
398 }
399
400 include_once './Services/PrivacySecurity/classes/class.ilPrivacySettings.php';
401 if ($usr_id == $edit_info['update_user']) {
402 $a_user_data[$usr_id]['odf_last_update'] = '';
403 $a_user_data[$usr_id]['odf_info_txt'] = $GLOBALS['DIC']['lng']->txt('cdf_edited_by_self');
404 if (ilPrivacySettings::_getInstance()->enabledAccessTimesByType($this->getRepositoryObject()->getType())) {
405 $a_user_data[$usr_id]['odf_last_update'] .= ('_' . $edit_info['editing_time']->get(IL_CAL_UNIX));
406 $a_user_data[$usr_id]['odf_info_txt'] .= (', ' . ilDatePresentation::formatDate($edit_info['editing_time']));
407 }
408 } else {
409 $a_user_data[$usr_id]['odf_last_update'] = $edit_info['update_user'];
410 $a_user_data[$usr_id]['odf_last_update'] .= ('_' . $edit_info['editing_time']->get(IL_CAL_UNIX));
411
412 $name = ilObjUser::_lookupName($edit_info['update_user']);
413 $a_user_data[$usr_id]['odf_info_txt'] = ($name['firstname'] . ' ' . $name['lastname'] . ', ' . ilDatePresentation::formatDate($edit_info['editing_time']));
414 }
415 }
416 }
417
418 foreach ($usr_data['set'] as $user) {
419 // Check acceptance
420 if (!$this->checkAcceptance($user['usr_id'])) {
421 continue;
422 }
423 // DONE: accepted
424 foreach ($usr_data_fields as $field) {
425 $a_user_data[$user['usr_id']][$field] = $user[$field] ? $user[$field] : '';
426 }
427 }
428
429 // Waiting list subscription
430 foreach ($sub_data as $usr_id => $usr_data) {
431 if (!in_array($usr_id, $usr_ids)) {
432 continue;
433 }
434 $a_user_data[$usr_id]['sub_time'] = $usr_data['time'];
435 $a_user_data[$usr_id]['subject'] = $usr_data['subject'];
436 }
437
438 $this->setMaxCount(count($sub_ids));
439 return $this->setData($a_user_data);
440 }
441
442 protected function checkAcceptance()
443 {
444 return true;
445 }
446
447 public function setShowSubject($a_value)
448 {
449 $this->show_subject = (bool) $a_value;
450 }
451
452 public function getShowSubject()
453 {
454 return $this->show_subject;
455 }
456}
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, $include_seconds=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.
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.
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.
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.
global $ilCtrl
Definition: ilias.php:18
$user
Definition: migrateto20.php:57
$GLOBALS['JPEG_Segment_Names']
Global Variable: XMP_tag_captions.
if(isset($_REQUEST['delete'])) $list
Definition: registry.php:41
global $DIC
Definition: saml.php:7
$ilUser
Definition: imgupload.php:18