class.ilAssQuestionHintRequestGUI.php

Go to the documentation of this file.

<?php

class ilAssQuestionHintRequestGUI extends ilAssQuestionHintAbstractGUI
{
    public const CMD_SHOW_LIST = 'showList';
    public const CMD_SHOW_HINT = 'showHint';
    public const CMD_CONFIRM_REQUEST = 'confirmRequest';
    public const CMD_PERFORM_REQUEST = 'performRequest';
    public const CMD_BACK_TO_QUESTION = 'backToQuestion';

    protected $parentGUI = null;

    protected $parentCMD = null;

    protected $questionHintTracking = null;

    public function __construct($parentGUI, $parentCMD, assQuestionGUI $questionGUI, $questionHintTracking)
    {
        $this->parentGUI = $parentGUI;
        $this->parentCMD = $parentCMD;
        $this->questionHintTracking = $questionHintTracking;

        parent::__construct($questionGUI);
    }

    public function executeCommand()
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $ilTabs = $DIC['ilTabs'];
        $lng = $DIC['lng'];

        $cmd = $ilCtrl->getCmd(self::CMD_SHOW_LIST);
        $nextClass = $ilCtrl->getNextClass($this);

        switch ($nextClass) {
            case 'ilasshintpagegui':

                require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintPageObjectCommandForwarder.php';
                $forwarder = new ilAssQuestionHintPageObjectCommandForwarder($this->questionOBJ, $ilCtrl, $ilTabs, $lng);
                $forwarder->setPresentationMode(ilAssQuestionHintPageObjectCommandForwarder::PRESENTATION_MODE_REQUEST);
                $forwarder->forward();
                break;

            default:

                $cmd .= 'Cmd';
                return $this->$cmd();
                break;
        }
        return '';
    }

    private function showListCmd(): void
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];

        if ($DIC->globalScreen()->tool()->context()->current()->getAdditionalData()
            ->exists(ilTestPlayerLayoutProvider::TEST_PLAYER_TITLE)) {
            $DIC->globalScreen()->tool()->context()->current()->getAdditionalData()->replace(
                ilTestPlayerLayoutProvider::TEST_PLAYER_TITLE,
                $this->parentGUI->getObject()->getTitle() . ' - ' . $lng->txt('show_requested_question_hints')
            );
        }

        require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintsTableGUI.php';

        $questionHintList = $this->questionHintTracking->getRequestedHintsList();

        $table = new ilAssQuestionHintsTableGUI(
            $this->questionOBJ,
            $questionHintList,
            $this,
            self::CMD_SHOW_LIST
        );

        $this->populateContent($ilCtrl->getHtml($table), $tpl);
    }

    private function showHintCmd(): void
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];

        if (!$this->request->isset('hintId') || !(int) $this->request->raw('hintId')) {
            throw new ilTestException('no hint id given');
        }

        $isRequested = $this->questionHintTracking->isRequested((int) $this->request->raw('hintId'));

        if (!$isRequested) {
            throw new ilTestException('hint with given id is not yet requested for given testactive and testpass');
        }

        $questionHint = ilAssQuestionHint::getInstanceById((int) $this->request->raw('hintId'));

        require_once 'Services/Utilities/classes/class.ilUtil.php';
        require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
        require_once 'Services/Form/classes/class.ilNonEditableValueGUI.php';

        if ($DIC->globalScreen()->tool()->context()->current()->getAdditionalData()
            ->exists(ilTestPlayerLayoutProvider::TEST_PLAYER_TITLE)) {
            $DIC->globalScreen()->tool()->context()->current()->getAdditionalData()->replace(
                ilTestPlayerLayoutProvider::TEST_PLAYER_TITLE,
                $this->parentGUI->getObject()->getTitle() . ' - ' . sprintf(
                    $lng->txt('tst_question_hints_form_header_edit'),
                    $questionHint->getIndex(),
                    $this->request->int('sequence') ?? 0
                )
            );
        }

        $form = new ilPropertyFormGUI();

        $form->setFormAction($ilCtrl->getFormAction($this));

        $form->setTableWidth('100%');

        $form->setTitle(sprintf(
            $lng->txt('tst_question_hints_form_header_edit'),
            $questionHint->getIndex(),
            $this->questionOBJ->getTitleForHTMLOutput()
        ));

        $form->addCommandButton(self::CMD_BACK_TO_QUESTION, $lng->txt('tst_question_hints_back_to_question'));

        $numExistingRequests = $this->questionHintTracking->getNumExistingRequests();

        if ($numExistingRequests > 1) {
            $form->addCommandButton(self::CMD_SHOW_LIST, $lng->txt('show_requested_question_hints'));
        }

        // form input: hint text

        $nonEditableHintText = new ilNonEditableValueGUI($lng->txt('tst_question_hints_form_label_hint_text'), 'hint_text', true);
        $nonEditableHintText->setValue(ilLegacyFormElementsUtil::prepareTextareaOutput($questionHint->getText(), true));
        $form->addItem($nonEditableHintText);

        // form input: hint points

        $nonEditableHintPoints = new ilNonEditableValueGUI($lng->txt('tst_question_hints_form_label_hint_points'), 'hint_points');
        $nonEditableHintPoints->setValue($questionHint->getPoints());
        $form->addItem($nonEditableHintPoints);

        $this->populateContent($ilCtrl->getHtml($form), $tpl);
    }

    private function confirmRequestCmd(): void
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];


        if ($DIC->globalScreen()->tool()->context()->current()->getAdditionalData()
            ->exists(ilTestPlayerLayoutProvider::TEST_PLAYER_TITLE)) {
            $DIC->globalScreen()->tool()->context()->current()->getAdditionalData()->replace(
                ilTestPlayerLayoutProvider::TEST_PLAYER_TITLE,
                $this->parentGUI->getObject()->getTitle() . ' - ' . $lng->txt('tst_question_hints_confirm_request')
            );
        }

        try {
            $nextRequestableHint = $this->questionHintTracking->getNextRequestableHint();
        } catch (ilTestNoNextRequestableHintExistsException $e) {
            $ilCtrl->redirect($this, self::CMD_BACK_TO_QUESTION);
        }


        $confirmation = new ilConfirmationGUI();

        $formAction = ilUtil::appendUrlParameterString(
            $ilCtrl->getFormAction($this),
            "hintId={$nextRequestableHint->getId()}"
        );

        $confirmation->setFormAction($formAction);

        $confirmation->setConfirm($lng->txt('tst_question_hints_confirm_request'), self::CMD_PERFORM_REQUEST);
        $confirmation->setCancel($lng->txt('tst_question_hints_cancel_request'), self::CMD_BACK_TO_QUESTION);

        if ($nextRequestableHint->getPoints() == 0.0) {
            $confirmation->setHeaderText($lng->txt('tst_question_hints_request_confirmation_no_deduction'));
        } else {
            $confirmation->setHeaderText(sprintf(
                $lng->txt('tst_question_hints_request_confirmation'),
                $nextRequestableHint->getIndex(),
                $nextRequestableHint->getPoints()
            ));
        }

        $this->populateContent($ilCtrl->getHtml($confirmation), $tpl);
    }

    private function performRequestCmd(): void
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];

        if (!$this->request->isset('hintId') || !(int) $this->request->raw('hintId')) {
            throw new ilTestException('no hint id given');
        }

        try {
            $nextRequestableHint = $this->questionHintTracking->getNextRequestableHint();
        } catch (ilTestNoNextRequestableHintExistsException $e) {
            $ilCtrl->redirect($this, self::CMD_BACK_TO_QUESTION);
        }

        if ($nextRequestableHint->getId() != (int) $this->request->raw('hintId')) {
            throw new ilTestException('given hint id does not relate to the next requestable hint');
        }

        $this->questionHintTracking->storeRequest($nextRequestableHint);

        $redirectTarget = $this->getHintPresentationLinkTarget($nextRequestableHint->getId(), false);

        ilUtil::redirect($redirectTarget);
    }

    private function backToQuestionCmd(): void
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];

        $ilCtrl->redirect($this->parentGUI, $this->parentCMD);
    }

    private function populateContent($content, $tpl): void
    {
        global $DIC;
        $tpl = $DIC['tpl'];

        if (!$this->isQuestionPreview() && $this->parentGUI->object->getKioskMode()) {
            $tpl->hideFooter();

            $tpl->addBlockFile(
                'CONTENT',
                'kiosk_content',
                'tpl.il_tst_question_hints_kiosk_page.html',
                'Modules/TestQuestionPool'
            );

            $tpl->setVariable('KIOSK_HEAD', $this->parentGUI->getKioskHead());

            $tpl->setVariable('KIOSK_CONTENT', $content);
        } else {
            $tpl->setContent($content);
        }
    }

    private function isQuestionPreview(): bool
    {
        if ($this->questionHintTracking instanceof ilAssQuestionPreviewHintTracking) {
            return true;
        }

        return false;
    }

    public function getHintPresentationLinkTarget($hintId, $xmlStyle = true): string
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];

        if ($this->questionOBJ->isAdditionalContentEditingModePageObject()) {
            $ilCtrl->setParameterByClass('ilasshintpagegui', 'hint_id', $hintId);
            $linkTarget = $ilCtrl->getLinkTargetByClass('ilAssHintPageGUI', '', '', false, $xmlStyle);
        } else {
            $ilCtrl->setParameter($this, 'hintId', $hintId);
            $linkTarget = $ilCtrl->getLinkTarget($this, self::CMD_SHOW_HINT, '', false, $xmlStyle);
        }

        return $linkTarget;
    }
}