Class for cloze tests. More...

Inheritance diagram for assClozeTest:

Collaboration diagram for assClozeTest:

Public Member Functions

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

assClozeTest constructor More...

isComplete ()

Returns TRUE, if a cloze test is complete for use. More...

cleanQuestiontext ($text)

Cleans cloze question text to remove attributes or tags from older ILIAS versions. More...

replaceFirstGap ($gaptext, $content)

Replace the first gap in a string without treating backreferences. More...

loadFromDb ($question_id)

Loads a assClozeTest object from a database. More...

saveToDb ($original_id="")

Saves a assClozeTest object to a database. More...

saveAnswerSpecificDataToDb ()

Save all gaps to the database. More...

saveAdditionalQuestionDataToDb ()

Saves the data for the additional data table. More...

getGaps ()

Returns the array of gaps. More...

flushGaps ()

Deletes all gaps without changing the cloze text. More...

setClozeText ($cloze_text="")

Evaluates the text gap solutions from the cloze text. More...

setClozeTextValue ($cloze_text="")

getClozeText ()

Returns the cloze text. More...

getClozeTextForHTMLOutput ()

Returns the cloze text as HTML (with optional nl2br) Fix for Mantis 29987: We assume Tiny embeds any text in tags, so if no tags are present, we derive it's non-HTML content and apply nl2br. More...

getStartTag ()

Returns the start tag of a cloze gap. More...

setStartTag ($start_tag="[gap]")

Sets the start tag of a cloze gap. More...

getEndTag ()

Returns the end tag of a cloze gap. More...

setEndTag ($end_tag="[/gap]")

Sets the end tag of a cloze gap. More...

getFeedbackMode ()

setFeedbackMode ($feedbackMode)

createGapsFromQuestiontext ()

Create gap entries by parsing the question text. More...

setGapType ($gap_index, $gap_type)

Set the type of a gap with a given index. More...

setGapShuffle ($gap_index=0, $shuffle=1)

Sets the shuffle state of a gap with a given index. More...

clearGapAnswers ()

Removes all answers from the gaps. More...

getGapCount ()

Returns the number of gaps. More...

addGapAnswer ($gap_index, $order, $answer)

Sets the answer text of a gap with a given index. More...

getGap ($gap_index=0)

Returns the gap at a given index. More...

setGapSize ($gap_index, $order, $size)

setGapAnswerPoints ($gap_index, $order, $points)

Sets the points of a gap with a given index and an answer with a given order. More...

addGapText ($gap_index)

Adds a new answer text value to a text gap with a given index. More...

addGapAtIndex ($gap, $index)

Adds a ClozeGap object at a given index. More...

setGapAnswerLowerBound ($gap_index, $order, $bound)

Sets the lower bound of a gap with a given index and an answer with a given order. More...

setGapAnswerUpperBound ($gap_index, $order, $bound)

Sets the upper bound of a gap with a given index and an answer with a given order. More...

getMaximumPoints ()

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

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

Duplicates an assClozeTest. More...

copyObject ($target_questionpool_id, $title="")

Copies an assClozeTest object. More...

createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")

copyGapCombination ($orgID, $newID)

updateClozeTextFromGaps ()

Updates the gap parameters in the cloze text from the form input. More...

deleteAnswerText ($gap_index, $answer_index)

Deletes the answer text of a gap with a given index and an answer with a given order. More...

deleteGap ($gap_index)

Deletes a gap with a given index. More...

getTextgapPoints ($a_original, $a_entered, $max_points)

Returns the points for a text gap and compares the given solution with the entered solution using the text gap rating options. More...

getNumericgapPoints ($a_original, $a_entered, $max_points, $lowerBound, $upperBound)

Returns the points for a text gap and compares the given solution with the entered solution using the text gap rating options. More...

checkForValidFormula ($value)

calculateReachedPoints ($active_id, $pass=null, $authorized=true, $returndetails=false)

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

validateSolutionSubmit ()

fetchSolutionSubmit ($submit)

getSolutionSubmitValidation ()

getSolutionSubmit ()

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

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

getQuestionType ()

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

getTextgapRating ()

Returns the rating option for text gaps. More...

setTextgapRating ($a_textgap_rating)

Sets the rating option for text gaps. More...

getIdenticalScoring ()

Returns the identical scoring status of the question. More...

setIdenticalScoring ($a_identical_scoring)

Sets the identical scoring option for cloze questions. 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...

setFixedTextLength ($a_text_len)

Sets a fixed text length for all text fields in the cloze question. More...

getFixedTextLength ()

Gets the fixed text length for all text fields in the cloze question. More...

getMaximumGapPoints ($gap_index)

Returns the maximum points for a gap. More...

getRTETextWithMediaObjects ()

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

getGapCombinationsExists ()

getGapCombinations ()

setGapCombinationsExists ($value)

setGapCombinations ($value)

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

toJSON ()

Returns a JSON representation of the question. More...

getOperators ($expression)

Get all available operations for a specific question. More...

getExpressionTypes ()

Get all available expression types for a specific question. More...

getAvailableAnswerOptions ($index=null)

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

calculateCombinationResult ($user_result)

calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

fetchAnswerValueForGap ($userSolution, $gapIndex)

isAddableAnswerOptionValue ($qIndex, $answerOptionValue)

addAnswerOptionValue ($qIndex, $answerOptionValue, $points)

savePartial ()

Public Member Functions inherited from assQuestion

getShuffler ()

setShuffler (ilArrayElementShuffler $shuffler)

setProcessLocker ($processLocker)

getProcessLocker ()

fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping, array $solutionhints=[])

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

getDescriptionForHTMLOutput ()

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

getAuthorForHTMLOutput ()

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

getQuestionForHTMLOutput ()

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

isInActiveTest ()

saveAdditionalQuestionDataToDb ()

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

saveAnswerSpecificDataToDb ()

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

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

Data Fields
	$gaps

	$gap_combinations

	$gap_combinations_exists

	$start_tag

	$end_tag

	$textgap_rating

	$identical_scoring

	$fixedTextLength

	$cloze_text

	$feedbackOBJ

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

const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = '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
	saveClozeGapItemsToDb ($gap, $key)
	Save all items belonging to one cloze gap to the db. More...

	saveClozeTextGapRecordToDb ($next_id, $key, $item, $gap)
	Saves a gap-item record. More...

	saveClozeSelectGapRecordToDb ($next_id, $key, $item, $gap)
	Saves a gap-item record. More...

	saveClozeNumericGapRecordToDb ($next_id, $key, $item, $gap)
	Saves a gap-item record. More...

	isValidNumericSubmitValue ($submittedValue)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	calculateReachedPointsForSolution ($user_result, &$detailed=null)

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)

	purifyAndPrepareTextAreaOutput (string $content)

	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
	$feedbackMode = ilAssClozeTestFeedback::FB_MODE_GAP_QUESTION

Protected Attributes inherited from assQuestion
	$id

	$title

	$comment

	$owner

	$author

	$question

	$points

	$est_working_time

	$shuffle

	$test_id

	$obj_id

	$ilias

	$tpl

	$lng

	$db

	$refinery

	$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 cloze tests.

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

Version: $Id$

Definition at line 24 of file class.assClozeTest.php.

Constructor & Destructor Documentation

◆ __construct()

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

assClozeTest constructor

The constructor takes possible arguments an creates an instance of the assClozeTest 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

Returns: \assClozeTest

Definition at line 117 of file class.assClozeTest.php.

      {
        parent::__construct($title, $comment, $author, $owner, $question);
        $this->start_tag = "[gap]";
        $this->end_tag = "[/gap]";
        $this->gaps = array();
        $this->setQuestion($question); // @TODO: Should this be $question?? See setter for why this is not trivial.
        $this->fixedTextLength = "";
        $this->identical_scoring = 1;
        $this->gap_combinations_exists = false;
        $this->gap_combinations = array();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addAnswerOptionValue()

assClozeTest::addAnswerOptionValue	(	$qIndex,
		$answerOptionValue,
		$points
	)

Reimplemented from assQuestion.

Definition at line 2028 of file class.assClozeTest.php.

    {
        $gap = $this->getGap($qIndex); /* @var assClozeGap $gap */
 
        $item = new assAnswerCloze($answerOptionValue, $points);
        $item->setOrder($gap->getItemCount());
 
        $gap->addItem($item);
    }

References assQuestion\$points, and getGap().

Here is the call graph for this function:

◆ addGapAnswer()

assClozeTest::addGapAnswer	(	$gap_index,
		$order,
		$answer
	)

Sets the answer text of a gap with a given index.

The index of the first gap is 0, the index of the second gap is 1 and so on.

Parameters

integer	$gap_index	A nonnegative index of the n-th gap
integer	$order	The order of the answer text
string	$answer	The answer text @access public

See also: $gaps

Definition at line 762 of file class.assClozeTest.php.

    {
        if (array_key_exists($gap_index, $this->gaps)) {
            if ($this->gaps[$gap_index]->getType() == CLOZE_NUMERIC) {
                // only allow notation with "." for real numbers
                $answer = str_replace(",", ".", $answer);
            }
            $this->gaps[$gap_index]->addItem(new assAnswerCloze(trim($answer), 0, $order));
        }
    }

References CLOZE_NUMERIC.

◆ addGapAtIndex()

assClozeTest::addGapAtIndex	(	$gap,
		$index
	)

Adds a ClozeGap object at a given index.

Parameters

object	$gap	The gap object
integer	$index	A nonnegative index of the n-th gap @access public

See also: $gaps

Definition at line 843 of file class.assClozeTest.php.

    {
        $this->gaps[$index] = $gap;
    }

References $index.

◆ addGapText()

assClozeTest::addGapText ( $gap_index )

Adds a new answer text value to a text gap with a given index.

The index of the first gap is 0, the index of the second gap is 1 and so on.

Parameters

integer $gap_index A nonnegative index of the n-th gap @access public

See also: $gaps

Definition at line 822 of file class.assClozeTest.php.

    {
        if (array_key_exists($gap_index, $this->gaps)) {
            include_once "./Modules/TestQuestionPool/classes/class.assAnswerCloze.php";
            $answer = new assAnswerCloze(
                "",
                0,
                $this->gaps[$gap_index]->getItemCount()
            );
            $this->gaps[$gap_index]->addItem($answer);
        }
    }

◆ calculateCombinationResult()

assClozeTest::calculateCombinationResult ( $user_result )

Definition at line 1814 of file class.assClozeTest.php.

    {
        $points = 0;
 
        $assClozeGapCombinationObj = new assClozeGapCombination();
 
        if ($assClozeGapCombinationObj->combinationExistsForQid($this->getId())) {
            $combinations_for_question = $assClozeGapCombinationObj->getCleanCombinationArray($this->getId());
            $gap_answers = array();
            $gap_used_in_combination = array();
            foreach ($user_result as $user_result_build_list) {
                if (is_array($user_result_build_list)) {
                    $gap_answers[$user_result_build_list['gap_id']] = $user_result_build_list['value'];
                }
            }
 
            foreach ($combinations_for_question as $combination) {
                foreach ($combination as $row_key => $row_answers) {
                    $combination_fulfilled = true;
                    $points_for_combination = $row_answers['points'];
                    foreach ($row_answers as $gap_key => $combination_gap_answer) {
                        if ($gap_key !== 'points') {
                            $gap_used_in_combination[$gap_key] = $gap_key;
                        }
                        if ($combination_fulfilled && array_key_exists($gap_key, $gap_answers)) {
                            switch ($combination_gap_answer['type']) {
                                case CLOZE_TEXT:
                                    $is_text_gap_correct = $this->getTextgapPoints($gap_answers[$gap_key], $combination_gap_answer['answer'], 1);
                                    if ($is_text_gap_correct != 1) {
                                        $combination_fulfilled = false;
                                    }
                                    break;
                                case CLOZE_SELECT:
                                    $answer = $this->gaps[$gap_key]->getItem($gap_answers[$gap_key]);
                                    $answertext = $answer->getAnswertext();
                                    if ($answertext != $combination_gap_answer['answer']) {
                                        $combination_fulfilled = false;
                                    }
                                    break;
                                case CLOZE_NUMERIC:
                                    $answer = $this->gaps[$gap_key]->getItem(0);
                                    if ($combination_gap_answer['answer'] != 'out_of_bound') {
                                        $is_numeric_gap_correct = $this->getNumericgapPoints($answer->getAnswertext(), $gap_answers[$gap_key], 1, $answer->getLowerBound(), $answer->getUpperBound());
                                        if ($is_numeric_gap_correct != 1) {
                                            $combination_fulfilled = false;
                                        }
                                    } else {
                                        $wrong_is_the_new_right = $this->getNumericgapPoints($answer->getAnswertext(), $gap_answers[$gap_key], 1, $answer->getLowerBound(), $answer->getUpperBound());
                                        if ($wrong_is_the_new_right == 1) {
                                            $combination_fulfilled = false;
                                        }
                                    }
                                    break;
                            }
                        } else {
                            if ($gap_key !== 'points') {
                                $combination_fulfilled = false;
                            }
                        }
                    }
                    if ($combination_fulfilled) {
                        $points += $points_for_combination;
                    }
                }
            }
        }
        return array($points, $gap_used_in_combination);
    }

References assQuestion\$points, CLOZE_NUMERIC, CLOZE_SELECT, CLOZE_TEXT, assQuestion\getId(), getNumericgapPoints(), and getTextgapPoints().

Referenced by calculateReachedPointsForSolution().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPoints()

assClozeTest::calculateReachedPoints	(	$active_id,
		$pass = `null`,
		$authorized = `true`,
		$returndetails = `false`
	)

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

The points are calculated from the given answers.

@access public

Parameters

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

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

Reimplemented from assQuestion.

Definition at line 1266 of file class.assClozeTest.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        if (is_null($pass)) {
            $pass = $this->getSolutionMaxPass($active_id);
        }
 
        $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorized);
        $user_result = array();
        while ($data = $ilDB->fetchAssoc($result)) {
            if (strcmp($data["value2"], "") != 0) {
                $user_result[$data["value1"]] = array(
                    "gap_id" => $data["value1"],
                    "value" => $data["value2"]
                );
            }
        }
 
        ksort($user_result); // this is required when identical scoring for same solutions is disabled
 
        if ($returndetails) {
            $detailed = array();
            $this->calculateReachedPointsForSolution($user_result, $detailed);
            return $detailed;
        }
 
        return $this->calculateReachedPointsForSolution($user_result);
    }

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

Here is the call graph for this function:

◆ calculateReachedPointsForSolution()

assClozeTest::calculateReachedPointsForSolution	(		$user_result,
		&	$detailed = `null`
	)

protected

Parameters

$user_result
$detailed

Returns: array

Definition at line 1887 of file class.assClozeTest.php.

    {
        if ($detailed === null) {
            $detailed = array();
        }
 
        $assClozeGapCombinationObj = new assClozeGapCombination();
        $combinations[1] = array();
        if ($assClozeGapCombinationObj->combinationExistsForQid($this->getId())) {
            $combinations = $this->calculateCombinationResult($user_result);
            $points = $combinations[0];
        }
        $counter = 0;
        $solution_values_text = array(); // for identical scoring checks
        $solution_values_select = array(); // for identical scoring checks
        $solution_values_numeric = array(); // for identical scoring checks
        foreach ($user_result as $gap_id => $value) {
            if (is_string($value)) {
                $value = array("value" => $value);
            }
 
            if (array_key_exists($gap_id, $this->gaps) && !array_key_exists($gap_id, $combinations[1])) {
                switch ($this->gaps[$gap_id]->getType()) {
                    case CLOZE_TEXT:
                        $gappoints = 0;
                        for ($order = 0; $order < $this->gaps[$gap_id]->getItemCount(); $order++) {
                            $answer = $this->gaps[$gap_id]->getItem($order);
                            $gotpoints = $this->getTextgapPoints($answer->getAnswertext(), $value["value"], $answer->getPoints());
                            if ($gotpoints > $gappoints) {
                                $gappoints = $gotpoints;
                            }
                        }
                        if (!$this->getIdenticalScoring()) {
                            // check if the same solution text was already entered
                            if ((in_array($value["value"], $solution_values_text)) && ($gappoints > 0)) {
                                $gappoints = 0;
                            }
                        }
                        $points += $gappoints;
                        $detailed[$gap_id] = array("points" => $gappoints, "best" => ($this->getMaximumGapPoints($gap_id) == $gappoints) ? true : false, "positive" => ($gappoints > 0) ? true : false);
                        array_push($solution_values_text, $value["value"]);
                        break;
                    case CLOZE_NUMERIC:
                        $gappoints = 0;
                        for ($order = 0; $order < $this->gaps[$gap_id]->getItemCount(); $order++) {
                            $answer = $this->gaps[$gap_id]->getItem($order);
                            $gotpoints = $this->getNumericgapPoints($answer->getAnswertext(), $value["value"], $answer->getPoints(), $answer->getLowerBound(), $answer->getUpperBound());
                            if ($gotpoints > $gappoints) {
                                $gappoints = $gotpoints;
                            }
                        }
                        if (!$this->getIdenticalScoring()) {
                            // check if the same solution value was already entered
                            include_once "./Services/Math/classes/class.EvalMath.php";
                            $eval = new EvalMath();
                            $eval->suppress_errors = true;
                            $found_value = false;
                            foreach ($solution_values_numeric as $solval) {
                                if ($eval->e($solval) == $eval->e($value["value"])) {
                                    $found_value = true;
                                }
                            }
                            if ($found_value && ($gappoints > 0)) {
                                $gappoints = 0;
                            }
                        }
                        $points += $gappoints;
                        $detailed[$gap_id] = array("points" => $gappoints, "best" => ($this->getMaximumGapPoints($gap_id) == $gappoints) ? true : false, "positive" => ($gappoints > 0) ? true : false);
                        array_push($solution_values_numeric, $value["value"]);
                        break;
                    case CLOZE_SELECT:
                        if ($value["value"] >= 0) {
                            for ($order = 0; $order < $this->gaps[$gap_id]->getItemCount(); $order++) {
                                $answer = $this->gaps[$gap_id]->getItem($order);
                                if ($value["value"] == $answer->getOrder()) {
                                    $answerpoints = $answer->getPoints();
                                    if (!$this->getIdenticalScoring()) {
                                        // check if the same solution value was already entered
                                        if ((in_array($answer->getAnswertext(), $solution_values_select)) && ($answerpoints > 0)) {
                                            $answerpoints = 0;
                                        }
                                    }
                                    $points += $answerpoints;
                                    $detailed[$gap_id] = array("points" => $answerpoints, "best" => ($this->getMaximumGapPoints($gap_id) == $answerpoints) ? true : false, "positive" => ($answerpoints > 0) ? true : false);
                                    array_push($solution_values_select, $answer->getAnswertext());
                                }
                            }
                        }
                        break;
                }
            }
        }
 
        return $points;
    }

References assQuestion\$points, calculateCombinationResult(), CLOZE_NUMERIC, CLOZE_SELECT, CLOZE_TEXT, getIdenticalScoring(), getMaximumGapPoints(), getNumericgapPoints(), and getTextgapPoints().

Referenced by calculateReachedPoints(), and calculateReachedPointsFromPreviewSession().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPointsFromPreviewSession()

assClozeTest::calculateReachedPointsFromPreviewSession ( ilAssQuestionPreviewSession $previewSession )

Reimplemented from assQuestion.

Definition at line 1983 of file class.assClozeTest.php.

    {
        $userSolution = array();
 
        foreach ($previewSession->getParticipantsSolution() as $key => $val) {
            $userSolution[$key] = array('gap_id' => $key, 'value' => $val);
        }
 
        $reachedPoints = $this->calculateReachedPointsForSolution($userSolution);
        $reachedPoints = $this->deductHintPointsFromReachedPoints($previewSession, $reachedPoints);
 
        return $this->ensureNonNegativePoints($reachedPoints);
    }

References calculateReachedPointsForSolution(), assQuestion\deductHintPointsFromReachedPoints(), assQuestion\ensureNonNegativePoints(), and ilAssQuestionPreviewSession\getParticipantsSolution().

Here is the call graph for this function:

◆ checkForValidFormula()

assClozeTest::checkForValidFormula ( $value )

Parameters

$value

Returns: int

Definition at line 1252 of file class.assClozeTest.php.

    {
        return preg_match("/^-?(\\d*)(,|\\.|\\/){0,1}(\\d*)$/", $value, $matches);
    }

◆ cleanQuestiontext()

assClozeTest::cleanQuestiontext ( $text )

Cleans cloze question text to remove attributes or tags from older ILIAS versions.

Parameters

string $text The cloze question text

Returns: string The cleaned cloze question text

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

    {
        // fau: fixGapReplace - mask dollars for replacement
        $text = str_replace('$', 'GAPMASKEDDOLLAR', $text);
        $text = preg_replace("/\[gap[^\]]*?\]/", "[gap]", $text);
        $text = preg_replace("/<gap([^>]*?)>/", "[gap]", $text);
        $text = str_replace("</gap>", "[/gap]", $text);
        $text = str_replace('GAPMASKEDDOLLAR', '$', $text);
        // fau.
        return $text;
    }

Referenced by loadFromDb(), and setClozeText().

Here is the caller graph for this function:

◆ clearGapAnswers()

assClozeTest::clearGapAnswers ( )

Removes all answers from the gaps.

@access public

See also: $gaps

Definition at line 729 of file class.assClozeTest.php.

    {
        foreach ($this->gaps as $gap_index => $gap) {
            $this->gaps[$gap_index]->clearItems();
        }
    }

◆ copyGapCombination()

assClozeTest::copyGapCombination	(	$orgID,
		$newID
	)

Definition at line 1065 of file class.assClozeTest.php.

    {
        $assClozeGapCombinationObj = new assClozeGapCombination();
        $array = $assClozeGapCombinationObj->loadFromDb($orgID);
        $assClozeGapCombinationObj->importGapCombinationToDb($newID, $array);
    }

Referenced by copyObject(), createNewOriginalFromThisDuplicate(), and duplicate().

Here is the caller graph for this function:

◆ copyObject()

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

Copies an assClozeTest object.

@access public

Definition at line 991 of file class.assClozeTest.php.

    {
        if ($this->getId() <= 0) {
            // The question has not been saved. It cannot be duplicated
            return;
        }
 
        $thisId = $this->getId();
        $thisObjId = $this->getObjId();
 
        $clone = $this;
        include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
        $original_id = assQuestion::_getOriginalId($this->getId());
        $clone->id = -1;
        $clone->setObjId($target_questionpool_id);
        if ($title) {
            $clone->setTitle($title);
        }
 
        $clone->saveToDb();
 
        if ($this->gap_combinations_exists) {
            $this->copyGapCombination($original_id, $clone->getId());
            $clone->saveToDb();
        }
 
        // copy question page content
        $clone->copyPageOfQuestion($original_id);
        // copy XHTML media objects
        $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
 
        $clone->onCopy($thisObjId, $thisId, $clone->getObjId(), $clone->getId());
 
        return $clone->getId();
    }

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

Here is the call graph for this function:

◆ createGapsFromQuestiontext()

assClozeTest::createGapsFromQuestiontext ( )

Create gap entries by parsing the question text.

@access public

See also: $gaps

Definition at line 674 of file class.assClozeTest.php.

    {
        include_once "./Modules/TestQuestionPool/classes/class.assClozeGap.php";
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerCloze.php";
        $search_pattern = "|\[gap\](.*?)\[/gap\]|i";
        preg_match_all($search_pattern, $this->getClozeText(), $found);
        $this->gaps = array();
        if (count($found[0])) {
            foreach ($found[1] as $gap_index => $answers) {
                // create text gaps by default
                $gap = new assClozeGap(CLOZE_TEXT);
                $textparams = preg_split("/(?<!\\\\),/", $answers);
                foreach ($textparams as $key => $value) {
                    $answer = new assAnswerCloze($value, 0, $key);
                    $gap->addItem($answer);
                }
                $this->gaps[$gap_index] = $gap;
            }
        }
    }

References CLOZE_TEXT, and getClozeText().

Referenced by setClozeText().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createNewOriginalFromThisDuplicate()

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

Definition at line 1027 of file class.assClozeTest.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();
 
        if ($this->gap_combinations_exists) {
            $this->copyGapCombination($sourceQuestionId, $clone->getId());
            $clone->saveToDb();
        }
        // copy question page content
        $clone->copyPageOfQuestion($sourceQuestionId);
        // copy XHTML media objects
        $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
 
        $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
 
        return $clone->id;
    }

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

Here is the call graph for this function:

◆ deleteAnswerText()

assClozeTest::deleteAnswerText	(	$gap_index,
		$answer_index
	)

Deletes the answer text of a gap with a given index and an answer with a given order.

The index of the first gap is 0, the index of the second gap is 1 and so on.

Parameters

integer	$gap_index	A nonnegative index of the n-th gap
integer	$answer_index	The order of the answer text @access public

See also: $gaps

Definition at line 1102 of file class.assClozeTest.php.

    {
        if (array_key_exists($gap_index, $this->gaps)) {
            if ($this->gaps[$gap_index]->getItemCount() == 1) {
                // this is the last answer text => remove the gap
                $this->deleteGap($gap_index);
            } else {
                // remove the answer text
                $this->gaps[$gap_index]->deleteItem($answer_index);
                $this->updateClozeTextFromGaps();
            }
        }
    }

References deleteGap(), and updateClozeTextFromGaps().

Here is the call graph for this function:

◆ deleteGap()

assClozeTest::deleteGap ( $gap_index )

Deletes a gap with a given index.

The index of the first gap is 0, the index of the second gap is 1 and so on.

Parameters

integer $gap_index A nonnegative index of the n-th gap @access public

See also: $gaps

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

    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $output = $this->getClozeText();
            foreach ($this->getGaps() as $replace_gap_index => $gap) {
                $answers = array();
                foreach ($gap->getItemsRaw() as $item) {
                    array_push($answers, str_replace(",", "\\,", $item->getAnswerText()));
                }
                if ($replace_gap_index == $gap_index) {
                    // fau: fixGapReplace - use replace function
                    $output = $this->replaceFirstGap($output, '');
                // fau.
                } else {
                    // fau: fixGapReplace - use replace function
                    $output = $this->replaceFirstGap($output, "[_gap]" . join(",", $answers) . "[/_gap]");
                    // fau.
                }
            }
            $output = str_replace("_gap]", "gap]", $output);
            $this->cloze_text = $output;
            unset($this->gaps[$gap_index]);
            $this->gaps = array_values($this->gaps);
        }
    }

References getClozeText(), getGaps(), and replaceFirstGap().

Referenced by deleteAnswerText().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ duplicate()

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

Duplicates an assClozeTest.

@access public

Reimplemented from assQuestion.

Definition at line 935 of file class.assClozeTest.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();
        }
        if ($this->gap_combinations_exists) {
            $this->copyGapCombination($this_id, $clone->getId());
        }
        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);
 
        $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
 
        return $clone->getId();
    }

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

Here is the call graph for this function:

◆ fetchAnswerValueForGap()

assClozeTest::fetchAnswerValueForGap	(	$userSolution,
		$gapIndex
	)

Definition at line 1997 of file class.assClozeTest.php.

    {
        $answerValue = '';
 
        foreach ($userSolution as $value1 => $value2) {
            if ($value1 == $gapIndex) {
                $answerValue = $value2;
                break;
            }
        }
 
        return $answerValue;
    }

◆ fetchSolutionSubmit()

assClozeTest::fetchSolutionSubmit ( $submit )

Definition at line 1328 of file class.assClozeTest.php.

    {
        $solutionSubmit = array();
        foreach ($submit as $key => $value) {
            if ($value === null || is_array($value)) {
                continue;
            }
 
            $trimmed_value = trim($value);
            if ($trimmed_value === '') {
                continue;
            }
 
            if (preg_match("/^gap_(\d+)/", $key, $matches)) {
                $gap = $this->getGap($matches[1]);
                if (!is_object($gap)
                    || $gap->getType() == CLOZE_SELECT && $trimmed_value == -1) {
                    continue;
                }
 
                if ($gap->getType() == CLOZE_NUMERIC && !is_numeric(str_replace(",", ".", $trimmed_value))) {
                    $trimmed_value = null;
                } elseif ($gap->getType() == CLOZE_NUMERIC) {
                    $trimmed_value = str_replace(",", ".", $trimmed_value);
                }
                $solutionSubmit[trim($matches[1])] = $trimmed_value;
            }
        }
 
        return $solutionSubmit;
    }

References CLOZE_NUMERIC, CLOZE_SELECT, and getGap().

Referenced by getSolutionSubmit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ flushGaps()

assClozeTest::flushGaps ( )

Deletes all gaps without changing the cloze text.

@access public

See also: $gaps

Definition at line 538 of file class.assClozeTest.php.

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

◆ getAdditionalTableName()

assClozeTest::getAdditionalTableName ( )

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

Returns: string The additional table name @access public

Reimplemented from assQuestion.

Definition at line 1518 of file class.assClozeTest.php.

    {
        return "qpl_qst_cloze";
    }

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

◆ getAnswerTableName()

assClozeTest::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns: string The answer table name @access public

Reimplemented from assQuestion.

Definition at line 1529 of file class.assClozeTest.php.

    {
        return array("qpl_a_cloze",'qpl_a_cloze_combi_res');
    }

◆ getAvailableAnswerOptions()

assClozeTest::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 1805 of file class.assClozeTest.php.

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

References $index, getGap(), and getGaps().

Here is the call graph for this function:

◆ getClozeText()

assClozeTest::getClozeText ( )

Returns the cloze text.

Returns: string The cloze text string @access public

See also: $cloze_text

Definition at line 571 of file class.assClozeTest.php.

    {
        return $this->cloze_text;
    }

References $cloze_text.

Referenced by createGapsFromQuestiontext(), deleteGap(), getClozeTextForHTMLOutput(), getRTETextWithMediaObjects(), isComplete(), lmMigrateQuestionTypeSpecificContent(), saveAdditionalQuestionDataToDb(), toJSON(), and updateClozeTextFromGaps().

Here is the caller graph for this function:

◆ getClozeTextForHTMLOutput()

assClozeTest::getClozeTextForHTMLOutput ( )

Returns the cloze text as HTML (with optional nl2br) Fix for Mantis 29987: We assume Tiny embeds any text in tags, so if no tags are present, we derive it's non-HTML content and apply nl2br.

Returns: string The cloze text string as HTML

See also: $cloze_text

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

                                                : string
    {
        $gaps = [];
        preg_match_all('/\[gap\].*?\[\/gap\]/', $this->getClozeText(), $gaps);
        $string_with_replaced_gaps = str_replace($gaps[0], '######GAP######', $this->getClozeText());
        $cleaned_text = $this->getHtmlQuestionContentPurifier()->purify(
            $string_with_replaced_gaps
        );
        $cleaned_text_with_gaps = preg_replace_callback('/######GAP######/', function ($match) use (&$gaps) {
            return array_shift($gaps[0]);
        }, $cleaned_text);
 
        if ($this->isAdditionalContentEditingModePageObject()
            || !(new ilSetting('advanced_editing'))->get('advanced_editing_javascript_editor') === 'tinymce') {
            $cleaned_text_with_gaps = nl2br($cleaned_text_with_gaps);
        }
 
        return $this->prepareTextareaOutput($cleaned_text_with_gaps, true);
    }

References $gaps, getClozeText(), assQuestion\getHtmlQuestionContentPurifier(), assQuestion\isAdditionalContentEditingModePageObject(), and assQuestion\prepareTextareaOutput().

Here is the call graph for this function:

◆ getEndTag()

assClozeTest::getEndTag ( )

Returns the end tag of a cloze gap.

Returns: string The end tag of a cloze gap @access public

See also: $end_tag

Definition at line 635 of file class.assClozeTest.php.

    {
        return $this->end_tag;
    }

References $end_tag.

◆ getExpressionTypes()

assClozeTest::getExpressionTypes ( )

Get all available expression types for a specific question.

Returns: array

Implements iQuestionCondition.

Definition at line 1728 of file class.assClozeTest.php.

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

References iQuestionCondition\EmptyAnswerExpression, iQuestionCondition\NumberOfResultExpression, iQuestionCondition\NumericResultExpression, iQuestionCondition\PercentageResultExpression, and iQuestionCondition\StringResultExpression.

◆ getFeedbackMode()

assClozeTest::getFeedbackMode ( )

Returns: string

Definition at line 655 of file class.assClozeTest.php.

    {
        return $this->feedbackMode;
    }

References $feedbackMode.

Referenced by saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

◆ getFixedTextLength()

assClozeTest::getFixedTextLength ( )

Gets the fixed text length for all text fields in the cloze question.

Returns: integer The text field length @access public

Definition at line 1551 of file class.assClozeTest.php.

    {
        return $this->fixedTextLength;
    }

References $fixedTextLength.

Referenced by saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

◆ getGap()

assClozeTest::getGap ( $gap_index = 0 )

Returns the gap at a given index.

Parameters

integer $gap_index A nonnegative index of the n-th gap

Returns: object The gap of the given index @access public

See also: $gaps

Definition at line 781 of file class.assClozeTest.php.

    {
        if (array_key_exists($gap_index, $this->gaps)) {
            return $this->gaps[$gap_index];
        } else {
            return null;
        }
    }

Referenced by addAnswerOptionValue(), fetchSolutionSubmit(), getAvailableAnswerOptions(), getSolutionSubmitValidation(), isAddableAnswerOptionValue(), saveWorkingData(), and validateSolutionSubmit().

Here is the caller graph for this function:

◆ getGapCombinations()

assClozeTest::getGapCombinations ( )

Definition at line 1593 of file class.assClozeTest.php.

    {
        return $this->gap_combinations;
    }

References $gap_combinations.

◆ getGapCombinationsExists()

assClozeTest::getGapCombinationsExists ( )

Definition at line 1588 of file class.assClozeTest.php.

    {
        return $this->gap_combinations_exists;
    }

References $gap_combinations_exists.

◆ getGapCount()

assClozeTest::getGapCount ( )

Returns the number of gaps.

Returns: integer The number of gaps @access public

See also: $gaps

Definition at line 743 of file class.assClozeTest.php.

    {
        if (is_array($this->gaps)) {
            return count($this->gaps);
        } else {
            return 0;
        }
    }

◆ getGaps()

assClozeTest::getGaps ( )

Returns the array of gaps.

Returns: array Array containing the gap objects of the cloze question gaps @access public

Definition at line 526 of file class.assClozeTest.php.

    {
        return $this->gaps;
    }

References $gaps.

Referenced by deleteGap(), getAvailableAnswerOptions(), isComplete(), setExportDetailsXLS(), toJSON(), and updateClozeTextFromGaps().

Here is the caller graph for this function:

◆ getIdenticalScoring()

assClozeTest::getIdenticalScoring ( )

Returns the identical scoring status of the question.

Returns: boolean The identical scoring status

See also: $identical_scoring @access User interface

Definition at line 1495 of file class.assClozeTest.php.

    {
        return ($this->identical_scoring) ? 1 : 0;
    }

Referenced by calculateReachedPointsForSolution(), and saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

◆ getMaximumGapPoints()

assClozeTest::getMaximumGapPoints ( $gap_index )

Returns the maximum points for a gap.

Parameters

integer $gap_index The index of the gap

Returns: double The maximum points for the gap @access public

See also: $points

Definition at line 1564 of file class.assClozeTest.php.

    {
        $points = 0;
        $gap_max_points = 0;
        if (array_key_exists($gap_index, $this->gaps)) {
            $gap = &$this->gaps[$gap_index];
            foreach ($gap->getItems($this->getShuffler()) as $answer) {
                if ($answer->getPoints() > $gap_max_points) {
                    $gap_max_points = $answer->getPoints();
                }
            }
            $points += $gap_max_points;
        }
        return $points;
    }

References assQuestion\$points.

Referenced by calculateReachedPointsForSolution().

Here is the caller graph for this function:

◆ getMaximumPoints()

assClozeTest::getMaximumPoints ( )

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

@access public

See also: $points

Reimplemented from assQuestion.

Definition at line 888 of file class.assClozeTest.php.

    {
        $assClozeGapCombinationObj = new assClozeGapCombination();
        $points = 0;
        $gaps_used_in_combination = array();
        if ($assClozeGapCombinationObj->combinationExistsForQid($this->getId())) {
            $points = $assClozeGapCombinationObj->getMaxPointsForCombination($this->getId());
            $gaps_used_in_combination = $assClozeGapCombinationObj->getGapsWhichAreUsedInCombination($this->getId());
        }
        foreach ($this->gaps as $gap_index => $gap) {
            if (!array_key_exists($gap_index, $gaps_used_in_combination)) {
                if ($gap->getType() == CLOZE_TEXT) {
                    $gap_max_points = 0;
                    foreach ($gap->getItems($this->getShuffler()) as $item) {
                        if ($item->getPoints() > $gap_max_points) {
                            $gap_max_points = $item->getPoints();
                        }
                    }
                    $points += $gap_max_points;
                } elseif ($gap->getType() == CLOZE_SELECT) {
                    $srpoints = 0;
                    foreach ($gap->getItems($this->getShuffler()) as $item) {
                        if ($item->getPoints() > $srpoints) {
                            $srpoints = $item->getPoints();
                        }
                    }
                    $points += $srpoints;
                } elseif ($gap->getType() == CLOZE_NUMERIC) {
                    $numpoints = 0;
                    foreach ($gap->getItems($this->getShuffler()) as $item) {
                        if ($item->getPoints() > $numpoints) {
                            $numpoints = $item->getPoints();
                        }
                    }
                    $points += $numpoints;
                }
            }
        }
 
        return $points;
    }

References assQuestion\$points, CLOZE_NUMERIC, CLOZE_SELECT, CLOZE_TEXT, and assQuestion\getId().

Referenced by isComplete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNumericgapPoints()

assClozeTest::getNumericgapPoints	(	$a_original,
		$a_entered,
		$max_points,
		$lowerBound,
		$upperBound
	)

Returns the points for a text gap and compares the given solution with the entered solution using the text gap rating options.

Parameters

string	$a_original	The original (correct) text
string	$a_entered	The text entered by the user
integer	$max_points	The maximum number of points for the solution @access public

Definition at line 1212 of file class.assClozeTest.php.

    {
        // fau: fixGapFormula - check entered value by evalMath
        //              if( ! $this->checkForValidFormula($a_entered) )
        //              {
        //                      return 0;
        //              }
 
        include_once "./Services/Math/classes/class.EvalMath.php";
        $eval = new EvalMath();
        $eval->suppress_errors = true;
        $result = 0;
 
        if ($eval->e($a_entered) === false) {
            return 0;
        } elseif (($eval->e($lowerBound) !== false) && ($eval->e($upperBound) !== false)) {
            // fau.
            if (($eval->e($a_entered) >= $eval->e($lowerBound)) && ($eval->e($a_entered) <= $eval->e($upperBound))) {
                $result = $max_points;
            }
        } elseif ($eval->e($lowerBound) !== false) {
            if (($eval->e($a_entered) >= $eval->e($lowerBound)) && ($eval->e($a_entered) <= $eval->e($a_original))) {
                $result = $max_points;
            }
        } elseif ($eval->e($upperBound) !== false) {
            if (($eval->e($a_entered) >= $eval->e($a_original)) && ($eval->e($a_entered) <= $eval->e($upperBound))) {
                $result = $max_points;
            }
        } else {
            if ($eval->e($a_entered) == $eval->e($a_original)) {
                $result = $max_points;
            }
        }
        return $result;
    }

References $result.

Referenced by calculateCombinationResult(), and calculateReachedPointsForSolution().

Here is the caller graph for this function:

◆ getOperators()

assClozeTest::getOperators ( $expression )

Get all available operations for a specific question.

Parameters

string $expression

Implements iQuestionCondition.

Definition at line 1718 of file class.assClozeTest.php.

    {
        require_once "./Modules/TestQuestionPool/classes/class.ilOperatorsExpressionMapping.php";
        return ilOperatorsExpressionMapping::getOperatorsByExpression($expression);
    }

References ilOperatorsExpressionMapping\getOperatorsByExpression().

Here is the call graph for this function:

◆ getQuestionType()

assClozeTest::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question @access public

Reimplemented from assQuestion.

Definition at line 1446 of file class.assClozeTest.php.

    {
        return "assClozeTest";
    }

Referenced by toJSON().

Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assClozeTest::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 1584 of file class.assClozeTest.php.

    {
        return parent::getRTETextWithMediaObjects() . $this->getClozeText();
    }

References getClozeText().

Here is the call graph for this function:

◆ getSolutionSubmit()

assClozeTest::getSolutionSubmit ( )

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

    {
        return $this->fetchSolutionSubmit($_POST);
    }

References $_POST, and fetchSolutionSubmit().

Referenced by saveWorkingData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSolutionSubmitValidation()

assClozeTest::getSolutionSubmitValidation ( )

Definition at line 1360 of file class.assClozeTest.php.

    {
        $submit = $_POST;
        $solutionSubmit = array();
 
        foreach ($submit as $key => $value) {
            if (preg_match("/^gap_(\d+)/", $key, $matches)) {
                if ($value !== null && $value !== '') {
                    $gap = $this->getGap($matches[1]);
                    if (is_object($gap)) {
                        if (!(($gap->getType() == CLOZE_SELECT) && ($value == -1))) {
                            if ($gap->getType() == CLOZE_NUMERIC) {
                                $value = str_replace(",", ".", $value);
                            }
                            $solutionSubmit[trim($matches[1])] = $value;
                        }
                    }
                }
            }
        }
 
        return $solutionSubmit;
    }

References $_POST, CLOZE_NUMERIC, CLOZE_SELECT, and getGap().

Referenced by validateSolutionSubmit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStartTag()

assClozeTest::getStartTag ( )

Returns the start tag of a cloze gap.

Returns: string The start tag of a cloze gap @access public

See also: $start_tag

Definition at line 611 of file class.assClozeTest.php.

    {
        return $this->start_tag;
    }

References $start_tag.

◆ getTextgapPoints()

assClozeTest::getTextgapPoints	(	$a_original,
		$a_entered,
		$max_points
	)

Returns the points for a text gap and compares the given solution with the entered solution using the text gap rating options.

Parameters

string	$a_original	The original (correct) text
string	$a_entered	The text entered by the user
integer	$max_points	The maximum number of points for the solution @access public

Definition at line 1159 of file class.assClozeTest.php.

    {
        include_once "./Services/Utilities/classes/class.ilStr.php";
        global $DIC;
        $refinery = $DIC->refinery();
        $result = 0;
        $gaprating = $this->getTextgapRating();
 
        switch ($gaprating) {
            case TEXTGAP_RATING_CASEINSENSITIVE:
                if (strcmp(ilStr::strToLower($a_original), ilStr::strToLower($a_entered)) == 0) {
                    $result = $max_points;
                }
                break;
            case TEXTGAP_RATING_CASESENSITIVE:
                if (strcmp($a_original, $a_entered) == 0) {
                    $result = $max_points;
                }
                break;
            case TEXTGAP_RATING_LEVENSHTEIN1:
                $transformation = $refinery->string()->levenshtein()->standard($a_original, 1);
                break;
            case TEXTGAP_RATING_LEVENSHTEIN2:
                $transformation = $refinery->string()->levenshtein()->standard($a_original, 2);
                break;
            case TEXTGAP_RATING_LEVENSHTEIN3:
                $transformation = $refinery->string()->levenshtein()->standard($a_original, 3);
                break;
            case TEXTGAP_RATING_LEVENSHTEIN4:
                $transformation = $refinery->string()->levenshtein()->standard($a_original, 4);
                break;
            case TEXTGAP_RATING_LEVENSHTEIN5:
                $transformation = $refinery->string()->levenshtein()->standard($a_original, 5);
                break;
        }
 
        // run answers against Levenshtein2 methods
        if (isset($transformation) && $transformation->transform($a_entered) >= 0) {
            $result = $max_points;
        }
        return $result;
    }

References $DIC, assQuestion\$refinery, $result, getTextgapRating(), ilStr\strToLower(), TEXTGAP_RATING_CASEINSENSITIVE, TEXTGAP_RATING_CASESENSITIVE, TEXTGAP_RATING_LEVENSHTEIN1, TEXTGAP_RATING_LEVENSHTEIN2, TEXTGAP_RATING_LEVENSHTEIN3, TEXTGAP_RATING_LEVENSHTEIN4, and TEXTGAP_RATING_LEVENSHTEIN5.

Referenced by calculateCombinationResult(), and calculateReachedPointsForSolution().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTextgapRating()

assClozeTest::getTextgapRating ( )

Returns the rating option for text gaps.

Returns: string The rating option for text gaps

See also: $textgap_rating @access User interface

Definition at line 1458 of file class.assClozeTest.php.

    {
        return $this->textgap_rating;
    }

References $textgap_rating.

Referenced by getTextgapPoints(), and saveAdditionalQuestionDataToDb().

Here is the caller graph for this function:

◆ isAddableAnswerOptionValue()

assClozeTest::isAddableAnswerOptionValue	(	$qIndex,
		$answerOptionValue
	)

Reimplemented from assQuestion.

Definition at line 2011 of file class.assClozeTest.php.

    {
        $gap = $this->getGap($qIndex);
 
        if ($gap->getType() != CLOZE_TEXT) {
            return false;
        }
 
        foreach ($gap->getItems(new ilArrayElementOrderKeeper()) as $item) {
            if ($item->getAnswertext() === $answerOptionValue) {
                return false;
            }
        }
 
        return true;
    }

References CLOZE_TEXT, and getGap().

Here is the call graph for this function:

◆ isComplete()

assClozeTest::isComplete ( )

Returns TRUE, if a cloze test is complete for use.

Returns: boolean TRUE, if the cloze test is complete for use, otherwise FALSE

Reimplemented from assQuestion.

Definition at line 140 of file class.assClozeTest.php.

    {
        if (strlen($this->getTitle())
            && $this->getAuthor()
            && $this->getClozeText()
            && count($this->getGaps())
            && $this->getMaximumPoints() > 0) {
            return true;
        }
        return false;
    }

References assQuestion\getAuthor(), getClozeText(), getGaps(), getMaximumPoints(), and assQuestion\getTitle().

Here is the call graph for this function:

◆ isValidNumericSubmitValue()

assClozeTest::isValidNumericSubmitValue ( $submittedValue )

protected

Definition at line 1297 of file class.assClozeTest.php.

    {
        if (is_numeric($submittedValue)) {
            return true;
        }
 
        if (preg_match('/^[-+]{0,1}\d+\/\d+$/', $submittedValue)) {
            return true;
        }
 
        return false;
    }

Referenced by validateSolutionSubmit().

Here is the caller graph for this function:

◆ lmMigrateQuestionTypeSpecificContent()

assClozeTest::lmMigrateQuestionTypeSpecificContent ( ilAssSelfAssessmentMigrator $migrator )

protected

Parameters

ilAssSelfAssessmentMigrator $migrator

Reimplemented from assQuestion.

Definition at line 1650 of file class.assClozeTest.php.

    {
        // DO NOT USE SETTER FOR CLOZE TEXT -> SETTER DOES RECREATE GAP OBJECTS without having gap type info ^^
        //$this->setClozeText( $migrator->migrateToLmContent($this->getClozeText()) );
        $this->cloze_text = $migrator->migrateToLmContent($this->getClozeText());
        // DO NOT USE SETTER FOR CLOZE TEXT -> SETTER DOES RECREATE GAP OBJECTS without having gap type info ^^
    }

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

Here is the call graph for this function:

◆ loadFromDb()

assClozeTest::loadFromDb ( $question_id )

Loads a assClozeTest object from a database.

Parameters

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

Reimplemented from assQuestion.

Definition at line 193 of file class.assClozeTest.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $result = $ilDB->queryF(
            "SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
            array("integer"),
            array($question_id)
        );
        if ($result->numRows() == 1) {
            $data = $ilDB->fetchAssoc($result);
            $this->setId($question_id);
            $this->setNrOfTries($data['nr_of_tries']);
            $this->setObjId($data["obj_fi"]);
            $this->setTitle($data["title"]);
            $this->setComment($data["description"]);
            $this->setOriginalId($data["original_id"]);
            $this->setAuthor($data["author"]);
            $this->setPoints($data["points"]);
            $this->setOwner($data["owner"]);
            $this->setQuestion($this->cleanQuestiontext($data["question_text"]));
            $this->setClozeText($data['cloze_text']);
            $this->setFixedTextLength($data["fixed_textlen"]);
            $this->setIdenticalScoring(($data['tstamp'] == 0) ? true : $data["identical_scoring"]);
            $this->setFeedbackMode($data['feedback_mode'] === null ? ilAssClozeTestFeedback::FB_MODE_GAP_QUESTION : $data['feedback_mode']);
 
            try {
                $this->setLifecycle(ilAssQuestionLifecycle::getInstance($data['lifecycle']));
            } catch (ilTestQuestionPoolInvalidArgumentException $e) {
                $this->setLifecycle(ilAssQuestionLifecycle::getDraftInstance());
            }
 
            // replacement of old syntax with new syntax
            include_once("./Services/RTE/classes/class.ilRTE.php");
            $this->question = ilRTE::_replaceMediaObjectImageSrc($this->question, 1);
            $this->cloze_text = ilRTE::_replaceMediaObjectImageSrc($this->cloze_text, 1);
            $this->setTextgapRating($data["textgap_rating"]);
            $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
 
            try {
                $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
            } catch (ilTestQuestionPoolException $e) {
            }
 
            // open the cloze gaps with all answers
            include_once "./Modules/TestQuestionPool/classes/class.assAnswerCloze.php";
            include_once "./Modules/TestQuestionPool/classes/class.assClozeGap.php";
            $result = $ilDB->queryF(
                "SELECT * FROM qpl_a_cloze WHERE question_fi = %s ORDER BY gap_id, aorder ASC",
                array("integer"),
                array($question_id)
            );
            if ($result->numRows() > 0) {
                $this->gaps = array();
                while ($data = $ilDB->fetchAssoc($result)) {
                    switch ($data["cloze_type"]) {
                        case CLOZE_TEXT:
                            if (!array_key_exists($data["gap_id"], $this->gaps)) {
                                $this->gaps[$data["gap_id"]] = new assClozeGap(CLOZE_TEXT);
                            }
                            $answer = new assAnswerCloze(
                                $data["answertext"],
                                $data["points"],
                                $data["aorder"]
                            );
                            $this->gaps[$data["gap_id"]]->setGapSize($data['gap_size']);
 
                            $this->gaps[$data["gap_id"]]->addItem($answer);
                            break;
                        case CLOZE_SELECT:
                            if (!array_key_exists($data["gap_id"], $this->gaps)) {
                                $this->gaps[$data["gap_id"]] = new assClozeGap(CLOZE_SELECT);
                                $this->gaps[$data["gap_id"]]->setShuffle($data["shuffle"]);
                            }
                            $answer = new assAnswerCloze(
                                $data["answertext"],
                                $data["points"],
                                $data["aorder"]
                            );
                            $this->gaps[$data["gap_id"]]->addItem($answer);
                            break;
                        case CLOZE_NUMERIC:
                            if (!array_key_exists($data["gap_id"], $this->gaps)) {
                                $this->gaps[$data["gap_id"]] = new assClozeGap(CLOZE_NUMERIC);
                            }
                            $answer = new assAnswerCloze(
                                $data["answertext"],
                                $data["points"],
                                $data["aorder"]
                            );
                            $this->gaps[$data["gap_id"]]->setGapSize($data['gap_size']);
                            $answer->setLowerBound($data["lowerlimit"]);
                            $answer->setUpperBound($data["upperlimit"]);
                            $this->gaps[$data["gap_id"]]->addItem($answer);
                            break;
                    }
                }
            }
        }
        $assClozeGapCombinationObj = new assClozeGapCombination();
        $check_for_gap_combinations = $assClozeGapCombinationObj->loadFromDb($question_id);
        if (count($check_for_gap_combinations) != 0) {
            $this->setGapCombinationsExists(true);
            $this->setGapCombinations($check_for_gap_combinations);
        }
        parent::loadFromDb($question_id);
    }

References $data, $DIC, Vendor\Package\$e, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), cleanQuestiontext(), CLOZE_NUMERIC, CLOZE_SELECT, CLOZE_TEXT, ilAssClozeTestFeedback\FB_MODE_GAP_QUESTION, getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), setClozeText(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), setFeedbackMode(), setFixedTextLength(), setGapCombinations(), setGapCombinationsExists(), assQuestion\setId(), setIdenticalScoring(), assQuestion\setLifecycle(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), setTextgapRating(), and assQuestion\setTitle().

Here is the call graph for this function:

◆ replaceFirstGap()

assClozeTest::replaceFirstGap	(	$gaptext,
		$content
	)

Replace the first gap in a string without treating backreferences.

Parameters

string	$gaptext	text with gap tags
string	$content	content for the first gap

Returns: string

Definition at line 178 of file class.assClozeTest.php.

    {
        $content = str_replace('$', 'GAPMASKEDDOLLAR', $content);
        $output = preg_replace("/\[gap\].*?\[\/gap\]/", $content, $gaptext, 1);
        $output = str_replace('GAPMASKEDDOLLAR', '$', $output);
 
        return $output;
    }

Referenced by deleteGap(), and updateClozeTextFromGaps().

Here is the caller graph for this function:

◆ saveAdditionalQuestionDataToDb()

assClozeTest::saveAdditionalQuestionDataToDb ( )

Saves the data for the additional data table.

This method uses the ugly DELETE-INSERT. Here, this does no harm.

Implements ilObjQuestionScoringAdjustable.

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

    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */
 
 
        $DIC->database()->manipulateF(
            "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
            array( "integer" ),
            array( $this->getId() )
        );
 
        $DIC->database()->insert($this->getAdditionalTableName(), array(
            'question_fi' => array('integer', $this->getId()),
            'textgap_rating' => array('text', $this->getTextgapRating()),
            'identical_scoring' => array('text', $this->getIdenticalScoring()),
            'fixed_textlen' => array('integer', $this->getFixedTextLength() ? $this->getFixedTextLength() : null),
            'cloze_text' => array('text', ilRTE::_replaceMediaObjectImageSrc($this->getClozeText(), 0)),
            'feedback_mode' => array('text', $this->getFeedbackMode())
        ));
    }

References $DIC, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), getClozeText(), getFeedbackMode(), getFixedTextLength(), assQuestion\getId(), getIdenticalScoring(), and getTextgapRating().

Referenced by saveToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAnswerSpecificDataToDb()

assClozeTest::saveAnswerSpecificDataToDb ( )

Save all gaps to the database.

Implements ilObjAnswerScoringAdjustable.

Definition at line 324 of file class.assClozeTest.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $ilDB->manipulateF(
            "DELETE FROM qpl_a_cloze WHERE question_fi = %s",
            array( "integer" ),
            array( $this->getId() )
        );
 
        foreach ($this->gaps as $key => $gap) {
            $this->saveClozeGapItemsToDb($gap, $key);
        }
    }

References $DIC, $ilDB, assQuestion\getId(), and saveClozeGapItemsToDb().

Referenced by saveToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveClozeGapItemsToDb()

assClozeTest::saveClozeGapItemsToDb	(	$gap,
		$key
	)

protected

Save all items belonging to one cloze gap to the db.

Parameters

$gap
$key

Definition at line 372 of file class.assClozeTest.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        foreach ($gap->getItems($this->getShuffler()) as $item) {
            $query = "";
            $next_id = $ilDB->nextId('qpl_a_cloze');
            switch ($gap->getType()) {
                case CLOZE_TEXT:
                    $this->saveClozeTextGapRecordToDb($next_id, $key, $item, $gap);
                    break;
                case CLOZE_SELECT:
                    $this->saveClozeSelectGapRecordToDb($next_id, $key, $item, $gap);
                    break;
                case CLOZE_NUMERIC:
                    $this->saveClozeNumericGapRecordToDb($next_id, $key, $item, $gap);
                    break;
            }
        }
    }

References $DIC, $ilDB, $query, CLOZE_NUMERIC, CLOZE_SELECT, CLOZE_TEXT, saveClozeNumericGapRecordToDb(), saveClozeSelectGapRecordToDb(), and saveClozeTextGapRecordToDb().

Referenced by saveAnswerSpecificDataToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveClozeNumericGapRecordToDb()

assClozeTest::saveClozeNumericGapRecordToDb	(	$next_id,
		$key,
		$item,
		$gap
	)

protected

Saves a gap-item record.

Parameters

$next_id	int Next Id for the record.
$key	int Gap Id
$item	gap Gap item data object.
$gap	gap Gap data object.

Definition at line 475 of file class.assClozeTest.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        include_once "./Services/Math/classes/class.EvalMath.php";
        $eval = new EvalMath();
        $eval->suppress_errors = true;
        $ilDB->manipulateF(
            "INSERT INTO qpl_a_cloze (answer_id, question_fi, gap_id, answertext, points, aorder, cloze_type, lowerlimit, upperlimit, gap_size) VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
            array(
                                "integer",
                                "integer",
                                "integer",
                                "text",
                                "float",
                                "integer",
                                "text",
                                "text",
                                "text",
                                "integer"
                            ),
            array(
                                $next_id,
                                $this->getId(),
                                $key,
                                strlen($item->getAnswertext()) ? $item->getAnswertext() : "",
                                $item->getPoints(),
                                $item->getOrder(),
                                $gap->getType(),
                                ($eval->e($item->getLowerBound() !== false) && strlen(
                                    $item->getLowerBound()
                                ) > 0) ? $item->getLowerBound() : $item->getAnswertext(),
                                ($eval->e($item->getUpperBound() !== false) && strlen(
                                    $item->getUpperBound()
                                ) > 0) ? $item->getUpperBound() : $item->getAnswertext(),
                                (int) $gap->getGapSize()
                            )
        );
    }

References $DIC, $ilDB, and assQuestion\getId().

Referenced by saveClozeGapItemsToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveClozeSelectGapRecordToDb()

assClozeTest::saveClozeSelectGapRecordToDb	(	$next_id,
		$key,
		$item,
		$gap
	)

protected

Saves a gap-item record.

Parameters

$next_id	int Next Id for the record.
$key	int Gap Id
$item	gap Gap item data object.
$gap	gap Gap data object.

Definition at line 438 of file class.assClozeTest.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilDB->manipulateF(
            "INSERT INTO qpl_a_cloze (answer_id, question_fi, gap_id, answertext, points, aorder, cloze_type, shuffle) VALUES (%s, %s, %s, %s, %s, %s, %s, %s)",
            array(
                                "integer",
                                "integer",
                                "integer",
                                "text",
                                "float",
                                "integer",
                                "text",
                                "text"
                            ),
            array(
                                $next_id,
                                $this->getId(),
                                $key,
                                strlen($item->getAnswertext()) ? $item->getAnswertext() : "",
                                $item->getPoints(),
                                $item->getOrder(),
                                $gap->getType(),
                                ($gap->getShuffle()) ? "1" : "0"
                            )
        );
    }

References $DIC, $ilDB, and assQuestion\getId().

Referenced by saveClozeGapItemsToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveClozeTextGapRecordToDb()

assClozeTest::saveClozeTextGapRecordToDb	(	$next_id,
		$key,
		$item,
		$gap
	)

protected

Saves a gap-item record.

Parameters

$next_id	int Next Id for the record.
$key	int Gap Id
$item	gap Gap item data object.
$gap	gap Gap data object.

Definition at line 401 of file class.assClozeTest.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilDB->manipulateF(
            "INSERT INTO qpl_a_cloze (answer_id, question_fi, gap_id, answertext, points, aorder, cloze_type, gap_size) VALUES (%s, %s, %s, %s, %s, %s, %s, %s)",
            array(
                                "integer",
                                "integer",
                                "integer",
                                "text",
                                "float",
                                "integer",
                                "text",
                                "integer"
                            ),
            array(
                                $next_id,
                                $this->getId(),
                                $key,
                                strlen($item->getAnswertext()) ? $item->getAnswertext() : "",
                                $item->getPoints(),
                                $item->getOrder(),
                                $gap->getType(),
                                (int) $gap->getGapSize()
                            )
        );
    }

References $DIC, $ilDB, and assQuestion\getId().

Referenced by saveClozeGapItemsToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePartial()

assClozeTest::savePartial ( )

Reimplemented from assQuestion.

Definition at line 2038 of file class.assClozeTest.php.

    {
        return true;
    }

◆ saveToDb()

assClozeTest::saveToDb ( $original_id = "" )

Saves a assClozeTest object to a database.

Parameters

int | string $original_id ID of the original question

Returns: mixed|void

@access public

Reimplemented from assQuestion.

Definition at line 312 of file class.assClozeTest.php.

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

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

Here is the call graph for this function:

◆ saveWorkingData()

assClozeTest::saveWorkingData	(	$active_id,
		$pass = `null`,
		$authorized = `true`
	)

Saves the learners input of the question to the database.

@access public

Parameters

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

Returns: boolean $status

Reimplemented from assQuestion.

Definition at line 1397 of file class.assClozeTest.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];
        if (is_null($pass)) {
            include_once "./Modules/Test/classes/class.ilObjTest.php";
            $pass = ilObjTest::_getPass($active_id);
        }
 
        $entered_values = 0;
 
        $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(function () use (&$entered_values, $active_id, $pass, $authorized) {
            $this->removeCurrentSolution($active_id, $pass, $authorized);
 
            foreach ($this->getSolutionSubmit() as $key => $value) {
                if ($value !== null && $value !== '') {
                    $gap = $this->getGap($key);
                    if (is_object($gap)) {
                        if (!(($gap->getType() == CLOZE_SELECT) && ($value == -1))) {
                            $this->saveCurrentSolution($active_id, $pass, $key, $value, $authorized);
                            $entered_values++;
                        }
                    }
                }
            }
        });
 
        if ($entered_values) {
            include_once("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
            if (ilObjAssessmentFolder::_enabledAssessmentLogging()) {
                assQuestion::logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
            }
        } else {
            include_once("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
            if (ilObjAssessmentFolder::_enabledAssessmentLogging()) {
                assQuestion::logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
            }
        }
 
        return true;
    }

References $DIC, $ilDB, $ilUser, $pass, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), CLOZE_SELECT, getGap(), assQuestion\getProcessLocker(), getSolutionSubmit(), assQuestion\logAction(), assQuestion\removeCurrentSolution(), and assQuestion\saveCurrentSolution().

Here is the call graph for this function:

◆ setClozeText()

assClozeTest::setClozeText ( $cloze_text = "" )

Evaluates the text gap solutions from the cloze text.

A single or multiple text gap solutions could be entered using the following syntax in the cloze text: solution1 [, solution2, ..., solutionN] enclosed in the text gap selector gap[]

Parameters

string $cloze_text The cloze text with all gaps and gap gaps @access public

See also: $cloze_text

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

    {
        $this->gaps = [];
        $this->cloze_text = $this->cleanQuestiontext($cloze_text);
        $this->createGapsFromQuestiontext();
    }

References $cloze_text, cleanQuestiontext(), and createGapsFromQuestiontext().

Referenced by loadFromDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setClozeTextValue()

assClozeTest::setClozeTextValue ( $cloze_text = "" )

Definition at line 559 of file class.assClozeTest.php.

    {
        $this->cloze_text = $cloze_text;
    }

References $cloze_text.

◆ setEndTag()

assClozeTest::setEndTag ( $end_tag = "[/gap]" )

Sets the end tag of a cloze gap.

Parameters

string $end_tag The end tag for a cloze gap @access public

See also: $end_tag

Definition at line 647 of file class.assClozeTest.php.

    {
        $this->end_tag = $end_tag;
    }

References $end_tag.

◆ setExportDetailsXLS()

assClozeTest::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 1611 of file class.assClozeTest.php.

    {
        parent::setExportDetailsXLS($worksheet, $startrow, $active_id, $pass);
 
        $solution = $this->getSolutionValues($active_id, $pass);
        $i = 1;
        foreach ($this->getGaps() as $gap_index => $gap) {
            $worksheet->setCell($startrow + $i, 0, $this->lng->txt("gap") . " $i");
            $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
            $checked = false;
            foreach ($solution as $solutionvalue) {
                if ($gap_index == $solutionvalue["value1"]) {
                    $string_escaping_org_value = $worksheet->getStringEscaping();
                    try {
                        $worksheet->setStringEscaping(false);
 
                        switch ($gap->getType()) {
                            case CLOZE_SELECT:
                                $worksheet->setCell($startrow + $i, 2, $gap->getItem($solutionvalue["value2"])->getAnswertext());
                                break;
                            case CLOZE_NUMERIC:
                            case CLOZE_TEXT:
                                $worksheet->setCell($startrow + $i, 2, $solutionvalue["value2"]);
                                break;
                        }
                    } finally {
                        $worksheet->setStringEscaping($string_escaping_org_value);
                    }
                }
            }
            $i++;
        }
 
        return $startrow + $i + 1;
    }

References $i, $pass, CLOZE_NUMERIC, CLOZE_SELECT, CLOZE_TEXT, getGaps(), and assQuestion\getSolutionValues().

Here is the call graph for this function:

◆ setFeedbackMode()

assClozeTest::setFeedbackMode ( $feedbackMode )

Parameters

string $feedbackMode

Definition at line 663 of file class.assClozeTest.php.

    {
        $this->feedbackMode = $feedbackMode;
    }

References $feedbackMode.

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ setFixedTextLength()

assClozeTest::setFixedTextLength ( $a_text_len )

Sets a fixed text length for all text fields in the cloze question.

Parameters

integer $a_text_len The text field length @access public

Definition at line 1540 of file class.assClozeTest.php.

    {
        $this->fixedTextLength = $a_text_len;
    }

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ setGapAnswerLowerBound()

assClozeTest::setGapAnswerLowerBound	(	$gap_index,
		$order,
		$bound
	)

Sets the lower bound of a gap with a given index and an answer with a given order.

The index of the first gap is 0, the index of the second gap is 1 and so on.

Parameters

integer	$gap_index	A nonnegative index of the n-th gap
integer	$order	The order of the answer text
string	$answer	The lower bound of the answer @access public

See also: $gaps

Definition at line 858 of file class.assClozeTest.php.

    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $this->gaps[$gap_index]->setItemLowerBound($order, $bound);
        }
    }

◆ setGapAnswerPoints()

assClozeTest::setGapAnswerPoints	(	$gap_index,
		$order,
		$points
	)

Sets the points of a gap with a given index and an answer with a given order.

The index of the first gap is 0, the index of the second gap is 1 and so on.

Parameters

integer	$gap_index	A nonnegative index of the n-th gap
integer	$order	The order of the answer text
string	$answer	The points of the answer @access public

See also: $gaps

Definition at line 807 of file class.assClozeTest.php.

    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $this->gaps[$gap_index]->setItemPoints($order, $points);
        }
    }

References assQuestion\$points.

◆ setGapAnswerUpperBound()

assClozeTest::setGapAnswerUpperBound	(	$gap_index,
		$order,
		$bound
	)

Sets the upper bound of a gap with a given index and an answer with a given order.

The index of the first gap is 0, the index of the second gap is 1 and so on.

Parameters

integer	$gap_index	A nonnegative index of the n-th gap
integer	$order	The order of the answer text
string	$answer	The upper bound of the answer @access public

See also: $gaps

Definition at line 875 of file class.assClozeTest.php.

    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $this->gaps[$gap_index]->setItemUpperBound($order, $bound);
        }
    }

◆ setGapCombinations()

assClozeTest::setGapCombinations ( $value )

Definition at line 1603 of file class.assClozeTest.php.

    {
        $this->gap_combinations = $value;
    }

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ setGapCombinationsExists()

assClozeTest::setGapCombinationsExists ( $value )

Definition at line 1598 of file class.assClozeTest.php.

    {
        $this->gap_combinations_exists = $value;
    }

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ setGapShuffle()

assClozeTest::setGapShuffle	(	$gap_index = `0`,
		$shuffle = `1`
	)

Sets the shuffle state of a gap with a given index.

The index of the first gap is 0, the index of the second gap is 1 and so on.

Parameters

integer	$index	A nonnegative index of the n-th gap
integer	$shuffle	Turn shuffle on (=1) or off (=0) @access public

See also: $gaps

Definition at line 716 of file class.assClozeTest.php.

    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $this->gaps[$gap_index]->setShuffle($shuffle);
        }
    }

References assQuestion\$shuffle.

◆ setGapSize()

assClozeTest::setGapSize	(	$gap_index,
		$order,
		$size
	)

Definition at line 790 of file class.assClozeTest.php.

    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $this->gaps[$gap_index]->setGapSize($size);
        }
    }

References $size.

◆ setGapType()

assClozeTest::setGapType	(	$gap_index,
		$gap_type
	)

Set the type of a gap with a given index.

@access private

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

    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $this->gaps[$gap_index]->setType($gap_type);
        }
    }

◆ setIdenticalScoring()

assClozeTest::setIdenticalScoring ( $a_identical_scoring )

Sets the identical scoring option for cloze questions.

Parameters

boolean $a_identical_scoring The identical scoring option for cloze questions

See also: $identical_scoring @access User interface

Definition at line 1507 of file class.assClozeTest.php.

    {
        $this->identical_scoring = ($a_identical_scoring) ? 1 : 0;
    }

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ setStartTag()

assClozeTest::setStartTag ( $start_tag = "[gap]" )

Sets the start tag of a cloze gap.

Parameters

string $start_tag The start tag for a cloze gap @access public

See also: $start_tag

Definition at line 623 of file class.assClozeTest.php.

    {
        $this->start_tag = $start_tag;
    }

References $start_tag.

◆ setTextgapRating()

assClozeTest::setTextgapRating ( $a_textgap_rating )

Sets the rating option for text gaps.

Parameters

string $a_textgap_rating The rating option for text gaps

See also: $textgap_rating @access User interface

Definition at line 1470 of file class.assClozeTest.php.

    {
        switch ($a_textgap_rating) {
            case TEXTGAP_RATING_CASEINSENSITIVE:
            case TEXTGAP_RATING_CASESENSITIVE:
            case TEXTGAP_RATING_LEVENSHTEIN1:
            case TEXTGAP_RATING_LEVENSHTEIN2:
            case TEXTGAP_RATING_LEVENSHTEIN3:
            case TEXTGAP_RATING_LEVENSHTEIN4:
            case TEXTGAP_RATING_LEVENSHTEIN5:
                $this->textgap_rating = $a_textgap_rating;
                break;
            default:
                $this->textgap_rating = TEXTGAP_RATING_CASEINSENSITIVE;
                break;
        }
    }

References TEXTGAP_RATING_CASEINSENSITIVE, TEXTGAP_RATING_CASESENSITIVE, TEXTGAP_RATING_LEVENSHTEIN1, TEXTGAP_RATING_LEVENSHTEIN2, TEXTGAP_RATING_LEVENSHTEIN3, TEXTGAP_RATING_LEVENSHTEIN4, and TEXTGAP_RATING_LEVENSHTEIN5.

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ toJSON()

assClozeTest::toJSON ( )

Returns a JSON representation of the question.

Reimplemented from assQuestion.

Definition at line 1661 of file class.assClozeTest.php.

    {
        include_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['clozetext'] = $this->formatSAQuestion($this->getClozeText());
        $result['nr_of_tries'] = (int) $this->getNrOfTries();
        $result['shuffle'] = (bool) $this->getShuffle();
        $result['feedback'] = array(
            'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
            'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
        );
 
        $gaps = array();
        foreach ($this->getGaps() as $key => $gap) {
            $items = array();
            foreach ($gap->getItems($this->getShuffler()) as $item) {
                $jitem = array();
                $jitem['points'] = $item->getPoints();
                $jitem['value'] = $this->formatSAQuestion($item->getAnswertext());
                $jitem['order'] = $item->getOrder();
                if ($gap->getType() == CLOZE_NUMERIC) {
                    $jitem['lowerbound'] = $item->getLowerBound();
                    $jitem['upperbound'] = $item->getUpperBound();
                } else {
                    $jitem['value'] = trim($jitem['value']);
                }
                array_push($items, $jitem);
            }
 
            if ($gap->getGapSize() && ($gap->getType() == CLOZE_TEXT || $gap->getType() == CLOZE_NUMERIC)) {
                $jgap['size'] = $gap->getGapSize();
            }
 
            $jgap['shuffle'] = $gap->getShuffle();
            $jgap['type'] = $gap->getType();
            $jgap['item'] = $items;
 
            array_push($gaps, $jgap);
        }
        $result['gaps'] = $gaps;
        $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
        $result['mobs'] = $mobs;
        return json_encode($result);
    }

References $gaps, $mobs, $result, ilObjMediaObject\_getMobsOfObject(), CLOZE_NUMERIC, CLOZE_TEXT, assQuestion\formatSAQuestion(), getClozeText(), getGaps(), assQuestion\getId(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), and assQuestion\getTitle().

Here is the call graph for this function:

◆ updateClozeTextFromGaps()

assClozeTest::updateClozeTextFromGaps ( )

Updates the gap parameters in the cloze text from the form input.

@access private

Definition at line 1077 of file class.assClozeTest.php.

    {
        $output = $this->getClozeText();
        foreach ($this->getGaps() as $gap_index => $gap) {
            $answers = array();
            foreach ($gap->getItemsRaw() as $item) {
                array_push($answers, str_replace([',', '['], ["\\,", '[&hairsp;'], $item->getAnswerText()));
            }
            // fau: fixGapReplace - use replace function
            $output = $this->replaceFirstGap($output, "[_gap]" . $this->prepareTextareaOutput(join(",", $answers), true) . "[/_gap]");
            // fau.
        }
        $output = str_replace("_gap]", "gap]", $output);
        $this->cloze_text = $output;
    }

References getClozeText(), getGaps(), assQuestion\prepareTextareaOutput(), and replaceFirstGap().

Referenced by deleteAnswerText().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateSolutionSubmit()

assClozeTest::validateSolutionSubmit ( )

Reimplemented from assQuestion.

Definition at line 1310 of file class.assClozeTest.php.

    {
        foreach ($this->getSolutionSubmitValidation() as $gapIndex => $value) {
            $gap = $this->getGap($gapIndex);
 
            if ($gap->getType() != CLOZE_NUMERIC) {
                continue;
            }
 
            if (strlen($value) && !$this->isValidNumericSubmitValue($value)) {
                ilUtil::sendFailure($this->lng->txt("err_no_numeric_value"), true);
                return false;
            }
        }
 
        return true;
    }

References CLOZE_NUMERIC, getGap(), getSolutionSubmitValidation(), isValidNumericSubmitValue(), and ilUtil\sendFailure().

Here is the call graph for this function:

Field Documentation

◆ $cloze_text

assClozeTest::$cloze_text

Definition at line 95 of file class.assClozeTest.php.

Referenced by getClozeText(), setClozeText(), and setClozeTextValue().

◆ $end_tag

assClozeTest::$end_tag

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

Referenced by getEndTag(), and setEndTag().

◆ $feedbackMode

assClozeTest::$feedbackMode = ilAssClozeTestFeedback::FB_MODE_GAP_QUESTION

protected

Definition at line 102 of file class.assClozeTest.php.

Referenced by getFeedbackMode(), and setFeedbackMode().

◆ $feedbackOBJ

assClozeTest::$feedbackOBJ

Definition at line 100 of file class.assClozeTest.php.

◆ $fixedTextLength

assClozeTest::$fixedTextLength

Definition at line 93 of file class.assClozeTest.php.

Referenced by getFixedTextLength().

◆ $gap_combinations

assClozeTest::$gap_combinations

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

Referenced by getGapCombinations().

◆ $gap_combinations_exists

assClozeTest::$gap_combinations_exists

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

Referenced by getGapCombinationsExists().

◆ $gaps

assClozeTest::$gaps

Definition at line 33 of file class.assClozeTest.php.

Referenced by getClozeTextForHTMLOutput(), getGaps(), and toJSON().

◆ $identical_scoring

assClozeTest::$identical_scoring

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

◆ $start_tag

assClozeTest::$start_tag

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

Referenced by getStartTag(), and setStartTag().

◆ $textgap_rating

assClozeTest::$textgap_rating

Definition at line 75 of file class.assClozeTest.php.

Referenced by getTextgapRating().

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

Modules/TestQuestionPool/classes/class.assClozeTest.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAnswerOptionValue()

◆ addGapAnswer()

◆ addGapAtIndex()

◆ addGapText()

◆ calculateCombinationResult()

◆ calculateReachedPoints()

◆ calculateReachedPointsForSolution()

◆ calculateReachedPointsFromPreviewSession()

◆ checkForValidFormula()

◆ cleanQuestiontext()

◆ clearGapAnswers()

◆ copyGapCombination()

◆ copyObject()

◆ createGapsFromQuestiontext()

◆ createNewOriginalFromThisDuplicate()

◆ deleteAnswerText()

◆ deleteGap()

◆ duplicate()

◆ fetchAnswerValueForGap()

◆ fetchSolutionSubmit()

◆ flushGaps()

◆ getAdditionalTableName()

◆ getAnswerTableName()

◆ getAvailableAnswerOptions()

◆ getClozeText()

◆ getClozeTextForHTMLOutput()

◆ getEndTag()

◆ getExpressionTypes()

◆ getFeedbackMode()

◆ getFixedTextLength()

◆ getGap()

◆ getGapCombinations()

◆ getGapCombinationsExists()

◆ getGapCount()

◆ getGaps()

◆ getIdenticalScoring()

◆ getMaximumGapPoints()

◆ getMaximumPoints()

◆ getNumericgapPoints()

◆ getOperators()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSolutionSubmit()

◆ getSolutionSubmitValidation()

◆ getStartTag()

◆ getTextgapPoints()

◆ getTextgapRating()

◆ isAddableAnswerOptionValue()

◆ isComplete()

◆ isValidNumericSubmitValue()

◆ lmMigrateQuestionTypeSpecificContent()

◆ loadFromDb()

◆ replaceFirstGap()

◆ saveAdditionalQuestionDataToDb()

◆ saveAnswerSpecificDataToDb()

◆ saveClozeGapItemsToDb()

◆ saveClozeNumericGapRecordToDb()

◆ saveClozeSelectGapRecordToDb()

◆ saveClozeTextGapRecordToDb()

◆ savePartial()

◆ saveToDb()

◆ saveWorkingData()

◆ setClozeText()

◆ setClozeTextValue()

◆ setEndTag()

◆ setExportDetailsXLS()

◆ setFeedbackMode()

◆ setFixedTextLength()

◆ setGapAnswerLowerBound()

◆ setGapAnswerPoints()

◆ setGapAnswerUpperBound()