ilExSubmissionFileGUI Class Reference

File-based submissions. More...

Inheritance diagram for ilExSubmissionFileGUI:

Collaboration diagram for ilExSubmissionFileGUI:

Public Member Functions
	executeCommand ()
	submissionScreenObject ()
	Displays a form which allows members to deliver their solutions. More...
	uploadFormObject (ilPropertyFormGUI $a_form=null)
	Display form for single file upload. More...
	uploadZipFormObject (ilPropertyFormGUI $a_form=null)
	Display form for zip file upload. More...
	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 ($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	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 ($a_no_notifications=false)
	handleRemovedUpload ()

Additional Inherited Members
Protected Attributes inherited from ilExSubmissionBaseGUI
	$exercise
	$submission
	$assignment

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

@ilCtrl_Calls ilExSubmissionFileGUI:

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

Member Function Documentation

confirmDeleteDeliveredObject()

ilExSubmissionFileGUI::confirmDeleteDeliveredObject

(

)

Confirm deletion of delivered files.

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

        {
                global $ilCtrl, $tpl, $lng;
                
                if (!$this->submission->canSubmit())
                {
                        ilUtil::sendFailure($this->lng->txt("exercise_time_over"), true);
                        $ilCtrl->redirect($this, "submissionScreen");
                }
                
                if (!is_array($_POST["delivered"]) || count($_POST["delivered"]) == 0)
                {
                        ilUtil::sendFailure($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"));
                
                        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
                        $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 ($_POST["delivered"] 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());
                }
        }

References $_POST, $files, $ilCtrl, $lng, $title, $tpl, and ilUtil\sendFailure().

Here is the call graph for this function:

deleteDeliveredObject()

ilExSubmissionFileGUI::deleteDeliveredObject

(

)

Delete file(s) submitted by user.

Parameters

return

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

        {
                global $ilCtrl;
                
                if (!$this->submission->canSubmit())
                {
                        ilUtil::sendFailure($this->lng->txt("exercise_time_over"), true);                       
                }               
                else if (!count($_POST["delivered"]))
                {
                        ilUtil::sendFailure($this->lng->txt("please_select_a_delivered_file_to_delete"), true);
                }
                else
                {
                        $this->submission->deleteSelectedFiles($_POST["delivered"]);                            
                        $this->handleRemovedUpload();
                        
                        ilUtil::sendSuccess($this->lng->txt("exc_submitted_files_deleted"), true);
                }               
                $ilCtrl->redirect($this, "submissionScreen");
        }       

References $_POST, $ilCtrl, ilExSubmissionBaseGUI\handleRemovedUpload(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

Here is the call graph for this function:

downloadNewReturnedObject()

ilExSubmissionFileGUI::downloadNewReturnedObject

(

)

Download newly submitted files of user.

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

        {                                               
                $this->downloadReturnedObject(true);    
        }

References downloadReturnedObject().

Here is the call graph for this function:

downloadObject()

ilExSubmissionFileGUI::downloadObject

(

)

User downloads (own) submitted files.

Parameters

return

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

        {
                global $ilCtrl;
 
                if(!$this->submission->canView())
                {
                        $this->returnToParentObject();
                }
                
                if (count($_REQUEST["delivered"]))
                {
                        if(!is_array($_REQUEST["delivered"]))
                        {
                                $_REQUEST["delivered"] = array($_REQUEST["delivered"]);
                        }
                        $this->submission->downloadFiles($_REQUEST["delivered"]);
                        exit;
                }
                else
                {
                        ilUtil::sendFailure($this->lng->txt("please_select_a_delivered_file_to_download"), true);
                        $ilCtrl->redirect($this, "submissionScreen");
                }
        }

References $ilCtrl, exit, ilExSubmissionBaseGUI\returnToParentObject(), and ilUtil\sendFailure().

Here is the call graph for this function:

downloadReturnedObject()

ilExSubmissionFileGUI::downloadReturnedObject

(

$a_only_new = false

)

Download submitted files of user.

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

        {               
                $peer_review_mask_filename = false;
                
                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);                        
                $this->returnToParentObject();
        }

References ilExSubmissionBaseGUI\returnToParentObject().

Referenced by downloadNewReturnedObject().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilExSubmissionFileGUI::executeCommand

(

)

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

        {
                global $ilCtrl;
                
                if(!$this->submission->canView())
                {
                        $this->returnToParentObject();
                }
                
                $class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd("submissionScreen");             
                
                switch($class)
                {               
                        default:                                                                        
                                $this->{$cmd."Object"}();                               
                                break;                  
                }
        }

References $cmd, $ilCtrl, and ilExSubmissionBaseGUI\returnToParentObject().

Here is the call graph for this function:

getOverviewContent()

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

static

Reimplemented from ilExSubmissionBaseGUI.

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

        {               
                global $lng, $ilCtrl;
                
                $titles = array();
                foreach($a_submission->getFiles() as $file)
                {
                        $titles[] = $file["filetitle"];
                }
                $files_str = implode($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.= " ".$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.= " ".$button->render();
                                }
                        }
                }
 
                $a_info->addProperty($lng->txt("exc_files_returned"), $files_str);      
        }

References $file, $ilCtrl, $lng, $title, ilInfoScreenGUI\addProperty(), ilExSubmission\canSubmit(), ilExSubmission\getFiles(), ilLinkButton\getInstance(), and ilExSubmission\hasNoTeamYet().

Here is the call graph for this function:

initUploadForm()

ilExSubmissionFileGUI::initUploadForm ( )

protected

Init upload form form.

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

        {
                global $lng, $ilCtrl;
        
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
        
                // file input
                include_once("./Services/Form/classes/class.ilFileWizardInputGUI.php");
                $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;
        }

References $ilCtrl, and $lng.

Referenced by uploadFileObject(), and uploadFormObject().

Here is the caller graph for this function:

initZipUploadForm()

ilExSubmissionFileGUI::initZipUploadForm ( )

protected

Init upload form form.

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

        {
                global $lng, $ilCtrl;
        
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
        
                include_once("./Services/Form/classes/class.ilFileInputGUI.php");
                $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;
        }

References $ilCtrl, and $lng.

Referenced by uploadZipFormObject(), and uploadZipObject().

Here is the caller graph for this function:

submissionScreenObject()

ilExSubmissionFileGUI::submissionScreenObject

(

)

Displays a form which allows members to deliver their solutions.

@access public

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

        {
                global $ilToolbar, $ilHelp, $ilUser;
 
 
                $this->handleTabs();
 
                $ilHelp->setScreenIdComponent("exc");
                $ilHelp->setScreenId("submissions");
 
                if (!$this->submission->canSubmit())
                {
                        ilUtil::sendInfo($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);
                                }
                                
                                $ilToolbar->addButton($this->lng->txt("file_add"), 
                                        $this->ctrl->getLinkTarget($this, "uploadForm"));
 
                                if(!$max_files ||
                                        $max_files > 1)
                                {
                                        $ilToolbar->addButton($this->lng->txt("header_zip"), 
                                                $this->ctrl->getLinkTarget($this, "uploadZipForm"));
                                }
                        }
                        
                        if($max_files)
                        {
                                ilUtil::sendInfo(sprintf($this->lng->txt("exc_max_file_reached"), $max_files));
                        }                       
                }
 
                include_once("./Modules/Exercise/classes/class.ilExcDeliveredFilesTableGUI.php");
                $tab = new ilExcDeliveredFilesTableGUI($this, "submissionScreen", $this->submission);
                $this->tpl->setContent($tab->getHTML());
        }

References $ilUser, $tab, ilDatePresentation\formatDate(), ilExSubmissionBaseGUI\handleTabs(), IL_CAL_UNIX, ilUtil\sendInfo(), and sprintf.

Here is the call graph for this function:

uploadFileObject()

ilExSubmissionFileGUI::uploadFileObject

(

)

Upload files.

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

        {
                global $ilCtrl;
                
                // #15322
                if (!$this->submission->canSubmit())
                {
                        ilUtil::sendInfo($this->lng->txt("exercise_time_over"), true);                  
                }
                else
                {
                        $form = $this->initUploadForm();
                        if(!$form->checkInput())
                        {
                                return $this->uploadFormObject($form);
                        }
                        
                        $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))
                                {
                                        ilUtil::sendFailure($this->lng->txt("exc_upload_error"), true);
                                }
                                else
                                {
                                        $success = true;
                                }
                        }
 
                        if($success)
                        {
                                ilUtil::sendSuccess($this->lng->txt("file_added"), true);                               
                                $this->handleNewUpload();
                        }
                }
                
                $ilCtrl->redirect($this, "submissionScreen");
        }

References $file, $ilCtrl, $success, ilExSubmissionBaseGUI\handleNewUpload(), initUploadForm(), ilUtil\sendFailure(), ilUtil\sendInfo(), ilUtil\sendSuccess(), and uploadFormObject().

Here is the call graph for this function:

uploadFormObject()

ilExSubmissionFileGUI::uploadFormObject

(

ilPropertyFormGUI

$a_form = null

)

Display form for single file upload.

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

        {               
                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"));
 
                global $ilHelp;
                $ilHelp->setScreenIdComponent("exc");
                $ilHelp->setScreenId("upload_submission");
 
                if(!$a_form)
                {
                        $a_form = $this->initUploadForm();
                }
                $this->tpl->setContent($a_form->getHTML());     
        }

References initUploadForm().

Referenced by uploadFileObject().

Here is the call graph for this function:

Here is the caller graph for this function:

uploadZipFormObject()

ilExSubmissionFileGUI::uploadZipFormObject

(

ilPropertyFormGUI

$a_form = null

)

Display form for zip file upload.

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

        {               
                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());     
        }

References initZipUploadForm().

Referenced by uploadZipObject().

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 287 of file class.ilExSubmissionFileGUI.php.

        {
                global $ilCtrl;
        
                // #15322
                if (!$this->submission->canSubmit())
                {
                        ilUtil::sendInfo($this->lng->txt("exercise_time_over"), true);                  
                }
                else 
                {
                        $form = $this->initZipUploadForm();
                        if(!$form->checkInput())
                        {
                                return $this->uploadZipFormObject($form);
                        }
                        
                        if (preg_match("/zip/",$_FILES["deliver"]["type"]) == 1)
                        {
                                if($this->submission->processUploadedZipFile($_FILES["deliver"]["tmp_name"]))
                                {
                                        ilUtil::sendSuccess($this->lng->txt("file_added"), true);                               
                                        $this->handleNewUpload();                               
                                }
                        }
                }
                
                $ilCtrl->redirect($this, "submissionScreen");
        }

References $ilCtrl, ilExSubmissionBaseGUI\handleNewUpload(), initZipUploadForm(), ilUtil\sendInfo(), ilUtil\sendSuccess(), and uploadZipFormObject().

Here is the call graph for this function:

---

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

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