ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Public Member Functions | Static Public Member Functions | Static Protected Member Functions
ilLPStatusObjectives Class Reference
+ Inheritance diagram for ilLPStatusObjectives:
+ Collaboration diagram for ilLPStatusObjectives:

Public Member Functions

 __construct ($a_obj_id)
 
 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 _getNotAttempted ($a_obj_id)
 
static _getInProgress ($a_obj_id)
 
static _getCompleted ($a_obj_id)
 
static _getFailed ($a_obj_id)
 
static _getStatusInfo ($a_obj_id)
 
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 _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)
 

Static Protected Member Functions

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

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
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilLPStatusObjectives::__construct (   $a_obj_id)

Reimplemented from ilLPStatus.

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

19 {
20 global $DIC;
21
22 $ilDB = $DIC['ilDB'];
23
24 parent::__construct($a_obj_id);
25 $this->db = $ilDB;
26 }
$DIC
global $DIC
Definition: saml.php:7
$ilDB
global $ilDB
Definition: storeScorm2004.php:19

References $DIC, and $ilDB.

Member Function Documentation

◆ _getCompleted()

static ilLPStatusObjectives::_getCompleted (   $a_obj_id)
static

Reimplemented from ilLPStatus.

Definition at line 65 of file class.ilLPStatusObjectives.php.

66 {
67 $objective_results = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
68 $usr_ids = (array) $objective_results['user_status'][self::LP_STATUS_COMPLETED_NUM];
69
70 if ($usr_ids) {
71 // Exclude all non members
72 $usr_ids = array_intersect(self::getMembers($a_obj_id), (array) $usr_ids);
73 }
74
75 return $usr_ids ? $usr_ids : array();
76 }
ilLPStatusWrapper\_getStatusInfo
static _getStatusInfo($a_obj_id)
Reads informations about the object e.g test results, tlt, number of visits.
Definition: class.ilLPStatusWrapper.php:124

References ilLPStatusWrapper\_getStatusInfo().

+ Here is the call graph for this function:

◆ _getFailed()

static ilLPStatusObjectives::_getFailed (   $a_obj_id)
static

Reimplemented from ilLPStatus.

Definition at line 78 of file class.ilLPStatusObjectives.php.

79 {
80 $objective_results = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
81 $usr_ids = (array) $objective_results['user_status'][self::LP_STATUS_FAILED_NUM];
82
83 if ($usr_ids) {
84 // Exclude all non members
85 $usr_ids = array_intersect(self::getMembers($a_obj_id), (array) $usr_ids);
86 }
87
88 return $usr_ids ? $usr_ids : array();
89 }

References ilLPStatusWrapper\_getStatusInfo().

+ Here is the call graph for this function:

◆ _getInProgress()

static ilLPStatusObjectives::_getInProgress (   $a_obj_id)
static

Reimplemented from ilLPStatus.

Definition at line 43 of file class.ilLPStatusObjectives.php.

44 {
45 $objective_results = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
46 $usr_ids = (array) $objective_results['user_status'][self::LP_STATUS_IN_PROGRESS_NUM];
47
48 /* change_event is of no use when no objective has been tried yet
49 include_once './Services/Tracking/classes/class.ilChangeEvent.php';
50 $users = ilChangeEvent::lookupUsersInProgress($a_obj_id);
51
52 // Exclude all users with status completed/failed.
53 $users = array_diff((array) $users,ilLPStatusWrapper::_getCompleted($a_obj_id));
54 $users = array_diff((array) $users,ilLPStatusWrapper::_getFailed($a_obj_id));
55 */
56
57 if ($usr_ids) {
58 // Exclude all non members
59 $usr_ids = array_intersect(self::getMembers($a_obj_id), (array) $usr_ids);
60 }
61
62 return $usr_ids ? $usr_ids : array();
63 }

References ilLPStatusWrapper\_getStatusInfo().

+ Here is the call graph for this function:

◆ _getNotAttempted()

static ilLPStatusObjectives::_getNotAttempted (   $a_obj_id)
static

Reimplemented from ilLPStatus.

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

29 {
30 $users = array();
31
32 $members = self::getMembers($a_obj_id);
33 if ($members) {
34 // diff in progress, completed and failed (use stored result in LPStatusWrapper)
35 $users = array_diff((array) $members, ilLPStatusWrapper::_getInProgress($a_obj_id));
36 $users = array_diff((array) $members, ilLPStatusWrapper::_getCompleted($a_obj_id));
37 $users = array_diff((array) $members, ilLPStatusWrapper::_getFailed($a_obj_id));
38 }
39
40 return $users;
41 }
$users
$users
Definition: authpage.php:44
ilLPStatusObjectives\getMembers
static getMembers($a_obj_id)
Get members for object.
Definition: class.ilLPStatusObjectives.php:187
ilLPStatusWrapper\_getCompleted
static _getCompleted($a_obj_id)
Static function to read the users who have the status 'completed'.
Definition: class.ilLPStatusWrapper.php:86
ilLPStatusWrapper\_getInProgress
static _getInProgress($a_obj_id)
Static function to read users who have the status 'in_progress'.
Definition: class.ilLPStatusWrapper.php:61
ilLPStatusWrapper\_getFailed
static _getFailed($a_obj_id)
Static function to read the users who have the status 'completed'.
Definition: class.ilLPStatusWrapper.php:108

References $users, ilLPStatusWrapper\_getCompleted(), ilLPStatusWrapper\_getFailed(), ilLPStatusWrapper\_getInProgress(), and getMembers().

+ Here is the call graph for this function:

◆ _getStatusInfo()

static ilLPStatusObjectives::_getStatusInfo (   $a_obj_id)
static

Reimplemented from ilLPStatus.

Definition at line 91 of file class.ilLPStatusObjectives.php.

92 {
93 global $DIC;
94
95 $ilDB = $DIC['ilDB'];
96
97 include_once 'Modules/Course/classes/class.ilCourseObjective.php';
98
99 $status_info = array();
100 $status_info['user_status'] = array();
101 $status_info['objectives'] = ilCourseObjective::_getObjectiveIds($a_obj_id, true);
102 $status_info['num_objectives'] = count($status_info['objectives']);
103
104 if ($status_info['num_objectives']) {
105 $in = $ilDB->in('objective_id', $status_info['objectives'], false, 'integer');
106
107 include_once "Modules/Course/classes/Objectives/class.ilLOUserResults.php";
108 foreach (ilLOUserResults::getSummarizedObjectiveStatusForLP($a_obj_id, $status_info['objectives']) as $user_id => $user_status) {
109 $status_info['user_status'][$user_status][] = $user_id;
110 }
111
112 // change event should lead to "in progress" - see determineStatus()
113 include_once("./Services/Tracking/classes/class.ilChangeEvent.php");
114 foreach (ilChangeEvent::lookupUsersInProgress($a_obj_id) as $user_id) {
115 if (!is_array($status_info['user_status'][ilLPStatus::LP_STATUS_IN_PROGRESS_NUM]) ||
116 !in_array($user_id, $status_info['user_status'][ilLPStatus::LP_STATUS_IN_PROGRESS_NUM])) {
117 $status_info['user_status'][ilLPStatus::LP_STATUS_IN_PROGRESS_NUM][] = $user_id;
118 }
119 }
120
121 // Read title/description
122 $query = "SELECT * FROM crs_objectives WHERE " . $in;
123 $res = $ilDB->query($query);
124 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
125 $status_info['objective_title'][$row->objective_id] = $row->title;
126 $status_info['objective_description'][$row->objective_id] = $row->description;
127 }
128 }
129
130 return $status_info;
131 }
$in
if(php_sapi_name() !='cli') $in
Definition: Utf8Test.php:37
ilChangeEvent\lookupUsersInProgress
static lookupUsersInProgress($a_obj_id)
Lookup users in progress.
Definition: class.ilChangeEvent.php:777
ilCourseObjective\_getObjectiveIds
static _getObjectiveIds($course_id, $a_activated_only=false)
Definition: class.ilCourseObjective.php:533
ilLOUserResults\getSummarizedObjectiveStatusForLP
static getSummarizedObjectiveStatusForLP($a_obj_id, array $a_objective_ids, $a_user_id=null)
Definition: class.ilLOUserResults.php:453
ilLPStatus\LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_IN_PROGRESS_NUM
Definition: class.ilLPStatus.php:29
$row
$row
Definition: migrateto20.php:360
$query
$query
Definition: proxy_ylocal.php:13
$res
foreach($_POST as $key=> $value) $res
Definition: save_question_post_data.php:15

References $DIC, $ilDB, $in, $query, $res, $row, ilCourseObjective\_getObjectiveIds(), ilDBConstants\FETCHMODE_OBJECT, ilLOUserResults\getSummarizedObjectiveStatusForLP(), ilChangeEvent\lookupUsersInProgress(), and ilLPStatus\LP_STATUS_IN_PROGRESS_NUM.

+ Here is the call graph for this function:

◆ _lookupCompletedForObject()

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

202 {
203 if (!$a_user_ids) {
204 $a_user_ids = self::getMembers($a_obj_id);
205 if (!$a_user_ids) {
206 return array();
207 }
208 }
209 return self::_lookupStatusForObject($a_obj_id, self::LP_STATUS_COMPLETED_NUM, $a_user_ids);
210 }
ilLPStatus\_lookupStatusForObject
static _lookupStatusForObject($a_obj_id, $a_status, $a_user_ids=null)
Get users with given status for object.
Definition: class.ilLPStatus.php:669

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

+ Here is the call graph for this function:

◆ _lookupFailedForObject()

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

220 {
221 return array();
222 }

◆ _lookupInProgressForObject()

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

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

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

+ Here is the call graph for this function:

◆ determineStatus()

ilLPStatusObjectives::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 141 of file class.ilLPStatusObjectives.php.

142 {
143 global $DIC;
144
145 $ilObjDataCache = $DIC['ilObjDataCache'];
146 $ilDB = $DIC['ilDB'];
147
148 // the status completed depends on:
149 // $status_info['num_objectives'] (ilLPStatusWrapper::_getStatusInfo($a_obj_id);)
150 // - ilCourseObjective::_getObjectiveIds($a_obj_id);
151 // - table crs_objectives manipulated in
152 // - ilCourseObjective
153
154 // $status_info['objective_result'] (ilLPStatusWrapper::_getStatusInfo($a_obj_id);)
155 // table crs_objective_status (must not contain a dataset)
156 // ilCourseObjectiveResult -> added ilLPStatusWrapper::_updateStatus()
157
158 $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
159 switch ($ilObjDataCache->lookupType($a_obj_id)) {
160 case "crs":
161 include_once("./Services/Tracking/classes/class.ilChangeEvent.php");
162 if (ilChangeEvent::hasAccessed($a_obj_id, $a_user_id)) {
163 // an initial test (only) should also lead to "in progress"
164 $status = self::LP_STATUS_IN_PROGRESS_NUM;
165
166 include_once 'Modules/Course/classes/class.ilCourseObjective.php';
167 $objectives = ilCourseObjective::_getObjectiveIds($a_obj_id, true);
168 if ($objectives) {
169 // #14051 - getSummarizedObjectiveStatusForLP() might return null
170 include_once "Modules/Course/classes/Objectives/class.ilLOUserResults.php";
171 $objtv_status = ilLOUserResults::getSummarizedObjectiveStatusForLP($a_obj_id, $objectives, $a_user_id);
172 if ($objtv_status !== null) {
173 $status = $objtv_status;
174 }
175 }
176 }
177 break;
178 }
179 return $status;
180 }
ilChangeEvent\hasAccessed
static hasAccessed($a_obj_id, $a_usr_id)
Has accessed.
Definition: class.ilChangeEvent.php:798
ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM
Definition: class.ilLPStatus.php:28

References $DIC, $ilDB, ilCourseObjective\_getObjectiveIds(), ilLOUserResults\getSummarizedObjectiveStatusForLP(), ilChangeEvent\hasAccessed(), ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

+ Here is the call graph for this function:

◆ getMembers()

static ilLPStatusObjectives::getMembers (   $a_obj_id)
staticprotected

Get members for object.

Parameters
int$a_obj_id
Returns
array

Definition at line 187 of file class.ilLPStatusObjectives.php.

188 {
189 include_once 'Modules/Course/classes/class.ilCourseParticipants.php';
190 $member_obj = ilCourseParticipants::_getInstanceByObjId($a_obj_id);
191 return $member_obj->getMembers();
192 }
ilCourseParticipants\_getInstanceByObjId
static _getInstanceByObjId($a_obj_id)
Get singleton instance.
Definition: class.ilCourseParticipants.php:77

References ilCourseParticipants\_getInstanceByObjId().

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

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