ilExSubmissionGUI Class Reference

Class ilExSubmissionGUI. More...

Collaboration diagram for ilExSubmissionGUI:

Public Member Functions
	__construct (ilObjExercise $a_exercise, ilExAssignment $a_ass, ?int $a_user_id=null)
	executeCommand ()
	getHTML (array $par)
	listPublicSubmissionsObject ()
	downloadFeedbackFileObject ()
	Download feedback file. More...
	downloadGlobalFeedbackFileObject ()
	downloadFileObject ()
	returnToParentObject ()

Data Fields
const	MODE_OVERVIEW_CONTENT = 1

Protected Attributes
ILIAS Exercise InternalDomainService	$domain
ILIAS Exercise InternalGUIService	$gui
ilCtrl	$ctrl
ilTabsGUI	$tabs_gui
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
ilObjUser	$user
ilObjExercise	$exercise
ilExSubmission	$submission
ilExAssignment	$assignment
ilExAssignmentTypesGUI	$type_guis
int	$user_id
GUIRequest	$request

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

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilExSubmissionGUI: ilExSubmissionTeamGUI, ilExSubmissionFileGUI ilExSubmissionGUI: ilExSubmissionTextGUI, ilExSubmissionObjectGUI ilExSubmissionGUI: ilExPeerReviewGUI

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

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, $lng, $service, $tpl, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), null, and ILIAS\Repository\user().

      {
        global $DIC;

        $service = $DIC->exercise()->internal();
        $this->gui = $gui = $service->gui();
        $this->domain = $domain = $service->domain();

        $this->user = $domain->user();
        $ilCtrl = $gui->ctrl();
        $ilTabs = $gui->tabs();
        $lng = $domain->lng();
        $tpl = $gui->ui()->mainTemplate();

        if (!$a_user_id) {
            $a_user_id = $this->user->getId();
        }

        $this->assignment = $a_ass;
        $this->exercise = $a_exercise;
        $this->user_id = $a_user_id;

        $this->type_guis = $gui->assignment()->types();

        // #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;
        $this->request = $DIC->exercise()->internal()->gui()->request();
        $this->domain = $DIC->exercise()->internal()->domain();
    }

Here is the call graph for this function:

Member Function Documentation

downloadFeedbackFileObject()

ilExSubmissionGUI::downloadFeedbackFileObject

(

)

Download feedback file.

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

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

                                                : bool
    {
        $file = $this->request->getFile();

        if (!isset($file)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("exc_select_one_file"), true);
            $this->ctrl->redirect($this, "view");
        }

        $this->domain->assignment()->tutorFeedbackFile($this->assignment->getId())
            ->deliver($this->user_id, $file);
        return true;
    }

Here is the call graph for this function:

downloadFileObject()

ilExSubmissionGUI::downloadFileObject

(

)

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

References $user_id, ILIAS\Repository\ctrl(), ilExcAssMemberState\getInstanceByIds(), and ILIAS\Repository\lng().

                                        : bool
    {
        $file = $this->request->getFile();

        if (!isset($file)) {
            $this->tpl->setOnScreenMessage('failure', $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) {
                    $this->domain->assignment()->instructionFiles($this->assignment->getId())->deliver($lfile["fullpath"], $file);
                }
            }
            if (!$file_exist) {
                return false;
            }
        }

        return true;
    }

Here is the call graph for this function:

downloadGlobalFeedbackFileObject()

ilExSubmissionGUI::downloadGlobalFeedbackFileObject

(

)

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

References $ctrl, $user_id, and ilExcAssMemberState\getInstanceByIds().

                                                      : void
    {
        $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->domain->assignment()->sampleSolution($this->assignment->getId())->deliver();
    }

Here is the call graph for this function:

executeCommand()

ilExSubmissionGUI::executeCommand

(

)

Exceptions

ilCtrlException

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

References $ctrl, $DIC, ilExSubmission\canView(), ILIAS\Repository\ctrl(), ilExSubmission\getAssignment(), getHTML(), ilCtrl\getNextClass(), ilExSubmissionTeamGUI\getOverviewContent(), ilExSubmission\getSubmissionType(), ILIAS\Repository\lng(), and ilExSubmission\TYPE_REPO_OBJECT.

                                    : void
    {
        $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 = $this->gui->getTeamSubmissionGUI($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);
                    $ilCtrl->forwardCommand($type_gui);
                }

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

Here is the call graph for this function:

getHTML()

ilExSubmissionGUI::getHTML

(

array

$par

)

Exceptions

ilExcUnknownAssignmentTypeException

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

Referenced by executeCommand().

                                       : string
    {
        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());
                $type_gui->getOverviewContent($par["info"], $par["submission"]);
                break;
        }
        return "";
    }

Here is the caller graph for this function:

listPublicSubmissionsObject()

ilExSubmissionGUI::listPublicSubmissionsObject

(

)

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

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

                                                 : void
    {
        $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 311 of file class.ilExSubmissionGUI.php.

References ILIAS\Repository\ctrl().

Referenced by listPublicSubmissionsObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$assignment

ilExAssignment ilExSubmissionGUI::$assignment

protected

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

$ctrl

ilCtrl ilExSubmissionGUI::$ctrl

protected

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

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

$domain

ILIAS Exercise InternalDomainService ilExSubmissionGUI::$domain

protected

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

$exercise

ilObjExercise ilExSubmissionGUI::$exercise

protected

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

$gui

ILIAS Exercise InternalGUIService ilExSubmissionGUI::$gui

protected

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

$lng

ilLanguage ilExSubmissionGUI::$lng

protected

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

Referenced by __construct(), and listPublicSubmissionsObject().

$request

GUIRequest ilExSubmissionGUI::$request

protected

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

$submission

ilExSubmission ilExSubmissionGUI::$submission

protected

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

$tabs_gui

ilTabsGUI ilExSubmissionGUI::$tabs_gui

protected

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

Referenced by listPublicSubmissionsObject().

$tpl

ilGlobalTemplateInterface ilExSubmissionGUI::$tpl

protected

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

Referenced by __construct().

$type_guis

ilExAssignmentTypesGUI ilExSubmissionGUI::$type_guis

protected

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

$user

ilObjUser ilExSubmissionGUI::$user

protected

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

$user_id

int ilExSubmissionGUI::$user_id

protected

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

Referenced by downloadFileObject(), and downloadGlobalFeedbackFileObject().

MODE_OVERVIEW_CONTENT

const ilExSubmissionGUI::MODE_OVERVIEW_CONTENT = 1

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

---

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

• components/ILIAS/Exercise/Submission/class.ilExSubmissionGUI.php