class.ilTestSubmissionReviewGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Test\Results\Presentation\TitlesBuilder as ResultsTitlesBuilder;
use ILIAS\Test\Presentation\WorkingTime;
use ILIAS\UI\Component\Modal\Interruptive as InterruptiveModal;

class ilTestSubmissionReviewGUI extends ilTestServiceGUI
{
    private ?InterruptiveModal $finish_test_modal = null;

    public function __construct(
        protected ilTestPlayerAbstractGUI $test_player_gui,
        ilObjTest $testOBJ,
        protected ilTestSession $testSession
    ) {
        parent::__construct($testOBJ);
    }

    public function executeCommand(): string
    {
        if (!$this->object->getEnableExamview()) {
            return '';
        }

        switch ($this->ctrl->getNextClass($this)) {
            default:
                $this->dispatchCommand();
                break;
        }

        return '';
    }

    protected function dispatchCommand()
    {
        switch ($this->ctrl->getCmd()) {
            case 'show':
            default:
                $this->show();
        }
    }

    private function getContentBlockName(): string
    {
        if ($this->object->getKioskMode()) {
            // See: https://mantis.ilias.de/view.php?id=27784
            //$this->tpl->setBodyClass("kiosk");
            $this->tpl->hideFooter();
            return "CONTENT";
        } else {
            return "ADM_CONTENT";
        }
    }

    protected function buildToolbar($toolbarId): ilToolbarGUI
    {
        $toolbar = new ilToolbarGUI();
        $toolbar->setId($toolbarId);

        $back_url = $this->ctrl->getLinkTarget(
            $this->test_player_gui,
            $this->object->getListOfQuestionsEnd() ?
            ilTestPlayerCommands::QUESTION_SUMMARY : ilTestPlayerCommands::BACK_FROM_FINISHING
        );

        $toolbar->addComponent(
            $this->ui_factory->button()->standard($this->lng->txt('tst_resume_test'), $back_url)
        );

        if ($this->finish_test_modal === null) {
            $class = get_class($this->test_player_gui);
            $this->ctrl->setParameterByClass($class, 'reviewed', 1);
            $this->finish_test_modal = $this->test_player_gui->buildFinishTestModal();
            $this->ctrl->setParameterByClass($class, 'reviewed', 0);
        }

        $toolbar->addComponent(
            $this->ui_factory->button()->primary($this->lng->txt('finish_test'), $this->finish_test_modal->getShowSignal())
        );

        return $toolbar;
    }

    protected function buildUserReviewOutput(): string
    {
        $testResultHeaderLabelBuilder = new ResultsTitlesBuilder($this->lng, $this->obj_cache);

        $objectivesList = null;

        if ($this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()) {
            $testSequence = $this->test_sequence_factory->getSequenceByActiveIdAndPass($this->testSession->getActiveId(), $this->testSession->getPass());
            $testSequence->loadFromDb();
            $testSequence->loadQuestions();

            $objectivesAdapter = ilLOTestQuestionAdapter::getInstance($this->testSession);

            $objectivesList = $this->buildQuestionRelatedObjectivesList($objectivesAdapter, $testSequence);
            $objectivesList->loadObjectivesTitles();

            $testResultHeaderLabelBuilder->setObjectiveOrientedContainerId($this->testSession->getObjectiveOrientedContainerId());
            $testResultHeaderLabelBuilder->setUserId($this->testSession->getUserId());
            $testResultHeaderLabelBuilder->setTestObjId($this->object->getId());
            $testResultHeaderLabelBuilder->setTestRefId($this->object->getRefId());
            $testResultHeaderLabelBuilder->initObjectiveOrientedMode();
        }

        $results = $this->object->getTestResult(
            $this->testSession->getActiveId(),
            $this->testSession->getPass(),
            false,
            !$this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()
        );

        $testevaluationgui = new ilTestEvaluationGUI($this->object);
        $testevaluationgui->setContextResultPresentation(false);

        $results_output = $testevaluationgui->getPassListOfAnswers(
            $results,
            $this->testSession->getActiveId(),
            $this->testSession->getPass(),
            false,
            false,
            false,
            false,
            false,
            $objectivesList,
            $testResultHeaderLabelBuilder
        );

        return $results_output;
    }

    protected function show(): void
    {
        $this->global_screen->tool()->context()->current()->getAdditionalData()->replace(
            ilTestPlayerLayoutProvider::TEST_PLAYER_VIEW_TITLE,
            $this->object->getTitle() . ' - ' . $this->lng->txt('tst_results_overview')
        );

        $html = '';
        if ($this->object->getEnableProcessingTime()) {
            $active_id = $this->testSession->getActiveId();
            $starting_time = $this->object->getStartingTimeOfUser($active_id);
            $working_time = new WorkingTime(
                $this->lng,
                $this->ui_factory,
                $this->ui_renderer,
                $starting_time,
                $this->object->getProcessingTimeInSeconds($active_id)
            );

            $html .= $working_time->getMessageBox(true);

            $class = $this->getObject()->isFixedTest()
                ? ilTestPlayerFixedQuestionSetGUI::class
                : ilTestPlayerRandomQuestionSetGUI::class;

            $working_time_js_template = $working_time->prepareWorkingTimeJsTemplate(
                $this->getObject(),
                getdate($starting_time),
                $this->ctrl->getLinkTargetByClass($class, 'checkWorkingTime', '', true),
                $this->ctrl->getFormActionByClass($class, ilTestPlayerCommands::REDIRECT_AFTER_QUESTION_LIST)
            );

            $this->tpl->addOnLoadCode($working_time_js_template->get());
        }

        $html .= $this->buildToolbar('review_nav_top')->getHTML();
        $html .= $this->buildUserReviewOutput() . '<br />';
        $html .= $this->buildToolbar('review_nav_bottom')->getHTML();

        if ($this->object->isShowExamIdInTestPassEnabled() && !$this->object->getKioskMode()) {
            $examIdTpl = new ilTemplate('tpl.exam_id_block.html', true, true, 'components/ILIAS/Test');
            $examIdTpl->setVariable('EXAM_ID_VAL', ilObjTest::lookupExamId(
                $this->testSession->getActiveId(),
                $this->testSession->getPass(),
            ));
            $examIdTpl->setVariable('EXAM_ID_TXT', $this->lng->txt('exam_id'));
            $html .= $examIdTpl->get();
        }

        $html .= $this->ui_renderer->render($this->finish_test_modal);

        $this->tpl->setVariable($this->getContentBlockName(), $html);
    }
}