ilLPStatusExerciseReturned Class Reference

Inheritance diagram for ilLPStatusExerciseReturned:

Collaboration diagram for ilLPStatusExerciseReturned:

Public Member Functions
	determineStatus (int $a_obj_id, int $a_usr_id, ?object $a_obj=null)
	Determine status. More...
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	_getNotAttempted (int $a_obj_id)
static	_getInProgress (int $a_obj_id)
static	_getCompleted (int $a_obj_id)
static	_getFailed (int $a_obj_id)
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 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 (string $type, int $obj_id, int $sub_id=0)
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)

Static Protected Member Functions
static	getMembers (int $a_obj_id)
	Get members for object. More...
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...

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
int	$obj_id
ilDBInterface	$db
ilObjectDataCache	$ilObjDataCache

Detailed Description

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

Member Function Documentation

_getCompleted()

static ilLPStatusExerciseReturned::_getCompleted ( int  $a_obj_id )

static

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

References ilExerciseMembers\_getPassedUsers().

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

Here is the call graph for this function:

_getFailed()

static ilLPStatusExerciseReturned::_getFailed ( int  $a_obj_id )

static

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

References ilExerciseMembers\_getFailedUsers().

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

Here is the call graph for this function:

_getInProgress()

static ilLPStatusExerciseReturned::_getInProgress ( int  $a_obj_id )

static

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

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

                                                        : array
    {
        $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), $users);
        }

        return $users;
    }

Here is the call graph for this function:

_getNotAttempted()

static ilLPStatusExerciseReturned::_getNotAttempted ( int  $a_obj_id )

static

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

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

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

static

Get completed users for object.

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

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

static

Get failed users for object.

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

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

static

Get in progress users for object.

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

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

Determine status.

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

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

     : int {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];

        $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
        switch ($this->ilObjDataCache->lookupType($a_obj_id)) {
            case 'exc':
                if (ilChangeEvent::hasAccessed($a_obj_id, $a_usr_id) ||
                    ilExerciseMembers::_hasReturned($a_obj_id, $a_usr_id)) {
                    $status = self::LP_STATUS_IN_PROGRESS_NUM;
                }
                $ex_stat = ilExerciseMembers::_lookupStatus(
                    $a_obj_id,
                    $a_usr_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 ( int  $a_obj_id )

staticprotected

Get members for object.

Definition at line 115 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:

• components/ILIAS/Tracking/classes/status/class.ilLPStatusExerciseReturned.php