ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
•All Data Structures Namespaces Files Functions Variables Modules Pages
class.ilLPStatusSCORM.php
Go to the documentation of this file.
1 <?php
2 
3 /* Copyright (c) 1998-2011 ILIAS open source, Extended GPL, see docs/LICENSE */
4 
5 include_once './Services/Tracking/classes/class.ilLPStatus.php';
6 
15 class ilLPStatusSCORM extends ilLPStatus
16 {
17 
18  function ilLPStatusSCORM($a_obj_id)
19  {
20  global $ilDB;
21 
22  parent::ilLPStatus($a_obj_id);
23  $this->db =& $ilDB;
24  }
25 
26 
27  function _getInProgress($a_obj_id)
28  {
29  $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
30  $users = array();
31  foreach($status_info['in_progress'] as $in_progress)
32  {
33  $users = array_merge($users,$in_progress);
34  }
35  $users = array_unique($users);
36  $users = array_diff($users,ilLPStatusWrapper::_getCompleted($a_obj_id));
37  $users = array_diff($users,ilLPStatusWrapper::_getFailed($a_obj_id));
38 
39  return $users;
40  }
41 
42  function _getCompleted($a_obj_id)
43  {
44  global $ilDB;
45 
46  include_once './Modules/ScormAicc/classes/SCORM/class.ilObjSCORMTracking.php';
47 
48  $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
49 
50  $items = $status_info['scos'];
51 
52  $counter = 0;
53  $users = array();
54  foreach($items as $sco_id)
55  {
56  $tmp_users = $status_info['completed'][$sco_id];
57 
58  if(!$counter++)
59  {
60  $users = $tmp_users;
61  }
62  else
63  {
64  $users = array_intersect($users,$tmp_users);
65  }
66  }
67 
68  $users = array_diff($users,ilLPStatusWrapper::_getFailed($a_obj_id));
69  return $users;
70  }
71 
72  function _getFailed($a_obj_id)
73  {
74  $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
75 
76  if(!count($status_info['scos']))
77  {
78  return array();
79  }
80  $users = array();
81  foreach($status_info['scos'] as $sco_id)
82  {
83  // max attempts vs. failed
84  if(sizeof($status_info['in_progress'][$sco_id]))
85  {
86  foreach($status_info['in_progress'][$sco_id] as $user_id)
87  {
88  if(!in_array($user_id, $status_info['failed'][$sco_id]))
89  {
90  switch($status_info["subtype"])
91  {
92  case 'hacp':
93  case 'aicc':
94  case 'scorm':
95  include_once './Modules/ScormAicc/classes/SCORM/class.ilObjSCORMTracking.php';
96  $has_max_attempts = ilObjSCORMTracking::_hasMaxAttempts($a_obj_id, $user_id);
97  break;
98 
99  case 'scorm2004':
100  include_once("./Modules/Scorm2004/classes/class.ilSCORM2004Tracking.php");
101  $has_max_attempts = ilSCORM2004Tracking::_hasMaxAttempts($a_obj_id, $user_id);
102  break;
103  }
104 
105  if($has_max_attempts)
106  {
107  $status_info['failed'][$sco_id][] = $user_id;
108  }
109  }
110  }
111  }
112 
113  $users = array_merge($users,(array) $status_info['failed'][$sco_id]);
114  }
115  return array_unique($users);
116  }
117 
118 
119  function _getStatusInfo($a_obj_id)
120  {
121  // Which sco's determine the status
122  include_once './Services/Object/classes/class.ilObjectLP.php';
123  $olp = ilObjectLP::getInstance($a_obj_id);
124  $collection = $olp->getCollectionInstance();
125  if($collection)
126  {
127  $status_info['scos'] = $collection->getItems();
128  }
129  else
130  {
131  $status_info['scos'] = array();
132  }
133  $status_info['num_scos'] = count($status_info['scos']);
134 
135  // Get subtype
136  include_once './Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php';
137  $status_info['subtype'] = ilObjSAHSLearningModule::_lookupSubType($a_obj_id);
138 
139  switch($status_info['subtype'])
140  {
141  case 'hacp':
142  case 'aicc':
143  include_once './Modules/ScormAicc/classes/SCORM/class.ilObjSCORMTracking.php';
144  $status_info['num_completed'] = ilObjSCORMTracking::_getCountCompletedPerUser($status_info['scos'],$a_obj_id);
145 
146  include_once './Modules/ScormAicc/classes/class.ilObjAICCLearningModule.php';
147  foreach(ilObjAICCLearningModule::_getTrackingItems($a_obj_id) as $item)
148  {
149  if(in_array($item['obj_id'],$status_info['scos']))
150  {
151  $status_info['scos_title']["$item[obj_id]"] = $item['title'];
152  }
153  }
154  $info = ilObjSCORMTracking::_getProgressInfo($status_info['scos'],$a_obj_id);
155  break;
156 
157  case 'scorm':
158  include_once './Modules/ScormAicc/classes/SCORM/class.ilObjSCORMTracking.php';
159  $status_info['num_completed'] = ilObjSCORMTracking::_getCountCompletedPerUser($status_info['scos'],$a_obj_id);
160 
161  include_once './Modules/ScormAicc/classes/SCORM/class.ilSCORMItem.php';
162  foreach($status_info['scos'] as $sco_id)
163  {
164  $status_info['scos_title'][$sco_id] = ilSCORMItem::_lookupTitle($sco_id);
165  }
166  $info = ilObjSCORMTracking::_getProgressInfo($status_info['scos'],$a_obj_id);
167  break;
168 
169  case "scorm2004":
170  include_once './Modules/Scorm2004/classes/class.ilSCORM2004Tracking.php';
171  $status_info['num_completed'] = ilSCORM2004Tracking::_getCountCompletedPerUser($status_info['scos'],$a_obj_id,true);
172  include_once './Modules/Scorm2004/classes/class.ilObjSCORM2004LearningModule.php';
173  foreach($status_info['scos'] as $sco_id)
174  {
175  $status_info['scos_title'][$sco_id] = ilObjSCORM2004LearningModule::_lookupItemTitle($sco_id);
176  }
177 
178  $info = ilSCORM2004Tracking::_getItemProgressInfo($status_info['scos'],$a_obj_id,true);
179  break;
180  }
181 
182  $status_info['completed'] = array();
183  $status_info['failed'] = array();
184  $status_info['in_progress'] = array();
185  foreach($status_info['scos'] as $sco_id)
186  {
187  $status_info['completed'][$sco_id] = $info['completed'][$sco_id] ? $info['completed'][$sco_id] : array();
188  $status_info['failed'][$sco_id] = $info['failed'][$sco_id] ? $info['failed'][$sco_id] : array();
189  $status_info['in_progress'][$sco_id] = $info['in_progress'][$sco_id] ? $info['in_progress'][$sco_id] : array();
190  }
191 //var_dump($status_info["completed"]);
192  return $status_info;
193  }
194 
203  function determineStatus($a_obj_id, $a_user_id, $a_obj = null)
204  {
205  global $ilObjDataCache, $ilDB, $ilLog;
206 
207  $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
208 
209  // if the user has accessed the scorm object
210  // the status is at least "in progress"
211  include_once("./Services/Tracking/classes/class.ilChangeEvent.php");
212  if (ilChangeEvent::hasAccessed($a_obj_id, $a_user_id))
213  {
214  $status = self::LP_STATUS_IN_PROGRESS_NUM;
215  }
216 //$ilLog->write("-".$status."-");
217 
218  // Which sco's determine the status
219  include_once './Services/Object/classes/class.ilObjectLP.php';
220  $olp = ilObjectLP::getInstance($a_obj_id);
221  $collection = $olp->getCollectionInstance();
222  if($collection)
223  {
224  $scos = $collection->getItems();
225  if(sizeof($scos)) // #15462 (#11513 - empty collections cannot be completed)
226  {
227  include_once './Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php';
228  $subtype = ilObjSAHSLearningModule::_lookupSubType($a_obj_id);
229  switch($subtype)
230  {
231  case 'hacp':
232  case 'aicc':
233  case 'scorm':
234  include_once("./Modules/ScormAicc/classes/SCORM/class.ilObjSCORMTracking.php");
235  $scorm_status = ilObjSCORMTracking::_getCollectionStatus($scos, $a_obj_id, $a_user_id);
236  break;
237 
238  case 'scorm2004':
239  include_once("./Modules/Scorm2004/classes/class.ilSCORM2004Tracking.php");
240  $scorm_status = ilSCORM2004Tracking::_getCollectionStatus($scos, $a_obj_id, $a_user_id);
241  break;
242  }
243 
244  switch ($scorm_status)
245  {
246  case "in_progress":
247  $status = self::LP_STATUS_IN_PROGRESS_NUM;
248  break;
249  case "completed":
250  $status = self::LP_STATUS_COMPLETED_NUM;
251  break;
252  case "failed":
253  $status = self::LP_STATUS_FAILED_NUM;
254  break;
255  }
256  }
257  }
258 
259 //$ilLog->write("-".$status."-");
260  return $status;
261  }
262 
271  function determinePercentage($a_obj_id, $a_user_id, $a_obj = null)
272  {
273  // Which sco's determine the status
274  include_once './Services/Object/classes/class.ilObjectLP.php';
275  $olp = ilObjectLP::getInstance($a_obj_id);
276  $collection = $olp->getCollectionInstance();
277  if($collection)
278  {
279  $scos = $collection->getItems();
280  $reqscos = count($scos);
281 
282  include_once './Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php';
283  $subtype = ilObjSAHSLearningModule::_lookupSubType($a_obj_id);
284  if ($subtype != "scorm2004")
285  {
286  include_once("./Modules/ScormAicc/classes/SCORM/class.ilObjSCORMTracking.php");
287  $compl = ilObjSCORMTracking::_countCompleted($scos, $a_obj_id, $a_user_id);
288  }
289  else
290  {
291  include_once("./Modules/Scorm2004/classes/class.ilSCORM2004Tracking.php");
292  $compl = ilSCORM2004Tracking::_countCompleted($scos, $a_obj_id, $a_user_id, true);
293  }
294  }
295 
296  if ($reqscos > 0)
297  {
298  $per = min(100, 100 / $reqscos * $compl);
299  }
300  else
301  {
302  $per = 100;
303  }
304 
305  return $per;
306  }
307 
308  function refreshStatus($a_obj_id)
309  {
310  parent::refreshStatus($a_obj_id);
311 
312  // this is restricted to SCOs in the current collection
313  include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
314  $in_progress = ilLPStatusWrapper::_getInProgress($a_obj_id);
315  $completed = ilLPStatusWrapper::_getCompleted($a_obj_id);
316  $failed = ilLPStatusWrapper::_getFailed($a_obj_id);
317  $all_active_users = array_unique(array_merge($in_progress, $completed, $failed));
318 
319  // get all tracked users regardless of SCOs
320  include_once './Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php';
321  $subtype = ilObjSAHSLearningModule::_lookupSubType($a_obj_id);
322  if ($subtype != "scorm2004")
323  {
324  include_once("./Modules/ScormAicc/classes/SCORM/class.ilObjSCORMTracking.php");
325  $all_tracked_users = ilObjSCORMTracking::_getTrackedUsers($a_obj_id);
326  }
327  else
328  {
329  include_once("./Modules/Scorm2004/classes/class.ilSCORM2004Tracking.php");
330  $all_tracked_users = ilSCORM2004Tracking::_getTrackedUsers($a_obj_id);
331  }
332 
333  $not_attempted_users = array_diff($all_tracked_users, $all_active_users);
334  unset($all_tracked_users);
335  unset($all_active_users);
336 
337  // reset all users which have no data for the current SCOs
338  if($not_attempted_users)
339  {
340  foreach($not_attempted_users as $usr_id)
341  {
342  // this will update any (parent) collections if necessary
343  ilLPStatus::writeStatus($a_obj_id, $usr_id, self::LP_STATUS_NOT_ATTEMPTED_NUM, 0);
344  }
345  }
346  }
347 }
348 ?>
ilSCORM2004Tracking\_hasMaxAttempts
static _hasMaxAttempts($a_obj_id, $a_user_id)
Definition: class.ilSCORM2004Tracking.php:348
ilChangeEvent\hasAccessed
static hasAccessed($a_obj_id, $a_usr_id)
Has accessed.
Definition: class.ilChangeEvent.php:852
ilSCORM2004Tracking\_getTrackedUsers
_getTrackedUsers($a_obj_id)
Get all tracked users.
Definition: class.ilSCORM2004Tracking.php:237
ilObjAICCLearningModule\_getTrackingItems
_getTrackingItems($a_obj_id)
get all tracking items of scorm object
Definition: class.ilObjAICCLearningModule.php:164
ilSCORM2004Tracking\_getItemProgressInfo
_getItemProgressInfo($a_scorm_item_ids, $a_obj_id, $a_omit_failed=false)
Definition: class.ilSCORM2004Tracking.php:257
ilSCORMItem\_lookupTitle
_lookupTitle($a_obj_id)
Definition: class.ilSCORMItem.php:329
ilLPStatusWrapper\_getStatusInfo
_getStatusInfo($a_obj_id)
Reads informations about the object e.g test results, tlt, number of visits.
Definition: class.ilLPStatusWrapper.php:128
ilObjSCORMTracking\_countCompleted
static _countCompleted($a_scos, $a_obj_id, $a_user_id)
Definition: class.ilObjSCORMTracking.php:563
ilObjSCORMTracking\_hasMaxAttempts
static _hasMaxAttempts($a_obj_id, $a_user_id)
Definition: class.ilObjSCORMTracking.php:532
ilObjSCORMTracking\_getCountCompletedPerUser
static _getCountCompletedPerUser($a_scorm_item_ids, $a_obj_id)
Get users who have status completed or passed.
Definition: class.ilObjSCORMTracking.php:688
ilLPStatusSCORM\determineStatus
determineStatus($a_obj_id, $a_user_id, $a_obj=null)
Determine status.
Definition: class.ilLPStatusSCORM.php:203
ilLPStatusWrapper\_getFailed
_getFailed($a_obj_id)
Static function to read the users who have the status &#39;completed&#39;.
Definition: class.ilLPStatusWrapper.php:111
ilSCORM2004Tracking\_countCompleted
static _countCompleted($a_scos, $a_obj_id, $a_user_id, $a_omit_failed=false)
Definition: class.ilSCORM2004Tracking.php:377
ilObjSAHSLearningModule\_lookupSubType
_lookupSubType($a_obj_id)
lookup subtype id (scorm, aicc, hacp)
Definition: class.ilObjSAHSLearningModule.php:157
ilLPStatusWrapper\_getCompleted
_getCompleted($a_obj_id)
Static function to read the users who have the status &#39;completed&#39;.
Definition: class.ilLPStatusWrapper.php:88
$ilLog
$ilLog
Definition: inc.setup_header.php:132
$failed
$failed
Definition: Utf8Test.php:86
ilSCORM2004Tracking\_getCollectionStatus
static _getCollectionStatus($a_scos, $a_obj_id, $a_user_id)
Definition: class.ilSCORM2004Tracking.php:300
ilLPStatus\writeStatus
static writeStatus($a_obj_id, $a_user_id, $a_status, $a_percentage=false, $a_force_per=false)
Write status for user and object.
Definition: class.ilLPStatus.php:363
ilObjSCORMTracking\_getCollectionStatus
static _getCollectionStatus($a_scos, $a_obj_id, $a_user_id)
Definition: class.ilObjSCORMTracking.php:476
ilObjSCORMTracking\_getProgressInfo
static _getProgressInfo($sco_item_ids, $a_obj_id)
Get info about.
Definition: class.ilObjSCORMTracking.php:735
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
ilLPStatus
Abstract class ilLPStatus for all learning progress modes E.g ilLPStatusManual, ilLPStatusObjectives ...
Definition: class.ilLPStatus.php:15
ilLPStatusSCORM\determinePercentage
determinePercentage($a_obj_id, $a_user_id, $a_obj=null)
Determine percentage.
Definition: class.ilLPStatusSCORM.php:271
ilLPStatusWrapper\_getInProgress
_getInProgress($a_obj_id)
Static function to read users who have the status &#39;in_progress&#39;.
Definition: class.ilLPStatusWrapper.php:62
ilObjSCORMTracking\_getTrackedUsers
_getTrackedUsers($a_obj_id)
Get all tracked users.
Definition: class.ilObjSCORMTracking.php:621
ilObjectLP\getInstance
static getInstance($a_obj_id)
Definition: class.ilObjectLP.php:25
ilSCORM2004Tracking\_getCountCompletedPerUser
_getCountCompletedPerUser($a_scorm_item_ids, $a_obj_id, $a_omit_failed=false)
Get progress of selected scos.
Definition: class.ilSCORM2004Tracking.php:124