Collaboration diagram for ilAssQuestionPreviewGUI:

Public Member Functions
	__construct (ilCtrl $ctrl, ilRbacSystem $rbac_system, ilTabsGUI $tabs, ilGlobalTemplateInterface $tpl, ilLanguage $lng, ilDBInterface $db, ilObjUser $user, RandomGroup $randomGroup, int $parent_ref_id, RBACServices $rbac_services)

	initQuestion ($questionId, $parentObjId)

	getObject ()

	initPreviewSettings ($parentRefId)

	initPreviewSession ($userId, $questionId)

	initHintTracking ()

	initStyleSheets ()

	executeCommand ()

	saveQuestionSolution ()

	gatewayConfirmHintRequestCmd ()

	gatewayShowHintListCmd ()

Data Fields
const	CMD_SHOW = 'show'

const	CMD_RESET = 'reset'

const	CMD_STATISTICS = 'assessment'

const	CMD_INSTANT_RESPONSE = 'instantResponse'

const	CMD_HANDLE_QUESTION_ACTION = 'handleQuestionAction'

const	CMD_GATEWAY_CONFIRM_HINT_REQUEST = 'gatewayConfirmHintRequest'

const	CMD_GATEWAY_SHOW_HINT_LIST = 'gatewayShowHintList'

const	TAB_ID_QUESTION = 'question'

const	FEEDBACK_FOCUS_ANCHOR = 'focus'

Protected Member Functions
	buildPreviewFormAction ()

	isCommentingRequired ()

	handleInstantResponseRendering (ilTemplate $tpl)

	populateReachedPointsOutput (ilTemplate $tpl)

	populateInstantResponseHeader (ilTemplate $tpl, $withFocusAnchor)

	populateInstantResponseMessage (ilTemplate $tpl, string $a_message)

	populateNotesPanel (ilTemplate $tpl, $notesPanelHTML)

Private Member Functions
	showCmd ($notesPanelHTML='')

	assessmentCmd ()

	resetCmd ()

	instantResponseCmd ()

	handleQuestionActionCmd ()

	populatePreviewToolbar (ilTemplate $tpl)

	populateQuestionOutput (ilTemplate $tpl)

	populateSolutionOutput (ilTemplate $tpl)

	getQuestionNavigationHtml ()

	populateGenericQuestionFeedback (ilTemplate $tpl)
	Populate the block for an instant generic feedback. More...

	populateSpecificQuestionFeedback (ilTemplate $tpl)
	Populate the block for an instant specific feedback. More...

	isShowBestSolutionRequired ()

	isShowGenericQuestionFeedbackRequired ()

	isShowSpecificQuestionFeedbackRequired ()

	isShowReachedPointsRequired ()

	getQuestionAnswerShuffler ()

Private Attributes
RBACServices	$rbac_services

ilCtrlInterface	$ctrl

ilRbacSystem	$rbac_system

ilTabsGUI	$tabs

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilDBInterface	$db

ilObjUser	$user

assQuestionGUI	$questionGUI

assQuestion	$questionOBJ

ilAssQuestionPreviewSettings	$previewSettings = null

ilAssQuestionPreviewSession	$previewSession = null

ilAssQuestionPreviewHintTracking	$hintTracking = null

RandomGroup	$randomGroup

int	$parent_ref_id

Detailed Description

Definition at line 38 of file class.ilAssQuestionPreviewGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionPreviewGUI::__construct	(	ilCtrl	$ctrl,
		ilRbacSystem	$rbac_system,
		ilTabsGUI	$tabs,
		ilGlobalTemplateInterface	$tpl,
		ilLanguage	$lng,
		ilDBInterface	$db,
		ilObjUser	$user,
		RandomGroup	$randomGroup,
		int	$parent_ref_id,
		RBACServices	$rbac_services
	)

Definition at line 70 of file class.ilAssQuestionPreviewGUI.php.

      {
        $this->ctrl = $ctrl;
        $this->rbac_system = $rbac_system;
        $this->tabs = $tabs;
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->db = $db;
        $this->user = $user;
        $this->randomGroup = $randomGroup;
        $this->rbac_services = $rbac_services;
        $this->parent_ref_id = $parent_ref_id;
 
        $this->tpl->addCss(ilObjStyleSheet::getContentStylePath(0));
        $this->tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());
    }

References $ctrl, $db, $lng, $parent_ref_id, $randomGroup, $rbac_services, $rbac_system, $tabs, $tpl, $user, ILIAS\Repository\ctrl(), ilObjStyleSheet\getContentStylePath(), ilObjStyleSheet\getSyntaxStylePath(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ assessmentCmd()

ilAssQuestionPreviewGUI::assessmentCmd ( )

private

Definition at line 274 of file class.ilAssQuestionPreviewGUI.php.

    {
        $this->tabs->activateTab('statistics');
        $this->questionGUI->assessment();
    }

References ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ buildPreviewFormAction()

ilAssQuestionPreviewGUI::buildPreviewFormAction ( )

protected

Returns: string

Definition at line 244 of file class.ilAssQuestionPreviewGUI.php.

                                               : string
    {
        return $this->ctrl->getFormAction($this, self::CMD_SHOW) . '#' . self::FEEDBACK_FOCUS_ANCHOR;
    }

References ILIAS\Repository\ctrl(), and FEEDBACK_FOCUS_ANCHOR.

Referenced by showCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilAssQuestionPreviewGUI::executeCommand ( )

Definition at line 206 of file class.ilAssQuestionPreviewGUI.php.

                                    : void
    {
        global $DIC;
        $ilHelp = $DIC['ilHelp'];
        $ilHelp->setScreenIdComponent('qpl');
 
        $this->tabs->setTabActive(self::TAB_ID_QUESTION);
 
        $this->lng->loadLanguageModule('content');
 
        $nextClass = $this->ctrl->getNextClass($this);
 
        switch ($nextClass) {
            case 'ilassquestionhintrequestgui':
                $gui = new ilAssQuestionHintRequestGUI($this, self::CMD_SHOW, $this->questionGUI, $this->hintTracking);
                $this->ctrl->forwardCommand($gui);
                break;
            case 'ilassspecfeedbackpagegui':
            case 'ilassgenfeedbackpagegui':
                $forwarder = new ilAssQuestionFeedbackPageObjectCommandForwarder($this->questionOBJ, $this->ctrl, $this->tabs, $this->lng);
                $forwarder->forward();
                break;
            case 'ilnotegui':
                $notesGUI = new ilNoteGUI($this->questionOBJ->getObjId(), $this->questionOBJ->getId(), 'quest');
                $notesGUI->enablePublicNotes(true);
                $notesGUI->enablePublicNotesDeletion(true);
                $notesPanelHTML = $this->ctrl->forwardCommand($notesGUI);
                $this->showCmd($notesPanelHTML);
                break;
            default:
                $cmd = $this->ctrl->getCmd(self::CMD_SHOW) . 'Cmd';
                $this->$cmd();
        }
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), showCmd(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ gatewayConfirmHintRequestCmd()

ilAssQuestionPreviewGUI::gatewayConfirmHintRequestCmd ( )

Definition at line 595 of file class.ilAssQuestionPreviewGUI.php.

                                                  : void
    {
        if (!$this->saveQuestionSolution()) {
            $this->previewSession->setInstantResponseActive(false);
            $this->showCmd();
            return;
        }
 
        $this->ctrl->redirectByClass(
            'ilAssQuestionHintRequestGUI',
            ilAssQuestionHintRequestGUI::CMD_CONFIRM_REQUEST
        );
    }

References ilAssQuestionHintRequestGUI\CMD_CONFIRM_REQUEST, ILIAS\Repository\ctrl(), saveQuestionSolution(), and showCmd().

Here is the call graph for this function:

◆ gatewayShowHintListCmd()

ilAssQuestionPreviewGUI::gatewayShowHintListCmd ( )

Definition at line 609 of file class.ilAssQuestionPreviewGUI.php.

                                            : void
    {
        if (!$this->saveQuestionSolution()) {
            $this->previewSession->setInstantResponseActive(false);
            $this->showCmd();
            return;
        }
 
        $this->ctrl->redirectByClass(
            'ilAssQuestionHintRequestGUI',
            ilAssQuestionHintRequestGUI::CMD_SHOW_LIST
        );
    }

References ilAssQuestionHintRequestGUI\CMD_SHOW_LIST, ILIAS\Repository\ctrl(), saveQuestionSolution(), and showCmd().

Here is the call graph for this function:

◆ getObject()

ilAssQuestionPreviewGUI::getObject ( )

Definition at line 171 of file class.ilAssQuestionPreviewGUI.php.

                               : assQuestion
    {
        return $this->questionOBJ;
    }

References $questionOBJ.

◆ getQuestionAnswerShuffler()

ilAssQuestionPreviewGUI::getQuestionAnswerShuffler ( )

private

Returns: Transformation

Definition at line 626 of file class.ilAssQuestionPreviewGUI.php.

                                                : Transformation
    {
        if (!$this->previewSession->randomizerSeedExists()) {
            $this->previewSession->setRandomizerSeed((new RandomSeed())->createSeed());
        }
        return $this->randomGroup->shuffleArray(new GivenSeed((int) $this->previewSession->getRandomizerSeed()));
    }

Referenced by populateQuestionOutput().

Here is the caller graph for this function:

◆ getQuestionNavigationHtml()

ilAssQuestionPreviewGUI::getQuestionNavigationHtml ( )

private

Definition at line 474 of file class.ilAssQuestionPreviewGUI.php.

                                                : string
    {
        $navGUI = new ilAssQuestionRelatedNavigationBarGUI($this->ctrl, $this->lng);
 
        $navGUI->setInstantResponseCmd(self::CMD_INSTANT_RESPONSE);
        $navGUI->setHintRequestCmd(self::CMD_GATEWAY_CONFIRM_HINT_REQUEST);
        $navGUI->setHintListCmd(self::CMD_GATEWAY_SHOW_HINT_LIST);
 
        $navGUI->setInstantResponseEnabled($this->previewSettings->isInstantFeedbackNavigationRequired());
        $navGUI->setHintProvidingEnabled($this->previewSettings->isHintProvidingEnabled());
 
        $navGUI->setHintRequestsPossible($this->hintTracking->requestsPossible());
        $navGUI->setHintRequestsExist($this->hintTracking->requestsExist());
 
        return $this->ctrl->getHTML($navGUI);
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by populateQuestionOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleInstantResponseRendering()

ilAssQuestionPreviewGUI::handleInstantResponseRendering ( ilTemplate $tpl )

protected

Definition at line 280 of file class.ilAssQuestionPreviewGUI.php.

                                                                      : void
    {
        $response_required = false;
        $response_available = false;
        $jump_to_response = false;
 
        if ($this->isShowReachedPointsRequired()) {
            $this->populateReachedPointsOutput($tpl);
            $response_required = true;
            $response_available = true;
            $jump_to_response = true;
        }
 
        if ($this->isShowBestSolutionRequired()) {
            $this->populateSolutionOutput($tpl);
            $response_required = true;
            $response_available = true;
            $jump_to_response = true;
        }
 
        if ($this->isShowGenericQuestionFeedbackRequired()) {
            $response_required = true;
            if ($this->populateGenericQuestionFeedback($tpl)) {
                $response_available = true;
                $jump_to_response = true;
            }
        }
 
        if ($this->isShowSpecificQuestionFeedbackRequired()) {
            $response_required = true;
 
            if ($this->questionGUI->hasInlineFeedback()) {
                // Don't jump to the feedback below the question if some feedback is shown within the question
                $jump_to_response = false;
            } else {
                if ($this->populateSpecificQuestionFeedback($tpl)) {
                    $response_available = true;
                    $jump_to_response = true;
                }
            }
        }
 
        if ($response_required) {
            $this->populateInstantResponseHeader($tpl, $jump_to_response);
            if (!$response_available) {
                if ($this->questionGUI->hasInlineFeedback()) {
                    $this->populateInstantResponseMessage(
                        $tpl,
                        $this->lng->txt('tst_feedback_is_given_inline')
                    );
                } else {
                    $this->populateInstantResponseMessage(
                        $tpl,
                        $this->lng->txt('tst_feedback_not_available_for_answer')
                    );
                }
            }
        }
    }

References isShowBestSolutionRequired(), isShowGenericQuestionFeedbackRequired(), isShowReachedPointsRequired(), isShowSpecificQuestionFeedbackRequired(), ILIAS\Repository\lng(), populateGenericQuestionFeedback(), populateInstantResponseHeader(), populateInstantResponseMessage(), populateReachedPointsOutput(), populateSolutionOutput(), and populateSpecificQuestionFeedback().

Referenced by showCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleQuestionActionCmd()

ilAssQuestionPreviewGUI::handleQuestionActionCmd ( )

private

Definition at line 363 of file class.ilAssQuestionPreviewGUI.php.

                                              : void
    {
        $this->questionOBJ->persistPreviewState($this->previewSession);
        $this->ctrl->redirect($this, self::CMD_SHOW);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ initHintTracking()

ilAssQuestionPreviewGUI::initHintTracking ( )

Definition at line 190 of file class.ilAssQuestionPreviewGUI.php.

                                      : void
    {
        $this->hintTracking = new ilAssQuestionPreviewHintTracking($this->db, $this->previewSession);
    }

◆ initPreviewSession()

ilAssQuestionPreviewGUI::initPreviewSession	(	$userId,
		$questionId
	)

Definition at line 183 of file class.ilAssQuestionPreviewGUI.php.

                                                            : void
    {
        $this->previewSession = new ilAssQuestionPreviewSession($userId, $questionId);
 
        $this->previewSession->init();
    }

◆ initPreviewSettings()

ilAssQuestionPreviewGUI::initPreviewSettings ( $parentRefId )

Definition at line 176 of file class.ilAssQuestionPreviewGUI.php.

                                                     : void
    {
        $this->previewSettings = new ilAssQuestionPreviewSettings($parentRefId);
 
        $this->previewSettings->init();
    }

◆ initQuestion()

ilAssQuestionPreviewGUI::initQuestion	(	$questionId,
		$parentObjId
	)

Definition at line 97 of file class.ilAssQuestionPreviewGUI.php.

                                                           : void
    {
        $this->questionGUI = assQuestion::instantiateQuestionGUI($questionId);
        $this->questionOBJ = $this->questionGUI->object;
 
        $this->questionOBJ->setObjId($parentObjId);
 
        if ($this->ctrl->getCmd() === 'editQuestion') {
            $this->questionGUI->setQuestionTabs();
        } else {
            if ($_GET["q_id"]) {
                $this->tabs->clearTargets();
                $this->tabs->addTarget(
                    self::TAB_ID_QUESTION,
                    $this->ctrl->getLinkTargetByClass('ilAssQuestionPreviewGUI', self::CMD_SHOW),
                    '',
                    [strtolower(__CLASS__)]
                );
                // Assessment of questions sub menu entry
                $q_type = $this->questionOBJ->getQuestionType();
                $classname = $q_type . "GUI";
                $this->tabs->addTarget(
                    "statistics",
                    $this->ctrl->getLinkTargetByClass('ilAssQuestionPreviewGUI', "assessment"),
                    array("assessment"),
                    $classname,
                    ""
                );
                if ((isset($_GET['calling_test']) && strlen($_GET['calling_test']) !== 0) ||
                    (isset($_GET['test_ref_id']) && strlen($_GET['test_ref_id']) !== 0)) {
                    $ref_id = $_GET['calling_test'];
                    if (strlen($ref_id) !== 0 && !is_numeric($ref_id)) {
                        $ref_id_array = explode('_', $ref_id);
                        $ref_id = array_pop($ref_id_array);
                    }
 
                    if (strlen($ref_id) === 0) {
                        $ref_id = $_GET['test_ref_id'];
                    }
 
                    $link = ilTestExpressPage::getReturnToPageLink();
                    $this->tabs->setBackTarget(
                        $this->lng->txt("backtocallingtest"),
                        "ilias.php?baseClass=ilObjTestGUI&cmd=questions&ref_id=$ref_id"
                    );
                } elseif (isset($_GET['calling_consumer']) && (int) $_GET['calling_consumer']) {
                    $ref_id = (int) $_GET['calling_consumer'];
                    $consumer = ilObjectFactory::getInstanceByRefId($ref_id);
                    if ($consumer instanceof ilQuestionEditingFormConsumer) {
                        $this->tabs->setBackTarget(
                            $consumer->getQuestionEditingFormBackTargetLabel(),
                            $consumer->getQuestionEditingFormBackTarget($_GET['consumer_context'])
                        );
                    } else {
                        $this->tabs->setBackTarget($this->lng->txt("qpl"), ilLink::_getLink($ref_id));
                    }
                } else {
                    $this->ctrl->clearParameterByClass(ilObjQuestionPoolGUI::class, 'q_id');
                    $this->tabs->setBackTarget($this->lng->txt("backtocallingpool"), $this->ctrl->getLinkTargetByClass(ilObjQuestionPoolGUI::class, "questions"));
                    $this->ctrl->setParameterByClass(ilObjQuestionPoolGUI::class, 'q_id', $questionId);
                }
            }
        }
        $this->questionGUI->outAdditionalOutput();
 
        $this->questionGUI->populateJavascriptFilesRequiredForWorkForm($this->tpl);
        $this->questionOBJ->setOutputType(OUTPUT_JAVASCRIPT); // TODO: remove including depending stuff
 
        $this->questionGUI->setTargetGui($this);
        $this->questionGUI->setQuestionActionCmd(self::CMD_HANDLE_QUESTION_ACTION);
 
        $this->questionGUI->setRenderPurpose(assQuestionGUI::RENDER_PURPOSE_DEMOPLAY);
    }

References $_GET, $ref_id, ilLink\_getLink(), ILIAS\Repository\ctrl(), ilObjectFactory\getInstanceByRefId(), ilTestExpressPage\getReturnToPageLink(), assQuestion\instantiateQuestionGUI(), ILIAS\Repository\int(), ILIAS\Repository\lng(), OUTPUT_JAVASCRIPT, assQuestionGUI\RENDER_PURPOSE_DEMOPLAY, and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ initStyleSheets()

ilAssQuestionPreviewGUI::initStyleSheets ( )

Definition at line 195 of file class.ilAssQuestionPreviewGUI.php.

                                     : void
    {
        $this->tpl->setCurrentBlock("ContentStyle");
        $this->tpl->setVariable("LOCATION_CONTENT_STYLESHEET", ilObjStyleSheet::getContentStylePath(0));
        $this->tpl->parseCurrentBlock();
 
        $this->tpl->setCurrentBlock("SyntaxStyle");
        $this->tpl->setVariable("LOCATION_SYNTAX_STYLESHEET", ilObjStyleSheet::getSyntaxStylePath());
        $this->tpl->parseCurrentBlock();
    }

References ilObjStyleSheet\getContentStylePath(), and ilObjStyleSheet\getSyntaxStylePath().

Here is the call graph for this function:

◆ instantResponseCmd()

ilAssQuestionPreviewGUI::instantResponseCmd ( )

private

Definition at line 352 of file class.ilAssQuestionPreviewGUI.php.

                                         : void
    {
        if ($this->saveQuestionSolution()) {
            $this->previewSession->setInstantResponseActive(true);
        } else {
            $this->previewSession->setInstantResponseActive(false);
        }
 
        $this->ctrl->redirect($this, self::CMD_SHOW);
    }

References ILIAS\Repository\ctrl(), and saveQuestionSolution().

Here is the call graph for this function:

◆ isCommentingRequired()

ilAssQuestionPreviewGUI::isCommentingRequired ( )

protected

Definition at line 249 of file class.ilAssQuestionPreviewGUI.php.

                                             : bool
    {
        if ($this->previewSettings->isTestRefId()) {
            return false;
        }
 
        return (bool) $this->rbac_services->system()->checkAccess('write', (int) $_GET['ref_id']);
    }

References $_GET.

Referenced by showCmd().

Here is the caller graph for this function:

◆ isShowBestSolutionRequired()

ilAssQuestionPreviewGUI::isShowBestSolutionRequired ( )

private

Definition at line 554 of file class.ilAssQuestionPreviewGUI.php.

    {
        if (!$this->previewSettings->isBestSolutionEnabled()) {
            return false;
        }
 
        return $this->previewSession->isInstantResponseActive();
    }

Referenced by handleInstantResponseRendering().

Here is the caller graph for this function:

◆ isShowGenericQuestionFeedbackRequired()

ilAssQuestionPreviewGUI::isShowGenericQuestionFeedbackRequired ( )

private

Definition at line 563 of file class.ilAssQuestionPreviewGUI.php.

    {
        if (!$this->previewSettings->isGenericFeedbackEnabled()) {
            return false;
        }
 
        return $this->previewSession->isInstantResponseActive();
    }

Referenced by handleInstantResponseRendering().

Here is the caller graph for this function:

◆ isShowReachedPointsRequired()

ilAssQuestionPreviewGUI::isShowReachedPointsRequired ( )

private

Definition at line 581 of file class.ilAssQuestionPreviewGUI.php.

    {
        if (!$this->previewSettings->isReachedPointsEnabled()) {
            return false;
        }
 
        return $this->previewSession->isInstantResponseActive();
    }

Referenced by handleInstantResponseRendering().

Here is the caller graph for this function:

◆ isShowSpecificQuestionFeedbackRequired()

ilAssQuestionPreviewGUI::isShowSpecificQuestionFeedbackRequired ( )

private

Definition at line 572 of file class.ilAssQuestionPreviewGUI.php.

    {
        if (!$this->previewSettings->isSpecificFeedbackEnabled()) {
            return false;
        }
 
        return $this->previewSession->isInstantResponseActive();
    }

Referenced by handleInstantResponseRendering(), and populateQuestionOutput().

Here is the caller graph for this function:

◆ populateGenericQuestionFeedback()

ilAssQuestionPreviewGUI::populateGenericQuestionFeedback ( ilTemplate $tpl )

private

Populate the block for an instant generic feedback.

Returns: bool true, if there is some feedback populated

Definition at line 495 of file class.ilAssQuestionPreviewGUI.php.

                                                                     : bool
    {
        if ($this->questionOBJ->isPreviewSolutionCorrect($this->previewSession)) {
            $feedback = $this->questionGUI->getGenericFeedbackOutputForCorrectSolution();
            $cssClass = ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_CORRECT;
        } else {
            $feedback = $this->questionGUI->getGenericFeedbackOutputForIncorrectSolution();
            $cssClass = ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_WRONG;
        }
 
        if ($feedback !== '') {
            $tpl->setCurrentBlock('instant_feedback_generic');
            $tpl->setVariable('GENERIC_FEEDBACK', $feedback);
            $tpl->setVariable('ILC_FB_CSS_CLASS', $cssClass);
            $tpl->parseCurrentBlock();
            return true;
        }
        return false;
    }

References $tpl, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_CORRECT, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_WRONG, ilGlobalTemplateInterface\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), and ilGlobalTemplateInterface\setVariable().

Referenced by handleInstantResponseRendering().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateInstantResponseHeader()

ilAssQuestionPreviewGUI::populateInstantResponseHeader	(	ilTemplate	$tpl,
			$withFocusAnchor
	)

protected

Definition at line 534 of file class.ilAssQuestionPreviewGUI.php.

                                                                                       : void
    {
        if ($withFocusAnchor) {
            $tpl->setCurrentBlock('inst_resp_id');
            $tpl->setVariable('INSTANT_RESPONSE_FOCUS_ID', self::FEEDBACK_FOCUS_ANCHOR);
            $tpl->parseCurrentBlock();
        }
 
        $tpl->setCurrentBlock('instant_response_header');
        $tpl->setVariable('INSTANT_RESPONSE_HEADER', $this->lng->txt('tst_feedback'));
        $tpl->parseCurrentBlock();
    }

References $tpl, ILIAS\Repository\lng(), ilGlobalTemplateInterface\parseCurrentBlock(), ilTemplate\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), and ilGlobalTemplateInterface\setVariable().

Referenced by handleInstantResponseRendering().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateInstantResponseMessage()

ilAssQuestionPreviewGUI::populateInstantResponseMessage	(	ilTemplate	$tpl,
		string	$a_message
	)

protected

Definition at line 547 of file class.ilAssQuestionPreviewGUI.php.

    {
        $tpl->setCurrentBlock('instant_response_message');
        $tpl->setVariable('INSTANT_RESPONSE_MESSAGE', $a_message);
        $tpl->parseCurrentBlock();
    }

References $tpl, ilGlobalTemplateInterface\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), and ilGlobalTemplateInterface\setVariable().

Referenced by handleInstantResponseRendering().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateNotesPanel()

ilAssQuestionPreviewGUI::populateNotesPanel	(	ilTemplate	$tpl,
			$notesPanelHTML
	)

protected

Definition at line 634 of file class.ilAssQuestionPreviewGUI.php.

                                                                           : void
    {
        if (!strlen($notesPanelHTML)) {
            $notesPanelHTML = $this->questionGUI->getNotesHTML();
        }
 
        $tpl->setCurrentBlock('notes_panel');
        $tpl->setVariable('NOTES_PANEL', $notesPanelHTML);
        $tpl->parseCurrentBlock();
    }

References $tpl, ilGlobalTemplateInterface\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), and ilGlobalTemplateInterface\setVariable().

Referenced by showCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populatePreviewToolbar()

ilAssQuestionPreviewGUI::populatePreviewToolbar ( ilTemplate $tpl )

private

Definition at line 369 of file class.ilAssQuestionPreviewGUI.php.

                                                            : void
    {
        $toolbarGUI = new ilAssQuestionPreviewToolbarGUI($this->lng);
 
        $toolbarGUI->setFormAction($this->ctrl->getFormAction($this, self::CMD_SHOW));
        $toolbarGUI->setResetPreviewCmd(self::CMD_RESET);
 
        // Check Permissions first, some Toolbar Actions are only available for write access
        if ($this->rbac_services->system()->checkAccess('write', (int) $_GET['ref_id'])) {
            $toolbarGUI->setEditPageCmd(
                $this->ctrl->getLinkTargetByClass('ilAssQuestionPageGUI', 'edit')
            );
 
            $toolbarGUI->setEditQuestionCmd(
                $this->ctrl->getLinkTargetByClass(
                    array('ilrepositorygui','ilobjquestionpoolgui', get_class($this->questionGUI)),
                    'editQuestion'
                )
            );
        }
 
        $toolbarGUI->build();
 
        $tpl->setVariable('PREVIEW_TOOLBAR', $this->ctrl->getHTML($toolbarGUI));
    }

References $_GET, $tpl, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setVariable().

Referenced by showCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateQuestionOutput()

ilAssQuestionPreviewGUI::populateQuestionOutput ( ilTemplate $tpl )

private

Definition at line 395 of file class.ilAssQuestionPreviewGUI.php.

                                                            : void
    {
        // FOR WHAT EXACTLY IS THIS USEFUL?
        $this->ctrl->setReturnByClass('ilAssQuestionPageGUI', 'view');
        $this->ctrl->setReturnByClass('ilObjQuestionPoolGUI', 'questions');
 
        $pageGUI = new ilAssQuestionPageGUI($this->questionOBJ->getId());
        $pageGUI->setRenderPageContainer(false);
        $pageGUI->setEditPreview(true);
        $pageGUI->setEnabledTabs(false);
 
        // FOR WHICH SITUATION IS THIS WORKAROUND NECCESSARY? (sure .. imagemaps, but where this can be done?)
        if (strlen($this->ctrl->getCmd()) == 0 && !isset($_POST['editImagemapForward_x'])) { // workaround for page edit imagemaps, keep in mind
            $this->ctrl->setCmdClass(get_class($pageGUI));
            $this->ctrl->setCmd('preview');
        }
 
        $this->questionGUI->setPreviewSession($this->previewSession);
        $this->questionGUI->object->setShuffler($this->getQuestionAnswerShuffler());
 
        $questionHtml = $this->questionGUI->getPreview(true, $this->isShowSpecificQuestionFeedbackRequired());
        $this->questionGUI->magicAfterTestOutput();
 
        $questionHtml .= $this->getQuestionNavigationHtml();
 
        $pageGUI->setQuestionHTML(array($this->questionOBJ->getId() => $questionHtml));
 
        $pageGUI->setPresentationTitle($this->questionOBJ->getTitleForHTMLOutput());
 
        $tpl->setVariable('QUESTION_OUTPUT', $pageGUI->preview());
        // \ilPageObjectGUI::preview sets an undefined tab, so the "question" tab has to be activated again
        $this->tabs->setTabActive(self::TAB_ID_QUESTION);
    }

References $tpl, ILIAS\Repository\ctrl(), getQuestionAnswerShuffler(), getQuestionNavigationHtml(), isShowSpecificQuestionFeedbackRequired(), ilGlobalTemplateInterface\setVariable(), and ILIAS\Repository\tabs().

Referenced by showCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateReachedPointsOutput()

ilAssQuestionPreviewGUI::populateReachedPointsOutput ( ilTemplate $tpl )

protected

Definition at line 429 of file class.ilAssQuestionPreviewGUI.php.

                                                                   : void
    {
        $reachedPoints = $this->questionOBJ->calculateReachedPointsFromPreviewSession($this->previewSession);
        $maxPoints = $this->questionOBJ->getMaximumPoints();
 
        $scoreInformation = sprintf(
            $this->lng->txt("you_received_a_of_b_points"),
            $reachedPoints,
            $maxPoints
        );
 
        $tpl->setCurrentBlock("reached_points_feedback");
        $tpl->setVariable("REACHED_POINTS_FEEDBACK", $scoreInformation);
        $tpl->parseCurrentBlock();
    }

References $tpl, ILIAS\Repository\lng(), ilGlobalTemplateInterface\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), and ilGlobalTemplateInterface\setVariable().

Referenced by handleInstantResponseRendering().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateSolutionOutput()

ilAssQuestionPreviewGUI::populateSolutionOutput ( ilTemplate $tpl )

private

Definition at line 445 of file class.ilAssQuestionPreviewGUI.php.

                                                            : void
    {
        // FOR WHAT EXACTLY IS THIS USEFUL?
        $this->ctrl->setReturnByClass('ilAssQuestionPageGUI', 'view');
        $this->ctrl->setReturnByClass('ilObjQuestionPoolGUI', 'questions');
 
        $pageGUI = new ilAssQuestionPageGUI($this->questionOBJ->getId());
 
        $pageGUI->setEditPreview(true);
        $pageGUI->setEnabledTabs(false);
 
        // FOR WHICH SITUATION IS THIS WORKAROUND NECCESSARY? (sure .. imagemaps, but where this can be done?)
        if (strlen($this->ctrl->getCmd()) == 0 && !isset($_POST['editImagemapForward_x'])) { // workaround for page edit imagemaps, keep in mind
            $this->ctrl->setCmdClass(get_class($pageGUI));
            $this->ctrl->setCmd('preview');
        }
 
        $this->questionGUI->setPreviewSession($this->previewSession);
 
        $pageGUI->setQuestionHTML(array($this->questionOBJ->getId() => $this->questionGUI->getSolutionOutput(0, null, false, false, true, false, true, false, false)));
 
        $output = $this->questionGUI->getSolutionOutput(0, null, false, false, true, false, true, false, false);
 
        $tpl->setCurrentBlock('solution_output');
        $tpl->setVariable('TXT_CORRECT_SOLUTION', $this->lng->txt('tst_best_solution_is'));
        $tpl->setVariable('SOLUTION_OUTPUT', $output);
        $tpl->parseCurrentBlock();
    }

References $tpl, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilGlobalTemplateInterface\setVariable().

Referenced by handleInstantResponseRendering().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateSpecificQuestionFeedback()

ilAssQuestionPreviewGUI::populateSpecificQuestionFeedback ( ilTemplate $tpl )

private

Populate the block for an instant specific feedback.

Returns: bool true, if there is some feedback populated

Definition at line 519 of file class.ilAssQuestionPreviewGUI.php.

                                                                      : bool
    {
        $fb = $this->questionGUI->getSpecificFeedbackOutput(
            (array) $this->previewSession->getParticipantsSolution()
        );
 
        if (!empty($fb)) {
            $tpl->setCurrentBlock('instant_feedback_specific');
            $tpl->setVariable('ANSWER_FEEDBACK', $fb);
            $tpl->parseCurrentBlock();
            return true;
        }
        return false;
    }

References $tpl, ilGlobalTemplateInterface\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), and ilGlobalTemplateInterface\setVariable().

Referenced by handleInstantResponseRendering().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetCmd()

ilAssQuestionPreviewGUI::resetCmd ( )

private

Definition at line 340 of file class.ilAssQuestionPreviewGUI.php.

                               : void
    {
        $this->previewSession->setRandomizerSeed(null);
        $this->previewSession->setParticipantsSolution(null);
        $this->previewSession->resetRequestedHints();
        $this->previewSession->setInstantResponseActive(false);
 
        $this->tpl->setOnScreenMessage('info', $this->lng->txt('qst_preview_reset_msg'), true);
 
        $this->ctrl->redirect($this, self::CMD_SHOW);
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ saveQuestionSolution()

ilAssQuestionPreviewGUI::saveQuestionSolution ( )

Definition at line 590 of file class.ilAssQuestionPreviewGUI.php.

                                          : bool
    {
        return $this->questionOBJ->persistPreviewState($this->previewSession);
    }

Referenced by gatewayConfirmHintRequestCmd(), gatewayShowHintListCmd(), and instantResponseCmd().

Here is the caller graph for this function:

◆ showCmd()

ilAssQuestionPreviewGUI::showCmd ( $notesPanelHTML = '' )

private

Definition at line 258 of file class.ilAssQuestionPreviewGUI.php.

                                                  : void
    {
        $tpl = new ilTemplate('tpl.qpl_question_preview.html', true, true, 'Modules/TestQuestionPool');
        $tpl->setVariable('PREVIEW_FORMACTION', $this->buildPreviewFormAction());
 
        $this->populatePreviewToolbar($tpl);
        $this->populateQuestionOutput($tpl);
        $this->handleInstantResponseRendering($tpl);
 
        if ($this->isCommentingRequired()) {
            $this->populateNotesPanel($tpl, $notesPanelHTML);
        }
 
        $this->tpl->setContent($tpl->get());
    }