This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for assMultipleChoice:

Collaboration diagram for assMultipleChoice:

Public Member Functions
	setIsSingleline ($isSingleline)

	getIsSingleline ()

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

	getSelectionLimit ()

	setSelectionLimit ($selectionLimit)

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

	saveToDb ($original_id="")
	Saves a assMultipleChoice object to a database. More...

	getThumbPrefix ()

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

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

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

	createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")

	getOutputType ()
	Gets the multiple choice output type which is either OUTPUT_ORDER (=0) or OUTPUT_RANDOM (=1). More...

	setOutputType ($output_type=OUTPUT_ORDER)
	Sets the output type of the assMultipleChoice object. More...

	addAnswer ( $answertext="", $points=0.0, $points_unchecked=0.0, $order=0, $answerimage="", $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 ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
	Returns the points, a learner has reached answering the question. More...

	validateSolutionSubmit ()

	syncWithOriginal ()

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

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

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

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

	copyImages ($question_id, $source_questionpool)

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

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

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

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

	removeAnswerImage ($index)

	getMultilineAnswerSetting ()

	setMultilineAnswerSetting ($a_setting=0)

	setSpecificFeedbackSetting ($a_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 ()

	isAnswered (int $active_id, int $pass)
	returns boolean wether the question is answered during test pass or not More...

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

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

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

	isSingleline ()

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

	getShuffler ()

	setShuffler (Transformation $shuffler)

	setProcessLocker (ilAssQuestionProcessLocker $processLocker)

	getProcessLocker ()

	fromXML ($item, int $questionpool_id, ?int $tst_id, &$tst_object, int &$question_counter, array $import_mapping, array &$solutionhints=[])
	Receives parameters from a QTI parser and creates a valid ILIAS question object. More...

	toXML (bool $a_include_header=true, bool $a_include_binary=true, bool $a_shuffle=false, bool $test_output=false, bool $force_image_references=false)
	Returns a QTI xml representation of the question. More...

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

	questionTitleExists (int $questionpool_id, string $title)
	Returns TRUE if the question title exists in a question pool in the database. More...

	setTitle (string $title="")

	setId (int $id=-1)

	setTestId (int $id=-1)

	setComment (string $comment="")

	setOutputType (int $outputType=OUTPUT_HTML)

	setShuffle (?bool $shuffle=true)

	setAuthor (string $author="")

	setOwner (int $owner=-1)

	getTitle ()

	getTitleForHTMLOutput ()

	getTitleFilenameCompliant ()

	getId ()

	getShuffle ()

	getTestId ()

	getComment ()

	getDescriptionForHTMLOutput ()

	getThumbSize ()

	setThumbSize (int $a_size)

	getMinimumThumbSize ()

	getMaximumThumbSize ()

	getOutputType ()

	supportsJavascriptOutput ()

	supportsNonJsOutput ()

	requiresJsSwitch ()

	getAuthor ()

	getAuthorForHTMLOutput ()

	getOwner ()

	getObjId ()

	setObjId (int $obj_id=0)

	getLifecycle ()

	setLifecycle (ilAssQuestionLifecycle $lifecycle)

	setExternalId (?string $external_id)

	getExternalId ()

	getSuggestedSolutionOutput ()

	_getSuggestedSolution (int $question_id, int $subquestion_index=0)

	loadSuggestedSolution (int $question_id, int $subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...

	getSuggestedSolutions ()

	getReachedPoints (int $active_id, int $pass)

	getMaximumPoints ()

	getAdjustedReachedPoints (int $active_id, int $pass, bool $authorizedSolution=true)
	returns the reached points ... More...

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

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

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

	validateSolutionSubmit ()

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

	moveUploadedMediaFile (string $file, string $name)
	Move an uploaded media file to an public accessible temp dir to present it. More...

	getSuggestedSolutionPath ()

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

	buildImagePath ($questionId, $parentObjectId)

	getFlashPath ()
	Returns the image path for web accessable flash files of a question. More...

	getSuggestedSolutionPathWeb ()

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

	getTestOutputSolutions (int $activeId, int $pass)

	getUserSolutionPreferingIntermediate (int $active_id, $pass=null)

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

	isInUse (int $question_id=0)
	Checks whether the question is in use or not in pools or tests. More...

	usageNumber (int $question_id=0)
	Returns the number of place the question is in use in pools or tests. More...

	isClone (int $question_id=0)
	Checks whether the question is a clone of another question or not. More...

	getAdditionalTableName ()

	getAnswerTableName ()

	deleteAnswers (int $question_id)

	deleteAdditionalTableData (int $question_id)

	delete (int $question_id)

	getTotalAnswers ()

	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)

	syncXHTMLMediaObjectsOfQuestion ()

	createPageObject ()

	copyPageOfQuestion (int $a_q_id)

	getPageOfQuestion ()

	setOriginalId (?int $original_id)

	getOriginalId ()

	fixSvgToPng (string $imageFilenameContainingString)

	fixUnavailableSkinImageSources (string $html)

	loadFromDb (int $question_id)

	createNewQuestion (bool $a_create_page=true)
	Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...

	saveQuestionDataToDb (int $original_id=-1)

	saveToDb ()

	setNewOriginalId (int $newId)

	deleteSuggestedSolutions ()

	getSuggestedSolution (int $subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...

	getSuggestedSolutionTitle (int $subquestion_index=0)
	Returns the title of a suggested solution at a given subquestion_index. More...

	setSuggestedSolution (string $solution_id="", int $subquestion_index=0, bool $is_import=false)
	Sets a suggested solution for the question. More...

	updateSuggestedSolutions (int $original_id=-1, int $original_obj_id=-1)

	_resolveInternalLink (string $internal_link)

	_resolveIntLinks (int $question_id)

	syncWithOriginal ()

	_questionExists ($question_id)
	Returns true if the question already exists in the database. More...

	_questionExistsInPool (int $question_id)

	getPoints ()

	setPoints (float $points)

	getSolutionMaxPass (int $active_id)

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

	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $previewSession, $reachedPoints)

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)

	adjustReachedPointsByScoringOptions ($points, $active_id, $pass=null)
	Adjust the given reached points by checks for all special scoring options in the test container. More...

	isHTML ($a_text)
	Checks if a given string contains HTML or not. More...

	prepareTextareaOutput (string $txt_output, bool $prepare_for_latex_output=false, bool $omitNl2BrWhenTextArea=false)

	QTIMaterialToString (ilQTIMaterial $a_material)
	Reads an QTI material tag and creates a text or XHTML string. More...

	addQTIMaterial (ilXmlWriter $a_xml_writer, string $a_material, bool $close_material_tag=true, bool $add_mobs=true)

	buildHashedImageFilename (string $plain_image_filename, bool $unique=false)

	getQuestion ()

	getQuestionForHTMLOutput ()

	setQuestion (string $question="")

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

	getQuestionTypeID ()

	syncHints ()

	cleanupMediaObjectUsage ()

	getInstances ()

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

	hasSpecificFeedback ()

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

	__get ($value)
	Object getter. More...

	__set ($key, $value)
	Object setter. More...

	__isset ($key)
	Object issetter. More...

	getNrOfTries ()

	setNrOfTries (int $a_nr_of_tries)

	setExportImagePath (string $path)

	formatSAQuestion ($a_q)

	setPreventRteUsage (bool $prevent_rte_usage)

	getPreventRteUsage ()

	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)

	setSelfAssessmentEditingMode (bool $selfassessmenteditingmode)

	getSelfAssessmentEditingMode ()

	setDefaultNrOfTries (int $defaultnroftries)

	getDefaultNrOfTries ()

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

	ensureHintPageObjectExists ($pageObjectId)

	isAnswered (int $active_id, int $pass)

	isAutosaveable ()

	getAdditionalContentEditingMode ()

	setAdditionalContentEditingMode (?string $additionalContentEditingMode)

	isAdditionalContentEditingModePageObject ()

	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)

	getValidAdditionalContentEditingModes ()

	getHtmlUserSolutionPurifier ()

	getHtmlQuestionContentPurifier ()

	setLastChange ($lastChange)

	getLastChange ()

	removeIntermediateSolution (int $active_id, int $pass)

	removeCurrentSolution (int $active_id, int $pass, bool $authorized=true)

	saveCurrentSolution (int $active_id, int $pass, $value1, $value2, bool $authorized=true, $tstamp=0)

	updateCurrentSolution (int $solutionId, $value1, $value2, bool $authorized=true)

	updateCurrentSolutionsAuthorization (int $activeId, int $pass, bool $authorized, bool $keepTime=false)

	setStep ($step)

	getStep ()

	toJSON ()

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

	intermediateSolutionExists (int $active_id, int $pass)

	authorizedSolutionExists (int $active_id, ?int $pass)

	authorizedOrIntermediateSolutionExists (int $active_id, int $pass)

	lookupForExistingSolutions (int $activeId, int $pass)
	Lookup if an authorized or intermediate solution exists. More...

	isAddableAnswerOptionValue (int $qIndex, string $answerOptionValue)

	addAnswerOptionValue (int $qIndex, string $answerOptionValue, float $points)

	removeAllExistingSolutions ()

	removeExistingSolutions (int $activeId, int $pass)

	resetUsersAnswer (int $activeId, int $pass)

	removeResultRecord (int $activeId, int $pass)

	fetchValuePairsFromIndexedValues (array $indexedValues)

	fetchIndexedValuesFromValuePairs (array $valuePairs)

	areObligationsToBeConsidered ()

	setObligationsToBeConsidered (bool $obligationsToBeConsidered)

	updateTimestamp ()

	getTestPresentationConfig ()

	savePartial ()

	isInActiveTest ()

Public Member Functions inherited from ilObjQuestionScoringAdjustable
	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...

Public Member Functions inherited from ilObjAnswerScoringAdjustable
	saveAnswerSpecificDataToDb ()
	Saves the answer specific records into a question types answer table. More...

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

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

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

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

	getSpecificFeedbackAllCorrectOptionLabel ()

Data Fields
	$answers

	$output_type

	$isSingleline

	$lastChange

	$feedback_setting

Data Fields inherited from assQuestion
const	IMG_MIME_TYPE_JPG = 'image/jpeg'

const	IMG_MIME_TYPE_PNG = 'image/png'

const	IMG_MIME_TYPE_GIF = 'image/gif'

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

const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'

const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'

ilAssQuestionFeedback	$feedbackOBJ

bool	$prevent_rte_usage = false

bool	$selfassessmenteditingmode = false

int	$defaultnroftries = 0

string	$questionActionCmd = 'handleQuestionAction'

const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'

Data Fields inherited from iQuestionCondition
const	StringResultExpression = '~TEXT~'

const	PercentageResultExpression = '%n%'

const	NumericResultExpression = '#n#'

const	MatchingResultExpression = ';n:m;'

const	OrderingResultExpression = '$n,m,o,p$'

const	NumberOfResultExpression = '+n+'

const	ExclusiveResultExpression = 'n,m,o,p'

const	EmptyAnswerExpression = "?"

Protected Member Functions
	rebuildThumbnails ()
	Rebuild the thumbnail images with a new thumbnail size. More...

	generateThumbForFile ($path, $file)

	isForcedEmptySolution ($solutionSubmit)

	deleteImage ($image_filename)
	Deletes an image file. More...

	syncImages ()
	Sync images of a MC question on synchronisation with the original question. More...

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	getSolutionSubmit ()

	calculateReachedPointsForSolution ($found_values, $active_id=0)

	buildTestPresentationConfig ()
	build basic test question configuration instance More...

Protected Member Functions inherited from assQuestion
	getQuestionAction ()

	isNonEmptyItemListPostSubmission (string $postSubmissionFieldname)

	ensureCurrentTestPass (int $active_id, int $pass)

	lookupCurrentTestPass (int $active_id, int $pass)

	lookupTestId (int $active_id)
	@refactor Move to ilObjTest or similar More...

	log (int $active_id, string $langVar)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	deletePageOfQuestion (int $question_id)

	onDuplicate (int $originalParentId, int $originalQuestionId, int $duplicateParentId, int $duplicateQuestionId)

	beforeSyncWithOriginal (int $origQuestionId, int $dupQuestionId, int $origParentObjId, int $dupParentObjId)

	afterSyncWithOriginal (int $origQuestionId, int $dupQuestionId, int $origParentObjId, int $dupParentObjId)

	onCopy (int $sourceParentId, int $sourceQuestionId, int $targetParentId, int $targetQuestionId)

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

	syncSuggestedSolutionFiles (int $target_question_id, int $target_obj_id)

	copySuggestedSolutionFiles (int $source_questionpool_id, int $source_question_id)

	ensureNonNegativePoints ($points)

	purifyAndPrepareTextAreaOutput (string $content)

	getRTETextWithMediaObjects ()

	getSelfAssessmentFormatter ()

	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	duplicateQuestionHints (int $originalQuestionId, int $duplicateQuestionId)

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

	buildQuestionDataQuery ()

	getCurrentSolutionResultSet (int $active_id, int $pass, bool $authorized=true)

	removeSolutionRecordById (int $solutionId)

	getSolutionRecordById (int $solutionId)

	deleteDummySolutionRecord (int $activeId, int $passIndex)

	isDummySolutionRecord (array $solutionRecord)

	deleteSolutionRecordByValues (int $activeId, int $passIndex, bool $authorized, array $matchValues)

	duplicateIntermediateSolutionAuthorized (int $activeId, int $passIndex)

	forceExistingIntermediateSolution (int $activeId, int $passIndex, bool $considerDummyRecordCreation)

	lookupMaxStep (int $active_id, int $pass)

	buildTestPresentationConfig ()
	build basic test question configuration instance More...

Protected Attributes
	$selectionLimit

Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ILIAS DI LoggingServices	$ilLog

int	$id

string	$title

string	$comment

string	$owner

string	$author

int	$thumb_size

string	$question
	The question text. More...

float	$points
	The maximum available points for the question. More...

bool	$shuffle
	Indicates whether the answers will be shuffled or not. More...

int	$test_id
	The database id of a test in which the question is contained. More...

int	$obj_id = 0
	Object id of the container object. More...

	$ilias

ilGlobalPageTemplate	$tpl

ilLanguage	$lng

ilDBInterface	$db

Container	$dic

int	$outputType = OUTPUT_JAVASCRIPT
	Contains the output type of a question. More...

array	$suggested_solutions

int	$original_id = null

	$page

string	$external_id = null

ilAssQuestionProcessLocker	$processLocker

	$step

	$lastChange

Transformation	$shuffler

ilTestQuestionConfig	$testQuestionConfig

ilAssQuestionLifecycle	$lifecycle

ilObjUser	$current_user

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

static	isForcePassResultUpdateEnabled ()

static	isAllowedImageMimeType ($mimeType)

static	fetchMimeTypeIdentifier (string $contentType)

static	getAllowedFileExtensionsForMimeType (string $mimeType)

static	isAllowedImageFileExtension (string $mimeType, string $fileExtension)

static	getAllowedImageMaterialFileExtensions ()

static	_getMaximumPoints (int $question_id)
	Returns the maximum points, a learner can reach answering the question. More...

static	_getQuestionInfo (int $question_id)

static	_getSuggestedSolutionCount (int $question_id)

static	_getSuggestedSolutionOutput (int $question_id)

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

static	_updateTestResultCache (int $active_id, ilAssQuestionProcessLocker $processLocker=null)
	@TODO Move this to a proper place. More...

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

static	getQuestionTypeFromDb (int $question_id)

static	_getTotalRightAnswers (int $a_q_id)

static	_getTitle (int $a_q_id)

static	_getQuestionText (int $a_q_id)

static	isFileAvailable (string $file)

static	_getQuestionType (int $question_id)

static	_getQuestionTitle (int $question_id)

static	saveOriginalId (int $questionId, int $originalId)

static	resetOriginalId (int $questionId)

static	_getInternalLinkHref (string $target="")

static	_getOriginalId (int $question_id)

static	originalQuestionExists (int $questionId)

static	_instanciateQuestion (int $question_id)

static	_instantiateQuestion (int $question_id)

static	instantiateQuestion (int $question_id)

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

static	_isWriteable (int $question_id, int $user_id)

static	_isUsedInRandomTest (int $question_id)

static	_isWorkedThrough (int $active_id, int $question_id, int $pass)
	Returns true if the question was worked through in the given pass Worked through means that the user entered at least one value. More...

static	_areAnswered (int $a_user_id, array $a_question_ids)
	Checks if an array of question ids is answered by a user or not. More...

static	_setReachedPoints (int $active_id, int $question_id, float $points, float $maxpoints, int $pass, bool $manualscoring, bool $obligationsEnabled)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...

static	_needsManualScoring (int $question_id)

static	_includeClass (string $question_type, int $gui=0)

static	getFeedbackClassNameByQuestionType (string $questionType)

static	isCoreQuestionType (string $questionType)

static	includeCoreClass ($questionType, $withGuiClass)

static	_getQuestionTypeName ($type_tag)

static	_instanciateQuestionGUI (int $question_id)

static	instantiateQuestionGUI (int $a_question_id)

static	_questionExistsInTest (int $question_id, int $test_id)

static	lookupParentObjId (int $questionId)

static	lookupOriginalParentObjId (int $originalQuestionId)
	returns the parent object id for given original question id (should be a qpl id, but theoretically it can be a tst id, too) More...

static	isObligationPossible (int $questionId)

static	implodeKeyValues (array $keyValues)

static	explodeKeyValues (string $keyValues)

static	convertISO8601FormatH_i_s_ExtendedToSeconds (string $time)

static	missingResultRecordExists (int $activeId, int $pass, array $questionIds)

static	getQuestionsMissingResultRecord (int $activeId, int $pass, array $questionIds)

static	lookupResultRecordExist (int $activeId, int $questionId, int $pass)

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

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

Static Protected Attributes inherited from assQuestion
static	$allowedFileExtensionsByMimeType

static	$allowedCharsetsByMimeType

static	$allowedImageMaterialFileExtensionsByMimeType

static	$forcePassResultsUpdateEnabled = false

static	$imageSourceFixReplaceMap

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class for 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 36 of file class.assMultipleChoice.php.

Constructor & Destructor Documentation

◆ __construct()

assMultipleChoice::__construct	(	$title = `""`,
		$comment = `""`,
		$author = `""`,
		$owner = `-1`,
		$question = `""`,
		$output_type = `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 96 of file class.assMultipleChoice.php.

      {
        parent::__construct($title, $comment, $author, $owner, $question);
        $this->output_type = $output_type;
        $this->answers = array();
        $this->shuffle = 1;
        $this->selectionLimit = null;
        $this->feedback_setting = 0;
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addAnswer()

assMultipleChoice::addAnswer	(	$answertext = `""`,
		$points = `0.0`,
		$points_unchecked = `0.0`,
		$order = `0`,
		$answerimage = `""`,
		$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 444 of file class.assMultipleChoice.php.

     : void {
        $answertext = $this->getHtmlQuestionContentPurifier()->purify($answertext);
        if (array_key_exists($order, $this->answers)) {
            // insert answer
            $answer = new ASS_AnswerMultipleResponseImage($answertext, $points, $order, -1, 0);
            $answer->setPointsUnchecked($points_unchecked);
            $answer->setImage($answerimage);
            $newchoices = array();
            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;
        } else {
            $answer = new ASS_AnswerMultipleResponseImage($answertext, $points, count($this->answers), (int) $answer_id, 0);
            $answer->setPointsUnchecked($points_unchecked);
            $answer->setImage($answerimage);
            $this->answers[] = $answer;
        }
    }

References $i, and assQuestion\$points.

◆ buildTestPresentationConfig()

assMultipleChoice::buildTestPresentationConfig ( )

protected

build basic test question configuration instance

method can be overwritten to configure an instance use parent call for building when possible

Reimplemented from assQuestion.

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

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

References $config, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ calculateReachedPoints()

assMultipleChoice::calculateReachedPoints	(	$active_id,
		$pass = `null`,
		$authorizedSolution = `true`,
		$returndetails = `false`
	)

Returns the points, a learner has reached answering the question.

The points are calculated from the given answers.

Parameters

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

Exceptions

ilTestException

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

Reimplemented from assQuestion.

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

    {
        if ($returndetails) {
            throw new ilTestException('return details not implemented for ' . __METHOD__);
        }
 
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $found_values = array();
        if (is_null($pass)) {
            $pass = $this->getSolutionMaxPass($active_id);
        }
        $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);
        while ($data = $ilDB->fetchAssoc($result)) {
            if (strcmp($data["value1"], "") != 0) {
                array_push($found_values, $data["value1"]);
            }
        }
 
        $points = $this->calculateReachedPointsForSolution($found_values, $active_id);
 
        return $points;
    }

References $data, $DIC, and $ilDB.

◆ calculateReachedPointsForSolution()

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

protected

Parameters

$found_values
$active_id

Returns: float

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

                                                                                       : float
    {
        if ($found_values == null) {
            $found_values = [];
        }
        $points = 0;
        foreach ($this->answers as $key => $answer) {
            if (in_array($key, $found_values)) {
                $points += $answer->getPoints();
            } else {
                $points += $answer->getPointsUnchecked();
            }
        }
        if ($active_id) {
            if (count($found_values) == 0) {
                $points = 0;
            }
        }
        return $points;
    }

References ILIAS\LTI\ToolProvider\$key.

◆ copyImages()

assMultipleChoice::copyImages	(	$question_id,
		$source_questionpool
	)

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

                                                                  : void
    {
        global $DIC;
        $ilLog = $DIC['ilLog'];
        $imagepath = $this->getImagePath();
        $imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
        $imagepath_original = str_replace("/$this->obj_id/", "/$source_questionpool/", $imagepath_original);
        foreach ($this->answers as $answer) {
            $filename = $answer->getImage();
            if (strlen($filename)) {
                if (!file_exists($imagepath)) {
                    ilFileUtils::makeDirParents($imagepath);
                }
                if (!@copy($imagepath_original . $filename, $imagepath . $filename)) {
                    $ilLog->write("image could not be duplicated!!!!", $ilLog->ERROR);
                    $ilLog->write("object: " . print_r($this, true), $ilLog->ERROR);
                }
                if (@file_exists($imagepath_original . $this->getThumbPrefix() . $filename)) {
                    if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename)) {
                        $ilLog->write("image thumbnail could not be duplicated!!!!", $ilLog->ERROR);
                        $ilLog->write("object: " . print_r($this, true), $ilLog->ERROR);
                    }
                }
            }
        }
    }

References $DIC, $filename, and ilFileUtils\makeDirParents().

Here is the call graph for this function:

◆ copyObject()

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

Copies an assMultipleChoice object.

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

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

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

Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

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

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

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

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

Here is the call graph for this function:

◆ 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 518 of file class.assMultipleChoice.php.

                                            : void
    {
        if ($index < 0) {
            return;
        }
        if (count($this->answers) < 1) {
            return;
        }
        if ($index >= count($this->answers)) {
            return;
        }
        $answer = $this->answers[$index];
        if (strlen($answer->getImage())) {
            $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);
            }
        }
    }

References $i, and $index.

◆ deleteImage()

assMultipleChoice::deleteImage ( $image_filename )

protected

Deletes an image file.

Parameters

string $image_filename Name of the image file to delete

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

                                                   : void
    {
        $imagepath = $this->getImagePath();
        @unlink($imagepath . $image_filename);
        $thumbpath = $imagepath . $this->getThumbPrefix() . $image_filename;
        @unlink($thumbpath);
    }

◆ duplicate()

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

Duplicates an assMultipleChoiceQuestion.

Reimplemented from assQuestion.

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

                                                                                                                                    : int
    {
        if ($this->id <= 0) {
            // The question has not been saved. It cannot be duplicated
            return -1;
        }
        // duplicate the question in database
        $this_id = $this->getId();
        $thisObjId = $this->getObjId();
 
        $clone = $this;
        include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
        $original_id = assQuestion::_getOriginalId($this->id);
        $clone->id = -1;
 
        if ((int) $testObjId > 0) {
            $clone->setObjId($testObjId);
        }
 
        if ($title) {
            $clone->setTitle($title);
        }
 
        if ($author) {
            $clone->setAuthor($author);
        }
        if ($owner) {
            $clone->setOwner($owner);
        }
 
        if ($for_test) {
            $clone->saveToDb($original_id);
        } else {
            $clone->saveToDb();
        }
 
        // copy question page content
        $clone->copyPageOfQuestion($this_id);
        // copy XHTML media objects
        $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
        // duplicate the images
        $clone->duplicateImages($this_id, $thisObjId);
 
        $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
 
        return $clone->id;
    }

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

Here is the call graph for this function:

◆ flushAnswers()

assMultipleChoice::flushAnswers ( )

Deletes all answers.

See also: $answers

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

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

◆ generateThumbForFile()

assMultipleChoice::generateThumbForFile	(	$path,
		$file
	)

protected

Parameters

$path	string
$file	string

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

                                                         : void
    {
        $filename = $path . $file;
        if (@file_exists($filename)) {
            $thumbpath = $path . $this->getThumbPrefix() . $file;
            $path_info = @pathinfo($filename);
            $ext = "";
            switch (strtoupper($path_info['extension'])) {
                case 'PNG':
                    $ext = 'PNG';
                    break;
                case 'GIF':
                    $ext = 'GIF';
                    break;
                default:
                    $ext = 'JPEG';
                    break;
            }
            ilShellUtil::convertImage($filename, $thumbpath, $ext, $this->getThumbSize());
        }
    }

References $filename, $path, ilShellUtil\convertImage(), getThumbPrefix(), and assQuestion\getThumbSize().

Referenced by rebuildThumbnails().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdditionalTableName()

assMultipleChoice::getAdditionalTableName ( )

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

Returns: string The additional table name

Reimplemented from assQuestion.

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

                                            : string
    {
        return "qpl_qst_mc";
    }

Referenced by loadFromDb().

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

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

References $index.

◆ getAnswerCount()

assMultipleChoice::getAnswerCount ( )

Returns the number of answers.

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

See also: $answers

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

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

◆ getAnswers()

& assMultipleChoice::getAnswers ( )

Returns a reference to the answers array.

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

                                 : array
    {
        return $this->answers;
    }

Referenced by rebuildThumbnails().

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

Reimplemented from assQuestion.

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

Implements iQuestionCondition.

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

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

References $index.

◆ getExpressionTypes()

assMultipleChoice::getExpressionTypes ( )

Get all available expression types for a specific question.

Returns: array

Implements iQuestionCondition.

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

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

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

◆ getIsSingleline()

assMultipleChoice::getIsSingleline ( )

Returns: mixed

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

    {
        return $this->isSingleline;
    }

References $isSingleline.

◆ getMaximumPoints()

assMultipleChoice::getMaximumPoints ( )

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

See also: $points

Reimplemented from assQuestion.

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

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

References ILIAS\LTI\ToolProvider\$key.

Referenced by isComplete().

Here is the caller graph for this function:

◆ getMultilineAnswerSetting()

assMultipleChoice::getMultilineAnswerSetting ( )

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

                                               : int
    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
 
        $multilineAnswerSetting = $ilUser->getPref("tst_multiline_answers");
        if ($multilineAnswerSetting != 1) {
            $multilineAnswerSetting = 0;
        }
        return $multilineAnswerSetting;
    }

References $DIC, and $ilUser.

◆ getOperators()

assMultipleChoice::getOperators ( $expression )

Get all available operations for a specific question.

Parameters

string $expression

Implements iQuestionCondition.

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

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

References ilOperatorsExpressionMapping\getOperatorsByExpression().

Here is the call graph for this function:

◆ getOutputType()

assMultipleChoice::getOutputType ( )

Gets the multiple choice output type which is either OUTPUT_ORDER (=0) or OUTPUT_RANDOM (=1).

Returns: integer The output type of the assMultipleChoice object

See also: $output_type

Reimplemented from assQuestion.

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

                                   : int
    {
        return $this->output_type;
    }

References $output_type.

◆ getQuestionType()

assMultipleChoice::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question

Reimplemented from assQuestion.

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

                                     : string
    {
        return "assMultipleChoice";
    }

◆ getRTETextWithMediaObjects()

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

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

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

Here is the call graph for this function:

◆ getSelectionLimit()

assMultipleChoice::getSelectionLimit ( )

Returns: int

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

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

References $selectionLimit.

◆ getSolutionSubmit()

assMultipleChoice::getSolutionSubmit ( )

protected

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

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

References Vendor\Package\$a, $index, and $post.

◆ getSpecificFeedbackAllCorrectOptionLabel()

assMultipleChoice::getSpecificFeedbackAllCorrectOptionLabel ( )

Implements ilAssSpecificFeedbackOptionLabelProvider.

Definition at line 1241 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 1232 of file class.assMultipleChoice.php.

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

◆ getThumbPrefix()

assMultipleChoice::getThumbPrefix ( )

Returns: string

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

                                    : string
    {
        return "thumb.";
    }

Referenced by generateThumbForFile().

Here is the caller graph for this function:

◆ isAnswered()

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

returns boolean wether the question is answered during test pass or not

(overwrites method in class assQuestion)

Parameters

integer	$active_id
integer	$pass

Returns: boolean $answered

Reimplemented from assQuestion.

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

                                                         : bool
    {
        $numExistingSolutionRecords = assQuestion::getNumExistingSolutionRecords($active_id, $pass, $this->getId());
 
        return $numExistingSolutionRecords > 0;
    }

References ILIAS\Survey\Mode\getId(), and assQuestion\getNumExistingSolutionRecords().

Here is the call graph for this function:

◆ isComplete()

assMultipleChoice::isComplete ( )

Returns true, if a multiple choice question is complete for use.

Returns: boolean True, if the multiple choice question is complete for use, otherwise false @access public

Reimplemented from assQuestion.

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

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

References getMaximumPoints().

Here is the call graph for this function:

◆ isForcedEmptySolution()

assMultipleChoice::isForcedEmptySolution ( $solutionSubmit )

protected

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

                                                             : bool
    {
        if (!count($solutionSubmit) && !empty($_POST['tst_force_form_diff_input'])) {
            return true;
        }
 
        return false;
    }

◆ isSingleline()

assMultipleChoice::isSingleline ( )

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

                                  : bool
    {
        return (bool) $this->isSingleline;
    }

Referenced by loadFromDb(), rebuildThumbnails(), and setIsSingleline().

Here is the caller graph for this function:

◆ lmMigrateQuestionTypeSpecificContent()

assMultipleChoice::lmMigrateQuestionTypeSpecificContent ( ilAssSelfAssessmentMigrator $migrator )

protected

Parameters

ilAssSelfAssessmentMigrator $migrator

Reimplemented from assQuestion.

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

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

References ilAssSelfAssessmentMigrator\migrateToLmContent().

Here is the call graph for this function:

◆ loadFromDb()

assMultipleChoice::loadFromDb ( $question_id )

Loads a assMultipleChoice object from a database.

Parameters

integer $question_id A unique key which defines the multiple choice test in the database

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

                                            : void
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $hasimages = 0;
 
        $result = $ilDB->queryF(
            "SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
            array("integer"),
            array($question_id)
        );
        if ($result->numRows() == 1) {
            $data = $ilDB->fetchAssoc($result);
            $this->setId($question_id);
            $this->setObjId($data["obj_fi"]);
            $this->setTitle($data["title"] ?? '');
            $this->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"]);
            include_once("./Services/RTE/classes/class.ilRTE.php");
            $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->isSingleline = $data['allow_images'] === null || $data['allow_images'] === '0';
            $this->lastChange = $data['tstamp'];
            $this->setSelectionLimit((int) $data['selection_limit'] > 0 ? (int) $data['selection_limit'] : null);
            $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 = $ilDB->queryF(
            "SELECT * FROM qpl_a_mc WHERE question_fi = %s ORDER BY aorder ASC",
            array('integer'),
            array($question_id)
        );
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMultipleResponseImage.php";
        if ($result->numRows() > 0) {
            while ($data = $ilDB->fetchAssoc($result)) {
                $imagefilename = $this->getImagePath() . $data["imagefile"];
                if (!@file_exists($imagefilename)) {
                    $data["imagefile"] = "";
                }
                include_once("./Services/RTE/classes/class.ilRTE.php");
                $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"]);
                array_push($this->answers, $answer);
            }
        }
 
        parent::loadFromDb($question_id);
    }

References $data, $DIC, Vendor\Package\$e, $ilDB, assQuestion\$shuffle, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), assQuestion\getImagePath(), ilAssQuestionLifecycle\getInstance(), assQuestion\getMinimumThumbSize(), isSingleline(), 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().

Here is the call graph for this function:

◆ rebuildThumbnails()

assMultipleChoice::rebuildThumbnails ( )

protected

Rebuild the thumbnail images with a new thumbnail size.

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

                                          : void
    {
        if ($this->isSingleline && ($this->getThumbSize())) {
            foreach ($this->getAnswers() as $answer) {
                if (strlen($answer->getImage())) {
                    $this->generateThumbForFile($this->getImagePath(), $answer->getImage());
                }
            }
        }
    }

References generateThumbForFile(), getAnswers(), assQuestion\getImagePath(), assQuestion\getThumbSize(), and isSingleline().

Here is the call graph for this function:

◆ removeAnswerImage()

assMultipleChoice::removeAnswerImage ( $index )

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

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

References $index.

◆ saveToDb()

assMultipleChoice::saveToDb ( $original_id = "" )

Saves a assMultipleChoice object to a database.

Parameters

string $original_id

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

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

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

Here is the call graph for this function:

◆ setExportDetailsXLS()

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

{}

Reimplemented from assQuestion.

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

                                                                                                                    : int
    {
        parent::setExportDetailsXLS($worksheet, $startrow, $active_id, $pass);
 
        $solution = $this->getSolutionValues($active_id, $pass);
 
        $i = 1;
        foreach ($this->getAnswers() as $id => $answer) {
            $worksheet->setCell($startrow + $i, 0, $answer->getAnswertext());
            $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
            $checked = false;
            foreach ($solution as $solutionvalue) {
                if ($id == $solutionvalue["value1"]) {
                    $checked = true;
                }
            }
            if ($checked) {
                $worksheet->setCell($startrow + $i, 2, 1);
            } else {
                $worksheet->setCell($startrow + $i, 2, 0);
            }
            $i++;
        }
 
        return $startrow + $i + 1;
    }

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

Here is the call graph for this function:

◆ 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 912 of file class.assMultipleChoice.php.

                                                                           : 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 {
                include_once "./Services/MediaObjects/classes/class.ilObjMediaObject.php";
                $mimetype = ilObjMediaObject::getMimeType($imagepath . $image_filename);
                if (!preg_match("/^image/", $mimetype)) {
                    unlink($imagepath . $image_filename);
                    $result = 1;
                } else {
                    // create thumbnail file
                    if ($this->isSingleline && ($this->getThumbSize())) {
                        $this->generateThumbForFile($imagepath, $image_filename);
                    }
                }
            }
        }
        return $result;
    }

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

Here is the call graph for this function:

◆ setIsSingleline()

assMultipleChoice::setIsSingleline ( $isSingleline )

Parameters

mixed $isSingleline

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

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

References $isSingleline, and isSingleline().

Here is the call graph for this function:

◆ setMultilineAnswerSetting()

assMultipleChoice::setMultilineAnswerSetting ( $a_setting = 0 )

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

                                                             : void
    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        $ilUser->writePref("tst_multiline_answers", $a_setting);
    }

References $DIC, and $ilUser.

◆ setOutputType()

assMultipleChoice::setOutputType ( $output_type = OUTPUT_ORDER )

Sets the output type of the assMultipleChoice object.

Parameters

int | string $output_type A nonnegative integer value specifying the output type. It is OUTPUT_ORDER (=0) or OUTPUT_RANDOM (=1).

See also: $response

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

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

References $output_type.

◆ setSelectionLimit()

assMultipleChoice::setSelectionLimit ( $selectionLimit )

Parameters

int $selectionLimit

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

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

References $selectionLimit.

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ setSpecificFeedbackSetting()

assMultipleChoice::setSpecificFeedbackSetting ( $a_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 1218 of file class.assMultipleChoice.php.

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

◆ syncImages()

assMultipleChoice::syncImages ( )

protected

Sync images of a MC question on synchronisation with the original question.

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

                                   : void
    {
        global $DIC;
        $ilLog = $DIC['ilLog'];
        $imagepath = $this->getImagePath();
        $question_id = $this->getOriginalId();
        $originalObjId = parent::lookupParentObjId($this->getOriginalId());
        $imagepath_original = $this->getImagePath($question_id, $originalObjId);
 
        ilFileUtils::delDir($imagepath_original);
        foreach ($this->answers as $answer) {
            $filename = $answer->getImage();
            if (strlen($filename)) {
                if (@file_exists($imagepath . $filename)) {
                    if (!file_exists($imagepath)) {
                        ilFileUtils::makeDirParents($imagepath);
                    }
                    if (!file_exists($imagepath_original)) {
                        ilFileUtils::makeDirParents($imagepath_original);
                    }
                    if (!@copy($imagepath . $filename, $imagepath_original . $filename)) {
                        $ilLog->write("image could not be duplicated!!!!", $ilLog->ERROR);
                        $ilLog->write("object: " . print_r($this, true), $ilLog->ERROR);
                    }
                }
                if (@file_exists($imagepath . $this->getThumbPrefix() . $filename)) {
                    if (!@copy($imagepath . $this->getThumbPrefix() . $filename, $imagepath_original . $this->getThumbPrefix() . $filename)) {
                        $ilLog->write("image thumbnail could not be duplicated!!!!", $ilLog->ERROR);
                        $ilLog->write("object: " . print_r($this, true), $ilLog->ERROR);
                    }
                }
            }
        }
    }

References $DIC, $filename, ilFileUtils\delDir(), and ilFileUtils\makeDirParents().

Here is the call graph for this function:

◆ syncWithOriginal()

assMultipleChoice::syncWithOriginal ( )

Reimplemented from assQuestion.

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

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

◆ toJSON()

assMultipleChoice::toJSON ( )

Returns a JSON representation of the question.

Reimplemented from assQuestion.

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

                            : string
    {
        require_once './Services/RTE/classes/class.ilRTE.php';
        $result = array();
        $result['id'] = $this->getId();
        $result['type'] = (string) $this->getQuestionType();
        $result['title'] = $this->getTitleForHTMLOutput();
        $result['question'] = $this->formatSAQuestion($this->getQuestion());
        $result['nr_of_tries'] = $this->getNrOfTries();
        $result['shuffle'] = $this->getShuffle();
        $result['selection_limit'] = (int) $this->getSelectionLimit();
        $result['feedback'] = array(
            'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
            'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
        );
 
        $answers = array();
        $has_image = false;
        foreach ($this->getAnswers() as $key => $answer_obj) {
            if ((string) $answer_obj->getImage()) {
                $has_image = true;
            }
            array_push($answers, array(
                "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);
    }

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

Here is the call graph for this function:

◆ validateSolutionSubmit()

assMultipleChoice::validateSolutionSubmit ( )

Reimplemented from assQuestion.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

Field Documentation

◆ $answers

assMultipleChoice::$answers

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

◆ $feedback_setting

assMultipleChoice::$feedback_setting

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

◆ $isSingleline

assMultipleChoice::$isSingleline

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

Referenced by getIsSingleline(), and setIsSingleline().

◆ $lastChange

assMultipleChoice::$lastChange

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

◆ $output_type

assMultipleChoice::$output_type

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

Referenced by __construct(), getOutputType(), and setOutputType().

◆ $selectionLimit

assMultipleChoice::$selectionLimit

protected

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

Referenced by getSelectionLimit(), and setSelectionLimit().

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

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

◆ copyImages()

◆ copyObject()

◆ createNewOriginalFromThisDuplicate()

◆ deleteAnswer()

◆ deleteImage()

◆ duplicate()

◆ flushAnswers()

◆ generateThumbForFile()

◆ getAdditionalTableName()

◆ getAnswer()

◆ getAnswerCount()

◆ getAnswers()

◆ getAnswerTableName()

◆ getAvailableAnswerOptions()

◆ getExpressionTypes()

◆ getIsSingleline()

◆ getMaximumPoints()

◆ getMultilineAnswerSetting()

◆ getOperators()

◆ getOutputType()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSelectionLimit()

◆ getSolutionSubmit()

◆ getSpecificFeedbackAllCorrectOptionLabel()

◆ getSpecificFeedbackSetting()

◆ getThumbPrefix()

◆ isAnswered()

◆ isComplete()

◆ isForcedEmptySolution()

◆ isSingleline()

◆ lmMigrateQuestionTypeSpecificContent()

◆ loadFromDb()

◆ rebuildThumbnails()

◆ removeAnswerImage()

◆ saveToDb()

◆ setExportDetailsXLS()

◆ setImageFile()

◆ setIsSingleline()

◆ setMultilineAnswerSetting()

◆ setOutputType()

◆ setSelectionLimit()

◆ setSpecificFeedbackSetting()

◆ syncImages()

◆ syncWithOriginal()

◆ toJSON()

◆ validateSolutionSubmit()

Field Documentation

◆ $answers

◆ $feedback_setting

◆ $isSingleline

◆ $lastChange

◆ $output_type

◆ $selectionLimit