File-based submissions. More...

Inheritance diagram for ilExSubmissionFileGUI:

Collaboration diagram for ilExSubmissionFileGUI:

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

	executeCommand ()

	submissionScreenObject ()

	uploadFormObject (ilPropertyFormGUI $a_form=null)

	uploadZipFormObject (\ILIAS\Repository\Form\FormAdapterGUI $a_form=null)

	addUploadObject ()

	confirmDeleteDeliveredObject ()
	Confirm deletion of delivered files. More...

	deleteDeliveredObject ()
	Delete file(s) submitted by user. More...

	downloadReturnedObject (bool $a_only_new=false)
	Download submitted files of user. More...

	downloadNewReturnedObject ()
	Download newly submitted files of user. More...

	downloadObject ()
	User downloads (own) submitted files. More...

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

	returnToParentObject ()

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

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

Protected Member Functions
	initUploadForm ()
	Init upload form form. More...

	getUploadForm ()

	handleUploadResult (\ILIAS\FileUpload\FileUpload $upload, \ILIAS\FileUpload\DTO\UploadResult $result)

	getZipUploadForm ()
	Init upload form form. More...

	handleZipUploadResult (\ILIAS\FileUpload\FileUpload $upload, \ILIAS\FileUpload\DTO\UploadResult $result)

Protected Member Functions inherited from ilExSubmissionBaseGUI
	handleTabs ()

	handleNewUpload (bool $a_no_notifications=false)

	handleRemovedUpload ()

	triggerAssignmentTool ()

Protected Attributes
ILIAS Exercise Submission SubmissionManager	$subm

	$log

ilToolbarGUI	$toolbar

ilHelpGUI	$help

ilObjUser	$user

UIServices	$ui

Protected Attributes inherited from ilExSubmissionBaseGUI
ILIAS Exercise Notification NotificationManager	$notification

ILIAS Exercise InternalDomainService	$domain

ILIAS Exercise InternalGUIService	$gui

ilCtrl	$ctrl

ilTabsGUI	$tabs_gui

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilObjExercise	$exercise

ilExSubmission	$submission

ilExAssignment	$assignment

MandatoryAssignmentsManager	$mandatory_manager

ContextServices	$tool_context

ilExAssignmentTypesGUI	$type_guis

int	$requested_ref_id

GUIRequest	$request

Detailed Description

File-based submissions.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om; Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

ilExSubmissionFileGUI: ilRepoStandardUploadHandlerGUI

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

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 38 of file class.ilExSubmissionFileGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilExSubmission\getAssignment(), ILIAS\Repository\help(), ILIAS\Repository\toolbar(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

       {
         global $DIC;
 
         parent::__construct($a_exercise, $a_submission);
 
         $this->toolbar = $DIC->toolbar();
         $this->help = $DIC["ilHelp"];
         $this->user = $DIC->user();
         $this->ui = $DIC->ui();
         $this->log = $DIC->logger()->exc();
         $this->subm = $DIC->exercise()->internal()->domain()->submission(
             $a_submission->getAssignment()->getId()
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ addUploadObject()

ilExSubmissionFileGUI::addUploadObject ( )

Definition at line 302 of file class.ilExSubmissionFileGUI.php.

References ilExSubmissionBaseGUI\$ctrl, ilExSubmissionBaseGUI\handleNewUpload(), and ILIAS\Repository\lng().

                                      : void
     {
         $ilCtrl = $this->ctrl;
         $this->tpl->setOnScreenMessage('success', $this->lng->txt("file_added"), true);
         $this->handleNewUpload();
 
         $ilCtrl->redirect($this, "submissionScreen");
     }

Here is the call graph for this function:

◆ confirmDeleteDeliveredObject()

ilExSubmissionFileGUI::confirmDeleteDeliveredObject ( )

Confirm deletion of delivered files.

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

References ilExSubmissionBaseGUI\$ctrl, ilExSubmissionBaseGUI\$lng, ilExSubmissionBaseGUI\$tpl, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                                   : void
     {
         $ilCtrl = $this->ctrl;
         $tpl = $this->tpl;
         $lng = $this->lng;
 
         $file_ids = $this->request->getSubmittedFileIds();
         if (!$this->submission->canSubmit()) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("exercise_time_over"), true);
             $ilCtrl->redirect($this, "submissionScreen");
         }
 
         if (count($file_ids) == 0) {
             $this->tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
             $ilCtrl->redirect($this, "submissionScreen");
         } else {
             $this->tabs_gui->clearTargets();
             $this->tabs_gui->setBackTarget(
                 $this->lng->txt("back"),
                 $this->ctrl->getLinkTarget($this, "submissionScreen")
             );
 
             $cgui = new ilConfirmationGUI();
             $cgui->setFormAction($ilCtrl->getFormAction($this));
             $cgui->setHeaderText($lng->txt("info_delete_sure"));
             $cgui->setCancel($lng->txt("cancel"), "submissionScreen");
             $cgui->setConfirm($lng->txt("delete"), "deleteDelivered");
 
             $subs = $this->subm->getSubmissionsOfUser(
                 $this->submission->getUserId(),
                 $file_ids
             );
 
             foreach ($subs as $sub) {
                 $cgui->addItem("delivered[]", $sub->getId(), $sub->getTitle());
             }
 
             $tpl->setContent($cgui->getHTML());
         }
     }

Here is the call graph for this function:

◆ deleteDeliveredObject()

ilExSubmissionFileGUI::deleteDeliveredObject ( )

Delete file(s) submitted by user.

Definition at line 445 of file class.ilExSubmissionFileGUI.php.

References ilExSubmissionBaseGUI\$ctrl, ilExSubmissionBaseGUI\handleRemovedUpload(), and ILIAS\Repository\lng().

                                            : void
     {
         $ilCtrl = $this->ctrl;
 
         $file_ids = $this->request->getSubmittedFileIds();
 
         if (!$this->submission->canSubmit()) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("exercise_time_over"), true);
         } elseif (count($file_ids) == 0) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("please_select_a_delivered_file_to_delete"), true);
         } else {
             $this->subm->deleteSubmissions(
                 $this->submission->getUserId(),
                 $file_ids
             );
             $this->handleRemovedUpload();
 
             $this->tpl->setOnScreenMessage('success', $this->lng->txt("exc_submitted_files_deleted"), true);
         }
         $ilCtrl->redirect($this, "submissionScreen");
     }

Here is the call graph for this function:

◆ downloadNewReturnedObject()

ilExSubmissionFileGUI::downloadNewReturnedObject ( )

Download newly submitted files of user.

Definition at line 492 of file class.ilExSubmissionFileGUI.php.

References downloadReturnedObject().

                                                : void
     {
         $this->downloadReturnedObject(true);
     }

Here is the call graph for this function:

◆ downloadObject()

ilExSubmissionFileGUI::downloadObject ( )

User downloads (own) submitted files.

Definition at line 500 of file class.ilExSubmissionFileGUI.php.

References ilExSubmissionBaseGUI\$ctrl, exit, ILIAS\Repository\lng(), and ilExSubmissionBaseGUI\returnToParentObject().

                                     : void
     {
         $ilCtrl = $this->ctrl;
 
         $delivered_id = $this->request->getSubmittedFileId();
 
         if (!$this->submission->canView()) {
             $this->returnToParentObject();
         }
 
         if (!is_array($delivered_id) && $delivered_id > 0) {
             $delivered_id = [$delivered_id];
         }
         if (is_array($delivered_id) && $delivered_id !== []) {
             $this->submission->downloadFiles($delivered_id);
             exit;
         } else {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("please_select_a_delivered_file_to_download"), true);
             $ilCtrl->redirect($this, "submissionScreen");
         }
     }

Here is the call graph for this function:

◆ downloadReturnedObject()

ilExSubmissionFileGUI::downloadReturnedObject ( bool $a_only_new = false )

Download submitted files of user.

Definition at line 470 of file class.ilExSubmissionFileGUI.php.

References ilExSubmissionBaseGUI\$lng, ilExSubmissionBaseGUI\returnToParentObject(), and ilLanguage\txt().

Referenced by downloadNewReturnedObject().

                                                                     : void
     {
         $lng = $this->lng;
 
         if ($this->submission->canView()) {
             $peer_review_mask_filename = $this->submission->hasPeerReviewAccess();
         } else {
             // no access
             return;
         }
 
         $this->submission->downloadFiles(null, $a_only_new, $peer_review_mask_filename);
         // we only get here, if no files have been found for download
         if ($a_only_new) {
             $this->tpl->setOnScreenMessage('info', $lng->txt("exc_all_new_files_offered_already"), true);
         }
         $this->returnToParentObject();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilExSubmissionFileGUI::executeCommand ( )

Definition at line 56 of file class.ilExSubmissionFileGUI.php.

References ilExSubmissionBaseGUI\$ctrl, ilExSubmissionBaseGUI\$gui, ILIAS\Repository\ctrl(), getUploadForm(), getZipUploadForm(), and ilExSubmissionBaseGUI\returnToParentObject().

                                     : void
     {
         $ilCtrl = $this->ctrl;
 
         if (!$this->submission->canView()) {
             $this->returnToParentObject();
         }
 
         $class = $ilCtrl->getNextClass($this);
         $cmd = $ilCtrl->getCmd("submissionScreen");
 
         switch ($class) {
             case strtolower(ilRepoStandardUploadHandlerGUI::class):
                 if ($this->request->getZip()) {
                     $form = $this->getZipUploadForm();
                 } else {
                     $form = $this->getUploadForm();
                 }
                 $gui = $form->getRepoStandardUploadHandlerGUI("deliver");
                 $this->ctrl->forwardCommand($gui);
                 break;
 
             default:
                 $this->{$cmd . "Object"}();
                 break;
         }
     }

Here is the call graph for this function:

◆ getOverviewContent()

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

static

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

References $DIC, ilExSubmissionBaseGUI\$gui, ilExSubmissionBaseGUI\$lng, ilInfoScreenGUI\addProperty(), ilExSubmission\canSubmit(), ilExSubmission\getAssignment(), ilExSubmission\getUserId(), ilExSubmission\hasNoTeamYet(), and ilLanguage\txt().

      : void {
         global $DIC;
 
         $lng = $DIC->language();
         $ilCtrl = $DIC->ctrl();
         $gui = $DIC->exercise()->internal()->gui();
         $subm = $DIC->exercise()->internal()->domain()->submission(
             $a_submission->getAssignment()->getId()
         );
 
         $titles = array();
         foreach ($subm->getSubmissionsOfUser($a_submission->getUserId()) as $sub) {
             $titles[] = htmlentities($sub->getTitle());
         }
         $files_str = implode("<br>", $titles);
         if ($files_str == "") {
             $files_str = $lng->txt("message_no_delivered_files");
         }
 
         // no team == no submission
         if (!$a_submission->hasNoTeamYet()) {
             if ($a_submission->canSubmit()) {
                 $title = (count($titles) == 0
                     ? $lng->txt("exc_hand_in")
                     : $lng->txt("exc_edit_submission"));
 
                 $button = $gui->link(
                     $title,
                     $ilCtrl->getLinkTargetByClass(array(ilAssignmentPresentationGUI::class, "ilExSubmissionGUI", "ilExSubmissionFileGUI"), "submissionScreen")
                 )->primary();
                 $files_str .= "<br><br>" . $button->render();
             } else {
                 if (count($titles) > 0) {
                     $link = $gui->link(
                         $lng->txt("already_delivered_files"),
                         $ilCtrl->getLinkTargetByClass(array(ilAssignmentPresentationGUI::class, "ilExSubmissionGUI", "ilExSubmissionFileGUI"), "submissionScreen")
                     )->emphasised();
                     $files_str .= "<br><br>" . $link->render();
                 }
             }
         }
 
         $a_info->addProperty($lng->txt("exc_files_returned"), $files_str);
     }

Here is the call graph for this function:

◆ getUploadForm()

ilExSubmissionFileGUI::getUploadForm ( )

protected

Definition at line 256 of file class.ilExSubmissionFileGUI.php.

References handleUploadResult(), and ILIAS\Repository\lng().

Referenced by executeCommand(), and uploadFormObject().

                                       : \ILIAS\Repository\Form\FormAdapterGUI
     {
         $max_file = $this->submission->getAssignment()->getMaxFile();
         $cnt_sub = $this->subm->countSubmissionsOfUser($this->submission->getUserId());
         if ($max_file > 0) {
             $max_file = $this->submission->getAssignment()->getMaxFile() - $cnt_sub;
         } else {
             $max_file = 20;
         }
 
         $form_adapter = $this->gui
             ->form(self::class, 'addUpload')
             ->section("props", $this->lng->txt('file_add'))
             ->file(
                 "deliver",
                 $this->lng->txt("files"),
                 $this->handleUploadResult(...),
                 "mep_id",
                 "",
                 $max_file
             );
         return $form_adapter;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getZipUploadForm()

ilExSubmissionFileGUI::getZipUploadForm ( )

protected

Init upload form form.

Definition at line 337 of file class.ilExSubmissionFileGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by executeCommand(), and uploadZipFormObject().

                                          : \ILIAS\Repository\Form\FormAdapterGUI
     {
         /*
         $max_file = $this->submission->getAssignment()->getMaxFile();
         if ($max_file > 0) {
             $max_file = $this->submission->getAssignment()->getMaxFile() - count($this->submission->getFiles());
         } else {
             $max_file = 20;
         }*/
         $this->ctrl->setParameterByClass(self::class, "zip", "1");
         $form_adapter = $this->gui
             ->form(self::class, 'addUpload')
             ->section("props", $this->lng->txt('file_add'))
             ->file(
                 "deliver",
                 $this->lng->txt("files"),
                 \Closure::fromCallable([$this, 'handleZipUploadResult']),
                 "mep_id",
                 "",
                 1,
                 ["application/zip"]
             );
         return $form_adapter;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleUploadResult()

ilExSubmissionFileGUI::handleUploadResult	(	\ILIAS\FileUpload\FileUpload	$upload,
		\ILIAS\FileUpload\DTO\UploadResult	$result
	)

protected

Definition at line 280 of file class.ilExSubmissionFileGUI.php.

References ILIAS\Repository\user().

Referenced by getUploadForm().

      : \ILIAS\FileUpload\Handler\BasicHandlerResult {
         $title = $result->getName();
 
         //$this->submission->addFileUpload($result);
         $subm = $this->domain->submission($this->assignment->getId());
         $subm->addUpload(
             $this->user->getid(),
             $result,
             $title
         );
 
         return new \ILIAS\FileUpload\Handler\BasicHandlerResult(
             '',
             \ILIAS\FileUpload\Handler\HandlerResult::STATUS_OK,
             $title,
             ''
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleZipUploadResult()

ilExSubmissionFileGUI::handleZipUploadResult	(	\ILIAS\FileUpload\FileUpload	$upload,
		\ILIAS\FileUpload\DTO\UploadResult	$result
	)

protected

Definition at line 364 of file class.ilExSubmissionFileGUI.php.

References Vendor\Package\$e, ILIAS\Repository\lng(), and ILIAS\Repository\user().

      : \ILIAS\FileUpload\Handler\BasicHandlerResult {
         $title = $result->getName();
         //$this->submission->addFileUpload($result);
         $subm = $this->domain->submission($this->assignment->getId());
         $mess = "";
         if ($this->submission->canSubmit()) {
             try {
                 $subm->addZipUploads(
                     $this->user->getid(),
                     $result
                 );
                 return new \ILIAS\FileUpload\Handler\BasicHandlerResult(
                     '',
                     \ILIAS\FileUpload\Handler\HandlerResult::STATUS_OK,
                     $title,
                     ''
                 );
             } catch (ilExcTooManyFilesSubmittedException $e) {
                 $mess = $this->lng->txt("exc_too_many_files");
             }
         } else {
             $mess = $this->lng->txt("exc_cannot_submit_any_files");
         }
         return new \ILIAS\FileUpload\Handler\BasicHandlerResult(
             '',
             \ILIAS\FileUpload\Handler\HandlerResult::STATUS_FAILED,
             $title,
             $mess
         );
     }

Here is the call graph for this function:

◆ initUploadForm()

ilExSubmissionFileGUI::initUploadForm ( )

protected

Init upload form form.

Definition at line 234 of file class.ilExSubmissionFileGUI.php.

References ilExSubmissionBaseGUI\$ctrl, ilExSubmissionBaseGUI\$lng, ilFileWizardInputGUI\setFilenames(), and ilLanguage\txt().

                                        : ilPropertyFormGUI
     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         $form = new ilPropertyFormGUI();
 
         // file input
         $fi = new ilFileWizardInputGUI($lng->txt("file"), "deliver");
         $fi->setFilenames(array(0 => ''));
         $fi->setRequired(true);
         $form->addItem($fi);
 
         $form->addCommandButton("uploadFile", $lng->txt("upload"));
         $form->addCommandButton("submissionScreen", $lng->txt("cancel"));
 
         $form->setTitle($lng->txt("file_add"));
         $form->setFormAction($ilCtrl->getFormAction($this, "uploadFile"));
 
         return $form;
     }

Here is the call graph for this function:

◆ submissionScreenObject()

ilExSubmissionFileGUI::submissionScreenObject ( )

Definition at line 133 of file class.ilExSubmissionFileGUI.php.

References Vendor\Package\$b, $help, $toolbar, $user, ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilExSubmissionBaseGUI\handleTabs(), IL_CAL_UNIX, ILIAS\Repository\lng(), ilExSubmissionBaseGUI\triggerAssignmentTool(), and ILIAS\Repository\ui().

                                             : void
     {
         $ilToolbar = $this->toolbar;
         $ilHelp = $this->help;
         $ilUser = $this->user;
 
         $this->triggerAssignmentTool();
 
         $this->handleTabs();
 
         $ilHelp->setScreenIdComponent("exc");
         $ilHelp->setScreenId("submissions");
 
         if (!$this->submission->canSubmit()) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt("exercise_time_over"));
         } else {
             $max_files = $this->submission->getAssignment()->getMaxFile();
 
             if ($this->submission->canAddFile()) {
                 // #15883 - extended deadline warning
                 $deadline = $this->assignment->getPersonalDeadline($ilUser->getId());
                 if ($deadline &&
                     time() > $deadline) {
                     $dl = ilDatePresentation::formatDate(new ilDateTime($deadline, IL_CAL_UNIX));
                     $dl = sprintf($this->lng->txt("exc_late_submission_warning"), $dl);
                     $dl = '<span class="warning">' . $dl . '</span>';
                     $ilToolbar->addText($dl);
                 }
 
                 $b = $this->ui->factory()->button()->standard(
                     $this->lng->txt("file_add"),
                     $this->ctrl->getLinkTarget($this, "uploadForm")
                 );
                 $ilToolbar->addStickyItem($b);
 
                 if (!$max_files ||
                     $max_files > 1) {
                     $ilToolbar->addButton(
                         $this->lng->txt("header_zip"),
                         $this->ctrl->getLinkTarget($this, "uploadZipForm")
                     );
                 }
             }
 
             if ($max_files) {
                 $this->tpl->setOnScreenMessage('info', sprintf($this->lng->txt("exc_max_file_reached"), $max_files));
             }
         }
 
         $tab = new ilExcDeliveredFilesTableGUI($this, "submissionScreen", $this->submission);
         $this->tpl->setContent($tab->getHTML());
     }

Here is the call graph for this function:

◆ uploadFormObject()

ilExSubmissionFileGUI::uploadFormObject ( ilPropertyFormGUI $a_form = null )

Definition at line 187 of file class.ilExSubmissionFileGUI.php.

References $help, ILIAS\Repository\ctrl(), getUploadForm(), ILIAS\Repository\lng(), and ilHelpGUI\setScreenIdComponent().

      : void {
         if (!$this->submission->canSubmit()) {
             $this->ctrl->redirect($this, "submissionScreen");
         }
 
         $this->tabs_gui->clearTargets();
         $this->tabs_gui->setBackTarget(
             $this->lng->txt("back"),
             $this->ctrl->getLinkTarget($this, "submissionScreen")
         );
 
         $ilHelp = $this->help;
         $ilHelp->setScreenIdComponent("exc");
         $ilHelp->setScreenId("upload_submission");
 
         if (!$a_form) {
             $a_form = $this->getUploadForm();
             $this->tpl->setContent($a_form->render());
             return;
         }
         $this->tpl->setContent($a_form->getHTML());
     }

Here is the call graph for this function:

◆ uploadZipFormObject()

ilExSubmissionFileGUI::uploadZipFormObject ( \ILIAS\Repository\Form\FormAdapterGUI $a_form = null )

Definition at line 212 of file class.ilExSubmissionFileGUI.php.

References ILIAS\Repository\ctrl(), getZipUploadForm(), and ILIAS\Repository\lng().

      : void {
         if (!$this->submission->canSubmit()) {
             $this->ctrl->redirect($this, "submissionScreen");
         }
 
         $this->tabs_gui->clearTargets();
         $this->tabs_gui->setBackTarget(
             $this->lng->txt("back"),
             $this->ctrl->getLinkTarget($this, "submissionScreen")
         );
 
         if (!$a_form) {
             $a_form = $this->getZipUploadForm();
         }
         $this->tpl->setContent($a_form->render());
     }