ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
class.ilLPStatusObjectives.php
Go to the documentation of this file.
1<?php
2
3/* Copyright (c) 1998-2011 ILIAS open source, Extended GPL, see docs/LICENSE */
4
5include_once 'Services/Tracking/classes/class.ilLPStatus.php';
6
7
17{
18 public function __construct($a_obj_id)
19 {
20 global $DIC;
21
22 $ilDB = $DIC['ilDB'];
23
24 parent::__construct($a_obj_id);
25 $this->db = $ilDB;
26 }
27
28 public static function _getNotAttempted($a_obj_id)
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 }
42
43 public static function _getInProgress($a_obj_id)
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 }
64
65 public static function _getCompleted($a_obj_id)
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 }
77
78 public static function _getFailed($a_obj_id)
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 }
90
91 public static function _getStatusInfo($a_obj_id)
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 }
132
141 public function determineStatus($a_obj_id, $a_user_id, $a_obj = null)
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
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"
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 }
181
187 protected static function getMembers($a_obj_id)
188 {
189 include_once 'Modules/Course/classes/class.ilCourseParticipants.php';
190 $member_obj = ilCourseParticipants::_getInstanceByObjId($a_obj_id);
191 return $member_obj->getMembers();
192 }
193
201 public static function _lookupCompletedForObject($a_obj_id, $a_user_ids = null)
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 }
211
219 public static function _lookupFailedForObject($a_obj_id, $a_user_ids = null)
220 {
221 return array();
222 }
223
231 public static function _lookupInProgressForObject($a_obj_id, $a_user_ids = null)
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 }
241}
if(php_sapi_name() !='cli') $in
Definition: Utf8Test.php:37
An exception for terminatinating execution or to throw for unit testing.
static lookupUsersInProgress($a_obj_id)
Lookup users in progress.
static hasAccessed($a_obj_id, $a_usr_id)
Has accessed.
static _getObjectiveIds($course_id, $a_activated_only=false)
static _getInstanceByObjId($a_obj_id)
Get singleton instance.
static getSummarizedObjectiveStatusForLP($a_obj_id, array $a_objective_ids, $a_user_id=null)
static _lookupInProgressForObject($a_obj_id, $a_user_ids=null)
Get in progress users for object.
determineStatus($a_obj_id, $a_user_id, $a_obj=null)
Determine status.
static getMembers($a_obj_id)
Get members for object.
static _lookupFailedForObject($a_obj_id, $a_user_ids=null)
Get failed users for object.
static _lookupCompletedForObject($a_obj_id, $a_user_ids=null)
Get completed users for object.
static _getStatusInfo($a_obj_id)
Reads informations about the object e.g test results, tlt, number of visits.
static _getCompleted($a_obj_id)
Static function to read the users who have the status 'completed'.
static _getInProgress($a_obj_id)
Static function to read users who have the status 'in_progress'.
static _getFailed($a_obj_id)
Static function to read the users who have the status 'completed'.
Abstract class ilLPStatus for all learning progress modes E.g ilLPStatusManual, ilLPStatusObjectives ...
static _lookupStatusForObject($a_obj_id, $a_status, $a_user_ids=null)
Get users with given status for object.
const LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
$query
foreach($_POST as $key=> $value) $res
global $ilDB
$DIC
Definition: xapitoken.php:46