Class for image map questions. More...

Inheritance diagram for assImagemapQuestion:

Collaboration diagram for assImagemapQuestion:

Public Member Functions
	__construct ( $title="", $comment="", $author="", $owner=-1, $question="", $image_filename="")
	assImagemapQuestion constructor More...

	setIsMultipleChoice ($is_multiple_choice)
	Set true if the Imagemapquestion is a multiplechoice Question. More...

	getIsMultipleChoice ()
	Returns true, if the imagemap question is a multiplechoice question. More...

	isComplete ()
	Returns true, if a imagemap question is complete for use. More...

	saveToDb ($original_id="")
	Saves an assImagemapQuestion 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...

	duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
	Duplicates an assImagemapQuestion. More...

	copyObject ($target_questionpool_id, $title="")
	Copies an assImagemapQuestion object. More...

	createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")

	duplicateImage ($question_id, $objectId=null)

	copyImage ($question_id, $source_questionpool)

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

	uploadImagemap (array $shapes)
	Uploads an image map and takes over the areas. More...

	getImageFilename ()

	setImageFilename ($image_filename, $image_tempfilename="")
	Sets the image file name. More...

	get_imagemap_contents ($href="#")
	Gets the imagemap file contents. More...

	addAnswer ( $answertext="", $points=0.0, $order=0, $coords="", $area="", $points_unchecked=0.0)
	Adds a possible answer for a imagemap question. More...

	getAnswerCount ()
	Returns the number of answers. More...

	getAnswer ($index=0)
	Returns an answer. More...

&	getAnswers ()
	Returns the answer array. More...

	deleteArea ($index=0)
	Deletes an answer. More...

	flushAnswers ()
	Deletes all answers. More...

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

	calculateReachedPoints ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
	Returns the points, a learner has reached answering the question. More...

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

	isAutosaveable ()

	saveWorkingData ($active_id, $pass=null, $authorized=true)
	Saves the learners input of the question to the database. More...

	syncWithOriginal ()

	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...

	setExportDetailsXLS ($worksheet, $startrow, $active_id, $pass)
	{} More...

	deleteImage ()
	Deletes the image file. More...

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

	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...

	getTestOutputSolutions ($activeId, $pass)

Public Member Functions inherited from assQuestion
	__construct ( $title="", $comment="", $author="", $owner=-1, $question="")
	assQuestion constructor More...

	getShuffler ()

	setShuffler (ilArrayElementShuffler $shuffler)

	setProcessLocker ($processLocker)

	getProcessLocker ()

	fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
	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...

	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...

	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...

	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 ()

	createRandomSolution ($test_id, $user_id)

	_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...

	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 ()

Public Member Functions inherited from iQuestionCondition
	getUserQuestionResult ($active_id, $pass)
	Get the user solution for a question by active_id and the test pass. More...

Data Fields
	$currentSolution = array()

const	MODE_SINGLE_CHOICE = 0

const	MODE_MULTIPLE_CHOICE = 1

	$answers

	$image_filename

	$imagemap_contents

	$coords

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_DEFAULT = 'default'
	constant for additional content editing mode "default" More...

const	ADDITIONAL_CONTENT_EDITING_MODE_PAGE_OBJECT = '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)

	calculateReachedPointsForSolution ($found_values)

	getAddSolutionSelectionParameter ()

	isAddSolutionSelectionRequest ()

	getRemoveSolutionSelectionParameter ()

	isRemoveSolutionSelectionRequest ()

	getReuseSolutionSelectionParameter ()

	isReuseSolutionSelectionRequest ()

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)

	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
	$is_multiple_choice = false

Protected Attributes inherited from assQuestion
	$id

	$title

	$comment

	$owner

	$author

	$question

	$points

	$est_working_time

	$shuffle

	$test_id

	$obj_id

	$ilias

	$tpl

	$lng

	$db

	$outputType = OUTPUT_JAVASCRIPT

	$suggested_solutions

	$original_id

	$page

	$external_id = ''

	$questionChangeListeners = array()

	$processLocker

	$step = null

	$lastChange

	$shuffler

	$testQuestionConfig

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

Class for image map questions.

assImagemapQuestion is a class for imagemap question.

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 24 of file class.assImagemapQuestion.php.

Constructor & Destructor Documentation

◆ __construct()

assImagemapQuestion::__construct	(	$title = `""`,
		$comment = `""`,
		$author = `""`,
		$owner = `-1`,
		$question = `""`,
		$image_filename = `""`
	)

assImagemapQuestion constructor

The constructor takes possible arguments an creates an instance of the assImagemapQuestion 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 imagemap question.
string	$image_filename

Returns

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

References assQuestion\$author, assQuestion\$comment, $image_filename, assQuestion\$owner, assQuestion\$question, and assQuestion\$title.

       {
         parent::__construct($title, $comment, $author, $owner, $question);
         $this->image_filename = $image_filename;
         $this->answers = array();
         $this->coords = array();
     }

Member Function Documentation

◆ addAnswer()

assImagemapQuestion::addAnswer	(	$answertext = `""`,
		$points = `0.0`,
		$order = `0`,
		$coords = `""`,
		$area = `""`,
		$points_unchecked = `0.0`
	)

Adds a possible answer for a imagemap question.

Adds a possible answer for a imagemap question. A ASS_AnswerImagemap object will be created and assigned to the array $this->answers.

Parameters

string	$answertext	The answer text
double	$points	The points for selecting the answer (even negative points can be used)
integer	$status	The state of the answer (set = 1 or unset = 0)
integer	$order	A possible display order of the answer public

See also: $answers; ASS_AnswerImagemap

Definition at line 492 of file class.assImagemapQuestion.php.

References $coords, $i, and assQuestion\$points.

Referenced by uploadImagemap().

       {
         include_once "./Modules/TestQuestionPool/classes/class.assAnswerImagemap.php";
         if (array_key_exists($order, $this->answers)) {
             // Insert answer
             $answer = new ASS_AnswerImagemap($answertext, $points, $order, $coords, $area, -1, $points_unchecked);
             for ($i = count($this->answers) - 1; $i >= $order; $i--) {
                 $this->answers[$i + 1] = $this->answers[$i];
                 $this->answers[$i + 1]->setOrder($i + 1);
             }
             $this->answers[$order] = $answer;
         } else {
             // Append answer
             $answer = new ASS_AnswerImagemap($answertext, $points, count($this->answers), $coords, $area, -1, $points_unchecked);
             array_push($this->answers, $answer);
         }
     }

Here is the caller graph for this function:

◆ calculateReachedPoints()

assImagemapQuestion::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.

public

Parameters

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

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

Definition at line 649 of file class.assImagemapQuestion.php.

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

Referenced by getExpressionTypes().

     {
         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) {
                 array_push($found_values, $data["value1"]);
             }
         }
         
         $points = $this->calculateReachedPointsForSolution($found_values);
 
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPointsForSolution()

assImagemapQuestion::calculateReachedPointsForSolution ( $found_values )

protected

Parameters

$found_values

Returns: int

Definition at line 939 of file class.assImagemapQuestion.php.

References $key, assQuestion\$points, and getIsMultipleChoice().

Referenced by calculateReachedPoints(), and calculateReachedPointsFromPreviewSession().

     {
         $points = 0;
         if (count($found_values) > 0) {
             foreach ($this->answers as $key => $answer) {
                 if (in_array($key, $found_values)) {
                     $points += $answer->getPoints();
                 } elseif ($this->getIsMultipleChoice()) {
                     $points += $answer->getPointsUnchecked();
                 }
             }
             return $points;
         }
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPointsFromPreviewSession()

assImagemapQuestion::calculateReachedPointsFromPreviewSession ( ilAssQuestionPreviewSession $previewSession )

Definition at line 674 of file class.assImagemapQuestion.php.

References calculateReachedPointsForSolution(), assQuestion\deductHintPointsFromReachedPoints(), assQuestion\ensureNonNegativePoints(), and ilAssQuestionPreviewSession\getParticipantsSolution().

     {
         $solutionData = $previewSession->getParticipantsSolution();
 
         $reachedPoints = $this->calculateReachedPointsForSolution(is_array($solutionData) ? array_values($solutionData) : array());
         $reachedPoints = $this->deductHintPointsFromReachedPoints($previewSession, $reachedPoints);
         
         return $this->ensureNonNegativePoints($reachedPoints);
     }

Here is the call graph for this function:

◆ copyImage()

assImagemapQuestion::copyImage	(	$question_id,
		$source_questionpool
	)

Definition at line 334 of file class.assImagemapQuestion.php.

References $filename, getImageFilename(), assQuestion\getImagePath(), and ilUtil\makeDirParents().

     {
         $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);
         if (!file_exists($imagepath)) {
             ilUtil::makeDirParents($imagepath);
         }
         $filename = $this->getImageFilename();
         if (!copy($imagepath_original . $filename, $imagepath . $filename)) {
             print "image could not be copied!!!! ";
         }
     }

Here is the call graph for this function:

◆ copyObject()

assImagemapQuestion::copyObject	(	$target_questionpool_id,
		$title = `""`
	)

Copies an assImagemapQuestion object.

Copies an assImagemapQuestion object

public

Definition at line 240 of file class.assImagemapQuestion.php.

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

     {
         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->copyImage($original_id, $source_questionpool_id);
         
         $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
         
         return $clone->id;
     }

Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

assImagemapQuestion::createNewOriginalFromThisDuplicate	(	$targetParentId,
		$targetQuestionTitle = `""`
	)

Definition at line 270 of file class.assImagemapQuestion.php.

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

     {
         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->copyImage($sourceQuestionId, $sourceParentId);
 
         $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ deleteArea()

assImagemapQuestion::deleteArea ( $index = 0 )

Deletes an answer.

Deletes an area with a given index. The index of the first area is 0, the index of the second area is 1 and so on.

Parameters

integer $index A nonnegative index of the n-th answer public

See also: $answers

Definition at line 579 of file class.assImagemapQuestion.php.

References $i, and $index.

     {
         if ($index < 0) {
             return;
         }
         if (count($this->answers) < 1) {
             return;
         }
         if ($index >= count($this->answers)) {
             return;
         }
         unset($this->answers[$index]);
         $this->answers = array_values($this->answers);
         for ($i = 0; $i < count($this->answers); $i++) {
             if ($this->answers[$i]->getOrder() > $index) {
                 $this->answers[$i]->setOrder($i);
             }
         }
     }

◆ deleteImage()

assImagemapQuestion::deleteImage ( )

Deletes the image file.

Definition at line 882 of file class.assImagemapQuestion.php.

References flushAnswers(), getImageFilename(), and assQuestion\getImagePath().

     {
         $file = $this->getImagePath() . $this->getImageFilename();
         @unlink($file);
         $this->flushAnswers();
         $this->image_filename = "";
     }

Here is the call graph for this function:

◆ duplicate()

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

Duplicates an assImagemapQuestion.

public

Definition at line 187 of file class.assImagemapQuestion.php.

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

     {
         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->duplicateImage($this_id, $thisObjId);
         
         $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
         
         return $clone->id;
     }

Here is the call graph for this function:

◆ duplicateImage()

assImagemapQuestion::duplicateImage	(	$question_id,
		$objectId = `null`
	)

Definition at line 305 of file class.assImagemapQuestion.php.

References $DIC, $filename, $ilLog, getImageFilename(), assQuestion\getImagePath(), and ilUtil\makeDirParents().

     {
         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);
         }
 
         if (!file_exists($imagepath)) {
             ilUtil::makeDirParents($imagepath);
         }
         $filename = $this->getImageFilename();
 
         // #18755
         if (!file_exists($imagepath_original . $filename)) {
             $ilLog->write("Could not find an image map file when trying to duplicate image: " . $imagepath_original . $filename);
             $imagepath_original = str_replace("/$this->obj_id/", "/$objectId/", $imagepath_original);
             $ilLog->write("Using fallback source directory:" . $imagepath_original);
         }
 
         if (!file_exists($imagepath_original . $filename) || !copy($imagepath_original . $filename, $imagepath . $filename)) {
             $ilLog->write("Could not duplicate image for image map question: " . $imagepath_original . $filename);
         }
     }

Here is the call graph for this function:

◆ flushAnswers()

assImagemapQuestion::flushAnswers ( )

Deletes all answers.

Deletes all answers

public

See also: $answers

Definition at line 607 of file class.assImagemapQuestion.php.

Referenced by deleteImage().

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

Here is the caller graph for this function:

◆ get_imagemap_contents()

assImagemapQuestion::get_imagemap_contents ( $href = "#" )

Gets the imagemap file contents.

Gets the imagemap file contents

Returns: string The imagemap file contents of the assImagemapQuestion object public

See also: $imagemap_contents

Definition at line 465 of file class.assImagemapQuestion.php.

References $i, and $imagemap_contents.

     {
         $imagemap_contents = "<map name=\"" . $this->title . "\"> ";
         for ($i = 0; $i < count($this->answers); $i++) {
             $imagemap_contents .= "<area alt=\"" . $this->answers[$i]->getAnswertext() . "\" ";
             $imagemap_contents .= "shape=\"" . $this->answers[$i]->getArea() . "\" ";
             $imagemap_contents .= "coords=\"" . $this->answers[$i]->getCoords() . "\" ";
             $imagemap_contents .= "href=\"$href&selimage=" . $this->answers[$i]->getOrder() . "\" /> ";
         }
         $imagemap_contents .= "</map>";
         return $imagemap_contents;
     }

◆ getAdditionalTableName()

assImagemapQuestion::getAdditionalTableName ( )

Returns the name of the additional question data table in the database.

Returns the name of the additional question data table in the database

Returns: string The additional table name public

Definition at line 818 of file class.assImagemapQuestion.php.

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

     {
         return "qpl_qst_imagemap";
     }

Here is the caller graph for this function:

◆ getAddSolutionSelectionParameter()

assImagemapQuestion::getAddSolutionSelectionParameter ( )

protected

Definition at line 1055 of file class.assImagemapQuestion.php.

References $_GET, and isAddSolutionSelectionRequest().

Referenced by saveWorkingData().

     {
         if (!$this->isAddSolutionSelectionRequest()) {
             return null;
         }
         
         return $_GET["selImage"];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAnswer()

assImagemapQuestion::getAnswer ( $index = 0 )

Returns an answer.

Returns an answer with a given index. The index of the first answer is 0, the index of the second answer is 1 and so on.

Parameters

integer $index A nonnegative index of the n-th answer

Returns: object ASS_AnswerImagemap-Object containing the answer public

See also: $answers

Definition at line 541 of file class.assImagemapQuestion.php.

References $index.

Referenced by getAvailableAnswerOptions().

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

Here is the caller graph for this function:

◆ getAnswerCount()

assImagemapQuestion::getAnswerCount ( )

Returns the number of answers.

Returns the number of answers

Returns: integer The number of answers of the multiple choice question public

See also: $answers

Definition at line 525 of file class.assImagemapQuestion.php.

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

◆ getAnswers()

& assImagemapQuestion::getAnswers ( )

Returns the answer array.

Returns the answer array

Returns: array The answer array public

See also: $answers

Definition at line 564 of file class.assImagemapQuestion.php.

References $answers.

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

     {
         return $this->answers;
     }

Here is the caller graph for this function:

◆ getAnswerTableName()

assImagemapQuestion::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns the name of the answer table in the database

Returns: string The answer table name public

Definition at line 831 of file class.assImagemapQuestion.php.

     {
         return "qpl_a_imagemap";
     }

◆ getAvailableAnswerOptions()

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

References $index, getAnswer(), and getAnswers().

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

Here is the call graph for this function:

◆ getExpressionTypes()

assImagemapQuestion::getExpressionTypes ( )

Get all available expression types for a specific question.

Returns: array

Implements iQuestionCondition.

Definition at line 973 of file class.assImagemapQuestion.php.

References $data, $DIC, $ilDB, $pass, assQuestion\$points, $result, $row, calculateReachedPoints(), iQuestionCondition\EmptyAnswerExpression, iQuestionCondition\ExclusiveResultExpression, assQuestion\getId(), getMaximumPoints(), iQuestionCondition\getUserQuestionResult(), iQuestionCondition\NumberOfResultExpression, and iQuestionCondition\PercentageResultExpression.

     {
         return array(
             iQuestionCondition::PercentageResultExpression,
             iQuestionCondition::NumberOfResultExpression,
             iQuestionCondition::EmptyAnswerExpression,
             iQuestionCondition::ExclusiveResultExpression
         );
     }

Here is the call graph for this function:

◆ getImageFilename()

assImagemapQuestion::getImageFilename ( )

Definition at line 424 of file class.assImagemapQuestion.php.

References $image_filename.

Referenced by copyImage(), deleteImage(), duplicateImage(), and toJSON().

     {
         return $this->image_filename;
     }

Here is the caller graph for this function:

◆ getIsMultipleChoice()

assImagemapQuestion::getIsMultipleChoice ( )

Returns true, if the imagemap question is a multiplechoice question.

Returns: bool

Definition at line 91 of file class.assImagemapQuestion.php.

References $is_multiple_choice.

Referenced by calculateReachedPointsForSolution(), and toJSON().

     {
         return $this->is_multiple_choice;
     }

Here is the caller graph for this function:

◆ getMaximumPoints()

assImagemapQuestion::getMaximumPoints ( )

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

Returns the maximum points, a learner can reach answering the question

public

See also: $points

Definition at line 620 of file class.assImagemapQuestion.php.

References $key, and assQuestion\$points.

Referenced by getExpressionTypes(), and isComplete().

     {
         $points = 0;
         foreach ($this->answers as $key => $value) {
             if ($this->is_multiple_choice) {
                 if ($value->getPoints() > $value->getPointsUnchecked()) {
                     $points += $value->getPoints();
                 } else {
                     $points += $value->getPointsUnchecked();
                 }
             } else {
                 if ($value->getPoints() > $points) {
                     $points = $value->getPoints();
                 }
             }
         }
         return $points;
     }

Here is the caller graph for this function:

◆ getOperators()

assImagemapQuestion::getOperators ( $expression )

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

Definition at line 963 of file class.assImagemapQuestion.php.

References ilOperatorsExpressionMapping\getOperatorsByExpression().

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

Here is the call graph for this function:

◆ getQuestionType()

assImagemapQuestion::getQuestionType ( )

Returns the question type of the question.

Returns the question type of the question

Returns: integer The question type of the question public

Definition at line 805 of file class.assImagemapQuestion.php.

Referenced by toJSON().

     {
         return "assImagemapQuestion";
     }

Here is the caller graph for this function:

◆ getRemoveSolutionSelectionParameter()

assImagemapQuestion::getRemoveSolutionSelectionParameter ( )

protected

Definition at line 1075 of file class.assImagemapQuestion.php.

References $_GET, and isRemoveSolutionSelectionRequest().

Referenced by saveWorkingData().

     {
         if (!$this->isRemoveSolutionSelectionRequest()) {
             return null;
         }
         
         return $_GET["remImage"];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReuseSolutionSelectionParameter()

assImagemapQuestion::getReuseSolutionSelectionParameter ( )

protected

Definition at line 1099 of file class.assImagemapQuestion.php.

References $_GET, assQuestion\explodeKeyValues(), and isReuseSolutionSelectionRequest().

Referenced by saveWorkingData().

     {
         if (!$this->isReuseSolutionSelectionRequest()) {
             return null;
         }
         
         return assQuestion::explodeKeyValues($_GET["reuseSelection"]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assImagemapQuestion::getRTETextWithMediaObjects ( )

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

Definition at line 840 of file class.assImagemapQuestion.php.

References $index, $text, and assQuestion\getId().

     {
         $text = parent::getRTETextWithMediaObjects();
         foreach ($this->answers as $index => $answer) {
             $text .= $this->feedbackOBJ->getSpecificAnswerFeedbackContent($this->getId(), 0, $index);
         }
         return $text;
     }

Here is the call graph for this function:

◆ getTestOutputSolutions()

assImagemapQuestion::getTestOutputSolutions	(	$activeId,
		$pass
	)

Definition at line 1044 of file class.assImagemapQuestion.php.

References $pass.

     {
         $solution = parent::getTestOutputSolutions($activeId, $pass);
         
         $this->currentSolution = array();
         foreach ($solution as $record) {
             $this->currentSolution[] = $record['value1'];
         }
         
         return $solution;
     }

◆ isAddSolutionSelectionRequest()

assImagemapQuestion::isAddSolutionSelectionRequest ( )

protected

Definition at line 1063 of file class.assImagemapQuestion.php.

References $_GET.

Referenced by getAddSolutionSelectionParameter(), and saveWorkingData().

     {
         if (!isset($_GET["selImage"])) {
             return false;
         }
         
         if (!strlen($_GET["selImage"])) {
             return false;
         }
         
         return true;
     }

Here is the caller graph for this function:

◆ isAutosaveable()

assImagemapQuestion::isAutosaveable ( )

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

     {
         return false; // #15217
     }

◆ isComplete()

assImagemapQuestion::isComplete ( )

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

Returns: boolean True, if the imagemap question is complete for use, otherwise false public

Definition at line 102 of file class.assImagemapQuestion.php.

References getMaximumPoints().

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

Here is the call graph for this function:

◆ isRemoveSolutionSelectionRequest()

assImagemapQuestion::isRemoveSolutionSelectionRequest ( )

protected

Definition at line 1083 of file class.assImagemapQuestion.php.

References $_GET.

Referenced by getRemoveSolutionSelectionParameter(), and saveWorkingData().

     {
         if (!$this->is_multiple_choice) {
             return false;
         }
         
         if (!isset($_GET["remImage"])) {
             return false;
         }
         
         if (!strlen($_GET["remImage"])) {
             return false;
         }
         
         return true;
     }

Here is the caller graph for this function:

◆ isReuseSolutionSelectionRequest()

assImagemapQuestion::isReuseSolutionSelectionRequest ( )

protected

Definition at line 1107 of file class.assImagemapQuestion.php.

References $_GET, and assQuestion\getTestPresentationConfig().

Referenced by getReuseSolutionSelectionParameter(), and saveWorkingData().

     {
         if (!$this->getTestPresentationConfig()->isPreviousPassSolutionReuseAllowed()) {
             return false;
         }
         
         if (!isset($_GET["reuseSelection"])) {
             return false;
         }
         
         if (!strlen($_GET["reuseSelection"])) {
             return false;
         }
         
         if (!preg_match('/\d(,\d)*/', $_GET["reuseSelection"])) {
             return false;
         }
         
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadFromDb()

assImagemapQuestion::loadFromDb ( $question_id )

Loads a assImagemapQuestion object from a database.

Loads a assImagemapQuestion object from a database (experimental)

Parameters

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

Definition at line 357 of file class.assImagemapQuestion.php.

References $data, $DIC, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), setImageFilename(), setIsMultipleChoice(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), and assQuestion\setTitle().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $result = $ilDB->queryF(
             "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",
             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"]);
             $this->setIsMultipleChoice($data["is_multiple_choice"] == self::MODE_MULTIPLE_CHOICE);
             include_once("./Services/RTE/classes/class.ilRTE.php");
             $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
             $this->setImageFilename($data["image_file"]);
             $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
             
             try {
                 $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
             } catch (ilTestQuestionPoolException $e) {
             }
 
             $result = $ilDB->queryF(
                 "SELECT * FROM qpl_a_imagemap WHERE question_fi = %s ORDER BY aorder ASC",
                 array("integer"),
                 array($question_id)
             );
             include_once "./Modules/TestQuestionPool/classes/class.assAnswerImagemap.php";
             if ($result->numRows() > 0) {
                 while ($data = $ilDB->fetchAssoc($result)) {
                     array_push($this->answers, new ASS_AnswerImagemap($data["answertext"], $data["points"], $data["aorder"], $data["coords"], $data["area"], $data['question_fi'], $data['points_unchecked']));
                 }
             }
         }
         parent::loadFromDb($question_id);
     }

Here is the call graph for this function:

◆ saveAdditionalQuestionDataToDb()

assImagemapQuestion::saveAdditionalQuestionDataToDb ( )

Saves a record to the question types additional data table.

Returns: mixed

Implements ilObjQuestionScoringAdjustable.

Definition at line 159 of file class.assImagemapQuestion.php.

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

Referenced by saveToDb().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         
         $ilDB->manipulateF(
             "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
             array( "integer" ),
             array( $this->getId() )
         );
         
         $ilDB->manipulateF(
             "INSERT INTO " . $this->getAdditionalTableName(
                                                                         ) . " (question_fi, image_file, is_multiple_choice) VALUES (%s, %s, %s)",
             array( "integer", "text", 'integer' ),
             array(
                                 $this->getId(),
                                 $this->image_filename,
                                 (int) $this->is_multiple_choice
                             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAnswerSpecificDataToDb()

assImagemapQuestion::saveAnswerSpecificDataToDb ( )

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

Returns: mixed

Implements ilObjAnswerScoringAdjustable.

Definition at line 133 of file class.assImagemapQuestion.php.

References $DIC, $ilDB, $key, and assQuestion\getId().

Referenced by saveToDb().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $ilDB->manipulateF(
             "DELETE FROM qpl_a_imagemap WHERE question_fi = %s",
             array( "integer" ),
             array( $this->getId() )
         );
 
         // Anworten wegschreiben
         foreach ($this->answers as $key => $value) {
             $answer_obj = $this->answers[$key];
             $answer_obj->setOrder($key);
             $next_id = $ilDB->nextId('qpl_a_imagemap');
             $ilDB->manipulateF(
                 "INSERT INTO qpl_a_imagemap (answer_id, question_fi, answertext, points, aorder, coords, area, points_unchecked) VALUES (%s, %s, %s, %s, %s, %s, %s, %s)",
                 array( "integer", "integer", "text", "float", "integer", "text", "text", "float" ),
                 array( $next_id, $this->id, $answer_obj->getAnswertext(
                                     ), $answer_obj->getPoints(), $answer_obj->getOrder(
                                     ), $answer_obj->getCoords(), $answer_obj->getArea(
                                     ), $answer_obj->getPointsUnchecked() )
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePreviewData()

assImagemapQuestion::savePreviewData ( ilAssQuestionPreviewSession $previewSession )

protected

Definition at line 771 of file class.assImagemapQuestion.php.

References $_GET, ilAssQuestionPreviewSession\getParticipantsSolution(), and ilAssQuestionPreviewSession\setParticipantsSolution().

     {
         $solution = $previewSession->getParticipantsSolution();
 
         if ($this->is_multiple_choice && strlen($_GET['remImage'])) {
             unset($solution[(int) $_GET['remImage']]);
         }
         
         if (strlen($_GET['selImage'])) {
             if (!$this->is_multiple_choice) {
                 $solution = array();
             }
             
             $solution[(int) $_GET['selImage']] = (int) $_GET['selImage'];
         }
 
         $previewSession->setParticipantsSolution($solution);
     }

Here is the call graph for this function:

◆ saveToDb()

assImagemapQuestion::saveToDb ( $original_id = "" )

Saves an assImagemapQuestion object to a database.

Saves an assImagemapQuestion object to a database

Parameters

string $original_id

Returns: mixed|void

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

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

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

Here is the call graph for this function:

◆ saveWorkingData()

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

Saves the learners input of the question to the database.

public

Parameters

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

Returns: boolean $status

Definition at line 697 of file class.assImagemapQuestion.php.

References $_GET, $DIC, $ilDB, $pass, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), assQuestion\deleteDummySolutionRecord(), assQuestion\deleteSolutionRecordByValues(), assQuestion\forceExistingIntermediateSolution(), getAddSolutionSelectionParameter(), assQuestion\getId(), assQuestion\getProcessLocker(), getRemoveSolutionSelectionParameter(), getReuseSolutionSelectionParameter(), isAddSolutionSelectionRequest(), isRemoveSolutionSelectionRequest(), isReuseSolutionSelectionRequest(), assQuestion\logAction(), assQuestion\removeCurrentSolution(), assQuestion\saveCurrentSolution(), and assQuestion\updateCurrentSolutionsAuthorization().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         if (is_null($pass)) {
             include_once "./Modules/Test/classes/class.ilObjTest.php";
             $pass = ilObjTest::_getPass($active_id);
         }
 
         $solutionSelectionChanged = false;
 
         $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(function () use (&$solutionSelectionChanged, $ilDB, $active_id, $pass, $authorized) {
             if ($authorized) {
                 // remove the dummy record of the intermediate solution
                 $this->deleteDummySolutionRecord($active_id, $pass);
                 
                 // delete the authorized solution and make the intermediate solution authorized (keeping timestamps)
                 $this->removeCurrentSolution($active_id, $pass, true);
                 $this->updateCurrentSolutionsAuthorization($active_id, $pass, true, true);
                 
                 $solutionSelectionChanged = true;
             } else {
                 $this->forceExistingIntermediateSolution(
                     $active_id,
                     $pass,
                     $this->is_multiple_choice
                 );
                 
                 if ($this->isReuseSolutionSelectionRequest()) {
                     $selection = $this->getReuseSolutionSelectionParameter();
                     
                     foreach ($selection as $selectedIndex) {
                         $this->saveCurrentSolution($active_id, $pass, (int) $selectedIndex, null, $authorized);
                         $solutionSelectionChanged = true;
                     }
                 } elseif ($this->isRemoveSolutionSelectionRequest()) {
                     $selection = $this->getRemoveSolutionSelectionParameter();
                     
                     $this->deleteSolutionRecordByValues($active_id, $pass, $authorized, array(
                         'value1' => (int) $selection
                     ));
                     
                     $solutionSelectionChanged = true;
                 } elseif ($this->isAddSolutionSelectionRequest()) {
                     $selection = $this->getAddSolutionSelectionParameter();
 
                     if ($this->is_multiple_choice) {
                         $this->deleteSolutionRecordByValues($active_id, $pass, $authorized, array(
                             'value1' => (int) $_GET['selImage']
                         ));
                     } else {
                         $this->removeCurrentSolution($active_id, $pass, $authorized);
                     }
 
                     $this->saveCurrentSolution($active_id, $pass, $_GET['selImage'], null, $authorized);
                     
                     $solutionSelectionChanged = true;
                 }
             }
         });
 
         require_once 'Modules/Test/classes/class.ilObjAssessmentFolder.php';
         if (ilObjAssessmentFolder::_enabledAssessmentLogging()) {
             if ($solutionSelectionChanged) {
                 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 true;
     }

Here is the call graph for this function:

◆ setExportDetailsXLS()

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

{}

Definition at line 852 of file class.assImagemapQuestion.php.

References $i, assQuestion\$id, $pass, getAnswers(), and assQuestion\getSolutionValues().

     {
         parent::setExportDetailsXLS($worksheet, $startrow, $active_id, $pass);
 
         $solution = $this->getSolutionValues($active_id, $pass);
 
         $i = 1;
         foreach ($this->getAnswers() as $id => $answer) {
             $worksheet->setCell($startrow + $i, 0, $answer->getArea() . ": " . $answer->getCoords());
             $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
             
             $cellValue = 0;
             foreach ($solution as $solIndex => $sol) {
                 if ($sol['value1'] == $id) {
                     $cellValue = 1;
                     break;
                 }
             }
             
             $worksheet->setCell($startrow + $i, 1, $cellValue);
 
             $i++;
         }
 
         return $startrow + $i + 1;
     }

Here is the call graph for this function:

◆ setImageFilename()

assImagemapQuestion::setImageFilename	(	$image_filename,
		$image_tempfilename = `""`
	)

Sets the image file name.

Parameters

string $image_file name. public

See also: $image_filename

Definition at line 436 of file class.assImagemapQuestion.php.

References $DIC, $ilLog, $image_filename, assQuestion\getImagePath(), and ilUtil\makeDirParents().

Referenced by loadFromDb().

     {
         if (!empty($image_filename)) {
             $image_filename = str_replace(" ", "_", $image_filename);
             $this->image_filename = $image_filename;
         }
         if (!empty($image_tempfilename)) {
             $imagepath = $this->getImagePath();
             if (!file_exists($imagepath)) {
                 ilUtil::makeDirParents($imagepath);
             }
             if (!ilUtil::moveUploadedFile($image_tempfilename, $image_filename, $imagepath . $image_filename)) {
                 $this->ilias->raiseError("The image could not be uploaded!", $this->ilias->error_obj->MESSAGE);
             }
             global $DIC;
             $ilLog = $DIC['ilLog'];
             $ilLog->write("gespeichert: " . $imagepath . $image_filename);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIsMultipleChoice()

assImagemapQuestion::setIsMultipleChoice ( $is_multiple_choice )

Set true if the Imagemapquestion is a multiplechoice Question.

Parameters

bool $is_multiple_choice

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

References $is_multiple_choice.

Referenced by loadFromDb().

     {
         $this->is_multiple_choice = $is_multiple_choice;
     }

Here is the caller graph for this function:

◆ syncWithOriginal()

assImagemapQuestion::syncWithOriginal ( )

Definition at line 790 of file class.assImagemapQuestion.php.

References assQuestion\getOriginalId().

     {
         if ($this->getOriginalId()) {
             parent::syncWithOriginal();
         }
     }

Here is the call graph for this function:

◆ toJSON()

assImagemapQuestion::toJSON ( )

Returns a JSON representation of the question.

Definition at line 893 of file class.assImagemapQuestion.php.

References $answers, $key, $mobs, $result, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), getAnswers(), assQuestion\getId(), getImageFilename(), assQuestion\getImagePathWeb(), getIsMultipleChoice(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), and assQuestion\getTitle().

     {
         include_once("./Services/RTE/classes/class.ilRTE.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['shuffle'] = (bool) $this->getShuffle();
         $result['is_multiple'] = (bool) $this->getIsMultipleChoice();
         $result['feedback'] = array(
             'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
             'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
         );
         $result['image'] = (string) $this->getImagePathWeb() . $this->getImageFilename();
         
         $answers = array();
         $order = 0;
         foreach ($this->getAnswers() as $key => $answer_obj) {
             array_push($answers, array(
                 "answertext" => (string) $answer_obj->getAnswertext(),
                 "points" => (float) $answer_obj->getPoints(),
                 "points_unchecked" => (float) $answer_obj->getPointsUnchecked(),
                 "order" => (int) $order,
                 "coords" => $answer_obj->getCoords(),
                 "state" => $answer_obj->getState(),
                 "area" => $answer_obj->getArea(),
                 "feedback" => $this->formatSAQuestion(
                     $this->feedbackOBJ->getSpecificAnswerFeedbackExportPresentation($this->getId(), 0, $key)
                 )
             ));
             $order++;
         }
         $result['answers'] = $answers;
 
         $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
         $result['mobs'] = $mobs;
         
         return json_encode($result);
     }

Here is the call graph for this function:

◆ uploadImagemap()

assImagemapQuestion::uploadImagemap ( array $shapes )

Uploads an image map and takes over the areas.

Parameters

ASS_AnswerImagemap[] $shapes

Returns: integer number of areas added

Definition at line 410 of file class.assImagemapQuestion.php.

References addAnswer().

     {
         $added = 0;
 
         if (count($shapes) > 0) {
             foreach ($shapes as $shape) {
                 $this->addAnswer($shape->getAnswertext(), 0.0, count($this->answers), $shape->getCoords(), $shape->getArea());
                 $added++;
             }
         }
 
         return $added;
     }

Here is the call graph for this function:

Field Documentation

◆ $answers

assImagemapQuestion::$answers

Definition at line 34 of file class.assImagemapQuestion.php.

Referenced by getAnswers(), and toJSON().

◆ $coords

assImagemapQuestion::$coords

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

Referenced by addAnswer().

◆ $currentSolution

assImagemapQuestion::$currentSolution = array()

Definition at line 27 of file class.assImagemapQuestion.php.

◆ $image_filename

assImagemapQuestion::$image_filename

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

Referenced by __construct(), getImageFilename(), and setImageFilename().

◆ $imagemap_contents

assImagemapQuestion::$imagemap_contents

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

Referenced by get_imagemap_contents().

◆ $is_multiple_choice

assImagemapQuestion::$is_multiple_choice = false

protected

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

Referenced by getIsMultipleChoice(), and setIsMultipleChoice().

◆ MODE_MULTIPLE_CHOICE

const assImagemapQuestion::MODE_MULTIPLE_CHOICE = 1

Definition at line 31 of file class.assImagemapQuestion.php.

Referenced by assImagemapQuestionGUI\populateQuestionSpecificFormPart(), and assImagemapQuestionGUI\writeQuestionSpecificPostData().

◆ MODE_SINGLE_CHOICE

const assImagemapQuestion::MODE_SINGLE_CHOICE = 0

Definition at line 30 of file class.assImagemapQuestion.php.

Referenced by assImagemapQuestionGUI\populateQuestionSpecificFormPart().

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

Modules/TestQuestionPool/classes/class.assImagemapQuestion.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAnswer()

◆ calculateReachedPoints()

◆ calculateReachedPointsForSolution()

◆ calculateReachedPointsFromPreviewSession()

◆ copyImage()

◆ copyObject()

◆ createNewOriginalFromThisDuplicate()

◆ deleteArea()

◆ deleteImage()

◆ duplicate()

◆ duplicateImage()

◆ flushAnswers()

◆ get_imagemap_contents()

◆ getAdditionalTableName()

◆ getAddSolutionSelectionParameter()

◆ getAnswer()

◆ getAnswerCount()

◆ getAnswers()

◆ getAnswerTableName()

◆ getAvailableAnswerOptions()

◆ getExpressionTypes()

◆ getImageFilename()

◆ getIsMultipleChoice()

◆ getMaximumPoints()

◆ getOperators()

◆ getQuestionType()

◆ getRemoveSolutionSelectionParameter()

◆ getReuseSolutionSelectionParameter()

◆ getRTETextWithMediaObjects()

◆ getTestOutputSolutions()

◆ isAddSolutionSelectionRequest()

◆ isAutosaveable()

◆ isComplete()

◆ isRemoveSolutionSelectionRequest()

◆ isReuseSolutionSelectionRequest()

◆ loadFromDb()

◆ saveAdditionalQuestionDataToDb()

◆ saveAnswerSpecificDataToDb()

◆ savePreviewData()

◆ saveToDb()

◆ saveWorkingData()

◆ setExportDetailsXLS()

◆ setImageFilename()

◆ setIsMultipleChoice()

◆ syncWithOriginal()

◆ toJSON()

◆ uploadImagemap()

Field Documentation

◆ $answers

◆ $coords

◆ $currentSolution

◆ $image_filename

◆ $imagemap_contents

◆ $is_multiple_choice

◆ MODE_MULTIPLE_CHOICE

◆ MODE_SINGLE_CHOICE