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

Inheritance diagram for assErrorTextGUI:

Collaboration diagram for assErrorTextGUI:

Public Member Functions
	__construct ($id=-1)

	writeAnswerSpecificPostData (ilPropertyFormGUI $form)
	Extracts the answer specific values from the request and applies them to the data object. More...

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

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

	populateAnswerSpecificFormPart (ilPropertyFormGUI $form)

	populateQuestionSpecificFormPart (ilPropertyFormGUI $form)

	analyze ()
	Parse the error text. More...

	getSolutionOutput (int $active_id, ?int $pass=null, bool $graphical_output=false, bool $result_output=false, bool $show_question_only=true, bool $show_feedback=false, bool $show_correct_solution=false, bool $show_manual_scoring=false, bool $show_question_text=true, bool $show_inline_feedback=true)

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

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

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

	getSpecificFeedbackOutput (array $user_solution)

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

	getAnswersFrequency ($relevant_answers, $question_index)

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

	showHints ()

	buildFocusAnchorHtml ()

	isAnswerFrequencyStatisticSupported ()

	getSubQuestionsIndex ()

	getAnswersFrequency ($relevantAnswers, $questionIndex)

	getAnswerFrequencyTableGUI ($parentGui, $parentCmd, $relevantAnswers, $questionIndex)

	prepareReprintableCorrectionsForm (ilPropertyFormGUI $form)

	populateCorrectionsFormProperties (ilPropertyFormGUI $form)

	saveCorrectionsFormProperties (ilPropertyFormGUI $form)

	isInLearningModuleContext ()

	setInLearningModuleContext (bool $flag)

	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)

Protected Member Functions
	writePostData (bool $always=false)
	{} More...

Protected Member Functions inherited from assQuestionGUI
	hasSpecialQuestionCommands ()

	writePostData (bool $always=false)
	Evaluates a posted edit form and writes the form data in the question object. More...

	renderEditForm (ilPropertyFormGUI $form)

	getUseUnchangedAnswerCheckboxHtml ()

	getPreviousSolutionProvidedMessage ()

	getPreviousSolutionConfirmationCheckboxHtml ()

	setTestSpecificProperties ()

	addNumberOfTriesToFormIfNecessary (ilPropertyFormGUI $form)

	saveTaxonomyAssignments ()

	populateTaxonomyFormSection (ilPropertyFormGUI $form)

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

	getTypeOptions ()

	createSuggestedSolutionLinkingTo (string $type, string $target)

	setDefaultTabs (ilTabsGUI $tabs_gui)

	setQuestionSpecificTabs (ilTabsGUI $tabs_gui)

	getBasicEditQuestionTabCommands ()

	getAdditionalEditQuestionCommands ()

	addTab_QuestionFeedback (ilTabsGUI $tabs)

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

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

Private Member Functions
	restructurePostDataForSaving (array $post)

	generateQuestionOutput ($selections, $show_question_only)

	getUsersSolutionFromPreviewOrDatabase (int $active_id=0, ?int $pass=null)

Private Attributes
const	DEFAULT_POINTS_WRONG = -1

ilTabsGUI	$tabs

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 The assErrorTextGUI class encapsulates the GUI representation for error text 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$

assErrorTextGUI: ilObjQuestionPoolGUI assErrorTextGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

assErrorTextGUI::__construct ( $id = -1 )

Definition at line 39 of file class.assErrorTextGUI.php.

References $DIC, $id, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), assQuestionGUI\setErrorMessage(), and ILIAS\Repository\tabs().

     {
         global $DIC;
         $this->tabs = $DIC->tabs();
 
         parent::__construct();
         $this->object = new assErrorText();
         $this->setErrorMessage($this->lng->txt("msg_form_save_error"));
         if ($id >= 0) {
             $this->object->loadFromDb($id);
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ analyze()

assErrorTextGUI::analyze ( )

Parse the error text.

Definition at line 218 of file class.assErrorTextGUI.php.

References editQuestion(), assQuestionGUI\saveTaxonomyAssignments(), assQuestionGUI\setAdditionalContentEditingModeFromPost(), ILIAS\Repository\tabs(), and writePostData().

                              : void
     {
         $this->setAdditionalContentEditingModeFromPost();
         $this->writePostData(true);
         $this->saveTaxonomyAssignments();
         $this->object->setErrorsFromParsedErrorText();
         $this->tabs->activateTab('edit_question');
         $this->editQuestion();
     }

Here is the call graph for this function:

◆ editQuestion()

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

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

References assQuestionGUI\addBasicQuestionFormProperties(), assQuestionGUI\addQuestionFormCommandButtons(), ILIAS\Repository\ctrl(), assQuestionGUI\isSaveCommand(), ILIAS\Repository\lng(), ILIAS\Repository\object(), assQuestionGUI\outQuestionType(), populateAnswerSpecificFormPart(), populateQuestionSpecificFormPart(), assQuestionGUI\populateTaxonomyFormSection(), and assQuestionGUI\renderEditForm().

Referenced by analyze(), and writePostData().

      : 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("orderinghorizontal");
 
         $this->addBasicQuestionFormProperties($form);
 
         $this->populateQuestionSpecificFormPart($form);
 
         if (count($this->object->getErrorData()) || $checkonly) {
             $this->populateAnswerSpecificFormPart($form);
         }
 
         $this->populateTaxonomyFormSection($form);
 
         $form->addCommandButton("analyze", $this->lng->txt('analyze_errortext'));
         $this->addQuestionFormCommandButtons($form);
 
         $errors = false;
 
         if ($save) {
             $form->setValuesByPost();
             $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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateQuestionOutput()

assErrorTextGUI::generateQuestionOutput	(	$selections,
		$show_question_only
	)

private

Definition at line 369 of file class.assErrorTextGUI.php.

References ILIAS\Repository\ctrl(), assQuestionGUI\getILIASPage(), assQuestionGUI\getTargetGuiClass(), null, and ILIAS\Repository\object().

Referenced by getPreview(), and getTestOutput().

                                                                              : string
     {
         $template = new ilTemplate("tpl.il_as_qpl_errortext_output.html", true, true, "components/ILIAS/TestQuestionPool");
 
         if ($this->object->getTextSize() >= 10) {
             $template->setVariable("STYLE", " style=\"font-size: " . $this->object->getTextSize() . "%;\"");
         }
         $template->setVariable("QUESTIONTEXT", $this->object->getQuestionForHTMLOutput());
         $errortext = $this->object->assembleErrorTextOutput($selections);
         if ($this->getTargetGuiClass() !== null) {
             $this->ctrl->setParameterByClass($this->getTargetGuiClass(), 'errorvalue', '');
         }
         $template->setVariable("ERRORTEXT", $errortext);
         $template->setVariable("ERRORTEXT_ID", "qst_" . $this->object->getId());
         $template->setVariable("ERRORTEXT_VALUE", join(',', $selections['user']));
 
         $this->tpl->addOnLoadCode('il.test.player.errortext.init()');
         $this->tpl->addJavascript('assets/js/errortext.js');
         $questionoutput = $template->get();
 
         if ($show_question_only) {
             return $questionoutput;
         }
 
         return $this->getILIASPage($questionoutput);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAfterParticipationSuppressionAnswerPostVars()

assErrorTextGUI::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 447 of file class.assErrorTextGUI.php.

◆ getAfterParticipationSuppressionQuestionPostVars()

assErrorTextGUI::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 461 of file class.assErrorTextGUI.php.

◆ getAggregatedAnswersView()

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

Definition at line 472 of file class.assErrorTextGUI.php.

                                                                      : string
     {
         $errortext = $this->object->getErrorText();
 
         $passdata = []; // Regroup answers into units of passes.
         foreach ($relevant_answers as $answer_chosen) {
             $passdata[$answer_chosen['active_fi'] . '-' . $answer_chosen['pass']][$answer_chosen['value2']][] = $answer_chosen['value1'];
         }
 
         $html = '';
         foreach ($passdata as $key => $pass) {
             $passdata[$key] = $this->object->createErrorTextOutput($pass);
             $html .= $passdata[$key] . '<hr /><br />';
         }
 
         return $html;
     }

◆ getAnswersFrequency()

assErrorTextGUI::getAnswersFrequency	(	$relevant_answers,
		$question_index
	)

Definition at line 490 of file class.assErrorTextGUI.php.

                                                                            : array
     {
         $answers_by_active_and_pass = [];
 
         foreach ($relevant_answers as $row) {
             $key = $row['active_fi'] . ':' . $row['pass'];
 
             if (!isset($answers_by_active_and_pass[$key])) {
                 $answers_by_active_and_pass[$key] = ['user' => []];
             }
 
             $answers_by_active_and_pass[$key]['user'][] = $row['value1'];
         }
 
         $answers = [];
 
         foreach ($answers_by_active_and_pass as $answer) {
             $error_text = '<div class="errortext">' . $this->object->assembleErrorTextOutput($answer) . '</div>';
             $error_text_hashed = md5($error_text);
 
             if (!isset($answers[$error_text_hashed])) {
                 $answers[$error_text_hashed] = [
                     'answer' => $error_text, 'frequency' => 0
                 ];
             }
 
             $answers[$error_text_hashed]['frequency']++;
         }
 
         return array_values($answers);
     }

◆ getPreview()

assErrorTextGUI::getPreview	(	bool	$show_question_only = `false`,
		bool	$show_inline_feedback = `false`
	)

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

References generateQuestionOutput(), and getUsersSolutionFromPreviewOrDatabase().

      : string {
         $selections = [
             'user' => $this->getUsersSolutionFromPreviewOrDatabase()
          ];
 
         return $this->generateQuestionOutput($selections, $show_question_only);
     }

Here is the call graph for this function:

◆ getSolutionOutput()

assErrorTextGUI::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`
	)

Definition at line 228 of file class.assErrorTextGUI.php.

References getUsersSolutionFromPreviewOrDatabase(), and renderSolutionOutput().

      : string {
         $user_solutions = $this->getUsersSolutionFromPreviewOrDatabase($active_id, $pass);
         return $this->renderSolutionOutput(
             $user_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,
         );
     }

Here is the call graph for this function:

◆ getSpecificFeedbackOutput()

assErrorTextGUI::getSpecificFeedbackOutput ( array $user_solution )

Definition at line 414 of file class.assErrorTextGUI.php.

References ILIAS\Repository\object(), and ilLegacyFormElementsUtil\prepareTextareaOutput().

Referenced by renderSolutionOutput().

                                                                    : string
     {
         if (!$this->object->feedbackOBJ->specificAnswerFeedbackExists()) {
             return '';
         }
 
         $feedback = '<table class="test_specific_feedback"><tbody>';
         $elements = $this->object->getErrorData();
         foreach ($elements as $index => $element) {
             $feedback .= '<tr>';
             $feedback .= '<td class="text-nowrap">' . $index . '. ' . $element->getTextWrong() . ':</td>';
             $feedback .= '<td>' . $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
                 $this->object->getId(),
                 0,
                 $index
             ) . '</td>';
 
             $feedback .= '</tr>';
         }
         $feedback .= '</tbody></table>';
 
         return ilLegacyFormElementsUtil::prepareTextareaOutput($feedback, true);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTestOutput()

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

Definition at line 350 of file class.assErrorTextGUI.php.

References generateQuestionOutput(), getUsersSolutionFromPreviewOrDatabase(), and assQuestionGUI\outQuestionPage().

      : string {
         $selections = [
             'user' => $this->getUsersSolutionFromPreviewOrDatabase($active_id, $pass)
          ];
 
         return $this->outQuestionPage(
             '',
             $is_question_postponed,
             $active_id,
             $this->generateQuestionOutput($selections, false)
         );
     }

Here is the call graph for this function:

◆ getUsersSolutionFromPreviewOrDatabase()

assErrorTextGUI::getUsersSolutionFromPreviewOrDatabase	(	int	$active_id = `0`,
		?int	$pass = `null`
	)

private

Definition at line 396 of file class.assErrorTextGUI.php.

References assQuestionGUI\getPreviewSession().

Referenced by getPreview(), getSolutionOutput(), getTestOutput(), and renderSolutionOutput().

                                                                                                  : array
     {
         if (is_object($this->getPreviewSession())) {
             return (array) $this->getPreviewSession()->getParticipantsSolution();
         }
 
         if ($active_id > 0) {
             $selections = [];
             $solutions = $this->object->getSolutionValues($active_id, $pass ?? 0, true);
             foreach ($solutions as $solution) {
                 $selections[] = $solution['value1'];
             }
             return $selections;
         }
 
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateAnswerSpecificFormPart()

assErrorTextGUI::populateAnswerSpecificFormPart ( ilPropertyFormGUI $form )

Parameters

ilPropertyFormGUI $form

Returns: ilPropertyFormGUI

Implements ilGuiAnswerScoringAdjustable.

Definition at line 161 of file class.assErrorTextGUI.php.

References ilPropertyFormGUI\addItem(), ilNumberInputGUI\allowDecimals(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilErrorTextWizardInputGUI\setKeyName().

Referenced by editQuestion().

                                                                            : ilPropertyFormGUI
     {
         $header = new ilFormSectionHeaderGUI();
         $header->setTitle($this->lng->txt("errors_section"));
         $form->addItem($header);
 
         $errordata = new ilErrorTextWizardInputGUI($this->lng->txt("errors"), "errordata");
         $errordata->setKeyName($this->lng->txt('text_wrong'));
         $errordata->setValueName($this->lng->txt('text_correct'));
         $errordata->setValues($this->object->getErrorData());
         $form->addItem($errordata);
 
         // points for wrong selection
         $points_wrong = new ilNumberInputGUI($this->lng->txt("points_wrong"), "points_wrong");
         $points_wrong->allowDecimals(true);
         $points_wrong->setMaxValue(0);
         $points_wrong->setMaxvalueShouldBeLess(true);
         $points_wrong->setValue($this->object->getPointsWrong());
         $points_wrong->setInfo($this->lng->txt("points_wrong_info"));
         $points_wrong->setSize(6);
         $points_wrong->setRequired(true);
         $form->addItem($points_wrong);
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateCorrectionsFormProperties()

assErrorTextGUI::populateCorrectionsFormProperties ( ilPropertyFormGUI $form )

Definition at line 522 of file class.assErrorTextGUI.php.

References ilPropertyFormGUI\addItem(), ilNumberInputGUI\allowDecimals(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilErrorTextWizardInputGUI\setKeyName().

                                                                               : void
     {
         $errordata = new ilAssErrorTextCorrectionsInputGUI($this->lng->txt('errors'), 'errordata');
         $errordata->setKeyName($this->lng->txt('text_wrong'));
         $errordata->setValueName($this->lng->txt('text_correct'));
         $errordata->setValues($this->object->getErrorData());
         $form->addItem($errordata);
 
         // points for wrong selection
         $points_wrong = new ilNumberInputGUI($this->lng->txt('points_wrong'), 'points_wrong');
         $points_wrong->allowDecimals(true);
         $points_wrong->setMaxValue(0);
         $points_wrong->setMaxvalueShouldBeLess(true);
         $points_wrong->setValue($this->object->getPointsWrong());
         $points_wrong->setInfo($this->lng->txt('points_wrong_info'));
         $points_wrong->setSize(6);
         $points_wrong->setRequired(true);
         $form->addItem($points_wrong);
     }

Here is the call graph for this function:

◆ populateQuestionSpecificFormPart()

assErrorTextGUI::populateQuestionSpecificFormPart ( ilPropertyFormGUI $form )

Parameters

$form ilPropertyFormGUI

Returns: ilPropertyFormGUI

Implements ilGuiQuestionScoringAdjustable.

Definition at line 190 of file class.assErrorTextGUI.php.

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

Referenced by editQuestion().

                                                                              : ilPropertyFormGUI
     {
         // errortext
         $errortext = new ilTextAreaInputGUI($this->lng->txt("errortext"), "errortext");
         $errortext->setValue($this->object->getErrorText());
         $errortext->setRequired(true);
         $errortext->setInfo($this->lng->txt("errortext_info"));
         $errortext->setRows(10);
         $errortext->setCols(80);
         $form->addItem($errortext);
 
         if (!$this->object->getSelfAssessmentEditingMode()) {
             // textsize
             $textsize = new ilNumberInputGUI($this->lng->txt("textsize"), "textsize");
             $textsize->setValue($this->object->getTextSize() ?? 100.0);
             $textsize->setInfo($this->lng->txt("textsize_errortext_info"));
             $textsize->setSize(6);
             $textsize->setSuffix("%");
             $textsize->setMinValue(10);
             $textsize->setRequired(true);
             $form->addItem($textsize);
         }
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderSolutionOutput()

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

Definition at line 257 of file class.assErrorTextGUI.php.

References ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_CORRECT, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_WRONG, assQuestionGUI\generateCorrectnessIconsForCorrectness(), assQuestionGUI\getGenericFeedbackOutput(), assQuestionGUI\getILIASPage(), getSpecificFeedbackOutput(), getUsersSolutionFromPreviewOrDatabase(), assQuestionGUI\hasCorrectSolution(), assQuestionGUI\isTestPresentationContext(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilLegacyFormElementsUtil\prepareTextareaOutput().

Referenced by getSolutionOutput().

      : ?string {
         $template = new ilTemplate("tpl.il_as_qpl_errortext_output_solution.html", true, true, "components/ILIAS/TestQuestionPool");
 
         $selections = [
             'user' => $user_solutions ?
                 $user_solutions :
                 $this->getUsersSolutionFromPreviewOrDatabase($active_id, $pass)
         ];
         $selections['best'] = $this->object->getBestSelection();
 
         $reached_points = $this->object->getPoints();
         if ($active_id > 0 && !$show_correct_solution) {
             $reached_points = $this->object->getReachedPoints($active_id, $pass);
         }
 
         if ($result_output === true) {
             $resulttext = ($reached_points == 1) ? "(%s " . $this->lng->txt("point") . ")" : "(%s " . $this->lng->txt("points") . ")";
             $template->setVariable("RESULT_OUTPUT", sprintf($resulttext, $reached_points));
         }
 
         if ($this->object->getTextSize() >= 10) {
             $template->setVariable("STYLE", " style=\"font-size: " . $this->object->getTextSize() . "%;\"");
         }
 
         if ($show_question_text === true) {
             $template->setVariable("QUESTIONTEXT", $this->object->getQuestionForHTMLOutput());
         }
 
         $correctness_icons = [
             'correct' => $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_OK),
             'not_correct' => $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_NOT_OK)
         ];
         $errortext = $this->object->assembleErrorTextOutput($selections, $graphical_output, $show_correct_solution, false, $correctness_icons);
 
         $template->setVariable("ERRORTEXT", $errortext);
         $questionoutput = $template->get();
 
         $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", true, true, "components/ILIAS/TestQuestionPool");
 
         $feedback = '';
         if ($show_feedback) {
             if (!$this->isTestPresentationContext()) {
                 $fb = $this->getGenericFeedbackOutput($active_id, $pass);
                 $feedback .= mb_strlen($fb) ? $fb : '';
             }
 
             $fb = $this->getSpecificFeedbackOutput([]);
             $feedback .= mb_strlen($fb) ? $fb : '';
         }
         if (mb_strlen($feedback)) {
             $cssClass = (
                 $this->hasCorrectSolution($active_id, $pass) ?
                 ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_CORRECT : ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_WRONG
             );
 
             $solutiontemplate->setVariable("ILC_FB_CSS_CLASS", $cssClass);
             $solutiontemplate->setVariable("FEEDBACK", ilLegacyFormElementsUtil::prepareTextareaOutput($feedback, true));
         }
 
         $solutiontemplate->setVariable("SOLUTION_OUTPUT", $questionoutput);
 
         $solutionoutput = $solutiontemplate->get();
         if (!$show_question_only) {
             // get page object output
             $solutionoutput = $this->getILIASPage($solutionoutput);
         }
         return $solutionoutput;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restructurePostDataForSaving()

assErrorTextGUI::restructurePostDataForSaving ( array $post )

private

Definition at line 75 of file class.assErrorTextGUI.php.

Referenced by writeAnswerSpecificPostData().

                                                               : array
     {
         $keys = $post['key'] ?? [];
         $restructured_array = [];
         foreach ($keys as $key => $text_wrong) {
             $restructured_array[] = new assAnswerErrorText(
                 $text_wrong,
                 $post['value'][$key],
                 (float) str_replace(',', '.', $post['points'][$key])
             );
         }
         return $restructured_array;
     }

Here is the caller graph for this function:

◆ saveCorrectionsFormProperties()

assErrorTextGUI::saveCorrectionsFormProperties ( ilPropertyFormGUI $form )

Parameters

ilPropertyFormGUI $form

Definition at line 545 of file class.assErrorTextGUI.php.

References ilPropertyFormGUI\getInput().

                                                                           : void
     {
         $existing_errordata = $this->object->getErrorData();
         $this->object->flushErrorData();
         $new_errordata = $this->request_data_collector->raw('errordata');
         $errordata = [];
         foreach ($new_errordata['points'] as $index => $points) {
             $errordata[$index] = $existing_errordata[$index]->withPoints(
                 (float) str_replace(',', '.', $points)
             );
         }
         $this->object->setErrorData($errordata);
         $this->object->setPointsWrong((float) str_replace(',', '.', $form->getInput('points_wrong')));
     }

Here is the call graph for this function:

◆ writeAnswerSpecificPostData()

assErrorTextGUI::writeAnswerSpecificPostData ( ilPropertyFormGUI $form )

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

Implements ilGuiAnswerScoringAdjustable.

Definition at line 68 of file class.assErrorTextGUI.php.

References $data, and restructurePostDataForSaving().

Referenced by writePostData().

                                                                         : void
     {
         $data = $this->restructurePostDataForSaving($this->request_data_collector->raw('errordata') ?? []);
         $this->object->setErrorData($data);
         $this->object->removeErrorDataWithoutPosition();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writePostData()

assErrorTextGUI::writePostData ( bool $always = false )

protected

{}

Definition at line 55 of file class.assErrorTextGUI.php.

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

Referenced by analyze().

                                                           : int
     {
         $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()

assErrorTextGUI::writeQuestionSpecificPostData ( ilPropertyFormGUI $form )

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

Implements ilGuiQuestionScoringAdjustable.

Definition at line 89 of file class.assErrorTextGUI.php.

References ILIAS\Repository\object().

Referenced by writePostData().

                                                                           : void
     {
         $this->object->setQuestion(
             $this->request_data_collector->string('question')
         );
 
         $this->object->setErrorText(
             $this->request_data_collector->raw('errortext')
         );
 
         $this->object->parseErrorText();
 
         $this->object->setPointsWrong(
             $this->request_data_collector->float('points_wrong') ?? self::DEFAULT_POINTS_WRONG
         );
 
         if (!$this->object->getSelfAssessmentEditingMode()) {
             $this->object->setTextSize(
                 $this->request_data_collector->float('textsize')
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $tabs

ilTabsGUI assErrorTextGUI::$tabs

private

Definition at line 37 of file class.assErrorTextGUI.php.

◆ DEFAULT_POINTS_WRONG

const assErrorTextGUI::DEFAULT_POINTS_WRONG = -1

private

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

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

components/ILIAS/TestQuestionPool/classes/class.assErrorTextGUI.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ analyze()

◆ editQuestion()

◆ generateQuestionOutput()

◆ getAfterParticipationSuppressionAnswerPostVars()

◆ getAfterParticipationSuppressionQuestionPostVars()

◆ getAggregatedAnswersView()

◆ getAnswersFrequency()

◆ getPreview()

◆ getSolutionOutput()

◆ getSpecificFeedbackOutput()

◆ getTestOutput()

◆ getUsersSolutionFromPreviewOrDatabase()

◆ populateAnswerSpecificFormPart()

◆ populateCorrectionsFormProperties()

◆ populateQuestionSpecificFormPart()

◆ renderSolutionOutput()

◆ restructurePostDataForSaving()

◆ saveCorrectionsFormProperties()

◆ writeAnswerSpecificPostData()

◆ writePostData()

◆ writeQuestionSpecificPostData()

Field Documentation

◆ $tabs

◆ DEFAULT_POINTS_WRONG