Class for text questions. More...

Inheritance diagram for assTextQuestion:

Collaboration diagram for assTextQuestion:

Public Member Functions
	__construct ( $title="", $comment="", $author="", $owner=-1, $question="")
	assTextQuestion constructor More...

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

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

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

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

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

	createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")

	getMaxNumOfChars ()
	Gets the maximum number of characters for the text solution. More...

	setMaxNumOfChars ($maxchars=0)
	Sets the maximum number of characters for the text solution. More...

	isWordCounterEnabled ()

	setWordCounterEnabled ($wordCounterEnabled)

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

	getMinimumPoints ()

	setReachedPoints ($active_id, $points, $pass=null)
	Sets the points, a learner has reached answering the question. More...

	isKeywordMatching ($answertext, $a_keyword)
	Checks if one of the keywords matches the answertext. More...

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

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

	getSolutionSubmit ()

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

	getTextRating ()
	Returns the rating option for text comparisons. More...

	setTextRating ($a_text_rating)
	Sets the rating option for text comparisons. More...

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

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

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

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

	getAnswerCount ()

	addAnswer ( $answertext="", $points=0.0, $points_unchecked=0.0, $order=0, $answerimage="")
	Adds a possible answer for a multiple choice question. More...

	getAnswers ()

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

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

	getAnswerTableName ()

	flushAnswers ()
	Deletes all answers. More...

	setAnswers ($answers)

	duplicateAnswers ($original_id)

	getKeywordRelation ()

	setKeywordRelation ($a_relation)
	This method implements a default behaviour. More...

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

	countLetters ($text)

	countWords ($text)

	getLatestAutosaveContent ($active_id)

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

	getShuffler ()

	setShuffler (ilArrayElementShuffler $shuffler)

	setProcessLocker ($processLocker)

	getProcessLocker ()

	fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
	Receives parameters from a QTI parser and creates a valid ILIAS question object. More...

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

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

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

	setTitle ($title="")
	Sets the title string of the assQuestion object. More...

	setId ($id=-1)
	Sets the id of the assQuestion object. More...

	setTestId ($id=-1)
	Sets the test id of the assQuestion object. More...

	setComment ($comment="")
	Sets the comment string of the assQuestion object. More...

	setOutputType ($outputType=OUTPUT_HTML)
	Sets the output type. More...

	setShuffle ($shuffle=true)
	Sets the shuffle flag. More...

	setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)
	Sets the estimated working time of a question from given hour, minute and second. More...

	setEstimatedWorkingTimeFromDurationString ($durationString)
	Sets the estimated working time of a question from a given datetime string. More...

	keyInArray ($searchkey, $array)
	returns TRUE if the key occurs in an array More...

	setAuthor ($author="")
	Sets the authors name of the assQuestion object. More...

	setOwner ($owner="")
	Sets the creator/owner ID of the assQuestion object. More...

	getTitle ()
	Gets the title string of the assQuestion object. More...

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

	getId ()
	Gets the id of the assQuestion object. More...

	getShuffle ()
	Gets the shuffle flag. More...

	getTestId ()
	Gets the test id of the assQuestion object. More...

	getComment ()
	Gets the comment string of the assQuestion object. More...

	getOutputType ()
	Gets the output type. More...

	supportsJavascriptOutput ()
	Returns true if the question type supports JavaScript output. More...

	supportsNonJsOutput ()

	requiresJsSwitch ()

	getEstimatedWorkingTime ()
	Gets the estimated working time of a question. More...

	getAuthor ()
	Gets the authors name of the assQuestion object. More...

	getOwner ()
	Gets the creator/owner ID of the assQuestion object. More...

	getObjId ()
	Get the object id of the container object. More...

	setObjId ($obj_id=0)
	Set the object id of the container object. More...

	getLifecycle ()

	setLifecycle (ilAssQuestionLifecycle $lifecycle)

	setExternalId ($external_id)

	getExternalId ()

	getSuggestedSolutionOutput ()

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

	getSuggestedSolutions ()
	Return the suggested solutions. More...

	getReachedPoints ($active_id, $pass=null)
	Returns the points, a learner has reached answering the question This is the fast way to get the points directly from the database. More...

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

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

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

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

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

	validateSolutionSubmit ()

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

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

	getSuggestedSolutionPath ()
	Returns the path for a suggested solution. More...

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

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

	buildImagePath ($questionId, $parentObjectId)

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

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

	getSuggestedSolutionPathWeb ()
	Returns the web path for a suggested solution. More...

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

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

	getTestOutputSolutions ($activeId, $pass)

	getUserSolutionPreferingIntermediate ($active_id, $pass=null)

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

	isInUse ($question_id="")
	Checks whether the question is in use or not. More...

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

	pcArrayShuffle ($array)
	Shuffles the values of a given array. More...

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

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

	deleteAnswers ($question_id)
	Deletes datasets from answers tables. More...

	deleteAdditionalTableData ($question_id)
	Deletes datasets from the additional question table in the database. More...

	delete ($question_id)
	Deletes a question and all materials from the database. More...

	getTotalAnswers ()
	get total number of answers More...

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

	copyXHTMLMediaObjectsOfQuestion ($a_q_id)

	syncXHTMLMediaObjectsOfQuestion ()

	createPageObject ()
	create page object of question More...

	copyPageOfQuestion ($a_q_id)

	getPageOfQuestion ()

	setOriginalId ($original_id)

	getOriginalId ()

	fixSvgToPng ($imageFilenameContainingString)

	fixUnavailableSkinImageSources ($html)

	loadFromDb ($question_id)
	Loads the question from the database. More...

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

	saveQuestionDataToDb ($original_id="")

	saveToDb ($original_id="")
	Saves the question to the database. More...

	setNewOriginalId ($newId)

	deleteSuggestedSolutions ()
	Deletes all suggestes solutions in the database. More...

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

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

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

	_resolveInternalLink ($internal_link)

	_resolveIntLinks ($question_id)

	syncWithOriginal ()

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

	_questionExistsInPool ($question_id)
	Returns true if the question already exists in the database and is assigned to a question pool. More...

	getPoints ()
	Returns the maximum available points for the question. More...

	setPoints ($a_points)
	Sets the maximum available points for the question. More...

	getSolutionMaxPass ($active_id)
	Returns the maximum pass a users question solution. More...

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

	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $previewSession, $reachedPoints)

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)

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

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

	prepareTextareaOutput ($txt_output, $prepare_for_latex_output=false, $omitNl2BrWhenTextArea=false)
	Prepares a string for a text area output in tests. More...

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

	addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=true, $add_mobs=true)
	Creates a QTI material tag from a plain text or xhtml text. More...

	buildHashedImageFilename ($plain_image_filename, $unique=false)

	getQuestion ()
	Gets the question string of the question object. More...

	setQuestion ($question="")
	Sets the question string of the question object. More...

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

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

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

&	getInstances ()
	Gets all instances of the question. More...

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

	setExportDetailsXLS ($worksheet, $startrow, $active_id, $pass)
	Creates an Excel worksheet for the detailed cumulated results of this question. More...

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

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

	getNrOfTries ()

	setNrOfTries ($a_nr_of_tries)

	setExportImagePath ($a_path)

	formatSAQuestion ($a_q)
	Format self assessment question. More...

	setPreventRteUsage ($a_val)
	Set prevent rte usage. More...

	getPreventRteUsage ()
	Get prevent rte usage. More...

	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)

	setSelfAssessmentEditingMode ($a_selfassessmenteditingmode)
	Set Self-Assessment Editing Mode. More...

	getSelfAssessmentEditingMode ()
	Get Self-Assessment Editing Mode. More...

	setDefaultNrOfTries ($a_defaultnroftries)
	Set Default Nr of Tries. More...

	getDefaultNrOfTries ()
	Get Default Nr of Tries. More...

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

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

	isAutosaveable ()

	getAdditionalContentEditingMode ()
	getter for additional content editing mode for this question More...

	setAdditionalContentEditingMode ($additinalContentEditingMode)
	setter for additional content editing mode for this question More...

	isAdditionalContentEditingModePageObject ()
	isser for additional "pageobject" content editing mode More...

	isValidAdditionalContentEditingMode ($additionalContentEditingMode)
	returns the fact wether the passed additional content mode is valid or not More...

	getValidAdditionalContentEditingModes ()
	getter for valid additional content editing modes More...

	addQuestionChangeListener (ilQuestionChangeListener $listener)

	getQuestionChangeListeners ()

	getHtmlUserSolutionPurifier ()

	getHtmlQuestionContentPurifier ()

	setLastChange ($lastChange)

	getLastChange ()

	removeIntermediateSolution ($active_id, $pass)

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

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

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

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

	setStep ($step)

	getStep ()

	toJSON ()

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

	intermediateSolutionExists ($active_id, $pass)

	authorizedSolutionExists ($active_id, $pass)

	authorizedOrIntermediateSolutionExists ($active_id, $pass)

	isAddableAnswerOptionValue ($qIndex, $answerOptionValue)

	addAnswerOptionValue ($qIndex, $answerOptionValue, $points)

	removeAllExistingSolutions ()

	removeExistingSolutions ($activeId, $pass)

	resetUsersAnswer ($activeId, $pass)

	removeResultRecord ($activeId, $pass)

	fetchValuePairsFromIndexedValues (array $indexedValues)

	fetchIndexedValuesFromValuePairs (array $valuePairs)

	areObligationsToBeConsidered ()

	setObligationsToBeConsidered ($obligationsToBeConsidered)

	updateTimestamp ()

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

	savePartial ()

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

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

Static Public Member Functions
static	getValidScoringModes ()

static	getScoringModesWithPointsByQuestion ()

static	getScoringModesWithPointsByKeyword ()

static	isObligationPossible ($questionId)
	returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration More...

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

static	isForcePassResultUpdateEnabled ()

static	isAllowedImageMimeType ($mimeType)

static	fetchMimeTypeIdentifier ($contentTypeString)

static	getAllowedFileExtensionsForMimeType ($mimeType)

static	isAllowedImageFileExtension ($mimeType, $fileExtension)

static	getAllowedImageMaterialFileExtensions ()

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

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

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

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

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

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

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

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

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

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

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

static	isFileAvailable ($file)

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

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

static	saveOriginalId ($questionId, $originalId)

static	resetOriginalId ($questionId)

static	_getInternalLinkHref ($target="")

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

static	originalQuestionExists ($questionId)

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

static	_instantiateQuestion ($question_id)

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

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

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

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

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

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

static	_needsManualScoring ($question_id)

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

static	getGuiClassNameByQuestionType ($questionType)

static	getObjectClassNameByQuestionType ($questionType)

static	getFeedbackClassNameByQuestionType ($questionType)

static	isCoreQuestionType ($questionType)

static	includeCoreClass ($questionType, $withGuiClass)

static	includePluginClass ($questionType, $withGuiClass)

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

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

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

static	_questionExistsInTest ($question_id, $test_id)

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

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

static	isObligationPossible ($questionId)
	returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration More...

static	implodeKeyValues ($keyValues)

static	explodeKeyValues ($keyValues)

static	setResultGateway ($resultGateway)

static	getResultGateway ()

static	sumTimesInISO8601FormatH_i_s_Extended ($time1, $time2)

static	convertISO8601FormatH_i_s_ExtendedToSeconds ($time)

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

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

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

Data Fields
	$maxNumOfChars

	$keywords

	$answers

	$text_rating

	$keyword_relation = 'any'

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

const	IMG_MIME_TYPE_PNG = 'image/png'

const	IMG_MIME_TYPE_GIF = 'image/gif'

const	ADDITIONAL_CONTENT_EDITING_MODE_DEFAULT = 'default'
	constant for additional content editing mode "default" More...

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

	$feedbackOBJ = null

	$prevent_rte_usage = false

	$selfassessmenteditingmode = false

	$defaultnroftries = 0

	$questionActionCmd = 'handleQuestionAction'

const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'

Protected Member Functions
	calculateReachedPointsForSolution ($solution)

Protected Member Functions inherited from assQuestion
	getQuestionAction ()

	isNonEmptyItemListPostSubmission ($postSubmissionFieldname)

	ensureCurrentTestPass ($active_id, $pass)

	lookupCurrentTestPass ($active_id, $pass)

	lookupTestId ($active_id)

	log ($active_id, $langVar)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

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

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

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

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

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

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

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

	copySuggestedSolutionFiles ($source_questionpool_id, $source_question_id)

	ensureNonNegativePoints ($points)

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

	getSelfAssessmentFormatter ()

	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	duplicateQuestionHints ($originalQuestionId, $duplicateQuestionId)

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

	buildQuestionDataQuery ()

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

	removeSolutionRecordById ($solutionId)

	getSolutionRecordById ($solutionId)

	deleteDummySolutionRecord ($activeId, $passIndex)

	isDummySolutionRecord ($solutionRecord)

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

	duplicateIntermediateSolutionAuthorized ($activeId, $passIndex)

	forceExistingIntermediateSolution ($activeId, $passIndex, $considerDummyRecordCreation)

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

Protected Attributes
	$wordCounterEnabled

Protected Attributes inherited from assQuestion
	$id

	$title

	$comment

	$owner

	$author

	$question

	$points

	$est_working_time

	$shuffle

	$test_id

	$obj_id

	$ilias

	$tpl

	$lng

	$db

	$outputType = OUTPUT_JAVASCRIPT

	$suggested_solutions

	$original_id

	$page

	$external_id = ''

	$questionChangeListeners = array()

	$processLocker

	$step = null

	$lastChange

	$shuffler

	$testQuestionConfig

	$lifecycle

Private Member Functions
	isValidTextRating ($textRating)

Private Attributes
	$matchcondition

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

static	getKeyValuesImplosionSeparator ()

Static Protected Attributes inherited from assQuestion
static	$allowedFileExtensionsByMimeType

static	$allowedCharsetsByMimeType

static	$allowedImageMaterialFileExtensionsByMimeType

static	$forcePassResultsUpdateEnabled = false

static	$imageSourceFixReplaceMap

Detailed Description

Class for text questions.

assTextQuestion is a class for text questions

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

Version: $Id$

Definition at line 22 of file class.assTextQuestion.php.

Constructor & Destructor Documentation

◆ __construct()

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

assTextQuestion constructor

The constructor takes possible arguments an creates an instance of the assTextQuestion object.

Parameters

string	$title	A title string to describe the question
string	$comment	A comment string to describe the question
string	$author	A string containing the name of the questions author
integer	$owner	A numerical ID to identify the owner/creator
string	$question	The question string of the text question

Definition at line 74 of file class.assTextQuestion.php.

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

       {
         parent::__construct($title, $comment, $author, $owner, $question);
         $this->wordCounterEnabled = false;
         $this->maxNumOfChars = 0;
         $this->points = 1;
         $this->answers = array();
         $this->matchcondition = 0;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addAnswer()

assTextQuestion::addAnswer	(	$answertext = `""`,
		$points = `0.0`,
		$points_unchecked = `0.0`,
		$order = `0`,
		$answerimage = `""`
	)

Adds a possible answer for a multiple choice question.

A ASS_AnswerBinaryStateImage object will be created and assigned to the array $this->answers.

Parameters

string	$answertext	The answer text
double	$points	The points for selecting the answer (even negative points can be used)
boolean	$state	Defines the answer as correct (TRUE) or incorrect (FALSE)
integer	$order	A possible display order of the answer
double	$points	The points for not selecting the answer (even negative points can be used) public

See also: $answers; ASS_AnswerBinaryStateImage

Definition at line 853 of file class.assTextQuestion.php.

References assQuestion\$points.

Referenced by loadFromDb(), and setAnswers().

       {
         include_once "./Modules/TestQuestionPool/classes/class.assAnswerMultipleResponseImage.php";
 
         // add answer
         $answer = new ASS_AnswerMultipleResponseImage($answertext, $points);
         $this->answers[] = $answer;
     }

Here is the caller graph for this function:

◆ calculateReachedPoints()

assTextQuestion::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 !!)

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

Definition at line 576 of file class.assTextQuestion.php.

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

     {
         if ($returndetails) {
             throw new ilTestException('return details not implemented for ' . __METHOD__);
         }
         
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $points = 0;
         if (is_null($pass)) {
             $pass = $this->getSolutionMaxPass($active_id);
         }
 
         $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);
         
         // Return min points when no answer was given.
         if ($ilDB->numRows($result) == 0) {
             return $this->getMinimumPoints();
         }
         
         // Return points of points are already on the row.
         $row = $ilDB->fetchAssoc($result);
         if ($row["points"] != null) {
             return $row["points"];
         }
 
         return $this->calculateReachedPointsForSolution($row['value1']);
     }

Here is the call graph for this function:

◆ calculateReachedPointsForSolution()

assTextQuestion::calculateReachedPointsForSolution ( $solution )

protected

Definition at line 500 of file class.assTextQuestion.php.

References $answers, assQuestion\$points, getAnswers(), getKeywordRelation(), getMaximumPoints(), getMinimumPoints(), and isKeywordMatching().

Referenced by calculateReachedPoints().

     {
         // Return min points when keyword relation is NON KEYWORDS
         if ($this->getKeywordRelation() == 'non') {
             return $this->getMinimumPoints();
         }
 
         // Return min points if there are no answers present.
         $answers = $this->getAnswers();
 
         if (count($answers) == 0) {
             return $this->getMinimumPoints();
         }
         
         switch ($this->getKeywordRelation()) {
             case 'any':
 
                 $points = 0;
 
                 foreach ($answers as $answer) {
                     $qst_answer = $answer->getAnswertext();
                     $user_answer = '  ' . $solution;
 
                     if ($this->isKeywordMatching($user_answer, $qst_answer)) {
                         $points += $answer->getPoints();
                     }
                 }
 
                 break;
 
             case 'all':
 
                 $points = $this->getMaximumPoints();
 
                 foreach ($answers as $answer) {
                     $qst_answer = $answer->getAnswertext();
                     $user_answer = '  ' . $solution;
 
                     if (!$this->isKeywordMatching($user_answer, $qst_answer)) {
                         $points = 0;
                         break;
                     }
                 }
 
                 break;
 
             case 'one':
 
                 $points = 0;
 
                 foreach ($answers as $answer) {
                     $qst_answer = $answer->getAnswertext();
                     $user_answer = '  ' . $solution;
 
                     if ($this->isKeywordMatching($user_answer, $qst_answer)) {
                         $points = $this->getMaximumPoints();
                         break;
                     }
                 }
 
                 break;
         }
 
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyObject()

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

Copies an assTextQuestion object.

public

Definition at line 240 of file class.assTextQuestion.php.

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

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

Here is the call graph for this function:

◆ countLetters()

assTextQuestion::countLetters ( $text )

Definition at line 1050 of file class.assTextQuestion.php.

References ilStr\strLen().

     {
         $text = strip_tags($text);
         
         $text = str_replace('&gt;', '>', $text);
         $text = str_replace('&lt;', '<', $text);
         $text = str_replace('&nbsp;', ' ', $text);
         $text = str_replace('&amp;', '&', $text);
         
         $text = str_replace("\r\n", "\n", $text);
         $text = str_replace("\n", "", $text);
         
         return ilStr::strLen($text);
     }

Here is the call graph for this function:

◆ countWords()

assTextQuestion::countWords ( $text )

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

     {
         $text = str_replace('&nbsp;', ' ', $text);
 
         $text = preg_replace('/[.,:;!?\-_#\'"+*\\/=()&%§$]/m', '', $text);
 
         $text = preg_replace('/^\s*/m', '', $text);
         $text = preg_replace('/\s*$/m', '', $text);
         $text = preg_replace('/\s+/m', ' ', $text);
 
         return count(explode(' ', $text));
     }

◆ createNewOriginalFromThisDuplicate()

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

Definition at line 269 of file class.assTextQuestion.php.

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

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

Here is the call graph for this function:

◆ deleteAnswer()

assTextQuestion::deleteAnswer ( $index = 0 )

Deletes an answer with a given index.

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

Parameters

integer $index A nonnegative index of the n-th answer public

See also: $answers

Definition at line 904 of file class.assTextQuestion.php.

References $i, and $index.

     {
         if ($index < 0) {
             return;
         }
         if (count($this->answers) < 1) {
             return;
         }
         if ($index >= count($this->answers)) {
             return;
         }
         $answer = $this->answers[$index];
         if (strlen($answer->getImage())) {
             $this->deleteImage($answer->getImage());
         }
         unset($this->answers[$index]);
         $this->answers = array_values($this->answers);
         for ($i = 0; $i < count($this->answers); $i++) {
             if ($this->answers[$i]->getOrder() > $index) {
                 $this->answers[$i]->setOrder($i);
             }
         }
     }

◆ duplicate()

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

Duplicates an assTextQuestion.

public

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

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

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

Here is the call graph for this function:

◆ duplicateAnswers()

assTextQuestion::duplicateAnswers ( $original_id )

Definition at line 965 of file class.assTextQuestion.php.

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

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $result = $ilDB->queryF(
             "SELECT * FROM qpl_a_essay WHERE question_fi = %s",
             array('integer'),
             array($original_id)
         );
         if ($result->numRows()) {
             while ($row = $ilDB->fetchAssoc($result)) {
                 $next_id = $ilDB->nextId('qpl_a_essay');
                 $affectedRows = $ilDB->manipulateF(
                     "INSERT INTO qpl_a_essay (answer_id, question_fi, answertext, points) 
                                          VALUES (%s, %s, %s, %s)",
                     array('integer','integer','text','float'),
                     array($next_id, $this->getId(), $row["answertext"], $row["points"])
                 );
             }
         }
     }

Here is the call graph for this function:

◆ flushAnswers()

assTextQuestion::flushAnswers ( )

Deletes all answers.

public

See also: $answers

Definition at line 939 of file class.assTextQuestion.php.

Referenced by loadFromDb(), and setAnswers().

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

Here is the caller graph for this function:

◆ getAdditionalTableName()

assTextQuestion::getAdditionalTableName ( )

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

Returns: string The additional table name public

Definition at line 774 of file class.assTextQuestion.php.

Referenced by getSolutionSubmit(), and loadFromDb().

     {
         return "qpl_qst_essay";
     }

Here is the caller graph for this function:

◆ getAnswer()

assTextQuestion::getAnswer ( $index = 0 )

Returns an answer with a given index.

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

Parameters

integer $index A nonnegative index of the n-th answer

Returns: object ASS_AnswerBinaryStateImage-Object containing the answer public

See also: $answers

Definition at line 881 of file class.assTextQuestion.php.

References $index.

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

◆ getAnswerCount()

assTextQuestion::getAnswerCount ( )

Definition at line 835 of file class.assTextQuestion.php.

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

◆ getAnswers()

assTextQuestion::getAnswers ( )

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

References $answers.

Referenced by calculateReachedPointsForSolution().

     {
         return $this->answers;
     }

Here is the caller graph for this function:

◆ getAnswerTableName()

assTextQuestion::getAnswerTableName ( )

Definition at line 928 of file class.assTextQuestion.php.

     {
         return 'qpl_a_essay';
     }

◆ getKeywordRelation()

assTextQuestion::getKeywordRelation ( )

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

References $keyword_relation.

Referenced by calculateReachedPointsForSolution(), getMaximumPoints(), getMinimumPoints(), and getSolutionSubmit().

     {
         return $this->keyword_relation;
     }

Here is the caller graph for this function:

◆ getLatestAutosaveContent()

assTextQuestion::getLatestAutosaveContent ( $active_id )

Definition at line 1078 of file class.assTextQuestion.php.

References assQuestion\getId().

     {
         $question_fi = $this->getId();
 
         // Do we have an unauthorized result?
         $cntresult = $this->db->query('
             SELECT count(solution_id) cnt
             FROM tst_solutions 
             WHERE active_fi = ' . $this->db->quote($active_id, 'int') . '
             AND question_fi = ' . $this->db->quote($this->getId(), 'int') . '
             AND authorized = ' . $this->db->quote(0, 'int')
         );
         $row = $this->db->fetchAssoc($cntresult);
         if($row['cnt'] > 0 ) {
             $tresult = $this->db->query('
             SELECT value1
             FROM tst_solutions 
             WHERE active_fi = ' . $this->db->quote($active_id, 'int') . '
             AND question_fi = ' . $this->db->quote($this->getId(), 'int') . '
             AND authorized = ' . $this->db->quote(0, 'int')
             );
             $trow = $this->db->fetchAssoc($tresult);
             return $trow['value1'];
         }
         return '';
     }

Here is the call graph for this function:

◆ getMaximumPoints()

assTextQuestion::getMaximumPoints ( )

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

public

See also: $points

Definition at line 354 of file class.assTextQuestion.php.

References assQuestion\$points, and getKeywordRelation().

Referenced by calculateReachedPointsForSolution(), and isComplete().

     {
         if (in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion())) {
             return parent::getPoints();
         }
         
         $points = 0;
         
         foreach ($this->answers as $answer) {
             if ($answer->getPoints() > 0) {
                 $points = $points + $answer->getPoints();
             }
         }
         
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxNumOfChars()

assTextQuestion::getMaxNumOfChars ( )

Gets the maximum number of characters for the text solution.

Returns: integer The maximum number of characters for the text solution public

See also: $maxNumOfChars

Definition at line 311 of file class.assTextQuestion.php.

References $maxNumOfChars.

Referenced by getSolutionSubmit(), and toJSON().

     {
         if (strcmp($this->maxNumOfChars, "") == 0) {
             return 0;
         } else {
             return $this->maxNumOfChars;
         }
     }

Here is the caller graph for this function:

◆ getMinimumPoints()

assTextQuestion::getMinimumPoints ( )

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

References assQuestion\$points, and getKeywordRelation().

Referenced by calculateReachedPoints(), and calculateReachedPointsForSolution().

     {
         if (in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion())) {
             return 0;
         }
         
         $points = 0;
 
         foreach ($this->answers as $answer) {
             if ($answer->getPoints() < 0) {
                 $points = $points + $answer->getPoints();
             }
         }
 
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionType()

assTextQuestion::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question public

Definition at line 726 of file class.assTextQuestion.php.

Referenced by toJSON().

     {
         return "assTextQuestion";
     }

Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assTextQuestion::getRTETextWithMediaObjects ( )

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

Definition at line 783 of file class.assTextQuestion.php.

     {
         return parent::getRTETextWithMediaObjects();
     }

◆ getScoringModesWithPointsByKeyword()

static assTextQuestion::getScoringModesWithPointsByKeyword ( )

static

Definition at line 1012 of file class.assTextQuestion.php.

Referenced by assTextQuestionGUI\getBestAnswer().

     {
         return array('any');
     }

Here is the caller graph for this function:

◆ getScoringModesWithPointsByQuestion()

static assTextQuestion::getScoringModesWithPointsByQuestion ( )

static

Definition at line 1007 of file class.assTextQuestion.php.

     {
         return array('non', 'all', 'one');
     }

◆ getSolutionSubmit()

assTextQuestion::getSolutionSubmit ( )

Returns: mixed|string

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

References $_POST, $DIC, $ilDB, getAdditionalTableName(), assQuestion\getHtmlUserSolutionPurifier(), assQuestion\getId(), getKeywordRelation(), getMaxNumOfChars(), getTextRating(), ilUtil\isHTML(), isWordCounterEnabled(), ilObjQuestionScoringAdjustable\saveAdditionalQuestionDataToDb(), ilObjAnswerScoringAdjustable\saveAnswerSpecificDataToDb(), and ilUtil\stripSlashes().

Referenced by saveWorkingData().

     {
         $text = ilUtil::stripSlashes($_POST["TEXT"], false);
         
         if (ilUtil::isHTML($text)) {
             $text = $this->getHtmlUserSolutionPurifier()->purify($text);
         }
         
         return $text;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTextRating()

assTextQuestion::getTextRating ( )

Returns the rating option for text comparisons.

Returns: string The rating option for text comparisons

See also: $text_rating User interface

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

References $text_rating.

Referenced by getSolutionSubmit(), and isKeywordMatching().

     {
         return $this->text_rating;
     }

Here is the caller graph for this function:

◆ getValidScoringModes()

static assTextQuestion::getValidScoringModes ( )

static

Definition at line 1002 of file class.assTextQuestion.php.

     {
         return array_merge(self::getScoringModesWithPointsByQuestion(), self::getScoringModesWithPointsByKeyword());
     }

◆ isAnswered()

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

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

(overwrites method in class assQuestion)

Parameters

integer	$active_id
integer	$pass

Returns: boolean $answered

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

References $pass, assQuestion\getId(), and assQuestion\getNumExistingSolutionRecords().

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

Here is the call graph for this function:

◆ isComplete()

assTextQuestion::isComplete ( )

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

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

Definition at line 94 of file class.assTextQuestion.php.

References getMaximumPoints().

     {
         if (strlen($this->title)
             && $this->author
             && $this->question
             && $this->getMaximumPoints() > 0
         ) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ isKeywordMatching()

assTextQuestion::isKeywordMatching	(	$answertext,
		$a_keyword
	)

Checks if one of the keywords matches the answertext.

Parameters

string	$answertext	The answertext of the user
string	$a_keyword	The keyword which should be checked

Returns: boolean TRUE if the keyword matches, FALSE otherwise private

Definition at line 441 of file class.assTextQuestion.php.

References $result, getTextRating(), ilStr\strPos(), 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 calculateReachedPointsForSolution().

     {
         $result = false;
         $textrating = $this->getTextRating();
         include_once "./Services/Utilities/classes/class.ilStr.php";
         switch ($textrating) {
             case TEXTGAP_RATING_CASEINSENSITIVE:
                 if (ilStr::strPos(ilStr::strToLower($answertext), ilStr::strToLower($a_keyword)) !== false) {
                     return true;
                 }
                 break;
             case TEXTGAP_RATING_CASESENSITIVE:
                 if (ilStr::strPos($answertext, $a_keyword) !== false) {
                     return true;
                 }
                 break;
         }
         
         // "<p>red</p>" would not match "red" even with distance of 5
         $answertext = strip_tags($answertext);
         
         $answerwords = array();
         if (preg_match_all("/([^\s.]+)/", $answertext, $matches)) {
             foreach ($matches[1] as $answerword) {
                 array_push($answerwords, trim($answerword));
             }
         }
         foreach ($answerwords as $a_original) {
             switch ($textrating) {
                 case TEXTGAP_RATING_LEVENSHTEIN1:
                     if (levenshtein($a_original, $a_keyword) <= 1) {
                         return true;
                     }
                     break;
                 case TEXTGAP_RATING_LEVENSHTEIN2:
                     if (levenshtein($a_original, $a_keyword) <= 2) {
                         return true;
                     }
                     break;
                 case TEXTGAP_RATING_LEVENSHTEIN3:
                     if (levenshtein($a_original, $a_keyword) <= 3) {
                         return true;
                     }
                     break;
                 case TEXTGAP_RATING_LEVENSHTEIN4:
                     if (levenshtein($a_original, $a_keyword) <= 4) {
                         return true;
                     }
                     break;
                 case TEXTGAP_RATING_LEVENSHTEIN5:
                     if (levenshtein($a_original, $a_keyword) <= 5) {
                         return true;
                     }
                     break;
             }
         }
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isObligationPossible()

static assTextQuestion::isObligationPossible ( $questionId )

static

returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration

(overwrites method in class assQuestion)

Parameters

integer $questionId

Returns: boolean $obligationPossible

Definition at line 1045 of file class.assTextQuestion.php.

     {
         return true;
     }

◆ isValidTextRating()

assTextQuestion::isValidTextRating ( $textRating )

private

Definition at line 417 of file class.assTextQuestion.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().

     {
         switch ($textRating) {
             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:
                 return true;
         }
         
         return false;
     }

Here is the caller graph for this function:

◆ isWordCounterEnabled()

assTextQuestion::isWordCounterEnabled ( )

Returns: bool

Definition at line 335 of file class.assTextQuestion.php.

References $wordCounterEnabled.

Referenced by getSolutionSubmit().

     {
         return $this->wordCounterEnabled;
     }

Here is the caller graph for this function:

◆ loadFromDb()

assTextQuestion::loadFromDb ( $question_id )

Loads a assTextQuestion object from a database.

Parameters

object	$db	A pear DB object
integer	$question_id	A unique key which defines the text question in the database public

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

References $data, $DIC, Vendor\Package\$e, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), addAnswer(), flushAnswers(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), assQuestion\getId(), ilAssQuestionLifecycle\getInstance(), isValidTextRating(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), setKeywordRelation(), assQuestion\setLifecycle(), setMaxNumOfChars(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setShuffle(), setTextRating(), assQuestion\setTitle(), setWordCounterEnabled(), and TEXTGAP_RATING_CASEINSENSITIVE.

     {
         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 ($ilDB->numRows($result) == 1) {
             $data = $ilDB->fetchAssoc($result);
             $this->setId($question_id);
             $this->setObjId($data["obj_fi"]);
             $this->setTitle($data["title"]);
             $this->setComment($data["description"]);
             $this->setOriginalId($data["original_id"]);
             $this->setNrOfTries($data['nr_of_tries']);
             $this->setAuthor($data["author"]);
             $this->setPoints((float) $data["points"]);
             $this->setOwner($data["owner"]);
             include_once("./Services/RTE/classes/class.ilRTE.php");
             $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
             $this->setShuffle($data["shuffle"]);
             $this->setWordCounterEnabled((bool) $data['word_cnt_enabled']);
             $this->setMaxNumOfChars($data["maxnumofchars"]);
             $this->setTextRating($this->isValidTextRating($data["textgap_rating"]) ? $data["textgap_rating"] : TEXTGAP_RATING_CASEINSENSITIVE);
             $this->matchcondition = (strlen($data['matchcondition'])) ? $data['matchcondition'] : 0;
             $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
             $this->setKeywordRelation(($data['keyword_relation']));
 
             try {
                 $this->setLifecycle(ilAssQuestionLifecycle::getInstance($data['lifecycle']));
             } catch (ilTestQuestionPoolInvalidArgumentException $e) {
                 $this->setLifecycle(ilAssQuestionLifecycle::getDraftInstance());
             }
 
             try {
                 $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
             } catch (ilTestQuestionPoolException $e) {
             }
         }
 
         $result = $ilDB->queryF(
             "SELECT * FROM qpl_a_essay WHERE question_fi = %s",
             array("integer"),
             array($this->getId())
         );
         
         $this->flushAnswers();
         while ($row = $ilDB->fetchAssoc($result)) {
             $this->addAnswer($row['answertext'], $row['points']);
         }
         
         parent::loadFromDb($question_id);
     }

Here is the call graph for this function:

◆ saveToDb()

assTextQuestion::saveToDb ( $original_id = "" )

Saves a assTextQuestion object to a database.

Parameters

string $original_id

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

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

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

Here is the call graph for this function:

◆ saveWorkingData()

assTextQuestion::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 614 of file class.assTextQuestion.php.

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

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $ilUser = $DIC['ilUser'];
 
         include_once "./Services/Utilities/classes/class.ilStr.php";
         if (is_null($pass)) {
             include_once "./Modules/Test/classes/class.ilObjTest.php";
             $pass = ilObjTest::_getPass($active_id);
         }
 
         $entered_values = 0;
         $text = $this->getSolutionSubmit();
 
         $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(function () use (&$entered_values, $active_id, $pass, $authorized, $text) {
             $this->removeCurrentSolution($active_id, $pass, $authorized);
 
             if (strlen($text)) {
                 $this->saveCurrentSolution($active_id, $pass, trim($text), null, $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:

◆ setAnswers()

assTextQuestion::setAnswers ( $answers )

Definition at line 944 of file class.assTextQuestion.php.

References $answers, $i, addAnswer(), and flushAnswers().

     {
         if (isset($answers['answer'])) {
             $count = count($answers['answer']);
             $withPoints = true;
         } else {
             $count = count($answers);
             $withPoints = false;
         }
         
         $this->flushAnswers();
         
         for ($i = 0; $i < $count; $i++) {
             if ($withPoints) {
                 $this->addAnswer($answers['answer'][$i], $answers['points'][$i]);
             } else {
                 $this->addAnswer($answers[$i], 0);
             }
         }
     }

Here is the call graph for this function:

◆ setExportDetailsXLS()

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

{}

Definition at line 791 of file class.assTextQuestion.php.

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

     {
         parent::setExportDetailsXLS($worksheet, $startrow, $active_id, $pass);
 
         $solutions = $this->getSolutionValues($active_id, $pass);
         
         $i = 1;
         $worksheet->setCell($startrow + $i, 0, $this->lng->txt("result"));
         $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
         
         require_once 'Modules/Test/classes/class.ilObjAssessmentFolder.php';
         $assessment_folder = new ilObjAssessmentFolder();
 
         $string_escaping_org_value = $worksheet->getStringEscaping();
         if ($assessment_folder->getExportEssayQuestionsWithHtml() == 1) {
             $worksheet->setStringEscaping(false);
         }
 
         if (strlen($solutions[0]["value1"])) {
             $worksheet->setCell($startrow + $i, 1, $solutions[0]["value1"]);
         }
         $i++;
 
         $worksheet->setStringEscaping($string_escaping_org_value);
         return $startrow + $i + 1;
     }

Here is the call graph for this function:

◆ setKeywordRelation()

assTextQuestion::setKeywordRelation ( $a_relation )

This method implements a default behaviour.

During the creation of a text question, the record which holds the keyword relation is not existing, so keyword_relation defaults to 'one'.

Definition at line 997 of file class.assTextQuestion.php.

Referenced by loadFromDb().

     {
         $this->keyword_relation = $a_relation;
     }

Here is the caller graph for this function:

◆ setMaxNumOfChars()

assTextQuestion::setMaxNumOfChars ( $maxchars = 0 )

Sets the maximum number of characters for the text solution.

Parameters

integer $maxchars The maximum number of characters for the text solution public

See also: $maxNumOfChars

Definition at line 327 of file class.assTextQuestion.php.

Referenced by loadFromDb().

     {
         $this->maxNumOfChars = $maxchars;
     }

Here is the caller graph for this function:

◆ setReachedPoints()

assTextQuestion::setReachedPoints	(	$active_id,
		$points,
		$pass = `null`
	)

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

Parameters

integer	$user_id	The database ID of the learner
integer	$test_id	The database Id of the test containing the question
integer	$points	The points the user has reached answering the question

Returns: boolean true on success, otherwise false public

Definition at line 396 of file class.assTextQuestion.php.

References $DIC, $ilDB, $pass, assQuestion\$points, assQuestion\getId(), assQuestion\getPoints(), and assQuestion\getSolutionMaxPass().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         
         if (($points > 0) && ($points <= $this->getPoints())) {
             if (is_null($pass)) {
                 $pass = $this->getSolutionMaxPass($active_id);
             }
             $affectedRows = $ilDB->manipulateF(
                 "UPDATE tst_test_result SET points = %s WHERE active_fi = %s AND question_fi = %s AND pass = %s",
                 array('float','integer','integer','integer'),
                 array($points, $active_id, $this->getId(), $pass)
             );
             self::_updateTestPassResults($active_id, $pass);
             return true;
         } else {
             return true;
         }
     }

Here is the call graph for this function:

◆ setTextRating()

assTextQuestion::setTextRating ( $a_text_rating )

Sets the rating option for text comparisons.

Parameters

string $a_textgap_rating The rating option for text comparisons

See also: $textgap_rating User interface

Definition at line 750 of file class.assTextQuestion.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().

     {
         switch ($a_text_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->text_rating = $a_text_rating;
                 break;
             default:
                 $this->text_rating = TEXTGAP_RATING_CASEINSENSITIVE;
                 break;
         }
     }

Here is the caller graph for this function:

◆ setWordCounterEnabled()

assTextQuestion::setWordCounterEnabled ( $wordCounterEnabled )

Parameters

bool $wordCounterEnabled

Definition at line 343 of file class.assTextQuestion.php.

References $wordCounterEnabled.

Referenced by loadFromDb().

     {
         $this->wordCounterEnabled = $wordCounterEnabled;
     }

Here is the caller graph for this function:

◆ toJSON()

assTextQuestion::toJSON ( )

Returns a JSON representation of the question.

Definition at line 821 of file class.assTextQuestion.php.

References $result, assQuestion\formatSAQuestion(), assQuestion\getId(), getMaxNumOfChars(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), and assQuestion\getTitle().

     {
         include_once("./Services/RTE/classes/class.ilRTE.php");
         $result = array();
         $result['id'] = (int) $this->getId();
         $result['type'] = (string) $this->getQuestionType();
         $result['title'] = (string) $this->getTitle();
         $result['question'] = $this->formatSAQuestion($this->getQuestion());
         $result['nr_of_tries'] = (int) $this->getNrOfTries();
         $result['shuffle'] = (bool) $this->getShuffle();
         $result['maxlength'] = (int) $this->getMaxNumOfChars();
         return json_encode($result);
     }

Here is the call graph for this function:

Field Documentation

◆ $answers

assTextQuestion::$answers

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

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

◆ $keyword_relation

assTextQuestion::$keyword_relation = 'any'

Definition at line 60 of file class.assTextQuestion.php.

Referenced by getKeywordRelation().

◆ $keywords

assTextQuestion::$keywords

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

◆ $matchcondition

assTextQuestion::$matchcondition

private

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

◆ $maxNumOfChars

assTextQuestion::$maxNumOfChars

Definition at line 31 of file class.assTextQuestion.php.

Referenced by getMaxNumOfChars().

◆ $text_rating

assTextQuestion::$text_rating

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

Referenced by getTextRating().

◆ $wordCounterEnabled

assTextQuestion::$wordCounterEnabled

protected

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

Referenced by isWordCounterEnabled(), and setWordCounterEnabled().

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

Modules/TestQuestionPool/classes/class.assTextQuestion.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAnswer()

◆ calculateReachedPoints()

◆ calculateReachedPointsForSolution()

◆ copyObject()

◆ countLetters()

◆ countWords()

◆ createNewOriginalFromThisDuplicate()

◆ deleteAnswer()

◆ duplicate()

◆ duplicateAnswers()

◆ flushAnswers()

◆ getAdditionalTableName()

◆ getAnswer()

◆ getAnswerCount()

◆ getAnswers()

◆ getAnswerTableName()

◆ getKeywordRelation()

◆ getLatestAutosaveContent()

◆ getMaximumPoints()

◆ getMaxNumOfChars()

◆ getMinimumPoints()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getScoringModesWithPointsByKeyword()

◆ getScoringModesWithPointsByQuestion()

◆ getSolutionSubmit()

◆ getTextRating()

◆ getValidScoringModes()

◆ isAnswered()

◆ isComplete()

◆ isKeywordMatching()

◆ isObligationPossible()

◆ isValidTextRating()

◆ isWordCounterEnabled()

◆ loadFromDb()

◆ saveToDb()

◆ saveWorkingData()

◆ setAnswers()

◆ setExportDetailsXLS()

◆ setKeywordRelation()

◆ setMaxNumOfChars()

◆ setReachedPoints()

◆ setTextRating()

◆ setWordCounterEnabled()

◆ toJSON()

Field Documentation

◆ $answers

◆ $keyword_relation

◆ $keywords

◆ $matchcondition

◆ $maxNumOfChars

◆ $text_rating

◆ $wordCounterEnabled