ilSCORM2004Tracking Class Reference

Class ilSCORM2004Tracking. More...

Collaboration diagram for ilSCORM2004Tracking:

Static Public Member Functions
static	_getInProgress (int $scorm_item_id, int $a_obj_id)
static	_getCompleted (int $scorm_item_id, int $a_obj_id)
static	_getFailed (int $scorm_item_id, int $a_obj_id)
static	_getCountCompletedPerUser (array $a_scorm_item_ids, int $a_obj_id, bool $a_omit_failed=false)
	Get progress of selected scos. More...
static	_getProgressInfo (int $a_obj_id)
	Get overall scorm status. More...
static	_getProgressInfoOfUser (int $a_obj_id, int $a_user_id)
	Get overall scorm status. More...
static	_getTrackedUsers (int $a_obj_id)
	Get all tracked users. More...
static	_getItemProgressInfo (array $a_scorm_item_ids, int $a_obj_id, bool $a_omit_failed)
static	_getCollectionStatus (array $a_scos, int $a_obj_id, int $a_user_id)
static	_countCompleted (array $a_scos, int $a_obj_id, int $a_user_id, bool $a_omit_failed)
static	_syncReadEvent (int $a_obj_id, int $a_user_id, string $a_type, int $a_ref_id, ?bool $time_from_lms=null)
	Synch read event table. More...
static	_isCompleted (string $a_status, string $a_satisfied)
static	_isInProgress (string $a_status, string $a_satisfied)
static	_isFailed (string $a_status, string $a_satisfied)
static	getSumTotalTimeSecondsFromScos (int $a_obj_id, int $a_user_id, bool $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 26 of file class.ilSCORM2004Tracking.php.

Member Function Documentation

_countCompleted()

static ilSCORM2004Tracking::_countCompleted ( array  $a_scos, int  $a_obj_id, int  $a_user_id, bool  $a_omit_failed  )

static

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

     : int {
        global $DIC;
 
        $ilDB = $DIC->database();
        $cnt = 0;
 
        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)
            );
 
 
            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;
    }

References $ilDB, and $res.

Referenced by ilLPStatusSCORM\determinePercentage().

Here is the caller graph for this function:

_getCollectionStatus()

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

static

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

                                                                                             : string
    {
        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;
    }

References $DIC, $ilDB, and $res.

_getCompleted()

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

static

Exceptions

Exception

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

                                                                           : void
    {
        throw new Exception("Not Implemented: ilSCORM2004Tracking_getCompleted");
    }

_getCountCompletedPerUser()

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

static

Get progress of selected scos.

Parameters

bool

$a_omit_failed

do not include success==failed

Returns

array<int|string, mixed>

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

                                                                                                                         : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $users = [];
 
        $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;
    }

References $DIC, $ilDB, and $res.

Referenced by ilLPStatusSCORM\_getStatusInfo().

Here is the caller graph for this function:

_getFailed()

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

static

Exceptions

Exception

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

                                                                        : void
    {
        throw new Exception("Not Implemented: ilSCORM2004Tracking_getFailed");
    }

_getInProgress()

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

static

Exceptions

Exception

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

                                                                            : void
    {
        throw new Exception("Not Implemented: ilSCORM2004Tracking_getInProgress");
    }

_getItemProgressInfo()

static ilSCORM2004Tracking::_getItemProgressInfo ( array  $a_scorm_item_ids, int  $a_obj_id, bool  $a_omit_failed  )

static

Returns

array<string, array<int|string, mixed[]>>

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

                                                                                                            : array
    {
        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;
    }

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

Referenced by ilLPStatusSCORM\_getStatusInfo().

Here is the caller graph for this function:

_getProgressInfo()

static ilSCORM2004Tracking::_getProgressInfo ( int  $a_obj_id )

static

Get overall scorm status.

Returns

array<string, int[]>

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

                                                          : array
    {
        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'][] = (int) $row["user_id"];
            }
            if (self::_isInProgress($row["status"], $row["satisfied"])) {
                $info['in_progress'][] = (int) $row["user_id"];
            }
            if (self::_isFailed($row["status"], $row["satisfied"])) {
                $info['failed'][] = (int) $row["user_id"];
            }
        }
 
        return $info;
    }

References $DIC, $ilDB, $info, $res, and ILIAS\Repository\int().

Referenced by ilLPStatusSCORMPackage\_getStatusInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

_getProgressInfoOfUser()

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

static

Get overall scorm status.

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

                                                                                : string
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $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;
    }

References $DIC, $ilDB, and $res.

_getTrackedUsers()

static ilSCORM2004Tracking::_getTrackedUsers ( int  $a_obj_id )

static

Get all tracked users.

Returns

int[]

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

                                                          : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $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[] = (int) $row["user_id"];
        }
        return $users;
    }

References $DIC, $ilDB, $res, and ILIAS\Repository\int().

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

Here is the call graph for this function:

Here is the caller graph for this function:

_isCompleted()

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

static

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

                                                                              : bool
    {
        return $a_status === "completed" || $a_satisfied === "satisfied";
    }

_isFailed()

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

static

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

                                                                           : bool
    {
        return $a_status === "completed" && $a_satisfied === "notSatisfied";
    }

_isInProgress()

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

static

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

                                                                               : bool
    {
        return $a_status !== "completed";
    }

_syncReadEvent()

static ilSCORM2004Tracking::_syncReadEvent ( int  $a_obj_id, int  $a_user_id, string  $a_type, int  $a_ref_id, ?bool  $time_from_lms = null  )

static

Synch read event table.

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

                                                                                                                                    : void
    {
        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);
        }
 
        //workaround if $row->read_count == null TODO ERASE
        try {
            ilChangeEvent::_recordReadEvent(
                $a_type,
                $a_ref_id,
                $a_obj_id,
                $a_user_id,
                false,
                $attempts,
                $time
            );
        } catch (\Exception $exception) {
            ilChangeEvent::_recordReadEvent(
                $a_type,
                $a_ref_id,
                $a_obj_id,
                $a_user_id,
                false,
                null,
                $time
            );
        }
    }

References $DIC, $ilDB, $time_from_lms, ilChangeEvent\_recordReadEvent(), 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 ( int  $a_obj_id, int  $a_user_id, bool  $a_write = false  )

static

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

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

                                                                                                               : int
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $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)) {
            $scos[] = $val_rec['cp_node_id'];
        }
        $time = 0;
        foreach ($scos as $sco) {
            $sec = 0;
            $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;
        }
        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;
    }

References $DIC, $ilDB, ilObjSCORM2004LearningModule\_ISODurationToCentisec(), and ILIAS\Repository\int().

Referenced by 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:

• components/ILIAS/Scorm2004/classes/class.ilSCORM2004Tracking.php