class.ilExSubmissionBaseGUI.php

Go to the documentation of this file.

<?php

use ILIAS\GlobalScreen\ScreenContext\ContextServices;
use ILIAS\Exercise\Assignment\Mandatory\MandatoryAssignmentsManager;
use ILIAS\Exercise\GUIRequest;

abstract class ilExSubmissionBaseGUI
{
    protected ilCtrl $ctrl;
    protected ilTabsGUI $tabs_gui;
    protected ilLanguage $lng;
    protected ilGlobalTemplateInterface $tpl;
    protected ilObjExercise $exercise;
    protected ilExSubmission $submission;
    protected ilExAssignment $assignment;
    protected MandatoryAssignmentsManager $mandatory_manager;
    protected ContextServices $tool_context;
    protected ilExAssignmentTypesGUI $type_guis;
    protected int $requested_ref_id;
    protected GUIRequest $request;

    public function __construct(
        ilObjExercise $a_exercise,
        ilExSubmission $a_submission
    ) {
        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();

        $this->mandatory_manager = $DIC
            ->exercise()
            ->internal()
            ->domain()
            ->assignment()
            ->mandatoryAssignments($this->exercise);

        $this->request = $DIC->exercise()->internal()->gui()->request();
        $this->requested_ref_id = $this->request->getRefId();

        // :TODO:
        $this->ctrl = $ilCtrl;
        $this->tabs_gui = $ilTabs;
        $this->lng = $lng;
        $this->tpl = $tpl;

        $this->type_guis = ilExAssignmentTypesGUI::getInstance();
        $this->tool_context = $DIC->globalScreen()->tool()->context();
    }

    abstract public static function getOverviewContent(
        ilInfoScreenGUI $a_info,
        ilExSubmission $a_submission
    ): void;

    protected function handleTabs(): void
    {
        $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()) {
            ilExSubmissionTeamGUI::handleTabs();
        }
    }

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


    //
    // RETURNED/EXERCISE STATUS
    //

    protected function handleNewUpload(
        bool $a_no_notifications = false
    ): void {
        $has_submitted = $this->submission->hasSubmitted();

        $this->exercise->processExerciseStatus(
            $this->assignment,
            $this->submission->getUserIds(),
            $has_submitted,
            $this->submission->validatePeerReviews()
        );

        if ($has_submitted &&
            !$a_no_notifications) {
            $users = ilNotification::getNotificationsForObject(ilNotification::TYPE_EXERCISE_SUBMISSION, $this->exercise->getId());

            $not = new ilExerciseMailNotification();
            $not->setType(ilExerciseMailNotification::TYPE_SUBMISSION_UPLOAD);
            $not->setAssignmentId($this->assignment->getId());
            $not->setRefId($this->exercise->getRefId());
            $not->setRecipients($users);
            $not->send();
        }
    }

    protected function handleRemovedUpload(): void
    {
        // #16532 - always send notifications
        $this->handleNewUpload();
    }

    protected function triggerAssignmentTool(): void
    {
        $ass_ids = [$this->assignment->getId()];
        $this->tool_context->current()->addAdditionalData(ilExerciseGSToolProvider::SHOW_EXC_ASSIGNMENT_INFO, true);
        $this->tool_context->current()->addAdditionalData(ilExerciseGSToolProvider::EXC_ASS_IDS, $ass_ids);
    }
}