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="", int $owner=-1, $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)

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

	setExportDetailsXLSX (ilAssExcelFormatHelper $worksheet, int $startrow, int $col, 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...

	setTitle (string $title="")

	setId (int $id=-1)

	setTestId (int $id=-1)

	setComment (string $comment="")

	setShuffle (?bool $shuffle=true)

	setAuthor (string $author="")

	setOwner (int $owner=-1)

	getTitle ()

	getTitleForHTMLOutput ()

	getTitleFilenameCompliant ()

	getId ()

	getShuffle ()

	getTestId ()

	getComment ()

	getDescriptionForHTMLOutput ()

	getThumbSize ()

	setThumbSize (int $a_size)

	getMinimumThumbSize ()

	getMaximumThumbSize ()

	getAuthor ()

	getAuthorForHTMLOutput ()

	getOwner ()

	getObjId ()

	setObjId (int $obj_id=0)

	getLifecycle ()

	setLifecycle (ilAssQuestionLifecycle $lifecycle)

	setExternalId (?string $external_id)

	getExternalId ()

	getSuggestedSolutionOutput ()

	getSuggestedSolutions ()

	getReachedPoints (int $active_id, int $pass)

	getMaximumPoints ()

	getAdjustedReachedPoints (int $active_id, int $pass, bool $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...

	getSuggestedSolutionPath ()

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

	getSuggestedSolutionPathWeb ()

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

	getTestOutputSolutions (int $activeId, int $pass)

	getUserSolutionPreferingIntermediate (int $active_id, $pass=null)

	getSolutionValues ($active_id, $pass=null, bool $authorized=true)
	Loads solutions of a given user from the database an returns it. 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 ()

	deleteSuggestedSolutions ()

	getSuggestedSolution (int $subquestion_index=0)

	resolveInternalLink (string $internal_link)

	resolveSuggestedSolutionLinks ()

	syncWithOriginal ()

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

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

	setExportDetailsXLSX (ilAssExcelFormatHelper $worksheet, int $startrow, int $col, int $active_id, int $pass)

	getNrOfTries ()

	setNrOfTries (int $a_nr_of_tries)

	setExportImagePath (string $path)

	formatSAQuestion ($a_q)

	setPreventRteUsage (bool $prevent_rte_usage)

	getPreventRteUsage ()

	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)

	setSelfAssessmentEditingMode (bool $selfassessmenteditingmode)

	getSelfAssessmentEditingMode ()

	setDefaultNrOfTries (int $defaultnroftries)

	getDefaultNrOfTries ()

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

	ensureHintPageObjectExists ($pageObjectId)

	isAnswered (int $active_id, int $pass)

	getAdditionalContentEditingMode ()

	setAdditionalContentEditingMode (?string $additionalContentEditingMode)

	isAdditionalContentEditingModePageObject ()

	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)

	getValidAdditionalContentEditingModes ()

	getHtmlUserSolutionPurifier ()

	getHtmlQuestionContentPurifier ()

	setLastChange ($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="", int $owner=-1, $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 ()

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

Public Member Functions inherited from assQuestionInterface
	validateSolutionSubmit ()

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

	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)

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

	deleteComments ()

	getNotesManager ()

	getNotesDataService ()

	getNotesRepo ()

	syncSuggestedSolutions (int $target_question_id, int $target_obj_id)

	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)

	copySuggestedSolutions (int $target_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...

	getSuggestedSolutionsRepo ()

	loadSuggestedSolutions ()

Protected Attributes
	$is_multiple_choice = false

Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true

ILIAS TestQuestionPool QuestionInfoService	$questioninfo

ILIAS Test TestParticipantInfoService	$testParticipantInfo

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ILIAS TestQuestionPool QuestionFilesService	$questionFilesService

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

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

SkillUsageService	$skillUsageService

assQuestionSuggestedSolutionsDatabaseRepository	$suggestedsolution_repo = null

Private Attributes
ILIAS TestQuestionPool InternalRequestService	$request

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

static	isForcePassResultUpdateEnabled ()

static	_getSuggestedSolutionOutput (int $question_id)

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

static	logAction (string $logtext, int $active_id, int $question_id)

static	isFileAvailable (string $file)

static	saveOriginalId (int $questionId, int $originalId)

static	resetOriginalId (int $questionId)

static	_getInternalLinkHref (string $target="")

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	_setReachedPoints (int $active_id, int $question_id, float $points, float $maxpoints, int $pass, bool $manualscoring, bool $obligationsEnabled, ?int $test_id=null)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...

static	_needsManualScoring (int $question_id)

static	getFeedbackClassNameByQuestionType (string $questionType)

static	instantiateQuestionGUI (int $a_question_id)

static	_questionExistsInTest (int $question_id, int $test_id)

static	lookupParentObjId (int $questionId)

static	isObligationPossible (int $questionId)

static	implodeKeyValues (array $keyValues)

static	explodeKeyValues (string $keyValues)

static	convertISO8601FormatH_i_s_ExtendedToSeconds (string $time)

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

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

Static Protected Attributes inherited from assQuestion
static	$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.

References assQuestion\$author, assQuestion\$comment, $DIC, $image_filename, assQuestion\$owner, assQuestion\$question, assQuestion\$title, and ILIAS\MetaData\Repository\Validation\Data\__construct().

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

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 public

See also: $answers; ASS_AnswerImagemap

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

References $coords, and assQuestion\$points.

Referenced by uploadImagemap().

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

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

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

Referenced by getExpressionTypes().

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

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

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

Referenced by calculateReachedPoints(), and calculateReachedPointsFromPreviewSession().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPointsFromPreviewSession()

assImagemapQuestion::calculateReachedPointsFromPreviewSession ( ilAssQuestionPreviewSession $previewSession )

Definition at line 705 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 352 of file class.assImagemapQuestion.php.

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

                                                                  : 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!!!! ";
         }
     }

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

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

                                                                     : 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;
 
         $original_id = $this->questioninfo->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 291 of file class.assImagemapQuestion.php.

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

                                                                                                   : int
     {
         if ($this->getId() <= 0) {
             throw new RuntimeException('The question has not been saved. It cannot be duplicated');
         }
 
         $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 610 of file class.assImagemapQuestion.php.

References ILIAS\UI\Implementation\Component\Table\getOrder().

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

Here is the call graph for this function:

◆ deleteImage()

assImagemapQuestion::deleteImage ( )

Deletes the image file.

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

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

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

Here is the call graph for this function:

◆ duplicate()

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

Duplicates an assImagemapQuestion.

public

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

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

                                                                                                                                  : 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;
         $original_id = $this->questioninfo->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 323 of file class.assImagemapQuestion.php.

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

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

Here is the call graph for this function:

◆ flushAnswers()

assImagemapQuestion::flushAnswers ( )

Deletes all answers.

Deletes all answers

public

See also: $answers

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

Referenced by deleteImage().

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

References $imagemap_contents.

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

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

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

                                             : string
     {
         return "qpl_qst_imagemap";
     }

Here is the caller graph for this function:

◆ getAddSolutionSelectionParameter()

assImagemapQuestion::getAddSolutionSelectionParameter ( )

protected

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

References isAddSolutionSelectionRequest().

Referenced by saveWorkingData().

     {
         if (!$this->isAddSolutionSelectionRequest()) {
             return null;
         }
 
         return $this->request->raw('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 572 of file class.assImagemapQuestion.php.

Referenced by getAvailableAnswerOptions().

                                          : ?object
     {
         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 556 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 public

See also: $answers

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

References $answers.

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

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

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

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

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

Here is the call graph for this function:

◆ getImageFilename()

assImagemapQuestion::getImageFilename ( )

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

References $image_filename.

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

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

References $is_multiple_choice.

Referenced by calculateReachedPointsForSolution(), and toJSON().

                                          : bool
     {
         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 651 of file class.assImagemapQuestion.php.

References ILIAS\LTI\ToolProvider\$key, and assQuestion\$points.

Referenced by getExpressionTypes(), and isComplete().

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

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

References ilOperatorsExpressionMapping\getOperatorsByExpression().

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

Referenced by toJSON().

                                      : string
     {
         return "assImagemapQuestion";
     }

Here is the caller graph for this function:

◆ getRemoveSolutionSelectionParameter()

assImagemapQuestion::getRemoveSolutionSelectionParameter ( )

protected

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

References isRemoveSolutionSelectionRequest().

Referenced by saveWorkingData().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReuseSolutionSelectionParameter()

assImagemapQuestion::getReuseSolutionSelectionParameter ( )

protected

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

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

Referenced by saveWorkingData().

                                                            : ?array
     {
         if (!$this->isReuseSolutionSelectionRequest()) {
             return null;
         }
 
         return assQuestion::explodeKeyValues($this->request->raw("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 873 of file class.assImagemapQuestion.php.

References assQuestion\getId().

                                                 : string
     {
         $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 1077 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 1096 of file class.assImagemapQuestion.php.

Referenced by getAddSolutionSelectionParameter(), and saveWorkingData().

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

Here is the caller graph for this function:

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

References getMaximumPoints().

                                 : bool
     {
         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 1116 of file class.assImagemapQuestion.php.

Referenced by getRemoveSolutionSelectionParameter(), and saveWorkingData().

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

Here is the caller graph for this function:

◆ isReuseSolutionSelectionRequest()

assImagemapQuestion::isReuseSolutionSelectionRequest ( )

protected

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

References assQuestion\getTestPresentationConfig().

Referenced by getReuseSolutionSelectionParameter(), and saveWorkingData().

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

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

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

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

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.

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

References $DIC, $ilDB, ILIAS\LTI\ToolProvider\$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 803 of file class.assImagemapQuestion.php.

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

                                                                                    : void
     {
         $solution = $previewSession->getParticipantsSolution();
 
         if ($this->is_multiple_choice
             && $this->request->isset('remImage')) {
             unset($solution[$this->request->int('remImage')]);
         }
 
         if ($this->request->isset('selImage')) {
             if (!$this->is_multiple_choice) {
                 $solution = array();
             }
 
             $solution[$this->request->int('selImage')] = $this->request->int('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 144 of file class.assImagemapQuestion.php.

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

                                                : void
     {
         if ($original_id == '') {
             $this->saveQuestionDataToDb();
         } else {
             $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 723 of file class.assImagemapQuestion.php.

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

                                                                                  : bool
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         if (is_null($pass)) {
             $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;
                 }
             }
         });
 
         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:

◆ setExportDetailsXLSX()

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

{}

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

References assQuestion\$id, getAnswers(), ilExcel\getColumnCoord(), assQuestion\getSolutionValues(), ilExcel\setBold(), and ilAssExcelFormatHelper\setCell().

                                                                                                                                : int
     {
         parent::setExportDetailsXLSX($worksheet, $startrow, $col, $active_id, $pass);
 
         $solution = $this->getSolutionValues($active_id, $pass);
 
         $i = 1;
         foreach ($this->getAnswers() as $id => $answer) {
             $worksheet->setCell($startrow + $i, $col, $answer->getArea() . ": " . $answer->getCoords());
             $worksheet->setBold($worksheet->getColumnCoord($col) . ($startrow + $i));
 
             $cellValue = 0;
             foreach ($solution as $solIndex => $sol) {
                 if ($sol['value1'] == $id) {
                     $cellValue = 1;
                     break;
                 }
             }
 
             $worksheet->setCell($startrow + $i, $col + 2, $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 461 of file class.assImagemapQuestion.php.

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

Referenced by loadFromDb().

                                                                                : 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->tpl->setOnScreenMessage('failure', 'The image could not be uploaded!');
                 return;
             }
             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 100 of file class.assImagemapQuestion.php.

References $is_multiple_choice.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ syncWithOriginal()

assImagemapQuestion::syncWithOriginal ( )

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

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

◆ toJSON()

assImagemapQuestion::toJSON ( )

Returns a JSON representation of the question.

Implements ilAssQuestionLMExportable.

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

References $answers, ILIAS\LTI\ToolProvider\$key, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), getAnswers(), assQuestion\getId(), getImageFilename(), assQuestion\getImagePathWeb(), getIsMultipleChoice(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), and assQuestion\getTitleForHTMLOutput().

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

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

References addAnswer().

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

Here is the call graph for this function:

Field Documentation

◆ $answers

assImagemapQuestion::$answers

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

Referenced by getAnswers(), and toJSON().

◆ $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'

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

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

◆ isComplete()

◆ isRemoveSolutionSelectionRequest()

◆ isReuseSolutionSelectionRequest()

◆ loadFromDb()

◆ saveAdditionalQuestionDataToDb()

◆ saveAnswerSpecificDataToDb()

◆ savePreviewData()

◆ saveToDb()

◆ saveWorkingData()

◆ setExportDetailsXLSX()

◆ setImageFilename()

◆ setIsMultipleChoice()

◆ syncWithOriginal()

◆ toJSON()

◆ uploadImagemap()

Field Documentation

◆ $answers

◆ $coords

◆ $currentSolution

◆ $image_filename

◆ $imagemap_contents

◆ $is_multiple_choice

◆ $request

◆ AVAILABLE_SHAPES

◆ MODE_MULTIPLE_CHOICE

◆ MODE_SINGLE_CHOICE