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

Inheritance diagram for assTextQuestion:

Collaboration diagram for assTextQuestion:

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

	getMatchcondition ()

	setMatchcondition (int $matchcondition)

	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 (bool $for_test=true, string $title="", string $author="", string $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 (ilAssExcelFormatHelper $worksheet, int $startrow, int $active_id, int $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 (int $active_id, int $pass)
	returns boolean wether the question is answered during test pass or not More...

	countLetters ($text)

	countWords ($text)

	getLatestAutosaveContent (int $active_id, int $pass)

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

	getShuffler ()

	setShuffler (Transformation $shuffler)

	setProcessLocker (ilAssQuestionProcessLocker $processLocker)

	getProcessLocker ()

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

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

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

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

	setTitle (string $title="")

	setId (int $id=-1)

	setTestId (int $id=-1)

	setComment (string $comment="")

	setOutputType (int $outputType=OUTPUT_HTML)

	setShuffle (?bool $shuffle=true)

	setAuthor (string $author="")

	setOwner (int $owner=-1)

	getTitle ()

	getTitleForHTMLOutput ()

	getTitleFilenameCompliant ()

	getId ()

	getShuffle ()

	getTestId ()

	getComment ()

	getDescriptionForHTMLOutput ()

	getThumbSize ()

	setThumbSize (int $a_size)

	getMinimumThumbSize ()

	getMaximumThumbSize ()

	getOutputType ()

	supportsJavascriptOutput ()

	supportsNonJsOutput ()

	requiresJsSwitch ()

	getAuthor ()

	getAuthorForHTMLOutput ()

	getOwner ()

	getObjId ()

	setObjId (int $obj_id=0)

	getLifecycle ()

	setLifecycle (ilAssQuestionLifecycle $lifecycle)

	setExternalId (?string $external_id)

	getExternalId ()

	getSuggestedSolutionOutput ()

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

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

	getSuggestedSolutions ()

	getReachedPoints (int $active_id, int $pass)

	getMaximumPoints ()

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

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

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

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

	validateSolutionSubmit ()

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

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

	getSuggestedSolutionPath ()

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

	buildImagePath ($questionId, $parentObjectId)

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

	getSuggestedSolutionPathWeb ()

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

	getTestOutputSolutions (int $activeId, int $pass)

	getUserSolutionPreferingIntermediate (int $active_id, $pass=null)

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

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

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

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

	getAdditionalTableName ()

	getAnswerTableName ()

	deleteAnswers (int $question_id)

	deleteAdditionalTableData (int $question_id)

	delete (int $question_id)

	getTotalAnswers ()

	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)

	syncXHTMLMediaObjectsOfQuestion ()

	createPageObject ()

	copyPageOfQuestion (int $a_q_id)

	getPageOfQuestion ()

	setOriginalId (?int $original_id)

	getOriginalId ()

	fixSvgToPng (string $imageFilenameContainingString)

	fixUnavailableSkinImageSources (string $html)

	loadFromDb (int $question_id)

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

	saveQuestionDataToDb (int $original_id=-1)

	saveToDb ()

	setNewOriginalId (int $newId)

	deleteSuggestedSolutions ()

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

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

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

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

	_resolveInternalLink (string $internal_link)

	_resolveIntLinks (int $question_id)

	syncWithOriginal ()

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

	_questionExistsInPool (int $question_id)

	getPoints ()

	setPoints (float $points)

	getSolutionMaxPass (int $active_id)

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

	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $previewSession, $reachedPoints)

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)

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

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

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

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

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

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

	getQuestion ()

	getQuestionForHTMLOutput ()

	setQuestion (string $question="")

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

	getQuestionTypeID ()

	syncHints ()

	cleanupMediaObjectUsage ()

	getInstances ()

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

	hasSpecificFeedback ()

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

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

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

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

	getNrOfTries ()

	setNrOfTries (int $a_nr_of_tries)

	setExportImagePath (string $path)

	formatSAQuestion ($a_q)

	setPreventRteUsage (bool $prevent_rte_usage)

	getPreventRteUsage ()

	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)

	setSelfAssessmentEditingMode (bool $selfassessmenteditingmode)

	getSelfAssessmentEditingMode ()

	setDefaultNrOfTries (int $defaultnroftries)

	getDefaultNrOfTries ()

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

	ensureHintPageObjectExists ($pageObjectId)

	isAnswered (int $active_id, int $pass)

	isAutosaveable ()

	getAdditionalContentEditingMode ()

	setAdditionalContentEditingMode (?string $additionalContentEditingMode)

	isAdditionalContentEditingModePageObject ()

	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)

	getValidAdditionalContentEditingModes ()

	getHtmlUserSolutionPurifier ()

	getHtmlQuestionContentPurifier ()

	setLastChange ($lastChange)

	getLastChange ()

	removeIntermediateSolution (int $active_id, int $pass)

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

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

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

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

	setStep ($step)

	getStep ()

	toJSON ()

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

	intermediateSolutionExists (int $active_id, int $pass)

	authorizedSolutionExists (int $active_id, ?int $pass)

	authorizedOrIntermediateSolutionExists (int $active_id, int $pass)

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

	isAddableAnswerOptionValue (int $qIndex, string $answerOptionValue)

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

	removeAllExistingSolutions ()

	removeExistingSolutions (int $activeId, int $pass)

	resetUsersAnswer (int $activeId, int $pass)

	removeResultRecord (int $activeId, int $pass)

	fetchValuePairsFromIndexedValues (array $indexedValues)

	fetchIndexedValuesFromValuePairs (array $valuePairs)

	areObligationsToBeConsidered ()

	setObligationsToBeConsidered (bool $obligationsToBeConsidered)

	updateTimestamp ()

	getTestPresentationConfig ()

	savePartial ()

	isInActiveTest ()

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

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

Static Public Member Functions
static	getValidScoringModes ()

static	getScoringModesWithPointsByQuestion ()

static	getScoringModesWithPointsByKeyword ()

static	isObligationPossible (int $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 (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...

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	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 = ':'

Protected Member Functions
	calculateReachedPointsForSolution ($solution)

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
const	HAS_SPECIFIC_FEEDBACK = false

	$wordCounterEnabled

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 Member Functions
	isValidTextRating ($textRating)

Private Attributes
	$matchcondition

Additional Inherited Members
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 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 37 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 90 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 880 of file class.assTextQuestion.php.

References assQuestion\$points.

Referenced by loadFromDb(), and setAnswers().

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

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

     {
         if ($returndetails) {
             throw new ilTestException('return details not implemented for ' . __METHOD__);
         }
 
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         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 527 of file class.assTextQuestion.php.

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

Referenced by calculateReachedPoints().

     {
         $solution = html_entity_decode($solution);
         // 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 270 of file class.assTextQuestion.php.

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

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

References ilStr\strLen().

                                        : int
     {
         $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 1092 of file class.assTextQuestion.php.

                                      : int
     {
         if ($text === '') {
             return 0;
         }
         $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 298 of file class.assTextQuestion.php.

References assQuestion\$id, 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();
         // 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 931 of file class.assTextQuestion.php.

References $i, and $index.

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

◆ duplicate()

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

Duplicates an assTextQuestion.

public

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

References assQuestion\$author, assQuestion\$original_id, assQuestion\$owner, assQuestion\$title, assQuestion\_getOriginalId(), 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();
         }
 
         // 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 992 of file class.assTextQuestion.php.

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

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

Referenced by loadFromDb(), and setAnswers().

                                   : void
     {
         $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 801 of file class.assTextQuestion.php.

Referenced by getSolutionSubmit(), and loadFromDb().

                                             : string
     {
         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 908 of file class.assTextQuestion.php.

References $index.

                                          : ?object
     {
         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 862 of file class.assTextQuestion.php.

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

◆ getAnswers()

assTextQuestion::getAnswers ( )

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

References $answers.

Referenced by calculateReachedPointsForSolution().

                                 : array
     {
         return $this->answers;
     }

Here is the caller graph for this function:

◆ getAnswerTableName()

assTextQuestion::getAnswerTableName ( )

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

                                         : string
     {
         return 'qpl_a_essay';
     }

◆ getKeywordRelation()

assTextQuestion::getKeywordRelation ( )

Definition at line 1015 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	(	int	$active_id,
		int	$pass
	)

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

References assQuestion\getId().

                                                                        : ?string
     {
         // 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')
             . ' AND pass = ' . $this->db->quote($pass, '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')
             . ' AND pass = ' . $this->db->quote($pass, 'int')
             );
             $trow = $this->db->fetchAssoc($tresult);
             return $trow['value1'];
         }
         return null;
     }

Here is the call graph for this function:

◆ getMatchcondition()

assTextQuestion::getMatchcondition ( )

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

References $matchcondition.

Referenced by getSolutionSubmit().

                                        : int
     {
         return $this->matchcondition;
     }

Here is the caller 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 382 of file class.assTextQuestion.php.

References assQuestion\$points, and getKeywordRelation().

Referenced by calculateReachedPointsForSolution(), and isComplete().

                                       : float
     {
         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 339 of file class.assTextQuestion.php.

References $maxNumOfChars.

Referenced by getSolutionSubmit(), and toJSON().

                                       : int
     {
         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 399 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 753 of file class.assTextQuestion.php.

Referenced by toJSON().

                                      : string
     {
         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 810 of file class.assTextQuestion.php.

                                                 : string
     {
         return parent::getRTETextWithMediaObjects();
     }

◆ getScoringModesWithPointsByKeyword()

static assTextQuestion::getScoringModesWithPointsByKeyword ( )

static

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

Referenced by assTextQuestionGUI\getBestAnswer().

                                                                : array
     {
         return array('any');
     }

Here is the caller graph for this function:

◆ getScoringModesWithPointsByQuestion()

static assTextQuestion::getScoringModesWithPointsByQuestion ( )

static

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

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

◆ getSolutionSubmit()

assTextQuestion::getSolutionSubmit ( )

Returns: mixed|string

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

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

Referenced by saveWorkingData().

     {
         if (ilObjAdvancedEditing::_getRichTextEditor() === 'tinymce') {
             $text = ilUtil::stripSlashes($_POST["TEXT"], false);
         } else {
             $text = htmlentities($_POST["TEXT"]);
         }
 
         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 public

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

References $text_rating.

Referenced by getSolutionSubmit(), and isKeywordMatching().

                                    : string
     {
         return $this->text_rating;
     }

Here is the caller graph for this function:

◆ getValidScoringModes()

static assTextQuestion::getValidScoringModes ( )

static

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

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

◆ isAnswered()

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

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

(overwrites method in class assQuestion)

Parameters

integer	$active_id
integer	$pass

Returns: boolean $answered

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

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

                                                          : bool
     {
         $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 120 of file class.assTextQuestion.php.

References getMaximumPoints().

                                 : bool
     {
         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 469 of file class.assTextQuestion.php.

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

                                                               : bool
     {
         global $DIC;
         $refinery = $DIC->refinery();
         $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));
             }
         }
 
         // create correct transformation
         switch ($textrating) {
             case TEXTGAP_RATING_LEVENSHTEIN1:
                 $transformation = $refinery->string()->levenshtein()->standard($a_keyword, 1);
                 break;
             case TEXTGAP_RATING_LEVENSHTEIN2:
                 $transformation = $refinery->string()->levenshtein()->standard($a_keyword, 2);
                 break;
             case TEXTGAP_RATING_LEVENSHTEIN3:
                 $transformation = $refinery->string()->levenshtein()->standard($a_keyword, 3);
                 break;
             case TEXTGAP_RATING_LEVENSHTEIN4:
                 $transformation = $refinery->string()->levenshtein()->standard($a_keyword, 4);
                 break;
             case TEXTGAP_RATING_LEVENSHTEIN5:
                 $transformation = $refinery->string()->levenshtein()->standard($a_keyword, 5);
                 break;
         }
 
         // run answers against Levenshtein methods
         foreach ($answerwords as $a_original) {
             if (isset($transformation) && $transformation->transform($a_original) >= 0) {
                 return true;
             }
         }
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isObligationPossible()

static assTextQuestion::isObligationPossible ( int $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 1072 of file class.assTextQuestion.php.

                                                                 : bool
     {
         return true;
     }

◆ isValidTextRating()

assTextQuestion::isValidTextRating ( $textRating )

private

Definition at line 445 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().

                                                    : bool
     {
         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 363 of file class.assTextQuestion.php.

References $wordCounterEnabled.

Referenced by getSolutionSubmit().

                                           : bool
     {
         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 157 of file class.assTextQuestion.php.

References $data, $DIC, Vendor\Package\$e, $ilDB, ilRTE\_replaceMediaObjectImageSrc(), addAnswer(), flushAnswers(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), assQuestion\getId(), ilAssQuestionLifecycle\getInstance(), isValidTextRating(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), 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.

                                             : 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 ($ilDB->numRows($result) == 1) {
             $data = $ilDB->fetchAssoc($result);
             $this->setId($question_id);
             $this->setObjId($data["obj_fi"]);
             $this->setTitle((string) $data["title"]);
             $this->setComment((string) $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((string) $data["question_text"], 1));
             $this->setShuffle(false);
             $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'])) ? (int) $data['matchcondition'] : 0;
             $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 137 of file class.assTextQuestion.php.

References assQuestion\$original_id, ilObjQuestionScoringAdjustable\saveAdditionalQuestionDataToDb(), ilObjAnswerScoringAdjustable\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()

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

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

                                                                                  : bool
     {
         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 971 of file class.assTextQuestion.php.

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

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

{}

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

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

                                                                                                                     : int
     {
         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()) {
             $worksheet->setStringEscaping(false);
         }
 
         if (array_key_exists(0, $solutions) && strlen($solutions[0]["value1"])) {
             $worksheet->setCell($startrow + $i, 2, html_entity_decode($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 1024 of file class.assTextQuestion.php.

Referenced by loadFromDb().

                                                    : void
     {
         $this->keyword_relation = $a_relation;
     }

Here is the caller graph for this function:

◆ setMatchcondition()

assTextQuestion::setMatchcondition ( int $matchcondition )

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

References $matchcondition.

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

◆ 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 355 of file class.assTextQuestion.php.

Referenced by loadFromDb().

                                                    : void
     {
         $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 424 of file class.assTextQuestion.php.

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

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

Definition at line 777 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().

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

References $wordCounterEnabled.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ toJSON()

assTextQuestion::toJSON ( )

Returns a JSON representation of the question.

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

References assQuestion\formatSAQuestion(), assQuestion\getId(), getMaxNumOfChars(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), and assQuestion\getTitleForHTMLOutput().

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

Here is the call graph for this function:

Field Documentation

◆ $answers

assTextQuestion::$answers

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

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

◆ $keyword_relation

assTextQuestion::$keyword_relation = 'any'

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

Referenced by getKeywordRelation().

◆ $keywords

assTextQuestion::$keywords

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

◆ $matchcondition

assTextQuestion::$matchcondition

private

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

Referenced by getMatchcondition(), and setMatchcondition().

◆ $maxNumOfChars

assTextQuestion::$maxNumOfChars

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

Referenced by getMaxNumOfChars().

◆ $text_rating

assTextQuestion::$text_rating

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

Referenced by getTextRating().

◆ $wordCounterEnabled

assTextQuestion::$wordCounterEnabled

protected

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

Referenced by isWordCounterEnabled(), and setWordCounterEnabled().

◆ HAS_SPECIFIC_FEEDBACK

const assTextQuestion::HAS_SPECIFIC_FEEDBACK = false

protected

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

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

◆ getMatchcondition()

◆ getMaximumPoints()

◆ getMaxNumOfChars()

◆ getMinimumPoints()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getScoringModesWithPointsByKeyword()

◆ getScoringModesWithPointsByQuestion()

◆ getSolutionSubmit()

◆ getTextRating()

◆ getValidScoringModes()

◆ isAnswered()

◆ isComplete()

◆ isKeywordMatching()

◆ isObligationPossible()

◆ isValidTextRating()

◆ isWordCounterEnabled()

◆ loadFromDb()

◆ saveToDb()

◆ saveWorkingData()

◆ setAnswers()

◆ setExportDetailsXLS()

◆ setKeywordRelation()

◆ setMatchcondition()

◆ setMaxNumOfChars()

◆ setReachedPoints()

◆ setTextRating()

◆ setWordCounterEnabled()

◆ toJSON()

Field Documentation

◆ $answers

◆ $keyword_relation

◆ $keywords

◆ $matchcondition

◆ $maxNumOfChars

◆ $text_rating

◆ $wordCounterEnabled

◆ HAS_SPECIFIC_FEEDBACK