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 ()
	parseQuestion ()
	checkInput ()
	check input fields More...
	getSolutionOutput (int $active_id, ?int $pass=null, 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_inline_feedback=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,)
	getPreview (bool $show_question_only=false, bool $show_inline_feedback=false)
	getTestOutput (int $active_id, int $pass, bool $is_question_postponed=false, array|bool $user_post_solutions=false, bool $show_specific_inline_feedback=false)
	getSpecificFeedbackOutput (array $userSolution)
	Returns the answer specific feedback for the question. More...
Public Member Functions inherited from assQuestionGUI
	editQuestion (bool $checkonly=false, ?bool $is_save_cmd=null)
	getSpecificFeedbackOutput (array $userSolution)
	Returns the answer specific feedback for the question. More...
	getSolutionOutput (int $active_id, ?int $pass=null, 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_inline_feedback=true)
	getPreview (bool $show_question_only=false, bool $show_inline_feedback=false)
	getTestOutput (int $active_id, int $pass, bool $is_question_postponed=false, array|bool $user_post_solutions=false, bool $show_specific_inline_feedback=false)
	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,)
	getObject ()
	setObject (assQuestion $question)
	setCopyToExistingPoolOnSave (?int $pool_ref_id)
	getCopyToExistingPoolOnSave ()
	setCopyToNewPoolOnSave (?string $pool_title)
	getCopyToNewPoolOnSave ()
	setMoveAfterQuestionId (?int $question_id)
	getMoveAfterQuestionId ()
	hasInlineFeedback ()
	addHeaderAction ()
	redrawHeaderAction ()
	getHeaderAction ()
	getCommentsPanelHTML ()
	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 (string $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)
	syncQuestion ()
	saveReturn ()
	saveQuestion ()
	setAdditionalContentEditingModeFromPost ()
	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)
	getQuestionType ()
	getAsValueAttribute (string $a_value)
	addQuestionFormCommandButtons (ilPropertyFormGUI $form)
	addBasicQuestionFormProperties (ilPropertyFormGUI $form)
	getGenericFeedbackOutput (int $active_id, ?int $pass)
	getGenericFeedbackOutputForCorrectSolution ()
	getGenericFeedbackOutputForIncorrectSolution ()
	outQuestionType ()
	saveSuggestedSolution ()
	cancelSuggestedSolution ()
	suggestedsolution (bool $save=false)
	outSolutionExplorer ()
	saveSuggestedSolutionType ()
	cancelExplorer ()
	outPageSelector ()
	outChapterSelector ()
	outGlossarySelector ()
	linkChilds ()
	addPG ()
	addST ()
	addGIT ()
	isSaveCommand ()
	setQuestionTabs ()
	addTab_SuggestedSolution (ilTabsGUI $tabs, string $classname)
	getEditQuestionTabCommands ()
	isAutosaveable ()
	outQuestionForTest (string $formaction, int $active_id, ?int $pass, bool $is_question_postponed=false, array|bool $user_post_solutions=false, bool $show_specific_inline_feedback=false)
	magicAfterTestOutput ()
	getFormEncodingType ()
	setPreviewSession (ilAssQuestionPreviewSession $preview_session)
	getPreviewSession ()
	buildFocusAnchorHtml ()
	isAnswerFrequencyStatisticSupported ()
	getSubQuestionsIndex ()
	getAnswersFrequency ($relevantAnswers, $questionIndex)
	getAnswerFrequencyTableGUI ($parentGui, $parentCmd, $relevantAnswers, $questionIndex)
	prepareReprintableCorrectionsForm (ilPropertyFormGUI $form)
	populateCorrectionsFormProperties (ilPropertyFormGUI $form)
	saveCorrectionsFormProperties (ilPropertyFormGUI $form)
	isInLearningModuleContext ()
	setInLearningModuleContext (bool $flag)
	cmdNeedsExistingQuestion (string $cmd)
	setContextAllowsSyncToPool (bool $sync_allowed)
	needsSyncQuery ()
	getQuestionSyncModal (string $cmd, string $cmd_class='')
	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)
	buildFileDownloadLink ()
	supportsAdjustment ()

Protected Member Functions
	setQuestionSpecificTabs (ilTabsGUI $ilTabs)
	writePostData (bool $always=false)
	{Evaluates a posted edit form and writes the form data in the question object. Returns integer A positive value, if one of the required fields wasn't set, else 0 } 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 ()
	setTestSpecificProperties ()
	addNumberOfTriesToFormIfNecessary (ilPropertyFormGUI $form)
	saveTaxonomyAssignments ()
	populateTaxonomyFormSection (ilPropertyFormGUI $form)
	genericFeedbackOutputBuilder (int $active_id, ?int $pass)
	getTypeOptions ()
	createSuggestedSolutionLinkingTo (string $type, string $target)
	setDefaultTabs (ilTabsGUI $tabs_gui)
	setQuestionSpecificTabs (ilTabsGUI $tabs_gui)
	getBasicEditQuestionTabCommands ()
	getAdditionalEditQuestionCommands ()
	addTab_QuestionFeedback (ilTabsGUI $tabs)
	addTab_Question (ilTabsGUI $tabs_gui)
	hasCorrectSolution ($activeId, $passIndex)
	writeQuestionGenericPostData ()
	completeTestOutputFormAction (string $form_action, int $active_id, int $pass)
	addBackTab (ilTabsGUI $tabs_gui)
	buildBasicEditFormObject ()
	escapeTemplatePlaceholders (string $text)
	buildEditForm ()
	generateCorrectnessIconsForCorrectness (int $correctness)
	renderLatex ($content)
	Wrap content with latex in a LatexContent UI component and render it to be processed by MathJax in the browser. More...
	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 ()
	resetSavedPreviewSession ()

Protected Attributes
const	HAS_SPECIAL_QUESTION_COMMANDS = true
Protected Attributes inherited from assQuestionGUI
const	HAS_SPECIAL_QUESTION_COMMANDS = false
const	SUGGESTED_SOLUTION_COMMANDS_CANCEL = 'cancelSuggestedSolution'
const	SUGGESTED_SOLUTION_COMMANDS_SAVE = 'saveSuggestedSolution'
const	SUGGESTED_SOLUTION_COMMANDS_DEFAULT = 'suggestedsolution'
const	QUESTION_SAVE_CMDS
const	ADDITIONAL_CMDS_NEEDING_EXISTING_QST
	There are functions that need an existing question. More...
UIServices	$ui
ilLogger	$logger
GeneralQuestionPropertiesRepository	$questionrepository
GUIService	$notes_gui
ilCtrl	$ctrl
assQuestion	$object
ilGlobalPageTemplate	$tpl
ilLanguage	$lng
Refinery	$refinery
	$error
string	$errormessage
int	$sequence_no
	sequence number in test More...
int	$question_count
	question count in test More...
ilPropertyFormGUI	$editForm = null
readonly ilTestLegacyFormsHelper	$forms_helper
readonly RequestDataCollector	$request_data_collector
bool	$parent_type_is_lm = false
SuggestedSolutionsDatabaseRepository	$suggestedsolution_repo = null

Private Member Functions
	getSuggestRangeOnLoadCode (string $result)
	hasResultUnit ($result, $unit_id, $resultunits)
	canUseAdvancedRating ($result)
	Check if advanced rating can be used for a result. More...
	populateVariablesInUserSolution (int $active_id, ?int $pass, array $user_solution)

Private Attributes
UIFactory	$ui_factory
UIRenderer	$ui_renderer

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	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	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'
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	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'
const	PRESENTATION_CONTEXT_TEST = 'pContextTest'
const	PRESENTATION_CONTEXT_RESULTS = 'pContextResults'
const	CMD_SYNC_QUESTION_AND_RETURN = 'syncQuestionReturn'

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

\ @ilCtrl_Calls assFormulaQuestionGUI: ilFormPropertyDispatchGUI

Definition at line 31 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 @access public

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

    {
        parent::__construct();
        global $DIC;
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
 
        $this->object = new assFormulaQuestion();
        if ($id >= 0) {
            $this->object->loadFromDb($id);
        }
    }

References $DIC, $id, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

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 738 of file class.assFormulaQuestionGUI.php.

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

checkInput()

assFormulaQuestionGUI::checkInput

(

)

check input fields

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

                                : bool
    {
        $title = $this->request_data_collector->string('title');
        $author = $this->request_data_collector->string('author');
        $question = $this->request_data_collector->string('question');
 
        if (empty($title) || empty($author) || empty($question)) {
            $this->addErrorMessage($this->lng->txt('fill_out_all_required_fields'));
            return false;
        }
 
        return true;
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getPreview()

assFormulaQuestionGUI::getPreview	(	bool	$show_question_only = false,
		bool	$show_inline_feedback = false
	)

Reimplemented from assQuestionGUI.

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

     : string {
        $user_solution = [];
        if (is_object($this->getPreviewSession())) {
            $solutions = $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, 'components/ILIAS/TestQuestionPool');
        if (is_object($this->getPreviewSession())) {
            $questiontext = $this->object->substituteVariables($user_solution);
        } else {
            $questiontext = $this->object->substituteVariables([]);
        }
        $template->setVariable("QUESTIONTEXT", $this->renderLatex(
            ilLegacyFormElementsUtil::prepareTextareaOutput($questiontext, true)
        ));
        $questionoutput = $template->get();
        if (!$show_question_only) {
            // get page object output
            $questionoutput = $this->getILIASPage($questionoutput);
        }
        return $questionoutput;
    }

References assFormulaQuestionResult\getResultTypeByQstId(), and ILIAS\Repository\object().

Here is the call graph for this function:

getSolutionOutput()

assFormulaQuestionGUI::getSolutionOutput	(	int	$active_id,
		?int	$pass = null,
		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_inline_feedback = true
	)

Reimplemented from assQuestionGUI.

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

     : string {
        if ($active_id > 0 && !$show_correct_solution) {
            $user_solution = $this->object->buildBasicUserSolutionsArray(
                $active_id,
                $pass
            );
 
            $user_solution = array_merge(
                $user_solution,
                $this->populateVariablesInUserSolution(
                    $active_id,
                    $pass,
                    $user_solution
                )
            );
        } elseif ($active_id !== 0) {
            $user_solution = $this->object->getBestSolution($this->object->getSolutionValues($active_id, $pass));
        } elseif (is_object($this->getPreviewSession())) {
            $solution_values = [];
            $participants_solution = $this->getPreviewSession()->getParticipantsSolution();
            if (is_array($participants_solution)) {
                foreach ($participants_solution as $val1 => $val2) {
                    $solution_values[] = ['value1' => $val1, 'value2' => $val2];
                }
            }
            $user_solution = $this->object->getBestSolution($solution_values);
        } else {
            $user_solution = $this->populateVariablesInUserSolution(
                $active_id,
                $pass,
                []
            );
        }
 
        return $this->renderSolutionOutput(
            $user_solution,
            $active_id,
            $pass,
            $graphical_output,
            $result_output,
            $show_question_only,
            $show_feedback,
            $show_correct_solution,
            $show_manual_scoring,
            $show_question_text,
            false,
            $show_inline_feedback
        );
    }

getSpecificFeedbackOutput()

assFormulaQuestionGUI::getSpecificFeedbackOutput

(

array

$userSolution

)

Returns the answer specific feedback for the question.

Parameters

array

$userSolution

($userSolution[<value1>] = <value2>)

Reimplemented from assQuestionGUI.

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

                                                                  : string
    {
        return '';
    }

getSuggestRangeOnLoadCode()

assFormulaQuestionGUI::getSuggestRangeOnLoadCode ( string  $result )

private

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

                                                              : Closure
    {
        return static function ($id) use ($result): string {
            return "document.getElementById('$id').addEventListener('click', "
                . '(e) => {'
                . '  e.target.setAttribute("name", "cmd[suggestRange]");'
                . '  let input = document.createElement("input");'
                . '  input.type = "hidden";'
                . '  input.name = "suggest_range_for";'
                . "  input.value = '$result';"
                . '  e.target.form.appendChild(input);'
                . '  e.target.form.requestSubmit(e.target);'
                . '});';
        };
    }

References $id.

getTestOutput()

assFormulaQuestionGUI::getTestOutput	(	int	$active_id,
		int	$pass,
		bool	$is_question_postponed = false,
		array|bool	$user_post_solutions = false,
		bool	$show_specific_inline_feedback = false
	)

Reimplemented from assQuestionGUI.

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

     : string {
        $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']);
                }
            }
        }
 
        // fau: testNav - take question variables always from authorized solution because they are saved with this flag, even if an authorized solution is not saved
        $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->resolveVariableSolutionValuesForPass($active_id, $pass);
        }
 
        // generate the question output
        $template = new ilTemplate("tpl.il_as_qpl_formulaquestion_output.html", true, true, 'components/ILIAS/TestQuestionPool');
 
        $questiontext = $this->object->substituteVariables($user_solution);
 
        $template->setVariable("QUESTIONTEXT", $this->renderLatex(
            ilLegacyFormElementsUtil::prepareTextareaOutput($questiontext, true)
        ));
 
        $questionoutput = $template->get();
        $pageoutput = $this->outQuestionPage("", $is_question_postponed, $active_id, $questionoutput);
        return $pageoutput;
    }

References ilObjTest\_getPass(), assFormulaQuestionResult\getResultTypeByQstId(), and ILIAS\Repository\object().

Here is the call graph for this function:

hasResultUnit()

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

private

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

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

parseQuestion()

assFormulaQuestionGUI::parseQuestion

(

)

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

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

populateVariablesInUserSolution()

assFormulaQuestionGUI::populateVariablesInUserSolution ( int  $active_id, ?int  $pass, array  $user_solution  )

private

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

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

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
	)

Reimplemented from assQuestionGUI.

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

     : ?string {
        $template = new ilTemplate("tpl.il_as_qpl_formulaquestion_output_solution.html", true, true, 'components/ILIAS/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", $this->renderLatex(
            ilLegacyFormElementsUtil::prepareTextareaOutput($questiontext, true)
        ));
        $questionoutput = $template->get();
        $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", true, true, "components/ILIAS/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", $this->renderLatex(
                ilLegacyFormElementsUtil::prepareTextareaOutput($feedback, true)
            ));
        }
        $solutiontemplate->setVariable("SOLUTION_OUTPUT", $questionoutput);
 
        $solutionoutput = $solutiontemplate->get();
        if (!$show_question_only) {
            $solutionoutput = $this->getILIASPage($solutionoutput);
        }
        return $solutionoutput;
    }

setQuestionSpecificTabs()

assFormulaQuestionGUI::setQuestionSpecificTabs ( ilTabsGUI  $ilTabs )

protected

Reimplemented from assQuestionGUI.

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

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

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

Here is the call graph for this function:

suggestRange()

assFormulaQuestionGUI::suggestRange

(

)

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

                                  : void
    {
        $this->setAdditionalContentEditingModeFromPost();
        $suggest_range_for_result = $this->request_data_collector->string('suggest_range_for');
        if ($this->writePostData()) {
            $this->tpl->setOnScreenMessage('info', $this->getErrorMessage());
        }
        $this->setTestSpecificProperties();
        $this->editQuestion(false, null, $suggest_range_for_result);
    }

References assQuestionGUI\editQuestion(), assQuestionGUI\getErrorMessage(), assQuestionGUI\setAdditionalContentEditingModeFromPost(), assQuestionGUI\setTestSpecificProperties(), and writePostData().

Here is the call graph for this function:

writePostData()

assFormulaQuestionGUI::writePostData ( bool  $always = false )

protected

{Evaluates a posted edit form and writes the form data in the question object.

Returns

integer A positive value, if one of the required fields wasn't set, else 0

}

Reimplemented from assQuestionGUI.

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

                                                          : int
    {
        $hasErrors = (!$always) ? $this->editQuestion(true) : false;
        $checked = true;
        if (!$hasErrors) {
            $this->object->setTitle($this->request_data_collector->string('title'));
            $this->object->setAuthor($this->request_data_collector->string('author'));
            $this->object->setComment($this->request_data_collector->string('comment'));
            $this->object->setQuestion($this->request_data_collector->string('question'));
 
            $this->object->parseQuestionText();
            $found_vars = [];
            $found_results = [];
 
            foreach ($this->request_data_collector->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 = new ilAssQuestionLifecycle($this->request_data_collector->string('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) {
                    $unit = $this->request_data_collector->int("unit_{$variable}");
                    $varObj = new assFormulaQuestionVariable(
                        $variable,
                        $this->request_data_collector->float("range_min_{$variable}") ?? 0.0,
                        $this->request_data_collector->float("range_max_{$variable}") ?? 0.0,
                        $unit !== null ? $this->object->getUnitrepository()->getUnit(
                            $unit
                        ) : null,
                        $this->request_data_collector->float("precision_{$variable}"),
                        $this->request_data_collector->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]*)/',
                    $this->request_data_collector->string("formula_{$result}"),
                    $form_vars
                );
                $tmp_form_vars = array_merge($tmp_form_vars, $form_vars[0]);
 
                $tmp_que_match = preg_match_all(
                    '/([$][v][0-9]*)/',
                    $this->request_data_collector->string('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 ($result_has_undefined_vars !== [] || $question_has_unused_vars !== []) {
                $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) {
                    $unit = $this->request_data_collector->int("unit_{$result}");
                    $resObj = new assFormulaQuestionResult(
                        $result,
                        $this->request_data_collector->float("range_min_{$result}") ?? 0.0,
                        $this->request_data_collector->float("range_max_{$result}") ?? 0.0,
                        $this->request_data_collector->float("tolerance_{$result}") ?? 0.0,
                        $unit !== null ? $this->object->getUnitrepository()->getUnit(
                            $unit
                        ) : null,
                        $this->request_data_collector->string("formula_{$result}"),
                        $this->request_data_collector->float("points_{$result}"),
                        $this->request_data_collector->float("precision_{$result}"),
                        $this->request_data_collector->int("rating_advanced_{$result}") !== 1,
                        $this->request_data_collector->int("rating_advanced_{$result}") === 1 ? $this->request_data_collector->float("rating_sign_{$result}") : null,
                        $this->request_data_collector->int("rating_advanced_{$result}") === 1 ? $this->request_data_collector->float("rating_value_{$result}") : null,
                        $this->request_data_collector->int("rating_advanced_{$result}") === 1 ? $this->request_data_collector->float("rating_unit_{$result}") : null,
                        $this->request_data_collector->int("result_type_{$result}")
                    );
                    $this->object->addResult($resObj);
                    $available_units = $this->request_data_collector->intArray("units_{$result}");
                    if (!empty($available_units)) {
                        $this->object->addResultUnits($resObj, $available_units);
                    }
                }
            }
            if ($checked === false) {
                $this->editQuestion();
                return 1;
            } else {
                $this->saveTaxonomyAssignments();
                $this->resetSavedPreviewSession();
                return 0;
            }
        } else {
            return 1;
        }
    }

References Vendor\Package\$e, $lifecycle, assQuestionGUI\addErrorMessage(), assQuestionGUI\editQuestion(), assQuestionGUI\isSaveCommand(), ILIAS\Repository\lng(), ILIAS\Repository\object(), assQuestionGUI\resetSavedPreviewSession(), and assQuestionGUI\saveTaxonomyAssignments().

Referenced by suggestRange().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ui_factory

UIFactory assFormulaQuestionGUI::$ui_factory

private

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

$ui_renderer

UIRenderer assFormulaQuestionGUI::$ui_renderer

private

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

HAS_SPECIAL_QUESTION_COMMANDS

const assFormulaQuestionGUI::HAS_SPECIAL_QUESTION_COMMANDS = true

protected

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

---

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

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