assMatchingQuestion Class Reference

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=MT_TERMS_DEFINITIONS)
	assMatchingQuestion constructor More...
	getShuffleMode ()
	setShuffleMode (int $shuffle)
	isComplete ()
	Returns true, if a matching question is complete for use. More...
	saveToDb ($original_id="")
	Saves a assMatchingQuestion object to a database. More...
	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...
	duplicate (bool $for_test=true, string $title="", string $author="", string $owner="", $testObjId=null)
	Duplicates an assMatchingQuestion. More...
	copyObject ($target_questionpool_id, $title="")
	Copies an assMatchingQuestion. More...
	createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")
	duplicateImages ($question_id, $objectId=null)
	copyImages ($question_id, $source_questionpool)
	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 ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
	Returns the points, a learner has reached answering the question. More...
	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 ($image_tempfilename, $image_filename, $previous_filename='')
	Sets the image file and uploads the image to the object's image directory. More...
	saveWorkingData ($active_id, $pass=null, $authorized=true)
	Saves the learners input of the question to the database. More...
	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...
	setExportDetailsXLS (ilAssExcelFormatHelper $worksheet, int $startrow, int $active_id, int $pass)
	{} 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...
	supportsJavascriptOutput ()
	supportsNonJsOutput ()
	setMatchingMode ($matchingMode)
	getMatchingMode ()
	getOperators ($expression)
	Get all available operations for a specific question. More...
	getExpressionTypes ()
	Get all available expression types for a specific question. 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...
Public Member Functions inherited from assQuestion
	__construct (string $title="", string $comment="", string $author="", int $owner=-1, string $question="")
	assQuestion constructor More...
	getShuffler ()
	setShuffler (Transformation $shuffler)
	setProcessLocker (ilAssQuestionProcessLocker $processLocker)
	getProcessLocker ()
	fromXML ($item, int $questionpool_id, ?int $tst_id, &$tst_object, int &$question_counter, array $import_mapping, array &$solutionhints=[])
	Receives parameters from a QTI parser and creates a valid ILIAS question object. More...
	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...
	isComplete ()
	Returns true, if a question is complete for use. More...
	questionTitleExists (int $questionpool_id, string $title)
	Returns TRUE if the question title exists in a question pool in the database. More...
	setTitle (string $title="")
	setId (int $id=-1)
	setTestId (int $id=-1)
	setComment (string $comment="")
	setOutputType (int $outputType=OUTPUT_HTML)
	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 ()
	getOutputType ()
	supportsJavascriptOutput ()
	supportsNonJsOutput ()
	requiresJsSwitch ()
	getAuthor ()
	getAuthorForHTMLOutput ()
	getOwner ()
	getObjId ()
	setObjId (int $obj_id=0)
	getLifecycle ()
	setLifecycle (ilAssQuestionLifecycle $lifecycle)
	setExternalId (?string $external_id)
	getExternalId ()
	getSuggestedSolutionOutput ()
	_getSuggestedSolution (int $question_id, int $subquestion_index=0)
	loadSuggestedSolution (int $question_id, int $subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...
	getSuggestedSolutions ()
	getReachedPoints (int $active_id, int $pass)
	getMaximumPoints ()
	getAdjustedReachedPoints (int $active_id, int $pass, bool $authorizedSolution=true)
	returns the reached points ... More...
	calculateResultsFromSolution (int $active_id, int $pass, bool $obligationsEnabled=false)
	Calculates the question results from a previously saved question solution. More...
	persistWorkingState (int $active_id, $pass, bool $obligationsEnabled=false, bool $authorized=true)
	persists the working state for current testactive and testpass More...
	persistPreviewState (ilAssQuestionPreviewSession $previewSession)
	persists the preview state for current user and question More...
	validateSolutionSubmit ()
	saveWorkingData (int $active_id, int $pass, bool $authorized=true)
	Saves the learners input of the question to the database. More...
	moveUploadedMediaFile (string $file, string $name)
	Move an uploaded media file to an public accessible temp dir to present it. More...
	getSuggestedSolutionPath ()
	getImagePath ($question_id=null, $object_id=null)
	Returns the image path for web accessable images of a question. More...
	buildImagePath ($questionId, $parentObjectId)
	getFlashPath ()
	Returns the image path for web accessable flash files 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, $pass=null)
	getSolutionValues ($active_id, $pass=null, bool $authorized=true)
	Loads solutions of a given user from the database an returns it. More...
	isInUse (int $question_id=0)
	Checks whether the question is in use or not in pools or tests. More...
	usageNumber (int $question_id=0)
	Returns the number of place the question is in use in pools or tests. More...
	isClone (int $question_id=0)
	Checks whether the question is a clone of another question or not. More...
	getAdditionalTableName ()
	getAnswerTableName ()
	deleteAnswers (int $question_id)
	deleteAdditionalTableData (int $question_id)
	delete (int $question_id)
	getTotalAnswers ()
	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)
	syncXHTMLMediaObjectsOfQuestion ()
	createPageObject ()
	copyPageOfQuestion (int $a_q_id)
	getPageOfQuestion ()
	setOriginalId (?int $original_id)
	getOriginalId ()
	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=-1)
	saveToDb ()
	setNewOriginalId (int $newId)
	deleteSuggestedSolutions ()
	getSuggestedSolution (int $subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...
	getSuggestedSolutionTitle (int $subquestion_index=0)
	Returns the title of a suggested solution at a given subquestion_index. More...
	setSuggestedSolution (string $solution_id="", int $subquestion_index=0, bool $is_import=false)
	Sets a suggested solution for the question. More...
	updateSuggestedSolutions (int $original_id=-1, int $original_obj_id=-1)
	_resolveInternalLink (string $internal_link)
	_resolveIntLinks (int $question_id)
	syncWithOriginal ()
	_questionExists ($question_id)
	Returns true if the question already exists in the database. More...
	_questionExistsInPool (int $question_id)
	getPoints ()
	setPoints (float $points)
	getSolutionMaxPass (int $active_id)
	calculateReachedPoints ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
	Returns the points, a learner has reached answering the question. More...
	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $previewSession, $reachedPoints)
	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)
	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)
	adjustReachedPointsByScoringOptions ($points, $active_id, $pass=null)
	Adjust the given reached points by checks for all special scoring options in the test container. More...
	isHTML ($a_text)
	Checks if a given string contains HTML or not. More...
	prepareTextareaOutput (string $txt_output, bool $prepare_for_latex_output=false, bool $omitNl2BrWhenTextArea=false)
	QTIMaterialToString (ilQTIMaterial $a_material)
	Reads an QTI material tag and creates a text or XHTML string. More...
	addQTIMaterial (ilXmlWriter $a_xml_writer, string $a_material, bool $close_material_tag=true, bool $add_mobs=true)
	buildHashedImageFilename (string $plain_image_filename, bool $unique=false)
	getQuestion ()
	getQuestionForHTMLOutput ()
	setQuestion (string $question="")
	getQuestionType ()
	Returns the question type of the question. More...
	getQuestionTypeID ()
	syncHints ()
	cleanupMediaObjectUsage ()
	getInstances ()
	getActiveUserData (int $active_id)
	Returns the user id and the test id for a given active id. More...
	hasSpecificFeedback ()
	setExportDetailsXLS (ilAssExcelFormatHelper $worksheet, int $startrow, int $active_id, int $pass)
	__get ($value)
	Object getter. More...
	__set ($key, $value)
	Object setter. More...
	__isset ($key)
	Object issetter. More...
	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)
	isAutosaveable ()
	getAdditionalContentEditingMode ()
	setAdditionalContentEditingMode (?string $additionalContentEditingMode)
	isAdditionalContentEditingModePageObject ()
	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)
	getValidAdditionalContentEditingModes ()
	getHtmlUserSolutionPurifier ()
	getHtmlQuestionContentPurifier ()
	setLastChange ($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 ()
	duplicate (bool $for_test=true, string $title="", string $author="", string $owner="", $testObjId=null)
	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 $valuePairs)
	areObligationsToBeConsidered ()
	setObligationsToBeConsidered (bool $obligationsToBeConsidered)
	updateTimestamp ()
	getTestPresentationConfig ()
	savePartial ()
	isInActiveTest ()
	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...
	saveAnswerSpecificDataToDb ()
	Saves the answer specific records into a question types answer table. More...
Public Member Functions inherited from iQuestionCondition
	getOperators ($expression)
	Get all available operations for a specific question. More...
	getExpressionTypes ()
	Get all available expression types for a specific question. More...
	getUserQuestionResult ($active_id, $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...

Data Fields
	$matchingpairs
	$matching_type
	$thumb_geometry = 100
	$element_height
const	MATCHING_MODE_1_ON_1 = '1:1'
const	MATCHING_MODE_N_ON_N = 'n:n'
Data Fields inherited from assQuestion
const	IMG_MIME_TYPE_JPG = 'image/jpeg'
const	IMG_MIME_TYPE_PNG = 'image/png'
const	IMG_MIME_TYPE_GIF = 'image/gif'
const	TRIM_PATTERN = '/^[\p{C}\p{Z}]+|[\p{C}\p{Z}]+$/u'
const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'
const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'
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
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	generateThumbForFile ($path, $file)
	calculateReachedPointsForSolution ($found_values)
	afterSyncWithOriginal ($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId)
	{} 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)
Protected Member Functions inherited from assQuestion
	getQuestionAction ()
	isNonEmptyItemListPostSubmission (string $postSubmissionFieldname)
	ensureCurrentTestPass (int $active_id, int $pass)
	lookupCurrentTestPass (int $active_id, int $pass)
	lookupTestId (int $active_id)
	@refactor Move to ilObjTest or similar More...
	log (int $active_id, string $langVar)
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	deletePageOfQuestion (int $question_id)
	onDuplicate (int $originalParentId, int $originalQuestionId, int $duplicateParentId, int $duplicateQuestionId)
	beforeSyncWithOriginal (int $origQuestionId, int $dupQuestionId, int $origParentObjId, int $dupParentObjId)
	afterSyncWithOriginal (int $origQuestionId, int $dupQuestionId, int $origParentObjId, int $dupParentObjId)
	onCopy (int $sourceParentId, int $sourceQuestionId, int $targetParentId, int $targetQuestionId)
	duplicateSuggestedSolutionFiles (int $parent_id, int $question_id)
	Duplicates the files of a suggested solution if the question is duplicated. More...
	syncSuggestedSolutionFiles (int $target_question_id, int $target_obj_id)
	copySuggestedSolutionFiles (int $source_questionpool_id, int $source_question_id)
	ensureNonNegativePoints ($points)
	purifyAndPrepareTextAreaOutput (string $content)
	getRTETextWithMediaObjects ()
	getSelfAssessmentFormatter ()
	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)
	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)
	duplicateQuestionHints (int $originalQuestionId, int $duplicateQuestionId)
	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 ()
	build basic test question configuration instance More...

Protected Attributes
array	$terms = []
	$definitions
	$matchingMode = self::MATCHING_MODE_1_ON_1
Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery
ILIAS DI LoggingServices	$ilLog
int	$id
string	$title
string	$comment
string	$owner
string	$author
int	$thumb_size
string	$question
	The question text. More...
float	$points
	The maximum available points for the question. More...
bool	$shuffle
	Indicates whether the answers will be shuffled or not. More...
int	$test_id
	The database id of a test in which the question is contained. More...
int	$obj_id = 0
	Object id of the container object. More...
	$ilias
ilGlobalPageTemplate	$tpl
ilLanguage	$lng
ilDBInterface	$db
Container	$dic
int	$outputType = OUTPUT_JAVASCRIPT
	Contains the output type of a question. More...
array	$suggested_solutions
int	$original_id = null
	$page
string	$external_id = null
ilAssQuestionProcessLocker	$processLocker
	$step
	$lastChange
Transformation	$shuffler
ilTestQuestionConfig	$testQuestionConfig
ilAssQuestionLifecycle	$lifecycle
ilObjUser	$current_user

Private Member Functions
	getPositiveScoredMatchingPairs ()
	getMostPositiveScoredUniqueTermMatchingPairs ()
	fetchSubmittedMatchingsFromPost ()
	checkSubmittedMatchings ($submittedMatchings)

Private Attributes
int	$shufflemode = 0
RandomGroup	$randomGroup

Additional Inherited Members
Static Public Member Functions inherited from assQuestion
static	setForcePassResultUpdateEnabled (bool $forcePassResultsUpdateEnabled)
static	isForcePassResultUpdateEnabled ()
static	isAllowedImageMimeType ($mimeType)
static	fetchMimeTypeIdentifier (string $contentType)
static	getAllowedFileExtensionsForMimeType (string $mimeType)
static	isAllowedImageFileExtension (string $mimeType, string $fileExtension)
static	getAllowedImageMaterialFileExtensions ()
static	_getMaximumPoints (int $question_id)
	Returns the maximum points, a learner can reach answering the question. More...
static	_getQuestionInfo (int $question_id)
static	_getSuggestedSolutionCount (int $question_id)
static	_getSuggestedSolutionOutput (int $question_id)
static	_getReachedPoints (int $active_id, int $question_id, int $pass)
static	_updateTestResultCache (int $active_id, ilAssQuestionProcessLocker $processLocker=null)
	@TODO Move this to a proper place. More...
static	logAction (string $logtext, int $active_id, int $question_id)
static	getQuestionTypeFromDb (int $question_id)
static	_getTotalRightAnswers (int $a_q_id)
static	_getTitle (int $a_q_id)
static	_getQuestionText (int $a_q_id)
static	isFileAvailable (string $file)
static	_getQuestionType (int $question_id)
static	_getQuestionTitle (int $question_id)
static	saveOriginalId (int $questionId, int $originalId)
static	resetOriginalId (int $questionId)
static	_getInternalLinkHref (string $target="")
static	_getOriginalId (int $question_id)
static	originalQuestionExists (int $questionId)
static	_instanciateQuestion (int $question_id)
static	_instantiateQuestion (int $question_id)
static	instantiateQuestion (int $question_id)
static	_getSolutionMaxPass (int $question_id, int $active_id)
	Returns the maximum pass a users question solution. More...
static	_isWriteable (int $question_id, int $user_id)
static	_isUsedInRandomTest (int $question_id)
static	_isWorkedThrough (int $active_id, int $question_id, int $pass)
	Returns true if the question was worked through in the given pass Worked through means that the user entered at least one value. More...
static	_areAnswered (int $a_user_id, array $a_question_ids)
	Checks if an array of question ids is answered by a user or not. More...
static	_setReachedPoints (int $active_id, int $question_id, float $points, float $maxpoints, int $pass, bool $manualscoring, bool $obligationsEnabled)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...
static	_needsManualScoring (int $question_id)
static	_includeClass (string $question_type, int $gui=0)
static	getFeedbackClassNameByQuestionType (string $questionType)
static	isCoreQuestionType (string $questionType)
static	includeCoreClass ($questionType, $withGuiClass)
static	_getQuestionTypeName ($type_tag)
static	_instanciateQuestionGUI (int $question_id)
static	instantiateQuestionGUI (int $a_question_id)
static	_questionExistsInTest (int $question_id, int $test_id)
static	lookupParentObjId (int $questionId)
static	lookupOriginalParentObjId (int $originalQuestionId)
	returns the parent object id for given original question id (should be a qpl id, but theoretically it can be a tst id, too) More...
static	isObligationPossible (int $questionId)
static	implodeKeyValues (array $keyValues)
static	explodeKeyValues (string $keyValues)
static	convertISO8601FormatH_i_s_ExtendedToSeconds (string $time)
static	missingResultRecordExists (int $activeId, int $pass, array $questionIds)
static	getQuestionsMissingResultRecord (int $activeId, int $pass, array $questionIds)
static	lookupResultRecordExist (int $activeId, int $questionId, int $pass)
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	$allowedFileExtensionsByMimeType
static	$allowedCharsetsByMimeType
static	$allowedImageMaterialFileExtensionsByMimeType
static	$forcePassResultsUpdateEnabled = 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 39 of file class.assMatchingQuestion.php.

Constructor & Destructor Documentation

__construct()

assMatchingQuestion::__construct	(		$title = "",
			$comment = "",
			$author = "",
			$owner = -1,
			$question = "",
			$matching_type = 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 102 of file class.assMatchingQuestion.php.

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

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

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 766 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 604 of file class.assMatchingQuestion.php.

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

References assQuestion\$points, and createMatchingPair().

Here is the call graph for this function:

addTerm()

assMatchingQuestion::addTerm

(

assAnswerMatchingTerm

$term

)

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

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

afterSyncWithOriginal()

assMatchingQuestion::afterSyncWithOriginal (   $origQuestionId,   $dupQuestionId,   $origParentObjId,   $dupParentObjId  )

protected

{}

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

                                                                                                                : void
    {
        parent::afterSyncWithOriginal($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId);
 
        $origImagePath = $this->buildImagePath($origQuestionId, $origParentObjId);
        $dupImagePath = $this->buildImagePath($dupQuestionId, $dupParentObjId);
 
        ilFileUtils::delDir($origImagePath);
        if (is_dir($dupImagePath)) {
            ilFileUtils::makeDirParents($origImagePath);
            ilFileUtils::rCopy($dupImagePath, $origImagePath);
        }
    }

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

Here is the call graph for this function:

calculateReachedPoints()

assMatchingQuestion::calculateReachedPoints	(		$active_id,
			$pass = null,
			$authorizedSolution = true,
			$returndetails = false
	)

Returns the points, a learner has reached answering the question.

The points are calculated from the given answers.

@access public

Parameters

integer	$active_id
integer	$pass
boolean	$returndetails	(deprecated !!)

Returns

integer/array $points/$details (array $details is deprecated !!)

Reimplemented from assQuestion.

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

                                                                                                                        : float
    {
        if ($returndetails) {
            throw new ilTestException('return details not implemented for ' . __METHOD__);
        }
 
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $found_values = [];
        if (is_null($pass)) {
            $pass = $this->getSolutionMaxPass($active_id);
        }
        $result = $this->getCurrentSolutionResultSet($active_id, (int) $pass, $authorizedSolution);
        while ($data = $ilDB->fetchAssoc($result)) {
            if (strcmp($data["value1"], "") != 0) {
                if (!isset($found_values[$data['value2']])) {
                    $found_values[$data['value2']] = array();
                }
 
                $found_values[$data['value2']][] = $data['value1'];
            }
        }
 
        $points = $this->calculateReachedPointsForSolution($found_values);
 
        return $points;
    }

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

Here is the call graph for this function:

calculateReachedPointsForSolution()

assMatchingQuestion::calculateReachedPointsForSolution (   $found_values )

protected

Parameters

$found_values

Returns

float

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

                                                                       : float
    {
        $points = 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;
    }

References assQuestion\$points, and $terms.

Referenced by calculateReachedPoints().

Here is the caller graph for this function:

checkSubmittedMatchings()

assMatchingQuestion::checkSubmittedMatchings (   $submittedMatchings )

private

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

                                                                 : bool
    {
        if ($this->getMatchingMode() == self::MATCHING_MODE_N_ON_N) {
            return true;
        }
 
        $handledTerms = array();
 
        foreach ($submittedMatchings as $definition => $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;
    }

References $i, $terms, getMatchingMode(), and ILIAS\Repository\lng().

Referenced by savePreviewData(), and saveWorkingData().

Here is the call graph for this function:

Here is the caller graph for this function:

copyImages()

assMatchingQuestion::copyImages	(		$question_id,
			$source_questionpool
	)

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

                                                                  : void
    {
        global $DIC;
        $ilLog = $DIC['ilLog'];
 
        $imagepath = $this->getImagePath();
        $imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
        $imagepath_original = str_replace("/$this->obj_id/", "/$source_questionpool/", $imagepath_original);
        foreach ($this->terms as $term) {
            if (strlen($term->getPicture())) {
                if (!file_exists($imagepath)) {
                    ilFileUtils::makeDirParents($imagepath);
                }
                $filename = $term->getPicture();
                if (!@copy($imagepath_original . $filename, $imagepath . $filename)) {
                    $ilLog->write("matching question image could not be copied: $imagepath_original$filename");
                }
                if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename)) {
                    $ilLog->write("matching question image thumbnail could not be copied: $imagepath_original" . $this->getThumbPrefix() . $filename);
                }
            }
        }
        foreach ($this->definitions as $definition) {
            if (strlen($definition->getPicture())) {
                $filename = $definition->getPicture();
                if (!file_exists($imagepath)) {
                    ilFileUtils::makeDirParents($imagepath);
                }
 
                if (assQuestion::isFileAvailable($imagepath_original . $filename)) {
                    copy($imagepath_original . $filename, $imagepath . $filename);
                } else {
                    $ilLog->write("matching question image could not be copied: $imagepath_original$filename");
                }
 
                if (assQuestion::isFileAvailable($imagepath_original . $this->getThumbPrefix() . $filename)) {
                    copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename);
                } else {
                    $ilLog->write("matching question image thumbnail could not be copied: $imagepath_original" . $this->getThumbPrefix() . $filename);
                }
            }
        }
    }

References $DIC, $filename, assQuestion\$ilLog, assQuestion\getImagePath(), getThumbPrefix(), assQuestion\isFileAvailable(), and ilFileUtils\makeDirParents().

Here is the call graph for this function:

copyObject()

assMatchingQuestion::copyObject	(		$target_questionpool_id,
			$title = ""
	)

Copies an assMatchingQuestion.

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

                                                                    : int
    {
        if ($this->getId() <= 0) {
            throw new RuntimeException('The question has not been saved. It cannot be duplicated');
        }
        // duplicate the question in database
        $clone = $this;
        include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
        $original_id = assQuestion::_getOriginalId($this->id);
        $clone->id = -1;
        $source_questionpool_id = $this->getObjId();
        $clone->setObjId($target_questionpool_id);
        if ($title) {
            $clone->setTitle($title);
        }
        $clone->saveToDb();
        // copy question page content
        $clone->copyPageOfQuestion($original_id);
        // copy XHTML media objects
        $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
        // duplicate the image
        $clone->copyImages($original_id, $source_questionpool_id);
 
        $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
 
        return $clone->id;
    }

References assQuestion\$original_id, assQuestion\$title, assQuestion\_getOriginalId(), assQuestion\getId(), and assQuestion\getObjId().

Here is the call graph for this function:

createMatchingDefinition()

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

protected

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

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

Referenced by insertDefinition(), and loadFromDb().

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 1615 of file class.assMatchingQuestion.php.

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

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

Here is the caller graph for this function:

createMatchingTerm()

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

protected

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

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

Referenced by insertTerm(), and loadFromDb().

Here is the caller graph for this function:

createNewOriginalFromThisDuplicate()

assMatchingQuestion::createNewOriginalFromThisDuplicate	(		$targetParentId,
			$targetQuestionTitle = ""
	)

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

                                                                                                  : int
    {
        if ($this->getId() <= 0) {
            throw new RuntimeException('The question has not been saved. It cannot be duplicated');
        }
 
        include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
 
        $sourceQuestionId = $this->id;
        $sourceParentId = $this->getObjId();
 
        // duplicate the question in database
        $clone = $this;
        $clone->id = -1;
 
        $clone->setObjId($targetParentId);
 
        if ($targetQuestionTitle) {
            $clone->setTitle($targetQuestionTitle);
        }
 
        $clone->saveToDb();
        // copy question page content
        $clone->copyPageOfQuestion($sourceQuestionId);
        // copy XHTML media objects
        $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
        // duplicate the image
        $clone->copyImages($sourceQuestionId, $sourceParentId);
 
        $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
 
        return $clone->id;
    }

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

Here is the call 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 847 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 1026 of file class.assMatchingQuestion.php.

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

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

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

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 665 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);
    }

References $index.

deleteTerm()

assMatchingQuestion::deleteTerm

(

$position

)

Deletes a term.

Parameters

string

$term_id

The id of the term to delete

See also

$terms

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

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

duplicate()

assMatchingQuestion::duplicate	(	bool	$for_test = true,
		string	$title = "",
		string	$author = "",
		string	$owner = "",
			$testObjId = null
	)

Duplicates an assMatchingQuestion.

Reimplemented from assQuestion.

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

                                                                                                                                    : int
    {
        if ($this->id <= 0) {
            // The question has not been saved. It cannot be duplicated
            return -1;
        }
        // duplicate the question in database
        $this_id = $this->getId();
        $thisObjId = $this->getObjId();
 
        $clone = $this;
        include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
        $original_id = assQuestion::_getOriginalId($this->id);
        $clone->id = -1;
 
        if ((int) $testObjId > 0) {
            $clone->setObjId($testObjId);
        }
 
        if ($title) {
            $clone->setTitle($title);
        }
        if ($author) {
            $clone->setAuthor($author);
        }
        if ($owner) {
            $clone->setOwner((int) $owner);
        }
        if ($for_test) {
            $clone->saveToDb($original_id);
        } else {
            $clone->saveToDb();
        }
 
        // copy question page content
        $clone->copyPageOfQuestion($this_id);
        // copy XHTML media objects
        $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
        // duplicate the image
        $clone->duplicateImages($this_id, $thisObjId, $clone->getId(), $testObjId);
 
        $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
 
        return $clone->id;
    }

References assQuestion\$author, assQuestion\$original_id, assQuestion\$owner, assQuestion\$title, assQuestion\_getOriginalId(), assQuestion\getId(), and assQuestion\getObjId().

Here is the call graph for this function:

duplicateImages()

assMatchingQuestion::duplicateImages	(		$question_id,
			$objectId = null
	)

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

                                                                   : void
    {
        global $DIC;
        $ilLog = $DIC['ilLog'];
        $imagepath = $this->getImagePath();
        $imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
 
        if ((int) $objectId > 0) {
            $imagepath_original = str_replace("/$this->obj_id/", "/$objectId/", $imagepath_original);
        }
 
        foreach ($this->terms as $term) {
            if (strlen($term->getPicture())) {
                $filename = $term->getPicture();
                if (!file_exists($imagepath)) {
                    ilFileUtils::makeDirParents($imagepath);
                }
                if (!@copy($imagepath_original . $filename, $imagepath . $filename)) {
                    $ilLog->write("matching question image could not be duplicated: $imagepath_original$filename");
                }
                if (@file_exists($imagepath_original . $this->getThumbPrefix() . $filename)) {
                    if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename)) {
                        $ilLog->write("matching question image thumbnail could not be duplicated: $imagepath_original" . $this->getThumbPrefix() . $filename);
                    }
                }
            }
        }
        foreach ($this->definitions as $definition) {
            if (strlen($definition->getPicture())) {
                $filename = $definition->getPicture();
                if (!file_exists($imagepath)) {
                    ilFileUtils::makeDirParents($imagepath);
                }
                if (!@copy($imagepath_original . $filename, $imagepath . $filename)) {
                    $ilLog->write("matching question image could not be duplicated: $imagepath_original$filename");
                }
                if (@file_exists($imagepath_original . $this->getThumbPrefix() . $filename)) {
                    if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename)) {
                        $ilLog->write("matching question image thumbnail could not be duplicated: $imagepath_original" . $this->getThumbPrefix() . $filename);
                    }
                }
            }
        }
    }

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

Here is the call graph for this function:

fetchIndexedValuesFromValuePairs()

assMatchingQuestion::fetchIndexedValuesFromValuePairs

(

array

$valuePairs

)

Parameters

array

$valuePairs

Returns

array $indexedValues

Reimplemented from assQuestion.

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

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

fetchSubmittedMatchingsFromPost()

assMatchingQuestion::fetchSubmittedMatchingsFromPost ( )

private

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

                                                      : array
    {
        $request = $this->dic->testQuestionPool()->internal()->request();
        $post = $request->getParsedBody();
 
        $matchings = array();
        if (array_key_exists('matching', $post)) {
            $postData = $post['matching'][$this->getId()];
            foreach ($this->getDefinitions() as $definition) {
                if (isset($postData[$definition->getIdentifier()])) {
                    foreach ($this->getTerms() as $term) {
                        if (isset($postData[$definition->getIdentifier()][$term->getIdentifier()])) {
                            if (!is_array($postData[$definition->getIdentifier()])) {
                                $postData[$definition->getIdentifier()] = array();
                            }
                            $matchings[$definition->getIdentifier()][] = $term->getIdentifier();
                        }
                    }
                }
            }
        }
 
        return $matchings;
    }

References $post, getDefinitions(), assQuestion\getId(), and getTerms().

Referenced by savePreviewData(), and saveWorkingData().

Here is the call graph for this function:

Here is the caller graph for this function:

flushDefinitions()

assMatchingQuestion::flushDefinitions

(

)

Deletes all definitions.

See also

$definitions

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

                                      : void
    {
        $this->definitions = array();
    }

flushMatchingPairs()

assMatchingQuestion::flushMatchingPairs

(

)

Deletes all matching pairs.

See also

$matchingpairs

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

                                        : void
    {
        $this->matchingpairs = array();
    }

flushTerms()

assMatchingQuestion::flushTerms

(

)

Deletes all terms.

See also

$terms

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

                                : void
    {
        $this->terms = array();
    }

generateThumbForFile()

assMatchingQuestion::generateThumbForFile (   $path,   $file  )

protected

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

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

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

Referenced by rebuildThumbnails().

Here is the call graph for this function:

Here is the caller graph for this function:

getAdditionalTableName()

assMatchingQuestion::getAdditionalTableName

(

)

Returns

string|array Or Array?

See also

Deletion methods here

Reimplemented from assQuestion.

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

                                            : string
    {
        return "qpl_qst_matching";
    }

Referenced by saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

getAnswerTableName()

assMatchingQuestion::getAnswerTableName

(

)

Returns

string|array Or Array?

See also

Deletion methods here

Reimplemented from assQuestion.

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

                                        : array
    {
        return array("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

Implements iQuestionCondition.

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

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

References $index, getMatchingPair(), and 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 750 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 728 of file class.assMatchingQuestion.php.

                                    : array
    {
        return $this->definitions;
    }

References $definitions.

Referenced by fetchSubmittedMatchingsFromPost(), and toJSON().

Here is the caller graph for this function:

getDefinitionWithIdentifier()

assMatchingQuestion::getDefinitionWithIdentifier

(

$a_identifier

)

Returns a definition with a given identifier.

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

    {
        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 992 of file class.assMatchingQuestion.php.

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

References $filename.

getExpressionTypes()

assMatchingQuestion::getExpressionTypes

(

)

Get all available expression types for a specific question.

Returns

array

Implements iQuestionCondition.

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

                                        : array
    {
        return array(
            iQuestionCondition::PercentageResultExpression,
            iQuestionCondition::NumericResultExpression,
            iQuestionCondition::MatchingResultExpression,
            iQuestionCondition::EmptyAnswerExpression,
        );
    }

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

getMatchingMode()

assMatchingQuestion::getMatchingMode

(

)

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

                                     : string
    {
        return $this->matchingMode;
    }

References $matchingMode.

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

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 644 of file class.assMatchingQuestion.php.

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

References $index.

Referenced by getAvailableAnswerOptions().

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 706 of file class.assMatchingQuestion.php.

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

getMatchingPairs()

& assMatchingQuestion::getMatchingPairs

(

)

Returns the matchingpairs array.

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

                                       : array
    {
        return $this->matchingpairs;
    }

References $matchingpairs.

Referenced by getAvailableAnswerOptions(), saveAnswerSpecificDataToDb(), setExportDetailsXLS(), and toJSON().

Here is the caller graph for this function:

getMaximumPoints()

assMatchingQuestion::getMaximumPoints

(

)

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

Reimplemented from assQuestion.

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

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

References assQuestion\$points, and getMaximumScoringMatchingPairs().

Referenced by isComplete().

Here is the call graph for this function:

Here is the caller graph for this function:

getMaximumScoringMatchingPairs()

assMatchingQuestion::getMaximumScoringMatchingPairs

(

)

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

                                                    : 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 array();
    }

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

Referenced by getMaximumPoints().

Here is the call graph for this function:

Here is the caller graph for this function:

getMostPositiveScoredUniqueTermMatchingPairs()

assMatchingQuestion::getMostPositiveScoredUniqueTermMatchingPairs ( )

private

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

                                                                   : array
    {
        $matchingPairsByDefinition = array();
 
        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;
    }

Referenced by getMaximumScoringMatchingPairs().

Here is the caller graph for this function:

getOperators()

assMatchingQuestion::getOperators

(

$expression

)

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

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

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

References ilOperatorsExpressionMapping\getOperatorsByExpression().

Here is the call graph for this function:

getPositiveScoredMatchingPairs()

assMatchingQuestion::getPositiveScoredMatchingPairs ( )

private

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

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

Referenced by getMaximumScoringMatchingPairs().

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

Reimplemented from assQuestion.

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

                                     : string
    {
        return "assMatchingQuestion";
    }

Referenced by toJSON().

Here is the caller graph for this function:

getRandomId()

assMatchingQuestion::getRandomId

(

)

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

References ILIAS\LTI\ToolProvider\$key.

getRTETextWithMediaObjects()

assMatchingQuestion::getRTETextWithMediaObjects

(

)

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

Reimplemented from assQuestion.

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

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

getShuffleMode()

assMatchingQuestion::getShuffleMode

(

)

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

                                    : int
    {
        return $this->shufflemode;
    }

References $shufflemode.

Referenced by saveAdditionalQuestionDataToDb().

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 739 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 717 of file class.assMatchingQuestion.php.

                              : array
    {
        return $this->terms;
    }

References $terms.

Referenced by fetchSubmittedMatchingsFromPost(), and toJSON().

Here is the caller graph for this function:

getTermWithIdentifier()

assMatchingQuestion::getTermWithIdentifier

(

$a_identifier

)

Returns a term with a given identifier.

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

    {
        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 1291 of file class.assMatchingQuestion.php.

                                      : int
    {
        return $this->thumb_geometry;
    }

References $thumb_geometry.

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

Here is the caller graph for this function:

getThumbPrefix()

assMatchingQuestion::getThumbPrefix

(

)

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

                                    : string
    {
        return "thumb.";
    }

Referenced by copyImages(), deleteImagefile(), duplicateImages(), generateThumbForFile(), and setImageFile().

Here is the caller graph for this function:

getThumbSize()

assMatchingQuestion::getThumbSize

(

)

Get the thumbnail geometry.

Returns

integer Geometry

Reimplemented from assQuestion.

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

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

References getThumbGeometry().

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 797 of file class.assMatchingQuestion.php.

                                                                                               : 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, array($definition), $part2);
        } else {
            array_push($this->definitions, $definition);
        }
    }

References createMatchingDefinition().

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 580 of file class.assMatchingQuestion.php.

                                                                                                  : 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, array($pair), $part2);
        } else {
            array_push($this->matchingpairs, $pair);
        }
    }

References assQuestion\$points, and createMatchingPair().

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 777 of file class.assMatchingQuestion.php.

                                                                             : 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, array($term), $part2);
        } else {
            array_push($this->terms, $term);
        }
    }

References createMatchingTerm().

Here is the call graph for this function:

isComplete()

assMatchingQuestion::isComplete

(

)

Returns true, if a matching question is complete for use.

Returns

boolean True, if the matching question is complete for use, otherwise false

Reimplemented from assQuestion.

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

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

References getMaximumPoints().

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 266 of file class.assMatchingQuestion.php.

                                            : void
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $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 = $ilDB->queryF(
            $query,
            array('integer'),
            array($question_id)
        );
 
        if ($result->numRows() == 1) {
            $data = $ilDB->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"]);
            include_once("./Services/RTE/classes/class.ilRTE.php");
            $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 = array();
        $result = $ilDB->queryF(
            "SELECT * FROM qpl_a_mterm WHERE question_fi = %s ORDER BY term_id ASC",
            array('integer'),
            array($question_id)
        );
        $this->terms = [];
        if ($result->numRows() > 0) {
            while ($data = $ilDB->fetchAssoc($result)) {
                $term = $this->createMatchingTerm($data['term'] ?? '', $data['picture'] ?? '', (int) $data['ident']);
                $this->terms[] = $term;
                $termids[$data['term_id']] = $term;
            }
        }
 
        $definitionids = array();
        $result = $ilDB->queryF(
            "SELECT * FROM qpl_a_mdef WHERE question_fi = %s ORDER BY def_id ASC",
            array('integer'),
            array($question_id)
        );
 
        $this->definitions = array();
        if ($result->numRows() > 0) {
            while ($data = $ilDB->fetchAssoc($result)) {
                $definition = $this->createMatchingDefinition($data['definition'] ?? '', $data['picture'] ?? '', (int) $data['ident']);
                array_push($this->definitions, $definition);
                $definitionids[$data['def_id']] = $definition;
            }
        }
 
        $this->matchingpairs = array();
        $result = $ilDB->queryF(
            "SELECT * FROM qpl_a_matching WHERE question_fi = %s ORDER BY answer_id",
            array('integer'),
            array($question_id)
        );
        if ($result->numRows() > 0) {
            while ($data = $ilDB->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);
    }

References $data, $DIC, Vendor\Package\$e, $ilDB, $query, ilRTE\_replaceMediaObjectImageSrc(), createMatchingDefinition(), createMatchingPair(), createMatchingTerm(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), 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().

Here is the call graph for this function:

rebuildThumbnails()

assMatchingQuestion::rebuildThumbnails

(

)

Rebuild the thumbnail images with a new thumbnail size.

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

                                       : void
    {
        foreach ($this->terms as $term) {
            if (strlen($term->getPicture())) {
                $this->generateThumbForFile($this->getImagePath(), $term->getPicture());
            }
        }
        foreach ($this->definitions as $definition) {
            if (strlen($definition->getPicture())) {
                $this->generateThumbForFile($this->getImagePath(), $definition->getPicture());
            }
        }
    }

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

Referenced by saveAnswerSpecificDataToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

removeDefinitionImage()

assMatchingQuestion::removeDefinitionImage

(

$index

)

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

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

References $index, and deleteImagefile().

Here is the call graph for this function:

removeTermImage()

assMatchingQuestion::removeTermImage

(

$index

)

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

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

References $index, and deleteImagefile().

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 238 of file class.assMatchingQuestion.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        // save additional data
 
        $ilDB->manipulateF(
            "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
            array( "integer" ),
            array( $this->getId() )
        );
 
        $ilDB->insert($this->getAdditionalTableName(), array(
            'question_fi' => array('integer', $this->getId()),
            'shuffle' => array('text', $this->getShuffleMode()),
            'matching_type' => array('text', $this->matching_type),
            'thumb_geometry' => array('integer', $this->getThumbGeometry()),
            'matching_mode' => array('text', $this->getMatchingMode())
        ));
    }

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

Referenced by saveToDb().

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 168 of file class.assMatchingQuestion.php.

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

References $DIC, $ilDB, ILIAS\LTI\ToolProvider\$key, $matchingpairs, assQuestion\getId(), getMatchingPairs(), and rebuildThumbnails().

Referenced by saveToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

savePreviewData()

assMatchingQuestion::savePreviewData ( ilAssQuestionPreviewSession  $previewSession )

protected

Reimplemented from assQuestion.

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

                                                                                   : void
    {
        $submittedMatchings = $this->fetchSubmittedMatchingsFromPost();
 
        if ($this->checkSubmittedMatchings($submittedMatchings)) {
            $previewSession->setParticipantsSolution($submittedMatchings);
        }
    }

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

Here is the call graph for this function:

saveToDb()

assMatchingQuestion::saveToDb

(

$original_id = ""

)

Saves a assMatchingQuestion object to a database.

Parameters

string

$original_id

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

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

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

Here is the call graph for this function:

saveWorkingData()

assMatchingQuestion::saveWorkingData	(		$active_id,
			$pass = null,
			$authorized = true
	)

Saves the learners input of the question to the database.

@access public

Parameters

integer	$active_id	Active id of the user
integer	$pass	Test pass

Returns

boolean $status

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

                                                                                 : bool
    {
        $submittedMatchings = $this->fetchSubmittedMatchingsFromPost();
        $submittedMatchingsValid = $this->checkSubmittedMatchings($submittedMatchings);
 
        $matchingsExist = false;
 
        if ($submittedMatchingsValid) {
            if (is_null($pass)) {
                include_once "./Modules/Test/classes/class.ilObjTest.php";
                $pass = ilObjTest::_getPass($active_id);
            }
 
            $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(function () use (&$matchingsExist, $submittedMatchings, $active_id, $pass, $authorized) {
                $this->removeCurrentSolution($active_id, $pass, $authorized);
 
                foreach ($submittedMatchings as $definition => $terms) {
                    foreach ($terms as $i => $term) {
                        $this->saveCurrentSolution($active_id, $pass, $term, $definition, $authorized);
                        $matchingsExist = true;
                    }
                }
            });
 
            $saveWorkingDataResult = true;
        } else {
            $saveWorkingDataResult = false;
        }
 
        include_once("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
        if (ilObjAssessmentFolder::_enabledAssessmentLogging()) {
            if ($matchingsExist) {
                assQuestion::logAction($this->lng->txtlng(
                    "assessment",
                    "log_user_entered_values",
                    ilObjAssessmentFolder::_getLogLanguage()
                ), $active_id, $this->getId());
            } else {
                assQuestion::logAction($this->lng->txtlng(
                    "assessment",
                    "log_user_not_entered_values",
                    ilObjAssessmentFolder::_getLogLanguage()
                ), $active_id, $this->getId());
            }
        }
 
        return $saveWorkingDataResult;
    }

References $i, $terms, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), checkSubmittedMatchings(), fetchSubmittedMatchingsFromPost(), assQuestion\getProcessLocker(), ILIAS\Repository\lng(), assQuestion\logAction(), assQuestion\removeCurrentSolution(), and assQuestion\saveCurrentSolution().

Here is the call graph for this function:

setExportDetailsXLS()

assMatchingQuestion::setExportDetailsXLS	(	ilAssExcelFormatHelper	$worksheet,
		int	$startrow,
		int	$active_id,
		int	$pass
	)

{}

Reimplemented from assQuestion.

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

                                                                                                                    : int
    {
        parent::setExportDetailsXLS($worksheet, $startrow, $active_id, $pass);
 
        $solutions = $this->getSolutionValues($active_id, $pass);
 
        $imagepath = $this->getImagePath();
        $i = 1;
        foreach ($solutions as $solution) {
            $matches_written = false;
            foreach ($this->getMatchingPairs() as $idx => $pair) {
                if (!$matches_written) {
                    $worksheet->setCell($startrow + $i, 1, $this->lng->txt("matches"));
                }
                $matches_written = true;
                if ($pair->getDefinition()->getIdentifier() == $solution["value2"]) {
                    if (strlen($pair->getDefinition()->getText())) {
                        $worksheet->setCell($startrow + $i, 0, $pair->getDefinition()->getText());
                    } else {
                        $worksheet->setCell($startrow + $i, 0, $pair->getDefinition()->getPicture());
                    }
                }
                if ($pair->getTerm()->getIdentifier() == $solution["value1"]) {
                    if (strlen($pair->getTerm()->getText())) {
                        $worksheet->setCell($startrow + $i, 2, $pair->getTerm()->getText());
                    } else {
                        $worksheet->setCell($startrow + $i, 2, $pair->getTerm()->getPicture());
                    }
                }
            }
            $i++;
        }
 
        return $startrow + $i + 1;
    }

References $i, assQuestion\getImagePath(), getMatchingPairs(), assQuestion\getSolutionValues(), ILIAS\Repository\lng(), and ilAssExcelFormatHelper\setCell().

Here is the call graph for this function:

setImageFile()

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

Sets the image file and uploads the image to the object's image directory.

Parameters

string	$image_filename	Name of the original image file
string	$image_tempfilename	Name of the temporary uploaded image file

Returns

integer An errorcode if the image upload fails, 0 otherwise @access public

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

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

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

Here is the call graph for this function:

setMatchingMode()

assMatchingQuestion::setMatchingMode

(

$matchingMode

)

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

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

References $matchingMode.

Referenced by loadFromDb().

Here is the caller graph for this function:

setShuffle()

assMatchingQuestion::setShuffle

(

$shuffle = true

)

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

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

References assQuestion\$shuffle.

Referenced by loadFromDb().

Here is the caller graph for this function:

setShuffleMode()

assMatchingQuestion::setShuffleMode

(

int

$shuffle

)

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

    {
        $this->shufflemode = $shuffle;
    }

References assQuestion\$shuffle.

Referenced by loadFromDb().

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 860 of file class.assMatchingQuestion.php.

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

References $index.

setThumbGeometry()

assMatchingQuestion::setThumbGeometry

(

int

$a_geometry

)

Set the thumbnail geometry.

Parameters

integer

$a_geometry

Geometry

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

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

Referenced by loadFromDb().

Here is the caller graph for this function:

supportsJavascriptOutput()

assMatchingQuestion::supportsJavascriptOutput

(

)

Reimplemented from assQuestion.

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

                                              : bool
    {
        return true;
    }

supportsNonJsOutput()

assMatchingQuestion::supportsNonJsOutput

(

)

Reimplemented from assQuestion.

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

                                         : bool
    {
        return false;
    }

toJSON()

assMatchingQuestion::toJSON

(

)

Returns a JSON representation of the question.

Reimplemented from assQuestion.

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

                            : 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'] = array(
            '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);
    }

References $definitions, $mobs, $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().

Here is the call graph for this function:

withMatchingPairs()

assMatchingQuestion::withMatchingPairs

(

array

$pairs

)

Parameters

assAnswerMatchingPair[]

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

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

Field Documentation

$definitions

assMatchingQuestion::$definitions

protected

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

Referenced by getDefinitions(), and toJSON().

$element_height

assMatchingQuestion::$element_height

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

$matching_type

assMatchingQuestion::$matching_type

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

Referenced by __construct().

$matchingMode

assMatchingQuestion::$matchingMode = self::MATCHING_MODE_1_ON_1

protected

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

Referenced by getMatchingMode(), and setMatchingMode().

$matchingpairs

assMatchingQuestion::$matchingpairs

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

Referenced by getMatchingPairs(), and saveAnswerSpecificDataToDb().

$randomGroup

RandomGroup assMatchingQuestion::$randomGroup

private

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

$shufflemode

int assMatchingQuestion::$shufflemode = 0

private

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

Referenced by getShuffleMode().

$terms

array assMatchingQuestion::$terms = []

protected

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

Referenced by calculateReachedPointsForSolution(), checkSubmittedMatchings(), getTerms(), saveWorkingData(), and toJSON().

$thumb_geometry

assMatchingQuestion::$thumb_geometry = 100

Definition at line 74 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 83 of file class.assMatchingQuestion.php.

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

MATCHING_MODE_N_ON_N

const assMatchingQuestion::MATCHING_MODE_N_ON_N = 'n:n'

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

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

---

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

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