ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
Public Member Functions | Static Public Member Functions | Static Protected Member Functions
ilLPStatusEvent Class Reference
+ 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. More...
 
- Public Member Functions inherited from ilLPStatus
 ilLPStatus ($a_obj_id)
 
 _getCountNotAttempted ($a_obj_id)
 
 _getNotAttempted ($a_obj_id)
 
 _getCountInProgress ($a_obj_id)
 
 _getInProgress ($a_obj_id)
 
 _getCountCompleted ($a_obj_id)
 
 _getCompleted ($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_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...
 
 _lookupStatusChanged ($a_obj_id, $a_user_id)
 Lookup status changed. More...
 

Static Public Member Functions

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 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. 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 _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)
 

Static Protected Member Functions

static getMembers ($a_obj_id, $a_is_crs_id=false)
 Get members for object. More...
 
- 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. 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...
 

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

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

Member Function Documentation

◆ _getCompleted()

ilLPStatusEvent::_getCompleted (   $a_obj_id)

Reimplemented from ilLPStatus.

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

84 {
85 $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
86 return $status_info['participated_users'] ? $status_info['participated_users'] : array();
87 }
ilLPStatusWrapper\_getStatusInfo
_getStatusInfo($a_obj_id)
Reads informations about the object e.g test results, tlt, number of visits.
Definition: class.ilLPStatusWrapper.php:128

References ilLPStatusWrapper\_getStatusInfo().

+ Here is the call graph for this function:

◆ _getInProgress()

ilLPStatusEvent::_getInProgress (   $a_obj_id)

Reimplemented from ilLPStatus.

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

65 {
66 $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
67
68 // If registration is disabled in_progress is not available
69 if(!$status_info['registration'])
70 {
71 return array();
72 }
73 // If event has occured in_progress is impossible
74 if($status_info['starting_time'] < time())
75 {
76 return array();
77 }
78
79 // Otherwise all users who registered will get the status in progress
80 return $status_info['registered_users'] ? $status_info['registered_users'] : array();
81 }

References ilLPStatusWrapper\_getStatusInfo().

+ Here is the call graph for this function:

◆ _getNotAttempted()

ilLPStatusEvent::_getNotAttempted (   $a_obj_id)

Reimplemented from ilLPStatus.

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

48 {
49 $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
50
51 $users = array();
52
53 $members = self::getMembers($status_info['crs_id'], true);
54 if($members)
55 {
56 // diff in progress and completed (use stored result in LPStatusWrapper)
57 $users = array_diff((array) $members, ilLPStatusWrapper::_getInProgress($a_obj_id));
58 $users = array_diff((array) $users, ilLPStatusWrapper::_getCompleted($a_obj_id));
59 }
60
61 return $users;
62 }
ilLPStatusEvent\getMembers
static getMembers($a_obj_id, $a_is_crs_id=false)
Get members for object.
Definition: class.ilLPStatusEvent.php:168
ilLPStatusWrapper\_getCompleted
_getCompleted($a_obj_id)
Static function to read the users who have the status 'completed'.
Definition: class.ilLPStatusWrapper.php:88
ilLPStatusWrapper\_getInProgress
_getInProgress($a_obj_id)
Static function to read users who have the status 'in_progress'.
Definition: class.ilLPStatusWrapper.php:62

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

+ Here is the call graph for this function:

◆ _getStatusInfo()

ilLPStatusEvent::_getStatusInfo (   $a_obj_id)

Reimplemented from ilLPStatus.

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

90 {
91 global $tree;
92
93 include_once './Modules/Session/classes/class.ilEventParticipants.php';
94 include_once('./Modules/Session/classes/class.ilObjSession.php');
95 include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
96
97 $references = ilObject::_getAllReferences($a_obj_id);
98 $ref_id = end($references);
99
100 $course_ref_id = $tree->checkForParentType($ref_id,'crs');
101 $course_obj_id = ilObject::_lookupObjId($course_ref_id);
102
103 $status_info = array();
104 $status_info['crs_id'] = $course_obj_id;
105 $status_info['registration'] = ilObjSession::_lookupRegistrationEnabled($a_obj_id);
106 $status_info['title'] = ilObject::_lookupTitle($a_obj_id);
107 $status_info['description'] = ilObject::_lookupDescription($a_obj_id);
108
109 $time_info = ilSessionAppointment::_lookupAppointment($a_obj_id);
110 $status_info['starting_time'] = $time_info['start'];
111 $status_info['ending_time'] = $time_info['end'];
112 $status_info['fullday'] = $time_info['fullday'];
113
114 $status_info['registered_users'] = ilEventParticipants::_getRegistered($a_obj_id);
115 $status_info['participated_users'] = ilEventParticipants::_getParticipated($a_obj_id);
116
117 return $status_info;
118 }
ilObjSession\_lookupRegistrationEnabled
static _lookupRegistrationEnabled($a_obj_id)
lookup registration enabled
Definition: class.ilObjSession.php:65
ilObject\_lookupObjId
static _lookupObjId($a_id)
Definition: class.ilObject.php:1041
ilObject\_lookupTitle
static _lookupTitle($a_id)
lookup object title
Definition: class.ilObject.php:944
ilObject\_lookupDescription
static _lookupDescription($a_id)
lookup object description
Definition: class.ilObject.php:994
ilObject\_getAllReferences
static _getAllReferences($a_id)
get all reference ids of object
Definition: class.ilObject.php:922
ilSessionAppointment\_lookupAppointment
static _lookupAppointment($a_obj_id)
lookup appointment
Definition: class.ilSessionAppointment.php:47
$ref_id
$ref_id
Definition: sahs_server.php:39

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

+ Here is the call graph for this function:

◆ _lookupCompletedForObject()

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.

196 {
197 if(!$a_user_ids)
198 {
199 $a_user_ids = self::getMembers($a_obj_id);
200 if(!$a_user_ids)
201 {
202 return array();
203 }
204 }
205 return self::_lookupStatusForObject($a_obj_id, self::LP_STATUS_COMPLETED_NUM, $a_user_ids);
206 }
ilLPStatus\_lookupStatusForObject
static _lookupStatusForObject($a_obj_id, $a_status, $a_user_ids=null)
Get users with given status for object.
Definition: class.ilLPStatus.php:653

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

+ Here is the call graph for this function:

◆ _lookupFailedForObject()

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.

216 {
217 return array();
218 }

◆ _lookupInProgressForObject()

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.

228 {
229 if(!$a_user_ids)
230 {
231 $a_user_ids = self::getMembers($a_obj_id);
232 if(!$a_user_ids)
233 {
234 return array();
235 }
236 }
237 return self::_lookupStatusForObject($a_obj_id, self::LP_STATUS_IN_PROGRESS_NUM, $a_user_ids);
238 }

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

+ Here is the call graph for this function:

◆ determineStatus()

ilLPStatusEvent::determineStatus (   $a_obj_id,
  $a_user_id,
  $a_obj = null 
)

Determine status.

Parameters
integerobject id
integeruser id
objectobject (optional depends on object type)
Returns
integer status

Reimplemented from ilLPStatus.

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

129 {
130 global $ilObjDataCache;
131
132 $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
133 switch ($ilObjDataCache->lookupType($a_obj_id))
134 {
135 case 'sess':
136 include_once './Modules/Session/classes/class.ilEventParticipants.php';
137 include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
138 include_once('./Modules/Session/classes/class.ilObjSession.php');
139
140 $time_info = ilSessionAppointment::_lookupAppointment($a_obj_id);
141 $registration = ilObjSession::_lookupRegistrationEnabled($a_obj_id);
142
143 // If registration is disabled in_progress is not available
144 // If event has occured in_progress is impossible
145 if ($registration && $time_info['start'] >= time())
146 {
147 // is user registered -> in progress
148 if (ilEventParticipants::_isRegistered($a_user_id, $a_obj_id))
149 {
150 $status = self::LP_STATUS_IN_PROGRESS_NUM;
151 }
152 }
153 if (ilEventParticipants::_hasParticipated($a_user_id, $a_obj_id))
154 {
155 $status = self::LP_STATUS_COMPLETED_NUM;
156 }
157 break;
158 }
159 return $status;
160 }
ilEventParticipants\_isRegistered
static _isRegistered($a_usr_id, $a_event_id)
Definition: class.ilEventParticipants.php:220
ilEventParticipants\_hasParticipated
static _hasParticipated($a_usr_id, $a_event_id)
Definition: class.ilEventParticipants.php:205
ilLPStatus\LP_STATUS_COMPLETED_NUM
const LP_STATUS_COMPLETED_NUM
Definition: class.ilLPStatus.php:30
ilLPStatus\LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_IN_PROGRESS_NUM
Definition: class.ilLPStatus.php:29
ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM
Definition: class.ilLPStatus.php:28

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

+ Here is the call graph for this function:

◆ getMembers()

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.

169 {
170 // find course in path
171 if(!$a_is_crs_id)
172 {
173 $references = ilObject::_getAllReferences($a_obj_id);
174 $ref_id = end($references);
175 $course_ref_id = $tree->checkForParentType($ref_id,'crs');
176 $course_obj_id = ilObject::_lookupObjId($course_ref_id);
177 }
178 else
179 {
180 $course_obj_id = $a_obj_id;
181 }
182
183 include_once 'Modules/Course/classes/class.ilCourseParticipants.php';
184 $member_obj = ilCourseParticipants::_getInstanceByObjId($course_obj_id);
185 return $member_obj->getMembers();
186 }
ilCourseParticipants\_getInstanceByObjId
static _getInstanceByObjId($a_obj_id)
Get singleton instance.
Definition: class.ilCourseParticipants.php:77

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ilLPStatusEvent()

ilLPStatusEvent::ilLPStatusEvent (   $a_obj_id)

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

40 {
41 global $ilDB;
42
43 parent::ilLPStatus($a_obj_id);
44 $this->db =& $ilDB;
45 }
$ilDB
global $ilDB
Definition: storeScorm2004.php:19

References $ilDB.

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