ilLPStatusStudyProgramme Class Reference

Inheritance diagram for ilLPStatusStudyProgramme:

Collaboration diagram for ilLPStatusStudyProgramme:

Public Member Functions
	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	_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 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

Definition at line 15 of file class.ilLPStatusStudyProgramme.php.

Member Function Documentation

_getCompleted()

static ilLPStatusStudyProgramme::_getCompleted (   $a_obj_id )

static

Reimplemented from ilLPStatus.

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

    {
        require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
        $prg = new ilObjStudyProgramme($a_obj_id, false);
        return $prg->getIdsOfUsersWithCompletedProgress();
    }

_getCountCompleted()

static ilLPStatusStudyProgramme::_getCountCompleted (   $a_obj_id )

static

Reimplemented from ilLPStatus.

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

    {
        return count(self::_getCompleted($a_obj_id));
    }

_getCountInProgress()

static ilLPStatusStudyProgramme::_getCountInProgress (   $a_obj_id )

static

Reimplemented from ilLPStatus.

Definition at line 17 of file class.ilLPStatusStudyProgramme.php.

    {
        return count(self::_getInProgress($a_obj_id));
    }

_getFailed()

static ilLPStatusStudyProgramme::_getFailed (   $a_obj_id )

static

Reimplemented from ilLPStatus.

Definition at line 41 of file class.ilLPStatusStudyProgramme.php.

    {
        require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
        $prg = new ilObjStudyProgramme($a_obj_id, false);
        return $prg->getIdsOfUsersWithFailedProgress();
    }

_getInProgress()

static ilLPStatusStudyProgramme::_getInProgress (   $a_obj_id )

static

Reimplemented from ilLPStatus.

Definition at line 22 of file class.ilLPStatusStudyProgramme.php.

    {
        require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
        $prg = new ilObjStudyProgramme($a_obj_id, false);
        return $prg->getIdsOfUsersWithNotCompletedAndRelevantProgress();
    }

determineStatus()

ilLPStatusStudyProgramme::determineStatus	(		$a_obj_id,
			$a_usr_id,
			$a_obj = null
	)

Determine status.

Parameters

return

Reimplemented from ilLPStatus.

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

    {
        require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
        $prg = new ilObjStudyProgramme($a_obj_id, false);
        $progresses = $prg->getProgressesOf($a_user_id);
 
        $successful = false;
        $relevant = false;
 
        foreach ($progresses as $progress) {
            if ($progress->isSuccessful()) {
                $successful = true;
                break;
            }
            if ($progress->isRelevant()) {
                $relevant = true;
            }
            $progress->recalculateFailedToDeadline();
            if ($progress->isFailed()) {
                $failed = true;
            }
        }
 
        if ($successful) {
            return ilLPStatus::LP_STATUS_COMPLETED_NUM;
        }
        if ($failed) {
            return ilLPStatus::LP_STATUS_FAILED_NUM;
        }
        if ($relevant) {
            return ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
        }
 
        return ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
    }

References $failed, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

---

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

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