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 ($checkonly=false)
	Creates an output of the edit form for the question. More...

	addanswers ()
	Add a new answer. More...

	removeanswers ()
	Remove an answer. 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...

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

	getTestOutput ($active_id, $pass=null, $is_postponed=false, $use_post_solutions=false, $inlineFeedback=false)

	getSpecificFeedbackOutput (array $userSolution)

	writeQuestionSpecificPostData (ilPropertyFormGUI $form)
	Extracts the question specific values from $_POST and applies them to the data object. More...

	writeAnswerSpecificPostData (ilPropertyFormGUI $form)
	Extracts the answer specific values from $_POST 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...

	getAggregatedAnswersView (array $relevant_answers)
	Returns an html string containing a question specific representation of the answers so far given in the test for use in the right column in the scoring adjustment user interface. More...

	aggregateAnswers ($relevant_answers_chosen)

	renderAggregateView ($aggregate)

	getAnswersFrequency ($relevantAnswers, $questionIndex)

	populateCorrectionsFormProperties (ilPropertyFormGUI $form)

	saveCorrectionsFormProperties (ilPropertyFormGUI $form)

Public Member Functions inherited from assQuestionGUI
	hasInlineFeedback ()

	addHeaderAction ()

	redrawHeaderAction ()

	getHeaderAction ()

	getNotesHTML ()

	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)

	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)

Public Member Functions inherited from ilGuiQuestionScoringAdjustable
	populateQuestionSpecificFormPart (ilPropertyFormGUI $form)
	Adds the question specific forms parts to a question property form gui. More...

Public Member Functions inherited from ilGuiAnswerScoringAdjustable
	populateAnswerSpecificFormPart (ilPropertyFormGUI $form)
	Adds the answer specific form parts to a question property form gui. More...

Protected Member Functions
	writePostData (bool $always=false)
	{} 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 ()

	addNumberOfTriesToFormIfNecessary (ilPropertyFormGUI $form)

	saveTaxonomyAssignments ()

	populateTaxonomyFormSection (ilPropertyFormGUI $form)

	genericFeedbackOutputBuilder (string $feedback_correct, string $feedback_incorrect, int $active_id, ?int $pass)

	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)

	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 ()

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	_getGUIClassNameForId ($a_q_id)

static	_getClassNameForQType ($q_type)

static	getCommandsFromClassConstants (string $guiClassName, string $cmdConstantNameBegin='CMD_')

static	prepareTextareaOutput ($txt_output, $prepare_for_latex_output=false, $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'

Protected Attributes inherited from assQuestionGUI
const	SUGGESTED_SOLUTION_COMMANDS

const	HAS_SPECIAL_QUESTION_COMMANDS = false

ILIAS Notes GUIService	$notes_gui

ilCtrl	$ctrl

ilPropertyFormGUI	$editForm

ILIAS TestQuestionPool InternalRequestService	$request

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$

assTextSubsetGUI: ilFormPropertyDispatchGUI

Definition at line 36 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 47 of file class.assTextSubsetGUI.php.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addanswers()

assTextSubsetGUI::addanswers ( )

Add a new answer.

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

References editQuestion(), and writePostData().

                                 : void
     {
         $this->writePostData(true);
         $position = key($_POST['cmd']['addanswers']);
         $this->object->addAnswer("", 0, $position + 1);
         $this->editQuestion();
     }

Here is the call graph for this function:

◆ aggregateAnswers()

assTextSubsetGUI::aggregateAnswers ( $relevant_answers_chosen )

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

Referenced by getAggregatedAnswersView().

                                                               : array
     {
         $aggregate = array();
 
         foreach ($relevant_answers_chosen as $relevant_answer) {
             if (array_key_exists($relevant_answer['value1'], $aggregate)) {
                 $aggregate[$relevant_answer['value1']]++;
             } else {
                 $aggregate[$relevant_answer['value1']] = 1;
             }
         }
         return $aggregate;
     }

Here is the caller graph for this function:

◆ completeAddAnswerAction()

assTextSubsetGUI::completeAddAnswerAction	(	$answers,
		$questionIndex
	)

protected

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

References ILIAS\LTI\ToolProvider\$key, and ILIAS\Repository\object().

Referenced by getAnswersFrequency().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editQuestion()

assTextSubsetGUI::editQuestion ( $checkonly = false )

Creates an output of the edit form for the question.

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

References $errors, assQuestionGUI\addBasicQuestionFormProperties(), assQuestionGUI\addQuestionFormCommandButtons(), ILIAS\Repository\ctrl(), assQuestionGUI\getQuestionTemplate(), assQuestionGUI\isSaveCommand(), ILIAS\Repository\object(), assQuestionGUI\outQuestionType(), populateAnswerSpecificFormPart(), populateQuestionSpecificFormPart(), and assQuestionGUI\populateTaxonomyFormSection().

Referenced by addanswers(), removeanswers(), and writePostData().

                                                     : bool
     {
         $save = $this->isSaveCommand();
         $this->getQuestionTemplate();
 
         $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->tpl->setVariable("QUESTION_DATA", $form->getHTML());
         }
         return $errors;
     }

Here is the call graph for this function:

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

                                                                     : array
     {
         return array();
     }

◆ 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 411 of file class.assTextSubsetGUI.php.

                                                                       : array
     {
         return array();
     }

◆ getAggregatedAnswersView()

assTextSubsetGUI::getAggregatedAnswersView ( array $relevant_answers )

Returns an html string containing a question specific representation of the answers so far given in the test for use in the right column in the scoring adjustment user interface.

Parameters

array $relevant_answers

Returns: string

Implements ilGuiQuestionScoringAdjustable.

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

References aggregateAnswers(), and renderAggregateView().

                                                                      : string
     {
         return  $this->renderAggregateView(
             $this->aggregateAnswers($relevant_answers)
         )->get();
     }

Here is the call graph for this function:

◆ getAnswersFrequency()

assTextSubsetGUI::getAnswersFrequency	(	$relevantAnswers,
		$questionIndex
	)

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

References completeAddAnswerAction().

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

Here is the call graph for this function:

◆ getPreview()

assTextSubsetGUI::getPreview	(	$show_question_only = `false`,
		$showInlineFeedback = `false`
	)

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

References $i, assQuestionGUI\escapeTemplatePlaceholders(), assQuestionGUI\getILIASPage(), assQuestionGUI\getPreviewSession(), and ILIAS\Repository\object().

                                                                                         : string
     {
         $solutions = is_object($this->getPreviewSession()) ? (array) $this->getPreviewSession()->getParticipantsSolution() : array();
         $template = new ilTemplate("tpl.il_as_qpl_textsubset_output.html", true, true, "Modules/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->object->getQuestionForHTMLOutput());
         $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()

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

References $i, $index, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_CORRECT, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_WRONG, assQuestionGUI\escapeTemplatePlaceholders(), assQuestionGUI\generateCorrectnessIconsForCorrectness(), assQuestionGUI\getGenericFeedbackOutput(), assQuestionGUI\getILIASPage(), assQuestionGUI\hasCorrectSolution(), assQuestionGUI\isTestPresentationContext(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

      : string {
         // get the solution of the user for the active pass or from the last pass if allowed
         $solutions = array();
         if (($active_id > 0) && (!$show_correct_solution)) {
             $solutions = $this->object->getSolutionValues($active_id, $pass);
         } else {
             $rank = array();
             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();
                     }
                     array_push($rank[$points_string_for_key], $answer->getAnswertext());
                 }
             }
             krsort($rank, SORT_NUMERIC);
             foreach ($rank as $index => $bestsolutions) {
                 array_push($solutions, array("value1" => join(",", $bestsolutions), "points" => $index));
             }
         }
 
         $template = new ilTemplate("tpl.il_as_qpl_textsubset_output_solution.html", true, true, "Modules/TestQuestionPool");
         $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", true, true, "Modules/TestQuestionPool");
         $available_answers = &$this->object->getAvailableAnswers();
         for ($i = 0; $i < $this->object->getCorrectAnswers(); $i++) {
             if (!array_key_exists($i, $solutions) || (strcmp($solutions[$i]["value1"], "") == 0)) {
             } else {
                 if (($active_id > 0) && (!$show_correct_solution)) {
                     if ($graphicalOutput) {
                         // output of ok/not ok icons for user entered solutions
                         $index = $this->object->isAnswerCorrect($available_answers, $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($solutions[$i]["value1"]));
                 $template->setVariable("COUNTER", $i + 1);
                 if ($result_output) {
                     $points = $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", $this->object->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:

◆ getSpecificFeedbackOutput()

assTextSubsetGUI::getSpecificFeedbackOutput ( array $userSolution )

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

                                                                   : string
     {
         $output = "";
         return $this->object->prepareTextareaOutput($output, true);
     }

◆ getTestOutput()

assTextSubsetGUI::getTestOutput	(	$active_id,
		$pass = `null`,
		$is_postponed = `false`,
		$use_post_solutions = `false`,
		$inlineFeedback = `false`
	)

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

References $i, assQuestionGUI\escapeTemplatePlaceholders(), ILIAS\Repository\object(), and assQuestionGUI\outQuestionPage().

                                                                                                                                         : string
     {
         // 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->getUserSolutionPreferingIntermediate($active_id, $pass);
         }
 
         $template = new ilTemplate("tpl.il_as_qpl_textsubset_output.html", true, true, "Modules/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->object->getQuestionForHTMLOutput());
         $questionoutput = $template->get();
         $pageoutput = $this->outQuestionPage("", $is_postponed, $active_id, $questionoutput);
         return $pageoutput;
     }

Here is the call graph for this function:

◆ populateAnswerSpecificFormPart()

assTextSubsetGUI::populateAnswerSpecificFormPart ( \ilPropertyFormGUI $form )

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

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

Referenced by editQuestion().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateCorrectionsFormProperties()

assTextSubsetGUI::populateCorrectionsFormProperties ( ilPropertyFormGUI $form )

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

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

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

Here is the call graph for this function:

◆ populateQuestionSpecificFormPart()

assTextSubsetGUI::populateQuestionSpecificFormPart ( \ilPropertyFormGUI $form )

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

References ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilNumberInputGUI\setMinValue(), and ilSelectInputGUI\setOptions().

Referenced by editQuestion().

                                                                               : 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 = array(
             "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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeanswers()

assTextSubsetGUI::removeanswers ( )

Remove an answer.

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

References editQuestion(), and writePostData().

                                    : void
     {
         $this->writePostData(true);
         $position = key($_POST['cmd']['removeanswers']);
         $this->object->deleteAnswer($position);
         $this->editQuestion();
     }

Here is the call graph for this function:

◆ renderAggregateView()

assTextSubsetGUI::renderAggregateView ( $aggregate )

Parameters

$aggregate

Returns: ilTemplate

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

References ILIAS\LTI\ToolProvider\$key, assQuestionGUI\$tpl, ilGlobalPageTemplate\parseCurrentBlock(), ilGlobalPageTemplate\setCurrentBlock(), and ilGlobalPageTemplate\setVariable().

Referenced by getAggregatedAnswersView().

                                                    : ilTemplate
     {
         $tpl = new ilTemplate('tpl.il_as_aggregated_answers_table.html', true, true, "Modules/TestQuestionPool");
 
         foreach ($aggregate as $key => $value) {
             $tpl->setCurrentBlock('aggregaterow');
             $tpl->setVariable('OPTION', $key);
             $tpl->setVariable('COUNT', $value);
             $tpl->parseCurrentBlock();
         }
         return $tpl;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveCorrectionsFormProperties()

assTextSubsetGUI::saveCorrectionsFormProperties ( ilPropertyFormGUI $form )

Parameters

ilPropertyFormGUI $form

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

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

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

Here is the call graph for this function:

◆ writeAnswerSpecificPostData()

assTextSubsetGUI::writeAnswerSpecificPostData ( ilPropertyFormGUI $form )

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

Implements ilGuiAnswerScoringAdjustable.

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

References $index, and assQuestion\extendedTrim().

Referenced by writePostData().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writePostData()

assTextSubsetGUI::writePostData ( bool $always = false )

protected

{}

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

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

Referenced by addanswers(), and removeanswers().

                                                           : 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.
          */
         $this->answers_from_post = $_POST['answers']['answer'];
         $hasErrors = (!$always) ? $this->editQuestion(true) : false;
         if (!$hasErrors) {
             $this->writeQuestionGenericPostData();
             $this->writeQuestionSpecificPostData(new ilPropertyFormGUI());
             $this->writeAnswerSpecificPostData(new ilPropertyFormGUI());
             $this->saveTaxonomyAssignments();
             return 0;
         }
         return 1;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeQuestionSpecificPostData()

assTextSubsetGUI::writeQuestionSpecificPostData ( ilPropertyFormGUI $form )

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

Implements ilGuiQuestionScoringAdjustable.

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

Referenced by writePostData().

                                                                           : void
     {
         $this->object->setCorrectAnswers($_POST["correctanswers"]);
         $this->object->setTextRating($_POST["text_rating"]);
     }

Here is the caller graph for this function:

Field Documentation

◆ $answers_from_post

assTextSubsetGUI::$answers_from_post

private

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

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

Modules/TestQuestionPool/classes/class.assTextSubsetGUI.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addanswers()

◆ aggregateAnswers()

◆ completeAddAnswerAction()

◆ editQuestion()

◆ getAfterParticipationSuppressionAnswerPostVars()

◆ getAfterParticipationSuppressionQuestionPostVars()

◆ getAggregatedAnswersView()

◆ getAnswersFrequency()

◆ getPreview()

◆ getSolutionOutput()

◆ getSpecificFeedbackOutput()

◆ getTestOutput()

◆ populateAnswerSpecificFormPart()

◆ populateCorrectionsFormProperties()

◆ populateQuestionSpecificFormPart()

◆ removeanswers()

◆ renderAggregateView()

◆ saveCorrectionsFormProperties()

◆ writeAnswerSpecificPostData()

◆ writePostData()

◆ writeQuestionSpecificPostData()

Field Documentation

◆ $answers_from_post