assClozeTest Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. 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, $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 (bool $for_test=true, string $title="", string $author="", string $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, $authorizedSolution=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 ()
	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 (ilAssExcelFormatHelper $worksheet, int $startrow, int $active_id, int $pass)
	{} 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 $preview_session)
	fetchAnswerValueForGap ($userSolution, $gapIndex)
	isAddableAnswerOptionValue (int $qIndex, string $answerOptionValue)
	addAnswerOptionValue (int $qIndex, string $answerOptionValue, float $points)
	savePartial ()
Public Member Functions inherited from assQuestion
	__construct (string $title="", string $comment="", string $author="", int $owner=-1, string $question="")
	assQuestion constructor More...
	getShuffler ()
	setShuffler (Transformation $shuffler)
	setProcessLocker (ilAssQuestionProcessLocker $processLocker)
	getProcessLocker ()
	fromXML ($item, int $questionpool_id, ?int $tst_id, &$tst_object, int &$question_counter, array $import_mapping, array &$solutionhints=[])
	Receives parameters from a QTI parser and creates a valid ILIAS question object. More...
	toXML (bool $a_include_header=true, bool $a_include_binary=true, bool $a_shuffle=false, bool $test_output=false, bool $force_image_references=false)
	Returns a QTI xml representation of the question. More...
	isComplete ()
	Returns true, if a question is complete for use. More...
	questionTitleExists (int $questionpool_id, string $title)
	Returns TRUE if the question title exists in a question pool in the database. More...
	setTitle (string $title="")
	setId (int $id=-1)
	setTestId (int $id=-1)
	setComment (string $comment="")
	setOutputType (int $outputType=OUTPUT_HTML)
	setShuffle (?bool $shuffle=true)
	setAuthor (string $author="")
	setOwner (int $owner=-1)
	getTitle ()
	getTitleForHTMLOutput ()
	getTitleFilenameCompliant ()
	getId ()
	getShuffle ()
	getTestId ()
	getComment ()
	getDescriptionForHTMLOutput ()
	getThumbSize ()
	setThumbSize (int $a_size)
	getMinimumThumbSize ()
	getMaximumThumbSize ()
	getOutputType ()
	supportsJavascriptOutput ()
	supportsNonJsOutput ()
	requiresJsSwitch ()
	getAuthor ()
	getAuthorForHTMLOutput ()
	getOwner ()
	getObjId ()
	setObjId (int $obj_id=0)
	getLifecycle ()
	setLifecycle (ilAssQuestionLifecycle $lifecycle)
	setExternalId (?string $external_id)
	getExternalId ()
	getSuggestedSolutionOutput ()
	_getSuggestedSolution (int $question_id, int $subquestion_index=0)
	loadSuggestedSolution (int $question_id, int $subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...
	getSuggestedSolutions ()
	getReachedPoints (int $active_id, int $pass)
	getMaximumPoints ()
	getAdjustedReachedPoints (int $active_id, int $pass, bool $authorizedSolution=true)
	returns the reached points ... More...
	calculateResultsFromSolution (int $active_id, int $pass, bool $obligationsEnabled=false)
	Calculates the question results from a previously saved question solution. More...
	persistWorkingState (int $active_id, $pass, bool $obligationsEnabled=false, bool $authorized=true)
	persists the working state for current testactive and testpass More...
	persistPreviewState (ilAssQuestionPreviewSession $previewSession)
	persists the preview state for current user and question More...
	validateSolutionSubmit ()
	saveWorkingData (int $active_id, int $pass, bool $authorized=true)
	Saves the learners input of the question to the database. More...
	moveUploadedMediaFile (string $file, string $name)
	Move an uploaded media file to an public accessible temp dir to present it. More...
	getSuggestedSolutionPath ()
	getImagePath ($question_id=null, $object_id=null)
	Returns the image path for web accessable images of a question. More...
	buildImagePath ($questionId, $parentObjectId)
	getFlashPath ()
	Returns the image path for web accessable flash files of a question. More...
	getSuggestedSolutionPathWeb ()
	getImagePathWeb ()
	Returns the web image path for web accessable images of a question. More...
	getTestOutputSolutions (int $activeId, int $pass)
	getUserSolutionPreferingIntermediate (int $active_id, $pass=null)
	getSolutionValues ($active_id, $pass=null, bool $authorized=true)
	Loads solutions of a given user from the database an returns it. More...
	isInUse (int $question_id=0)
	Checks whether the question is in use or not in pools or tests. More...
	usageNumber (int $question_id=0)
	Returns the number of place the question is in use in pools or tests. More...
	isClone (int $question_id=0)
	Checks whether the question is a clone of another question or not. More...
	getAdditionalTableName ()
	getAnswerTableName ()
	deleteAnswers (int $question_id)
	deleteAdditionalTableData (int $question_id)
	delete (int $question_id)
	getTotalAnswers ()
	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)
	syncXHTMLMediaObjectsOfQuestion ()
	createPageObject ()
	copyPageOfQuestion (int $a_q_id)
	getPageOfQuestion ()
	setOriginalId (?int $original_id)
	getOriginalId ()
	fixSvgToPng (string $imageFilenameContainingString)
	fixUnavailableSkinImageSources (string $html)
	loadFromDb (int $question_id)
	createNewQuestion (bool $a_create_page=true)
	Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...
	saveQuestionDataToDb (int $original_id=-1)
	saveToDb ()
	setNewOriginalId (int $newId)
	deleteSuggestedSolutions ()
	getSuggestedSolution (int $subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...
	getSuggestedSolutionTitle (int $subquestion_index=0)
	Returns the title of a suggested solution at a given subquestion_index. More...
	setSuggestedSolution (string $solution_id="", int $subquestion_index=0, bool $is_import=false)
	Sets a suggested solution for the question. More...
	updateSuggestedSolutions (int $original_id=-1, int $original_obj_id=-1)
	_resolveInternalLink (string $internal_link)
	_resolveIntLinks (int $question_id)
	syncWithOriginal ()
	_questionExists ($question_id)
	Returns true if the question already exists in the database. More...
	_questionExistsInPool (int $question_id)
	getPoints ()
	setPoints (float $points)
	getSolutionMaxPass (int $active_id)
	calculateReachedPoints ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
	Returns the points, a learner has reached answering the question. More...
	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $previewSession, $reachedPoints)
	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)
	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)
	adjustReachedPointsByScoringOptions ($points, $active_id, $pass=null)
	Adjust the given reached points by checks for all special scoring options in the test container. More...
	isHTML ($a_text)
	Checks if a given string contains HTML or not. More...
	prepareTextareaOutput (string $txt_output, bool $prepare_for_latex_output=false, bool $omitNl2BrWhenTextArea=false)
	QTIMaterialToString (ilQTIMaterial $a_material)
	Reads an QTI material tag and creates a text or XHTML string. More...
	addQTIMaterial (ilXmlWriter $a_xml_writer, string $a_material, bool $close_material_tag=true, bool $add_mobs=true)
	buildHashedImageFilename (string $plain_image_filename, bool $unique=false)
	getQuestion ()
	getQuestionForHTMLOutput ()
	setQuestion (string $question="")
	getQuestionType ()
	Returns the question type of the question. More...
	getQuestionTypeID ()
	syncHints ()
	cleanupMediaObjectUsage ()
	getInstances ()
	getActiveUserData (int $active_id)
	Returns the user id and the test id for a given active id. More...
	hasSpecificFeedback ()
	setExportDetailsXLS (ilAssExcelFormatHelper $worksheet, int $startrow, int $active_id, int $pass)
	__get ($value)
	Object getter. More...
	__set ($key, $value)
	Object setter. More...
	__isset ($key)
	Object issetter. More...
	getNrOfTries ()
	setNrOfTries (int $a_nr_of_tries)
	setExportImagePath (string $path)
	formatSAQuestion ($a_q)
	setPreventRteUsage (bool $prevent_rte_usage)
	getPreventRteUsage ()
	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)
	setSelfAssessmentEditingMode (bool $selfassessmenteditingmode)
	getSelfAssessmentEditingMode ()
	setDefaultNrOfTries (int $defaultnroftries)
	getDefaultNrOfTries ()
	syncSkillAssignments (int $srcParentId, int $srcQuestionId, int $trgParentId, int $trgQuestionId)
	ensureHintPageObjectExists ($pageObjectId)
	isAnswered (int $active_id, int $pass)
	isAutosaveable ()
	getAdditionalContentEditingMode ()
	setAdditionalContentEditingMode (?string $additionalContentEditingMode)
	isAdditionalContentEditingModePageObject ()
	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)
	getValidAdditionalContentEditingModes ()
	getHtmlUserSolutionPurifier ()
	getHtmlQuestionContentPurifier ()
	setLastChange ($lastChange)
	getLastChange ()
	removeIntermediateSolution (int $active_id, int $pass)
	removeCurrentSolution (int $active_id, int $pass, bool $authorized=true)
	saveCurrentSolution (int $active_id, int $pass, $value1, $value2, bool $authorized=true, $tstamp=0)
	updateCurrentSolution (int $solutionId, $value1, $value2, bool $authorized=true)
	updateCurrentSolutionsAuthorization (int $activeId, int $pass, bool $authorized, bool $keepTime=false)
	setStep ($step)
	getStep ()
	toJSON ()
	duplicate (bool $for_test=true, string $title="", string $author="", string $owner="", $testObjId=null)
	intermediateSolutionExists (int $active_id, int $pass)
	authorizedSolutionExists (int $active_id, ?int $pass)
	authorizedOrIntermediateSolutionExists (int $active_id, int $pass)
	lookupForExistingSolutions (int $activeId, int $pass)
	Lookup if an authorized or intermediate solution exists. More...
	isAddableAnswerOptionValue (int $qIndex, string $answerOptionValue)
	addAnswerOptionValue (int $qIndex, string $answerOptionValue, float $points)
	removeAllExistingSolutions ()
	removeExistingSolutions (int $activeId, int $pass)
	resetUsersAnswer (int $activeId, int $pass)
	removeResultRecord (int $activeId, int $pass)
	fetchValuePairsFromIndexedValues (array $indexedValues)
	fetchIndexedValuesFromValuePairs (array $valuePairs)
	areObligationsToBeConsidered ()
	setObligationsToBeConsidered (bool $obligationsToBeConsidered)
	updateTimestamp ()
	getTestPresentationConfig ()
	savePartial ()
	isInActiveTest ()
Public Member Functions inherited from iQuestionCondition
	getUserQuestionResult ($active_id, $pass)
	Get the user solution for a question by active_id and the test pass. More...

Data Fields
array	$gaps = []
	$gap_combinations
	$gap_combinations_exists
	$start_tag
	$end_tag
	$textgap_rating
	$identical_scoring
	$fixedTextLength
	$cloze_text
ilAssQuestionFeedback	$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	TRIM_PATTERN = '/^[\p{C}\p{Z}]+|[\p{C}\p{Z}]+$/u'
const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'
const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'
ilAssQuestionFeedback	$feedbackOBJ
bool	$prevent_rte_usage = false
bool	$selfassessmenteditingmode = false
int	$defaultnroftries = 0
string	$questionActionCmd = 'handleQuestionAction'
const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'
Data Fields inherited from iQuestionCondition
const	StringResultExpression = '~TEXT~'
const	PercentageResultExpression = '%n%'
const	NumericResultExpression = '#n#'
const	MatchingResultExpression = ';n:m;'
const	OrderingResultExpression = '$n,m,o,p$'
const	NumberOfResultExpression = '+n+'
const	ExclusiveResultExpression = '*n,m,o,p*'
const	EmptyAnswerExpression = "?"

Protected Member Functions
	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 (string $postSubmissionFieldname)
	ensureCurrentTestPass (int $active_id, int $pass)
	lookupCurrentTestPass (int $active_id, int $pass)
	lookupTestId (int $active_id)
	Move to ilObjTest or similar More...
	log (int $active_id, string $langVar)
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	deletePageOfQuestion (int $question_id)
	onDuplicate (int $originalParentId, int $originalQuestionId, int $duplicateParentId, int $duplicateQuestionId)
	beforeSyncWithOriginal (int $origQuestionId, int $dupQuestionId, int $origParentObjId, int $dupParentObjId)
	afterSyncWithOriginal (int $origQuestionId, int $dupQuestionId, int $origParentObjId, int $dupParentObjId)
	onCopy (int $sourceParentId, int $sourceQuestionId, int $targetParentId, int $targetQuestionId)
	duplicateSuggestedSolutionFiles (int $parent_id, int $question_id)
	Duplicates the files of a suggested solution if the question is duplicated. More...
	syncSuggestedSolutionFiles (int $target_question_id, int $target_obj_id)
	copySuggestedSolutionFiles (int $source_questionpool_id, int $source_question_id)
	ensureNonNegativePoints ($points)
	purifyAndPrepareTextAreaOutput (string $content)
	getRTETextWithMediaObjects ()
	getSelfAssessmentFormatter ()
	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)
	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)
	duplicateQuestionHints (int $originalQuestionId, int $duplicateQuestionId)
	duplicateSkillAssignments (int $srcParentId, int $srcQuestionId, int $trgParentId, int $trgQuestionId)
	buildQuestionDataQuery ()
	getCurrentSolutionResultSet (int $active_id, int $pass, bool $authorized=true)
	removeSolutionRecordById (int $solutionId)
	getSolutionRecordById (int $solutionId)
	deleteDummySolutionRecord (int $activeId, int $passIndex)
	isDummySolutionRecord (array $solutionRecord)
	deleteSolutionRecordByValues (int $activeId, int $passIndex, bool $authorized, array $matchValues)
	duplicateIntermediateSolutionAuthorized (int $activeId, int $passIndex)
	forceExistingIntermediateSolution (int $activeId, int $passIndex, bool $considerDummyRecordCreation)
	lookupMaxStep (int $active_id, int $pass)
	buildTestPresentationConfig ()
	build basic test question configuration instance More...

Protected Attributes
	$feedbackMode = ilAssClozeTestFeedback::FB_MODE_GAP_QUESTION
Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery
ILIAS DI LoggingServices	$ilLog
int	$id
string	$title
string	$comment
string	$owner
string	$author
int	$thumb_size
string	$question
	The question text. More...
float	$points
	The maximum available points for the question. More...
bool	$shuffle
	Indicates whether the answers will be shuffled or not. More...
int	$test_id
	The database id of a test in which the question is contained. More...
int	$obj_id = 0
	Object id of the container object. More...
	$ilias
ilGlobalPageTemplate	$tpl
ilLanguage	$lng
ilDBInterface	$db
Container	$dic
int	$outputType = OUTPUT_JAVASCRIPT
	Contains the output type of a question. More...
array	$suggested_solutions
int	$original_id = null
	$page
string	$external_id = null
ilAssQuestionProcessLocker	$processLocker
	$step
	$lastChange
Transformation	$shuffler
ilTestQuestionConfig	$testQuestionConfig
ilAssQuestionLifecycle	$lifecycle
ilObjUser	$current_user

Private Attributes
RandomGroup	$randomGroup

Additional Inherited Members
Static Public Member Functions inherited from assQuestion
static	setForcePassResultUpdateEnabled (bool $forcePassResultsUpdateEnabled)
static	isForcePassResultUpdateEnabled ()
static	isAllowedImageMimeType ($mimeType)
static	fetchMimeTypeIdentifier (string $contentType)
static	getAllowedFileExtensionsForMimeType (string $mimeType)
static	isAllowedImageFileExtension (string $mimeType, string $fileExtension)
static	getAllowedImageMaterialFileExtensions ()
static	_getMaximumPoints (int $question_id)
	Returns the maximum points, a learner can reach answering the question. More...
static	_getQuestionInfo (int $question_id)
static	_getSuggestedSolutionCount (int $question_id)
static	_getSuggestedSolutionOutput (int $question_id)
static	_getReachedPoints (int $active_id, int $question_id, int $pass)
static	_updateTestResultCache (int $active_id, ilAssQuestionProcessLocker $processLocker=null)
	Move this to a proper place. More...
static	logAction (string $logtext, int $active_id, int $question_id)
static	getQuestionTypeFromDb (int $question_id)
static	_getTotalRightAnswers (int $a_q_id)
static	_getTitle (int $a_q_id)
static	_getQuestionText (int $a_q_id)
static	isFileAvailable (string $file)
static	_getQuestionType (int $question_id)
static	_getQuestionTitle (int $question_id)
static	saveOriginalId (int $questionId, int $originalId)
static	resetOriginalId (int $questionId)
static	_getInternalLinkHref (string $target="")
static	_getOriginalId (int $question_id)
static	originalQuestionExists (int $questionId)
static	_instanciateQuestion (int $question_id)
static	_instantiateQuestion (int $question_id)
static	instantiateQuestion (int $question_id)
static	_getSolutionMaxPass (int $question_id, int $active_id)
	Returns the maximum pass a users question solution. More...
static	_isWriteable (int $question_id, int $user_id)
static	_isUsedInRandomTest (int $question_id)
static	_isWorkedThrough (int $active_id, int $question_id, int $pass)
	Returns true if the question was worked through in the given pass Worked through means that the user entered at least one value. More...
static	_areAnswered (int $a_user_id, array $a_question_ids)
	Checks if an array of question ids is answered by a user or not. More...
static	_setReachedPoints (int $active_id, int $question_id, float $points, float $maxpoints, int $pass, bool $manualscoring, bool $obligationsEnabled)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...
static	_needsManualScoring (int $question_id)
static	_includeClass (string $question_type, int $gui=0)
static	getFeedbackClassNameByQuestionType (string $questionType)
static	isCoreQuestionType (string $questionType)
static	includeCoreClass ($questionType, $withGuiClass)
static	_getQuestionTypeName ($type_tag)
static	_instanciateQuestionGUI (int $question_id)
static	instantiateQuestionGUI (int $a_question_id)
static	_questionExistsInTest (int $question_id, int $test_id)
static	lookupParentObjId (int $questionId)
static	lookupOriginalParentObjId (int $originalQuestionId)
	returns the parent object id for given original question id (should be a qpl id, but theoretically it can be a tst id, too) More...
static	isObligationPossible (int $questionId)
static	implodeKeyValues (array $keyValues)
static	explodeKeyValues (string $keyValues)
static	convertISO8601FormatH_i_s_ExtendedToSeconds (string $time)
static	missingResultRecordExists (int $activeId, int $pass, array $questionIds)
static	getQuestionsMissingResultRecord (int $activeId, int $pass, array $questionIds)
static	lookupResultRecordExist (int $activeId, int $questionId, int $pass)
static	extendedTrim (string $value)
	Trim non-printable characters from the beginning and end of a string. More...
Static Protected Member Functions inherited from assQuestion
static	getNumExistingSolutionRecords (int $activeId, int $pass, int $questionId)
Static Protected Attributes inherited from assQuestion
static	$allowedFileExtensionsByMimeType
static	$allowedCharsetsByMimeType
static	$allowedImageMaterialFileExtensionsByMimeType
static	$forcePassResultsUpdateEnabled = false
static	$imageSourceFixReplaceMap

Detailed Description

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

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

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

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

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

      {
        global $DIC;

        parent::__construct($title, $comment, $author, $owner, $question);
        $this->start_tag = "[gap]";
        $this->end_tag = "[/gap]";
        $this->gaps = [];
        $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 = [];
        $this->randomGroup = $DIC->refinery()->random();
    }

Here is the call graph for this function:

Member Function Documentation

addAnswerOptionValue()

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

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

References getGap().

                                                                                               : void
    {
        $gap = $this->getGap($qIndex); /* @var assClozeGap $gap */

        $item = new assAnswerCloze($answerOptionValue, $points);
        $item->setOrder($gap->getItemCount());

        $gap->addItem($item);
    }

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 public

See also

$gaps

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

References CLOZE_NUMERIC.

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

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 public

See also

$gaps

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

References $index.

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

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 public

See also

$gaps

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

                                          : void
    {
        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 1806 of file class.assClozeTest.php.

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

Referenced by calculateReachedPointsForSolution().

                                                            : array
    {
        $points = 0;

        $assClozeGapCombinationObj = new assClozeGapCombination();
        $gap_used_in_combination = [];
        if ($assClozeGapCombinationObj->combinationExistsForQid($this->getId())) {
            $combinations_for_question = $assClozeGapCombinationObj->getCleanCombinationArray($this->getId());
            $gap_answers = [];

            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 = '';
                                    if ($answer !== null) {
                                        $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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

calculateReachedPoints()

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

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

The points are calculated from the given answers.

public

Parameters

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

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

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

Referenced by getExpressionTypes().

    {
        $ilDB = $this->db;

        if (is_null($pass)) {
            $pass = $this->getSolutionMaxPass($active_id);
        }

        $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);
        $user_result = [];
        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 = [];
            $this->calculateReachedPointsForSolution($user_result, $detailed);
            return $detailed;
        }

        return $this->calculateReachedPointsForSolution($user_result);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

calculateReachedPointsForSolution()

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

protected

Parameters

array	$user_result
array	$detailed

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

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

Referenced by calculateReachedPoints(), and calculateReachedPointsFromPreviewSession().

                                                                                         : float
    {
        if ($detailed === null) {
            $detailed = [];
        }

        $points = 0;

        $assClozeGapCombinationObj = new assClozeGapCombination();
        $combinations[1] = [];
        if ($assClozeGapCombinationObj->combinationExistsForQid($this->getId())) {
            $combinations = $this->calculateCombinationResult($user_result);
            $points = $combinations[0];
        }
        $counter = 0;
        $solution_values_text = []; // for identical scoring checks
        $solution_values_select = []; // for identical scoring checks
        $solution_values_numeric = []; // 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

calculateReachedPointsFromPreviewSession()

assClozeTest::calculateReachedPointsFromPreviewSession

(

ilAssQuestionPreviewSession

$preview_session

)

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

References ILIAS\LTI\ToolProvider\$key, calculateReachedPointsForSolution(), assQuestion\deductHintPointsFromReachedPoints(), assQuestion\ensureNonNegativePoints(), and ilAssQuestionPreviewSession\getParticipantsSolution().

    {
        $participant_session = $preview_session->getParticipantsSolution();

        if (!is_array($participant_session)) {
            return 0;
        }

        $user_solution = [];

        foreach ($participant_session as $key => $val) {
            $user_solution[$key] = array('gap_id' => $key, 'value' => $val);
        }

        $reached_points = $this->calculateReachedPointsForSolution($user_solution);
        $reached_points = $this->deductHintPointsFromReachedPoints($preview_session, $reached_points);

        return $this->ensureNonNegativePoints($reached_points);
    }

Here is the call graph for this function:

checkForValidFormula()

assClozeTest::checkForValidFormula

(

$value

)

Parameters

$value

Returns

int

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

                                                : int
    {
        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 169 of file class.assClozeTest.php.

Referenced by loadFromDb(), and setClozeText().

                                            : string
    {
        // 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;
    }

Here is the caller graph for this function:

clearGapAnswers()

assClozeTest::clearGapAnswers

(

)

Removes all answers from the gaps.

public

See also

$gaps

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

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

copyGapCombination()

assClozeTest::copyGapCombination	(		$orgID,
			$newID
	)

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

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

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

Here is the caller graph for this function:

copyObject()

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

Copies an assClozeTest object.

public

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

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

                                                                    : int
    {
        if ($this->getId() <= 0) {
            throw new RuntimeException('The question has not been saved. It cannot be duplicated');
        }

        $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();
    }

Here is the call graph for this function:

createGapsFromQuestiontext()

assClozeTest::createGapsFromQuestiontext

(

)

Create gap entries by parsing the question text.

public

See also

$gaps

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

References ILIAS\LTI\ToolProvider\$key, CLOZE_TEXT, and getClozeText().

Referenced by setClozeText().

                                                : void
    {
        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 = [];
        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;
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createNewOriginalFromThisDuplicate()

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

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

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

                                                                                                  : int
    {
        if ($this->getId() <= 0) {
            throw new RuntimeException('The question has not been saved. It cannot be duplicated');
        }

        include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");

        $sourceQuestionId = $this->id;
        $sourceParentId = $this->getObjId();

        // duplicate the question in database
        $clone = $this;
        $clone->id = -1;

        $clone->setObjId($targetParentId);

        if ($targetQuestionTitle) {
            $clone->setTitle($targetQuestionTitle);
        }

        $clone->saveToDb();

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

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 public

See also

$gaps

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

References deleteGap(), and updateClozeTextFromGaps().

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

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 public

See also

$gaps

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

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

Referenced by deleteAnswerText().

                                         : void
    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $output = $this->getClozeText();
            foreach ($this->getGaps() as $replace_gap_index => $gap) {
                $answers = [];
                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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

duplicate()

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

Duplicates an assClozeTest.

public

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

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

                                                                                                                                    : int
    {
        if ($this->id <= 0) {
            // The question has not been saved. It cannot be duplicated
            return -1;
        }
        // duplicate the question in database
        $this_id = $this->getId();
        $thisObjId = $this->getObjId();

        $clone = $this;
        include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
        $original_id = assQuestion::_getOriginalId($this->id);
        $clone->id = -1;

        if ((int) $testObjId > 0) {
            $clone->setObjId($testObjId);
        }

        if ($title) {
            $clone->setTitle($title);
        }
        if ($author) {
            $clone->setAuthor($author);
        }
        if ($owner) {
            $clone->setOwner($owner);
        }
        if ($for_test) {
            $clone->saveToDb($original_id);
        } else {
            $clone->saveToDb();
        }
        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();
    }

Here is the call graph for this function:

fetchAnswerValueForGap()

assClozeTest::fetchAnswerValueForGap	(		$userSolution,
			$gapIndex
	)

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

                                                                    : string
    {
        $answerValue = '';

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

        return $answerValue;
    }

fetchSolutionSubmit()

assClozeTest::fetchSolutionSubmit

(

$submit

)

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

References $index, CLOZE_NUMERIC, CLOZE_SELECT, getGaps(), and ILIAS\Repository\int().

Referenced by getSolutionSubmit().

                                                : array
    {
        $solutionSubmit = [];
        $post_wrapper = $this->dic->http()->wrapper()->post();
        foreach ($this->getGaps() as $index => $gap) {
            if (!$post_wrapper->has("gap_$index")) {
                continue;
            }
            $value = trim($post_wrapper->retrieve(
                "gap_$index",
                $this->dic->refinery()->kindlyTo()->string()
            ));
            if ($value === '') {
                continue;
            }

            if (!(($gap->getType() === (int) CLOZE_SELECT) && ($value === -1))) {
                if (
                    $gap->getType() === (int) CLOZE_NUMERIC
                    && !is_numeric(str_replace(",", ".", $value))
                ) {
                    $value = null;
                } elseif ($gap->getType() === (int) CLOZE_NUMERIC) {
                    $value = str_replace(",", ".", $value);
                }
                $solutionSubmit[$index] = $value;
            }
        }

        return $solutionSubmit;
    }

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.

See also

$gaps

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

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

getAdditionalTableName()

assClozeTest::getAdditionalTableName

(

)

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

Returns

string The additional table name public

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

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

                                            : string
    {
        return "qpl_qst_cloze";
    }

Here is the caller graph for this function:

getAnswerTableName()

assClozeTest::getAnswerTableName

(

)

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

                                        : array
    {
        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 1797 of file class.assClozeTest.php.

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

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

Here is the call graph for this function:

getClozeText()

assClozeTest::getClozeText

(

)

Returns the cloze text.

Returns

string The cloze text string public

See also

$cloze_text

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

References $cloze_text.

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

                                  : string
    {
        return $this->cloze_text;
    }

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

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

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

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 public

See also

$end_tag

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

References $end_tag.

                               : string
    {
        return $this->end_tag;
    }

getExpressionTypes()

assClozeTest::getExpressionTypes

(

)

Get all available expression types for a specific question.

Returns

array

Implements iQuestionCondition.

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

References $data, $DIC, $ilDB, assQuestion\$points, calculateReachedPoints(), iQuestionCondition\EmptyAnswerExpression, assQuestion\getId(), getMaximumPoints(), iQuestionCondition\getUserQuestionResult(), assQuestion\lookupMaxStep(), iQuestionCondition\NumberOfResultExpression, iQuestionCondition\NumericResultExpression, iQuestionCondition\PercentageResultExpression, and iQuestionCondition\StringResultExpression.

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

Here is the call graph for this function:

getFeedbackMode()

assClozeTest::getFeedbackMode

(

)

Returns

string

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

References $feedbackMode.

Referenced by saveAdditionalQuestionDataToDb().

                                     : string
    {
        return $this->feedbackMode;
    }

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 public

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

References $fixedTextLength.

Referenced by saveAdditionalQuestionDataToDb().

    {
        return $this->fixedTextLength;
    }

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

See also

$gaps

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

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

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

Here is the caller graph for this function:

getGapCombinations()

assClozeTest::getGapCombinations

(

)

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

References $gap_combinations.

                                        : array
    {
        return $this->gap_combinations;
    }

getGapCombinationsExists()

assClozeTest::getGapCombinationsExists

(

)

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

References $gap_combinations_exists.

                                              : bool
    {
        return $this->gap_combinations_exists;
    }

getGapCount()

assClozeTest::getGapCount

(

)

Returns the number of gaps.

Returns

integer The number of gaps public

See also

$gaps

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

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

getGaps()

assClozeTest::getGaps

(

)

Returns the array of gaps.

Returns

array<int, assClozeGap> A map containing the gap objects of the cloze question gaps mapped to the respective gap id.

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

References $gaps.

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

                             : array
    {
        return $this->gaps;
    }

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 public

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

Referenced by calculateReachedPointsForSolution(), and saveAdditionalQuestionDataToDb().

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

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 public

See also

$points

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

References assQuestion\$points.

Referenced by calculateReachedPointsForSolution().

    {
        $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;
    }

Here is the caller graph for this function:

getMaximumPoints()

assClozeTest::getMaximumPoints

(

)

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

public

See also

$points

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

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

Referenced by getExpressionTypes(), and isComplete().

                                      : float
    {
        $assClozeGapCombinationObj = new assClozeGapCombination();
        $points = 0;
        $gaps_used_in_combination = [];
        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;
    }

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
float	$max_points	The maximum number of points for the solution public

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

Referenced by calculateCombinationResult(), and calculateReachedPointsForSolution().

                                                                                                       : float
    {
        include_once "./Services/Math/classes/class.EvalMath.php";
        $eval = new EvalMath();
        $eval->suppress_errors = true;
        $result = 0.0;

        if ($eval->e($a_entered) === false) {
            return 0.0;
        } elseif (($eval->e($lowerBound) !== false) && ($eval->e($upperBound) !== false)) {
            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;
            }
        } elseif ($eval->e($a_entered) == $eval->e($a_original)) {
            $result = $max_points;
        }
        return $result;
    }

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

References ilOperatorsExpressionMapping\getOperatorsByExpression().

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

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 public

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

Referenced by toJSON().

                                     : string
    {
        return "assClozeTest";
    }

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.

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

References getClozeText().

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

Here is the call graph for this function:

getSolutionSubmit()

assClozeTest::getSolutionSubmit

(

)

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

References fetchSolutionSubmit().

Referenced by saveWorkingData().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getSolutionSubmitValidation()

assClozeTest::getSolutionSubmitValidation

(

)

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

References ILIAS\LTI\ToolProvider\$key, CLOZE_NUMERIC, CLOZE_SELECT, and getGap().

Referenced by validateSolutionSubmit().

                                                 : array
    {
        $submit = $_POST;
        $solutionSubmit = [];

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

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 public

See also

$start_tag

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

References $start_tag.

                                 : string
    {
        return $this->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 public

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

References $DIC, assQuestion\$refinery, 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().

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

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 public

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

References $textgap_rating.

Referenced by getTextgapPoints(), and saveAdditionalQuestionDataToDb().

                                      : string
    {
        return $this->textgap_rating;
    }

Here is the caller graph for this function:

isAddableAnswerOptionValue()

assClozeTest::isAddableAnswerOptionValue	(	int	$qIndex,
		string	$answerOptionValue
	)

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

References CLOZE_TEXT, and getGap().

                                                                                      : bool
    {
        $gap = $this->getGap($qIndex);

        if ($gap->getType() != CLOZE_TEXT) {
            return false;
        }

        foreach ($gap->getItems($this->randomGroup->dontShuffle()) as $item) {
            if ($item->getAnswertext() === $answerOptionValue) {
                return false;
            }
        }

        return true;
    }

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

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

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

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

Here is the call graph for this function:

isValidNumericSubmitValue()

assClozeTest::isValidNumericSubmitValue (   $submittedValue )

protected

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

Referenced by validateSolutionSubmit().

                                                                 : bool
    {
        if (is_numeric($submittedValue)) {
            return true;
        }

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

        return false;
    }

Here is the caller graph for this function:

lmMigrateQuestionTypeSpecificContent()

assClozeTest::lmMigrateQuestionTypeSpecificContent ( ilAssSelfAssessmentMigrator  $migrator )

protected

Parameters

ilAssSelfAssessmentMigrator

$migrator

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

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

                                                                                                  : void
    {
        // 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 ^^
    }

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

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

References $data, $DIC, Vendor\Package\$e, $ilDB, 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(), 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().

                                            : void
    {
        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((string) $data["title"]);
            $this->setComment((string) $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"]);

            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 = [];
                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((int) $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((int) $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);
    }

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

Referenced by deleteGap(), and updateClozeTextFromGaps().

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

        return $output;
    }

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

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

Referenced by saveToDb().

    {
        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())
        ));
    }

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

References $DIC, $ilDB, ILIAS\LTI\ToolProvider\$key, assQuestion\getId(), and saveClozeGapItemsToDb().

Referenced by saveToDb().

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

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

References $DIC, $ilDB, ILIAS\LTI\ToolProvider\$key, $query, CLOZE_NUMERIC, CLOZE_SELECT, CLOZE_TEXT, saveClozeNumericGapRecordToDb(), saveClozeSelectGapRecordToDb(), and saveClozeTextGapRecordToDb().

Referenced by saveAnswerSpecificDataToDb().

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

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	mixed Gap item data object.
$gap	mixed Gap data object.

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

References $DIC, $ilDB, ILIAS\LTI\ToolProvider\$key, assQuestion\getId(), and ILIAS\Repository\int().

Referenced by saveClozeGapItemsToDb().

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

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	mixed Gap item data object.
$gap	mixed Gap data object.

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

References $DIC, $ilDB, ILIAS\LTI\ToolProvider\$key, and assQuestion\getId().

Referenced by saveClozeGapItemsToDb().

                                                                                : void
    {
        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)",
            [
                "integer",
                "integer",
                "integer",
                "text",
                "float",
                "integer",
                "text",
                "text"
            ],
            [
                $next_id,
                $this->getId(),
                $key,
                strlen($item->getAnswertext()) ? $item->getAnswertext() : "",
                $item->getPoints(),
                $item->getOrder(),
                $gap->getType(),
                ($gap->getShuffle()) ? "1" : "0"
            ]
        );
    }

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	mixed Gap item data object.
$gap	mixed Gap data object.

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

References $DIC, $ilDB, ILIAS\LTI\ToolProvider\$key, assQuestion\getId(), and ILIAS\Repository\int().

Referenced by saveClozeGapItemsToDb().

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

Here is the call graph for this function:

Here is the caller graph for this function:

savePartial()

assClozeTest::savePartial

(

)

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

                                 : bool
    {
        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

public

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

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

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

        parent::saveToDb();
    }

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.

public

Parameters

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

Returns

boolean $status

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

References ILIAS\LTI\ToolProvider\$key, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), CLOZE_SELECT, getGap(), assQuestion\getId(), assQuestion\getProcessLocker(), getSolutionSubmit(), ILIAS\Repository\lng(), assQuestion\logAction(), assQuestion\removeCurrentSolution(), assQuestion\saveCurrentSolution(), and ilUtil\stripSlashes().

                                                                                 : bool
    {
        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(trim(ilUtil::stripSlashes($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;
    }

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 public

See also

$cloze_text

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

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

Referenced by loadFromDb().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setClozeTextValue()

assClozeTest::setClozeTextValue

(

$cloze_text = ""

)

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

References $cloze_text.

                                                       : void
    {
        $this->cloze_text = $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 public

See also

$end_tag

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

References $end_tag.

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

setExportDetailsXLS()

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

{}

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

References $i, CLOZE_NUMERIC, CLOZE_SELECT, CLOZE_TEXT, ilExcel\getColumnCoord(), getGaps(), assQuestion\getSolutionValues(), ilAssExcelFormatHelper\getStringEscaping(), ILIAS\Repository\lng(), ilExcel\setBold(), ilAssExcelFormatHelper\setCell(), and ilAssExcelFormatHelper\setStringEscaping().

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

Here is the call graph for this function:

setFeedbackMode()

assClozeTest::setFeedbackMode

(

$feedbackMode

)

Parameters

string

$feedbackMode

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

References $feedbackMode.

Referenced by loadFromDb().

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

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 public

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

Referenced by loadFromDb().

                                                   : void
    {
        $this->fixedTextLength = $a_text_len;
    }

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 public

See also

$gaps

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

                                                                      : void
    {
        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 public

See also

$gaps

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

References assQuestion\$points.

                                                                   : void
    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $this->gaps[$gap_index]->setItemPoints($order, $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 public

See also

$gaps

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

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

setGapCombinations()

assClozeTest::setGapCombinations

(

$value

)

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

Referenced by loadFromDb().

                                              : void
    {
        $this->gap_combinations = $value;
    }

Here is the caller graph for this function:

setGapCombinationsExists()

assClozeTest::setGapCombinationsExists

(

$value

)

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

Referenced by loadFromDb().

                                                    : void
    {
        $this->gap_combinations_exists = $value;
    }

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

See also

$gaps

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

References assQuestion\$shuffle.

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

setGapSize()

assClozeTest::setGapSize	(		$gap_index,
			$size
	)

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

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

setGapType()

assClozeTest::setGapType	(		$gap_index,
			$gap_type
	)

Set the type of a gap with a given index.

private

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

                                                     : void
    {
        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 public

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

Referenced by loadFromDb().

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

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 public

See also

$start_tag

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

References $start_tag.

                                                     : void
    {
        $this->start_tag = $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 public

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

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

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

Here is the caller graph for this function:

toJSON()

assClozeTest::toJSON

(

)

Returns a JSON representation of the question.

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

References $gaps, ILIAS\LTI\ToolProvider\$key, $mobs, ilObjMediaObject\_getMobsOfObject(), CLOZE_NUMERIC, CLOZE_TEXT, assQuestion\formatSAQuestion(), getClozeText(), getGaps(), assQuestion\getId(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), and assQuestion\getTitleForHTMLOutput().

                            : string
    {
        include_once("./Services/RTE/classes/class.ilRTE.php");
        $result = [];
        $result['id'] = $this->getId();
        $result['type'] = (string) $this->getQuestionType();
        $result['title'] = $this->getTitleForHTMLOutput();
        $result['question'] = $this->formatSAQuestion($this->getQuestion());
        $result['clozetext'] = $this->formatSAQuestion($this->getClozeText());
        $result['nr_of_tries'] = $this->getNrOfTries();
        $result['shuffle'] = $this->getShuffle();
        $result['feedback'] = array(
            'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
            'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
        );

        $gaps = [];
        foreach ($this->getGaps() as $key => $gap) {
            $items = [];
            foreach ($gap->getItems($this->getShuffler()) as $item) {
                $jitem = [];
                $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);
    }

Here is the call graph for this function:

updateClozeTextFromGaps()

assClozeTest::updateClozeTextFromGaps

(

)

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

private

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

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

Referenced by deleteAnswerText().

                                             : void
    {
        $output = $this->getClozeText();
        foreach ($this->getGaps() as $gap_index => $gap) {
            $answers = [];
            foreach ($gap->getItemsRaw() as $item) {
                array_push($answers, str_replace([',', '['], ["\\,", '[ '], $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateSolutionSubmit()

assClozeTest::validateSolutionSubmit

(

)

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

References CLOZE_NUMERIC, getGap(), getSolutionSubmitValidation(), isValidNumericSubmitValue(), and ILIAS\Repository\lng().

                                            : bool
    {
        foreach ($this->getSolutionSubmitValidation() as $gapIndex => $value) {
            $gap = $this->getGap($gapIndex);

            if ($gap->getType() != CLOZE_NUMERIC) {
                continue;
            }

            if (strlen($value) && !$this->isValidNumericSubmitValue($value)) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt("err_no_numeric_value"), true);
                return false;
            }
        }

        return true;
    }

Here is the call graph for this function:

Field Documentation

$cloze_text

assClozeTest::$cloze_text

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

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

$end_tag

assClozeTest::$end_tag

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

Referenced by getEndTag(), and setEndTag().

$feedbackMode

assClozeTest::$feedbackMode = ilAssClozeTestFeedback::FB_MODE_GAP_QUESTION

protected

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

Referenced by getFeedbackMode(), and setFeedbackMode().

$feedbackOBJ

ilAssQuestionFeedback assClozeTest::$feedbackOBJ

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

$fixedTextLength

assClozeTest::$fixedTextLength

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

Referenced by getFixedTextLength().

$gap_combinations

assClozeTest::$gap_combinations

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

Referenced by getGapCombinations().

$gap_combinations_exists

assClozeTest::$gap_combinations_exists

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

Referenced by getGapCombinationsExists().

$gaps

array assClozeTest::$gaps = []

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

Referenced by getGaps(), and toJSON().

$identical_scoring

assClozeTest::$identical_scoring

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

$randomGroup

RandomGroup assClozeTest::$randomGroup

private

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

$start_tag

assClozeTest::$start_tag

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

Referenced by getStartTag(), and setStartTag().

$textgap_rating

assClozeTest::$textgap_rating

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