Class for multiple choice tests. More...

Inheritance diagram for assMultipleChoice:

Collaboration diagram for assMultipleChoice:

Public Member Functions
	setIsSingleline (bool $is_singleline)

	__construct (string $title="", string $comment="", string $author="", int $owner=-1, string $question="", private int $output_type=self::OUTPUT_ORDER)
	assMultipleChoice constructor More...

	getSelectionLimit ()

	setSelectionLimit (?int $selection_limit)

	isComplete ()

	saveToDb (?int $original_id=null)

	loadFromDb (int $question_id)

	addAnswer (string $answertext='', float $points=0.0, float $points_unchecked=0.0, int $order=0, ?string $answerimage=null, int $answer_id=-1)
	Adds a possible answer for a multiple choice question. More...

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

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

	deleteAnswer ($index=0)
	Deletes an answer with a given index. More...

	flushAnswers ()
	Deletes all answers. More...

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

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

	validateSolutionSubmit ()

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

	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...

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

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

	setImageFile ($image_filename, $image_tempfilename="")
	Sets the image file and uploads the image to the object's image directory. More...

	getRTETextWithMediaObjects ()

&	getAnswers ()
	Returns a reference to the answers array. More...

	setAnswers (array $answers)

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

	removeAnswerImage ($index)

	getMultilineAnswerSetting ()

	setMultilineAnswerSetting ($setting=0)

	setSpecificFeedbackSetting (int $feedback_setting)
	Sets the feedback settings in effect for the question. More...

	getSpecificFeedbackSetting ()
	Gets the current feedback settings in effect for the question. More...

	getSpecificFeedbackAllCorrectOptionLabel ()

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

	isSingleline ()

	toLog (AdditionalInformationGenerator $additional_info)

	solutionValuesToText (array $solution_values)

	getCorrectSolutionForTextOutput (int $active_id, int $pass)

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, array $solutionhints=[])

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

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

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

	duplicate (bool $for_test=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 ()

	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $preview_session, $reached_points)

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

	cloneHints (int $source_question_id, int $target_question_id)

	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)

	ensureHintPageObjectExists ($pageObjectId)

	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)

Public Member Functions inherited from iQuestionCondition
	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...

Data Fields
const	OUTPUT_ORDER = 0

const	OUTPUT_RANDOM = 1

array	$answers = []

bool	$is_singleline = true

int	$feedback_setting = 0

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)

	isForcedEmptySolution (array $solutionSubmit)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	getSolutionSubmit ()

	calculateReachedPointsForSolution (?array $found_values, int $active_id=0)

	buildTestPresentationConfig ()

	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)

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)

	duplicateQuestionHints (int $original_question_id, int $duplicate_question_id)

	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
int	$selection_limit = null

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

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

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

assMultipleChoice is a class for multiple choice questions.

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

Version: $Id$

Definition at line 42 of file class.assMultipleChoice.php.

Constructor & Destructor Documentation

◆ __construct()

assMultipleChoice::__construct	(	string	$title = `""`,
		string	$comment = `""`,
		string	$author = `""`,
		int	$owner = `-1`,
		string	$question = `""`,
		private int	$output_type = `self::OUTPUT_ORDER`
	)

assMultipleChoice constructor

The constructor takes possible arguments an creates an instance of the assMultipleChoice 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 multiple choice question
int \| string	$output_type	The output order of the multiple choice answers

See also: assQuestion:assQuestion()

Definition at line 73 of file class.assMultipleChoice.php.

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

       {
         parent::__construct($title, $comment, $author, $owner, $question);
         $this->answers = [];
         $this->shuffle = true;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addAnswer()

assMultipleChoice::addAnswer	(	string	$answertext = `''`,
		float	$points = `0.0`,
		float	$points_unchecked = `0.0`,
		int	$order = `0`,
		?string	$answerimage = `null`,
		int	$answer_id = `-1`
	)

Adds a possible answer for a multiple choice question.

A ASS_AnswerBinaryStateImage 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)
float	$points_unchecked	The points for not selecting the answer (even positive points can be used)
integer	$order	A possible display order of the answer
string	$answerimage
int	$answer_id	The Answer id used in the database

See also: $answers; ASS_AnswerBinaryStateImage

Definition at line 211 of file class.assMultipleChoice.php.

References assQuestion\$points, and assQuestion\getHtmlQuestionContentPurifier().

      : void {
         if (array_key_exists($order, $this->answers)) {
             // insert answer
             $answer = new ASS_AnswerMultipleResponseImage(
                 $this->getHtmlQuestionContentPurifier()->purify($answertext),
                 $points,
                 $order,
                 -1,
                 0
             );
             $answer->setPointsUnchecked($points_unchecked);
             $answer->setImage($answerimage);
             $newchoices = [];
             for ($i = 0; $i < $order; $i++) {
                 $newchoices[] = $this->answers[$i];
             }
             $newchoices[] = $answer;
             for ($i = $order, $iMax = count($this->answers); $i < $iMax; $i++) {
                 $changed = $this->answers[$i];
                 $changed->setOrder($i + 1);
                 $newchoices[] = $changed;
             }
             $this->answers = $newchoices;
             return;
         } else {
             $answer = new ASS_AnswerMultipleResponseImage(
                 $this->getHtmlQuestionContentPurifier()->purify($answertext),
                 $points,
                 count($this->answers),
                 $answer_id,
                 0
             );
             $answer->setPointsUnchecked($points_unchecked);
             $answer->setImage($answerimage);
             $this->answers[] = $answer;
         }
     }

Here is the call graph for this function:

◆ buildTestPresentationConfig()

assMultipleChoice::buildTestPresentationConfig ( )

protected

Definition at line 867 of file class.assMultipleChoice.php.

References ILIAS\Repository\lng().

                                                     : ilTestQuestionConfig
     {
         $config = parent::buildTestPresentationConfig();
         $config->setUseUnchangedAnswerLabel($this->lng->txt('tst_mc_label_none_above'));
         return $config;
     }

Here is the call graph for this function:

◆ calculateReachedPoints()

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

Definition at line 345 of file class.assMultipleChoice.php.

References $data, calculateReachedPointsForSolution(), assQuestion\getCurrentSolutionResultSet(), assQuestion\getSolutionMaxPass(), and null.

Referenced by getUserQuestionResult().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPointsForSolution()

assMultipleChoice::calculateReachedPointsForSolution	(	?array	$found_values,
		int	$active_id = `0`
	)

protected

Definition at line 782 of file class.assMultipleChoice.php.

References assQuestion\$points.

Referenced by calculateReachedPoints().

      : float {
         if ($found_values === []
             && $active_id !== 0) {
             return 0.0;
         }
 
         $found_values ??= [];
         $points = 0.0;
         foreach ($this->answers as $key => $answer) {
             if (in_array($key, $found_values)) {
                 $points += $answer->getPoints();
                 continue;
             }
             $points += $answer->getPointsUnchecked();
         }
 
         return $points;
     }

Here is the caller graph for this function:

◆ cloneQuestionTypeSpecificProperties()

assMultipleChoice::cloneQuestionTypeSpecificProperties ( \assQuestion $target )

protected

Definition at line 184 of file class.assMultipleChoice.php.

References getAnswers(), assQuestion\getId(), and assQuestion\getObjId().

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

Here is the call graph for this function:

◆ deleteAnswer()

assMultipleChoice::deleteAnswer ( $index = 0 )

Deletes 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

See also: $answers

Definition at line 297 of file class.assMultipleChoice.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;
         }
         $answer = $this->answers[$index];
         if ($answer->hasImage()) {
             $this->deleteImage($answer->getImage());
         }
         unset($this->answers[$index]);
         $this->answers = array_values($this->answers);
         for ($i = 0, $iMax = count($this->answers); $i < $iMax; $i++) {
             if ($this->answers[$i]->getOrder() > $index) {
                 $this->answers[$i]->setOrder($i);
             }
         }
     }

Here is the call graph for this function:

◆ flushAnswers()

assMultipleChoice::flushAnswers ( )

Deletes all answers.

See also: $answers

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

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

◆ getAdditionalTableName()

assMultipleChoice::getAdditionalTableName ( )

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

Returns: string The additional table name

Definition at line 574 of file class.assMultipleChoice.php.

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

                                             : string
     {
         return "qpl_qst_mc";
     }

Here is the caller graph for this function:

◆ getAnswer()

assMultipleChoice::getAnswer ( $index = 0 )

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_AnswerBinaryStateImage-Object containing the answer

See also: $answers

Definition at line 275 of file class.assMultipleChoice.php.

References null.

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

assMultipleChoice::getAnswerCount ( )

Returns the number of answers.

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

See also: $answers

Definition at line 262 of file class.assMultipleChoice.php.

Referenced by isComplete(), and validateSolutionSubmit().

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

Here is the caller graph for this function:

◆ getAnswers()

& assMultipleChoice::getAnswers ( )

Returns a reference to the answers array.

Definition at line 641 of file class.assMultipleChoice.php.

References $answers.

Referenced by cloneQuestionTypeSpecificProperties(), getAvailableAnswerOptions(), getCorrectSolutionForTextOutput(), getMaximumPoints(), getSolutionSubmit(), lmMigrateQuestionTypeSpecificContent(), solutionValuesToLog(), solutionValuesToText(), toJSON(), and toLog().

                                  : array
     {
         return $this->answers;
     }

Here is the caller graph for this function:

◆ getAnswerTableName()

assMultipleChoice::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns: string The answer table name

Definition at line 584 of file class.assMultipleChoice.php.

                                         : string
     {
         return "qpl_a_mc";
     }

◆ getAvailableAnswerOptions()

assMultipleChoice::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 858 of file class.assMultipleChoice.php.

References getAnswer(), getAnswers(), and null.

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

Here is the call graph for this function:

◆ getCorrectSolutionForTextOutput()

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

Definition at line 949 of file class.assMultipleChoice.php.

References getAnswers(), and ASS_AnswerSimple\getAnswertext().

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

Here is the call graph for this function:

◆ getExpressionTypes()

assMultipleChoice::getExpressionTypes ( )

Get all available expression types for a specific question.

Returns: array

Implements iQuestionCondition.

Definition at line 809 of file class.assMultipleChoice.php.

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

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

◆ getMaximumPoints()

assMultipleChoice::getMaximumPoints ( )

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

See also: $points

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

References getAnswers().

Referenced by getUserQuestionResult(), and isComplete().

                                       : float
     {
         $total_max_points = 0.0;
         foreach ($this->getAnswers() as $answer) {
             $total_max_points += max($answer->getPointsChecked(), $answer->getPointsUnchecked());
         }
         return $total_max_points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMultilineAnswerSetting()

assMultipleChoice::getMultilineAnswerSetting ( )

Definition at line 719 of file class.assMultipleChoice.php.

                                                : int
     {
         return $this->current_user->getPref('tst_multiline_answers') === '1' ? 1 : 0;
     }

◆ getOperators()

assMultipleChoice::getOperators ( string $expression )

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

Definition at line 804 of file class.assMultipleChoice.php.

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

◆ getQuestionType()

assMultipleChoice::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question

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

Referenced by toJSON(), and toLog().

                                      : string
     {
         return "assMultipleChoice";
     }

Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assMultipleChoice::getRTETextWithMediaObjects ( )

Definition at line 627 of file class.assMultipleChoice.php.

References assQuestion\getId().

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

Here is the call graph for this function:

◆ getSelectionLimit()

assMultipleChoice::getSelectionLimit ( )

Definition at line 86 of file class.assMultipleChoice.php.

References $selection_limit.

Referenced by saveAdditionalQuestionDataToDb(), toJSON(), toLog(), and validateSolutionSubmit().

                                        : ?int
     {
         return $this->selection_limit;
     }

Here is the caller graph for this function:

◆ getSolutionSubmit()

assMultipleChoice::getSolutionSubmit ( )

protected

Definition at line 766 of file class.assMultipleChoice.php.

References Vendor\Package\$a, $post, and getAnswers().

Referenced by saveWorkingData(), and validateSolutionSubmit().

                                           : array
     {
         $solutionSubmit = [];
         $post = $this->dic->http()->wrapper()->post();
 
         foreach ($this->getAnswers() as $index => $a) {
             if ($post->has("multiple_choice_result_$index")) {
                 $value = $post->retrieve("multiple_choice_result_$index", $this->dic->refinery()->kindlyTo()->string());
                 if (is_numeric($value)) {
                     $solutionSubmit[] = $value;
                 }
             }
         }
         return $solutionSubmit;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSpecificFeedbackAllCorrectOptionLabel()

assMultipleChoice::getSpecificFeedbackAllCorrectOptionLabel ( )

Implements ilAssSpecificFeedbackOptionLabelProvider.

Definition at line 761 of file class.assMultipleChoice.php.

                                                               : string
     {
         return 'feedback_correct_sc_mc';
     }

◆ getSpecificFeedbackSetting()

assMultipleChoice::getSpecificFeedbackSetting ( )

Gets the current feedback settings in effect for the question.

Values are: 1 - Feedback is shown for all answer options. 2 - Feedback is shown for all checked/selected options. 3 - Feedback is shown for all correct options.

Returns: integer

Definition at line 752 of file class.assMultipleChoice.php.

References $feedback_setting.

Referenced by saveAdditionalQuestionDataToDb().

                                                 : int
     {
         if ($this->feedback_setting) {
             return $this->feedback_setting;
         } else {
             return 1;
         }
     }

Here is the caller graph for this function:

◆ getUserQuestionResult()

assMultipleChoice::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 819 of file class.assMultipleChoice.php.

References $data, assQuestion\$points, calculateReachedPoints(), assQuestion\getId(), getMaximumPoints(), and assQuestion\lookupMaxStep().

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

Here is the call graph for this function:

◆ isComplete()

assMultipleChoice::isComplete ( )

Definition at line 96 of file class.assMultipleChoice.php.

References getAnswerCount(), and getMaximumPoints().

                                 : bool
     {
         return $this->title !== ''
             && $this->author !== ''
             && $this->question !== ''
             && $this->getAnswerCount() > 0
             && $this->getMaximumPoints() >= 0;
     }

Here is the call graph for this function:

◆ isForcedEmptySolution()

assMultipleChoice::isForcedEmptySolution ( array $solutionSubmit )

protected

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

Referenced by saveWorkingData().

                                                                    : bool
     {
         $tst_force_form_diff_input = $this->questionpool_request->strArray('tst_force_form_diff_input');
         return !count($solutionSubmit) && !empty($tst_force_form_diff_input);
     }

Here is the caller graph for this function:

◆ isSingleline()

assMultipleChoice::isSingleline ( )

Definition at line 874 of file class.assMultipleChoice.php.

References $is_singleline.

                                   : bool
     {
         return $this->is_singleline;
     }

◆ lmMigrateQuestionTypeSpecificContent()

assMultipleChoice::lmMigrateQuestionTypeSpecificContent ( ilAssSelfAssessmentMigrator $migrator )

protected

Parameters

ilAssSelfAssessmentMigrator $migrator

Definition at line 654 of file class.assMultipleChoice.php.

References getAnswers(), and ilAssSelfAssessmentMigrator\migrateToLmContent().

                                                                                                   : void
     {
         foreach ($this->getAnswers() as $answer) {
             /* @var ASS_AnswerBinaryStateImage $answer */
             $answer->setAnswertext($migrator->migrateToLmContent($answer->getAnswertext()));
         }
     }

Here is the call graph for this function:

◆ loadFromDb()

assMultipleChoice::loadFromDb ( int $question_id )

Definition at line 113 of file class.assMultipleChoice.php.

References $data, Vendor\Package\$e, assQuestion\$shuffle, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), assQuestion\getImagePath(), ilAssQuestionLifecycle\getInstance(), assQuestion\getMinimumThumbSize(), null, assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setId(), assQuestion\setLifecycle(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), setSelectionLimit(), assQuestion\setShuffle(), assQuestion\setThumbSize(), and assQuestion\setTitle().

                                                 : 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($data["title"] ?? '');
             $this->setNrOfTries($data['nr_of_tries']);
             $this->setComment($data["description"] ?? '');
             $this->setOriginalId($data["original_id"]);
             $this->setAuthor($data["author"]);
             $this->setPoints($data["points"]);
             $this->setOwner($data["owner"]);
             $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"] ?? '', 1));
             $shuffle = (is_null($data['shuffle'])) ? true : $data['shuffle'];
             $this->setShuffle((bool) $shuffle);
             if ($data['thumb_size'] !== null && $data['thumb_size'] >= $this->getMinimumThumbSize()) {
                 $this->setThumbSize($data['thumb_size']);
             }
             $this->is_singleline = $data['allow_images'] === null || $data['allow_images'] === '0';
             $this->lastChange = $data['tstamp'];
             $this->setSelectionLimit((int) $data['selection_limit'] > 0 ? (int) $data['selection_limit'] : null);
             if (isset($data['feedback_setting'])) {
                 $this->feedback_setting = $data['feedback_setting'];
             }
 
             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 = $this->db->queryF(
             "SELECT * FROM qpl_a_mc WHERE question_fi = %s ORDER BY aorder ASC",
             ['integer'],
             [$question_id]
         );
         if ($result->numRows() > 0) {
             while ($data = $this->db->fetchAssoc($result)) {
                 $imagefilename = $this->getImagePath() . $data["imagefile"];
                 if (!file_exists($imagefilename)) {
                     $data["imagefile"] = null;
                 }
                 $data["answertext"] = ilRTE::_replaceMediaObjectImageSrc($data["answertext"] ?? '', 1);
 
                 $answer = new ASS_AnswerMultipleResponseImage(
                     $data["answertext"],
                     $data["points"],
                     $data["aorder"],
                     $data["answer_id"]
                 );
                 $answer->setPointsUnchecked($data["points_unchecked"]);
                 $answer->setImage($data["imagefile"] ? $data["imagefile"] : null);
                 array_push($this->answers, $answer);
             }
         }
 
         parent::loadFromDb($question_id);
     }

Here is the call graph for this function:

◆ removeAnswerImage()

assMultipleChoice::removeAnswerImage ( $index )

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

References null.

                                              : void
     {
         $answer = $this->answers[$index];
         if (is_object($answer)) {
             $this->deleteImage($answer->getImage());
             $answer->setImage(null);
         }
     }

◆ saveAdditionalQuestionDataToDb()

assMultipleChoice::saveAdditionalQuestionDataToDb ( )

Saves a record to the question types additional data table.

Returns: mixed

Implements ilObjQuestionScoringAdjustable.

Definition at line 419 of file class.assMultipleChoice.php.

References ilFileUtils\delDir(), getAdditionalTableName(), assQuestion\getId(), assQuestion\getImagePath(), getSelectionLimit(), assQuestion\getShuffle(), getSpecificFeedbackSetting(), and assQuestion\getThumbSize().

Referenced by saveToDb().

     {
         if (!$this->is_singleline) {
             ilFileUtils::delDir($this->getImagePath());
         }
 
         // save additional data
         $this->db->replace(
             $this->getAdditionalTableName(),
             [
                 'shuffle' => ['text', $this->getShuffle()],
                 'allow_images' => ['text', $this->is_singleline ? 0 : 1],
                 'thumb_size' => ['integer', $this->getThumbSize()],
                 'selection_limit' => ['integer', $this->getSelectionLimit()],
                 'feedback_setting' => ['integer', $this->getSpecificFeedbackSetting()]
             ],
             ['question_fi' => ['integer', $this->getId()]]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAnswerSpecificDataToDb()

assMultipleChoice::saveAnswerSpecificDataToDb ( )

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

Returns: mixed

Implements ilObjAnswerScoringAdjustable.

Definition at line 439 of file class.assMultipleChoice.php.

References ilRTE\_replaceMediaObjectImageSrc(), assQuestion\getAdditionalContentEditingMode(), assQuestion\getId(), and null.

Referenced by saveToDb().

                                                 : void
     {
         // Get all feedback entries
         $result = $this->db->queryF(
             "SELECT * FROM qpl_fb_specific WHERE question_fi = %s",
             ['integer'],
             [$this->getId()]
         );
         $db_feedback = $this->db->fetchAll($result);
 
         // Check if feedback exists and the regular editor is used and not the page editor
         if (sizeof($db_feedback) >= 1 && $this->getAdditionalContentEditingMode() == 'default') {
             // Get all existing answer data for question
             $result = $this->db->queryF(
                 "SELECT answer_id, aorder  FROM qpl_a_mc WHERE question_fi = %s",
                 ['integer'],
                 [$this->getId()]
             );
             $db_answers = $this->db->fetchAll($result);
 
             // Collect old and new order entries by ids and order to calculate a diff/intersection and remove/update feedback
             $post_answer_order_for_id = [];
             foreach ($this->answers as $answer) {
                 // Only the first appearance of an id is used
                 if ($answer->getId() !== null && !in_array($answer->getId(), array_keys($post_answer_order_for_id))) {
                     // -1 is happening while import and also if a new multi line answer is generated
                     if ($answer->getId() == -1) {
                         continue;
                     }
                     $post_answer_order_for_id[$answer->getId()] = $answer->getOrder();
                 }
             }
 
             // If there is no usable ids from post, it's better to not touch the feedback
             // This is useful since the import is also using this function or the first creation of a new question in general
             if (sizeof($post_answer_order_for_id) >= 1) {
                 $db_answer_order_for_id = [];
                 $db_answer_id_for_order = [];
                 foreach ($db_answers as $db_answer) {
                     $db_answer_order_for_id[intval($db_answer['answer_id'])] = intval($db_answer['aorder']);
                     $db_answer_id_for_order[intval($db_answer['aorder'])] = intval($db_answer['answer_id']);
                 }
 
                 // Handle feedback
                 // the diff between the already existing answer ids from the Database and the answer ids from post
                 // feedback related to the answer ids should be deleted or in our case not recreated.
                 $db_answer_ids = array_keys($db_answer_order_for_id);
                 $post_answer_ids = array_keys($post_answer_order_for_id);
                 $diff_db_post_answer_ids = array_diff($db_answer_ids, $post_answer_ids);
                 $unused_answer_ids = array_keys($diff_db_post_answer_ids);
 
                 // Delete all feedback in the database
                 $this->feedbackOBJ->deleteSpecificAnswerFeedbacks($this->getId(), false);
                 // Recreate feedback
                 foreach ($db_feedback as $feedback_option) {
                     // skip feedback which answer is deleted
                     if (in_array(intval($feedback_option['answer']), $unused_answer_ids)) {
                         continue;
                     }
 
                     // Reorder feedback
                     $feedback_order_db = intval($feedback_option['answer']);
                     $db_answer_id = $db_answer_id_for_order[$feedback_order_db];
                     // This cuts feedback that currently would have no corresponding answer
                     // This case can happen while copying "broken" questions
                     // Or when saving a question with less answers than feedback
                     if (is_null($db_answer_id) || $db_answer_id < 0) {
                         continue;
                     }
                     $feedback_order_post = $post_answer_order_for_id[$db_answer_id];
                     $feedback_option['answer'] = $feedback_order_post;
 
                     // Recreate remaining feedback in database
                     $next_id = $this->db->nextId('qpl_fb_specific');
                     $this->db->manipulateF(
                         "INSERT INTO qpl_fb_specific (feedback_id, question_fi, answer, tstamp, feedback, question)
                             VALUES (%s, %s, %s, %s, %s, %s)",
                         ['integer', 'integer', 'integer', 'integer', 'text', 'integer'],
                         [
                             $next_id,
                             $feedback_option['question_fi'],
                             $feedback_option['answer'],
                             time(),
                             $feedback_option['feedback'],
                             $feedback_option['question']
                         ]
                     );
                 }
             }
         }
 
         // Delete all entries in qpl_a_mc for question
         $this->db->manipulateF(
             "DELETE FROM qpl_a_mc WHERE question_fi = %s",
             ['integer'],
             [$this->getId()]
         );
 
         // Recreate answers one by one
         foreach ($this->answers as $key => $value) {
             $answer_obj = $this->answers[$key];
             $next_id = $this->db->nextId('qpl_a_mc');
             $this->db->manipulateF(
                 "INSERT INTO qpl_a_mc (answer_id, question_fi, answertext, points, points_unchecked, aorder, imagefile, tstamp)
                         VALUES (%s, %s, %s, %s, %s, %s, %s, %s)",
                 ['integer', 'integer', 'text', 'float', 'float', 'integer', 'text', 'integer'],
                 [
                     $next_id,
                     $this->getId(),
                     ilRTE::_replaceMediaObjectImageSrc($answer_obj->getAnswertext(), 0),
                     $answer_obj->getPoints(),
                     $answer_obj->getPointsUnchecked(),
                     $answer_obj->getOrder(),
                     $answer_obj->getImage(),
                     time()
                 ]
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveToDb()

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

Definition at line 105 of file class.assMultipleChoice.php.

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

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

Here is the call graph for this function:

◆ saveWorkingData()

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

Definition at line 390 of file class.assMultipleChoice.php.

References ilObjTest\_getPass(), assQuestion\getProcessLocker(), getSolutionSubmit(), isForcedEmptySolution(), null, assQuestion\removeCurrentSolution(), and assQuestion\saveCurrentSolution().

      : bool {
         $pass = $pass ?? ilObjTest::_getPass($active_id);
 
         $answer = $this->getSolutionSubmit();
         $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(
             function () use ($answer, $active_id, $pass, $authorized) {
                 $this->removeCurrentSolution($active_id, $pass, $authorized);
 
                 foreach ($answer as $value) {
                     if ($value !== '') {
                         $this->saveCurrentSolution($active_id, $pass, $value, null, $authorized);
                     }
                 }
 
                 // fau: testNav - write a dummy entry for the evil mc questions with "None of the above" checked
                 if ($this->isForcedEmptySolution($answer)) {
                     $this->saveCurrentSolution($active_id, $pass, 'mc_none_above', null, $authorized);
                 }
                 // fau.
             }
         );
 
         return true;
     }

Here is the call graph for this function:

◆ setAnswers()

assMultipleChoice::setAnswers ( array $answers )

Definition at line 646 of file class.assMultipleChoice.php.

References $answers.

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

◆ setImageFile()

assMultipleChoice::setImageFile	(	$image_filename,
		$image_tempfilename = `""`
	)

Sets the image file and uploads the image to the object's image directory.

Parameters

string	$image_filename	Name of the original image file
string	$image_tempfilename	Name of the temporary uploaded image file

Returns: integer An errorcode if the image upload fails, 0 otherwise

Definition at line 596 of file class.assMultipleChoice.php.

References assQuestion\getImagePath(), ilObjMediaObject\getMimeType(), assQuestion\getThumbSize(), ilFileUtils\makeDirParents(), and ilFileUtils\moveUploadedFile().

                                                                            : int
     {
         $result = 0;
         if (!empty($image_tempfilename)) {
             $image_filename = str_replace(" ", "_", $image_filename);
             $imagepath = $this->getImagePath();
             if (!file_exists($imagepath)) {
                 ilFileUtils::makeDirParents($imagepath);
             }
             if (!ilFileUtils::moveUploadedFile($image_tempfilename, $image_filename, $imagepath . $image_filename)) {
                 $result = 2;
             } else {
                 $mimetype = ilObjMediaObject::getMimeType($imagepath . $image_filename);
                 if (!preg_match("/^image/", $mimetype)) {
                     unlink($imagepath . $image_filename);
                     $result = 1;
                 } else {
                     // create thumbnail file
                     if ($this->is_singleline && ($this->getThumbSize())) {
                         $this->generateThumbForFile(
                             $image_filename,
                             $this->getImagePath(),
                             $this->getThumbSize()
                         );
                     }
                 }
             }
         }
         return $result;
     }

Here is the call graph for this function:

◆ setIsSingleline()

assMultipleChoice::setIsSingleline ( bool $is_singleline )

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

References $is_singleline.

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

◆ setMultilineAnswerSetting()

assMultipleChoice::setMultilineAnswerSetting ( $setting = 0 )

Definition at line 724 of file class.assMultipleChoice.php.

                                                            : void
     {
         $this->current_user->writePref('tst_multiline_answers', (string) $setting);
     }

◆ setSelectionLimit()

assMultipleChoice::setSelectionLimit ( ?int $selection_limit )

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

References $selection_limit.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setSpecificFeedbackSetting()

assMultipleChoice::setSpecificFeedbackSetting ( int $feedback_setting )

Sets the feedback settings in effect for the question.

Options are: 1 - Feedback is shown for all answer options. 2 - Feedback is shown for all checked/selected options. 3 - Feedback is shown for all correct options.

Parameters

integer $a_feedback_setting

Definition at line 738 of file class.assMultipleChoice.php.

References $feedback_setting.

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

◆ solutionValuesToLog()

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

protected

Definition at line 910 of file class.assMultipleChoice.php.

References assQuestion\$id, getAnswers(), and ILIAS\Test\Logging\AdditionalInformationGenerator\getCheckedUncheckedTagForBool().

      : array {
         $solution_ids = array_map(
             static fn(array $v): string => $v['value1'],
             $solution_values
         );
         $parsed_solutions = [];
         foreach ($this->getAnswers() as $id => $answer) {
             $checked = false;
             if (in_array($id, $solution_ids)) {
                 $checked = true;
             }
             $parsed_solutions[$answer->getAnswertext()] = $additional_info
                 ->getCheckedUncheckedTagForBool($checked);
         }
         return $parsed_solutions;
     }

Here is the call graph for this function:

◆ solutionValuesToText()

assMultipleChoice::solutionValuesToText ( array $solution_values )

Definition at line 930 of file class.assMultipleChoice.php.

References getAnswers(), and ASS_AnswerSimple\getId().

                                                                 : array
     {
         $solution_ids = array_map(
             static fn(array $v): string => $v['value1'],
             $solution_values
         );
 
         return array_map(
             function (ASS_AnswerMultipleResponseImage $v) use ($solution_ids): string {
                 $checked = 'unchecked';
                 if (in_array($v->getId(), $solution_ids)) {
                     $checked = 'checked';
                 }
                 return "{$v->getAnswertext()} ({$this->lng->txt($checked)})";
             },
             $this->getAnswers()
         );
     }

Here is the call graph for this function:

◆ toJSON()

assMultipleChoice::toJSON ( )

Returns a JSON representation of the question.

Implements ILIAS\TestQuestionPool\Questions\QuestionLMExportable.

Definition at line 665 of file class.assMultipleChoice.php.

References $answers, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), getAnswers(), assQuestion\getId(), assQuestion\getImagePathWeb(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), getSelectionLimit(), assQuestion\getShuffle(), assQuestion\getThumbSize(), assQuestion\getTitleForHTMLOutput(), and ILIAS\Repository\int().

                             : 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['selection_limit'] = (int) $this->getSelectionLimit();
         $result['feedback'] = [
             'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
             'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
         ];
 
         $answers = [];
         $has_image = false;
         foreach ($this->getAnswers() as $key => $answer_obj) {
             if ((string) $answer_obj->getImage()) {
                 $has_image = true;
             }
             array_push($answers, [
                 "answertext" => $this->formatSAQuestion($answer_obj->getAnswertext()),
                 "points_checked" => (float) $answer_obj->getPointsChecked(),
                 "points_unchecked" => (float) $answer_obj->getPointsUnchecked(),
                 "order" => (int) $answer_obj->getOrder(),
                 "image" => (string) $answer_obj->getImage(),
                 "feedback" => $this->formatSAQuestion(
                     $this->feedbackOBJ->getSpecificAnswerFeedbackExportPresentation($this->getId(), 0, $key)
                 )
             ]);
         }
         $result['answers'] = $answers;
 
         if ($has_image) {
             $result['path'] = $this->getImagePathWeb();
             $result['thumb'] = $this->getThumbSize();
         }
 
         $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
         $result['mobs'] = $mobs;
 
         return json_encode($result);
     }

Here is the call graph for this function:

◆ toLog()

assMultipleChoice::toLog ( AdditionalInformationGenerator $additional_info )

Implements ILIAS\TestQuestionPool\Questions\Question.

Definition at line 879 of file class.assMultipleChoice.php.

References assQuestion\formatSAQuestion(), getAnswers(), assQuestion\getQuestion(), getQuestionType(), getSelectionLimit(), assQuestion\getShuffle(), assQuestion\getTitleForHTMLOutput(), ILIAS\Test\Logging\AdditionalInformationGenerator\getTrueFalseTagForBool(), and ILIAS\Repository\int().

                                                                           : 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()),
             'ass_mc_sel_lim_setting' => (int) $this->getSelectionLimit(),
             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))
             ]
         ];
 
         foreach ($this->getAnswers() as $key => $answer_obj) {
             $result[AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTIONS][$key + 1] = [
                 AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION => $this->formatSAQuestion($answer_obj->getAnswertext()),
                 AdditionalInformationGenerator::KEY_QUESTION_POINTS_CHECKED => (float) $answer_obj->getPointsChecked(),
                 AdditionalInformationGenerator::KEY_QUESTION_POINTS_UNCHECKED => (float) $answer_obj->getPointsUnchecked(),
                 AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION_ORDER => (int) $answer_obj->getOrder(),
                 AdditionalInformationGenerator::KEY_QUESTION_ANSWER_OPTION_IMAGE => (string) $answer_obj->getImage(),
                 AdditionalInformationGenerator::KEY_FEEDBACK => $this->formatSAQuestion(
                     $this->feedbackOBJ->getSpecificAnswerFeedbackExportPresentation($this->getId(), 0, $key)
                 )
             ];
         }
 
         return $result;
     }

Here is the call graph for this function:

◆ validateSolutionSubmit()

assMultipleChoice::validateSolutionSubmit ( )

Implements ILIAS\TestQuestionPool\Questions\Question.

Definition at line 364 of file class.assMultipleChoice.php.

References getAnswerCount(), getSelectionLimit(), getSolutionSubmit(), and ILIAS\Repository\lng().

                                             : bool
     {
         $submit = $this->getSolutionSubmit();
 
         if ($this->getSelectionLimit()) {
             if (count($submit) > $this->getSelectionLimit()) {
                 $failureMsg = sprintf(
                     $this->lng->txt('ass_mc_sel_lim_exhausted_hint'),
                     $this->getSelectionLimit(),
                     $this->getAnswerCount()
                 );
 
                 $this->tpl->setOnScreenMessage('failure', $failureMsg, true);
                 return false;
             }
         }
 
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $answers

array assMultipleChoice::$answers = []

Definition at line 49 of file class.assMultipleChoice.php.

Referenced by getAnswers(), setAnswers(), and toJSON().

◆ $feedback_setting

int assMultipleChoice::$feedback_setting = 0

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

Referenced by getSpecificFeedbackSetting(), and setSpecificFeedbackSetting().

◆ $is_singleline

bool assMultipleChoice::$is_singleline = true

Definition at line 50 of file class.assMultipleChoice.php.

Referenced by isSingleline(), and setIsSingleline().

◆ $selection_limit

int assMultipleChoice::$selection_limit = null

protected

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

Referenced by getSelectionLimit(), and setSelectionLimit().

◆ OUTPUT_ORDER

const assMultipleChoice::OUTPUT_ORDER = 0

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

◆ OUTPUT_RANDOM

const assMultipleChoice::OUTPUT_RANDOM = 1

Definition at line 47 of file class.assMultipleChoice.php.

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

components/ILIAS/TestQuestionPool/classes/class.assMultipleChoice.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAnswer()

◆ buildTestPresentationConfig()

◆ calculateReachedPoints()

◆ calculateReachedPointsForSolution()

◆ cloneQuestionTypeSpecificProperties()

◆ deleteAnswer()

◆ flushAnswers()

◆ getAdditionalTableName()

◆ getAnswer()

◆ getAnswerCount()

◆ getAnswers()

◆ getAnswerTableName()

◆ getAvailableAnswerOptions()

◆ getCorrectSolutionForTextOutput()

◆ getExpressionTypes()

◆ getMaximumPoints()

◆ getMultilineAnswerSetting()

◆ getOperators()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSelectionLimit()

◆ getSolutionSubmit()

◆ getSpecificFeedbackAllCorrectOptionLabel()

◆ getSpecificFeedbackSetting()

◆ getUserQuestionResult()

◆ isComplete()

◆ isForcedEmptySolution()

◆ isSingleline()

◆ lmMigrateQuestionTypeSpecificContent()

◆ loadFromDb()

◆ removeAnswerImage()

◆ saveAdditionalQuestionDataToDb()

◆ saveAnswerSpecificDataToDb()

◆ saveToDb()

◆ saveWorkingData()

◆ setAnswers()

◆ setImageFile()

◆ setIsSingleline()

◆ setMultilineAnswerSetting()

◆ setSelectionLimit()

◆ setSpecificFeedbackSetting()

◆ solutionValuesToLog()

◆ solutionValuesToText()

◆ toJSON()

◆ toLog()

◆ validateSolutionSubmit()

Field Documentation

◆ $answers

◆ $feedback_setting

◆ $is_singleline

◆ $selection_limit

◆ OUTPUT_ORDER

◆ OUTPUT_RANDOM