ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilSessionOverviewGUI Class Reference
+ Collaboration diagram for ilSessionOverviewGUI:

Public Member Functions

 __construct ($a_crs_ref_id, ilParticipants $a_members)
 constructor More...
 
 executeCommand ()
 ecxecute command More...
 
 listSessions ()
 list sessions of all user More...
 
 exportCSV ()
 Events List CSV Export. More...
 

Protected Attributes

 $course_ref_id = null
 
 $course_id = null
 
 $lng
 
 $tpl
 
 $ctrl
 

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 32 of file class.ilSessionOverviewGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilSessionOverviewGUI::__construct (   $a_crs_ref_id,
ilParticipants  $a_members 
)

constructor

public

Parameters

Definition at line 48 of file class.ilSessionOverviewGUI.php.

References $ilCtrl, $lng, $tpl, and ilObject\_lookupObjId().

49  {
50  global $tpl, $ilCtrl, $lng;
51 
52  $this->ctrl = $ilCtrl;
53  $this->tpl = $tpl;
54  $this->lng = $lng;
55  $this->lng->loadLanguageModule('event');
56  $this->lng->loadLanguageModule('crs');
57 
58  $this->course_ref_id = $a_crs_ref_id;
59  $this->course_id = ilObject::_lookupObjId($this->course_ref_id);
60  $this->members_obj = $a_members;
61  }
global $ilCtrl
Definition: ilias.php:18
static _lookupObjId($a_id)
+ Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilSessionOverviewGUI::executeCommand ( )

ecxecute command

public

Parameters

Definition at line 70 of file class.ilSessionOverviewGUI.php.

References $cmd.

71  {
72  $next_class = $this->ctrl->getNextClass($this);
73  $cmd = $this->ctrl->getCmd();
74 
75  switch($next_class)
76  {
77  default:
78  if(!$cmd)
79  {
80  $cmd = "listSessions";
81  }
82  $this->$cmd();
83  break;
84  }
85  }
$cmd
Definition: sahs_server.php:35

◆ exportCSV()

ilSessionOverviewGUI::exportCSV ( )

Events List CSV Export.

public

Parameters

Definition at line 117 of file class.ilSessionOverviewGUI.php.

References ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), ilUtil\_sortIds(), array, ilUtil\deliverData(), ilObjectFactory\getInstanceByRefId(), IL_CAL_FKT_DATE, IL_CAL_UNIX, and time.

118  {
119  global $tree,$ilAccess;
120 
121  include_once('Services/Utilities/classes/class.ilCSVWriter.php');
122  include_once 'Modules/Session/classes/class.ilEventParticipants.php';
123 
124  $members = $this->members_obj->getParticipants();
125  $members = ilUtil::_sortIds($members,'usr_data','lastname','usr_id');
126 
127  $events = array();
128  foreach($tree->getSubtree($tree->getNodeData($this->course_ref_id),false,'sess') as $event_id)
129  {
130  $tmp_event = ilObjectFactory::getInstanceByRefId($event_id,false);
131  if(!is_object($tmp_event) or !$ilAccess->checkAccess('write','',$event_id))
132  {
133  continue;
134  }
135  $events[] = $tmp_event;
136  }
137 
138  $this->csv = new ilCSVWriter();
139  $this->csv->addColumn($this->lng->txt("lastname"));
140  $this->csv->addColumn($this->lng->txt("firstname"));
141  $this->csv->addColumn($this->lng->txt("login"));
142 
143  foreach($events as $event_obj)
144  {
145  // TODO: do not export relative dates
146  $this->csv->addColumn($event_obj->getTitle().' ('.$event_obj->getFirstAppointment()->appointmentToString().')');
147  }
148 
149  $this->csv->addRow();
150 
151  foreach($members as $user_id)
152  {
153  $name = ilObjUser::_lookupName($user_id);
154 
155  $this->csv->addColumn($name['lastname']);
156  $this->csv->addColumn($name['firstname']);
157  $this->csv->addColumn(ilObjUser::_lookupLogin($user_id));
158 
159  foreach($events as $event_obj)
160  {
161  $event_part = new ilEventParticipants((int) $event_obj->getId());
162 
163  $this->csv->addColumn($event_part->hasParticipated($user_id) ?
164  $this->lng->txt('event_participated') :
165  $this->lng->txt('event_not_participated'));
166  }
167 
168  $this->csv->addRow();
169  }
170  $date = new ilDate(time(),IL_CAL_UNIX);
171  ilUtil::deliverData($this->csv->getCSVString(),$date->get(IL_CAL_FKT_DATE,'Y-m-d')."_course_events.csv", "text/csv");
172  }
static _lookupLogin($a_user_id)
lookup login
static _lookupName($a_user_id)
lookup user name
static deliverData($a_data, $a_filename, $mime="application/octet-stream", $charset="")
deliver data for download via browser.
Helper class to generate CSV files.
const IL_CAL_UNIX
Class for single dates.
static _sortIds($a_ids, $a_table, $a_field, $a_id_name)
Function that sorts ids by a given table field using WHERE IN E.g: __sort(array(6,7),'usr_data','lastname','usr_id') => sorts by lastname.
const IL_CAL_FKT_DATE
Create styles array
The data for the language used.
static getInstanceByRefId($a_ref_id, $stop_on_error=true)
get an instance of an Ilias object by reference id
Add data(end) time
Method that wraps PHPs time in order to allow simulations with the workflow.
+ Here is the call graph for this function:

◆ listSessions()

ilSessionOverviewGUI::listSessions ( )

list sessions of all user

public

Parameters

Definition at line 93 of file class.ilSessionOverviewGUI.php.

References $ilErr, and $tbl.

94  {
95  global $ilToolbar,$ilErr,$ilAccess;
96 
97  if(!$ilAccess->checkAccess('manage_members','',$this->course_ref_id))
98  {
99  $ilErr->raiseError($this->lng->txt('msg_no_perm_read'),$ilErr->MESSAGE);
100  }
101 
102  $ilToolbar->addButton($this->lng->txt('event_csv_export'),
103  $this->ctrl->getLinkTarget($this,'exportCSV'));
104 
105  include_once 'Modules/Session/classes/class.ilSessionOverviewTableGUI.php';
106  $tbl = new ilSessionOverviewTableGUI($this, 'listSessions', $this->course_ref_id, $this->members_obj->getParticipants());
107  $this->tpl->setContent($tbl->getHTML());
108  }
global $ilErr
Definition: raiseError.php:16
$tbl
Definition: example_048.php:81
Table presentation for session overview.

Field Documentation

◆ $course_id

ilSessionOverviewGUI::$course_id = null
protected

Definition at line 35 of file class.ilSessionOverviewGUI.php.

◆ $course_ref_id

ilSessionOverviewGUI::$course_ref_id = null
protected

Definition at line 34 of file class.ilSessionOverviewGUI.php.

◆ $ctrl

ilSessionOverviewGUI::$ctrl
protected

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

◆ $lng

ilSessionOverviewGUI::$lng
protected

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

Referenced by __construct().

◆ $tpl

ilSessionOverviewGUI::$tpl
protected

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

Referenced by __construct().


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