ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
Static Public Member Functions
ilSCORM2004Tracking Class Reference
Modules/ScormAicc

Class ilSCORM2004Tracking. More...

+ Collaboration diagram for ilSCORM2004Tracking:

Static Public Member Functions

static _getInProgress ($scorm_item_id, $a_obj_id)
 
static _getCompleted ($scorm_item_id, $a_obj_id)
 
static _getFailed ($scorm_item_id, $a_obj_id)
 
static _getCountCompletedPerUser ($a_scorm_item_ids, $a_obj_id, $a_omit_failed=false)
 Get progress of selected scos. More...
 
static _getProgressInfo ($a_obj_id)
 Get overall scorm status. More...
 
static _getProgressInfoOfUser ($a_obj_id, $a_user_id)
 Get overall scorm status. More...
 
static _getTrackedUsers ($a_obj_id)
 Get all tracked users. More...
 
static _getItemProgressInfo ($a_scorm_item_ids, $a_obj_id, $a_omit_failed=false)
 
static _getCollectionStatus ($a_scos, $a_obj_id, $a_user_id)
 
static _countCompleted ( $a_scos, $a_obj_id, $a_user_id, $a_omit_failed=false)
 
static _syncReadEvent ($a_obj_id, $a_user_id, $a_type, $a_ref_id, $time_from_lms=null)
 Synch read event table. More...
 
static _isCompleted ($a_status, $a_satisfied)
 
static _isInProgress ($a_status, $a_satisfied)
 
static _isFailed ($a_status, $a_satisfied)
 
static getSumTotalTimeSecondsFromScos ($a_obj_id, $a_user_id, $a_write=false)
 should be avoided; store value to increase performance for further requests More...
 

Detailed Description

Class ilSCORM2004Tracking.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Definition at line 12 of file class.ilSCORM2004Tracking.php.

Member Function Documentation

◆ _countCompleted()

static ilSCORM2004Tracking::_countCompleted (   $a_scos,
  $a_obj_id,
  $a_user_id,
  $a_omit_failed = false 
)
static

Definition at line 346 of file class.ilSCORM2004Tracking.php.

351 {
352 global $DIC;
353
354 $ilDB = $DIC->database();
355
356 if (is_array($a_scos)) {
357 $in = $ilDB->in('cp_node.cp_node_id', $a_scos, false, 'integer');
358
359 $res = $ilDB->queryF(
360 'SELECT cp_node.cp_node_id id,
361 cmi_node.completion_status completion,
362 cmi_node.success_status success
363 FROM cp_node, cmi_node
364 WHERE ' . $in . '
365 AND cp_node.cp_node_id = cmi_node.cp_node_id
366 AND cp_node.slm_id = %s
367 AND cmi_node.user_id = %s',
368 array('integer', 'integer'),
369 array($a_obj_id, $a_user_id)
370 );
371
372
373 $cnt = 0;
374 while ($rec = $ilDB->fetchAssoc($res)) {
375 // #8171: alex, added (!$a_omit_failed || $rec["success"] != "failed")
376 // since completed/failed combination should not be included in
377 // percentage calculation at ilLPStatusSCOM::determinePercentage
378 if (($rec["completion"] == "completed" || $rec["success"] == "passed")
379 && (!$a_omit_failed || $rec["success"] != "failed")) {
380 $cnt++;
381 }
382 }
383 }
384 return $cnt;
385 }
$in
if(php_sapi_name() !='cli') $in
Definition: Utf8Test.php:37
$res
foreach($_POST as $key=> $value) $res
Definition: save_question_post_data.php:15
$ilDB
global $ilDB
Definition: storeScorm2004.php:19
$DIC
$DIC
Definition: xapitoken.php:46

References $DIC, $ilDB, $in, and $res.

Referenced by ilLPStatusSCORM\determinePercentage().

+ Here is the caller graph for this function:

◆ _getCollectionStatus()

static ilSCORM2004Tracking::_getCollectionStatus (   $a_scos,
  $a_obj_id,
  $a_user_id 
)
static

Definition at line 298 of file class.ilSCORM2004Tracking.php.

299 {
300 global $DIC;
301
302 $ilDB = $DIC->database();
303
304 $status = "not_attempted";
305
306 if (is_array($a_scos)) {
307 $in = $ilDB->in('cp_node.cp_node_id', $a_scos, false, 'integer');
308
309 $res = $ilDB->queryF(
310 'SELECT cp_node.cp_node_id id,
311 cmi_node.completion_status completion,
312 cmi_node.success_status success
313 FROM cp_node, cmi_node
314 WHERE ' . $in . '
315 AND cp_node.cp_node_id = cmi_node.cp_node_id
316 AND cp_node.slm_id = %s
317 AND cmi_node.user_id = %s',
318 array('integer', 'integer'),
319 array($a_obj_id, $a_user_id)
320 );
321
322 $started = false;
323 $cntcompleted = 0;
324 $failed = false;
325 while ($rec = $ilDB->fetchAssoc($res)) {
326 if ($rec["completion"] == "completed" || $rec["success"] == "passed") {
327 $cntcompleted++;
328 }
329 if ($rec["success"] == "failed") {
330 $failed = true;
331 }
332 $started = true;
333 }
334 if ($started == true) {
335 $status = "in_progress";
336 }
337 if ($failed == true) {
338 $status = "failed";
339 } elseif ($cntcompleted == count($a_scos)) {
340 $status = "completed";
341 }
342 }
343 return $status;
344 }
$failed
$failed
Definition: Utf8Test.php:85

References $DIC, $failed, $ilDB, $in, and $res.

Referenced by ilLPStatusSCORM\determineStatus().

+ Here is the caller graph for this function:

◆ _getCompleted()

static ilSCORM2004Tracking::_getCompleted (   $scorm_item_id,
  $a_obj_id 
)
static

Definition at line 51 of file class.ilSCORM2004Tracking.php.

52 {
53 global $DIC;
54
55 $ilDB = $DIC->database();
56
57 die("Not Implemented: ilSCORM2004Tracking_getCompleted");
58 /*
59 if(is_array($scorm_item_id))
60 {
61 $where = "WHERE sco_id IN(".implode(",",ilUtil::quoteArray($scorm_item_id)).") ";
62 }
63 else
64 {
65 $where = "sco_id = ".$ilDB->quote($scorm_item_id)." ";
66 }
67
68 $query = "SELECT DISTINCT(user_id) FROM scorm_tracking ".
69 $where.
70 "AND obj_id = ".$ilDB->quote($a_obj_id)." ".
71 "AND lvalue = 'cmi.core.lesson_status' ".
72 "AND ( rvalue = 'completed' ".
73 "OR rvalue = 'passed')";
74 $res = $ilDB->query($query);
75 while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
76 {
77 $user_ids[] = $row->user_id;
78 }
79 return $user_ids ? $user_ids : array();
80 */
81 }

References $DIC, and $ilDB.

◆ _getCountCompletedPerUser()

static ilSCORM2004Tracking::_getCountCompletedPerUser (   $a_scorm_item_ids,
  $a_obj_id,
  $a_omit_failed = false 
)
static

Get progress of selected scos.

Parameters
object$a_scorm_item_ids
object$a_obj_id
bool$a_omit_faileddo not include success==failed
Returns

Definition at line 121 of file class.ilSCORM2004Tracking.php.

122 {
123 global $DIC;
124
125 $ilDB = $DIC->database();
126
127 $in = $ilDB->in('cp_node.cp_node_id', $a_scorm_item_ids, false, 'integer');
128
129 // #8171: success_status vs. completion status
130 $omit_failed = '';
131 if ($a_omit_failed) {
132 $omit_failed = ' AND success_status <> ' . $ilDB->quote('failed', 'text');
133 }
134
135 $res = $ilDB->queryF(
136 '
137 SELECT cmi_node.user_id user_id, COUNT(user_id) completed FROM cp_node, cmi_node
138 WHERE ' . $in . $omit_failed . '
139 AND cp_node.cp_node_id = cmi_node.cp_node_id
140 AND cp_node.slm_id = %s
141 AND completion_status = %s
142 GROUP BY cmi_node.user_id',
143 array('integer', 'text'),
144 array($a_obj_id, 'completed')
145 );
146 while ($row = $ilDB->fetchObject($res)) {
147 $users[$row->user_id] = $row->completed;
148 }
149
150 return $users ? $users : array();
151 }

References $DIC, $ilDB, $in, and $res.

Referenced by ilLPStatusSCORM\_getStatusInfo().

+ Here is the caller graph for this function:

◆ _getFailed()

static ilSCORM2004Tracking::_getFailed (   $scorm_item_id,
  $a_obj_id 
)
static

Definition at line 83 of file class.ilSCORM2004Tracking.php.

84 {
85 global $DIC;
86
87 $ilDB = $DIC->database();
88
89 die("Not Implemented: ilSCORM2004Tracking_getFailed");
90 /*
91 if(is_array($scorm_item_id))
92 {
93 $where = "WHERE sco_id IN('".implode("','",$scorm_item_id)."') ";
94 }
95 else
96 {
97 $where = "sco_id = '".$scorm_item_id."' ";
98 }
99
100 $query = "SELECT DISTINCT(user_id) FROM scorm_tracking ".
101 $where.
102 "AND obj_id = '".$a_obj_id."' ".
103 "AND lvalue = 'cmi.core.lesson_status' ".
104 "AND rvalue = 'failed'";
105 $res = $ilDB->query($query);
106 while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
107 {
108 $user_ids[] = $row->user_id;
109 }
110 return $user_ids ? $user_ids : array();
111 */
112 }

References $DIC, and $ilDB.

◆ _getInProgress()

static ilSCORM2004Tracking::_getInProgress (   $scorm_item_id,
  $a_obj_id 
)
static

Definition at line 14 of file class.ilSCORM2004Tracking.php.

15 {
16 die("Not Implemented: ilSCORM2004Tracking_getInProgress");
17 /*
18 global $DIC;
19
20 $ilDB = $DIC->database();
21
22 if(is_array($scorm_item_id))
23 {
24 $where = "WHERE sco_id IN(";
25 $where .= implode(",",ilUtil::quoteArray($scorm_item_id));
26 $where .= ") ";
27 $where .= ("AND obj_id = ".$ilDB->quote($a_obj_id)." ");
28
29 }
30 else
31 {
32 $where = "WHERE sco_id = ".$ilDB->quote($scorm_item_id)." ";
33 $where .= ("AND obj_id = ".$ilDB->quote($a_obj_id)." ");
34 }
35
36
37 $query = "SELECT user_id,sco_id FROM scorm_tracking ".
38 $where.
39 "GROUP BY user_id, sco_id";
40
41
42 $res = $ilDB->query($query);
43 while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
44 {
45 $in_progress[$row->sco_id][] = $row->user_id;
46 }
47 return is_array($in_progress) ? $in_progress : array();
48 */
49 }

◆ _getItemProgressInfo()

static ilSCORM2004Tracking::_getItemProgressInfo (   $a_scorm_item_ids,
  $a_obj_id,
  $a_omit_failed = false 
)
static

Definition at line 257 of file class.ilSCORM2004Tracking.php.

258 {
259 global $DIC;
260
261 $ilDB = $DIC->database();
262
263 $in = $ilDB->in('cp_node.cp_node_id', $a_scorm_item_ids, false, 'integer');
264
265 $res = $ilDB->queryF(
266 'SELECT cp_node.cp_node_id id,
267 cmi_node.user_id user_id,
268 cmi_node.completion_status completion,
269 cmi_node.success_status success
270 FROM cp_node, cmi_node
271 WHERE ' . $in . '
272 AND cp_node.cp_node_id = cmi_node.cp_node_id
273 AND cp_node.slm_id = %s',
274 array('integer'),
275 array($a_obj_id)
276 );
277
278 $info['completed'] = array();
279 $info['failed'] = array();
280 $info['in_progress'] = array();
281
282 while ($row = $ilDB->fetchAssoc($res)) {
283 // if any data available, set in progress.
284 $info['in_progress'][$row["id"]][] = $row["user_id"];
285 if ($row["completion"] == "completed" || $row["success"] == "passed") {
286 // #8171: success_status vs. completion status
287 if (!$a_omit_failed || $row["success"] != "failed") {
288 $info['completed'][$row["id"]][] = $row["user_id"];
289 }
290 }
291 if ($row["success"] == "failed") {
292 $info['failed'][$row["id"]][] = $row["user_id"];
293 }
294 }
295 return $info;
296 }

References $DIC, $ilDB, $in, and $res.

Referenced by ilLPStatusSCORM\_getStatusInfo().

+ Here is the caller graph for this function:

◆ _getProgressInfo()

static ilSCORM2004Tracking::_getProgressInfo (   $a_obj_id)
static

Get overall scorm status.

Parameters
object$a_obj_id
Returns

Definition at line 159 of file class.ilSCORM2004Tracking.php.

160 {
161 global $DIC;
162
163 $ilDB = $DIC->database();
164
165 $res = $ilDB->queryF(
166 '
167 SELECT user_id, status, satisfied FROM cmi_gobjective
168 WHERE objective_id = %s
169 AND scope_id = %s',
170 array('text', 'integer'),
171 array('-course_overall_status-', $a_obj_id)
172 );
173
174 $info['completed'] = array();
175 $info['failed'] = array();
176 $info['in_progress'] = array();
177
178 while ($row = $ilDB->fetchAssoc($res)) {
179 if (self::_isCompleted($row["status"], $row["satisfied"])) {
180 $info['completed'][] = $row["user_id"];
181 }
182 if (self::_isInProgress($row["status"], $row["satisfied"])) {
183 $info['in_progress'][] = $row["user_id"];
184 }
185 if (self::_isFailed($row["status"], $row["satisfied"])) {
186 $info['failed'][] = $row["user_id"];
187 }
188 }
189
190 return $info;
191 }

References $DIC, $ilDB, and $res.

Referenced by ilLPStatusSCORMPackage\_getStatusInfo().

+ Here is the caller graph for this function:

◆ _getProgressInfoOfUser()

static ilSCORM2004Tracking::_getProgressInfoOfUser (   $a_obj_id,
  $a_user_id 
)
static

Get overall scorm status.

Parameters
object$a_obj_id
Returns

Definition at line 198 of file class.ilSCORM2004Tracking.php.

199 {
200 global $DIC;
201
202 $ilDB = $DIC->database();
203 $ilLog = $DIC["ilLog"];
204
205 $res = $ilDB->queryF(
206 '
207 SELECT status, satisfied FROM cmi_gobjective
208 WHERE objective_id = %s
209 AND scope_id = %s AND user_id = %s',
210 array('text', 'integer', 'integer'),
211 array('-course_overall_status-', $a_obj_id, $a_user_id)
212 );
213
214 $status = "not_attempted";
215 if ($row = $ilDB->fetchAssoc($res)) {
216 if (self::_isInProgress($row["status"], $row["satisfied"])) {
217 $status = "in_progress";
218 }
219 if (self::_isCompleted($row["status"], $row["satisfied"])) {
220 $status = "completed";
221 }
222 if (self::_isFailed($row["status"], $row["satisfied"])) {
223 $status = "failed";
224 }
225 }
226 return $status;
227 }
$ilLog
$ilLog
Definition: inc.setup_header.php:123

References $DIC, $ilDB, $ilLog, and $res.

Referenced by ilLPStatusSCORMPackage\determineStatus().

+ Here is the caller graph for this function:

◆ _getTrackedUsers()

static ilSCORM2004Tracking::_getTrackedUsers (   $a_obj_id)
static

Get all tracked users.

Parameters
object$a_obj_id
Returns

Definition at line 234 of file class.ilSCORM2004Tracking.php.

235 {
236 global $DIC;
237
238 $ilDB = $DIC->database();
239 $ilLog = $DIC["ilLog"];
240
241 $res = $ilDB->queryF(
242 '
243 SELECT DISTINCT user_id FROM cmi_gobjective
244 WHERE objective_id = %s
245 AND scope_id = %s',
246 array('text', 'integer'),
247 array('-course_overall_status-', $a_obj_id)
248 );
249
250 $users = array();
251 while ($row = $ilDB->fetchAssoc($res)) {
252 $users[] = $row["user_id"];
253 }
254 return $users;
255 }

References $DIC, $ilDB, $ilLog, and $res.

Referenced by ilLPStatusSCORM\refreshStatus(), and ilLPStatusSCORMPackage\refreshStatus().

+ Here is the caller graph for this function:

◆ _isCompleted()

static ilSCORM2004Tracking::_isCompleted (   $a_status,
  $a_satisfied 
)
static

Definition at line 446 of file class.ilSCORM2004Tracking.php.

447 {
448 if ($a_status == "completed" || $a_satisfied == "satisfied") {
449 return true;
450 }
451
452 return false;
453 }

◆ _isFailed()

static ilSCORM2004Tracking::_isFailed (   $a_status,
  $a_satisfied 
)
static

Definition at line 470 of file class.ilSCORM2004Tracking.php.

471 {
472 if ($a_status == "completed" && $a_satisfied == "notSatisfied") {
473 return true;
474 }
475
476 return false;
477 }

◆ _isInProgress()

static ilSCORM2004Tracking::_isInProgress (   $a_status,
  $a_satisfied 
)
static

Definition at line 458 of file class.ilSCORM2004Tracking.php.

459 {
460 if ($a_status != "completed") {
461 return true;
462 }
463
464 return false;
465 }

◆ _syncReadEvent()

static ilSCORM2004Tracking::_syncReadEvent (   $a_obj_id,
  $a_user_id,
  $a_type,
  $a_ref_id,
  $time_from_lms = null 
)
static

Synch read event table.

Parameters

return

Definition at line 393 of file class.ilSCORM2004Tracking.php.

394 {
395 global $DIC;
396
397 $ilDB = $DIC->database();
398
399 //get condition to select time
400 $val_set = $ilDB->queryF(
401 'SELECT time_from_lms FROM sahs_lm WHERE id = %s',
402 array('integer'),
403 array($a_obj_id)
404 );
405 $val_rec = $ilDB->fetchAssoc($val_set);
406 $time_from_lms = (ilUtil::yn2tf($val_rec["time_from_lms"]));
407
408 // get attempts and time
409 $val_set = $ilDB->queryF(
410 '
411 SELECT package_attempts, sco_total_time_sec, total_time_sec
412 FROM sahs_user WHERE obj_id = %s AND user_id = %s',
413 array('integer','integer'),
414 array($a_obj_id,$a_user_id)
415 );
416 $val_rec = $ilDB->fetchAssoc($val_set);
417 if ($time_from_lms == false) {
418 $time = $val_rec["sco_total_time_sec"];
419 } else {
420 $time = $val_rec["total_time_sec"];
421 }
422 $attempts = $val_rec["package_attempts"];
423 if ($attempts == null) {
424 $attempts = "";
425 } //??
426
427 if ($attempts != "" && $time == null) { //use old way
428 $time = self::getSumTotalTimeSecondsFromScos($a_obj_id, $a_user_id, true);
429 }
430
431 include_once("./Services/Tracking/classes/class.ilChangeEvent.php");
432 ilChangeEvent::_recordReadEvent(
433 $a_type,
434 $a_ref_id,
435 $a_obj_id,
436 $a_user_id,
437 false,
438 $attempts,
439 $time
440 );
441 }
ilChangeEvent\_recordReadEvent
static _recordReadEvent( $a_type, $a_ref_id, $obj_id, $usr_id, $isCatchupWriteEvents=true, $a_ext_rc=false, $a_ext_time=false)
Records a read event and catches up with write events.
Definition: class.ilChangeEvent.php:113
ilSCORM2004Tracking\getSumTotalTimeSecondsFromScos
static getSumTotalTimeSecondsFromScos($a_obj_id, $a_user_id, $a_write=false)
should be avoided; store value to increase performance for further requests
Definition: class.ilSCORM2004Tracking.php:482
ilUtil\yn2tf
static yn2tf($a_yn)
convert "y"/"n" to true/false
Definition: class.ilUtil.php:2971
$a_type
$a_type
Definition: workflow.php:92

References $a_type, $DIC, $ilDB, ilChangeEvent\_recordReadEvent(), getSumTotalTimeSecondsFromScos(), and ilUtil\yn2tf().

Referenced by ilSCORM2004StoreData\scormPlayerUnload(), and ilSCORM2004StoreData\syncGlobalStatus().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSumTotalTimeSecondsFromScos()

static ilSCORM2004Tracking::getSumTotalTimeSecondsFromScos (   $a_obj_id,
  $a_user_id,
  $a_write = false 
)
static

should be avoided; store value to increase performance for further requests

Definition at line 482 of file class.ilSCORM2004Tracking.php.

483 {
484 global $DIC;
485
486 $ilDB = $DIC->database();
487 $ilLog = $DIC["ilLog"];
488 $scos = array();
489 $val_set = $ilDB->queryF(
490 'SELECT cp_node_id FROM cp_node
491 WHERE nodename = %s
492 AND cp_node.slm_id = %s',
493 array('text', 'integer'),
494 array('item', $a_obj_id)
495 );
496 while ($val_rec = $ilDB->fetchAssoc($val_set)) {
497 array_push($scos, $val_rec['cp_node_id']);
498 }
499 $time = 0;
500 foreach ($scos as $sco) {
501 include_once("./Modules/Scorm2004/classes/class.ilObjSCORM2004LearningModule.php");
502 $data_set = $ilDB->queryF(
503 '
504 SELECT total_time
505 FROM cmi_node
506 WHERE cp_node_id = %s
507 AND user_id = %s',
508 array('integer','integer'),
509 array($sco, $a_user_id)
510 );
511
512 while ($data_rec = $ilDB->fetchAssoc($data_set)) {
513 $sec = ilObjSCORM2004LearningModule::_ISODurationToCentisec($data_rec["total_time"]) / 100;
514 }
515 $time += (int) $sec;
516 $sec = 0;
517 //$ilLog->write("++".$time);
518 }
519 if ($a_write && $time > 0) {
520 $ilDB->queryF(
521 'UPDATE sahs_user SET sco_total_time_sec=%s WHERE obj_id = %s AND user_id = %s',
522 array('integer', 'integer', 'integer'),
523 array($time, $a_obj_id, $a_user_id)
524 );
525 }
526 return $time;
527 }
ilObjSCORM2004LearningModule\_ISODurationToCentisec
static _ISODurationToCentisec($str)
convert ISO 8601 Timeperiods to centiseconds ta
Definition: class.ilObjSCORM2004LearningModule.php:707

References $DIC, $ilDB, $ilLog, and ilObjSCORM2004LearningModule\_ISODurationToCentisec().

Referenced by _syncReadEvent(), and ilObjSCORMInitData\getStatus().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:
The documentation for this class was generated from the following file: