assMatchingQuestionGUI Class Reference

Matching question GUI representation. More...

Inheritance diagram for assMatchingQuestionGUI:

Collaboration diagram for assMatchingQuestionGUI:

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...
	uploadterms ()
	removeimageterms ()
	uploaddefinitions ()
	removeimagedefinitions ()
	addterms ()
	removeterms ()
	adddefinitions ()
	removedefinitions ()
	addpairs ()
	removepairs ()
	editQuestion (bool $checkonly=false, ?bool $is_save_cmd=null)
	populateAnswerSpecificFormPart (\ilPropertyFormGUI $form)
	populateQuestionSpecificFormPart (\ilPropertyFormGUI $form)
	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 $attempt, bool $is_question_postponed=false, array|bool $user_post_solutions=false, bool $show_specific_inline_feedback=false)
	checkInput ()
	check input fields More...
	getSpecificFeedbackOutput (array $userSolution)
	Returns the answer specific feedback for the question. More...
	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...
	getAnswersFrequency ($relevantAnswers, $questionIndex)
	getAnswerFrequencyTableGUI ($parentGui, $parentCmd, $relevantAnswers, $questionIndex)
	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 ()
	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)
	buildFileDownloadLink ()
Public Member Functions inherited from ilGuiQuestionScoringAdjustable
	populateQuestionSpecificFormPart (ilPropertyFormGUI $form)
	Adds the question specific forms parts to a question property form gui. More...
	writeQuestionSpecificPostData (ilPropertyFormGUI $form)
	Extracts the question specific values from the request 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...
Public Member Functions inherited from ilGuiAnswerScoringAdjustable
	populateAnswerSpecificFormPart (ilPropertyFormGUI $form)
	Adds the answer specific form parts to a question property form gui. More...
	writeAnswerSpecificPostData (ilPropertyFormGUI $form)
	Extracts the answer specific values from the request and applies them to the data object. More...
	getAfterParticipationSuppressionAnswerPostVars ()
	Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment. More...

Protected Member Functions
	writePostData (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...
	sortDefinitionsBySolution (array $solutions, array $definitions)
	getAnswerStatisticImageHtml ($picture)
	getAnswerStatisticMatchingElemHtml ($elem)
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 (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_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)
	renderLatex ($content)
	Wrap content with latex in a LatexContent UI component and render it to be processed by MathJax in the browser. More...
	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 ()
	resetSavedPreviewSession ()

Private Member Functions
	isDefImgUploadCommand ()
	isTermImgUploadCommand ()
	isValidTermAndDefinitionAmount (ilPropertyFormGUI $form)
	for mode 1:1 terms count must not be less than definitions count for mode n:n this limitation is cancelled More...
	populateDefinition (ilTemplate $template, assAnswerMatchingDefinition $definition, array $solutions, array $terms)
	populateAssignedTerms (ilTemplate $definition_template, int $definition_id, array $assigned_term_ids, array $available_terms)
	getArrayKeyForTermId (int $term_id, array $terms)
	buildTermHtml (assAnswerMatchingTerm $term, ?int $definition_id=null)
	buildSolutionsArray (int $active_id, int $attempt, array|bool $user_post_solutions)
	isCorrectMatching ($pair, $definition, $term)
	initializePlayerJS ()

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

Matching question GUI representation.

The assMatchingQuestionGUI class encapsulates the GUI representation for matching questions.

Author

Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

\ @ilCtrl_Calls assMatchingQuestionGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

__construct()

assMatchingQuestionGUI::__construct

(

$id = -1

)

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

    {
        parent::__construct();
        $this->object = new assMatchingQuestion();
        $this->setErrorMessage($this->lng->txt('msg_form_save_error'));
        if ($id >= 0) {
            $this->object->loadFromDb($id);
        }
    }

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

Here is the call graph for this function:

Member Function Documentation

adddefinitions()

assMatchingQuestionGUI::adddefinitions

(

)

Definition at line 222 of file class.assMatchingQuestionGUI.php.

                                    : void
    {
        $this->setAdditionalContentEditingModeFromPost();
        $this->writePostData(true);
        $this->object->insertDefinition($this->request_data_collector->getCmdIndex('adddefinitions') + 1);
        $this->editQuestion();
    }

References editQuestion(), assQuestionGUI\setAdditionalContentEditingModeFromPost(), and writePostData().

Here is the call graph for this function:

addpairs()

assMatchingQuestionGUI::addpairs

(

)

Definition at line 238 of file class.assMatchingQuestionGUI.php.

                              : void
    {
        $this->setAdditionalContentEditingModeFromPost();
        $this->writePostData(true);
        $this->object->insertMatchingPair($this->request_data_collector->getCmdIndex('addpairs') + 1);
        $this->editQuestion();
    }

References editQuestion(), assQuestionGUI\setAdditionalContentEditingModeFromPost(), and writePostData().

Here is the call graph for this function:

addterms()

assMatchingQuestionGUI::addterms

(

)

Definition at line 205 of file class.assMatchingQuestionGUI.php.

                              : void
    {
        $this->setAdditionalContentEditingModeFromPost();
        $this->writePostData(true);
        $add_terms = $this->request_data_collector->getCmdIndex('addterms');
        $this->object->insertTerm($add_terms + 1);
        $this->editQuestion();
    }

References editQuestion(), assQuestionGUI\setAdditionalContentEditingModeFromPost(), and writePostData().

Here is the call graph for this function:

buildSolutionsArray()

assMatchingQuestionGUI::buildSolutionsArray ( int  $active_id, int  $attempt, array|bool  $user_post_solutions  )

private

Definition at line 839 of file class.assMatchingQuestionGUI.php.

                                                                                                       : array
    {
        if ($active_id === 0) {
            return [];
        }
        if ($user_post_solutions !== false) {
            return $user_post_solutions['matching'];
        }
 
        return array_reduce(
            $this->object->getTestOutputSolutions($active_id, $attempt),
            static function (array $c, array $v): array {
                if (!array_key_exists($v['value2'], $c)) {
                    $c[$v['value2']] = [$v['value1']];
                    return $c;
                }
                $c[$v['value2']][] = $v['value1'];
                return $c;
            },
            []
        );
    }

References $c, and ILIAS\Repository\object().

Here is the call graph for this function:

buildTermHtml()

assMatchingQuestionGUI::buildTermHtml ( assAnswerMatchingTerm  $term, ?int  $definition_id = null  )

private

Definition at line 796 of file class.assMatchingQuestionGUI.php.

                                                                                           : string
    {
        $template = new ilTemplate('tpl.il_as_qpl_matching_term_output.html', true, true, 'components/ILIAS/TestQuestionPool');
 
        $template->setVariable('ID_DRAGGABLE', $term->getIdentifier());
 
        if ($definition_id !== null) {
            $template->setCurrentBlock('definition_id');
            $template->setVariable('IID_DROPAREA', $definition_id);
            $template->parseCurrentBlock();
        }
 
        if ($term->getPicture() === '') {
            $template->setCurrentBlock('term_text');
            $template->setVariable('TERM_TEXT', $this->renderLatex(
                ilLegacyFormElementsUtil::prepareTextareaOutput($term->getText(), true, true)
            ));
            $template->parseCurrentBlock();
            return $template->get();
        }
 
        $template->setCurrentBlock('term_picture');
        $template->setVariable('TERM_ID', $term->getIdentifier());
        $template->setVariable('IMAGE_HREF', $this->object->getImagePathWeb() . $term->getPicture());
        $thumbweb = $this->object->getImagePathWeb() . $this->object->getThumbPrefix() . $term->getPicture();
        $thumb = $this->object->getImagePath() . $this->object->getThumbPrefix() . $term->getPicture();
        if (!file_exists($thumb)) {
            $this->object->rebuildThumbnails();
        }
        $template->setVariable('THUMBNAIL_HREF', $thumbweb);
        $template->setVariable('THUMB_ALT', $this->lng->txt('image'));
        $template->setVariable('THUMB_TITLE', $this->lng->txt('image'));
        $template->setVariable('TEXT_PREVIEW', $this->lng->txt('preview'));
        $template->setVariable('TEXT_TERM', $term->getText() !== ''
            ? $this->renderLatex(
                ilLegacyFormElementsUtil::prepareTextareaOutput($term->getText(), true, true)
            )
            : '');
        $template->setVariable('IMG_PREVIEW', ilUtil::getImagePath('media/enlarge.svg'));
        $template->parseCurrentBlock();
        return $template->get();
    }

References assAnswerMatchingTerm\getIdentifier(), ilUtil\getImagePath(), assAnswerMatchingTerm\getPicture(), assAnswerMatchingTerm\getText(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilLegacyFormElementsUtil\prepareTextareaOutput().

Here is the call graph for this function:

checkInput()

assMatchingQuestionGUI::checkInput

(

)

check input fields

Definition at line 946 of file class.assMatchingQuestionGUI.php.

                                : bool
    {
        $title = $this->request_data_collector->string('title');
        $author = $this->request_data_collector->string('author');
        $question = $this->request_data_collector->string('question');
 
        return !empty($title) && !empty($author) && !empty($question);
    }

editQuestion()

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

Reimplemented from assQuestionGUI.

Definition at line 254 of file class.assMatchingQuestionGUI.php.

     : 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(true);
        $form->setTableWidth("100%");
        $form->setId("matching");
 
        $this->addBasicQuestionFormProperties($form);
        $this->populateQuestionSpecificFormPart($form);
        $this->populateAnswerSpecificFormPart($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 && !$this->isValidTermAndDefinitionAmount($form) && !$this->object->getSelfAssessmentEditingMode()) {
                $errors = true;
                $terms = $form->getItemByPostVar('terms');
                $terms->setAlert($this->lng->txt("msg_number_of_terms_too_low"));
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
            }
            if ($errors) {
                $checkonly = false;
            }
        }
 
        if (!$checkonly) {
            $this->renderEditForm($form);
        }
        return $errors;
    }

Referenced by adddefinitions(), addpairs(), addterms(), removedefinitions(), removeimagedefinitions(), removeimageterms(), removepairs(), removeterms(), uploaddefinitions(), uploadterms(), and writePostData().

Here is the caller graph for this function:

getAfterParticipationSuppressionAnswerPostVars()

assMatchingQuestionGUI::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 1000 of file class.assMatchingQuestionGUI.php.

                                                                    : array
    {
        return [];
    }

getAfterParticipationSuppressionQuestionPostVars()

assMatchingQuestionGUI::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 1014 of file class.assMatchingQuestionGUI.php.

                                                                      : array
    {
        return [];
    }

getAnswerFrequencyTableGUI()

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

Parameters

$parentGui
$parentCmd
$relevantAnswers
$questionIndex

Returns

ilMatchingQuestionAnswerFreqStatTableGUI

Reimplemented from assQuestionGUI.

Definition at line 1112 of file class.assMatchingQuestionGUI.php.

                                                                                                        : ilAnswerFrequencyStatisticTableGUI
    {
        $table = new ilMatchingQuestionAnswerFreqStatTableGUI($parentGui, $parentCmd, $this->object);
        $table->setQuestionIndex($questionIndex);
        $table->setData($this->getAnswersFrequency($relevantAnswers, $questionIndex));
        $table->initColumns();
 
        return $table;
    }

getAnswersFrequency()

assMatchingQuestionGUI::getAnswersFrequency	(		$relevantAnswers,
			$questionIndex
	)

Reimplemented from assQuestionGUI.

Definition at line 1061 of file class.assMatchingQuestionGUI.php.

                                                                         : array
    {
        $answersByActiveAndPass = [];
 
        foreach ($relevantAnswers as $row) {
            $key = $row['active_fi'] . ':' . $row['pass'];
 
            if (!isset($answersByActiveAndPass[$key])) {
                $answersByActiveAndPass[$key] = [];
            }
 
            $answersByActiveAndPass[$key][$row['value1']] = $row['value2'];
        }
 
        $answers = [];
 
        foreach ($answersByActiveAndPass as $key => $matchingPairs) {
            foreach ($matchingPairs as $termId => $defId) {
                $hash = md5($termId . ':' . $defId);
 
                if (!isset($answers[$hash])) {
                    $termHtml = $this->getAnswerStatisticMatchingElemHtml(
                        $this->object->getTermWithIdentifier($termId)
                    );
 
                    $defHtml = $this->getAnswerStatisticMatchingElemHtml(
                        $this->object->getDefinitionWithIdentifier($defId)
                    );
 
                    $answers[$hash] = [
                        'answer' => $termHtml . $defHtml,
                        'term' => $termHtml,
                        'definition' => $defHtml,
                        'frequency' => 0
                    ];
                }
 
                $answers[$hash]['frequency']++;
            }
        }
 
        return $answers;
    }

References ILIAS\Repository\object().

Here is the call graph for this function:

getAnswerStatisticImageHtml()

assMatchingQuestionGUI::getAnswerStatisticImageHtml (   $picture )

protected

Definition at line 1040 of file class.assMatchingQuestionGUI.php.

                                                            : string
    {
        $thumbweb = $this->object->getImagePathWeb() . $this->object->getThumbPrefix() . $picture;
        return '<img src="' . $thumbweb . '" alt="' . $picture . '" title="' . $picture . '"/>';
    }

getAnswerStatisticMatchingElemHtml()

assMatchingQuestionGUI::getAnswerStatisticMatchingElemHtml (   $elem )

protected

Definition at line 1046 of file class.assMatchingQuestionGUI.php.

                                                                : string
    {
        $html = '';
 
        if (strlen($elem->getText())) {
            $html .= $elem->getText();
        }
 
        if (strlen($elem->getPicture())) {
            $html .= $this->getAnswerStatisticImageHtml($elem->getPicture());
        }
 
        return $html;
    }

getArrayKeyForTermId()

assMatchingQuestionGUI::getArrayKeyForTermId ( int  $term_id, array  $terms  )

private

Definition at line 786 of file class.assMatchingQuestionGUI.php.

                                                                     : ?int
    {
        foreach ($terms as $key => $term) {
            if ($term->getIdentifier() === $term_id) {
                return $key;
            }
        }
        return null;
    }

getPreview()

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

Reimplemented from assQuestionGUI.

Definition at line 657 of file class.assMatchingQuestionGUI.php.

     : string {
        $template = new ilTemplate('tpl.il_as_qpl_matching_output.html', true, true, 'components/ILIAS/TestQuestionPool');
        $this->initializePlayerJS();
 
        $solutions = $this->getPreviewSession()?->getParticipantsSolution() ?? [];
 
        // shuffle output
        $terms = $this->object->getTerms();
        $definitions = $this->object->getDefinitions();
        switch ($this->object->getShuffleMode()) {
            case 1:
                $terms = $this->object->getShuffler()->transform($terms);
                $definitions = $this->object->getShuffler()->transform(
                    $this->object->getShuffler()->transform($definitions)
                );
                break;
            case 2:
                $terms = $this->object->getShuffler()->transform($terms);
                break;
            case 3:
                $definitions = $this->object->getShuffler()->transform($definitions);
                break;
        }
 
        foreach ($definitions as $definition) {
            $terms = $this->populateDefinition($template, $definition, $solutions, $terms);
            $template->setCurrentBlock('droparea');
            $template->setVariable('ID_DROPAREA', $definition->getIdentifier());
            $template->setVariable('QUESTION_ID', $this->object->getId());
            $template->parseCurrentBlock();
        }
 
        $template->setVariable(
            'TERMS_PRESENTATION_SOURCE',
            array_reduce(
                $terms,
                fn(string $c, assAnswerMatchingTerm $v) => $c . $this->buildTermHtml($v),
                ''
            )
        );
 
        $template->setVariable('QUESTIONTEXT', $this->renderLatex($this->object->getQuestionForHTMLOutput()));
 
        $questionoutput = $template->get();
 
        if (!$show_question_only) {
            // get page object output
            $questionoutput = $this->getILIASPage($questionoutput);
        }
 
        return $questionoutput;
    }

getSolutionOutput()

assMatchingQuestionGUI::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
	)

Reimplemented from assQuestionGUI.

Definition at line 449 of file class.assMatchingQuestionGUI.php.

     : string {
        $solutions = [];
        if (($active_id > 0) && (!$show_correct_solution)) {
            $solutions = $this->object->getSolutionValues($active_id, $pass);
        } else {
            foreach ($this->object->getMaximumScoringMatchingPairs() as $pair) {
                $solutions[] = [
                    'value1' => $pair->getTerm()->getIdentifier(),
                    'value2' => $pair->getDefinition()->getIdentifier(),
                    'points' => $pair->getPoints()
                ];
            }
        }
 
        return $this->renderSolutionOutput(
            $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,
        );
    }

getSpecificFeedbackOutput()

assMatchingQuestionGUI::getSpecificFeedbackOutput

(

array

$userSolution

)

Returns the answer specific feedback for the question.

Parameters

array

$userSolution

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

Reimplemented from assQuestionGUI.

Definition at line 955 of file class.assMatchingQuestionGUI.php.

                                                                  : string
    {
        $matches = array_values($this->object->matchingpairs);
 
        if (!$this->object->feedbackOBJ->specificAnswerFeedbackExists()) {
            return '';
        }
 
        $feedback = '<table class="test_specific_feedback"><tbody>';
 
        foreach ($matches as $idx => $ans) {
            if (!isset($userSolution[$ans->getDefinition()->getIdentifier()])) {
                continue;
            }
 
            if (!is_array($userSolution[$ans->getDefinition()->getIdentifier()])) {
                continue;
            }
 
            if (!in_array($ans->getTerm()->getIdentifier(), $userSolution[$ans->getDefinition()->getIdentifier()])) {
                continue;
            }
 
            $fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
                $this->object->getId(),
                0,
                $idx
            );
            $feedback .= "<tr><td>\"{$ans->getDefinition()->getText()}\" {$this->lng->txt('matches')} ";
            $feedback .= "\"{$ans->getTerm()->getText()}\"</td><td>{$fb}</td></tr>";
        }
 
        $feedback .= '</tbody></table>';
        return $this->renderLatex(ilLegacyFormElementsUtil::prepareTextareaOutput($feedback, true));
    }

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

Here is the call graph for this function:

getTestOutput()

assMatchingQuestionGUI::getTestOutput	(	int	$active_id,
		int	$attempt,
		bool	$is_question_postponed = false,
		array|bool	$user_post_solutions = false,
		bool	$show_specific_inline_feedback = false
	)

Reimplemented from assQuestionGUI.

Definition at line 885 of file class.assMatchingQuestionGUI.php.

     : string {
        $template = new ilTemplate('tpl.il_as_qpl_matching_output.html', true, true, 'components/ILIAS/TestQuestionPool');
        $this->initializePlayerJS();
 
        $solutions = $this->buildSolutionsArray($active_id, $attempt, $user_post_solutions);
        $terms = $this->object->getTerms();
        $definitions = $this->object->getDefinitions();
        switch ($this->object->getShuffleMode()) {
            case 1:
                $terms = $this->object->getShuffler()->transform($terms);
                if ($solutions !== []) {
                    $definitions = $this->sortDefinitionsBySolution($solutions, $definitions);
                } else {
                    $definitions = $this->object->getShuffler()->transform(
                        $this->object->getShuffler()->transform($definitions)
                    );
                }
                break;
            case 2:
                $terms = $this->object->getShuffler()->transform($terms);
                break;
            case 3:
                if ($solutions !== []) {
                    $definitions = $this->sortDefinitionsBySolution($solutions, $definitions);
                } else {
                    $definitions = $this->object->getShuffler()->transform($definitions);
                }
                break;
        }
 
        foreach ($definitions as $definition) {
            $terms = $this->populateDefinition($template, $definition, $solutions, $terms);
            $template->setCurrentBlock('droparea');
            $template->setVariable('ID_DROPAREA', $definition->getIdentifier());
            $template->setVariable('QUESTION_ID', $this->object->getId());
            $template->parseCurrentBlock();
        }
 
        $template->setVariable(
            'TERMS_PRESENTATION_SOURCE',
            array_reduce(
                $terms,
                fn(string $c, assAnswerMatchingTerm $v) => $c . $this->buildTermHtml($v),
                ''
            )
        );
 
        $template->setVariable('QUESTIONTEXT', $this->renderLatex($this->object->getQuestionForHTMLOutput()));
 
        return $this->outQuestionPage('', $is_question_postponed, $active_id, $template->get());
    }

initializePlayerJS()

assMatchingQuestionGUI::initializePlayerJS ( )

private

Definition at line 1163 of file class.assMatchingQuestionGUI.php.

                                         : void
    {
        $this->tpl->addJavaScript('assets/js/matching.js');
        $this->tpl->addOnLoadCode(
            'il.test.matching.init('
            . "document.querySelector('#ilMatchingQuestionContainer_{$this->object->getId()}'),"
            . "'{$this->object->getMatchingMode()}');"
        );
    }

isCorrectMatching()

assMatchingQuestionGUI::isCorrectMatching (   $pair,   $definition,   $term  )

private

Definition at line 1019 of file class.assMatchingQuestionGUI.php.

                                                                 : bool
    {
        if (!($pair->getPoints() > 0)) {
            return false;
        }
 
        if (!is_object($term)) {
            return false;
        }
 
        if ($pair->getDefinition()->getIdentifier() != $definition->getIdentifier()) {
            return false;
        }
 
        if ($pair->getTerm()->getIdentifier() != $term->getIdentifier()) {
            return false;
        }
 
        return true;
    }

isDefImgUploadCommand()

assMatchingQuestionGUI::isDefImgUploadCommand ( )

private

Definition at line 297 of file class.assMatchingQuestionGUI.php.

                                            : bool
    {
        return $this->ctrl->getCmd() == 'uploaddefinitions';
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

isTermImgUploadCommand()

assMatchingQuestionGUI::isTermImgUploadCommand ( )

private

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

                                             : bool
    {
        return $this->ctrl->getCmd() == 'uploadterms';
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

isValidTermAndDefinitionAmount()

assMatchingQuestionGUI::isValidTermAndDefinitionAmount ( ilPropertyFormGUI  $form )

private

for mode 1:1 terms count must not be less than definitions count for mode n:n this limitation is cancelled

Parameters

ilPropertyFormGUI

$form

Returns

bool

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

                                                                            : bool
    {
        $matchingMode = $form->getItemByPostVar('matching_mode')->getValue();
 
        if ($matchingMode == assMatchingQuestion::MATCHING_MODE_N_ON_N) {
            return true;
        }
 
        $numTerms = count($form->getItemByPostVar('terms')->getValues());
        $numDefinitions = count($form->getItemByPostVar('definitions')->getValues());
 
        if ($numTerms >= $numDefinitions) {
            return true;
        }
 
        return false;
    }

References ilPropertyFormGUI\getItemByPostVar(), and assMatchingQuestion\MATCHING_MODE_N_ON_N.

Here is the call graph for this function:

populateAnswerSpecificFormPart()

assMatchingQuestionGUI::populateAnswerSpecificFormPart

(

\ilPropertyFormGUI

$form

)

Definition at line 332 of file class.assMatchingQuestionGUI.php.

                                                                            : ilPropertyFormGUI
    {
        $definitions = new ilMatchingWizardInputGUI($this->lng->txt("definitions"), "definitions");
        if ($this->object->getSelfAssessmentEditingMode()) {
            $definitions->setHideImages(true);
        }
 
        $stripHtmlEntitesFromValues = function (assAnswerMatchingTerm $value) {
            return $value->withText(html_entity_decode($value->getText()));
        };
 
        $definitions->setRequired(true);
        $definitions->setQuestionObject($this->object);
        $definitions->setTextName($this->lng->txt('definition_text'));
        $definitions->setImageName($this->lng->txt('definition_image'));
        if (!count($this->object->getDefinitions())) {
            $this->object->addDefinition(new assAnswerMatchingDefinition());
        }
        $definitionvalues = array_map($stripHtmlEntitesFromValues, $this->object->getDefinitions());
        $definitions->setValues($definitionvalues);
        if ($this->isDefImgUploadCommand()) {
            $definitions->checkInput();
        }
        $definitions->setInfo($this->lng->txt('latex_edit_info'));
        $form->addItem($definitions);
 
        $terms = new ilMatchingWizardInputGUI($this->lng->txt("terms"), "terms");
        if ($this->object->getSelfAssessmentEditingMode()) {
            $terms->setHideImages(true);
        }
        $terms->setRequired(true);
        $terms->setQuestionObject($this->object);
        $terms->setTextName($this->lng->txt('term_text'));
        $terms->setImageName($this->lng->txt('term_image'));
 
        if (0 === count($this->object->getTerms())) {
            // @PHP8-CR: If you look above, how $this->object->addDefinition does in fact take an object, I take this
            // issue as an indicator for a bigger issue and won't suppress / "quickfix" this but postpone further
            // analysis, eventually involving T&A TechSquad
            $this->object->addTerm(new assAnswerMatchingTerm());
        }
        $termvalues = array_map($stripHtmlEntitesFromValues, $this->object->getTerms());
        $terms->setValues($termvalues);
        if ($this->isTermImgUploadCommand()) {
            $terms->checkInput();
        }
        $terms->setInfo($this->lng->txt('latex_edit_info'));
        $form->addItem($terms);
 
        $pairs = new ilMatchingPairWizardInputGUI($this->lng->txt('matching_pairs'), 'pairs');
        $pairs->setRequired(true);
        $pairs->setTerms($this->object->getTerms());
        $pairs->setDefinitions($this->object->getDefinitions());
        if (count($this->object->getMatchingPairs()) == 0) {
            $this->object->addMatchingPair($termvalues[0], $definitionvalues[0], 0);
            //$this->object->addMatchingPair(new assAnswerMatchingPair($termvalues[0], $definitionvalues[0], 0));
        }
        $pairs->setPairs($this->object->getMatchingPairs());
        $form->addItem($pairs);
 
        return $form;
    }

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

Here is the call graph for this function:

populateAssignedTerms()

assMatchingQuestionGUI::populateAssignedTerms ( ilTemplate  $definition_template, int  $definition_id, array  $assigned_term_ids, array  $available_terms  )

private

Parameters

array<int>

$term_ids

Definition at line 757 of file class.assMatchingQuestionGUI.php.

     : array {
        $definition_template->setVariable('ASSIGNED_TERMS', json_encode($assigned_term_ids));
        $definition_template->setVariable(
            'TERMS_PRESENTATION_ASSIGNED',
            array_reduce(
                $assigned_term_ids,
                function (string $c, int $v) use ($definition_id, &$available_terms) {
                    $key = $this->getArrayKeyForTermId($v, $available_terms);
                    if ($key === null) {
                        return $c;
                    }
                    $c .= $this->buildTermHtml($available_terms[$key], $definition_id);
                    if ($this->object->getMatchingMode() === assMatchingQuestion::MATCHING_MODE_1_ON_1) {
                        unset($available_terms[$key]);
                    }
                    return $c;
                },
                ''
            )
        );
 
        return $available_terms;
    }

References $c, assMatchingQuestion\MATCHING_MODE_1_ON_1, and ILIAS\Repository\object().

Here is the call graph for this function:

populateCorrectionsFormProperties()

assMatchingQuestionGUI::populateCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Reimplemented from assQuestionGUI.

Definition at line 1122 of file class.assMatchingQuestionGUI.php.

                                                                              : void
    {
        $pairs = new ilAssMatchingPairCorrectionsInputGUI($this->lng->txt('matching_pairs'), 'pairs');
        $pairs->setRequired(true);
        $pairs->setTerms($this->object->getTerms());
        $pairs->setDefinitions($this->object->getDefinitions());
        $pairs->setPairs($this->object->getMatchingPairs());
        $pairs->setThumbsWebPathWithPrefix($this->object->getImagePathWeb() . $this->object->getThumbPrefix());
        $form->addItem($pairs);
    }

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

Here is the call graph for this function:

populateDefinition()

assMatchingQuestionGUI::populateDefinition ( ilTemplate  $template, assAnswerMatchingDefinition  $definition, array  $solutions, array  $terms  )

private

Definition at line 713 of file class.assMatchingQuestionGUI.php.

     : array {
        if ($definition->getPicture() !== '') {
            $template->setCurrentBlock('definition_picture');
            $template->setVariable('DEFINITION_ID', $definition->getIdentifier());
            $template->setVariable('IMAGE_HREF', $this->object->getImagePathWeb() . $definition->getPicture());
            $thumbweb = $this->object->getImagePathWeb() . $this->object->getThumbPrefix() . $definition->getPicture();
            $thumb = $this->object->getImagePath() . $this->object->getThumbPrefix() . $definition->getPicture();
            if (!file_exists($thumb)) {
                $this->object->rebuildThumbnails();
            }
            $template->setVariable('THUMBNAIL_HREF', $thumbweb);
            $template->setVariable('THUMB_ALT', $this->lng->txt('image'));
            $template->setVariable('THUMB_TITLE', $this->lng->txt('image'));
            $template->setVariable('TEXT_DEFINITION', (strlen($definition->getText())) ? $this->renderLatex(
                ilLegacyFormElementsUtil::prepareTextareaOutput($definition->getText(), true, true)
            ) : '');
            $template->setVariable('TEXT_PREVIEW', $this->lng->txt('preview'));
            $template->setVariable('IMG_PREVIEW', ilUtil::getImagePath('media/enlarge.svg'));
            $template->parseCurrentBlock();
        } else {
            $template->setCurrentBlock('definition_text');
            $template->setVariable('DEFINITION', $this->renderLatex(
                ilLegacyFormElementsUtil::prepareTextareaOutput($definition->getText(), true, true)
            ));
            $template->parseCurrentBlock();
        }
 
        if ($solutions === []
            || !array_key_exists($definition->getIdentifier(), $solutions)) {
            $template->setVariable('ASSIGNED_TERMS', json_encode([]));
            return $terms;
        }
 
        return $this->populateAssignedTerms($template, $definition->getIdentifier(), $solutions[$definition->getIdentifier()], $terms);
    }

References assAnswerMatchingTerm\getIdentifier(), ilUtil\getImagePath(), assAnswerMatchingTerm\getPicture(), assAnswerMatchingTerm\getText(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareTextareaOutput(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

populateQuestionSpecificFormPart()

assMatchingQuestionGUI::populateQuestionSpecificFormPart

(

\ilPropertyFormGUI

$form

)

Definition at line 395 of file class.assMatchingQuestionGUI.php.

                                                                              : ilPropertyFormGUI
    {
        // Edit mode
        $hidden = new ilHiddenInputGUI("matching_type");
        $hidden->setValue('');
        $form->addItem($hidden);
 
        if (!$this->object->getSelfAssessmentEditingMode()) {
            // shuffle
            $shuffle = new ilSelectInputGUI($this->lng->txt("shuffle_answers"), "shuffle");
            $shuffle_options = [
                0 => $this->lng->txt("no"),
                1 => $this->lng->txt("matching_shuffle_terms_definitions"),
                2 => $this->lng->txt("matching_shuffle_terms"),
                3 => $this->lng->txt("matching_shuffle_definitions")
            ];
            $shuffle->setOptions($shuffle_options);
            $shuffle->setValue($this->object->getShuffleMode());
            $shuffle->setRequired(false);
            $form->addItem($shuffle);
 
            $geometry = new ilNumberInputGUI($this->lng->txt('thumb_size'), 'thumb_geometry');
            $geometry->setValue((string) $this->object->getThumbGeometry());
            $geometry->setRequired(true);
            $geometry->setMaxLength(6);
            $geometry->setMinValue($this->object->getMinimumThumbSize());
            $geometry->setMaxValue($this->object->getMaximumThumbSize());
            $geometry->setSize(6);
            $geometry->setInfo($this->lng->txt('thumb_size_info'));
            $form->addItem($geometry);
        }
 
        // Matching Mode
        $mode = new ilRadioGroupInputGUI($this->lng->txt('qpl_qst_inp_matching_mode'), 'matching_mode');
        $mode->setRequired(true);
 
        $modeONEonONE = new ilRadioOption(
            $this->lng->txt('qpl_qst_inp_matching_mode_one_on_one'),
            assMatchingQuestion::MATCHING_MODE_1_ON_1
        );
        $mode->addOption($modeONEonONE);
 
        $modeALLonALL = new ilRadioOption(
            $this->lng->txt('qpl_qst_inp_matching_mode_all_on_all'),
            assMatchingQuestion::MATCHING_MODE_N_ON_N
        );
        $mode->addOption($modeALLonALL);
 
        $mode->setValue($this->object->getMatchingMode());
 
        $form->addItem($mode);
        return $form;
    }

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

Here is the call graph for this function:

removedefinitions()

assMatchingQuestionGUI::removedefinitions

(

)

Definition at line 230 of file class.assMatchingQuestionGUI.php.

                                       : void
    {
        $this->setAdditionalContentEditingModeFromPost();
        $this->writePostData(true);
        $this->object->deleteDefinition($this->request_data_collector->getCmdIndex('removedefinitions'));
        $this->editQuestion();
    }

References editQuestion(), assQuestionGUI\setAdditionalContentEditingModeFromPost(), and writePostData().

Here is the call graph for this function:

removeimagedefinitions()

assMatchingQuestionGUI::removeimagedefinitions

(

)

Definition at line 197 of file class.assMatchingQuestionGUI.php.

                                            : void
    {
        $this->setAdditionalContentEditingModeFromPost();
        $this->writePostData(true);
        $this->object->removeDefinitionImage($this->request_data_collector->getCmdIndex('removeimagedefinitions'));
        $this->editQuestion();
    }

References editQuestion(), assQuestionGUI\setAdditionalContentEditingModeFromPost(), and writePostData().

Here is the call graph for this function:

removeimageterms()

assMatchingQuestionGUI::removeimageterms

(

)

Definition at line 182 of file class.assMatchingQuestionGUI.php.

                                      : void
    {
        $this->setAdditionalContentEditingModeFromPost();
        $this->writePostData(true);
        $this->object->removeTermImage($this->request_data_collector->getCmdIndex('removeimageterms'));
        $this->editQuestion();
    }

References editQuestion(), assQuestionGUI\setAdditionalContentEditingModeFromPost(), and writePostData().

Here is the call graph for this function:

removepairs()

assMatchingQuestionGUI::removepairs

(

)

Definition at line 246 of file class.assMatchingQuestionGUI.php.

                                 : void
    {
        $this->setAdditionalContentEditingModeFromPost();
        $this->writePostData(true);
        $this->object->deleteMatchingPair($this->request_data_collector->getCmdIndex('removepairs'));
        $this->editQuestion();
    }

References editQuestion(), assQuestionGUI\setAdditionalContentEditingModeFromPost(), and writePostData().

Here is the call graph for this function:

removeterms()

assMatchingQuestionGUI::removeterms

(

)

Definition at line 214 of file class.assMatchingQuestionGUI.php.

                                 : void
    {
        $this->setAdditionalContentEditingModeFromPost();
        $this->writePostData(true);
        $this->object->deleteTerm($this->request_data_collector->getCmdIndex('removeterms'));
        $this->editQuestion();
    }

References editQuestion(), assQuestionGUI\setAdditionalContentEditingModeFromPost(), and writePostData().

Here is the call graph for this function:

renderSolutionOutput()

assMatchingQuestionGUI::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
	)

Reimplemented from assQuestionGUI.

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

     : ?string {
        $template = new ilTemplate('tpl.il_as_qpl_matching_output_solution.html', true, true, 'components/ILIAS/TestQuestionPool');
        $solutiontemplate = new ilTemplate('tpl.il_as_tst_solution_output.html', true, true, 'components/ILIAS/TestQuestionPool');
        $i = 0;
 
        foreach ($user_solutions as $solution) {
            $definition = $this->object->getDefinitionWithIdentifier($solution['value2']);
            $term = $this->object->getTermWithIdentifier($solution['value1']);
            $points = $solution['points'];
 
            if (is_object($definition)) {
                if ($definition->getPicture() !== '') {
                    if ($definition->getText() !== '') {
                        $template->setCurrentBlock('definition_image_text');
                        $template->setVariable(
                            'TEXT_DEFINITION',
                            ilLegacyFormElementsUtil::prepareFormOutput($definition->getText())
                        );
                        $template->parseCurrentBlock();
                    }
 
                    $answerImageSrc = ilWACSignedPath::signFile(
                        $this->object->getImagePathWeb() . $this->object->getThumbPrefix() . $definition->getPicture()
                    );
 
                    $template->setCurrentBlock('definition_image');
                    $template->setVariable('ANSWER_IMAGE_URL', $answerImageSrc);
                    $template->setVariable(
                        'ANSWER_IMAGE_ALT',
                        (strlen($definition->getText())) ? ilLegacyFormElementsUtil::prepareFormOutput(
                            $definition->getText()
                        ) : ilLegacyFormElementsUtil::prepareFormOutput($definition->getPicture())
                    );
                    $template->setVariable(
                        'ANSWER_IMAGE_TITLE',
                        (strlen($definition->getText())) ? ilLegacyFormElementsUtil::prepareFormOutput(
                            $definition->getText()
                        ) : ilLegacyFormElementsUtil::prepareFormOutput($definition->getPicture())
                    );
                    $template->setVariable('URL_PREVIEW', $this->object->getImagePathWeb() . $definition->getPicture());
                    $template->setVariable("TEXT_PREVIEW", $this->lng->txt('preview'));
                    $template->setVariable("IMG_PREVIEW", ilUtil::getImagePath('media/enlarge.svg'));
                    $template->parseCurrentBlock();
                } else {
                    $template->setCurrentBlock('definition_text');
                    $template->setVariable("DEFINITION", ilLegacyFormElementsUtil::prepareTextareaOutput($definition->getText(), true));
                    $template->parseCurrentBlock();
                }
            }
            if ($term !== null) {
                if (strlen($term->getPicture())) {
                    if (strlen($term->getText())) {
                        $template->setCurrentBlock('term_image_text');
                        $template->setVariable("TEXT_TERM", ilLegacyFormElementsUtil::prepareFormOutput($term->getText()));
                        $template->parseCurrentBlock();
                    }
 
                    $answerImageSrc = ilWACSignedPath::signFile(
                        $this->object->getImagePathWeb() . $this->object->getThumbPrefix() . $term->getPicture()
                    );
 
                    $template->setCurrentBlock('term_image');
                    $template->setVariable('ANSWER_IMAGE_URL', $answerImageSrc);
                    $template->setVariable(
                        'ANSWER_IMAGE_ALT',
                        (strlen($term->getText())) ? ilLegacyFormElementsUtil::prepareFormOutput(
                            $term->getText()
                        ) : ilLegacyFormElementsUtil::prepareFormOutput($term->getPicture())
                    );
                    $template->setVariable(
                        'ANSWER_IMAGE_TITLE',
                        (strlen($term->getText())) ? ilLegacyFormElementsUtil::prepareFormOutput(
                            $term->getText()
                        ) : ilLegacyFormElementsUtil::prepareFormOutput($term->getPicture())
                    );
                    $template->setVariable('URL_PREVIEW', $this->object->getImagePathWeb() . $term->getPicture());
                    $template->setVariable("TEXT_PREVIEW", $this->lng->txt('preview'));
                    $template->setVariable("IMG_PREVIEW", ilUtil::getImagePath('media/enlarge.svg'));
                    $template->parseCurrentBlock();
                } else {
                    $template->setCurrentBlock('term_text');
                    $template->setVariable("TERM", ilLegacyFormElementsUtil::prepareTextareaOutput($term->getText(), true));
                    $template->parseCurrentBlock();
                }
                $i++;
            }
            if (($active_id > 0) && (!$show_correct_solution)) {
                if ($graphical_output) {
                    // output of ok/not ok icons for user entered solutions
                    $ok = false;
                    foreach ($this->object->getMatchingPairs() as $pair) {
                        if ($this->isCorrectMatching($pair, $definition, $term)) {
                            $ok = true;
                        }
                    }
 
                    $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_NOT_OK);
                    if ($ok) {
                        $correctness_icon = $this->generateCorrectnessIconsForCorrectness(self::CORRECTNESS_OK);
                    }
                    $template->setCurrentBlock('icon_ok');
                    $template->setVariable('ICON_OK', $correctness_icon);
                    $template->parseCurrentBlock();
                }
            }
 
            if ($result_output) {
                $resulttext = ($points == 1) ? '(%s ' . $this->lng->txt('point') . ')' : '(%s ' . $this->lng->txt('points') . ')';
                $template->setCurrentBlock('result_output');
                $template->setVariable('RESULT_OUTPUT', sprintf($resulttext, $points));
                $template->parseCurrentBlock();
            }
 
            $template->setCurrentBlock('row');
            $template->setVariable('TEXT_MATCHES', $this->lng->txt('matches'));
            $template->parseCurrentBlock();
        }
 
        if ($show_question_text == true) {
            $template->setVariable('QUESTIONTEXT', $this->object->getQuestionForHTMLOutput());
        }
 
        $questionoutput = $template->get();
 
        $feedback = '';
        if ($show_feedback) {
            if (!$this->isTestPresentationContext()) {
                $fb = $this->getGenericFeedbackOutput((int) $active_id, $pass);
                $feedback .= strlen($fb) ? $fb : '';
            }
 
            $fb = $this->getSpecificFeedbackOutput([]);
            $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));
        }
 
        $solutiontemplate->setVariable('SOLUTION_OUTPUT', $questionoutput);
 
        $solutionoutput = $solutiontemplate->get();
        if (!$show_question_only) {
            // get page object output
            $solutionoutput = $this->getILIASPage($solutionoutput);
        }
        return $solutionoutput;
    }

saveCorrectionsFormProperties()

assMatchingQuestionGUI::saveCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

Reimplemented from assQuestionGUI.

Definition at line 1136 of file class.assMatchingQuestionGUI.php.

                                                                          : void
    {
        $pairs = $this->object->getMatchingPairs();
        $nu_pairs = [];
 
        if ($this->request_data_collector->isset('pairs')) {
            $points_of_pairs = $this->request_data_collector->raw('pairs')['points'];
            $pair_terms = explode(',', $this->request_data_collector->raw('pairs')['term_id']);
            $pair_definitions = explode(',', $this->request_data_collector->raw('pairs')['definition_id']);
            $values = [];
            foreach ($points_of_pairs as $idx => $points) {
                $k = implode('.', [$pair_terms[$idx], $pair_definitions[$idx]]);
                $values[$k] = (float) str_replace(',', '.', $points);
            }
 
            foreach ($pairs as $idx => $pair) {
                $id = implode('.', [
                    $pair->getTerm()->getIdentifier(),
                    $pair->getDefinition()->getIdentifier()
                ]);
                $nu_pairs[$id] = $pair->withPoints($values[$id]);
            }
 
            $this->object = $this->object->withMatchingPairs($nu_pairs);
        }
    }

References $id.

sortDefinitionsBySolution()

assMatchingQuestionGUI::sortDefinitionsBySolution ( array  $solutions, array  $definitions  )

protected

Parameters

array<int,int>	$solution
array<assAnswerMatchingDefinition>	$definitions

Returns

array

Definition at line 867 of file class.assMatchingQuestionGUI.php.

                                                                                      : array
    {
        $neworder = [];
        $handled_definitions = [];
        foreach (array_keys($solutions) as $definition_id) {
            $neworder[] = $this->object->getDefinitionWithIdentifier($definition_id);
            $handled_definitions[$definition_id] = $definition_id;
        }
 
        foreach ($definitions as $definition) {
            if (!isset($handled_definitions[$definition->getIdentifier()])) {
                $neworder[] = $definition;
            }
        }
 
        return $neworder;
    }

uploaddefinitions()

assMatchingQuestionGUI::uploaddefinitions

(

)

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

                                       : void
    {
        $this->setAdditionalContentEditingModeFromPost();
        $this->writePostData(true);
        $this->editQuestion();
    }

References editQuestion(), assQuestionGUI\setAdditionalContentEditingModeFromPost(), and writePostData().

Here is the call graph for this function:

uploadterms()

assMatchingQuestionGUI::uploadterms

(

)

Definition at line 175 of file class.assMatchingQuestionGUI.php.

                                 : void
    {
        $this->setAdditionalContentEditingModeFromPost();
        $this->writePostData(true);
        $this->editQuestion();
    }

References editQuestion(), assQuestionGUI\setAdditionalContentEditingModeFromPost(), and writePostData().

Here is the call graph for this function:

writeAnswerSpecificPostData()

assMatchingQuestionGUI::writeAnswerSpecificPostData

(

ilPropertyFormGUI

$form

)

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

Implements ilGuiAnswerScoringAdjustable.

Definition at line 65 of file class.assMatchingQuestionGUI.php.

                                                                        : void
    {
        // Delete all existing answers and create new answers from the form data
        $this->object->flushMatchingPairs();
        $this->object->flushTerms();
        $this->object->flushDefinitions();
 
        $kindlyTo = $this->refinery->kindlyTo();
 
        $uploads = $this->request_data_collector->getProcessedUploads();
        $allowed_mime_types = ['image/jpeg', 'image/png', 'image/gif'];
 
        if ($this->request_data_collector->isset('terms')) {
            $terms = $this->request_data_collector->raw('terms');
            $answers = $this->forms_helper->transformArray($terms, 'answer', $kindlyTo->string());
            $terms_image_names = $this->forms_helper->transformArray($terms, 'imagename', $kindlyTo->string());
            $terms_identifiers = $this->forms_helper->transformArray($terms, 'identifier', $kindlyTo->int());
 
            foreach ($answers as $index => $answer) {
                $filename = $terms_image_names[$index] ?? '';
 
                $upload_tmp_name = $this->request_data_collector->getUploadFilename(['terms', 'image'], $index);
 
                if (isset($uploads[$upload_tmp_name]) && $uploads[$upload_tmp_name]->isOk() &&
                    in_array($uploads[$upload_tmp_name]->getMimeType(), $allowed_mime_types)) {
                    $filename = '';
                    $name = $uploads[$upload_tmp_name]->getName();
                    if ($this->object->setImageFile(
                        $uploads[$upload_tmp_name]->getPath(),
                        $this->object->getEncryptedFilename($name)
                    )) {
                        $filename = $this->object->getEncryptedFilename($name);
                    }
                }
                // @PHP8-CR: There seems to be a bigger issue lingering here and won't suppress / "quickfix" this but
                // postpone further analysis, eventually involving T&A TechSquad (see also remark in assMatchingQuestionGUI
                $this->object->addTerm(
                    new assAnswerMatchingTerm(
                        ilUtil::stripSlashes(htmlentities($answer)),
                        $filename,
                        $terms_identifiers[$index] ?? 0
                    )
                );
            }
        }
 
        if ($this->request_data_collector->isset('definitions')) {
            $definitions = $this->request_data_collector->raw('definitions');
            $answers = $this->forms_helper->transformArray($definitions, 'answer', $kindlyTo->string());
            $definitions_image_names = $this->forms_helper->transformArray($definitions, 'imagename', $kindlyTo->string());
            $definitions_identifiers = $this->forms_helper->transformArray($definitions, 'identifier', $kindlyTo->int());
 
            foreach ($answers as $index => $answer) {
                $filename = $definitions_image_names[$index] ?? '';
 
                $upload_tmp_name = $this->request_data_collector->getUploadFilename(['definitions', 'image'], $index);
 
                if (isset($uploads[$upload_tmp_name]) && $uploads[$upload_tmp_name]->isOk() &&
                    in_array($uploads[$upload_tmp_name]->getMimeType(), $allowed_mime_types)) {
                    $filename = '';
                    $name = $uploads[$upload_tmp_name]->getName();
                    if ($this->object->setImageFile(
                        $uploads[$upload_tmp_name]->getPath(),
                        $this->object->getEncryptedFilename($name)
                    )) {
                        $filename = $this->object->getEncryptedFilename($name);
                    }
                }
 
                $this->object->addDefinition(
                    new assAnswerMatchingDefinition(
                        ilUtil::stripSlashes(htmlentities($answer)),
                        $filename,
                        $definitions_identifiers[$index] ?? 0
                    )
                );
            }
        }
 
        if ($this->request_data_collector->isset('pairs')) {
            $pairs = $this->request_data_collector->raw('pairs');
            $points_of_pairs = $this->forms_helper->transformArray($pairs, 'points', $kindlyTo->float());
            $pair_terms = $this->forms_helper->transformArray($pairs, 'term', $kindlyTo->int());
            $pair_definitions = $this->forms_helper->transformArray($pairs, 'definition', $kindlyTo->int());
 
            foreach ($points_of_pairs as $index => $points) {
                $term_id = $pair_terms[$index] ?? 0;
                $definition_id = $pair_definitions[$index] ?? 0;
                $this->object->addMatchingPair(
                    $this->object->getTermWithIdentifier($term_id),
                    $this->object->getDefinitionWithIdentifier($definition_id),
                    $points
                );
            }
        }
    }

References $filename, ILIAS\Repository\object(), ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

Referenced by writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

writePostData()

assMatchingQuestionGUI::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 52 of file class.assMatchingQuestionGUI.php.

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

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

Referenced by adddefinitions(), addpairs(), addterms(), removedefinitions(), removeimagedefinitions(), removeimageterms(), removepairs(), removeterms(), uploaddefinitions(), and uploadterms().

Here is the call graph for this function:

Here is the caller graph for this function:

writeQuestionSpecificPostData()

assMatchingQuestionGUI::writeQuestionSpecificPostData

(

ilPropertyFormGUI

$form

)

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

Implements ilGuiQuestionScoringAdjustable.

Definition at line 162 of file class.assMatchingQuestionGUI.php.

                                                                          : void
    {
        if (!$this->object->getSelfAssessmentEditingMode()) {
            $this->object->setShuffle($this->request_data_collector->int('shuffle'));
            $this->object->setShuffleMode($this->request_data_collector->int('shuffle'));
        } else {
            $this->object->setShuffle(1);
            $this->object->setShuffleMode(1);
        }
        $this->object->setThumbGeometry($this->request_data_collector->int('thumb_geometry'));
        $this->object->setMatchingMode($this->request_data_collector->string('matching_mode'));
    }

References ILIAS\Repository\object().

Referenced by writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/TestQuestionPool/classes/class.assMatchingQuestionGUI.php