ilLPStatusVisits Class Reference

Inheritance diagram for ilLPStatusVisits:

Collaboration diagram for ilLPStatusVisits:

Public Member Functions
	__construct ($a_obj_id)
	determineStatus ($a_obj_id, $a_user_id, $a_obj=null)
	Determine status. More...
	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	_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=true)

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

Version

$Id$

Definition at line 16 of file class.ilLPStatusVisits.php.

Constructor & Destructor Documentation

__construct()

ilLPStatusVisits::__construct

(

$a_obj_id

)

Definition at line 18 of file class.ilLPStatusVisits.php.

References $DIC, and $ilDB.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

Member Function Documentation

_getCompleted()

static ilLPStatusVisits::_getCompleted (   $a_obj_id )

static

Definition at line 47 of file class.ilLPStatusVisits.php.

References $DIC, $ilDB, ilLPStatusWrapper\_getStatusInfo(), and ilChangeEvent\_lookupReadEvents().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
        $required_visits = $status_info['visits'];

        include_once './Services/Tracking/classes/class.ilChangeEvent.php';
        $all = ilChangeEvent::_lookupReadEvents($a_obj_id);
        foreach ($all as $event) {
            if ($event['read_count'] >= $required_visits) {
                $user_ids[] = $event['usr_id'];
            }
        }
        return $user_ids ? $user_ids : array();
    }

Here is the call graph for this function:

_getInProgress()

static ilLPStatusVisits::_getInProgress (   $a_obj_id )

static

Definition at line 28 of file class.ilLPStatusVisits.php.

References $DIC, $ilDB, ilLPStatusWrapper\_getStatusInfo(), and ilChangeEvent\_lookupReadEvents().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
        $required_visits = $status_info['visits'];
            
        include_once './Services/Tracking/classes/class.ilChangeEvent.php';
        $all = ilChangeEvent::_lookupReadEvents($a_obj_id);
        foreach ($all as $event) {
            if ($event['read_count'] < $required_visits) {
                $user_ids[] = $event['usr_id'];
            }
        }
        return $user_ids ? $user_ids : array();
    }

Here is the call graph for this function:

_getStatusInfo()

static ilLPStatusVisits::_getStatusInfo (   $a_obj_id )

static

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

References ilLPObjSettings\_lookupVisits().

    {
        include_once 'Services/Tracking/classes/class.ilLPObjSettings.php';
        $status_info['visits'] = ilLPObjSettings::_lookupVisits($a_obj_id);

        return $status_info;
    }

Here is the call graph for this function:

determinePercentage()

ilLPStatusVisits::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 119 of file class.ilLPStatusVisits.php.

References ilChangeEvent\_lookupReadEvents(), and ilLPObjSettings\_lookupVisits().

    {
        include_once 'Services/Tracking/classes/class.ilLPObjSettings.php';
        $reqv = ilLPObjSettings::_lookupVisits($a_obj_id);

        $re = ilChangeEvent::_lookupReadEvents($a_obj_id, $a_user_id);
        $rc = (int) $re[0]["read_count"];

        if ($reqv > 0) {
            $per = min(100, 100 / $reqv * $rc);
        } else {
            $per = 100;
        }

        return $per;
    }

Here is the call graph for this function:

determineStatus()

ilLPStatusVisits::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 82 of file class.ilLPStatusVisits.php.

References $DIC, $ilDB, ilLPStatusWrapper\_getStatusInfo(), ilChangeEvent\_lookupReadEvents(), and ilChangeEvent\hasAccessed().

    {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];
        $ilDB = $DIC['ilDB'];
        
        $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
        switch ($ilObjDataCache->lookupType($a_obj_id)) {
            case 'lm':
                include_once './Services/Tracking/classes/class.ilChangeEvent.php';
                if (ilChangeEvent::hasAccessed($a_obj_id, $a_user_id)) {
                    $status = self::LP_STATUS_IN_PROGRESS_NUM;
                    
                    // completed?
                    $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
                    $required_visits = $status_info['visits'];

                    include_once './Services/Tracking/classes/class.ilChangeEvent.php';
                    $re = ilChangeEvent::_lookupReadEvents($a_obj_id, $a_user_id);
                    if ($re[0]['read_count'] >= $required_visits) {
                        $status = self::LP_STATUS_COMPLETED_NUM;
                    }
                }
                break;
        }
        return $status;
    }

Here is the call graph for this function:

---

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

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