ilAssQuestionPreviewGUI Class Reference

Collaboration diagram for ilAssQuestionPreviewGUI:

Public Member Functions
	__construct (private readonly ilCtrl $ctrl, private readonly ilRbacSystem $rbac_system, private ilTabsGUI $tabs, private ilToolbarGUI $toolbar, private ilGlobalTemplateInterface $tpl, private readonly UIFactory $ui_factory, private readonly ilLanguage $lng, private readonly ilDBInterface $db, private readonly RandomGroup $random_group, private readonly GlobalScreen $global_screen, private readonly HTTPServices $http, private readonly Refinery $refinery, private readonly int $parent_obj_ref_id)
	setInfoMessage (string $message)
	setPrimaryCmd (string $label, string $cmd)
	addAdditionalCmd (string $label, string $cmd)
	getQuestion ()
	getObject ()
	initQuestion (assQuestionGUI $question_gui, int $parent_obj_id)
	initPreviewSettings (int $parent_ref_id)
	initPreviewSession (int $user_id, int $question_id)
	initHintTracking ()
	initStyleSheets ()
	executeCommand ()
	showCmd (string $commands_panel_html='')
	assessmentCmd ()
	handleInstantResponseRendering (ilTemplate $tpl)
	resetCmd ()
	instantResponseCmd ()
	handleQuestionActionCmd ()
	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 ()
	populateReachedPointsOutput (ilTemplate $tpl)
	populateInstantResponseHeader (ilTemplate $tpl, $withFocusAnchor)
	populateInstantResponseMessage (ilTemplate $tpl, string $a_message)
	populateCommentsPanel (ilTemplate $tpl, string $comments_panel_html)

Protected Attributes
readonly RequestDataCollector	$request_data_collector

Private Member Functions
	populateToolbar ()
	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	$question_gui = null
assQuestion	$question_obj = null
ilAssQuestionPreviewSettings	$preview_settings = null
ilAssQuestionPreviewSession	$preview_session = null
ilAssQuestionPreviewHintTracking	$hint_tracking = null
string	$info_message = null
array	$primary_cmd = []
array	$additional_cmds = []

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilAssQuestionPreviewGUI::__construct	(	private readonly ilCtrl	$ctrl,
		private readonly ilRbacSystem	$rbac_system,
		private ilTabsGUI	$tabs,
		private ilToolbarGUI	$toolbar,
		private ilGlobalTemplateInterface	$tpl,
		private readonly UIFactory	$ui_factory,
		private readonly ilLanguage	$lng,
		private readonly ilDBInterface	$db,
		private readonly RandomGroup	$random_group,
		private readonly GlobalScreen	$global_screen,
		private readonly HTTPServices	$http,
		private readonly Refinery	$refinery,
		private readonly int	$parent_obj_ref_id
	)

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

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

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

        $local_dic = QuestionPoolDIC::dic();
        $this->request_data_collector = $local_dic['request_data_collector'];
    }

Here is the call graph for this function:

Member Function Documentation

addAdditionalCmd()

ilAssQuestionPreviewGUI::addAdditionalCmd	(	string	$label,
		string	$cmd
	)

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

                                                                : void
    {
        $this->additional_cmds[$label] = $cmd;
    }

assessmentCmd()

ilAssQuestionPreviewGUI::assessmentCmd

(

)

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

References ILIAS\Repository\tabs().

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

Here is the call graph for this function:

buildPreviewFormAction()

ilAssQuestionPreviewGUI::buildPreviewFormAction ( )

protected

Definition at line 230 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 187 of file class.ilAssQuestionPreviewGUI.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), 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->question_gui,
                    $this->hint_tracking,
                    $this->ctrl,
                    $this->lng,
                    $this->tpl,
                    $this->tabs,
                    $this->global_screen
                );
                $this->ctrl->forwardCommand($gui);
                break;
            case 'ilassspecfeedbackpagegui':
            case 'ilassgenfeedbackpagegui':
                $forwarder = new ilAssQuestionFeedbackPageObjectCommandForwarder($this->question_obj, $this->ctrl, $this->tabs, $this->lng);
                $forwarder->forward();
                break;
            case 'ilcommentgui':
                $comment_gui = new ilCommentGUI($this->question_obj->getObjId(), $this->question_obj->getId(), 'quest');
                $comments_panel_html = $this->ctrl->forwardCommand($comment_gui);
                $this->showCmd($comments_panel_html);
                break;
            default:
                $cmd = $this->ctrl->getCmd(self::CMD_SHOW);
                $this->{$cmd . 'Cmd'}();
        }
    }

Here is the call graph for this function:

gatewayConfirmHintRequestCmd()

ilAssQuestionPreviewGUI::gatewayConfirmHintRequestCmd

(

)

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

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

                                                  : void
    {
        if (!$this->saveQuestionSolution()) {
            $this->preview_session->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 590 of file class.ilAssQuestionPreviewGUI.php.

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

                                            : void
    {
        if (!$this->saveQuestionSolution()) {
            $this->preview_session->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 121 of file class.ilAssQuestionPreviewGUI.php.

References $question_obj.

                               : assQuestion
    {
        return $this->question_obj;
    }

getQuestion()

ilAssQuestionPreviewGUI::getQuestion

(

)

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

References $question_obj.

                                 : assQuestion
    {
        return $this->question_obj;
    }

getQuestionAnswerShuffler()

ilAssQuestionPreviewGUI::getQuestionAnswerShuffler ( )

private

Returns

Transformation

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

Referenced by populateQuestionOutput().

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

Here is the caller graph for this function:

getQuestionNavigationHtml()

ilAssQuestionPreviewGUI::getQuestionNavigationHtml ( )

private

Definition at line 455 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->preview_settings->isInstantFeedbackNavigationRequired());
        $navGUI->setHintProvidingEnabled($this->preview_settings->isHintProvidingEnabled());

        $navGUI->setHintRequestsPossible($this->hint_tracking->requestsPossible());
        $navGUI->setHintRequestsExist($this->hint_tracking->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

)

Definition at line 272 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->question_gui->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->question_gui->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

(

)

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

initHintTracking()

ilAssQuestionPreviewGUI::initHintTracking

(

)

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

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

initPreviewSession()

ilAssQuestionPreviewGUI::initPreviewSession	(	int	$user_id,
		int	$question_id
	)

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

                                                                      : void
    {
        $this->preview_session = new ilAssQuestionPreviewSession($user_id, $question_id);
        $this->preview_session->init();
    }

initPreviewSettings()

ilAssQuestionPreviewGUI::initPreviewSettings

(

int

$parent_ref_id

)

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

                                                           : void
    {
        $this->preview_settings = new ilAssQuestionPreviewSettings($parent_ref_id);

        $this->preview_settings->init();
    }

initQuestion()

ilAssQuestionPreviewGUI::initQuestion	(	assQuestionGUI	$question_gui,
		int	$parent_obj_id
	)

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

References $question_gui, ILIAS\Repository\ctrl(), assQuestionGUI\getObject(), assQuestionGUI\RENDER_PURPOSE_DEMOPLAY, and ILIAS\Repository\tabs().

                                                                                  : void
    {
        $this->question_gui = $question_gui;
        $this->question_obj = $this->question_gui->getObject();

        $this->question_obj->setObjId($parent_obj_id);

        $this->tabs->clearTargets();
        $this->tabs->addTarget(
            self::TAB_ID_QUESTION,
            $this->ctrl->getLinkTargetByClass(self::class, self::CMD_SHOW),
            '',
            [strtolower(__CLASS__)]
        );
        // Assessment of questions sub menu entry
        $q_type = $this->question_obj->getQuestionType();
        $classname = $q_type . 'GUI';
        $this->tabs->addTarget(
            'statistics',
            $this->ctrl->getLinkTargetByClass(self::class, 'assessment'),
            ['assessment'],
            $classname,
            ''
        );

        $this->question_gui->populateJavascriptFilesRequiredForWorkForm($this->tpl);
        $this->question_gui->setTargetGui($this);
        $this->question_gui->setQuestionActionCmd(self::CMD_HANDLE_QUESTION_ACTION);

        $this->question_gui->setRenderPurpose(assQuestionGUI::RENDER_PURPOSE_DEMOPLAY);
    }

Here is the call graph for this function:

initStyleSheets()

ilAssQuestionPreviewGUI::initStyleSheets

(

)

Definition at line 176 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

(

)

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

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

                                        : void
    {
        if ($this->saveQuestionSolution()) {
            $this->preview_session->setInstantResponseActive(true);
        } else {
            $this->preview_session->setInstantResponseActive(false);
        }

        $this->ctrl->redirect($this, self::CMD_SHOW);
    }

Here is the call graph for this function:

isCommentingRequired()

ilAssQuestionPreviewGUI::isCommentingRequired ( )

protected

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

Referenced by showCmd().

                                             : bool
    {
        return !$this->preview_settings->isTestRefId() &&
            $this->rbac_system->checkAccess('read', $this->request_data_collector->getRefId());
    }

Here is the caller graph for this function:

isShowBestSolutionRequired()

ilAssQuestionPreviewGUI::isShowBestSolutionRequired ( )

private

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

Referenced by handleInstantResponseRendering().

    {
        if (!$this->preview_settings->isBestSolutionEnabled()) {
            return false;
        }

        return $this->preview_session->isInstantResponseActive();
    }

Here is the caller graph for this function:

isShowGenericQuestionFeedbackRequired()

ilAssQuestionPreviewGUI::isShowGenericQuestionFeedbackRequired ( )

private

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

Referenced by handleInstantResponseRendering().

    {
        if (!$this->preview_settings->isGenericFeedbackEnabled()) {
            return false;
        }

        return $this->preview_session->isInstantResponseActive();
    }

Here is the caller graph for this function:

isShowReachedPointsRequired()

ilAssQuestionPreviewGUI::isShowReachedPointsRequired ( )

private

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

Referenced by handleInstantResponseRendering().

    {
        if (!$this->preview_settings->isReachedPointsEnabled()) {
            return false;
        }

        return $this->preview_session->isInstantResponseActive();
    }

Here is the caller graph for this function:

isShowSpecificQuestionFeedbackRequired()

ilAssQuestionPreviewGUI::isShowSpecificQuestionFeedbackRequired ( )

private

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

Referenced by handleInstantResponseRendering(), and populateQuestionOutput().

                                                             : bool
    {
        if (!$this->preview_settings->isSpecificFeedbackEnabled()) {
            return false;
        }

        return $this->preview_session->isInstantResponseActive();
    }

Here is the caller graph for this function:

populateCommentsPanel()

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

protected

Definition at line 615 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->question_gui->getCommentsPanelHTML();
        }

        $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 476 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->question_obj->isPreviewSolutionCorrect($this->preview_session)) {
            $feedback = $this->question_gui->getGenericFeedbackOutputForCorrectSolution();
            $cssClass = ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_CORRECT;
        } else {
            $feedback = $this->question_gui->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 515 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 528 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:

populateQuestionOutput()

ilAssQuestionPreviewGUI::populateQuestionOutput ( ilTemplate  $tpl )

private

Definition at line 386 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');

        $page_gui = new ilAssQuestionPageGUI($this->question_obj->getId());
        $page_gui->setRenderPageContainer(false);
        $page_gui->setEditPreview(true);
        $page_gui->setEnabledTabs(false);

        $this->question_gui->setPreviewSession($this->preview_session);
        $question = $this->question_gui->getObject();
        $question->setShuffler($this->getQuestionAnswerShuffler());
        $this->question_gui->setObject($question);

        $question_html = $this->question_gui->getPreview(true, $this->isShowSpecificQuestionFeedbackRequired());
        $this->question_gui->magicAfterTestOutput();

        $question_html .= $this->getQuestionNavigationHtml();

        $page_gui->setQuestionHTML([$this->question_obj->getId() => $question_html]);

        $page_gui->setPresentationTitle($this->question_obj->getTitleForHTMLOutput());

        $tpl->setVariable('QUESTION_OUTPUT', $page_gui->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 416 of file class.ilAssQuestionPreviewGUI.php.

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

Referenced by handleInstantResponseRendering().

                                                                   : void
    {
        $reachedPoints = $this->question_obj->calculateReachedPointsFromPreviewSession($this->preview_session);
        $maxPoints = $this->question_obj->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 432 of file class.ilAssQuestionPreviewGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), null, 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->question_obj->getId());

        $pageGUI->setEditPreview(true);
        $pageGUI->setEnabledTabs(false);

        $this->question_gui->setPreviewSession($this->preview_session);

        $pageGUI->setQuestionHTML([$this->question_obj->getId() => $this->question_gui->getSolutionOutput(0, null, false, false, true, false, true, false, false)]);

        $output = $this->question_gui->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 500 of file class.ilAssQuestionPreviewGUI.php.

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

Referenced by handleInstantResponseRendering().

                                                                      : bool
    {
        $fb = $this->question_gui->getSpecificFeedbackOutput(
            (array) $this->preview_session->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:

populateToolbar()

ilAssQuestionPreviewGUI::populateToolbar ( )

private

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

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

Referenced by showCmd().

                                      : void
    {
        $this->toolbar->setFormAction($this->ctrl->getFormAction($this, self::CMD_SHOW));

        if ($this->rbac_system->checkAccess('write', $this->parent_obj_ref_id)) {
            if ($this->primary_cmd !== []) {
                $this->toolbar->addComponent(
                    $this->ui_factory->button()->primary(key($this->primary_cmd), current($this->primary_cmd))
                );
            }
            foreach ($this->additional_cmds as $label => $action) {
                $this->toolbar->addComponent(
                    $this->ui_factory->button()->standard($label, $action)
                );
            }
        }

        $this->toolbar->addComponent(
            $this->ui_factory->button()->standard(
                $this->lng->txt('qpl_reset_preview'),
                $this->ctrl->getLinkTargetByClass(ilAssQuestionPreviewGUI::class, self::CMD_RESET)
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetCmd()

ilAssQuestionPreviewGUI::resetCmd

(

)

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

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

                              : void
    {
        $this->preview_session->setRandomizerSeed(null);
        $this->preview_session->setParticipantsSolution(null);
        $this->preview_session->resetRequestedHints();
        $this->preview_session->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 571 of file class.ilAssQuestionPreviewGUI.php.

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

                                          : bool
    {
        return $this->question_obj->persistPreviewState($this->preview_session);
    }

Here is the caller graph for this function:

setInfoMessage()

ilAssQuestionPreviewGUI::setInfoMessage

(

string

$message

)

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

References $message.

Referenced by ilObjTestGUI\forwardCommandToQuestionPreview().

                                                   : void
    {
        $this->info_message = $message;
    }

Here is the caller graph for this function:

setPrimaryCmd()

ilAssQuestionPreviewGUI::setPrimaryCmd	(	string	$label,
		string	$cmd
	)

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

                                                             : void
    {
        $this->primary_cmd[$label] = $cmd;
    }

showCmd()

ilAssQuestionPreviewGUI::showCmd

(

string

$commands_panel_html = ''

)

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

References buildPreviewFormAction(), assQuestionGUI\CMD_SYNC_QUESTION_AND_RETURN, handleInstantResponseRendering(), isCommentingRequired(), null, populateCommentsPanel(), populateQuestionOutput(), and populateToolbar().

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

                                                             : void
    {
        $tpl = new ilTemplate('tpl.qpl_question_preview.html', true, true, 'components/ILIAS/TestQuestionPool');
        $tpl->setVariable('PREVIEW_FORMACTION', $this->buildPreviewFormAction());

        $modal = '';
        if ($this->question_gui->isSaveCommand() && $this->question_gui->needsSyncQuery()) {
            $modal = $this->question_gui->getQuestionSyncModal(assQuestionGUI::CMD_SYNC_QUESTION_AND_RETURN);
        }

        if ($this->info_message !== null) {
            $this->tpl->setOnScreenMessage('info', $this->info_message, true);
        }

        $this->populateToolbar();
        $this->populateQuestionOutput($tpl);
        $this->handleInstantResponseRendering($tpl);

        if ($this->isCommentingRequired()) {
            $this->populateCommentsPanel($tpl, $commands_panel_html);
        }

        $this->tpl->setContent($tpl->get() . $modal);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$additional_cmds

array< string $label, string $action > ilAssQuestionPreviewGUI::$additional_cmds = []

private

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

$hint_tracking

ilAssQuestionPreviewHintTracking ilAssQuestionPreviewGUI::$hint_tracking = null

private

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

$info_message

string ilAssQuestionPreviewGUI::$info_message = null

private

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

$preview_session

ilAssQuestionPreviewSession ilAssQuestionPreviewGUI::$preview_session = null

private

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

$preview_settings

ilAssQuestionPreviewSettings ilAssQuestionPreviewGUI::$preview_settings = null

private

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

$primary_cmd

array< string $label, string $action > ilAssQuestionPreviewGUI::$primary_cmd = []

private

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

$question_gui

assQuestionGUI ilAssQuestionPreviewGUI::$question_gui = null

private

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

Referenced by initQuestion().

$question_obj

assQuestion ilAssQuestionPreviewGUI::$question_obj = null

private

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

Referenced by getObject(), and getQuestion().

$request_data_collector

readonly RequestDataCollector ilAssQuestionPreviewGUI::$request_data_collector

protected

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

CMD_GATEWAY_CONFIRM_HINT_REQUEST

const ilAssQuestionPreviewGUI::CMD_GATEWAY_CONFIRM_HINT_REQUEST = 'gatewayConfirmHintRequest'

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

CMD_GATEWAY_SHOW_HINT_LIST

const ilAssQuestionPreviewGUI::CMD_GATEWAY_SHOW_HINT_LIST = 'gatewayShowHintList'

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

CMD_HANDLE_QUESTION_ACTION

const ilAssQuestionPreviewGUI::CMD_HANDLE_QUESTION_ACTION = 'handleQuestionAction'

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

CMD_INSTANT_RESPONSE

const ilAssQuestionPreviewGUI::CMD_INSTANT_RESPONSE = 'instantResponse'

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

CMD_RESET

const ilAssQuestionPreviewGUI::CMD_RESET = 'reset'

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

CMD_SHOW

const ilAssQuestionPreviewGUI::CMD_SHOW = 'show'

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

Referenced by assQuestionGUI\addBackTab(), ILIAS\Test\StaticURLHandler\buildQuestionURL(), ilObjTestGUI\executeCommand(), ilQuestionBrowserTableGUI\fillRow(), ilAssQuestionPageGUI\finishEditing(), ilAssQuestionPageCommandForwarder\forward(), ILIAS\Test\Questions\Presentation\QuestionsTableActions\handleCommand(), assQuestionGUI\saveReturn(), and ilObjTestGUI\showNextViewAfterQuestionSave().

CMD_STATISTICS

const ilAssQuestionPreviewGUI::CMD_STATISTICS = 'assessment'

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

Referenced by ilQuestionBrowserTableGUI\fillRow(), and ILIAS\Test\Questions\Presentation\QuestionsTableActions\handleCommand().

FEEDBACK_FOCUS_ANCHOR

const ilAssQuestionPreviewGUI::FEEDBACK_FOCUS_ANCHOR = 'focus'

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

TAB_ID_QUESTION

const ilAssQuestionPreviewGUI::TAB_ID_QUESTION = 'question'

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

---

The documentation for this class was generated from the following file:

• components/ILIAS/TestQuestionPool/classes/class.ilAssQuestionPreviewGUI.php