ilExSubmissionFileGUI Class Reference

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 (ilPropertyFormGUI $a_form=null)
	uploadFileObject ()
	Upload files. More...
	uploadZipObject ()
	Upload zip file. More...
	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
	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...
	initZipUploadForm ()
	Init upload form form. More...
Protected Member Functions inherited from ilExSubmissionBaseGUI
	handleTabs ()
	handleNewUpload (bool $a_no_notifications=false)
	handleRemovedUpload ()
	triggerAssignmentTool ()

Protected Attributes
ilToolbarGUI	$toolbar
ilHelpGUI	$help
ilObjUser	$user
UIServices	$ui
Protected Attributes inherited from ilExSubmissionBaseGUI
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:

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

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), 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();
    }

Here is the call graph for this function:

Member Function Documentation

confirmDeleteDeliveredObject()

ilExSubmissionFileGUI::confirmDeleteDeliveredObject

(

)

Confirm deletion of delivered files.

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

References ilExSubmissionBaseGUI\$ctrl, Vendor\Package\$f, $i, 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");

            $files = $this->submission->getFiles();

            foreach ($file_ids as $i) {
                reset($files);
                $title = "";
                foreach ($files as $f) {
                    if ($f["returned_id"] == $i) {
                        $title = $f["filetitle"];
                    }
                }
                $cgui->addItem("delivered[]", $i, $title);
            }

            $tpl->setContent($cgui->getHTML());
        }
    }

Here is the call graph for this function:

deleteDeliveredObject()

ilExSubmissionFileGUI::deleteDeliveredObject

(

)

Delete file(s) submitted by user.

Definition at line 378 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->submission->deleteSelectedFiles($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 422 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 430 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 400 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 50 of file class.ilExSubmissionFileGUI.php.

References ilExSubmissionBaseGUI\$ctrl, and ilExSubmissionBaseGUI\returnToParentObject().

                                    : void
    {
        $ilCtrl = $this->ctrl;

        if (!$this->submission->canView()) {
            $this->returnToParentObject();
        }

        $class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd("submissionScreen");

        switch ($class) {
            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 68 of file class.ilExSubmissionFileGUI.php.

References $DIC, ilExSubmissionBaseGUI\$lng, ilInfoScreenGUI\addProperty(), ilExSubmission\canSubmit(), ilExSubmission\getFiles(), ilLinkButton\getInstance(), ilExSubmission\hasNoTeamYet(), and ilLanguage\txt().

     : void {
        global $DIC;

        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();

        $titles = array();
        foreach ($a_submission->getFiles() as $file) {
            $titles[] = htmlentities($file["filetitle"]);
        }
        $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 = ilLinkButton::getInstance();
                $button->setPrimary(true);
                $button->setCaption($title, false);
                $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionFileGUI"), "submissionScreen"));
                $files_str .= "<br><br>" . $button->render();
            } else {
                if (count($titles) > 0) {
                    $button = ilLinkButton::getInstance();
                    $button->setCaption("already_delivered_files");
                    $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionFileGUI"), "submissionScreen"));
                    $files_str .= "<br><br>" . $button->render();
                }
            }
        }

        $a_info->addProperty($lng->txt("exc_files_returned"), $files_str);
    }

Here is the call graph for this function:

initUploadForm()

ilExSubmissionFileGUI::initUploadForm ( )

protected

Init upload form form.

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

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

Referenced by uploadFileObject(), and uploadFormObject().

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

Here is the caller graph for this function:

initZipUploadForm()

ilExSubmissionFileGUI::initZipUploadForm ( )

protected

Init upload form form.

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

References ilExSubmissionBaseGUI\$ctrl, ilExSubmissionBaseGUI\$lng, ilFileInputGUI\setSuffixes(), and ilLanguage\txt().

Referenced by uploadZipFormObject(), and uploadZipObject().

                                          : ilPropertyFormGUI
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $form = new ilPropertyFormGUI();

        $fi = new ilFileInputGUI($lng->txt("file"), "deliver");
        $fi->setSuffixes(array("zip"));
        $fi->setRequired(true);
        $form->addItem($fi);

        $form->addCommandButton("uploadZip", $lng->txt("upload"));
        $form->addCommandButton("submissionScreen", $lng->txt("cancel"));

        $form->setTitle($lng->txt("header_zip"));
        $form->setFormAction($ilCtrl->getFormAction($this, "uploadZip"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

submissionScreenObject()

ilExSubmissionFileGUI::submissionScreenObject

(

)

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

References Vendor\Package\$b, $help, $ilUser, $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:

uploadFileObject()

ilExSubmissionFileGUI::uploadFileObject

(

)

Upload files.

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

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

                                      : void
    {
        $ilCtrl = $this->ctrl;

        // #15322
        if (!$this->submission->canSubmit()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("exercise_time_over"), true);
        } else {
            $form = $this->initUploadForm();
            if (!$form->checkInput()) {
                $this->uploadFormObject($form);
                return;
            }

            $success = false;
            foreach ($_FILES["deliver"]["name"] as $k => $v) {
                $file = array(
                    "name" => $_FILES["deliver"]["name"][$k],
                    "type" => $_FILES["deliver"]["type"][$k],
                    "tmp_name" => $_FILES["deliver"]["tmp_name"][$k],
                    "error" => $_FILES["deliver"]["error"][$k],
                    "size" => $_FILES["deliver"]["size"][$k],
                    );
                if (!$this->submission->uploadFile($file)) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt("exc_upload_error") . " [Single File]", true);
                } else {
                    $success = true;
                }
            }

            if ($success) {
                $this->tpl->setOnScreenMessage('success', $this->lng->txt("file_added"), true);
                $this->handleNewUpload();
            }
        }

        $ilCtrl->redirect($this, "submissionScreen");
    }

Here is the call graph for this function:

uploadFormObject()

ilExSubmissionFileGUI::uploadFormObject

(

ilPropertyFormGUI

$a_form = null

)

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

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

Referenced by uploadFileObject().

     : 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->initUploadForm();
        }
        $this->tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

uploadZipFormObject()

ilExSubmissionFileGUI::uploadZipFormObject

(

ilPropertyFormGUI

$a_form = null

)

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

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

Referenced by uploadZipObject().

     : 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->initZipUploadForm();
        }
        $this->tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

uploadZipObject()

ilExSubmissionFileGUI::uploadZipObject

(

)

Upload zip file.

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

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

                                     : void
    {
        $ilCtrl = $this->ctrl;

        // #15322
        if (!$this->submission->canSubmit()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("exercise_time_over"), true);
        } else {
            $form = $this->initZipUploadForm();
            if (!$form->checkInput()) {
                $this->uploadZipFormObject($form);
                return;
            }

            if (preg_match("/zip/", $_FILES["deliver"]["type"]) == 1) {
                if ($this->submission->processUploadedZipFile($_FILES["deliver"]["tmp_name"])) {
                    $this->tpl->setOnScreenMessage('success', $this->lng->txt("file_added"), true);
                    $this->handleNewUpload();
                }
            }
        }

        $ilCtrl->redirect($this, "submissionScreen");
    }

Here is the call graph for this function:

Field Documentation

$help

ilHelpGUI ilExSubmissionFileGUI::$help

protected

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

Referenced by submissionScreenObject(), and uploadFormObject().

$toolbar

ilToolbarGUI ilExSubmissionFileGUI::$toolbar

protected

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

Referenced by submissionScreenObject().

$ui

UIServices ilExSubmissionFileGUI::$ui

protected

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

$user

ilObjUser ilExSubmissionFileGUI::$user

protected

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

Referenced by submissionScreenObject().

---

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

• Modules/Exercise/Submission/class.ilExSubmissionFileGUI.php