ilLPStatusExerciseReturned Class Reference

Inheritance diagram for ilLPStatusExerciseReturned:

Collaboration diagram for ilLPStatusExerciseReturned:

Public Member Functions
	__construct ($a_obj_id)
	determineStatus ($a_obj_id, $a_user_id, $a_obj=null)
	Determine status. 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	_getNotAttempted ($a_obj_id)
static	_getInProgress ($a_obj_id)
static	_getCompleted ($a_obj_id)
static	_getFailed ($a_obj_id)
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 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, &$a_old_status=self::LP_STATUS_NOT_ATTEMPTED_NUM)
	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=true)

Static Protected Member Functions
static	getMembers ($a_obj_id)
	Get members for object. More...
Static Protected Member Functions inherited from ilLPStatus
static	raiseEvent ($a_obj_id, $a_usr_id, $a_status, $a_old_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...

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
Protected Attributes inherited from ilLPStatus
	$obj_id = null
	$db = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilLPStatusExerciseReturned::__construct

(

$a_obj_id

)

Definition at line 38 of file class.ilLPStatusExerciseReturned.php.

References $DIC, $ilDB, and ILIAS\GlobalScreen\Provider\__construct().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

Here is the call graph for this function:

Member Function Documentation

_getCompleted()

static ilLPStatusExerciseReturned::_getCompleted (   $a_obj_id )

static

Definition at line 80 of file class.ilLPStatusExerciseReturned.php.

References $ret, and ilExerciseMembers\_getPassedUsers().

    {
        $ret = ilExerciseMembers::_getPassedUsers($a_obj_id);
        return $ret ? $ret : array();
    }

Here is the call graph for this function:

_getFailed()

static ilLPStatusExerciseReturned::_getFailed (   $a_obj_id )

static

Definition at line 86 of file class.ilLPStatusExerciseReturned.php.

References $failed, and ilExerciseMembers\_getFailedUsers().

    {
        $failed = ilExerciseMembers::_getFailedUsers($a_obj_id);
        return $failed ? $failed : array();
    }

Here is the call graph for this function:

_getInProgress()

static ilLPStatusExerciseReturned::_getInProgress (   $a_obj_id )

static

Definition at line 62 of file class.ilLPStatusExerciseReturned.php.

References ilLPStatusWrapper\_getCompleted(), ilLPStatusWrapper\_getFailed(), ilExerciseMembers\_getReturned(), and ilChangeEvent\lookupUsersInProgress().

    {
        include_once './Services/Tracking/classes/class.ilChangeEvent.php';
        $users = ilExerciseMembers::_getReturned($a_obj_id);
        $all = ilChangeEvent::lookupUsersInProgress($a_obj_id);
        $users = $users + $all;

        $users = array_diff($users, ilLPStatusWrapper::_getCompleted($a_obj_id));
        $users = array_diff($users, ilLPStatusWrapper::_getFailed($a_obj_id));
        
        if ($users) {
            // Exclude all non members
            $users = array_intersect(self::getMembers($a_obj_id), (array) $users);
        }

        return $users;
    }

Here is the call graph for this function:

_getNotAttempted()

static ilLPStatusExerciseReturned::_getNotAttempted (   $a_obj_id )

static

Definition at line 48 of file class.ilLPStatusExerciseReturned.php.

References ilLPStatusWrapper\_getCompleted(), ilLPStatusWrapper\_getFailed(), and ilLPStatusWrapper\_getInProgress().

    {
        $users = array();
        
        $members = self::getMembers($a_obj_id);
        if ($members) {
            $users = array_diff($members, ilLPStatusWrapper::_getInProgress($a_obj_id));
            $users = array_diff($users, ilLPStatusWrapper::_getCompleted($a_obj_id));
            $users = array_diff($users, ilLPStatusWrapper::_getFailed($a_obj_id));
        }
        
        return $users;
    }

Here is the call graph for this function:

_lookupCompletedForObject()

static ilLPStatusExerciseReturned::_lookupCompletedForObject (   $a_obj_id,   $a_user_ids = null  )

static

Get completed users for object.

Parameters

int	$a_obj_id
array	$a_user_ids

Returns

array

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

    {
        if (!$a_user_ids) {
            $a_user_ids = self::getMembers($a_obj_id);
            if (!$a_user_ids) {
                return array();
            }
        }
        return self::_lookupStatusForObject($a_obj_id, self::LP_STATUS_COMPLETED_NUM, $a_user_ids);
    }

_lookupFailedForObject()

static ilLPStatusExerciseReturned::_lookupFailedForObject (   $a_obj_id,   $a_user_ids = null  )

static

Get failed users for object.

Parameters

int	$a_obj_id
array	$a_user_ids

Returns

array

Definition at line 161 of file class.ilLPStatusExerciseReturned.php.

    {
        if (!$a_user_ids) {
            $a_user_ids = self::getMembers($a_obj_id);
            if (!$a_user_ids) {
                return array();
            }
        }
        return self::_lookupStatusForObject($a_obj_id, self::LP_STATUS_FAILED_NUM, $a_user_ids);
    }

_lookupInProgressForObject()

static ilLPStatusExerciseReturned::_lookupInProgressForObject (   $a_obj_id,   $a_user_ids = null  )

static

Get in progress users for object.

Parameters

int	$a_obj_id
array	$a_user_ids

Returns

array

Definition at line 179 of file class.ilLPStatusExerciseReturned.php.

    {
        if (!$a_user_ids) {
            $a_user_ids = self::getMembers($a_obj_id);
            if (!$a_user_ids) {
                return array();
            }
        }
        return self::_lookupStatusForObject($a_obj_id, self::LP_STATUS_IN_PROGRESS_NUM, $a_user_ids);
    }

determineStatus()

ilLPStatusExerciseReturned::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 100 of file class.ilLPStatusExerciseReturned.php.

References $DIC, ilExerciseMembers\_hasReturned(), ilExerciseMembers\_lookupStatus(), and ilChangeEvent\hasAccessed().

    {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];
        
        $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
        switch ($ilObjDataCache->lookupType($a_obj_id)) {
            case 'exc':
                include_once './Services/Tracking/classes/class.ilChangeEvent.php';
                if (ilChangeEvent::hasAccessed($a_obj_id, $a_user_id) ||
                    ilExerciseMembers::_hasReturned($a_obj_id, $a_user_id)) {
                    $status = self::LP_STATUS_IN_PROGRESS_NUM;
                }
                $ex_stat = ilExerciseMembers::_lookupStatus($a_obj_id, $a_user_id);
                if ($ex_stat == "passed") {
                    $status = self::LP_STATUS_COMPLETED_NUM;
                }
                if ($ex_stat == "failed") {
                    $status = self::LP_STATUS_FAILED_NUM;
                }
                break;
        }
        return $status;
    }

Here is the call graph for this function:

getMembers()

static ilLPStatusExerciseReturned::getMembers (   $a_obj_id )

staticprotected

Get members for object.

Parameters

int

$a_obj_id

Returns

array

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

References ilExerciseMembers\_getMembers().

    {
        return ilExerciseMembers::_getMembers($a_obj_id);
    }

Here is the call graph for this function:

---

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

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