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

Inheritance diagram for assFormulaQuestion:

Collaboration diagram for assFormulaQuestion:

Public Member Functions
	__construct (string $title="", string $comment="", string $author="", int $owner=-1, string $question="")

	clearVariables ()

	getVariables ()

	getVariable ($variable)

	addVariable ($variable)

	clearResults ()

	getResults ()

	getResult ($result)

	addResult ($result)

	addResultUnits ($result, $unit_ids)

	addResultUnit ($result, $unit)

	getResultUnits (assFormulaQuestionResult $result)

	getAllResultUnits ()

	hasResultUnit ($result, $unit_id)

	parseQuestionText ()

	checkForDuplicateVariables ()

	checkForDuplicateResults ()

	fetchAllResults ($questionText)

	fetchAllVariables ($questionText)

	hasRequiredVariableSolutionValues (array $userSolution)

	getInitialVariableSolutionValues ()

	substituteVariables (array $userdata, bool $graphicalOutput=false, bool $forsolution=false, bool $result_output=false, array $correctness_icons=[])

	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 (bool $for_test=true, string $title="", string $author="", string $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 (int $activeId, int $pass)
	Lookup if an authorized or intermediate solution exists. More...

	removeExistingSolutions (int $activeId, int $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 (ilAssExcelFormatHelper $worksheet, int $startrow, int $active_id, int $pass)
	{} More...

	getBestSolution ($solutions)
	Returns the best solution for a given pass of a participant. More...

	setId ($id=-1)

	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 (string $title="", string $comment="", string $author="", int $owner=-1, string $question="")
	assQuestion constructor More...

	getShuffler ()

	setShuffler (Transformation $shuffler)

	setProcessLocker (ilAssQuestionProcessLocker $processLocker)

	getProcessLocker ()

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

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

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

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

	setTitle (string $title="")

	setId (int $id=-1)

	setTestId (int $id=-1)

	setComment (string $comment="")

	setOutputType (int $outputType=OUTPUT_HTML)

	setShuffle (?bool $shuffle=true)

	setAuthor (string $author="")

	setOwner (int $owner=-1)

	getTitle ()

	getTitleForHTMLOutput ()

	getTitleFilenameCompliant ()

	getId ()

	getShuffle ()

	getTestId ()

	getComment ()

	getDescriptionForHTMLOutput ()

	getThumbSize ()

	setThumbSize (int $a_size)

	getMinimumThumbSize ()

	getMaximumThumbSize ()

	getOutputType ()

	supportsJavascriptOutput ()

	supportsNonJsOutput ()

	requiresJsSwitch ()

	getAuthor ()

	getAuthorForHTMLOutput ()

	getOwner ()

	getObjId ()

	setObjId (int $obj_id=0)

	getLifecycle ()

	setLifecycle (ilAssQuestionLifecycle $lifecycle)

	setExternalId (?string $external_id)

	getExternalId ()

	getSuggestedSolutionOutput ()

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

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

	getSuggestedSolutions ()

	getReachedPoints (int $active_id, int $pass)

	getMaximumPoints ()

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

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

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

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

	validateSolutionSubmit ()

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

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

	getSuggestedSolutionPath ()

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

	buildImagePath ($questionId, $parentObjectId)

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

	getSuggestedSolutionPathWeb ()

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

	getTestOutputSolutions (int $activeId, int $pass)

	getUserSolutionPreferingIntermediate (int $active_id, $pass=null)

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

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

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

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

	getAdditionalTableName ()

	getAnswerTableName ()

	deleteAnswers (int $question_id)

	deleteAdditionalTableData (int $question_id)

	delete (int $question_id)

	getTotalAnswers ()

	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)

	syncXHTMLMediaObjectsOfQuestion ()

	createPageObject ()

	copyPageOfQuestion (int $a_q_id)

	getPageOfQuestion ()

	setOriginalId (?int $original_id)

	getOriginalId ()

	fixSvgToPng (string $imageFilenameContainingString)

	fixUnavailableSkinImageSources (string $html)

	loadFromDb (int $question_id)

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

	saveQuestionDataToDb (int $original_id=-1)

	saveToDb ()

	setNewOriginalId (int $newId)

	deleteSuggestedSolutions ()

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

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

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

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

	_resolveInternalLink (string $internal_link)

	_resolveIntLinks (int $question_id)

	syncWithOriginal ()

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

	_questionExistsInPool (int $question_id)

	getPoints ()

	setPoints (float $points)

	getSolutionMaxPass (int $active_id)

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

	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $previewSession, $reachedPoints)

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)

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

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

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

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

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

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

	getQuestion ()

	getQuestionForHTMLOutput ()

	setQuestion (string $question="")

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

	getQuestionTypeID ()

	syncHints ()

	cleanupMediaObjectUsage ()

	getInstances ()

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

	hasSpecificFeedback ()

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

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

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

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

	getNrOfTries ()

	setNrOfTries (int $a_nr_of_tries)

	setExportImagePath (string $path)

	formatSAQuestion ($a_q)

	setPreventRteUsage (bool $prevent_rte_usage)

	getPreventRteUsage ()

	migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)

	setSelfAssessmentEditingMode (bool $selfassessmenteditingmode)

	getSelfAssessmentEditingMode ()

	setDefaultNrOfTries (int $defaultnroftries)

	getDefaultNrOfTries ()

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

	ensureHintPageObjectExists ($pageObjectId)

	isAnswered (int $active_id, int $pass)

	isAutosaveable ()

	getAdditionalContentEditingMode ()

	setAdditionalContentEditingMode (?string $additionalContentEditingMode)

	isAdditionalContentEditingModePageObject ()

	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)

	getValidAdditionalContentEditingModes ()

	getHtmlUserSolutionPurifier ()

	getHtmlQuestionContentPurifier ()

	setLastChange ($lastChange)

	getLastChange ()

	removeIntermediateSolution (int $active_id, int $pass)

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

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

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

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

	setStep ($step)

	getStep ()

	toJSON ()

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

	intermediateSolutionExists (int $active_id, int $pass)

	authorizedSolutionExists (int $active_id, ?int $pass)

	authorizedOrIntermediateSolutionExists (int $active_id, int $pass)

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

	isAddableAnswerOptionValue (int $qIndex, string $answerOptionValue)

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

	removeAllExistingSolutions ()

	removeExistingSolutions (int $activeId, int $pass)

	resetUsersAnswer (int $activeId, int $pass)

	removeResultRecord (int $activeId, int $pass)

	fetchValuePairsFromIndexedValues (array $indexedValues)

	fetchIndexedValuesFromValuePairs (array $valuePairs)

	areObligationsToBeConsidered ()

	setObligationsToBeConsidered (bool $obligationsToBeConsidered)

	updateTimestamp ()

	getTestPresentationConfig ()

	savePartial ()

	isInActiveTest ()

Public Member Functions inherited from iQuestionCondition
	getUserQuestionResult ($active_id, $pass)
	Get the user solution for a question by active_id and the test pass. More...

Protected Member Functions
	generateResultInputHTML (string $result_key, string $result_value, bool $forsolution)

	isValidSolutionResultValue ($submittedValue)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	getSolutionSubmit ()

Protected Member Functions inherited from assQuestion
	getQuestionAction ()

	isNonEmptyItemListPostSubmission (string $postSubmissionFieldname)

	ensureCurrentTestPass (int $active_id, int $pass)

	lookupCurrentTestPass (int $active_id, int $pass)

	lookupTestId (int $active_id)
	Move to ilObjTest or similar More...

	log (int $active_id, string $langVar)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	deletePageOfQuestion (int $question_id)

	onDuplicate (int $originalParentId, int $originalQuestionId, int $duplicateParentId, int $duplicateQuestionId)

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

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

	onCopy (int $sourceParentId, int $sourceQuestionId, int $targetParentId, int $targetQuestionId)

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

	syncSuggestedSolutionFiles (int $target_question_id, int $target_obj_id)

	copySuggestedSolutionFiles (int $source_questionpool_id, int $source_question_id)

	ensureNonNegativePoints ($points)

	purifyAndPrepareTextAreaOutput (string $content)

	getRTETextWithMediaObjects ()

	getSelfAssessmentFormatter ()

	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	duplicateQuestionHints (int $originalQuestionId, int $duplicateQuestionId)

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

	buildQuestionDataQuery ()

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

	removeSolutionRecordById (int $solutionId)

	getSolutionRecordById (int $solutionId)

	deleteDummySolutionRecord (int $activeId, int $passIndex)

	isDummySolutionRecord (array $solutionRecord)

	deleteSolutionRecordByValues (int $activeId, int $passIndex, bool $authorized, array $matchValues)

	duplicateIntermediateSolutionAuthorized (int $activeId, int $passIndex)

	forceExistingIntermediateSolution (int $activeId, int $passIndex, bool $considerDummyRecordCreation)

	lookupMaxStep (int $active_id, int $pass)

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

Private Attributes
array	$variables

array	$results

array	$resultunits

ilUnitConfigurationRepository	$unitrepository

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

static	isForcePassResultUpdateEnabled ()

static	isAllowedImageMimeType ($mimeType)

static	fetchMimeTypeIdentifier (string $contentType)

static	getAllowedFileExtensionsForMimeType (string $mimeType)

static	isAllowedImageFileExtension (string $mimeType, string $fileExtension)

static	getAllowedImageMaterialFileExtensions ()

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

static	_getQuestionInfo (int $question_id)

static	_getSuggestedSolutionCount (int $question_id)

static	_getSuggestedSolutionOutput (int $question_id)

static	_getReachedPoints (int $active_id, int $question_id, int $pass)

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

static	logAction (string $logtext, int $active_id, int $question_id)

static	getQuestionTypeFromDb (int $question_id)

static	_getTotalRightAnswers (int $a_q_id)

static	_getTitle (int $a_q_id)

static	_getQuestionText (int $a_q_id)

static	isFileAvailable (string $file)

static	_getQuestionType (int $question_id)

static	_getQuestionTitle (int $question_id)

static	saveOriginalId (int $questionId, int $originalId)

static	resetOriginalId (int $questionId)

static	_getInternalLinkHref (string $target="")

static	_getOriginalId (int $question_id)

static	originalQuestionExists (int $questionId)

static	_instanciateQuestion (int $question_id)

static	_instantiateQuestion (int $question_id)

static	instantiateQuestion (int $question_id)

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

static	_isWriteable (int $question_id, int $user_id)

static	_isUsedInRandomTest (int $question_id)

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

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

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

static	_needsManualScoring (int $question_id)

static	_includeClass (string $question_type, int $gui=0)

static	getFeedbackClassNameByQuestionType (string $questionType)

static	isCoreQuestionType (string $questionType)

static	includeCoreClass ($questionType, $withGuiClass)

static	_getQuestionTypeName ($type_tag)

static	_instanciateQuestionGUI (int $question_id)

static	instantiateQuestionGUI (int $a_question_id)

static	_questionExistsInTest (int $question_id, int $test_id)

static	lookupParentObjId (int $questionId)

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

static	isObligationPossible (int $questionId)

static	implodeKeyValues (array $keyValues)

static	explodeKeyValues (string $keyValues)

static	convertISO8601FormatH_i_s_ExtendedToSeconds (string $time)

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

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

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

static	extendedTrim (string $value)
	Trim non-printable characters from the beginning and end of a string. More...

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

const	IMG_MIME_TYPE_PNG = 'image/png'

const	IMG_MIME_TYPE_GIF = 'image/gif'

const	TRIM_PATTERN = '/^[\p{C}\p{Z}]+\|[\p{C}\p{Z}]+$/u'

const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'

const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'

ilAssQuestionFeedback	$feedbackOBJ

bool	$prevent_rte_usage = false

bool	$selfassessmenteditingmode = false

int	$defaultnroftries = 0

string	$questionActionCmd = 'handleQuestionAction'

const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'

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 (int $activeId, int $pass, int $questionId)

Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ILIAS DI LoggingServices	$ilLog

int	$id

string	$title

string	$comment

string	$owner

string	$author

int	$thumb_size

string	$question
	The question text. More...

float	$points
	The maximum available points for the question. More...

bool	$shuffle
	Indicates whether the answers will be shuffled or not. More...

int	$test_id
	The database id of a test in which the question is contained. More...

int	$obj_id = 0
	Object id of the container object. More...

	$ilias

ilGlobalPageTemplate	$tpl

ilLanguage	$lng

ilDBInterface	$db

Container	$dic

int	$outputType = OUTPUT_JAVASCRIPT
	Contains the output type of a question. More...

array	$suggested_solutions

int	$original_id = null

	$page

string	$external_id = null

ilAssQuestionProcessLocker	$processLocker

	$step

	$lastChange

Transformation	$shuffler

ilTestQuestionConfig	$testQuestionConfig

ilAssQuestionLifecycle	$lifecycle

ilObjUser	$current_user

Static Protected Attributes inherited from assQuestion
static	$allowedFileExtensionsByMimeType

static	$allowedCharsetsByMimeType

static	$allowedImageMaterialFileExtensionsByMimeType

static	$forcePassResultsUpdateEnabled = false

static	$imageSourceFixReplaceMap

Detailed Description

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

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class for 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 28 of file class.assFormulaQuestion.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addResult()

assFormulaQuestion::addResult ( $result )

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

Referenced by loadFromDb(), and parseQuestionText().

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

Here is the caller graph for this function:

◆ addResultUnit()

assFormulaQuestion::addResultUnit	(	$result,
		$unit
	)

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

References $resultunits.

Referenced by loadFromDb().

                                                  : void
     {
         if (is_object($result) && is_object($unit)) {
             if (!array_key_exists($result->getResult(), $this->resultunits) ||
                 !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 95 of file class.assFormulaQuestion.php.

References assQuestion\$id, and getUnitrepository().

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

Referenced by loadFromDb(), and parseQuestionText().

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

References assQuestion\$points, 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 898 of file class.assFormulaQuestion.php.

References assQuestion\$points, 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 485 of file class.assFormulaQuestion.php.

References getResultUnits().

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

References assQuestion\getQuestion().

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

References assQuestion\getQuestion().

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

Referenced by parseQuestionText().

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

Here is the caller graph for this function:

◆ clearVariables()

assFormulaQuestion::clearVariables ( )

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

Referenced by parseQuestionText().

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

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

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

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

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

References $DIC, and $ilDB.

                                                : void
     {
         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	(	bool	$for_test = `true`,
		string	$title = `""`,
		string	$author = `""`,
		string	$owner = `""`,
			$testObjId = `null`
	)

Duplicates an assFormulaQuestion public.

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

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

                                                                                                                                     : int
     {
         if ($this->id <= 0) {
             // The question has not been saved. It cannot be duplicated
             return -1;
         }
         // duplicate the question in database
         $this_id = $this->getId();
         $thisObjId = $this->getObjId();
 
         $clone = $this;
         include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
         $original_id = assQuestion::_getOriginalId($this->id);
         $clone->id = -1;
 
         if ((int) $testObjId > 0) {
             $clone->setObjId($testObjId);
         }
 
         if ($title) {
             $clone->setTitle($title);
         }
 
         if ($author) {
             $clone->setAuthor($author);
         }
         if ($owner) {
             $clone->setOwner($owner);
         }
 
         if ($for_test) {
             $clone->saveToDb($original_id);
         } else {
             $clone->saveToDb();
         }
 
         $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 193 of file class.assFormulaQuestion.php.

References getResult().

Referenced by getInitialVariableSolutionValues().

                                                   : array
     {
         $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 211 of file class.assFormulaQuestion.php.

References getVariable().

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

                                                     : array
     {
         $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:

◆ generateResultInputHTML()

assFormulaQuestion::generateResultInputHTML	(	string	$result_key,
		string	$result_value,
		bool	$forsolution
	)

protected

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

References ilLegacyFormElementsUtil\prepareFormOutput().

Referenced by substituteVariables().

                                                                                                            : string
     {
         if ($forsolution) {
             return  '<span class="ilc_qinput_TextInput solutionbox">'
                 . ilLegacyFormElementsUtil::prepareFormOutput($result_value)
                 . '</span>';
         }
         $input = '<input class="ilc_qinput_TextInput" type="text"';
         $input .= 'spellcheck="false" autocomplete="off" autocorrect="off" autocapitalize="off"';
         $input .= 'name="result_' . $result_key . '"';
         $input .= ' value="' . $result_value . '"/>';
         return $input;
     }

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

                                             : string
     {
         return "";
     }

◆ getAllResultUnits()

assFormulaQuestion::getAllResultUnits ( )

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

References $resultunits.

                                        : array
     {
         return $this->resultunits;
     }

◆ getAnswerTableName()

assFormulaQuestion::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns: string The answer table name

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

                                         : string
     {
         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 1468 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 1246 of file class.assFormulaQuestion.php.

References ilMath\_div(), assFormulaQuestionResult\convertDecimalToCoprimeFraction(), ILIAS\Survey\Mode\getId(), getResults(), getVariable(), getVariables(), assFormulaQuestionUnit\lookupUnitFactor(), assFormulaQuestionResult\RESULT_CO_FRAC, and assFormulaQuestionResult\RESULT_FRAC.

                                                : array
     {
         $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();
 
                 $check_unit = false;
                 if (array_key_exists($result_name, $available_units) &&
                     $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 1406 of file class.assFormulaQuestion.php.

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

                                         : array
     {
         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 247 of file class.assFormulaQuestion.php.

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

                                                       : array
     {
         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 841 of file class.assFormulaQuestion.php.

References assQuestion\$points.

Referenced by getExpressionTypes(), and isComplete().

                                       : float
     {
         $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 1397 of file class.assFormulaQuestion.php.

References ilOperatorsExpressionMapping\getOperatorsByExpression().

                                              : array
     {
         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 1134 of file class.assFormulaQuestion.php.

                                      : string
     {
         return "assFormulaQuestion";
     }

◆ getResult()

assFormulaQuestion::getResult ( $result )

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

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

References $results.

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

                                 : array
     {
         return $this->results;
     }

Here is the caller graph for this function:

◆ getResultUnits()

assFormulaQuestion::getResultUnits ( assFormulaQuestionResult $result )

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

References Vendor\Package\$a, Vendor\Package\$b, assFormulaQuestionResult\getResult(), and assFormulaQuestionUnit\getSequence().

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

                                                                     : array
     {
         if (!isset($this->resultunits[$result->getResult()])) {
             return [];
         }
 
         $result_units = $this->resultunits[$result->getResult()];
 
         usort($result_units, static function (assFormulaQuestionUnit $a, assFormulaQuestionUnit $b) {
             return $a->getSequence() <=> $b->getSequence();
         });
 
         return $result_units;
     }

Here is the call graph for this function:

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

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

◆ getSolutionSubmit()

assFormulaQuestion::getSolutionSubmit ( )

protected

Returns: array

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

References Vendor\Package\$a, $index, ILIAS\LTI\ToolProvider\$key, $post, and getResults().

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

                                           : array
     {
         $solutionSubmit = [];
 
         $post = $this->dic->http()->wrapper()->post();
 
         foreach ($this->getResults() as $index => $a) {
             $key = "result_$index";
             if ($post->has($key)) {
                 $value = $post->retrieve(
                     $key,
                     $this->dic->refinery()->kindlyTo()->string()
                 );
 
                 $solutionSubmit[$key] = $value;
             }
             if ($post->has($key . "_unit")) {
                 $value = $post->retrieve(
                     $key . "_unit",
                     $this->dic->refinery()->kindlyTo()->string()
                 );
                 $solutionSubmit[$key . "_unit"] = $value;
             }
         }
         return $solutionSubmit;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUnitrepository()

assFormulaQuestion::getUnitrepository ( )

Returns

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

References $unitrepository.

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

                                        : ilUnitConfigurationRepository
     {
         return $this->unitrepository;
     }

Here is the caller graph for this function:

◆ getVariable()

assFormulaQuestion::getVariable ( $variable )

Definition at line 59 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 54 of file class.assFormulaQuestion.php.

References $variables.

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

                                   : array
     {
         return $this->variables;
     }

Here is the caller graph for this function:

◆ hasRequiredVariableSolutionValues()

assFormulaQuestion::hasRequiredVariableSolutionValues ( array $userSolution )

Parameters

array $userSolution

Returns: bool

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

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

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

References $resultunits.

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

References getMaximumPoints().

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

Referenced by validateSolutionSubmit().

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

References $data, $DIC, Vendor\Package\$e, $ilDB, ilRTE\_replaceMediaObjectImageSrc(), addResult(), addResultUnit(), addVariable(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), getResult(), getUnitrepository(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), setId(), assQuestion\setLifecycle(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), and assQuestion\setTitle().

                                             : void
     {
         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((string) $data["title"]);
             $this->setComment((string) $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->setLifecycle(ilAssQuestionLifecycle::getInstance($data['lifecycle']));
             } catch (ilTestQuestionPoolInvalidArgumentException $e) {
                 $this->setLifecycle(ilAssQuestionLifecycle::getDraftInstance());
             }
 
             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((string) $data["question_text"], 1));
 
             // 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	(	int	$activeId,
		int	$pass
	)

Lookup if an authorized or intermediate solution exists.

Parameters

int	$activeId
int	$pass

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

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

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

                                                                         : array
     {
         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 150 of file class.assFormulaQuestion.php.

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

                                        : void
     {
         $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	(	int	$activeId,
		int	$pass
	)

Remove an existing solution without removing the variables.

Parameters

int	$activeId
int	$pass

Returns: int

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

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

                                                                      : int
     {
         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 1113 of file class.assFormulaQuestion.php.

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

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

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

                                                : void
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         if ($original_id == "") {
             $this->saveQuestionDataToDb();
         } else {
             $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 943 of file class.assFormulaQuestion.php.

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

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

{}

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

References $i, ilExcel\getColumnCoord(), assQuestion\getSolutionValues(), getUnitrepository(), getVariable(), ilExcel\setBold(), and ilAssExcelFormatHelper\setCell().

                                                                                                                     : int
     {
         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, 2, $unit->getUnit());
                 }
             } else {
                 $worksheet->setCell($startrow + $i, 2, $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, 3, $var->getUnit()->getUnit());
                 }
             }
             $i++;
         }
 
         return $startrow + $i + 1;
     }

Here is the call graph for this function:

◆ setId()

assFormulaQuestion::setId ( $id = -1 )

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

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

Referenced by loadFromDb().

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

References $unitrepository.

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

◆ substituteVariables()

assFormulaQuestion::substituteVariables	(	array	$userdata,
		bool	$graphicalOutput = `false`,
		bool	$forsolution = `false`,
		bool	$result_output = `false`,
		array	$correctness_icons = `[]`
	)

Parameters

int[]	$selections
string[]	$correctness_icons

Returns: bool|mixed|string

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

References assFormulaQuestionResult\convertDecimalToCoprimeFraction(), fetchAllVariables(), generateResultInputHTML(), ILIAS\Survey\Mode\getId(), assQuestion\getQuestion(), getResult(), getResults(), getResultUnits(), getUnitrepository(), getVariables(), ILIAS\Repository\lng(), assQuestion\purifyAndPrepareTextAreaOutput(), 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);
         }
 
         $text = $this->purifyAndPrepareTextAreaOutput($text);
 
         if (preg_match_all("/(\\\$r\\d+)/ims", $this->getQuestion(), $rmatches)) {
             foreach ($rmatches[1] as $result) {
                 $resObj = $this->getResult($result);
                 $value = "";
                 $frac_helper = '';
                 $userdata[$result]['result_type'] = $resObj->getResultType();
                 $is_frac = false;
                 if (
                     $resObj->getResultType() == assFormulaQuestionResult::RESULT_FRAC ||
                     $resObj->getResultType() == assFormulaQuestionResult::RESULT_CO_FRAC
                 ) {
                     $is_frac = true;
                 }
                 if (is_array($userdata) &&
                     isset($userdata[$result]) &&
                     isset($userdata[$result]["value"])) {
 
                     $input = $this->generateResultInputHTML($result, $userdata[$result]["value"], $forsolution);
                 } elseif ($forsolution) {
                     $value = '';
                     if (!is_array($userdata)) {
                         $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];
                         }
                     }
 
                     $input = $this->generateResultInputHTML($result, $value, true);
                 } else {
                     $input = $this->generateResultInputHTML($result, '', false);
                 }
 
                 $units = "";
                 $result_units = $this->getResultUnits($resObj);
                 if (count($result_units) > 0) {
                     if ($forsolution) {
                         if (is_array($userdata)) {
                             foreach ($result_units as $unit) {
                                 if (isset($userdata[$result]["unit"]) && $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 ($result_units as $unit) {
                             $units .= '<option value="' . $unit->getId() . '"';
                             if (array_key_exists($result, $userdata) &&
                                 is_array($userdata[$result]) &&
                                 array_key_exists('unit', $userdata[$result])) {
                                 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 ($frac_helper !== '') {
                             $units .= ' &asymp; ' . $frac_helper . ', ';
                         } elseif (is_array($userdata) &&
                             array_key_exists($result, $userdata) &&
                             array_key_exists('frac_helper', $userdata[$result]) &&
                             is_string($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 ($frac_helper !== '') {
                             $units .= ' &asymp; ' . $frac_helper . ', ';
                         } elseif (is_array($userdata) && isset($userdata[$result]) && isset($userdata[$result]["frac_helper"]) && $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) &&
                         array_key_exists($result, $userdata) &&
                         is_array($userdata[$result])) {
                         if (array_key_exists('unit', $userdata[$result]) && $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');
 
                     $correctness_icon = $correctness_icons['not_correct'];
                     if ($resObj->isCorrect($this->getVariables(), $this->getResults(), $user_value, $resunit)) {
                         $correctness_icon = $correctness_icons['correct'];
                     }
                     $template->setCurrentBlock("icon_ok");
                     $template->setVariable("ICON_OK", $correctness_icon);
                     $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) &&
                         array_key_exists($resObj->getResult(), $userdata) &&
                         array_key_exists('value', $userdata[$resObj->getResult()])) {
                         $found = $resObj->getResultInfo(
                             $this->getVariables(),
                             $this->getResults(),
                             $userdata[$resObj->getResult()]["value"],
                             $userdata[$resObj->getResult()]["unit"] ?? null,
                             $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 1373 of file class.assFormulaQuestion.php.

References ILIAS\LTI\ToolProvider\$key, getSolutionSubmit(), isValidSolutionResultValue(), and ILIAS\Repository\lng().

                                             : bool
     {
         foreach ($this->getSolutionSubmit() as $key => $value) {
             if ($value && !$this->isValidSolutionResultValue($value)) {
                 $this->tpl->setOnScreenMessage(
                     'failure',
                     $this->lng->txt("err_no_numeric_value"),
                     true
                 );
                 return false;
             }
         }
 
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $results

array assFormulaQuestion::$results

private

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

Referenced by getResults().

◆ $resultunits

array assFormulaQuestion::$resultunits

private

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

Referenced by addResultUnit(), getAllResultUnits(), and hasResultUnit().

◆ $unitrepository

ilUnitConfigurationRepository assFormulaQuestion::$unitrepository

private

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

Referenced by getUnitrepository(), and setUnitrepository().

◆ $variables

array assFormulaQuestion::$variables

private

Definition at line 30 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

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addResult()

◆ addResultUnit()

◆ addResultUnits()

◆ addVariable()

◆ calculateReachedPoints()

◆ calculateReachedPointsFromPreviewSession()

◆ canUseAdvancedRating()

◆ checkForDuplicateResults()

◆ checkForDuplicateVariables()

◆ clearResults()

◆ clearVariables()

◆ copyObject()

◆ createNewOriginalFromThisDuplicate()

◆ deleteAnswers()

◆ duplicate()

◆ fetchAllResults()

◆ fetchAllVariables()

◆ generateResultInputHTML()

◆ getAdditionalTableName()

◆ getAllResultUnits()

◆ getAnswerTableName()

◆ getAvailableAnswerOptions()

◆ getBestSolution()

◆ getExpressionTypes()

◆ getInitialVariableSolutionValues()

◆ getMaximumPoints()

◆ getOperators()

◆ getQuestionType()

◆ getResult()

◆ getResults()

◆ getResultUnits()

◆ getRTETextWithMediaObjects()

◆ getSolutionSubmit()

◆ getUnitrepository()

◆ getVariable()

◆ getVariables()

◆ hasRequiredVariableSolutionValues()

◆ hasResultUnit()

◆ isComplete()

◆ isValidSolutionResultValue()

◆ loadFromDb()

◆ lookupForExistingSolutions()

◆ parseQuestionText()

◆ removeExistingSolutions()

◆ savePreviewData()

◆ saveToDb()

◆ saveWorkingData()

◆ setExportDetailsXLS()

◆ setId()

◆ setUnitrepository()

◆ substituteVariables()

◆ validateSolutionSubmit()

Field Documentation

◆ $results

◆ $resultunits

◆ $unitrepository

◆ $variables