Class for matching questions. More...

Inheritance diagram for assMatchingQuestion:

Collaboration diagram for assMatchingQuestion:

Public Member Functions
	__construct ( $title="", $comment="", $author="", $owner=-1, $question="", $matching_type=self::MT_TERMS_DEFINITIONS)
	assMatchingQuestion constructor More...

	getShuffleMode ()

	setShuffleMode (int $shuffle)

	isComplete ()

	saveToDb (?int $original_id=null)

	saveAnswerSpecificDataToDb ()
	Saves the answer specific records into a question types answer table. More...

	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...

	loadFromDb ($question_id)
	Loads a assMatchingQuestion object from a database. More...

	insertMatchingPair ($position, $term=null, $definition=null, $points=0.0)
	Inserts a matching pair for an matching choice question. More...

	addMatchingPair (?assAnswerMatchingTerm $term=null, ?assAnswerMatchingDefinition $definition=null, $points=0.0)
	Adds an matching pair for an matching choice question. More...

	getTermWithIdentifier ($a_identifier)
	Returns a term with a given identifier. More...

	getDefinitionWithIdentifier ($a_identifier)
	Returns a definition with a given identifier. More...

	getMatchingPair ($index=0)
	Returns a matching pair with a given index. More...

	deleteMatchingPair ($index=0)
	Deletes a matching pair with a given index. More...

	flushMatchingPairs ()
	Deletes all matching pairs. More...

	withMatchingPairs (array $pairs)

	getMatchingPairCount ()
	Returns the number of matching pairs. More...

	getTerms ()
	Returns the terms of the matching question. More...

	getDefinitions ()
	Returns the definitions of the matching question. More...

	getTermCount ()
	Returns the number of terms. More...

	getDefinitionCount ()
	Returns the number of definitions. More...

	addTerm (assAnswerMatchingTerm $term)

	addDefinition ($definition)
	Adds a definition. More...

	insertTerm ($position, ?assAnswerMatchingTerm $term=null)
	Inserts a term. More...

	insertDefinition ($position, ?assAnswerMatchingDefinition $definition=null)
	Inserts a definition. More...

	flushTerms ()
	Deletes all terms. More...

	flushDefinitions ()
	Deletes all definitions. More...

	deleteTerm ($position)
	Deletes a term. More...

	deleteDefinition ($position)
	Deletes a definition. More...

	setTerm ($term, $index)
	Sets a specific term. More...

	calculateReachedPoints (int $active_id, ?int $pass=null, bool $authorized_solution=true)

	getMaximumPoints ()
	Calculates and Returns the maximum points, a learner can reach answering the question. More...

	getMaximumScoringMatchingPairs ()

	fetchIndexedValuesFromValuePairs (array $valuePairs)

	getEncryptedFilename ($filename)
	Returns the encrypted save filename of a matching picture Images are saved with an encrypted filename to prevent users from cheating by guessing the solution from the image filename. More...

	removeTermImage ($index)

	removeDefinitionImage ($index)

	deleteImagefile (string $filename)
	Deletes an imagefile from the system if the file is deleted manually. More...

	setImageFile (string $image_tempfilename, string $image_filename, string $previous_filename='')

	saveWorkingData (int $active_id, ?int $pass=null, bool $authorized=true)

	getRandomId ()

	setShuffle ($shuffle=true)

	getQuestionType ()
	Returns the question type of the question. More...

	getAdditionalTableName ()

	getAnswerTableName ()

	getRTETextWithMediaObjects ()
	Collects all text in the question which could contain media objects which were created with the Rich Text Editor. More...

	getMatchingPairs ()
	Returns the matchingpairs array. More...

	getThumbGeometry ()
	Get the thumbnail geometry. More...

	getThumbSize ()
	Get the thumbnail geometry. More...

	setThumbGeometry (int $a_geometry)
	Set the thumbnail geometry. More...

	rebuildThumbnails ()
	Rebuild the thumbnail images with a new thumbnail size. More...

	getThumbPrefix ()

	toJSON ()
	Returns a JSON representation of the question. More...

	setMatchingMode (string $matching_mode)

	getMatchingMode ()

	getOperators (string $expression)
	Get all available operations for a specific question. More...

	getExpressionTypes ()
	Get all available expression types for a specific question. More...

	getUserQuestionResult (int $active_id, int $pass)
	Get the user solution for a question by active_id and the test pass. More...

	getAvailableAnswerOptions ($index=null)
	If index is null, the function returns an array with all anwser options Else it returns the specific answer option. More...

	toLog (AdditionalInformationGenerator $additional_info)

	solutionValuesToText (array $solution_values)

	getCorrectSolutionForTextOutput (int $active_id, int $pass)

Public Member Functions inherited from assQuestion
	getQuestionType ()

	isComplete ()

	saveWorkingData (int $active_id, ?int $pass=null, bool $authorized=true)

	calculateReachedPoints (int $active_id, ?int $pass=null, bool $authorized_solution=true)

	getAdditionalTableName ()

	getAnswerTableName ()

	toLog (AdditionalInformationGenerator $additional_info)
	MUST return an array of the question settings that can be stored in the log. More...

	getCurrentUser ()

	getShuffler ()

	setShuffler (Transformation $shuffler)

	setProcessLocker (ilAssQuestionProcessLocker $processLocker)

	getProcessLocker ()

	fromXML (string $importdirectory, int $user_id, ilQTIItem $item, int $questionpool_id, ?int $tst_id, ?ilObject &$tst_object, int &$question_counter, array $import_mapping, array $solutionhints=[])

	toXML (bool $a_include_header=true, bool $a_include_binary=true, bool $a_shuffle=false, bool $test_output=false, bool $force_image_references=false)
	Returns a QTI xml representation of the question. More...

	setTitle (string $title="")

	setId (int $id=-1)

	setTestId (int $id=-1)

	setComment (string $comment="")

	setShuffle (?bool $shuffle=true)

	setAuthor (string $author="")

	setOwner (int $owner=-1)

	getTitle ()

	getTitleForHTMLOutput ()

	getTitleFilenameCompliant ()

	getId ()

	getShuffle ()

	getTestId ()

	getComment ()

	getDescriptionForHTMLOutput ()

	getThumbSize ()

	setThumbSize (int $a_size)

	getMinimumThumbSize ()

	getMaximumThumbSize ()

	getAuthor ()

	getAuthorForHTMLOutput ()

	getOwner ()

	getObjId ()

	setObjId (int $obj_id=0)

	getLifecycle ()

	setLifecycle (ilAssQuestionLifecycle $lifecycle)

	setExternalId (?string $external_id)

	getExternalId ()

	getSuggestedSolutionOutput ()

	getSuggestedSolutions ()

	getReachedPoints (int $active_id, int $pass)

	getMaximumPoints ()

	getAdjustedReachedPoints (int $active_id, int $pass, bool $authorized_solution=true)

	calculateResultsFromSolution (int $active_id, int $pass)
	Calculates the question results from a previously saved question solution. More...

	persistWorkingState (int $active_id, $pass, bool $authorized=true)
	persists the working state for current testactive and testpass More...

	persistPreviewState (ilAssQuestionPreviewSession $preview_session)
	persists the preview state for current user and question More...

	validateSolutionSubmit ()

	getSuggestedSolutionPath ()

	getImagePath ($question_id=null, $object_id=null)
	Returns the image path for web accessable images of a question. More...

	getSuggestedSolutionPathWeb ()

	getImagePathWeb ()
	Returns the web image path for web accessable images of a question. More...

	getTestOutputSolutions (int $activeId, int $pass)

	getUserSolutionPreferingIntermediate (int $active_id, ?int $pass=null)

	getSolutionValues (int $active_id, ?int $pass=null, bool $authorized=true)
	Loads solutions of a given user from the database an returns it. More...

	deleteAnswers (int $question_id)

	deleteAdditionalTableData (int $question_id)

	delete (int $question_id)

	getTotalAnswers ()

	cloneXHTMLMediaObjectsOfQuestion (int $source_question_id)

	createPageObject ()

	clonePageOfQuestion (int $a_q_id)

	getPageOfQuestion ()

	setOriginalId (?int $original_id)

	getOriginalId ()

static	fixSvgToPng (string $imageFilenameContainingString)

	fixUnavailableSkinImageSources (string $html)

	loadFromDb (int $question_id)

	createNewQuestion (bool $a_create_page=true)
	Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...

	saveQuestionDataToDb (?int $original_id=null)

	duplicate (bool $for_test=true, string $title='', string $author='', int $owner=-1, $test_obj_id=null)

	copyObject (int $target_parent_id, string $title='')

	createNewOriginalFromThisDuplicate (int $target_parent_id, string $target_question_title='')

	saveToDb (?int $original_id=null)

	deleteSuggestedSolutions ()

	getSuggestedSolution (int $subquestion_index=0)

	resolveInternalLink (string $internal_link)

	resolveSuggestedSolutionLinks ()

	getInternalLinkHref (string $target)

	syncWithOriginal ()

	getPoints ()

	setPoints (float $points)

	getSolutionMaxPass (int $active_id)

	isWriteable ()

	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $preview_session, $reached_points)

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $preview_session)

	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $preview_session)

	adjustReachedPointsByScoringOptions (float $points, int $active_id)
	Adjust the given reached points by checks for all special scoring options in the test container. More...

	buildHashedImageFilename (string $plain_image_filename, bool $unique=false)

	getQuestion ()

	getQuestionForHTMLOutput ()

	setQuestion (string $question="")

	getQuestionTypeID ()

	cloneHints (int $source_question_id, int $target_question_id)

	cleanupMediaObjectUsage ()

	getInstances ()

	getActiveUserData (int $active_id)
	Returns the user id and the test id for a given active id. More...

	hasSpecificFeedback ()

	getNrOfTries ()

	setNrOfTries (int $a_nr_of_tries)

	setExportImagePath (string $path)

	formatSAQuestion ($a_q)

	setPreventRteUsage (bool $prevent_rte_usage)

	getPreventRteUsage ()

	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)

	setSelfAssessmentEditingMode (bool $selfassessmenteditingmode)

	getSelfAssessmentEditingMode ()

	setDefaultNrOfTries (int $defaultnroftries)

	getDefaultNrOfTries ()

	syncSkillAssignments (int $srcParentId, int $srcQuestionId, int $trgParentId, int $trgQuestionId)

	ensureHintPageObjectExists ($pageObjectId)

	isAnswered (int $active_id, int $pass)

	getAdditionalContentEditingMode ()

	setAdditionalContentEditingMode (?string $additionalContentEditingMode)

	isAdditionalContentEditingModePageObject ()

	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)

	getValidAdditionalContentEditingModes ()

	getHtmlUserSolutionPurifier ()

	getHtmlQuestionContentPurifier ()

	setLastChange (int $lastChange)

	getLastChange ()

	removeIntermediateSolution (int $active_id, int $pass)

	removeCurrentSolution (int $active_id, int $pass, bool $authorized=true)

	saveCurrentSolution (int $active_id, int $pass, $value1, $value2, bool $authorized=true, $tstamp=0)

	updateCurrentSolution (int $solutionId, $value1, $value2, bool $authorized=true)

	updateCurrentSolutionsAuthorization (int $activeId, int $pass, bool $authorized, bool $keepTime=false)

	setStep ($step)

	getStep ()

	toJSON ()

	intermediateSolutionExists (int $active_id, int $pass)

	authorizedSolutionExists (int $active_id, ?int $pass)

	authorizedOrIntermediateSolutionExists (int $active_id, int $pass)

	lookupForExistingSolutions (int $activeId, int $pass)
	Lookup if an authorized or intermediate solution exists. More...

	isAddableAnswerOptionValue (int $qIndex, string $answerOptionValue)

	addAnswerOptionValue (int $qIndex, string $answerOptionValue, float $points)

	removeAllExistingSolutions ()

	removeExistingSolutions (int $activeId, int $pass)

	resetUsersAnswer (int $activeId, int $pass)

	removeResultRecord (int $activeId, int $pass)

	fetchValuePairsFromIndexedValues (array $indexedValues)

	fetchIndexedValuesFromValuePairs (array $value_pairs)

	updateTimestamp ()

	getTestPresentationConfig ()

	hasWritableOriginalInQuestionPool ()

	answerToParticipantInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, int $active_id, int $pass, string $source_ip, TestParticipantInteractionTypes $interaction_type)

	toQuestionAdministrationInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, TestQuestionAdministrationInteractionTypes $interaction_type)

	getSolutionForTextOutput (int $active_id, int $pass)

	getCorrectSolutionForTextOutput (int $active_id, int $pass)

	getVariablesAsTextArray (int $active_id, int $pass)

Public Member Functions inherited from iQuestionCondition
	getAvailableAnswerOptions (?int $index=null)
	If index is null, the function returns an array with all anwser options else it returns the specific answer option. More...

Data Fields
const	MT_TERMS_PICTURES = 0

const	MT_TERMS_DEFINITIONS = 1

const	MATCHING_MODE_1_ON_1 = '1:1'

const	MATCHING_MODE_N_ON_N = 'n:n'

int	$thumb_geometry = 100

int	$element_height

int	$matching_type

	$matchingpairs

Data Fields inherited from assQuestion
const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'

const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'

const	TRIM_PATTERN = '/^[\p{C}\p{Z}]+\|[\p{C}\p{Z}]+$/u'

ilAssQuestionFeedback	$feedbackOBJ

bool	$prevent_rte_usage = false

bool	$selfassessmenteditingmode = false

int	$defaultnroftries = 0

string	$questionActionCmd = 'handleQuestionAction'

const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'

Data Fields inherited from iQuestionCondition
const	StringResultExpression = '~TEXT~'

const	PercentageResultExpression = '%n%'

const	NumericResultExpression = '#n#'

const	MatchingResultExpression = ';n:m;'

const	OrderingResultExpression = '$n,m,o,p$'

const	NumberOfResultExpression = '+n+'

const	ExclusiveResultExpression = 'n,m,o,p'

const	EmptyAnswerExpression = "?"

Protected Member Functions
	cloneQuestionTypeSpecificProperties (\assQuestion $target)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	generateThumbForFile ($path, $file)

	calculateReachedPointsForSolution (?array $found_values)

	afterSyncWithOriginal (int $original_question_id, int $clone_question_id, int $original_parent_id, int $clone_parent_id)
	{} More...

	createMatchingTerm (string $term='', string $picture='', int $identifier=0)

	createMatchingDefinition (string $term='', string $picture='', int $identifier=0)

	createMatchingPair (?assAnswerMatchingTerm $term=null, ?assAnswerMatchingDefinition $definition=null, float $points=0.0)

	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)

Protected Member Functions inherited from assQuestion
	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)
	MUST convert the given solution values into an array or a string that can be stored in the log. More...

	solutionValuesToText (array $solution_values)
	MUST convert the given solution values into text. More...

	getQuestionAction ()

	isNonEmptyItemListPostSubmission (string $post_submission_field_name)

	savePreviewData (ilAssQuestionPreviewSession $preview_session)

	deletePageOfQuestion (int $question_id)

	cloneQuestionTypeSpecificProperties (self $target)

	removeAllImageFiles (string $image_target_path)

	onDuplicate (int $original_parent_id, int $original_question_id, int $duplicate_parent_id, int $duplicate_question_id)

	afterSyncWithOriginal (int $original_question_id, int $clone_question_id, int $original_parent_id, int $clone_parent_id)

	onCopy (int $sourceParentId, int $sourceQuestionId, int $targetParentId, int $targetQuestionId)

	duplicateComments (int $parent_source_id, int $source_id, int $parent_target_id, int $target_id)

	deleteComments ()

	getNotesManager ()

	getNotesDataService ()

	getNotesRepo ()

	cloneSuggestedSolutions (int $source_question_id, int $target_question_id)

	duplicateSuggestedSolutionFiles (int $parent_id, int $question_id)
	Duplicates the files of a suggested solution if the question is duplicated. More...

	cloneSuggestedSolutionFiles (int $source_question_id, int $target_question_id)

	copySuggestedSolutions (int $target_question_id)

	ensureNonNegativePoints (float $points)

	purifyAndPrepareTextAreaOutput (string $content)

	getRTETextWithMediaObjects ()

	getSelfAssessmentFormatter ()

	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	duplicateQuestionHints (int $original_question_id, int $duplicate_question_id)

	duplicateSkillAssignments (int $srcParentId, int $srcQuestionId, int $trgParentId, int $trgQuestionId)

	buildQuestionDataQuery ()

	getCurrentSolutionResultSet (int $active_id, int $pass, bool $authorized=true)

	removeSolutionRecordById (int $solutionId)

	getSolutionRecordById (int $solutionId)

	deleteDummySolutionRecord (int $activeId, int $passIndex)

	isDummySolutionRecord (array $solutionRecord)

	deleteSolutionRecordByValues (int $activeId, int $passIndex, bool $authorized, array $matchValues)

	duplicateIntermediateSolutionAuthorized (int $activeId, int $passIndex)

	forceExistingIntermediateSolution (int $activeId, int $passIndex, bool $considerDummyRecordCreation)

	lookupMaxStep (int $active_id, int $pass)

	buildTestPresentationConfig ()

	getSuggestedSolutionsRepo ()

	loadSuggestedSolutions ()

	answerToLog (AdditionalInformationGenerator $additional_info, int $active_id, int $pass)

Protected Attributes
string	$matching_mode = self::MATCHING_MODE_1_ON_1

array	$terms = []

array	$definitions = []

Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true

GeneralQuestionPropertiesRepository	$questionrepository

RequestDataCollector	$questionpool_request

QuestionFiles	$question_files

ilAssQuestionProcessLocker	$processLocker

ilTestQuestionConfig	$testQuestionConfig

SuggestedSolutionsDatabaseRepository	$suggestedsolution_repo

ILIAS	$ilias

ilGlobalPageTemplate	$tpl

ilLanguage	$lng

ilDBInterface	$db

ilObjUser	$current_user

SkillUsageService	$skillUsageService

HTTPServices	$http

Refinery	$refinery

Transformation	$shuffler

LoggingServices	$log

Container	$dic

ilAssQuestionLifecycle	$lifecycle

ilAssQuestionPage	$page

int	$id

string	$title

string	$comment

int	$owner

string	$author

int	$thumb_size

string	$question

float	$points = 0.0

bool	$shuffle = true

int	$test_id

int	$obj_id = 0

int	$original_id = null

int	$lastChange = null

string	$external_id = null

int	$step = null

array	$suggested_solutions

Private Member Functions
	cloneImages (int $source_question_id, int $source_parent_id, int $target_question_id, int $target_parent_id)

	getPositiveScoredMatchingPairs ()

	getMostPositiveScoredUniqueTermMatchingPairs ()

	checkSubmittedMatchings (array $submitted_matchings)

Private Attributes
int	$shufflemode = 0

RandomGroup	$randomGroup

Additional Inherited Members
Static Public Member Functions inherited from assQuestion
static	setForcePassResultUpdateEnabled (bool $force_pass_results_update_enabled)

static	isForcePassResultUpdateEnabled ()

static	_getSuggestedSolutionOutput (int $question_id)

static	_getReachedPoints (int $active_id, int $question_id, int $pass)

static	isFileAvailable (string $file)

static	saveOriginalId (int $questionId, int $originalId)

static	resetOriginalId (int $questionId)

static	instantiateQuestion (int $question_id)

static	_getSolutionMaxPass (int $question_id, int $active_id)
	Returns the maximum pass a users question solution. More...

static	_setReachedPoints (int $active_id, int $question_id, float $points, float $maxpoints, int $pass, bool $manualscoring)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...

static	getFeedbackClassNameByQuestionType (string $questionType)

static	_questionExistsInTest (int $question_id, int $test_id)

static	lookupParentObjId (int $question_id)

static	implodeKeyValues (array $keyValues)

static	explodeKeyValues (string $keyValues)

static	convertISO8601FormatH_i_s_ExtendedToSeconds (string $time)

static	extendedTrim (string $value)
	Trim non-printable characters from the beginning and end of a string. More...

Static Protected Member Functions inherited from assQuestion
static	getNumExistingSolutionRecords (int $activeId, int $pass, int $questionId)

Static Protected Attributes inherited from assQuestion
static	$force_pass_results_update_enabled = false

static	$imageSourceFixReplaceMap

Detailed Description

Class for matching questions.

assMatchingQuestion is a class 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$

Definition at line 40 of file class.assMatchingQuestion.php.

Constructor & Destructor Documentation

◆ __construct()

assMatchingQuestion::__construct	(	$title = `""`,
		$comment = `""`,
		$author = `""`,
		$owner = `-1`,
		$question = `""`,
		$matching_type = `self::MT_TERMS_DEFINITIONS`
	)

assMatchingQuestion constructor

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

Parameters

string	$title	A title string to describe the question
string	$comment	A comment string to describe the question
string	$author	A string containing the name of the questions author
integer	$owner	A numerical ID to identify the owner/creator
string	$question	The question string of the matching question
int	$matching_type

Definition at line 87 of file class.assMatchingQuestion.php.

References assQuestion\$author, assQuestion\$comment, $DIC, $matching_type, assQuestion\$owner, assQuestion\$question, assQuestion\$title, and ILIAS\GlobalScreen\Provider\__construct().

       {
         global $DIC;
 
         parent::__construct($title, $comment, $author, $owner, $question);
         $this->matchingpairs = [];
         $this->matching_type = $matching_type;
         $this->terms = [];
         $this->definitions = [];
         $this->randomGroup = $DIC->refinery()->random();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addDefinition()

assMatchingQuestion::addDefinition ( $definition )

Adds a definition.

Parameters

object $definition The definition

See also: $definitions

Definition at line 584 of file class.assMatchingQuestion.php.

                                               : void
     {
         array_push($this->definitions, $definition);
     }

◆ addMatchingPair()

assMatchingQuestion::addMatchingPair	(	?assAnswerMatchingTerm	$term = `null`,
		?assAnswerMatchingDefinition	$definition = `null`,
			$points = `0.0`
	)

Adds an matching pair for an matching choice question.

The students have to fill in an order for the matching pair. The matching pair is an ASS_AnswerMatching object that will be created and assigned to the array $this->matchingpairs.

Parameters

assAnswerMatchingTerm \| null	$term	A matching term
assAnswerMatchingDefinition \| null	$definition	A matching definition
float	$points	The points for selecting the matching pair, incl. negative.

See also: $matchingpairs

Definition at line 422 of file class.assMatchingQuestion.php.

References assQuestion\$points, and createMatchingPair().

                                                                                                                                         : void
     {
         $pair = $this->createMatchingPair($term, $definition, $points);
         array_push($this->matchingpairs, $pair);
     }

Here is the call graph for this function:

◆ addTerm()

assMatchingQuestion::addTerm ( assAnswerMatchingTerm $term )

Definition at line 573 of file class.assMatchingQuestion.php.

                                                         : void
     {
         $this->terms[] = $term;
     }

◆ afterSyncWithOriginal()

assMatchingQuestion::afterSyncWithOriginal	(	int	$original_question_id,
		int	$clone_question_id,
		int	$original_parent_id,
		int	$clone_parent_id
	)

protected

{}

Definition at line 1309 of file class.assMatchingQuestion.php.

References ilFileUtils\delDir(), ilFileUtils\makeDirParents(), and ilFileUtils\rCopy().

      : void {
         parent::afterSyncWithOriginal($original_question_id, $clone_question_id, $original_parent_id, $clone_parent_id);
 
         $original_image_path = $this->question_files->buildImagePath($original_question_id, $original_parent_id);
         $clone_image_path = $this->question_files->buildImagePath($clone_question_id, $clone_parent_id);
 
         ilFileUtils::delDir($original_image_path);
         if (is_dir($clone_image_path)) {
             ilFileUtils::makeDirParents($original_image_path);
             ilFileUtils::rCopy($clone_image_path, $original_image_path);
         }
     }

Here is the call graph for this function:

◆ calculateReachedPoints()

assMatchingQuestion::calculateReachedPoints	(	int	$active_id,
		?int	$pass = `null`,
		bool	$authorized_solution = `true`
	)

Definition at line 683 of file class.assMatchingQuestion.php.

References $data, assQuestion\$points, calculateReachedPointsForSolution(), assQuestion\getCurrentSolutionResultSet(), and assQuestion\getSolutionMaxPass().

Referenced by getUserQuestionResult().

      : float {
         $found_values = [];
         if (is_null($pass)) {
             $pass = $this->getSolutionMaxPass($active_id);
         }
         $result = $this->getCurrentSolutionResultSet($active_id, (int) $pass, $authorized_solution);
         while ($data = $this->db->fetchAssoc($result)) {
             if ($data['value1'] === '') {
                 continue;
             }
 
             if (!isset($found_values[$data['value2']])) {
                 $found_values[$data['value2']] = [];
             }
 
             $found_values[$data['value2']][] = $data['value1'];
         }
 
         $points = $this->calculateReachedPointsForSolution($found_values);
 
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPointsForSolution()

assMatchingQuestion::calculateReachedPointsForSolution ( ?array $found_values )

protected

Definition at line 1194 of file class.assMatchingQuestion.php.

References assQuestion\$points.

Referenced by calculateReachedPoints().

                                                                               : float
     {
         $points = 0.0;
         if (!is_array($found_values)) {
             return $points;
         }
         foreach ($found_values as $definition => $terms) {
             if (!is_array($terms)) {
                 continue;
             }
             foreach ($terms as $term) {
                 foreach ($this->matchingpairs as $pair) {
                     if ($pair->getDefinition()->getIdentifier() == $definition
                         && $pair->getTerm()->getIdentifier() == $term) {
                         $points += $pair->getPoints();
                     }
                 }
             }
         }
         return $points;
     }

Here is the caller graph for this function:

◆ checkSubmittedMatchings()

assMatchingQuestion::checkSubmittedMatchings ( array $submitted_matchings )

private

Definition at line 887 of file class.assMatchingQuestion.php.

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

Referenced by savePreviewData(), and saveWorkingData().

                                                                         : bool
     {
         if ($this->getMatchingMode() == self::MATCHING_MODE_N_ON_N) {
             return true;
         }
 
         $handledTerms = [];
 
         foreach ($submitted_matchings as $terms) {
             if (count($terms) > 1) {
                 $this->tpl->setOnScreenMessage('failure', $this->lng->txt("multiple_matching_values_selected"), true);
                 return false;
             }
 
             foreach ($terms as $i => $term) {
                 if (isset($handledTerms[$term])) {
                     $this->tpl->setOnScreenMessage('failure', $this->lng->txt("duplicate_matching_values_selected"), true);
                     return false;
                 }
 
                 $handledTerms[$term] = $term;
             }
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneImages()

assMatchingQuestion::cloneImages	(	int	$source_question_id,
		int	$source_parent_id,
		int	$target_question_id,
		int	$target_parent_id
	)

private

Definition at line 330 of file class.assMatchingQuestion.php.

References $filename, assQuestion\getImagePath(), getThumbPrefix(), ilFileUtils\makeDirParents(), and assQuestion\removeAllImageFiles().

      : void {
         $image_source_path = $this->getImagePath($source_question_id, $source_parent_id);
         $image_target_path = $this->getImagePath($target_question_id, $target_parent_id);
 
         if (!file_exists($image_target_path)) {
             ilFileUtils::makeDirParents($image_target_path);
         } else {
             $this->removeAllImageFiles($image_target_path);
         }
 
         foreach ($this->terms as $term) {
             if ($term->getPicture() === '') {
                 continue;
             }
 
             $filename = $term->getPicture();
             if (!file_exists($image_source_path . $filename)
                 || !copy($image_source_path . $filename, $image_target_path . $filename)) {
                 $this->log->root()->warning('matching question image could not be copied: '
                     . $image_source_path . $filename);
             }
             if (!file_exists($image_source_path . $this->getThumbPrefix() . $filename)
                 || !copy(
                     $image_source_path . $this->getThumbPrefix() . $filename,
                     $image_target_path . $this->getThumbPrefix() . $filename
                 )) {
                 $this->log->root()->warning('matching question image thumbnail could not be copied: '
                     . $image_source_path . $this->getThumbPrefix() . $filename);
             }
         }
         foreach ($this->definitions as $definition) {
             if ($definition->getPicture() === '') {
                 continue;
             }
             $filename = $definition->getPicture();
 
             if (!file_exists($image_source_path . $filename)
                 || !copy($image_source_path . $filename, $image_target_path . $filename)) {
                 $this->log->root()->warning('matching question image could not be copied: '
                     . $image_source_path . $filename);
             }
 
             if (!file_exists($image_source_path . $this->getThumbPrefix() . $filename)
                 || !copy(
                     $image_source_path . $this->getThumbPrefix() . $filename,
                     $image_target_path . $this->getThumbPrefix() . $filename
                 )) {
                 $this->log->root()->warning('matching question image thumbnail could not be copied: '
                     . $image_source_path . $this->getThumbPrefix() . $filename);
             }
         }
     }

Here is the call graph for this function:

◆ cloneQuestionTypeSpecificProperties()

assMatchingQuestion::cloneQuestionTypeSpecificProperties ( \assQuestion $target )

protected

Definition at line 323 of file class.assMatchingQuestion.php.

References assQuestion\getId(), and assQuestion\getObjId().

      : \assQuestion {
         $target->cloneImages($this->getId(), $this->getObjId(), $target->getId(), $target->getObjId());
         return $target;
     }

Here is the call graph for this function:

◆ createMatchingDefinition()

assMatchingQuestion::createMatchingDefinition	(	string	$term = `''`,
		string	$picture = `''`,
		int	$identifier = `0`
	)

protected

Definition at line 1331 of file class.assMatchingQuestion.php.

Referenced by createMatchingPair(), insertDefinition(), and loadFromDb().

                                                                                                              : assAnswerMatchingDefinition
     {
         return new assAnswerMatchingDefinition($term, $picture, $identifier);
     }

Here is the caller graph for this function:

◆ createMatchingPair()

assMatchingQuestion::createMatchingPair	(	?assAnswerMatchingTerm	$term = `null`,
		?assAnswerMatchingDefinition	$definition = `null`,
		float	$points = `0.0`
	)

protected

Definition at line 1335 of file class.assMatchingQuestion.php.

References assQuestion\$points, createMatchingDefinition(), and createMatchingTerm().

Referenced by addMatchingPair(), insertMatchingPair(), and loadFromDb().

      : assAnswerMatchingPair {
         $term = $term ?? $this->createMatchingTerm();
         $definition = $definition ?? $this->createMatchingDefinition();
         return new assAnswerMatchingPair($term, $definition, $points);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMatchingTerm()

assMatchingQuestion::createMatchingTerm	(	string	$term = `''`,
		string	$picture = `''`,
		int	$identifier = `0`
	)

protected

Definition at line 1327 of file class.assMatchingQuestion.php.

Referenced by createMatchingPair(), insertTerm(), and loadFromDb().

                                                                                                        : assAnswerMatchingTerm
     {
         return new assAnswerMatchingTerm($term, $picture, $identifier);
     }

Here is the caller graph for this function:

◆ deleteDefinition()

assMatchingQuestion::deleteDefinition ( $position )

Deletes a definition.

Parameters

integer $position The position of the definition in the definition array

See also: $definitions

Definition at line 665 of file class.assMatchingQuestion.php.

                                                : void
     {
         unset($this->definitions[$position]);
         $this->definitions = array_values($this->definitions);
     }

◆ deleteImagefile()

assMatchingQuestion::deleteImagefile ( string $filename )

Deletes an imagefile from the system if the file is deleted manually.

Parameters

string $filename Image file filename

Returns: boolean Success

Definition at line 832 of file class.assMatchingQuestion.php.

References Vendor\Package\$e, $filename, assQuestion\getImagePath(), and getThumbPrefix().

Referenced by removeDefinitionImage(), removeTermImage(), and setImageFile().

                                                      : bool
     {
         $deletename = $filename;
         try {
             $result = unlink($this->getImagePath() . $deletename)
                 && unlink($this->getImagePath() . $this->getThumbPrefix() . $deletename);
         } catch (Throwable $e) {
             $result = false;
         }
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteMatchingPair()

assMatchingQuestion::deleteMatchingPair ( $index = 0 )

Deletes a matching pair with a given index.

The index of the first matching pair is 0, the index of the second matching pair is 1 and so on.

Parameters

integer $index A nonnegative index of the n-th matching pair

See also: $matchingpairs

Definition at line 483 of file class.assMatchingQuestion.php.

                                                   : void
     {
         if ($index < 0) {
             return;
         }
         if (count($this->matchingpairs) < 1) {
             return;
         }
         if ($index >= count($this->matchingpairs)) {
             return;
         }
         unset($this->matchingpairs[$index]);
         $this->matchingpairs = array_values($this->matchingpairs);
     }

◆ deleteTerm()

assMatchingQuestion::deleteTerm ( $position )

Deletes a term.

Parameters

string $term_id The id of the term to delete

See also: $terms

Definition at line 653 of file class.assMatchingQuestion.php.

                                          : void
     {
         unset($this->terms[$position]);
         $this->terms = array_values($this->terms);
     }

◆ fetchIndexedValuesFromValuePairs()

assMatchingQuestion::fetchIndexedValuesFromValuePairs ( array $valuePairs )

Parameters

array $valuePairs

Returns: array $indexedValues

Definition at line 775 of file class.assMatchingQuestion.php.

                                                                        : array
     {
         $indexedValues = [];
 
         foreach ($valuePairs as $valuePair) {
             if (!isset($indexedValues[$valuePair['value2']])) {
                 $indexedValues[$valuePair['value2']] = [];
             }
 
             $indexedValues[$valuePair['value2']][] = $valuePair['value1'];
         }
 
         return $indexedValues;
     }

◆ flushDefinitions()

assMatchingQuestion::flushDefinitions ( )

Deletes all definitions.

See also: $definitions

Definition at line 642 of file class.assMatchingQuestion.php.

                                       : void
     {
         $this->definitions = [];
     }

◆ flushMatchingPairs()

assMatchingQuestion::flushMatchingPairs ( )

Deletes all matching pairs.

See also: $matchingpairs

Definition at line 502 of file class.assMatchingQuestion.php.

                                         : void
     {
         $this->matchingpairs = [];
     }

◆ flushTerms()

assMatchingQuestion::flushTerms ( )

Deletes all terms.

See also: $terms

Definition at line 633 of file class.assMatchingQuestion.php.

                                 : void
     {
         $this->terms = [];
     }

◆ generateThumbForFile()

assMatchingQuestion::generateThumbForFile	(	$path,
		$file
	)

protected

Definition at line 1087 of file class.assMatchingQuestion.php.

References $filename, $path, ilShellUtil\convertImage(), getThumbGeometry(), and getThumbPrefix().

Referenced by rebuildThumbnails().

                                                          : void
     {
         $filename = $path . $file;
         if (file_exists($filename)) {
             $thumbpath = $path . $this->getThumbPrefix() . $file;
             $path_info = pathinfo($filename);
             $ext = "";
             switch (strtoupper($path_info['extension'])) {
                 case 'PNG':
                     $ext = 'PNG';
                     break;
                 case 'GIF':
                     $ext = 'GIF';
                     break;
                 default:
                     $ext = 'JPEG';
                     break;
             }
             ilShellUtil::convertImage($filename, $thumbpath, $ext, (string) $this->getThumbGeometry());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdditionalTableName()

assMatchingQuestion::getAdditionalTableName ( )

Definition at line 983 of file class.assMatchingQuestion.php.

Referenced by saveAdditionalQuestionDataToDb().

                                             : string
     {
         return "qpl_qst_matching";
     }

Here is the caller graph for this function:

◆ getAnswerTableName()

assMatchingQuestion::getAnswerTableName ( )

Definition at line 988 of file class.assMatchingQuestion.php.

                                         : array
     {
         return ["qpl_a_matching", "qpl_a_mterm"];
     }

◆ getAvailableAnswerOptions()

assMatchingQuestion::getAvailableAnswerOptions ( $index = null )

If index is null, the function returns an array with all anwser options Else it returns the specific answer option.

Parameters

null | int $index

Definition at line 1297 of file class.assMatchingQuestion.php.

References getMatchingPair(), getMatchingPairs(), and null.

     {
         if ($index !== null) {
             return $this->getMatchingPair($index);
         } else {
             return $this->getMatchingPairs();
         }
     }

Here is the call graph for this function:

◆ getCorrectSolutionForTextOutput()

assMatchingQuestion::getCorrectSolutionForTextOutput	(	int	$active_id,
		int	$pass
	)

Definition at line 1418 of file class.assMatchingQuestion.php.

References assAnswerMatchingPair\getDefinition(), getMatchingPairs(), and assAnswerMatchingPair\getTerm().

                                                                               : array
     {
         return array_map(
             fn(assAnswerMatchingPair $v): string => $v->getDefinition()->getText() . ': '
                 . $v->getTerm()->getText(),
             $this->getMatchingPairs()
         );
     }

Here is the call graph for this function:

◆ getDefinitionCount()

assMatchingQuestion::getDefinitionCount ( )

Returns the number of definitions.

Returns: integer The number of definitions

See also: $definitions

Definition at line 568 of file class.assMatchingQuestion.php.

                                         : int
     {
         return count($this->definitions);
     }

◆ getDefinitions()

assMatchingQuestion::getDefinitions ( )

Returns the definitions of the matching question.

Returns: array An array containing the definitions

See also: $terms

Definition at line 546 of file class.assMatchingQuestion.php.

References $definitions.

Referenced by solutionValuesToText(), toJSON(), and toLog().

                                     : array
     {
         return $this->definitions;
     }

Here is the caller graph for this function:

◆ getDefinitionWithIdentifier()

assMatchingQuestion::getDefinitionWithIdentifier ( $a_identifier )

Returns a definition with a given identifier.

Definition at line 444 of file class.assMatchingQuestion.php.

References null.

     {
         foreach ($this->definitions as $definition) {
             if ($definition->getIdentifier() == $a_identifier) {
                 return $definition;
             }
         }
         return null;
     }

◆ getEncryptedFilename()

assMatchingQuestion::getEncryptedFilename ( $filename )

Returns the encrypted save filename of a matching picture Images are saved with an encrypted filename to prevent users from cheating by guessing the solution from the image filename.

Parameters

string $filename Original filename

Returns: string Encrypted filename

Definition at line 798 of file class.assMatchingQuestion.php.

References $filename.

                                                    : string
     {
         $extension = "";
         if (preg_match("/.*\\.(\\w+)$/", $filename, $matches)) {
             $extension = $matches[1];
         }
         return md5($filename) . "." . $extension;
     }

◆ getExpressionTypes()

assMatchingQuestion::getExpressionTypes ( )

Get all available expression types for a specific question.

Returns: array

Implements iQuestionCondition.

Definition at line 1221 of file class.assMatchingQuestion.php.

References iQuestionCondition\EmptyAnswerExpression, iQuestionCondition\MatchingResultExpression, iQuestionCondition\NumericResultExpression, and iQuestionCondition\PercentageResultExpression.

                                         : array
     {
         return [
             iQuestionCondition::PercentageResultExpression,
             iQuestionCondition::NumericResultExpression,
             iQuestionCondition::MatchingResultExpression,
             iQuestionCondition::EmptyAnswerExpression,
         ];
     }

◆ getMatchingMode()

assMatchingQuestion::getMatchingMode ( )

Definition at line 1189 of file class.assMatchingQuestion.php.

References $matching_mode.

Referenced by checkSubmittedMatchings(), getMaximumScoringMatchingPairs(), saveAdditionalQuestionDataToDb(), toJSON(), and toLog().

                                      : string
     {
         return $this->matching_mode;
     }

Here is the caller graph for this function:

◆ getMatchingPair()

assMatchingQuestion::getMatchingPair ( $index = 0 )

Returns a matching pair with a given index.

The index of the first matching pair is 0, the index of the second matching pair is 1 and so on.

Parameters

integer $index A nonnegative index of the n-th matching pair

Returns: object ASS_AnswerMatching-Object

See also: $matchingpairs

Definition at line 462 of file class.assMatchingQuestion.php.

References null.

Referenced by getAvailableAnswerOptions().

                                                : ?object
     {
         if ($index < 0) {
             return null;
         }
         if (count($this->matchingpairs) < 1) {
             return null;
         }
         if ($index >= count($this->matchingpairs)) {
             return null;
         }
         return $this->matchingpairs[$index];
     }

Here is the caller graph for this function:

◆ getMatchingPairCount()

assMatchingQuestion::getMatchingPairCount ( )

Returns the number of matching pairs.

Returns: integer The number of matching pairs of the matching question

See also: $matchingpairs

Definition at line 524 of file class.assMatchingQuestion.php.

                                           : int
     {
         return count($this->matchingpairs);
     }

◆ getMatchingPairs()

assMatchingQuestion::getMatchingPairs ( )

Returns the matchingpairs array.

Definition at line 1005 of file class.assMatchingQuestion.php.

References $matchingpairs.

Referenced by getAvailableAnswerOptions(), getCorrectSolutionForTextOutput(), saveAnswerSpecificDataToDb(), toJSON(), and toLog().

                                       : array
     {
         return $this->matchingpairs;
     }

Here is the caller graph for this function:

◆ getMaximumPoints()

assMatchingQuestion::getMaximumPoints ( )

Calculates and Returns the maximum points, a learner can reach answering the question.

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

References assQuestion\$points, and getMaximumScoringMatchingPairs().

Referenced by getUserQuestionResult(), and isComplete().

                                       : float
     {
         $points = 0;
 
         foreach ($this->getMaximumScoringMatchingPairs() as $pair) {
             $points += $pair->getPoints();
         }
 
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaximumScoringMatchingPairs()

assMatchingQuestion::getMaximumScoringMatchingPairs ( )

Definition at line 724 of file class.assMatchingQuestion.php.

References getMatchingMode(), getMostPositiveScoredUniqueTermMatchingPairs(), and getPositiveScoredMatchingPairs().

Referenced by getMaximumPoints().

                                                     : array
     {
         if ($this->getMatchingMode() == self::MATCHING_MODE_N_ON_N) {
             return $this->getPositiveScoredMatchingPairs();
         } elseif ($this->getMatchingMode() == self::MATCHING_MODE_1_ON_1) {
             return $this->getMostPositiveScoredUniqueTermMatchingPairs();
         }
 
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMostPositiveScoredUniqueTermMatchingPairs()

assMatchingQuestion::getMostPositiveScoredUniqueTermMatchingPairs ( )

private

Definition at line 750 of file class.assMatchingQuestion.php.

Referenced by getMaximumScoringMatchingPairs().

                                                                    : array
     {
         $matchingPairsByDefinition = [];
 
         foreach ($this->matchingpairs as $pair) {
             if ($pair->getPoints() <= 0) {
                 continue;
             }
 
             $defId = $pair->getDefinition()->getIdentifier();
 
             if (!isset($matchingPairsByDefinition[$defId])) {
                 $matchingPairsByDefinition[$defId] = $pair;
             } elseif ($pair->getPoints() > $matchingPairsByDefinition[$defId]->getPoints()) {
                 $matchingPairsByDefinition[$defId] = $pair;
             }
         }
 
         return $matchingPairsByDefinition;
     }

Here is the caller graph for this function:

◆ getOperators()

assMatchingQuestion::getOperators ( string $expression )

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

Definition at line 1216 of file class.assMatchingQuestion.php.

                                                     : array
     {
         return ilOperatorsExpressionMapping::getOperatorsByExpression($expression);
     }

◆ getPositiveScoredMatchingPairs()

assMatchingQuestion::getPositiveScoredMatchingPairs ( )

private

Definition at line 735 of file class.assMatchingQuestion.php.

Referenced by getMaximumScoringMatchingPairs().

                                                      : array
     {
         $matchingPairs = [];
 
         foreach ($this->matchingpairs as $pair) {
             if ($pair->getPoints() <= 0) {
                 continue;
             }
 
             $matchingPairs[] = $pair;
         }
 
         return $matchingPairs;
     }

Here is the caller graph for this function:

◆ getQuestionType()

assMatchingQuestion::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question

Definition at line 978 of file class.assMatchingQuestion.php.

Referenced by toJSON(), and toLog().

                                      : string
     {
         return "assMatchingQuestion";
     }

Here is the caller graph for this function:

◆ getRandomId()

assMatchingQuestion::getRandomId ( )

Definition at line 951 of file class.assMatchingQuestion.php.

                                  : int
     {
         mt_srand((float) microtime() * 1000000);
         $random_number = mt_rand(1, 100000);
         $found = false;
         while ($found) {
             $found = false;
             foreach ($this->matchingpairs as $key => $pair) {
                 if (($pair->getTerm()->getIdentifier() == $random_number) || ($pair->getDefinition()->getIdentifier() == $random_number)) {
                     $found = true;
                     $random_number++;
                 }
             }
         }
         return $random_number;
     }

◆ getRTETextWithMediaObjects()

assMatchingQuestion::getRTETextWithMediaObjects ( )

Collects all text in the question which could contain media objects which were created with the Rich Text Editor.

Definition at line 997 of file class.assMatchingQuestion.php.

                                                 : string
     {
         return parent::getRTETextWithMediaObjects();
     }

◆ getShuffleMode()

assMatchingQuestion::getShuffleMode ( )

Definition at line 105 of file class.assMatchingQuestion.php.

References $shufflemode.

Referenced by saveAdditionalQuestionDataToDb().

                                     : int
     {
         return $this->shufflemode;
     }

Here is the caller graph for this function:

◆ getTermCount()

assMatchingQuestion::getTermCount ( )

Returns the number of terms.

Returns: integer The number of terms

See also: $terms

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

                                   : int
     {
         return count($this->terms);
     }

◆ getTerms()

assMatchingQuestion::getTerms ( )

Returns the terms of the matching question.

Returns: assAnswerMatchingTerm[] An array containing the terms

See also: $terms

Definition at line 535 of file class.assMatchingQuestion.php.

References $terms.

Referenced by solutionValuesToText(), toJSON(), and toLog().

                               : array
     {
         return $this->terms;
     }

Here is the caller graph for this function:

◆ getTermWithIdentifier()

assMatchingQuestion::getTermWithIdentifier ( $a_identifier )

Returns a term with a given identifier.

Definition at line 431 of file class.assMatchingQuestion.php.

References null.

     {
         foreach ($this->terms as $term) {
             if ($term->getIdentifier() == $a_identifier) {
                 return $term;
             }
         }
         return null;
     }

◆ getThumbGeometry()

assMatchingQuestion::getThumbGeometry ( )

Get the thumbnail geometry.

Returns: integer Geometry

Definition at line 1015 of file class.assMatchingQuestion.php.

References $thumb_geometry.

Referenced by generateThumbForFile(), getThumbSize(), saveAdditionalQuestionDataToDb(), and setImageFile().

                                       : int
     {
         return $this->thumb_geometry;
     }

Here is the caller graph for this function:

◆ getThumbPrefix()

assMatchingQuestion::getThumbPrefix ( )

Definition at line 1082 of file class.assMatchingQuestion.php.

Referenced by cloneImages(), deleteImagefile(), generateThumbForFile(), and setImageFile().

                                     : string
     {
         return "thumb.";
     }

Here is the caller graph for this function:

◆ getThumbSize()

assMatchingQuestion::getThumbSize ( )

Get the thumbnail geometry.

Returns: integer Geometry

Definition at line 1025 of file class.assMatchingQuestion.php.

References getThumbGeometry().

                                   : int
     {
         return $this->getThumbGeometry();
     }

Here is the call graph for this function:

◆ getUserQuestionResult()

assMatchingQuestion::getUserQuestionResult	(	int	$active_id,
		int	$pass
	)

Get the user solution for a question by active_id and the test pass.

Implements iQuestionCondition.

Definition at line 1231 of file class.assMatchingQuestion.php.

References $data, assQuestion\$points, calculateReachedPoints(), assQuestion\getId(), getMaximumPoints(), and assQuestion\lookupMaxStep().

      : ilUserQuestionResult {
         $result = new ilUserQuestionResult($this, $active_id, $pass);
 
         $data = $this->db->queryF(
             "SELECT ident FROM qpl_a_mdef WHERE question_fi = %s ORDER BY def_id",
             ["integer"],
             [$this->getId()]
         );
 
         $definitions = [];
         for ($index = 1; $index <= $this->db->numRows($data); ++$index) {
             $row = $this->db->fetchAssoc($data);
             $definitions[$row["ident"]] = $index;
         }
 
         $data = $this->db->queryF(
             "SELECT ident FROM qpl_a_mterm WHERE question_fi = %s ORDER BY term_id",
             ["integer"],
             [$this->getId()]
         );
 
         $terms = [];
         for ($index = 1; $index <= $this->db->numRows($data); ++$index) {
             $row = $this->db->fetchAssoc($data);
             $terms[$row["ident"]] = $index;
         }
 
         $maxStep = $this->lookupMaxStep($active_id, $pass);
 
         if ($maxStep > 0) {
             $data = $this->db->queryF(
                 "SELECT value1, value2 FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND step = %s",
                 ["integer", "integer", "integer","integer"],
                 [$active_id, $pass, $this->getId(), $maxStep]
             );
         } else {
             $data = $this->db->queryF(
                 "SELECT value1, value2 FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s",
                 ["integer", "integer", "integer"],
                 [$active_id, $pass, $this->getId()]
             );
         }
 
         while ($row = $this->db->fetchAssoc($data)) {
             if ($row["value1"] > 0) {
                 $result->addKeyValue($definitions[$row["value2"]], $terms[$row["value1"]]);
             }
         }
 
         $points = $this->calculateReachedPoints($active_id, $pass);
         $max_points = $this->getMaximumPoints();
 
         $result->setReachedPercentage(($points / $max_points) * 100);
 
         return $result;
     }

Here is the call graph for this function:

◆ insertDefinition()

assMatchingQuestion::insertDefinition	(		$position,
		?assAnswerMatchingDefinition	$definition = `null`
	)

Inserts a definition.

Parameters

object $definition The definition

See also: $definitions

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

References createMatchingDefinition().

                                                                                                 : void
     {
         if (is_null($definition)) {
             $definition = $this->createMatchingDefinition();
         }
         if ($position < count($this->definitions)) {
             $part1 = array_slice($this->definitions, 0, $position);
             $part2 = array_slice($this->definitions, $position);
             $this->definitions = array_merge($part1, [$definition], $part2);
         } else {
             array_push($this->definitions, $definition);
         }
     }

Here is the call graph for this function:

◆ insertMatchingPair()

assMatchingQuestion::insertMatchingPair	(	$position,
		$term = `null`,
		$definition = `null`,
		$points = `0.0`
	)

Inserts a matching pair for an matching choice question.

The students have to fill in an order for the matching pair. The matching pair is an ASS_AnswerMatching object that will be created and assigned to the array $this->matchingpairs.

Parameters

integer	$position	The insert position in the matching pairs array
object	$term	A matching term
object	$definition	A matching definition
double	$points	The points for selecting the matching pair (even negative points can be used)

See also: $matchingpairs

Definition at line 398 of file class.assMatchingQuestion.php.

References assQuestion\$points, and createMatchingPair().

                                                                                                   : void
     {
         $pair = $this->createMatchingPair($term, $definition, $points);
 
         if ($position < count($this->matchingpairs)) {
             $part1 = array_slice($this->matchingpairs, 0, $position);
             $part2 = array_slice($this->matchingpairs, $position);
             $this->matchingpairs = array_merge($part1, [$pair], $part2);
         } else {
             array_push($this->matchingpairs, $pair);
         }
     }

Here is the call graph for this function:

◆ insertTerm()

assMatchingQuestion::insertTerm	(		$position,
		?assAnswerMatchingTerm	$term = `null`
	)

Inserts a term.

Parameters

string $term The text of the term

See also: $terms

Definition at line 595 of file class.assMatchingQuestion.php.

References createMatchingTerm().

                                                                               : void
     {
         if (is_null($term)) {
             $term = $this->createMatchingTerm();
         }
         if ($position < count($this->terms)) {
             $part1 = array_slice($this->terms, 0, $position);
             $part2 = array_slice($this->terms, $position);
             $this->terms = array_merge($part1, [$term], $part2);
         } else {
             array_push($this->terms, $term);
         }
     }

Here is the call graph for this function:

◆ isComplete()

assMatchingQuestion::isComplete ( )

Definition at line 115 of file class.assMatchingQuestion.php.

References getMaximumPoints().

                                 : bool
     {
         if (strlen($this->title)
             && $this->author
             && $this->question
             && count($this->matchingpairs)
             && $this->getMaximumPoints() > 0
         ) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ loadFromDb()

assMatchingQuestion::loadFromDb ( $question_id )

Loads a assMatchingQuestion object from a database.

Parameters

object	$db	A pear DB object
integer	$question_id	A unique key which defines the multiple choice test in the database

Definition at line 227 of file class.assMatchingQuestion.php.

References $data, Vendor\Package\$e, ilRTE\_replaceMediaObjectImageSrc(), createMatchingDefinition(), createMatchingPair(), createMatchingTerm(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), null, assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setId(), assQuestion\setLifecycle(), setMatchingMode(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), setShuffle(), setShuffleMode(), setThumbGeometry(), and assQuestion\setTitle().

                                             : void
     {
         $query = "
                         SELECT          qpl_questions.*,
                                                 {$this->getAdditionalTableName()}.*
                         FROM            qpl_questions
                         LEFT JOIN       {$this->getAdditionalTableName()}
                         ON                      {$this->getAdditionalTableName()}.question_fi = qpl_questions.question_id
                         WHERE           qpl_questions.question_id = %s
                 ";
 
         $result = $this->db->queryF(
             $query,
             ['integer'],
             [$question_id]
         );
 
         if ($result->numRows() == 1) {
             $data = $this->db->fetchAssoc($result);
             $this->setId((int) $question_id);
             $this->setObjId((int) $data["obj_fi"]);
             $this->setTitle((string) $data["title"]);
             $this->setComment((string) $data["description"]);
             $this->setOriginalId((int) $data["original_id"]);
             $this->setNrOfTries((int) $data['nr_of_tries']);
             $this->setAuthor($data["author"]);
             $this->setPoints((float) $data["points"]);
             $this->setOwner((int) $data["owner"]);
             $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc((string) $data["question_text"], 1));
             $this->setThumbGeometry((int) $data["thumb_geometry"]);
             $this->setShuffle($data["shuffle"] != '0');
             $this->setShuffleMode((int) $data['shuffle']);
             $this->setMatchingMode($data['matching_mode'] === null ? self::MATCHING_MODE_1_ON_1 : $data['matching_mode']);
 
             try {
                 $this->setLifecycle(ilAssQuestionLifecycle::getInstance($data['lifecycle']));
             } catch (ilTestQuestionPoolInvalidArgumentException $e) {
                 $this->setLifecycle(ilAssQuestionLifecycle::getDraftInstance());
             }
 
             try {
                 $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
             } catch (ilTestQuestionPoolException $e) {
             }
         }
 
         $termids = [];
         $result = $this->db->queryF(
             "SELECT * FROM qpl_a_mterm WHERE question_fi = %s ORDER BY term_id ASC",
             ['integer'],
             [$question_id]
         );
         $this->terms = [];
         if ($result->numRows() > 0) {
             while ($data = $this->db->fetchAssoc($result)) {
                 $term = $this->createMatchingTerm($data['term'] ?? '', $data['picture'] ?? '', (int) $data['ident']);
                 $this->terms[] = $term;
                 $termids[$data['term_id']] = $term;
             }
         }
 
         $definitionids = [];
         $result = $this->db->queryF(
             "SELECT * FROM qpl_a_mdef WHERE question_fi = %s ORDER BY def_id ASC",
             ['integer'],
             [$question_id]
         );
 
         $this->definitions = [];
         if ($result->numRows() > 0) {
             while ($data = $this->db->fetchAssoc($result)) {
                 $definition = $this->createMatchingDefinition($data['definition'] ?? '', $data['picture'] ?? '', (int) $data['ident']);
                 array_push($this->definitions, $definition);
                 $definitionids[$data['def_id']] = $definition;
             }
         }
 
         $this->matchingpairs = [];
         $result = $this->db->queryF(
             "SELECT * FROM qpl_a_matching WHERE question_fi = %s ORDER BY answer_id",
             ['integer'],
             [$question_id]
         );
         if ($result->numRows() > 0) {
             while ($data = $this->db->fetchAssoc($result)) {
                 $pair = $this->createMatchingPair(
                     $termids[$data['term_fi']],
                     $definitionids[$data['definition_fi']],
                     (float) $data['points']
                 );
                 array_push($this->matchingpairs, $pair);
             }
         }
         parent::loadFromDb((int) $question_id);
     }

Here is the call graph for this function:

◆ rebuildThumbnails()

assMatchingQuestion::rebuildThumbnails ( )

Rebuild the thumbnail images with a new thumbnail size.

Definition at line 1043 of file class.assMatchingQuestion.php.

References assQuestion\buildHashedImageFilename(), generateThumbForFile(), and assQuestion\getImagePath().

Referenced by saveAnswerSpecificDataToDb().

                                        : void
     {
         $new_terms = [];
         foreach ($this->terms as $term) {
             if ($term->getPicture() !== '') {
                 $current_file_path = $this->getImagePath() . $term->getPicture();
                 if (!file_exists($current_file_path)) {
                     $new_terms[] = $term;
                     continue;
                 }
                 $new_file_name = $this->buildHashedImageFilename($term->getPicture(), true);
                 $new_file_path = $this->getImagePath() . $new_file_name;
                 rename($current_file_path, $new_file_path);
                 $term = $term->withPicture($new_file_name);
                 $this->generateThumbForFile($this->getImagePath(), $term->getPicture());
             }
             $new_terms[] = $term;
         }
         $this->terms = $new_terms;
 
         $new_definitions = [];
         foreach ($this->definitions as $definition) {
             if ($definition->getPicture() !== '') {
                 $current_file_path = $this->getImagePath() . $definition->getPicture();
                 if (!file_exists($current_file_path)) {
                     $new_definitions[] = $definition;
                     continue;
                 }
                 $new_file_name = $this->buildHashedImageFilename($definition->getPicture(), true);
                 $new_file_path = $this->getImagePath() . $new_file_name;
                 rename($current_file_path, $new_file_path);
                 $definition = $definition->withPicture($new_file_name);
                 $this->generateThumbForFile($this->getImagePath(), $definition->getPicture());
             }
             $new_definitions[] = $definition;
         }
         $this->definitions = $new_definitions;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeDefinitionImage()

assMatchingQuestion::removeDefinitionImage ( $index )

Definition at line 816 of file class.assMatchingQuestion.php.

References deleteImagefile(), and null.

                                                  : void
     {
         $definition = $this->definitions[$index] ?? null;
         if (is_object($definition)) {
             $this->deleteImagefile($definition->getPicture());
             $definition = $definition->withPicture('');
         }
     }

Here is the call graph for this function:

◆ removeTermImage()

assMatchingQuestion::removeTermImage ( $index )

Definition at line 807 of file class.assMatchingQuestion.php.

References deleteImagefile(), and null.

                                            : void
     {
         $term = $this->terms[$index] ?? null;
         if (is_object($term)) {
             $this->deleteImagefile($term->getPicture());
             $term = $term->withPicture('');
         }
     }

Here is the call graph for this function:

◆ saveAdditionalQuestionDataToDb()

assMatchingQuestion::saveAdditionalQuestionDataToDb ( )

Saves a record to the question types additional data table.

Returns: mixed

Implements ilObjQuestionScoringAdjustable.

Definition at line 204 of file class.assMatchingQuestion.php.

References getAdditionalTableName(), assQuestion\getId(), getMatchingMode(), getShuffleMode(), and getThumbGeometry().

Referenced by saveToDb().

     {
         $this->db->manipulateF(
             "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
             [ "integer" ],
             [ $this->getId() ]
         );
 
         $this->db->insert($this->getAdditionalTableName(), [
             'question_fi' => ['integer', $this->getId()],
             'shuffle' => ['text', $this->getShuffleMode()],
             'matching_type' => ['text', $this->matching_type],
             'thumb_geometry' => ['integer', $this->getThumbGeometry()],
             'matching_mode' => ['text', $this->getMatchingMode()]
         ]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAnswerSpecificDataToDb()

assMatchingQuestion::saveAnswerSpecificDataToDb ( )

Saves the answer specific records into a question types answer table.

Returns: mixed

Implements ilObjAnswerScoringAdjustable.

Definition at line 137 of file class.assMatchingQuestion.php.

References $matchingpairs, assQuestion\getId(), getMatchingPairs(), and rebuildThumbnails().

Referenced by saveToDb().

     {
         $this->rebuildThumbnails();
 
         $this->db->manipulateF(
             "DELETE FROM qpl_a_mterm WHERE question_fi = %s",
             [ 'integer' ],
             [ $this->getId() ]
         );
 
         // delete old definitions
         $this->db->manipulateF(
             "DELETE FROM qpl_a_mdef WHERE question_fi = %s",
             [ 'integer' ],
             [ $this->getId() ]
         );
 
         $termids = [];
         // write terms
         foreach ($this->terms as $key => $term) {
             $next_id = $this->db->nextId('qpl_a_mterm');
             $this->db->insert('qpl_a_mterm', [
                 'term_id' => ['integer', $next_id],
                 'question_fi' => ['integer', $this->getId()],
                 'picture' => ['text', $term->getPicture()],
                 'term' => ['text', $term->getText()],
                 'ident' => ['integer', $term->getIdentifier()]
             ]);
             $termids[$term->getIdentifier()] = $next_id;
         }
 
         $definitionids = [];
         // write definitions
         foreach ($this->definitions as $key => $definition) {
             $next_id = $this->db->nextId('qpl_a_mdef');
             $this->db->insert('qpl_a_mdef', [
                 'def_id' => ['integer', $next_id],
                 'question_fi' => ['integer', $this->getId()],
                 'picture' => ['text', $definition->getPicture()],
                 'definition' => ['text', $definition->getText()],
                 'ident' => ['integer', $definition->getIdentifier()]
             ]);
             $definitionids[$definition->getIdentifier()] = $next_id;
         }
 
         $this->db->manipulateF(
             "DELETE FROM qpl_a_matching WHERE question_fi = %s",
             [ 'integer' ],
             [ $this->getId() ]
         );
         $matchingpairs = $this->getMatchingPairs();
         foreach ($matchingpairs as $key => $pair) {
             $next_id = $this->db->nextId('qpl_a_matching');
             $this->db->manipulateF(
                 "INSERT INTO qpl_a_matching (answer_id, question_fi, points, term_fi, definition_fi) VALUES (%s, %s, %s, %s, %s)",
                 [ 'integer', 'integer', 'float', 'integer', 'integer' ],
                 [
                                     $next_id,
                                     $this->getId(),
                                     $pair->getPoints(),
                                     $termids[$pair->getTerm()->getIdentifier()],
                                     $definitionids[$pair->getDefinition()->getIdentifier()]
                                 ]
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePreviewData()

assMatchingQuestion::savePreviewData ( ilAssQuestionPreviewSession $previewSession )

protected

Definition at line 942 of file class.assMatchingQuestion.php.

References checkSubmittedMatchings(), and ilAssQuestionPreviewSession\setParticipantsSolution().

                                                                                    : void
     {
         $submitted_matchings = $this->questionpool_request->getMatchingPairs();
 
         if ($this->checkSubmittedMatchings($submitted_matchings)) {
             $previewSession->setParticipantsSolution($submitted_matchings);
         }
     }

Here is the call graph for this function:

◆ saveToDb()

assMatchingQuestion::saveToDb ( ?int $original_id = null )

Definition at line 128 of file class.assMatchingQuestion.php.

References assQuestion\$original_id, saveAdditionalQuestionDataToDb(), saveAnswerSpecificDataToDb(), and assQuestion\saveQuestionDataToDb().

                                                       : void
     {
         $this->saveQuestionDataToDb($original_id);
         $this->saveAdditionalQuestionDataToDb();
         $this->saveAnswerSpecificDataToDb();
 
         parent::saveToDb();
     }

Here is the call graph for this function:

◆ saveWorkingData()

assMatchingQuestion::saveWorkingData	(	int	$active_id,
		?int	$pass = `null`,
		bool	$authorized = `true`
	)

Definition at line 914 of file class.assMatchingQuestion.php.

References ilObjTest\_getPass(), checkSubmittedMatchings(), assQuestion\getProcessLocker(), null, assQuestion\removeCurrentSolution(), and assQuestion\saveCurrentSolution().

      : bool {
         if ($pass === null) {
             $pass = ilObjTest::_getPass($active_id);
         }
 
         $submitted_matchings = $this->questionpool_request->getMatchingPairs();
         if (!$this->checkSubmittedMatchings($submitted_matchings)) {
             return false;
         }
 
         $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(
             function () use ($submitted_matchings, $active_id, $pass, $authorized) {
                 $this->removeCurrentSolution($active_id, $pass, $authorized);
                 foreach ($submitted_matchings as $definition => $terms) {
                     foreach ($terms as $i => $term) {
                         $this->saveCurrentSolution($active_id, $pass, $term, $definition, $authorized);
                     }
                 }
             }
         );
 
         return true;
     }

Here is the call graph for this function:

◆ setImageFile()

assMatchingQuestion::setImageFile	(	string	$image_tempfilename,
		string	$image_filename,
		string	$previous_filename = `''`
	)

Definition at line 844 of file class.assMatchingQuestion.php.

References ilShellUtil\convertImage(), deleteImagefile(), assQuestion\getImagePath(), getThumbGeometry(), getThumbPrefix(), ilFileUtils\makeDirParents(), and ilFileUtils\moveUploadedFile().

      : bool {
         $result = true;
         if ($image_tempfilename === '') {
             return true;
         }
 
         $image_filename = str_replace(' ', '_', $image_filename);
         $imagepath = $this->getImagePath();
         if (!file_exists($imagepath)) {
             ilFileUtils::makeDirParents($imagepath);
         }
 
         if (!ilFileUtils::moveUploadedFile(
             $image_tempfilename,
             $image_filename,
             $imagepath . $image_filename
         )
         ) {
             return false;
         }
 
         // create thumbnail file
         $thumbpath = $imagepath . $this->getThumbPrefix() . $image_filename;
         ilShellUtil::convertImage(
             $imagepath . $image_filename,
             $thumbpath,
             'JPEG',
             (string) $this->getThumbGeometry()
         );
 
         if ($result
             && $image_filename !== $previous_filename
             && $previous_filename !== ''
         ) {
             $this->deleteImagefile($previous_filename);
         }
         return $result;
     }

Here is the call graph for this function:

◆ setMatchingMode()

assMatchingQuestion::setMatchingMode ( string $matching_mode )

Definition at line 1184 of file class.assMatchingQuestion.php.

References $matching_mode.

Referenced by loadFromDb().

                                                           : void
     {
         $this->matching_mode = $matching_mode;
     }

Here is the caller graph for this function:

◆ setShuffle()

assMatchingQuestion::setShuffle ( $shuffle = true )

Definition at line 968 of file class.assMatchingQuestion.php.

References assQuestion\$shuffle.

Referenced by loadFromDb().

                                                : void
     {
         $this->shuffle = (bool) $shuffle;
     }

Here is the caller graph for this function:

◆ setShuffleMode()

assMatchingQuestion::setShuffleMode ( int $shuffle )

Definition at line 110 of file class.assMatchingQuestion.php.

References assQuestion\$shuffle.

Referenced by loadFromDb().

     {
         $this->shufflemode = $shuffle;
     }

Here is the caller graph for this function:

◆ setTerm()

assMatchingQuestion::setTerm	(	$term,
		$index
	)

Sets a specific term.

Parameters

string	$term	The text of the term
string	$index	The index of the term

See also: $terms

Definition at line 678 of file class.assMatchingQuestion.php.

                                           : void
     {
         $this->terms[$index] = $term;
     }

◆ setThumbGeometry()

assMatchingQuestion::setThumbGeometry ( int $a_geometry )

Set the thumbnail geometry.

Parameters

integer $a_geometry Geometry

Definition at line 1035 of file class.assMatchingQuestion.php.

Referenced by loadFromDb().

                                                      : void
     {
         $this->thumb_geometry = ($a_geometry < 1) ? 100 : $a_geometry;
     }

Here is the caller graph for this function:

◆ solutionValuesToLog()

assMatchingQuestion::solutionValuesToLog	(	AdditionalInformationGenerator	$additional_info,
		array	$solution_values
	)

protected

Definition at line 1383 of file class.assMatchingQuestion.php.

References solutionValuesToText().

      : array {
         return $this->solutionValuesToText($solution_values);
     }

Here is the call graph for this function:

◆ solutionValuesToText()

assMatchingQuestion::solutionValuesToText ( array $solution_values )

Definition at line 1390 of file class.assMatchingQuestion.php.

References $c, getDefinitions(), and getTerms().

Referenced by solutionValuesToLog().

                                                                 : array
     {
         $reducer = static function (array $c, assAnswerMatchingTerm|assAnswerMatchingDefinition $v): array {
             $c[$v->getIdentifier()] = $v->getText() !== ''
                 ? $v->getPicture()
                 : $v->getText();
             return $c;
         };
 
         $terms_by_identifier = array_reduce(
             $this->getTerms(),
             $reducer,
             []
         );
 
         $definitions_by_identifier = array_reduce(
             $this->getDefinitions(),
             $reducer,
             []
         );
 
         return array_map(
             static fn(array $v): string => $definitions_by_identifier[$v['value2']]
                 . ':' . $terms_by_identifier[$v['value1']],
             $solution_values
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toJSON()

assMatchingQuestion::toJSON ( )

Returns a JSON representation of the question.

Implements ILIAS\TestQuestionPool\Questions\QuestionLMExportable.

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

References $definitions, $terms, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), getDefinitions(), assQuestion\getId(), getMatchingMode(), getMatchingPairs(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffler(), getTerms(), assQuestion\getTitleForHTMLOutput(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and assQuestion\setShuffler().

                             : string
     {
         $result = [];
 
         $result['id'] = $this->getId();
         $result['type'] = (string) $this->getQuestionType();
         $result['title'] = $this->getTitleForHTMLOutput();
         $result['question'] = $this->formatSAQuestion($this->getQuestion());
         $result['nr_of_tries'] = $this->getNrOfTries();
         $result['matching_mode'] = $this->getMatchingMode();
         $result['shuffle'] = true;
         $result['feedback'] = [
             'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
             'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
         ];
 
         $this->setShuffler($this->randomGroup->shuffleArray(new RandomSeed()));
 
         $terms = [];
         foreach ($this->getShuffler()->transform($this->getTerms()) as $term) {
             $terms[] = [
                 "text" => $this->formatSAQuestion($term->getText()),
                 "id" => $this->getId() . $term->getIdentifier()
             ];
         }
         $result['terms'] = $terms;
 
         $this->setShuffler($this->randomGroup->shuffleArray(new RandomSeed()));
 
         $definitions = [];
         foreach ($this->getShuffler()->transform($this->getDefinitions()) as $def) {
             $definitions[] = [
                 "text" => $this->formatSAQuestion((string) $def->getText()),
                 "id" => $this->getId() . $def->getIdentifier()
             ];
         }
         $result['definitions'] = $definitions;
 
         // #10353
         $matchings = [];
         foreach ($this->getMatchingPairs() as $pair) {
             // fau: fixLmMatchingPoints - ignore matching pairs with 0 or negative points
             if ($pair->getPoints() <= 0) {
                 continue;
             }
             // fau.
 
             $pid = $pair->getDefinition()->getIdentifier();
             if ($this->getMatchingMode() == self::MATCHING_MODE_N_ON_N) {
                 $pid .= '::' . $pair->getTerm()->getIdentifier();
             }
 
             if (!isset($matchings[$pid]) || $matchings[$pid]["points"] < $pair->getPoints()) {
                 $matchings[$pid] = [
                     "term_id" => $this->getId() . $pair->getTerm()->getIdentifier(),
                     "def_id" => $this->getId() . $pair->getDefinition()->getIdentifier(),
                     "points" => (int) $pair->getPoints()
                 ];
             }
         }
 
         $result['matchingPairs'] = array_values($matchings);
 
         $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
         $result['mobs'] = $mobs;
 
         $this->lng->loadLanguageModule('assessment');
         $result['reset_button_label'] = $this->lng->txt("reset_terms");
 
         return json_encode($result);
     }

Here is the call graph for this function:

◆ toLog()

assMatchingQuestion::toLog ( AdditionalInformationGenerator $additional_info )

Implements ILIAS\TestQuestionPool\Questions\Question.

Definition at line 1345 of file class.assMatchingQuestion.php.

References assQuestion\formatSAQuestion(), getDefinitions(), getMatchingMode(), getMatchingPairs(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), getTerms(), assQuestion\getTitleForHTMLOutput(), and ILIAS\Test\Logging\AdditionalInformationGenerator\getTrueFalseTagForBool().

                                                                           : array
     {
         $result = [
             AdditionalInformationGenerator::KEY_QUESTION_TYPE => (string) $this->getQuestionType(),
             AdditionalInformationGenerator::KEY_QUESTION_TITLE => $this->getTitleForHTMLOutput(),
             AdditionalInformationGenerator::KEY_QUESTION_TEXT => $this->formatSAQuestion($this->getQuestion()),
             AdditionalInformationGenerator::KEY_QUESTION_SHUFFLE_ANSWER_OPTIONS => $additional_info
                 ->getTrueFalseTagForBool($this->getShuffle()),
             'qpl_qst_inp_matching_mode' => $this->getMatchingMode() === self::MATCHING_MODE_1_ON_1 ? '{{ qpl_qst_inp_matching_mode_one_on_one }}' : '{{ qpl_qst_inp_matching_mode_all_on_all }}',
             AdditionalInformationGenerator::KEY_FEEDBACK => [
                 AdditionalInformationGenerator::KEY_QUESTION_FEEDBACK_ON_INCOMPLETE => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
                 AdditionalInformationGenerator::KEY_QUESTION_FEEDBACK_ON_COMPLETE => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
             ]
         ];
 
         foreach ($this->getTerms() as $term) {
             $result[AdditionalInformationGenerator::KEY_QUESTION_MATCHING_TERMS][] = $term->getText();
         }
 
         foreach ($this->getDefinitions() as $definition) {
             $result[AdditionalInformationGenerator::KEY_QUESTION_MATCHING_DEFINITIONS][] = $this->formatSAQuestion((string) $definition->getText());
         }
 
         // #10353
         $matching_pairs = [];
         $i = 1;
         foreach ($this->getMatchingPairs() as $pair) {
             $matching_pairs[$i++] = [
                 AdditionalInformationGenerator::KEY_QUESTION_MATCHING_TERM => $pair->getTerm()->getText(),
                 AdditionalInformationGenerator::KEY_QUESTION_MATCHING_DEFINITION => $this->formatSAQuestion((string) $pair->getDefinition()->getText()),
                 AdditionalInformationGenerator::KEY_QUESTION_REACHABLE_POINTS => (int) $pair->getPoints()
             ];
         }
 
         $result[AdditionalInformationGenerator::KEY_QUESTION_CORRECT_ANSWER_OPTIONS] = $matching_pairs;
         return $result;
     }

Here is the call graph for this function:

◆ withMatchingPairs()

assMatchingQuestion::withMatchingPairs ( array $pairs )

Parameters

assAnswerMatchingPair[]

Definition at line 510 of file class.assMatchingQuestion.php.

                                                    : self
     {
         $clone = clone $this;
         $clone->matchingpairs = $pairs;
         return $clone;
     }

Field Documentation

◆ $definitions

array assMatchingQuestion::$definitions = []

protected

Definition at line 73 of file class.assMatchingQuestion.php.

Referenced by getDefinitions(), and toJSON().

◆ $element_height

int assMatchingQuestion::$element_height

Definition at line 50 of file class.assMatchingQuestion.php.

◆ $matching_mode

string assMatchingQuestion::$matching_mode = self::MATCHING_MODE_1_ON_1

protected

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

Referenced by getMatchingMode(), and setMatchingMode().

◆ $matching_type

int assMatchingQuestion::$matching_type

Definition at line 51 of file class.assMatchingQuestion.php.

Referenced by __construct().

◆ $matchingpairs

assMatchingQuestion::$matchingpairs

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

Referenced by getMatchingPairs(), and saveAnswerSpecificDataToDb().

◆ $randomGroup

RandomGroup assMatchingQuestion::$randomGroup

private

Definition at line 54 of file class.assMatchingQuestion.php.

◆ $shufflemode

int assMatchingQuestion::$shufflemode = 0

private

Definition at line 49 of file class.assMatchingQuestion.php.

Referenced by getShuffleMode().

◆ $terms

array assMatchingQuestion::$terms = []

protected

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

Referenced by getTerms(), and toJSON().

◆ $thumb_geometry

int assMatchingQuestion::$thumb_geometry = 100

Definition at line 48 of file class.assMatchingQuestion.php.

Referenced by getThumbGeometry().

◆ MATCHING_MODE_1_ON_1

const assMatchingQuestion::MATCHING_MODE_1_ON_1 = '1:1'

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

Referenced by assMatchingQuestionImport\fromXML(), assMatchingQuestionGUI\populateAssignedTerms(), and assMatchingQuestionGUI\populateQuestionSpecificFormPart().

◆ MATCHING_MODE_N_ON_N

const assMatchingQuestion::MATCHING_MODE_N_ON_N = 'n:n'

Definition at line 46 of file class.assMatchingQuestion.php.

Referenced by assMatchingQuestionGUI\isValidTermAndDefinitionAmount(), and assMatchingQuestionGUI\populateQuestionSpecificFormPart().

◆ MT_TERMS_DEFINITIONS

const assMatchingQuestion::MT_TERMS_DEFINITIONS = 1

Definition at line 43 of file class.assMatchingQuestion.php.

◆ MT_TERMS_PICTURES

const assMatchingQuestion::MT_TERMS_PICTURES = 0

Definition at line 42 of file class.assMatchingQuestion.php.

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addDefinition()

◆ addMatchingPair()

◆ addTerm()

◆ afterSyncWithOriginal()

◆ calculateReachedPoints()

◆ calculateReachedPointsForSolution()

◆ checkSubmittedMatchings()

◆ cloneImages()

◆ cloneQuestionTypeSpecificProperties()

◆ createMatchingDefinition()

◆ createMatchingPair()

◆ createMatchingTerm()

◆ deleteDefinition()

◆ deleteImagefile()

◆ deleteMatchingPair()

◆ deleteTerm()

◆ fetchIndexedValuesFromValuePairs()

◆ flushDefinitions()

◆ flushMatchingPairs()

◆ flushTerms()

◆ generateThumbForFile()

◆ getAdditionalTableName()

◆ getAnswerTableName()

◆ getAvailableAnswerOptions()

◆ getCorrectSolutionForTextOutput()

◆ getDefinitionCount()

◆ getDefinitions()

◆ getDefinitionWithIdentifier()

◆ getEncryptedFilename()

◆ getExpressionTypes()

◆ getMatchingMode()

◆ getMatchingPair()

◆ getMatchingPairCount()

◆ getMatchingPairs()

◆ getMaximumPoints()

◆ getMaximumScoringMatchingPairs()

◆ getMostPositiveScoredUniqueTermMatchingPairs()

◆ getOperators()

◆ getPositiveScoredMatchingPairs()

◆ getQuestionType()

◆ getRandomId()

◆ getRTETextWithMediaObjects()

◆ getShuffleMode()

◆ getTermCount()

◆ getTerms()

◆ getTermWithIdentifier()

◆ getThumbGeometry()

◆ getThumbPrefix()

◆ getThumbSize()

◆ getUserQuestionResult()

◆ insertDefinition()

◆ insertMatchingPair()

◆ insertTerm()

◆ isComplete()

◆ loadFromDb()

◆ rebuildThumbnails()

◆ removeDefinitionImage()

◆ removeTermImage()

◆ saveAdditionalQuestionDataToDb()

◆ saveAnswerSpecificDataToDb()

◆ savePreviewData()

◆ saveToDb()

◆ saveWorkingData()

◆ setImageFile()

◆ setMatchingMode()

◆ setShuffle()

◆ setShuffleMode()

◆ setTerm()

◆ setThumbGeometry()