Collaboration diagram for ilAssQuestionPreviewGUI:

Public Member Functions
	__construct (private ilCtrl $ctrl, private ilRbacSystem $rbac_system, private ilTabsGUI $tabs, private ilGlobalTemplateInterface $tpl, private ilLanguage $lng, private ilDBInterface $db, private ilObjUser $user, private RandomGroup $randomGroup, private GlobalScreen $global_screen, private HTTPServices $http, private Refinery $refinery)

	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)

	populateCommentsPanel (ilTemplate $tpl, string $comments_panel_html)

Private Member Functions
	showCmd (string $notes_panel_html='')

	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
assQuestionGUI	$questionGUI

assQuestion	$questionOBJ

ilAssQuestionPreviewSettings	$previewSettings = null

ilAssQuestionPreviewSession	$previewSession = null

ilAssQuestionPreviewHintTracking	$hintTracking = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionPreviewGUI::__construct	(	private ilCtrl	$ctrl,
		private ilRbacSystem	$rbac_system,
		private ilTabsGUI	$tabs,
		private ilGlobalTemplateInterface	$tpl,
		private ilLanguage	$lng,
		private ilDBInterface	$db,
		private ilObjUser	$user,
		private RandomGroup	$randomGroup,
		private GlobalScreen	$global_screen,
		private HTTPServices	$http,
		private Refinery	$refinery
	)

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

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

       {
         $this->tpl->addCss(ilObjStyleSheet::getContentStylePath(0));
         $this->tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());
     }

Here is the call graph for this function:

Member Function Documentation

◆ assessmentCmd()

ilAssQuestionPreviewGUI::assessmentCmd ( )

private

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

References ILIAS\Repository\tabs().

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

Here is the call graph for this function:

◆ buildPreviewFormAction()

ilAssQuestionPreviewGUI::buildPreviewFormAction ( )

protected

Returns: string

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

References ILIAS\Repository\ctrl().

Referenced by showCmd().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilAssQuestionPreviewGUI::executeCommand ( )

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

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

                                     : 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,
                     $this->lng,
                     $this->tpl,
                     $this->tabs,
                     $this->global_screen
                 );
                 $this->ctrl->forwardCommand($gui);
                 break;
             case 'ilassspecfeedbackpagegui':
             case 'ilassgenfeedbackpagegui':
                 $page_id = $this->http->wrapper()->query()->retrieve(
                     'pg_id',
                     $this->refinery->byTrying([
                         $this->refinery->kindlyTo()->int(),
                         $this->refinery->always(null)
                     ])
                 );
 
                 if ($this->ctrl->getCmd() === 'displayMediaFullscreen'
                     && $page_id !== null) {
 
                     (new ilPageObjectGUI(
                         $nextClass === 'ilassgenfeedbackpagegui' ? 'qfbg' : 'qfbs',
                         $page_id
                     ))->displayMediaFullscreen();
                     break;
                 }
 
                 (new ilAssQuestionFeedbackPageObjectCommandForwarder(
                     $this->questionOBJ,
                     $this->ctrl,
                     $this->tabs,
                     $this->lng
                 ))->forward();
                 break;
             case 'ilcommentgui':
                 $comment_gui = new ilCommentGUI($this->questionOBJ->getObjId(), $this->questionOBJ->getId(), 'quest');
                 $comments_panel_html = $this->ctrl->forwardCommand($comment_gui);
                 $this->showCmd($comments_panel_html);
                 break;
             default:
                 $cmd = $this->ctrl->getCmd(self::CMD_SHOW) . 'Cmd';
                 $this->$cmd();
         }
     }

Here is the call graph for this function:

◆ gatewayConfirmHintRequestCmd()

ilAssQuestionPreviewGUI::gatewayConfirmHintRequestCmd ( )

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

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

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

Here is the call graph for this function:

◆ gatewayShowHintListCmd()

ilAssQuestionPreviewGUI::gatewayShowHintListCmd ( )

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

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

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

Here is the call graph for this function:

◆ getObject()

ilAssQuestionPreviewGUI::getObject ( )

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

References $questionOBJ.

                                : assQuestion
     {
         return $this->questionOBJ;
     }

◆ getQuestionAnswerShuffler()

ilAssQuestionPreviewGUI::getQuestionAnswerShuffler ( )

private

Returns: Transformation

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

Referenced by populateQuestionOutput().

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

Here is the caller graph for this function:

◆ getQuestionNavigationHtml()

ilAssQuestionPreviewGUI::getQuestionNavigationHtml ( )

private

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

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

Referenced by populateQuestionOutput().

                                                 : 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);
     }

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 281 of file class.ilAssQuestionPreviewGUI.php.

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

Referenced by showCmd().

                                                                       : 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')
                     );
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleQuestionActionCmd()

ilAssQuestionPreviewGUI::handleQuestionActionCmd ( )

private

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ initHintTracking()

ilAssQuestionPreviewGUI::initHintTracking ( )

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

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

◆ initPreviewSession()

ilAssQuestionPreviewGUI::initPreviewSession	(	$userId,
		$questionId
	)

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

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

◆ initPreviewSettings()

ilAssQuestionPreviewGUI::initPreviewSettings ( $parentRefId )

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

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

◆ initQuestion()

ilAssQuestionPreviewGUI::initQuestion	(	$questionId,
		$parentObjId
	)

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

References $_GET, $ref_id, ILIAS\Repository\ctrl(), ilTestExpressPage\getReturnToPageLink(), assQuestion\instantiateQuestionGUI(), ILIAS\Repository\lng(), assQuestionGUI\RENDER_PURPOSE_DEMOPLAY, and ILIAS\Repository\tabs().

Referenced by ilObjTestGUI\executeCommand().

                                                            : 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"),
                     ["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"
                     );
                 } 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->questionGUI->setTargetGui($this);
         $this->questionGUI->setQuestionActionCmd(self::CMD_HANDLE_QUESTION_ACTION);
 
         $this->questionGUI->setRenderPurpose(assQuestionGUI::RENDER_PURPOSE_DEMOPLAY);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initStyleSheets()

ilAssQuestionPreviewGUI::initStyleSheets ( )

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

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

                                      : 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();
     }

Here is the call graph for this function:

◆ instantResponseCmd()

ilAssQuestionPreviewGUI::instantResponseCmd ( )

private

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

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

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

Here is the call graph for this function:

◆ isCommentingRequired()

ilAssQuestionPreviewGUI::isCommentingRequired ( )

protected

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

References $ref_id, ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by showCmd().

                                              : bool
     {
         $ref_id = $this->http->wrapper()->query()->retrieve(
             'ref_id',
             $this->refinery->byTrying([
                 $this->refinery->kindlyTo()->int(),
                 $this->refinery->always(0)
             ])
         );
 
         return !$this->previewSettings->isTestRefId() && $this->rbac_system->checkAccess('read', (int) $ref_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isShowBestSolutionRequired()

ilAssQuestionPreviewGUI::isShowBestSolutionRequired ( )

private

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

Referenced by handleInstantResponseRendering().

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

Here is the caller graph for this function:

◆ isShowGenericQuestionFeedbackRequired()

ilAssQuestionPreviewGUI::isShowGenericQuestionFeedbackRequired ( )

private

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

Referenced by handleInstantResponseRendering().

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

Here is the caller graph for this function:

◆ isShowReachedPointsRequired()

ilAssQuestionPreviewGUI::isShowReachedPointsRequired ( )

private

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

Referenced by handleInstantResponseRendering().

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

Here is the caller graph for this function:

◆ isShowSpecificQuestionFeedbackRequired()

ilAssQuestionPreviewGUI::isShowSpecificQuestionFeedbackRequired ( )

private

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

Referenced by handleInstantResponseRendering(), and populateQuestionOutput().

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

Here is the caller graph for this function:

◆ populateCommentsPanel()

ilAssQuestionPreviewGUI::populateCommentsPanel	(	ilTemplate	$tpl,
		string	$comments_panel_html
	)

protected

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

References ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by showCmd().

                                                                                           : void
     {
         if ($comments_panel_html === '') {
             $comments_panel_html = $this->questionGUI->geCommentsPanelHTML();
         }
 
         $tpl->setCurrentBlock('notes_panel');
         $tpl->setVariable('NOTES_PANEL', $comments_panel_html);
         $tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

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 496 of file class.ilAssQuestionPreviewGUI.php.

References ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_CORRECT, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_WRONG, ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by handleInstantResponseRendering().

                                                                      : 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;
     }

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 535 of file class.ilAssQuestionPreviewGUI.php.

References ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by handleInstantResponseRendering().

                                                                                        : 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();
     }

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 548 of file class.ilAssQuestionPreviewGUI.php.

References ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by handleInstantResponseRendering().

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

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 370 of file class.ilAssQuestionPreviewGUI.php.

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

Referenced by showCmd().

                                                             : 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_system->checkAccess('write', (int) $_GET['ref_id'])) {
             $toolbarGUI->setEditPageCmd(
                 $this->ctrl->getLinkTargetByClass('ilAssQuestionPageGUI', 'edit')
             );
 
             $toolbarGUI->setEditQuestionCmd(
                 $this->ctrl->getLinkTargetByClass(
                     ['ilrepositorygui','ilobjquestionpoolgui', get_class($this->questionGUI)],
                     'editQuestion'
                 )
             );
         }
 
         $toolbarGUI->build();
 
         $tpl->setVariable('PREVIEW_TOOLBAR', $this->ctrl->getHTML($toolbarGUI));
     }

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 396 of file class.ilAssQuestionPreviewGUI.php.

References ILIAS\Repository\ctrl(), getQuestionAnswerShuffler(), getQuestionNavigationHtml(), isShowSpecificQuestionFeedbackRequired(), ilPageObjectGUI\setRenderPageContainer(), HTML_Template_IT\setVariable(), and ILIAS\Repository\tabs().

Referenced by showCmd().

                                                             : 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([$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);
     }

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 430 of file class.ilAssQuestionPreviewGUI.php.

References ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by handleInstantResponseRendering().

                                                                    : 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();
     }

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 446 of file class.ilAssQuestionPreviewGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), ilPageObjectGUI\setEditPreview(), and HTML_Template_IT\setVariable().

Referenced by handleInstantResponseRendering().

                                                             : 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([$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();
     }

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 520 of file class.ilAssQuestionPreviewGUI.php.

References ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by handleInstantResponseRendering().

                                                                       : 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetCmd()

ilAssQuestionPreviewGUI::resetCmd ( )

private

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

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

                                : 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);
     }

Here is the call graph for this function:

◆ saveQuestionSolution()

ilAssQuestionPreviewGUI::saveQuestionSolution ( )

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

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

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

Here is the caller graph for this function:

◆ showCmd()

ilAssQuestionPreviewGUI::showCmd ( string $notes_panel_html = '' )

private

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

References buildPreviewFormAction(), handleInstantResponseRendering(), isCommentingRequired(), populateCommentsPanel(), populatePreviewToolbar(), and populateQuestionOutput().

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

                                                            : 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->populateCommentsPanel($tpl, $notes_panel_html);
         }
 
         $this->tpl->setContent($tpl->get());
     }