Exercise assignment team. More...

Collaboration diagram for ilExAssignmentTeam:

Public Member Functions
	__construct ($a_id=null)

	getId ()

	getMembers ()
	Get members of assignment team. More...

	getMembersOfAllTeams ()
	Get members for all teams of assignment. More...

	addTeamMember ($a_user_id, $a_exc_ref_id=null)
	Add new member to team. More...

	removeTeamMember ($a_user_id, $a_exc_ref_id=null)
	Remove member from team. More...

	writeLog ($a_action, $a_details=null)

	getLog ()
	Get all log entries for team. More...

	sendNotification ($a_exc_ref_id, $a_user_id, $a_action)
	Send notification about team status. More...

Static Public Member Functions
static	getInstanceByUserId ($a_assignment_id, $a_user_id, $a_create_on_demand=false)

static	getInstancesFromMap ($a_assignment_id)

static	getTeamId ($a_assignment_id, $a_user_id, $a_create_on_demand=false)
	Get team id for member id. More...

static	getAssignmentTeamMap ($a_ass_id)
	Get team structure for assignment. More...

static	writeTeamLog ($a_team_id, $a_action, $a_details=null)
	Add entry to team log. More...

static	getAdoptableTeamAssignments ($a_exercise_id, $a_exclude_ass_id=null, $a_user_id=null)

static	adoptTeams ($a_source_ass_id, $a_target_ass_id, $a_user_id=null, $a_exc_ref_id=null)

static	getAdoptableGroups ($a_exc_ref_id)

static	getGroupMembersMap ($a_exc_ref_id)

Data Fields
const	TEAM_LOG_CREATE_TEAM = 1

const	TEAM_LOG_ADD_MEMBER = 2

const	TEAM_LOG_REMOVE_MEMBER = 3

const	TEAM_LOG_ADD_FILE = 4

const	TEAM_LOG_REMOVE_FILE = 5

Protected Member Functions
	read ($a_id)

	cleanLog ()
	Remove obsolete log entries. More...

Protected Attributes
	$db

	$user

	$id

	$assignment_id

	$members = array()

Detailed Description

Exercise assignment team.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 10 of file class.ilExAssignmentTeam.php.

Constructor & Destructor Documentation

◆ __construct()

ilExAssignmentTeam::__construct ( $a_id = null )

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

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->user = $DIC->user();
        if ($a_id) {
            $this->read($a_id);
        }
    }

References $DIC, read(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ addTeamMember()

ilExAssignmentTeam::addTeamMember	(	$a_user_id,
		$a_exc_ref_id = `null`
	)

Add new member to team.

Parameters

int	$a_user_id
int	$a_exc_ref_id

Definition at line 172 of file class.ilExAssignmentTeam.php.

    {
        $ilDB = $this->db;
        
        if (!$this->id) {
            return false;
        }
        
        // must not be in any team already
        if (!in_array($a_user_id, $this->getMembersOfAllTeams())) {
            $fields = array("id" => array("integer", $this->id),
                "ass_id" => array("integer", $this->assignment_id),
                "user_id" => array("integer", $a_user_id));
            $ilDB->insert("il_exc_team", $fields);
            
            if ($a_exc_ref_id) {
                $this->sendNotification($a_exc_ref_id, $a_user_id, "add");
            }
            
            $this->writeLog(
                self::TEAM_LOG_ADD_MEMBER,
                ilObjUser::_lookupFullname($a_user_id)
            );
            
            $this->read($this->id);
            
            return true;
        }
        
        return false;
    }

References $db, $ilDB, ilObjUser\_lookupFullname(), getMembersOfAllTeams(), read(), sendNotification(), and writeLog().

Here is the call graph for this function:

◆ adoptTeams()

static ilExAssignmentTeam::adoptTeams	(	$a_source_ass_id,
		$a_target_ass_id,
		$a_user_id = `null`,
		$a_exc_ref_id = `null`
	)

static

Definition at line 426 of file class.ilExAssignmentTeam.php.

    {
        $teams = array();
        
        $old_team = null;
        foreach (self::getAssignmentTeamMap($a_source_ass_id) as $user_id => $team_id) {
            $teams[$team_id][] = $user_id;
                        
            if ($a_user_id && $user_id == $a_user_id) {
                $old_team = $team_id;
            }
        }
        
        if ($a_user_id) {
            // no existing team (in source) or user already in team (in current)
            if (!$old_team ||
                self::getInstanceByUserId($a_target_ass_id, $a_user_id)->getId()) {
                return;
            }
        }
        
        $current_map = self::getAssignmentTeamMap($a_target_ass_id);
        
        foreach ($teams as $team_id => $user_ids) {
            if (!$old_team || $team_id == $old_team) {
                // only not assigned users
                $missing = array();
                foreach ($user_ids as $user_id) {
                    if (!array_key_exists($user_id, $current_map)) {
                        $missing[] = $user_id;
                    }
                }
                
                if (sizeof($missing)) {
                    // create new team
                    $first = array_shift($missing);
                    $new_team = self::getInstanceByUserId($a_target_ass_id, $first, true);
 
                    if ($a_exc_ref_id) {
                        // getTeamId() does NOT send notification
                        $new_team->sendNotification($a_exc_ref_id, $first, "add");
                    }
                
                    foreach ($missing as $user_id) {
                        $new_team->addTeamMember($user_id, $a_exc_ref_id);
                    }
                }
            }
        }
    }

References getAssignmentTeamMap(), getId(), and getInstanceByUserId().

Referenced by ilExAssignmentEditorGUI\adoptTeamAssignmentsObject(), and ilExSubmissionTeamGUI\createAdoptedTeamObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cleanLog()

ilExAssignmentTeam::cleanLog ( )

protected

Remove obsolete log entries.

As there is no proper team deletion event, we are doing it this way

Definition at line 321 of file class.ilExAssignmentTeam.php.

    {
        $ilDB = $this->db;
        
        // #18179
        
        $teams = array();
        $set = $ilDB->query("SELECT DISTINCT(id)" .
            " FROM il_exc_team");
        while ($row = $ilDB->fetchAssoc($set)) {
            $teams[] = $row["id"];
        }
        
        $set = $ilDB->query("SELECT DISTINCT(team_id)" .
            " FROM il_exc_team_log");
        while ($row = $ilDB->fetchAssoc($set)) {
            $team_id = $row["team_id"];
            if (!in_array($team_id, $teams)) {
                $ilDB->manipulate("DELETE FROM il_exc_team_log" .
                    " WHERE team_id = " . $ilDB->quote($team_id, "integer"));
            }
        }
    }

References $db, $ilDB, and $row.

Referenced by getLog().

Here is the caller graph for this function:

◆ getAdoptableGroups()

static ilExAssignmentTeam::getAdoptableGroups ( $a_exc_ref_id )

static

Definition at line 481 of file class.ilExAssignmentTeam.php.

    {
        global $DIC;
 
        $tree = $DIC->repositoryTree();
        
        $res = array();
                
        $parent_ref_id = $tree->getParentId($a_exc_ref_id);
        if ($parent_ref_id) {
            foreach ($tree->getChildsByType($parent_ref_id, "grp") as $group) {
                $res[] = $group["obj_id"];
            }
        }
        
        return $res;
    }

References $DIC, and $res.

Referenced by ilExerciseManagementGUI\membersObject().

Here is the caller graph for this function:

◆ getAdoptableTeamAssignments()

static ilExAssignmentTeam::getAdoptableTeamAssignments	(	$a_exercise_id,
		$a_exclude_ass_id = `null`,
		$a_user_id = `null`
	)

static

Definition at line 378 of file class.ilExAssignmentTeam.php.

    {
        $res = array();
        
        $data = ilExAssignment::getAssignmentDataOfExercise($a_exercise_id);
        foreach ($data as $row) {
            if ($a_exclude_ass_id && $row["id"] == $a_exclude_ass_id) {
                continue;
            }
            
            if ($row["type"] == ilExAssignment::TYPE_UPLOAD_TEAM) {
                $map = self::getAssignmentTeamMap($row["id"]);
                
                if ($a_user_id && !array_key_exists($a_user_id, $map)) {
                    continue;
                }
                
                if (sizeof($map)) {
                    $user_team = null;
                    if ($a_user_id) {
                        $user_team_id = $map[$a_user_id];
                        $user_team = array();
                        foreach ($map as $user_id => $team_id) {
                            if ($user_id != $a_user_id &&
                                $user_team_id == $team_id) {
                                $user_team[] = $user_id;
                            }
                        }
                    }
                    
                    if (!$a_user_id ||
                        sizeof($user_team)) {
                        $res[$row["id"]] = array(
                            "title" => $row["title"],
                            "teams" => sizeof(array_flip($map)),
                        );
                        
                        if ($a_user_id) {
                            $res[$row["id"]]["user_team"] = $user_team;
                        }
                    }
                }
            }
        }
        
        return ilUtil::sortArray($res, "title", "asc", false, true);
    }

References $data, $res, $row, ilExAssignment\getAssignmentDataOfExercise(), getAssignmentTeamMap(), ilUtil\sortArray(), and ilExAssignment\TYPE_UPLOAD_TEAM.

Referenced by ilExAssignmentEditorGUI\adoptTeamAssignmentsFormObject(), ilExSubmissionTeamGUI\createTeamObject(), and ilExAssignmentEditorGUI\saveAssignmentObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentTeamMap()

static ilExAssignmentTeam::getAssignmentTeamMap ( $a_ass_id )

static

Get team structure for assignment.

Parameters

int $a_ass_id

Returns: array

Definition at line 242 of file class.ilExAssignmentTeam.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $map = array();
        
        $sql = "SELECT * FROM il_exc_team" .
            " WHERE ass_id = " . $ilDB->quote($a_ass_id, "integer");
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $map[$row["user_id"]] = $row["id"];
        }
        
        return $map;
    }

References $DIC, $ilDB, and $row.

Referenced by adoptTeams(), ilExSubmissionTeamGUI\createTeamObject(), ilExerciseManagementGUI\createTeamsFromGroupsObject(), ilExSubmission\downloadAllAssignmentFiles(), getAdoptableTeamAssignments(), and ilExerciseMemberTableGUI\parseData().

Here is the caller graph for this function:

◆ getGroupMembersMap()

static ilExAssignmentTeam::getGroupMembersMap ( $a_exc_ref_id )

static

Definition at line 499 of file class.ilExAssignmentTeam.php.

    {
        $res = array();
        
        include_once "Modules/Group/classes/class.ilGroupParticipants.php";
        foreach (self::getAdoptableGroups($a_exc_ref_id) as $grp_obj_id) {
            $members_obj = new ilGroupParticipants($grp_obj_id);
            
            $res[$grp_obj_id] = array(
                "title" => ilObject::_lookupTitle($grp_obj_id)
                ,"members" =>  $members_obj->getMembers()
            );
        }
        
        return ilUtil::sortArray($res, "title", "asc", false, true);
    }

References $res, ilObject\_lookupTitle(), and ilUtil\sortArray().

Referenced by ilExerciseManagementGUI\createTeamsFromGroupsObject(), and ilExerciseManagementGUI\initGroupForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilExAssignmentTeam::getId ( )

Definition at line 68 of file class.ilExAssignmentTeam.php.

    {
        return $this->id;
    }

References $id.

Referenced by adoptTeams().

Here is the caller graph for this function:

◆ getInstanceByUserId()

static ilExAssignmentTeam::getInstanceByUserId	(	$a_assignment_id,
		$a_user_id,
		$a_create_on_demand = `false`
	)

static

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

    {
        $id = self::getTeamId($a_assignment_id, $a_user_id, $a_create_on_demand);
        return new self($id);
    }

References $id, and getTeamId().

Referenced by ilExSubmission\__construct(), adoptTeams(), ilExerciseManagementGUI\createTeamsFromGroupsObject(), ilExerciseManagementGUI\createTeamsObject(), and ilExerciseManagementGUI\dissolveTeamsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstancesFromMap()

static ilExAssignmentTeam::getInstancesFromMap ( $a_assignment_id )

static

Definition at line 49 of file class.ilExAssignmentTeam.php.

    {
        $teams = array();
        foreach (self::getAssignmentTeamMap($a_assignment_id) as $user_id => $team_id) {
            $teams[$team_id][] = $user_id;
        }
        
        $res = array();
        foreach ($teams as $team_id => $members) {
            $team = new self();
            $team->id = $team_id;
            $team->assignment_id = $a_assignment_id;
            $team->members = $members;
            $res[$team_id] = $team;
        }
        
        return $res;
    }

References $members, and $res.

Referenced by ilExerciseManagementGUI\initIndividualDeadlineForm(), and ilExerciseMemberTableGUI\parseData().

Here is the caller graph for this function:

◆ getLog()

ilExAssignmentTeam::getLog ( )

Get all log entries for team.

Parameters

int $a_team_id

Returns: array

Definition at line 298 of file class.ilExAssignmentTeam.php.

    {
        $ilDB = $this->db;
        
        $this->cleanLog();
        
        $res = array();
        
        $sql = "SELECT * FROM il_exc_team_log" .
            " WHERE team_id = " . $ilDB->quote($this->id, "integer") .
            " ORDER BY tstamp DESC";
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = $row;
        }
        return $res;
    }

References $db, $ilDB, $res, $row, and cleanLog().

Here is the call graph for this function:

◆ getMembers()

ilExAssignmentTeam::getMembers ( )

Get members of assignment team.

Returns: array

Definition at line 139 of file class.ilExAssignmentTeam.php.

    {
        return $this->members;
    }

References $members.

◆ getMembersOfAllTeams()

ilExAssignmentTeam::getMembersOfAllTeams ( )

Get members for all teams of assignment.

Returns: array

Definition at line 149 of file class.ilExAssignmentTeam.php.

    {
        $ilDB = $this->db;
        
        $ids = array();
        
        $sql = "SELECT user_id" .
            " FROM il_exc_team" .
            " WHERE ass_id = " . $ilDB->quote($this->assignment_id, "integer");
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $ids[] = $row["user_id"];
        }
        
        return $ids;
    }

References $db, $ilDB, and $row.

Referenced by addTeamMember().

Here is the caller graph for this function:

◆ getTeamId()

static ilExAssignmentTeam::getTeamId	(	$a_assignment_id,
		$a_user_id,
		$a_create_on_demand = `false`
	)

static

Get team id for member id.

team will be created if no team yet

Parameters

int	$a_user_id
bool	$a_create_on_demand

Returns: int

Definition at line 102 of file class.ilExAssignmentTeam.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $sql = "SELECT id FROM il_exc_team" .
            " WHERE ass_id = " . $ilDB->quote($a_assignment_id, "integer") .
            " AND user_id = " . $ilDB->quote($a_user_id, "integer");
        $set = $ilDB->query($sql);
        $row = $ilDB->fetchAssoc($set);
        $id = $row["id"];
        
        if (!$id && $a_create_on_demand) {
            $id = $ilDB->nextId("il_exc_team");
            
            $fields = array("id" => array("integer", $id),
                "ass_id" => array("integer", $a_assignment_id),
                "user_id" => array("integer", $a_user_id));
            $ilDB->insert("il_exc_team", $fields);
            
            self::writeTeamLog($id, self::TEAM_LOG_CREATE_TEAM);
            self::writeTeamLog(
                $id,
                self::TEAM_LOG_ADD_MEMBER,
                ilObjUser::_lookupFullname($a_user_id)
            );
        }
        
        return $id;
    }

References $DIC, $id, $ilDB, $row, ilObjUser\_lookupFullname(), and writeTeamLog().

Referenced by ilExSubmissionTeamGUI\createAdoptedTeamObject(), ilExSubmissionTeamGUI\createSingleMemberTeamObject(), ilExSubmissionTeamGUI\createTeamObject(), getInstanceByUserId(), ilExAssignment\getPersonalDeadline(), and ilExerciseSubmissionTableGUI\parseRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilExAssignmentTeam::read ( $a_id )

protected

Definition at line 73 of file class.ilExAssignmentTeam.php.

    {
        $ilDB = $this->db;
        
        // #18094
        $this->members = array();
        
        $sql = "SELECT * FROM il_exc_team" .
            " WHERE id = " . $ilDB->quote($a_id, "integer");
        $set = $ilDB->query($sql);
        if ($ilDB->numRows($set)) {
            $this->id = $a_id;
        
            while ($row = $ilDB->fetchAssoc($set)) {
                $this->assignment_id = $row["ass_id"];
                $this->members[] = $row["user_id"];
            }
        }
    }

References $db, $ilDB, and $row.

Referenced by __construct(), addTeamMember(), and removeTeamMember().

Here is the caller graph for this function:

◆ removeTeamMember()

ilExAssignmentTeam::removeTeamMember	(	$a_user_id,
		$a_exc_ref_id = `null`
	)

Remove member from team.

Parameters

int	$a_user_id
int	$a_exc_ref_id

Definition at line 210 of file class.ilExAssignmentTeam.php.

    {
        $ilDB = $this->db;
        
        if (!$this->id) {
            return;
        }
        
        $sql = "DELETE FROM il_exc_team" .
            " WHERE ass_id = " . $ilDB->quote($this->assignment_id, "integer") .
            " AND id = " . $ilDB->quote($this->id, "integer") .
            " AND user_id = " . $ilDB->quote($a_user_id, "integer");
        $ilDB->manipulate($sql);
            
        if ($a_exc_ref_id) {
            $this->sendNotification($a_exc_ref_id, $a_user_id, "rmv");
        }
        
        $this->writeLog(
            self::TEAM_LOG_REMOVE_MEMBER,
            ilObjUser::_lookupFullname($a_user_id)
        );
        
        $this->read($this->id);
    }

References $db, $ilDB, ilObjUser\_lookupFullname(), read(), sendNotification(), and writeLog().

Here is the call graph for this function:

◆ sendNotification()

ilExAssignmentTeam::sendNotification	(	$a_exc_ref_id,
		$a_user_id,
		$a_action
	)

Send notification about team status.

Parameters

int	$a_exc_ref_id
int	$a_user_id
string	$a_action

Definition at line 352 of file class.ilExAssignmentTeam.php.

    {
        $ilUser = $this->user;
        
        // no need to notify current user
        if (!$a_exc_ref_id ||
            $ilUser->getId() == $a_user_id) {
            return;
        }
        
        $ass = new ilExAssignment($this->assignment_id);
                
        include_once "./Services/Notification/classes/class.ilSystemNotification.php";
        $ntf = new ilSystemNotification();
        $ntf->setLangModules(array("exc"));
        $ntf->setRefId($a_exc_ref_id);
        $ntf->setChangedByUserId($ilUser->getId());
        $ntf->setSubjectLangId('exc_team_notification_subject_' . $a_action);
        $ntf->setIntroductionLangId('exc_team_notification_body_' . $a_action);
        $ntf->addAdditionalInfo("exc_assignment", $ass->getTitle());
        $ntf->setGotoLangId('exc_team_notification_link');
        $ntf->setReasonLangId('exc_team_notification_reason');
        $ntf->sendMail(array($a_user_id));
    }

References $ilUser, and $user.

Referenced by addTeamMember(), and removeTeamMember().

Here is the caller graph for this function:

◆ writeLog()

ilExAssignmentTeam::writeLog	(	$a_action,
		$a_details = `null`
	)

Definition at line 260 of file class.ilExAssignmentTeam.php.

    {
        self::writeTeamLog($this->id, $a_action, $a_details);
    }

References writeTeamLog().

Referenced by addTeamMember(), and removeTeamMember().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeTeamLog()

static ilExAssignmentTeam::writeTeamLog	(	$a_team_id,
		$a_action,
		$a_details = `null`
	)

static

Add entry to team log.

Parameters

int	$a_team_id
int	$a_action
string	$a_details

Definition at line 272 of file class.ilExAssignmentTeam.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
        $id = $ilDB->nextId('il_exc_team_log');
 
        $fields = array(
            "log_id" => array("integer", $id),
            "team_id" => array("integer", $a_team_id),
            "user_id" => array("integer", $ilUser->getId()),
            "action" => array("integer", $a_action),
            "details" => array("text", $a_details),
            "tstamp" => array("integer", time())
        );
 
        $ilDB->insert("il_exc_team_log", $fields);
    }