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

	supportsIntermediateSolutionOutput ()
	Question type specific support of intermediate solution output The function getSolutionOutput respects getUseIntermediateSolution() 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 ($userSolution)
	Returns the answer specific feedback for the question. More...

	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 ($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
	__construct ()
	assQuestionGUI constructor More...

	hasInlineFeedback ()
	this method can be overwritten per question type More...

	addHeaderAction ()

	redrawHeaderAction ()

	getHeaderAction ()

	getNotesHTML ()

	executeCommand ()
	execute command More...

	getType ()
	needed for page editor compliance More...

	getPresentationContext ()

	setPresentationContext ($presentationContext)

	isTestPresentationContext ()

	isPreviousSolutionPrefilled ()

	setPreviousSolutionPrefilled ($previousSolutionPrefilled)

	getRenderPurpose ()

	setRenderPurpose ($renderPurpose)

	isRenderPurposePrintPdf ()

	isRenderPurposePreview ()

	isRenderPurposeInputValue ()

	isRenderPurposePlayback ()

	isRenderPurposeDemoplay ()

	renderPurposeSupportsFormHtml ()

	getEditContext ()

	setEditContext ($editContext)

	isAuthoringEditContext ()

	isAdjustmentEditContext ()

	setAdjustmentEditContext ()

	getNavigationGUI ()

	setNavigationGUI ($navigationGUI)

	setTaxonomyIds ($taxonomyIds)

	getTaxonomyIds ()

	setTargetGui ($linkTargetGui)

	setTargetGuiClass ($targetGuiClass)

	getTargetGuiClass ()

	setQuestionHeaderBlockBuilder ($questionHeaderBlockBuilder)

	getQuestionHeaderBlockBuilder ()

	setQuestionActionCmd ($questionActionCmd)

	getQuestionActionCmd ()

&	createQuestionGUI ($question_type, $question_id=-1)
	Creates a question gui representation. More...

	populateJavascriptFilesRequiredForWorkForm (ilGlobalTemplateInterface $tpl)

	getPresentationJavascripts ()

	getQuestionTemplate ()
	get question template More...

	getILIASPage ($html="")
	Returns the ILIAS Page around a question. More...

	outQuestionPage ($a_temp_var, $a_postponed=false, $active_id="", $html="", $inlineFeedbackEnabled=false)
	output question page More...

	cancel ()
	cancel action More...

	originalSyncForm ($return_to="", $return_to_feedback='')

	sync ()

	cancelSync ()

	saveEdit ()
	save question More...

	save ()
	save question More...

	saveReturn ()
	save question More...

	apply ()
	apply changes More...

	getContextPath ($cont_obj, $a_endnode_id, $a_startnode_id=1)
	get context path in content object tree More...

	setSequenceNumber ($nr)

	getSequenceNumber ()

	setQuestionCount ($a_question_count)

	getQuestionCount ()

	getErrorMessage ()

	setErrorMessage ($errormessage)

	addErrorMessage ($errormessage)

	outAdditionalOutput ()

	getQuestionType ()
	Returns the question type string. More...

	getAsValueAttribute ($a_value)
	Returns a HTML value attribute. More...

	addNewIdListener (&$a_object, $a_method, $a_parameters="")
	Add a listener that is notified with the new question ID, when a new question is saved. More...

	callNewIdListeners ($a_new_id)
	Call the new id listeners. More...

	addQuestionFormCommandButtons ($form)
	Add the command buttons of a question properties form. More...

	addBasicQuestionFormProperties ($form)
	Add basic question form properties: assessment: title, author, description, question, working time. More...

	getAnswerFeedbackOutput ($active_id, $pass)
	Returns the answer generic feedback depending on the results of the question. More...

	getGenericFeedbackOutput ($active_id, $pass)
	Returns the answer specific feedback for the question. More...

	getGenericFeedbackOutputForCorrectSolution ()

	getGenericFeedbackOutputForIncorrectSolution ()

	getSpecificFeedbackOutput ($userSolution)
	Returns the answer specific feedback for the question. More...

	outQuestionType ()

	showSuggestedSolution ()

	suggestedsolution ()
	Allows to add suggested solutions for questions. More...

	outSolutionExplorer ()

	saveSuggestedSolution ()

	cancelExplorer ()

	outPageSelector ()

	outChapterSelector ()

	outGlossarySelector ()

	linkChilds ()

	addPG ()

	addST ()

	addGIT ()

	isSaveCommand ()

	setQuestionTabs ()

	addTab_SuggestedSolution (ilTabsGUI $tabs, $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)

	supportsIntermediateSolutionOutput ()
	Question type specific support of intermediate solution output The function getSolutionOutput respects getUseIntermediateSolution() More...

	hasIntermediateSolution ($activeId, $passIndex)
	Check if the question has an intermediate solution. More...

	setUseIntermediateSolution ($use)

	getUseIntermediateSolution ()
	Get if intermediate solution should be used for solution output. More...

	isAutosaveable ()

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

	outQuestionForTest ( $formaction, $active_id, $pass, $is_question_postponed=false, $user_post_solutions=false, $show_specific_inline_feedback=false)

	magicAfterTestOutput ()

	getTestOutput ( $active_id, $pass, $is_question_postponed, $user_post_solutions, $show_specific_inline_feedback)

	getFormEncodingType ()

	setPreviewSession ($previewSession)

	getPreviewSession ()

	showHints ()

	buildFocusAnchorHtml ()

	isAnswerFreuqencyStatisticSupported ()

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

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

	getAggregatedAnswersView ($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...

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 $_POST 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 ($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 ($always=false)
	Evaluates a posted edit form and writes the form data in the question object. More...

	renderEditForm ($form)

	getUseUnchangedAnswerCheckboxHtml ()

	getPreviousSolutionProvidedMessage ()

	getPreviousSolutionConfirmationCheckboxHtml ()

	saveTaxonomyAssignments ()

	populateTaxonomyFormSection (ilPropertyFormGUI $form)

	setDefaultTabs (ilTabsGUI $ilTabs)

	setQuestionSpecificTabs (ilTabsGUI $ilTabs)

	getBasicEditQuestionTabCommands ()

	getAdditionalEditQuestionCommands ()

	addTab_QuestionFeedback (ilTabsGUI $tabs)
	adds the feedback tab to ilTabsGUI More...

	addTab_QuestionHints (ilTabsGUI $tabs)
	adds the hints tab to ilTabsGUI More...

	addTab_Question (ilTabsGUI $tabsGUI)

	hasCorrectSolution ($activeId, $passIndex)

	writeQuestionGenericPostData ()

	completeTestOutputFormAction ($formAction, $active_id, $pass)

	addBackTab (ilTabsGUI $ilTabs)

	buildBasicEditFormObject ()

	escapeTemplatePlaceholders (string $text)

	buildEditForm ()

	addSaveOnEnterOnLoadCode ()

Private Attributes
	$answers_from_post

Additional Inherited Members
Static Public Member Functions inherited from assQuestionGUI
static	_getQuestionGUI ($question_type, $question_id=-1)
	Creates a question gui representation and returns the alias to the question gui note: please do not use $this inside this method to allow static calls. More...

static	_getGUIClassNameForId ($a_q_id)

static	_getClassNameForQType ($q_type)

static	getCommandsFromClassConstants ($guiClassName, $cmdConstantNameBegin='CMD_')
	extracts values of all constants of given class with given prefix as array can be used to get all possible commands in case of these commands are defined as constants 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	SESSION_PREVIEW_DATA_BASE_INDEX = 'ilAssQuestionPreviewAnswers'

	$object

	$tpl

	$lng

	$error

	$errormessage

	$request

	$sequence_no
	sequence number in test More...

	$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	HAS_SPECIAL_QUESTION_COMMANDS = false

	$ctrl

	$editForm

	$use_intermediate_solution = false

Detailed Description

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

    {
        parent::__construct();
        require_once './Modules/TestQuestionPool/classes/class.assTextSubset.php';
        $this->object = new assTextSubset();
        if ($id >= 0) {
            $this->object->loadFromDb($id);
        }
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ addanswers()

assTextSubsetGUI::addanswers ( )

Add a new answer.

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

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

References $_POST, editQuestion(), and writePostData().

Here is the call graph for this function:

◆ aggregateAnswers()

assTextSubsetGUI::aggregateAnswers ( $relevant_answers_chosen )

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

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

Referenced by getAggregatedAnswersView().

Here is the caller graph for this function:

◆ completeAddAnswerAction()

assTextSubsetGUI::completeAddAnswerAction	(	$answers,
		$questionIndex
	)

protected

Definition at line 495 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;
    }

Referenced by getAnswersFrequency().

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

    {
        $save = $this->isSaveCommand();
        $this->getQuestionTemplate();
 
        require_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        $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;
    }

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

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

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

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

    {
        return array();
    }

◆ getAggregatedAnswersView()

assTextSubsetGUI::getAggregatedAnswersView ( $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 439 of file class.assTextSubsetGUI.php.

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

References aggregateAnswers(), and renderAggregateView().

Here is the call graph for this function:

◆ getAnswersFrequency()

assTextSubsetGUI::getAnswersFrequency	(	$relevantAnswers,
		$questionIndex
	)

Reimplemented from assQuestionGUI.

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

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

References completeAddAnswerAction().

Here is the call graph for this function:

◆ getPreview()

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

Reimplemented from assQuestionGUI.

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

    {
        $solutions = is_object($this->getPreviewSession()) ? (array) $this->getPreviewSession()->getParticipantsSolution() : array();
        // generate the question output
        include_once "./Services/UICore/classes/class.ilTemplate.php";
        $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", sprintf("%02d", $i + 1));
            $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;
    }

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

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: The solution output of the question as HTML code

Reimplemented from assQuestionGUI.

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

      {
        // 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, !$this->getUseIntermediateSolution());
        } else {
            $rank = array();
            foreach ($this->object->answers as $answer) {
                if ($answer->getPoints() > 0) {
                    if (!is_array($rank[$answer->getPoints()])) {
                        $rank[$answer->getPoints()] = array();
                    }
                    array_push($rank[$answer->getPoints()], $answer->getAnswertext());
                }
            }
            krsort($rank, SORT_NUMERIC);
            foreach ($rank as $index => $bestsolutions) {
                array_push($solutions, array("value1" => join(",", $bestsolutions), "points" => $index));
            }
        }
 
        // generate the question output
        include_once "./Services/UICore/classes/class.ilTemplate.php";
        $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 ((!$test_id) && (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;
                        }
                        if ($correct) {
                            $template->setCurrentBlock("icon_ok");
                            $template->setVariable("ICON_OK", ilUtil::getImagePath("icon_ok.svg"));
                            $template->setVariable("TEXT_OK", $this->lng->txt("answer_is_right"));
                            $template->parseCurrentBlock();
                        } else {
                            $template->setCurrentBlock("icon_ok");
                            $template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_not_ok.svg"));
                            $template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_wrong"));
                            $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->getAnswerFeedbackOutput($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;
    }

References $i, $index, $pass, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_CORRECT, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_WRONG, assQuestionGUI\escapeTemplatePlaceholders(), assQuestionGUI\getAnswerFeedbackOutput(), assQuestionGUI\getILIASPage(), ilUtil\getImagePath(), assQuestionGUI\getUseIntermediateSolution(), assQuestionGUI\hasCorrectSolution(), and assQuestionGUI\isTestPresentationContext().

Here is the call graph for this function:

◆ getSpecificFeedbackOutput()

assTextSubsetGUI::getSpecificFeedbackOutput ( $userSolution )

Returns the answer specific feedback for the question.

This method should be overwritten by the actual question.

Todo:: Mark this method abstract!

Parameters

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

Returns: string HTML Code with the answer specific feedback @access public

Reimplemented from assQuestionGUI.

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

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

◆ getTestOutput()

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

Reimplemented from assQuestionGUI.

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

    {
        // get the solution of the user for the active pass or from the last pass if allowed
        $user_solution = "";
        if ($active_id) {
            $solutions = null;
            // hey: prevPassSolutions - obsolete due to central check
            #include_once "./Modules/Test/classes/class.ilObjTest.php";
            #if (!ilObjTest::_getUsePreviousAnswers($active_id, true))
            #{
            #   if (is_null($pass)) $pass = ilObjTest::_getPass($active_id);
            #}
            // hey.
            $solutions = $this->object->getUserSolutionPreferingIntermediate($active_id, $pass);
        }
 
        // generate the question output
        include_once "./Services/UICore/classes/class.ilTemplate.php";
        $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", sprintf("%02d", $i + 1));
            $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;
    }

References $i, $pass, assQuestionGUI\escapeTemplatePlaceholders(), and assQuestionGUI\outQuestionPage().

Here is the call graph for this function:

◆ populateAnswerSpecificFormPart()

assTextSubsetGUI::populateAnswerSpecificFormPart ( \ilPropertyFormGUI $form )

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

    {
        // Choices
        include_once "./Modules/TestQuestionPool/classes/class.ilAnswerWizardInputGUI.php";
        $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().

Referenced by editQuestion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateCorrectionsFormProperties()

assTextSubsetGUI::populateCorrectionsFormProperties ( ilPropertyFormGUI $form )

Parameters

ilPropertyFormGUI $form

Reimplemented from assQuestionGUI.

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

    {
        // Choices
        require_once 'Modules/TestQuestionPool/classes/forms/class.ilAssAnswerCorrectionsInputGUI.php';
        $choices = new ilAssAnswerCorrectionsInputGUI($this->lng->txt("answers"), "answers");
        $choices->setRequired(true);
        $choices->setQuestionObject($this->object);
        $choices->setValues($this->object->getAnswers());
        $form->addItem($choices);
 
        return $form;
    }

References ilPropertyFormGUI\addItem().

Here is the call graph for this function:

◆ populateQuestionSpecificFormPart()

assTextSubsetGUI::populateQuestionSpecificFormPart ( \ilPropertyFormGUI $form )

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

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

References ilPropertyFormGUI\addItem().

Referenced by editQuestion().

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

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

References $_POST, editQuestion(), and writePostData().

Here is the call graph for this function:

◆ renderAggregateView()

assTextSubsetGUI::renderAggregateView ( $aggregate )

Parameters

$aggregate

Returns: ilTemplate

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

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

References assQuestionGUI\$tpl.

Referenced by getAggregatedAnswersView().

Here is the caller graph for this function:

◆ saveCorrectionsFormProperties()

assTextSubsetGUI::saveCorrectionsFormProperties ( ilPropertyFormGUI $form )

Parameters

ilPropertyFormGUI $form

Reimplemented from assQuestionGUI.

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

    {
        $points = $form->getInput('answers')['points'];
 
        foreach ($this->object->getAnswers() as $index => $answer) {
            /* @var ASS_AnswerBinaryStateImage $answer */
            $answer->setPoints((float) $points[$index]);
        }
    }

References $index, and ilPropertyFormGUI\getInput().

Here is the call graph for this function:

◆ supportsIntermediateSolutionOutput()

assTextSubsetGUI::supportsIntermediateSolutionOutput ( )

Question type specific support of intermediate solution output The function getSolutionOutput respects getUseIntermediateSolution()

Returns: bool

Reimplemented from assQuestionGUI.

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

    {
        return true;
    }

◆ writeAnswerSpecificPostData()

assTextSubsetGUI::writeAnswerSpecificPostData ( ilPropertyFormGUI $form )

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

Parameters

bool $always If true, a check for form validity is omitted.

Returns: void

Implements ilGuiAnswerScoringAdjustable.

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

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

References $_POST, $index, and ilUtil\secureString().

Referenced by writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writePostData()

assTextSubsetGUI::writePostData ( $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 48 of file class.assTextSubsetGUI.php.

    {
        /*
         * 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) {
            require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
            $this->writeQuestionGenericPostData();
            $this->writeQuestionSpecificPostData(new ilPropertyFormGUI());
            $this->writeAnswerSpecificPostData(new ilPropertyFormGUI());
            $this->saveTaxonomyAssignments();
            return 0;
        }
        return 1;
    }

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

Referenced by addanswers(), and removeanswers().

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.

Parameters

bool $always If true, a check for form validity is omitted.

Returns: void

Implements ilGuiQuestionScoringAdjustable.

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

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

References $_POST.

Referenced by writePostData().

Here is the caller graph for this function:

Field Documentation

◆ $answers_from_post

assTextSubsetGUI::$answers_from_post

private

Definition at line 26 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()

◆ supportsIntermediateSolutionOutput()

◆ writeAnswerSpecificPostData()

◆ writePostData()

◆ writeQuestionSpecificPostData()

Field Documentation

◆ $answers_from_post