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 ()
	getHTML ($par)
	Get HTML. More...
	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, ilObjExercise $a_exc)

Data Fields
const	MODE_OVERVIEW_CONTENT = 1

Protected Attributes
	$ctrl
	$tabs_gui
	$lng
	$tpl
	$user
	$exercise
	$submission
	$assignment
	$type_guis

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

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

Definition at line 14 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 60 of file class.ilExSubmissionGUI.php.

References $DIC, $ilUser, $lng, $tpl, ilExAssignmentTypesGUI\getInstance(), and user().

    {
        global $DIC;

        $this->user = $DIC->user();
        $ilCtrl = $DIC->ctrl();
        $ilTabs = $DIC->tabs();
        $lng = $DIC->language();
        $tpl = $DIC["tpl"];
        $ilUser = $DIC->user();
        
        if (!$a_user_id) {
            $a_user_id = $ilUser->getId();
        }
        
        $this->assignment = $a_ass;
        $this->exercise = $a_exercise;
        $this->user_id = $a_user_id;

        $this->type_guis = ilExAssignmentTypesGUI::getInstance();

        // #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;
    }

Here is the call graph for this function:

Member Function Documentation

downloadFeedbackFileObject()

ilExSubmissionGUI::downloadFeedbackFileObject

(

)

Download feedback file.

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

References $ilUser, $user, ilUtil\deliverFile(), exit, ilFSStorageExercise\getFeedbackFiles(), and ilUtil\sendFailure().

    {
        $ilUser = $this->user;
        
        $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
        $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;
    }

Here is the call graph for this function:

downloadFileObject()

ilExSubmissionGUI::downloadFileObject

(

)

Download assignment file.

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

References ilUtil\deliverFile(), exit, ilExcAssMemberState\getInstanceByIds(), and ilUtil\sendFailure().

    {
        $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
        $state = ilExcAssMemberState::getInstanceByIds($this->assignment->getId(), $this->user_id);
        if ($state->areInstructionsVisible()) {
            // 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;
    }

Here is the call graph for this function:

downloadGlobalFeedbackFileObject()

ilExSubmissionGUI::downloadGlobalFeedbackFileObject

(

)

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

References $ctrl, ilUtil\deliverFile(), and ilExcAssMemberState\getInstanceByIds().

    {
        $ilCtrl = $this->ctrl;

        $state = ilExcAssMemberState::getInstanceByIds($this->assignment->getId(), $this->user_id);
        
        // fix bug 28466, this code should be streamlined with the if above and
        // the presentation of the download link in the ilExAssignmentGUI->addSubmission
        if (!$state->isGlobalFeedbackFileAccessible($this->submission)) {
            $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());
    }

Here is the call graph for this function:

executeCommand()

ilExSubmissionGUI::executeCommand

(

)

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

References $ctrl, and ilExSubmission\TYPE_REPO_OBJECT.

    {
        $ilCtrl = $this->ctrl;
        
        $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")
                );

                // forward to type gui
                if ($this->submission->getSubmissionType() != ilExSubmission::TYPE_REPO_OBJECT) {
                    $this->tabs_gui->addTab(
                        "submission",
                        $this->lng->txt("exc_submission"),
                        $this->ctrl->getLinkTargetByClass("ilexsubmission" . $this->submission->getSubmissionType() . "gui", "")
                    );
                }

                $gui = new ilExSubmissionTeamGUI($this->exercise, $this->submission);
                $ilCtrl->forwardCommand($gui);
                break;
            
            case "ilexsubmissiontextgui":
                $gui = new ilExSubmissionTextGUI($this->exercise, $this->submission);
                $ilCtrl->forwardCommand($gui);
                break;
            
            case "ilexsubmissionfilegui":
                $gui = new ilExSubmissionFileGUI($this->exercise, $this->submission);
                $ilCtrl->forwardCommand($gui);
                break;
            
            case "ilexsubmissionobjectgui":
                $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")
                );
        
                $peer_gui = new ilExPeerReviewGUI($this->assignment, $this->submission);
                $this->ctrl->forwardCommand($peer_gui);
                break;
                
            default:


                // forward to type gui
                if ($this->type_guis->isExAssTypeGUIClass($class)) {
                    $type_gui = $this->type_guis->getByClassName($class);
                    $type_gui->setSubmission($this->submission);
                    $type_gui->setExercise($this->exercise);
                    return $ilCtrl->forwardCommand($type_gui);
                }

                $this->{$cmd . "Object"}();
                break;
        }
    }

getHTML()

ilExSubmissionGUI::getHTML

(

$par

)

Get HTML.

Parameters

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

Referenced by getOverviewContent().

    {
        switch ($par["mode"]) {
            // get overview content from ass type gui
            case self::MODE_OVERVIEW_CONTENT:
                $type_gui = $this->type_guis->getById($par["submission"]->getAssignment()->getType());
                return $type_gui->getOverviewContent($par["info"], $par["submission"]);
                break;
        }
    }

Here is the caller graph for this function:

getOverviewContent()

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

static

Parameters

ilInfoScreenGUI	$a_info
ilExSubmission	$a_submission
ilObjExercise	$a_exc

Returns

string

Exceptions

ilCtrlException

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

References $DIC, ilExSubmission\canView(), ilExSubmission\getAssignment(), getHTML(), ilExSubmissionTeamGUI\getOverviewContent(), ilExSubmission\getSubmissionType(), and ilExSubmission\TYPE_REPO_OBJECT.

Referenced by ilExAssignmentGUI\addSubmission().

    {
        global $DIC;

        $ilCtrl = $DIC->ctrl();

        if (!$a_submission->canView()) {
            return;
        }
            
        $ilCtrl->setParameterByClass("ilExSubmissionGUI", "ass_id", $a_submission->getAssignment()->getId());
            
        if ($a_submission->getAssignment()->hasTeam()) {
            ilExSubmissionTeamGUI::getOverviewContent($a_info, $a_submission);
        }
        
        $submission_type = $a_submission->getSubmissionType();
        // old handling -> forward to submission type gui class
        // @todo migrate everything to new concept
        if ($submission_type != ilExSubmission::TYPE_REPO_OBJECT) {
            $class = "ilExSubmission" . $submission_type . "GUI";
            $class::getOverviewContent($a_info, $a_submission);
        } else { // new: get HTML from assignemt type gui class
            $sub_gui = new ilExSubmissionGUI($a_exc, $a_submission->getAssignment());
            $ilCtrl->getHTML($sub_gui, array(
                "mode" => self::MODE_OVERVIEW_CONTENT,
                "info" => $a_info,
                "submission" => $a_submission
            ));
        }
            
        $ilCtrl->setParameterByClass("ilExSubmissionGUI", "ass_id", "");
    }

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 235 of file class.ilExSubmissionGUI.php.

References $ctrl, $lng, $tabs_gui, returnToParentObject(), and ilExAssignment\TYPE_TEXT.

    {
        $ilTabs = $this->tabs_gui;
        $ilCtrl = $this->ctrl;
        $lng = $this->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) {
            $tab = new ilPublicSubmissionsTableGUI($this, "listPublicSubmissions", $this->assignment);
            $this->tpl->setContent($tab->getHTML());
        } else {
            // #13271
            $tbl = new ilExAssignmentListTextTableGUI($this, "listPublicSubmissions", $this->assignment, false, true);
            $this->tpl->setContent($tbl->getHTML());
        }
    }

Here is the call graph for this function:

returnToParentObject()

ilExSubmissionGUI::returnToParentObject

(

)

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

Referenced by listPublicSubmissionsObject().

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

Here is the caller graph for this function:

Field Documentation

$assignment

ilExSubmissionGUI::$assignment

protected

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

$ctrl

ilExSubmissionGUI::$ctrl

protected

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

Referenced by downloadGlobalFeedbackFileObject(), executeCommand(), and listPublicSubmissionsObject().

$exercise

ilExSubmissionGUI::$exercise

protected

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

$lng

ilExSubmissionGUI::$lng

protected

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

Referenced by __construct(), and listPublicSubmissionsObject().

$submission

ilExSubmissionGUI::$submission

protected

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

$tabs_gui

ilExSubmissionGUI::$tabs_gui

protected

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

Referenced by listPublicSubmissionsObject().

$tpl

ilExSubmissionGUI::$tpl

protected

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

Referenced by __construct().

$type_guis

ilExSubmissionGUI::$type_guis

protected

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

$user

ilExSubmissionGUI::$user

protected

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

Referenced by downloadFeedbackFileObject().

MODE_OVERVIEW_CONTENT

const ilExSubmissionGUI::MODE_OVERVIEW_CONTENT = 1

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

---

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

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