Class for image map questions. More...

Inheritance diagram for assImagemapQuestion:

Collaboration diagram for assImagemapQuestion:

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

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

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

	isComplete ()

	saveToDb (?int $original_id=null)

	saveAnswerSpecificDataToDb ()
	Saves the answer specific records into a question types answer table. More...

	saveAdditionalQuestionDataToDb ()

	copyImagemapFiles (int $source_question_id, int $source_parent_id, int $target_question_id, int $target_parent_id)

	loadFromDb (int $question_id)

	uploadImagemap (array $shapes)

	uploadImageFile (string $upload_file_name, string $upload_tmp_name)

	getImageFilename ()

	setImageFilename (string $image_filename)

	get_imagemap_contents (string $href='#')

	addAnswer (string $answertext='', float $points=0.0, int $order=0, string $coords='', string $area='', float $points_unchecked=0.0)

	getAnswerCount ()

	getAnswer (int $index=0)

&	getAnswers ()

	deleteArea (int $index=0)

	flushAnswers ()

	getMaximumPoints ()

	calculateReachedPoints (int $active_id, ?int $pass=null, bool $authorized_solution=true)

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $preview_session)

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

	getQuestionType ()
	Returns the question type of the question. More...

	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...

	getAnswerTableName ()
	Returns the name of the answer table in the database. More...

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

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

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

	getOperators (string $expression)
	Get all available operations for a specific question. More...

	getExpressionTypes ()
	Get all available expression types for a specific question. More...

	getUserQuestionResult (int $active_id, int $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...

	getTestOutputSolutions ($activeId, $pass)

	toLog (AdditionalInformationGenerator $additional_info)
	MUST return an array of the question settings that can be stored in the log. More...

	solutionValuesToText (array $solution_values)
	MUST convert the given solution values into text. More...

	getCorrectSolutionForTextOutput (int $active_id, int $pass)

	toNormalized (Transformations $transformations, array $context=[])

	fromNormalized (array $normalized, Transformations $transformations)

Public Member Functions inherited from assQuestion
	getQuestionType ()

	isComplete ()

	saveWorkingData (int $active_id, ?int $pass=null, bool $authorized=true)

	calculateReachedPoints (int $active_id, ?int $pass=null, bool $authorized_solution=true)

	getAdditionalTableName ()

	getAnswerTableName ()

	toLog (AdditionalInformationGenerator $additional_info)
	MUST return an array of the question settings that can be stored in the log. More...

	getCurrentUser ()

	getShuffler ()

	setShuffler (Transformation $shuffler)

	setProcessLocker (ilAssQuestionProcessLocker $processLocker)

	getProcessLocker ()

	fromXML (string $importdirectory, int $user_id, ilQTIItem $item, int $questionpool_id, ?int $tst_id, ?ilObject &$tst_object, int &$question_counter, array $import_mapping)

	toXML (bool $a_include_header=true, bool $a_include_binary=true, bool $a_shuffle=false, bool $test_output=false, bool $force_image_references=false)

	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 $authorized_solution=true)

	calculateResultsFromSolution (int $active_id, int $pass)
	Calculates the question results from a previously saved question solution. More...

	persistWorkingState (int $active_id, $pass, bool $authorized=true)
	persists the working state for current testactive and testpass More...

	persistPreviewState (ilAssQuestionPreviewSession $preview_session)
	persists the preview state for current user and question More...

	validateSolutionSubmit ()

	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, ?int $pass=null)

	getSolutionValues (int $active_id, ?int $pass=null, bool $authorized=true)
	Loads solutions of a given user from the database an returns it. More...

	deleteAnswers (int $question_id)

	deleteAdditionalTableData (int $question_id)

	delete (int $question_id)

	getTotalAnswers ()

	cloneXHTMLMediaObjectsOfQuestion (int $source_question_id)

	createPageObject ()

	clonePageOfQuestion (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=null)

	updateOriginalId (?int $original_id=null)

	duplicate (bool $set_original_id=true, string $title='', string $author='', int $owner=-1, $test_obj_id=null)

	copyObject (int $target_parent_id, string $title='')

	createNewOriginalFromThisDuplicate (int $target_parent_id, string $target_question_title='')

	saveToDb (?int $original_id=null)

	deleteSuggestedSolutions ()

	getSuggestedSolution (int $subquestion_index=0)

	resolveInternalLink (string $internal_link)

	resolveSuggestedSolutionLinks ()

	getInternalLinkHref (string $target)

	syncWithOriginal ()

	getPoints ()

	setPoints (float $points)

	getSolutionMaxPass (int $active_id)

	isWriteable ()

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $preview_session)

	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $preview_session)

	adjustReachedPointsByScoringOptions (float $points, int $active_id)
	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="")

	getQuestionTypeID ()

	cleanupMediaObjectUsage ()

	getInstances ()

	getActiveUserData (int $active_id)
	Returns the user id and the test id for a given active id. More...

	hasSpecificFeedback ()

	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)

	isAnswered (int $active_id, int $pass)

	getAdditionalContentEditingMode ()

	setAdditionalContentEditingMode (?string $additionalContentEditingMode)

	isAdditionalContentEditingModePageObject ()

	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)

	getValidAdditionalContentEditingModes ()

	getHtmlUserSolutionPurifier ()

	getHtmlQuestionContentPurifier ()

	setLastChange (int $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 ()

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

	updateTimestamp ()

	getTestPresentationConfig ()

	hasWritableOriginalInQuestionPool ()

	answerToParticipantInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, int $active_id, int $pass, string $source_ip, TestParticipantInteractionTypes $interaction_type)

	toQuestionAdministrationInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, TestQuestionAdministrationInteractionTypes $interaction_type)

	getSolutionForTextOutput (int $active_id, int $pass)

	getCorrectSolutionForTextOutput (int $active_id, int $pass)

	getVariablesAsTextArray (int $active_id, int $pass)

	toNormalized (Transformations $transformations, array $context=[])

	fromNormalized (array $normalized, Transformations $transformations)

	validateSolutionSubmit ()

	toLog (AdditionalInformationGenerator $additional_info)

	answerToParticipantInteraction (AdditionalInformationGenerator $additional_info, int $test_id, int $active_id, int $pass, string $source_ip, TestParticipantInteractionTypes $interaction_type)

	toQuestionAdministrationInteraction (AdditionalInformationGenerator $additional_info, int $test_id, TestQuestionAdministrationInteractionTypes $interaction_type)

	saveAnswerSpecificDataToDb ()
	Saves the answer specific records into a question types answer table. More...

Public Member Functions inherited from iQuestionCondition
	getOperators (string $expression)
	Get all available operations for a specific question. More...

	getExpressionTypes ()
	Get all available expression types for a specific question. More...

	getUserQuestionResult (int $active_id, int $pass)
	Get the user solution for a question by active_id and the test pass. More...

	getAvailableAnswerOptions (?int $index=null)
	If index is null, the function returns an array with all anwser options else it returns the specific answer option. More...

	toJSON ()

	toNormalized (Transformations $transformations, array $context=[])
	Convert the internal state of the implementing object into a language-neutral array structure. More...

	fromNormalized (array $normalized, Transformations $transformations)
	Restore the object from its normalized representation. More...

Data Fields
	$currentSolution = []

const	MODE_SINGLE_CHOICE = 0

const	MODE_MULTIPLE_CHOICE = 1

const	AVAILABLE_SHAPES

array	$answers

string	$image_filename

string	$imagemap_contents

array	$coords

Data Fields inherited from assQuestion
const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'

const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'

const	TRIM_PATTERN = '/^[\p{C}\p{Z}]+\|[\p{C}\p{Z}]+$/u'

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
	cloneQuestionTypeSpecificProperties (\assQuestion $target)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	calculateReachedPointsForSolution (?array $found_values)

	getAddSolutionSelectionParameter ()

	isAddSolutionSelectionRequest ()

	getRemoveSolutionSelectionParameter ()

	isRemoveSolutionSelectionRequest ()

	getReuseSolutionSelectionParameter ()

	isReuseSolutionSelectionRequest ()

	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)
	MUST convert the given solution values into an array or a string that can be stored in the log. More...

Protected Member Functions inherited from assQuestion
	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)
	MUST convert the given solution values into an array or a string that can be stored in the log. More...

	solutionValuesToText (array $solution_values)
	MUST convert the given solution values into text. More...

	getQuestionAction ()

	isNonEmptyItemListPostSubmission (string $post_submission_field_name)

	savePreviewData (ilAssQuestionPreviewSession $preview_session)

	deletePageOfQuestion (int $question_id)

	cloneQuestionTypeSpecificProperties (self $target)

	removeAllImageFiles (string $image_target_path)

	onDuplicate (int $original_parent_id, int $original_question_id, int $duplicate_parent_id, int $duplicate_question_id)

	afterSyncWithOriginal (int $original_question_id, int $clone_question_id, int $original_parent_id, int $clone_parent_id)

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

	cloneSuggestedSolutions (int $source_question_id, int $target_question_id)

	duplicateSuggestedSolutionFiles (int $parent_id, int $question_id)
	Duplicates the files of a suggested solution if the question is duplicated. More...

	cloneSuggestedSolutionFiles (int $source_question_id, int $target_question_id)

	copySuggestedSolutions (int $target_question_id)

	ensureNonNegativePoints (float $points)

	purifyAndPrepareTextAreaOutput (string $content)

	getRTETextWithMediaObjects ()

	getSelfAssessmentFormatter ()

	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

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

	getSuggestedSolutionsRepo ()

	loadSuggestedSolutions ()

	answerToLog (AdditionalInformationGenerator $additional_info, int $active_id, int $pass)

Protected Attributes
bool	$is_multiple_choice = false

Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true

GeneralQuestionPropertiesRepository	$questionrepository

RequestDataCollector	$questionpool_request

QuestionFiles	$question_files

ilAssQuestionProcessLocker	$processLocker

ilTestQuestionConfig	$testQuestionConfig

SuggestedSolutionsDatabaseRepository	$suggestedsolution_repo

ILIAS	$ilias

ilGlobalPageTemplate	$tpl

ilLanguage	$lng

ilDBInterface	$db

ilObjUser	$current_user

SkillUsageService	$skillUsageService

HTTPServices	$http

Refinery	$refinery

Transformation	$shuffler

LoggingServices	$log

Container	$dic

ilAssQuestionLifecycle	$lifecycle

ilAssQuestionPage	$page

TestResultRepository	$test_result_repository

int	$id

string	$title

string	$comment

int	$owner

string	$author

int	$thumb_size

string	$question

float	$points = 0.0

bool	$shuffle = true

int	$test_id

int	$obj_id = 0

int	$original_id = null

int	$lastChange = null

string	$external_id = null

int	$step = null

array	$suggested_solutions

Private Attributes
RequestDataCollector	$request

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

static	isForcePassResultUpdateEnabled ()

static	_getSuggestedSolutionOutput (int $question_id)

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

static	isFileAvailable (string $file)

static	saveOriginalId (int $questionId, int $originalId)

static	resetOriginalId (int $questionId)

static	instantiateQuestion (int $question_id)

static	_getSolutionMaxPass (int $question_id, int $active_id)
	Returns the maximum pass a users question solution. More...

static	getFeedbackClassNameByQuestionType (string $questionType)

static	_questionExistsInTest (int $question_id, int $test_id)

static	lookupParentObjId (int $question_id)

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

static	$imageSourceFixReplaceMap

Detailed Description

Class for image map questions.

assImagemapQuestion is a class for imagemap question.

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m; Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de; Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

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

      {
        parent::__construct($title, $comment, $author, $owner, $question);
        $this->image_filename = $image_filename;
        $this->answers = [];
        $this->coords = [];
 
        $local_dic = QuestionPoolDIC::dic();
        $this->request = $local_dic['request_data_collector'];
    }

References assQuestion\$author, assQuestion\$comment, $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	(	string	$answertext = `''`,
		float	$points = `0.0`,
		int	$order = `0`,
		string	$coords = `''`,
		string	$area = `''`,
		float	$points_unchecked = `0.0`
	)

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

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

◆ calculateReachedPoints()

assImagemapQuestion::calculateReachedPoints	(	int	$active_id,
		?int	$pass = `null`,
		bool	$authorized_solution = `true`
	)

Reimplemented from assQuestion.

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

     : float {
        if ($pass === null) {
            $pass = $this->getSolutionMaxPass($active_id);
        }
        $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorized_solution);
        $found_values = [];
        while ($data = $this->db->fetchAssoc($result)) {
            if ($data['value1'] !== '') {
                $found_values[] = $data['value1'];
            }
        }
 
        $points = $this->calculateReachedPointsForSolution($found_values);
 
        return $points;
    }

◆ calculateReachedPointsForSolution()

assImagemapQuestion::calculateReachedPointsForSolution ( ?array $found_values )

protected

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

◆ calculateReachedPointsFromPreviewSession()

assImagemapQuestion::calculateReachedPointsFromPreviewSession ( ilAssQuestionPreviewSession $preview_session )

Reimplemented from assQuestion.

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

                                                                                                          : float
    {
        $solution_data = $preview_session->getParticipantsSolution();
 
        $reached_points = $this->calculateReachedPointsForSolution(is_array($solution_data) ? array_values($solution_data) : []);
 
        return $this->ensureNonNegativePoints($reached_points);
    }

◆ cloneQuestionTypeSpecificProperties()

assImagemapQuestion::cloneQuestionTypeSpecificProperties ( \assQuestion $target )

protected

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

     : \assQuestion {
        $this->copyImagemapFiles($this->getId(), $this->getObjId(), $target->getId(), $target->getObjId());
        return $target;
    }

◆ copyImagemapFiles()

assImagemapQuestion::copyImagemapFiles	(	int	$source_question_id,
		int	$source_parent_id,
		int	$target_question_id,
		int	$target_parent_id
	)

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

     : void {
        $image_source_path = $this->getImagePath($source_question_id, $source_parent_id);
        $image_target_path = $this->getImagePath($target_question_id, $target_parent_id);
 
        if (!file_exists($image_target_path)) {
            ilFileUtils::makeDirParents($image_target_path);
        } else {
            $this->removeAllImageFiles($image_target_path);
        }
 
        if (!file_exists($image_source_path) || !is_readable($image_source_path)) {
            $this->log->forComponent('qpl')->alert(
                "Could not copy imagemap question files: Source path '{$image_source_path}' does not exist or is not readable.",
                [
                    'source_question_id' => $source_question_id,
                    'source_parent_id' => $source_parent_id,
                    'target_question_id' => $target_question_id,
                    'target_parent_id' => $target_parent_id,
                    'image_source_path' => $image_source_path,
                    'image_target_path' => $image_target_path
                ]
            );
            return;
        }
 
        $src = opendir($image_source_path);
        while ($src_file = readdir($src)) {
            if ($src_file === '.' || $src_file === '..') {
                continue;
            }
            copy(
                $image_source_path . DIRECTORY_SEPARATOR . $src_file,
                $image_target_path . DIRECTORY_SEPARATOR . $src_file
            );
        }
    }

◆ deleteArea()

assImagemapQuestion::deleteArea ( int $index = 0 )

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

◆ deleteImage()

assImagemapQuestion::deleteImage ( )

Deletes the image file.

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

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

◆ flushAnswers()

assImagemapQuestion::flushAnswers ( )

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

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

◆ fromNormalized()

assImagemapQuestion::fromNormalized	(	array	$normalized,
		Transformations	$transformations
	)

Parameters

array<array-key,mixed> $normalized

Reimplemented from assQuestion.

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

     : static
    {
        $clone = parent::fromNormalized($normalized, $transformations);
        $clone->image_filename = $transformations->denormalize($normalized['image'], QuestionImage::class)->getFilename();
        $clone->is_multiple_choice = $transformations->bool($normalized['multiple_choice']);
        $clone->answers = array_map(
            static fn(array $answer): ASS_AnswerImagemap => $transformations->denormalize($answer, new ASS_AnswerImagemap()),
            $normalized['answers']
        );
 
        return $clone;
    }

◆ get_imagemap_contents()

assImagemapQuestion::get_imagemap_contents ( string $href = '#' )

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

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

                                            : string
    {
        return 'qpl_qst_imagemap';
    }

Referenced by saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

◆ getAddSolutionSelectionParameter()

assImagemapQuestion::getAddSolutionSelectionParameter ( )

protected

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

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

◆ getAnswer()

assImagemapQuestion::getAnswer ( int $index = 0 )

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

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

◆ getAnswerCount()

assImagemapQuestion::getAnswerCount ( )

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

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

◆ getAnswers()

& assImagemapQuestion::getAnswers ( )

Definition at line 403 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 608 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

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

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

◆ getCorrectSolutionForTextOutput()

assImagemapQuestion::getCorrectSolutionForTextOutput	(	int	$active_id,
		int	$pass
	)

Reimplemented from assQuestion.

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

                                                                              : array
    {
        return array_map(
            fn(ASS_AnswerImagemap $v): string => "{$v->getArea()}: {$v->getCoords()}"
                . "({$this->lng->txt('points')} "
                . "{$this->lng->txt('checked')}: {$v->getPoints()}, "
                . "{$this->lng->txt('unchecked')}: {$v->getPointsUnchecked()})",
            $this->getAnswers()
        );
    }

◆ getExpressionTypes()

assImagemapQuestion::getExpressionTypes ( )

Get all available expression types for a specific question.

Returns: array

Implements iQuestionCondition.

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

                                        : array
    {
        return [
            iQuestionCondition::PercentageResultExpression,
            iQuestionCondition::NumberOfResultExpression,
            iQuestionCondition::EmptyAnswerExpression,
            iQuestionCondition::ExclusiveResultExpression
        ];
    }

◆ getImageFilename()

assImagemapQuestion::getImageFilename ( )

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

                                      : string
    {
        return $this->image_filename;
    }

◆ getIsMultipleChoice()

assImagemapQuestion::getIsMultipleChoice ( )

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

Returns: bool

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

                                         : bool
    {
        return $this->is_multiple_choice;
    }

References $is_multiple_choice.

◆ getMaximumPoints()

assImagemapQuestion::getMaximumPoints ( )

Reimplemented from assQuestion.

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

Referenced by isComplete().

Here is the caller graph for this function:

◆ getOperators()

assImagemapQuestion::getOperators ( string $expression )

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

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

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

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

                                     : string
    {
        return 'assImagemapQuestion';
    }

◆ getRemoveSolutionSelectionParameter()

assImagemapQuestion::getRemoveSolutionSelectionParameter ( )

protected

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

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

◆ getReuseSolutionSelectionParameter()

assImagemapQuestion::getReuseSolutionSelectionParameter ( )

protected

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

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

◆ 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 617 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;
    }

◆ getTestOutputSolutions()

assImagemapQuestion::getTestOutputSolutions	(	$activeId,
		$pass
	)

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

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

◆ getUserQuestionResult()

assImagemapQuestion::getUserQuestionResult	(	int	$active_id,
		int	$pass
	)

Get the user solution for a question by active_id and the test pass.

Implements iQuestionCondition.

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

     : ilUserQuestionResult {
        $result = new ilUserQuestionResult($this, $active_id, $pass);
 
        $maxStep = $this->lookupMaxStep($active_id, $pass);
        if ($maxStep > 0) {
            $data = $this->db->queryF(
                'SELECT value1+1 as value1 FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND step = %s',
                ['integer', 'integer', 'integer', 'integer'],
                [$active_id, $pass, $this->getId(), $maxStep]
            );
        } else {
            $data = $this->db->queryF(
                'SELECT value1+1 as value1 FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND step IS NULL',
                ['integer', 'integer', 'integer'],
                [$active_id, $pass, $this->getId()]
            );
        }
 
        while ($row = $this->db->fetchAssoc($data)) {
            $result->addKeyValue($row['value1'], $row['value1']);
        }
 
        $points = $this->calculateReachedPoints($active_id, $pass);
        $max_points = $this->getMaximumPoints();
 
        $result->setReachedPercentage(($points / $max_points) * 100);
 
        return $result;
    }

◆ isAddSolutionSelectionRequest()

assImagemapQuestion::isAddSolutionSelectionRequest ( )

protected

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

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

◆ isComplete()

assImagemapQuestion::isComplete ( )

Reimplemented from assQuestion.

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

                                : bool
    {
        if ($this->title !== ''
            && $this->author
            && $this->question
            && $this->image_filename
            && $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 803 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 827 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 ( int $question_id )

Reimplemented from assQuestion.

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

                                                : void
    {
        $result = $this->db->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',
            ['integer'],
            [$question_id]
        );
        if ($result->numRows() == 1) {
            $data = $this->db->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(new ilAssQuestionLifecycle($data['lifecycle']));
            } catch (ilTestQuestionPoolInvalidArgumentException $e) {
                $this->setLifecycle(new ilAssQuestionLifecycle());
            }
 
            try {
                $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
            } catch (ilTestQuestionPoolException $e) {
            }
 
            $result = $this->db->queryF(
                'SELECT * FROM qpl_a_imagemap WHERE question_fi = %s ORDER BY aorder ASC',
                ['integer'],
                [$question_id]
            );
            if ($result->numRows() > 0) {
                while ($data = $this->db->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, Vendor\Package\$e, and ilRTE\_replaceMediaObjectImageSrc().

Here is the call graph for this function:

◆ saveAdditionalQuestionDataToDb()

assImagemapQuestion::saveAdditionalQuestionDataToDb ( )

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

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

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

                                                : void
    {
        $this->db->manipulateF(
            'DELETE FROM qpl_a_imagemap WHERE question_fi = %s',
            [ 'integer' ],
            [ $this->getId() ]
        );
 
        // Anworten wegschreiben
        foreach ($this->answers as $key => $value) {
            $answer_obj = $this->answers[$key];
            $answer_obj->setOrder($key);
            $next_id = $this->db->nextId('qpl_a_imagemap');
            $this->db->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)',
                [ 'integer', 'integer', 'text', 'float', 'integer', 'text', 'text', 'float' ],
                [ $next_id, $this->id, $answer_obj->getAnswertext(
                ), $answer_obj->getPoints(), $answer_obj->getOrder(
                ), $answer_obj->getCoords(), $answer_obj->getArea(
                ), $answer_obj->getPointsUnchecked() ]
            );
        }
    }

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

                                                                                   : 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 = [];
            }
 
            $solution[$this->request->int('selImage')] = $this->request->int('selImage');
        }
 
        $previewSession->setParticipantsSolution($solution);
    }

◆ saveToDb()

assImagemapQuestion::saveToDb ( ?int $original_id = null )

Reimplemented from assQuestion.

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

                                                      : void
    {
        $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	(	int	$active_id,
		?int	$pass = `null`,
		bool	$authorized = `true`
	)

Saves the learners input of the question to the database.

@access public

Parameters

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

Returns: boolean $status

Reimplemented from assQuestion.

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

     : bool {
        if (is_null($pass)) {
            $pass = ilObjTest::_getPass($active_id);
        }
 
        $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(
            function () use ($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);
                    return;
                }
 
                $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);
                    }
                    return;
                }
 
                if ($this->isRemoveSolutionSelectionRequest()) {
                    $selection = $this->getRemoveSolutionSelectionParameter();
                    $this->deleteSolutionRecordByValues($active_id, $pass, $authorized, [
                        'value1' => (int) $selection
                    ]);
                    return;
                }
 
                if (!$this->isAddSolutionSelectionRequest()) {
                    return;
                }
                $selection = $this->getAddSolutionSelectionParameter();
 
                if ($this->is_multiple_choice) {
                    $this->deleteSolutionRecordByValues($active_id, $pass, $authorized, [
                        'value1' => (int) $this->request->raw('selImage')
                    ]);
                } else {
                    $this->removeCurrentSolution($active_id, $pass, $authorized);
                }
 
                $this->saveCurrentSolution($active_id, $pass, $this->request->raw('selImage'), null, $authorized);
            }
        );
 
        return true;
    }

◆ setImageFilename()

assImagemapQuestion::setImageFilename ( string $image_filename )

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

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

◆ setIsMultipleChoice()

assImagemapQuestion::setIsMultipleChoice ( $is_multiple_choice )

Set true if the Imagemapquestion is a multiplechoice Question.

Parameters

bool $is_multiple_choice

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

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

References $is_multiple_choice.

◆ solutionValuesToLog()

assImagemapQuestion::solutionValuesToLog	(	AdditionalInformationGenerator	$additional_info,
		array	$solution_values
	)

protected

MUST convert the given solution values into an array or a string that can be stored in the log.

Language variables must be generated through the corresponding functions in the AdditionalInformationGenerator. If an array is returned it will be rendered into a line per array entry in the format "key: value". If the key exists as a language variable, it will be translated.

Reimplemented from assQuestion.

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

     : array {
        $parsed_solution = [];
        foreach ($this->getAnswers() as $id => $answer) {
            $value = $additional_info->getTagForLangVar('unchecked');
            foreach ($solution_values as $solution) {
                if ($solution['value1'] == $id) {
                    $value = $additional_info->getTagForLangVar('checked');
                    break;
                }
            }
            $parsed_solution["{$answer->getArea()}: {$answer->getCoords()}"] = $value;
        }
        return $parsed_solution;
    }

◆ solutionValuesToText()

assImagemapQuestion::solutionValuesToText ( array $solution_values )

MUST convert the given solution values into text.

If the text has multiple lines each line MUST be placed as an entry in an array.

Reimplemented from assQuestion.

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

                                                                : array
    {
        $parsed_solution = [];
        foreach ($this->getAnswers() as $id => $answer) {
            $value = $this->lng->txt('unchecked');
            foreach ($solution_values as $solution) {
                if ($solution['value1'] == $id) {
                    $value = $this->lng->txt('checked');
                    break;
                }
            }
            $parsed_solution[] = "{$answer->getArea()}: {$answer->getCoords()} ({$value})";
        }
        return $parsed_solution;
    }

◆ toJSON()

assImagemapQuestion::toJSON ( )

Returns a JSON representation of the question.

Reimplemented from assQuestion.

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

                            : string
    {
        $result = [];
        $result['id'] = $this->getId();
        $result['type'] = (string) $this->getQuestionType();
        $result['title'] = $this->getTitleForHTMLOutput();
        $result['question'] = $this->formatSAQuestion($this->getQuestion());
        $result['nr_of_tries'] = $this->getNrOfTries();
        $result['shuffle'] = $this->getShuffle();
        $result['is_multiple'] = $this->getIsMultipleChoice();
        $result['feedback'] = [
            '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 = [];
        $order = 0;
        foreach ($this->getAnswers() as $key => $answer_obj) {
            array_push($answers, [
                '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);
    }

◆ toLog()

assImagemapQuestion::toLog ( AdditionalInformationGenerator $additional_info )

MUST return an array of the question settings that can be stored in the log.

Language variables must be generated through the corresponding functions in the AdditionalInformationGenerator. If an array is returned it will be rendered into a line per array entry in the format "key: value". If the key exists as a language variable, it will be translated.

Reimplemented from assQuestion.

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

                                                                          : array
    {
        $result = [
            AdditionalInformationGenerator::KEY_QUESTION_TYPE => (string) $this->getQuestionType(),
            AdditionalInformationGenerator::KEY_QUESTION_TITLE => $this->getTitleForHTMLOutput(),
            AdditionalInformationGenerator::KEY_QUESTION_TEXT => $this->formatSAQuestion($this->getQuestion()),
            AdditionalInformationGenerator::KEY_QUESTION_SHUFFLE_ANSWER_OPTIONS => $additional_info
                ->getTrueFalseTagForBool($this->getShuffle()),
                AdditionalInformationGenerator::KEY_QUESTION_IMAGEMAP_MODE => $this->getIsMultipleChoice()
                ? $additional_info->getTagForLangVar('tst_imap_qst_mode_mc')
                : $additional_info->getTagForLangVar('tst_imap_qst_mode_sc'),
            AdditionalInformationGenerator::KEY_QUESTION_IMAGEMAP_IMAGE => $this->getImagePathWeb() . $this->getImageFilename(),
            AdditionalInformationGenerator::KEY_FEEDBACK => [
                AdditionalInformationGenerator::KEY_QUESTION_FEEDBACK_ON_INCOMPLETE => $this->formatSAQuestion(
                    $this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)
                ),
                AdditionalInformationGenerator::KEY_QUESTION_FEEDBACK_ON_COMPLETE => $this->formatSAQuestion(
                    $this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true)
                )
            ]
        ];
 
        $answers = [];
        $order = 0;
        foreach ($this->getAnswers() as $key => $answer_obj) {
            array_push($answers, [
                AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION => (string) $answer_obj->getAnswertext(),
                AdditionalInformationGenerator::KEY_QUESTION_POINTS_CHECKED => (float) $answer_obj->getPoints(),
                AdditionalInformationGenerator::KEY_QUESTION_POINTS_UNCHECKED => (float) $answer_obj->getPointsUnchecked(),
                AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION_ORDER => $order,
                AdditionalInformationGenerator::KEY_QUESTION_IMAGEMAP_ANSWER_OPTION_COORDS => $answer_obj->getCoords(),
                AdditionalInformationGenerator::KEY_FEEDBACK => $this->formatSAQuestion(
                    $this->feedbackOBJ->getSpecificAnswerFeedbackExportPresentation($this->getId(), 0, $key)
                )
            ]);
            $order++;
        }
        $result[AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTIONS] = $answers;
 
        return $result;
    }

◆ toNormalized()

assImagemapQuestion::toNormalized	(	Transformations	$transformations,
		array	$context = `[]`
	)

Parameters

array<string,mixed> $context

Returns: array<array-key, mixed>|float|bool|int|string|null

Reimplemented from assQuestion.

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

     : array|float|bool|int|string|null
    {
        return [
            ...$transformations->normalize(parent::toNormalized($transformations, $context)),
            'image' => $transformations->normalize(new QuestionImage($this->image_filename, $this->getId())),
            'multiple_choice' => $this->is_multiple_choice,
            'answers' => $transformations->normalize($this->answers),
        ];
    }

◆ uploadImageFile()

assImagemapQuestion::uploadImageFile	(	string	$upload_file_name,
		string	$upload_tmp_name
	)

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

     : void {
        $path_parts = pathinfo($upload_file_name);
        $suffix = $path_parts['extension'] ?? '';
 
        if (!in_array($path_parts['extension'], ['jpg', 'jpeg', 'png', 'gif'])) {
            $this->tpl->setOnScreenMessage('failure', 'The image could not be uploaded!');
            return;
        }
 
        $image_filename = bin2hex(random_bytes(10)) . ".{$suffix}";
 
        $imagepath = $this->getImagePath();
        if (!file_exists($imagepath)) {
            ilFileUtils::makeDirParents($imagepath);
        }
 
        if (!ilFileUtils::moveUploadedFile($upload_tmp_name, $image_filename, $imagepath . $image_filename)) {
            $this->tpl->setOnScreenMessage('failure', 'The image could not be uploaded!');
            return;
        }
 
        $this->setImageFilename($image_filename);
    }

◆ uploadImagemap()

assImagemapQuestion::uploadImagemap ( array $shapes )

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

Field Documentation

◆ $answers

array assImagemapQuestion::$answers

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

◆ $coords

array assImagemapQuestion::$coords

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

◆ $currentSolution

assImagemapQuestion::$currentSolution = []

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

◆ $image_filename

string assImagemapQuestion::$image_filename

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

Referenced by __construct().

◆ $imagemap_contents

string assImagemapQuestion::$imagemap_contents

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

◆ $is_multiple_choice

bool assImagemapQuestion::$is_multiple_choice = false

protected

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

Referenced by getIsMultipleChoice(), and setIsMultipleChoice().

◆ $request

RequestDataCollector assImagemapQuestion::$request

private

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

◆ AVAILABLE_SHAPES

const assImagemapQuestion::AVAILABLE_SHAPES

Initial value:

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

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

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

◆ MODE_MULTIPLE_CHOICE

const assImagemapQuestion::MODE_MULTIPLE_CHOICE = 1

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

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

◆ MODE_SINGLE_CHOICE

const assImagemapQuestion::MODE_SINGLE_CHOICE = 0

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

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

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

components/ILIAS/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()

◆ cloneQuestionTypeSpecificProperties()

◆ copyImagemapFiles()

◆ deleteArea()

◆ deleteImage()

◆ flushAnswers()

◆ fromNormalized()

◆ get_imagemap_contents()

◆ getAdditionalTableName()

◆ getAddSolutionSelectionParameter()

◆ getAnswer()

◆ getAnswerCount()

◆ getAnswers()

◆ getAnswerTableName()

◆ getAvailableAnswerOptions()

◆ getCorrectSolutionForTextOutput()

◆ getExpressionTypes()

◆ getImageFilename()

◆ getIsMultipleChoice()

◆ getMaximumPoints()

◆ getOperators()

◆ getQuestionType()

◆ getRemoveSolutionSelectionParameter()

◆ getReuseSolutionSelectionParameter()

◆ getRTETextWithMediaObjects()

◆ getTestOutputSolutions()

◆ getUserQuestionResult()

◆ isAddSolutionSelectionRequest()

◆ isComplete()

◆ isRemoveSolutionSelectionRequest()

◆ isReuseSolutionSelectionRequest()

◆ loadFromDb()

◆ saveAdditionalQuestionDataToDb()

◆ saveAnswerSpecificDataToDb()

◆ savePreviewData()

◆ saveToDb()

◆ saveWorkingData()

◆ setImageFilename()

◆ setIsMultipleChoice()

◆ solutionValuesToLog()

◆ solutionValuesToText()

◆ toJSON()

◆ toLog()

◆ toNormalized()

◆ uploadImageFile()

◆ uploadImagemap()

Field Documentation

◆ $answers

◆ $coords

◆ $currentSolution

◆ $image_filename

◆ $imagemap_contents

◆ $is_multiple_choice

◆ $request

◆ AVAILABLE_SHAPES

◆ MODE_MULTIPLE_CHOICE

◆ MODE_SINGLE_CHOICE