ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
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 {
81 $this->addColumn($all_cols[$col]['txt'], $col);
82 }
83
84 $this->addColumn($this->lng->txt('application_date'),'sub_time',"10%");
85
86 if($this->getShowSubject())
87 $this->addColumn($this->lng->txt('subject'),'subject','15%');
88
89 $this->addColumn('','mail','10%');
90
91 if($this->getRepositoryObject()->getType() == "sess")
92 {
93 $this->addMultiCommand('confirmAssignSubscribers',$this->lng->txt('sess_accept_request'));
94 }
95 else{
96 $this->addMultiCommand('confirmAssignSubscribers',$this->lng->txt('assign'));
97 }
98
99 $this->addMultiCommand('confirmRefuseSubscribers',$this->lng->txt('refuse'));
100 $this->addMultiCommand('sendMailToSelectedUsers',$this->lng->txt('crs_mem_send_mail'));
101
102
103 $this->setPrefix('subscribers');
104 $this->setSelectAllCheckbox('subscribers');
105 $this->setRowTemplate("tpl.show_subscribers_row.html","Services/Membership");
106
107 if($show_content)
108 {
109 $this->enable('sort');
110 $this->enable('header');
111 $this->enable('numinfo');
112 $this->enable('select_all');
113 }
114 else
115 {
116 $this->disable('content');
117 $this->disable('header');
118 $this->disable('footer');
119 $this->disable('numinfo');
120 $this->disable('select_all');
121 }
122
123 $this->setExternalSegmentation(true);
124
125 include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
126 self::$has_odf_definitions = ilCourseDefinedFieldDefinition::_hasFields($this->getRepositoryObject()->getId());
127
128 }
129
133 protected function getRepositoryObject()
134 {
135 return $this->rep_object;
136 }
137
142 public function getSelectableColumns()
143 {
144 if(self::$all_columns)
145 {
146 return self::$all_columns;
147 }
148
149 include_once './Services/PrivacySecurity/classes/class.ilExportFieldsInfo.php';
151 self::$all_columns = $ef->getSelectableFieldsInfo($this->getRepositoryObject()->getId());
152 return self::$all_columns;
153 }
154
155
163 public function fillRow($a_set)
164 {
165 global $ilUser;
166
167
168 include_once './Modules/Course/classes/class.ilObjCourseGrouping.php';
171 {
172 $prefix = $this->getRepositoryObject()->getType();
173 $this->tpl->setVariable('ALERT_MSG',
174 sprintf($this->lng->txt($prefix.'_lim_assigned'),
175 ilObject::_lookupTitle(current($ids))
176 ));
177
178 }
179
180 $this->tpl->setVariable('VAL_ID',$a_set['usr_id']);
181 $this->tpl->setVariable('VAL_NAME',$a_set['lastname'].', '.$a_set['firstname']);
182
183 foreach($this->getSelectedColumns() as $field)
184 {
185 switch($field)
186 {
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 {
229
230 if(strlen($a_set['subject']))
231 {
232 $this->tpl->setCurrentBlock('subject');
233 $this->tpl->setVariable('VAL_SUBJECT','"'.$a_set['subject'].'"');
234 $this->tpl->parseCurrentBlock();
235 }
236 else
237 {
238 $this->tpl->touchBlock('subject');
239 }
240
241 }
242 }
243
248 public function showActionLinks($a_set)
249 {
250 if(!self::$has_odf_definitions)
251 {
252 $this->ctrl->setParameterByClass(get_class($this->getParentObject()),'member_id',$a_set['usr_id']);
253 $link = $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()),'sendMailToSelectedUsers');
254 $this->tpl->setVariable('MAIL_LINK',$link);
255 $this->tpl->setVariable('MAIL_TITLE',$this->lng->txt('crs_mem_send_mail'));
256 return TRUE;
257 }
258
259 // show action menu
260 include_once './Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php';
261 $list = new ilAdvancedSelectionListGUI();
262 $list->setSelectionHeaderClass('small');
263 $list->setItemLinkClass('small');
264 $list->setId('actl_'.$a_set['usr_id'].'_'.$this->getId());
265 $list->setListTitle($this->lng->txt('actions'));
266
267 $this->ctrl->setParameterByClass(get_class($this->getParentObject()),'member_id',$a_set['usr_id']);
268 $this->ctrl->setParameter($this->parent_obj, 'member_id', $a_set['usr_id']);
269 $trans = $this->lng->txt($this->getRepositoryObject()->getType().'_mem_send_mail');
270 $link = $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()),'sendMailToSelectedUsers');
271 $list->addItem($trans, '', $link,'sendMailToSelectedUsers');
272
273 $this->ctrl->setParameterByClass('ilobjectcustomuserfieldsgui','member_id',$a_set['usr_id']);
274 $trans = $this->lng->txt($this->getRepositoryObject()->getType().'_cdf_edit_member');
275 $list->addItem($trans, '', $this->ctrl->getLinkTargetByClass('ilobjectcustomuserfieldsgui','editMember'));
276
277 $this->tpl->setVariable('ACTION_USER',$list->getHTML());
278
279 }
280
281
289 public function readSubscriberData()
290 {
291 include_once './Services/Membership/classes/class.ilParticipants.php';
292
294
295 $sub_ids = array();
296 foreach($sub_data as $usr_id => $usr_data)
297 {
298 $sub_ids[] = $usr_id;
299 }
300
302
303 include_once './Services/User/classes/class.ilUserQuery.php';
304
305 $additional_fields = $this->getSelectedColumns();
306 unset($additional_fields["firstname"]);
307 unset($additional_fields["lastname"]);
308 unset($additional_fields["last_login"]);
309 unset($additional_fields["access_until"]);
310 unset($additional_fields['org_units']);
311
312 $udf_ids = $usr_data_fields = $odf_ids = array();
313 foreach($additional_fields as $field)
314 {
315 if(substr($field, 0, 3) == 'udf')
316 {
317 $udf_ids[] = substr($field, 4);
318 continue;
319 }
320 if(substr($field, 0, 3) == 'odf')
321 {
322 $odf_ids[] = substr($field, 4);
323 continue;
324 }
325
326 $usr_data_fields[] = $field;
327 }
328
330 $this->getOrderField(),
331 $this->getOrderDirection(),
332 $this->getOffset(),
333 $this->getLimit(),
334 '',
335 '',
336 null,
337 false,
338 false,
339 0,
340 0,
341 null,
342 $usr_data_fields,
343 $sub_ids
344 );
345
346 foreach((array) $usr_data['set'] as $user)
347 {
348 $usr_ids[] = $user['usr_id'];
349 }
350
351 // merge course data
352 $course_user_data = $this->getParentObject()->readMemberData($usr_ids, array());
353 $a_user_data = array();
354 foreach((array) $usr_data['set'] as $ud)
355 {
356 $a_user_data[$ud['usr_id']] = array_merge($ud,(array) $course_user_data[$ud['usr_id']]);
357 }
358
359 // Custom user data fields
360 if($udf_ids)
361 {
362 include_once './Services/User/classes/class.ilUserDefinedData.php';
363 $data = ilUserDefinedData::lookupData($usr_ids, $udf_ids);
364 foreach($data as $usr_id => $fields)
365 {
366 if(!$this->checkAcceptance($usr_id))
367 {
368 continue;
369 }
370
371 foreach($fields as $field_id => $value)
372 {
373 $a_user_data[$usr_id]['udf_' . $field_id] = $value;
374 }
375 }
376 }
377 // Object specific user data fields
378 if($odf_ids)
379 {
380 include_once './Modules/Course/classes/Export/class.ilCourseUserData.php';
382 foreach($data as $usr_id => $fields)
383 {
384 // #7264: as we get data for all course members filter against user data
385 if(!$this->checkAcceptance($usr_id) || !in_array($usr_id, $usr_ids))
386 {
387 continue;
388 }
389
390 foreach($fields as $field_id => $value)
391 {
392 $a_user_data[$usr_id]['odf_' . $field_id] = $value;
393 }
394 }
395
396 // add last edit date
397 include_once './Services/Membership/classes/class.ilObjectCustomUserFieldHistory.php';
398 foreach(ilObjectCustomUserFieldHistory::lookupEntriesByObjectId($this->getRepositoryObject()->getId()) as $usr_id => $edit_info)
399 {
400 if(!isset($a_user_data[$usr_id]))
401 {
402 continue;
403 }
404
405 include_once './Services/PrivacySecurity/classes/class.ilPrivacySettings.php';
406 if($usr_id == $edit_info['update_user'])
407 {
408 $a_user_data[$usr_id]['odf_last_update'] = '';
409 $a_user_data[$usr_id]['odf_info_txt'] = $GLOBALS['lng']->txt('cdf_edited_by_self');
410 if(ilPrivacySettings::_getInstance()->enabledAccessTimesByType($this->getRepositoryObject()->getType()))
411 {
412 $a_user_data[$usr_id]['odf_last_update'] .= ('_'.$edit_info['editing_time']->get(IL_CAL_UNIX));
413 $a_user_data[$usr_id]['odf_info_txt'] .= (', '.ilDatePresentation::formatDate($edit_info['editing_time']));
414 }
415 }
416 else
417 {
418 $a_user_data[$usr_id]['odf_last_update'] = $edit_info['update_user'];
419 $a_user_data[$usr_id]['odf_last_update'] .= ('_'.$edit_info['editing_time']->get(IL_CAL_UNIX));
420
421 $name = ilObjUser::_lookupName($edit_info['update_user']);
422 $a_user_data[$usr_id]['odf_info_txt'] = ($name['firstname'].' '.$name['lastname'].', '.ilDatePresentation::formatDate($edit_info['editing_time']));
423 }
424 }
425 }
426
427 foreach($usr_data['set'] as $user)
428 {
429 // Check acceptance
430 if(!$this->checkAcceptance($user['usr_id']))
431 {
432 continue;
433 }
434 // DONE: accepted
435 foreach($usr_data_fields as $field)
436 {
437 $a_user_data[$user['usr_id']][$field] = $user[$field] ? $user[$field] : '';
438 }
439 }
440
441 // Waiting list subscription
442 foreach($sub_data as $usr_id => $usr_data)
443 {
444 if(!in_array($usr_id, $usr_ids))
445 {
446 continue;
447 }
448 $a_user_data[$usr_id]['sub_time'] = $usr_data['time'];
449 $a_user_data[$usr_id]['subject'] = $usr_data['subject'];
450 }
451
452 $this->setMaxCount(count($sub_ids));
453 return $this->setData($a_user_data);
454 }
455
456 protected function checkAcceptance()
457 {
458 return true;
459 }
460
461 public function setShowSubject($a_value)
462 {
463 $this->show_subject = (bool)$a_value;
464 }
465
466 public function getShowSubject()
467 {
468 return $this->show_subject;
469 }
470}
471?>
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)
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.
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.
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.
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.
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="")
Get data for user administration list.
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
global $ilCtrl
Definition: ilias.php:18
global $lng
Definition: privfeed.php:17
$ilUser
Definition: imgupload.php:18