ILIAS  release_4-4 Revision
•All Data Structures Namespaces Files Functions Variables Modules Pages
class.ilMemberExportGUI.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 
24 include_once('Services/PrivacySecurity/classes/class.ilExportFieldsInfo.php');
25 include_once('./Services/Membership/classes/Export/class.ilMemberExport.php');
26 include_once('Modules/Course/classes/class.ilFSStorageCourse.php');
27 include_once('Modules/Group/classes/class.ilFSStorageGroup.php');
28 include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
29 include_once('Services/User/classes/class.ilUserDefinedFields.php');
30 include_once('Services/User/classes/class.ilUserFormSettings.php');
31 
41 class ilMemberExportGUI
42 {
43  private $ref_id;
44  private $obj_id;
45  private $type;
46  private $ctrl;
47  private $tpl;
48  private $lng;
49 
50  private $fields_info;
51  private $fss_export = null;
52 
60  public function __construct($a_ref_id)
61  {
62  global $ilCtrl,$tpl,$lng,$ilUser,$ilObjDataCache;
63 
64  $this->ctrl = $ilCtrl;
65  $this->tpl = $tpl;
66  $this->lng = $lng;
67  $this->lng->loadLanguageModule('ps');
68  $this->ref_id = $a_ref_id;
69  $this->obj_id = $ilObjDataCache->lookupObjId($this->ref_id);
70  $this->type = ilObject::_lookupType($this->obj_id);
71 
72  $this->fields_info = ilExportFieldsInfo::_getInstanceByType(ilObject::_lookupType($this->obj_id));
73  $this->initFileSystemStorage();
74  }
75 
83  public function executeCommand()
84  {
85  global $ilAccess,$rbacsystem;
86 
87  include_once('Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
88  if(!ilPrivacySettings::_getInstance()->checkExportAccess($this->ref_id))
89  {
90  ilUtil::sendFailure($this->lng->txt('permission_denied'),true);
91  $this->ctrl->returnToParent($this);
92  }
93 
94  $next_class = $this->ctrl->getNextClass($this);
95  $cmd = $this->ctrl->getCmd();
96 
97  switch($next_class)
98  {
99  default:
100  if(!$cmd)
101  {
102  $cmd = 'show';
103  }
104  $this->$cmd();
105  break;
106  }
107  }
108 
115  public function show($a_deliver_file = false)
116  {
117  $this->showFileList();
118  $this->tpl->addBlockFile('ADM_CONTENT','adm_content','tpl.member_export.html','Modules/Course');
119  $this->tpl->setVariable('FORM_ACTION',$this->ctrl->getFormAction($this));
120  $this->tpl->setVariable('TXT_EXPORT_SETTINGS',$this->lng->txt('ps_export_settings'));
121  $this->tpl->setVariable('TXT_USER_SELECTION',$this->lng->txt('ps_user_selection'));
122  $this->tpl->setVariable('TXT_EXPORT_ADMIN',$this->lng->txt('ps_export_admin'));
123  $this->tpl->setVariable('TXT_EXPORT_MEMBER',$this->lng->txt('ps_export_member'));
124  $this->tpl->setVariable('TXT_EXPORT_WAIT',$this->lng->txt('ps_export_wait'));
125  $this->tpl->setVariable('TXT_EXPORT_SUB',$this->lng->txt('ps_export_sub'));
126 
127  // Check user selection
128  $this->exportSettings = new ilUserFormSettings('memexp');
129 
130  $this->tpl->setVariable('CHECK_EXPORT_ADMIN',ilUtil::formCheckbox($this->exportSettings->enabled('admin'),'export_members[admin]',1));
131  if($this->type == 'crs')
132  {
133  $this->tpl->setVariable('CHECK_EXPORT_TUTOR',ilUtil::formCheckbox($this->exportSettings->enabled('tutor'),'export_members[tutor]',1));
134  $this->tpl->setVariable('TXT_EXPORT_TUTOR',$this->lng->txt('ps_export_tutor'));
135  }
136  $this->tpl->setVariable('CHECK_EXPORT_MEMBER',ilUtil::formCheckbox($this->exportSettings->enabled('member'),'export_members[member]',1));
137  $this->tpl->setVariable('CHECK_EXPORT_SUB',ilUtil::formCheckbox($this->exportSettings->enabled('subscribers'),'export_members[subscribers]',1));
138  $this->tpl->setVariable('CHECK_EXPORT_WAIT',ilUtil::formCheckbox($this->exportSettings->enabled('waiting_list'),'export_members[waiting_list]',1));
139 
140  $this->tpl->setVariable('TXT_EXPORT',$this->lng->txt('ps_perform_export'));
141  $this->tpl->setVariable('TXT_EXPORT_EXCEL',$this->lng->txt('ps_export_excel'));
142 
143  // User Data
144  $this->tpl->setVariable('TXT_USER_DATA_SELECTION',$this->lng->txt('ps_export_data'));
145  $this->tpl->setVariable('TXT_EXPORT_USER_DATA_HEADER',$this->lng->txt('ps_export_user_data'));
146 
147  include_once './Services/Booking/classes/class.ilBookingEntry.php';
148  if(ilBookingEntry::hasObjectBookingEntries($this->obj_id, $GLOBALS['ilUser']->getId()))
149  {
150  $this->tpl->setCurrentBlock('consultation');
151  $this->lng->loadLanguageModule('dateplaner');
152  $this->tpl->setVariable('TXT_CH',$this->lng->txt('cal_ch_field_ch'));
153  $this->tpl->setVariable('TXT_EXPORT_CH',$this->lng->txt('cal_ch_export_apps'));
154  $this->tpl->setVariable('CHECK_EXPORT_CH',ilUtil::formCheckbox($this->exportSettings->enabled('consultation_hour'), 'export_members[consultation_hour]', 1));
155  $this->tpl->parseCurrentBlock();
156  }
157 
158  $fields = $this->fields_info->getFieldsInfo();
159  foreach($fields as $field => $exportable)
160  {
161  if(!$exportable)
162  {
163  continue;
164  }
165  $this->tpl->setCurrentBlock('user_data_row');
166  $this->tpl->setVariable('CHECK_EXPORT_USER_DATA',ilUtil::formCheckbox($this->exportSettings->enabled($field),'export_members['.$field.']',1));
167  $this->tpl->setVariable('TXT_EXPORT_USER_DATA',$this->lng->txt($field));
168  $this->tpl->parseCurrentBlock();
169  }
170 
171  $udf = ilUserDefinedFields::_getInstance();
172  foreach($exp = $udf->getExportableFields($this->obj_id) as $field_id => $udf_data)
173  {
174  $this->tpl->setCurrentBlock('user_data_row');
175  $this->tpl->setVariable('CHECK_EXPORT_USER_DATA',ilUtil::formCheckbox($this->exportSettings->enabled('udf_'.$field_id),
176  'export_members[udf_'.$field_id.']',1));
177  $this->tpl->setVariable('TXT_EXPORT_USER_DATA',$udf_data['field_name']);
178  $this->tpl->parseCurrentBlock();
179  }
180 
181 
182  $cdf_fields = ilCourseDefinedFieldDefinition::_getFields($this->obj_id);
183  foreach($cdf_fields as $field_obj)
184  {
185  $this->tpl->setCurrentBlock('cdf_row');
186  $this->tpl->setVariable('CHECK_CDF_DATA',ilUtil::formCheckbox($this->exportSettings->enabled('cdf_'.$field_obj->getId()),
187  'export_members[cdf_'.$field_obj->getId().']',
188  1));
189  $this->tpl->setVariable('TXT_CDF_NAME',$field_obj->getName());
190  $this->tpl->parseCurrentBlock();
191  }
192  if(count($cdf_fields))
193  {
194  $this->tpl->setCurrentBlock('cdf_fields');
195  $this->tpl->setVariable('TXT_CDF_SELECTION',$this->lng->txt('ps_'.$this->type.'_user_fields'));
196  $this->tpl->parseCurrentBlock();
197  }
198 
199  if($a_deliver_file and 0)
200  {
201  $this->tpl->setCurrentBlock('iframe');
202  $this->tpl->setVariable('SOURCE',$this->ctrl->getLinkTarget($this,'deliverData'));
203  }
204  }
205 
213  public function deliverData()
214  {
215  foreach($this->fss_export->getMemberExportFiles() as $file)
216  {
217  if($file['name'] == $_SESSION['member_export_filename'])
218  {
219  $content = $this->fss_export->getMemberExportFile($_SESSION['member_export_filename']);
220  ilUtil::deliverData($content,date('Y_m_d_H-i',$file['timest']).
221  '_member_export_'.
222  $this->obj_id.
223  '.csv','text/csv');
224  }
225  }
226  }
227 
234  public function showFileList()
235  {
236  global $ilUser;
237 
238  if(!count($files = $this->fss_export->getMemberExportFiles()))
239  {
240  return false;
241  }
242 
243  $a_tpl = new ilTemplate('tpl.table.html',true,true);
244  $a_tpl->addBlockfile("TBL_CONTENT", "tbl_content", "tpl.member_export_file_row.html", "Modules/Course");
245  $a_tpl->setVariable('FORMACTION',$this->ctrl->getFormaction($this));
246 
247  include_once("./Services/Table/classes/class.ilTableGUI.php");
248  $tbl = new ilTableGUI();
249 
250  // load template for table content data
251 
252  $tbl->setTitle($this->lng->txt("ps_export_files"));
253 
254  $tbl->setHeaderNames(array("", $this->lng->txt("type"),
255  $this->lng->txt("ps_size"),
256  $this->lng->txt("date") ));
257 
258  $cols = array("", "type","size", "date");
259 
260  $header_params = $this->ctrl->getParameterArray($this,'show');
261  $tbl->setHeaderVars($cols, $header_params);
262  $tbl->setColumnWidth(array("1%", "9%", "45%", "45%"));
263 
264  // control
265  $tbl->setOrderColumn($_GET["sort_by"]);
266  $tbl->setOrderDirection($_GET["sort_order"]);
267  $tbl->setLimit($ilUser->getPref('hits_per_page',9999));
268  $tbl->setOffset($_GET["offset"]);
269  $tbl->setMaxCount(count($files));
270  $tbl->disable("sort");
271  $a_tpl->setVariable("COLUMN_COUNTS",4);
272 
273  $files = array_reverse($files);
274  $files = array_slice($files, $_GET["offset"], $_GET["limit"]);
275  $num = 0;
276  $i=0;
277  foreach($files as $exp_file)
278  {
279  $a_tpl->setCurrentBlock("tbl_content");
280  $a_tpl->setVariable("TXT_FILENAME", $exp_file["file"]);
281 
282  $css_row = ilUtil::switchColor($i++, "tblrow1", "tblrow2");
283  $a_tpl->setVariable("CSS_ROW", $css_row);
284 
285  $a_tpl->setVariable("TXT_SIZE",$exp_file['size']);
286  $a_tpl->setVariable("TXT_TYPE", strtoupper($exp_file["type"]));
287  $a_tpl->setVariable("CHECKBOX_ID",$exp_file["timest"]);
288  $a_tpl->setVariable("TXT_DATE", date("Y-m-d H:i",$exp_file['timest']));
289  $a_tpl->parseCurrentBlock();
290  }
291 
292 
293  // delete button
294  $a_tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.png"));
295  $a_tpl->setCurrentBlock("tbl_action_btn");
296  $a_tpl->setVariable("BTN_NAME", "confirmDeleteExportFile");
297  $a_tpl->setVariable("BTN_VALUE", $this->lng->txt("delete"));
298  $a_tpl->parseCurrentBlock();
299 
300  $a_tpl->setCurrentBlock("tbl_action_btn");
301  $a_tpl->setVariable("BTN_NAME", "downloadExportFile");
302  $a_tpl->setVariable("BTN_VALUE", $this->lng->txt("download"));
303  $a_tpl->parseCurrentBlock();
304 
305  // footer
306  $tbl->setFooter("tblfooter",$this->lng->txt("previous"),$this->lng->txt("next"));
307  //$tbl->disable("footer");
308 
309  $tbl->setTemplate($a_tpl);
310  $tbl->render();
311 
312  #$this->tpl->setCurrentBlock('file_list');
313  $this->tpl->setVariable('FILE_LIST_TABLE',$a_tpl->get());
314  #$this->tpl->parseCurrentBlock();
315 
316  }
317 
325  public function downloadExportFile()
326  {
327  if(count($_POST['files']) != 1)
328  {
329  ilUtil::sendFailure($this->lng->txt('ps_select_one'));
330  $this->show();
331  return true;
332  }
333  foreach($this->fss_export->getMemberExportFiles() as $file)
334  {
335  if(!in_array($file['timest'],$_POST['files']))
336  {
337  continue;
338  }
339  $contents = $this->fss_export->getMemberExportFile($file['timest'].'_participant_export_'.
340  $file['type'].'_'.$this->obj_id.'.'.$file['type']);
341 
342 
343  switch($file['type'])
344  {
345  case 'xls':
346  ilUtil::deliverData(
347  $contents,
348  date('Y_m_d_H-i'.$file['timest']).'_member_export_'.$this->obj_id.'.xls',
349  'application/vnd.ms-excel'
350  );
351 
352  default:
353  case 'csv':
354  ilUtil::deliverData($contents,date('Y_m_d_H-i'.$file['timest']).
355  '_member_export_'.
356  $this->obj_id.
357  '.csv','text/csv');
358  break;
359  }
360  return true;
361 
362  }
363 
364 
365  }
366 
374  public function confirmDeleteExportFile()
375  {
376  if(!count($_POST['files']))
377  {
378  ilUtil::sendFailure($this->lng->txt('ps_select_one'));
379  $this->show();
380  return false;
381  }
382  $_SESSION['il_del_member_export'] = $_POST['files'];
383  ilUtil::sendQuestion($this->lng->txt("info_delete_sure"));
384 
385  $this->tpl->addBlockFile('ADM_CONTENT','adm_content','tpl.member_export_confirm_delete.html','Modules/Course');
386  $this->tpl->setVariable('FORMACTION',$this->ctrl->getFormAction($this));
387  $this->tpl->setVariable('TEXT',$this->lng->txt('ps_delete_export_files'));
388 
389 
390  $counter = 0;
391  foreach($this->fss_export->getMemberExportFiles() as $file)
392  {
393  if(!in_array($file['timest'],$_POST['files']))
394  {
395  continue;
396  }
397  $this->tpl->setCurrentBlock('table_row');
398  $this->tpl->setVariable('CSS_ROW',ilUtil::switchColor($counter++,'tblrow1','tblrow2'));
399  $this->tpl->setVariable('TEXT_TYPE',strtoupper($file['type']));
400  $this->tpl->setVariable('DATE',ilDatePresentation::formatDate(new ilDateTime($file['timest'],IL_CAL_UNIX)));
401  $this->tpl->parseCurrentBlock();
402  }
403  $this->tpl->setCurrentBlock('operation_btn');
404  $this->tpl->setVariable('BTN_NAME','deleteExportFile');
405  $this->tpl->setVariable('BTN_VALUE',$this->lng->txt('delete'));
406  $this->tpl->parseCurrentBlock();
407 
408  $this->tpl->setCurrentBlock('operation_btn');
409  $this->tpl->setVariable('BTN_NAME','show');
410  $this->tpl->setVariable('BTN_VALUE',$this->lng->txt('cancel'));
411  $this->tpl->parseCurrentBlock();
412 
413  }
414 
422  public function deleteExportFile()
423  {
424  if(!is_array($_SESSION['il_del_member_export']))
425  {
426  $this->show();
427  return false;
428  }
429  $counter = 0;
430  foreach($this->fss_export->getMemberExportFiles() as $file)
431  {
432  if(!in_array($file['timest'],$_SESSION['il_del_member_export']))
433  {
434  continue;
435  }
436  $this->fss_export->deleteMemberExportFile($file['timest'].'_participant_export_'.$file['type'].'_'.$this->obj_id.'.'.$file['type']);
437  }
438  ilUtil::sendSuccess($this->lng->txt('ps_files_deleted'));
439  $this->show();
440  }
441 
442 
443 
444 
451  public function export()
452  {
453  // Save settings
454  $this->exportSettings = new ilUserFormSettings('memexp');
455  $this->exportSettings->set($_POST['export_members']);
456  $this->exportSettings->store();
457 
458  $this->export = new ilMemberExport($this->ref_id);
459  $this->export->create();
460 
461  $filename = time().'_participant_export_csv_'.$this->obj_id.'.csv';
462  $this->fss_export->addMemberExportFile($this->export->getCSVString(),$filename);
463 
464  $_SESSION['member_export_filename'] = $filename;
465 
466  $this->show(true);
467  }
468 
469  public function exportExcel()
470  {
471  $this->exportSettings = new ilUserFormSettings('memexp');
472  $this->exportSettings->set($_POST['export_members']);
473  $this->exportSettings->store();
474 
475  $filename = time().'_participant_export_xls_'.$this->obj_id.'.xls';
476  $this->fss_export->initMemberExportDirectory();
477  $filepath = $this->fss_export->getMemberExportDirectory().DIRECTORY_SEPARATOR.$filename;
478 
479  $this->export = new ilMemberExport($this->ref_id,ilMemberExport::EXPORT_EXCEL);
480  $this->export->setFilename($filepath);
481  $this->export->create();
482 
483  $_SESSION['member_export_filename'] = $filename;
484 
485  $this->show(true);
486 
487  }
488 
489 
494  protected function initFileSystemStorage()
495  {
496  if($this->type == 'crs')
497  {
498  $this->fss_export = new ilFSStorageCourse($this->obj_id);
499  }
500  if($this->type == 'grp')
501  {
502  $this->fss_export = new ilFSStorageGroup($this->obj_id);
503  }
504 
505  }
506 }
507 ?>
$_SESSION
< a tabindex="-1" style="border-style: none;" href="#" title="Refresh Image" onclick="document.getElementById('siimage').src = './securimage_show.php?sid=' + Math.random(); this.blur(); return false">< img src="./images/refresh.png" alt="Reload Image" height="32" width="32" onclick="this.blur()" align="bottom" border="0"/></a >< br/>< strong > Enter Code *if($_SERVER['REQUEST_METHOD']=='POST' &&@ $_POST['do']=='contact') $_SESSION['ctform']['success']
Definition: example_form.php:192
ilUtil\sendSuccess
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.
Definition: class.ilUtil.php:4956
ilUtil\deliverData
static deliverData($a_data, $a_filename, $mime="application/octet-stream", $charset="")
deliver data for download via browser.
Definition: class.ilUtil.php:2166
$file
print $file
Definition: HFile_ueconv.php:128
ilMemberExport
Class for generation of member export files.
Definition: class.ilMemberExport.php:42
ilMemberExportGUI\show
show($a_deliver_file=false)
Show list of export files.
Definition: class.ilMemberExportGUI.php:115
ilMemberExportGUI\downloadExportFile
downloadExportFile()
Download export file.
Definition: class.ilMemberExportGUI.php:325
$_POST
$_POST['username']
Definition: cron.php:12
ilMemberExportGUI\deleteExportFile
deleteExportFile()
Delete member export files.
Definition: class.ilMemberExportGUI.php:422
ilMemberExportGUI\showFileList
showFileList()
Show file list of available export files.
Definition: class.ilMemberExportGUI.php:234
ilBookingEntry\hasObjectBookingEntries
static hasObjectBookingEntries($a_obj_id, $a_usr_id)
Check if object has assigned consultation hour appointments.
Definition: class.ilBookingEntry.php:473
ilUserDefinedFields\_getInstance
static _getInstance()
Get instance.
Definition: class.ilUserDefinedFields.php:46
$_GET
$_GET["client_id"]
Definition: cfg.phpunit.template.php:12
ilMemberExportGUI\export
export()
Export Create member export file and store it in data directory.
Definition: class.ilMemberExportGUI.php:451
ilMemberExportGUI\__construct
__construct($a_ref_id)
Constructor.
Definition: class.ilMemberExportGUI.php:60
$cmd
$cmd
Definition: sahs_server.php:35
ilTableGUI
Class ilTableGUI.
Definition: class.ilTableGUI.php:18
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:11
$ilCtrl
global $ilCtrl
Definition: ilias.php:18
ilMemberExportGUI\executeCommand
executeCommand()
Execute Command.
Definition: class.ilMemberExportGUI.php:83
$GLOBALS
$GLOBALS['ct_recipient']
Definition: example_form.ajax.php:4
ilExportFieldsInfo\_getInstanceByType
static _getInstanceByType($a_type)
Get Singleton Instance.
Definition: class.ilExportFieldsInfo.php:70
ilUtil\getImagePath
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
Definition: class.ilUtil.php:107
ilTemplate
special template class to simplify handling of ITX/PEAR
Definition: class.ilTemplate.php:11
ilDatePresentation\formatDate
static formatDate(ilDateTime $date)
Format a date public.
Definition: class.ilDatePresentation.php:113
ilDateTime
Date and time handling
Definition: class.ilDateTime.php:32
ilUtil\sendQuestion
static sendQuestion($a_info="", $a_keep=false)
Send Question to Screen.
Definition: class.ilUtil.php:4942
ilObject\_lookupType
static _lookupType($a_id, $a_reference=false)
lookup object type
Definition: class.ilObject.php:1183
ilUtil\sendFailure
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
Definition: class.ilUtil.php:4930
$filename
$filename
Definition: buildRTE.php:89
ilMemberExportGUI\confirmDeleteExportFile
confirmDeleteExportFile()
Confirm deletion of export files.
Definition: class.ilMemberExportGUI.php:374
$ilUser
global $ilUser
Definition: imgupload.php:15
ilMemberExportGUI\initFileSystemStorage
initFileSystemStorage()
Init file object.
Definition: class.ilMemberExportGUI.php:494
ilUtil\switchColor
static switchColor($a_num, $a_css1, $a_css2)
switches style sheets for each even $a_num (used for changing colors of different result rows) ...
Definition: class.ilUtil.php:654
ilPrivacySettings\_getInstance
static _getInstance()
Get instance of ilPrivacySettings.
Definition: class.ilPrivacySettings.php:77
ilUtil\formCheckbox
static formCheckbox($checked, $varname, $value, $disabled=false)
??? public
Definition: class.ilUtil.php:476
ilCourseDefinedFieldDefinition\_getFields
static _getFields($a_container_id, $a_sort=IL_CDF_SORT_NAME)
Get all fields of a container.
Definition: class.ilCourseDefinedFieldDefinition.php:138