Collaboration diagram for ilExerciseMembers:

Public Member Functions
	__construct ($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 ()

Static Public Member Functions
static	_getMembers ($a_obj_id)

static	_lookupStatus ($a_obj_id, $a_user_id)
	Lookup current status (notgraded\|passed\|failed) More...

static	_writeStatus ($a_obj_id, $a_user_id, $a_status)
	Write user status. More...

static	_writeReturned ($a_obj_id, $a_user_id, $a_status)
	Write returned status. More...

static	_getReturned ($a_obj_id)
	Get returned status for all members (if they have anything returned for any assignment) More...

static	_hasReturned ($a_obj_id, $a_user_id)
	Has user returned anything in any assignment? More...

static	_getPassedUsers ($a_obj_id)
	Get all users that passed the exercise. More...

static	_getFailedUsers ($a_obj_id)
	Get all users that failed the exercise. More...

Data Fields
	$ref_id

	$obj_id

	$members

	$status

Protected Attributes
	$db

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.

Constructor & Destructor Documentation

◆ __construct()

ilExerciseMembers::__construct ( $a_exc )

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

References $DIC, and read().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->exc = $a_exc;
         $this->obj_id = $a_exc->getId();
         $this->ref_id = $a_exc->getRefId();
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getFailedUsers()

static ilExerciseMembers::_getFailedUsers ( $a_obj_id )

static

Get all users that failed the exercise.

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

References $DIC, $ilDB, $query, $res, $row, and array.

Referenced by ilLPStatusExerciseReturned\_getFailed().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT DISTINCT(usr_id) FROM exc_members " .
             "WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer") . " " .
             "AND status = " . $ilDB->quote("failed", "text");
         $res = $ilDB->query($query);
         while ($row = $ilDB->fetchObject($res)) {
             $usr_ids[] = $row->usr_id;
         }
         return $usr_ids ? $usr_ids : array();
     }

Here is the caller graph for this function:

◆ _getMembers()

static ilExerciseMembers::_getMembers ( $a_obj_id )

static

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

References $DIC, $ilDB, $query, $res, $row, and array.

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

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         // #14963 - see ilExAssignment::getMemberListData()
         $query = "SELECT DISTINCT(excm.usr_id) ud" .
             " FROM exc_members excm" .
             " JOIN object_data od ON (od.obj_id = excm.usr_id)" .
             " WHERE excm.obj_id = " . $ilDB->quote($a_obj_id, "integer") .
             " AND od.type = " . $ilDB->quote("usr", "text");
 
         $res = $ilDB->query($query);
         while ($row = $ilDB->fetchObject($res)) {
             $usr_ids[] = $row->ud;
         }
 
         return $usr_ids ? $usr_ids : array();
     }

Here is the caller graph for this function:

◆ _getPassedUsers()

static ilExerciseMembers::_getPassedUsers ( $a_obj_id )

static

Get all users that passed the exercise.

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

References $DIC, $ilDB, $query, $res, $row, and array.

Referenced by ilLPStatusExerciseReturned\_getCompleted().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT DISTINCT(usr_id) FROM exc_members " .
             "WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer") . " " .
             "AND status = " . $ilDB->quote("passed", "text");
         $res = $ilDB->query($query);
         while ($row = $ilDB->fetchObject($res)) {
             $usr_ids[] = $row->usr_id;
         }
         return $usr_ids ? $usr_ids : array();
     }

Here is the caller graph for this function:

◆ _getReturned()

static ilExerciseMembers::_getReturned ( $a_obj_id )

static

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

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

References $DIC, $ilDB, $query, $res, $row, and array.

Referenced by ilLPStatusExerciseReturned\_getInProgress().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT DISTINCT(usr_id) as ud FROM exc_members " .
             "WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer") . " " .
             "AND returned = 1";
 
         $res = $ilDB->query($query);
         while ($row = $ilDB->fetchObject($res)) {
             $usr_ids[] = $row->ud;
         }
 
         return $usr_ids ? $usr_ids : array();
     }

Here is the caller graph for this function:

◆ _hasReturned()

static ilExerciseMembers::_hasReturned	(	$a_obj_id,
		$a_user_id
	)

static

Has user returned anything in any assignment?

Parameters

integer	object id
integer	user id

Returns: boolean true/false

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

References $DIC, and $ilDB.

Referenced by ilLPStatusExerciseReturned\determineStatus().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
     
         $set = $ilDB->query(
             "SELECT DISTINCT(usr_id) FROM exc_members WHERE " .
             " obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
             " returned = " . $ilDB->quote(1, "integer") . " AND " .
             " usr_id = " . $ilDB->quote($a_user_id, "integer")
         );
         if ($rec = $ilDB->fetchAssoc($set)) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ _lookupStatus()

static ilExerciseMembers::_lookupStatus	(	$a_obj_id,
		$a_user_id
	)

static

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_id	exercise id
int	$a_user_id	member id

Returns: mixed false (if user is no member) or notgraded|passed|failed

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

References $DIC, $ilDB, $query, $res, and $row.

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

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT status FROM exc_members " .
             "WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer") .
             " AND usr_id = " . $ilDB->quote($a_user_id, "integer");
 
         $res = $ilDB->query($query);
         if ($row = $ilDB->fetchAssoc($res)) {
             return $row["status"];
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ _writeReturned()

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

static

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

int	exercise id
int	user id
text	status

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

References $DIC, $ilDB, and ilLPStatusWrapper\_updateStatus().

Referenced by ilObjExercise\processExerciseStatus().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $ilDB->manipulate(
             "UPDATE exc_members SET " .
             " returned = " . $ilDB->quote($a_status, "integer") .
             " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer") .
             " AND usr_id = " . $ilDB->quote($a_user_id, "integer")
         );
         
         include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
         ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _writeStatus()

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

static

Write user status.

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

Parameters

int	exercise id
int	user id
text	status

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

References $DIC, $ilDB, and ilLPStatusWrapper\_updateStatus().

Referenced by ilObjExercise\updateUserStatus().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $ilDB->manipulate(
             "UPDATE exc_members SET " .
             " status = " . $ilDB->quote($a_status, "text") .
             " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer") .
             " AND usr_id = " . $ilDB->quote($a_user_id, "integer")
         );
         
         include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
         ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
     }

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_id user id

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

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

Referenced by assignMembers().

     {
         $ilDB = $this->db;
 
         if ($this->exc->hasAddToDesktop()) {
             $tmp_user = ilObjectFactory::getInstanceByObjId($a_usr_id);
             $tmp_user->addDesktopItem($this->getRefId(), "exc");
         }
 
         $ilDB->manipulate("DELETE FROM exc_members " .
             "WHERE obj_id = " . $ilDB->quote($this->getObjId(), "integer") . " " .
             "AND usr_id = " . $ilDB->quote($a_usr_id, "integer") . " ");
 
         // @todo: some of this fields may not be needed anymore
         $ilDB->manipulateF(
             "INSERT INTO exc_members (obj_id, usr_id, status, sent, feedback) " .
             " VALUES (%s,%s,%s,%s,%s)",
             array("integer", "integer", "text", "integer", "integer"),
             array($this->getObjId(), $a_usr_id, 'notgraded', 0, 0)
         );
 
         include_once("./Modules/Exercise/classes/class.ilExAssignment.php");
         ilExAssignment::createNewUserRecords($a_usr_id, $this->getObjId());
         
         $this->read();
         
         include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
         ilLPStatusWrapper::_updateStatus($this->getObjId(), $a_usr_id);
 
         return true;
     }

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 127 of file class.ilExerciseMembers.php.

References assignMember(), and isAssigned().

     {
         $assigned = 0;
         if (is_array($a_members)) {
             foreach ($a_members as $member) {
                 if (!$this->isAssigned($member)) {
                     $this->assignMember($member);
                 } else {
                     ++$assigned;
                 }
             }
         }
         if ($assigned == count($a_members)) {
             return false;
         } else {
             return true;
         }
     }

Here is the call graph for this function:

◆ deassignMember()

ilExerciseMembers::deassignMember ( $a_usr_id )

Detaches a user from an exercise.

Parameters

int $a_usr_id user id

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

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

Referenced by deassignMembers().

     {
         $ilDB = $this->db;
 
         $tmp_user = ilObjectFactory::getInstanceByObjId($a_usr_id);
         $tmp_user->dropDesktopItem($this->getRefId(), "exc");
 
         $query = "DELETE FROM exc_members " .
             "WHERE obj_id = " . $ilDB->quote($this->getObjId(), "integer") . " " .
             "AND usr_id = " . $ilDB->quote($a_usr_id, "integer") . " ";
 
         $ilDB->manipulate($query);
         
         $this->read();
         
         include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
         ilLPStatusWrapper::_updateStatus($this->getObjId(), $a_usr_id);
         
         // delete all delivered files of the member
         include_once("./Modules/Exercise/classes/class.ilExSubmission.php");
         ilExSubmission::deleteUser($this->exc->getId(), $a_usr_id);
 
         // @todo: delete all assignment associations (and their files)
         
         return false;
     }

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 181 of file class.ilExerciseMembers.php.

References deassignMember().

     {
         if (is_array($a_members)) {
             foreach ($a_members as $member) {
                 $this->deassignMember($member);
             }
         } else {
             return false;
         }
     }

Here is the call graph for this function:

◆ delete()

ilExerciseMembers::delete ( )

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

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

     {
         $ilDB = $this->db;
 
         $query = "DELETE FROM exc_members WHERE obj_id = " .
             $ilDB->quote($this->getObjId(), "integer");
         $ilDB->manipulate($query);
         
         include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
         ilLPStatusWrapper::_refreshStatus($this->getObjId());
 
         return true;
     }

Here is the call graph for this function:

◆ getMembers()

ilExerciseMembers::getMembers ( )

Get members array.

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

References array.

Referenced by isAssigned().

     {
         return $this->members ? $this->members : array();
     }

Here is the caller graph for this function:

◆ getObjId()

ilExerciseMembers::getObjId ( )

Get exercise id.

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

References $obj_id.

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

     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getRefId()

ilExerciseMembers::getRefId ( )

Get exercise ref id.

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

References $ref_id.

Referenced by assignMember(), and deassignMember().

     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ ilClone()

ilExerciseMembers::ilClone ( $a_new_id )

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

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

     {
         $ilDB = $this->db;
 
         $data = array();
 
         $query = "SELECT * FROM exc_members " .
             "WHERE obj_id = " . $ilDB->quote($this->getObjId(), "integer");
 
         $res = $ilDB->query($query);
         while ($row = $ilDB->fetchObject($res)) {
             $data[] = array("usr_id" => $row->usr_id,
                             "notice" => $row->notice,
                             "returned" => $row->returned,
                             "status" => $row->status,
                             "sent"       => $row->sent,
                             "feedback"   => $row->feedback
                             );
         }
         foreach ($data as $row) {
             $ilDB->manipulateF(
                 "INSERT INTO exc_members " .
                 " (obj_id, usr_id, notice, returned, status, feedback, sent) VALUES " .
                 " (%s,%s,%s,%s,%s,%s,%s)",
                 array("integer", "integer", "text", "integer", "text", "integer", "integer"),
                 array($a_new_id, $row["usr_id"], $row["notice"], (int) $row["returned"],
                     $row["status"], (int) $row["feedback"], (int) $row["sent"])
             );
             
             include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
             ilLPStatusWrapper::_updateStatus($a_new_id, $row["usr_id"]);
         }
         return true;
     }

Here is the call graph for this function:

◆ isAssigned()

ilExerciseMembers::isAssigned ( $a_id )

Is user assigned to exercise?

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

References getMembers().

Referenced by assignMembers().

     {
         return in_array($a_id, $this->getMembers());
     }

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 195 of file class.ilExerciseMembers.php.

References $db, $ilDB, $query, $res, $row, ilObject\_lookupType(), array, getObjId(), and setMembers().

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

     {
         $ilDB = $this->db;
 
         $tmp_arr_members = array();
 
         $query = "SELECT * FROM exc_members " .
             "WHERE obj_id = " . $ilDB->quote($this->getObjId(), "integer");
 
         $res = $ilDB->query($query);
         while ($row = $ilDB->fetchObject($res)) {
             if (ilObject::_lookupType($row->usr_id) == "usr") {
                 $tmp_arr_members[] = $row->usr_id;
             }
         }
         $this->setMembers($tmp_arr_members);
 
         return true;
     }

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 74 of file class.ilExerciseMembers.php.

Referenced by read().

     {
         $this->members = $a_members;
     }

Here is the caller graph for this function:

◆ setObjId()

ilExerciseMembers::setObjId ( $a_obj_id )

Set exercise id.

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

     {
         $this->obj_id = $a_obj_id;
     }

Field Documentation

◆ $db

ilExerciseMembers::$db

protected

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

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

◆ $members

ilExerciseMembers::$members

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

◆ $obj_id

ilExerciseMembers::$obj_id

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

Referenced by getObjId().

◆ $ref_id

ilExerciseMembers::$ref_id

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

Referenced by getRefId().

◆ $status

ilExerciseMembers::$status

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

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

Modules/Exercise/classes/class.ilExerciseMembers.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getFailedUsers()

◆ _getMembers()

◆ _getPassedUsers()

◆ _getReturned()

◆ _hasReturned()

◆ _lookupStatus()

◆ _writeReturned()

◆ _writeStatus()

◆ assignMember()

◆ assignMembers()

◆ deassignMember()

◆ deassignMembers()

◆ delete()

◆ getMembers()

◆ getObjId()

◆ getRefId()

◆ ilClone()

◆ isAssigned()

◆ read()

◆ setMembers()

◆ setObjId()

Field Documentation

◆ $db

◆ $members

◆ $obj_id

◆ $ref_id

◆ $status