ilLPStatusSCORMPackage Class Reference

Inheritance diagram for ilLPStatusSCORMPackage:

Collaboration diagram for ilLPStatusSCORMPackage:

Public Member Functions
	__construct ($a_obj_id)
	determineStatus ($a_obj_id, $a_user_id, $a_obj=null)
	Determine status. More...
	refreshStatus ($a_obj_id, $a_users=null)
	determinePercentage ($a_obj_id, $a_user_id, $a_obj=null)
	Determine percentage. More...
Public Member Functions inherited from ilLPStatus
	__construct ($a_obj_id)
	_updateStatus ($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_force_raise=false)
	New status handling (st: status, nr: accesses, p: percentage, t: time spent, m: mark) More...
	determinePercentage ($a_obj_id, $a_usr_id, $a_obj=null)
	Determine percentage. More...
	determineStatus ($a_obj_id, $a_usr_id, $a_obj=null)
	Determine status. More...
	refreshStatus ($a_obj_id, $a_users=null)
	Refresh status. More...

Static Public Member Functions
static	_getInProgress ($a_obj_id)
static	_getCompleted ($a_obj_id)
static	_getFailed ($a_obj_id)
static	_getStatusInfo ($a_obj_id)
Static Public Member Functions inherited from ilLPStatus
static	_getCountNotAttempted ($a_obj_id)
static	_getNotAttempted ($a_obj_id)
static	_getCountInProgress ($a_obj_id)
static	_getInProgress ($a_obj_id)
static	_getCountCompleted ($a_obj_id)
static	_getCompleted ($a_obj_id)
static	_getFailed ($a_obj_id)
static	_getCountFailed ()
static	_getStatusInfo ($a_obj_id)
static	_getTypicalLearningTime ($a_obj_id)
static	checkStatusForObject ($a_obj_id, $a_users=false)
	This function checks whether the status for a given number of users is dirty and must be recalculated. More...
static	writeStatus ($a_obj_id, $a_user_id, $a_status, $a_percentage=false, $a_force_per=false)
	Write status for user and object. More...
static	setInProgressIfNotAttempted ($a_obj_id, $a_user_id)
	This function shoudl be clalled for normal "read events". More...
static	setAllDirty ()
	Sets all status to dirty. More...
static	setDirty ($a_obj_id)
	Sets status of an object to dirty. More...
static	_lookupStatus ($a_obj_id, $a_user_id, $a_create=true)
	Lookup status. More...
static	_lookupPercentage ($a_obj_id, $a_user_id)
	Lookup percentage. More...
static	_hasUserCompleted ($a_obj_id, $a_user_id)
	Lookup user object completion. More...
static	_lookupStatusChanged ($a_obj_id, $a_user_id)
	Lookup status changed. More...
static	_lookupCompletedForObject ($a_obj_id, $a_user_ids=null)
	Get completed users for object. More...
static	_lookupFailedForObject ($a_obj_id, $a_user_ids=null)
	Get failed users for object. More...
static	_lookupInProgressForObject ($a_obj_id, $a_user_ids=null)
	Get in progress users for object. More...
static	preloadListGUIData ($a_obj_ids)
static	getListGUIStatus ($a_obj_id, $a_image_only=false)

Additional Inherited Members
Data Fields inherited from ilLPStatus
	$obj_id = null
	$db = null
const	LP_STATUS_NOT_ATTEMPTED = 'trac_no_attempted'
const	LP_STATUS_IN_PROGRESS = 'trac_in_progress'
const	LP_STATUS_COMPLETED = 'trac_completed'
const	LP_STATUS_FAILED = 'trac_failed'
const	LP_STATUS_NOT_ATTEMPTED_NUM = 0
const	LP_STATUS_IN_PROGRESS_NUM = 1
const	LP_STATUS_COMPLETED_NUM = 2
const	LP_STATUS_FAILED_NUM = 3
const	LP_STATUS_REGISTERED = 'trac_registered'
const	LP_STATUS_NOT_REGISTERED = 'trac_not_registered'
const	LP_STATUS_PARTICIPATED = 'trac_participated'
const	LP_STATUS_NOT_PARTICIPATED = 'trac_not_participated'
Static Public Attributes inherited from ilLPStatus
static	$list_gui_cache
Static Protected Member Functions inherited from ilLPStatus
static	raiseEvent ($a_obj_id, $a_usr_id, $a_status, $a_percentage)
static	_lookupStatusForObject ($a_obj_id, $a_status, $a_user_ids=null)
	Get users with given status for object. More...
static	validateLPForObjects ($a_user_id, $a_obj_ids, $a_parent_ref_id)
	Process given objects for lp-relevance. More...
static	checkLPModesForObjects ($a_obj_ids, array &$a_coll_obj_ids)
	Process lp modes for given objects. More...
static	getLPStatusForObjects ($a_user_id, $a_obj_ids)
	Get LP status for given objects (and user) More...

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Stefan Meyer alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 34 of file class.ilLPStatusSCORMPackage.php.

Constructor & Destructor Documentation

__construct()

ilLPStatusSCORMPackage::__construct

(

$a_obj_id

)

Definition at line 36 of file class.ilLPStatusSCORMPackage.php.

References $ilDB.

    {
        global $ilDB;

        parent::__construct($a_obj_id);
        $this->db = $ilDB;
    }

Member Function Documentation

_getCompleted()

static ilLPStatusSCORMPackage::_getCompleted (   $a_obj_id )

static

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

References $users, and ilLPStatusWrapper\_getStatusInfo().

    {
        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
        $users = $status_info['completed'];
        return array_unique($users);
    }

Here is the call graph for this function:

_getFailed()

static ilLPStatusSCORMPackage::_getFailed (   $a_obj_id )

static

Definition at line 58 of file class.ilLPStatusSCORMPackage.php.

References $users, and ilLPStatusWrapper\_getStatusInfo().

    {
        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
        $users = $status_info['failed'];
        return array_unique($users);
    }

Here is the call graph for this function:

_getInProgress()

static ilLPStatusSCORMPackage::_getInProgress (   $a_obj_id )

static

Definition at line 44 of file class.ilLPStatusSCORMPackage.php.

References $users, and ilLPStatusWrapper\_getStatusInfo().

    {
        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
        $users = $status_info['in_progress'];
        return array_unique($users);
    }

Here is the call graph for this function:

_getStatusInfo()

static ilLPStatusSCORMPackage::_getStatusInfo (   $a_obj_id )

static

Definition at line 66 of file class.ilLPStatusSCORMPackage.php.

References $info, and ilSCORM2004Tracking\_getProgressInfo().

    {
        include_once './Modules/Scorm2004/classes/class.ilSCORM2004Tracking.php';
        $status_info['subtype'] = "scorm2004";
        $info = ilSCORM2004Tracking::_getProgressInfo($a_obj_id);

        $status_info['completed'] = $info['completed'];
        $status_info['failed'] = $info['failed'];
        $status_info['in_progress'] = $info['in_progress'];

        return $status_info;
    }

Here is the call graph for this function:

determinePercentage()

ilLPStatusSCORMPackage::determinePercentage	(		$a_obj_id,
			$a_user_id,
			$a_obj = null
	)

Determine percentage.

Parameters

integer	object id
integer	user id
object	object (optional depends on object type)

Returns

integer percentage

Definition at line 143 of file class.ilLPStatusSCORMPackage.php.

    {
        return null;//todo!
    }

determineStatus()

ilLPStatusSCORMPackage::determineStatus	(		$a_obj_id,
			$a_user_id,
			$a_obj = null
	)

Determine status.

Parameters

integer	object id
integer	user id
object	object (optional depends on object type)

Returns

integer status

Definition at line 87 of file class.ilLPStatusSCORMPackage.php.

References $ilDB, $ilLog, and ilSCORM2004Tracking\_getProgressInfoOfUser().

    {
        global $ilObjDataCache, $ilDB, $ilLog;
        
        include_once("./Modules/Scorm2004/classes/class.ilSCORM2004Tracking.php");
        $scorm_status = ilSCORM2004Tracking::_getProgressInfoOfUser($a_obj_id, $a_user_id);
        $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
        switch ($scorm_status) {
            case "in_progress":
                $status = self::LP_STATUS_IN_PROGRESS_NUM;
                break;
            case "completed":
                $status = self::LP_STATUS_COMPLETED_NUM;
                break;
            case "failed":
                $status = self::LP_STATUS_FAILED_NUM;
                break;
        }

        return $status;
    }

Here is the call graph for this function:

refreshStatus()

ilLPStatusSCORMPackage::refreshStatus	(		$a_obj_id,
			$a_users = null
	)

Definition at line 109 of file class.ilLPStatusSCORMPackage.php.

References $failed, ilLPStatusWrapper\_getCompleted(), ilLPStatusWrapper\_getFailed(), ilLPStatusWrapper\_getInProgress(), ilSCORM2004Tracking\_getTrackedUsers(), and ilLPStatus\writeStatus().

    {
        parent::refreshStatus($a_obj_id, $a_users);
        
        include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
        $in_progress = ilLPStatusWrapper::_getInProgress($a_obj_id);
        $completed = ilLPStatusWrapper::_getCompleted($a_obj_id);
        $failed = ilLPStatusWrapper::_getFailed($a_obj_id);
        $all_active_users = array_unique(array_merge($in_progress, $completed, $failed));
        
        // get all tracked users regardless of SCOs
        include_once("./Modules/Scorm2004/classes/class.ilSCORM2004Tracking.php");
        $all_tracked_users = ilSCORM2004Tracking::_getTrackedUsers($a_obj_id);
        
        $not_attempted_users = array_diff($all_tracked_users, $all_active_users);
        unset($all_tracked_users);
        unset($all_active_users);
        
        // reset all users which have no data for the current SCOs
        if ($not_attempted_users) {
            foreach ($not_attempted_users as $usr_id) {
                // this will update any (parent) collections if necessary
                ilLPStatus::writeStatus($a_obj_id, $usr_id, self::LP_STATUS_NOT_ATTEMPTED_NUM, 0);
            }
        }
    }

Here is the call graph for this function:

---

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

• Services/Tracking/classes/status/class.ilLPStatusSCORMPackage.php