class.SettingsGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Exercise\Settings;

use ILIAS\Exercise\InternalDomainService;
use ILIAS\Exercise\InternalGUIService;
use ILIAS\Repository\Form\FormAdapterGUI;
use ILIAS\Exercise\InternalDataService;

class SettingsGUI
{
    public function __construct(
        protected InternalDataService $data,
        protected InternalDomainService $domain,
        protected InternalGUIService $gui,
        protected int $obj_id
    ) {
    }

    public function executeCommand(): void
    {
        $ctrl = $this->gui->ctrl();
        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("edit");

        switch ($next_class) {
            default:
                if (in_array($cmd, ["edit", "save"])) {
                    $this->$cmd();
                }
        }
    }

    protected function edit(): void
    {
        $mt = $this->gui->ui()->mainTemplate();
        $form = $this->getEditForm();
        $mt->setContent($form->render());
    }

    protected function getEditForm(): FormAdapterGUI
    {
        $settings = $this->domain->exerciseSettings()->getByObjId($this->obj_id);
        $random_manager = $this->domain->assignment()->randomAssignments(new \ilObjExercise($this->obj_id, false));
        $lng = $this->domain->lng();

        $mand = \ilExAssignment::countMandatory($this->obj_id);
        $pass_nr_min = max($mand, 1);
        $pass_nr_max = \ilExAssignment::count($this->obj_id);

        $form = $this->gui
            ->form(self::class, "save")
            ->section("general", $lng->txt('exc_edit_exercise'))
            ->addStdTitleAndDescription($this->obj_id, "exc")
            ->section("avail", $lng->txt('rep_activation_availability'))
            ->addOnline($this->obj_id, "exc")
            ->section("pres", $lng->txt('obj_presentation'))
            ->addStdTile($this->obj_id, "exc");

        $form = $form
            ->section("pass_exc", $lng->txt('exc_passing_exc'))
            ->switch(
                "pass_mode",
                $lng->txt("exc_pass_mode"),
                (!$random_manager->canBeDeactivated() && $settings->getPassMode() == \ilObjExercise::PASS_MODE_RANDOM)
                    ? $lng->txt("exc_pass_mode_not_changeable_info") . " " .
                    implode(" ", $random_manager->getDeniedDeactivationReasons())
                    : "",
                $settings->getPassMode()
            )
            ->group(
                \ilObjExercise::PASS_MODE_ALL,
                $lng->txt("exc_pass_all"),
                $lng->txt("exc_pass_all_info")
            )
            ->group(
                \ilObjExercise::PASS_MODE_NR,
                $lng->txt("exc_pass_minimum_nr"),
                $lng->txt("exc_pass_minimum_nr_info")
            )
            ->number(
                "pass_nr",
                $lng->txt("exc_min_nr"),
                $lng->txt("exc_min_nr_info"),
                $settings->getPassNr(),
                $pass_nr_min,
                $pass_nr_max
            )->required()
            ->group(
                \ilObjExercise::PASS_MODE_RANDOM,
                $lng->txt("exc_random_selection"),
                !$random_manager->canBeActivated() && $settings->getPassMode() != \ilObjExercise::PASS_MODE_RANDOM
                    ? $lng->txt("exc_random_selection_not_changeable_info") . " " . implode(
                        " ",
                        $random_manager->getDeniedActivationReasons()
                    )
                    : $lng->txt("exc_random_selection_info"),
                (!$random_manager->canBeActivated() && $settings->getPassMode() != \ilObjExercise::PASS_MODE_RANDOM)
            )
            ->number(
                "nr_random_mand",
                $lng->txt("exc_nr_random_mand"),
                "",
                $settings->getNrMandatoryRandom(),
                1,
                \ilExAssignment::count($this->obj_id)
            )
            ->required()
            ->end()
            ->disabled((!$random_manager->canBeDeactivated() && $settings->getPassMode() == \ilObjExercise::PASS_MODE_RANDOM));

        $form = $form
            ->switch(
                "completion_by_submission",
                $lng->txt("exc_passed_status_determination"),
                "",
                $settings->getCompletionBySubmission() ? "1" : "0"
            )
            ->group("0", $lng->txt("exc_completion_by_tutor"))
            ->group(
                "1",
                $lng->txt("exc_completion_by_submission"),
                $lng->txt("exc_completion_by_submission_info")
            )->end();

        $form = $form
            ->section("publishing", $lng->txt('exc_publishing'))
            ->checkbox(
                "show_submissions",
                $lng->txt("exc_show_submissions"),
                $lng->txt("exc_show_submissions_info"),
                $settings->getShowSubmissions()
            );

        $form = $form
            ->section("notification", $lng->txt('exc_notification'))
            ->checkbox(
                "notification",
                $lng->txt("exc_submission_notification"),
                $lng->txt("exc_submission_notification_info"),
                \ilNotification::hasNotification(
                    \ilNotification::TYPE_EXERCISE_SUBMISSION,
                    $this->domain->user()->getId(),
                    $this->obj_id
                )
            );

        $form = $form
            ->section("feedback", $lng->txt('exc_feedback'))
            ->checkbox(
                "exc_settings_feedback_mail",
                $lng->txt("exc_settings_feedback_mail"),
                $lng->txt("exc_settings_feedback_mail_info"),
                $settings->hasTutorFeedbackMail()
            )
            ->checkbox(
                "exc_settings_feedback_file",
                $lng->txt("exc_settings_feedback_file"),
                $lng->txt("exc_settings_feedback_file_info"),
                $settings->hasTutorFeedbackFile()
            )
            ->checkbox(
                "exc_settings_feedback_text",
                $lng->txt("exc_settings_feedback_text"),
                $lng->txt("exc_settings_feedback_text_info"),
                $settings->hasTutorFeedbackText()
            );

        $form = $form->addAdditionalFeatures(
            $this->obj_id,
            [
                \ilObjectServiceSettingsGUI::CUSTOM_METADATA
            ]
        );

        return $form;
    }

    protected function save(): void
    {
        $mt = $this->gui->ui()->mainTemplate();
        $form = $this->getEditForm();
        $ctrl = $this->gui->ctrl();
        $lng = $this->domain->lng();

        $old_settings = $this->domain->exerciseSettings()->getByObjId($this->obj_id);

        if ($form->isValid()) {

            $form->saveStdTitleAndDescription($this->obj_id, "exc");
            $form->saveStdTile($this->obj_id, "exc");
            $form->saveOnline($this->obj_id, "exc");

            $feedback = 0;
            $feedback += $form->getData("exc_settings_feedback_mail")
                ? \ilObjExercise::TUTOR_FEEDBACK_MAIL
                : 0;
            $feedback += $form->getData("exc_settings_feedback_file")
                ? \ilObjExercise::TUTOR_FEEDBACK_FILE
                : 0;
            $feedback += $form->getData("exc_settings_feedback_text")
                ? \ilObjExercise::TUTOR_FEEDBACK_TEXT
                : 0;
            $settings = $this->data->settings(
                $this->obj_id,
                $old_settings->getInstruction(),    // obsolete?
                $old_settings->getTimeStamp(),  // obsolete?
                $form->getData("pass_mode"),
                (int) $form->getData("nr_random_mand"),
                (int) $form->getData("pass_nr"),
                (bool) $form->getData("show_submissions"),
                (bool) $form->getData("completion_by_submission"),
                (int) $old_settings->getCertificateVisibility(),  // obsolete?
                $feedback
            );
            $this->domain->exerciseSettings()->update($settings);

            \ilNotification::setNotification(
                \ilNotification::TYPE_EXERCISE_SUBMISSION,
                $this->domain->user()->getId(),
                $this->obj_id,
                (bool) $form->getData("notification")
            );
            $form->saveAdditionalFeatures(
                $this->obj_id,
                [\ilObjectServiceSettingsGUI::CUSTOM_METADATA]
            );

            $mt->setOnScreenMessage("success", $lng->txt("msg_obj_modified"), true);
            $ctrl->redirectByClass(self::class, "edit");
        } else {
            $mt = $this->gui->ui()->mainTemplate();
            $mt->setContent($form->render());
        }
    }
}