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.

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

Referenced by ilLPStatusSCORM\determinePercentage().

       {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         if (is_array($a_scos)) {
             $in = $ilDB->in('cp_node.cp_node_id', $a_scos, false, 'integer');
 
             $res = $ilDB->queryF(
                 'SELECT cp_node.cp_node_id id,
                                                 cmi_node.completion_status completion, 
                                                 cmi_node.success_status success
                                  FROM cp_node, cmi_node 
                                  WHERE ' . $in . '
                                  AND cp_node.cp_node_id = cmi_node.cp_node_id
                                  AND cp_node.slm_id = %s
                                 AND cmi_node.user_id = %s',
                 array('integer', 'integer'),
                 array($a_obj_id, $a_user_id)
             );
     
             
             $cnt = 0;
             while ($rec = $ilDB->fetchAssoc($res)) {
                 // #8171: alex, added (!$a_omit_failed || $rec["success"] != "failed")
                 // since completed/failed combination should not be included in
                 // percentage calculation at ilLPStatusSCOM::determinePercentage
                 if (($rec["completion"] == "completed" || $rec["success"] == "passed")
                     && (!$a_omit_failed || $rec["success"] != "failed")) {
                     $cnt++;
                 }
             }
         }
         return $cnt;
     }

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.

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

Referenced by ilLPStatusSCORM\determineStatus().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $status = "not_attempted";
 
         if (is_array($a_scos)) {
             $in = $ilDB->in('cp_node.cp_node_id', $a_scos, false, 'integer');
 
             $res = $ilDB->queryF(
                 'SELECT cp_node.cp_node_id id,
                                                 cmi_node.completion_status completion, 
                                                 cmi_node.success_status success
                                  FROM cp_node, cmi_node 
                                  WHERE ' . $in . '
                                  AND cp_node.cp_node_id = cmi_node.cp_node_id
                                  AND cp_node.slm_id = %s
                                 AND cmi_node.user_id = %s',
                 array('integer', 'integer'),
                 array($a_obj_id, $a_user_id)
             );
 
             $started = false;
             $cntcompleted = 0;
             $failed = false;
             while ($rec = $ilDB->fetchAssoc($res)) {
                 if ($rec["completion"] == "completed" || $rec["success"] == "passed") {
                     $cntcompleted++;
                 }
                 if ($rec["success"] == "failed") {
                     $failed = true;
                 }
                 $started = true;
             }
             if ($started == true) {
                 $status = "in_progress";
             }
             if ($failed == true) {
                 $status = "failed";
             } elseif ($cntcompleted == count($a_scos)) {
                 $status = "completed";
             }
         }
         return $status;
     }

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.

References $DIC, and $ilDB.

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         die("Not Implemented: ilSCORM2004Tracking_getCompleted");
         /*
                 if(is_array($scorm_item_id))
                 {
                     $where = "WHERE sco_id IN(".implode(",",ilUtil::quoteArray($scorm_item_id)).") ";
                 }
                 else
                 {
                     $where = "sco_id = ".$ilDB->quote($scorm_item_id)." ";
                 }
 
                 $query = "SELECT DISTINCT(user_id) FROM scorm_tracking ".
                     $where.
                     "AND obj_id = ".$ilDB->quote($a_obj_id)." ".
                     "AND lvalue = 'cmi.core.lesson_status' ".
                     "AND ( rvalue = 'completed' ".
                     "OR rvalue = 'passed')";
                 $res = $ilDB->query($query);
                 while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                 {
                     $user_ids[] = $row->user_id;
                 }
                 return $user_ids ? $user_ids : array();
         */
     }

◆ _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_failed	do not include success==failed

Returns

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

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

Referenced by ilLPStatusSCORM\_getStatusInfo().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $in = $ilDB->in('cp_node.cp_node_id', $a_scorm_item_ids, false, 'integer');
         
         // #8171: success_status vs. completion status
         $omit_failed = '';
         if ($a_omit_failed) {
             $omit_failed = ' AND success_status <> ' . $ilDB->quote('failed', 'text');
         }
         
         $res = $ilDB->queryF(
             '
                         SELECT cmi_node.user_id user_id, COUNT(user_id) completed FROM cp_node, cmi_node 
                         WHERE ' . $in . $omit_failed . '
                         AND cp_node.cp_node_id = cmi_node.cp_node_id
                         AND cp_node.slm_id = %s
                         AND completion_status = %s 
                         GROUP BY cmi_node.user_id',
             array('integer', 'text'),
             array($a_obj_id, 'completed')
         );
         while ($row = $ilDB->fetchObject($res)) {
             $users[$row->user_id] = $row->completed;
         }
 
         return $users ? $users : array();
     }

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.

References $DIC, and $ilDB.

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         die("Not Implemented: ilSCORM2004Tracking_getFailed");
         /*
                 if(is_array($scorm_item_id))
                 {
                     $where = "WHERE sco_id IN('".implode("','",$scorm_item_id)."') ";
                 }
                 else
                 {
                     $where = "sco_id = '".$scorm_item_id."' ";
                 }
 
                 $query = "SELECT DISTINCT(user_id) FROM scorm_tracking ".
                     $where.
                     "AND obj_id = '".$a_obj_id."' ".
                     "AND lvalue = 'cmi.core.lesson_status' ".
                     "AND rvalue = 'failed'";
                 $res = $ilDB->query($query);
                 while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                 {
                     $user_ids[] = $row->user_id;
                 }
                 return $user_ids ? $user_ids : array();
         */
     }

◆ _getInProgress()

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

static

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

     {
         die("Not Implemented: ilSCORM2004Tracking_getInProgress");
         /*
                 global $DIC;
 
                 $ilDB = $DIC->database();
 
                 if(is_array($scorm_item_id))
                 {
                     $where = "WHERE sco_id IN(";
                     $where .= implode(",",ilUtil::quoteArray($scorm_item_id));
                     $where .= ") ";
                     $where .= ("AND obj_id = ".$ilDB->quote($a_obj_id)." ");
 
                 }
                 else
                 {
                     $where = "WHERE sco_id = ".$ilDB->quote($scorm_item_id)." ";
                     $where .= ("AND obj_id = ".$ilDB->quote($a_obj_id)." ");
                 }
 
 
                 $query = "SELECT user_id,sco_id FROM scorm_tracking ".
                     $where.
                     "GROUP BY user_id, sco_id";
 
 
                 $res = $ilDB->query($query);
                 while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                 {
                     $in_progress[$row->sco_id][] = $row->user_id;
                 }
                 return is_array($in_progress) ? $in_progress : array();
         */
     }

◆ _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.

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

Referenced by ilLPStatusSCORM\_getStatusInfo().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $in = $ilDB->in('cp_node.cp_node_id', $a_scorm_item_ids, false, 'integer');
 
         $res = $ilDB->queryF(
             'SELECT cp_node.cp_node_id id, 
                                         cmi_node.user_id user_id,
                                         cmi_node.completion_status completion, 
                                         cmi_node.success_status success
                          FROM cp_node, cmi_node 
                          WHERE ' . $in . '
                          AND cp_node.cp_node_id = cmi_node.cp_node_id
                          AND cp_node.slm_id = %s',
             array('integer'),
             array($a_obj_id)
         );
         
         $info['completed'] = array();
         $info['failed'] = array();
         $info['in_progress'] = array();
 
         while ($row = $ilDB->fetchAssoc($res)) {
             // if any data available, set in progress.
             $info['in_progress'][$row["id"]][] = $row["user_id"];
             if ($row["completion"] == "completed" || $row["success"] == "passed") {
                 // #8171: success_status vs. completion status
                 if (!$a_omit_failed || $row["success"] != "failed") {
                     $info['completed'][$row["id"]][] = $row["user_id"];
                 }
             }
             if ($row["success"] == "failed") {
                 $info['failed'][$row["id"]][] = $row["user_id"];
             }
         }
         return $info;
     }

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.

References $DIC, $ilDB, $info, $res, and $row.

Referenced by ilLPStatusSCORMPackage\_getStatusInfo().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $res = $ilDB->queryF(
             '
                         SELECT user_id, status, satisfied FROM cmi_gobjective
                         WHERE objective_id = %s
                         AND scope_id = %s',
             array('text', 'integer'),
             array('-course_overall_status-', $a_obj_id)
         );
         
         $info['completed'] = array();
         $info['failed'] = array();
         $info['in_progress'] = array();
 
         while ($row = $ilDB->fetchAssoc($res)) {
             if (self::_isCompleted($row["status"], $row["satisfied"])) {
                 $info['completed'][] = $row["user_id"];
             }
             if (self::_isInProgress($row["status"], $row["satisfied"])) {
                 $info['in_progress'][] = $row["user_id"];
             }
             if (self::_isFailed($row["status"], $row["satisfied"])) {
                 $info['failed'][] = $row["user_id"];
             }
         }
 
         return $info;
     }

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.

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

Referenced by ilLPStatusSCORMPackage\determineStatus().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilLog = $DIC["ilLog"];
 
         $res = $ilDB->queryF(
             '
                         SELECT status, satisfied FROM cmi_gobjective
                         WHERE objective_id = %s
                         AND scope_id = %s AND user_id = %s',
             array('text', 'integer', 'integer'),
             array('-course_overall_status-', $a_obj_id, $a_user_id)
         );
         
         $status = "not_attempted";
         if ($row = $ilDB->fetchAssoc($res)) {
             if (self::_isInProgress($row["status"], $row["satisfied"])) {
                 $status = "in_progress";
             }
             if (self::_isCompleted($row["status"], $row["satisfied"])) {
                 $status = "completed";
             }
             if (self::_isFailed($row["status"], $row["satisfied"])) {
                 $status = "failed";
             }
         }
         return $status;
     }

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.

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

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

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilLog = $DIC["ilLog"];
 
         $res = $ilDB->queryF(
             '
                         SELECT DISTINCT user_id FROM cmi_gobjective
                         WHERE objective_id = %s
                         AND scope_id = %s',
             array('text', 'integer'),
             array('-course_overall_status-', $a_obj_id)
         );
         
         $users = array();
         while ($row = $ilDB->fetchAssoc($res)) {
             $users[] = $row["user_id"];
         }
         return $users;
     }

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.

     {
         if ($a_status == "completed" || $a_satisfied == "satisfied") {
             return true;
         }
         
         return false;
     }

◆ _isFailed()

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

static

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

     {
         if ($a_status == "completed" && $a_satisfied == "notSatisfied") {
             return true;
         }
         
         return false;
     }

◆ _isInProgress()

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

static

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

     {
         if ($a_status != "completed") {
             return true;
         }
         
         return false;
     }

◆ _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

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

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

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

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         //get condition to select time
         $val_set = $ilDB->queryF(
             'SELECT time_from_lms FROM sahs_lm WHERE id = %s',
             array('integer'),
             array($a_obj_id)
         );
         $val_rec = $ilDB->fetchAssoc($val_set);
         $time_from_lms = (ilUtil::yn2tf($val_rec["time_from_lms"]));
         
         // get attempts and time
         $val_set = $ilDB->queryF(
             '
                         SELECT package_attempts, sco_total_time_sec, total_time_sec 
                         FROM sahs_user WHERE obj_id = %s AND user_id = %s',
             array('integer','integer'),
             array($a_obj_id,$a_user_id)
         );
         $val_rec = $ilDB->fetchAssoc($val_set);
         if ($time_from_lms == false) {
             $time = $val_rec["sco_total_time_sec"];
         } else {
             $time = $val_rec["total_time_sec"];
         }
         $attempts = $val_rec["package_attempts"];
         if ($attempts == null) {
             $attempts = "";
         } //??
 
         if ($attempts != "" && $time == null) { //use old way
             $time = self::getSumTotalTimeSecondsFromScos($a_obj_id, $a_user_id, true);
         }
 
         include_once("./Services/Tracking/classes/class.ilChangeEvent.php");
         ilChangeEvent::_recordReadEvent(
             $a_type,
             $a_ref_id,
             $a_obj_id,
             $a_user_id,
             false,
             $attempts,
             $time
         );
     }

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.

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

Referenced by ilObjSCORMInitData\getStatus().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilLog = $DIC["ilLog"];
         $scos = array();
         $val_set = $ilDB->queryF(
             'SELECT cp_node_id FROM cp_node 
                         WHERE nodename = %s
                         AND cp_node.slm_id = %s',
             array('text', 'integer'),
             array('item', $a_obj_id)
         );
         while ($val_rec = $ilDB->fetchAssoc($val_set)) {
             array_push($scos, $val_rec['cp_node_id']);
         }
         $time = 0;
         foreach ($scos as $sco) {
             include_once("./Modules/Scorm2004/classes/class.ilObjSCORM2004LearningModule.php");
             $data_set = $ilDB->queryF(
                 '
                                 SELECT total_time
                                 FROM cmi_node 
                                 WHERE cp_node_id = %s
                                 AND user_id = %s',
                 array('integer','integer'),
                 array($sco, $a_user_id)
             );
             
             while ($data_rec = $ilDB->fetchAssoc($data_set)) {
                 $sec = ilObjSCORM2004LearningModule::_ISODurationToCentisec($data_rec["total_time"]) / 100;
             }
             $time += (int) $sec;
             $sec = 0;
             //$ilLog->write("++".$time);
         }
         if ($a_write && $time > 0) {
             $ilDB->queryF(
                 'UPDATE sahs_user SET sco_total_time_sec=%s WHERE obj_id = %s AND user_id = %s',
                 array('integer', 'integer', 'integer'),
                 array($time, $a_obj_id, $a_user_id)
             );
         }
         return $time;
     }

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:

Modules/Scorm2004/classes/class.ilSCORM2004Tracking.php

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ _countCompleted()

◆ _getCollectionStatus()

◆ _getCompleted()

◆ _getCountCompletedPerUser()

◆ _getFailed()

◆ _getInProgress()

◆ _getItemProgressInfo()

◆ _getProgressInfo()

◆ _getProgressInfoOfUser()

◆ _getTrackedUsers()

◆ _isCompleted()

◆ _isFailed()

◆ _isInProgress()

◆ _syncReadEvent()

◆ getSumTotalTimeSecondsFromScos()