class.ilTestSubmissionReviewGUI.php

Go to the documentation of this file.

<?php

class ilTestSubmissionReviewGUI extends ilTestServiceGUI
{
    protected $testOutputGUI = null;

    protected $testSession;

    public function __construct(ilTestOutputGUI $testOutputGUI, ilObjTest $testOBJ, ilTestSession $testSession)
    {
        $this->testOutputGUI = $testOutputGUI;
        $this->testSession = $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 'pdfDownload':

                if ($this->object->getShowExamviewPdf()) {
                    $this->pdfDownload();
                }

                break;

            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
    {
        require_once 'Modules/Test/classes/class.ilTestPlayerCommands.php';
        require_once 'Services/UIComponent/Toolbar/classes/class.ilToolbarGUI.php';
        require_once 'Services/UIComponent/Button/classes/class.ilLinkButton.php';
        require_once 'Services/UIComponent/Button/classes/class.ilButton.php';

        $toolbar = new ilToolbarGUI();
        $toolbar->setId($toolbarId);

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

        $button = ilLinkButton::getInstance();
        $button->setCaption('btn_previous');
        $button->setUrl($backUrl);
        $toolbar->addButtonInstance($button);

        if ($this->object->getShowExamviewPdf()) {
            $pdfUrl = $this->ctrl->getLinkTarget($this, 'pdfDownload');

            $button = ilLinkButton::getInstance();
            $button->setCaption('pdf_export');
            $button->setUrl($pdfUrl);
            $button->setTarget(ilButton::FORM_TARGET_BLANK);
            $toolbar->addButtonInstance($button);
        }

        $this->ctrl->setParameter($this->testOutputGUI, 'reviewed', 1);
        $nextUrl = $this->ctrl->getLinkTarget($this->testOutputGUI, ilTestPlayerCommands::FINISH_TEST);
        $this->ctrl->setParameter($this->testOutputGUI, 'reviewed', 0);

        $button = ilLinkButton::getInstance();
        $button->setPrimary(true);
        $button->setCaption('btn_next');
        $button->setUrl($nextUrl);
        $toolbar->addButtonInstance($button);

        return $toolbar;
    }

    protected function buildUserReviewOutput(): string
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        $ilObjDataCache = $DIC['ilObjDataCache'];

        require_once 'Modules/Test/classes/class.ilTestResultHeaderLabelBuilder.php';
        $testResultHeaderLabelBuilder = new ilTestResultHeaderLabelBuilder($this->lng, $ilObjDataCache);

        $objectivesList = null;

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

            require_once 'Modules/Course/classes/Objectives/class.ilLOTestQuestionAdapter.php';
            $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()
        );

        require_once 'class.ilTestEvaluationGUI.php';
        $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()
    {
        global $DIC;
        $DIC->globalScreen()->tool()->context()->current()->getAdditionalData()->replace(
            ilTestPlayerLayoutProvider::TEST_PLAYER_TITLE,
            $this->object->getTitle() . ' - ' . $this->lng->txt('tst_results_overview')
        );

        $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, 'Modules/Test');
            $examIdTpl->setVariable('EXAM_ID_VAL', ilObjTest::lookupExamId(
                $this->testSession->getActiveId(),
                $this->testSession->getPass(),
                $this->object->getId()
            ));
            $examIdTpl->setVariable('EXAM_ID_TXT', $this->lng->txt('exam_id'));
            $html .= $examIdTpl->get();
        }

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

    protected function pdfDownload()
    {
        ilPDFGeneratorUtils::prepareGenerationRequest("Test", PDF_USER_RESULT);

        $reviewOutput = $this->buildUserReviewOutput();

        $filename = $this->testOutputGUI->object->getRefId();
        $filename .= '-' . $this->testSession->getActiveId() . '-';
        $filename .= $this->testSession->getPass() . '.pdf';

        ilTestPDFGenerator::generatePDF($reviewOutput, ilTestPDFGenerator::PDF_OUTPUT_DOWNLOAD, $filename, PDF_USER_RESULT);

        exit;
    }

    protected function buildPdfFilename(): string
    {
        global $DIC;
        $ilSetting = $DIC['ilSetting'];

        $inst_id = $ilSetting->get('inst_id', null);

        require_once 'Services/Utilities/classes/class.ilUtil.php';

        $path = ilFileUtils::getWebspaceDir() . '/assessment/' . $this->testOutputGUI->object->getId() . '/exam_pdf';

        if (!is_dir($path)) {
            ilFileUtils::makeDirParents($path);
        }

        $filename = ilFileUtils::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH) . '/' . $path . '/exam_N';
        $filename .= $inst_id . '-' . $this->testOutputGUI->object->getId();
        $filename .= '-' . $this->testSession->getActiveId() . '-';
        $filename .= $this->testSession->getPass() . '.pdf';

        return $filename;
    }
}