ILIAS  Release_4_1_x_branch Revision 61804
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions
ilObjSCORMTracking Class Reference
Modules/ScormAicc

Class ilObjSCORMTracking. More...

+ Inheritance diagram for ilObjSCORMTracking:
+ Collaboration diagram for ilObjSCORMTracking:

Public Member Functions

 ilObjSCORMTracking ()
 Constructor public.
 extractData ()
 store ($obj_id=0, $sahs_id=0, $extractData=1)
 storeJsApi ($obj_id=0)
 _syncReadEvent ($a_obj_id, $a_user_id, $a_type, $a_ref_id)
 Synch read event table.
 _insertTrackData ($a_sahs_id, $a_lval, $a_rval, $a_obj_id)
 _getTrackedUsers ($a_obj_id)
 Get all tracked users.
 _getFailed ($scorm_item_id, $a_obj_id)
 Redesign required.

Static Public Member Functions

static _getInProgress ($scorm_item_id, $a_obj_id)
 Redesign required.
static _getCompleted ($scorm_item_id, $a_obj_id)
 Redesign required.
static _getCollectionStatus ($a_scos, $a_obj_id, $a_user_id)
static _countCompleted ($a_scos, $a_obj_id, $a_user_id)
static _getCountCompletedPerUser ($a_scorm_item_ids, $a_obj_id)
 Get users who have status completed or passed.
static _getProgressInfo ($sco_item_ids, $a_obj_id)
 Get info about.

Detailed Description

Class ilObjSCORMTracking.

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.ilObjSCORMTracking.php.

Member Function Documentation

static ilObjSCORMTracking::_countCompleted (   $a_scos,
  $a_obj_id,
  $a_user_id 
)
static

Definition at line 463 of file class.ilObjSCORMTracking.php.

References $ilDB, $in, and $res.

Referenced by ilLPStatusSCORM\determinePercentage().

{
global $ilDB;
if (is_array($a_scos))
{
$in = $ilDB->in('sco_id', $a_scos, false, 'integer');
$res = $ilDB->queryF('SELECT sco_id, rvalue FROM scorm_tracking
WHERE '.$in.'
AND obj_id = %s
AND lvalue = %s
AND user_id = %s',
array('integer','text', 'integer'),
array($a_obj_id,'cmi.core.lesson_status', $a_user_id));
$cnt = 0;
while ($rec = $ilDB->fetchAssoc($res))
{
if ($rec["rvalue"] == "completed" || $rec["rvalue"] == "passed")
{
$cnt++;
}
}
}
return $cnt;
}

+ Here is the caller graph for this function:

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

Definition at line 412 of file class.ilObjSCORMTracking.php.

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

Referenced by ilLPStatusSCORM\determineStatus().

{
global $ilDB;
$status = "not_attempted";
if (is_array($a_scos))
{
$in = $ilDB->in('sco_id', $a_scos, false, 'integer');
$res = $ilDB->queryF('SELECT sco_id, rvalue FROM scorm_tracking
WHERE '.$in.'
AND obj_id = %s
AND lvalue = %s
AND user_id = %s',
array('integer','text', 'integer'),
array($a_obj_id,'cmi.core.lesson_status', $a_user_id));
$cnt = 0;
$completed = true;
$failed = false;
while ($rec = $ilDB->fetchAssoc($res))
{
if ($rec["rvalue"] == "failed")
{
$failed = true;
}
if ($rec["rvalue"] != "completed" && $rec["rvalue"] != "passed")
{
$completed = false;
}
$cnt++;
}
if ($cnt > 0)
{
$status = "in_progress";
}
if ($completed && $cnt == count($a_scos))
{
$status = "completed";
}
if ($failed)
{
$status = "failed";
}
}
return $status;
}

+ Here is the caller graph for this function:

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

Redesign required.

Todo:
avoid like search against clob field rvalue
Deprecated:
Parameters
object$scorm_item_id
object$a_obj_id
Returns

Definition at line 378 of file class.ilObjSCORMTracking.php.

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

{
global $ilDB;
if(is_array($scorm_item_id))
{
$in = $ilDB->in('sco_id', $scorm_item_id, false, 'integer');
$res = $ilDB->queryF('SELECT DISTINCT(user_id) FROM scorm_tracking
WHERE '.$in.'
AND obj_id = %s
AND lvalue = %s
AND ('.$ilDB->like('rvalue', 'clob', 'completed').' OR '.$ilDB->like('rvalue', 'clob', 'passed').')',
array('integer','text'),
array($a_obj_id,'cmi.core.lesson_status'));
}
else
{
$res = $ilDB->queryF('SELECT DISTINCT(user_id) FROM scorm_tracking
WHERE sco_id = %s
AND obj_id = %s
AND lvalue = %s
AND ('.$ilDB->like('rvalue', 'clob', 'completed').' OR '.$ilDB->like('rvalue', 'clob', 'passed').')',
array('integer','integer','text'),
array($scorm_item_id,$a_obj_id,'cmi.core.lesson_status'));
}
while($row = $ilDB->fetchObject($res))
{
$user_ids[] = $row->user_id;
}
return $user_ids ? $user_ids : array();
}
static ilObjSCORMTracking::_getCountCompletedPerUser (   $a_scorm_item_ids,
  $a_obj_id 
)
static

Get users who have status completed or passed.

Parameters
object$a_scorm_item_ids
object$a_obj_id
Returns

Definition at line 565 of file class.ilObjSCORMTracking.php.

References $ilDB, $in, $query, $res, and $row.

Referenced by ilLPStatusSCORM\_getStatusInfo().

{
global $ilDB;
$in = $ilDB->in('sco_id', $a_scorm_item_ids, false, 'integer');
// Why does this query use a like search against "passed" and "failed"
/*
$res = $ilDB->queryF('
SELECT user_id, COUNT(user_id) completed FROM scorm_tracking
WHERE '.$in.'
AND obj_id = %s
AND lvalue = %s
AND ('.$ilDB->like('rvalue', 'clob', 'completed').' OR '.$ilDB->like('rvalue', 'clob', 'passed').')
GROUP BY user_id',
array('integer', 'text'),
array($a_obj_id, 'cmi.core.lesson_status')
);
*/
// Avoid searches against field rvalue.
// This gives the possibility to reuse the obj_id,sco_id,lvalue index.
$query = "SELECT user_id,rvalue FROM scorm_tracking ".
"WHERE ".$in." ".
"AND obj_id = ".$ilDB->quote($a_obj_id,'integer')." ".
"AND lvalue = ".$ilDB->quote('cmi.core.lesson_status','text');
$res = $ilDB->query($query);
while($row = $ilDB->fetchObject($res))
{
if($row->rvalue == 'passed' or $row->rvalue == 'completed')
{
++$users[$row->user_id];
}
}
return $users ? $users : array();
}

+ Here is the caller graph for this function:

ilObjSCORMTracking::_getFailed (   $scorm_item_id,
  $a_obj_id 
)

Redesign required.

Todo:
avoid like search against clob field rvalue
Deprecated:
Parameters
object$scorm_item_id
object$a_obj_id
Returns

Definition at line 522 of file class.ilObjSCORMTracking.php.

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

{
global $ilDB;
if(is_array($scorm_item_id))
{
$in = $ilDB->in('sco_id', $scorm_item_id, false, 'integer');
$res = $ilDB->queryF('
SELECT DISTINCT(user_id) FROM scorm_tracking
WHERE '.$in.'
AND obj_id = %s
AND lvalue = %s
AND '.$ilDB->like('rvalue', 'clob', 'failed').' ',
array('integer','text'),
array($a_obj_id,'cmi.core.lesson_status'));
}
else
{
$res = $ilDB->queryF('
SELECT DISTINCT(user_id) FROM scorm_tracking
WHERE sco_id = %s
AND obj_id = %s
AND lvalue = %s
AND '.$ilDB->like('rvalue', 'clob', 'failed').' ',
array('integer','integer','text'),
array($scorm_item_id,$a_obj_id,'cmi.core.lesson_status'));
}
while($row = $ilDB->fetchObject($res))
{
$user_ids[] = $row->user_id;
}
return $user_ids ? $user_ids : array();
}
static ilObjSCORMTracking::_getInProgress (   $scorm_item_id,
  $a_obj_id 
)
static

Redesign required.

Todo:
avoid like search against clob field rvalue
Deprecated:
Parameters
object$scorm_item_id
object$a_obj_id
Returns

Definition at line 339 of file class.ilObjSCORMTracking.php.

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

Referenced by _getProgressInfo().

{
global $ilDB;
if(is_array($scorm_item_id))
{
$in = $ilDB->in('sco_id', $scorm_item_id, false, 'integer');
$res = $ilDB->queryF('SELECT user_id,sco_id FROM scorm_tracking
WHERE '.$in.'
AND obj_id = %s
GROUP BY user_id, sco_id',
array('integer'),array($a_obj_id));
}
else
{
$res = $ilDB->queryF('SELECT user_id,sco_id FROM scorm_tracking
WHERE sco_id = %s
AND obj_id = %s',
array('integer','integer'),array($scorm_item_id,$a_obj_id)
);
}
while($row = $ilDB->fetchObject($res))
{
$in_progress[$row->sco_id][] = $row->user_id;
}
return is_array($in_progress) ? $in_progress : array();
}

+ Here is the caller graph for this function:

static ilObjSCORMTracking::_getProgressInfo (   $sco_item_ids,
  $a_obj_id 
)
static

Get info about.

Parameters
object$sco_item_ids
object$a_obj_id
Returns

Definition at line 609 of file class.ilObjSCORMTracking.php.

References $ilDB, $in, $res, $row, and _getInProgress().

Referenced by ilLPStatusSCORM\_getStatusInfo().

{
global $ilDB;
$in = $ilDB->in('sco_id', $sco_item_ids, false, 'integer');
$res = $ilDB->queryF('
SELECT * FROM scorm_tracking
WHERE '.$in.'
AND obj_id = %s
AND lvalue = %s ',
array('integer','text'),
array($a_obj_id,'cmi.core.lesson_status'));
$info['completed'] = array();
$info['failed'] = array();
while($row = $ilDB->fetchObject($res))
{
switch($row->rvalue)
{
case 'completed':
case 'passed':
$info['completed'][$row->sco_id][] = $row->user_id;
break;
case 'failed':
$info['failed'][$row->sco_id][] = $row->user_id;
break;
}
}
$info['in_progress'] = ilObjSCORMTracking::_getInProgress($sco_item_ids,$a_obj_id);
return $info;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjSCORMTracking::_getTrackedUsers (   $a_obj_id)

Get all tracked users.

Parameters
object$a_obj_id
Returns

Definition at line 496 of file class.ilObjSCORMTracking.php.

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

Referenced by ilTrQuery\getParticipantsForObject().

{
global $ilDB, $ilLog;
$res = $ilDB->queryF('SELECT DISTINCT user_id FROM scorm_tracking
WHERE obj_id = %s
AND lvalue = %s',
array('integer','text'),
array($a_obj_id,'cmi.core.lesson_status'));
$users = array();
while ($row = $ilDB->fetchAssoc($res))
{
$users[] = $row["user_id"];
}
return $users;
}

+ Here is the caller graph for this function:

ilObjSCORMTracking::_insertTrackData (   $a_sahs_id,
  $a_lval,
  $a_rval,
  $a_obj_id 
)

Definition at line 310 of file class.ilObjSCORMTracking.php.

References $ilDB, ilLPStatusWrapper\_updateStatus(), and ilUtil\now().

Referenced by ilSCORMItem\insertTrackData(), ilAICCUnit\insertTrackData(), and ilAICCCourse\insertTrackData().

{
global $ilDB, $ilUser;
$ilDB->insert('scorm_tracking', array(
'obj_id' => array('integer', $a_obj_id),
'user_id' => array('integer', $ilUser->getId()),
'sco_id' => array('integer', $a_sahs_id),
'lvalue' => array('text', $a_lval),
'rvalue' => array('clob', $a_rval),
'c_timestamp' => array('timestamp', ilUtil::now())
));
if ($a_lval == "cmi.core.lesson_status")
{
include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
ilLPStatusWrapper::_updateStatus($a_obj_id, $ilUser->getId());
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjSCORMTracking::_syncReadEvent (   $a_obj_id,
  $a_user_id,
  $a_type,
  $a_ref_id 
)

Synch read event table.

Parameters
@return

Definition at line 265 of file class.ilObjSCORMTracking.php.

References $ilDB, $ilLog, and ilChangeEvent\_recordReadEvent().

Referenced by store(), and storeJsApi().

{
global $ilDB, $ilLog;
// get attempts
$val_set = $ilDB->queryF('
SELECT * FROM scorm_tracking
WHERE user_id = %s
AND sco_id = %s
AND lvalue = %s
AND obj_id = %s',
array('integer','integer','text','integer'),
array($a_user_id,0,'package_attempts',$a_obj_id));
$val_rec = $ilDB->fetchAssoc($val_set);
$val_rec["rvalue"] = str_replace("\r\n", "\n", $val_rec["rvalue"]);
if ($val_rec["rvalue"] == null) {
$val_rec["rvalue"]="";
}
$attempts = $val_rec["rvalue"];
// get learning time
$sco_set = $ilDB->queryF('
SELECT sco_id, rvalue FROM scorm_tracking
WHERE obj_id = %s
AND user_id = %s
AND lvalue = %s
AND sco_id <> %s',
array('integer','integer','text','integer'),
array($a_obj_id,$a_user_id, 'cmi.core.total_time',0));
$time = 0;
while($sco_rec = $ilDB->fetchAssoc($sco_set))
{
$tarr = explode(":", $sco_rec["rvalue"]);
$sec = (int) $tarr[2] + (int) $tarr[1] * 60 +
(int) substr($tarr[0], strlen($tarr[0]) - 3) * 60 * 60;
$time += $sec;
}
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:

ilObjSCORMTracking::extractData ( )

Definition at line 24 of file class.ilObjSCORMTracking.php.

References $_GET, and $_POST.

Referenced by store().

{
$this->insert = array();
if (is_array($_GET["iL"]))
{
foreach($_GET["iL"] as $key => $value)
{
$this->insert[] = array("left" => $value, "right" => $_GET["iR"][$key]);
}
}
if (is_array($_POST["iL"]))
{
foreach($_POST["iL"] as $key => $value)
{
$this->insert[] = array("left" => $value, "right" => $_POST["iR"][$key]);
}
}
$this->update = array();
if (is_array($_GET["uL"]))
{
foreach($_GET["uL"] as $key => $value)
{
$this->update[] = array("left" => $value, "right" => $_GET["uR"][$key]);
}
}
if (is_array($_POST["uL"]))
{
foreach($_POST["uL"] as $key => $value)
{
$this->update[] = array("left" => $value, "right" => $_POST["uR"][$key]);
}
}
}

+ Here is the caller graph for this function:

ilObjSCORMTracking::ilObjSCORMTracking ( )

Constructor public.

Definition at line 18 of file class.ilObjSCORMTracking.php.

{
global $ilias;
}
ilObjSCORMTracking::store (   $obj_id = 0,
  $sahs_id = 0,
  $extractData = 1 
)

Definition at line 59 of file class.ilObjSCORMTracking.php.

References $_GET, $_POST, $ilDB, $ref_id, ilObject\_lookupObjId(), _syncReadEvent(), ilLPStatusWrapper\_updateStatus(), extractData(), and ilUtil\now().

Referenced by ilObjHACPTracking\putparam().

{
global $ilDB, $ilUser;
$ref_id = $_GET["ref_id"];
if (empty($obj_id))
{
$obj_id = ilObject::_lookupObjId($_GET["ref_id"]);
}
// writing to scorm test log
$f = fopen("./Modules/ScormAicc/log/scorm.log", "a");
fwrite($f, "\nCALLING SCORM store()\n");
fwrite($f,'POST: '.print_r($_POST,true));
if (empty($sahs_id))
$sahs_id = ($_GET["sahs_id"] != "") ? $_GET["sahs_id"] : $_POST["sahs_id"];
if ($extractData==1)
$this->extractData();
if (is_object($ilUser))
{
$user_id = $ilUser->getId();
}
if ($obj_id <= 1)
{
fwrite($f, "Error: No obj_id given.\n");
}
else
{
foreach($this->insert as $insert)
{
$set = $ilDB->queryF('
SELECT * FROM scorm_tracking
WHERE user_id = %s
AND sco_id = %s
AND lvalue = %s
AND obj_id = %s',
array('integer','integer','text','integer'),
array($user_id,$sahs_id,$insert["left"],$obj_id));
if ($rec = $ilDB->fetchAssoc($set))
{
fwrite($f, "Error Insert, left value already exists. L:".$insert["left"].",R:".
$insert["right"].",sahs_id:".$sahs_id.",user_id:".$user_id."\n");
}
else
{
$ilDB->insert('scorm_tracking', array(
'obj_id' => array('integer', $obj_id),
'user_id' => array('integer', $user_id),
'sco_id' => array('integer', $sahs_id),
'lvalue' => array('text', $insert["left"]),
'rvalue' => array('clob', $insert["right"]),
'c_timestamp' => array('timestamp', ilUtil::now())
));
fwrite($f, "Insert - L:".$insert["left"].",R:".
$insert["right"].",sahs_id:".$sahs_id.",user_id:".$user_id."\n");
}
}
foreach($this->update as $update)
{
$set = $ilDB->queryF('
SELECT * FROM scorm_tracking
WHERE user_id = %s
AND sco_id = %s
AND lvalue = %s
AND obj_id = %s',
array('integer','integer','text','integer'),
array($user_id,$sahs_id,$update["left"],$obj_id));
if ($rec = $ilDB->fetchAssoc($set))
{
$ilDB->update('scorm_tracking',
array(
'rvalue' => array('clob', $update["right"]),
'c_timestamp' => array('timestamp', ilUtil::now())
),
array(
'user_id' => array('integer', $user_id),
'sco_id' => array('integer', $sahs_id),
'lvalue' => array('text', $update["left"]),
'obj_id' => array('integer', $obj_id)
)
);
}
else
{
fwrite($f, "ERROR Update, left value does not exist. L:".$update["left"].",R:".
$update["right"].",sahs_id:".$sahs_id.",user_id:".$user_id."\n");
}
}
}
fclose($f);
// update status
include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
ilLPStatusWrapper::_updateStatus($obj_id, $user_id);
// update time and numbers of attempts in change event
ilObjSCORMTracking::_syncReadEvent($obj_id, $user_id, "sahs", $ref_id);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjSCORMTracking::storeJsApi (   $obj_id = 0)

Definition at line 168 of file class.ilObjSCORMTracking.php.

References $_GET, $_POST, $ilDB, $ilLog, $ref_id, ilObject\_lookupObjId(), _syncReadEvent(), ilLPStatusWrapper\_updateStatus(), and ilUtil\now().

{
global $ilLog, $ilDB, $ilUser;
$b_updateStatus=false;
$b_messageLog=false;
if ($ilLog->current_log_level == 30)
$b_messageLog=true;
$ref_id = $_GET["ref_id"];
if (empty($obj_id))
$obj_id = ilObject::_lookupObjId($_GET["ref_id"]);
if ($b_messageLog)
$ilLog->write("ScormAicc: CALLING SCORM storeJsApi() ".$_POST);
if (is_object($ilUser))
$user_id = $ilUser->getId();
$aa_data = array();
if (is_array($_POST["S"])) {
foreach($_POST["S"] as $key => $value) {
$aa_data[] = array("sco_id" => $value, "left" => $_POST["L"][$key], "right" => $_POST["R"][$key]);
}
}
if ($obj_id <= 1) {
$ilLog->write("ScormAicc: storeJsApi: Error: No valid obj_id given.");
}
else {
foreach($aa_data as $a_data) {
$set = $ilDB->queryF('
SELECT rvalue FROM scorm_tracking
WHERE user_id = %s
AND sco_id = %s
AND lvalue = %s
AND obj_id = %s',
array('integer','integer','text','integer'),
array($user_id,$a_data["sco_id"],$a_data["left"],$obj_id));
if ($rec = $ilDB->fetchAssoc($set)) {
if ($a_data["left"] == 'cmi.core.lesson_status' && $a_data["right"] != $rec["rvalue"]) {
$b_updateStatus = true;
}
$ilDB->update('scorm_tracking',
array(
'rvalue' => array('clob', $a_data["right"]),
'c_timestamp' => array('timestamp', ilUtil::now())
),
array(
'user_id' => array('integer', $user_id),
'sco_id' => array('integer', $a_data["sco_id"]),
'lvalue' => array('text', $a_data["left"]),
'obj_id' => array('integer', $obj_id)
)
);
if ($b_messageLog) {
$ilLog->write("ScormAicc: storeJsApi Updated - L:".$a_data["left"].",R:".
$a_data["right"]." for obj_id:".$obj_id.",sco_id:".$a_data["sco_id"].",user_id:".$user_id);
}
}
else {
if ($a_data["left"] == 'cmi.core.lesson_status') {
$b_updateStatus = true;
}
$ilDB->insert('scorm_tracking', array(
'obj_id' => array('integer', $obj_id),
'user_id' => array('integer', $user_id),
'sco_id' => array('integer', $a_data["sco_id"]),
'lvalue' => array('text', $a_data["left"]),
'rvalue' => array('clob', $a_data["right"]),
'c_timestamp' => array('timestamp', ilUtil::now())
));
if ($b_messageLog) {
$ilLog->write("ScormAicc: storeJsApi Inserted - L:".$a_data["left"].",R:".
$a_data["right"]." for obj_id:".$obj_id.",sco_id:".$$a_data["sco_id"].",user_id:".$user_id);
}
}
}
}
// update status
if ($b_updateStatus == true) {
include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
ilLPStatusWrapper::_updateStatus($obj_id, $user_id);
}
// update time and numbers of attempts in change event
ilObjSCORMTracking::_syncReadEvent($obj_id, $user_id, "sahs", $ref_id);
}

+ Here is the call graph for this function:

The documentation for this class was generated from the following file: