assMatchingQuestionGUI Class Reference

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

Inheritance diagram for assMatchingQuestionGUI:

Collaboration diagram for assMatchingQuestionGUI:

Public Member Functions
	__construct ($id=-1)
	assMatchingQuestionGUI constructor More...
	writeAnswerSpecificPostData (ilPropertyFormGUI $form)
	Extracts the answer specific values from $_POST and applies them to the data object. More...
	writeQuestionSpecificPostData (ilPropertyFormGUI $form)
	Extracts the question specific values from $_POST and applies them to the data object. More...
	uploadterms ()
	removeimageterms ()
	uploaddefinitions ()
	removeimagedefinitions ()
	addterms ()
	removeterms ()
	adddefinitions ()
	removedefinitions ()
	addpairs ()
	removepairs ()
	editQuestion ($checkonly=false)
	populateAnswerSpecificFormPart (\ilPropertyFormGUI $form)
	populateQuestionSpecificFormPart (\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)
	getPresentationJavascripts ()
	getTestOutput ($active_id, $pass, $is_postponed=false, $user_post_solution=false, $inlineFeedback=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...
	getAggregatedAnswersView (array $relevant_answers)
	Returns an html string containing a question specific representation of the answers so far given in the test for use in the right column in the scoring adjustment user interface. More...
	getAnswersFrequency ($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)
Public Member Functions inherited from ilGuiQuestionScoringAdjustable
	populateQuestionSpecificFormPart (ilPropertyFormGUI $form)
	Adds the question specific forms parts to a question property form gui. More...
	writeQuestionSpecificPostData (ilPropertyFormGUI $form)
	Extracts the question specific values from $_POST and applies them to the data object. More...
	getAfterParticipationSuppressionQuestionPostVars ()
	Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment. More...
	getAggregatedAnswersView (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...
Public Member Functions inherited from ilGuiAnswerScoringAdjustable
	populateAnswerSpecificFormPart (ilPropertyFormGUI $form)
	Adds the answer specific form parts to a question property form gui. More...
	writeAnswerSpecificPostData (ilPropertyFormGUI $form)
	Extracts the answer specific values from $_POST and applies them to the data object. More...
	getAfterParticipationSuppressionAnswerPostVars ()
	Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment. More...

Protected Member Functions
	writePostData (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...
	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 ()
	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
	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...
	isCorrectMatching ($pair, $definition, $term)

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

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

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 34 of file class.assMatchingQuestionGUI.php.

Constructor & Destructor Documentation

__construct()

assMatchingQuestionGUI::__construct

(

$id = -1

)

assMatchingQuestionGUI constructor

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

Parameters

integer	$id	The database id of a image map question object
integer	$id	The database id of a image map question object

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

    {
        parent::__construct();
        include_once "./Modules/TestQuestionPool/classes/class.assMatchingQuestion.php";
        $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 221 of file class.assMatchingQuestionGUI.php.

                                    : void
    {
        $this->writePostData(true);
        $position = key($_POST["cmd"]["adddefinitions"]);
        $this->object->insertDefinition($position + 1);
        $this->editQuestion();
    }

References editQuestion(), and writePostData().

Here is the call graph for this function:

addpairs()

assMatchingQuestionGUI::addpairs

(

)

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

                              : void
    {
        $this->writePostData(true);
        $position = key($_POST["cmd"]["addpairs"]);
        $this->object->insertMatchingPair($position + 1);
        $this->editQuestion();
    }

References editQuestion(), and writePostData().

Here is the call graph for this function:

addterms()

assMatchingQuestionGUI::addterms

(

)

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

                              : void
    {
        $this->writePostData(true);
        $position = key($_POST["cmd"]["addterms"]);
        $this->object->insertTerm($position + 1);
        $this->editQuestion();
    }

References editQuestion(), and writePostData().

Here is the call graph for this function:

checkInput()

assMatchingQuestionGUI::checkInput

(

)

check input fields

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

                                : bool
    {
        if ((!$_POST["title"]) or (!$_POST["author"]) or (!$_POST["question"])) {
            return false;
        }
        return true;
    }

editQuestion()

assMatchingQuestionGUI::editQuestion

(

$checkonly = false

)

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

                                                    : bool
    {
        $save = $this->isSaveCommand();
        $this->getQuestionTemplate();
 
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $this->editForm = $form;
 
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->outQuestionType());
        $form->setMultipart(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->tpl->setVariable("QUESTION_DATA", $form->getHTML());
        }
        return $errors;
    }

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

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

Here is the call graph for this function:

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

                                                                    : array
    {
        return array();
    }

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

                                                                      : array
    {
        return array();
    }

getAggregatedAnswersView()

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

                                                                     : string
    {
        return ''; //print_r($relevant_answers,true);
    }

getAnswerFrequencyTableGUI()

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

Parameters

$parentGui
$parentCmd
$relevantAnswers
$questionIndex

Returns

ilMatchingQuestionAnswerFreqStatTableGUI

Reimplemented from assQuestionGUI.

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

                                                                                                        : ilAnswerFrequencyStatisticTableGUI
    {
        require_once 'Modules/TestQuestionPool/classes/tables/class.ilMatchingQuestionAnswerFreqStatTableGUI.php';
 
        $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 1092 of file class.assMatchingQuestionGUI.php.

                                                                         : array
    {
        $answersByActiveAndPass = array();
 
        foreach ($relevantAnswers as $row) {
            $key = $row['active_fi'] . ':' . $row['pass'];
 
            if (!isset($answersByActiveAndPass[$key])) {
                $answersByActiveAndPass[$key] = array();
            }
 
            $answersByActiveAndPass[$key][$row['value1']] = $row['value2'];
        }
 
        $answers = array();
 
        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] = array(
                        'answer' => $termHtml . $defHtml,
                        'term' => $termHtml,
                        'definition' => $defHtml,
                        'frequency' => 0
                    );
                }
 
                $answers[$hash]['frequency']++;
            }
        }
 
        return $answers;
    }

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

Here is the call graph for this function:

getAnswerStatisticImageHtml()

assMatchingQuestionGUI::getAnswerStatisticImageHtml (   $picture )

protected

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

getPresentationJavascripts()

assMatchingQuestionGUI::getPresentationJavascripts

(

)

Reimplemented from assQuestionGUI.

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

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

References $DIC.

getPreview()

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

Reimplemented from assQuestionGUI.

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

                                                                                        : string
    {
        $solutions = is_object($this->getPreviewSession()) ? (array) $this->getPreviewSession()->getParticipantsSolution() : array();
 
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        if ($DIC->http()->agent()->isMobile() || $DIC->http()->agent()->isIpad()) {
            require_once 'Services/jQuery/classes/class.iljQueryUtil.php';
            iljQueryUtil::initjQuery();
            iljQueryUtil::initjQueryUI();
            $this->tpl->addJavaScript('./node_modules/@andxor/jquery-ui-touch-punch-fix/jquery.ui.touch-punch.js');
        }
        $this->tpl->addJavaScript('Modules/TestQuestionPool/js/ilMatchingQuestion.js');
        $this->tpl->addOnLoadCode('ilMatchingQuestionInit();');
        $this->tpl->addCss(ilUtil::getStyleSheetLocation('output', 'test_javascript.css', 'Modules/TestQuestionPool'));
 
        $template = new ilTemplate("tpl.il_as_qpl_matching_output.html", true, true, "Modules/TestQuestionPool");
 
        foreach ($solutions as $defId => $terms) {
            foreach ($terms as $termId) {
                $template->setCurrentBlock("matching_data");
                $template->setVariable("DEFINITION_ID", $defId);
                $template->setVariable("TERM_ID", $termId);
                $template->parseCurrentBlock();
            }
        }
 
        // 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;
        }
 
        // create definitions
        $counter = 0;
        foreach ($definitions as $definition) {
            if (strlen($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->object->prepareTextareaOutput($definition->getText(), true, true) : '');
                $template->setVariable("TEXT_PREVIEW", $this->lng->txt('preview'));
                $template->setVariable("IMG_PREVIEW", ilUtil::getImagePath('enlarge.svg'));
                $template->parseCurrentBlock();
            } else {
                $template->setCurrentBlock("definition_text");
                $template->setVariable("DEFINITION", $this->object->prepareTextareaOutput($definition->getText(), true, true));
                $template->parseCurrentBlock();
            }
 
            $template->setCurrentBlock("droparea");
            $template->setVariable("ID_DROPAREA", $definition->getIdentifier());
            $template->setVariable("QUESTION_ID", $this->object->getId());
            $template->parseCurrentBlock();
 
            $template->setCurrentBlock("definition_data");
            $template->setVariable("DEFINITION_ID", $definition->getIdentifier());
            $template->parseCurrentBlock();
        }
 
        // create terms
        $counter = 0;
        foreach ($terms as $term) {
            if (strlen($term->getPicture())) {
                $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", (strlen($term->getText())) ? $this->object->prepareTextareaOutput($term->getText(), true, true) : '');
                $template->setVariable("IMG_PREVIEW", ilUtil::getImagePath('enlarge.svg'));
                $template->parseCurrentBlock();
            } else {
                $template->setCurrentBlock("term_text");
                $template->setVariable("TERM_TEXT", $this->object->prepareTextareaOutput($term->getText(), true, true));
                $template->parseCurrentBlock();
            }
            $template->setCurrentBlock("draggable");
            $template->setVariable("ID_DRAGGABLE", $term->getIdentifier());
            $template->parseCurrentBlock();
 
            $template->setCurrentBlock("term_data");
            $template->setVariable("TERM_ID", $term->getIdentifier());
            $template->parseCurrentBlock();
        }
 
        $template->setVariable('MATCHING_MODE', $this->object->getMatchingMode());
 
        $template->setVariable("RESET_BUTTON", $this->lng->txt("reset_terms"));
 
        $template->setVariable("QUESTIONTEXT", $this->object->getQuestionForHTMLOutput());
 
        $questionoutput = $template->get();
 
        if (!$show_question_only) {
            // get page object output
            $questionoutput = $this->getILIASPage($questionoutput);
        }
 
        return $questionoutput;
    }

References $DIC, ilUtil\getImagePath(), ilUtil\getStyleSheetLocation(), iljQueryUtil\initjQuery(), iljQueryUtil\initjQueryUI(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Here is the call graph for this function:

getSolutionOutput()

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

Reimplemented from assQuestionGUI.

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

     : string {
        // generate the question output
        include_once "./Services/UICore/classes/class.ilTemplate.php";
        $template = new ilTemplate("tpl.il_as_qpl_matching_output_solution.html", true, true, "Modules/TestQuestionPool");
        $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", true, true, "Modules/TestQuestionPool");
 
        $solutions = array();
        if (($active_id > 0) && (!$show_correct_solution)) {
            include_once "./Modules/Test/classes/class.ilObjTest.php";
            $solutions = $this->object->getSolutionValues($active_id, $pass);
        } else {
            foreach ($this->object->getMaximumScoringMatchingPairs() as $pair) {
                $solutions[] = array(
                    "value1" => $pair->getTerm()->getIdentifier(),
                    "value2" => $pair->getDefinition()->getIdentifier(),
                    'points' => $pair->getPoints()
                );
            }
        }
 
        $i = 0;
 
        foreach ($solutions as $solution) {
            $definition = $this->object->getDefinitionWithIdentifier($solution['value2']);
            $term = $this->object->getTermWithIdentifier($solution['value1']);
            $points = $solution['points'];
 
            if (is_object($definition)) {
                if (strlen($definition->getPicture())) {
                    if (strlen($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('enlarge.svg'));
                    $template->parseCurrentBlock();
                } else {
                    $template->setCurrentBlock('definition_text');
                    $template->setVariable("DEFINITION", $this->object->prepareTextareaOutput($definition->getText(), true));
                    $template->parseCurrentBlock();
                }
            }
            if (is_object($term)) {
                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('enlarge.svg'));
                    $template->parseCurrentBlock();
                } else {
                    $template->setCurrentBlock('term_text');
                    $template->setVariable("TERM", $this->object->prepareTextareaOutput($term->getText(), true));
                    $template->parseCurrentBlock();
                }
                $i++;
            }
            if (($active_id > 0) && (!$show_correct_solution)) {
                if ($graphicalOutput) {
                    // 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(array());
            $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", $this->object->prepareTextareaOutput($feedback, true));
        }
 
        $solutiontemplate->setVariable("SOLUTION_OUTPUT", $questionoutput);
 
        $solutionoutput = $solutiontemplate->get();
        if (!$show_question_only) {
            // get page object output
            $solutionoutput = $this->getILIASPage($solutionoutput);
        }
        return $solutionoutput;
    }

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 974 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() . '"&nbsp;' . $this->lng->txt("matches") . '&nbsp;"';
            $feedback .= $ans->getTerm()->getText() . '"</td><td>';
            $feedback .= $fb . '</td> </tr>';
        }
 
        $feedback .= '</tbody></table>';
        return $this->object->prepareTextareaOutput($feedback, true);
    }

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

Here is the call graph for this function:

getTestOutput()

assMatchingQuestionGUI::getTestOutput	(		$active_id,
			$pass,
			$is_postponed = false,
			$user_post_solution = false,
			$inlineFeedback = false
	)

Reimplemented from assQuestionGUI.

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

                                                                                                                                 : string
    // hey.
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        if ($DIC->http()->agent()->isMobile() || $DIC->http()->agent()->isIpad()) {
            require_once 'Services/jQuery/classes/class.iljQueryUtil.php';
            iljQueryUtil::initjQuery();
            iljQueryUtil::initjQueryUI();
            $this->tpl->addJavaScript('./node_modules/@andxor/jquery-ui-touch-punch-fix/jquery.ui.touch-punch.js');
        }
        $this->tpl->addJavaScript('Modules/TestQuestionPool/js/ilMatchingQuestion.js');
        $this->tpl->addOnLoadCode('ilMatchingQuestionInit();');
        $this->tpl->addCss(ilUtil::getStyleSheetLocation('output', 'test_javascript.css', 'Modules/TestQuestionPool'));
 
        $template = new ilTemplate("tpl.il_as_qpl_matching_output.html", true, true, "Modules/TestQuestionPool");
 
        $solutions = array();
        if ($active_id) {
            if (is_array($user_post_solution)) {
                foreach ($user_post_solution['matching'][$this->object->getId()] as $definition => $term) {
                    array_push($solutions, array("value1" => $term, "value2" => $definition));
                }
            } else {
                // hey: prevPassSolutions - obsolete due to central check
                $solutions = $this->object->getTestOutputSolutions($active_id, $pass);
                // hey.
            }
 
            $counter = 0;
            foreach ($solutions as $idx => $solution_value) {
                if (($solution_value["value2"] > -1) && ($solution_value["value1"] > -1)) {
                    $template->setCurrentBlock("matching_data");
                    $template->setVariable("TERM_ID", $solution_value["value1"]);
                    $template->setVariable("DEFINITION_ID", $solution_value["value2"]);
                    $template->parseCurrentBlock();
                }
 
                $counter++;
            }
        }
 
        $terms = $this->object->getTerms();
        $definitions = $this->object->getDefinitions();
        switch ($this->object->getShuffleMode()) {
            case 1:
                $terms = $this->object->getShuffler()->transform($terms);
                if (count($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 (count($solutions)) {
                    $definitions = $this->sortDefinitionsBySolution($solutions, $definitions);
                } else {
                    $definitions = $this->object->getShuffler()->transform($definitions);
                }
                break;
        }
 
        // create definitions
        $counter = 0;
        foreach ($definitions as $definition) {
            if (strlen($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->object->prepareTextareaOutput($definition->getText(), true, true) : '');
                $template->setVariable("TEXT_PREVIEW", $this->lng->txt('preview'));
                $template->setVariable("IMG_PREVIEW", ilUtil::getImagePath('enlarge.svg'));
                $template->parseCurrentBlock();
            } else {
                $template->setCurrentBlock("definition_text");
                $template->setVariable("DEFINITION", $this->object->prepareTextareaOutput($definition->getText(), true, true));
                $template->parseCurrentBlock();
            }
 
            $template->setCurrentBlock("droparea");
            $template->setVariable("ID_DROPAREA", $definition->getIdentifier());
            $template->setVariable("QUESTION_ID", $this->object->getId());
            $template->parseCurrentBlock();
 
            $template->setCurrentBlock("definition_data");
            $template->setVariable("DEFINITION_ID", $definition->getIdentifier());
            $template->parseCurrentBlock();
        }
 
        // create terms
        $counter = 0;
        foreach ($terms as $term) {
            if (strlen($term->getPicture())) {
                $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", (strlen($term->getText())) ? $this->object->prepareTextareaOutput($term->getText(), true, true) : '');
                $template->setVariable("IMG_PREVIEW", ilUtil::getImagePath('enlarge.svg'));
                $template->parseCurrentBlock();
            } else {
                $template->setCurrentBlock("term_text");
                $template->setVariable("TERM_TEXT", $this->object->prepareTextareaOutput($term->getText(), true, true));
                $template->parseCurrentBlock();
            }
            $template->setCurrentBlock("draggable");
            $template->setVariable("ID_DRAGGABLE", $term->getIdentifier());
            $template->parseCurrentBlock();
 
            $template->setCurrentBlock('term_data');
            $template->setVariable('TERM_ID', $term->getIdentifier());
            $template->parseCurrentBlock();
        }
 
        $template->setVariable('MATCHING_MODE', $this->object->getMatchingMode());
 
        $template->setVariable("RESET_BUTTON", $this->lng->txt("reset_terms"));
 
        $template->setVariable("QUESTIONTEXT", $this->object->getQuestionForHTMLOutput());
 
        return $this->outQuestionPage("", $is_postponed, $active_id, $template->get());
    }

References $DIC, ilUtil\getImagePath(), ilUtil\getStyleSheetLocation(), iljQueryUtil\initjQuery(), iljQueryUtil\initjQueryUI(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Here is the call graph for this function:

isCorrectMatching()

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

private

Definition at line 1050 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 296 of file class.assMatchingQuestionGUI.php.

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

References ILIAS\Repository\ctrl().

Referenced by populateAnswerSpecificFormPart().

Here is the call graph for this function:

Here is the caller graph for this function:

isTermImgUploadCommand()

assMatchingQuestionGUI::isTermImgUploadCommand ( )

private

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

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

References ILIAS\Repository\ctrl().

Referenced by populateAnswerSpecificFormPart().

Here is the call graph for this function:

Here is the caller 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 313 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.

Referenced by editQuestion().

Here is the call graph for this function:

Here is the caller graph for this function:

populateAnswerSpecificFormPart()

assMatchingQuestionGUI::populateAnswerSpecificFormPart

(

\ilPropertyFormGUI

$form

)

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

                                                                            : ilPropertyFormGUI
    {
        // Definitions
        include_once "./Modules/TestQuestionPool/classes/class.ilMatchingWizardInputGUI.php";
        $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'));
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingDefinition.php";
        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();
        }
        $form->addItem($definitions);
 
        // Terms
        include_once "./Modules/TestQuestionPool/classes/class.ilMatchingWizardInputGUI.php";
        $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'));
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingTerm.php";
        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();
        }
        $form->addItem($terms);
 
        // Matching Pairs
        include_once "./Modules/TestQuestionPool/classes/class.ilMatchingPairWizardInputGUI.php";
        $pairs = new ilMatchingPairWizardInputGUI($this->lng->txt('matching_pairs'), 'pairs');
        $pairs->setRequired(true);
        $pairs->setTerms($this->object->getTerms());
        $pairs->setDefinitions($this->object->getDefinitions());
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingPair.php";
        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(), isDefImgUploadCommand(), isTermImgUploadCommand(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by editQuestion().

Here is the call graph for this function:

Here is the caller graph for this function:

populateCorrectionsFormProperties()

assMatchingQuestionGUI::populateCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Reimplemented from assQuestionGUI.

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

                                                                              : void
    {
        require_once 'Modules/TestQuestionPool/classes/forms/class.ilAssMatchingPairCorrectionsInputGUI.php';
        $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:

populateQuestionSpecificFormPart()

assMatchingQuestionGUI::populateQuestionSpecificFormPart

(

\ilPropertyFormGUI

$form

)

Definition at line 400 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 = array(
                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($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().

Referenced by editQuestion().

Here is the call graph for this function:

Here is the caller graph for this function:

removedefinitions()

assMatchingQuestionGUI::removedefinitions

(

)

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

                                       : void
    {
        $this->writePostData(true);
        $position = key($_POST["cmd"]["removedefinitions"]);
        $this->object->deleteDefinition($position);
        $this->editQuestion();
    }

References editQuestion(), and writePostData().

Here is the call graph for this function:

removeimagedefinitions()

assMatchingQuestionGUI::removeimagedefinitions

(

)

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

                                            : void
    {
        $this->writePostData(true);
        $position = key($_POST['cmd']['removeimagedefinitions']);
        $this->object->removeDefinitionImage($position);
        $this->editQuestion();
    }

References editQuestion(), and writePostData().

Here is the call graph for this function:

removeimageterms()

assMatchingQuestionGUI::removeimageterms

(

)

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

                                      : void
    {
        $this->writePostData(true);
        $position = key($_POST['cmd']['removeimageterms']);
        $this->object->removeTermImage($position);
        $this->editQuestion();
    }

References editQuestion(), and writePostData().

Here is the call graph for this function:

removepairs()

assMatchingQuestionGUI::removepairs

(

)

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

                                 : void
    {
        $this->writePostData(true);
        $position = key($_POST["cmd"]["removepairs"]);
        $this->object->deleteMatchingPair($position);
        $this->editQuestion();
    }

References editQuestion(), and writePostData().

Here is the call graph for this function:

removeterms()

assMatchingQuestionGUI::removeterms

(

)

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

                                 : void
    {
        $this->writePostData(true);
        $position = key($_POST["cmd"]["removeterms"]);
        $this->object->deleteTerm($position);
        $this->editQuestion();
    }

References editQuestion(), and writePostData().

Here is the call graph for this function:

saveCorrectionsFormProperties()

assMatchingQuestionGUI::saveCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

Reimplemented from assQuestionGUI.

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

                                                                          : void
    {
        $pairs = $this->object->getMatchingPairs();
        $nu_pairs = [];
 
        if ($this->request->isset('pairs')) {
            $points_of_pairs = $this->request->raw('pairs')['points'];
            $pair_terms = explode(',', $this->request->raw('pairs')['term_id']);
            $pair_definitions = explode(',', $this->request->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.

uploaddefinitions()

assMatchingQuestionGUI::uploaddefinitions

(

)

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

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

References editQuestion(), and writePostData().

Here is the call graph for this function:

uploadterms()

assMatchingQuestionGUI::uploadterms

(

)

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

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

References editQuestion(), and writePostData().

Here is the call graph for this function:

writeAnswerSpecificPostData()

assMatchingQuestionGUI::writeAnswerSpecificPostData

(

ilPropertyFormGUI

$form

)

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

Implements ilGuiAnswerScoringAdjustable.

Definition at line 72 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();
 
        $uploads = $this->request->getProcessedUploads();
        $allowed_mime_types = ['image/jpeg', 'image/png', 'image/gif'];
 
        if ($this->request->isset('terms')) {
            $answers = $this->request->raw('terms')['answer'] ?? [];
            $terms_image_names = $this->request->raw('terms')['imagename'] ?? [];
            $terms_identifiers = $this->request->raw('terms')['identifier'] ?? [];
 
            foreach ($answers as $index => $answer) {
                $filename = $terms_image_names[$index] ?? '';
 
                $upload_tmp_name = $this->request->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] ?? ''
                    )
                );
            }
        }
 
        if ($this->request->isset('definitions')) {
            $answers = $this->request->raw('definitions')['answer'] ?? [];
            $definitions_image_names = $this->request->raw('definitions')['imagename'] ?? [];
            $definitions_identifiers = $this->request->raw('definitions')['identifier'] ?? [];
 
            foreach ($answers as $index => $answer) {
                $filename = $definitions_image_names[$index] ?? '';
 
                $upload_tmp_name = $this->request->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] ?? ''
                    )
                );
            }
        }
 
        if ($this->request->isset('pairs')) {
            $points_of_pairs = $this->request->raw('pairs')['points'] ?? [];
            $pair_terms = $this->request->raw('pairs')['term'] ?? [];
            $pair_definitions = $this->request->raw('pairs')['definition'] ?? [];
 
            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),
                    (float) str_replace(',', '.', $points)
                );
            }
        }
    }

References $filename, $index, $name, ILIAS\Repository\object(), 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 58 of file class.assMatchingQuestionGUI.php.

                                                          : int
    {
        $hasErrors = (!$always) ? $this->editQuestion(true) : false;
        if (!$hasErrors) {
            require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
            $this->writeQuestionGenericPostData();
            $this->writeQuestionSpecificPostData(new ilPropertyFormGUI());
            $this->writeAnswerSpecificPostData(new ilPropertyFormGUI());
            $this->saveTaxonomyAssignments();
            return 0;
        }
        return 1;
    }

References 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 $_POST and applies them to the data object.

Implements ilGuiQuestionScoringAdjustable.

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

                                                                          : void
    {
        if (!$this->object->getSelfAssessmentEditingMode()) {
            $this->object->setShuffle($_POST["shuffle"] ?? '0');
            $this->object->setShuffleMode($_POST["shuffle"] ?? '0');
        } else {
            $this->object->setShuffle(1);
            $this->object->setShuffleMode(1);
        }
        $this->object->setThumbGeometry($_POST["thumb_geometry"] ?? 0);
        $this->object->setMatchingMode($_POST['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:

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