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

Collaboration diagram for assTextSubsetGUI:

Public Member Functions
	__construct ($id=-1)
	assTextSubsetGUI constructor More...
	editQuestion (bool $checkonly=false, ?bool $is_save_cmd=null)
	addanswers ()
	removeanswers ()
	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 $user_solution)
	Returns the answer specific feedback for the question. More...
	writeQuestionSpecificPostData (ilPropertyFormGUI $form)
	Extracts the question specific values from the request and applies them to the data object. More...
	writeAnswerSpecificPostData (ilPropertyFormGUI $form)
	Extracts the answer specific values from the request and applies them to the data object. More...
	populateQuestionSpecificFormPart (\ilPropertyFormGUI $form)
	populateAnswerSpecificFormPart (\ilPropertyFormGUI $form)
	getAfterParticipationSuppressionAnswerPostVars ()
	Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment. More...
	getAfterParticipationSuppressionQuestionPostVars ()
	Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment. More...
	getAnswersFrequency ($relevantAnswers, $questionIndex)
	populateCorrectionsFormProperties (ilPropertyFormGUI $form)
	saveCorrectionsFormProperties (ilPropertyFormGUI $form)
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 ()
Public Member Functions inherited from ilGuiQuestionScoringAdjustable
	populateQuestionSpecificFormPart (ilPropertyFormGUI $form)
	Adds the question specific forms parts to a question property form gui. More...
	writeQuestionSpecificPostData (ilPropertyFormGUI $form)
	Extracts the question specific values from the request and applies them to the data object. More...
	getAfterParticipationSuppressionQuestionPostVars ()
	Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment. More...
Public Member Functions inherited from ilGuiAnswerScoringAdjustable
	populateAnswerSpecificFormPart (ilPropertyFormGUI $form)
	Adds the answer specific form parts to a question property form gui. More...
	writeAnswerSpecificPostData (ilPropertyFormGUI $form)
	Extracts the answer specific values from the request and applies them to the data object. More...
	getAfterParticipationSuppressionAnswerPostVars ()
	Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment. More...

Protected Member Functions
	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...
	completeAddAnswerAction ($answers, $questionIndex)
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 ()

Private Attributes
	$answers_from_post

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'
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...
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

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 Multiple choice question GUI representation

The assTextSubsetGUI class encapsulates the GUI representation for multiple 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

Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

\ @ilCtrl_Calls assTextSubsetGUI: ilFormPropertyDispatchGUI

Definition at line 34 of file class.assTextSubsetGUI.php.

Constructor & Destructor Documentation

__construct()

assTextSubsetGUI::__construct

(

$id = -1

)

assTextSubsetGUI constructor

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

Parameters

integer

$id

The database id of a text subset question object

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

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

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

Here is the call graph for this function:

Member Function Documentation

addanswers()

assTextSubsetGUI::addanswers

(

)

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

                                : void
    {
        $this->setAdditionalContentEditingModeFromPost();
        $this->writePostData(true);
        $cmd = $this->request_data_collector->raw('cmd') ?? [];
        $add_answers = in_array('addanswers', $cmd) && is_array($cmd['addanswers']) ? $cmd['addanswers'] : [];
        $this->object->addAnswer('', 0, key($add_answers) + 1);
        $this->editQuestion();
    }

completeAddAnswerAction()

assTextSubsetGUI::completeAddAnswerAction (   $answers,   $questionIndex  )

protected

Definition at line 470 of file class.assTextSubsetGUI.php.

    {
        foreach ($answers as $key => $ans) {
            $found = false;
 
            foreach ($this->object->getAnswers() as $item) {
                if ($ans['answer'] !== $item->getAnswerText()) {
                    continue;
                }
 
                $found = true;
                break;
            }
 
            if (!$found) {
                $answers[$key]['addable'] = true;
            }
        }
 
        return $answers;
    }

References ILIAS\Repository\object().

Here is the call graph for this function:

editQuestion()

assTextSubsetGUI::editQuestion	(	bool	$checkonly = false,
		?bool	$is_save_cmd = null
	)

Reimplemented from assQuestionGUI.

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

     : bool {
        $save = $is_save_cmd ?? $this->isSaveCommand();
 
        $form = new ilPropertyFormGUI();
        $this->editForm = $form;
 
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->outQuestionType());
        $form->setMultipart(false);
        $form->setTableWidth("100%");
        $form->setId("asstextsubset");
 
        $this->addBasicQuestionFormProperties($form);
        $this->populateQuestionSpecificFormPart($form);
        $this->populateAnswerSpecificFormPart($form);
        $this->populateTaxonomyFormSection($form);
        $this->addQuestionFormCommandButtons($form);
 
        $errors = false;
        if ($save) {
            $form->setValuesByPost();
            $points = $form->getItemByPostVar('points');
            $points->setValue($this->object->getMaximumPoints());
            $errors = !$form->checkInput();
            $form->setValuesByPost(); // again, because checkInput now performs the whole stripSlashes handling and we need this if we don't want to have duplication of backslashes
            if ($errors) {
                $checkonly = false;
            }
        }
 
        if (!$checkonly) {
            $this->renderEditForm($form);
        }
        return $errors;
    }

Referenced by writePostData().

Here is the caller graph for this function:

getAfterParticipationSuppressionAnswerPostVars()

assTextSubsetGUI::getAfterParticipationSuppressionAnswerPostVars

(

)

Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment.

The form elements will be shown disabled, so the users see the usual form but can only edit the settings, which make sense in the given context.

E.g. array('cloze_type', 'image_filename')

Returns

string[]

Implements ilGuiAnswerScoringAdjustable.

Definition at line 434 of file class.assTextSubsetGUI.php.

                                                                    : array
    {
        return [];
    }

getAfterParticipationSuppressionQuestionPostVars()

assTextSubsetGUI::getAfterParticipationSuppressionQuestionPostVars

(

)

Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment.

The form elements will be shown disabled, so the users see the usual form but can only edit the settings, which make sense in the given context.

E.g. array('cloze_type', 'image_filename')

Returns

string[]

Implements ilGuiQuestionScoringAdjustable.

Definition at line 448 of file class.assTextSubsetGUI.php.

                                                                      : array
    {
        return [];
    }

getAnswersFrequency()

assTextSubsetGUI::getAnswersFrequency	(		$relevantAnswers,
			$questionIndex
	)

Reimplemented from assQuestionGUI.

Definition at line 453 of file class.assTextSubsetGUI.php.

                                                                         : array
    {
        $answers = [];
 
        foreach ($relevantAnswers as $ans) {
            if (!isset($answers[$ans['value1']])) {
                $answers[$ans['value1']] = [
                    'answer' => $ans['value1'], 'frequency' => 0
                ];
            }
 
            $answers[$ans['value1']]['frequency']++;
        }
        $answers = $this->completeAddAnswerAction($answers, $questionIndex);
        return $answers;
    }

getPreview()

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

Reimplemented from assQuestionGUI.

Definition at line 270 of file class.assTextSubsetGUI.php.

     : string {
        $solutions = is_object($this->getPreviewSession()) ? (array) $this->getPreviewSession()->getParticipantsSolution() : [];
        $template = new ilTemplate("tpl.il_as_qpl_textsubset_output.html", true, true, "components/ILIAS/TestQuestionPool");
        $width = $this->object->getMaxTextboxWidth();
        for ($i = 0; $i < $this->object->getCorrectAnswers(); $i++) {
            $template->setCurrentBlock("textsubset_row");
            foreach ($solutions as $idx => $solution_value) {
                if ($idx == $i) {
                    $template->setVariable("TEXTFIELD_VALUE", " value=\""
                        . $this->escapeTemplatePlaceholders($solution_value)
                        . "\"");
                }
            }
            $template->setVariable("COUNTER", $i + 1);
            $template->setVariable("TEXTFIELD_ID", $i);
            $template->setVariable("TEXTFIELD_SIZE", $width);
            $template->parseCurrentBlock();
        }
        $template->setVariable("QUESTIONTEXT", $this->renderLatex($this->object->getQuestionForHTMLOutput()));
        $questionoutput = $template->get();
        if (!$show_question_only) {
            // get page object output
            $questionoutput = $this->getILIASPage($questionoutput);
        }
        return $questionoutput;
    }

getSolutionOutput()

assTextSubsetGUI::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 136 of file class.assTextSubsetGUI.php.

     : string {
        // get the solution of the user for the active pass or from the last pass if allowed
        $solutions = [];
        if (($active_id > 0) && (!$show_correct_solution)) {
            $solutions = $this->object->getSolutionValues($active_id, $pass);
        } else {
            $rank = [];
            foreach ($this->object->answers as $answer) {
                $points_string_for_key = (string) $answer->getPoints();
                if ($answer->getPoints() > 0) {
                    if (!array_key_exists($points_string_for_key, $rank)) {
                        $rank[$points_string_for_key] = [];
                    }
                    array_push($rank[$points_string_for_key], $answer->getAnswertext());
                }
            }
            krsort($rank, SORT_NUMERIC);
            foreach ($rank as $index => $bestsolutions) {
                array_push($solutions, ["value1" => join(",", $bestsolutions), "points" => $index]);
            }
        }
 
        return $this->renderSolutionOutput(
            $solutions,
            $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()

assTextSubsetGUI::getSpecificFeedbackOutput

(

array

$userSolution

)

Returns the answer specific feedback for the question.

Parameters

array

$userSolution

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

Reimplemented from assQuestionGUI.

Definition at line 333 of file class.assTextSubsetGUI.php.

                                                                   : string
    {
        $output = "";
        return ilLegacyFormElementsUtil::prepareTextareaOutput($output, true);
    }

References ilLegacyFormElementsUtil\prepareTextareaOutput().

Here is the call graph for this function:

getTestOutput()

assTextSubsetGUI::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 300 of file class.assTextSubsetGUI.php.

     : string {
        if ($active_id) {
            $solutions = $this->object->getUserSolutionPreferingIntermediate($active_id, $pass);
        }
 
        $template = new ilTemplate("tpl.il_as_qpl_textsubset_output.html", true, true, "components/ILIAS/TestQuestionPool");
        $width = $this->object->getMaxTextboxWidth();
        for ($i = 0; $i < $this->object->getCorrectAnswers(); $i++) {
            $template->setCurrentBlock("textsubset_row");
            foreach ($solutions as $idx => $solution_value) {
                if ($idx == $i) {
                    $template->setVariable("TEXTFIELD_VALUE", " value=\""
                        . $this->escapeTemplatePlaceholders($solution_value["value1"])
                        . "\"");
                }
            }
            $template->setVariable("COUNTER", $i + 1);
            $template->setVariable("TEXTFIELD_ID", $i);
            $template->setVariable("TEXTFIELD_SIZE", $width);
            $template->parseCurrentBlock();
        }
        $template->setVariable("QUESTIONTEXT", $this->renderLatex($this->object->getQuestionForHTMLOutput()));
        $questionoutput = $template->get();
        $pageoutput = $this->outQuestionPage("", $is_question_postponed, $active_id, $questionoutput);
        return $pageoutput;
    }

populateAnswerSpecificFormPart()

assTextSubsetGUI::populateAnswerSpecificFormPart

(

\ilPropertyFormGUI

$form

)

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

                                                                            : ilPropertyFormGUI
    {
        $choices = new ilAnswerWizardInputGUI($this->lng->txt("answers"), "answers");
        $choices->setRequired(true);
        $choices->setQuestionObject($this->object);
        $choices->setSingleline(true);
        $choices->setAllowMove(false);
        $choices->setMinValue(0.0);
        if ($this->object->getAnswerCount() == 0) {
            $this->object->addAnswer("", 0, 0);
        }
        $choices->setValues(array_map(
            function (ASS_AnswerBinaryStateImage $value) {
                $value->setAnswerText(html_entity_decode($value->getAnswerText()));
                return $value;
            },
            $this->object->getAnswers()
        ));
        $form->addItem($choices);
        return $form;
    }

References ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Here is the call graph for this function:

populateCorrectionsFormProperties()

assTextSubsetGUI::populateCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Reimplemented from assQuestionGUI.

Definition at line 492 of file class.assTextSubsetGUI.php.

                                                                              : void
    {
        $choices = new ilAssAnswerCorrectionsInputGUI($this->lng->txt("answers"), "answers");
        $choices->setRequired(true);
        $choices->setQuestionObject($this->object);
        $choices->setValues($this->object->getAnswers());
        $form->addItem($choices);
    }

References ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Here is the call graph for this function:

populateQuestionSpecificFormPart()

assTextSubsetGUI::populateQuestionSpecificFormPart

(

\ilPropertyFormGUI

$form

)

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

                                                                              : ilPropertyFormGUI
    {
        // number of requested answers
        $correctanswers = new ilNumberInputGUI($this->lng->txt("nr_of_correct_answers"), "correctanswers");
        $correctanswers->setMinValue(1);
        $correctanswers->setDecimals(0);
        $correctanswers->setSize(3);
        $correctanswers->setValue($this->object->getCorrectAnswers());
        $correctanswers->setRequired(true);
        $form->addItem($correctanswers);
 
        // maximum available points
        $points = new ilNumberInputGUI($this->lng->txt("maximum_points"), "points");
        $points->setMinValue(0.0);
        $points->setMinvalueShouldBeGreater(true);
        $points->setSize(6);
        $points->setDisabled(true);
        $points->allowDecimals(true);
        $points->setValue($this->object->getMaximumPoints());
        $points->setRequired(false);
        $form->addItem($points);
 
        // text rating
        $textrating = new ilSelectInputGUI($this->lng->txt("text_rating"), "text_rating");
        $text_options = [
            "ci" => $this->lng->txt("cloze_textgap_case_insensitive"),
            "cs" => $this->lng->txt("cloze_textgap_case_sensitive")
        ];
        if (!$this->object->getSelfAssessmentEditingMode()) {
            $text_options["l1"] = sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "1");
            $text_options["l2"] = sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "2");
            $text_options["l3"] = sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "3");
            $text_options["l4"] = sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "4");
            $text_options["l5"] = sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "5");
        }
        $textrating->setOptions($text_options);
        $textrating->setValue($this->object->getTextRating());
        $form->addItem($textrating);
        return $form;
    }

References ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Here is the call graph for this function:

removeanswers()

assTextSubsetGUI::removeanswers

(

)

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

                                   : void
    {
        $this->setAdditionalContentEditingModeFromPost();
        $this->writePostData(true);
        $cmd = $this->request_data_collector->raw('cmd') ?? [];
        $remove_answers = in_array('removeanswers', $cmd) && is_array($cmd['removeanswers']) ? $cmd['removeanswers'] : [];
        $this->object->deleteAnswer(key($remove_answers));
        $this->editQuestion();
    }

renderSolutionOutput()

assTextSubsetGUI::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 185 of file class.assTextSubsetGUI.php.

     : ?string {
        $template = new ilTemplate("tpl.il_as_qpl_textsubset_output_solution.html", true, true, "components/ILIAS/TestQuestionPool");
        $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", true, true, "components/ILIAS/TestQuestionPool");
 
        $available_answers = $this->object->getAvailableAnswers();
        for ($i = 0; $i < $this->object->getCorrectAnswers(); $i++) {
            if (!array_key_exists($i, $user_solutions) || (strcmp($user_solutions[$i]["value1"], "") == 0)) {
            } else {
                if (($active_id > 0) && (!$show_correct_solution)) {
                    if ($graphical_output) {
                        // output of ok/not ok icons for user entered solutions
                        $index = $this->object->isAnswerCorrect($available_answers, $user_solutions[$i]["value1"]);
                        $correct = false;
                        if ($index !== false) {
                            unset($available_answers[$index]);
                            $correct = true;
                        }
 
                        $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_NOT_OK);
                        if ($correct) {
                            $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_OK);
                        }
                        $template->setCurrentBlock("icon_ok");
                        $template->setVariable("ICON_OK", $correctness_icon);
                        $template->parseCurrentBlock();
                    }
                }
                $template->setCurrentBlock("textsubset_row");
                $template->setVariable(
                    'SOLUTION',
                    $this->escapeTemplatePlaceholders(
                        htmlspecialchars(
                            $user_solutions[$i]['value1'],
                            ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401,
                            null,
                            false
                        )
                    )
                );
                $template->setVariable("COUNTER", $i + 1);
                if ($result_output) {
                    $points = $user_solutions[$i]["points"];
                    $resulttext = ($points == 1) ? "(%s " . $this->lng->txt("point") . ")" : "(%s " . $this->lng->txt("points") . ")";
                    $template->setVariable("RESULT_OUTPUT", sprintf($resulttext, $points));
                }
                $template->parseCurrentBlock();
            }
        }
        if ($show_question_text == true) {
            $template->setVariable("QUESTIONTEXT", $this->object->getQuestionForHTMLOutput());
        }
        $questionoutput = $template->get();
        $feedback = ($show_feedback && !$this->isTestPresentationContext()) ? $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;
    }

saveCorrectionsFormProperties()

assTextSubsetGUI::saveCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

Reimplemented from assQuestionGUI.

Definition at line 504 of file class.assTextSubsetGUI.php.

                                                                          : void
    {
        $input = $form->getItemByPostVar('answers');
        $values = $input->getValues();
 
        foreach ($this->object->getAnswers() as $index => $answer) {
            $points = (float) str_replace(',', '.', $values[$index]->getPoints());
            $answer->setPoints($points);
        }
    }

References ilPropertyFormGUI\getItemByPostVar(), and ILIAS\Repository\object().

Here is the call graph for this function:

writeAnswerSpecificPostData()

assTextSubsetGUI::writeAnswerSpecificPostData

(

ilPropertyFormGUI

$form

)

Extracts the answer specific values from the request and applies them to the data object.

Implements ilGuiAnswerScoringAdjustable.

Definition at line 345 of file class.assTextSubsetGUI.php.

                                                                        : void
    {
        // Delete all existing answers and create new answers from the form data
        $this->object->flushAnswers();
 
        $answers = $this->request_data_collector->raw('answers', 3);
 
        foreach ($this->answers_from_post as $index => $answertext) {
            $this->object->addAnswer(
                assQuestion::extendedTrim($answertext),
                $this->refinery->kindlyTo()->float()->transform($answers['points'][$index]),
                $index
            );
        }
    }

References assQuestion\extendedTrim(), and ILIAS\Repository\refinery().

Referenced by writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

writePostData()

assTextSubsetGUI::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 57 of file class.assTextSubsetGUI.php.

                                                          : int
    {
        /*
         * sk 26.09.22: This is horrific but I don't see a better way right now,
         * without needing to check most questions for side-effects.
         */
        $answers = $this->request_data_collector->raw('answers');
        $this->answers_from_post = $answers['answer'] ?? [];
 
        if (!(!$always && $this->editQuestion(true))) {
            $this->writeQuestionGenericPostData();
            $this->writeQuestionSpecificPostData(new ilPropertyFormGUI());
            $this->writeAnswerSpecificPostData(new ilPropertyFormGUI());
            $this->saveTaxonomyAssignments();
            return 0;
        }
 
        return 1;
    }

References editQuestion(), assQuestionGUI\saveTaxonomyAssignments(), writeAnswerSpecificPostData(), assQuestionGUI\writeQuestionGenericPostData(), and writeQuestionSpecificPostData().

Here is the call graph for this function:

writeQuestionSpecificPostData()

assTextSubsetGUI::writeQuestionSpecificPostData

(

ilPropertyFormGUI

$form

)

Extracts the question specific values from the request and applies them to the data object.

Implements ilGuiQuestionScoringAdjustable.

Definition at line 339 of file class.assTextSubsetGUI.php.

                                                                          : void
    {
        $this->object->setCorrectAnswers($this->request_data_collector->int('correctanswers'));
        $this->object->setTextRating($this->request_data_collector->string('text_rating'));
    }

Referenced by writePostData().

Here is the caller graph for this function:

Field Documentation

$answers_from_post

assTextSubsetGUI::$answers_from_post

private

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

---

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

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