ILIAS  release_4-4 Revision
ilExerciseMembers Class Reference

Class ilExerciseMembers. More...

+ Collaboration diagram for ilExerciseMembers:

Public Member Functions

 ilExerciseMembers ($a_exc)
 
 getRefId ()
 Get exercise ref id. More...
 
 getObjId ()
 Get exercise id. More...
 
 setObjId ($a_obj_id)
 Set exercise id. More...
 
 getMembers ()
 Get members array. More...
 
 setMembers ($a_members)
 Set members array. More...
 
 assignMember ($a_usr_id)
 Assign a user to the exercise. More...
 
 isAssigned ($a_id)
 Is user assigned to exercise? More...
 
 assignMembers ($a_members)
 Assign members to exercise. More...
 
 deassignMember ($a_usr_id)
 Detaches a user from an exercise. More...
 
 deassignMembers ($a_members)
 Deassign members. More...
 
 read ()
 Read all members. More...
 
 ilClone ($a_new_id)
 
 delete ()
 
 _getMembers ($a_obj_id)
 
 _getReturned ($a_obj_id)
 Get returned status for all members (if they have anything returned for any assignment) More...
 
 _hasReturned ($a_obj_id, $a_user_id)
 Has user returned anything in any assignment? More...
 
 _getPassedUsers ($a_obj_id)
 Get all users that passed the exercise. More...
 
 _getFailedUsers ($a_obj_id)
 Get all users that failed the exercise. More...
 
 _lookupStatus ($a_obj_id, $a_user_id)
 Lookup current status (notgraded|passed|failed) More...
 
 _writeStatus ($a_obj_id, $a_user_id, $a_status)
 Write user status. More...
 
 _writeReturned ($a_obj_id, $a_user_id, $a_status)
 Write returned status. More...
 

Data Fields

 $ref_id
 
 $obj_id
 
 $members
 
 $status
 

Detailed Description

Class ilExerciseMembers.

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

Definition at line 12 of file class.ilExerciseMembers.php.

Member Function Documentation

◆ _getFailedUsers()

ilExerciseMembers::_getFailedUsers (   $a_obj_id)

Get all users that failed the exercise.

Definition at line 351 of file class.ilExerciseMembers.php.

References $query, $res, and $row.

Referenced by ilLPStatusExerciseReturned\_getFailed().

352  {
353  global $ilDB;
354 
355  $query = "SELECT DISTINCT(usr_id) FROM exc_members ".
356  "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer")." ".
357  "AND status = ".$ilDB->quote("failed", "text");
358  $res = $ilDB->query($query);
359  while($row = $ilDB->fetchObject($res))
360  {
361  $usr_ids[] = $row->usr_id;
362  }
363  return $usr_ids ? $usr_ids : array();
364  }
+ Here is the caller graph for this function:

◆ _getMembers()

ilExerciseMembers::_getMembers (   $a_obj_id)

Definition at line 265 of file class.ilExerciseMembers.php.

References $query, $res, and $row.

Referenced by ilLPStatusExerciseReturned\getMembers(), ilExerciseXMLWriter\handleAssignmentMembers(), and ilExAssignment\sendFeedbackNotifications().

266  {
267  global $ilDB;
268 
269  // #14963 - see ilExAssignment::getMemberListData()
270  $query = "SELECT DISTINCT(excm.usr_id) ud".
271  " FROM exc_members excm".
272  " JOIN object_data od ON (od.obj_id = excm.usr_id)".
273  " WHERE excm.obj_id = ".$ilDB->quote($a_obj_id, "integer").
274  " AND od.type = ".$ilDB->quote("usr", "text");
275 
276  $res = $ilDB->query($query);
277  while($row = $ilDB->fetchObject($res))
278  {
279  $usr_ids[] = $row->ud;
280  }
281 
282  return $usr_ids ? $usr_ids : array();
283  }
+ Here is the caller graph for this function:

◆ _getPassedUsers()

ilExerciseMembers::_getPassedUsers (   $a_obj_id)

Get all users that passed the exercise.

Definition at line 333 of file class.ilExerciseMembers.php.

References $query, $res, and $row.

Referenced by ilLPStatusExerciseReturned\_getCompleted().

334  {
335  global $ilDB;
336 
337  $query = "SELECT DISTINCT(usr_id) FROM exc_members ".
338  "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer")." ".
339  "AND status = ".$ilDB->quote("passed", "text");
340  $res = $ilDB->query($query);
341  while($row = $ilDB->fetchObject($res))
342  {
343  $usr_ids[] = $row->usr_id;
344  }
345  return $usr_ids ? $usr_ids : array();
346  }
+ Here is the caller graph for this function:

◆ _getReturned()

ilExerciseMembers::_getReturned (   $a_obj_id)

Get returned status for all members (if they have anything returned for any assignment)

Definition at line 290 of file class.ilExerciseMembers.php.

References $query, $res, and $row.

Referenced by ilLPStatusExerciseReturned\_getInProgress().

291  {
292  global $ilDB;
293 
294  $query = "SELECT DISTINCT(usr_id) as ud FROM exc_members ".
295  "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer")." ".
296  "AND returned = 1";
297 
298  $res = $ilDB->query($query);
299  while($row = $ilDB->fetchObject($res))
300  {
301  $usr_ids[] = $row->ud;
302  }
303 
304  return $usr_ids ? $usr_ids : array();
305  }
+ Here is the caller graph for this function:

◆ _hasReturned()

ilExerciseMembers::_hasReturned (   $a_obj_id,
  $a_user_id 
)

Has user returned anything in any assignment?

Parameters
integerobject id
integeruser id
Returns
boolean true/false

Definition at line 314 of file class.ilExerciseMembers.php.

Referenced by ilLPStatusExerciseReturned\determineStatus().

315  {
316  global $ilDB;
317 
318  $set = $ilDB->query("SELECT DISTINCT(usr_id) FROM exc_members WHERE ".
319  " obj_id = ".$ilDB->quote($a_obj_id, "integer")." AND ".
320  " returned = ".$ilDB->quote(1, "integer")." AND ".
321  " usr_id = ".$ilDB->quote($a_user_id, "integer")
322  );
323  if ($rec = $ilDB->fetchAssoc($set))
324  {
325  return true;
326  }
327  return false;
328  }
+ Here is the caller graph for this function:

◆ _lookupStatus()

ilExerciseMembers::_lookupStatus (   $a_obj_id,
  $a_user_id 
)

Lookup current status (notgraded|passed|failed)

This information is determined by the assignment status and saved redundtantly in this table for performance reasons.

Parameters
int$a_obj_idexercise id
int$a_user_idmember id
Returns
mixed false (if user is no member) or notgraded|passed|failed

Definition at line 376 of file class.ilExerciseMembers.php.

References $query, $res, and $row.

Referenced by ilObjExercise\_checkCondition(), ilLPStatusExerciseReturned\determineStatus(), ilObjExercise\exportGradesExcel(), ilExGradesTableGUI\fillRow(), ilExerciseCertificateAdapter\getCertificateVariablesForPresentation(), and ilObjExercise\hasUserCertificate().

377  {
378  global $ilDB;
379 
380  $query = "SELECT status FROM exc_members ".
381  "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer").
382  " AND usr_id = ".$ilDB->quote($a_user_id, "integer");
383 
384  $res = $ilDB->query($query);
385  if($row = $ilDB->fetchAssoc($res))
386  {
387  return $row["status"];
388  }
389 
390  return false;
391  }
+ Here is the caller graph for this function:

◆ _writeReturned()

ilExerciseMembers::_writeReturned (   $a_obj_id,
  $a_user_id,
  $a_status 
)

Write returned status.

The returned status is initially 0. If the first file is returned by a user for any assignment of the exercise, the returned status is set to 1 and it will stay that way, even if this file is deleted again. -> learning progress uses this to determine "in progress" status

Parameters
intexercise id
intuser id
textstatus

Definition at line 430 of file class.ilExerciseMembers.php.

References ilLPStatusWrapper\_updateStatus().

Referenced by ilObjExercise\addResourceObject(), ilObjExerciseGUI\addTeamMemberActionObject(), ilObjExercise\deliverFile(), ilObjExercise\processUploadedFile(), and ilObjExerciseGUI\removeTeamMemberObject().

431  {
432  global $ilDB;
433 
434  $ilDB->manipulate("UPDATE exc_members SET ".
435  " returned = ".$ilDB->quote($a_status, "text").
436  " WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer").
437  " AND usr_id = ".$ilDB->quote($a_user_id, "integer")
438  );
439 
440  include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
441  ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
442  }
static _updateStatus($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_no_raise=false, $a_force_raise=false)
Update status.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _writeStatus()

ilExerciseMembers::_writeStatus (   $a_obj_id,
  $a_user_id,
  $a_status 
)

Write user status.

This information is determined by the assignment status and saved redundtantly in this table for performance reasons. See ilObjExercise->updateUserStatus().

Parameters
intexercise id
intuser id
textstatus

Definition at line 404 of file class.ilExerciseMembers.php.

References ilLPStatusWrapper\_updateStatus().

Referenced by ilObjExercise\updateUserStatus().

405  {
406  global $ilDB;
407 
408  $ilDB->manipulate("UPDATE exc_members SET ".
409  " status = ".$ilDB->quote($a_status, "text").
410  " WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer").
411  " AND usr_id = ".$ilDB->quote($a_user_id, "integer")
412  );
413 
414  include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
415  ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
416  }
static _updateStatus($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_no_raise=false, $a_force_raise=false)
Update status.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ assignMember()

ilExerciseMembers::assignMember (   $a_usr_id)

Assign a user to the exercise.

Parameters
int$a_usr_iduser id

Definition at line 76 of file class.ilExerciseMembers.php.

References ilLPStatusWrapper\_updateStatus(), ilExAssignment\createNewUserRecords(), ilObjectFactory\getInstanceByObjId(), getObjId(), getRefId(), and read().

Referenced by assignMembers().

77  {
78  global $ilDB;
79 
80  $tmp_user = ilObjectFactory::getInstanceByObjId($a_usr_id);
81  $tmp_user->addDesktopItem($this->getRefId(),"exc");
82 
83  $ilDB->manipulate("DELETE FROM exc_members ".
84  "WHERE obj_id = ".$ilDB->quote($this->getObjId(), "integer")." ".
85  "AND usr_id = ".$ilDB->quote($a_usr_id, "integer")." ");
86 
87 // @todo: some of this fields may not be needed anymore
88  $ilDB->manipulateF("INSERT INTO exc_members (obj_id, usr_id, status, sent, feedback) ".
89  " VALUES (%s,%s,%s,%s,%s)",
90  array("integer", "integer", "text", "integer", "integer"),
91  array($this->getObjId(), $a_usr_id, 'notgraded', 0, 0));
92 
93  include_once("./Modules/Exercise/classes/class.ilExAssignment.php");
95 
96  $this->read();
97 
98  include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
99  ilLPStatusWrapper::_updateStatus($this->getObjId(), $a_usr_id);
100 
101  return true;
102  }
static _updateStatus($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_no_raise=false, $a_force_raise=false)
Update status.
getRefId()
Get exercise ref id.
getObjId()
Get exercise id.
getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
read()
Read all members.
static createNewUserRecords($a_user_id, $a_exc_id)
Create member status record for a new participant for all assignments.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ assignMembers()

ilExerciseMembers::assignMembers (   $a_members)

Assign members to exercise.

Definition at line 115 of file class.ilExerciseMembers.php.

References assignMember(), and isAssigned().

116  {
117  $assigned = 0;
118  if(is_array($a_members))
119  {
120  foreach($a_members as $member)
121  {
122  if(!$this->isAssigned($member))
123  {
124  $this->assignMember($member);
125  }
126  else
127  {
128  ++$assigned;
129  }
130  }
131  }
132  if($assigned == count($a_members))
133  {
134  return false;
135  }
136  else
137  {
138  return true;
139  }
140  }
isAssigned($a_id)
Is user assigned to exercise?
assignMember($a_usr_id)
Assign a user to the exercise.
+ Here is the call graph for this function:

◆ deassignMember()

ilExerciseMembers::deassignMember (   $a_usr_id)

Detaches a user from an exercise.

Parameters
int$a_usr_iduser id

Definition at line 147 of file class.ilExerciseMembers.php.

References $query, ilLPStatusWrapper\_updateStatus(), ilObjectFactory\getInstanceByObjId(), getObjId(), getRefId(), and read().

Referenced by deassignMembers().

148  {
149  global $ilDB;
150 
151  $tmp_user = ilObjectFactory::getInstanceByObjId($a_usr_id);
152  $tmp_user->dropDesktopItem($this->getRefId(),"exc");
153 
154  $query = "DELETE FROM exc_members ".
155  "WHERE obj_id = ".$ilDB->quote($this->getObjId(), "integer")." ".
156  "AND usr_id = ".$ilDB->quote($a_usr_id, "integer")." ";
157 
158  $ilDB->manipulate($query);
159 
160  $this->read();
161 
162  include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
163  ilLPStatusWrapper::_updateStatus($this->getObjId(), $a_usr_id);
164 
165  // delete all delivered files of the member
166  $this->exc->deleteAllDeliveredFilesOfUser($a_usr_id);
167 
168 // @todo: delete all assignment associations (and their files)
169 
170  return false;
171  }
static _updateStatus($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_no_raise=false, $a_force_raise=false)
Update status.
getRefId()
Get exercise ref id.
getObjId()
Get exercise id.
getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
read()
Read all members.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ deassignMembers()

ilExerciseMembers::deassignMembers (   $a_members)

Deassign members.

Definition at line 176 of file class.ilExerciseMembers.php.

References deassignMember().

177  {
178  if(is_array($a_members))
179  {
180  foreach($a_members as $member)
181  {
182  $this->deassignMember($member);
183  }
184  }
185  else
186  {
187  return false;
188  }
189  }
deassignMember($a_usr_id)
Detaches a user from an exercise.
+ Here is the call graph for this function:

◆ delete()

ilExerciseMembers::delete ( )

Definition at line 251 of file class.ilExerciseMembers.php.

References $query, ilLPStatusWrapper\_refreshStatus(), and getObjId().

252  {
253  global $ilDB;
254 
255  $query = "DELETE FROM exc_members WHERE obj_id = ".
256  $ilDB->quote($this->getObjId(), "integer");
257  $ilDB->manipulate($query);
258 
259  include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
261 
262  return true;
263  }
getObjId()
Get exercise id.
_refreshStatus($a_obj_id, $a_users=null)
Set dirty.
+ Here is the call graph for this function:

◆ getMembers()

ilExerciseMembers::getMembers ( )

Get members array.

Definition at line 58 of file class.ilExerciseMembers.php.

Referenced by isAssigned().

59  {
60  return $this->members ? $this->members : array();
61  }
+ Here is the caller graph for this function:

◆ getObjId()

ilExerciseMembers::getObjId ( )

Get exercise id.

Definition at line 42 of file class.ilExerciseMembers.php.

References $obj_id.

Referenced by assignMember(), deassignMember(), delete(), ilClone(), and read().

43  {
44  return $this->obj_id;
45  }
+ Here is the caller graph for this function:

◆ getRefId()

ilExerciseMembers::getRefId ( )

Get exercise ref id.

Definition at line 34 of file class.ilExerciseMembers.php.

References $ref_id.

Referenced by assignMember(), and deassignMember().

35  {
36  return $this->ref_id;
37  }
+ Here is the caller graph for this function:

◆ ilClone()

ilExerciseMembers::ilClone (   $a_new_id)

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

References $data, $query, $res, $row, ilLPStatusWrapper\_updateStatus(), and getObjId().

215  {
216  global $ilDB;
217 
218  $data = array();
219 
220  $query = "SELECT * FROM exc_members ".
221  "WHERE obj_id = ".$ilDB->quote($this->getObjId(), "integer");
222 
223  $res = $ilDB->query($query);
224  while($row = $ilDB->fetchObject($res))
225  {
226  $data[] = array("usr_id" => $row->usr_id,
227  "notice" => $row->notice,
228  "returned" => $row->returned,
229  "status" => $row->status,
230  "sent" => $row->sent,
231  "feedback" => $row->feedback
232  );
233  }
234  foreach($data as $row)
235  {
236  $ilDB->manipulateF("INSERT INTO exc_members ".
237  " (obj_id, usr_id, notice, returned, status, feedback, sent) VALUES ".
238  " (%s,%s,%s,%s,%s,%s,%s)",
239  array ("integer", "integer", "text", "integer", "text", "integer", "integer"),
240  array ($a_new_id, $row["usr_id"], $row["notice"], (int) $row["returned"],
241  $row["status"], (int) $row["feedback"], (int) $row["sent"])
242  );
243 
244  include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
245  ilLPStatusWrapper::_updateStatus($a_new_id, $row["usr_id"]);
246  }
247  return true;
248  }
static _updateStatus($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_no_raise=false, $a_force_raise=false)
Update status.
getObjId()
Get exercise id.
while($lm_rec=$ilDB->fetchAssoc($lm_set)) $data
+ Here is the call graph for this function:

◆ ilExerciseMembers()

ilExerciseMembers::ilExerciseMembers (   $a_exc)

Definition at line 23 of file class.ilExerciseMembers.php.

References read().

24  {
25  $this->exc = $a_exc;
26  $this->obj_id = $a_exc->getId();
27  $this->ref_id = $a_exc->getRefId();
28  $this->read();
29  }
read()
Read all members.
+ Here is the call graph for this function:

◆ isAssigned()

ilExerciseMembers::isAssigned (   $a_id)

Is user assigned to exercise?

Definition at line 107 of file class.ilExerciseMembers.php.

References getMembers().

Referenced by assignMembers().

108  {
109  return in_array($a_id,$this->getMembers());
110  }
getMembers()
Get members array.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ read()

ilExerciseMembers::read ( )

Read all members.

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

References $query, $res, $row, getObjId(), and setMembers().

Referenced by assignMember(), deassignMember(), and ilExerciseMembers().

195  {
196  global $ilDB;
197 
198  $tmp_arr_members = array();
199 
200  $query = "SELECT * FROM exc_members ".
201  "WHERE obj_id = ".$ilDB->quote($this->getObjId(), "integer");
202 
203  $res = $ilDB->query($query);
204  while($row = $ilDB->fetchObject($res))
205  {
206  $tmp_arr_members[] = $row->usr_id;
207  }
208  $this->setMembers($tmp_arr_members);
209 
210  return true;
211  }
getObjId()
Get exercise id.
setMembers($a_members)
Set members array.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setMembers()

ilExerciseMembers::setMembers (   $a_members)

Set members array.

Definition at line 66 of file class.ilExerciseMembers.php.

Referenced by read().

67  {
68  $this->members = $a_members;
69  }
+ Here is the caller graph for this function:

◆ setObjId()

ilExerciseMembers::setObjId (   $a_obj_id)

Set exercise id.

Definition at line 50 of file class.ilExerciseMembers.php.

51  {
52  $this->obj_id = $a_obj_id;
53  }

Field Documentation

◆ $members

ilExerciseMembers::$members

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

◆ $obj_id

ilExerciseMembers::$obj_id

Definition at line 15 of file class.ilExerciseMembers.php.

Referenced by getObjId().

◆ $ref_id

ilExerciseMembers::$ref_id

Definition at line 14 of file class.ilExerciseMembers.php.

Referenced by getRefId().

◆ $status

ilExerciseMembers::$status

Definition at line 17 of file class.ilExerciseMembers.php.


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