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

Inheritance diagram for assOrderingHorizontalGUI:

Collaboration diagram for assOrderingHorizontalGUI:

Public Member Functions
	__construct ($id=-1)
	assOrderingHorizontalGUI constructor More...

	getCommand ($cmd)

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

	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 ($show_question_only=false, $showInlineFeedback=false)

	getTestOutput ($active_id, $pass, $is_postponed=false, $use_post_solutions=false, $show_feedback=false)

	getPresentationJavascripts ()

	getSpecificFeedbackOutput (array $userSolution)

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

	populateQuestionSpecificFormPart (\ilPropertyFormGUI $form)

	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, $answer_defined_on_question)

	renderAggregateView ($aggregate)

	getAnswersFrequency ($relevantAnswers, $questionIndex)

	populateCorrectionsFormProperties (ilPropertyFormGUI $form)

	saveCorrectionsFormProperties (ilPropertyFormGUI $form)

Public Member Functions inherited from assQuestionGUI
	hasInlineFeedback ()

	addHeaderAction ()

	redrawHeaderAction ()

	getHeaderAction ()

	geCommentsPanelHTML ()

	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)

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

	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)

	isInLearningModuleContext ()

	setInLearningModuleContext (bool $flag)

	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)

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

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

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

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

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 (?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	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_CANCEL = 'cancelSuggestedSolution'

const	SUGGESTED_SOLUTION_COMMANDS_SAVE = 'saveSuggestedSolution'

const	SUGGESTED_SOLUTION_COMMANDS_DEFAULT = 'suggestedsolution'

const	HAS_SPECIAL_QUESTION_COMMANDS = false

ilLogger	$logger

ILIAS TestQuestionPool QuestionInfoService	$questioninfo

ILIAS Notes GUIService	$notes_gui

ilCtrl	$ctrl

Refinery	$refinery

ilPropertyFormGUI	$editForm

ILIAS TestQuestionPool InternalRequestService	$request

bool	$parent_type_is_lm = false

assQuestionSuggestedSolutionsDatabaseRepository	$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 assOrderingHorizontalGUI class encapsulates the GUI representation for horizontal ordering 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$

assOrderingHorizontalGUI: ilObjQuestionPoolGUI assOrderingHorizontalGUI: ilPropertyFormGUI, ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

assOrderingHorizontalGUI::__construct ( $id = -1 )

assOrderingHorizontalGUI constructor

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

Parameters

integer $id The database id of a single choice question object public

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

References $id, ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\lng(), and assQuestionGUI\setErrorMessage().

     {
         parent::__construct();
         $this->object = new assOrderingHorizontal();
         $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

◆ aggregateAnswers()

assOrderingHorizontalGUI::aggregateAnswers	(	$relevant_answers_chosen,
		$answer_defined_on_question
	)

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

References ILIAS\Repository\object().

Referenced by getAggregatedAnswersView().

                                                                                            : array
     {
         $aggregate = array();
         foreach ($relevant_answers_chosen as $answer) {
             $answer = str_replace($this->object->getAnswerSeparator(), '&nbsp;&nbsp;-&nbsp;&nbsp;', $answer);
             if (in_array($answer['value1'], $aggregate)) {
                 $aggregate[$answer['value1']] = $aggregate[$answer['value1']] + 1;
             } else {
                 $aggregate[$answer['value1']] = 1;
             }
         }
 
         return $aggregate;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editQuestion()

assOrderingHorizontalGUI::editQuestion ( $checkonly = false )

Creates an output of the edit form for the question.

public

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

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

Referenced by 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("orderinghorizontal");
 
         $this->addBasicQuestionFormProperties($form);
         $this->populateQuestionSpecificFormPart($form);
 
 
         $this->populateTaxonomyFormSection($form);
 
         $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->tpl->setVariable("QUESTION_DATA", $form->getHTML());
         }
         return $errors;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAfterParticipationSuppressionQuestionPostVars()

assOrderingHorizontalGUI::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 406 of file class.assOrderingHorizontalGUI.php.

                                                                       : array
     {
         return array();
     }

◆ getAggregatedAnswersView()

assOrderingHorizontalGUI::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 454 of file class.assOrderingHorizontalGUI.php.

References aggregateAnswers(), ILIAS\Repository\object(), and renderAggregateView().

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

Here is the call graph for this function:

◆ getAnswersFrequency()

assOrderingHorizontalGUI::getAnswersFrequency	(	$relevantAnswers,
		$questionIndex
	)

Definition at line 494 of file class.assOrderingHorizontalGUI.php.

References ILIAS\Repository\object().

                                                                          : array
     {
         $answers = array();
 
         foreach ($relevantAnswers as $ans) {
             $md5 = md5($ans['value1']);
 
             if (!isset($answers[$md5])) {
                 $answer = str_replace(
                     $this->object->getAnswerSeparator(),
                     '&nbsp;&nbsp;-&nbsp;&nbsp;',
                     $ans['value1']
                 );
 
                 $answers[$md5] = array(
                     'answer' => $answer, 'frequency' => 0
                 );
             }
 
             $answers[$md5]['frequency']++;
         }
 
         return $answers;
     }

Here is the call graph for this function:

◆ getCommand()

assOrderingHorizontalGUI::getCommand ( $cmd )

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

     {
         return $cmd;
     }

◆ getPresentationJavascripts()

assOrderingHorizontalGUI::getPresentationJavascripts ( )

Definition at line 372 of file class.assOrderingHorizontalGUI.php.

References $DIC.

                                                 : array
     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         $files = array();
 
         if ($DIC->http()->agent()->isMobile() || $DIC->http()->agent()->isIpad()) {
             $files[] = './node_modules/@andxor/jquery-ui-touch-punch-fix/jquery.ui.touch-punch.js';
         }
 
         return $files;
     }

◆ getPreview()

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

Definition at line 259 of file class.assOrderingHorizontalGUI.php.

References $DIC, $id, assQuestionGUI\getILIASPage(), assQuestionGUI\getPreviewSession(), iljQueryUtil\initjQuery(), iljQueryUtil\initjQueryUI(), ILIAS\Repository\object(), and ilLegacyFormElementsUtil\prepareFormOutput().

                                                                                         : string
     {
         if (is_object($this->getPreviewSession()) && strlen((string) $this->getPreviewSession()->getParticipantsSolution())) {
             $elements = (string) $this->getPreviewSession()->getParticipantsSolution();
             $elements = $this->object->splitAndTrimOrderElementText($elements, $this->object->getAnswerSeparator());
         } else {
             $elements = $this->object->getRandomOrderingElements();
         }
 
         $template = new ilTemplate("tpl.il_as_qpl_orderinghorizontal_preview.html", true, true, "Modules/TestQuestionPool");
         $js = <<<JS
 
         $('#horizontal_{QUESTION_ID}').ilHorizontalOrderingQuestion({
             result_value_selector  : '.ilOrderingValue',
             result_separator       : '{::}'
         });
 
 JS;
         $js = str_replace('{QUESTION_ID}', $this->object->getId(), $js);
         $this->tpl->addOnLoadCode($js);
 
         foreach ($elements as $id => $element) {
             $template->setCurrentBlock("element");
             $template->setVariable("ELEMENT_ID", "e_" . $this->object->getId() . "_$id");
             $template->setVariable("ORDERING_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($element));
             $template->setVariable("ELEMENT_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($element));
             $template->parseCurrentBlock();
         }
         $template->setVariable("QUESTION_ID", $this->object->getId());
         $template->setVariable("VALUE_ORDERRESULT", ' value="' . join('{::}', $elements) . '"');
         if ($this->object->getTextSize() >= 10) {
             $template->setVariable("STYLE", " style=\"font-size: " . $this->object->getTextSize() . "%;\"");
         }
         $template->setVariable("QUESTIONTEXT", $this->object->getQuestionForHTMLOutput());
         $questionoutput = $template->get();
         if (!$show_question_only) {
             // get page object output
             $questionoutput = $this->getILIASPage($questionoutput);
         }
         global $DIC; /* @var ILIAS\DI\Container $DIC */
         if ($DIC->http()->agent()->isMobile() || $DIC->http()->agent()->isIpad()) {
             iljQueryUtil::initjQuery();
             iljQueryUtil::initjQueryUI();
             $this->tpl->addJavaScript('./node_modules/@andxor/jquery-ui-touch-punch-fix/jquery.ui.touch-punch.js');
         }
         $this->tpl->addJavascript("./Modules/TestQuestionPool/templates/default/orderinghorizontal.js");
         return $questionoutput;
     }

Here is the call graph for this function:

◆ getSolutionOutput()

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

Definition at line 131 of file class.assOrderingHorizontalGUI.php.

References renderSolutionOutput().

      : string {
 
         $user_solutions = [];
         if (($active_id > 0) && (!$show_correct_solution)) {
             $user_solutions = $this->object->getSolutionValues($active_id, $pass);
         }
 
         $show_inline_feedback = false;
         return $this->renderSolutionOutput(
             $user_solutions,
             $active_id,
             $pass,
             $graphicalOutput,
             $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()

assOrderingHorizontalGUI::getSpecificFeedbackOutput ( array $userSolution )

Definition at line 385 of file class.assOrderingHorizontalGUI.php.

◆ getTestOutput()

assOrderingHorizontalGUI::getTestOutput	(	$active_id,
		$pass,
		$is_postponed = `false`,
		$use_post_solutions = `false`,
		$show_feedback = `false`
	)

Definition at line 309 of file class.assOrderingHorizontalGUI.php.

References $DIC, $id, ilSession\clear(), assQuestionGUI\getILIASPage(), iljQueryUtil\initjQuery(), iljQueryUtil\initjQueryUI(), ILIAS\Repository\object(), assQuestionGUI\outQuestionPage(), ilLegacyFormElementsUtil\prepareFormOutput(), and ilSession\set().

                                                                                                                                 : string
     // hey.
     {
         // generate the question output
         $template = new ilTemplate("tpl.il_as_qpl_orderinghorizontal_output.html", true, true, "Modules/TestQuestionPool");
         $js = <<<JS
     $().ready(function() {
         if (typeof $.fn.ilHorizontalOrderingQuestion != 'undefined') {
             $('#horizontal_{QUESTION_ID}').ilHorizontalOrderingQuestion({
                 result_value_selector: '.ilOrderingValue',
                 result_separator: '{::}'
             });
         }
     });
 JS;
         $js = str_replace('{QUESTION_ID}', $this->object->getId(), $js);
         $this->tpl->addOnLoadCode($js);
 
 
         $elements = $this->object->getRandomOrderingElements();
 
         if ($active_id) {
             $solutions = $this->object->getTestOutputSolutions($active_id, $pass);
             // hey.
             if (is_array($solutions) && count($solutions) == 1) {
                 $elements = explode("{::}", $solutions[0]['value1']);
             }
         }
         if (!is_array($solutions) || count($solutions) == 0) {
             ilSession::set('qst_ordering_horizontal_elements', $elements);
         } else {
             ilSession::clear('qst_ordering_horizontal_elements');
         }
         foreach ($elements as $id => $element) {
             $template->setCurrentBlock("element");
             $template->setVariable("ELEMENT_ID", "e_" . $this->object->getId() . "_$id");
             $template->setVariable("ORDERING_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($element));
             $template->setVariable("ELEMENT_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($element));
             $template->parseCurrentBlock();
         }
         $template->setVariable("QUESTION_ID", $this->object->getId());
         if ($this->object->getTextSize() >= 10) {
             $template->setVariable("STYLE", " style=\"font-size: " . $this->object->getTextSize() . "%;\"");
         }
         $template->setVariable("VALUE_ORDERRESULT", ' value="' . join('{::}', $elements) . '"');
         $template->setVariable("QUESTIONTEXT", $this->object->getQuestionForHTMLOutput());
         $questionoutput = $template->get();
         //if (!$show_question_only) {
         // get page object output
         $questionoutput = $this->getILIASPage($questionoutput);
         //}
         global $DIC; /* @var ILIAS\DI\Container $DIC */
         if ($DIC->http()->agent()->isMobile() || $DIC->http()->agent()->isIpad()) {
             iljQueryUtil::initjQuery();
             iljQueryUtil::initjQueryUI();
             $this->tpl->addJavaScript('./node_modules/@andxor/jquery-ui-touch-punch-fix/jquery.ui.touch-punch.js');
         }
         $this->tpl->addJavascript("./Modules/TestQuestionPool/templates/default/orderinghorizontal.js");
         $questionoutput = $template->get();
         $pageoutput = $this->outQuestionPage("", $is_postponed, $active_id, $questionoutput);
         return $pageoutput;
     }

Here is the call graph for this function:

◆ populateCorrectionsFormProperties()

assOrderingHorizontalGUI::populateCorrectionsFormProperties ( ilPropertyFormGUI $form )

Definition at line 519 of file class.assOrderingHorizontalGUI.php.

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

                                                                               : void
     {
         // points
         $points = new ilNumberInputGUI($this->lng->txt("points"), "points");
 
         $points->allowDecimals(true);
         $points->setValue($this->object->getPoints());
         $points->setRequired(true);
         $points->setSize(3);
         $points->setMinValue(0.0);
         $points->setMinvalueShouldBeGreater(true);
         $form->addItem($points);
     }

Here is the call graph for this function:

◆ populateQuestionSpecificFormPart()

assOrderingHorizontalGUI::populateQuestionSpecificFormPart ( \ilPropertyFormGUI $form )

Definition at line 411 of file class.assOrderingHorizontalGUI.php.

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

Referenced by editQuestion().

                                                                               : ilPropertyFormGUI
     {
         // ordertext
         $ordertext = new ilTextAreaInputGUI($this->lng->txt("ordertext"), "ordertext");
         $ordertext->setValue((string) self::prepareTextareaOutput($this->object->getOrderText(), false, true));
         $ordertext->setRequired(true);
         $ordertext->setInfo(sprintf($this->lng->txt("ordertext_info"), $this->object->getSeparator()));
         $ordertext->setRows(10);
         $ordertext->setCols(80);
         $form->addItem($ordertext);
         // textsize
         $textsize = new ilNumberInputGUI($this->lng->txt("textsize"), "textsize");
         $textsize->setValue($this->object->getTextSize());
         $textsize->setInfo($this->lng->txt("textsize_info"));
         $textsize->setSize(6);
         $textsize->setMinValue(10);
         $textsize->setRequired(false);
         $form->addItem($textsize);
         // points
         $points = new ilNumberInputGUI($this->lng->txt("points"), "points");
 
         $points->allowDecimals(true);
         // mbecker: Fix for mantis bug 7866: Predefined values schould make sense.
         // This implements a default value of "1" for this question type.
         if ($this->object->getPoints() == null) {
             $points->setValue("1");
         } else {
             $points->setValue($this->object->getPoints());
         }
         $points->setRequired(true);
         $points->setSize(3);
         $points->setMinValue(0.0);
         $points->setMinvalueShouldBeGreater(true);
         $form->addItem($points);
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderAggregateView()

assOrderingHorizontalGUI::renderAggregateView ( $aggregate )

Parameters

$aggregate

Returns: ilTemplate

Definition at line 481 of file class.assOrderingHorizontalGUI.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 => $line_data) {
             $tpl->setCurrentBlock('aggregaterow');
             $tpl->setVariable('COUNT', $line_data);
             $tpl->setVariable('OPTION', $key);
             $tpl->parseCurrentBlock();
         }
         return $tpl;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderSolutionOutput()

assOrderingHorizontalGUI::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 165 of file class.assOrderingHorizontalGUI.php.

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

Referenced by getSolutionOutput().

      : ?string {
         $elements = [];
         if (count($user_solutions) && strlen($user_solutions[0]['value1'])) {
             $elements = explode("{::}", $user_solutions[0]['value1']);
         }
 
         if (!count($elements)) {
             $elements = $show_correct_solution ? $this->object->getOrderingElements() : $this->object->getRandomOrderingElements();
         }
 
         $template = new ilTemplate("tpl.il_as_qpl_orderinghorizontal_output_solution.html", true, true, "Modules/TestQuestionPool");
         foreach ($elements as $id => $element) {
             $template->setCurrentBlock("element");
             $template->setVariable("ELEMENT_ID", "sol_e_" . $this->object->getId() . "_$id");
             $template->setVariable("ELEMENT_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($element));
             $template->parseCurrentBlock();
         }
 
         if (($active_id > 0) && (!$show_correct_solution)) {
             if ($this->object->getStep() === null) {
                 $reached_points = $this->object->getReachedPoints($active_id, $pass);
             } else {
                 $reached_points = $this->object->calculateReachedPoints($active_id, $pass);
             }
             if ($graphical_output) {
                 $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_NOT_OK);
                 if ($reached_points == $this->object->getMaximumPoints()) {
                     $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_OK);
                 } elseif ($reached_points > 0) {
                     $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_MOSTLY_OK);
                 }
                 $template->setCurrentBlock("icon_ok");
                 $template->setVariable("ICON_OK", $correctness_icon);
                 $template->parseCurrentBlock();
             }
         } else {
             $reached_points = $this->object->getPoints();
         }
 
         if ($result_output) {
             $resulttext = ($reached_points == 1) ? "(%s " . $this->lng->txt("point") . ")" : "(%s " . $this->lng->txt("points") . ")";
             $template->setVariable("RESULT_OUTPUT", sprintf($resulttext, $reached_points));
         }
         if ($show_question_text == true) {
             $template->setVariable("QUESTIONTEXT", $this->object->getQuestionForHTMLOutput());
         }
         //              $template->setVariable("SOLUTION_TEXT", ilUtil::prepareFormOutput($solutionvalue));
         if ($this->object->getTextSize() >= 10) {
             $template->setVariable("STYLE", " style=\"font-size: " . $this->object->getTextSize() . "%;\"");
         }
 
         $questionoutput = $template->get();
         $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", true, true, "Modules/TestQuestionPool");
         $solutiontemplate->setVariable("SOLUTION_OUTPUT", $questionoutput);
 
 
         $feedback = '';
         if ($show_feedback) {
             if (!$this->isTestPresentationContext()) {
                 $fb = $this->getGenericFeedbackOutput((int) $active_id, $pass);
                 $feedback .= strlen($fb) ? $fb : '';
             }
         }
         if (strlen($feedback)) {
             $cssClass = (
                 $this->hasCorrectSolution($active_id, $pass) ?
                 ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_CORRECT : ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_WRONG
             );
 
             $solutiontemplate->setVariable("ILC_FB_CSS_CLASS", $cssClass);
             $solutiontemplate->setVariable("FEEDBACK", ilLegacyFormElementsUtil::prepareTextareaOutput($feedback, true));
         }
         $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:

◆ saveCorrectionsFormProperties()

assOrderingHorizontalGUI::saveCorrectionsFormProperties ( ilPropertyFormGUI $form )

Parameters

ilPropertyFormGUI $form

Definition at line 536 of file class.assOrderingHorizontalGUI.php.

References ilPropertyFormGUI\getInput().

                                                                           : void
     {
         $this->object->setPoints((float) str_replace(',', '.', $form->getInput('points')));
     }

Here is the call graph for this function:

◆ writePostData()

assOrderingHorizontalGUI::writePostData ( bool $always = false )

protected

{}

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

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

                                                           : int
     {
         $hasErrors = (!$always) ? $this->editQuestion(true) : false;
         if (!$hasErrors) {
             $this->writeQuestionGenericPostData();
             $this->writeQuestionSpecificPostData(new ilPropertyFormGUI());
             $this->saveTaxonomyAssignments();
             return 0;
         }
         return 1;
     }

Here is the call graph for this function:

◆ writeQuestionSpecificPostData()

assOrderingHorizontalGUI::writeQuestionSpecificPostData ( ilPropertyFormGUI $form )

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

Implements ilGuiQuestionScoringAdjustable.

Definition at line 390 of file class.assOrderingHorizontalGUI.php.

Referenced by writePostData().

                                                                           : void
     {
         $this->object->setTextSize((float) str_replace(',', '.', $this->request->raw('textsize') ?? '0.0'));
         $this->object->setOrderText($this->request->raw('ordertext'));
         $this->object->setPoints((float) str_replace(',', '.', $this->request->raw('points')));
     }

Here is the caller graph for this function:

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

Modules/TestQuestionPool/classes/class.assOrderingHorizontalGUI.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ aggregateAnswers()

◆ editQuestion()

◆ getAfterParticipationSuppressionQuestionPostVars()

◆ getAggregatedAnswersView()

◆ getAnswersFrequency()

◆ getCommand()

◆ getPresentationJavascripts()

◆ getPreview()

◆ getSolutionOutput()

◆ getSpecificFeedbackOutput()

◆ getTestOutput()

◆ populateCorrectionsFormProperties()

◆ populateQuestionSpecificFormPart()

◆ renderAggregateView()

◆ renderSolutionOutput()

◆ saveCorrectionsFormProperties()

◆ writePostData()

◆ writeQuestionSpecificPostData()