assFormulaQuestion Class Reference

Class for single choice questions assFormulaQuestion is a class for single choice questions. More...

Inheritance diagram for assFormulaQuestion:

Collaboration diagram for assFormulaQuestion:

Public Member Functions
	__construct ( $title="", $comment="", $author="", $owner=-1, $question="")
	assFormulaQuestion constructor The constructor takes possible arguments an creates an instance of the assFormulaQuestion object. More...
	clearVariables ()
	getVariables ()
	getVariable ($variable)
	addVariable ($variable)
	clearResults ()
	getResults ()
	getResult ($result)
	addResult ($result)
	addResultUnits ($result, $unit_ids)
	addResultUnit ($result, $unit)
	getResultUnits ($result)
	hasResultUnit ($result, $unit_id)
	parseQuestionText ()
	checkForDuplicateVariables ()
	checkForDuplicateResults ()
	fetchAllResults ($questionText)
	fetchAllVariables ($questionText)
	hasRequiredVariableSolutionValues (array $userSolution)
	getInitialVariableSolutionValues ()
	substituteVariables (array $userdata, $graphicalOutput=false, $forsolution=false, $result_output=false)
	canUseAdvancedRating ($result)
	Check if advanced rating can be used for a result. More...
	isComplete ()
	Returns true, if the question is complete for use. More...
	saveToDb ($original_id="")
	Saves a assFormulaQuestion object to a database public. More...
	loadFromDb ($question_id)
	Loads a assFormulaQuestion object from a database. More...
	duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
	Duplicates an assFormulaQuestion public. More...
	copyObject ($target_questionpool_id, $title="")
	Copies an assFormulaQuestion object public. 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 The points are calculated from the given answers. More...
	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)
	saveWorkingData ($active_id, $pass=null, $authorized=true)
	Saves the learners input of the question to the database. More...
	lookupForExistingSolutions ($activeId, $pass)
	Lookup if an authorized or intermediate solution exists. More...
	removeExistingSolutions ($activeId, $pass)
	Remove an existing solution without removing the variables. More...
	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...
	deleteAnswers ($question_id)
	Deletes datasets from answers tables. 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...
	getBestSolution ($solutions)
	Returns the best solution for a given pass of a participant. More...
	setId ($id=-1)
	__get ($value)
	Object getter. More...
	setUnitrepository ($unitrepository)
	getUnitrepository ()
	validateSolutionSubmit ()
	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)
	isAddableAnswerOptionValue ($qIndex, $answerOptionValue)
	addAnswerOptionValue ($qIndex, $answerOptionValue, $points)
	removeAllExistingSolutions ()
	removeExistingSolutions ($activeId, $pass)
	resetUsersAnswer ($activeId, $pass)
	removeResultRecord ($activeId, $pass)
	fetchValuePairsFromIndexedValues (array $indexedValues)
	fetchIndexedValuesFromValuePairs (array $valuePairs)
	areObligationsToBeConsidered ()
	setObligationsToBeConsidered ($obligationsToBeConsidered)
	updateTimestamp ()
	getTestPresentationConfig ()
	Get the test question configuration (initialised once) More...
	savePartial ()
Public Member Functions inherited from iQuestionCondition
	getUserQuestionResult ($active_id, $pass)
	Get the user solution for a question by active_id and the test pass. More...

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

Private Attributes
	$variables
	$results
	$resultunits
	$unitrepository

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 ()
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
Static Protected Attributes inherited from assQuestion
static	$allowedFileExtensionsByMimeType
static	$allowedCharsetsByMimeType
static	$allowedImageMaterialFileExtensionsByMimeType
static	$forcePassResultsUpdateEnabled = false
static	$imageSourceFixReplaceMap

Detailed Description

Class for single choice questions assFormulaQuestion is a class for single choice 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

Version

Id

class.assFormulaQuestion.php 1236 2010-02-15 15:44:16Z hschottm

Definition at line 19 of file class.assFormulaQuestion.php.

Constructor & Destructor Documentation

__construct()

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

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

Parameters

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

See also

assQuestion:assQuestion()

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

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

      {
        parent::__construct($title, $comment, $author, $owner, $question);
        $this->variables = array();
        $this->results = array();
        $this->resultunits = array();
        $this->unitrepository = new ilUnitConfigurationRepository(0);
    }

Member Function Documentation

__get()

assFormulaQuestion::__get

(

$value

)

Object getter.

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

References $resultunits.

    {
        switch ($value) {
            case "resultunits":
                return $this->resultunits;
                break;
            default:
                return parent::__get($value);
                break;
        }
    }

addResult()

assFormulaQuestion::addResult

(

$result

)

Definition at line 96 of file class.assFormulaQuestion.php.

References $result.

Referenced by loadFromDb(), and parseQuestionText().

    {
        $this->results[$result->getResult()] = $result;
    }

Here is the caller graph for this function:

addResultUnit()

assFormulaQuestion::addResultUnit	(		$result,
			$unit
	)

Definition at line 114 of file class.assFormulaQuestion.php.

References $result.

Referenced by loadFromDb().

    {
        if (is_object($result) && is_object($unit)) {
            if (!is_array($this->resultunits[$result->getResult()])) {
                $this->resultunits[$result->getResult()] = array();
            }
            $this->resultunits[$result->getResult()][$unit->getId()] = $unit;
        }
    }

Here is the caller graph for this function:

addResultUnits()

assFormulaQuestion::addResultUnits	(		$result,
			$unit_ids
	)

Definition at line 101 of file class.assFormulaQuestion.php.

References assQuestion\$id, $result, and getUnitrepository().

    {
        $this->resultunits[$result->getResult()] = array();
        if ((!is_object($result)) || (!is_array($unit_ids))) {
            return;
        }
        foreach ($unit_ids as $id) {
            if (is_numeric($id) && ($id > 0)) {
                $this->resultunits[$result->getResult()][$id] = $this->getUnitrepository()->getUnit($id);
            }
        }
    }

Here is the call graph for this function:

addVariable()

assFormulaQuestion::addVariable

(

$variable

)

Definition at line 73 of file class.assFormulaQuestion.php.

Referenced by loadFromDb(), and parseQuestionText().

    {
        $this->variables[$variable->getVariable()] = $variable;
    }

Here is the caller graph for this function:

calculateReachedPoints()

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

Parameters

integer	$user_id	The database ID of the learner
integer	$test_id	The database Id of the test containing the question public

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

References $pass, assQuestion\$points, $result, getResults(), assQuestion\getSolutionMaxPass(), assQuestion\getSolutionValues(), getVariable(), and getVariables().

Referenced by getExpressionTypes().

    {
        if (is_null($pass)) {
            $pass = $this->getSolutionMaxPass($active_id);
        }
        $solutions = &$this->getSolutionValues($active_id, $pass, $authorizedSolution);
        $user_solution = array();
        foreach ($solutions as $idx => $solution_value) {
            if (preg_match("/^(\\\$v\\d+)$/", $solution_value["value1"], $matches)) {
                $user_solution[$matches[1]] = $solution_value["value2"];
                $varObj = $this->getVariable($solution_value["value1"]);
                $varObj->setValue($solution_value["value2"]);
            } elseif (preg_match("/^(\\\$r\\d+)$/", $solution_value["value1"], $matches)) {
                if (!array_key_exists($matches[1], $user_solution)) {
                    $user_solution[$matches[1]] = array();
                }
                $user_solution[$matches[1]]["value"] = $solution_value["value2"];
            } elseif (preg_match("/^(\\\$r\\d+)_unit$/", $solution_value["value1"], $matches)) {
                if (!array_key_exists($matches[1], $user_solution)) {
                    $user_solution[$matches[1]] = array();
                }
                $user_solution[$matches[1]]["unit"] = $solution_value["value2"];
            }
        }
        //vd($this->getResults());
        $points = 0;
        foreach ($this->getResults() as $result) {
            //vd($user_solution[$result->getResult()]["value"]);
            $points += $result->getReachedPoints($this->getVariables(), $this->getResults(), $user_solution[$result->getResult()]["value"], $user_solution[$result->getResult()]["unit"], $this->unitrepository->getUnits());
        }

        return $points;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

calculateReachedPointsFromPreviewSession()

assFormulaQuestion::calculateReachedPointsFromPreviewSession

(

ilAssQuestionPreviewSession

$previewSession

)

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

References assQuestion\$points, $result, assQuestion\deductHintPointsFromReachedPoints(), assQuestion\ensureNonNegativePoints(), ilAssQuestionPreviewSession\getParticipantsSolution(), getResults(), and getVariables().

    {
        $user_solution = $previewSession->getParticipantsSolution();

        $points = 0;
        foreach ($this->getResults() as $result) {
            $v = isset($user_solution[$result->getResult()]) ? $user_solution[$result->getResult()] : null;
            $u = isset($user_solution[$result->getResult() . '_unit']) ? $user_solution[$result->getResult() . '_unit'] : null;
            
            $points += $result->getReachedPoints(
                $this->getVariables(),
                $this->getResults(),
                $v,
                $u,
                $this->unitrepository->getUnits()
            );
        }

        $reachedPoints = $this->deductHintPointsFromReachedPoints($previewSession, $points);
        
        return $this->ensureNonNegativePoints($reachedPoints);
    }

Here is the call graph for this function:

canUseAdvancedRating()

assFormulaQuestion::canUseAdvancedRating

(

$result

)

Check if advanced rating can be used for a result.

This is only possible if there is exactly one possible correct unit for the result, otherwise it is impossible to determine wheather the unit is correct or the value.

Returns

boolean True if advanced rating could be used, false otherwise

Definition at line 483 of file class.assFormulaQuestion.php.

References $result, and getResultUnits().

    {
        $result_units = $this->getResultUnits($result);
        $resultunit = $result->getUnit();
        $similar_units = 0;
        foreach ($result_units as $unit) {
            if (is_object($resultunit)) {
                if ($resultunit->getId() != $unit->getId()) {
                    if ($resultunit->getBaseUnit() && $unit->getBaseUnit()) {
                        if ($resultunit->getBaseUnit() == $unit->getBaseUnit()) {
                            return false;
                        }
                    }
                    if ($resultunit->getBaseUnit()) {
                        if ($resultunit->getBaseUnit() == $unit->getId()) {
                            return false;
                        }
                    }
                    if ($unit->getBaseUnit()) {
                        if ($unit->getBaseUnit() == $resultunit->getId()) {
                            return false;
                        }
                    }
                }
            }
        }
        return true;
    }

Here is the call graph for this function:

checkForDuplicateResults()

assFormulaQuestion::checkForDuplicateResults

(

)

Definition at line 173 of file class.assFormulaQuestion.php.

References assQuestion\getQuestion().

    {
        if (preg_match_all("/(\\\$r\\d+)/ims", $this->getQuestion(), $rmatches)) {
            if ((count(array_unique($rmatches[1]))) != count($rmatches[1])) {
                return false;
            }
        }
        return true;
    }

Here is the call graph for this function:

checkForDuplicateVariables()

assFormulaQuestion::checkForDuplicateVariables

(

)

Definition at line 163 of file class.assFormulaQuestion.php.

References assQuestion\getQuestion().

    {
        if (preg_match_all("/(\\\$v\\d+)/ims", $this->getQuestion(), $matches)) {
            if ((count(array_unique($matches[1]))) != count($matches[1])) {
                return false;
            }
        }
        return true;
    }

Here is the call graph for this function:

clearResults()

assFormulaQuestion::clearResults

(

)

Definition at line 78 of file class.assFormulaQuestion.php.

Referenced by parseQuestionText().

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

Here is the caller graph for this function:

clearVariables()

assFormulaQuestion::clearVariables

(

)

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

Referenced by parseQuestionText().

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

Here is the caller graph for this function:

copyObject()

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

Copies an assFormulaQuestion object public.

Definition at line 764 of file class.assFormulaQuestion.php.

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

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

        $clone->unitrepository->cloneUnits($original_id, $clone->getId());

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

Here is the call graph for this function:

createNewOriginalFromThisDuplicate()

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

Definition at line 794 of file class.assFormulaQuestion.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:

deleteAnswers()

assFormulaQuestion::deleteAnswers

(

$question_id

)

Deletes datasets from answers tables.

Parameters

integer

$question_id

The question id which should be deleted in the answers table public

Definition at line 1138 of file class.assFormulaQuestion.php.

References $DIC, and $ilDB.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM il_qpl_qst_fq_var WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );

        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM il_qpl_qst_fq_res WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );

        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM il_qpl_qst_fq_res_unit WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );

        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM il_qpl_qst_fq_ucat WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );

        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM il_qpl_qst_fq_unit WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );
    }

duplicate()

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

Duplicates an assFormulaQuestion public.

Definition at line 713 of file class.assFormulaQuestion.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();
        }

        $clone->unitrepository->cloneUnits($this_id, $clone->getId());

        // 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:

fetchAllResults()

assFormulaQuestion::fetchAllResults

(

$questionText

)

Parameters

string

$questionText

Returns

assFormulaQuestionResult[] $resObjects

Definition at line 187 of file class.assFormulaQuestion.php.

References getResult().

Referenced by getInitialVariableSolutionValues().

    {
        $resObjects = array();
        $matches = null;
        
        if (preg_match_all("/(\\\$r\\d+)/ims", $questionText, $matches)) {
            foreach ($matches[1] as $resultKey) {
                $resObjects[] = $this->getResult($resultKey);
            }
        }
        
        return $resObjects;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchAllVariables()

assFormulaQuestion::fetchAllVariables

(

$questionText

)

Parameters

string

$questionText

Returns

assFormulaQuestionVariable[] $varObjects

Definition at line 205 of file class.assFormulaQuestion.php.

References getVariable().

Referenced by getInitialVariableSolutionValues(), hasRequiredVariableSolutionValues(), and substituteVariables().

    {
        $varObjects = array();
        $matches = null;
        
        if (preg_match_all("/(\\\$v\\d+)/ims", $questionText, $matches)) {
            foreach ($matches[1] as $variableKey) {
                $varObjects[] = $this->getVariable($variableKey);
            }
        }
        
        return $varObjects;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAdditionalTableName()

assFormulaQuestion::getAdditionalTableName

(

)

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

Returns

string The additional table name

Definition at line 1119 of file class.assFormulaQuestion.php.

    {
        return "";
    }

getAnswerTableName()

assFormulaQuestion::getAnswerTableName

(

)

Returns the name of the answer table in the database.

Returns

string The answer table name

Definition at line 1128 of file class.assFormulaQuestion.php.

    {
        return "";
    }

getAvailableAnswerOptions()

assFormulaQuestion::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 1444 of file class.assFormulaQuestion.php.

References $index, getResult(), and getResults().

    {
        if ($index !== null) {
            return $this->getResult('$r' . ($index + 1));
        } else {
            return $this->getResults();
        }
    }

Here is the call graph for this function:

getBestSolution()

assFormulaQuestion::getBestSolution

(

$solutions

)

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

Returns

array An associated array containing the best solution public

Definition at line 1222 of file class.assFormulaQuestion.php.

References $result, ilMath\_div(), assFormulaQuestionResult\convertDecimalToCoprimeFraction(), getResults(), getVariable(), getVariables(), assFormulaQuestionUnit\lookupUnitFactor(), assFormulaQuestionResult\RESULT_CO_FRAC, and assFormulaQuestionResult\RESULT_FRAC.

    {
        $user_solution = array();

        foreach ($solutions as $idx => $solution_value) {
            if (preg_match("/^(\\\$v\\d+)$/", $solution_value["value1"], $matches)) {
                $user_solution[$matches[1]] = $solution_value["value2"];
                $varObj = $this->getVariable($matches[1]);
                $varObj->setValue($solution_value["value2"]);
            } elseif (preg_match("/^(\\\$r\\d+)$/", $solution_value["value1"], $matches)) {
                if (!array_key_exists($matches[1], $user_solution)) {
                    $user_solution[$matches[1]] = array();
                }
                $user_solution[$matches[1]]["value"] = $solution_value["value2"];
            } elseif (preg_match("/^(\\\$r\\d+)_unit$/", $solution_value["value1"], $matches)) {
                if (!array_key_exists($matches[1], $user_solution)) {
                    $user_solution[$matches[1]] = array();
                }
                $user_solution[$matches[1]]["unit"] = $solution_value["value2"];
            }
        }
        foreach ($this->getResults() as $result) {
            $resVal = $result->calculateFormula($this->getVariables(), $this->getResults(), parent::getId(), false);

            if (is_object($result->getUnit())) {
                $user_solution[$result->getResult()]["unit"] = $result->getUnit()->getId();
                $user_solution[$result->getResult()]["value"] = $resVal;
            } elseif ($result->getUnit() == null) {
                $unit_factor = 1;
                // there is no fix result_unit, any "available unit" is accepted
                
                $available_units = $result->getAvailableResultUnits(parent::getId());
                $result_name = $result->getResult();
                
                if ($available_units[$result_name] != null) {
                    $check_unit = in_array($user_solution[$result_name]['unit'], $available_units[$result_name]);
                }

                if ($check_unit == true) {
                    //get unit-factor
                    $unit_factor = assFormulaQuestionUnit::lookupUnitFactor($user_solution[$result_name]['unit']);
                }

                try {
                    $user_solution[$result->getResult()]["value"] = ilMath::_div($resVal, $unit_factor, 55);
                } catch (ilMathDivisionByZeroException $ex) {
                    $user_solution[$result->getResult()]["value"] = 0;
                }
            }
            if ($result->getResultType() == assFormulaQuestionResult::RESULT_CO_FRAC
                || $result->getResultType() == assFormulaQuestionResult::RESULT_FRAC) {
                $value = assFormulaQuestionResult::convertDecimalToCoprimeFraction($resVal);
                if (is_array($value)) {
                    $user_solution[$result->getResult()]["value"] = $value[0];
                    $user_solution[$result->getResult()]["frac_helper"] = $value[1];
                } else {
                    $user_solution[$result->getResult()]["value"] = $value;
                    $user_solution[$result->getResult()]["frac_helper"] = null;
                }
            } else {
                $user_solution[$result->getResult()]["value"] = round($user_solution[$result->getResult()]["value"], $result->getPrecision());
                /*
                $user_solution[$result->getResult()]["value"] = ilMath::_div(
                    $user_solution[$result->getResult()]["value"],
                    1,
                    $result->getPrecision()
                );
                */
            }
        }
        return $user_solution;
    }

Here is the call graph for this function:

getExpressionTypes()

assFormulaQuestion::getExpressionTypes

(

)

Get all available expression types for a specific question.

Returns

array

Implements iQuestionCondition.

Definition at line 1382 of file class.assFormulaQuestion.php.

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

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

Here is the call graph for this function:

getInitialVariableSolutionValues()

assFormulaQuestion::getInitialVariableSolutionValues

(

)

Returns

array $initialVariableSolutionValues

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

References fetchAllResults(), fetchAllVariables(), assQuestion\getQuestion(), getResults(), and getVariables().

    {
        foreach ($this->fetchAllResults($this->getQuestion()) as $resObj) {
            $resObj->findValidRandomVariables($this->getVariables(), $this->getResults());
        }

        $variableSolutionValues = array();
        
        foreach ($this->fetchAllVariables($this->getQuestion()) as $varObj) {
            $variableSolutionValues[$varObj->getVariable()] = $varObj->getValue();
        }
        
        return $variableSolutionValues;
    }

Here is the call graph for this function:

getMaximumPoints()

assFormulaQuestion::getMaximumPoints

(

)

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

See also

$points

Definition at line 831 of file class.assFormulaQuestion.php.

References assQuestion\$points, and $result.

Referenced by getExpressionTypes(), and isComplete().

    {
        $points = 0;
        foreach ($this->results as $result) {
            $points += $result->getPoints();
        }
        return $points;
    }

Here is the caller graph for this function:

getOperators()

assFormulaQuestion::getOperators

(

$expression

)

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

Definition at line 1372 of file class.assFormulaQuestion.php.

References ilOperatorsExpressionMapping\getOperatorsByExpression().

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

Here is the call graph for this function:

getQuestionType()

assFormulaQuestion::getQuestionType

(

)

Returns the question type of the question.

Returns

string The question type of the question

Definition at line 1110 of file class.assFormulaQuestion.php.

    {
        return "assFormulaQuestion";
    }

getResult()

assFormulaQuestion::getResult

(

$result

)

Definition at line 88 of file class.assFormulaQuestion.php.

References $result.

Referenced by fetchAllResults(), getAvailableAnswerOptions(), loadFromDb(), and substituteVariables().

    {
        if (array_key_exists($result, $this->results)) {
            return $this->results[$result];
        }
        return null;
    }

Here is the caller graph for this function:

getResults()

assFormulaQuestion::getResults

(

)

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

References $results.

Referenced by calculateReachedPoints(), calculateReachedPointsFromPreviewSession(), getAvailableAnswerOptions(), getBestSolution(), getInitialVariableSolutionValues(), and substituteVariables().

    {
        return $this->results;
    }

Here is the caller graph for this function:

getResultUnits()

assFormulaQuestion::getResultUnits

(

$result

)

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

References $result, and $resultunits.

Referenced by canUseAdvancedRating(), saveToDb(), and substituteVariables().

    {
        if (array_key_exists($result->getResult(), $this->resultunits)) {
            return $this->resultunits[$result->getResult()];
        } else {
            return array();
        }
    }

Here is the caller graph for this function:

getRTETextWithMediaObjects()

assFormulaQuestion::getRTETextWithMediaObjects

(

)

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

Definition at line 1178 of file class.assFormulaQuestion.php.

References $text.

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

getSolutionSubmit()

assFormulaQuestion::getSolutionSubmit ( )

protected

Returns

array

Definition at line 1335 of file class.assFormulaQuestion.php.

References $_POST.

Referenced by savePreviewData(), saveWorkingData(), and validateSolutionSubmit().

    {
        $solutionSubmit = array();
        foreach ($_POST as $k => $v) {
            if (preg_match("/^result_(\\\$r\\d+)$/", $k)) {
                $solutionSubmit[$k] = $v;
            } elseif (preg_match("/^result_(\\\$r\\d+)_unit$/", $k)) {
                $solutionSubmit[$k] = $v;
            }
        }
        return $solutionSubmit;
    }

Here is the caller graph for this function:

getUnitrepository()

assFormulaQuestion::getUnitrepository

(

)

Returns

Definition at line 1327 of file class.assFormulaQuestion.php.

References $unitrepository.

Referenced by addResultUnits(), loadFromDb(), setExportDetailsXLS(), and substituteVariables().

    {
        return $this->unitrepository;
    }

Here is the caller graph for this function:

getVariable()

assFormulaQuestion::getVariable

(

$variable

)

Definition at line 65 of file class.assFormulaQuestion.php.

Referenced by calculateReachedPoints(), fetchAllVariables(), getBestSolution(), and setExportDetailsXLS().

    {
        if (array_key_exists($variable, $this->variables)) {
            return $this->variables[$variable];
        }
        return null;
    }

Here is the caller graph for this function:

getVariables()

assFormulaQuestion::getVariables

(

)

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

References $variables.

Referenced by calculateReachedPoints(), calculateReachedPointsFromPreviewSession(), getBestSolution(), getInitialVariableSolutionValues(), and substituteVariables().

    {
        return $this->variables;
    }

Here is the caller graph for this function:

hasRequiredVariableSolutionValues()

assFormulaQuestion::hasRequiredVariableSolutionValues

(

array

$userSolution

)

Parameters

array

$userSolution

Returns

bool

Definition at line 223 of file class.assFormulaQuestion.php.

References fetchAllVariables(), and assQuestion\getQuestion().

    {
        foreach ($this->fetchAllVariables($this->getQuestion()) as $varObj) {
            if (!isset($userSolution[$varObj->getVariable()])) {
                return false;
            }
            
            if (!strlen($userSolution[$varObj->getVariable()])) {
                return false;
            }
        }
        
        return true;
    }

Here is the call graph for this function:

hasResultUnit()

assFormulaQuestion::hasResultUnit	(		$result,
			$unit_id
	)

Definition at line 133 of file class.assFormulaQuestion.php.

References $result, and $resultunits.

    {
        if (array_key_exists($result->getResult(), $this->resultunits)) {
            if (array_key_exists($unit_id, $this->resultunits[$result->getResult()])) {
                return true;
            }
        }

        return false;
    }

isComplete()

assFormulaQuestion::isComplete

(

)

Returns true, if the question is complete for use.

Returns

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

Definition at line 516 of file class.assFormulaQuestion.php.

References getMaximumPoints().

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

Here is the call graph for this function:

isValidSolutionResultValue()

assFormulaQuestion::isValidSolutionResultValue (   $submittedValue )

protected

Definition at line 905 of file class.assFormulaQuestion.php.

Referenced by validateSolutionSubmit().

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

Here is the caller graph for this function:

loadFromDb()

assFormulaQuestion::loadFromDb

(

$question_id

)

Loads a assFormulaQuestion object from a database.

Parameters

integer

$question_id

A unique key which defines the question in the database

Definition at line 629 of file class.assFormulaQuestion.php.

References $data, $DIC, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), addResult(), addResultUnit(), addVariable(), getResult(), getUnitrepository(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), setId(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setSuggestedSolution(), and assQuestion\setTitle().

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $result = $ilDB->queryF(
            "SELECT qpl_questions.* FROM qpl_questions WHERE question_id = %s",
            array('integer'),
            array($question_id)
        );
        if ($result->numRows() == 1) {
            $data = $ilDB->fetchAssoc($result);
            $this->setId($question_id);
            $this->setTitle($data["title"]);
            $this->setComment($data["description"]);
            $this->setSuggestedSolution($data["solution_hint"]);
            $this->setPoints($data['points']);
            $this->setOriginalId($data["original_id"]);
            $this->setObjId($data["obj_fi"]);
            $this->setAuthor($data["author"]);
            $this->setOwner($data["owner"]);

            try {
                $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
            } catch (ilTestQuestionPoolException $e) {
            }

            $this->unitrepository = new ilUnitConfigurationRepository($question_id);

            include_once("./Services/RTE/classes/class.ilRTE.php");
            $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
            $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));

            // load variables
            $result = $ilDB->queryF(
                "SELECT * FROM il_qpl_qst_fq_var WHERE question_fi = %s",
                array('integer'),
                array($question_id)
            );
            if ($result->numRows() > 0) {
                while ($data = $ilDB->fetchAssoc($result)) {
                    $varObj = new assFormulaQuestionVariable($data["variable"], $data["range_min"], $data["range_max"], $this->getUnitrepository()->getUnit($data["unit_fi"]), $data["varprecision"], $data["intprecision"]);
                    $varObj->setRangeMinTxt($data['range_min_txt']);
                    $varObj->setRangeMaxTxt($data['range_max_txt']);
                    $this->addVariable($varObj);
                }
            }
            // load results
            $result = $ilDB->queryF(
                "SELECT * FROM il_qpl_qst_fq_res WHERE question_fi = %s",
                array('integer'),
                array($question_id)
            );
            if ($result->numRows() > 0) {
                while ($data = $ilDB->fetchAssoc($result)) {
                    $resObj = new assFormulaQuestionResult($data["result"], $data["range_min"], $data["range_max"], $data["tolerance"], $this->getUnitrepository()->getUnit($data["unit_fi"]), $data["formula"], $data["points"], $data["resprecision"], $data["rating_simple"], $data["rating_sign"], $data["rating_value"], $data["rating_unit"]);
                    $resObj->setResultType($data['result_type']);
                    $resObj->setRangeMinTxt($data['range_min_txt']);
                    $resObj->setRangeMaxTxt($data['range_max_txt']);
                    $this->addResult($resObj);
                }
            }

            // load result units
            $result = $ilDB->queryF(
                "SELECT * FROM il_qpl_qst_fq_res_unit WHERE question_fi = %s",
                array('integer'),
                array($question_id)
            );
            if ($result->numRows() > 0) {
                while ($data = $ilDB->fetchAssoc($result)) {
                    $unit = $this->getUnitrepository()->getUnit($data["unit_fi"]);
                    $resObj = $this->getResult($data["result"]);
                    $this->addResultUnit($resObj, $unit);
                }
            }
        }
        parent::loadFromDb($question_id);
    }

Here is the call graph for this function:

lookupForExistingSolutions()

assFormulaQuestion::lookupForExistingSolutions	(		$activeId,
			$pass
	)

Lookup if an authorized or intermediate solution exists.

Parameters

int	$activeId
int	$pass

Returns

array ['authorized' => bool, 'intermediate' => bool]

Definition at line 1019 of file class.assFormulaQuestion.php.

References $DIC, $ilDB, $pass, $query, $result, $row, assQuestion\getId(), and assQuestion\getStep().

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $return = array(
            'authorized' => false,
            'intermediate' => false
        );

        $query = "
                        SELECT authorized, COUNT(*) cnt
                        FROM tst_solutions
                        WHERE active_fi = " . $ilDB->quote($activeId, 'integer') . "
                        AND question_fi = " . $ilDB->quote($this->getId(), 'integer') . "
                        AND pass = " . $ilDB->quote($pass, 'integer') . "
                        AND value1 like '\$r%'
                        AND value2 is not null
                        AND value2 <> ''
                ";

        if ($this->getStep() !== null) {
            $query .= " AND step = " . $ilDB->quote((int) $this->getStep(), 'integer') . " ";
        }

        $query .= "
                        GROUP BY authorized
                ";

        $result = $ilDB->query($query);

        while ($row = $ilDB->fetchAssoc($result)) {
            if ($row['authorized']) {
                $return['authorized'] = $row['cnt'] > 0;
            } else {
                $return['intermediate'] = $row['cnt'] > 0;
            }
        }
        return $return;
    }

Here is the call graph for this function:

parseQuestionText()

assFormulaQuestion::parseQuestionText

(

)

Definition at line 144 of file class.assFormulaQuestion.php.

References $result, addResult(), addVariable(), clearResults(), clearVariables(), and assQuestion\getQuestion().

    {
        $this->clearResults();
        $this->clearVariables();
        if (preg_match_all("/(\\\$v\\d+)/ims", $this->getQuestion(), $matches)) {
            foreach ($matches[1] as $variable) {
                $varObj = new assFormulaQuestionVariable($variable, 0, 0, null, 0);
                $this->addVariable($varObj);
            }
        }

        if (preg_match_all("/(\\\$r\\d+)/ims", $this->getQuestion(), $rmatches)) {
            foreach ($rmatches[1] as $result) {
                $resObj = new assFormulaQuestionResult($result, null, null, 0, -1, null, 1, 1, true);
                $this->addResult($resObj);
            }
        }
    }

Here is the call graph for this function:

removeExistingSolutions()

assFormulaQuestion::removeExistingSolutions	(		$activeId,
			$pass
	)

Remove an existing solution without removing the variables.

Parameters

int	$activeId
int	$pass

Returns

int

Definition at line 1068 of file class.assFormulaQuestion.php.

References $DIC, $ilDB, $pass, $query, assQuestion\getId(), and assQuestion\getStep().

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $query = "
                        DELETE FROM tst_solutions
                        WHERE active_fi = " . $ilDB->quote($activeId, 'integer') . "
                        AND question_fi = " . $ilDB->quote($this->getId(), 'integer') . "
                        AND pass = " . $ilDB->quote($pass, 'integer') . "
                        AND value1 like '\$r%'
                ";

        if ($this->getStep() !== null) {
            $query .= " AND step = " . $ilDB->quote((int) $this->getStep(), 'integer') . " ";
        }

        return $ilDB->manipulate($query);
    }

Here is the call graph for this function:

savePreviewData()

assFormulaQuestion::savePreviewData ( ilAssQuestionPreviewSession  $previewSession )

protected

Definition at line 1089 of file class.assFormulaQuestion.php.

References $key, ilAssQuestionPreviewSession\getParticipantsSolution(), getSolutionSubmit(), and ilAssQuestionPreviewSession\setParticipantsSolution().

    {
        $userSolution = $previewSession->getParticipantsSolution();
        
        foreach ($this->getSolutionSubmit() as $key => $val) {
            $matches = null;
            
            if (preg_match("/^result_(\\\$r\\d+)$/", $key, $matches)) {
                $userSolution[$matches[1]] = $val;
            } elseif (preg_match("/^result_(\\\$r\\d+)_unit$/", $key, $matches)) {
                $userSolution[$matches[1] . "_unit"] = $val;
            }
        }

        $previewSession->setParticipantsSolution($userSolution);
    }

Here is the call graph for this function:

saveToDb()

assFormulaQuestion::saveToDb

(

$original_id = ""

)

Saves a assFormulaQuestion object to a database public.

Definition at line 529 of file class.assFormulaQuestion.php.

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $this->saveQuestionDataToDb($original_id);
        // save variables
        $affectedRows = $ilDB->manipulateF(
            "
                DELETE FROM il_qpl_qst_fq_var 
                WHERE question_fi = %s",
            array("integer"),
            array($this->getId())
        );

        foreach ($this->variables as $variable) {
            $next_id = $ilDB->nextId('il_qpl_qst_fq_var');
            $ilDB->insert(
                'il_qpl_qst_fq_var',
                array(
                'variable_id' => array('integer', $next_id),
                'question_fi' => array('integer', $this->getId()),
                'variable' => array('text', $variable->getVariable()),
                'range_min' => array('float', ((strlen($variable->getRangeMin())) ? $variable->getRangeMin() : 0.0)),
                'range_max' => array('float', ((strlen($variable->getRangeMax())) ? $variable->getRangeMax() : 0.0)),
                'unit_fi' => array('integer', (is_object($variable->getUnit()) ? (int) $variable->getUnit()->getId() : 0)),
                'varprecision' => array('integer', (int) $variable->getPrecision()),
                'intprecision' => array('integer', (int) $variable->getIntprecision()),
                'range_min_txt' => array('text', $variable->getRangeMinTxt()),
                'range_max_txt' => array('text', $variable->getRangeMaxTxt())
            )
            );
        }
        // save results
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM il_qpl_qst_fq_res WHERE question_fi = %s",
            array("integer"),
            array($this->getId())
        );
        
        foreach ($this->results as $result) {
            $next_id = $ilDB->nextId('il_qpl_qst_fq_res');
            if (is_object($result->getUnit())) {
                $tmp_result_unit = $result->getUnit()->getId();
            } else {
                $tmp_result_unit = null;
            }

            $formula = str_replace(",", ".", $result->getFormula());
            
            $ilDB->insert("il_qpl_qst_fq_res", array(
                "result_id" => array("integer", $next_id),
                "question_fi" => array("integer", $this->getId()),
                "result" => array("text", $result->getResult()),
                "range_min" => array("float", ((strlen($result->getRangeMin())) ? $result->getRangeMin() : 0)),
                "range_max" => array("float", ((strlen($result->getRangeMax())) ? $result->getRangeMax() : 0)),
                "tolerance" => array("float", ((strlen($result->getTolerance())) ? $result->getTolerance() : 0)),
                "unit_fi" => array("integer", (int) $tmp_result_unit),
                "formula" => array("clob", $formula),
                "resprecision" => array("integer", $result->getPrecision()),
                "rating_simple" => array("integer", ($result->getRatingSimple()) ? 1 : 0),
                "rating_sign" => array("float", ($result->getRatingSimple()) ? 0 : $result->getRatingSign()),
                "rating_value" => array("float", ($result->getRatingSimple()) ? 0 : $result->getRatingValue()),
                "rating_unit" => array("float", ($result->getRatingSimple()) ? 0 : $result->getRatingUnit()),
                "points" => array("float", $result->getPoints()),
                "result_type" => array('integer', (int) $result->getResultType()),
                "range_min_txt" => array("text", $result->getRangeMinTxt()),
                "range_max_txt" => array("text", $result->getRangeMaxTxt())

            ));
        }
        // save result units
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM il_qpl_qst_fq_res_unit WHERE question_fi = %s",
            array("integer"),
            array($this->getId())
        );
        foreach ($this->results as $result) {
            foreach ($this->getResultUnits($result) as $unit) {
                $next_id = $ilDB->nextId('il_qpl_qst_fq_res_unit');
                $affectedRows = $ilDB->manipulateF(
                    "INSERT INTO il_qpl_qst_fq_res_unit (result_unit_id, question_fi, result, unit_fi) VALUES (%s, %s, %s, %s)",
                    array('integer', 'integer', 'text', 'integer'),
                    array(
                        $next_id,
                        $this->getId(),
                        $result->getResult(),
                        $unit->getId()
                    )
                );
            }
        }

        parent::saveToDb();
    }

Here is the call graph for this function:

saveWorkingData()

assFormulaQuestion::saveWorkingData	(		$active_id,
			$pass = null,
			$authorized = true
	)

Saves the learners input of the question to the database.

Parameters

integer

$test_id

The database id of the test containing this question

Returns

boolean Indicates the save status (true if saved successful, false otherwise) public

See also

$answers

Definition at line 927 of file class.assFormulaQuestion.php.

References $DIC, $ilDB, $key, $pass, $result, $row, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), assQuestion\getId(), assQuestion\getProcessLocker(), getSolutionSubmit(), assQuestion\getStep(), assQuestion\logAction(), and assQuestion\saveCurrentSolution().

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        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, $ilDB, $active_id, $pass, $authorized) {
            $solutionSubmit = $this->getSolutionSubmit();
            foreach ($solutionSubmit as $key => $value) {
                $matches = null;
                if (preg_match("/^result_(\\\$r\\d+)$/", $key, $matches)) {
                    if (strlen($value)) {
                        $entered_values = true;
                    }

                    $queryResult = "SELECT solution_id FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND authorized = %s  AND " . $ilDB->like('value1', 'clob', $matches[1]);

                    if ($this->getStep() !== null) {
                        $queryResult .= " AND step = " . $ilDB->quote((int) $this->getStep(), 'integer') . " ";
                    }

                    $result = $ilDB->queryF(
                        $queryResult,
                        array('integer', 'integer', 'integer', 'integer'),
                        array($active_id, $pass, $this->getId(), (int) $authorized)
                    );
                    if ($result->numRows()) {
                        while ($row = $ilDB->fetchAssoc($result)) {
                            $ilDB->manipulateF(
                                "DELETE FROM tst_solutions WHERE solution_id = %s AND authorized = %s",
                                array('integer', 'integer'),
                                array($row['solution_id'], (int) $authorized)
                            );
                        }
                    }

                    $this->saveCurrentSolution($active_id, $pass, $matches[1], str_replace(",", ".", $value), $authorized);
                } elseif (preg_match("/^result_(\\\$r\\d+)_unit$/", $key, $matches)) {
                    $queryResultUnit = "SELECT solution_id FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND authorized = %s AND " . $ilDB->like('value1', 'clob', $matches[1] . "_unit");

                    if ($this->getStep() !== null) {
                        $queryResultUnit .= " AND step = " . $ilDB->quote((int) $this->getStep(), 'integer') . " ";
                    }

                    $result = $ilDB->queryF(
                        $queryResultUnit,
                        array('integer', 'integer', 'integer', 'integer'),
                        array($active_id, $pass, $this->getId(), (int) $authorized)
                    );
                    if ($result->numRows()) {
                        while ($row = $ilDB->fetchAssoc($result)) {
                            $ilDB->manipulateF(
                                "DELETE FROM tst_solutions WHERE solution_id = %s AND authorized = %s",
                                array('integer', 'integer'),
                                array($row['solution_id'], (int) $authorized)
                            );
                        }
                    }

                    $this->saveCurrentSolution($active_id, $pass, $matches[1] . "_unit", $value, $authorized);
                }
            }
        });

        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:

setExportDetailsXLS()

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

{}

Definition at line 1187 of file class.assFormulaQuestion.php.

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

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

        $solution = $this->getSolutionValues($active_id, $pass);

        $i = 1;
        foreach ($solution as $solutionvalue) {
            $worksheet->setCell($startrow + $i, 0, $solutionvalue["value1"]);
            $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
            if (strpos($solutionvalue["value1"], "_unit")) {
                $unit = $this->getUnitrepository()->getUnit($solutionvalue["value2"]);
                if (is_object($unit)) {
                    $worksheet->setCell($startrow + $i, 1, $unit->getUnit());
                }
            } else {
                $worksheet->setCell($startrow + $i, 1, $solutionvalue["value2"]);
            }
            if (preg_match("/(\\\$v\\d+)/", $solutionvalue["value1"], $matches)) {
                $var = $this->getVariable($solutionvalue["value1"]);
                if (is_object($var) && (is_object($var->getUnit()))) {
                    $worksheet->setCell($startrow + $i, 2, $var->getUnit()->getUnit());
                }
            }
            $i++;
        }

        return $startrow + $i + 1;
    }

Here is the call graph for this function:

setId()

assFormulaQuestion::setId

(

$id = -1

)

Definition at line 1295 of file class.assFormulaQuestion.php.

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

Referenced by loadFromDb().

    {
        parent::setId($id);
        $this->unitrepository->setConsumerId($this->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setUnitrepository()

assFormulaQuestion::setUnitrepository

(

$unitrepository

)

Parameters

\ilUnitConfigurationRepository

$unitrepository

Definition at line 1319 of file class.assFormulaQuestion.php.

References $unitrepository.

    {
        $this->unitrepository = $unitrepository;
    }

substituteVariables()

assFormulaQuestion::substituteVariables	(	array	$userdata,
			$graphicalOutput = false,
			$forsolution = false,
			$result_output = false
	)

Parameters

array	$userdata
bool	$graphicalOutput
bool	$forsolution
bool	$result_output
ilAssQuestionPreviewSession | null	$previewSession

Returns

bool|mixed|string

Definition at line 264 of file class.assFormulaQuestion.php.

References $input, $result, $template, $text, assFormulaQuestionResult\convertDecimalToCoprimeFraction(), fetchAllVariables(), ilUtil\getImagePath(), assQuestion\getQuestion(), getResult(), getResults(), getResultUnits(), getUnitrepository(), getVariables(), ilUtil\prepareFormOutput(), assFormulaQuestionResult\RESULT_CO_FRAC, assFormulaQuestionResult\RESULT_DEC, assFormulaQuestionResult\RESULT_FRAC, and assFormulaQuestionResult\RESULT_NO_SELECTION.

    {
        if ((count($this->results) == 0) && (count($this->variables) == 0)) {
            return false;
        }
        
        $text = $this->getQuestion();
        
        foreach ($this->fetchAllVariables($this->getQuestion()) as $varObj) {
            if (isset($userdata[$varObj->getVariable()]) && strlen($userdata[$varObj->getVariable()])) {
                $varObj->setValue($userdata[$varObj->getVariable()]);
            }

            $unit = (is_object($varObj->getUnit())) ? $varObj->getUnit()->getUnit() : "";
            $val = (strlen($varObj->getValue()) > 8) ? strtoupper(sprintf("%e", $varObj->getValue())) : $varObj->getValue();
            
            $text = preg_replace("/\\$" . substr($varObj->getVariable(), 1) . "(?![0-9]+)/", $val . " " . $unit . "\\1", $text);
        }
        
        if (preg_match_all("/(\\\$r\\d+)/ims", $this->getQuestion(), $rmatches)) {
            foreach ($rmatches[1] as $result) {
                $resObj = $this->getResult($result);
                $value = "";
                $frac_helper = '';
                $user_data[$result]['result_type'] = $resObj->getResultType();

                if (
                    $resObj->getResultType() == assFormulaQuestionResult::RESULT_FRAC ||
                    $resObj->getResultType() == assFormulaQuestionResult::RESULT_CO_FRAC
                ) {
                    $is_frac = true;
                }
                if (is_array($userdata)) {
                    if (is_array($userdata[$result])) {
                        if (false && $forsolution && $result_output) { // fix for mantis #25956
                            $value_org = $resObj->calculateFormula($this->getVariables(), $this->getResults(), parent::getId());
                            $value = sprintf("%." . $resObj->getPrecision() . "f", $value_org);
                            if ($is_frac) {
                                $value = assFormulaQuestionResult::convertDecimalToCoprimeFraction($value_org);
                                if (is_array($value)) {
                                    $frac_helper = $value[1];
                                    $value = $value[0];
                                }
                            }
                        } else {
                            if ($forsolution) {
                                $value = $userdata[$result]["value"];
                            } else {
                                $value = ' value="' . $userdata[$result]["value"] . '"';
                            }
                        }
                    }
                } else {
                    if ($forsolution) {
                        $value = $resObj->calculateFormula($this->getVariables(), $this->getResults(), parent::getId());
                        $value = sprintf("%." . $resObj->getPrecision() . "f", $value);

                        if ($is_frac) {
                            $value = assFormulaQuestionResult::convertDecimalToCoprimeFraction($value);
                            if (is_array($value)) {
                                $frac_helper = $value[1];
                                $value = $value[0];
                            }
                            $value = ' value="' . $value . '"';
                        }
                    } else {
                        // Precision fix for Preview by tjoussen
                        // If all default values are set, this function is called in getPreview
                        $use_precision = !($userdata == null && $graphicalOutput == false && $forsolution == false && $result_output == false);

                        $val = $resObj->calculateFormula($this->getVariables(), $this->getResults(), parent::getId(), $use_precision);

                        if ($resObj->getResultType() == assFormulaQuestionResult::RESULT_FRAC
                            || $resObj->getResultType() == assFormulaQuestionResult::RESULT_CO_FRAC) {
                            $val = $resObj->convertDecimalToCoprimeFraction($val);
                            if (is_array($val)) {
                                $frac_helper = $val[1];
                                $val = $val[0];
                            }
                        } else {
                            $val = sprintf("%." . $resObj->getPrecision() . "f", $val);
                            $val = (strlen($val) > 8) ? strtoupper(sprintf("%e", $val)) : $val;
                        }
                        $value = ' value="' . $val . '"';
                    }
                }

                if ($forsolution) {
                    $input = '<span class="ilc_qinput_TextInput solutionbox">' . ilUtil::prepareFormOutput($value) . '</span>';
                } else {
                    $input = '<input class="ilc_qinput_TextInput" type="text" spellcheck="false" autocomplete="off" autocorrect="off" autocapitalize="off" name="result_' . $result . '"' . $value . ' />';
                }
                
                $units = "";
                if (count($this->getResultUnits($resObj)) > 0) {
                    if ($forsolution) {
                        if (is_array($userdata)) {
                            foreach ($this->getResultUnits($resObj) as $unit) {
                                if ($userdata[$result]["unit"] == $unit->getId()) {
                                    $units = $unit->getUnit();
                                }
                            }
                        } else {
                            if ($resObj->getUnit()) {
                                $units = $resObj->getUnit()->getUnit();
                            }
                        }
                    } else {
                        $units = '<select name="result_' . $result . '_unit">';
                        $units .= '<option value="-1">' . $this->lng->txt("select_unit") . '</option>';
                        foreach ($this->getResultUnits($resObj) as $unit) {
                            $units .= '<option value="' . $unit->getId() . '"';
                            if ((is_array($userdata[$result])) && (strlen($userdata[$result]["unit"]))) {
                                if ($userdata[$result]["unit"] == $unit->getId()) {
                                    $units .= ' selected="selected"';
                                }
                            }
                            $units .= '>' . $unit->getUnit() . '</option>';
                        }
                        $units .= '</select>';
                    }
                } else {
                    $units = "";
                }
                switch ($resObj->getResultType()) {
                    case assFormulaQuestionResult::RESULT_DEC:
                        $units .= ' ' . $this->lng->txt('expected_result_type') . ': ' . $this->lng->txt('result_dec');
                        break;
                    case assFormulaQuestionResult::RESULT_FRAC:
                        if (strlen($frac_helper)) {
                            $units .= ' &asymp; ' . $frac_helper . ', ';
                        } elseif (is_array($userdata) && isset($userdata[$result]) && strlen($userdata[$result]["frac_helper"])) {
                            if (!preg_match('-/-', $value)) {
                                $units .= ' &asymp; ' . $userdata[$result]["frac_helper"] . ', ';
                            }
                        }
                        $units .= ' ' . $this->lng->txt('expected_result_type') . ': ' . $this->lng->txt('result_frac');
                        break;
                    case assFormulaQuestionResult::RESULT_CO_FRAC:
                        if (strlen($frac_helper)) {
                            $units .= ' &asymp; ' . $frac_helper . ', ';
                        } elseif (is_array($userdata) && isset($userdata[$result]) && strlen($userdata[$result]["frac_helper"])) {
                            if (!preg_match('-/-', $value)) {
                                $units .= ' &asymp; ' . $userdata[$result]["frac_helper"] . ', ';
                            }
                        }
                        $units .= ' ' . $this->lng->txt('expected_result_type') . ': ' . $this->lng->txt('result_co_frac');
                        break;
                    case assFormulaQuestionResult::RESULT_NO_SELECTION:
                        break;
                }
                $checkSign = "";
                if ($graphicalOutput) {
                    $resunit = null;
                    $user_value = '';
                    if (is_array($userdata) && is_array($userdata[$result])) {
                        if ($userdata[$result]["unit"] > 0) {
                            $resunit = $this->getUnitrepository()->getUnit($userdata[$result]["unit"]);
                        }

                        if (isset($userdata[$result]["value"])) {
                            $user_value = $userdata[$result]["value"];
                        }
                    }

                    $template = new ilTemplate("tpl.il_as_qpl_formulaquestion_output_solution_image.html", true, true, 'Modules/TestQuestionPool');

                    if ($resObj->isCorrect($this->getVariables(), $this->getResults(), $user_value, $resunit)) {
                        $template->setCurrentBlock("icon_ok");
                        $template->setVariable("ICON_OK", ilUtil::getImagePath("icon_ok.svg"));
                        $template->setVariable("TEXT_OK", $this->lng->txt("answer_is_right"));
                        $template->parseCurrentBlock();
                    } else {
                        $template->setCurrentBlock("icon_not_ok");
                        $template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_not_ok.svg"));
                        $template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_wrong"));
                        $template->parseCurrentBlock();
                    }
                    $checkSign = $template->get();
                }
                $resultOutput = "";
                if ($result_output) {
                    $template = new ilTemplate("tpl.il_as_qpl_formulaquestion_output_solution_result.html", true, true, 'Modules/TestQuestionPool');

                    if (is_array($userdata)) {
                        $found = $resObj->getResultInfo($this->getVariables(), $this->getResults(), $userdata[$resObj->getResult()]["value"], $userdata[$resObj->getResult()]["unit"], $this->getUnitrepository()->getUnits());
                    } else {
                        $found = $resObj->getResultInfo($this->getVariables(), $this->getResults(), $resObj->calculateFormula($this->getVariables(), $this->getResults(), parent::getId()), is_object($resObj->getUnit()) ? $resObj->getUnit()->getId() : null, $this->getUnitrepository()->getUnits());
                    }
                    $resulttext = "(";
                    if ($resObj->getRatingSimple()) {
                        if ($frac_helper) {
                            $resulttext .= "n/a";
                        } else {
                            $resulttext .= $found['points'] . " " . (($found['points'] == 1) ? $this->lng->txt('point') : $this->lng->txt('points'));
                        }
                    } else {
                        $resulttext .= $this->lng->txt("rated_sign") . " " . (($found['sign']) ? $found['sign'] : 0) . " " . (($found['sign'] == 1) ? $this->lng->txt('point') : $this->lng->txt('points')) . ", ";
                        $resulttext .= $this->lng->txt("rated_value") . " " . (($found['value']) ? $found['value'] : 0) . " " . (($found['value'] == 1) ? $this->lng->txt('point') : $this->lng->txt('points')) . ", ";
                        $resulttext .= $this->lng->txt("rated_unit") . " " . (($found['unit']) ? $found['unit'] : 0) . " " . (($found['unit'] == 1) ? $this->lng->txt('point') : $this->lng->txt('points'));
                    }
                    
                    $resulttext .= ")";
                    $template->setVariable("RESULT_OUTPUT", $resulttext);

                    $resultOutput = $template->get();
                }
                $text = preg_replace("/\\\$" . substr($result, 1) . "(?![0-9]+)/", $input . " " . $units . " " . $checkSign . " " . $resultOutput . " " . "\\1", $text);
            }
        }
        return $text;
    }

Here is the call graph for this function:

validateSolutionSubmit()

assFormulaQuestion::validateSolutionSubmit

(

)

Definition at line 1348 of file class.assFormulaQuestion.php.

References $key, getSolutionSubmit(), isValidSolutionResultValue(), and ilUtil\sendFailure().

    {
        foreach ($this->getSolutionSubmit() as $key => $value) {
            if (preg_match("/^result_(\\\$r\\d+)$/", $key)) {
                if (strlen($value) && !$this->isValidSolutionResultValue($value)) {
                    ilUtil::sendFailure($this->lng->txt("err_no_numeric_value"), true);
                    return false;
                }
            } elseif (preg_match("/^result_(\\\$r\\d+)_unit$/", $key)) {
                continue;
            }
        }
        
        return true;
    }

Here is the call graph for this function:

Field Documentation

$results

assFormulaQuestion::$results

private

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

Referenced by getResults().

$resultunits

assFormulaQuestion::$resultunits

private

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

Referenced by __get(), getResultUnits(), and hasResultUnit().

$unitrepository

assFormulaQuestion::$unitrepository

private

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

Referenced by getUnitrepository(), and setUnitrepository().

$variables

assFormulaQuestion::$variables

private

Definition at line 21 of file class.assFormulaQuestion.php.

Referenced by getVariables().

---

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

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