Class for TextSubset questions. More...

Inheritance diagram for assTextSubset:

Collaboration diagram for assTextSubset:

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

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

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

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

	addAnswer ($answertext, $points, $order)
	Adds an answer to the question. More...

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

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

	createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")

	getAnswerCount ()
	Returns the number of answers. More...

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

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

	flushAnswers ()
	Deletes all answers. More...

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

&	getAvailableAnswers ()
	Returns the available answers for the question. More...

	isAnswerCorrect ($answers, $answer)
	Returns the index of the found answer, if the given answer is in the set of correct answers and matchess the matching options, otherwise FALSE is returned. More...

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

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

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

	setCorrectAnswers ($a_correct_answers)
	Sets the number of correct answers needed to solve the question. More...

	getCorrectAnswers ()
	Returns the number of correct answers needed to solve the question. More...

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

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

&	joinAnswers ()
	Returns the answers of the question as a comma separated string. More...

	getMaxTextboxWidth ()
	Returns the maximum width needed for the answer textboxes. 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...

	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, &$format_title, &$format_bold)
	Creates an Excel worksheet for the detailed cumulated results of this question. More...

	getAnswers ()

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

	getOperators ($expression)
	Get all available operations for a specific question. More...

	getExpressionTypes ()
	Get all available expression types for a specific question. More...

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

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

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

	setExternalId ($external_id)

	getExternalId ()

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

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

	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, $question_id, $pass=NULL)
	Returns the points, a learner has reached answering the question. 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...

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

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

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

	_logAction ($logtext="", $active_id="", $question_id="")
	Logs an action into the Test&Assessment log. 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...

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

	getQuestionTypeFromDb ($question_id)
	get question type for question id 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...

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

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

	copyXHTMLMediaObjectsOfQuestion ($a_q_id)

	syncXHTMLMediaObjectsOfQuestion ()

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

	copyPageOfQuestion ($a_q_id)

	getPageOfQuestion ()

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

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

	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)

	_getInternalLinkHref ($target="")

	syncWithOriginal ()

	createRandomSolution ($test_id, $user_id)

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

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

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

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

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

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

	createNewImageFileName ($image_filename, $unique=false)

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

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

	_needsManualScoring ($question_id)

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

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

	_questionExistsInTest ($question_id, $test_id)

	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, $ignoredSolutionIds=array())

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

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

	updateCurrentSolutionsAuthorization ($activeId, $pass, $authorized)

	setStep ($step)

	getStep ()

	toJSON ()

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

	authorizedSolutionExists ($active_id, $pass)

	authorizedOrIntermediateSolutionExists ($active_id, $pass)

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

	removeExistingSolutions ($activeId, $pass)

	resetUsersAnswer ($activeId, $pass)

	removeResultRecord ($activeId, $pass)

	areObligationsToBeConsidered ()

	setObligationsToBeConsidered ($obligationsToBeConsidered)

	validateSolutionSubmit ()

	updateTimestamp ()

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

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

Public Member Functions inherited from iQuestionCondition
	getOperators ($expression)
	Get all available operations for a specific question. More...

	getExpressionTypes ()
	Get all available expression types for a specific question. More...

	getUserQuestionResult ($active_id, $pass)
	Get the user solution for a question by active_id and the test pass. More...

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

Data Fields
	$answers

	$correctanswers

	$text_rating

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'

Data Fields inherited from iQuestionCondition
const	StringResultExpression = '~TEXT~'

const	PercentageResultExpression = '%n%'

const	NumericResultExpression = '#n#'

const	MatchingResultExpression = ';n:m;'

const	OrderingResultExpression = '$n,m,o,p$'

const	NumberOfResultExpression = '+n+'

const	ExclusiveResultExpression = 'n,m,o,p'

const	EmptyAnswerExpression = "?"

Protected Member Functions
	reworkWorkingData ($active_id, $pass, $obligationsAnswered)
	Reworks the allready saved working data if neccessary. More...

	getSolutionSubmit ()

	calculateReachedPointsForSolution ($enteredTexts)

Protected Member Functions inherited from assQuestion
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	Reworks the allready saved working data if neccessary. More...

	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)

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

	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)

	getSelfAssessmentFormatter ()

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

static	isForcePassResultUpdateEnabled ()

static	isAllowedImageMimeType ($mimeType)

static	fetchMimeTypeIdentifier ($contentTypeString)

static	getAllowedFileExtensionsForMimeType ($mimeType)

static	isAllowedImageFileExtension ($mimeType, $fileExtension)

static	getAllowedImageFileExtensions ()

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	_getTotalRightAnswers ($a_q_id)
	get number of answers for question id (static) note: do not use $this inside this method More...

static	isFileAvailable ($file)

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	_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	_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	lookupParentObjId ($questionId)
	@global ilDB $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	setResultGateway ($resultGateway)

static	getResultGateway ()

static	sumTimesInISO8601FormatH_i_s_Extended ($time1, $time2)

static	convertISO8601FormatH_i_s_ExtendedToSeconds ($time)

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

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

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

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

	$suggested_solutions

	$original_id

	$page

	$external_id = ''

	$questionChangeListeners = array()

	$processLocker

	$step = null

	$lastChange

	$shuffler

Static Protected Attributes inherited from assQuestion
static	$allowedFileExtensionsByMimeType

static	$allowedCharsetsByMimeType

static	$forcePassResultsUpdateEnabled = false

static	$imageSourceFixReplaceMap

Detailed Description

Class for TextSubset questions.

assTextSubset is a class for TextSubset questions. To solve a TextSubset question, a learner has to enter a TextSubsetal value in a defined range

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; Nina Gharib nina@.nosp@m.wgse.nosp@m.rve.d.nosp@m.e; 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 26 of file class.assTextSubset.php.

Constructor & Destructor Documentation

◆ __construct()

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

assTextSubset constructor

The constructor takes possible arguments an creates an instance of the assTextSubset 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 TextSubsetal ID to identify the owner/creator
string	$question	The question string of the TextSubset question

Reimplemented from assQuestion.

Definition at line 66 of file class.assTextSubset.php.

        {
                parent::__construct($title, $comment, $author, $owner, $question);
                $this->answers = array();
                $this->correctanswers = 0;
        }

References assQuestion\$author, assQuestion\$comment, assQuestion\$owner, assQuestion\$question, and assQuestion\$title.

Member Function Documentation

◆ addAnswer()

assTextSubset::addAnswer	(	$answertext,
		$points,
		$order
	)

Adds an answer to the question.

@access public

Definition at line 181 of file class.assTextSubset.php.

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

References $changed, and assQuestion\$points.

◆ calculateReachedPoints()

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

@access public

Parameters

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

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

Reimplemented from assQuestion.

Definition at line 536 of file class.assTextSubset.php.

        {
                if( $returndetails )
                {
                        throw new ilTestException('return details not implemented for '.__METHOD__);
                }
                
                global $ilDB;
                
                
                if (is_null($pass))
                {
                        $pass = $this->getSolutionMaxPass($active_id);
                }
                $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);
                
                $enteredTexts = array();
                while ($data = $ilDB->fetchAssoc($result))
                {
                        $enteredTexts[] = $data["value1"];
                }
 
                $points = $this->calculateReachedPointsForSolution($enteredTexts);
 
                return $points;
        }

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

Here is the call graph for this function:

◆ calculateReachedPointsForSolution()

assTextSubset::calculateReachedPointsForSolution ( $enteredTexts )

protected

Parameters

$enteredTexts

Returns: int

Definition at line 885 of file class.assTextSubset.php.

        {
                $available_answers = $this->getAvailableAnswers();
                $points = 0;
                foreach($enteredTexts as $enteredtext)
                {
                        $index = $this->isAnswerCorrect($available_answers, $enteredtext);
                        if($index !== FALSE)
                        {
                                unset($available_answers[$index]);
                                $points += $this->answers[$index]->getPoints();
                        }
                }
                return $points;
        }

References assQuestion\$points, getAvailableAnswers(), and isAnswerCorrect().

Referenced by calculateReachedPoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyObject()

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

Copies an assTextSubset object.

@access public

Definition at line 273 of file class.assTextSubset.php.

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

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

Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

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

Definition at line 302 of file class.assTextSubset.php.

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

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

Here is the call graph for this function:

◆ deleteAnswer()

assTextSubset::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 @access public

See also: $answers

Definition at line 375 of file class.assTextSubset.php.

        {
                if ($index < 0) return;
                if (count($this->answers) < 1) return;
                if ($index >= count($this->answers)) return;
                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()

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

Duplicates an assTextSubsetQuestion.

@access public

Reimplemented from assQuestion.

Definition at line 214 of file class.assTextSubset.php.

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

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

Here is the call graph for this function:

◆ flushAnswers()

assTextSubset::flushAnswers ( )

Deletes all answers.

@access public

See also: $answers

Definition at line 397 of file class.assTextSubset.php.

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

◆ getAdditionalTableName()

assTextSubset::getAdditionalTableName ( )

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

Returns: string The additional table name @access public

Reimplemented from assQuestion.

Definition at line 758 of file class.assTextSubset.php.

        {
                return "qpl_qst_textsubset";
        }

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ getAnswer()

assTextSubset::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_assAnswerBinaryStateImage-Object containing the answer @access public

See also: $answers

Definition at line 358 of file class.assTextSubset.php.

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

Referenced by getAvailableAnswerOptions().

Here is the caller graph for this function:

◆ getAnswerCount()

assTextSubset::getAnswerCount ( )

Returns the number of answers.

Returns: integer The number of answers of the TextSubset question @access public

See also: $ranges

Definition at line 344 of file class.assTextSubset.php.

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

◆ getAnswers()

assTextSubset::getAnswers ( )

Definition at line 810 of file class.assTextSubset.php.

        {
                return $this->answers;
        }

References $answers.

Referenced by getAvailableAnswerOptions(), and toJSON().

Here is the caller graph for this function:

◆ getAnswerTableName()

assTextSubset::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns: string The answer table name @access public

Reimplemented from assQuestion.

Definition at line 769 of file class.assTextSubset.php.

        {
                return "qpl_a_textsubset";
        }

◆ getAvailableAnswerOptions()

assTextSubset::getAvailableAnswerOptions ( $index = null )

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

Parameters

null | int $index

Returns: array|ASS_AnswerSimple

Implements iQuestionCondition.

Definition at line 984 of file class.assTextSubset.php.

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

References getAnswer(), and getAnswers().

Here is the call graph for this function:

◆ getAvailableAnswers()

& assTextSubset::getAvailableAnswers ( )

Returns the available answers for the question.

@access private

See also: $answers

Definition at line 433 of file class.assTextSubset.php.

        {
                $available_answers = array();
                foreach ($this->answers as $answer)
                {
                        array_push($available_answers, $answer->getAnswertext());
                }
                return $available_answers;
        }

Referenced by calculateReachedPointsForSolution().

Here is the caller graph for this function:

◆ getCorrectAnswers()

assTextSubset::getCorrectAnswers ( )

Returns the number of correct answers needed to solve the question.

Returns: integer The number of correct answers @access public

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

        {
                return $this->correctanswers;
        }

References $correctanswers.

Referenced by getMaximumPoints(), and toJSON().

Here is the caller graph for this function:

◆ getExpressionTypes()

assTextSubset::getExpressionTypes ( )

Get all available expression types for a specific question.

Returns: array

Implements iQuestionCondition.

Definition at line 919 of file class.assTextSubset.php.

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

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

◆ getMaximumPoints()

assTextSubset::getMaximumPoints ( )

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

@access public

See also: $points

Reimplemented from assQuestion.

Definition at line 408 of file class.assTextSubset.php.

        {
                $points = array();
                foreach ($this->answers as $answer)
                {
                        if ($answer->getPoints() > 0)
                        {
                                array_push($points, $answer->getPoints());
                        }
                }
                rsort($points, SORT_NUMERIC);
                $maxpoints = 0;
                for ($counter = 0; $counter < $this->getCorrectAnswers(); $counter++)
                {
                        $maxpoints += $points[$counter];
                }
                return $maxpoints;
        }

References assQuestion\$points, and getCorrectAnswers().

Referenced by isComplete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxTextboxWidth()

assTextSubset::getMaxTextboxWidth ( )

Returns the maximum width needed for the answer textboxes.

Returns: integer Maximum textbox width @access public

Definition at line 741 of file class.assTextSubset.php.

        {
                $maxwidth = 0;
                foreach ($this->answers as $answer)
                {
                        $len = strlen($answer->getAnswertext());
                        if ($len > $maxwidth) $maxwidth = $len;
                }
                return $maxwidth + 3;
        }

◆ getOperators()

assTextSubset::getOperators ( $expression )

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

Definition at line 909 of file class.assTextSubset.php.

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

References ilOperatorsExpressionMapping\getOperatorsByExpression().

Here is the call graph for this function:

◆ getQuestionType()

assTextSubset::getQuestionType ( )

Returns the question type of the question.

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

Reimplemented from assQuestion.

Definition at line 710 of file class.assTextSubset.php.

        {
                return "assTextSubset";
        }

Referenced by toJSON().

Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assTextSubset::getRTETextWithMediaObjects ( )

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

Reimplemented from assQuestion.

Definition at line 778 of file class.assTextSubset.php.

        {
                return parent::getRTETextWithMediaObjects();
        }

◆ getSolutionSubmit()

assTextSubset::getSolutionSubmit ( )

protected

Returns: array

Definition at line 862 of file class.assTextSubset.php.

        {
                $solutionSubmit = array();
                $purifier = $this->getHtmlUserSolutionPurifier();
                foreach($_POST as $key => $val)
                {
                        if(preg_match("/^TEXTSUBSET_(\d+)/", $key, $matches))
                        {
                                $val = trim($val);
                                if(strlen($val))
                                {
                                        $val = $purifier->purify($val);
                                        $solutionSubmit[] = $val;
                                }
                        }
                }
                return $solutionSubmit;
        }

References $_POST, and assQuestion\getHtmlUserSolutionPurifier().

Referenced by saveWorkingData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTextRating()

assTextSubset::getTextRating ( )

Returns the rating option for text comparisons.

Returns: string The rating option for text comparisons

See also: $text_rating @access User interface

Definition at line 495 of file class.assTextSubset.php.

        {
                return $this->text_rating;
        }

References $text_rating.

Referenced by isAnswerCorrect(), and toJSON().

Here is the caller graph for this function:

◆ isAnswerCorrect()

assTextSubset::isAnswerCorrect	(	$answers,
		$answer
	)

Returns the index of the found answer, if the given answer is in the set of correct answers and matchess the matching options, otherwise FALSE is returned.

Parameters

array	$answers	An array containing the correct answers
string	$answer	The text of the given answer

Returns: mixed The index of the correct answer, FALSE otherwise @access public

Definition at line 453 of file class.assTextSubset.php.

        {
                include_once "./Services/Utilities/classes/class.ilStr.php";
                $result = 0;
                $textrating = $this->getTextRating();
                foreach ($answers as $key => $value)
                {
                        switch ($textrating)
                        {
                                case TEXTGAP_RATING_CASEINSENSITIVE:
                                        if (strcmp(ilStr::strToLower($value), ilStr::strToLower($answer)) == 0 && $this->answers[$key]->getPoints() > 0) return $key;
                                        break;
                                case TEXTGAP_RATING_CASESENSITIVE:
                                        if (strcmp($value, $answer) == 0 && $this->answers[$key]->getPoints() > 0) return $key;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN1:
                                        if (levenshtein($value, $answer) <= 1 && $this->answers[$key]->getPoints() > 0) return $key;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN2:
                                        if (levenshtein($value, $answer) <= 2 && $this->answers[$key]->getPoints() > 0) return $key;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN3:
                                        if (levenshtein($value, $answer) <= 3 && $this->answers[$key]->getPoints() > 0) return $key;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN4:
                                        if (levenshtein($value, $answer) <= 4 && $this->answers[$key]->getPoints() > 0) return $key;
                                        break;
                                case TEXTGAP_RATING_LEVENSHTEIN5:
                                        if (levenshtein($value, $answer) <= 5 && $this->answers[$key]->getPoints() > 0) return $key;
                                        break;
                        }
                }
                return FALSE;
        }

References $result, assQuestion\getPoints(), getTextRating(), 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().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isComplete()

assTextSubset::isComplete ( )

Returns true, if a TextSubset question is complete for use.

Returns: boolean True, if the TextSubset question is complete for use, otherwise false @access public

Reimplemented from assQuestion.

Definition at line 85 of file class.assTextSubset.php.

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

References getMaximumPoints().

Here is the call graph for this function:

◆ joinAnswers()

& assTextSubset::joinAnswers ( )

Returns the answers of the question as a comma separated string.

Returns: string The answer string @access public

Definition at line 721 of file class.assTextSubset.php.

        {
                $join = array();
                foreach ($this->answers as $answer)
                {
                        if (!is_array($join[$answer->getPoints() . ""]))
                        {
                                $join[$answer->getPoints() . ""] = array();
                        }
                        array_push($join[$answer->getPoints() . ""], $answer->getAnswertext());
                }
                return $join;
        }

◆ loadFromDb()

assTextSubset::loadFromDb ( $question_id )

Loads a assTextSubset object from a database.

Parameters

object	$db	A pear DB object
integer	$question_id	A unique key which defines the multiple choice test in the database @access public

Reimplemented from assQuestion.

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

        {
                global $ilDB;
 
                $result = $ilDB->queryF("SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
                        array("integer"),
                        array($question_id)
                );
                if ($result->numRows() == 1)
                {
                        $data = $ilDB->fetchAssoc($result);
                        $this->setId($question_id);
                        $this->setObjId($data["obj_fi"]);
                        $this->setNrOfTries($data['nr_of_tries']);
                        $this->setTitle($data["title"]);
                        $this->setComment($data["description"]);
                        $this->setOriginalId($data["original_id"]);
                        $this->setAuthor($data["author"]);
                        $this->setPoints($data["points"]);
                        $this->setOwner($data["owner"]);
                        include_once("./Services/RTE/classes/class.ilRTE.php");
                        $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
                        $this->setCorrectAnswers($data["correctanswers"]);
                        $this->setTextRating($data["textgap_rating"]);
                        $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
                        
                        try
                        {
                                $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
                        }
                        catch(ilTestQuestionPoolException $e)
                        {
                        }
                }
 
 
                $result = $ilDB->queryF("SELECT * FROM qpl_a_textsubset WHERE question_fi = %s ORDER BY aorder ASC",
                        array('integer'),
                        array($question_id)
                );
                include_once "./Modules/TestQuestionPool/classes/class.assAnswerBinaryStateImage.php";
                if ($result->numRows() > 0)
                {
                        while ($data = $ilDB->fetchAssoc($result))
                        {
                                array_push($this->answers, new ASS_AnswerBinaryStateImage($data["answertext"], $data["points"], $data["aorder"]));
                        }
                }
 
                parent::loadFromDb($question_id);
        }

References $data, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), setCorrectAnswers(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), setTextRating(), and assQuestion\setTitle().

Here is the call graph for this function:

◆ reworkWorkingData()

assTextSubset::reworkWorkingData	(	$active_id,
		$pass,
		$obligationsAnswered
	)

protected

Reworks the allready saved working data if neccessary.

@access protected

Parameters

integer	$active_id
integer	$pass
boolean	$obligationsAnswered

Definition at line 699 of file class.assTextSubset.php.

        {
                // nothing to rework!
        }

◆ saveToDb()

assTextSubset::saveToDb ( $original_id = "" )

Saves a assTextSubset object to a database.

Parameters

string $original_id

Reimplemented from assQuestion.

Definition at line 106 of file class.assTextSubset.php.

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

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

Here is the call graph for this function:

◆ saveWorkingData()

assTextSubset::saveWorkingData	(	$active_id,
		$pass = `NULL`,
		$authorized = `true`
	)

Saves the learners input of the question to the database.

@access public

Parameters

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

Returns: boolean $status

Reimplemented from assQuestion.

Definition at line 593 of file class.assTextSubset.php.

        {
                global $ilDB;
                global $ilUser;
 
                if (is_null($pass))
                {
                        include_once "./Modules/Test/classes/class.ilObjTest.php";
                        $pass = ilObjTest::_getPass($active_id);
                }
                $entered_values = 0;
 
                $solutionSubmit = $this->getSolutionSubmit();
 
                $this->getProcessLocker()->requestUserSolutionUpdateLock();
 
                $affectedRows = $this->removeCurrentSolution($active_id, $pass, $authorized);
                
                foreach($solutionSubmit as $value)
                {
                        if (strlen($value))
                        {
                                $this->saveCurrentSolution($active_id, $pass, $value, null, $authorized);
                                $entered_values++;
                        }
                }
 
                $this->getProcessLocker()->releaseUserSolutionUpdateLock();
 
                if ($entered_values)
                {
                        include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
                        if (ilObjAssessmentFolder::_enabledAssessmentLogging())
                        {
                                $this->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())
                        {
                                $this->logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
                        }
                }
                
                return true;
        }

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

Here is the call graph for this function:

◆ setCorrectAnswers()

assTextSubset::setCorrectAnswers ( $a_correct_answers )

Sets the number of correct answers needed to solve the question.

Parameters

integer $a_correct_anwers The number of correct answers @access public

Definition at line 569 of file class.assTextSubset.php.

        {
                $this->correctanswers = $a_correct_answers;
        }

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ setExportDetailsXLS()

assTextSubset::setExportDetailsXLS	(	&	$worksheet,
			$startrow,
			$active_id,
			$pass,
		&	$format_title,
		&	$format_bold
	)

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

Parameters

object	$worksheet	Reference to the parent excel worksheet
object	$startrow	Startrow of the output in the excel worksheet
object	$active_id	Active id of the participant
object	$pass	Test pass
object	$format_title	Excel title format
object	$format_bold	Excel bold format
array	$eval_data	Cumulated evaluation data @access public

Reimplemented from assQuestion.

Definition at line 795 of file class.assTextSubset.php.

        {
                include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
                $solutions = $this->getSolutionValues($active_id, $pass);
                $worksheet->writeString($startrow, 0, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())), $format_title);
                $worksheet->writeString($startrow, 1, ilExcelUtils::_convert_text($this->getTitle()), $format_title);
                $i = 1;
                foreach ($solutions as $solution)
                {
                        $worksheet->write($startrow + $i, 0, ilExcelUtils::_convert_text($solution["value1"]));
                        $i++;
                }
                return $startrow + $i + 1;
        }

References $pass, ilExcelUtils\_convert_text(), assQuestion\getSolutionValues(), and assQuestion\getTitle().

Here is the call graph for this function:

◆ setTextRating()

assTextSubset::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 @access User interface

Definition at line 507 of file class.assTextSubset.php.

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

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

Referenced by loadFromDb().

Here is the caller graph for this function:

◆ toJSON()

assTextSubset::toJSON ( )

Returns a JSON representation of the question.

Reimplemented from assQuestion.

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

        {
                include_once("./Services/RTE/classes/class.ilRTE.php");
                $result = array();
                $result['id'] = (int) $this->getId();
                $result['type'] = (string) $this->getQuestionType();
                $result['title'] = (string) $this->getTitle();
                $result['question'] =  $this->formatSAQuestion($this->getQuestion());
                $result['nr_of_tries'] = (int) $this->getNrOfTries();
                $result['matching_method'] = (string) $this->getTextRating();
                $result['feedback'] = array(
                        'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
                        'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
                );
 
                $answers = array();
                foreach ($this->getAnswers() as $key => $answer_obj)
                {
                        array_push($answers, array(
                                "answertext" => (string) $answer_obj->getAnswertext(),
                                "points" => (float)$answer_obj->getPoints(),
                                "order" => (int)$answer_obj->getOrder()
                        ));
                }
                $result['correct_answers'] = $answers;
 
                $answers = array();
                for($loop = 1; $loop <= (int) $this->getCorrectAnswers(); $loop++)
                {
                        array_push($answers, array(
                                "answernr" => $loop
                        ));
                }
                $result['answers'] = $answers;
 
                $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
                $result['mobs'] = $mobs;
                
                return json_encode($result);
        }

References $answers, $mobs, $result, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), getAnswers(), getCorrectAnswers(), assQuestion\getId(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), getTextRating(), and assQuestion\getTitle().

Here is the call graph for this function:

Field Documentation

◆ $answers

assTextSubset::$answers

Definition at line 35 of file class.assTextSubset.php.

Referenced by getAnswers(), and toJSON().

◆ $correctanswers

assTextSubset::$correctanswers

Definition at line 44 of file class.assTextSubset.php.

Referenced by getCorrectAnswers().

◆ $text_rating

assTextSubset::$text_rating

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

Referenced by getTextRating().

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

Modules/TestQuestionPool/classes/class.assTextSubset.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAnswer()

◆ calculateReachedPoints()

◆ calculateReachedPointsForSolution()

◆ copyObject()

◆ createNewOriginalFromThisDuplicate()

◆ deleteAnswer()

◆ duplicate()

◆ flushAnswers()

◆ getAdditionalTableName()

◆ getAnswer()

◆ getAnswerCount()

◆ getAnswers()

◆ getAnswerTableName()

◆ getAvailableAnswerOptions()

◆ getAvailableAnswers()

◆ getCorrectAnswers()

◆ getExpressionTypes()

◆ getMaximumPoints()

◆ getMaxTextboxWidth()

◆ getOperators()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSolutionSubmit()

◆ getTextRating()

◆ isAnswerCorrect()

◆ isComplete()

◆ joinAnswers()

◆ loadFromDb()

◆ reworkWorkingData()

◆ saveToDb()

◆ saveWorkingData()

◆ setCorrectAnswers()

◆ setExportDetailsXLS()

◆ setTextRating()

◆ toJSON()

Field Documentation

◆ $answers

◆ $correctanswers

◆ $text_rating