assMatchingQuestion Class Reference

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

Inheritance diagram for assMatchingQuestion:

Collaboration diagram for assMatchingQuestion:

Public Member Functions
	__construct ( $title="", $comment="", $author="", $owner=-1, $question="", $matching_type=MT_TERMS_DEFINITIONS)
	assMatchingQuestion constructor More...
	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 ($for_test=true, $title="", $author="", $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 ($term=null, $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...
	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 ($term)
	Adds a term. More...
	addDefinition ($definition)
	Adds a definition. More...
	insertTerm ($position, $term=null)
	Inserts a term. More...
	insertDefinition ($position, $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 ($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)
	Sets the shuffle flag. More...
	getQuestionType ()
	Returns the question type of the question. More...
	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...
	getAnswerTableName ()
	Returns the name of the answer table in the database. More...
	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 ($worksheet, $startrow, $active_id, $pass)
	{Creates an Excel worksheet for the detailed cumulated results of this question. Parameters object $worksheet Reference to the parent excel worksheet object $startrow Startrow of the output in the excel worksheet object $active_id Active id of the participant object $pass Test pass Returns object } More...
	getThumbGeometry ()
	Get the thumbnail geometry. More...
	getThumbSize ()
	Get the thumbnail geometry. More...
	setThumbGeometry ($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 TODO. More...
	supportsJavascriptOutput ()
	Returns true if the question type supports JavaScript output. More...
	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
	getShuffler ()
	setShuffler (ilArrayElementShuffler $shuffler)
	setProcessLocker ($processLocker)
	getProcessLocker ()
	fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping, array $solutionhints=[])
	Receives parameters from a QTI parser and creates a valid ILIAS question object. More...
	toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $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 ($questionpool_id, $title)
	Returns TRUE if the question title exists in the database. More...
	setTitle ($title="")
	Sets the title string of the assQuestion object. More...
	setId ($id=-1)
	Sets the id of the assQuestion object. More...
	setTestId ($id=-1)
	Sets the test id of the assQuestion object. More...
	setComment ($comment="")
	Sets the comment string of the assQuestion object. More...
	setOutputType ($outputType=OUTPUT_HTML)
	Sets the output type. More...
	setShuffle ($shuffle=true)
	Sets the shuffle flag. More...
	setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)
	Sets the estimated working time of a question from given hour, minute and second. More...
	setEstimatedWorkingTimeFromDurationString ($durationString)
	Sets the estimated working time of a question from a given datetime string. More...
	keyInArray ($searchkey, $array)
	returns TRUE if the key occurs in an array More...
	setAuthor ($author="")
	Sets the authors name of the assQuestion object. More...
	setOwner ($owner="")
	Sets the creator/owner ID of the assQuestion object. More...
	getTitle ()
	Gets the title string of the assQuestion object. More...
	getTitleFilenameCompliant ()
	returns the object title prepared to be used as a filename More...
	getId ()
	Gets the id of the assQuestion object. More...
	getShuffle ()
	Gets the shuffle flag. More...
	getTestId ()
	Gets the test id of the assQuestion object. More...
	getComment ()
	Gets the comment string of the assQuestion object. More...
	getOutputType ()
	Gets the output type. More...
	getDescriptionForHTMLOutput ()
	supportsJavascriptOutput ()
	Returns true if the question type supports JavaScript output. More...
	supportsNonJsOutput ()
	requiresJsSwitch ()
	getEstimatedWorkingTime ()
	Gets the estimated working time of a question. More...
	getAuthor ()
	Gets the authors name of the assQuestion object. More...
	getAuthorForHTMLOutput ()
	getOwner ()
	Gets the creator/owner ID of the assQuestion object. More...
	getObjId ()
	Get the object id of the container object. More...
	setObjId ($obj_id=0)
	Set the object id of the container object. More...
	getLifecycle ()
	setLifecycle (ilAssQuestionLifecycle $lifecycle)
	setExternalId ($external_id)
	getExternalId ()
	getSuggestedSolutionOutput ()
&	_getSuggestedSolution ($question_id, $subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...
	getSuggestedSolutions ()
	Return the suggested solutions. More...
	getReachedPoints ($active_id, $pass=null)
	Returns the points, a learner has reached answering the question This is the fast way to get the points directly from the database. More...
	getMaximumPoints ()
	Returns the maximum points, a learner can reach answering the question. More...
	getAdjustedReachedPoints ($active_id, $pass=null, $authorizedSolution=true)
	returns the reached points ... More...
	calculateResultsFromSolution ($active_id, $pass=null, $obligationsEnabled=false)
	Calculates the question results from a previously saved question solution. More...
	persistWorkingState ($active_id, $pass=null, $obligationsEnabled=false, $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 ($active_id, $pass=null, $authorized=true)
	Saves the learners input of the question to the database. More...
	moveUploadedMediaFile ($file, $name)
	Move an uploaded media file to an public accessible temp dir to present it. More...
	getSuggestedSolutionPath ()
	Returns the path for a suggested solution. More...
	getJavaPath ()
	Returns the image path for web accessable images of a question. More...
	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...
	getJavaPathWeb ()
	Returns the web image path for web accessable java applets of a question. More...
	getSuggestedSolutionPathWeb ()
	Returns the web path for a suggested solution. More...
	getImagePathWeb ()
	Returns the web image path for web accessable images of a question. More...
	getFlashPathWeb ()
	Returns the web image path for web accessable flash applications of a question. More...
	getTestOutputSolutions ($activeId, $pass)
	getUserSolutionPreferingIntermediate ($active_id, $pass=null)
	getSolutionValues ($active_id, $pass=null, $authorized=true)
	Loads solutions of a given user from the database an returns it. More...
	isInUse ($question_id="")
	Checks whether the question is in use or not. More...
	isClone ($question_id="")
	Checks whether the question is a clone of another question or not. More...
	pcArrayShuffle ($array)
	Shuffles the values of a given array. More...
	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...
	getAnswerTableName ()
	Returns the name of the answer table in the database. More...
	deleteAnswers ($question_id)
	Deletes datasets from answers tables. More...
	deleteAdditionalTableData ($question_id)
	Deletes datasets from the additional question table in the database. More...
	delete ($question_id)
	Deletes a question and all materials from the database. More...
	getTotalAnswers ()
	get total number of answers More...
	_getTotalAnswers ($a_q_id)
	get number of answers for question id (static) note: do not use $this inside this method More...
	copyXHTMLMediaObjectsOfQuestion ($a_q_id)
	syncXHTMLMediaObjectsOfQuestion ()
	createPageObject ()
	create page object of question More...
	copyPageOfQuestion ($a_q_id)
	getPageOfQuestion ()
	setOriginalId ($original_id)
	getOriginalId ()
	fixSvgToPng ($imageFilenameContainingString)
	fixUnavailableSkinImageSources ($html)
	loadFromDb ($question_id)
	Loads the question from the database. More...
	createNewQuestion ($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 ($original_id="")
	saveToDb ($original_id="")
	Saves the question to the database. More...
	setNewOriginalId ($newId)
	deleteSuggestedSolutions ()
	Deletes all suggestes solutions in the database. More...
	getSuggestedSolution ($subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...
	getSuggestedSolutionTitle ($subquestion_index=0)
	Returns the title of a suggested solution at a given subquestion_index. More...
	setSuggestedSolution ($solution_id="", $subquestion_index=0, $is_import=false)
	Sets a suggested solution for the question. More...
	_resolveInternalLink ($internal_link)
	_resolveIntLinks ($question_id)
	syncWithOriginal ()
	_questionExists ($question_id)
	Returns true if the question already exists in the database. More...
	_questionExistsInPool ($question_id)
	Returns true if the question already exists in the database and is assigned to a question pool. More...
	getPoints ()
	Returns the maximum available points for the question. More...
	setPoints ($a_points)
	Sets the maximum available points for the question. More...
	getSolutionMaxPass ($active_id)
	Returns the maximum pass a users question solution. More...
	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 ($txt_output, $prepare_for_latex_output=false, $omitNl2BrWhenTextArea=false)
	Prepares a string for a text area output in tests. More...
	QTIMaterialToString ($a_material)
	Reads an QTI material tag an creates a text string. More...
	addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=true, $add_mobs=true)
	Creates a QTI material tag from a plain text or xhtml text. More...
	buildHashedImageFilename ($plain_image_filename, $unique=false)
	getQuestion ()
	Gets the question string of the question object. More...
	setQuestion ($question="")
	Sets the question string of the question object. More...
	getQuestionForHTMLOutput ()
	getQuestionType ()
	Returns the question type of the question. More...
	getQuestionTypeID ()
	Returns the question type of the question. More...
	cleanupMediaObjectUsage ()
	synchronises appearances of media objects in the question with media object usage table More...
&	getInstances ()
	Gets all instances of the question. More...
	getActiveUserData ($active_id)
	Returns the user id and the test id for a given active id. More...
	setExportDetailsXLS ($worksheet, $startrow, $active_id, $pass)
	Creates an Excel worksheet for the detailed cumulated results of this question. More...
	__get ($value)
	Object getter. More...
	__set ($key, $value)
	Object setter. More...
	getNrOfTries ()
	setNrOfTries ($a_nr_of_tries)
	setExportImagePath ($a_path)
	formatSAQuestion ($a_q)
	Format self assessment question. More...
	setPreventRteUsage ($a_val)
	Set prevent rte usage. More...
	getPreventRteUsage ()
	Get prevent rte usage. More...
	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)
	setSelfAssessmentEditingMode ($a_selfassessmenteditingmode)
	Set Self-Assessment Editing Mode. More...
	getSelfAssessmentEditingMode ()
	Get Self-Assessment Editing Mode. More...
	setDefaultNrOfTries ($a_defaultnroftries)
	Set Default Nr of Tries. More...
	getDefaultNrOfTries ()
	Get Default Nr of Tries. More...
	syncSkillAssignments ($srcParentId, $srcQuestionId, $trgParentId, $trgQuestionId)
	isAnswered ($active_id, $pass=null)
	returns boolean wether the question is answered during test pass or not More...
	isAutosaveable ()
	getAdditionalContentEditingMode ()
	getter for additional content editing mode for this question More...
	setAdditionalContentEditingMode ($additinalContentEditingMode)
	setter for additional content editing mode for this question More...
	isAdditionalContentEditingModePageObject ()
	isser for additional "pageobject" content editing mode More...
	isValidAdditionalContentEditingMode ($additionalContentEditingMode)
	returns the fact wether the passed additional content mode is valid or not More...
	getValidAdditionalContentEditingModes ()
	getter for valid additional content editing modes More...
	addQuestionChangeListener (ilQuestionChangeListener $listener)
	getQuestionChangeListeners ()
	getHtmlUserSolutionPurifier ()
	getHtmlQuestionContentPurifier ()
	setLastChange ($lastChange)
	getLastChange ()
	removeIntermediateSolution ($active_id, $pass)
	removeCurrentSolution ($active_id, $pass, $authorized=true)
	saveCurrentSolution ($active_id, $pass, $value1, $value2, $authorized=true, $tstamp=null)
	updateCurrentSolution ($solutionId, $value1, $value2, $authorized=true)
	updateCurrentSolutionsAuthorization ($activeId, $pass, $authorized, $keepTime=false)
	setStep ($step)
	getStep ()
	toJSON ()
	duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
	intermediateSolutionExists ($active_id, $pass)
	authorizedSolutionExists ($active_id, $pass)
	authorizedOrIntermediateSolutionExists ($active_id, $pass)
	isAddableAnswerOptionValue ($qIndex, $answerOptionValue)
	addAnswerOptionValue ($qIndex, $answerOptionValue, $points)
	removeAllExistingSolutions ()
	removeExistingSolutions ($activeId, $pass)
	resetUsersAnswer ($activeId, $pass)
	removeResultRecord ($activeId, $pass)
	fetchValuePairsFromIndexedValues (array $indexedValues)
	fetchIndexedValuesFromValuePairs (array $valuePairs)
	areObligationsToBeConsidered ()
	setObligationsToBeConsidered ($obligationsToBeConsidered)
	updateTimestamp ()
	getTestPresentationConfig ()
	Get the test question configuration (initialised once) More...
	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	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'
	constant for additional content editing mode "default" More...
const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'
	constant for additional content editing mode "pageobject" More...
	$feedbackOBJ = null
	$prevent_rte_usage = false
	$selfassessmenteditingmode = false
	$defaultnroftries = 0
	$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...
Protected Member Functions inherited from assQuestion
	getQuestionAction ()
	isNonEmptyItemListPostSubmission ($postSubmissionFieldname)
	ensureCurrentTestPass ($active_id, $pass)
	lookupCurrentTestPass ($active_id, $pass)
	lookupTestId ($active_id)
	log ($active_id, $langVar)
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	deletePageOfQuestion ($question_id)
	Deletes the page object of a question with a given ID. More...
	onDuplicate ($originalParentId, $originalQuestionId, $duplicateParentId, $duplicateQuestionId)
	Will be called when a question is duplicated (inside a question pool or for insertion in a test) More...
	beforeSyncWithOriginal ($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId)
	afterSyncWithOriginal ($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId)
	onCopy ($sourceParentId, $sourceQuestionId, $targetParentId, $targetQuestionId)
	Will be called when a question is copied (into another question pool) More...
	duplicateSuggestedSolutionFiles ($parent_id, $question_id)
	Duplicates the files of a suggested solution if the question is duplicated. More...
	syncSuggestedSolutionFiles ($original_id)
	Syncs the files of a suggested solution if the question is synced. More...
	copySuggestedSolutionFiles ($source_questionpool_id, $source_question_id)
	ensureNonNegativePoints ($points)
	purifyAndPrepareTextAreaOutput (string $content)
	getRTETextWithMediaObjects ()
	Collects all text in the question which could contain media objects which were created with the Rich Text Editor. More...
	getSelfAssessmentFormatter ()
	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)
	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)
	duplicateQuestionHints ($originalQuestionId, $duplicateQuestionId)
	duplicateSkillAssignments ($srcParentId, $srcQuestionId, $trgParentId, $trgQuestionId)
	buildQuestionDataQuery ()
	getCurrentSolutionResultSet ($active_id, $pass, $authorized=true)
	Get a restulset for the current user solution for a this question by active_id and pass. More...
	removeSolutionRecordById ($solutionId)
	getSolutionRecordById ($solutionId)
	deleteDummySolutionRecord ($activeId, $passIndex)
	isDummySolutionRecord ($solutionRecord)
	deleteSolutionRecordByValues ($activeId, $passIndex, $authorized, $matchValues)
	duplicateIntermediateSolutionAuthorized ($activeId, $passIndex)
	forceExistingIntermediateSolution ($activeId, $passIndex, $considerDummyRecordCreation)
	buildTestPresentationConfig ()
	build basic test question configuration instance More...

Protected Attributes
	$terms
	$definitions
	$matchingMode = self::MATCHING_MODE_1_ON_1
Protected Attributes inherited from assQuestion
	$id
	$title
	$comment
	$owner
	$author
	$question
	$points
	$est_working_time
	$shuffle
	$test_id
	$obj_id
	$ilias
	$tpl
	$lng
	$db
	$refinery
	$outputType = OUTPUT_JAVASCRIPT
	$suggested_solutions
	$original_id
	$page
	$external_id = ''
	$questionChangeListeners = array()
	$processLocker
	$step = null
	$lastChange
	$shuffler
	$testQuestionConfig
	$lifecycle

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

Additional Inherited Members
Static Public Member Functions inherited from assQuestion
static	setForcePassResultUpdateEnabled ($forcePassResultsUpdateEnabled)
static	isForcePassResultUpdateEnabled ()
static	isAllowedImageMimeType ($mimeType)
static	fetchMimeTypeIdentifier ($contentTypeString)
static	getAllowedFileExtensionsForMimeType ($mimeType)
static	isAllowedImageFileExtension ($mimeType, $fileExtension)
static	getAllowedImageMaterialFileExtensions ()
static	_getMaximumPoints ($question_id)
	Returns the maximum points, a learner can reach answering the question. More...
static	_getQuestionInfo ($question_id)
	Returns question information from the database. More...
static	_getSuggestedSolutionCount ($question_id)
	Returns the number of suggested solutions associated with a question. More...
static	_getSuggestedSolutionOutput ($question_id)
	Returns the output of the suggested solution. More...
static	_getReachedPoints ($active_id, $question_id, $pass=null)
	Returns the points, a learner has reached answering the question. More...
static	_updateTestResultCache ($active_id, ilAssQuestionProcessLocker $processLocker=null)
	@TODO Move this to a proper place. More...
static	logAction ($logtext="", $active_id="", $question_id="")
	Logs an action into the Test&Assessment log. More...
static	getQuestionTypeFromDb ($question_id)
	get question type for question id More...
static	_getTotalRightAnswers ($a_q_id)
	get number of answers for question id (static) note: do not use $this inside this method More...
static	_getTitle ($a_q_id)
	Returns the title of a question. More...
static	_getQuestionText ($a_q_id)
	Returns question text. More...
static	isFileAvailable ($file)
static	_getQuestionType ($question_id)
	Returns the question type of a question with a given id. More...
static	_getQuestionTitle ($question_id)
	Returns the question title of a question with a given id. More...
static	saveOriginalId ($questionId, $originalId)
static	resetOriginalId ($questionId)
static	_getInternalLinkHref ($target="")
static	_getOriginalId ($question_id)
	Returns the original id of a question. More...
static	originalQuestionExists ($questionId)
static	_instanciateQuestion ($question_id)
	Creates an instance of a question with a given question id. More...
static	_instantiateQuestion ($question_id)
static	_getSolutionMaxPass ($question_id, $active_id)
	Returns the maximum pass a users question solution. More...
static	_isWriteable ($question_id, $user_id)
	Returns true if the question is writeable by a certain user. More...
static	_isUsedInRandomTest ($question_id="")
	Checks whether the question is used in a random test or not. More...
static	_isWorkedThrough ($active_id, $question_id, $pass=null)
	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 ($a_user_id, $a_question_ids)
	Checks if an array of question ids is answered by an user or not. More...
static	_setReachedPoints ($active_id, $question_id, $points, $maxpoints, $pass, $manualscoring, $obligationsEnabled)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...
static	_needsManualScoring ($question_id)
static	_includeClass ($question_type, $gui=0)
	Include the php class file for a given question type. More...
static	getGuiClassNameByQuestionType ($questionType)
static	getObjectClassNameByQuestionType ($questionType)
static	getFeedbackClassNameByQuestionType ($questionType)
static	isCoreQuestionType ($questionType)
static	includeCoreClass ($questionType, $withGuiClass)
static	includePluginClass ($questionType, $withGuiClass)
static	_getQuestionTypeName ($type_tag)
	Return the translation for a given question type tag. More...
static &	_instanciateQuestionGUI ($question_id)
	Creates an instance of a question gui with a given question id. More...
static	instantiateQuestionGUI ($a_question_id)
	Creates an instance of a question gui with a given question id. More...
static	_questionExistsInTest ($question_id, $test_id)
static	lookupParentObjId ($questionId)
	@global ilDBInterface $ilDB More...
static	lookupOriginalParentObjId ($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 ($questionId)
	returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration More...
static	implodeKeyValues ($keyValues)
static	explodeKeyValues ($keyValues)
static	setResultGateway ($resultGateway)
static	getResultGateway ()
static	sumTimesInISO8601FormatH_i_s_Extended ($time1, $time2)
static	convertISO8601FormatH_i_s_ExtendedToSeconds ($time)
static	missingResultRecordExists ($activeId, $pass, $questionIds)
static	getQuestionsMissingResultRecord ($activeId, $pass, $questionIds)
static	lookupResultRecordExist ($activeId, $questionId, $pass)
Static Protected Member Functions inherited from assQuestion
static	getNumExistingSolutionRecords ($activeId, $pass, $questionId)
	returns the number of existing solution records for the given test active / pass and given question id More...
static	getKeyValuesImplosionSeparator ()
Static Protected Attributes inherited from assQuestion
static	$allowedFileExtensionsByMimeType
static	$allowedCharsetsByMimeType
static	$allowedImageMaterialFileExtensionsByMimeType
static	$forcePassResultsUpdateEnabled = false
static	$imageSourceFixReplaceMap

Detailed Description

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

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

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

Returns

\assMatchingQuestion

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

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

References assQuestion\$author, assQuestion\$comment, $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 759 of file class.assMatchingQuestion.php.

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

addMatchingPair()

assMatchingQuestion::addMatchingPair	(		$term = null,
			$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 593 of file class.assMatchingQuestion.php.

    {
        require_once './Modules/TestQuestionPool/classes/class.assAnswerMatchingPair.php';
        require_once './Modules/TestQuestionPool/classes/class.assAnswerMatchingTerm.php';
        require_once './Modules/TestQuestionPool/classes/class.assAnswerMatchingDefinition.php';
        if (is_null($term)) {
            $term = new assAnswerMatchingTerm();
        }
        if (is_null($definition)) {
            $definition = new assAnswerMatchingDefinition();
        }
        $pair = new assAnswerMatchingPair($term, $definition, $points);
        array_push($this->matchingpairs, $pair);
    }

References assQuestion\$points.

addTerm()

assMatchingQuestion::addTerm

(

$term

)

Adds a term.

Parameters

string

$term

The text of the term

See also

$terms

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

    {
        array_push($this->terms, $term);
    }

afterSyncWithOriginal()

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

protected

{}

Reimplemented from assQuestion.

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

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

References assQuestion\buildImagePath(), ilUtil\delDir(), ilUtil\makeDirParents(), and ilUtil\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 870 of file class.assMatchingQuestion.php.

    {
        if ($returndetails) {
            throw new ilTestException('return details not implemented for ' . __METHOD__);
        }
 
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $found_values = array();
        if (is_null($pass)) {
            $pass = $this->getSolutionMaxPass($active_id);
        }
        $result = $this->getCurrentSolutionResultSet($active_id, $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, $pass, assQuestion\$points, $result, calculateReachedPointsForSolution(), assQuestion\getCurrentSolutionResultSet(), and assQuestion\getSolutionMaxPass().

Here is the call graph for this function:

calculateReachedPointsForSolution()

assMatchingQuestion::calculateReachedPointsForSolution (   $found_values )

protected

Parameters

$found_values

Returns

int

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

    {
        $points = 0;
        foreach ($found_values as $definition => $terms) {
            foreach ($terms as $term) {
                foreach ($this->matchingpairs as $pair) {
                    if ($pair->definition->identifier == $definition && $pair->term->identifier == $term) {
                        $points += $pair->points;
                    }
                }
            }
        }
        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 1084 of file class.assMatchingQuestion.php.

    {
        if ($this->getMatchingMode() == self::MATCHING_MODE_N_ON_N) {
            return true;
        }
 
        $handledTerms = array();
 
        foreach ($submittedMatchings as $definition => $terms) {
            if (count($terms) > 1) {
                ilUtil::sendFailure($this->lng->txt("multiple_matching_values_selected"), true);
                return false;
            }
 
            foreach ($terms as $i => $term) {
                if (isset($handledTerms[$term])) {
                    ilUtil::sendFailure($this->lng->txt("duplicate_matching_values_selected"), true);
                    return false;
                }
 
                $handledTerms[$term] = $term;
            }
        }
 
        return true;
    }

References $i, $terms, getMatchingMode(), and ilUtil\sendFailure().

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

    {
        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->picture)) {
                if (!file_exists($imagepath)) {
                    ilUtil::makeDirParents($imagepath);
                }
                $filename = $term->picture;
                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->picture)) {
                $filename = $definition->picture;
                if (!file_exists($imagepath)) {
                    ilUtil::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\getImagePath(), getThumbPrefix(), assQuestion\isFileAvailable(), and ilUtil\makeDirParents().

Here is the call graph for this function:

copyObject()

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

Copies an assMatchingQuestion.

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

    {
        if ($this->id <= 0) {
            // The question has not been saved. It cannot be duplicated
            return;
        }
        // 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(), and assQuestion\getObjId().

Here is the call graph for this function:

createNewOriginalFromThisDuplicate()

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

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

    {
        if ($this->id <= 0) {
            // The question has not been saved. It cannot be duplicated
            return;
        }
 
        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, 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 842 of file class.assMatchingQuestion.php.

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

deleteImagefile()

assMatchingQuestion::deleteImagefile

(

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

    {
        $deletename = $filename;
        $result = @unlink($this->getImagePath() . $deletename);
        $result = $result & @unlink($this->getImagePath() . $this->getThumbPrefix() . $deletename);
        return $result;
    }

References $filename, $result, 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 663 of file class.assMatchingQuestion.php.

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

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

duplicate()

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

Duplicates an assMatchingQuestion.

Reimplemented from assQuestion.

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

    {
        if ($this->id <= 0) {
            // The question has not been saved. It cannot be duplicated
            return;
        }
        // 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($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 462 of file class.assMatchingQuestion.php.

    {
        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->picture)) {
                $filename = $term->picture;
                if (!file_exists($imagepath)) {
                    ilUtil::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->picture)) {
                $filename = $definition->picture;
                if (!file_exists($imagepath)) {
                    ilUtil::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\getImagePath(), getThumbPrefix(), and ilUtil\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 964 of file class.assMatchingQuestion.php.

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

    {
        $postData = $_POST['matching'][$this->getId()];
 
        $matchings = array();
 
        foreach ($this->getDefinitions() as $definition) {
            if (isset($postData[$definition->identifier])) {
                foreach ($this->getTerms() as $term) {
                    if (isset($postData[$definition->identifier][$term->identifier])) {
                        if (!is_array($postData[$definition->identifier])) {
                            $postData[$definition->identifier] = array();
                        }
 
                        $matchings[$definition->identifier][] = $term->identifier;
                    }
                }
            }
        }
 
        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 819 of file class.assMatchingQuestion.php.

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

flushMatchingPairs()

assMatchingQuestion::flushMatchingPairs

(

)

Deletes all matching pairs.

See also

$matchingpairs

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

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

flushTerms()

assMatchingQuestion::flushTerms

(

)

Deletes all terms.

See also

$terms

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

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

generateThumbForFile()

assMatchingQuestion::generateThumbForFile (   $path,   $file  )

protected

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

    {
        $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;
            }
            ilUtil::convertImage($filename, $thumbpath, $ext, $this->getThumbGeometry());
        }
    }

References $filename, ilUtil\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 the name of the additional question data table in the database.

Returns

string The additional table name

Reimplemented from assQuestion.

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

    {
        return "qpl_qst_matching";
    }

Referenced by saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

getAnswerTableName()

assMatchingQuestion::getAnswerTableName

(

)

Returns the name of the answer table in the database.

Returns

string The answer table name

Reimplemented from assQuestion.

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

    {
        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

Returns

array|ASS_AnswerSimple

Implements iQuestionCondition.

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

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

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

    {
        foreach ($this->definitions as $definition) {
            if ($definition->identifier == $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 987 of file class.assMatchingQuestion.php.

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

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

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

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

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

getMatchingPairs()

& assMatchingQuestion::getMatchingPairs

(

)

Returns the matchingpairs array.

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

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

    {
        $points = 0;
 
        foreach ($this->getMaximumScoringMatchingPairs() as $pair) {
            $points += $pair->points;
        }
 
        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 913 of file class.assMatchingQuestion.php.

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

    {
        $matchingPairsByDefinition = array();
 
        foreach ($this->matchingpairs as $pair) {
            if ($pair->points <= 0) {
                continue;
            }
 
            $defId = $pair->definition->identifier;
 
            if (!isset($matchingPairsByDefinition[$defId])) {
                $matchingPairsByDefinition[$defId] = $pair;
            } elseif ($pair->points > $matchingPairsByDefinition[$defId]->points) {
                $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 1504 of file class.assMatchingQuestion.php.

    {
        require_once "./Modules/TestQuestionPool/classes/class.ilOperatorsExpressionMapping.php";
        return ilOperatorsExpressionMapping::getOperatorsByExpression($expression);
    }

References ilOperatorsExpressionMapping\getOperatorsByExpression().

Here is the call graph for this function:

getPositiveScoredMatchingPairs()

assMatchingQuestion::getPositiveScoredMatchingPairs ( )

private

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

    {
        $matchingPairs = array();
 
        foreach ($this->matchingpairs as $pair) {
            if ($pair->points <= 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.

    {
        return "assMatchingQuestion";
    }

Referenced by toJSON().

Here is the caller graph for this function:

getRandomId()

assMatchingQuestion::getRandomId

(

)

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

    {
        mt_srand((double) microtime() * 1000000);
        $random_number = mt_rand(1, 100000);
        $found = false;
        while ($found) {
            $found = false;
            foreach ($this->matchingpairs as $key => $pair) {
                if (($pair->term->identifier == $random_number) || ($pair->definition->identifier == $random_number)) {
                    $found = true;
                    $random_number++;
                }
            }
        }
        return $random_number;
    }

getRTETextWithMediaObjects()

assMatchingQuestion::getRTETextWithMediaObjects

(

)

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

Reimplemented from assQuestion.

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

    {
        return parent::getRTETextWithMediaObjects();
    }

getTermCount()

assMatchingQuestion::getTermCount

(

)

Returns the number of terms.

Returns

integer The number of terms

See also

$terms

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

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

getTerms()

assMatchingQuestion::getTerms

(

)

Returns the terms of the matching question.

Returns

array An array containing the terms

See also

$terms

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

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

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

getThumbGeometry()

assMatchingQuestion::getThumbGeometry

(

)

Get the thumbnail geometry.

Returns

integer Geometry

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

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

    {
        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

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

    {
        return $this->getThumbGeometry();
    }

References getThumbGeometry().

Here is the call graph for this function:

insertDefinition()

assMatchingQuestion::insertDefinition	(		$position,
			$definition = null
	)

Inserts a definition.

Parameters

object

$definition

The definition

See also

$definitions

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

    {
        if (is_null($definition)) {
            include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingDefinition.php";
            $definition = new assAnswerMatchingDefinition();
        }
        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);
        }
    }

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

    {
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingPair.php";
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingTerm.php";
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingDefinition.php";
        if (is_null($term)) {
            $term = new assAnswerMatchingTerm();
        }
        if (is_null($definition)) {
            $definition = new assAnswerMatchingDefinition();
        }
        $pair = new assAnswerMatchingPair($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.

insertTerm()

assMatchingQuestion::insertTerm	(		$position,
			$term = null
	)

Inserts a term.

Parameters

string

$term

The text of the term

See also

$terms

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

    {
        if (is_null($term)) {
            include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingTerm.php";
            $term = new assAnswerMatchingTerm();
        }
        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);
        }
    }

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

    {
        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

Reimplemented from assQuestion.

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

    {
        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($question_id);
            $this->setObjId($data["obj_fi"]);
            $this->setTitle($data["title"]);
            $this->setComment($data["description"]);
            $this->setOriginalId($data["original_id"]);
            $this->setNrOfTries($data['nr_of_tries']);
            $this->setAuthor($data["author"]);
            $this->setPoints($data["points"]);
            $this->setOwner($data["owner"]);
            include_once("./Services/RTE/classes/class.ilRTE.php");
            $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
            $this->setThumbGeometry($data["thumb_geometry"]);
            $this->setShuffle($data["shuffle"]);
            $this->setMatchingMode($data['matching_mode'] === null ? self::MATCHING_MODE_1_ON_1 : $data['matching_mode']);
            $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
 
            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)
        );
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingTerm.php";
        $this->terms = array();
        if ($result->numRows() > 0) {
            while ($data = $ilDB->fetchAssoc($result)) {
                $term = new assAnswerMatchingTerm($data['term'], $data['picture'], $data['ident']);
                array_push($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)
        );
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingDefinition.php";
        $this->definitions = array();
        if ($result->numRows() > 0) {
            while ($data = $ilDB->fetchAssoc($result)) {
                $definition = new assAnswerMatchingDefinition($data['definition'], $data['picture'], $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)
        );
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingPair.php";
        if ($result->numRows() > 0) {
            while ($data = $ilDB->fetchAssoc($result)) {
                array_push($this->matchingpairs, new assAnswerMatchingPair($termids[$data['term_fi']], $definitionids[$data['definition_fi']], $data['points']));
            }
        }
        parent::loadFromDb($question_id);
    }

References $data, $DIC, Vendor\Package\$e, $ilDB, $query, $result, ilRTE\_replaceMediaObjectImageSrc(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), assQuestion\setLifecycle(), setMatchingMode(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), setShuffle(), 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 1329 of file class.assMatchingQuestion.php.

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

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

    {
        $definition = $this->definitions[$index];
        if (is_object($definition)) {
            $this->deleteImagefile($definition->picture);
            $definition->picture = null;
        }
    }

References $index, and deleteImagefile().

Here is the call graph for this function:

removeTermImage()

assMatchingQuestion::removeTermImage

(

$index

)

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

    {
        $term = $this->terms[$index];
        if (is_object($term)) {
            $this->deleteImagefile($term->picture);
            $term->picture = null;
        }
    }

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 220 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->shuffle),
            '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(), 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 150 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->picture),
                'term' => array('text', $term->text),
                'ident' => array('integer', $term->identifier)
            ));
            $termids[$term->identifier] = $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->picture),
                'definition' => array('text', $definition->text),
                'ident' => array('integer', $definition->identifier)
            ));
            $definitionids[$definition->identifier] = $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->points,
                                    $termids[$pair->term->identifier],
                                    $definitionids[$pair->definition->identifier]
                                )
            );
        }
 
        $this->rebuildThumbnails();
    }

References $DIC, $ilDB, $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 1163 of file class.assMatchingQuestion.php.

    {
        $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

Reimplemented from assQuestion.

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $this->saveQuestionDataToDb($original_id);
        $this->saveAdditionalQuestionDataToDb();
        $this->saveAnswerSpecificDataToDb($ilDB);
 
 
        parent::saveToDb($original_id);
    }

References $DIC, $ilDB, 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

Reimplemented from assQuestion.

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $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 $DIC, $i, $ilDB, $pass, $terms, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), checkSubmittedMatchings(), fetchSubmittedMatchingsFromPost(), assQuestion\getProcessLocker(), assQuestion\logAction(), assQuestion\removeCurrentSolution(), and assQuestion\saveCurrentSolution().

Here is the call graph for this function:

setExportDetailsXLS()

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

{Creates an Excel worksheet for the detailed cumulated results of this question.

Parameters

object	$worksheet	Reference to the parent excel worksheet
object	$startrow	Startrow of the output in the excel worksheet
object	$active_id	Active id of the participant
object	$pass	Test pass

Returns

object

}

Reimplemented from assQuestion.

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

    {
        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->definition->identifier == $solution["value2"]) {
                    if (strlen($pair->definition->text)) {
                        $worksheet->setCell($startrow + $i, 0, $pair->definition->text);
                    } else {
                        $worksheet->setCell($startrow + $i, 0, $pair->definition->picture);
                    }
                }
                if ($pair->term->identifier == $solution["value1"]) {
                    if (strlen($pair->term->text)) {
                        $worksheet->setCell($startrow + $i, 2, $pair->term->text);
                    } else {
                        $worksheet->setCell($startrow + $i, 2, $pair->term->picture);
                    }
                }
            }
            $i++;
        }
 
        return $startrow + $i + 1;
    }

References $i, $pass, assQuestion\getImagePath(), getMatchingPairs(), and assQuestion\getSolutionValues().

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

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

References $result, ilUtil\convertImage(), deleteImagefile(), assQuestion\getImagePath(), getThumbGeometry(), getThumbPrefix(), ilUtil\makeDirParents(), and ilUtil\moveUploadedFile().

Here is the call graph for this function:

setMatchingMode()

assMatchingQuestion::setMatchingMode

(

$matchingMode

)

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

    {
        $this->matchingMode = $matchingMode;
    }

References $matchingMode.

Referenced by loadFromDb().

Here is the caller graph for this function:

setShuffle()

assMatchingQuestion::setShuffle

(

$shuffle = true

)

Sets the shuffle flag.

Parameters

integer

$shuffle

A flag indicating whether the answers are shuffled or not

See also

$shuffle

Reimplemented from assQuestion.

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

    {
        switch ($shuffle) {
            case 0:
            case 1:
            case 2:
            case 3:
                $this->shuffle = $shuffle;
                break;
            default:
                $this->shuffle = 1;
                break;
        }
    }

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

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

References $index.

setThumbGeometry()

assMatchingQuestion::setThumbGeometry

(

$a_geometry

)

Set the thumbnail geometry.

Parameters

integer

$a_geometry

Geometry

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

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

Referenced by loadFromDb().

Here is the caller graph for this function:

supportsJavascriptOutput()

assMatchingQuestion::supportsJavascriptOutput

(

)

Returns true if the question type supports JavaScript output.

Returns

boolean TRUE if the question type supports JavaScript output, FALSE otherwise @access public

Reimplemented from assQuestion.

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

    {
        return true;
    }

supportsNonJsOutput()

assMatchingQuestion::supportsNonJsOutput

(

)

Reimplemented from assQuestion.

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

    {
        return false;
    }

toJSON()

assMatchingQuestion::toJSON

(

)

Returns a JSON representation of the question TODO.

Reimplemented from assQuestion.

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

    {
        $result = array();
 
        $result['id'] = (int) $this->getId();
        $result['type'] = (string) $this->getQuestionType();
        $result['title'] = (string) $this->getTitle();
        $result['question'] = $this->formatSAQuestion($this->getQuestion());
        $result['nr_of_tries'] = (int) $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))
        );
 
        require_once 'Services/Randomization/classes/class.ilArrayElementShuffler.php';
        $this->setShuffler(new ilArrayElementShuffler());
        $seed = $this->getShuffler()->getSeed();
 
        $terms = array();
        $this->getShuffler()->setSeed($this->getShuffler()->buildSeedFromString($seed . 'terms'));
        foreach ($this->getShuffler()->shuffle($this->getTerms()) as $term) {
            $terms[] = array(
                "text" => $this->formatSAQuestion($term->text),
                "id" => (int) $this->getId() . $term->identifier
            );
        }
        $result['terms'] = $terms;
 
        // alex 9.9.2010 as a fix for bug 6513 I added the question id
        // to the "def_id" in the array. The $pair->definition->identifier is not
        // unique, since it gets it value from the morder table field
        // this value is not changed, when a question is copied.
        // thus copying the same question on a page results in problems
        // when the second one (the copy) is answered.
 
        $definitions = array();
        $this->getShuffler()->setSeed($this->getShuffler()->buildSeedFromString($seed . 'definitions'));
        foreach ($this->getShuffler()->shuffle($this->getDefinitions()) as $def) {
            $definitions[] = array(
                "text" => $this->formatSAQuestion((string) $def->text),
                "id" => (int) $this->getId() . $def->identifier
            );
        }
        $result['definitions'] = $definitions;
 
        // #10353
        $matchings = array();
        foreach ($this->getMatchingPairs() as $pair) {
            // fau: fixLmMatchingPoints - ignore matching pairs with 0 or negative points
            if ($pair->points <= 0) {
                continue;
            }
            // fau.
 
            $pid = $pair->definition->identifier;
            if ($this->getMatchingMode() == self::MATCHING_MODE_N_ON_N) {
                $pid .= '::' . $pair->term->identifier;
            }
 
            if (!isset($matchings[$pid]) || $matchings[$pid]["points"] < $pair->points) {
                $matchings[$pid] = array(
                    "term_id" => (int) $this->getId() . $pair->term->identifier,
                    "def_id" => (int) $this->getId() . $pair->definition->identifier,
                    "points" => (int) $pair->points
                );
            }
        }
 
        $result['matchingPairs'] = array_values($matchings);
 
        $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
        $result['mobs'] = $mobs;
 
        global $DIC;
        $lng = $DIC['lng'];
        $lng->loadLanguageModule('assessment');
        $result['reset_button_label'] = $lng->txt("reset_terms");
 
        return json_encode($result);
    }

References $definitions, $DIC, assQuestion\$lng, $mobs, $result, $terms, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), getDefinitions(), assQuestion\getId(), getMatchingMode(), getMatchingPairs(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffler(), getTerms(), assQuestion\getTitle(), and assQuestion\setShuffler().

Here is the call graph for this function:

Field Documentation

$definitions

assMatchingQuestion::$definitions

protected

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

Referenced by getDefinitions(), and toJSON().

$element_height

assMatchingQuestion::$element_height

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

$matching_type

assMatchingQuestion::$matching_type

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

Referenced by __construct().

$matchingMode

assMatchingQuestion::$matchingMode = self::MATCHING_MODE_1_ON_1

protected

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

Referenced by getMatchingMode(), and setMatchingMode().

$matchingpairs

assMatchingQuestion::$matchingpairs

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

Referenced by getMatchingPairs(), and saveAnswerSpecificDataToDb().

$terms

assMatchingQuestion::$terms

protected

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

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

$thumb_geometry

assMatchingQuestion::$thumb_geometry = 100

Definition at line 70 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 79 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 80 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