Class for multiple choice tests. More...

Inheritance diagram for assMultipleChoice:

Collaboration diagram for assMultipleChoice:

Public Member Functions

setIsSingleline ($isSingleline)

getIsSingleline ()

setLastChange ($lastChange)

getLastChange ()

__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 ($for_test=true, $title="", $author="", $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="")

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 ($worksheet, $startrow, $active_id, $pass)

{Creates an Excel worksheet for the detailed cumulated results of this question.

Parameters

object	$worksheet	Reference to the parent excel worksheet
object	$startrow	Startrow of the output in the excel worksheet
object	$active_id	Active id of the participant
object	$pass	Test pass

Returns: object

} More...

getThumbSize ()

setThumbSize ($a_size)

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 ($active_id, $pass=null)

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

Public Member Functions inherited from assQuestion

__construct ( $title="", $comment="", $author="", $owner=-1, $question="")

assQuestion constructor More...

getShuffler ()

setShuffler (ilArrayElementShuffler $shuffler)

setProcessLocker ($processLocker)

getProcessLocker ()

fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)

Receives parameters from a QTI parser and creates a valid ILIAS question object. More...

toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $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 ($questionpool_id, $title)

Returns TRUE if the question title exists in the database. More...

setTitle ($title="")

Sets the title string of the assQuestion object. More...

setId ($id=-1)

Sets the id of the assQuestion object. More...

setTestId ($id=-1)

Sets the test id of the assQuestion object. More...

setComment ($comment="")

Sets the comment string of the assQuestion object. More...

setOutputType ($outputType=OUTPUT_HTML)

Sets the output type. More...

setShuffle ($shuffle=true)

Sets the shuffle flag. More...

setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)

Sets the estimated working time of a question from given hour, minute and second. More...

setEstimatedWorkingTimeFromDurationString ($durationString)

Sets the estimated working time of a question from a given datetime string. More...

keyInArray ($searchkey, $array)

returns TRUE if the key occurs in an array More...

setAuthor ($author="")

Sets the authors name of the assQuestion object. More...

setOwner ($owner="")

Sets the creator/owner ID of the assQuestion object. More...

getTitle ()

Gets the title string of the assQuestion object. More...

getTitleFilenameCompliant ()

returns the object title prepared to be used as a filename More...

getId ()

Gets the id of the assQuestion object. More...

getShuffle ()

Gets the shuffle flag. More...

getTestId ()

Gets the test id of the assQuestion object. More...

getComment ()

Gets the comment string of the assQuestion object. More...

getOutputType ()

Gets the output type. More...

supportsJavascriptOutput ()

Returns true if the question type supports JavaScript output. More...

supportsNonJsOutput ()

requiresJsSwitch ()

getEstimatedWorkingTime ()

Gets the estimated working time of a question. More...

getAuthor ()

Gets the authors name of the assQuestion object. More...

getOwner ()

Gets the creator/owner ID of the assQuestion object. More...

getObjId ()

Get the object id of the container object. More...

setObjId ($obj_id=0)

Set the object id of the container object. More...

getLifecycle ()

setLifecycle (ilAssQuestionLifecycle $lifecycle)

setExternalId ($external_id)

getExternalId ()

getSuggestedSolutionOutput ()

& _getSuggestedSolution ($question_id, $subquestion_index=0)

Returns a suggested solution for a given subquestion index. More...

getSuggestedSolutions ()

Return the suggested solutions. More...

getReachedPoints ($active_id, $pass=null)

Returns the points, a learner has reached answering the question This is the fast way to get the points directly from the database. More...

getMaximumPoints ()

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

getAdjustedReachedPoints ($active_id, $pass=null, $authorizedSolution=true)

returns the reached points ... More...

calculateResultsFromSolution ($active_id, $pass=null, $obligationsEnabled=false)

Calculates the question results from a previously saved question solution. More...

persistWorkingState ($active_id, $pass=null, $obligationsEnabled=false, $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 ($active_id, $pass=null, $authorized=true)

Saves the learners input of the question to the database. More...

moveUploadedMediaFile ($file, $name)

Move an uploaded media file to an public accessible temp dir to present it. More...

getSuggestedSolutionPath ()

Returns the path for a suggested solution. More...

getJavaPath ()

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

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

getJavaPathWeb ()

Returns the web image path for web accessable java applets of a question. More...

getSuggestedSolutionPathWeb ()

Returns the web path for a suggested solution. More...

getImagePathWeb ()

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

getFlashPathWeb ()

Returns the web image path for web accessable flash applications of a question. More...

getTestOutputSolutions ($activeId, $pass)

getUserSolutionPreferingIntermediate ($active_id, $pass=null)

getSolutionValues ($active_id, $pass=null, $authorized=true)

Loads solutions of a given user from the database an returns it. More...

isInUse ($question_id="")

Checks whether the question is in use or not. More...

isClone ($question_id="")

Checks whether the question is a clone of another question or not. More...

pcArrayShuffle ($array)

Shuffles the values of a given array. 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...

deleteAnswers ($question_id)

Deletes datasets from answers tables. More...

deleteAdditionalTableData ($question_id)

Deletes datasets from the additional question table in the database. More...

delete ($question_id)

Deletes a question and all materials from the database. More...

getTotalAnswers ()

get total number of answers More...

_getTotalAnswers ($a_q_id)

get number of answers for question id (static) note: do not use $this inside this method More...

copyXHTMLMediaObjectsOfQuestion ($a_q_id)

syncXHTMLMediaObjectsOfQuestion ()

createPageObject ()

create page object of question More...

copyPageOfQuestion ($a_q_id)

getPageOfQuestion ()

setOriginalId ($original_id)

getOriginalId ()

fixSvgToPng ($imageFilenameContainingString)

fixUnavailableSkinImageSources ($html)

loadFromDb ($question_id)

Loads the question from the database. More...

createNewQuestion ($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 ($original_id="")

saveToDb ($original_id="")

Saves the question to the database. More...

setNewOriginalId ($newId)

deleteSuggestedSolutions ()

Deletes all suggestes solutions in the database. More...

getSuggestedSolution ($subquestion_index=0)

Returns a suggested solution for a given subquestion index. More...

getSuggestedSolutionTitle ($subquestion_index=0)

Returns the title of a suggested solution at a given subquestion_index. More...

setSuggestedSolution ($solution_id="", $subquestion_index=0, $is_import=false)

Sets a suggested solution for the question. More...

_resolveInternalLink ($internal_link)

_resolveIntLinks ($question_id)

syncWithOriginal ()

_questionExists ($question_id)

Returns true if the question already exists in the database. More...

_questionExistsInPool ($question_id)

Returns true if the question already exists in the database and is assigned to a question pool. More...

getPoints ()

Returns the maximum available points for the question. More...

setPoints ($a_points)

Sets the maximum available points for the question. More...

getSolutionMaxPass ($active_id)

Returns the maximum pass a users question solution. More...

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 ($txt_output, $prepare_for_latex_output=false, $omitNl2BrWhenTextArea=false)

Prepares a string for a text area output in tests. More...

QTIMaterialToString ($a_material)

Reads an QTI material tag an creates a text string. More...

addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=true, $add_mobs=true)

Creates a QTI material tag from a plain text or xhtml text. More...

buildHashedImageFilename ($plain_image_filename, $unique=false)

getQuestion ()

Gets the question string of the question object. More...

setQuestion ($question="")

Sets the question string of the question object. More...

getQuestionType ()

Returns the question type of the question. More...

getQuestionTypeID ()

Returns the question type of the question. More...

cleanupMediaObjectUsage ()

synchronises appearances of media objects in the question with media object usage table More...

& getInstances ()

Gets all instances of the question. More...

getActiveUserData ($active_id)

Returns the user id and the test id for a given active id. More...

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

Creates an Excel worksheet for the detailed cumulated results of this question. More...

__get ($value)

Object getter. More...

__set ($key, $value)

Object setter. More...

getNrOfTries ()

setNrOfTries ($a_nr_of_tries)

setExportImagePath ($a_path)

formatSAQuestion ($a_q)

Format self assessment question. More...

setPreventRteUsage ($a_val)

Set prevent rte usage. More...

getPreventRteUsage ()

Get prevent rte usage. More...

migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)

setSelfAssessmentEditingMode ($a_selfassessmenteditingmode)

Set Self-Assessment Editing Mode. More...

getSelfAssessmentEditingMode ()

Get Self-Assessment Editing Mode. More...

setDefaultNrOfTries ($a_defaultnroftries)

Set Default Nr of Tries. More...

getDefaultNrOfTries ()

Get Default Nr of Tries. More...

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

isAnswered ($active_id, $pass=null)

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

isAutosaveable ()

getAdditionalContentEditingMode ()

getter for additional content editing mode for this question More...

setAdditionalContentEditingMode ($additinalContentEditingMode)

setter for additional content editing mode for this question More...

isAdditionalContentEditingModePageObject ()

isser for additional "pageobject" content editing mode More...

isValidAdditionalContentEditingMode ($additionalContentEditingMode)

returns the fact wether the passed additional content mode is valid or not More...

getValidAdditionalContentEditingModes ()

getter for valid additional content editing modes More...

addQuestionChangeListener (ilQuestionChangeListener $listener)

getQuestionChangeListeners ()

getHtmlUserSolutionPurifier ()

getHtmlQuestionContentPurifier ()

setLastChange ($lastChange)

getLastChange ()

removeIntermediateSolution ($active_id, $pass)

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

saveCurrentSolution ($active_id, $pass, $value1, $value2, $authorized=true, $tstamp=null)

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

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

setStep ($step)

getStep ()

toJSON ()

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

intermediateSolutionExists ($active_id, $pass)

authorizedSolutionExists ($active_id, $pass)

authorizedOrIntermediateSolutionExists ($active_id, $pass)

isAddableAnswerOptionValue ($qIndex, $answerOptionValue)

addAnswerOptionValue ($qIndex, $answerOptionValue, $points)

removeAllExistingSolutions ()

removeExistingSolutions ($activeId, $pass)

resetUsersAnswer ($activeId, $pass)

removeResultRecord ($activeId, $pass)

fetchValuePairsFromIndexedValues (array $indexedValues)

fetchIndexedValuesFromValuePairs (array $valuePairs)

areObligationsToBeConsidered ()

setObligationsToBeConsidered ($obligationsToBeConsidered)

updateTimestamp ()

getTestPresentationConfig ()

Get the test question configuration (initialised once) More...

savePartial ()

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	ADDITIONAL_CONTENT_EDITING_MODE_DEFAULT = 'default'
	constant for additional content editing mode "default" More...

const	ADDITIONAL_CONTENT_EDITING_MODE_PAGE_OBJECT = 'pageobject'
	constant for additional content editing mode "pageobject" More...

	$feedbackOBJ = null

	$prevent_rte_usage = false

	$selfassessmenteditingmode = false

	$defaultnroftries = 0

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

	ensureCurrentTestPass ($active_id, $pass)

	lookupCurrentTestPass ($active_id, $pass)

	lookupTestId ($active_id)

	log ($active_id, $langVar)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	deletePageOfQuestion ($question_id)
	Deletes the page object of a question with a given ID. More...

	onDuplicate ($originalParentId, $originalQuestionId, $duplicateParentId, $duplicateQuestionId)
	Will be called when a question is duplicated (inside a question pool or for insertion in a test) More...

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

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

	onCopy ($sourceParentId, $sourceQuestionId, $targetParentId, $targetQuestionId)
	Will be called when a question is copied (into another question pool) More...

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

	syncSuggestedSolutionFiles ($original_id)
	Syncs the files of a suggested solution if the question is synced. More...

	copySuggestedSolutionFiles ($source_questionpool_id, $source_question_id)

	ensureNonNegativePoints ($points)

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

	getSelfAssessmentFormatter ()

	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	duplicateQuestionHints ($originalQuestionId, $duplicateQuestionId)

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

	buildQuestionDataQuery ()

	getCurrentSolutionResultSet ($active_id, $pass, $authorized=true)
	Get a restulset for the current user solution for a this question by active_id and pass. More...

	removeSolutionRecordById ($solutionId)

	getSolutionRecordById ($solutionId)

	deleteDummySolutionRecord ($activeId, $passIndex)

	isDummySolutionRecord ($solutionRecord)

	deleteSolutionRecordByValues ($activeId, $passIndex, $authorized, $matchValues)

	duplicateIntermediateSolutionAuthorized ($activeId, $passIndex)

	forceExistingIntermediateSolution ($activeId, $passIndex, $considerDummyRecordCreation)

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

Protected Attributes
	$thumb_size

	$selectionLimit

Protected Attributes inherited from assQuestion
	$id

	$title

	$comment

	$owner

	$author

	$question

	$points

	$est_working_time

	$shuffle

	$test_id

	$obj_id

	$ilias

	$tpl

	$lng

	$db

	$outputType = OUTPUT_JAVASCRIPT

	$suggested_solutions

	$original_id

	$page

	$external_id = ''

	$questionChangeListeners = array()

	$processLocker

	$step = null

	$lastChange

	$shuffler

	$testQuestionConfig

	$lifecycle

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

static	isForcePassResultUpdateEnabled ()

static	isAllowedImageMimeType ($mimeType)

static	fetchMimeTypeIdentifier ($contentTypeString)

static	getAllowedFileExtensionsForMimeType ($mimeType)

static	isAllowedImageFileExtension ($mimeType, $fileExtension)

static	getAllowedImageMaterialFileExtensions ()

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

static	_getQuestionInfo ($question_id)
	Returns question information from the database. More...

static	_getSuggestedSolutionCount ($question_id)
	Returns the number of suggested solutions associated with a question. More...

static	_getSuggestedSolutionOutput ($question_id)
	Returns the output of the suggested solution. More...

static	_getReachedPoints ($active_id, $question_id, $pass=null)
	Returns the points, a learner has reached answering the question. More...

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

static	logAction ($logtext="", $active_id="", $question_id="")
	Logs an action into the Test&Assessment log. More...

static	getQuestionTypeFromDb ($question_id)
	get question type for question id More...

static	_getTotalRightAnswers ($a_q_id)
	get number of answers for question id (static) note: do not use $this inside this method More...

static	_getTitle ($a_q_id)
	Returns the title of a question. More...

static	_getQuestionText ($a_q_id)
	Returns question text. More...

static	isFileAvailable ($file)

static	_getQuestionType ($question_id)
	Returns the question type of a question with a given id. More...

static	_getQuestionTitle ($question_id)
	Returns the question title of a question with a given id. More...

static	saveOriginalId ($questionId, $originalId)

static	resetOriginalId ($questionId)

static	_getInternalLinkHref ($target="")

static	_getOriginalId ($question_id)
	Returns the original id of a question. More...

static	originalQuestionExists ($questionId)

static	_instanciateQuestion ($question_id)
	Creates an instance of a question with a given question id. More...

static	_instantiateQuestion ($question_id)

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

static	_isWriteable ($question_id, $user_id)
	Returns true if the question is writeable by a certain user. More...

static	_isUsedInRandomTest ($question_id="")
	Checks whether the question is used in a random test or not. More...

static	_isWorkedThrough ($active_id, $question_id, $pass=null)
	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 ($a_user_id, $a_question_ids)
	Checks if an array of question ids is answered by an user or not. More...

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

static	_needsManualScoring ($question_id)

static	_includeClass ($question_type, $gui=0)
	Include the php class file for a given question type. More...

static	getGuiClassNameByQuestionType ($questionType)

static	getObjectClassNameByQuestionType ($questionType)

static	getFeedbackClassNameByQuestionType ($questionType)

static	isCoreQuestionType ($questionType)

static	includeCoreClass ($questionType, $withGuiClass)

static	includePluginClass ($questionType, $withGuiClass)

static	_getQuestionTypeName ($type_tag)
	Return the translation for a given question type tag. More...

static &	_instanciateQuestionGUI ($question_id)
	Creates an instance of a question gui with a given question id. More...

static	instantiateQuestionGUI ($a_question_id)
	Creates an instance of a question gui with a given question id. More...

static	_questionExistsInTest ($question_id, $test_id)

static	lookupParentObjId ($questionId)
	@global ilDBInterface $ilDB More...

static	lookupOriginalParentObjId ($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 ($questionId)
	returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration More...

static	implodeKeyValues ($keyValues)

static	explodeKeyValues ($keyValues)

static	setResultGateway ($resultGateway)

static	getResultGateway ()

static	sumTimesInISO8601FormatH_i_s_Extended ($time1, $time2)

static	convertISO8601FormatH_i_s_ExtendedToSeconds ($time)

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

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

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

Static Protected Member Functions inherited from assQuestion
static	getNumExistingSolutionRecords ($activeId, $pass, $questionId)
	returns the number of existing solution records for the given test active / pass and given question id More...

static	getKeyValuesImplosionSeparator ()

Static Protected Attributes inherited from assQuestion
static	$allowedFileExtensionsByMimeType

static	$allowedCharsetsByMimeType

static	$allowedImageMaterialFileExtensionsByMimeType

static	$forcePassResultsUpdateEnabled = 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 27 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 106 of file class.assMultipleChoice.php.

      {
        parent::__construct($title, $comment, $author, $owner, $question);
        $this->output_type = $output_type;
        $this->thumb_size = 150;
        $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 = `""`
	)

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

See also: $answers; ASS_AnswerBinaryStateImage

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

      {
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMultipleResponseImage.php";
        $answertext = $this->getHtmlQuestionContentPurifier()->purify($answertext);
        if (array_key_exists($order, $this->answers)) {
            // insert answer
            $answer = new ASS_AnswerMultipleResponseImage($answertext, $points, $order, $points_unchecked, $answerimage);
            $newchoices = array();
            for ($i = 0; $i < $order; $i++) {
                array_push($newchoices, $this->answers[$i]);
            }
            array_push($newchoices, $answer);
            for ($i = $order; $i < count($this->answers); $i++) {
                $changed = $this->answers[$i];
                $changed->setOrder($i + 1);
                array_push($newchoices, $changed);
            }
            $this->answers = $newchoices;
        } else {
            // add answer
            $answer = new ASS_AnswerMultipleResponseImage($answertext, $points, count($this->answers), $points_unchecked, $answerimage);
            array_push($this->answers, $answer);
        }
    }

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

Here is the call graph for this function:

◆ 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

Returns: ilTestQuestionConfig

Reimplemented from assQuestion.

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

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

References $config.

◆ 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 577 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, $ilDB, $pass, assQuestion\$points, $result, calculateReachedPointsForSolution(), assQuestion\getCurrentSolutionResultSet(), and assQuestion\getSolutionMaxPass().

Here is the call graph for this function:

◆ calculateReachedPointsForSolution()

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

protected

Parameters

$found_values
$active_id

Returns: int

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

    {
        $points = 0;
        foreach ($this->answers as $key => $answer) {
            if (in_array($key, $found_values)) {
                $points += $answer->getPoints();
            } else {
                $points += $answer->getPointsUnchecked();
            }
        }
        if ($active_id) {
            include_once "./Modules/Test/classes/class.ilObjTest.php";
            $mc_scoring = ilObjTest::_getMCScoring($active_id);
            if (($mc_scoring == 0) && (count($found_values) == 0)) {
                $points = 0;
            }
        }
        return $points;
    }

References assQuestion\$points, and ilObjTest\_getMCScoring().

Referenced by calculateReachedPoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyImages()

assMultipleChoice::copyImages	(	$question_id,
		$source_questionpool
	)

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

    {
        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)) {
                    ilUtil::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, $ilLog, assQuestion\getImagePath(), getThumbPrefix(), and ilUtil\makeDirParents().

Here is the call graph for this function:

◆ copyObject()

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

Copies an assMultipleChoice object.

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

    {
        if ($this->id <= 0) {
            // The question has not been saved. It cannot be duplicated
            return;
        }
        // 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(), and assQuestion\getObjId().

Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

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

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

    {
        if ($this->id <= 0) {
            // The question has not been saved. It cannot be duplicated
            return;
        }
 
        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, 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 513 of file class.assMultipleChoice.php.

    {
        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; $i < count($this->answers); $i++) {
            if ($this->answers[$i]->getOrder() > $index) {
                $this->answers[$i]->setOrder($i);
            }
        }
    }

References $i, $index, and deleteImage().

Here is the call graph for this function:

◆ deleteImage()

assMultipleChoice::deleteImage ( $image_filename )

protected

Deletes an image file.

Parameters

string $image_filename Name of the image file to delete

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

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

References assQuestion\getImagePath(), and getThumbPrefix().

Referenced by deleteAnswer(), and removeAnswerImage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ duplicate()

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

Duplicates an assMultipleChoiceQuestion.

Reimplemented from assQuestion.

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

    {
        if ($this->id <= 0) {
            // The question has not been saved. It cannot be duplicated
            return;
        }
        // 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 542 of file class.assMultipleChoice.php.

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

◆ generateThumbForFile()

assMultipleChoice::generateThumbForFile	(	$path,
		$file
	)

protected

Parameters

$path	string
$file	string

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

    {
        $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;
            }
            ilUtil::convertImage($filename, $thumbpath, $ext, $this->getThumbSize());
        }
    }

References $filename, ilUtil\convertImage(), getThumbPrefix(), and getThumbSize().

Referenced by rebuildThumbnails(), and setImageFile().

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

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

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

Referenced by getAvailableAnswerOptions().

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

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

◆ getAnswers()

& assMultipleChoice::getAnswers ( )

Returns a reference to the answers array.

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

    {
        return $this->answers;
    }

References $answers.

Referenced by getAvailableAnswerOptions(), lmMigrateQuestionTypeSpecificContent(), rebuildThumbnails(), setExportDetailsXLS(), and toJSON().

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

    {
        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

Returns: array|ASS_AnswerSimple

Implements iQuestionCondition.

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

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

References $index, getAnswer(), and 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 1314 of file class.assMultipleChoice.php.

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

    {
        return $this->isSingleline;
    }

References $isSingleline.

◆ getLastChange()

assMultipleChoice::getLastChange ( )

Returns: mixed

Reimplemented from assQuestion.

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

    {
        return $this->lastChange;
    }

References $lastChange.

◆ getMaximumPoints()

assMultipleChoice::getMaximumPoints ( )

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

See also: $points

Reimplemented from assQuestion.

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

    {
        $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 assQuestion\$points.

Referenced by isComplete().

Here is the caller graph for this function:

◆ getMultilineAnswerSetting()

assMultipleChoice::getMultilineAnswerSetting ( )

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

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

    {
        require_once "./Modules/TestQuestionPool/classes/class.ilOperatorsExpressionMapping.php";
        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 412 of file class.assMultipleChoice.php.

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

    {
        return "assMultipleChoice";
    }

Referenced by toJSON().

Here is the caller graph for this function:

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

    {
        $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 assQuestion\getId().

Here is the call graph for this function:

◆ getSelectionLimit()

assMultipleChoice::getSelectionLimit ( )

Returns: int

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

    {
        return $this->selectionLimit;
    }

References $selectionLimit.

Referenced by toJSON(), and validateSolutionSubmit().

Here is the caller graph for this function:

◆ getSolutionSubmit()

assMultipleChoice::getSolutionSubmit ( )

protected

Returns: array

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

    {
        $solutionSubmit = array();
        foreach ($_POST as $key => $value) {
            if (preg_match("/^multiple_choice_result_(\d+)/", $key)) {
                if (strlen($value)) {
                    $solutionSubmit[] = $value;
                }
            }
        }
        return $solutionSubmit;
    }

References $_POST.

Referenced by validateSolutionSubmit().

Here is the caller graph for this function:

◆ getSpecificFeedbackAllCorrectOptionLabel()

assMultipleChoice::getSpecificFeedbackAllCorrectOptionLabel ( )

Implements ilAssSpecificFeedbackOptionLabelProvider.

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

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

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

References $feedback_setting.

◆ getThumbPrefix()

assMultipleChoice::getThumbPrefix ( )

Returns: string

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

    {
        return "thumb.";
    }

Referenced by copyImages(), deleteImage(), generateThumbForFile(), and syncImages().

Here is the caller graph for this function:

◆ getThumbSize()

assMultipleChoice::getThumbSize ( )

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

    {
        return $this->thumb_size;
    }

References $thumb_size.

Referenced by generateThumbForFile(), rebuildThumbnails(), setImageFile(), and toJSON().

Here is the caller graph for this function:

◆ isAnswered()

assMultipleChoice::isAnswered	(	$active_id,
		$pass = `null`
	)

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

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

References $pass, assQuestion\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 145 of file class.assMultipleChoice.php.

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

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

References $_POST.

◆ lmMigrateQuestionTypeSpecificContent()

assMultipleChoice::lmMigrateQuestionTypeSpecificContent ( ilAssSelfAssessmentMigrator $migrator )

protected

Parameters

ilAssSelfAssessmentMigrator $migrator

Reimplemented from assQuestion.

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

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

References getAnswers(), and 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

Reimplemented from assQuestion.

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

    {
        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($shuffle);
            $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
            $this->setThumbSize($data['thumb_size']);
            $this->isSingleline = ($data['allow_images']) ? false : true;
            $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);
                array_push($this->answers, new ASS_AnswerMultipleResponseImage($data["answertext"], $data["points"], $data["aorder"], $data["points_unchecked"], $data["imagefile"]));
            }
        }
 
        parent::loadFromDb($question_id);
    }

References $data, $DIC, Vendor\Package\$e, $ilDB, $result, assQuestion\$shuffle, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), assQuestion\getImagePath(), ilAssQuestionLifecycle\getInstance(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), assQuestion\setLifecycle(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), setSelectionLimit(), assQuestion\setShuffle(), 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 172 of file class.assMultipleChoice.php.

    {
        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(), and getThumbSize().

Here is the call graph for this function:

◆ removeAnswerImage()

assMultipleChoice::removeAnswerImage ( $index )

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

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

References $index, and deleteImage().

Here is the call graph for this function:

◆ saveToDb()

assMultipleChoice::saveToDb ( $original_id = "" )

Saves a assMultipleChoice object to a database.

Parameters

string $original_id

Reimplemented from assQuestion.

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

    {
        $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	(	$worksheet,
		$startrow,
		$active_id,
		$pass
	)

{Creates an Excel worksheet for the detailed cumulated results of this question.

Parameters

object	$worksheet	Reference to the parent excel worksheet
object	$startrow	Startrow of the output in the excel worksheet
object	$active_id	Active id of the participant
object	$pass	Test pass

Returns: object

}

Reimplemented from assQuestion.

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

    {
        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, 1, 1);
            } else {
                $worksheet->setCell($startrow + $i, 1, 0);
            }
            $i++;
        }
 
        return $startrow + $i + 1;
    }

References $i, assQuestion\$id, $pass, getAnswers(), and assQuestion\getSolutionValues().

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

    {
        $result = 0;
        if (!empty($image_tempfilename)) {
            $image_filename = str_replace(" ", "_", $image_filename);
            $imagepath = $this->getImagePath();
            if (!file_exists($imagepath)) {
                ilUtil::makeDirParents($imagepath);
            }
            if (!ilUtil::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 $result, generateThumbForFile(), assQuestion\getImagePath(), ilObjMediaObject\getMimeType(), getThumbSize(), ilUtil\makeDirParents(), and ilUtil\moveUploadedFile().

Here is the call graph for this function:

◆ setIsSingleline()

assMultipleChoice::setIsSingleline ( $isSingleline )

Parameters

mixed $isSingleline

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

    {
        $this->isSingleline = $isSingleline;
    }

References $isSingleline.

◆ setLastChange()

assMultipleChoice::setLastChange ( $lastChange )

Parameters

mixed $lastChange

Reimplemented from assQuestion.

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

    {
        $this->lastChange = $lastChange;
    }

References $lastChange.

◆ setMultilineAnswerSetting()

assMultipleChoice::setMultilineAnswerSetting ( $a_setting = 0 )

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

    {
        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

Reimplemented from assQuestion.

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

    {
        $this->output_type = $output_type;
    }

References $output_type.

◆ setSelectionLimit()

assMultipleChoice::setSelectionLimit ( $selectionLimit )

Parameters

int $selectionLimit

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

    {
        $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 1122 of file class.assMultipleChoice.php.

    {
        $this->feedback_setting = $a_feedback_setting;
    }

◆ setThumbSize()

assMultipleChoice::setThumbSize ( $a_size )

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

    {
        $this->thumb_size = $a_size;
    }

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ syncImages()

assMultipleChoice::syncImages ( )

protected

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

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

    {
        global $DIC;
        $ilLog = $DIC['ilLog'];
 
        $imagepath = $this->getImagePath();
 
        $question_id = $this->getOriginalId();
        $originalObjId = parent::lookupParentObjId($this->getOriginalId());
        $imagepath_original = $this->getImagePath($question_id, $originalObjId);
 
        ilUtil::delDir($imagepath_original);
        foreach ($this->answers as $answer) {
            $filename = $answer->getImage();
            if (strlen($filename)) {
                if (@file_exists($imagepath . $filename)) {
                    if (!file_exists($imagepath)) {
                        ilUtil::makeDirParents($imagepath);
                    }
                    if (!file_exists($imagepath_original)) {
                        ilUtil::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, $ilLog, ilUtil\delDir(), assQuestion\getImagePath(), assQuestion\getOriginalId(), getThumbPrefix(), and ilUtil\makeDirParents().

Referenced by syncWithOriginal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ syncWithOriginal()

assMultipleChoice::syncWithOriginal ( )

Reimplemented from assQuestion.

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

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

References assQuestion\getOriginalId(), and syncImages().

Here is the call graph for this function:

◆ toJSON()

assMultipleChoice::toJSON ( )

Returns a JSON representation of the question.

Reimplemented from assQuestion.

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

    {
        require_once './Services/RTE/classes/class.ilRTE.php';
        $result = array();
        $result['id'] = (int) $this->getId();
        $result['type'] = (string) $this->getQuestionType();
        $result['title'] = (string) $this->getTitle();
        $result['question'] = $this->formatSAQuestion($this->getQuestion());
        $result['nr_of_tries'] = (int) $this->getNrOfTries();
        $result['shuffle'] = (bool) $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" => (string) $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 $answers, $mobs, $result, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), getAnswers(), assQuestion\getId(), assQuestion\getImagePathWeb(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), getSelectionLimit(), assQuestion\getShuffle(), getThumbSize(), and assQuestion\getTitle().

Here is the call graph for this function:

◆ validateSolutionSubmit()

assMultipleChoice::validateSolutionSubmit ( )

Reimplemented from assQuestion.

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

    {
        $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()
                );
 
                ilUtil::sendFailure($failureMsg, true);
                return false;
            }
        }
 
        return true;
    }

References getSelectionLimit(), getSolutionSubmit(), and ilUtil\sendFailure().

Here is the call graph for this function:

Field Documentation

◆ $answers

assMultipleChoice::$answers

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

Referenced by getAnswers(), and toJSON().

◆ $feedback_setting

assMultipleChoice::$feedback_setting

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

Referenced by getSpecificFeedbackSetting().

◆ $isSingleline

assMultipleChoice::$isSingleline

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

Referenced by getIsSingleline(), and setIsSingleline().

◆ $lastChange

assMultipleChoice::$lastChange

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

Referenced by getLastChange(), and setLastChange().

◆ $output_type

assMultipleChoice::$output_type

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

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

◆ $selectionLimit

assMultipleChoice::$selectionLimit

protected

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

Referenced by getSelectionLimit(), and setSelectionLimit().

◆ $thumb_size

assMultipleChoice::$thumb_size

protected

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

Referenced by getThumbSize().

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

◆ getLastChange()

◆ getMaximumPoints()

◆ getMultilineAnswerSetting()

◆ getOperators()

◆ getOutputType()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSelectionLimit()

◆ getSolutionSubmit()

◆ getSpecificFeedbackAllCorrectOptionLabel()

◆ getSpecificFeedbackSetting()

◆ getThumbPrefix()

◆ getThumbSize()

◆ isAnswered()

◆ isComplete()

◆ isForcedEmptySolution()

◆ lmMigrateQuestionTypeSpecificContent()

◆ loadFromDb()

◆ rebuildThumbnails()

◆ removeAnswerImage()

◆ saveToDb()

◆ setExportDetailsXLS()

◆ setImageFile()

◆ setIsSingleline()

◆ setLastChange()

◆ setMultilineAnswerSetting()

◆ setOutputType()

◆ setSelectionLimit()

◆ setSpecificFeedbackSetting()

◆ setThumbSize()

◆ syncImages()

◆ syncWithOriginal()

◆ toJSON()

◆ validateSolutionSubmit()

Field Documentation

◆ $answers

◆ $feedback_setting

◆ $isSingleline

◆ $lastChange

◆ $output_type

◆ $selectionLimit

◆ $thumb_size