ILIAS  release_4-4 Revision
•All Data Structures Namespaces Files Functions Variables Modules Pages
Public Member Functions | Protected Attributes
ilSessionOverviewGUI Class Reference
Modules/Session
+ 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  }
$ilCtrl
global $ilCtrl
Definition: ilias.php:18
ilObject\_lookupObjId
static _lookupObjId($a_id)
Definition: class.ilObject.php:1028
+ 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
$cmd
Definition: sahs_server.php:35

◆ exportCSV()

ilSessionOverviewGUI::exportCSV ( )

Events List CSV Export.

public

Parameters

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

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

227  {
228  global $tree,$ilAccess;
229 
230  include_once('Services/Utilities/classes/class.ilCSVWriter.php');
231  include_once 'Modules/Session/classes/class.ilEventParticipants.php';
232 
233  $members = $this->members_obj->getParticipants();
234  $members = ilUtil::_sortIds($members,'usr_data','lastname','usr_id');
235 
236  $events = array();
237  foreach($tree->getSubtree($tree->getNodeData($this->course_ref_id),false,'sess') as $event_id)
238  {
239  $tmp_event = ilObjectFactory::getInstanceByRefId($event_id,false);
240  if(!is_object($tmp_event) or !$ilAccess->checkAccess('write','',$event_id))
241  {
242  continue;
243  }
244  $events[] = $tmp_event;
245  }
246 
247  $this->csv = new ilCSVWriter();
248  $this->csv->addColumn($this->lng->txt("lastname"));
249  $this->csv->addColumn($this->lng->txt("firstname"));
250  $this->csv->addColumn($this->lng->txt("login"));
251 
252  foreach($events as $event_obj)
253  {
254  // TODO: do not export relative dates
255  $this->csv->addColumn($event_obj->getTitle().' ('.$event_obj->getFirstAppointment()->appointmentToString().')');
256  }
257 
258  $this->csv->addRow();
259 
260  foreach($members as $user_id)
261  {
262  $name = ilObjUser::_lookupName($user_id);
263 
264  $this->csv->addColumn($name['lastname']);
265  $this->csv->addColumn($name['firstname']);
266  $this->csv->addColumn(ilObjUser::_lookupLogin($user_id));
267 
268  foreach($events as $event_obj)
269  {
270  $event_part = new ilEventParticipants((int) $event_obj->getId());
271 
272  $this->csv->addColumn($event_part->hasParticipated($user_id) ?
273  $this->lng->txt('event_participated') :
274  $this->lng->txt('event_not_participated'));
275  }
276 
277  $this->csv->addRow();
278  }
279  $date = new ilDate(time(),IL_CAL_UNIX);
280  ilUtil::deliverData($this->csv->getCSVString(),$date->get(IL_CAL_FKT_DATE,'Y-m-d')."_course_events.csv", "text/csv");
281  }
ilObjUser\_lookupName
static _lookupName($a_user_id)
lookup user name
Definition: class.ilObjUser.php:724
ilUtil\deliverData
static deliverData($a_data, $a_filename, $mime="application/octet-stream", $charset="")
deliver data for download via browser.
Definition: class.ilUtil.php:2166
ilCSVWriter
Helper class to generate CSV files.
Definition: class.ilCSVWriter.php:38
ilObjectFactory\getInstanceByRefId
getInstanceByRefId($a_ref_id, $stop_on_error=true)
get an instance of an Ilias object by reference id
Definition: class.ilObjectFactory.php:143
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:11
ilDate
Class for single dates.
Definition: class.ilDate.php:36
ilUtil\_sortIds
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.
Definition: class.ilUtil.php:4842
IL_CAL_FKT_DATE
const IL_CAL_FKT_DATE
Definition: class.ilDateTime.php:12
ilObjUser\_lookupLogin
_lookupLogin($a_user_id)
lookup login
Definition: class.ilObjUser.php:754
+ 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 $_GET, $_SESSION, $ilErr, $ilUser, ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), ilUtil\_sortIds(), ilUtil\getImagePath(), ilObjectFactory\getInstanceByRefId(), and ilUtil\switchColor().

94  {
95  global $ilErr,$ilAccess, $ilUser,$tree;
96 
97  if(!$ilAccess->checkAccess('write','',$this->course_ref_id))
98  {
99  $ilErr->raiseError($this->lng->txt('msg_no_perm_read'),$ilErr->MESSAGE);
100  }
101 
102  $this->tpl->addBlockFile('ADM_CONTENT','adm_content','tpl.sess_list.html','Modules/Session');
103  $this->tpl->addBlockfile("BUTTONS", "buttons", "tpl.buttons.html");
104 
105  // display button
106  $this->tpl->setCurrentBlock("btn_cell");
107  $this->tpl->setVariable("BTN_LINK",$this->ctrl->getLinkTarget($this,'exportCSV'));
108  $this->tpl->setVariable("BTN_TXT",$this->lng->txt('event_csv_export'));
109  $this->tpl->parseCurrentBlock();
110 
111  include_once 'Modules/Session/classes/class.ilEventParticipants.php';
112 
113  $this->tpl->addBlockfile("EVENTS_TABLE","events_table", "tpl.table.html");
114  $this->tpl->addBlockfile('TBL_CONTENT','tbl_content','tpl.sess_list_row.html','Modules/Session');
115 
116  $members = $this->members_obj->getParticipants();
117  $members = ilUtil::_sortIds($members,'usr_data','lastname','usr_id');
118 
119  // Table
120  $tbl = new ilTableGUI();
121  $tbl->setTitle($this->lng->txt("event_overview"),
122  'icon_usr.png',
123  $this->lng->txt('obj_usr'));
124  $this->ctrl->setParameter($this,'offset',(int) $_GET['offset']);
125 
126  $events = array();
127  foreach($tree->getSubtree($tree->getNodeData($this->course_ref_id),false,'sess') as $event_id)
128  {
129  $tmp_event = ilObjectFactory::getInstanceByRefId($event_id,false);
130  if(!is_object($tmp_event) or !$ilAccess->checkAccess('write','',$event_id))
131  {
132  continue;
133  }
134  $events[] = $tmp_event;
135  }
136 
137  $headerNames = array();
138  $headerVars = array();
139  $colWidth = array();
140 
141  $headerNames[] = $this->lng->txt('name');
142  $headerVars[] = "name";
143  $colWidth[] = '20%';
144 
145  for ($i = 1; $i <= count($events); $i++)
146  {
147  $headerNames[] = $i;
148  $headerVars[] = "event_".$i;
149  $colWidth[] = 80/count($events)."%";
150  }
151 
152  $this->tpl->setVariable("FORMACTION",$this->ctrl->getFormAction($this));
153  $tbl->setHeaderNames($headerNames);
154  $tbl->setHeaderVars($headerVars, $this->ctrl->getParameterArray($this,'listSessions'));
155  $tbl->setColumnWidth($colWidth);
156 
157  $tbl->setOrderColumn($_GET["sort_by"]);
158  $tbl->setOrderDirection($_GET["sort_order"]);
159  $tbl->setOffset($_GET["offset"]);
160  $tbl->setLimit($ilUser->getPref("hits_per_page"));
161  $tbl->setMaxCount(count($members));
162  $tbl->setFooter("tblfooter",$this->lng->txt("previous"),$this->lng->txt("next"));
163 
164  $sliced_users = array_slice($members,$_GET['offset'],$_SESSION['tbl_limit']);
165  $tbl->disable('sort');
166  $tbl->render();
167 
168  $counter = 0;
169  foreach($sliced_users as $user_id)
170  {
171  foreach($events as $event_obj)
172  {
173  $this->tpl->setCurrentBlock("eventcols");
174 
175  $event_part = new ilEventParticipants($event_obj->getId());
176 
177  {
178  $this->tpl->setVariable("IMAGE_PARTICIPATED", $event_part->hasParticipated($user_id) ?
179  ilUtil::getImagePath('icon_ok.png') :
180  ilUtil::getImagePath('icon_not_ok.png'));
181 
182  $this->tpl->setVariable("PARTICIPATED", $event_part->hasParticipated($user_id) ?
183  $this->lng->txt('event_participated') :
184  $this->lng->txt('event_not_participated'));
185  }
186 
187  $this->tpl->parseCurrentBlock();
188  }
189 
190  $this->tpl->setCurrentBlock("tbl_content");
191  $name = ilObjUser::_lookupName($user_id);
192  $this->tpl->setVariable("CSS_ROW",ilUtil::switchColor($counter++,'tblrow1','tblrow2'));
193  $this->tpl->setVariable("LASTNAME",$name['lastname']);
194  $this->tpl->setVariable("FIRSTNAME",$name['firstname']);
195  $this->tpl->setVariable("LOGIN",ilObjUser::_lookupLogin($user_id));
196  $this->tpl->parseCurrentBlock();
197  }
198 
199  $this->tpl->setVariable("HEAD_TXT_LEGEND", $this->lng->txt("legend"));
200  $this->tpl->setVariable("HEAD_TXT_DIGIT", $this->lng->txt("event_digit"));
201  $this->tpl->setVariable("HEAD_TXT_EVENT", $this->lng->txt("event"));
202  $this->tpl->setVariable("HEAD_TXT_LOCATION", $this->lng->txt("event_location"));
203  $this->tpl->setVariable("HEAD_TXT_DATE_TIME",$this->lng->txt("event_date_time"));
204  $i = 1;
205  foreach($events as $event_obj)
206  {
207  $this->tpl->setCurrentBlock("legend_loop");
208  $this->tpl->setVariable("LEGEND_CSS_ROW",ilUtil::switchColor($counter++,'tblrow1','tblrow2'));
209  $this->tpl->setVariable("LEGEND_DIGIT", $i++);
210  $this->tpl->setVariable("LEGEND_EVENT_TITLE", $event_obj->getTitle());
211  $this->tpl->setVariable("LEGEND_EVENT_DESCRIPTION", $event_obj->getDescription());
212  $this->tpl->setVariable("LEGEND_EVENT_LOCATION", $event_obj->getLocation());
213  $this->tpl->setVariable("LEGEND_EVENT_APPOINTMENT", $event_obj->getFirstAppointment()->appointmentToString());
214  $this->tpl->parseCurrentBlock();
215  }
216 
217  }
$_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
ilObjUser\_lookupName
static _lookupName($a_user_id)
lookup user name
Definition: class.ilObjUser.php:724
ilObjectFactory\getInstanceByRefId
getInstanceByRefId($a_ref_id, $stop_on_error=true)
get an instance of an Ilias object by reference id
Definition: class.ilObjectFactory.php:143
$_GET
$_GET["client_id"]
Definition: cfg.phpunit.template.php:12
ilTableGUI
Class ilTableGUI.
Definition: class.ilTableGUI.php:18
ilUtil
Util class various functions, usage as namespace.
Definition: class.ilUtil.php:17
ilUtil\_sortIds
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),&#39;usr_data&#39;,&#39;lastname&#39;,&#39;usr_id&#39;) => sorts by lastname.
Definition: class.ilUtil.php:4842
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
ilObjUser\_lookupLogin
_lookupLogin($a_user_id)
lookup login
Definition: class.ilObjUser.php:754
$ilUser
global $ilUser
Definition: imgupload.php:15
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
$ilErr
$ilErr
Definition: inc.setup_header.php:81
+ Here is the call graph for this function:

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: