assErrorText Class Reference

Class for error text questions. More...

Inheritance diagram for assErrorText:

Collaboration diagram for assErrorText:

Public Member Functions
	__construct ( $title='', $comment='', $author='', $owner=-1, $question='')
	assErorText constructor More...
	isComplete ()
	Returns true, if a single choice question is complete for use. More...
	saveToDb ($original_id="")
	Saves a the object to the database. More...
	saveAnswerSpecificDataToDb ()
	Saves the answer specific records into a question types answer table. More...
	saveAdditionalQuestionDataToDb ()
	Saves the data for the additional data table. More...
	loadFromDb ($question_id)
	Loads the object from the database. More...
	duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
	Duplicates the object. More...
	copyObject ($target_questionpool_id, $title="")
	Copies an object. More...
	createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")
	getMaximumPoints ()
	Returns the maximum points, a learner can reach answering the question. More...
	calculateReachedPoints ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
	Returns the points, a learner has reached answering the question. More...
	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)
	saveWorkingData ($active_id, $pass=null, $authorized=true)
	Saves the learners input of the question to the database. More...
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	getQuestionType ()
	Returns the question type of the question. 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)
	{} More...
	fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
	Creates a question from a QTI file. 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 and sets the internal domxml variable with the DOM XML representation of the QTI xml representation. More...
	getBestSolution ($active_id, $pass)
	Returns the best solution for a given pass of a participant. More...
	getErrorsFromText ($a_text="")
	setErrorData ($a_data)
	createErrorTextOutput ($selections=null, $graphicalOutput=false, $correct_solution=false, $use_link_tags=true)
	createErrorTextExport ($selections=null)
	getBestSelection ($withPositivePointsOnly=true)
	flushErrorData ()
	Flush error data. More...
	addErrorData ($text_wrong, $text_correct, $points)
	getErrorData ()
	Get error data. More...
	getErrorText ()
	Get error text. More...
	setErrorText ($a_value)
	Set error text. More...
	getTextSize ()
	Set text size in percent. More...
	setTextSize ($a_value)
	Set text size in percent. More...
	getPointsWrong ()
	Get wrong points. More...
	setPointsWrong ($a_value)
	Set wrong points. More...
	__get ($value)
	Object getter. More...
	__set ($key, $value)
	Object setter. More...
	toJSON ()
	Returns a JSON representation of the question. More...
	getOperators ($expression)
	Get all available operations for a specific question. More...
	getExpressionTypes ()
	Get all available expression types for a specific question. More...
	getAvailableAnswerOptions ($index=null)
	If index is null, the function returns an array with all anwser options Else it returns the specific answer option. More...
Public Member Functions inherited from assQuestion
	__construct ( $title="", $comment="", $author="", $owner=-1, $question="")
	assQuestion constructor More...
	getShuffler ()
	setShuffler (ilArrayElementShuffler $shuffler)
	setProcessLocker ($processLocker)
	getProcessLocker ()
	fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
	Receives parameters from a QTI parser and creates a valid ILIAS question object. More...
	toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $force_image_references=false)
	Returns a QTI xml representation of the question. More...
	isComplete ()
	Returns true, if a question is complete for use. More...
	questionTitleExists ($questionpool_id, $title)
	Returns TRUE if the question title exists in the database. More...
	setTitle ($title="")
	Sets the title string of the assQuestion object. More...
	setId ($id=-1)
	Sets the id of the assQuestion object. More...
	setTestId ($id=-1)
	Sets the test id of the assQuestion object. More...
	setComment ($comment="")
	Sets the comment string of the assQuestion object. More...
	setOutputType ($outputType=OUTPUT_HTML)
	Sets the output type. More...
	setShuffle ($shuffle=true)
	Sets the shuffle flag. More...
	setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)
	Sets the estimated working time of a question from given hour, minute and second. More...
	setEstimatedWorkingTimeFromDurationString ($durationString)
	Sets the estimated working time of a question from a given datetime string. More...
	keyInArray ($searchkey, $array)
	returns TRUE if the key occurs in an array More...
	setAuthor ($author="")
	Sets the authors name of the assQuestion object. More...
	setOwner ($owner="")
	Sets the creator/owner ID of the assQuestion object. More...
	getTitle ()
	Gets the title string of the assQuestion object. More...
	getTitleFilenameCompliant ()
	returns the object title prepared to be used as a filename More...
	getId ()
	Gets the id of the assQuestion object. More...
	getShuffle ()
	Gets the shuffle flag. More...
	getTestId ()
	Gets the test id of the assQuestion object. More...
	getComment ()
	Gets the comment string of the assQuestion object. More...
	getOutputType ()
	Gets the output type. More...
	supportsJavascriptOutput ()
	Returns true if the question type supports JavaScript output. More...
	supportsNonJsOutput ()
	requiresJsSwitch ()
	getEstimatedWorkingTime ()
	Gets the estimated working time of a question. More...
	getAuthor ()
	Gets the authors name of the assQuestion object. More...
	getOwner ()
	Gets the creator/owner ID of the assQuestion object. More...
	getObjId ()
	Get the object id of the container object. More...
	setObjId ($obj_id=0)
	Set the object id of the container object. More...
	setExternalId ($external_id)
	getExternalId ()
	getSuggestedSolutionOutput ()
&	_getSuggestedSolution ($question_id, $subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...
	getSuggestedSolutions ()
	Return the suggested solutions. More...
	getReachedPoints ($active_id, $pass=null)
	Returns the points, a learner has reached answering the question This is the fast way to get the points directly from the database. More...
	getMaximumPoints ()
	Returns the maximum points, a learner can reach answering the question. More...
	getAdjustedReachedPoints ($active_id, $pass=null, $authorizedSolution=true)
	returns the reached points ... More...
	calculateResultsFromSolution ($active_id, $pass=null, $obligationsEnabled=false)
	Calculates the question results from a previously saved question solution. More...
	persistWorkingState ($active_id, $pass=null, $obligationsEnabled=false, $authorized=true)
	persists the working state for current testactive and testpass More...
	persistPreviewState (ilAssQuestionPreviewSession $previewSession)
	persists the preview state for current user and question More...
	validateSolutionSubmit ()
	saveWorkingData ($active_id, $pass=null, $authorized=true)
	Saves the learners input of the question to the database. More...
	moveUploadedMediaFile ($file, $name)
	Move an uploaded media file to an public accessible temp dir to present it. More...
	getSuggestedSolutionPath ()
	Returns the path for a suggested solution. More...
	getJavaPath ()
	Returns the image path for web accessable images of a question. More...
	getImagePath ($question_id=null, $object_id=null)
	Returns the image path for web accessable images of a question. More...
	buildImagePath ($questionId, $parentObjectId)
	getFlashPath ()
	Returns the image path for web accessable flash files of a question. More...
	getJavaPathWeb ()
	Returns the web image path for web accessable java applets of a question. More...
	getSuggestedSolutionPathWeb ()
	Returns the web path for a suggested solution. More...
	getImagePathWeb ()
	Returns the web image path for web accessable images of a question. More...
	getFlashPathWeb ()
	Returns the web image path for web accessable flash applications of a question. More...
	getTestOutputSolutions ($activeId, $pass)
	getUserSolutionPreferingIntermediate ($active_id, $pass=null)
	getSolutionValues ($active_id, $pass=null, $authorized=true)
	Loads solutions of a given user from the database an returns it. More...
	isInUse ($question_id="")
	Checks whether the question is in use or not. More...
	isClone ($question_id="")
	Checks whether the question is a clone of another question or not. More...
	pcArrayShuffle ($array)
	Shuffles the values of a given array. More...
	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...
	getAnswerTableName ()
	Returns the name of the answer table in the database. More...
	deleteAnswers ($question_id)
	Deletes datasets from answers tables. More...
	deleteAdditionalTableData ($question_id)
	Deletes datasets from the additional question table in the database. More...
	delete ($question_id)
	Deletes a question and all materials from the database. More...
	getTotalAnswers ()
	get total number of answers More...
	_getTotalAnswers ($a_q_id)
	get number of answers for question id (static) note: do not use $this inside this method More...
	copyXHTMLMediaObjectsOfQuestion ($a_q_id)
	syncXHTMLMediaObjectsOfQuestion ()
	createPageObject ()
	create page object of question More...
	copyPageOfQuestion ($a_q_id)
	getPageOfQuestion ()
	setOriginalId ($original_id)
	getOriginalId ()
	fixSvgToPng ($imageFilenameContainingString)
	fixUnavailableSkinImageSources ($html)
	loadFromDb ($question_id)
	Loads the question from the database. More...
	createNewQuestion ($a_create_page=true)
	Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...
	saveQuestionDataToDb ($original_id="")
	saveToDb ($original_id="")
	Saves the question to the database. More...
	setNewOriginalId ($newId)
	deleteSuggestedSolutions ()
	Deletes all suggestes solutions in the database. More...
	getSuggestedSolution ($subquestion_index=0)
	Returns a suggested solution for a given subquestion index. More...
	getSuggestedSolutionTitle ($subquestion_index=0)
	Returns the title of a suggested solution at a given subquestion_index. More...
	setSuggestedSolution ($solution_id="", $subquestion_index=0, $is_import=false)
	Sets a suggested solution for the question. More...
	_resolveInternalLink ($internal_link)
	_resolveIntLinks ($question_id)
	syncWithOriginal ()
	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...
	calculateReachedPoints ($active_id, $pass=null, $authorizedSolution=true, $returndetails=false)
	Returns the points, a learner has reached answering the question. More...
	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $previewSession, $reachedPoints)
	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)
	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)
	adjustReachedPointsByScoringOptions ($points, $active_id, $pass=null)
	Adjust the given reached points by checks for all special scoring options in the test container. More...
	isHTML ($a_text)
	Checks if a given string contains HTML or not. More...
	prepareTextareaOutput ($txt_output, $prepare_for_latex_output=false, $omitNl2BrWhenTextArea=false)
	Prepares a string for a text area output in tests. More...
	QTIMaterialToString ($a_material)
	Reads an QTI material tag an creates a text string. More...
	addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=true, $add_mobs=true)
	Creates a QTI material tag from a plain text or xhtml text. More...
	buildHashedImageFilename ($plain_image_filename, $unique=false)
	getQuestion ()
	Gets the question string of the question object. More...
	setQuestion ($question="")
	Sets the question string of the question object. More...
	getQuestionType ()
	Returns the question type of the question. More...
	getQuestionTypeID ()
	Returns the question type of the question. More...
	cleanupMediaObjectUsage ()
	synchronises appearances of media objects in the question with media object usage table More...
&	getInstances ()
	Gets all instances of the question. More...
	getActiveUserData ($active_id)
	Returns the user id and the test id for a given active id. More...
	setExportDetailsXLS ($worksheet, $startrow, $active_id, $pass)
	Creates an Excel worksheet for the detailed cumulated results of this question. More...
	__get ($value)
	Object getter. More...
	__set ($key, $value)
	Object setter. More...
	getNrOfTries ()
	setNrOfTries ($a_nr_of_tries)
	setExportImagePath ($a_path)
	formatSAQuestion ($a_q)
	Format self assessment question. More...
	setPreventRteUsage ($a_val)
	Set prevent rte usage. More...
	getPreventRteUsage ()
	Get prevent rte usage. More...
	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)
	setSelfAssessmentEditingMode ($a_selfassessmenteditingmode)
	Set Self-Assessment Editing Mode. More...
	getSelfAssessmentEditingMode ()
	Get Self-Assessment Editing Mode. More...
	setDefaultNrOfTries ($a_defaultnroftries)
	Set Default Nr of Tries. More...
	getDefaultNrOfTries ()
	Get Default Nr of Tries. More...
	syncSkillAssignments ($srcParentId, $srcQuestionId, $trgParentId, $trgQuestionId)
	isAnswered ($active_id, $pass=null)
	returns boolean wether the question is answered during test pass or not More...
	isAutosaveable ()
	getAdditionalContentEditingMode ()
	getter for additional content editing mode for this question More...
	setAdditionalContentEditingMode ($additinalContentEditingMode)
	setter for additional content editing mode for this question More...
	isAdditionalContentEditingModePageObject ()
	isser for additional "pageobject" content editing mode More...
	isValidAdditionalContentEditingMode ($additionalContentEditingMode)
	returns the fact wether the passed additional content mode is valid or not More...
	getValidAdditionalContentEditingModes ()
	getter for valid additional content editing modes More...
	addQuestionChangeListener (ilQuestionChangeListener $listener)
	getQuestionChangeListeners ()
	getHtmlUserSolutionPurifier ()
	getHtmlQuestionContentPurifier ()
	setLastChange ($lastChange)
	getLastChange ()
	removeIntermediateSolution ($active_id, $pass)
	removeCurrentSolution ($active_id, $pass, $authorized=true)
	saveCurrentSolution ($active_id, $pass, $value1, $value2, $authorized=true, $tstamp=null)
	updateCurrentSolution ($solutionId, $value1, $value2, $authorized=true)
	updateCurrentSolutionsAuthorization ($activeId, $pass, $authorized, $keepTime=false)
	setStep ($step)
	getStep ()
	toJSON ()
	duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
	intermediateSolutionExists ($active_id, $pass)
	authorizedSolutionExists ($active_id, $pass)
	authorizedOrIntermediateSolutionExists ($active_id, $pass)
	removeExistingSolutions ($activeId, $pass)
	resetUsersAnswer ($activeId, $pass)
	removeResultRecord ($activeId, $pass)
	fetchValuePairsFromIndexedValues (array $indexedValues)
	fetchIndexedValuesFromValuePairs (array $valuePairs)
	areObligationsToBeConsidered ()
	setObligationsToBeConsidered ($obligationsToBeConsidered)
	updateTimestamp ()
	getTestPresentationConfig ()
	Get the test question configuration (initialised once) More...
Public Member Functions inherited from iQuestionCondition
	getUserQuestionResult ($active_id, $pass)
	Get the user solution for a question by active_id and the test pass. More...

Protected Member Functions
	reworkWorkingData ($active_id, $pass, $obligationsAnswered, $authorized)
	{} More...
	isTokenSelected ($counter, array $selection)
	getPointsForSelectedPositions ($positions)
Protected Member Functions inherited from assQuestion
	getQuestionAction ()
	isNonEmptyItemListPostSubmission ($postSubmissionFieldname)
	ensureCurrentTestPass ($active_id, $pass)
	lookupCurrentTestPass ($active_id, $pass)
	lookupTestId ($active_id)
	log ($active_id, $langVar)
	reworkWorkingData ($active_id, $pass, $obligationsAnswered, $authorized)
	Reworks the allready saved working data if neccessary. More...
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	deletePageOfQuestion ($question_id)
	Deletes the page object of a question with a given ID. More...
	onDuplicate ($originalParentId, $originalQuestionId, $duplicateParentId, $duplicateQuestionId)
	Will be called when a question is duplicated (inside a question pool or for insertion in a test) More...
	beforeSyncWithOriginal ($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId)
	afterSyncWithOriginal ($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId)
	onCopy ($sourceParentId, $sourceQuestionId, $targetParentId, $targetQuestionId)
	Will be called when a question is copied (into another question pool) More...
	duplicateSuggestedSolutionFiles ($parent_id, $question_id)
	Duplicates the files of a suggested solution if the question is duplicated. More...
	syncSuggestedSolutionFiles ($original_id)
	Syncs the files of a suggested solution if the question is synced. More...
	copySuggestedSolutionFiles ($source_questionpool_id, $source_question_id)
	ensureNonNegativePoints ($points)
	getRTETextWithMediaObjects ()
	Collects all text in the question which could contain media objects which were created with the Rich Text Editor. More...
	getSelfAssessmentFormatter ()
	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)
	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)
	duplicateQuestionHints ($originalQuestionId, $duplicateQuestionId)
	duplicateSkillAssignments ($srcParentId, $srcQuestionId, $trgParentId, $trgQuestionId)
	buildQuestionDataQuery ()
	getCurrentSolutionResultSet ($active_id, $pass, $authorized=true)
	Get a restulset for the current user solution for a this question by active_id and pass. More...
	removeSolutionRecordById ($solutionId)
	getSolutionRecordById ($solutionId)
	deleteDummySolutionRecord ($activeId, $passIndex)
	deleteSolutionRecordByValues ($activeId, $passIndex, $authorized, $matchValues)
	duplicateIntermediateSolutionAuthorized ($activeId, $passIndex)
	forceExistingIntermediateSolution ($activeId, $passIndex, $considerDummyRecordCreation)
	buildTestPresentationConfig ()
	build basic test question configuration instance More...

Protected Attributes
	$errortext
	$textsize
	$errordata
	$points_wrong
Protected Attributes inherited from assQuestion
	$id
	$title
	$comment
	$owner
	$author
	$question
	$points
	$est_working_time
	$shuffle
	$test_id
	$obj_id
	$ilias
	$tpl
	$lng
	$db
	$outputType = OUTPUT_JAVASCRIPT
	$suggested_solutions
	$original_id
	$page
	$external_id = ''
	$questionChangeListeners = array()
	$processLocker
	$step = null
	$lastChange
	$shuffler
	$testQuestionConfig

Private Member Functions
	getErrorTokenHtml ($item, $class, $useLinkTags)

Additional Inherited Members
Static Public Member Functions inherited from assQuestion
static	setForcePassResultUpdateEnabled ($forcePassResultsUpdateEnabled)
static	isForcePassResultUpdateEnabled ()
static	isAllowedImageMimeType ($mimeType)
static	fetchMimeTypeIdentifier ($contentTypeString)
static	getAllowedFileExtensionsForMimeType ($mimeType)
static	isAllowedImageFileExtension ($mimeType, $fileExtension)
static	getAllowedImageMaterialFileExtensions ()
static	_getMaximumPoints ($question_id)
	Returns the maximum points, a learner can reach answering the question. More...
static	_getQuestionInfo ($question_id)
	Returns question information from the database. More...
static	_getSuggestedSolutionCount ($question_id)
	Returns the number of suggested solutions associated with a question. More...
static	_getSuggestedSolutionOutput ($question_id)
	Returns the output of the suggested solution. More...
static	_getReachedPoints ($active_id, $question_id, $pass=null)
	Returns the points, a learner has reached answering the question. More...
static	_updateTestResultCache ($active_id, ilAssQuestionProcessLocker $processLocker=null)
	Move this to a proper place. More...
static	logAction ($logtext="", $active_id="", $question_id="")
	Logs an action into the Test&Assessment log. More...
static	getQuestionTypeFromDb ($question_id)
	get question type for question id More...
static	_getTotalRightAnswers ($a_q_id)
	get number of answers for question id (static) note: do not use $this inside this method More...
static	_getTitle ($a_q_id)
	Returns the title of a question. More...
static	_getQuestionText ($a_q_id)
	Returns question text. More...
static	isFileAvailable ($file)
static	_getQuestionType ($question_id)
	Returns the question type of a question with a given id. More...
static	_getQuestionTitle ($question_id)
	Returns the question title of a question with a given id. More...
static	saveOriginalId ($questionId, $originalId)
static	resetOriginalId ($questionId)
static	_getInternalLinkHref ($target="")
static	_getOriginalId ($question_id)
	Returns the original id of a question. More...
static	originalQuestionExists ($questionId)
static	_instanciateQuestion ($question_id)
	Creates an instance of a question with a given question id. More...
static	_instantiateQuestion ($question_id)
static	_getSolutionMaxPass ($question_id, $active_id)
	Returns the maximum pass a users question solution. More...
static	_isWriteable ($question_id, $user_id)
	Returns true if the question is writeable by a certain user. More...
static	_isUsedInRandomTest ($question_id="")
	Checks whether the question is used in a random test or not. More...
static	_isWorkedThrough ($active_id, $question_id, $pass=null)
	Returns true if the question was worked through in the given pass Worked through means that the user entered at least one value. More...
static	_areAnswered ($a_user_id, $a_question_ids)
	Checks if an array of question ids is answered by an user or not. More...
static	_setReachedPoints ($active_id, $question_id, $points, $maxpoints, $pass, $manualscoring, $obligationsEnabled)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...
static	_needsManualScoring ($question_id)
static	_includeClass ($question_type, $gui=0)
	Include the php class file for a given question type. More...
static	getGuiClassNameByQuestionType ($questionType)
static	getObjectClassNameByQuestionType ($questionType)
static	getFeedbackClassNameByQuestionType ($questionType)
static	isCoreQuestionType ($questionType)
static	includeCoreClass ($questionType, $withGuiClass)
static	includePluginClass ($questionType, $withGuiClass)
static	_getQuestionTypeName ($type_tag)
	Return the translation for a given question type tag. More...
static &	_instanciateQuestionGUI ($question_id)
	Creates an instance of a question gui with a given question id. More...
static	instantiateQuestionGUI ($a_question_id)
	Creates an instance of a question gui with a given question id. More...
static	_questionExistsInTest ($question_id, $test_id)
static	lookupParentObjId ($questionId)
	ilDBInterface $ilDB More...
static	lookupOriginalParentObjId ($originalQuestionId)
	returns the parent object id for given original question id (should be a qpl id, but theoretically it can be a tst id, too) More...
static	isObligationPossible ($questionId)
	returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration More...
static	implodeKeyValues ($keyValues)
static	explodeKeyValues ($keyValues)
static	setResultGateway ($resultGateway)
static	getResultGateway ()
static	sumTimesInISO8601FormatH_i_s_Extended ($time1, $time2)
static	convertISO8601FormatH_i_s_ExtendedToSeconds ($time)
static	missingResultRecordExists ($activeId, $pass, $questionIds)
static	getQuestionsMissingResultRecord ($activeId, $pass, $questionIds)
static	lookupResultRecordExist ($activeId, $questionId, $pass)
Data Fields inherited from assQuestion
const	IMG_MIME_TYPE_JPG = 'image/jpeg'
const	IMG_MIME_TYPE_PNG = 'image/png'
const	IMG_MIME_TYPE_GIF = 'image/gif'
const	ADDITIONAL_CONTENT_EDITING_MODE_DEFAULT = 'default'
	constant for additional content editing mode "default" More...
const	ADDITIONAL_CONTENT_EDITING_MODE_PAGE_OBJECT = 'pageobject'
	constant for additional content editing mode "pageobject" More...
	$feedbackOBJ = null
	$prevent_rte_usage = false
	$selfassessmenteditingmode = false
	$defaultnroftries = 0
	$questionActionCmd = 'handleQuestionAction'
const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'
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 = "?"
Static Protected Member Functions inherited from assQuestion
static	getNumExistingSolutionRecords ($activeId, $pass, $questionId)
	returns the number of existing solution records for the given test active / pass and given question id More...
static	getKeyValuesImplosionSeparator ()
Static Protected Attributes inherited from assQuestion
static	$allowedFileExtensionsByMimeType
static	$allowedCharsetsByMimeType
static	$allowedImageMaterialFileExtensionsByMimeType
static	$forcePassResultsUpdateEnabled = false
static	$imageSourceFixReplaceMap

Detailed Description

Class for error 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

Grégory Saive gsaiv.nosp@m.e@da.nosp@m.tabay.nosp@m..de

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

Definition at line 23 of file class.assErrorText.php.

Constructor & Destructor Documentation

__construct()

assErrorText::__construct	(		$title = '',
			$comment = '',
			$author = '',
			$owner = -1,
			$question = ''
	)

assErorText constructor

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 single choice question.

Returns

Definition at line 41 of file class.assErrorText.php.

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

      {
        parent::__construct($title, $comment, $author, $owner, $question);
        $this->errortext = '';
        $this->textsize = 100.0;
        $this->errordata = array();
    }

Member Function Documentation

__get()

assErrorText::__get

(

$value

)

Object getter.

Definition at line 1060 of file class.assErrorText.php.

References getErrorText(), getPointsWrong(), and getTextSize().

    {
        switch ($value) {
            case "errortext":
                return $this->getErrorText();
                break;
            case "textsize":
                return $this->getTextSize();
                break;
            case "points_wrong":
                return $this->getPointsWrong();
                break;
            default:
                return parent::__get($value);
                break;
        }
    }

Here is the call graph for this function:

__set()

assErrorText::__set	(		$key,
			$value
	)

Object setter.

Definition at line 1081 of file class.assErrorText.php.

References $key, setErrorText(), setPointsWrong(), and setTextSize().

    {
        switch ($key) {
            case "errortext":
                $this->setErrorText($value);
                break;
            case "textsize":
                $this->setTextSize($value);
                break;
            case "points_wrong":
                $this->setPointsWrong($value);
                break;
            default:
                parent::__set($key, $value);
                break;
        }
    }

Here is the call graph for this function:

addErrorData()

assErrorText::addErrorData	(		$text_wrong,
			$text_correct,
			$points
	)

Definition at line 977 of file class.assErrorText.php.

References assQuestion\$points.

    {
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerErrorText.php";
        array_push($this->errordata, new assAnswerErrorText($text_wrong, $text_correct, $points));
    }

calculateReachedPoints()

assErrorText::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 331 of file class.assErrorText.php.

References $ilDB, $pass, assQuestion\$points, $result, $row, array, assQuestion\getCurrentSolutionResultSet(), getPointsForSelectedPositions(), and assQuestion\getSolutionMaxPass().

Referenced by getExpressionTypes().

    {
        if ($returndetails) {
            throw new ilTestException('return details not implemented for ' . __METHOD__);
        }

        global $ilDB;

        /* First get the positions which were selected by the user. */
        $positions = array();
        if (is_null($pass)) {
            $pass = $this->getSolutionMaxPass($active_id);
        }
        $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);

        while ($row = $ilDB->fetchAssoc($result)) {
            array_push($positions, $row['value1']);
        }
        $points = $this->getPointsForSelectedPositions($positions);
        return $points;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

calculateReachedPointsFromPreviewSession()

assErrorText::calculateReachedPointsFromPreviewSession

(

ilAssQuestionPreviewSession

$previewSession

)

Definition at line 353 of file class.assErrorText.php.

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

    {
        $reachedPoints = $this->getPointsForSelectedPositions($previewSession->getParticipantsSolution());
        $reachedPoints = $this->deductHintPointsFromReachedPoints($previewSession, $reachedPoints);
        return $this->ensureNonNegativePoints($reachedPoints);
    }

Here is the call graph for this function:

copyObject()

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

Copies an object.

Definition at line 241 of file class.assErrorText.php.

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

    {
        if ($this->id <= 0) {
            // The question has not been saved. It cannot be duplicated
            return;
        }
        // duplicate the question in database
        
        $thisId = $this->getId();
        $thisObjId = $this->getObjId();
        
        $clone = $this;
        include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
        $original_id = assQuestion::_getOriginalId($this->id);
        $clone->id = -1;
        $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($thisObjId, $thisId, $clone->getObjId(), $clone->getId());

        return $clone->id;
    }

Here is the call graph for this function:

createErrorTextExport()

assErrorText::createErrorTextExport

(

$selections = null

)

Definition at line 766 of file class.assErrorText.php.

References $counter, $text, array, getErrorText(), and ilUtil\prepareFormOutput().

Referenced by setExportDetailsXLS().

    {
        $counter = 0;
        $errorcounter = 0;
        include_once "./Services/Utilities/classes/class.ilStr.php";
        if (!is_array($selections)) {
            $selections = array();
        }
        $textarray = preg_split("/[\n\r]+/", $this->getErrorText());
        foreach ($textarray as $textidx => $text) {
            $items = preg_split("/\s+/", $text);
            foreach ($items as $idx => $item) {
                if (($posHash = strpos($item, '#')) === 0
                    || ($posOpeningBrackets = strpos($item, '((')) === 0
                    || ($posClosingBrackets = strpos($item, '))')) !== false) {
                    /* (Word|Passage)-Marking delimiter found. */

                    if ($posHash !== false) {
                        $item = ilStr::substr($item, 1, ilStr::strlen($item) - 1);
                    } elseif ($posOpeningBrackets !== false) {
                        $item = ilStr::substr($item, 2, ilStr::strlen($item) - 2);

                        /* Sometimes a closing bracket group needs
                           to be removed as well. */
                        if (strpos($item, '))') !== false) {
                            $item = ilStr::substr($item, 0, ilStr::strlen($item) - 2);
                        }
                    } else {
                        $appendComma = "";
                        if ($item{$posClosingBrackets+2} == ',') {
                            $appendComma = ",";
                        }

                        $item = ilStr::substr($item, 0, $posClosingBrackets) . $appendComma;
                    }
                }

                $word = "";
                if (in_array($counter, $selections)) {
                    $word .= '#';
                }
                $word .= ilUtil::prepareFormOutput($item);
                if (in_array($counter, $selections)) {
                    $word .= '#';
                }
                $items[$idx] = $word;
                $counter++;
            }
            $textarray[$textidx] = join($items, " ");
        }
        return join($textarray, "\n");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createErrorTextOutput()

assErrorText::createErrorTextOutput	(		$selections = null,
			$graphicalOutput = false,
			$correct_solution = false,
			$use_link_tags = true
	)

Definition at line 594 of file class.assErrorText.php.

References $counter, $img, $text, array, getErrorText(), getErrorTokenHtml(), ilUtil\getImagePath(), getPointsForSelectedPositions(), and isTokenSelected().

    {
        $counter = 0;
        $errorcounter = 0;
        include_once "./Services/Utilities/classes/class.ilStr.php";
        if (!is_array($selections)) {
            $selections = array();
        }
        $textarray = preg_split("/[\n\r]+/", $this->getErrorText());

        foreach ($textarray as $textidx => $text) {
            $in_passage  = false;
            $passage_end = false;
            $items = preg_split("/\s+/", $text);
            foreach ($items as $idx => $item) {
                $img = '';

                if (
                    ($posHash = strpos($item, '#')) === 0 ||
                    ($posOpeningBrackets = strpos($item, '((')) === 0 ||
                    ($posClosingBrackets = strpos($item, '))')) !== false
                ) {
                    /* (Word|Passage)-Marking delimiter found. */

                    if ($posHash !== false) {
                        $item = ilStr::substr($item, 1, ilStr::strlen($item) - 1);
                        $passage_end = false;
                    } elseif ($posOpeningBrackets !== false) {
                        $in_passage  = true;
                        $passage_start_idx = $counter;
                        $items_in_passage = array();
                        $passage_end = false;
                        $item = ilStr::substr($item, 2, ilStr::strlen($item) - 2);

                        /* Sometimes a closing bracket group needs
                           to be removed as well. */
                        if (strpos($item, '))') !== false) {
                            $item = str_replace("))", "", $item);
                            $passage_end = true;
                        }
                    } else {
                        $passage_end = true;
                        $item = str_replace("))", "", $item);
                    }

                    if ($correct_solution && !$in_passage) {
                        $errorobject = $this->errordata[$errorcounter];
                        if (is_object($errorobject)) {
                            $item = strlen($errorobject->text_correct) ? $errorobject->text_correct : ' ';
                        }
                        $errorcounter++;
                    }
                }
                
                if ($in_passage && !$passage_end) {
                    $items_in_passage[$idx] = $item;
                    $items[$idx] = '';
                    $counter++;
                    continue;
                }

                if ($in_passage && $passage_end) {
                    $in_passage  = false;
                    $passage_end = false;
                    if ($correct_solution) {
                        $class = (
                            $this->isTokenSelected($counter, $selections) ?
                            "ilc_qetitem_ErrorTextSelected" : "ilc_qetitem_ErrorTextItem"
                        );
                        
                        $errorobject = $this->errordata[$errorcounter];
                        if (is_object($errorobject)) {
                            $item = strlen($errorobject->text_correct) ? $errorobject->text_correct : ' ';
                        }
                        $errorcounter++;
                        $items[$idx] = $this->getErrorTokenHtml($item, $class, $use_link_tags) . $img;
                        $counter++;
                        continue;
                    }
                    
                    $group_selected = true;
                    if ($graphicalOutput) {
                        $start_idx = $passage_start_idx;
                        foreach ($items_in_passage as $tmp_idx => $tmp_item) {
                            if (!$this->isTokenSelected($start_idx, $selections)) {
                                $group_selected = false;
                                break;
                            }
                            
                            ++$start_idx;
                        }
                        if ($group_selected) {
                            if (!$this->isTokenSelected($counter, $selections)) {
                                $group_selected = false;
                            }
                        }
                    }

                    $item_stack = array();
                    $start_idx = $passage_start_idx;
                    foreach ($items_in_passage as $tmp_idx => $tmp_item) {
                        $class = (
                            $this->isTokenSelected($counter, $selections) ?
                            "ilc_qetitem_ErrorTextSelected" : "ilc_qetitem_ErrorTextItem"
                        );
                        $item_stack[] = $this->getErrorTokenHtml($tmp_item, $class, $use_link_tags) . $img;
                        $start_idx++;
                    }
                    $class = (
                        $this->isTokenSelected($counter, $selections) ?
                        "ilc_qetitem_ErrorTextSelected" : "ilc_qetitem_ErrorTextItem"
                    );
                    if ($graphicalOutput) {
                        if ($group_selected) {
                            $img = ' <img src="' . ilUtil::getImagePath("icon_ok.svg") . '" alt="' . $this->lng->txt("answer_is_right") . '" title="' . $this->lng->txt("answer_is_right") . '" /> ';
                        } else {
                            $img = ' <img src="' . ilUtil::getImagePath("icon_not_ok.svg") . '" alt="' . $this->lng->txt("answer_is_wrong") . '" title="' . $this->lng->txt("answer_is_wrong") . '" /> ';
                        }
                    }
                    
                    $item_stack[] = $this->getErrorTokenHtml($item, $class, $use_link_tags) . $img;
                    $item_stack = trim(implode(" ", $item_stack));
                    $item_stack = strlen($item_stack) ? $item_stack : '&nbsp;';
                    
                    if ($graphicalOutput) {
                        $items[$idx] = '<span class="selGroup">' . $item_stack . '</span>';
                    } else {
                        $items[$idx] = $item_stack;
                    }
                    
                    $counter++;
                    continue;
                }

                // Errors markes with #, group errors (()) are handled above
                $class = 'ilc_qetitem_ErrorTextItem';
                $img = '';
                if ($this->isTokenSelected($counter, $selections)) {
                    $class = "ilc_qetitem_ErrorTextSelected";
                    if ($graphicalOutput) {
                        if ($this->getPointsForSelectedPositions(array($counter)) > 0) {
                            $img = ' <img src="' . ilUtil::getImagePath("icon_ok.svg") . '" alt="' . $this->lng->txt("answer_is_right") . '" title="' . $this->lng->txt("answer_is_right") . '" /> ';
                        } else {
                            $img = ' <img src="' . ilUtil::getImagePath("icon_not_ok.svg") . '" alt="' . $this->lng->txt("answer_is_wrong") . '" title="' . $this->lng->txt("answer_is_wrong") . '" /> ';
                        }
                    }
                }

                $items[$idx] = $this->getErrorTokenHtml($item, $class, $use_link_tags) . $img;
                $counter++;
            }
            $textarray[$textidx] = '<p>' . implode(" ", $items) . '</p>';
        }
        
        return implode("\n", $textarray);
    }

Here is the call graph for this function:

createNewOriginalFromThisDuplicate()

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

Definition at line 272 of file class.assErrorText.php.

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

    {
        if ($this->id <= 0) {
            // The question has not been saved. It cannot be duplicated
            return;
        }

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

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

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

        $clone->setObjId($targetParentId);

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

        $clone->saveToDb();
        // copy question page content
        $clone->copyPageOfQuestion($sourceQuestionId);
        // copy XHTML media objects
        $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);

        $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());

        return $clone->id;
    }

Here is the call graph for this function:

duplicate()

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

Duplicates the object.

Definition at line 194 of file class.assErrorText.php.

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

    {
        if ($this->id <= 0) {
            // The question has not been saved. It cannot be duplicated
            return;
        }
        // duplicate the question in database
        $this_id = $this->getId();
        $thisObjId = $this->getObjId();
        
        $clone = $this;
        include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
        $original_id = assQuestion::_getOriginalId($this->id);
        $clone->id = -1;
        
        if ((int) $testObjId > 0) {
            $clone->setObjId($testObjId);
        }
        
        if ($title) {
            $clone->setTitle($title);
        }

        if ($author) {
            $clone->setAuthor($author);
        }
        if ($owner) {
            $clone->setOwner($owner);
        }

        if ($for_test) {
            $clone->saveToDb($original_id);
        } else {
            $clone->saveToDb();
        }
        // copy question page content
        $clone->copyPageOfQuestion($this_id);
        // copy XHTML media objects
        $clone->copyXHTMLMediaObjectsOfQuestion($this_id);

        $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
        return $clone->id;
    }

Here is the call graph for this function:

flushErrorData()

assErrorText::flushErrorData

(

)

Flush error data.

Definition at line 972 of file class.assErrorText.php.

References array.

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

fromXML()

assErrorText::fromXML	(	&	$item,
		&	$questionpool_id,
		&	$tst_id,
		&	$tst_object,
		&	$question_counter,
		&	$import_mapping
	)

Creates a question from a QTI file.

Receives parameters from a QTI parser and creates a valid ILIAS question object

Parameters

object	$item	The QTI item object
integer	$questionpool_id	The id of the parent questionpool
integer	$tst_id	The id of the parent test if the question is part of a test
object	$tst_object	A reference to the parent test object
integer	$question_counter	A reference to a question counter to count the questions of an imported question pool
array	$import_mapping	An array containing references to included ILIAS objects

Definition at line 502 of file class.assErrorText.php.

    {
        include_once "./Modules/TestQuestionPool/classes/import/qti12/class.assErrorTextImport.php";
        $import = new assErrorTextImport($this);
        $import->fromXML($item, $questionpool_id, $tst_id, $tst_object, $question_counter, $import_mapping);
    }

getAdditionalTableName()

assErrorText::getAdditionalTableName

(

)

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

Returns

string The additional table name

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

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

    {
        return "qpl_qst_errortext";
    }

Here is the caller graph for this function:

getAnswerTableName()

assErrorText::getAnswerTableName

(

)

Returns the name of the answer table in the database.

Returns

string The answer table name

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

    {
        return "qpl_a_errortext";
    }

getAvailableAnswerOptions()

assErrorText::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 1236 of file class.assErrorText.php.

References $index.

    {
        $error_text_array = explode(' ', $this->errortext);
        
        if ($index !== null) {
            if (array_key_exists($index, $error_text_array)) {
                return $error_text_array[$index];
            }
            return null;
        } else {
            return $error_text_array;
        }
    }

getBestSelection()

assErrorText::getBestSelection

(

$withPositivePointsOnly = true

)

Definition at line 819 of file class.assErrorText.php.

References $counter, assQuestion\$points, $text, array, getErrorText(), getPointsWrong(), and range.

    {
        $passages       = array();
        $words          = array();
        $counter        = 0;
        $errorcounter = 0;
        $textarray = preg_split("/[\n\r]+/", $this->getErrorText());
        foreach ($textarray as $textidx => $text) {
            $items              = preg_split("/\s+/", $text);
            $inPassage  = false;
            foreach ($items as $word) {
                $points = $this->getPointsWrong();
                $isErrorItem = false;
                if (strpos($word, '#') === 0) {
                    /* Word selection detected */
                    $errorobject = $this->errordata[$errorcounter];
                    if (is_object($errorobject)) {
                        $points = $errorobject->points;
                        $isErrorItem = true;
                    }
                    $errorcounter++;
                } elseif (($posOpeningBracket = strpos($word, '((')) === 0
                        || ($posClosingBracket = strpos($word, '))')) !== false
                        || $inPassage) {
                    /* Passage selection detected */

                    if ($posOpeningBracket !== false) {
                        $passages[] = array('begin_pos' => $counter, 'cnt_words' => 0);
                        $inPassage  = true;
                    } elseif ($posClosingBracket !== false) {
                        $inPassage = false;
                        $cur_pidx  = count($passages) - 1;
                        $passages[$cur_pidx]['end_pos'] = $counter;

                        $errorobject = $this->errordata[$errorcounter];
                        if (is_object($errorobject)) {
                            $passages[$cur_pidx]['score'] = $errorobject->points;
                            $passages[$cur_pidx]['isError'] = true;
                        }
                        
                        $errorcounter++;
                    }

                    $cur_pidx = count($passages) - 1;
                    $passages[$cur_pidx]['cnt_words']++;
                    $points = 0;
                }

                $words[$counter] = array("word" => $word, "points" => $points, "isError" => $isErrorItem);
                $counter++;
            }
        }

        $selections = array();
        foreach ($passages as $cnt => $pdata) {
            if (!$withPositivePointsOnly && $pdata['isError'] || $withPositivePointsOnly && $pdata['score'] > 0) {
                $indexes = range($pdata['begin_pos'], $pdata['end_pos']);
                $selections[$pdata['begin_pos']] = $indexes;
            }
        }

        foreach ($words as $idx => $word) {
            if (!$withPositivePointsOnly && $word['isError'] || $withPositivePointsOnly && $word['points'] > 0) {
                $selections[$idx] = array($idx);
            }
        }

        ksort($selections);
        
        $selections = array_values($selections);
        
        return $selections;
    }

Here is the call graph for this function:

getBestSolution()

assErrorText::getBestSolution	(		$active_id,
			$pass
	)

Returns the best solution for a given pass of a participant.

Returns

array An associated array containing the best solution

Definition at line 527 of file class.assErrorText.php.

References array.

    {
        $user_solution = array();
        return $user_solution;
    }

getErrorData()

assErrorText::getErrorData

(

)

Get error data.

Returns

array Error data

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

References $errordata.

Referenced by toJSON().

    {
        return $this->errordata;
    }

Here is the caller graph for this function:

getErrorsFromText()

assErrorText::getErrorsFromText

(

$a_text = ""

)

Definition at line 533 of file class.assErrorText.php.

References array, and getErrorText().

    {
        if (strlen($a_text) == 0) {
            $a_text = $this->getErrorText();
        }

        /* Workaround to allow '(' and ')' in passages.
           The beginning- and ending- Passage delimiters are
           replaced by a ~ (Tilde) symbol. */
        $a_text = str_replace(array("((", "))"), array("~", "~"), $a_text);

        /* Match either Passage delimited by double brackets
           or single words marked with a hash (#). */
        $r_passage = "/(~([^~]+)~|#([^\s]+))/";

        preg_match_all($r_passage, $a_text, $matches);

        if (is_array($matches[0]) && !empty($matches[0])) {
            /* At least one match. */

            /* We need only groups 2 and 3, respectively representing
               passage matches and single word matches. */
            $matches = array_intersect_key($matches, array(2 => '', 3 => ''));

            /* Remove empty values. */
            $matches[2] = array_diff($matches[2], array(''));
            $matches[3] = array_diff($matches[3], array(''));

            return array(
                "passages"  => $matches[2],
                "words"         => $matches[3],);
        }

        return array();
    }

Here is the call graph for this function:

getErrorText()

assErrorText::getErrorText

(

)

Get error text.

Returns

string Error text

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

References $errortext.

Referenced by __get(), createErrorTextExport(), createErrorTextOutput(), getBestSelection(), getErrorsFromText(), getPointsForSelectedPositions(), saveAdditionalQuestionDataToDb(), and toJSON().

    {
        return $this->errortext;
    }

Here is the caller graph for this function:

getErrorTokenHtml()

assErrorText::getErrorTokenHtml (   $item,   $class,   $useLinkTags  )

private

Parameters

$item
$class

Returns

string

Definition at line 1255 of file class.assErrorText.php.

References ilUtil\prepareFormOutput().

Referenced by createErrorTextOutput().

    {
        if ($useLinkTags) {
            return '<a class="' . $class . '" href="#">' . ($item == '&nbsp;' ? $item : ilUtil::prepareFormOutput($item)) . '</a>';
        }
        
        return '<span class="' . $class . '">' . ($item == '&nbsp;' ? $item : ilUtil::prepareFormOutput($item)) . '</span>';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExpressionTypes()

assErrorText::getExpressionTypes

(

)

Get all available expression types for a specific question.

Returns

array

Implements iQuestionCondition.

Definition at line 1184 of file class.assErrorText.php.

References $data, $ilDB, $pass, assQuestion\$points, $result, $row, array, calculateReachedPoints(), iQuestionCondition\EmptyAnswerExpression, iQuestionCondition\ExclusiveResultExpression, assQuestion\getId(), getMaximumPoints(), iQuestionCondition\getUserQuestionResult(), iQuestionCondition\NumberOfResultExpression, and iQuestionCondition\PercentageResultExpression.

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

Here is the call graph for this function:

getMaximumPoints()

assErrorText::getMaximumPoints

(

)

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

See also

$points

Definition at line 310 of file class.assErrorText.php.

Referenced by getExpressionTypes(), and isComplete().

    {
        $maxpoints = 0.0;
        foreach ($this->errordata as $object) {
            if ($object->points > 0) {
                $maxpoints += $object->points;
            }
        }
        return $maxpoints;
    }

Here is the caller graph for this function:

getOperators()

assErrorText::getOperators

(

$expression

)

Get all available operations for a specific question.

Parameters

string

$expression

Implements iQuestionCondition.

Definition at line 1174 of file class.assErrorText.php.

References ilOperatorsExpressionMapping\getOperatorsByExpression().

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

Here is the call graph for this function:

getPointsForSelectedPositions()

assErrorText::getPointsForSelectedPositions (   $positions )

protected

Definition at line 893 of file class.assErrorText.php.

References $counter, $i, assQuestion\$points, $text, $total, array, getErrorText(), and getPointsWrong().

Referenced by calculateReachedPoints(), calculateReachedPointsFromPreviewSession(), and createErrorTextOutput().

    {
        $passages       = array();
        $words          = array();
        $counter        = 0;
        $errorcounter = 0;
        $textarray        = preg_split("/[\n\r]+/", $this->getErrorText());
        foreach ($textarray as $textidx => $text) {
            $items              = preg_split("/\s+/", $text);
            $inPassage  = false;
            foreach ($items as $word) {
                $points  = $this->getPointsWrong();
                if (strpos($word, '#') === 0) {
                    /* Word selection detected */
                    $errorobject = $this->errordata[$errorcounter];
                    if (is_object($errorobject)) {
                        $points = $errorobject->points;
                    }
                    $errorcounter++;
                } elseif (($posOpeningBracket = strpos($word, '((')) === 0
                        || ($posClosingBracket = strpos($word, '))')) !== false
                        || $inPassage) {
                    /* Passage selection detected */

                    if ($posOpeningBracket !== false) {
                        $passages[] = array('begin_pos' => $counter, 'cnt_words' => 0);
                        $inPassage  = true;
                    } elseif ($posClosingBracket !== false) {
                        $inPassage = false;
                        $cur_pidx  = count($passages) - 1;
                        $passages[$cur_pidx]['end_pos'] = $counter;

                        $errorobject = $this->errordata[$errorcounter];
                        if (is_object($errorobject)) {
                            $passages[$cur_pidx]['score'] = $errorobject->points;
                        }
                        $errorcounter++;
                    }

                    $cur_pidx = count($passages) - 1;
                    $passages[$cur_pidx]['cnt_words']++;
                    $points = 0;
                }

                $words[$counter] = array("word" => $word, "points" => $points);
                $counter++;
            }
        }

        /* Calculate reached points */
        $total           = 0;
        foreach ($positions as $position) {
            /* First iterate through positions
               to identify single-word-selections. */

            $total += $words[$position]['points'];
        }

        foreach ($passages as $cnt => $p_data) {
            /* Iterate through configured passages to check
               wether the entire passage is selected or not.
               The total points is incremented by the passage's
               score only if the entire passage is selected. */
            $isSelected = in_array($p_data['begin_pos'], $positions);

            for ($i = 0; $i < $p_data['cnt_words']; $i++) {
                $current_pos = $p_data['begin_pos'] + $i;
                $isSelected  = $isSelected && in_array($current_pos, $positions);
            }

            $total += $isSelected ? $p_data['score'] : 0;
        }

        return $total;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPointsWrong()

assErrorText::getPointsWrong

(

)

Get wrong points.

Returns

double Points for wrong selection

Definition at line 1042 of file class.assErrorText.php.

References $points_wrong.

Referenced by __get(), getBestSelection(), getPointsForSelectedPositions(), and saveAdditionalQuestionDataToDb().

    {
        return $this->points_wrong;
    }

Here is the caller graph for this function:

getQuestionType()

assErrorText::getQuestionType

(

)

Returns the question type of the question.

Returns

integer The question type of the question

Definition at line 431 of file class.assErrorText.php.

Referenced by toJSON().

    {
        return "assErrorText";
    }

Here is the caller graph for this function:

getRTETextWithMediaObjects()

assErrorText::getRTETextWithMediaObjects

(

)

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

Definition at line 460 of file class.assErrorText.php.

References $text.

    {
        $text = parent::getRTETextWithMediaObjects();
        return $text;
    }

getTextSize()

assErrorText::getTextSize

(

)

Set text size in percent.

Returns

double Text size in percent

Definition at line 1018 of file class.assErrorText.php.

References $textsize.

Referenced by __get(), and saveAdditionalQuestionDataToDb().

    {
        return $this->textsize;
    }

Here is the caller graph for this function:

isComplete()

assErrorText::isComplete

(

)

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

Returns

boolean True, if the single choice question is complete for use, otherwise false

Definition at line 59 of file class.assErrorText.php.

References getMaximumPoints().

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

Here is the call graph for this function:

isTokenSelected()

assErrorText::isTokenSelected (   $counter, array  $selection  )

protected

Definition at line 751 of file class.assErrorText.php.

References $counter, and $data.

Referenced by createErrorTextOutput().

    {
        foreach ($selection as $data) {
            if (!is_array($data)) {
                if ($counter == $data) {
                    return true;
                }
            } elseif (in_array($counter, $data)) {
                return true;
            }
        }
        
        return false;
    }

Here is the caller graph for this function:

loadFromDb()

assErrorText::loadFromDb

(

$question_id

)

Loads the object from the database.

Parameters

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

Definition at line 143 of file class.assErrorText.php.

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

    {
        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->setTitle($data["title"]);
            $this->setComment($data["description"]);
            $this->setOriginalId($data["original_id"]);
            $this->setNrOfTries($data['nr_of_tries']);
            $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->setErrorText($data["errortext"]);
            $this->setTextSize($data["textsize"]);
            $this->setPointsWrong($data["points_wrong"]);
            $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_errortext WHERE question_fi = %s ORDER BY sequence ASC",
            array('integer'),
            array($question_id)
        );
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerErrorText.php";
        if ($result->numRows() > 0) {
            while ($data = $ilDB->fetchAssoc($result)) {
                array_push($this->errordata, new assAnswerErrorText($data["text_wrong"], $data["text_correct"], $data["points"]));
            }
        }

        parent::loadFromDb($question_id);
    }

Here is the call graph for this function:

reworkWorkingData()

assErrorText::reworkWorkingData (   $active_id,   $pass,   $obligationsAnswered,   $authorized  )

protected

{}

Definition at line 421 of file class.assErrorText.php.

    {
        // nothing to rework!
    }

saveAdditionalQuestionDataToDb()

assErrorText::saveAdditionalQuestionDataToDb

(

)

Saves the data for the additional data table.

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

Implements ilObjQuestionScoringAdjustable.

Definition at line 115 of file class.assErrorText.php.

References $ilDB, array, getAdditionalTableName(), getErrorText(), assQuestion\getId(), getPointsWrong(), and getTextSize().

Referenced by saveToDb().

    {
        global $ilDB;
        // save additional data
        $ilDB->manipulateF(
            "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
            array( "integer" ),
            array( $this->getId() )
        );
        
        $ilDB->manipulateF(
            "INSERT INTO " . $this->getAdditionalTableName() . " (question_fi, errortext, textsize, points_wrong) VALUES (%s, %s, %s, %s)",
            array("integer", "text", "float", "float"),
            array(
                               $this->getId(),
                               $this->getErrorText(),
                               $this->getTextSize(),
                               $this->getPointsWrong()
                           )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveAnswerSpecificDataToDb()

assErrorText::saveAnswerSpecificDataToDb

(

)

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

Returns

mixed

Implements ilObjAnswerScoringAdjustable.

Definition at line 83 of file class.assErrorText.php.

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

Referenced by saveToDb().

    {
        global $ilDB;
        $ilDB->manipulateF(
            "DELETE FROM qpl_a_errortext WHERE question_fi = %s",
            array( 'integer' ),
            array( $this->getId() )
        );

        $sequence = 0;
        foreach ($this->errordata as $object) {
            $next_id = $ilDB->nextId('qpl_a_errortext');
            $ilDB->manipulateF(
                "INSERT INTO qpl_a_errortext (answer_id, question_fi, text_wrong, text_correct, points, sequence) VALUES (%s, %s, %s, %s, %s, %s)",
                array( 'integer', 'integer', 'text', 'text', 'float', 'integer' ),
                array(
                                    $next_id,
                                    $this->getId(),
                                    $object->text_wrong,
                                    $object->text_correct,
                                    $object->points,
                                    $sequence++
                                )
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

savePreviewData()

assErrorText::savePreviewData

(

ilAssQuestionPreviewSession

$previewSession

)

Definition at line 407 of file class.assErrorText.php.

References $_POST, array, assQuestion\getId(), and ilAssQuestionPreviewSession\setParticipantsSolution().

    {
        if (strlen($_POST["qst_" . $this->getId()])) {
            $selection = explode(',', $_POST["qst_{$this->getId()}"]);
        } else {
            $selection = array();
        }
        
        $previewSession->setParticipantsSolution($selection);
    }

Here is the call graph for this function:

saveToDb()

assErrorText::saveToDb

(

$original_id = ""

)

Saves a the object to the database.

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

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

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

Here is the call graph for this function:

saveWorkingData()

assErrorText::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 368 of file class.assErrorText.php.

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

    {
        global $ilDB;
        global $ilUser;

        if (is_null($pass)) {
            include_once "./Modules/Test/classes/class.ilObjTest.php";
            $pass = ilObjTest::_getPass($active_id);
        }

        $entered_values = false;

        $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(function () use (&$entered_values, $active_id, $pass, $authorized) {
            $this->removeCurrentSolution($active_id, $pass, $authorized);

            if (strlen($_POST["qst_" . $this->getId()])) {
                $selected = explode(",", $_POST["qst_" . $this->getId()]);
                foreach ($selected as $position) {
                    $this->saveCurrentSolution($active_id, $pass, $position, null, $authorized);
                }
                $entered_values = true;
            }
        });

        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:

setErrorData()

assErrorText::setErrorData

(

$a_data

)

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

References $error, $errordata, $errors, assQuestion\$points, and array.

    {
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerErrorText.php";
        $temp = $this->errordata;
        $this->errordata = array();
        foreach ($a_data as $err_type => $errors) {
            /* Iterate through error types (Passages|single words) */

            foreach ($errors as $idx => $error) {
                /* Iterate through errors of this type. */
                $text_correct = "";
                $points = 0.0;
                foreach ($temp as $object) {
                    if (strcmp($object->text_wrong, $error) == 0) {
                        $text_correct = $object->text_correct;
                        $points = $object->points;
                        continue;
                    }
                }
                $this->errordata[$idx] = new assAnswerErrorText($error, $text_correct, $points);
            }
        }
        ksort($this->errordata);
    }

setErrorText()

assErrorText::setErrorText

(

$a_value

)

Set error text.

Parameters

string

$a_value

Error text

Definition at line 1008 of file class.assErrorText.php.

Referenced by __set(), and loadFromDb().

    {
        $this->errortext = $a_value;
    }

Here is the caller graph for this function:

setExportDetailsXLS()

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

{}

Definition at line 469 of file class.assErrorText.php.

References $errortext, $i, $pass, $worksheet, array, createErrorTextExport(), and assQuestion\getSolutionValues().

    {
        parent::setExportDetailsXLS($worksheet, $startrow, $active_id, $pass);

        $i= 0;
        $selections = array();
        $solutions =&$this->getSolutionValues($active_id, $pass);
        if (is_array($solutions)) {
            foreach ($solutions as $solution) {
                array_push($selections, $solution['value1']);
            }
            $errortext_value = join(",", $selections);
        }
        $errortext = $this->createErrorTextExport($selections);
        $i++;
        $worksheet->setCell($startrow+$i, 0, $errortext);
        $i++;

        return $startrow + $i + 1;
    }

Here is the call graph for this function:

setPointsWrong()

assErrorText::setPointsWrong

(

$a_value

)

Set wrong points.

Parameters

double

$a_value

Points for wrong selection

Definition at line 1052 of file class.assErrorText.php.

Referenced by __set(), and loadFromDb().

    {
        $this->points_wrong = $a_value;
    }

Here is the caller graph for this function:

setTextSize()

assErrorText::setTextSize

(

$a_value

)

Set text size in percent.

Parameters

double

$a_value

text size in percent

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

Referenced by __set(), and loadFromDb().

    {
        // in self-assesment-mode value should always be set (and must not be null)
        if ($a_value === null) {
            $a_value = 100;
        }
        $this->textsize = $a_value;
    }

Here is the caller graph for this function:

toJSON()

assErrorText::toJSON

(

)

Returns a JSON representation of the question.

Definition at line 1103 of file class.assErrorText.php.

References $mobs, $result, $text, ilObjMediaObject\_getMobsOfObject(), ilRTE\_replaceMediaObjectImageSrc(), array, assQuestion\formatSAQuestion(), getErrorData(), getErrorText(), assQuestion\getId(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), assQuestion\getTitle(), ilUtil\prepareFormOutput(), and string.

    {
        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['text'] =  (string) ilRTE::_replaceMediaObjectImageSrc($this->getErrorText(), 0);
        $result['nr_of_tries'] = (int) $this->getNrOfTries();
        $result['shuffle'] = (bool) $this->getShuffle();
        $result['feedback'] = array(
            'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
            'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
        );

        $answers = array();
        foreach ($this->getErrorData() as $idx => $answer_obj) {
            array_push($answers, array(
                "answertext_wrong" => (string) $answer_obj->text_wrong,
                "answertext_correct" => (string) $answer_obj->text_correct,
                "points" => (float) $answer_obj->points,
                "order" => (int) $idx+1
            ));
        }
        $result['correct_answers'] = $answers;

        $answers = array();
        $textarray = preg_split("/[\n\r]+/", $this->getErrorText());
        foreach ($textarray as $textidx => $text) {
            $items = preg_split("/\s+/", trim($text));
            foreach ($items as $idx => $item) {
                if (substr($item, 0, 1) == "#") {
                    $item = substr($item, 1);
                    
                    // #14115 - add position to correct answer
                    foreach ($result["correct_answers"] as $aidx => $answer) {
                        if ($answer["answertext_wrong"] == $item && !$answer["pos"]) {
                            $result["correct_answers"][$aidx]["pos"] = $this->getId() . "_" . $textidx . "_" . ($idx+1);
                            break;
                        }
                    }
                }
                array_push($answers, array(
                    "answertext" => (string) ilUtil::prepareFormOutput($item),
                    "order" => $this->getId() . "_" . $textidx . "_" . ($idx+1)
                ));
            }
            if ($textidx != sizeof($textarray)-1) {
                array_push($answers, array(
                        "answertext" => "###",
                        "order" => $this->getId() . "_" . $textidx . "_" . ($idx+2)
                    ));
            }
        }
        $result['answers'] = $answers;

        $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
        $result['mobs'] = $mobs;
        
        return json_encode($result);
    }

Here is the call graph for this function:

toXML()

assErrorText::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 and sets the internal domxml variable with the DOM XML representation of the QTI xml representation.

Returns

string The QTI xml representation of the question

Definition at line 515 of file class.assErrorText.php.

    {
        include_once "./Modules/TestQuestionPool/classes/export/qti12/class.assErrorTextExport.php";
        $export = new assErrorTextExport($this);
        return $export->toXML($a_include_header, $a_include_binary, $a_shuffle, $test_output, $force_image_references);
    }

Field Documentation

$errordata

assErrorText::$errordata

protected

Definition at line 27 of file class.assErrorText.php.

Referenced by getErrorData(), and setErrorData().

$errortext

assErrorText::$errortext

protected

Definition at line 25 of file class.assErrorText.php.

Referenced by getErrorText(), and setExportDetailsXLS().

$points_wrong

assErrorText::$points_wrong

protected

Definition at line 28 of file class.assErrorText.php.

Referenced by getPointsWrong().

$textsize

assErrorText::$textsize

protected

Definition at line 26 of file class.assErrorText.php.

Referenced by getTextSize().

---

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

• Modules/TestQuestionPool/classes/class.assErrorText.php