assLongMenuGUI Class Reference

Inheritance diagram for assLongMenuGUI:

Collaboration diagram for assLongMenuGUI:

Public Member Functions
	__construct ($id=-1)
	getCommand ($cmd)
	writeQuestionSpecificPostData (ilPropertyFormGUI $form)
	Extracts the question specific values from $_POST and applies them to the data object. More...
	populateQuestionSpecificFormPart (ilPropertyFormGUI $form)
	populateAnswerSpecificFormPart (ilPropertyFormGUI $form)
	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, $is_postponed=false, $use_post_solutions=false, $show_feedback=false)
	getSpecificFeedbackOutput (array $userSolution)
	Returns the answer specific feedback for the question. 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...
	getLongMenuTextWithInputFieldsInsteadOfGaps ($user_solution=array(), $solution=false, $graphical=false)
	getSubQuestionsIndex ()
	getAnswersFrequency ($relevantAnswers, $questionIndex)
	getAnswerFrequencyTableGUI ($parentGui, $parentCmd, $relevantAnswers, $questionIndex)
	populateCorrectionsFormProperties (ilPropertyFormGUI $form)
	saveCorrectionsFormProperties (ilPropertyFormGUI $form)
Public Member Functions inherited from assQuestionGUI
	hasInlineFeedback ()
	addHeaderAction ()
	redrawHeaderAction ()
	getHeaderAction ()
	getNotesHTML ()
	executeCommand ()
	getType ()
	needed for page editor compliance More...
	getPresentationContext ()
	setPresentationContext (string $presentationContext)
	isTestPresentationContext ()
	isPreviousSolutionPrefilled ()
	setPreviousSolutionPrefilled (bool $previousSolutionPrefilled)
	getRenderPurpose ()
	setRenderPurpose (string $renderPurpose)
	isRenderPurposePrintPdf ()
	isRenderPurposePreview ()
	isRenderPurposeInputValue ()
	isRenderPurposePlayback ()
	isRenderPurposeDemoplay ()
	renderPurposeSupportsFormHtml ()
	getEditContext ()
	setEditContext (string $editContext)
	isAuthoringEditContext ()
	isAdjustmentEditContext ()
	setAdjustmentEditContext ()
	getNavigationGUI ()
	setNavigationGUI (?ilTestQuestionNavigationGUI $navigationGUI)
	setTaxonomyIds (array $taxonomyIds)
	getTaxonomyIds ()
	setTargetGui ($linkTargetGui)
	setTargetGuiClass ($targetGuiClass)
	getTargetGuiClass ()
	setQuestionHeaderBlockBuilder (\ilQuestionHeaderBlockBuilder $questionHeaderBlockBuilder)
	getQuestionHeaderBlockBuilder ()
	setQuestionActionCmd (string $questionActionCmd)
	getQuestionActionCmd ()
	assessment ()
	populateJavascriptFilesRequiredForWorkForm (ilGlobalTemplateInterface $tpl)
	getPresentationJavascripts ()
	getQuestionTemplate ()
	getILIASPage (string $html="")
	Returns the ILIAS Page around a question. More...
	outQuestionPage ($a_temp_var, $a_postponed=false, $active_id="", $html="", $inlineFeedbackEnabled=false)
	cancel ()
	originalSyncForm (string $return_to="", string $return_to_feedback='')
	sync ()
	cancelSync ()
	saveEdit ()
	save ()
	saveReturn ()
	apply ()
	getContextPath ($cont_obj, int $a_endnode_id, int $a_startnode_id=1)
	get context path in content object tree More...
	setSequenceNumber (int $nr)
	getSequenceNumber ()
	setQuestionCount (int $a_question_count)
	getQuestionCount ()
	getErrorMessage ()
	setErrorMessage (string $errormessage)
	addErrorMessage (string $errormessage)
	outAdditionalOutput ()
	Why are you here? Some magic for plugins? More...
	getQuestionType ()
	getAsValueAttribute (string $a_value)
	addNewIdListener ($a_object, string $a_method, string $a_parameters="")
	Add a listener that is notified with the new question ID, when a new question is saved. More...
	callNewIdListeners (int $a_new_id)
	addQuestionFormCommandButtons (ilPropertyFormGUI $form)
	addBasicQuestionFormProperties (ilPropertyFormGUI $form)
	getGenericFeedbackOutput (int $active_id, ?int $pass)
	getGenericFeedbackOutputForCorrectSolution ()
	getGenericFeedbackOutputForIncorrectSolution ()
	getSpecificFeedbackOutput (array $userSolution)
	Returns the answer specific feedback for the question. More...
	outQuestionType ()
	suggestedsolution ()
	outSolutionExplorer ()
	saveSuggestedSolutionType ()
	cancelExplorer ()
	outPageSelector ()
	outChapterSelector ()
	outGlossarySelector ()
	linkChilds ()
	addPG ()
	addST ()
	addGIT ()
	isSaveCommand ()
	setQuestionTabs ()
	addTab_SuggestedSolution (ilTabsGUI $tabs, string $classname)
	getEditQuestionTabCommands ()
	getSolutionOutput ( $active_id, $pass=null, $graphicalOutput=false, $result_output=false, $show_question_only=true, $show_feedback=false, $show_correct_solution=false, $show_manual_scoring=false, $show_question_text=true)
	isAutosaveable ()
	getPreview ($show_question_only=false, $showInlineFeedback=false)
	outQuestionForTest (string $formaction, int $active_id, ?int $pass, bool $is_question_postponed=false, $user_post_solutions=false, bool $show_specific_inline_feedback=false)
	magicAfterTestOutput ()
	getTestOutput ( $active_id, $pass, $is_question_postponed, $user_post_solutions, $show_specific_inline_feedback)
	getFormEncodingType ()
	setPreviewSession (ilAssQuestionPreviewSession $previewSession)
	getPreviewSession ()
	showHints ()
	buildFocusAnchorHtml ()
	isAnswerFrequencyStatisticSupported ()
	getSubQuestionsIndex ()
	getAnswersFrequency ($relevantAnswers, $questionIndex)
	getAnswerFrequencyTableGUI ($parentGui, $parentCmd, $relevantAnswers, $questionIndex)
	prepareReprintableCorrectionsForm (ilPropertyFormGUI $form)
	populateCorrectionsFormProperties (ilPropertyFormGUI $form)
	saveCorrectionsFormProperties (ilPropertyFormGUI $form)
	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 (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...

Protected Member Functions
	getUserSolution ($active_id, $pass)
	writePostData (bool $always=false)
	{Evaluates a posted edit form and writes the form data in the question object. Returns integer A positive value, if one of the required fields wasn't set, else 0 } More...
	editQuestion (ilPropertyFormGUI $form=null)
	buildEditForm ()
	getTemplateForPreviewAndTest (array $user_solution)
Protected Member Functions inherited from assQuestionGUI
	hasSpecialQuestionCommands ()
	writePostData (bool $always=false)
	Evaluates a posted edit form and writes the form data in the question object. More...
	renderEditForm (ilPropertyFormGUI $form)
	getUseUnchangedAnswerCheckboxHtml ()
	getPreviousSolutionProvidedMessage ()
	getPreviousSolutionConfirmationCheckboxHtml ()
	addNumberOfTriesToFormIfNecessary (ilPropertyFormGUI $form)
	saveTaxonomyAssignments ()
	populateTaxonomyFormSection (ilPropertyFormGUI $form)
	genericFeedbackOutputBuilder (string $feedback_correct, string $feedback_incorrect, int $active_id, ?int $pass)
	setDefaultTabs (ilTabsGUI $ilTabs)
	setQuestionSpecificTabs (ilTabsGUI $ilTabs)
	getBasicEditQuestionTabCommands ()
	getAdditionalEditQuestionCommands ()
	addTab_QuestionFeedback (ilTabsGUI $tabs)
	addTab_QuestionHints (ilTabsGUI $tabs)
	addTab_Question (ilTabsGUI $tabsGUI)
	hasCorrectSolution ($activeId, $passIndex)
	writeQuestionGenericPostData ()
	completeTestOutputFormAction ($formAction, $active_id, $pass)
	addBackTab (ilTabsGUI $ilTabs)
	buildBasicEditFormObject ()
	escapeTemplatePlaceholders (string $text)
	buildEditForm ()
	generateCorrectnessIconsForCorrectness (int $correctness)
	cleanupAnswerText (array $answer_text, bool $is_rte)
	sk - 12.05.2023: This is one more of those that we need, but don't want. More...
	addSaveOnEnterOnLoadCode ()

Private Member Functions
	verifyAnswerOptions ()
	stripSlashesRecursive (array $data)
	trimArrayRecursive (array $data)
	getTextGapTemplate ($key, $value, $solution, $ok=false, $graphical=false)
	getSelectGapTemplate ($key, $answers, $user_value, $solution, $ok=false, $graphical=false)

Private Attributes
	$ilTabs

Additional Inherited Members
Static Public Member Functions inherited from assQuestionGUI
static	_getQuestionGUI (string $question_type='', int $question_id=-1)
	Creates a question gui representation and returns the alias to the question gui. More...
static	_getGUIClassNameForId ($a_q_id)
static	_getClassNameForQType ($q_type)
static	getCommandsFromClassConstants (string $guiClassName, string $cmdConstantNameBegin='CMD_')
static	prepareTextareaOutput ($txt_output, $prepare_for_latex_output=false, $omitNl2BrWhenTextArea=false)
	Prepares a string for a text area output where latex code may be in it If the text is HTML-free, CHR(13) will be converted to a line break. More...
Data Fields inherited from assQuestionGUI
const	FORM_MODE_EDIT = 'edit'
const	FORM_MODE_ADJUST = 'adjust'
const	FORM_ENCODING_URLENCODE = 'application/x-www-form-urlencoded'
const	FORM_ENCODING_MULTIPART = 'multipart/form-data'
const	CORRECTNESS_NOT_OK = 0
const	CORRECTNESS_MOSTLY_OK = 1
const	CORRECTNESS_OK = 2
const	ALLOWED_PLAIN_TEXT_TAGS = "<em>, <strong>"
	sk - 12.05.2023: This const is also used in ilKprimChoiceWizardInputGUI. More...
const	SESSION_PREVIEW_DATA_BASE_INDEX = 'ilAssQuestionPreviewAnswers'
assQuestion	$object
ilGlobalPageTemplate	$tpl
ilLanguage	$lng
	$error
string	$errormessage
int	$sequence_no
	sequence number in test More...
int	$question_count
	question count in test More...
const	PRESENTATION_CONTEXT_TEST = 'pContextTest'
const	PRESENTATION_CONTEXT_RESULTS = 'pContextResults'
const	RENDER_PURPOSE_PLAYBACK = 'renderPurposePlayback'
const	RENDER_PURPOSE_DEMOPLAY = 'renderPurposeDemoplay'
const	RENDER_PURPOSE_PREVIEW = 'renderPurposePreview'
const	RENDER_PURPOSE_PRINT_PDF = 'renderPurposePrintPdf'
const	RENDER_PURPOSE_INPUT_VALUE = 'renderPurposeInputValue'
const	EDIT_CONTEXT_AUTHORING = 'authoring'
const	EDIT_CONTEXT_ADJUSTMENT = 'adjustment'
Protected Attributes inherited from assQuestionGUI
const	SUGGESTED_SOLUTION_COMMANDS
const	HAS_SPECIAL_QUESTION_COMMANDS = false
ILIAS Notes GUIService	$notes_gui
ilCtrl	$ctrl
ilPropertyFormGUI	$editForm
ILIAS TestQuestionPool InternalRequestService	$request

Detailed Description

Definition at line 28 of file class.assLongMenuGUI.php.

Constructor & Destructor Documentation

__construct()

assLongMenuGUI::__construct

(

$id = -1

)

Definition at line 32 of file class.assLongMenuGUI.php.

    {
        parent::__construct();
        include_once './Modules/TestQuestionPool/classes/class.assLongMenu.php';
        $this->object = new assLongMenu();
        if ($id >= 0) {
            $this->object->loadFromDb($id);
        }
        global $DIC;
        $ilTabs = $DIC['ilTabs'];
        $lng = $DIC['lng'];
        $this->ilTabs = $ilTabs;
        $this->lng = $lng;
    }

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

Here is the call graph for this function:

Member Function Documentation

buildEditForm()

assLongMenuGUI::buildEditForm ( )

protected

Returns

ilPropertyFormGUI

Reimplemented from assQuestionGUI.

Definition at line 171 of file class.assLongMenuGUI.php.

                                      : ilPropertyFormGUI
    {
        $form = $this->buildBasicEditFormObject();
 
        $this->addQuestionFormCommandButtons($form);
 
        $this->addBasicQuestionFormProperties($form);
 
        $this->populateQuestionSpecificFormPart($form);
        //$this->populateAnswerSpecificFormPart($form);
 
        $this->populateTaxonomyFormSection($form);
 
        return $form;
    }

References assQuestionGUI\addBasicQuestionFormProperties(), assQuestionGUI\addQuestionFormCommandButtons(), assQuestionGUI\buildBasicEditFormObject(), populateQuestionSpecificFormPart(), and assQuestionGUI\populateTaxonomyFormSection().

Referenced by editQuestion(), and writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

editQuestion()

assLongMenuGUI::editQuestion ( ilPropertyFormGUI  $form = null )

protected

Definition at line 158 of file class.assLongMenuGUI.php.

                                                                   : void
    {
        if ($form === null) {
            $form = $this->buildEditForm();
        }
 
        $this->getQuestionTemplate();
 
        $this->tpl->setVariable("QUESTION_DATA", $this->ctrl->getHTML($form));
    }

References buildEditForm(), ILIAS\Repository\ctrl(), and assQuestionGUI\getQuestionTemplate().

Referenced by writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

getAfterParticipationSuppressionQuestionPostVars()

assLongMenuGUI::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 476 of file class.assLongMenuGUI.php.

                                                                      : array
    {
        return array();
    }

getAggregatedAnswersView()

assLongMenuGUI::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 487 of file class.assLongMenuGUI.php.

                                                                     : string
    {
        $overview = array();
        $aggregation = array();
        foreach ($relevant_answers as $answer) {
            $overview[$answer['active_fi']][$answer['pass']][$answer['value1']] = $answer['value2'];
        }
 
        foreach ($overview as $active) {
            foreach ($active as $answer) {
                foreach ($answer as $option => $value) {
                    $aggregation[$option][$value] = $aggregation[$option][$value] + 1;
                }
            }
        }
        $tpl = new ilTemplate('tpl.il_as_aggregated_longmenu_question_answers_table.html', true, true, "Modules/TestQuestionPool");
        $json = json_decode($this->object->getJsonStructure());
        foreach ($json as $key => $value) {
            $tpl->setVariable('TITLE', 'Longmenu ' . ($key + 1));
            if (array_key_exists($key, $aggregation)) {
                $aggregate = $aggregation[$key];
                foreach ($aggregate as $answer => $counts) {
                    $tpl->setVariable('OPTION', $answer);
                    $tpl->setVariable('COUNT', $counts);
                    $tpl->parseCurrentBlock();
                }
            }
        }
 
        return $tpl->get();
    }

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

Here is the call graph for this function:

getAnswerFrequencyTableGUI()

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

Reimplemented from assQuestionGUI.

Definition at line 643 of file class.assLongMenuGUI.php.

                                                                                                        : ilAnswerFrequencyStatisticTableGUI
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */
 
        $table = parent::getAnswerFrequencyTableGUI(
            $parentGui,
            $parentCmd,
            $relevantAnswers,
            $questionIndex
        );
 
        $table->setTitle(
            sprintf(
                $DIC->language()->txt('tst_corrections_answers_tbl_subindex'),
                $DIC->language()->txt('longmenu') . ' ' . ($questionIndex + 1)
            )
        );
 
        return $table;
    }

References $DIC.

getAnswersFrequency()

assLongMenuGUI::getAnswersFrequency	(		$relevantAnswers,
			$questionIndex
	)

Reimplemented from assQuestionGUI.

Definition at line 620 of file class.assLongMenuGUI.php.

                                                                         : array
    {
        $answers = [];
 
        foreach ($relevantAnswers as $row) {
            if ($row['value1'] != $questionIndex) {
                continue;
            }
 
            if (!isset($answers[$row['value2']])) {
                //$label = $this->getAnswerTextLabel($row['value1'], $row['value2']);
 
                $answers[$row['value2']] = array(
                    'answer' => $row['value2'], 'frequency' => 0
                );
            }
 
            $answers[$row['value2']]['frequency']++;
        }
 
        return $answers;
    }

getCommand()

assLongMenuGUI::getCommand

(

$cmd

)

Definition at line 66 of file class.assLongMenuGUI.php.

    {
        return $cmd;
    }

getLongMenuTextWithInputFieldsInsteadOfGaps()

assLongMenuGUI::getLongMenuTextWithInputFieldsInsteadOfGaps	(		$user_solution = array(),
			$solution = false,
			$graphical = false
	)

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

                                                                                                                                : string
    {
        $return_value = '';
        $text_array = preg_split("/\\[" . assLongMenu::GAP_PLACEHOLDER . " (\\d+)\\]/", $this->object->getLongMenuTextValue());
        $correct_answers = $this->object->getCorrectAnswers();
        $answers = $this->object->getAnswers();
        foreach ($text_array as $key => $value) {
            $answer_is_correct = false;
            $user_value = '';
            $return_value .= $this->object->prepareTextareaOutput($value, true);
            if ($key < sizeof($text_array) - 1) {
                if (!array_key_exists($key, $correct_answers)) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('longmenu_answeroptions_differ'));
                    continue;
                }
                if ($correct_answers[$key][2] == assLongMenu::ANSWER_TYPE_TEXT_VAL) {
                    if (array_key_exists($key, $user_solution)) {
                        $user_value = $user_solution[$key];
                        if (in_array($user_value, $correct_answers[$key][0])) {
                            $answer_is_correct = true;
                        }
                    }
 
                    $return_value .= $this->getTextGapTemplate($key, $user_value, $solution, $answer_is_correct, $graphical);
                } elseif ($correct_answers[$key][2] == assLongMenu::ANSWER_TYPE_SELECT_VAL) {
                    if (array_key_exists($key, $user_solution)) {
                        $user_value = $user_solution[$key];
                        if (in_array($user_value, $correct_answers[$key][0])) {
                            $answer_is_correct = true;
                        }
                    }
                    $return_value .= $this->getSelectGapTemplate($key, $answers[$key], $user_value, $solution, $answer_is_correct, $graphical);
                }
            }
        }
        return $return_value;
    }

References ILIAS\LTI\ToolProvider\$key, assLongMenu\ANSWER_TYPE_SELECT_VAL, assLongMenu\ANSWER_TYPE_TEXT_VAL, assLongMenu\GAP_PLACEHOLDER, ILIAS\Repository\lng(), and ILIAS\Repository\object().

Here is the call graph for this function:

getPreview()

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

Reimplemented from assQuestionGUI.

Definition at line 389 of file class.assLongMenuGUI.php.

                                                                                        : string
    {
        $user_solution = is_object($this->getPreviewSession()) ? (array) $this->getPreviewSession()->getParticipantsSolution() : array();
        $user_solution = array_values($user_solution);
 
        $template = $this->getTemplateForPreviewAndTest($user_solution);
 
        $question_output = $template->get();
        if (!$show_question_only) {
            $question_output = $this->getILIASPage($question_output);
        }
        return $question_output;
    }

getSelectGapTemplate()

assLongMenuGUI::getSelectGapTemplate (   $key,   $answers,   $user_value,   $solution,   $ok = false,   $graphical = false  )

private

Definition at line 580 of file class.assLongMenuGUI.php.

                                                                                                                  : string
    {
        $tpl = new ilTemplate("tpl.il_as_qpl_longmenu_question_select_gap.html", true, true, "Modules/TestQuestionPool");
        $tpl->setVariable('KEY', $key);
        if ($solution) {
            $tpl->setVariable('DISABLED', 'disabled');
            $tpl->setVariable('JS_IGNORE', '_ignore');
            $tpl->setCurrentBlock('best_solution');
            if ($user_value == -1) {
                $tpl->setVariable("SOLUTION", $this->lng->txt("please_select"));
            } else {
                $tpl->setVariable('SOLUTION', $user_value);
            }
            if ($graphical) {
                $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_NOT_OK);
                if ($ok) {
                    $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_OK);
                }
                $tpl->setVariable("ICON_OK", $correctness_icon);
            }
            $tpl->parseCurrentBlock();
        } else {
            $tpl->setVariable("PLEASE_SELECT", $this->lng->txt("please_select"));
            foreach ($answers as $value) {
                $tpl->setCurrentBlock('select_option');
                $tpl->setVariable('VALUE', $value);
                if ($value == $user_value) {
                    $tpl->setVariable('SELECTED', 'selected');
                }
                $tpl->parseCurrentBlock();
            }
        }
        return $tpl->get();
    }

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

Here is the call graph for this function:

getSolutionOutput()

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

Reimplemented from assQuestionGUI.

Definition at line 334 of file class.assLongMenuGUI.php.

     : string {
        $template = new ilTemplate("tpl.il_as_qpl_longmenu_question_output_solution.html", true, true, "Modules/TestQuestionPool");
 
        if ($show_question_text) {
            $template->setVariable("QUESTIONTEXT", $this->object->getQuestionForHTMLOutput());
        }
        if (($active_id > 0) && (!$show_correct_solution)) {
            $correct_solution = $this->getUserSolution($active_id, $pass);
        } else {
            $correct_solution = $this->object->getCorrectAnswersForQuestionSolution($this->object->getId());
        }
        $template->setVariable('LONGMENU_TEXT_SOLUTION', $this->getLongMenuTextWithInputFieldsInsteadOfGaps($correct_solution, true, $graphicalOutput));
        $solution_template = new ilTemplate("tpl.il_as_tst_solution_output.html", true, true, "Modules/TestQuestionPool");
        $question_output = $template->get();
        $feedback = '';
        if ($show_feedback) {
            if (!$this->isTestPresentationContext()) {
                $fb = $this->getGenericFeedbackOutput((int) $active_id, $pass);
                $feedback .= strlen($fb) ? $fb : '';
            }
 
            $fb = $this->getSpecificFeedbackOutput(array());
            $feedback .= strlen($fb) ? $fb : '';
        }
        if (strlen($feedback)) {
            $cssClass = (
                $this->hasCorrectSolution($active_id, $pass) ?
                ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_CORRECT : ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_WRONG
            );
 
            $solution_template->setVariable("ILC_FB_CSS_CLASS", $cssClass);
            $solution_template->setVariable("FEEDBACK", $this->object->prepareTextareaOutput($feedback, true));
        }
 
        $solution_template->setVariable("SOLUTION_OUTPUT", $question_output);
 
        $solution_output = $solution_template->get();
 
        if (!$show_question_only) {
            $solution_output = $this->getILIASPage($solution_output);
        }
 
        return $solution_output;
    }

References ILIAS\Repository\object(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

getSpecificFeedbackOutput()

assLongMenuGUI::getSpecificFeedbackOutput

(

array

$userSolution

)

Returns the answer specific feedback for the question.

Parameters

array

$userSolution

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

Reimplemented from assQuestionGUI.

Definition at line 441 of file class.assLongMenuGUI.php.

                                                                  : string
    {
        if (!$this->object->feedbackOBJ->specificAnswerFeedbackExists()) {
            return '';
        }
 
        $feedback = '<table class="test_specific_feedback"><tbody>';
        $gaps = $this->object->getCorrectAnswers();
        foreach ($gaps as $index => $answer) {
            $caption = assLongMenu::GAP_PLACEHOLDER . ' ';
            $caption .= $index + 1 . ': ';
 
            $feedback .= '<tr><td>';
 
            $feedback .= $caption . '</td><td>';
            $feedback .= $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
                $this->object->getId(),
                0,
                $index
            ) . '</td> </tr>';
        }
        $feedback .= '</tbody></table>';
        return $this->object->prepareTextareaOutput($feedback, true);
    }

References $index, assLongMenu\GAP_PLACEHOLDER, and ILIAS\Repository\object().

Here is the call graph for this function:

getSubQuestionsIndex()

assLongMenuGUI::getSubQuestionsIndex

(

)

Reimplemented from assQuestionGUI.

Definition at line 615 of file class.assLongMenuGUI.php.

                                          : array
    {
        return array_keys($this->object->getAnswers());
    }

References ILIAS\Repository\object().

Here is the call graph for this function:

getTemplateForPreviewAndTest()

assLongMenuGUI::getTemplateForPreviewAndTest ( array  $user_solution )

protected

Definition at line 427 of file class.assLongMenuGUI.php.

                                                                         : ilTemplate
    {
        $template = new ilTemplate("tpl.il_as_qpl_longmenu_question_output.html", true, true, "Modules/TestQuestionPool");
        $this->tpl->addJavaScript('./Modules/TestQuestionPool/templates/default/longMenuQuestionPlayer.js');
        $this->tpl->addOnLoadCode('il.test.player.longmenu.init('
            . $this->object->getMinAutoComplete() . ', '
            . json_encode($this->object->getAvailableAnswerOptions())
            . ')');
 
        $template->setVariable("QUESTIONTEXT", $this->object->getQuestionForHTMLOutput());
        $template->setVariable('LONGMENU_TEXT', $this->getLongMenuTextWithInputFieldsInsteadOfGaps($user_solution));
        return $template;
    }

References ILIAS\Repository\object().

Here is the call graph for this function:

getTestOutput()

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

Reimplemented from assQuestionGUI.

Definition at line 403 of file class.assLongMenuGUI.php.

     : string {
        $user_solution = array();
        if ($active_id) {
            $solutions = $this->object->getUserSolutionPreferingIntermediate($active_id, $pass);
            foreach ($solutions as $idx => $solution_value) {
                $user_solution[$solution_value["value1"]] = $solution_value["value2"];
            }
        }
 
        $template = $this->getTemplateForPreviewAndTest($user_solution);
 
        $question_output = $template->get();
        $page_output = $this->outQuestionPage("", $is_postponed, $active_id, $question_output);
        return $page_output;
    }

getTextGapTemplate()

assLongMenuGUI::getTextGapTemplate (   $key,   $value,   $solution,   $ok = false,   $graphical = false  )

private

Definition at line 557 of file class.assLongMenuGUI.php.

                                                                                                 : string
    {
        $tpl = new ilTemplate("tpl.il_as_qpl_longmenu_question_text_gap.html", true, true, "Modules/TestQuestionPool");
        if ($solution) {
            $tpl->setVariable('DISABLED', 'disabled');
            $tpl->setVariable('JS_IGNORE', '_ignore');
            if ($graphical) {
                $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_NOT_OK);
                if ($ok) {
                    $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_OK);
                }
                $tpl->setVariable("ICON_OK", $correctness_icon);
            }
        }
        if ($solution) {
            $tpl->setVariable('SIZE', 'size="' . mb_strlen($value) . '"');
        }
        $tpl->setVariable('VALUE', $value);
        $tpl->setVariable('KEY', $key);
 
        return $tpl->get();
    }

References ILIAS\LTI\ToolProvider\$key, and $tpl.

getUserSolution()

assLongMenuGUI::getUserSolution (   $active_id,   $pass  )

protected

Parameters

$active_id
$pass

Returns

array

Definition at line 52 of file class.assLongMenuGUI.php.

                                                         : array
    {
        $user_solution = array();
        if ($active_id) {
            $solutions = $this->object->getSolutionValues($active_id, $pass, true);
            // hey.
            foreach ($solutions as $idx => $solution_value) {
                $user_solution[$solution_value["value1"]] = $solution_value["value2"];
            }
            return $user_solution;
        }
        return $user_solution;
    }

populateAnswerSpecificFormPart()

assLongMenuGUI::populateAnswerSpecificFormPart

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

Returns

ilPropertyFormGUI

Definition at line 317 of file class.assLongMenuGUI.php.

                                                                           : ilPropertyFormGUI
    {
        return $form;
    }

populateCorrectionsFormProperties()

assLongMenuGUI::populateCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Reimplemented from assQuestionGUI.

Definition at line 664 of file class.assLongMenuGUI.php.

                                                                              : void
    {
        $correctAnswers = $this->object->getCorrectAnswers();
 
        foreach ($this->object->getAnswers() as $lmIndex => $lm) {
            $lmValues = array(
                'answers_all' => array(0 => $lm),
                'answers_all_count' => count($lm),
                'answers_correct' => $correctAnswers[$lmIndex][0]
            );
 
            $lmPoints = $correctAnswers[$lmIndex][1];
 
            $section = new ilFormSectionHeaderGUI();
            $section->setTitle($this->lng->txt('longmenu') . ' ' . ($lmIndex + 1));
            $form->addItem($section);
 
            $lmInput = new ilAssLongmenuCorrectionsInputGUI(
                $this->lng->txt('answers'),
                'longmenu_' . $lmIndex
            );
 
            $lmInput->setRequired(true);
 
            $lmInput->setValues($lmValues);
 
            $form->addItem($lmInput);
 
            $pointsInp = new ilNumberInputGUI($this->lng->txt("points"), 'points_' . $lmIndex);
            $pointsInp->setRequired(true);
            $pointsInp->allowDecimals(true);
            $pointsInp->setSize(4);
            $pointsInp->setMinValue(0);
            $pointsInp->setMinvalueShouldBeGreater(false);
            $pointsInp->setValue($lmPoints);
            $form->addItem($pointsInp);
        }
    }

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

Here is the call graph for this function:

populateQuestionSpecificFormPart()

assLongMenuGUI::populateQuestionSpecificFormPart

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

Returns

ilPropertyFormGUI

Implements ilGuiQuestionScoringAdjustable.

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

                                                                             : ilPropertyFormGUI
    {
        $long_menu_text = new ilTextAreaInputGUI($this->lng->txt("longmenu_text"), 'longmenu_text');
        $long_menu_text->setRequired(true);
        //$long_menu_text->setInfo($this->lng->txt("longmenu_hint"));
        $long_menu_text->setRows(10);
        $long_menu_text->setCols(80);
        if (!$this->object->getSelfAssessmentEditingMode()) {
            if ($this->object->getAdditionalContentEditingMode() == assQuestion::ADDITIONAL_CONTENT_EDITING_MODE_RTE) {
                include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
                $long_menu_text->setRteTags(ilObjAdvancedEditing::_getUsedHTMLTags("assessment"));
                $long_menu_text->addPlugin("latex");
                $long_menu_text->addButton("latex");
                $long_menu_text->addButton("pastelatex");
                $long_menu_text->setRTESupport($this->object->getId(), "qpl", "assessment");
                $long_menu_text->setUseRte(true);
            }
        } else {
            require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssSelfAssessmentQuestionFormatter.php';
            $long_menu_text->setRteTags(ilAssSelfAssessmentQuestionFormatter::getSelfAssessmentTags());
            $long_menu_text->setUseTagsForRteOnly(false);
        }
 
        $long_menu_text->setValue($this->object->getLongMenuTextValue());
        $form->addItem($long_menu_text);
 
        $tpl = new ilTemplate("tpl.il_as_qpl_longmenu_question_gap_button_code.html", true, true, "Modules/TestQuestionPool");
        $tpl->setVariable('INSERT_GAP', $this->lng->txt('insert_gap'));
        $tpl->parseCurrentBlock();
        $button = new ilCustomInputGUI(' ', '');
        $button->setHtml($tpl->get());
        $form->addItem($button);
 
        $modal = ilModalGUI::getInstance();
        $modal->setHeading('');
        $modal->setId("ilGapModal");
        //$modal->setBackdrop(ilModalGUI::BACKDROP_OFF);
        $modal->setBody('');
 
        $min_auto_complete = new ilNumberInputGUI($this->lng->txt("min_auto_complete"), 'min_auto_complete');
 
        $auto_complete = $this->object->getMinAutoComplete();
        if ($auto_complete == 0) {
            $auto_complete = assLongMenu::MIN_LENGTH_AUTOCOMPLETE;
        }
        $min_auto_complete->setValue($auto_complete);
        $min_auto_complete->setMinValue(1);
        $min_auto_complete->setMaxValue(99);
        $min_auto_complete->setSize(5);
        $form->addItem($min_auto_complete);
        // identical scoring
        $identical_scoring = new ilCheckboxInputGUI($this->lng->txt("identical_scoring"), "identical_scoring");
        $identical_scoring->setValue(1);
        $identical_scoring->setChecked($this->object->getIdenticalScoring());
        $identical_scoring->setInfo($this->lng->txt('identical_scoring_desc'));
        $identical_scoring->setRequired(false);
        $form->addItem($identical_scoring);
        $hidden_text = new ilHiddenInputGUI('hidden_text_files');
        $form->addItem($hidden_text);
 
        $hidden_correct = new ilHiddenInputGUI('hidden_correct_answers');
        $form->addItem($hidden_correct);
 
        $long_menu_language = [
            'edit' => '[' . $this->lng->txt('edit') . ']',
            'type' => $this->lng->txt('type'),
            'answers' => $this->lng->txt('answers'),
            'answer_options' => $this->lng->txt('answer_options'),
            'correct_answers' => $this->lng->txt('correct_answers'),
            'add_answers' => '[' . $this->lng->txt('add_answers') . ']',
            'manual_editing' => $this->lng->txt('manual_editing')
        ];
 
        $question_parts = [
            'list' => json_decode($this->object->getJsonStructure()),
            'gap_placeholder' => assLongMenu::GAP_PLACEHOLDER,
            'last_updated_element' => 0,
            'replacement_word' => '',
            'filereader_usable' => false,
            'max_input_fields' => assLongMenu::MAX_INPUT_FIELDS
        ];
        $answers = $this->object->getAnswersObject();
 
        if ($this->request->isset('hidden_text_files')) {
            $question_parts['list'] = json_decode($this->request->raw('hidden_correct_answers'));
            $answers = $this->request->raw('hidden_text_files');
        }
 
        $this->tpl->addJavaScript('./Modules/TestQuestionPool/templates/default/longMenuQuestionGapBuilder.js');
        $this->tpl->addJavaScript('./Modules/TestQuestionPool/templates/default/longMenuQuestion.js');
        $tpl = new ilTemplate("tpl.il_as_qpl_longmenu_question_gap.html", true, true, "Modules/TestQuestionPool");
        $tpl->setVariable('MAX_INPUT_FIELDS', assLongMenu::MAX_INPUT_FIELDS);
        $tpl->setVariable('GAP_PLACEHOLDER', assLongMenu::GAP_PLACEHOLDER);
        $tpl->setVariable('SELECT_BOX', $this->lng->txt('insert_gap'));
        $tpl->setVariable("SELECT", $this->lng->txt('answers_select'));
        $tpl->setVariable("TEXT", $this->lng->txt('answers_text_box'));
        $tpl->setVariable("POINTS", $this->lng->txt('points'));
        $tpl->setVariable("INFO_TEXT_UPLOAD", $this->lng->txt('info_text_upload'));
        $tpl->setVariable("TXT_BROWSE", $this->lng->txt('select_file'));
        $tpl->setVariable('POINTS_ERROR', $this->lng->txt('enter_enough_positive_points'));
        $tpl->setVariable('AUTOCOMPLETE_ERROR', $this->lng->txt('autocomplete_error'));
        $tpl->setVariable('MISSING_VALUE', $this->lng->txt('msg_input_is_required'));
        $tpl->setVariable('SAVE', $this->lng->txt('save'));
        $tpl->setVariable('CANCEL', $this->lng->txt('cancel'));
        $tag_input = new ilTagInputGUI();
        $tag_input->setPostVar('taggable');
        $tag_input->setJsSelfInit(false);
        $tag_input->setTypeAheadMinLength(1);
        $tpl->setVariable("TAGGING_PROTOTYPE", $tag_input->render(''));
 
        $tpl->setVariable("MY_MODAL", $modal->getHTML());
 
        $tpl->parseCurrentBlock();
        $this->tpl->addOnLoadCode('longMenuQuestion.Init(' .
            json_encode($long_menu_language) . ', ' .
            json_encode($question_parts) . ', ' .
            $answers . ');');
        $button = new ilCustomInputGUI(' ', '');
        $button->setHtml($tpl->get());
        $form->addItem($button);
        return $form;
    }

References assQuestionGUI\$tpl, ilObjAdvancedEditing\_getUsedHTMLTags(), ilPropertyFormGUI\addItem(), assQuestion\ADDITIONAL_CONTENT_EDITING_MODE_RTE, assLongMenu\GAP_PLACEHOLDER, ilGlobalPageTemplate\get(), ilModalGUI\getInstance(), ilAssSelfAssessmentQuestionFormatter\getSelfAssessmentTags(), ILIAS\Repository\lng(), assLongMenu\MAX_INPUT_FIELDS, assLongMenu\MIN_LENGTH_AUTOCOMPLETE, ILIAS\Repository\object(), ilGlobalPageTemplate\parseCurrentBlock(), and ilGlobalPageTemplate\setVariable().

Referenced by buildEditForm().

Here is the call graph for this function:

Here is the caller graph for this function:

saveCorrectionsFormProperties()

assLongMenuGUI::saveCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

Reimplemented from assQuestionGUI.

Definition at line 706 of file class.assLongMenuGUI.php.

                                                                          : void
    {
        $correctAnswers = $this->object->getCorrectAnswers();
 
        foreach ($this->object->getAnswers() as $lmIndex => $lm) {
            $pointsInput = (float) str_replace(',', '.', $form->getInput('points_' . $lmIndex));
            $correctAnswersInput = (array) $form->getInput('longmenu_' . $lmIndex . '_tags');
 
            foreach ($correctAnswersInput as $idx => $answer) {
                if (in_array($answer, $lm)) {
                    continue;
                }
 
                unset($correctAnswersInput[$idx]);
            }
 
            $correctAnswersInput = array_values($correctAnswersInput);
 
            $correctAnswers[$lmIndex][0] = $correctAnswersInput;
            $correctAnswers[$lmIndex][1] = $pointsInput;
        }
 
        $this->object->setCorrectAnswers($correctAnswers);
    }

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

Here is the call graph for this function:

stripSlashesRecursive()

assLongMenuGUI::stripSlashesRecursive ( array  $data )

private

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

                                                       : array
    {
        return array_map(
            function ($v) {
                if (is_array($v)) {
                    return $this->stripSlashesRecursive($v);
                }
                return ilUtil::stripSlashes($v);
            },
            $data
        );
    }

References $data, ilUtil\stripSlashes(), and stripSlashesRecursive().

Referenced by stripSlashesRecursive(), verifyAnswerOptions(), and writeQuestionSpecificPostData().

Here is the call graph for this function:

Here is the caller graph for this function:

trimArrayRecursive()

assLongMenuGUI::trimArrayRecursive ( array  $data )

private

Definition at line 145 of file class.assLongMenuGUI.php.

                                                    : array
    {
        return array_map(
            function ($v) {
                if (is_array($v)) {
                    return $this->trimArrayRecursive($v);
                }
                return trim($v);
            },
            $data
        );
    }

References $data, and trimArrayRecursive().

Referenced by trimArrayRecursive(), and writeQuestionSpecificPostData().

Here is the call graph for this function:

Here is the caller graph for this function:

verifyAnswerOptions()

assLongMenuGUI::verifyAnswerOptions ( )

private

Definition at line 114 of file class.assLongMenuGUI.php.

                                          : bool
    {
        $longmenu_text = $this->request->raw('longmenu_text') ?? '';
        $hidden_text_files = $this->request->raw('hidden_text_files') ?? '';
        $answer_options_from_text = preg_split(
            "/\\[" . assLongMenu::GAP_PLACEHOLDER . " (\\d+)\\]/",
            $longmenu_text
        );
 
        $answer_options_from_files = $this->stripSlashesRecursive(json_decode($hidden_text_files));
        if (count($answer_options_from_text) - 1 !== count($answer_options_from_files)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('longmenu_answeroptions_differ'));
            return false;
        }
 
        return true;
    }

References assLongMenu\GAP_PLACEHOLDER, ILIAS\Repository\lng(), and stripSlashesRecursive().

Referenced by writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

writePostData()

assLongMenuGUI::writePostData ( bool  $always = false )

protected

{Evaluates a posted edit form and writes the form data in the question object.

Returns

integer A positive value, if one of the required fields wasn't set, else 0

}

Reimplemented from assQuestionGUI.

Definition at line 74 of file class.assLongMenuGUI.php.

                                                          : int
    {
        $form = $this->buildEditForm();
        $form->setValuesByPost();
        $check = $form->checkInput() && $this->verifyAnswerOptions();
 
        if (!$check) {
            $this->editQuestion($form);
            return 1;
        }
        $this->writeQuestionGenericPostData();
        $this->writeQuestionSpecificPostData($form);
        $custom_check = $this->object->checkQuestionCustomPart($form);
        if (!$custom_check) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("form_input_not_valid"));
            $this->editQuestion($form);
            return 1;
        }
        $this->saveTaxonomyAssignments();
        return 0;
    }

References $check, buildEditForm(), editQuestion(), ILIAS\Repository\lng(), assQuestionGUI\saveTaxonomyAssignments(), verifyAnswerOptions(), assQuestionGUI\writeQuestionGenericPostData(), and writeQuestionSpecificPostData().

Here is the call graph for this function:

writeQuestionSpecificPostData()

assLongMenuGUI::writeQuestionSpecificPostData

(

ilPropertyFormGUI

$form

)

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

Implements ilGuiQuestionScoringAdjustable.

Definition at line 96 of file class.assLongMenuGUI.php.

                                                                          : void
    {
        $longmenu_text = $this->request->raw('longmenu_text') ?? '';
        $hidden_text_files = $this->request->raw('hidden_text_files') ?? '';
        $hidden_correct_answers = $this->request->raw('hidden_correct_answers') ?? [];
        $long_menu_type = $this->request->raw('long_menu_type') ?? '';
        $this->object->setLongMenuTextValue(ilUtil::stripSlashes($longmenu_text));
        $this->object->setAnswers($this->trimArrayRecursive($this->stripSlashesRecursive(json_decode($hidden_text_files))));
        $this->object->setCorrectAnswers($this->trimArrayRecursive($this->stripSlashesRecursive(json_decode($hidden_correct_answers))));
        $this->object->setAnswerType(ilArrayUtil::stripSlashesRecursive($long_menu_type));
        $this->object->setQuestion($this->request->raw('question'));
        $this->object->setLongMenuTextValue($this->request->raw('longmenu_text'));
        $this->object->setMinAutoComplete($this->request->int('min_auto_complete'));
        $this->object->setIdenticalScoring($this->request->int('identical_scoring'));
 
        $this->saveTaxonomyAssignments();
    }

References assQuestionGUI\saveTaxonomyAssignments(), ilUtil\stripSlashes(), ilArrayUtil\stripSlashesRecursive(), stripSlashesRecursive(), and trimArrayRecursive().

Referenced by writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ilTabs

assLongMenuGUI::$ilTabs

private

Definition at line 30 of file class.assLongMenuGUI.php.

Referenced by __construct().

---

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

• Modules/TestQuestionPool/classes/class.assLongMenuGUI.php