ilLPStatusSCORMPackage Class Reference

Inheritance diagram for ilLPStatusSCORMPackage:

Collaboration diagram for ilLPStatusSCORMPackage:

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

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

Additional Inherited Members
Data Fields inherited from ilLPStatus
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 (int $a_obj_id, int $a_usr_id, int $a_status, int $a_old_status, int $a_percentage)
static	_lookupStatusForObject (int $a_obj_id, int $a_status, ?array $a_user_ids=null)
	Get users with given status for object. More...
static	validateLPForObjects (int $a_user_id, array $a_obj_ids, int $a_parent_ref_id)
	Process given objects for lp-relevance. More...
static	checkLPModesForObjects (array $a_obj_ids, array &$a_coll_obj_ids)
	Process lp modes for given objects. More...
static	getLPStatusForObjects (int $a_user_id, array $a_obj_ids)
	Get LP status for given objects (and user) More...
Protected Attributes inherited from ilLPStatus
int	$obj_id
ilDBInterface	$db
ilObjectDataCache	$ilObjDataCache

Detailed Description

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

Member Function Documentation

_getCompleted()

static ilLPStatusSCORMPackage::_getCompleted ( int  $a_obj_id )

static

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

References ilLPStatusWrapper\_getStatusInfo().

                                                       : array
    {
        $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 ( int  $a_obj_id )

static

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

References ilLPStatusWrapper\_getStatusInfo().

                                                    : array
    {
        $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 ( int  $a_obj_id )

static

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

References ilLPStatusWrapper\_getStatusInfo().

                                                        : array
    {
        $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 ( int  $a_obj_id )

static

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

References ilSCORM2004Tracking\_getProgressInfo().

                                                        : array
    {
        $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	(	int	$a_obj_id,
		int	$a_usr_id,
		?object	$a_obj = null
	)

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

     : int {
        return 0;//todo!
    }

determineStatus()

ilLPStatusSCORMPackage::determineStatus	(	int	$a_obj_id,
		int	$a_usr_id,
		object	$a_obj = null
	)

Determine status.

Parameters

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

Returns

int status

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

References $DIC, $ilDB, ilLPStatus\$ilObjDataCache, and ilSCORM2004Tracking\_getProgressInfoOfUser().

     : int {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];
        $ilDB = $DIC['ilDB'];
        $ilLog = $DIC['ilLog'];

        $scorm_status = ilSCORM2004Tracking::_getProgressInfoOfUser(
            $a_obj_id,
            $a_usr_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	(	int	$a_obj_id,
		?array	$a_users = null
	)

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

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

                                                                        : void
    {
        parent::refreshStatus($a_obj_id, $a_users);

        $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
        $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