Collaboration diagram for ilAssQuestionPreviewGUI:

Public Member Functions
	__construct (ilCtrl $ctrl, ilTabsGUI $tabs, ilTemplate $tpl, ilLanguage $lng, ilDBInterface $db, ilObjUser $user)

	initQuestion ($questionId, $parentObjId)

	initPreviewSettings ($parentRefId)

	initPreviewSession ($userId, $questionId)

	initHintTracking ()

	initStyleSheets ()

	executeCommand ()

	saveQuestionSolution ()

	gatewayConfirmHintRequestCmd ()

	gatewayShowHintListCmd ()

Data Fields
const	CMD_SHOW = 'show'

const	CMD_RESET = 'reset'

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_PREVIEW = 'preview'

Protected Attributes
	$ctrl

	$tabs

	$tpl

	$lng

	$db

	$user

	$questionGUI

	$questionOBJ

	$previewSettings

	$previewSession

	$hintTracking

Private Member Functions
	showCmd ()

	resetCmd ()

	instantResponseCmd ()

	handleQuestionActionCmd ()

	populatePreviewToolbar (ilTemplate $tpl)

	populateQuestionOutput (ilTemplate $tpl)

	populateSolutionOutput (ilTemplate $tpl)

	populateQuestionNavigation (ilTemplate $tpl)

	populateGenericQuestionFeedback (ilTemplate $tpl)

	populateSpecificQuestionFeedback (ilTemplate $tpl)

	isShowBestSolutionRequired ()

	isShowGenericQuestionFeedbackRequired ()

	isShowSpecificQuestionFeedbackRequired ()

	getQuestionAnswerShuffler ()

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionPreviewGUI::__construct	(	ilCtrl	$ctrl,
		ilTabsGUI	$tabs,
		ilTemplate	$tpl,
		ilLanguage	$lng,
		ilDBInterface	$db,
		ilObjUser	$user
	)

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

References $ctrl, $db, $lng, $tabs, $tpl, $user, and user().

         {
                 $this->ctrl = $ctrl;
                 $this->tabs = $tabs;
                 $this->tpl = $tpl;
                 $this->lng = $lng;
                 $this->db = $db;
                 $this->user = $user;
         }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilAssQuestionPreviewGUI::executeCommand ( )

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

References $cmd, and $DIC.

         {
                 global $DIC; /* @var \ILIAS\DI\Container $DIC */
                 $ilHelp = $DIC['ilHelp']; /* @var ilHelpGUI $ilHelp */
                 $ilHelp->setScreenIdComponent('qpl');
 
                 $this->tabs->setTabActive(self::TAB_ID_QUESTION_PREVIEW);
                 
                 $this->lng->loadLanguageModule('content');
                 
                 $nextClass = $this->ctrl->getNextClass($this);
                 
                 switch($nextClass)
                 {
                         case 'ilassquestionhintrequestgui':
                                 
                                 require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintRequestGUI.php';
                                 $gui = new ilAssQuestionHintRequestGUI($this, self::CMD_SHOW, $this->questionGUI, $this->hintTracking);
 
                                 $this->ctrl->forwardCommand($gui);
 
                                 break;
 
                         case 'ilassspecfeedbackpagegui':
                         case 'ilassgenfeedbackpagegui':
                                 require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionFeedbackPageObjectCommandForwarder.php';
                                 $forwarder = new ilAssQuestionFeedbackPageObjectCommandForwarder($this->questionOBJ, $this->ctrl, $this->tabs, $this->lng);
                                 $forwarder->forward();
                                 break;
                         
                         default:
 
                                 $cmd = $this->ctrl->getCmd(self::CMD_SHOW).'Cmd';
                                 
                                 $this->$cmd();
                 }
         }

◆ gatewayConfirmHintRequestCmd()

ilAssQuestionPreviewGUI::gatewayConfirmHintRequestCmd ( )

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

References ilAssQuestionHintRequestGUI\CMD_CONFIRM_REQUEST, saveQuestionSolution(), and showCmd().

         {
                 if( !$this->saveQuestionSolution() )
                 {
                         $this->previewSession->setInstantResponseActive(false);
                         $this->showCmd();
                         return;
                 }
                 
                 require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintRequestGUI.php';
                 
                 $this->ctrl->redirectByClass(
                         'ilAssQuestionHintRequestGUI', ilAssQuestionHintRequestGUI::CMD_CONFIRM_REQUEST
                 );
         }

Here is the call graph for this function:

◆ gatewayShowHintListCmd()

ilAssQuestionPreviewGUI::gatewayShowHintListCmd ( )

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

References ilAssQuestionHintRequestGUI\CMD_SHOW_LIST, saveQuestionSolution(), and showCmd().

         {
                 if( !$this->saveQuestionSolution() )
                 {
                         $this->previewSession->setInstantResponseActive(false);
                         $this->showCmd();
                         return;
                 }
 
                 require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintRequestGUI.php';
                 
                 $this->ctrl->redirectByClass(
                         'ilAssQuestionHintRequestGUI', ilAssQuestionHintRequestGUI::CMD_SHOW_LIST
                 );
         }

Here is the call graph for this function:

◆ getQuestionAnswerShuffler()

ilAssQuestionPreviewGUI::getQuestionAnswerShuffler ( )

private

Returns: ilArrayElementShuffler

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

Referenced by populateQuestionOutput().

         {
                 require_once 'Services/Randomization/classes/class.ilArrayElementShuffler.php';
                 $shuffler = new ilArrayElementShuffler();
                 
                 if( !$this->previewSession->randomizerSeedExists() )
                 {
                         $this->previewSession->setRandomizerSeed($shuffler->buildRandomSeed());
                 }
                 
                 $shuffler->setSeed($this->previewSession->getRandomizerSeed());         
                 
                 return $shuffler;
         }

Here is the caller graph for this function:

◆ handleQuestionActionCmd()

ilAssQuestionPreviewGUI::handleQuestionActionCmd ( )

private

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

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

◆ initHintTracking()

ilAssQuestionPreviewGUI::initHintTracking ( )

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

         {
                 require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionPreviewHintTracking.php';
                 $this->hintTracking = new ilAssQuestionPreviewHintTracking($this->db, $this->previewSession);
         }

◆ initPreviewSession()

ilAssQuestionPreviewGUI::initPreviewSession	(	$userId,
		$questionId
	)

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

         {
                 require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionPreviewSession.php';
                 $this->previewSession = new ilAssQuestionPreviewSession($userId, $questionId);
 
                 $this->previewSession->init();
         }

◆ initPreviewSettings()

ilAssQuestionPreviewGUI::initPreviewSettings ( $parentRefId )

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

         {
                 require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionPreviewSettings.php';
                 $this->previewSettings = new ilAssQuestionPreviewSettings($parentRefId);
                 
                 $this->previewSettings->init();
         }

◆ initQuestion()

ilAssQuestionPreviewGUI::initQuestion	(	$questionId,
		$parentObjId
	)

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

References assQuestion\instantiateQuestionGUI(), OUTPUT_JAVASCRIPT, and assQuestionGUI\RENDER_PURPOSE_DEMOPLAY.

         {
                 require_once 'Modules/TestQuestionPool/classes/class.assQuestion.php';
                 
                 $this->questionGUI = assQuestion::instantiateQuestionGUI($questionId);
                 $this->questionOBJ = $this->questionGUI->object;
 
                 $this->questionOBJ->setObjId($parentObjId);
 
                 $this->questionGUI->setQuestionTabs();
                 $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);
         }

Here is the call graph for this function:

◆ initStyleSheets()

ilAssQuestionPreviewGUI::initStyleSheets ( )

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

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

         {
                 include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
                 
                 $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 230 of file class.ilAssQuestionPreviewGUI.php.

References saveQuestionSolution().

         {
                 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:

◆ isShowBestSolutionRequired()

ilAssQuestionPreviewGUI::isShowBestSolutionRequired ( )

private

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

Referenced by showCmd().

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

Referenced by showCmd().

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

Here is the caller graph for this function:

◆ isShowSpecificQuestionFeedbackRequired()

ilAssQuestionPreviewGUI::isShowSpecificQuestionFeedbackRequired ( )

private

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

Referenced by populateQuestionOutput(), and showCmd().

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

Here is the caller graph for this function:

◆ populateGenericQuestionFeedback()

ilAssQuestionPreviewGUI::populateGenericQuestionFeedback ( ilTemplate $tpl )

private

Definition at line 353 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 showCmd().

         {
                 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( strlen($feedback) )
                 {
                         $tpl->setCurrentBlock('instant_feedback_generic');
                         $tpl->setVariable('GENERIC_FEEDBACK', $feedback);
                         $tpl->setVariable('ILC_FB_CSS_CLASS', $cssClass);
                         $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 250 of file class.ilAssQuestionPreviewGUI.php.

References HTML_Template_IT\setVariable().

Referenced by showCmd().

         {
                 require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionPreviewToolbarGUI.php';
                 $toolbarGUI = new ilAssQuestionPreviewToolbarGUI($this->lng);
 
                 $toolbarGUI->setFormAction($this->ctrl->getFormAction($this, self::CMD_SHOW));
                 $toolbarGUI->setResetPreviewCmd(self::CMD_RESET);
 
                 $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:

◆ populateQuestionNavigation()

ilAssQuestionPreviewGUI::populateQuestionNavigation ( ilTemplate $tpl )

private

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

References HTML_Template_IT\setVariable().

Referenced by showCmd().

         {
                 require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionRelatedNavigationBarGUI.php';
                 $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());
                 
                 $tpl->setVariable('QUESTION_NAVIGATION', $this->ctrl->getHTML($navGUI));
         }

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

References $_POST, array, getQuestionAnswerShuffler(), isShowSpecificQuestionFeedbackRequired(), ilPageObjectGUI\setRenderPageContainer(), and HTML_Template_IT\setVariable().

Referenced by showCmd().

         {
                 // FOR WHAT EXACTLY IS THIS USEFUL?
                 $this->ctrl->setReturnByClass('ilAssQuestionPageGUI', 'view');
                 $this->ctrl->setReturnByClass('ilObjQuestionPoolGUI', 'questions');
 
                 include_once("./Modules/TestQuestionPool/classes/class.ilAssQuestionPageGUI.php");
                 $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();
                 
                 $pageGUI->setQuestionHTML(array($this->questionOBJ->getId() => $questionHtml));
 
                 //$pageGUI->setHeader($this->questionOBJ->getTitle()); // NO ADDITIONAL HEADER
                 $pageGUI->setPresentationTitle($this->questionOBJ->getTitle());
 
                 //$pageGUI->setTemplateTargetVar("ADM_CONTENT"); // NOT REQUIRED, OR IS?
 
                 $tpl->setVariable('QUESTION_OUTPUT', $pageGUI->preview());
         }

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

References $_POST, array, ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), ilPageObjectGUI\setEditPreview(), and HTML_Template_IT\setVariable().

Referenced by showCmd().

         {
                 // FOR WHAT EXACTLY IS THIS USEFUL?
                 $this->ctrl->setReturnByClass('ilAssQuestionPageGUI', 'view');
                 $this->ctrl->setReturnByClass('ilObjQuestionPoolGUI', 'questions');
 
                 include_once("./Modules/TestQuestionPool/classes/class.ilAssQuestionPageGUI.php");
                 $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
                 )));
 
                 //$pageGUI->setHeader($this->questionOBJ->getTitle()); // NO ADDITIONAL HEADER
                 //$pageGUI->setPresentationTitle($this->questionOBJ->getTitle());
 
                 //$pageGUI->setTemplateTargetVar("ADM_CONTENT"); // NOT REQUIRED, OR IS?
 
                 $tpl->setCurrentBlock('solution_output');
                 $tpl->setVariable('TXT_CORRECT_SOLUTION', $this->lng->txt('tst_best_solution_is'));
                 $tpl->setVariable('SOLUTION_OUTPUT', $pageGUI->preview());
                 $tpl->parseCurrentBlock();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateSpecificQuestionFeedback()

ilAssQuestionPreviewGUI::populateSpecificQuestionFeedback ( ilTemplate $tpl )

private

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

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

Referenced by showCmd().

         {
                 $tpl->setCurrentBlock('instant_feedback_specific');
                 $tpl->setVariable('ANSWER_FEEDBACK', $this->questionGUI->getSpecificFeedbackOutput(0, -1));
                 $tpl->parseCurrentBlock();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetCmd()

ilAssQuestionPreviewGUI::resetCmd ( )

private

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

References ilUtil\sendInfo().

         {
                 $this->previewSession->setRandomizerSeed(null);
                 $this->previewSession->setParticipantsSolution(null);
                 $this->previewSession->resetRequestedHints();
                 $this->previewSession->setInstantResponseActive(false);
 
                 ilUtil::sendInfo($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 412 of file class.ilAssQuestionPreviewGUI.php.

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

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

Here is the caller graph for this function:

◆ showCmd()

ilAssQuestionPreviewGUI::showCmd ( )

private

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

References $tpl, isShowBestSolutionRequired(), isShowGenericQuestionFeedbackRequired(), isShowSpecificQuestionFeedbackRequired(), populateGenericQuestionFeedback(), populatePreviewToolbar(), populateQuestionNavigation(), populateQuestionOutput(), populateSolutionOutput(), and populateSpecificQuestionFeedback().

Referenced by gatewayConfirmHintRequestCmd(), and gatewayShowHintListCmd().

         {
                 $tpl = new ilTemplate('tpl.qpl_question_preview.html', true, true, 'Modules/TestQuestionPool');
 
                 $tpl->setVariable('PREVIEW_FORMACTION', $this->ctrl->getFormAction($this, self::CMD_SHOW));
 
                 $this->populatePreviewToolbar($tpl);
                 
                 $this->populateQuestionOutput($tpl);
                 
                 $this->populateQuestionNavigation($tpl);
 
                 if( $this->isShowGenericQuestionFeedbackRequired() )
                 {
                         $this->populateGenericQuestionFeedback($tpl);
                 }
 
                 if( $this->isShowSpecificQuestionFeedbackRequired() )
                 {
                         $this->populateSpecificQuestionFeedback($tpl);
                 }
                 
                 if( $this->isShowBestSolutionRequired() )
                 {
                         $this->populateSolutionOutput($tpl);
                 }
                 
                 $this->tpl->setContent($tpl->get());
         }