assImagemapQuestion 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 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 (bool $for_test=true, string $title="", string $author="", string $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 (ilAssExcelFormatHelper $worksheet, int $startrow, int $active_id, int $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 (string $title="", string $comment="", string $author="", int $owner=-1, string $question="")
	assQuestion constructor More...
	getShuffler ()
	setShuffler (Transformation $shuffler)
	setProcessLocker (ilAssQuestionProcessLocker $processLocker)
	getProcessLocker ()
	fromXML ($item, int $questionpool_id, ?int $tst_id, &$tst_object, int &$question_counter, array $import_mapping, array &$solutionhints=[])
	Receives parameters from a QTI parser and creates a valid ILIAS question object. More...
	toXML (bool $a_include_header=true, bool $a_include_binary=true, bool $a_shuffle=false, bool $test_output=false, bool $force_image_references=false)
	Returns a QTI xml representation of the question. More...
	isComplete ()
	Returns true, if a question is complete for use. More...
	questionTitleExists (int $questionpool_id, string $title)
	Returns TRUE if the question title exists in a question pool in the database. More...
	setTitle (string $title="")
	setId (int $id=-1)
	setTestId (int $id=-1)
	setComment (string $comment="")
	setOutputType (int $outputType=OUTPUT_HTML)
	setShuffle (?bool $shuffle=true)
	setAuthor (string $author="")
	setOwner (int $owner=-1)
	getTitle ()
	getTitleForHTMLOutput ()
	getTitleFilenameCompliant ()
	getId ()
	getShuffle ()
	getTestId ()
	getComment ()
	getDescriptionForHTMLOutput ()
	getThumbSize ()
	setThumbSize (int $a_size)
	getMinimumThumbSize ()
	getMaximumThumbSize ()
	getOutputType ()
	supportsJavascriptOutput ()
	supportsNonJsOutput ()
	requiresJsSwitch ()
	getAuthor ()
	getAuthorForHTMLOutput ()
	getOwner ()
	getObjId ()
	setObjId (int $obj_id=0)
	getLifecycle ()
	setLifecycle (ilAssQuestionLifecycle $lifecycle)
	setExternalId (?string $external_id)
	getExternalId ()
	getSuggestedSolutionOutput ()
	_getSuggestedSolution (int $question_id, int $subquestion_index=0)
	loadSuggestedSolution (int $question_id, int $subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...
	getSuggestedSolutions ()
	getReachedPoints (int $active_id, int $pass)
	getMaximumPoints ()
	getAdjustedReachedPoints (int $active_id, int $pass, bool $authorizedSolution=true)
	returns the reached points ... More...
	calculateResultsFromSolution (int $active_id, int $pass, bool $obligationsEnabled=false)
	Calculates the question results from a previously saved question solution. More...
	persistWorkingState (int $active_id, $pass, bool $obligationsEnabled=false, bool $authorized=true)
	persists the working state for current testactive and testpass More...
	persistPreviewState (ilAssQuestionPreviewSession $previewSession)
	persists the preview state for current user and question More...
	validateSolutionSubmit ()
	saveWorkingData (int $active_id, int $pass, bool $authorized=true)
	Saves the learners input of the question to the database. More...
	moveUploadedMediaFile (string $file, string $name)
	Move an uploaded media file to an public accessible temp dir to present it. More...
	getSuggestedSolutionPath ()
	getImagePath ($question_id=null, $object_id=null)
	Returns the image path for web accessable images of a question. More...
	buildImagePath ($questionId, $parentObjectId)
	getFlashPath ()
	Returns the image path for web accessable flash files of a question. More...
	getSuggestedSolutionPathWeb ()
	getImagePathWeb ()
	Returns the web image path for web accessable images of a question. More...
	getTestOutputSolutions (int $activeId, int $pass)
	getUserSolutionPreferingIntermediate (int $active_id, $pass=null)
	getSolutionValues ($active_id, $pass=null, bool $authorized=true)
	Loads solutions of a given user from the database an returns it. More...
	isInUse (int $question_id=0)
	Checks whether the question is in use or not in pools or tests. More...
	usageNumber (int $question_id=0)
	Returns the number of place the question is in use in pools or tests. More...
	isClone (int $question_id=0)
	Checks whether the question is a clone of another question or not. More...
	getAdditionalTableName ()
	getAnswerTableName ()
	deleteAnswers (int $question_id)
	deleteAdditionalTableData (int $question_id)
	delete (int $question_id)
	getTotalAnswers ()
	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)
	syncXHTMLMediaObjectsOfQuestion ()
	createPageObject ()
	copyPageOfQuestion (int $a_q_id)
	getPageOfQuestion ()
	setOriginalId (?int $original_id)
	getOriginalId ()
	fixSvgToPng (string $imageFilenameContainingString)
	fixUnavailableSkinImageSources (string $html)
	loadFromDb (int $question_id)
	createNewQuestion (bool $a_create_page=true)
	Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...
	saveQuestionDataToDb (int $original_id=-1)
	saveToDb ()
	setNewOriginalId (int $newId)
	deleteSuggestedSolutions ()
	getSuggestedSolution (int $subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...
	getSuggestedSolutionTitle (int $subquestion_index=0)
	Returns the title of a suggested solution at a given subquestion_index. More...
	setSuggestedSolution (string $solution_id="", int $subquestion_index=0, bool $is_import=false)
	Sets a suggested solution for the question. More...
	updateSuggestedSolutions (int $original_id=-1, int $original_obj_id=-1)
	_resolveInternalLink (string $internal_link)
	_resolveIntLinks (int $question_id)
	syncWithOriginal ()
	_questionExists ($question_id)
	Returns true if the question already exists in the database. More...
	_questionExistsInPool (int $question_id)
	getPoints ()
	setPoints (float $points)
	getSolutionMaxPass (int $active_id)
	calculateReachedPoints ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
	Returns the points, a learner has reached answering the question. More...
	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $previewSession, $reachedPoints)
	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)
	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)
	adjustReachedPointsByScoringOptions ($points, $active_id, $pass=null)
	Adjust the given reached points by checks for all special scoring options in the test container. More...
	isHTML ($a_text)
	Checks if a given string contains HTML or not. More...
	prepareTextareaOutput (string $txt_output, bool $prepare_for_latex_output=false, bool $omitNl2BrWhenTextArea=false)
	QTIMaterialToString (ilQTIMaterial $a_material)
	Reads an QTI material tag and creates a text or XHTML string. More...
	addQTIMaterial (ilXmlWriter $a_xml_writer, string $a_material, bool $close_material_tag=true, bool $add_mobs=true)
	buildHashedImageFilename (string $plain_image_filename, bool $unique=false)
	getQuestion ()
	getQuestionForHTMLOutput ()
	setQuestion (string $question="")
	getQuestionType ()
	Returns the question type of the question. More...
	getQuestionTypeID ()
	syncHints ()
	cleanupMediaObjectUsage ()
	getInstances ()
	getActiveUserData (int $active_id)
	Returns the user id and the test id for a given active id. More...
	hasSpecificFeedback ()
	setExportDetailsXLS (ilAssExcelFormatHelper $worksheet, int $startrow, int $active_id, int $pass)
	__get ($value)
	Object getter. More...
	__set ($key, $value)
	Object setter. More...
	__isset ($key)
	Object issetter. More...
	getNrOfTries ()
	setNrOfTries (int $a_nr_of_tries)
	setExportImagePath (string $path)
	formatSAQuestion ($a_q)
	setPreventRteUsage (bool $prevent_rte_usage)
	getPreventRteUsage ()
	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)
	setSelfAssessmentEditingMode (bool $selfassessmenteditingmode)
	getSelfAssessmentEditingMode ()
	setDefaultNrOfTries (int $defaultnroftries)
	getDefaultNrOfTries ()
	syncSkillAssignments (int $srcParentId, int $srcQuestionId, int $trgParentId, int $trgQuestionId)
	ensureHintPageObjectExists ($pageObjectId)
	isAnswered (int $active_id, int $pass)
	isAutosaveable ()
	getAdditionalContentEditingMode ()
	setAdditionalContentEditingMode (?string $additionalContentEditingMode)
	isAdditionalContentEditingModePageObject ()
	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)
	getValidAdditionalContentEditingModes ()
	getHtmlUserSolutionPurifier ()
	getHtmlQuestionContentPurifier ()
	setLastChange ($lastChange)
	getLastChange ()
	removeIntermediateSolution (int $active_id, int $pass)
	removeCurrentSolution (int $active_id, int $pass, bool $authorized=true)
	saveCurrentSolution (int $active_id, int $pass, $value1, $value2, bool $authorized=true, $tstamp=0)
	updateCurrentSolution (int $solutionId, $value1, $value2, bool $authorized=true)
	updateCurrentSolutionsAuthorization (int $activeId, int $pass, bool $authorized, bool $keepTime=false)
	setStep ($step)
	getStep ()
	toJSON ()
	duplicate (bool $for_test=true, string $title="", string $author="", string $owner="", $testObjId=null)
	intermediateSolutionExists (int $active_id, int $pass)
	authorizedSolutionExists (int $active_id, ?int $pass)
	authorizedOrIntermediateSolutionExists (int $active_id, int $pass)
	lookupForExistingSolutions (int $activeId, int $pass)
	Lookup if an authorized or intermediate solution exists. More...
	isAddableAnswerOptionValue (int $qIndex, string $answerOptionValue)
	addAnswerOptionValue (int $qIndex, string $answerOptionValue, float $points)
	removeAllExistingSolutions ()
	removeExistingSolutions (int $activeId, int $pass)
	resetUsersAnswer (int $activeId, int $pass)
	removeResultRecord (int $activeId, int $pass)
	fetchValuePairsFromIndexedValues (array $indexedValues)
	fetchIndexedValuesFromValuePairs (array $valuePairs)
	areObligationsToBeConsidered ()
	setObligationsToBeConsidered (bool $obligationsToBeConsidered)
	updateTimestamp ()
	getTestPresentationConfig ()
	savePartial ()
	isInActiveTest ()
	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...
	saveAnswerSpecificDataToDb ()
	Saves the answer specific records into a question types answer table. More...
Public Member Functions inherited from iQuestionCondition
	getOperators ($expression)
	Get all available operations for a specific question. More...
	getExpressionTypes ()
	Get all available expression types for a specific question. More...
	getUserQuestionResult ($active_id, $pass)
	Get the user solution for a question by active_id and the test pass. More...
	getAvailableAnswerOptions ($index=null)
	If index is null, the function returns an array with all anwser options Else it returns the specific answer option. More...

Data Fields
	$currentSolution = array()
const	MODE_SINGLE_CHOICE = 0
const	MODE_MULTIPLE_CHOICE = 1
const	AVAILABLE_SHAPES
	$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	TRIM_PATTERN = '/^[\p{C}\p{Z}]+|[\p{C}\p{Z}]+$/u'
const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'
const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'
ilAssQuestionFeedback	$feedbackOBJ
bool	$prevent_rte_usage = false
bool	$selfassessmenteditingmode = false
int	$defaultnroftries = 0
string	$questionActionCmd = 'handleQuestionAction'
const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'
Data Fields inherited from iQuestionCondition
const	StringResultExpression = '~TEXT~'
const	PercentageResultExpression = '%n%'
const	NumericResultExpression = '#n#'
const	MatchingResultExpression = ';n:m;'
const	OrderingResultExpression = '$n,m,o,p$'
const	NumberOfResultExpression = '+n+'
const	ExclusiveResultExpression = '*n,m,o,p*'
const	EmptyAnswerExpression = "?"

Protected Member Functions
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	calculateReachedPointsForSolution ($found_values)
	getAddSolutionSelectionParameter ()
	isAddSolutionSelectionRequest ()
	getRemoveSolutionSelectionParameter ()
	isRemoveSolutionSelectionRequest ()
	getReuseSolutionSelectionParameter ()
	isReuseSolutionSelectionRequest ()
Protected Member Functions inherited from assQuestion
	getQuestionAction ()
	isNonEmptyItemListPostSubmission (string $postSubmissionFieldname)
	ensureCurrentTestPass (int $active_id, int $pass)
	lookupCurrentTestPass (int $active_id, int $pass)
	lookupTestId (int $active_id)
	@refactor Move to ilObjTest or similar More...
	log (int $active_id, string $langVar)
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	deletePageOfQuestion (int $question_id)
	onDuplicate (int $originalParentId, int $originalQuestionId, int $duplicateParentId, int $duplicateQuestionId)
	beforeSyncWithOriginal (int $origQuestionId, int $dupQuestionId, int $origParentObjId, int $dupParentObjId)
	afterSyncWithOriginal (int $origQuestionId, int $dupQuestionId, int $origParentObjId, int $dupParentObjId)
	onCopy (int $sourceParentId, int $sourceQuestionId, int $targetParentId, int $targetQuestionId)
	duplicateSuggestedSolutionFiles (int $parent_id, int $question_id)
	Duplicates the files of a suggested solution if the question is duplicated. More...
	syncSuggestedSolutionFiles (int $target_question_id, int $target_obj_id)
	copySuggestedSolutionFiles (int $source_questionpool_id, int $source_question_id)
	ensureNonNegativePoints ($points)
	purifyAndPrepareTextAreaOutput (string $content)
	getRTETextWithMediaObjects ()
	getSelfAssessmentFormatter ()
	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)
	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)
	duplicateQuestionHints (int $originalQuestionId, int $duplicateQuestionId)
	duplicateSkillAssignments (int $srcParentId, int $srcQuestionId, int $trgParentId, int $trgQuestionId)
	buildQuestionDataQuery ()
	getCurrentSolutionResultSet (int $active_id, int $pass, bool $authorized=true)
	removeSolutionRecordById (int $solutionId)
	getSolutionRecordById (int $solutionId)
	deleteDummySolutionRecord (int $activeId, int $passIndex)
	isDummySolutionRecord (array $solutionRecord)
	deleteSolutionRecordByValues (int $activeId, int $passIndex, bool $authorized, array $matchValues)
	duplicateIntermediateSolutionAuthorized (int $activeId, int $passIndex)
	forceExistingIntermediateSolution (int $activeId, int $passIndex, bool $considerDummyRecordCreation)
	lookupMaxStep (int $active_id, int $pass)
	buildTestPresentationConfig ()
	build basic test question configuration instance More...

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

Private Attributes
ILIAS TestQuestionPool InternalRequestService	$request

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

Detailed Description

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

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

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

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

Here is the call graph for this function:

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 @access public

See also

$answers

ASS_AnswerImagemap

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

     : void {
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerImagemap.php";
        if (array_key_exists($order, $this->answers)) {
            // Insert answer
            $answer = new ASS_AnswerImagemap($answertext, $points, $order, 0, -1);
            $answer->setCoords($coords);
            $answer->setArea($area);
            $answer->setPointsUnchecked($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), 0, -1);
            $answer->setCoords($coords);
            $answer->setArea($area);
            $answer->setPointsUnchecked($points_unchecked);
            array_push($this->answers, $answer);
        }
    }

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

Referenced by uploadImagemap().

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.

@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 685 of file class.assImagemapQuestion.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) {
                array_push($found_values, $data["value1"]);
            }
        }
 
        $points = $this->calculateReachedPointsForSolution($found_values);
 
        return $points;
    }

References $data, $DIC, and $ilDB.

calculateReachedPointsForSolution()

assImagemapQuestion::calculateReachedPointsForSolution (   $found_values )

protected

Parameters

$found_values

Returns

float

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

                                                                       : float
    {
        if ($found_values == null) {
            $found_values = [];
        }
        $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;
    }

References ILIAS\LTI\ToolProvider\$key.

calculateReachedPointsFromPreviewSession()

assImagemapQuestion::calculateReachedPointsFromPreviewSession

(

ilAssQuestionPreviewSession

$previewSession

)

Reimplemented from assQuestion.

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

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

References ilAssQuestionPreviewSession\getParticipantsSolution().

Here is the call graph for this function:

copyImage()

assImagemapQuestion::copyImage	(		$question_id,
			$source_questionpool
	)

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

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

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

Here is the call graph for this function:

copyObject()

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

Copies an assImagemapQuestion object.

Copies an assImagemapQuestion object

@access public

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

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

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

Here is the call graph for this function:

createNewOriginalFromThisDuplicate()

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

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

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

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

Here is the call graph for this function:

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 @access public

See also

$answers

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

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

References $i, and $index.

deleteImage()

assImagemapQuestion::deleteImage

(

)

Deletes the image file.

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

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

duplicate()

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

Duplicates an assImagemapQuestion.

@access public

Reimplemented from assQuestion.

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

                                                                                                                                    : int
    {
        if ($this->id <= 0) {
            // The question has not been saved. It cannot be duplicated
            return -1;
        }
        // duplicate the question in database
        $this_id = $this->getId();
        $thisObjId = $this->getObjId();
 
        $clone = $this;
        include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
        $original_id = assQuestion::_getOriginalId($this->id);
        $clone->id = -1;
 
        if ((int) $testObjId > 0) {
            $clone->setObjId($testObjId);
        }
 
        if ($title) {
            $clone->setTitle($title);
        }
        if ($author) {
            $clone->setAuthor($author);
        }
        if ($owner) {
            $clone->setOwner($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;
    }

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:

duplicateImage()

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

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

                                                                  : void
    {
        global $DIC;
        $ilLog = $DIC['ilLog'];
 
        $imagepath = $this->getImagePath();
        $imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
 
        if ((int) $objectId > 0) {
            $imagepath_original = str_replace("/$this->obj_id/", "/$objectId/", $imagepath_original);
        }
 
        if (!file_exists($imagepath)) {
            ilFileUtils::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);
        }
    }

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

Here is the call graph for this function:

flushAnswers()

assImagemapQuestion::flushAnswers

(

)

Deletes all answers.

Deletes all answers

@access public

See also

$answers

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

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

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 @access public

See also

$imagemap_contents

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

                                                      : string
    {
        $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;
    }

References $i, and $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 @access public

Reimplemented from assQuestion.

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

                                            : string
    {
        return "qpl_qst_imagemap";
    }

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

getAddSolutionSelectionParameter()

assImagemapQuestion::getAddSolutionSelectionParameter ( )

protected

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

    {
        if (!$this->isAddSolutionSelectionRequest()) {
            return null;
        }
 
        return $this->request->raw('selImage');
    }

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 @access public

See also

$answers

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

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

References $index.

getAnswerCount()

assImagemapQuestion::getAnswerCount

(

)

Returns the number of answers.

Returns the number of answers

Returns

integer The number of answers of the multiple choice question @access public

See also

$answers

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

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

getAnswers()

& assImagemapQuestion::getAnswers

(

)

Returns the answer array.

Returns the answer array

Returns

array The answer array @access public

See also

$answers

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

                                 : array
    {
        return $this->answers;
    }

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 @access public

Reimplemented from assQuestion.

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

                                        : string
    {
        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

Implements iQuestionCondition.

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

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

References $index.

getExpressionTypes()

assImagemapQuestion::getExpressionTypes

(

)

Get all available expression types for a specific question.

Returns

array

Implements iQuestionCondition.

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

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

References iQuestionCondition\EmptyAnswerExpression, iQuestionCondition\ExclusiveResultExpression, iQuestionCondition\NumberOfResultExpression, and iQuestionCondition\PercentageResultExpression.

getImageFilename()

assImagemapQuestion::getImageFilename

(

)

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

                                      : string
    {
        return $this->image_filename;
    }

References $image_filename.

Referenced by copyImage(), and duplicateImage().

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

                                         : bool
    {
        return $this->is_multiple_choice;
    }

References $is_multiple_choice.

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

@access public

See also

$points

Reimplemented from assQuestion.

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

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

References ILIAS\LTI\ToolProvider\$key.

Referenced by isComplete().

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

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

References ilOperatorsExpressionMapping\getOperatorsByExpression().

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 @access public

Reimplemented from assQuestion.

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

                                     : string
    {
        return "assImagemapQuestion";
    }

getRemoveSolutionSelectionParameter()

assImagemapQuestion::getRemoveSolutionSelectionParameter ( )

protected

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

    {
        if (!$this->isRemoveSolutionSelectionRequest()) {
            return null;
        }
 
        return $this->request->raw('remImage');
    }

getReuseSolutionSelectionParameter()

assImagemapQuestion::getReuseSolutionSelectionParameter ( )

protected

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

                                                           : ?array
    {
        if (!$this->isReuseSolutionSelectionRequest()) {
            return null;
        }
 
        return assQuestion::explodeKeyValues($this->request->raw("reuseSelection"));
    }

References assQuestion\explodeKeyValues().

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

Reimplemented from assQuestion.

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

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

References $index, and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

getTestOutputSolutions()

assImagemapQuestion::getTestOutputSolutions	(		$activeId,
			$pass
	)

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

                                                            : array
    {
        $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 1108 of file class.assImagemapQuestion.php.

                                                      : bool
    {
        if (!$this->request->isset("selImage")) {
            return false;
        }
 
        if (!strlen($this->request->raw('selImage'))) {
            return false;
        }
 
        return true;
    }

isAutosaveable()

assImagemapQuestion::isAutosaveable

(

)

Reimplemented from assQuestion.

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

                                    : bool
    {
        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 @access public

Reimplemented from assQuestion.

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

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

References getMaximumPoints().

Here is the call graph for this function:

isRemoveSolutionSelectionRequest()

assImagemapQuestion::isRemoveSolutionSelectionRequest ( )

protected

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

                                                         : bool
    {
        if (!$this->is_multiple_choice) {
            return false;
        }
 
        if (!$this->request->isset("remImage")) {
            return false;
        }
 
        if (!strlen($this->request->raw('remImage'))) {
            return false;
        }
 
        return true;
    }

isReuseSolutionSelectionRequest()

assImagemapQuestion::isReuseSolutionSelectionRequest ( )

protected

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

                                                        : bool
    {
        if (!$this->getTestPresentationConfig()->isPreviousPassSolutionReuseAllowed()) {
            return false;
        }
 
        if (!$this->request->isset("reuseSelection")) {
            return false;
        }
 
        if (!strlen($this->request->raw("reuseSelection"))) {
            return false;
        }
 
        if (!preg_match('/\d(,\d)*/', $this->request->raw("reuseSelection"))) {
            return false;
        }
 
        return true;
    }

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 @access public

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

                                            : void
    {
        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((string) $data["title"]);
            $this->setComment((string) $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((string) $data["question_text"], 1));
            $this->setImageFilename($data["image_file"]);
 
            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) {
            }
 
            $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)) {
                    $image_map_question = new ASS_AnswerImagemap($data["answertext"] ?? '', $data["points"], $data["aorder"]);
                    $image_map_question->setCoords($data["coords"]);
                    $image_map_question->setArea($data["area"]);
                    $image_map_question->setPointsUnchecked($data['points_unchecked']);
                    array_push($this->answers, $image_map_question);
                }
            }
        }
        parent::loadFromDb($question_id);
    }

References $data, $DIC, Vendor\Package\$e, $ilDB, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setId(), setImageFilename(), setIsMultipleChoice(), assQuestion\setLifecycle(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), and assQuestion\setTitle().

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

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

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

Referenced by saveToDb().

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

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

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

Referenced by saveToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

savePreviewData()

assImagemapQuestion::savePreviewData ( ilAssQuestionPreviewSession  $previewSession )

protected

Reimplemented from assQuestion.

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

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

References ilAssQuestionPreviewSession\getParticipantsSolution(), ILIAS\Repository\int(), and ilAssQuestionPreviewSession\setParticipantsSolution().

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

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

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

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.

@access public

Parameters

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

Returns

boolean $status

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

                                                                                 : bool
    {
        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) $this->request->raw('selImage')
                        ));
                    } else {
                        $this->removeCurrentSolution($active_id, $pass, $authorized);
                    }
 
                    $this->saveCurrentSolution($active_id, $pass, $this->request->raw('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;
    }

References $DIC, $ilDB, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), ILIAS\Repository\lng(), and assQuestion\logAction().

Here is the call graph for this function:

setExportDetailsXLS()

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

{}

Reimplemented from assQuestion.

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

                                                                                                                    : int
    {
        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, 2, $cellValue);
 
            $i++;
        }
 
        return $startrow + $i + 1;
    }

References $i, $id, ilExcel\getColumnCoord(), ilExcel\setBold(), and ilAssExcelFormatHelper\setCell().

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. @access public

See also

$image_filename

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

                                                                               : void
    {
        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)) {
                ilFileUtils::makeDirParents($imagepath);
            }
            if (!ilFileUtils::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);
        }
    }

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

Referenced by loadFromDb().

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

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

References $is_multiple_choice.

Referenced by loadFromDb().

Here is the caller graph for this function:

syncWithOriginal()

assImagemapQuestion::syncWithOriginal

(

)

Reimplemented from assQuestion.

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

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

toJSON()

assImagemapQuestion::toJSON

(

)

Returns a JSON representation of the question.

Reimplemented from assQuestion.

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

                            : string
    {
        include_once("./Services/RTE/classes/class.ilRTE.php");
        $result = array();
        $result['id'] = $this->getId();
        $result['type'] = (string) $this->getQuestionType();
        $result['title'] = $this->getTitleForHTMLOutput();
        $result['question'] = $this->formatSAQuestion($this->getQuestion());
        $result['nr_of_tries'] = $this->getNrOfTries();
        $result['shuffle'] = $this->getShuffle();
        $result['is_multiple'] = $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'] = $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" => $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);
    }

References ILIAS\LTI\ToolProvider\$key, $mobs, ilObjMediaObject\_getMobsOfObject(), and ILIAS\Survey\Mode\getId().

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

                                                 : int
    {
        $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;
    }

References addAnswer().

Here is the call graph for this function:

Field Documentation

$answers

assImagemapQuestion::$answers

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

$coords

assImagemapQuestion::$coords

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

Referenced by addAnswer().

$currentSolution

assImagemapQuestion::$currentSolution = array()

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

$image_filename

assImagemapQuestion::$image_filename

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

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

$imagemap_contents

assImagemapQuestion::$imagemap_contents

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

Referenced by get_imagemap_contents().

$is_multiple_choice

assImagemapQuestion::$is_multiple_choice = false

protected

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

Referenced by getIsMultipleChoice(), and setIsMultipleChoice().

$request

ILIAS TestQuestionPool InternalRequestService assImagemapQuestion::$request

private

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

AVAILABLE_SHAPES

const assImagemapQuestion::AVAILABLE_SHAPES

Initial value:

= [
        'RECT' => 'rect',
        'CIRCLE' => 'circle',
        'POLY' => 'poly']

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

Referenced by assImagemapQuestionGUI\saveShape(), and ilHtmlImageMapFileInputGUI\verifyArea().

MODE_MULTIPLE_CHOICE

const assImagemapQuestion::MODE_MULTIPLE_CHOICE = 1

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

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

MODE_SINGLE_CHOICE

const assImagemapQuestion::MODE_SINGLE_CHOICE = 0

Definition at line 42 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