ilLPStatusManualByTutor Class Reference

Inheritance diagram for ilLPStatusManualByTutor:

Collaboration diagram for ilLPStatusManualByTutor:

Public Member Functions
	__construct ($a_obj_id)
	Constructor.
	_getNotAttempted ($a_obj_id)
	get not attempted
	_getInProgress ($a_obj_id)
	get in progress
	_getCompleted ($a_obj_id)
	determineStatus ($a_obj_id, $a_user_id, $a_obj=null)
	Determine status.
Public Member Functions inherited from ilLPStatus
	ilLPStatus ($a_obj_id)
	_getCountNotAttempted ($a_obj_id)
	_getCountInProgress ($a_obj_id)
	_getCountCompleted ($a_obj_id)
	_getFailed ($a_obj_id)
	_getCountFailed ()
	_getStatusInfo ($a_obj_id)
	_getTypicalLearningTime ($a_obj_id)
	_updateStatus ($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_no_raise=false, $a_force_raise=false)
	New status handling (st: status, nr: accesses, p: percentage, t: time spent, m: mark)
	determinePercentage ($a_obj_id, $a_usr_id, $a_obj=null)
	Determine percentage.
	refreshStatus ($a_obj_id, $a_users=null)
	Refresh status.
	_lookupStatusChanged ($a_obj_id, $a_user_id)
	Lookup status changed.

Static Public Member Functions
static	_lookupCompletedForObject ($a_obj_id, $a_user_ids=null)
	Get completed users for object.
static	_lookupFailedForObject ($a_obj_id, $a_user_ids=null)
	Get failed users for object.
static	_lookupInProgressForObject ($a_obj_id, $a_user_ids=null)
	Get in progress users for object.
Static Public Member Functions inherited from ilLPStatus
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.
static	writeStatus ($a_obj_id, $a_user_id, $a_status, $a_percentage=false, $a_force_per=false)
	Write status for user and object.
static	setInProgressIfNotAttempted ($a_obj_id, $a_user_id)
	This function shoudl be clalled for normal "read events".
static	setAllDirty ()
	Sets all status to dirty.
static	setDirty ($a_obj_id)
	Sets status of an object to dirty.
static	_lookupStatus ($a_obj_id, $a_user_id, $a_create=true)
	Lookup status.
static	_lookupPercentage ($a_obj_id, $a_user_id)
	Lookup percentage.
static	_hasUserCompleted ($a_obj_id, $a_user_id)
	Lookup user object completion.
static	preloadListGUIData ($a_obj_ids)
static	getListGUIStatus ($a_obj_id)

Static Protected Member Functions
static	getMembers ($a_obj_id)
	Get members for object.
Static Protected Member Functions inherited from ilLPStatus
static	_lookupStatusForObject ($a_obj_id, $a_status, $a_user_ids=null)
	Get users with given status for object.

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
Protected Member Functions inherited from ilLPStatus
	raiseEvent ($a_obj_id, $a_usr_id, $a_status, $a_percentage)

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 35 of file class.ilLPStatusManualByTutor.php.

Constructor & Destructor Documentation

ilLPStatusManualByTutor::__construct

(

$a_obj_id

)

Constructor.

public

Parameters

int

object id

Definition at line 44 of file class.ilLPStatusManualByTutor.php.

References $ilDB, and ilLPStatus\ilLPStatus().

        {
                global $ilDB;

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

Here is the call graph for this function:

Member Function Documentation

ilLPStatusManualByTutor::_getCompleted

(

$a_obj_id

)

Reimplemented from ilLPStatus.

Definition at line 99 of file class.ilLPStatusManualByTutor.php.

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

        {
                global $ilDB;
                
                $usr_ids = array();

                $query = "SELECT DISTINCT(usr_id) user_id FROM ut_lp_marks ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer')." ".
                        "AND completed = '1' ";

                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $usr_ids[] = $row->user_id;
                }
                
                if($usr_ids)
                {
                        // Exclude all non members
                        $usr_ids = array_intersect(self::getMembers($a_obj_id), (array)$usr_ids);
                }

                return $usr_ids;
        }

ilLPStatusManualByTutor::_getInProgress

(

$a_obj_id

)

get in progress

public

Parameters

int

object id

Returns

array int Array of user ids

Reimplemented from ilLPStatus.

Definition at line 82 of file class.ilLPStatusManualByTutor.php.

References ilLPStatusWrapper\_getCompleted(), and ilChangeEvent\lookupUsersInProgress().

        {               
                include_once './Services/Tracking/classes/class.ilChangeEvent.php';
                $users = ilChangeEvent::lookupUsersInProgress($a_obj_id);
                
                // Exclude all users with status completed.
                $users = array_diff((array) $users,ilLPStatusWrapper::_getCompleted($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:

ilLPStatusManualByTutor::_getNotAttempted

(

$a_obj_id

)

get not attempted

public

Parameters

int

object id

Returns

array int Array of user ids

Reimplemented from ilLPStatus.

Definition at line 60 of file class.ilLPStatusManualByTutor.php.

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

        {               
                $users = array();
        
                $members = self::getMembers($a_obj_id);
                if($members)
                {
                        // diff in progress and completed (use stored result in LPStatusWrapper)
                        $users = array_diff($members, ilLPStatusWrapper::_getInProgress($a_obj_id));
                        $users = array_diff($users, ilLPStatusWrapper::_getCompleted($a_obj_id));                       
                }
                
                return $users;
        }

Here is the call graph for this function:

static ilLPStatusManualByTutor::_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

Reimplemented from ilLPStatus.

Definition at line 194 of file class.ilLPStatusManualByTutor.php.

References ilLPStatus\_lookupStatusForObject(), and getMembers().

        {
                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);
        }

Here is the call graph for this function:

static ilLPStatusManualByTutor::_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

Reimplemented from ilLPStatus.

Definition at line 214 of file class.ilLPStatusManualByTutor.php.

        {
                return array();
        }

static ilLPStatusManualByTutor::_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

Reimplemented from ilLPStatus.

Definition at line 226 of file class.ilLPStatusManualByTutor.php.

References ilLPStatus\_lookupStatusForObject(), and getMembers().

        {
                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);
        }       

Here is the call graph for this function:

ilLPStatusManualByTutor::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

Reimplemented from ilLPStatus.

Definition at line 132 of file class.ilLPStatusManualByTutor.php.

References $ilDB, ilChangeEvent\hasAccessed(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

        {
                global $ilObjDataCache, $ilDB;
                
                $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
                switch ($ilObjDataCache->lookupType($a_obj_id))
                {
                        case "crs":
                        case "grp":
                                // completed?
                                $set = $ilDB->query($q = "SELECT usr_id FROM ut_lp_marks ".
                                        "WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer')." ".
                                        "AND usr_id = ".$ilDB->quote($a_user_id ,'integer')." ".
                                        "AND completed = '1' ");
                                if ($rec = $ilDB->fetchAssoc($set))
                                {
                                        $status = self::LP_STATUS_COMPLETED_NUM;
                                }
                                else
                                {                               
                                        include_once './Services/Tracking/classes/class.ilChangeEvent.php';
                                        if (ilChangeEvent::hasAccessed($a_obj_id, $a_user_id))
                                        {
                                                $status = self::LP_STATUS_IN_PROGRESS_NUM;
                                        }
                                }
                                break;
                }
                return $status;
        }

Here is the call graph for this function:

static ilLPStatusManualByTutor::getMembers (   $a_obj_id )

staticprotected

Get members for object.

Parameters

int

$a_obj_id

Returns

array

Definition at line 168 of file class.ilLPStatusManualByTutor.php.

References ilCourseParticipants\_getInstanceByObjId(), and ilObjGroup\_getMembers().

Referenced by _getNotAttempted(), _lookupCompletedForObject(), and _lookupInProgressForObject().

        {
                global $ilObjDataCache;
        
                switch($ilObjDataCache->lookupType($a_obj_id))
                {
                        case 'crs':
                                include_once 'Modules/Course/classes/class.ilCourseParticipants.php';
                                $member_obj = ilCourseParticipants::_getInstanceByObjId($a_obj_id);
                                return $member_obj->getMembers();
                                
                        case 'grp':
                                include_once './Modules/Group/classes/class.ilObjGroup.php';
                                return ilObjGroup::_getMembers($a_obj_id);                      
                }
                
                return array();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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