ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
class.ilLPStatusEvent.php
Go to the documentation of this file.
1<?php
2/*
3 +-----------------------------------------------------------------------------+
4 | ILIAS open source |
5 +-----------------------------------------------------------------------------+
6 | Copyright (c) 1998-2001 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
33include_once './Services/Tracking/classes/class.ilLPStatus.php';
34include_once './Services/Tracking/classes/class.ilLPStatusWrapper.php';
35
37{
38
39 function ilLPStatusEvent($a_obj_id)
40 {
41 global $ilDB;
42
43 parent::ilLPStatus($a_obj_id);
44 $this->db =& $ilDB;
45 }
46
47 function _getNotAttempted($a_obj_id)
48 {
49 $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
50
51 $users = array();
52
53 $members = self::getMembers($status_info['crs_id'], true);
54 if($members)
55 {
56 // diff in progress and completed (use stored result in LPStatusWrapper)
57 $users = array_diff((array) $members, ilLPStatusWrapper::_getInProgress($a_obj_id));
58 $users = array_diff((array) $users, ilLPStatusWrapper::_getCompleted($a_obj_id));
59 }
60
61 return $users;
62 }
63
64 function _getInProgress($a_obj_id)
65 {
66 $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
67
68 // If registration is disabled in_progress is not available
69 if(!$status_info['registration'])
70 {
71 return array();
72 }
73 // If event has occured in_progress is impossible
74 if($status_info['starting_time'] < time())
75 {
76 return array();
77 }
78
79 // Otherwise all users who registered will get the status in progress
80 return $status_info['registered_users'] ? $status_info['registered_users'] : array();
81 }
82
83 function _getCompleted($a_obj_id)
84 {
85 $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
86 return $status_info['participated_users'] ? $status_info['participated_users'] : array();
87 }
88
89 function _getStatusInfo($a_obj_id)
90 {
91 global $tree;
92
93 include_once './Modules/Session/classes/class.ilEventParticipants.php';
94 include_once('./Modules/Session/classes/class.ilObjSession.php');
95 include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
96
97 $references = ilObject::_getAllReferences($a_obj_id);
98 $ref_id = end($references);
99
100 $course_ref_id = $tree->checkForParentType($ref_id,'crs');
101 $course_obj_id = ilObject::_lookupObjId($course_ref_id);
102
103 $status_info = array();
104 $status_info['crs_id'] = $course_obj_id;
105 $status_info['registration'] = ilObjSession::_lookupRegistrationEnabled($a_obj_id);
106 $status_info['title'] = ilObject::_lookupTitle($a_obj_id);
107 $status_info['description'] = ilObject::_lookupDescription($a_obj_id);
108
109 $time_info = ilSessionAppointment::_lookupAppointment($a_obj_id);
110 $status_info['starting_time'] = $time_info['start'];
111 $status_info['ending_time'] = $time_info['end'];
112 $status_info['fullday'] = $time_info['fullday'];
113
114 $status_info['registered_users'] = ilEventParticipants::_getRegistered($a_obj_id);
115 $status_info['participated_users'] = ilEventParticipants::_getParticipated($a_obj_id);
116
117 return $status_info;
118 }
119
128 function determineStatus($a_obj_id, $a_user_id, $a_obj = null)
129 {
130 global $ilObjDataCache;
131
133 switch ($ilObjDataCache->lookupType($a_obj_id))
134 {
135 case 'sess':
136 include_once './Modules/Session/classes/class.ilEventParticipants.php';
137 include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
138 include_once('./Modules/Session/classes/class.ilObjSession.php');
139
140 $time_info = ilSessionAppointment::_lookupAppointment($a_obj_id);
141 $registration = ilObjSession::_lookupRegistrationEnabled($a_obj_id);
142
143 // If registration is disabled in_progress is not available
144 // If event has occured in_progress is impossible
145 if ($registration && $time_info['start'] >= time())
146 {
147 // is user registered -> in progress
148 if (ilEventParticipants::_isRegistered($a_user_id, $a_obj_id))
149 {
151 }
152 }
153 if (ilEventParticipants::_hasParticipated($a_user_id, $a_obj_id))
154 {
156 }
157 break;
158 }
159 return $status;
160 }
161
168 protected static function getMembers($a_obj_id, $a_is_crs_id = false)
169 {
170 // find course in path
171 if(!$a_is_crs_id)
172 {
173 $references = ilObject::_getAllReferences($a_obj_id);
174 $ref_id = end($references);
175 $course_ref_id = $tree->checkForParentType($ref_id,'crs');
176 $course_obj_id = ilObject::_lookupObjId($course_ref_id);
177 }
178 else
179 {
180 $course_obj_id = $a_obj_id;
181 }
182
183 include_once 'Modules/Course/classes/class.ilCourseParticipants.php';
184 $member_obj = ilCourseParticipants::_getInstanceByObjId($course_obj_id);
185 return $member_obj->getMembers();
186 }
187
195 public static function _lookupCompletedForObject($a_obj_id, $a_user_ids = null)
196 {
197 if(!$a_user_ids)
198 {
199 $a_user_ids = self::getMembers($a_obj_id);
200 if(!$a_user_ids)
201 {
202 return array();
203 }
204 }
205 return self::_lookupStatusForObject($a_obj_id, self::LP_STATUS_COMPLETED_NUM, $a_user_ids);
206 }
207
215 public static function _lookupFailedForObject($a_obj_id, $a_user_ids = null)
216 {
217 return array();
218 }
219
227 public static function _lookupInProgressForObject($a_obj_id, $a_user_ids = null)
228 {
229 if(!$a_user_ids)
230 {
231 $a_user_ids = self::getMembers($a_obj_id);
232 if(!$a_user_ids)
233 {
234 return array();
235 }
236 }
237 return self::_lookupStatusForObject($a_obj_id, self::LP_STATUS_IN_PROGRESS_NUM, $a_user_ids);
238 }
239}
240?>
static _getInstanceByObjId($a_obj_id)
Get singleton instance.
static _isRegistered($a_usr_id, $a_event_id)
static _hasParticipated($a_usr_id, $a_event_id)
static getMembers($a_obj_id, $a_is_crs_id=false)
Get members for object.
determineStatus($a_obj_id, $a_user_id, $a_obj=null)
Determine status.
static _lookupCompletedForObject($a_obj_id, $a_user_ids=null)
Get completed users for object.
static _lookupFailedForObject($a_obj_id, $a_user_ids=null)
Get failed users for object.
static _lookupInProgressForObject($a_obj_id, $a_user_ids=null)
Get in progress users for object.
_getCompleted($a_obj_id)
Static function to read the users who have the status 'completed'.
_getStatusInfo($a_obj_id)
Reads informations about the object e.g test results, tlt, number of visits.
_getInProgress($a_obj_id)
Static function to read users who have the status 'in_progress'.
Abstract class ilLPStatus for all learning progress modes E.g ilLPStatusManual, ilLPStatusObjectives ...
const LP_STATUS_COMPLETED_NUM
static _lookupStatusForObject($a_obj_id, $a_status, $a_user_ids=null)
Get users with given status for object.
const LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM
static _lookupRegistrationEnabled($a_obj_id)
lookup registration enabled
static _lookupObjId($a_id)
static _lookupTitle($a_id)
lookup object title
static _lookupDescription($a_id)
lookup object description
static _getAllReferences($a_id)
get all reference ids of object
static _lookupAppointment($a_obj_id)
lookup appointment
$ref_id
Definition: sahs_server.php:39
global $ilDB