ilExSubmissionGUI Class Reference

Class ilExSubmissionGUI. More...

Collaboration diagram for ilExSubmissionGUI:

Public Member Functions
	__construct (ilObjExercise $a_exercise, ilExAssignment $a_ass, $a_user_id=null)
	Constructor. More...
	executeCommand ()
	listPublicSubmissionsObject ()
	List all submissions. More...
	downloadFeedbackFileObject ()
	Download feedback file. More...
	downloadGlobalFeedbackFileObject ()
	downloadFileObject ()
	Download assignment file. More...
	returnToParentObject ()

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

Protected Attributes
	$exercise
	$submission
	$assignment

Detailed Description

Class ilExSubmissionGUI.

Author

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

@ilCtrl_Calls ilExSubmissionGUI: ilExSubmissionTeamGUI, ilExSubmissionFileGUI @ilCtrl_Calls ilExSubmissionGUI: ilExSubmissionTextGUI, ilExSubmissionObjectGUI @ilCtrl_Calls ilExSubmissionGUI: ilExPeerReviewGUI

Definition at line 17 of file class.ilExSubmissionGUI.php.

Constructor & Destructor Documentation

__construct()

ilExSubmissionGUI::__construct	(	ilObjExercise	$a_exercise,
		ilExAssignment	$a_ass,
			$a_user_id = null
	)

Constructor.

Parameters

ilObjExercise	$a_exercise
ilExAssignment	$a_ass
int	$a_user_id

Returns

object

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

        {
                global $ilCtrl, $ilTabs, $lng, $tpl, $ilUser;
                
                if(!$a_user_id)
                {
                        $a_user_id = $ilUser->getId();
                }
                
                $this->assignment = $a_ass;
                $this->exercise = $a_exercise;          
                
                // #12337
                if (!$this->exercise->members_obj->isAssigned($a_user_id))
                {
                        $this->exercise->members_obj->assignMember($a_user_id);                         
                }               
                                                
                // public submissions ???
                $public_submissions = false;
                if ($this->exercise->getShowSubmissions() &&
                        $this->exercise->getTimestamp() - time() <= 0) // ???
                {
                        $public_submissions = true;
                }                               
                $this->submission = new ilExSubmission($a_ass, $a_user_id, null, false, $public_submissions);                           
                
                // :TODO:
                $this->ctrl = $ilCtrl;
                $this->tabs_gui = $ilTabs;
                $this->lng = $lng;
                $this->tpl = $tpl;
        }

References $ilCtrl, $ilUser, $lng, and $tpl.

Member Function Documentation

downloadFeedbackFileObject()

ilExSubmissionGUI::downloadFeedbackFileObject

(

)

Download feedback file.

Definition at line 183 of file class.ilExSubmissionGUI.php.

        {
                global $ilUser;
                
                $file = $_REQUEST["file"];
 
                if (!isset($file))
                {
                        ilUtil::sendFailure($this->lng->txt("exc_select_one_file"),true);
                        $this->ctrl->redirect($this, "view");
                }
                
                // check, whether file belongs to assignment
                include_once("./Modules/Exercise/classes/class.ilFSStorageExercise.php");
                $storage = new ilFSStorageExercise($this->exercise->getId(), $this->assignment->getId());
                $files = $storage->getFeedbackFiles($this->submission->getFeedbackId());
                $file_exist = false;    
                foreach($files as $fb_file)
                {
                        if($fb_file == $file)
                        {
                                $file_exist = true;
                                break;
                        }
                }               
                if(!$file_exist)
                {
                        echo "FILE DOES NOT EXIST";
                        exit;
                }
                
                // check whether assignment has already started                                         
                if (!$this->assignment->notStartedYet())
                {
                        // deliver file
                        $p = $storage->getFeedbackFilePath($this->submission->getFeedbackId(), $file);
                        ilUtil::deliverFile($p, $file);
                }
        
                return true;
        }

References $_REQUEST, $file, $ilUser, ilUtil\deliverFile(), exit, and ilUtil\sendFailure().

Here is the call graph for this function:

downloadFileObject()

ilExSubmissionGUI::downloadFileObject

(

)

Download assignment file.

Definition at line 250 of file class.ilExSubmissionGUI.php.

        {               
                $file = $_REQUEST["file"];
 
                if (!isset($file))
                {
                        ilUtil::sendFailure($this->lng->txt("exc_select_one_file"),true);
                        $this->ctrl->redirect($this, "view");
                }
                
                // check whether assignment as already started          
                if (!$this->assignment->notStartedYet())
                {
                        // check, whether file belongs to assignment
                        $files = $this->assignment->getFiles();
                        $file_exist = false;
                        foreach($files as $lfile)
                        {
                                if($lfile["name"] == $file)
                                {
                                        // deliver file
                                        ilUtil::deliverFile($lfile["fullpath"], $file);
                                        exit();
                                }
                        }
                        if(!$file_exist)
                        {
                                echo "FILE DOES NOT EXIST";
                                exit;
                        }
                }
                
                return true;
        }

References $_REQUEST, $file, ilUtil\deliverFile(), exit, and ilUtil\sendFailure().

Here is the call graph for this function:

downloadGlobalFeedbackFileObject()

ilExSubmissionGUI::downloadGlobalFeedbackFileObject

(

)

Definition at line 225 of file class.ilExSubmissionGUI.php.

        {
                global $ilCtrl;
                
                $needs_dl = ($this->assignment->getFeedbackDate() == ilExAssignment::FEEDBACK_DATE_DEADLINE);
                
                if(!$this->assignment || 
                        !$this->assignment->getFeedbackFile() ||
                        ($needs_dl && !$this->assignment->afterDeadlineStrict()) ||                             
                        (!$needs_dl && !$this->submission->hasSubmitted()))                                             
                {
                        $ilCtrl->redirect($this, "returnToParent");
                }
 
                // this is due to temporary bug in handleGlobalFeedbackFileUpload that missed the last "/"
                $file = (is_file($this->assignment->getGlobalFeedbackFilePath()))
                        ? $this->assignment->getGlobalFeedbackFilePath()
                        : $this->assignment->getGlobalFeedbackFileStoragePath().$this->assignment->getFeedbackFile();
 
                ilUtil::deliverFile($file, $this->assignment->getFeedbackFile());
        }

References $file, $ilCtrl, ilUtil\deliverFile(), and ilExAssignment\FEEDBACK_DATE_DEADLINE.

Here is the call graph for this function:

executeCommand()

ilExSubmissionGUI::executeCommand

(

)

Definition at line 65 of file class.ilExSubmissionGUI.php.

        {
                global $ilCtrl;
                
                $class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd("listPublicSubmissions");        
                
                switch($class)
                {                                       
                        case "ilexsubmissionteamgui":           
                                // team gui has no base gui - see we have to handle tabs here
                                
                                $this->tabs_gui->clearTargets();                
                                $this->tabs_gui->setBackTarget($this->lng->txt("back"), 
                                        $this->ctrl->getLinkTarget($this, "returnToParent"));   
                
                                $this->tabs_gui->addTab("submission", $this->lng->txt("exc_submission"), 
                                        $this->ctrl->getLinkTargetByClass("ilexsubmission".$this->submission->getSubmissionType()."gui", ""));
                        
                                include_once "Modules/Exercise/classes/class.ilExSubmissionTeamGUI.php";
                                $gui = new ilExSubmissionTeamGUI($this->exercise, $this->submission);
                                $ilCtrl->forwardCommand($gui);
                                break;
                        
                        case "ilexsubmissiontextgui":
                                include_once "Modules/Exercise/classes/class.ilExSubmissionTextGUI.php";
                                $gui = new ilExSubmissionTextGUI($this->exercise, $this->submission);
                                $ilCtrl->forwardCommand($gui); 
                                break;
                        
                        case "ilexsubmissionfilegui":
                                include_once "Modules/Exercise/classes/class.ilExSubmissionFileGUI.php";
                                $gui = new ilExSubmissionFileGUI($this->exercise, $this->submission);
                                $ilCtrl->forwardCommand($gui);
                                break;
                        
                        case "ilexsubmissionobjectgui":
                                include_once "Modules/Exercise/classes/class.ilExSubmissionObjectGUI.php";
                                $gui = new ilExSubmissionObjectGUI($this->exercise, $this->submission);
                                $ilCtrl->forwardCommand($gui);
                                break;
                        
                        case "ilexpeerreviewgui":                                                       
                                $this->tabs_gui->clearTargets();                
                                $this->tabs_gui->setBackTarget($this->lng->txt("back"), 
                                        $this->ctrl->getLinkTarget($this, "returnToParent"));   
                
                                include_once("./Modules/Exercise/classes/class.ilExPeerReviewGUI.php");
                                $peer_gui = new ilExPeerReviewGUI($this->assignment, $this->submission);
                                $this->ctrl->forwardCommand($peer_gui);
                                break;
                                
                        default:                                                                        
                                $this->{$cmd."Object"}();                               
                                break;
                }
        }       

References $cmd, and $ilCtrl.

getOverviewContent()

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

static

Definition at line 123 of file class.ilExSubmissionGUI.php.

        {
                global $ilCtrl;
                
                if(!$a_submission->canView())
                {
                        return;
                }
                        
                $ilCtrl->setParameterByClass("ilExSubmissionGUI", "ass_id", $a_submission->getAssignment()->getId());
                        
                if($a_submission->getAssignment()->hasTeam())
                {
                        include_once "Modules/Exercise/classes/class.ilExSubmissionTeamGUI.php";                        
                        ilExSubmissionTeamGUI::getOverviewContent($a_info, $a_submission);
                }
                
                $submission_type = $a_submission->getSubmissionType();
                $class = "ilExSubmission".$submission_type."GUI";               
                include_once "Modules/Exercise/classes/class.".$class.".php";                   
                $class::getOverviewContent($a_info, $a_submission);                                                                                                                                     
                        
                $ilCtrl->setParameterByClass("ilExSubmissionGUI", "ass_id", "");
        }

References $ilCtrl, ilExSubmission\canView(), ilExSubmission\getAssignment(), ilExSubmissionTeamGUI\getOverviewContent(), and ilExSubmission\getSubmissionType().

Referenced by ilExAssignmentGUI\addSubmission().

Here is the call graph for this function:

Here is the caller graph for this function:

listPublicSubmissionsObject()

ilExSubmissionGUI::listPublicSubmissionsObject

(

)

List all submissions.

Definition at line 152 of file class.ilExSubmissionGUI.php.

        {                               
                global $ilTabs, $ilCtrl, $lng;
                
                if(!$this->exercise->getShowSubmissions())
                {
                        $this->returnToParentObject();
                }
                
                $ilTabs->clearTargets();
                $ilTabs->setBackTarget($lng->txt("back"),
                        $ilCtrl->getLinkTarget($this, "returnToParent"));
                
                if($this->assignment->getType() != ilExAssignment::TYPE_TEXT)
                {               
                        include_once("./Modules/Exercise/classes/class.ilPublicSubmissionsTableGUI.php");
                        $tab = new ilPublicSubmissionsTableGUI($this, "listPublicSubmissions", $this->assignment);
                        $this->tpl->setContent($tab->getHTML());
                }
                else
                {                               
                        // #13271
                        include_once "Modules/Exercise/classes/class.ilExAssignmentListTextTableGUI.php";
                        $tbl = new ilExAssignmentListTextTableGUI($this, "listPublicSubmissions", $this->assignment, false, true);              
                        $this->tpl->setContent($tbl->getHTML());                
                }
        }

References $ilCtrl, $lng, $tab, $tbl, returnToParentObject(), and ilExAssignment\TYPE_TEXT.

Here is the call graph for this function:

returnToParentObject()

ilExSubmissionGUI::returnToParentObject

(

)

Definition at line 285 of file class.ilExSubmissionGUI.php.

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

Referenced by listPublicSubmissionsObject().

Here is the caller graph for this function:

Field Documentation

$assignment

ilExSubmissionGUI::$assignment

protected

Definition at line 21 of file class.ilExSubmissionGUI.php.

$exercise

ilExSubmissionGUI::$exercise

protected

Definition at line 19 of file class.ilExSubmissionGUI.php.

$submission

ilExSubmissionGUI::$submission

protected

Definition at line 20 of file class.ilExSubmissionGUI.php.

---

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

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