Submission team. More...

Collaboration diagram for ilExSubmissionTeamGUI:

Public Member Functions
	__construct (ilObjExercise $a_exercise, ilExSubmission $a_submission)

	executeCommand ()

	returnToParentObject ()

	submissionScreenTeamObject ()
	Displays a form which allows members to manage team uploads. More...

	addTeamMemberActionObject ($a_user_ids=array())

	confirmDeleteTeamObject ()

	confirmRemoveTeamMemberObject ($a_full_delete=false)

	removeTeamMemberObject ($a_full_delete=false)

	submissionScreenTeamLogObject ()

	createSingleMemberTeamObject ()

	showTeamLogObject ()

	createTeamObject ()

	createAdoptedTeamObject ()

	addUserFromAutoCompleteObject ()
	Add user as member. More...

Static Public Member Functions
static	getOverviewContent (ilInfoScreenGUI $a_info, ilExSubmission $a_submission)

static	handleTabs ()

Protected Member Functions
	canEditTeam ()

Protected Attributes
	$ctrl

	$tabs_gui

	$lng

	$tpl

	$toolbar

	$user

	$exercise

	$assignment

	$submission

	$team

Detailed Description

Submission team.

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

ilExSubmissionTeamGUI: ilRepositorySearchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilExSubmissionTeamGUI::__construct	(	ilObjExercise	$a_exercise,
		ilExSubmission	$a_submission
	)

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

References $DIC, $ilCtrl, $lng, $tpl, ilExSubmission\getAssignment(), and user().

     {
         global $DIC;
 
         $this->toolbar = $DIC->toolbar();
         $this->user = $DIC->user();
         $ilCtrl = $DIC->ctrl();
         $ilTabs = $DIC->tabs();
         $lng = $DIC->language();
         $tpl = $DIC["tpl"];
         
         $this->exercise = $a_exercise;
         $this->submission = $a_submission;
         $this->assignment = $a_submission->getAssignment();
     
         // :TODO:
         $this->ctrl = $ilCtrl;
         $this->tabs_gui = $ilTabs;
         $this->lng = $lng;
         $this->tpl = $tpl;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addTeamMemberActionObject()

ilExSubmissionTeamGUI::addTeamMemberActionObject ( $a_user_ids = array() )

Definition at line 253 of file class.ilExSubmissionTeamGUI.php.

References canEditTeam(), and ilUtil\sendFailure().

Referenced by addUserFromAutoCompleteObject().

     {
         if (!$this->canEditTeam()) {
             $this->ctrl->redirect("submissionScreenTeam");
         }
         
         if (!count($a_user_ids)) {
             ilUtil::sendFailure($this->lng->txt("no_checkbox"));
             return false;
         }
 
         $new_users = [];
 
         foreach ($a_user_ids as $user_id) {
             if ($this->team->addTeamMember($user_id, $this->exercise->getRefId())) {
                 $new_users[] = $user_id;
                 
                 // #14277
                 if (!$this->exercise->members_obj->isAssigned($user_id)) {
                     $this->exercise->members_obj->assignMember($user_id);
                 }
             } else {
                 // #11959
                 ilUtil::sendFailure($this->lng->txt("exc_members_already_assigned_team"), true);
             }
         }
         
         if (sizeof($new_users)) {
             // re-evaluate complete team, as new member could have already submitted
             $this->exercise->processExerciseStatus(
                 $this->assignment,
                 $this->team->getMembers(),
                 $this->submission->hasSubmitted(),
                 $this->submission->validatePeerReviews()
             );
             // :TODO: notification?
             ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
         }
 
         $this->ctrl->redirect($this, "submissionScreenTeam");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addUserFromAutoCompleteObject()

ilExSubmissionTeamGUI::addUserFromAutoCompleteObject ( )

Add user as member.

Definition at line 545 of file class.ilExSubmissionTeamGUI.php.

References $_POST, $user, ilObjUser\_lookupId(), addTeamMemberActionObject(), ilUtil\sendFailure(), and submissionScreenTeamObject().

     {
         if (!strlen(trim($_POST['user_login']))) {
             ilUtil::sendFailure($this->lng->txt('msg_no_search_string'));
             $this->submissionScreenTeamObject();
             return false;
         }
         
         $users = explode(',', $_POST['user_login']);
 
         $user_ids = array();
         foreach ($users as $user) {
             $user_id = ilObjUser::_lookupId($user);
 
             if (!$user_id) {
                 ilUtil::sendFailure($this->lng->txt('user_not_known'));
                 return $this->submissionScreenTeamObject();
             }
             
             $user_ids[] = $user_id;
         }
     
         return $this->addTeamMemberActionObject($user_ids);
     }

Here is the call graph for this function:

◆ canEditTeam()

ilExSubmissionTeamGUI::canEditTeam ( )

protected

Definition at line 203 of file class.ilExSubmissionTeamGUI.php.

Referenced by addTeamMemberActionObject(), confirmRemoveTeamMemberObject(), removeTeamMemberObject(), and submissionScreenTeamObject().

     {
         return (($this->submission->canSubmit() &&
             !$this->submission->getAssignment()->getTeamTutor()) ||
             $this->submission->isTutor());
     }

Here is the caller graph for this function:

◆ confirmDeleteTeamObject()

ilExSubmissionTeamGUI::confirmDeleteTeamObject ( )

Definition at line 295 of file class.ilExSubmissionTeamGUI.php.

References confirmRemoveTeamMemberObject().

     {
         $this->confirmRemoveTeamMemberObject(true);
     }

Here is the call graph for this function:

◆ confirmRemoveTeamMemberObject()

ilExSubmissionTeamGUI::confirmRemoveTeamMemberObject ( $a_full_delete = false )

Definition at line 300 of file class.ilExSubmissionTeamGUI.php.

References $_GET, $_POST, $ilUser, $tpl, $user, canEditTeam(), ilUserUtil\getNamePresentation(), removeTeamMemberObject(), returnToParentObject(), and ilUtil\sendFailure().

Referenced by confirmDeleteTeamObject().

     {
         $ilUser = $this->user;
         $tpl = $this->tpl;
         
         if (!$this->submission->isTutor()) {
             $ids = [];
             if ((bool) $a_full_delete) {
                 $ids = $this->team->getMembers();
             } elseif (isset($_POST["id"]) && is_array($_POST["id"])) {
                 $ids = $_POST["id"];
             }
             $ids = array_filter(array_map('intval', $ids));
 
             if (0 === count($ids) && !$this->canEditTeam()) {
                 ilUtil::sendFailure($this->lng->txt("select_one"), true);
                 $this->ctrl->redirect($this, "submissionScreenTeam");
             }
         } else {
             $ids = array_filter(array_map('intval', array($_GET["id"])));
             if (0 === count($ids)) {
                 $this->returnToParentObject();
             }
         }
             
         $members = $this->team->getMembers();
         if (sizeof($members) <= sizeof($ids)) {
             if (sizeof($members) == 1 && $members[0] == $ilUser->getId()) {
                 // direct team deletion - no confirmation
                 return $this->removeTeamMemberObject($a_full_delete);
             } else {
                 ilUtil::sendFailure($this->lng->txt("exc_team_at_least_one"), true);
                 $this->ctrl->redirect($this, "submissionScreenTeam");
             }
         }
             
         $cgui = new ilConfirmationGUI();
         $cgui->setFormAction($this->ctrl->getFormAction($this));
         $cgui->setHeaderText($this->lng->txt("exc_team_member_remove_sure"));
         $cgui->setConfirm($this->lng->txt("remove"), "removeTeamMember");
         $cgui->setCancel($this->lng->txt("cancel"), $this->submission->isTutor()
             ? "returnToParent"
             : "submissionScreenTeam");
 
         $files = $this->submission->getFiles();
         
         foreach ($ids as $id) {
             $details = array();
             foreach ($files as $file) {
                 if ($file["owner_id"] == $id) {
                     $details[] = $file["filetitle"];
                 }
             }
             $uname = ilUserUtil::getNamePresentation($id);
             if (sizeof($details)) {
                 $uname .= ": " . implode(", ", $details);
             }
             $cgui->addItem("id[]", $id, $uname);
         }
 
         $tpl->setContent($cgui->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createAdoptedTeamObject()

ilExSubmissionTeamGUI::createAdoptedTeamObject ( )

Definition at line 521 of file class.ilExSubmissionTeamGUI.php.

References $_POST, $ctrl, $ilCtrl, $ilUser, $lng, $user, ilExAssignmentTeam\adoptTeams(), and ilExAssignmentTeam\getTeamId().

     {
         $ilCtrl = $this->ctrl;
         $ilUser = $this->user;
         $lng = $this->lng;
         
         if ($this->submission->canSubmit()) {
             $src_ass_id = (int) $_POST["ass_adpt"];
             if ($src_ass_id > 0) {
                 ilExAssignmentTeam::adoptTeams($src_ass_id, $this->assignment->getId(), $ilUser->getId(), $this->exercise->getRefId());
             } else {
                 ilExAssignmentTeam::getTeamId($this->assignment->getId(), $ilUser->getId(), true);
             }
             
             ilUtil::sendSuccess($lng->txt("settings_saved"), true);
         }
         
         $ilCtrl->redirect($this, "returnToParent");
     }

Here is the call graph for this function:

◆ createSingleMemberTeamObject()

ilExSubmissionTeamGUI::createSingleMemberTeamObject ( )

Definition at line 439 of file class.ilExSubmissionTeamGUI.php.

References ilExAssignmentTeam\getTeamId(), and returnToParentObject().

     {
         ilExAssignmentTeam::getTeamId(
             $this->assignment->getId(),
             $this->submission->getUserId(),
             true
         );
         ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
         $this->returnToParentObject();
     }

Here is the call graph for this function:

◆ createTeamObject()

ilExSubmissionTeamGUI::createTeamObject ( )

Definition at line 456 of file class.ilExSubmissionTeamGUI.php.

References $ctrl, $ilCtrl, $ilUser, $lng, $tpl, $user, ilExAssignmentTeam\getAdoptableTeamAssignments(), ilExAssignmentTeam\getAssignmentTeamMap(), ilUserUtil\getNamePresentation(), ilExAssignmentTeam\getTeamId(), and ilRadioGroupInputGUI\setValue().

     {
         $ilCtrl = $this->ctrl;
         $ilUser = $this->user;
         $lng = $this->lng;
         $tpl = $this->tpl;
         
         if ($this->submission->canSubmit()) {
             $options = ilExAssignmentTeam::getAdoptableTeamAssignments($this->assignment->getExerciseId(), $this->assignment->getId(), $ilUser->getId());
             if (sizeof($options)) {
                 $form = new ilPropertyFormGUI();
                 $form->setTitle($lng->txt("exc_team_assignment_adopt_user"));
                 $form->setFormAction($ilCtrl->getFormAction($this, "createAdoptedTeam"));
 
                 $teams = new ilRadioGroupInputGUI($lng->txt("exc_assignment"), "ass_adpt");
                 $teams->setValue(-1);
 
                 $teams->addOption(new ilRadioOption($lng->txt("exc_team_assignment_adopt_none_user"), -1));
                 
                 $current_map = ilExAssignmentTeam::getAssignmentTeamMap($this->assignment->getId());
 
                 foreach ($options as $id => $item) {
                     $members = array();
                     $free = false;
                     foreach ($item["user_team"] as $user_id) {
                         $members[$user_id] = ilUserUtil::getNamePresentation($user_id);
                         
                         if (array_key_exists($user_id, $current_map)) {
                             $members[$user_id] .= " (" . $lng->txt("exc_team_assignment_adopt_already_assigned") . ")";
                         } else {
                             $free = true;
                         }
                     }
                     asort($members);
                     $members = implode("<br />", $members);
                     $option = new ilRadioOption($item["title"], $id);
                     $option->setInfo($members);
                     if (!$free) {
                         $option->setDisabled(true);
                     }
                     $teams->addOption($option);
                 }
 
                 $form->addItem($teams);
 
                 $form->addCommandButton("createAdoptedTeam", $lng->txt("save"));
                 $form->addCommandButton("returnToParent", $lng->txt("cancel"));
 
                 $tpl->setContent($form->getHTML());
                 return;
             }
             
             ilExAssignmentTeam::getTeamId($this->assignment->getId(), $ilUser->getId(), true);
             
             // #18046
             if (!$this->exercise->members_obj->isAssigned($ilUser->getId())) {
                 $this->exercise->members_obj->assignMember($ilUser->getId());
             }
             
             ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
         }
         
         $ilCtrl->redirect($this, "returnToParent");
     }

Here is the call graph for this function:

◆ executeCommand()

ilExSubmissionTeamGUI::executeCommand ( )

Definition at line 71 of file class.ilExSubmissionTeamGUI.php.

References $ctrl, $ilCtrl, and ilUserAutoComplete\PRIVACY_MODE_RESPECT_USER_SETTING.

     {
         $ilCtrl = $this->ctrl;
         
         $class = $ilCtrl->getNextClass($this);
         $cmd = $ilCtrl->getCmd("submissionScreenTeam");
             
         if (!$this->assignment->hasTeam() ||
             !$this->submission->canView()) {
             return;
         }
         $this->team = $this->submission->getTeam();
         
         if (!$this->submission->isTutor()) {
             self::handleTabs();
             $this->tabs_gui->activateTab("team");
         }
         
         switch ($class) {
             case 'ilrepositorysearchgui':
                 $this->ctrl->setReturn($this, 'submissionScreenTeam');
                 $rep_search = new ilRepositorySearchGUI();
                 if (!$this->submission->isTutor()) {
                     $rep_search->setPrivacyMode(ilUserAutoComplete::PRIVACY_MODE_RESPECT_USER_SETTING);
                 }
                 $rep_search->setTitle($this->lng->txt("exc_team_member_add"));
                 $rep_search->setCallback($this, 'addTeamMemberActionObject');
                 $this->ctrl->forwardCommand($rep_search);
                 break;
                             
             default:
                 $this->{$cmd . "Object"}();
                 break;
         }
     }

◆ getOverviewContent()

static ilExSubmissionTeamGUI::getOverviewContent	(	ilInfoScreenGUI	$a_info,
		ilExSubmission	$a_submission
	)

static

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

References $DIC, $ilCtrl, $lng, $team, ilInfoScreenGUI\addProperty(), ilExSubmission\getAssignment(), ilLinkButton\getInstance(), ilExcAssMemberState\getInstanceByIds(), ilExSubmission\getLastSubmission(), ilUserUtil\getNamePresentation(), ilExSubmission\getTeam(), ilExSubmission\getUserId(), and ilExSubmission\hasSubmitted().

Referenced by ilExSubmissionGUI\getOverviewContent().

     {
         global $DIC;
 
         $lng = $DIC->language();
         $ilCtrl = $DIC->ctrl();
         
         if (!$a_submission->getAssignment()->hasTeam()) {
             return;
         }
 
         $state = ilExcAssMemberState::getInstanceByIds($a_submission->getAssignment()->getId(), $a_submission->getUserId());
                                 
         $team_members = $a_submission->getTeam()->getMembers();
         if (sizeof($team_members)) {                                                                    // we have a team
             $team = array();
             foreach ($team_members as $member_id) {
                 //$team[] = ilObjUser::_lookupFullname($member_id);
                 $team[] = ilUserUtil::getNamePresentation($member_id, false, false, "", false);
             }
             $team = implode("; ", $team);
             
             if (!$a_submission->getAssignment()->getTeamTutor()) {
                 #23685
                 // any team member upload?
                 if (!$a_submission->getLastSubmission()) {
                     $button = ilLinkButton::getInstance();
                     $button->setCaption("exc_delete_team");
                     $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTeamGUI"), "confirmDeleteTeam"));
                     $team .= " " . $button->render();
                 }
                 $button = ilLinkButton::getInstance();
                 $button->setCaption("exc_manage_team");
                 $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTeamGUI"), "submissionScreenTeam"));
             } else {
                 $button = ilLinkButton::getInstance();
                 $button->setCaption("exc_team_log");
                 $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTeamGUI"), "submissionScreenTeamLog"));
             }
             $team .= "<br><br>" . $button->render();
 
             $a_info->addProperty($lng->txt("exc_team_members"), $team);
         } else {
             //if($a_submission->getAssignment()->beforeDeadline())              // this was "for all users"
             if (!$state->hasSubmissionEnded()) {                                                        // this is for current user/team -> no team creation, if no submission possible
                 if (!$a_submission->hasSubmitted()) {
                     $team_info = $lng->txt("exc_no_team_yet_notice");
                 } else {
                     $team_info = '<span class="warning">' . $lng->txt("exc_no_team_yet_notice") . '</span>';
                 }
 
                 if (!$a_submission->getAssignment()->getTeamTutor()) {
                     $button = ilLinkButton::getInstance();
                     $button->setPrimary(true);
                     $button->setCaption("exc_create_team");             // team creation
                     $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTeamGUI"), "createTeam"));
                     $team_info .= " " . $button->render();
                     
                     $team_info .= '<div class="ilFormInfo">' . $lng->txt("exc_no_team_yet_info") . '</div>';
                 } else {
                     $team_info .= '<div class="ilFormInfo">' . $lng->txt("exc_no_team_yet_info_tutor") . '</div>';
                 }
             } else {
                 $team_info = '<span class="warning">' . $lng->txt("exc_create_team_times_up_warning") . '</span>';
             }
             
             $a_info->addProperty($lng->txt("exc_team_members"), $team_info);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleTabs()

static ilExSubmissionTeamGUI::handleTabs ( )

static

Definition at line 182 of file class.ilExSubmissionTeamGUI.php.

References $DIC, $ilCtrl, and $lng.

Referenced by ilExSubmissionBaseGUI\handleTabs().

     {
         global $DIC;
 
         $ilTabs = $DIC->tabs();
         $ilCtrl = $DIC->ctrl();
         $lng = $DIC->language();
         
         $ilTabs->addTab(
             "team",
             $lng->txt("exc_team"),
             $ilCtrl->getLinkTargetByClass("ilExSubmissionTeamGUI", "submissionScreenTeam")
         );
 
         $ilTabs->addTab(
             "log",
             $lng->txt("exc_team_log"),
             $ilCtrl->getLinkTargetByClass("ilExSubmissionTeamGUI", "submissionScreenTeamLog")
         );
     }

Here is the caller graph for this function:

◆ removeTeamMemberObject()

ilExSubmissionTeamGUI::removeTeamMemberObject ( $a_full_delete = false )

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

References $_POST, $ilUser, $user, canEditTeam(), and ilUtil\sendFailure().

Referenced by confirmRemoveTeamMemberObject().

     {
         $ilUser = $this->user;
         
         $cancel_cmd = $this->submission->isTutor()
             ? "returnToParent"
             : "submissionScreenTeam";
 
         $ids = [];
         if ((bool) $a_full_delete) {
             $ids = $this->team->getMembers();
         } elseif (isset($_POST["id"]) && is_array($_POST["id"])) {
             $ids = $_POST["id"];
         }
         $ids = array_filter(array_map('intval', $ids));
 
         if (0 === count($ids) && !$this->canEditTeam()) {
             ilUtil::sendFailure($this->lng->txt("select_one"), true);
             $this->ctrl->redirect($this, $cancel_cmd);
         }
                 
         $team_deleted = (bool) $a_full_delete;
         if (!$team_deleted) {
             $members = $this->team->getMembers();
             if (sizeof($members) <= sizeof($ids)) {
                 if (sizeof($members) == 1 && $members[0] == $ilUser->getId()) {
                     $team_deleted = true;
                 } else {
                     ilUtil::sendFailure($this->lng->txt("exc_team_at_least_one"), true);
                     $this->ctrl->redirect($this, $cancel_cmd);
                 }
             }
         }
         
         foreach ($ids as $user_id) {
             $this->team->removeTeamMember($user_id, $this->exercise->getRefId());
         }
         
         // reset ex team members, as any submission is not valid without team
         $this->exercise->processExerciseStatus(
             $this->assignment,
             $ids,
             false
         );
         
         if (!$team_deleted) {
             // re-evaluate complete team, as removed member might have had submitted
             $this->exercise->processExerciseStatus(
                 $this->assignment,
                 $this->team->getMembers(),
                 $this->submission->hasSubmitted(),
                 $this->submission->validatePeerReviews()
             );
         }
                 
         ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
         if (!$team_deleted) {
             $this->ctrl->redirect($this, $cancel_cmd);
         } else {
             $this->ctrl->redirect($this, "returnToParent");
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ returnToParentObject()

ilExSubmissionTeamGUI::returnToParentObject ( )

Definition at line 177 of file class.ilExSubmissionTeamGUI.php.

Referenced by confirmRemoveTeamMemberObject(), and createSingleMemberTeamObject().

     {
         $this->ctrl->returnToParent($this);
     }

Here is the caller graph for this function:

◆ showTeamLogObject()

ilExSubmissionTeamGUI::showTeamLogObject ( )

Definition at line 450 of file class.ilExSubmissionTeamGUI.php.

     {
         $tbl = new ilExAssignmentTeamLogTableGUI($this, "showTeamLog", $this->team);
         $this->tpl->setContent($tbl->getHTML());
     }

◆ submissionScreenTeamLogObject()

ilExSubmissionTeamGUI::submissionScreenTeamLogObject ( )

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

     {
         $this->tabs_gui->activateTab("log");
     
         $tbl = new ilExAssignmentTeamLogTableGUI(
             $this,
             "submissionScreenTeamLog",
             $this->team
         );
         
         $this->tpl->setContent($tbl->getHTML());
     }

◆ submissionScreenTeamObject()

ilExSubmissionTeamGUI::submissionScreenTeamObject ( )

Displays a form which allows members to manage team uploads.

public

Definition at line 215 of file class.ilExSubmissionTeamGUI.php.

References $team, $toolbar, canEditTeam(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), ilExAssignmentTeamTableGUI\MODE_EDIT, and ilUtil\sendInfo().

Referenced by addUserFromAutoCompleteObject().

     {
         $ilToolbar = $this->toolbar;
                         
         // #13414
         $read_only = !$this->canEditTeam();
                 
         if ($this->submission->getAssignment()->afterDeadlineStrict(false)) {
             ilUtil::sendInfo($this->lng->txt("exercise_time_over"));
         } elseif (!$read_only) {
             $add_search = $this->submission->isTutor();
             // add member
             ilRepositorySearchGUI::fillAutoCompleteToolbar(
                 $this,
                 $ilToolbar,
                 array(
                     'auto_complete_name' => $this->lng->txt('user'),
                     'submit_name' => $this->lng->txt('add'),
                     'add_search' => $add_search,
                     'add_from_container' => $this->exercise->getRefId()
                 )
             );
         } elseif ($this->submission->getAssignment()->getTeamTutor()) {
             ilUtil::sendInfo($this->lng->txt("exc_no_team_yet_info_tutor"));
         }
         
         $tbl = new ilExAssignmentTeamTableGUI(
             $this,
             "submissionScreenTeam",
             ilExAssignmentTeamTableGUI::MODE_EDIT,
             $this->exercise->getRefId(),
             $this->team,
             $read_only
         );
         
         $this->tpl->setContent($tbl->getHTML());
     }