ilExerciseMembers Class Reference

Class ilExerciseMembers. More...

Collaboration diagram for ilExerciseMembers:

Public Member Functions
	__construct (ilObjExercise $a_exc)
	getRefId ()
	getObjId ()
	setObjId (int $a_obj_id)
	getMembers ()
	setMembers (array $a_members)
	assignMember (int $a_usr_id)
	Assign a user to the exercise. More...
	isAssigned (int $a_id)
	assignMembers (array $a_members)
	Assign members to exercise. More...
	deassignMember (int $a_usr_id)
	Detaches a user from an exercise. More...
	read ()
	ilClone (int $a_new_id)
	delete ()

Static Public Member Functions
static	_getMembers (int $a_obj_id)
static	_lookupStatus (int $a_obj_id, int $a_user_id)
	Lookup current status (notgraded|passed|failed) More...
static	_writeStatus (int $a_obj_id, int $a_user_id, string $a_status)
	Write user status This information is determined by the assignment status and saved redundantly in this table for performance reasons. More...
static	_writeReturned (int $a_obj_id, int $a_user_id, int $a_status)
	Write returned status. More...
static	_getReturned (int $a_obj_id)
	Get returned status for all members (if they have anything returned for any assignment) More...
static	_hasReturned (int $a_obj_id, int $a_user_id)
	Has user returned anything in any assignment? More...
static	_getPassedUsers (int $a_obj_id)
	Get all users that passed the exercise. More...
static	_getFailedUsers (int $a_obj_id)
	Get all users that failed the exercise. More...

Data Fields
int	$ref_id
int	$obj_id
array	$members
string	$status

Protected Attributes
IndividualDeadlineManager	$individual_deadlines
ilDBInterface	$db
ilRecommendedContentManager	$recommended_content_manager
ilObjExercise	$exc

Detailed Description

Class ilExerciseMembers.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilExerciseMembers::__construct

(

ilObjExercise

$a_exc

)

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

References $DIC, ilObject\getId(), ilObject\getRefId(), 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();
        $this->recommended_content_manager = new ilRecommendedContentManager();
        $this->individual_deadlines = $DIC->exercise()->internal()->domain()->individualDeadline();
    }

Here is the call graph for this function:

Member Function Documentation

_getFailedUsers()

static ilExerciseMembers::_getFailedUsers ( int  $a_obj_id )

static

Get all users that failed the exercise.

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

References $DIC, $ilDB, and $res.

Referenced by ilLPStatusExerciseReturned\_getFailed().

                                                         : array
    {
        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);
        $usr_ids = [];
        while ($row = $ilDB->fetchObject($res)) {
            $usr_ids[] = $row->usr_id;
        }
        return $usr_ids;
    }

Here is the caller graph for this function:

_getMembers()

static ilExerciseMembers::_getMembers ( int  $a_obj_id )

static

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

References $DIC, $ilDB, and $res.

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

                                                     : array
    {
        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);
        $usr_ids = [];
        while ($row = $ilDB->fetchObject($res)) {
            $usr_ids[] = $row->ud;
        }

        return $usr_ids;
    }

Here is the caller graph for this function:

_getPassedUsers()

static ilExerciseMembers::_getPassedUsers ( int  $a_obj_id )

static

Get all users that passed the exercise.

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

References $DIC, $ilDB, and $res.

Referenced by ilLPStatusExerciseReturned\_getCompleted().

                                                         : array
    {
        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);
        $usr_ids = [];
        while ($row = $ilDB->fetchObject($res)) {
            $usr_ids[] = $row->usr_id;
        }
        return $usr_ids;
    }

Here is the caller graph for this function:

_getReturned()

static ilExerciseMembers::_getReturned ( int  $a_obj_id )

static

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

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

References $DIC, $ilDB, and $res.

Referenced by ilLPStatusExerciseReturned\_getInProgress().

                                                      : array
    {
        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);
        $usr_ids = [];
        while ($row = $ilDB->fetchObject($res)) {
            $usr_ids[] = $row->ud;
        }

        return $usr_ids;
    }

Here is the caller graph for this function:

_hasReturned()

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

static

Has user returned anything in any assignment?

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

References $DIC, and $ilDB.

Referenced by ilLPStatusExerciseReturned\determineStatus().

                                                                      : bool
    {
        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")
        );
        return (bool) $ilDB->fetchAssoc($set);
    }

Here is the caller graph for this function:

_lookupStatus()

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

static

Lookup current status (notgraded|passed|failed)

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

Parameters

int	$a_obj_id	exercise id
int	$a_user_id	member id

Returns

?string null if user is no member, or notgraded|passed|failed

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

References $DIC, $ilDB, $res, and null.

Referenced by ilObjExerciseAccess\checkCondition(), ilLPStatusExerciseReturned\determineStatus(), ilObjExercise\exportGradesExcel(), ilExGradesTableGUI\fillRow(), and ILIAS\Exercise\Certificate\CertificateExerciseMembersHelper\lookUpStatus().

                                                                       : ?string
    {
        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 null;
    }

Here is the caller graph for this function:

_writeReturned()

static ilExerciseMembers::_writeReturned ( int  $a_obj_id, int  $a_user_id, int  $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

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

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

Referenced by ilObjExercise\processExerciseStatus().

     : void {
        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")
        );

        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 ( int  $a_obj_id, int  $a_user_id, string  $a_status  )

static

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

See ilObjExercise->updateUserStatus().

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

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

Referenced by ilObjExercise\updateUserStatus().

     : void {
        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")
        );

        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

(

int

$a_usr_id

)

Assign a user to the exercise.

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

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

Referenced by assignMembers().

                                               : void
    {
        $ilDB = $this->db;

        $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)
        );

        ilExAssignment::createNewUserRecords($a_usr_id, $this->getObjId());

        $this->read();

        ilLPStatusWrapper::_updateStatus($this->getObjId(), $a_usr_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

assignMembers()

ilExerciseMembers::assignMembers

(

array

$a_members

)

Assign members to exercise.

Parameters

int[]

$a_members

Returns

bool true, if all passed users could be assigned, false otherwise

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

References assignMember(), and isAssigned().

                                                   : bool
    {
        $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

(

int

$a_usr_id

)

Detaches a user from an exercise.

Exceptions

ilExcUnknownAssignmentTypeException

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

References $db, $ilDB, ilLPStatusWrapper\_updateStatus(), ilExSubmission\deleteUser(), ilExcIndividualDeadline\getInstance(), ilExAssignment\getInstancesByExercise(), getObjId(), getRefId(), and read().

                                                 : void
    {
        $ilDB = $this->db;

        $this->recommended_content_manager->removeObjectRecommendation($a_usr_id, $this->getRefId());
        $this->individual_deadlines->deleteAllOfUserInExercise($this->getObjId(), $a_usr_id, false);

        $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();

        ilLPStatusWrapper::_updateStatus($this->getObjId(), $a_usr_id);

        // delete all delivered files of the member
        ilExSubmission::deleteUser($this->exc->getId(), $a_usr_id);

        // delete individual deadline/starting time entries
        foreach (ilExAssignment::getInstancesByExercise($this->exc->getId()) as $ass) {
            $idl = ilExcIndividualDeadline::getInstance($ass->getId(), $a_usr_id, false);
            $idl->delete();
        }

        // @todo: delete all assignment associations (and their files)
    }

Here is the call graph for this function:

delete()

ilExerciseMembers::delete

(

)

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

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

                            : void
    {
        $ilDB = $this->db;

        $query = "DELETE FROM exc_members WHERE obj_id = " .
            $ilDB->quote($this->getObjId(), "integer");
        $ilDB->manipulate($query);

        ilLPStatusWrapper::_refreshStatus($this->getObjId());
    }

Here is the call graph for this function:

getMembers()

ilExerciseMembers::getMembers

(

)

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

Referenced by ilExGradesTableGUI\__construct(), and isAssigned().

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

Here is the caller graph for this function:

getObjId()

ilExerciseMembers::getObjId

(

)

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

References $obj_id.

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

                              : int
    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

getRefId()

ilExerciseMembers::getRefId

(

)

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

References $ref_id.

Referenced by deassignMember().

                              : int
    {
        return $this->ref_id;
    }

Here is the caller graph for this function:

ilClone()

ilExerciseMembers::ilClone

(

int

$a_new_id

)

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

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

                                          : void
    {
        $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"])
            );

            ilLPStatusWrapper::_updateStatus($a_new_id, $row["usr_id"]);
        }
    }

Here is the call graph for this function:

isAssigned()

ilExerciseMembers::isAssigned

(

int

$a_id

)

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

References getMembers().

Referenced by assignMembers().

                                         : bool
    {
        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

(

)

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

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

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

                          : void
    {
        $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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setMembers()

ilExerciseMembers::setMembers

(

array

$a_members

)

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

Referenced by read().

                                                : void
    {
        $this->members = $a_members;
    }

Here is the caller graph for this function:

setObjId()

ilExerciseMembers::setObjId

(

int

$a_obj_id

)

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

                                           : void
    {
        $this->obj_id = $a_obj_id;
    }

Field Documentation

$db

ilDBInterface ilExerciseMembers::$db

protected

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

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

$exc

ilObjExercise ilExerciseMembers::$exc

protected

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

$individual_deadlines

IndividualDeadlineManager ilExerciseMembers::$individual_deadlines

protected

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

$members

array ilExerciseMembers::$members

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

$obj_id

int ilExerciseMembers::$obj_id

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

Referenced by getObjId().

$recommended_content_manager

ilRecommendedContentManager ilExerciseMembers::$recommended_content_manager

protected

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

$ref_id

int ilExerciseMembers::$ref_id

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

Referenced by getRefId().

$status

string ilExerciseMembers::$status

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

---

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

• components/ILIAS/Exercise/Members/classes/class.ilExerciseMembers.php