class.ilTestCorrectionsGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer as UIRenderer;
use ILIAS\Refinery\Factory as RefineryFactory;
use ILIAS\Test\InternalRequestService;
use Psr\Http\Message\RequestInterface;
use ILIAS\TestQuestionPool\QuestionInfoService;

class ilTestCorrectionsGUI
{
    protected ilTestAccess $testAccess;

    public function __construct(
        protected ilDBInterface $database,
        protected ilCtrl $ctrl,
        protected ilAccessHandler $access,
        protected ilLanguage $language,
        protected ilTabsGUI $tabs,
        protected ilHelpGUI $help,
        protected UIFactory $ui_factory,
        protected UIRenderer $ui_renderer,
        protected ilGlobalTemplateInterface $main_tpl,
        protected RefineryFactory $refinery,
        protected RequestInterface $request,
        private InternalRequestService $testrequest,
        protected ilObjTest $testOBJ,
        protected QuestionInfoService $questioninfo
    ) {
        $this->testAccess = new ilTestAccess($testOBJ->getRefId(), $testOBJ->getTestId());
    }

    public function executeCommand()
    {
        if (!$this->testAccess->checkCorrectionsAccess()) {
            ilObjTestGUI::accessViolationRedirect();
        }
        if (
            $this->testrequest->isset('eqid') && (int) $this->testrequest->raw('eqid')
            && $this->testrequest->isset('eqpl') && (int) $this->testrequest->raw('eqpl')
        ) {
            $this->ctrl->setParameter($this, 'qid', (int) $this->testrequest->raw('eqid'));
            $this->ctrl->redirect($this, 'showQuestion');
        }
        if ($this->testrequest->isset('removeQid') && (int) $this->testrequest->raw('removeQid')) {
            $this->ctrl->setParameter($this, 'qid', (int) $this->testrequest->raw('removeQid'));
            $this->ctrl->redirect($this, 'confirmQuestionRemoval');
        }

        if ((int) $this->testrequest->raw('qid')
            && !$this->checkQuestion((int) $this->testrequest->raw('qid'))) {
            ilObjTestGUI::accessViolationRedirect();
        }

        $this->ctrl->saveParameter($this, 'qid');

        switch ($this->ctrl->getNextClass($this)) {
            default:

                $command = $this->ctrl->getCmd('showQuestionList');
                $this->{$command}();
        }
    }

    protected function showQuestionList()
    {
        $this->tabs->activateTab(ilTestTabsManager::TAB_ID_CORRECTION);

        if ($this->testOBJ->isFixedTest()) {
            $table_gui = new ilTestQuestionsTableGUI(
                $this,
                'showQuestionList',
                $this->testOBJ->getRefId(),
                $this->access,
                $this->ui_factory,
                $this->ui_renderer,
                $this->questioninfo
            );

            $table_gui->setQuestionRemoveRowButtonEnabled(true);
            $table_gui->init();

            $table_gui->setData($this->getQuestions());

            $rendered_gui_component = $table_gui->getHTML();
        } else {
            $lng = $this->language;
            $txt = $lng->txt('tst_corrections_incompatible_question_set_type');

            $infoBox = $this->ui_factory->messageBox()->info($txt);

            $rendered_gui_component = $this->ui_renderer->render($infoBox);
        }

        $this->main_tpl->setContent($rendered_gui_component);
    }

    protected function showQuestion(ilPropertyFormGUI $form = null)
    {
        $questionGUI = $this->getQuestion((int) $this->testrequest->raw('qid'));

        $this->setCorrectionTabsContext($questionGUI, 'question');

        $form ??= $this->buildQuestionCorrectionForm($questionGUI);

        $this->populatePageTitleAndDescription($questionGUI);
        $this->main_tpl->setContent($form->getHTML());
    }

    protected function saveQuestion()
    {
        $questionGUI = $this->getQuestion((int) $this->testrequest->raw('qid'));

        $form = $this->buildQuestionCorrectionForm($questionGUI);

        $form->setValuesByPost();

        if (!$form->checkInput()) {
            $questionGUI->prepareReprintableCorrectionsForm($form);

            $this->showQuestion($form);
            return;
        }

        $questionGUI->saveCorrectionsFormProperties($form);
        $questionGUI->object->setPoints($questionGUI->object->getMaximumPoints());
        $questionGUI->object->saveToDb();

        $scoring = new ilTestScoring($this->testOBJ, $this->database);
        $scoring->setPreserveManualScores(false);
        $scoring->setQuestionId($questionGUI->object->getId());
        $scoring->recalculateSolutions();

        $this->main_tpl->setOnScreenMessage('success', $this->language->txt('saved_successfully'), true);
        $this->ctrl->redirect($this, 'showQuestion');
    }

    protected function buildQuestionCorrectionForm(assQuestionGUI $questionGUI): ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setId('tst_question_correction');

        $form->setTitle($this->language->txt('tst_corrections_qst_form'));

        $hiddenQid = new ilHiddenInputGUI('qid');
        $hiddenQid->setValue((string) $questionGUI->object->getId());
        $form->addItem($hiddenQid);

        $questionGUI->populateCorrectionsFormProperties($form);

        $scoring = new ilTestScoring($this->testOBJ, $this->database);
        $scoring->setQuestionId($questionGUI->object->getId());

        if ($scoring->getNumManualScorings()) {
            $form->addCommandButton('confirmManualScoringReset', $this->language->txt('save'));
        } else {
            $form->addCommandButton('saveQuestion', $this->language->txt('save'));
        }

        return $form;
    }

    protected function addHiddenItemsFromArray(ilConfirmationGUI $gui, $array, $curPath = array())
    {
        foreach ($array as $name => $value) {
            if ($name == 'cmd' && !count($curPath)) {
                continue;
            }

            if (count($curPath)) {
                $name = "[{$name}]";
            }

            if (is_array($value)) {
                $nextPath = array_merge($curPath, array($name));
                $this->addHiddenItemsFromArray($gui, $value, $nextPath);
            } else {
                $postVar = implode('', $curPath) . $name;
                $gui->addHiddenItem($postVar, $value);
            }
        }
    }

    protected function confirmManualScoringReset()
    {
        $questionGUI = $this->getQuestion((int) $this->testrequest->raw('qid'));

        $this->setCorrectionTabsContext($questionGUI, 'question');

        $scoring = new ilTestScoring($this->testOBJ, $this->database);
        $scoring->setQuestionId($questionGUI->object->getId());

        $confirmation = sprintf(
            $this->language->txt('tst_corrections_manscore_reset_warning'),
            $scoring->getNumManualScorings(),
            $questionGUI->object->getTitleForHTMLOutput(),
            $questionGUI->object->getId()
        );

        $gui = new ilConfirmationGUI();
        $gui->setHeaderText($confirmation);
        $gui->setFormAction($this->ctrl->getFormAction($this));
        $gui->setCancel($this->language->txt('cancel'), 'showQuestion');
        $gui->setConfirm($this->language->txt('confirm'), 'saveQuestion');

        $this->addHiddenItemsFromArray($gui, $this->testrequest->getParsedBody());

        $this->main_tpl->setContent($gui->getHTML());
    }

    protected function showSolution()
    {
        $questionGUI = $this->getQuestion((int) $this->testrequest->raw('qid'));


        $pageGUI = new ilAssQuestionPageGUI($questionGUI->object->getId());
        $pageGUI->setRenderPageContainer(false);
        $pageGUI->setEditPreview(true);
        $pageGUI->setEnabledTabs(false);

        $solutionHTML = $questionGUI->getSolutionOutput(
            0,
            null,
            false,
            false,
            true,
            false,
            true,
            false,
            true
        );

        $pageGUI->setQuestionHTML(array($questionGUI->object->getId() => $solutionHTML));
        $pageGUI->setPresentationTitle($questionGUI->object->getTitleForHTMLOutput());

        $tpl = new ilTemplate('tpl.tst_corrections_solution_presentation.html', true, true, 'Modules/Test');
        $tpl->setVariable('SOLUTION_PRESENTATION', $pageGUI->preview());

        $this->populatePageTitleAndDescription($questionGUI);

        $this->main_tpl->setContent($tpl->get());

        $this->main_tpl->setCurrentBlock("ContentStyle");
        $stylesheet = ilObjStyleSheet::getContentStylePath(0);
        $this->main_tpl->setVariable("LOCATION_CONTENT_STYLESHEET", $stylesheet);
        $this->main_tpl->parseCurrentBlock();

        $this->main_tpl->setCurrentBlock("SyntaxStyle");
        $stylesheet = ilObjStyleSheet::getSyntaxStylePath();
        $this->main_tpl->setVariable("LOCATION_SYNTAX_STYLESHEET", $stylesheet);
        $this->main_tpl->parseCurrentBlock();
        $this->setCorrectionTabsContext($questionGUI, 'solution');
    }

    protected function showAnswerStatistic(?array $participant_results = null)
    {
        $questionGUI = $this->getQuestion((int) $this->testrequest->raw('qid'));
        $solutions = $participant_results
            ? $this->getSolutionsByParticipantResults($questionGUI->object, $participant_results)
            : $this->getSolutions($questionGUI->object);

        $this->setCorrectionTabsContext($questionGUI, 'answers');

        $tablesHtml = '';

        foreach ($questionGUI->getSubQuestionsIndex() as $subQuestionIndex) {
            $table = $questionGUI->getAnswerFrequencyTableGUI(
                $this,
                'showAnswerStatistic',
                $solutions,
                $subQuestionIndex
            );

            $tablesHtml .= $table->getHTML() . $table->getAdditionalHtml();
        }

        $this->populatePageTitleAndDescription($questionGUI);
        $this->main_tpl->setContent($tablesHtml);
    }

    protected function addAnswer()
    {
        $form_builder = new ilAddAnswerFormBuilder($this, $this->ui_factory, $this->refinery, $this->language, $this->ctrl);

        $form = $form_builder->buildAddAnswerForm()
            ->withRequest($this->request);

        $data = $form->getData();
        $question_id = $data['question_id'];

        if (!$this->checkQuestion($question_id)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt('form_input_not_valid'));
            $this->showAnswerStatistic();
            return;
        }

        $question_gui = $this->getQuestion($question_id);

        $question_index = $data['question_index'];
        $answer_value = $data['answer_value'];
        $points = $data['points'];

        if (!$points) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt('err_no_numeric_value'));
            $this->showAnswerStatistic();
            return;
        }

        if ($question_gui->object->isAddableAnswerOptionValue($question_index, $answer_value)) {
            $question_gui->object->addAnswerOptionValue($question_index, $answer_value, $points);
            $question_gui->object->saveToDb();
        }

        $scoring = new ilTestScoring($this->testOBJ, $this->database);
        $scoring->setPreserveManualScores(true);
        $scoring->setQuestionId($question_id);
        $results = $scoring->recalculateSolutions();

        $this->main_tpl->setOnScreenMessage('success', $this->language->txt('saved_successfully'));
        $this->showAnswerStatistic($results);
    }

    protected function confirmQuestionRemoval()
    {
        $this->tabs->activateTab(ilTestTabsManager::TAB_ID_CORRECTION);

        $questionGUI = $this->getQuestion((int) $this->testrequest->raw('qid'));

        $confirmation = sprintf(
            $this->language->txt('tst_corrections_qst_remove_confirmation'),
            $questionGUI->object->getTitleForHTMLOutput(),
            $questionGUI->object->getId()
        );

        $buttons = array(
            $this->ui_factory->button()->standard(
                $this->language->txt('confirm'),
                $this->ctrl->getLinkTarget($this, 'performQuestionRemoval')
            ),
            $this->ui_factory->button()->standard(
                $this->language->txt('cancel'),
                $this->ctrl->getLinkTarget($this, 'showQuestionList')
            )
        );

        $this->main_tpl->setContent($this->ui_renderer->render(
            $this->ui_factory->messageBox()->confirmation($confirmation)->withButtons($buttons)
        ));
    }

    protected function performQuestionRemoval(): void
    {
        $questionGUI = $this->getQuestion((int) $this->testrequest->raw('qid'));
        $scoring = new ilTestScoring($this->testOBJ, $this->database);

        $participantData = new ilTestParticipantData($this->database, $this->language);
        $participantData->load($this->testOBJ->getTestId());

        // remove question solutions
        $questionGUI->object->removeAllExistingSolutions();

        // remove test question results
        $scoring->removeAllQuestionResults($questionGUI->object->getId());

        // remove question from test and reindex remaining questions
        $this->testOBJ->removeQuestion($questionGUI->object->getId());
        $reindexedSequencePositionMap = $this->testOBJ->reindexFixedQuestionOrdering();
        $this->testOBJ->loadQuestions();

        // remove questions from all sequences
        $this->testOBJ->removeQuestionFromSequences(
            $questionGUI->object->getId(),
            $participantData->getActiveIds(),
            $reindexedSequencePositionMap
        );

        // update pass and test results
        $scoring->updatePassAndTestResults($participantData->getActiveIds());

        // trigger learning progress
        ilLPStatusWrapper::_refreshStatus($this->testOBJ->getId(), $participantData->getUserIds());

        // finally delete the question itself
        $questionGUI->object->delete($questionGUI->object->getId());

        // check for empty test and set test offline
        if (!count($this->testOBJ->getTestQuestions())) {
            $object_properties = $this->testOBJ->getObjectProperties();
            $object_properties->storePropertyIsOnline(
                $object_properties->getPropertyIsOnline()->withOffline()
            );
        }

        $this->ctrl->setParameter($this, 'qid', '');
        $this->ctrl->redirect($this, 'showQuestionList');
    }

    protected function setCorrectionTabsContext(assQuestionGUI $questionGUI, $activeTabId)
    {
        $this->tabs->clearTargets();
        $this->tabs->clearSubTabs();

        $this->help->setScreenIdComponent("tst");
        $this->help->setScreenId("scoringadjust");
        $this->help->setSubScreenId($activeTabId);


        $this->tabs->setBackTarget(
            $this->language->txt('back'),
            $this->ctrl->getLinkTarget($this, 'showQuestionList')
        );

        $this->tabs->addTab(
            'question',
            $this->language->txt('tst_corrections_tab_question'),
            $this->ctrl->getLinkTarget($this, 'showQuestion')
        );

        $this->tabs->addTab(
            'solution',
            $this->language->txt('tst_corrections_tab_solution'),
            $this->ctrl->getLinkTarget($this, 'showSolution')
        );

        if ($questionGUI->isAnswerFrequencyStatisticSupported()) {
            $this->tabs->addTab(
                'answers',
                $this->language->txt('tst_corrections_tab_statistics'),
                $this->ctrl->getLinkTarget($this, 'showAnswerStatistic')
            );
        }

        $this->tabs->activateTab($activeTabId);
    }

    protected function populatePageTitleAndDescription(assQuestionGUI $questionGUI)
    {
        $this->main_tpl->setTitle($questionGUI->object->getTitleForHTMLOutput());
        $this->main_tpl->setDescription($questionGUI->outQuestionType());
    }

    protected function checkQuestion($qId): bool
    {
        if (!$this->testOBJ->isTestQuestion($qId)) {
            return false;
        }

        $questionGUI = $this->getQuestion($qId);

        if (!$this->supportsAdjustment($questionGUI)) {
            return false;
        }

        if (!$this->allowedInAdjustment($questionGUI)) {
            return false;
        }

        return true;
    }

    protected function getQuestion($qId): assQuestionGUI
    {
        $question = assQuestion::instantiateQuestionGUI($qId);
        $question->object->setObjId($this->testOBJ->getId());

        return $question;
    }

    protected function getSolutions(assQuestion $question): array
    {
        $solutionRows = array();

        foreach ($this->testOBJ->getParticipants() as $activeId => $participantData) {
            $passesSelector = new ilTestPassesSelector($this->database, $this->testOBJ);
            $passesSelector->setActiveId($activeId);
            $passesSelector->loadLastFinishedPass();

            foreach ($passesSelector->getClosedPasses() as $pass) {
                foreach ($question->getSolutionValues($activeId, $pass) as $row) {
                    $solutionRows[] = $row;
                }
            }
        }

        return $solutionRows;
    }

    protected function getSolutionsByParticipantResults(assQuestion $question, array $participant_results): array
    {
        $solutions = [];

        foreach ($participant_results as $active_id => $result) {
            foreach ($result->getPasses() as $pass) {
                foreach ($question->getSolutionValues($active_id, $pass->getPass()) as $row) {
                    $solutions[] = $row;
                }
            }
        }

        return $solutions;
    }

    protected function getQuestions(): array
    {
        $questions = array();

        foreach ($this->testOBJ->getTestQuestions() as $questionData) {
            $questionGUI = $this->getQuestion($questionData['question_id']);

            if (!$this->supportsAdjustment($questionGUI)) {
                continue;
            }

            if (!$this->allowedInAdjustment($questionGUI)) {
                continue;
            }

            $questions[] = $questionData;
        }

        return $questions;
    }

    protected function supportsAdjustment(\assQuestionGUI $question_object): bool
    {
        return ($question_object instanceof ilGuiQuestionScoringAdjustable
                || $question_object instanceof ilGuiAnswerScoringAdjustable)
            && ($question_object->object instanceof ilObjQuestionScoringAdjustable
                || $question_object->object instanceof ilObjAnswerScoringAdjustable);
    }

    protected function allowedInAdjustment(\assQuestionGUI $question_object): bool
    {
        $type_def = [];
        foreach (explode(',', (new ilSetting('assessment'))->get('assessment_scoring_adjustment', '')) as $type) {
            $type_def[$type] = ilObjQuestionPool::getQuestionTypeByTypeId($type);
        }

        return in_array($question_object->getQuestionType(), $type_def);
    }
}