Exercise submission base gui. More...

Inheritance diagram for ilExSubmissionBaseGUI:

Collaboration diagram for ilExSubmissionBaseGUI:

Public Member Functions
	__construct (ilObjExercise $a_exercise, ilExSubmission $a_submission)

	returnToParentObject ()

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

Protected Member Functions
	handleTabs ()

	handleNewUpload ($a_no_notifications=false)

	handleRemovedUpload ()

Protected Attributes
	$ctrl

	$tabs_gui

	$lng

	$tpl

	$exercise

	$submission

	$assignment

	$type_guis

Detailed Description

Exercise submission base gui.

This is an abstract base class for all types of submissions

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

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented in ilExSubmissionFileGUI, and ilExSubmissionTextGUI.

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

    {
        global $DIC;
 
        $ilCtrl = $DIC->ctrl();
        $ilTabs = $DIC->tabs();
        $lng = $DIC->language();
        $tpl = $DIC["tpl"];
        
        $this->exercise = $a_exercise;
        $this->submission = $a_submission;
        $this->assignment = $a_submission->getAssignment();
        
        // :TODO:
        $this->ctrl = $ilCtrl;
        $this->tabs_gui = $ilTabs;
        $this->lng = $lng;
        $this->tpl = $tpl;
 
        include_once("./Modules/Exercise/AssignmentTypes/GUI/classes/class.ilExAssignmentTypesGUI.php");
        $this->type_guis = ilExAssignmentTypesGUI::getInstance();
    }

References $DIC, $ilCtrl, $lng, $tpl, ilExSubmission\getAssignment(), and ilExAssignmentTypesGUI\getInstance().

Here is the call graph for this function:

Member Function Documentation

◆ getOverviewContent()

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

staticabstract

Reimplemented in ilExSubmissionFileGUI, ilExSubmissionObjectGUI, and ilExSubmissionTextGUI.

◆ handleNewUpload()

ilExSubmissionBaseGUI::handleNewUpload ( $a_no_notifications = false )

protected

Definition at line 99 of file class.ilExSubmissionBaseGUI.php.

    {
        $has_submitted = $this->submission->hasSubmitted();
        
        $this->exercise->processExerciseStatus(
            $this->assignment,
            $this->submission->getUserIds(),
            $has_submitted,
            $this->submission->validatePeerReviews()
        );
        
        if ($has_submitted &&
            !$a_no_notifications) {
            include_once "./Services/Notification/classes/class.ilNotification.php";
            $users = ilNotification::getNotificationsForObject(ilNotification::TYPE_EXERCISE_SUBMISSION, $this->exercise->getId());
 
            include_once "./Modules/Exercise/classes/class.ilExerciseMailNotification.php";
            $not = new ilExerciseMailNotification();
            $not->setType(ilExerciseMailNotification::TYPE_SUBMISSION_UPLOAD);
            $not->setAssignmentId($this->assignment->getId());
            $not->setRefId($this->exercise->getRefId());
            $not->setRecipients($users);
            $not->send();
        }
    }

References $users, ilNotification\getNotificationsForObject(), ilNotification\TYPE_EXERCISE_SUBMISSION, and ilExerciseMailNotification\TYPE_SUBMISSION_UPLOAD.

Referenced by handleRemovedUpload(), ilExSubmissionObjectGUI\submitBlog(), ilExSubmissionObjectGUI\submitPortfolio(), ilExSubmissionTextGUI\updateAssignmentTextObject(), ilExSubmissionFileGUI\uploadFileObject(), and ilExSubmissionFileGUI\uploadZipObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleRemovedUpload()

ilExSubmissionBaseGUI::handleRemovedUpload ( )

protected

Definition at line 125 of file class.ilExSubmissionBaseGUI.php.

    {
        // #16532 - always send notifications
        $this->handleNewUpload();
    }

References handleNewUpload().

Referenced by ilExSubmissionObjectGUI\createPortfolioObject(), ilExSubmissionFileGUI\deleteDeliveredObject(), ilExSubmissionObjectGUI\saveBlogObject(), ilExSubmissionObjectGUI\setSelectedBlogObject(), ilExSubmissionObjectGUI\setSelectedPortfolioObject(), and ilExSubmissionTextGUI\updateAssignmentTextObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleTabs()

ilExSubmissionBaseGUI::handleTabs ( )

protected

Definition at line 68 of file class.ilExSubmissionBaseGUI.php.

    {
        $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->getLinkTarget($this, "")
        );
        $this->tabs_gui->activateTab("submission");
                    
        if ($this->assignment->hasTeam()) {
            include_once "Modules/Exercise/classes/class.ilExSubmissionTeamGUI.php";
            ilExSubmissionTeamGUI::handleTabs();
        }
    }

References ilExSubmissionTeamGUI\handleTabs().

Referenced by ilExSubmissionObjectGUI\createBlogObject(), ilExSubmissionTextGUI\editAssignmentTextObject(), ilExSubmissionObjectGUI\selectBlogObject(), ilExSubmissionObjectGUI\selectPortfolioObject(), ilExSubmissionTextGUI\showAssignmentTextObject(), and ilExSubmissionFileGUI\submissionScreenObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ returnToParentObject()

ilExSubmissionBaseGUI::returnToParentObject ( )

Definition at line 89 of file class.ilExSubmissionBaseGUI.php.

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

Here is the caller graph for this function:

Field Documentation

◆ $assignment

ilExSubmissionBaseGUI::$assignment

protected

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

◆ $ctrl

ilExSubmissionBaseGUI::$ctrl

protected

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

Referenced by ilExSubmissionFileGUI\confirmDeleteDeliveredObject(), ilExSubmissionObjectGUI\createPortfolioFromAssignmentObject(), ilExSubmissionFileGUI\deleteDeliveredObject(), ilExSubmissionFileGUI\downloadObject(), ilExSubmissionTextGUI\editAssignmentTextObject(), ilExSubmissionFileGUI\executeCommand(), ilExSubmissionObjectGUI\executeCommand(), ilExSubmissionTextGUI\executeCommand(), ilExSubmissionTextGUI\initAssignmentTextForm(), ilExSubmissionFileGUI\initUploadForm(), ilExSubmissionFileGUI\initZipUploadForm(), ilExSubmissionTextGUI\updateAssignmentTextObject(), ilExSubmissionFileGUI\uploadFileObject(), and ilExSubmissionFileGUI\uploadZipObject().

◆ $exercise

ilExSubmissionBaseGUI::$exercise

protected

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

◆ $lng

ilExSubmissionBaseGUI::$lng

protected

Definition at line 27 of file class.ilExSubmissionBaseGUI.php.

Referenced by __construct(), ilExSubmissionFileGUI\confirmDeleteDeliveredObject(), ilExSubmissionFileGUI\downloadReturnedObject(), ilExSubmissionFileGUI\getOverviewContent(), ilExSubmissionTextGUI\getOverviewContent(), ilExSubmissionObjectGUI\getOverviewContentBlog(), ilExSubmissionObjectGUI\getOverviewContentPortfolio(), ilExSubmissionTextGUI\initAssignmentTextForm(), ilExSubmissionFileGUI\initUploadForm(), and ilExSubmissionFileGUI\initZipUploadForm().

◆ $submission

ilExSubmissionBaseGUI::$submission

protected

Definition at line 35 of file class.ilExSubmissionBaseGUI.php.

Referenced by ilExSubmissionObjectGUI\askUnlinkPortfolioObject().

◆ $tabs_gui

ilExSubmissionBaseGUI::$tabs_gui

protected

Definition at line 22 of file class.ilExSubmissionBaseGUI.php.

◆ $tpl

ilExSubmissionBaseGUI::$tpl

protected

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

Referenced by __construct(), ilExSubmissionObjectGUI\askDirectSubmissionObject(), ilExSubmissionObjectGUI\askUnlinkPortfolioObject(), ilExSubmissionFileGUI\confirmDeleteDeliveredObject(), and ilExSubmissionObjectGUI\renderResourceSelection().

◆ $type_guis

ilExSubmissionBaseGUI::$type_guis

protected

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

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

Modules/Exercise/classes/class.ilExSubmissionBaseGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getOverviewContent()

◆ handleNewUpload()

◆ handleRemovedUpload()

◆ handleTabs()

◆ returnToParentObject()

Field Documentation

◆ $assignment

◆ $ctrl

◆ $exercise

◆ $lng

◆ $submission

◆ $tabs_gui

◆ $tpl

◆ $type_guis