Inheritance diagram for ilLPStatusEvent:

Collaboration diagram for ilLPStatusEvent:

Public Member Functions
	ilLPStatusEvent ($a_obj_id)
	_getNotAttempted ($a_obj_id)
	_getInProgress ($a_obj_id)
	_getCompleted ($a_obj_id)
	_getStatusInfo ($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 ()
	_getTypicalLearningTime ($a_obj_id)
	_updateStatus ($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_no_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.
	_lookupStatus ($a_obj_id, $a_user_id)
	Lookup 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 Protected Member Functions
static	getMembers ($a_obj_id, $a_is_crs_id=false)
	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
Protected Member Functions inherited from ilLPStatus
	raiseEvent ($a_obj_id, $a_usr_id, $a_status, $a_percentage)

Detailed Description

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

Member Function Documentation

ilLPStatusEvent::_getCompleted ( $a_obj_id )

Reimplemented from ilLPStatus.

Definition at line 83 of file class.ilLPStatusEvent.php.

References _getStatusInfo().

        {
                $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
                return $status_info['participated_users'] ? $status_info['participated_users'] : array();
        }

Here is the call graph for this function:

ilLPStatusEvent::_getInProgress ( $a_obj_id )

Reimplemented from ilLPStatus.

Definition at line 64 of file class.ilLPStatusEvent.php.

References _getStatusInfo().

        {
                $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
                // If registration is disabled in_progress is not available
                if(!$status_info['registration'])
                {
                        return array();
                }
                // If event has occured in_progress is impossible
                if($status_info['starting_time'] < time())
                {
                        return array();
                }
                // Otherwise all users who registered will get the status in progress
                return $status_info['registered_users'] ? $status_info['registered_users'] : array();
        }

Here is the call graph for this function:

ilLPStatusEvent::_getNotAttempted ( $a_obj_id )

Reimplemented from ilLPStatus.

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

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

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

Here is the call graph for this function:

ilLPStatusEvent::_getStatusInfo ( $a_obj_id )

Reimplemented from ilLPStatus.

Definition at line 89 of file class.ilLPStatusEvent.php.

References $ref_id, ilObject\_getAllReferences(), ilEventParticipants\_getParticipated(), ilEventParticipants\_getRegistered(), ilSessionAppointment\_lookupAppointment(), ilObject\_lookupDescription(), ilObject\_lookupObjId(), ilObjSession\_lookupRegistrationEnabled(), and ilObject\_lookupTitle().

Referenced by _getCompleted(), _getInProgress(), and _getNotAttempted().

        {
                global $tree;
                include_once './Modules/Session/classes/class.ilEventParticipants.php';
                include_once('./Modules/Session/classes/class.ilObjSession.php');
                include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
                $references     = ilObject::_getAllReferences($a_obj_id);       
                $ref_id = end($references);
                
                $course_ref_id = $tree->checkForParentType($ref_id,'crs');
                $course_obj_id = ilObject::_lookupObjId($course_ref_id);
                
                $status_info = array();
                $status_info['crs_id'] = $course_obj_id;
                $status_info['registration'] = ilObjSession::_lookupRegistrationEnabled($a_obj_id);
                $status_info['title'] = ilObject::_lookupTitle($a_obj_id);
                $status_info['description'] = ilObject::_lookupDescription($a_obj_id);
                
                $time_info = ilSessionAppointment::_lookupAppointment($a_obj_id);
                $status_info['starting_time'] = $time_info['start'];
                $status_info['ending_time'] = $time_info['end'];
                $status_info['fullday'] = $time_info['fullday'];
                $status_info['registered_users'] = ilEventParticipants::_getRegistered($a_obj_id);
                $status_info['participated_users'] = ilEventParticipants::_getParticipated($a_obj_id);
                return $status_info;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

static ilLPStatusEvent::_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 195 of file class.ilLPStatusEvent.php.

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

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

Here is the call graph for this function:

static ilLPStatusEvent::_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 215 of file class.ilLPStatusEvent.php.

        {
                return array();
        }

static ilLPStatusEvent::_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 227 of file class.ilLPStatusEvent.php.

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

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

Here is the call graph for this function:

ilLPStatusEvent::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 128 of file class.ilLPStatusEvent.php.

References ilEventParticipants\_hasParticipated(), ilEventParticipants\_isRegistered(), ilSessionAppointment\_lookupAppointment(), ilObjSession\_lookupRegistrationEnabled(), LP_STATUS_COMPLETED_NUM, LP_STATUS_IN_PROGRESS_NUM, and LP_STATUS_NOT_ATTEMPTED_NUM.

        {
                global $ilObjDataCache, $ilDB;
                
                $status = LP_STATUS_NOT_ATTEMPTED_NUM;
                switch ($ilObjDataCache->lookupType($a_obj_id))
                {
                        case 'sess':
                                include_once './Modules/Session/classes/class.ilEventParticipants.php';
                                include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
                                include_once('./Modules/Session/classes/class.ilObjSession.php');
                                
                                $time_info = ilSessionAppointment::_lookupAppointment($a_obj_id);
                                $registration = ilObjSession::_lookupRegistrationEnabled($a_obj_id);
                                
                                // If registration is disabled in_progress is not available
                                // If event has occured in_progress is impossible
                                if ($registration && $time_info['start'] >= time())
                                {
                                        // is user registered -> in progress
                                        if (ilEventParticipants::_isRegistered($a_user_id, $a_obj_id))
                                        {
                                                $status = LP_STATUS_IN_PROGRESS_NUM;
                                        }
                                }
                                if (ilEventParticipants::_hasParticipated($a_user_id, $a_obj_id))
                                {
                                        $status = LP_STATUS_COMPLETED_NUM;
                                }
                                break;
                }
                return $status;         
        }

Here is the call graph for this function:

static ilLPStatusEvent::getMembers	(	$a_obj_id,
		$a_is_crs_id = `false`
	)

staticprotected

Get members for object.

Parameters

int	$a_obj_id
bool	$a_is_crs_id

Returns: array

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

References $ref_id, ilObject\_getAllReferences(), ilCourseParticipants\_getInstanceByObjId(), and ilObject\_lookupObjId().

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

        {               
                // find course in path
                if(!$a_is_crs_id)
                {
                        $references     = ilObject::_getAllReferences($a_obj_id);       
                        $ref_id = end($references);             
                        $course_ref_id = $tree->checkForParentType($ref_id,'crs');
                        $course_obj_id = ilObject::_lookupObjId($course_ref_id);
                }
                else
                {
                        $course_obj_id = $a_obj_id;
                }
                
                include_once 'Modules/Course/classes/class.ilCourseParticipants.php';
                $member_obj = ilCourseParticipants::_getInstanceByObjId($course_obj_id);
                return $member_obj->getMembers();                                               
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLPStatusEvent::ilLPStatusEvent ( $a_obj_id )

Definition at line 39 of file class.ilLPStatusEvent.php.

References ilLPStatus\ilLPStatus().

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

Here is the call graph for this function:

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

Services/Tracking/classes/class.ilLPStatusEvent.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation