assFormulaQuestionGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for assFormulaQuestionGUI:

Collaboration diagram for assFormulaQuestionGUI:

Public Member Functions
	__construct ($id=-1)
	assFormulaQuestionGUI constructor The constructor takes possible arguments an creates an instance of the assFormulaQuestionGUI object. More...
	suggestRange (string $suggest_range_for_result)
	resetSavedPreviewSession ()
	isSaveCommand ()
	parseQuestion ()
	checkInput ()
	check input fields More...
	getSolutionOutput ( $active_id, $pass=null, $graphicalOutput=false, $result_output=false, $show_question_only=true, $show_feedback=false, $show_correct_solution=false, $show_manual_scoring=false, $show_question_text=true)
	Get the question solution output. More...
	renderSolutionOutput (mixed $user_solutions, int $active_id, ?int $pass, bool $graphical_output=false, bool $result_output=false, bool $show_question_only=true, bool $show_feedback=false, bool $show_correct_solution=false, bool $show_manual_scoring=false, bool $show_question_text=true, bool $show_autosave_title=false, bool $show_inline_feedback=false,)
	getPreview ($show_question_only=false, $showInlineFeedback=false)
	getTestOutput ($active_id, $pass, $is_postponed=false, $use_post_solutions=false, $show_feedback=false)
	getSpecificFeedbackOutput (array $userSolution)
Public Member Functions inherited from assQuestionGUI
	hasInlineFeedback ()
	addHeaderAction ()
	redrawHeaderAction ()
	getHeaderAction ()
	geCommentsPanelHTML ()
	executeCommand ()
	getType ()
	needed for page editor compliance More...
	getPresentationContext ()
	setPresentationContext (string $presentationContext)
	isTestPresentationContext ()
	isPreviousSolutionPrefilled ()
	setPreviousSolutionPrefilled (bool $previousSolutionPrefilled)
	getRenderPurpose ()
	setRenderPurpose (string $renderPurpose)
	isRenderPurposePrintPdf ()
	isRenderPurposePreview ()
	isRenderPurposeInputValue ()
	isRenderPurposePlayback ()
	isRenderPurposeDemoplay ()
	renderPurposeSupportsFormHtml ()
	getEditContext ()
	setEditContext (string $editContext)
	isAuthoringEditContext ()
	isAdjustmentEditContext ()
	setAdjustmentEditContext ()
	getNavigationGUI ()
	setNavigationGUI (?ilTestQuestionNavigationGUI $navigationGUI)
	setTaxonomyIds (array $taxonomyIds)
	getTaxonomyIds ()
	setTargetGui ($linkTargetGui)
	setTargetGuiClass ($targetGuiClass)
	getTargetGuiClass ()
	setQuestionHeaderBlockBuilder (\ilQuestionHeaderBlockBuilder $questionHeaderBlockBuilder)
	getQuestionHeaderBlockBuilder ()
	setQuestionActionCmd (string $questionActionCmd)
	getQuestionActionCmd ()
	assessment ()
	populateJavascriptFilesRequiredForWorkForm (ilGlobalTemplateInterface $tpl)
	getPresentationJavascripts ()
	getQuestionTemplate ()
	getILIASPage (string $html="")
	Returns the ILIAS Page around a question. More...
	outQuestionPage ($a_temp_var, $a_postponed=false, $active_id="", $html="", $inlineFeedbackEnabled=false)
	cancel ()
	originalSyncForm (string $return_to="", string $return_to_feedback='')
	sync ()
	cancelSync ()
	saveEdit ()
	save ()
	saveReturn ()
	apply ()
	getContextPath ($cont_obj, int $a_endnode_id, int $a_startnode_id=1)
	get context path in content object tree More...
	setSequenceNumber (int $nr)
	getSequenceNumber ()
	setQuestionCount (int $a_question_count)
	getQuestionCount ()
	getErrorMessage ()
	setErrorMessage (string $errormessage)
	addErrorMessage (string $errormessage)
	outAdditionalOutput ()
	Why are you here? Some magic for plugins? More...
	getQuestionType ()
	getAsValueAttribute (string $a_value)
	addNewIdListener ($a_object, string $a_method, string $a_parameters="")
	Add a listener that is notified with the new question ID, when a new question is saved. More...
	callNewIdListeners (int $a_new_id)
	addQuestionFormCommandButtons (ilPropertyFormGUI $form)
	addBasicQuestionFormProperties (ilPropertyFormGUI $form)
	getGenericFeedbackOutput (int $active_id, ?int $pass)
	getGenericFeedbackOutputForCorrectSolution ()
	getGenericFeedbackOutputForIncorrectSolution ()
	getSpecificFeedbackOutput (array $userSolution)
	Returns the answer specific feedback for the question. More...
	outQuestionType ()
	suggestedsolution ()
	outSolutionExplorer ()
	saveSuggestedSolutionType ()
	cancelExplorer ()
	outPageSelector ()
	outChapterSelector ()
	outGlossarySelector ()
	linkChilds ()
	addPG ()
	addST ()
	addGIT ()
	isSaveCommand ()
	setQuestionTabs ()
	addTab_SuggestedSolution (ilTabsGUI $tabs, string $classname)
	getEditQuestionTabCommands ()
	getSolutionOutput ( $active_id, $pass=null, $graphicalOutput=false, $result_output=false, $show_question_only=true, $show_feedback=false, $show_correct_solution=false, $show_manual_scoring=false, $show_question_text=true)
	renderSolutionOutput (mixed $user_solutions, int $active_id, int $pass, bool $graphical_output=false, bool $result_output=false, bool $show_question_only=true, bool $show_feedback=false, bool $show_correct_solution=false, bool $show_manual_scoring=false, bool $show_question_text=true, bool $show_autosave_title=false, bool $show_inline_feedback=false,)
	isAutosaveable ()
	getPreview ($show_question_only=false, $showInlineFeedback=false)
	outQuestionForTest (string $formaction, int $active_id, ?int $pass, bool $is_question_postponed=false, $user_post_solutions=false, bool $show_specific_inline_feedback=false)
	magicAfterTestOutput ()
	getTestOutput ( $active_id, $pass, $is_question_postponed, $user_post_solutions, $show_specific_inline_feedback)
	getFormEncodingType ()
	setPreviewSession (ilAssQuestionPreviewSession $previewSession)
	getPreviewSession ()
	showHints ()
	buildFocusAnchorHtml ()
	isAnswerFrequencyStatisticSupported ()
	getSubQuestionsIndex ()
	getAnswersFrequency ($relevantAnswers, $questionIndex)
	getAnswerFrequencyTableGUI ($parentGui, $parentCmd, $relevantAnswers, $questionIndex)
	prepareReprintableCorrectionsForm (ilPropertyFormGUI $form)
	populateCorrectionsFormProperties (ilPropertyFormGUI $form)
	saveCorrectionsFormProperties (ilPropertyFormGUI $form)
	isInLearningModuleContext ()
	setInLearningModuleContext (bool $flag)
	getAutoSavedSolutionOutput (int $active_id, int $pass, bool $graphical_output=false, bool $result_output=false, bool $show_question_only=true, bool $show_feedback=false, bool $show_correct_solution=false, bool $show_manual_scoring=false, bool $show_question_text=true, bool $show_autosave_title=false, bool $show_inline_feedback=false)

Protected Member Functions
	setQuestionSpecificTabs (ilTabsGUI $ilTabs)
	callSpecialQuestionCommands (string $cmd)
	writePostData (bool $always=false)
	{} More...
Protected Member Functions inherited from assQuestionGUI
	hasSpecialQuestionCommands ()
	writePostData (bool $always=false)
	Evaluates a posted edit form and writes the form data in the question object. More...
	renderEditForm (ilPropertyFormGUI $form)
	getUseUnchangedAnswerCheckboxHtml ()
	getPreviousSolutionProvidedMessage ()
	getPreviousSolutionConfirmationCheckboxHtml ()
	addNumberOfTriesToFormIfNecessary (ilPropertyFormGUI $form)
	saveTaxonomyAssignments ()
	populateTaxonomyFormSection (ilPropertyFormGUI $form)
	genericFeedbackOutputBuilder (string $feedback_correct, string $feedback_incorrect, int $active_id, ?int $pass)
	getTypeOptions ()
	createSuggestedSolutionLinkingTo (string $type, string $target)
	setDefaultTabs (ilTabsGUI $ilTabs)
	setQuestionSpecificTabs (ilTabsGUI $ilTabs)
	getBasicEditQuestionTabCommands ()
	getAdditionalEditQuestionCommands ()
	addTab_QuestionFeedback (ilTabsGUI $tabs)
	addTab_QuestionHints (ilTabsGUI $tabs)
	addTab_Question (ilTabsGUI $tabsGUI)
	hasCorrectSolution ($activeId, $passIndex)
	writeQuestionGenericPostData ()
	completeTestOutputFormAction ($formAction, $active_id, $pass)
	addBackTab (ilTabsGUI $ilTabs)
	buildBasicEditFormObject ()
	escapeTemplatePlaceholders (string $text)
	buildEditForm ()
	generateCorrectnessIconsForCorrectness (int $correctness)
	getSuggestedSolutionsRepo ()
	cleanupAnswerText (array $answer_text, bool $is_rte)
	sk - 12.05.2023: This is one more of those that we need, but don't want. More...
	addSaveOnEnterOnLoadCode ()

Protected Attributes
const	HAS_SPECIAL_QUESTION_COMMANDS = true
Protected Attributes inherited from assQuestionGUI
const	SUGGESTED_SOLUTION_COMMANDS_CANCEL = 'cancelSuggestedSolution'
const	SUGGESTED_SOLUTION_COMMANDS_SAVE = 'saveSuggestedSolution'
const	SUGGESTED_SOLUTION_COMMANDS_DEFAULT = 'suggestedsolution'
const	HAS_SPECIAL_QUESTION_COMMANDS = false
ilLogger	$logger
ILIAS TestQuestionPool QuestionInfoService	$questioninfo
ILIAS Notes GUIService	$notes_gui
ilCtrl	$ctrl
Refinery	$refinery
ilPropertyFormGUI	$editForm
ILIAS TestQuestionPool InternalRequestService	$request
bool	$parent_type_is_lm = false
assQuestionSuggestedSolutionsDatabaseRepository	$suggestedsolution_repo = null

Private Member Functions
	hasResultUnit ($result, $unit_id, $resultunits)
	canUseAdvancedRating ($result)
	Check if advanced rating can be used for a result. More...

Additional Inherited Members
Static Public Member Functions inherited from assQuestionGUI
static	_getQuestionGUI (string $question_type='', int $question_id=-1)
	Creates a question gui representation and returns the alias to the question gui. More...
static	_getGUIClassNameForId ($a_q_id)
static	_getClassNameForQType ($q_type)
static	getCommandsFromClassConstants (string $guiClassName, string $cmdConstantNameBegin='CMD_')
static	prepareTextareaOutput (?string $txt_output, bool $prepare_for_latex_output=false, bool $omitNl2BrWhenTextArea=false)
	Prepares a string for a text area output where latex code may be in it If the text is HTML-free, CHR(13) will be converted to a line break. More...
Data Fields inherited from assQuestionGUI
const	FORM_MODE_EDIT = 'edit'
const	FORM_MODE_ADJUST = 'adjust'
const	FORM_ENCODING_URLENCODE = 'application/x-www-form-urlencoded'
const	FORM_ENCODING_MULTIPART = 'multipart/form-data'
const	CORRECTNESS_NOT_OK = 0
const	CORRECTNESS_MOSTLY_OK = 1
const	CORRECTNESS_OK = 2
const	ALLOWED_PLAIN_TEXT_TAGS = "<em>, <strong>"
	sk - 12.05.2023: This const is also used in ilKprimChoiceWizardInputGUI. More...
const	SESSION_PREVIEW_DATA_BASE_INDEX = 'ilAssQuestionPreviewAnswers'
assQuestion	$object
ilGlobalPageTemplate	$tpl
ilLanguage	$lng
	$error
string	$errormessage
int	$sequence_no
	sequence number in test More...
int	$question_count
	question count in test More...
const	PRESENTATION_CONTEXT_TEST = 'pContextTest'
const	PRESENTATION_CONTEXT_RESULTS = 'pContextResults'
const	RENDER_PURPOSE_PLAYBACK = 'renderPurposePlayback'
const	RENDER_PURPOSE_DEMOPLAY = 'renderPurposeDemoplay'
const	RENDER_PURPOSE_PREVIEW = 'renderPurposePreview'
const	RENDER_PURPOSE_PRINT_PDF = 'renderPurposePrintPdf'
const	RENDER_PURPOSE_INPUT_VALUE = 'renderPurposeInputValue'
const	EDIT_CONTEXT_AUTHORING = 'authoring'
const	EDIT_CONTEXT_ADJUSTMENT = 'adjustment'

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Single choice question GUI representation The assFormulaQuestionGUI class encapsulates the GUI representation for single choice questions.

Author

Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Version

Id

class.assFormulaQuestionGUI.php 1235 2010-02-15 15:21:18Z hschottm

assFormulaQuestionGUI: ilFormPropertyDispatchGUI

Definition at line 30 of file class.assFormulaQuestionGUI.php.

Constructor & Destructor Documentation

__construct()

assFormulaQuestionGUI::__construct

(

$id = -1

)

assFormulaQuestionGUI constructor The constructor takes possible arguments an creates an instance of the assFormulaQuestionGUI object.

Parameters

integer

$id

The database id of a multiple choice question object public

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

References $id, and ILIAS\MetaData\Repository\Validation\Data\__construct().

    {
        parent::__construct();
        $this->object = new assFormulaQuestion();
        if ($id >= 0) {
            $this->object->loadFromDb($id);
        }
    }

Here is the call graph for this function:

Member Function Documentation

callSpecialQuestionCommands()

assFormulaQuestionGUI::callSpecialQuestionCommands ( string  $cmd )

protected

Definition at line 54 of file class.assFormulaQuestionGUI.php.

References assQuestionGUI\addSaveOnEnterOnLoadCode(), and suggestRange().

                                                               : void
    {
        if (preg_match('/suggestrange_(\$r\d+)/', $cmd, $matches)) {
            $this->addSaveOnEnterOnLoadCode();
            $this->suggestRange($matches[1]);
        }
    }

Here is the call graph for this function:

canUseAdvancedRating()

assFormulaQuestionGUI::canUseAdvancedRating (   $result )

private

Check if advanced rating can be used for a result.

This is only possible if there is exactly one possible correct unit for the result, otherwise it is impossible to determine wheather the unit is correct or the value.

Returns

boolean True if advanced rating could be used, false otherwise

Definition at line 721 of file class.assFormulaQuestionGUI.php.

Referenced by isSaveCommand().

                                                  : bool
    {
        $resultunit = $result->getUnit();

        /*
         *  if there is a result-unit (unit selectbox) selected it is possible to use advanced rating
         *      if there is no result-unit selected it is NOT possible to use advanced rating, because there is no
         *      definition if the result-value or the unit-value should be the correct solution!!
         *
         */
        if (is_object($resultunit)) {
            return true;
        } else {
            return false;
        }
    }

Here is the caller graph for this function:

checkInput()

assFormulaQuestionGUI::checkInput

(

)

check input fields

Definition at line 748 of file class.assFormulaQuestionGUI.php.

References assQuestionGUI\addErrorMessage(), and ILIAS\Repository\lng().

                                : bool
    {
        if ((!$_POST["title"]) or (!$_POST["author"]) or (!$_POST["question"])) {
            $this->addErrorMessage($this->lng->txt("fill_out_all_required_fields"));
            return false;
        }


        return true;
    }

Here is the call graph for this function:

getPreview()

assFormulaQuestionGUI::getPreview	(		$show_question_only = false,
			$showInlineFeedback = false
	)

Definition at line 890 of file class.assFormulaQuestionGUI.php.

References assQuestionGUI\getILIASPage(), assQuestionGUI\getPreviewSession(), assFormulaQuestionResult\getResultTypeByQstId(), ILIAS\Repository\object(), and ilLegacyFormElementsUtil\prepareTextareaOutput().

                                                                                        : string
    {
        $user_solution = [];

        if (is_object($this->getPreviewSession())) {
            $solutions = (array) $this->getPreviewSession()->getParticipantsSolution();

            foreach ($solutions as $val1 => $val2) {
                if (preg_match("/^(\\\$v\\d+)$/", $val1, $matches)) {
                    $user_solution[$matches[1]] = $val2;
                } elseif (preg_match("/^(\\\$r\\d+)$/", $val1, $matches)) {
                    if (!array_key_exists($matches[1], $user_solution)) {
                        $user_solution[$matches[1]] = [];
                    }
                    $user_solution[$matches[1]]["value"] = $val2;
                } elseif (preg_match("/^(\\\$r\\d+)_unit$/", $val1, $matches)) {
                    if (!array_key_exists($matches[1], $user_solution)) {
                        $user_solution[$matches[1]] = [];
                    }
                    $user_solution[$matches[1]]["unit"] = $val2;
                }

                if (preg_match("/^(\\\$r\\d+)/", $val1, $matches) && !isset($user_solution[$matches[1]]["result_type"])) {
                    $user_solution[$matches[1]]["result_type"] = assFormulaQuestionResult::getResultTypeByQstId($this->object->getId(), $val1);
                }
            }
        }

        if (!$this->object->hasRequiredVariableSolutionValues($user_solution)) {
            $user_solution = $this->object->getInitialVariableSolutionValues();

            if (is_object($this->getPreviewSession())) {
                $this->getPreviewSession()->setParticipantsSolution($user_solution);
            }
        }

        $template = new ilTemplate("tpl.il_as_qpl_formulaquestion_output.html", true, true, 'Modules/TestQuestionPool');
        if (is_object($this->getPreviewSession())) {
            $questiontext = $this->object->substituteVariables($user_solution);
        } else {
            $questiontext = $this->object->substituteVariables([]);
        }
        $template->setVariable("QUESTIONTEXT", ilLegacyFormElementsUtil::prepareTextareaOutput($questiontext, true));
        $questionoutput = $template->get();
        if (!$show_question_only) {
            // get page object output
            $questionoutput = $this->getILIASPage($questionoutput);
        }
        return $questionoutput;
    }

Here is the call graph for this function:

getSolutionOutput()

assFormulaQuestionGUI::getSolutionOutput	(		$active_id,
			$pass = null,
			$graphicalOutput = false,
			$result_output = false,
			$show_question_only = true,
			$show_feedback = false,
			$show_correct_solution = false,
			$show_manual_scoring = false,
			$show_question_text = true
	)

Get the question solution output.

Parameters

integer	$active_id	The active user id
integer	$pass	The test pass
boolean	$graphicalOutput	Show visual feedback for right/wrong answers
boolean	$result_output	Show the reached points for parts of the question
boolean	$show_question_only	Show the question without the ILIAS content around
boolean	$show_feedback	Show the question feedback
boolean	$show_correct_solution	Show the correct solution instead of the user solution
boolean	$show_manual_scoring	Show specific information for the manual scoring output

Returns

string The solution output of the question as HTML code

Definition at line 771 of file class.assFormulaQuestionGUI.php.

References Vendor\Package\$c, assQuestionGUI\getPreviewSession(), assFormulaQuestionVariable\getVariable(), ILIAS\Repository\object(), and renderSolutionOutput().

     : string {

        $user_solution = [];
        if ($pass !== null) {
            $user_solution = $this->object->getVariableSolutionValuesForPass($active_id, $pass);
        } else {
            $user_solution = array_reduce(
                $this->object->fetchAllVariables($this->object->getQuestion()),
                static function (array $c, assFormulaQuestionVariable $v): array {
                    $c[$v->getVariable()] = $v->getVariable();
                    return $c;
                },
                []
            );
        }

        if (($active_id > 0) && (!$show_correct_solution)) {
            $user_solution["active_id"] = $active_id;
            $user_solution["pass"] = $pass;
            $solutions = $this->object->getSolutionValues($active_id, $pass);
            foreach ($solutions as $idx => $solution_value) {
                if (preg_match("/^(\\\$v\\d+)$/", $solution_value["value1"], $matches)) {
                    $user_solution[$matches[1]] = $solution_value["value2"];
                } elseif (preg_match("/^(\\\$r\\d+)$/", $solution_value["value1"], $matches)) {
                    if (!array_key_exists($matches[1], $user_solution)) {
                        $user_solution[$matches[1]] = array();
                    }
                    $user_solution[$matches[1]]["value"] = $solution_value["value2"];
                } elseif (preg_match("/^(\\\$r\\d+)_unit$/", $solution_value["value1"], $matches)) {
                    if (!array_key_exists($matches[1], $user_solution)) {
                        $user_solution[$matches[1]] = array();
                    }
                    $user_solution[$matches[1]]["unit"] = $solution_value["value2"];
                }
            }
        } elseif ($active_id) {
            $user_solution = $this->object->getBestSolution($this->object->getSolutionValues($active_id, $pass));
        } elseif (is_object($this->getPreviewSession())) {
            $solution_values = [];

            $participantsSolution = $this->getPreviewSession()->getParticipantsSolution();
            if (is_array($participantsSolution)) {
                foreach ($participantsSolution as $val1 => $val2) {
                    $solution_values[] = array('value1' => $val1, 'value2' => $val2);
                }
            }

            $user_solution = $this->object->getBestSolution($solution_values);
        }

        return $this->renderSolutionOutput(
            $user_solution,
            $active_id,
            $pass,
            $graphicalOutput,
            $result_output,
            $show_question_only,
            $show_feedback,
            $show_correct_solution,
            $show_manual_scoring,
            $show_question_text,
            false,
            false
        );
    }

Here is the call graph for this function:

getSpecificFeedbackOutput()

assFormulaQuestionGUI::getSpecificFeedbackOutput

(

array

$userSolution

)

Definition at line 1002 of file class.assFormulaQuestionGUI.php.

                                                                  : string
    {
        return '';
    }

getTestOutput()

assFormulaQuestionGUI::getTestOutput	(		$active_id,
			$pass,
			$is_postponed = false,
			$use_post_solutions = false,
			$show_feedback = false
	)

Definition at line 942 of file class.assFormulaQuestionGUI.php.

References ilObjTest\_getPass(), assFormulaQuestionResult\getResultTypeByQstId(), ILIAS\Repository\lng(), ILIAS\Repository\object(), assQuestionGUI\outQuestionPage(), and ilLegacyFormElementsUtil\prepareTextareaOutput().

                                                                                                                                : string
    // hey.
    {
        $this->tpl->setOnScreenMessage('info', $this->lng->txt('enter_valid_values'));
        // get the solution of the user for the active pass or from the last pass if allowed
        $user_solution = [];
        if ($active_id) {
            $solutions = $this->object->getTestOutputSolutions($active_id, $pass);
            $actualPassIndex = null;
            if ($this->object->getTestPresentationConfig()->isSolutionInitiallyPrefilled()) {
                $actualPassIndex = ilObjTest::_getPass($active_id);
            }

            foreach ($solutions as $idx => $solution_value) {
                if (preg_match("/^(\\\$v\\d+)$/", $solution_value['value1'], $matches)) {
                    if ($this->object->getTestPresentationConfig()->isSolutionInitiallyPrefilled()) {
                        $this->object->saveCurrentSolution($active_id, $actualPassIndex, $matches[1], $solution_value['value2'], true);
                    }

                    $user_solution[$matches[1]] = $solution_value['value2'];
                } elseif (preg_match("/^(\\\$r\\d+)$/", $solution_value['value1'], $matches)) {
                    if (!array_key_exists($matches[1], $user_solution)) {
                        $user_solution[$matches[1]] = [];
                    }
                    $user_solution[$matches[1]]["value"] = $solution_value['value2'];
                } elseif (preg_match("/^(\\\$r\\d+)_unit$/", $solution_value['value1'], $matches)) {
                    if (!array_key_exists($matches[1], $user_solution)) {
                        $user_solution[$matches[1]] = [];
                    }
                    $user_solution[$matches[1]]["unit"] = $solution_value['value2'];
                }
                if (preg_match("/^(\\\$r\\d+)/", $solution_value['value1'], $matches) && !isset($user_solution[$matches[1]]["result_type"])) {
                    $user_solution[$matches[1]]["result_type"] = assFormulaQuestionResult::getResultTypeByQstId($this->object->getId(), $solution_value['value1']);
                }
            }
        }

        $solutions = $this->object->getSolutionValues($active_id, $pass, true);
        foreach ($solutions as $idx => $solution_value) {
            if (preg_match("/^(\\\$v\\d+)$/", $solution_value['value1'], $matches)) {
                $user_solution[$matches[1]] = $solution_value['value2'];
            }
        }

        if ($user_solution === []) {
            $user_solution = $this->object->getVariableSolutionValuesForPass($active_id, $pass);
        }

        // generate the question output
        $template = new ilTemplate("tpl.il_as_qpl_formulaquestion_output.html", true, true, 'Modules/TestQuestionPool');

        $questiontext = $this->object->substituteVariables($user_solution);

        $template->setVariable("QUESTIONTEXT", ilLegacyFormElementsUtil::prepareTextareaOutput($questiontext, true));

        $questionoutput = $template->get();
        $pageoutput = $this->outQuestionPage("", $is_postponed, $active_id, $questionoutput);
        return $pageoutput;
    }

Here is the call graph for this function:

hasResultUnit()

assFormulaQuestionGUI::hasResultUnit (   $result,   $unit_id,   $resultunits  )

private

Definition at line 704 of file class.assFormulaQuestionGUI.php.

Referenced by isSaveCommand().

                                                                   : bool
    {
        if (array_key_exists($result->getResult(), $resultunits)) {
            if (array_key_exists($unit_id, $resultunits[$result->getResult()])) {
                return true;
            }
        }
        return false;
    }

Here is the caller graph for this function:

isSaveCommand()

assFormulaQuestionGUI::isSaveCommand

(

)

Definition at line 194 of file class.assFormulaQuestionGUI.php.

References $check, ILIAS\LTI\ToolProvider\$key, assQuestionGUI\$object, $results, $txt, assQuestionGUI\addBasicQuestionFormProperties(), canUseAdvancedRating(), ILIAS\Repository\ctrl(), assQuestionGUI\getQuestionTemplate(), assFormulaQuestionResult\getResult(), assFormulaQuestionVariable\getVariable(), hasResultUnit(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\object(), assQuestionGUI\outQuestionType(), assQuestionGUI\populateTaxonomyFormSection(), ilRadioOption\setInfo(), ilSelectInputGUI\setOptions(), ilMultiSelectInputGUI\setOptions(), and ilFormPropertyGUI\setRequired().

Referenced by writePostData().

                                   : bool
    {
        return in_array($this->ctrl->getCmd(), array('save', 'saveEdit', 'saveReturn'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseQuestion()

assFormulaQuestionGUI::parseQuestion

(

)

Definition at line 738 of file class.assFormulaQuestionGUI.php.

References assQuestionGUI\addSaveOnEnterOnLoadCode(), and writePostData().

                                   : void
    {
        $this->writePostData();
        $this->addSaveOnEnterOnLoadCode();
        $this->editQuestion();
    }

Here is the call graph for this function:

renderSolutionOutput()

assFormulaQuestionGUI::renderSolutionOutput	(	mixed	$user_solutions,
		int	$active_id,
		?int	$pass,
		bool	$graphical_output = false,
		bool	$result_output = false,
		bool	$show_question_only = true,
		bool	$show_feedback = false,
		bool	$show_correct_solution = false,
		bool	$show_manual_scoring = false,
		bool	$show_question_text = true,
		bool	$show_autosave_title = false,
		bool	$show_inline_feedback = false
	)

Definition at line 847 of file class.assFormulaQuestionGUI.php.

References ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_CORRECT, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_WRONG, assQuestionGUI\generateCorrectnessIconsForCorrectness(), assQuestionGUI\getGenericFeedbackOutput(), assQuestionGUI\getILIASPage(), assQuestionGUI\hasCorrectSolution(), and ilLegacyFormElementsUtil\prepareTextareaOutput().

Referenced by getSolutionOutput().

     : ?string {
        $template = new ilTemplate("tpl.il_as_qpl_formulaquestion_output_solution.html", true, true, 'Modules/TestQuestionPool');
        $correctness_icons = [
            'correct' => $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_OK),
            'not_correct' => $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_NOT_OK)
        ];
        $questiontext = $this->object->substituteVariables($user_solutions, $graphical_output, true, $result_output, $correctness_icons);
        $template->setVariable("QUESTIONTEXT", ilLegacyFormElementsUtil::prepareTextareaOutput($questiontext, true));
        $questionoutput = $template->get();
        $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", true, true, "Modules/TestQuestionPool");
        $feedback = ($show_feedback) ? $this->getGenericFeedbackOutput((int) $active_id, $pass) : "";
        if (strlen($feedback)) {
            $cssClass = (
                $this->hasCorrectSolution($active_id, $pass) ?
                ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_CORRECT : ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_WRONG
            );

            $solutiontemplate->setVariable("ILC_FB_CSS_CLASS", $cssClass);
            $solutiontemplate->setVariable("FEEDBACK", ilLegacyFormElementsUtil::prepareTextareaOutput($feedback, true));
        }
        $solutiontemplate->setVariable("SOLUTION_OUTPUT", $questionoutput);

        $solutionoutput = $solutiontemplate->get();
        if (!$show_question_only) {
            // get page object output
            $solutionoutput = $this->getILIASPage($solutionoutput);
        }
        return $solutionoutput;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetSavedPreviewSession()

assFormulaQuestionGUI::resetSavedPreviewSession

(

)

Definition at line 184 of file class.assFormulaQuestionGUI.php.

References $DIC, assQuestionGUI\$ilUser, and ilObject\getId().

Referenced by writePostData().

                                              : void
    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        $user_id = $ilUser->getId();
        $question_id = $this->object->getId();
        $ilAssQuestionPreviewSession = new ilAssQuestionPreviewSession($user_id, $question_id);
        $ilAssQuestionPreviewSession->setParticipantsSolution([]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setQuestionSpecificTabs()

assFormulaQuestionGUI::setQuestionSpecificTabs ( ilTabsGUI  $ilTabs )

protected

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

References ilTabsGUI\addTarget(), and ILIAS\Repository\ctrl().

                                                                 : void
    {
        $ilTabs->addTarget('units', $this->ctrl->getLinkTargetByClass('ilLocalUnitConfigurationGUI', ''), '', 'illocalunitconfigurationgui');
    }

Here is the call graph for this function:

suggestRange()

assFormulaQuestionGUI::suggestRange

(

string

$suggest_range_for_result

)

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

References assQuestionGUI\getErrorMessage(), and writePostData().

Referenced by callSpecialQuestionCommands().

                                                                  : void
    {
        if ($this->writePostData()) {
            $this->tpl->setOnScreenMessage('info', $this->getErrorMessage());
        }
        $this->editQuestion(false, $suggest_range_for_result);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

writePostData()

assFormulaQuestionGUI::writePostData ( bool  $always = false )

protected

{}

Definition at line 73 of file class.assFormulaQuestionGUI.php.

References Vendor\Package\$e, ILIAS\LTI\ToolProvider\$key, $lifecycle, assQuestionGUI\addErrorMessage(), ilAssQuestionLifecycle\getInstance(), ILIAS\Repository\int(), isSaveCommand(), ILIAS\Repository\lng(), ILIAS\Repository\object(), resetSavedPreviewSession(), and assQuestionGUI\saveTaxonomyAssignments().

Referenced by parseQuestion(), and suggestRange().

                                                          : int
    {
        $hasErrors = (!$always) ? $this->editQuestion(true) : false;
        $checked = true;
        if (!$hasErrors) {
            $this->object->setTitle($this->request->string('title'));
            $this->object->setAuthor($this->request->string('author'));
            $this->object->setComment($this->request->string('comment'));
            $this->object->setQuestion($this->request->string('question'));

            $this->object->parseQuestionText();
            $found_vars = [];
            $found_results = [];

            foreach ($this->request->getParsedBody() as $key => $value) {
                if (preg_match("/^unit_(\\\$v\d+)$/", $key, $matches)) {
                    array_push($found_vars, $matches[1]);
                }
                if (preg_match("/^unit_(\\\$r\d+)$/", $key, $matches)) {
                    array_push($found_results, $matches[1]);
                }
            }

            try {
                $lifecycle = ilAssQuestionLifecycle::getInstance($_POST['lifecycle']);
                $this->object->setLifecycle($lifecycle);
            } catch (ilTestQuestionPoolInvalidArgumentException $e) {
            }

            if (!$this->object->checkForDuplicateResults()) {
                $this->addErrorMessage($this->lng->txt("err_duplicate_results"));
                $checked = false;
            }

            foreach ($found_vars as $variable) {
                if ($this->object->getVariable($variable) != null) {
                    $varObj = new assFormulaQuestionVariable(
                        $variable,
                        str_replace(',', '.', $_POST["range_min_{$variable}"]),
                        str_replace(',', '.', $_POST["range_max_{$variable}"]),
                        isset($_POST["unit_{$variable}"]) ? $this->object->getUnitrepository()->getUnit(
                            $_POST["unit_{$variable}"]
                        ) : null,
                        (int) $this->request->float("precision_{$variable}"),
                        (int) $this->request->float("intprecision_{$variable}")
                    );
                    $this->object->addVariable($varObj);
                }
            }

            $tmp_form_vars = [];
            $tmp_quest_vars = [];
            foreach ($found_results as $result) {
                $tmp_res_match = preg_match_all('/([$][v][0-9]*)/', $_POST["formula_{$result}"], $form_vars);
                $tmp_form_vars = array_merge($tmp_form_vars, $form_vars[0]);

                $tmp_que_match = preg_match_all('/([$][v][0-9]*)/', $_POST['question'], $quest_vars);
                $tmp_quest_vars = array_merge($tmp_quest_vars, $quest_vars[0]);
            }
            $result_has_undefined_vars = array_diff($tmp_form_vars, $found_vars);
            $question_has_unused_vars = array_diff($tmp_quest_vars, $tmp_form_vars);

            if (count($result_has_undefined_vars) > 0 || count($question_has_unused_vars) > 0) {
                $error_message = '';
                if (count($result_has_undefined_vars) > 0) {
                    $error_message .= $this->lng->txt("res_contains_undef_var") . '<br>';
                }
                if (count($question_has_unused_vars) > 0) {
                    $error_message .= $this->lng->txt("que_contains_unused_var");
                }
                $checked = false;
                if ($this->isSaveCommand()) {
                    $this->tpl->setOnScreenMessage('failure', $error_message);
                }
            }
            foreach ($found_results as $result) {
                if ($this->object->getResult($result) != null) {
                    $resObj = new assFormulaQuestionResult(
                        $result,
                        str_replace(',', '.', $_POST["range_min_{$result}"]),
                        str_replace(',', '.', $_POST["range_max_{$result}"]),
                        $this->request->float("tolerance_{$result}"),
                        isset($_POST["unit_{$result}"]) ? $this->object->getUnitrepository()->getUnit(
                            $_POST["unit_{$result}"]
                        ) : null,
                        $this->request->string("formula_{$result}"),
                        $this->request->float("points_{$result}"),
                        (int) $this->request->float("precision_{$result}"),
                        $this->request->int("rating_advanced_{$result}") !== 1,
                        $this->request->int("rating_advanced_{$result}") === 1 ? $this->request->float("rating_sign_{$result}") : null,
                        $this->request->int("rating_advanced_{$result}") === 1 ? $this->request->float("rating_value_{$result}") : null,
                        $this->request->int("rating_advanced_{$result}") === 1 ? $this->request->float("rating_unit_{$result}") : null,
                        $this->request->int("result_type_{$result}")
                    );
                    $this->object->addResult($resObj);
                    $this->object->addResultUnits($resObj, $_POST["units_{$result}"] ?? []);
                }
            }
            if ($checked == false) {
                $this->editQuestion();
                return 1;
            } else {
                $this->saveTaxonomyAssignments();
                $this->resetSavedPreviewSession();
                return 0;
            }
        } else {
            return 1;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

HAS_SPECIAL_QUESTION_COMMANDS

const assFormulaQuestionGUI::HAS_SPECIAL_QUESTION_COMMANDS = true

protected

Definition at line 32 of file class.assFormulaQuestionGUI.php.

---

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

• Modules/TestQuestionPool/classes/class.assFormulaQuestionGUI.php