assFormulaQuestion Class Reference

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

Inheritance diagram for assFormulaQuestion:

Collaboration diagram for assFormulaQuestion:

Public Member Functions
	__construct (string $title="", string $comment="", string $author="", int $owner=-1, string $question="")
	clearVariables ()
	getVariables ()
	getVariable (string $variable)
	addVariable (assFormulaQuestionVariable $variable)
	clearResults ()
	getResults ()
	getResult (string $result)
	addResult (assFormulaQuestionResult $result)
	addResultUnits (?assFormulaQuestionResult $result, ?array $unit_ids)
	addResultUnit (?assFormulaQuestionResult $result, ?assFormulaQuestionUnit $unit)
	getResultUnits (assFormulaQuestionResult $result)
	getAllResultUnits ()
	hasResultUnit (assFormulaQuestionResult $result, int $unit_id)
	parseQuestionText ()
	checkForDuplicateVariables ()
	checkForDuplicateResults ()
	fetchAllResults ($questionText)
	fetchAllVariables (string $question_text)
	hasRequiredVariableSolutionValues (array $userSolution)
	getVariableSolutionValuesForPass (int $active_id, int $pass)
	getInitialVariableSolutionValues ()
	saveCurrentSolution (int $active_id, int $pass, $value1, $value2, bool $authorized=true, $tstamp=0)
	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 (?int $original_id=null)
	loadFromDb (int $question_id)
	getMaximumPoints ()
	Returns the maximum points, a learner can reach answering the question. More...
	calculateReachedPoints (int $active_id, ?int $pass=null, bool $authorized_solution=true)
	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)
	saveWorkingData (int $active_id, ?int $pass=null, bool $authorized=true)
	lookupForExistingSolutions (int $active_id, int $pass)
	removeExistingSolutions (int $active_id, int $pass)
	getQuestionType ()
	getAdditionalTableName ()
	getAnswerTableName ()
	deleteAnswers (int $question_id)
	getRTETextWithMediaObjects ()
	getBestSolution (array $solutions)
	setId (int $id=-1)
	setUnitrepository (\ilUnitConfigurationRepository $unitrepository)
	getUnitrepository ()
	validateSolutionSubmit ()
	getOperators (string $expression)
	Get all available operations for a specific question. More...
	getExpressionTypes ()
	Get all available expression types for a specific question. More...
	getUserQuestionResult (int $active_id, int $pass)
	Get the user solution for a question by active_id and the test pass. More...
	getAvailableAnswerOptions ($index=null)
	If index is null, the function returns an array with all anwser options Else it returns the specific answer option. More...
	toLog (AdditionalInformationGenerator $additional_info)
	solutionValuesToText (array $solution_values)
	getCorrectSolutionForTextOutput (int $active_id, int $pass)
	getVariablesAsTextArray (int $active_id, int $pass)
Public Member Functions inherited from assQuestion
	getQuestionType ()
	isComplete ()
	saveWorkingData (int $active_id, ?int $pass=null, bool $authorized=true)
	calculateReachedPoints (int $active_id, ?int $pass=null, bool $authorized_solution=true)
	getAdditionalTableName ()
	getAnswerTableName ()
	toLog (AdditionalInformationGenerator $additional_info)
	MUST return an array of the question settings that can be stored in the log. More...
	getCurrentUser ()
	getShuffler ()
	setShuffler (Transformation $shuffler)
	setProcessLocker (ilAssQuestionProcessLocker $processLocker)
	getProcessLocker ()
	fromXML (string $importdirectory, int $user_id, ilQTIItem $item, int $questionpool_id, ?int $tst_id, ?ilObject &$tst_object, int &$question_counter, array $import_mapping, array $solutionhints=[])
	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...
	setTitle (string $title="")
	setId (int $id=-1)
	setTestId (int $id=-1)
	setComment (string $comment="")
	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 ()
	getAuthor ()
	getAuthorForHTMLOutput ()
	getOwner ()
	getObjId ()
	setObjId (int $obj_id=0)
	getLifecycle ()
	setLifecycle (ilAssQuestionLifecycle $lifecycle)
	setExternalId (?string $external_id)
	getExternalId ()
	getSuggestedSolutionOutput ()
	getSuggestedSolutions ()
	getReachedPoints (int $active_id, int $pass)
	getMaximumPoints ()
	getAdjustedReachedPoints (int $active_id, int $pass, bool $authorized_solution=true)
	calculateResultsFromSolution (int $active_id, int $pass)
	Calculates the question results from a previously saved question solution. More...
	persistWorkingState (int $active_id, $pass, bool $authorized=true)
	persists the working state for current testactive and testpass More...
	persistPreviewState (ilAssQuestionPreviewSession $preview_session)
	persists the preview state for current user and question More...
	validateSolutionSubmit ()
	getSuggestedSolutionPath ()
	getImagePath ($question_id=null, $object_id=null)
	Returns the image path for web accessable images 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, ?int $pass=null)
	getSolutionValues (int $active_id, ?int $pass=null, bool $authorized=true)
	Loads solutions of a given user from the database an returns it. More...
	deleteAnswers (int $question_id)
	deleteAdditionalTableData (int $question_id)
	delete (int $question_id)
	getTotalAnswers ()
	cloneXHTMLMediaObjectsOfQuestion (int $source_question_id)
	createPageObject ()
	clonePageOfQuestion (int $a_q_id)
	getPageOfQuestion ()
	setOriginalId (?int $original_id)
	getOriginalId ()
static	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=null)
	duplicate (bool $for_test=true, string $title='', string $author='', int $owner=-1, $test_obj_id=null)
	copyObject (int $target_parent_id, string $title='')
	createNewOriginalFromThisDuplicate (int $target_parent_id, string $target_question_title='')
	saveToDb (?int $original_id=null)
	deleteSuggestedSolutions ()
	getSuggestedSolution (int $subquestion_index=0)
	resolveInternalLink (string $internal_link)
	resolveSuggestedSolutionLinks ()
	getInternalLinkHref (string $target)
	syncWithOriginal ()
	getPoints ()
	setPoints (float $points)
	getSolutionMaxPass (int $active_id)
	isWriteable ()
	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $preview_session, $reached_points)
	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $preview_session)
	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $preview_session)
	adjustReachedPointsByScoringOptions (float $points, int $active_id)
	Adjust the given reached points by checks for all special scoring options in the test container. More...
	buildHashedImageFilename (string $plain_image_filename, bool $unique=false)
	getQuestion ()
	getQuestionForHTMLOutput ()
	setQuestion (string $question="")
	getQuestionTypeID ()
	cloneHints (int $source_question_id, int $target_question_id)
	cleanupMediaObjectUsage ()
	getInstances ()
	getActiveUserData (int $active_id)
	Returns the user id and the test id for a given active id. More...
	hasSpecificFeedback ()
	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)
	getAdditionalContentEditingMode ()
	setAdditionalContentEditingMode (?string $additionalContentEditingMode)
	isAdditionalContentEditingModePageObject ()
	isValidAdditionalContentEditingMode (string $additionalContentEditingMode)
	getValidAdditionalContentEditingModes ()
	getHtmlUserSolutionPurifier ()
	getHtmlQuestionContentPurifier ()
	setLastChange (int $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 ()
	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 $value_pairs)
	updateTimestamp ()
	getTestPresentationConfig ()
	hasWritableOriginalInQuestionPool ()
	answerToParticipantInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, int $active_id, int $pass, string $source_ip, TestParticipantInteractionTypes $interaction_type)
	toQuestionAdministrationInteraction (AdditionalInformationGenerator $additional_info, int $test_ref_id, TestQuestionAdministrationInteractionTypes $interaction_type)
	getSolutionForTextOutput (int $active_id, int $pass)
	getCorrectSolutionForTextOutput (int $active_id, int $pass)
	getVariablesAsTextArray (int $active_id, int $pass)
Public Member Functions inherited from iQuestionCondition
	getAvailableAnswerOptions (?int $index=null)
	If index is null, the function returns an array with all anwser options else it returns the specific answer option. More...

Protected Member Functions
	generateResultInputHTML (string $result_key, string $result_value, bool $forsolution)
	cloneQuestionTypeSpecificProperties (\assQuestion $target)
	isValidSolutionResultValue (string $submittedValue)
	savePreviewData (ilAssQuestionPreviewSession $previewSession)
	getSolutionSubmit ()
	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)
Protected Member Functions inherited from assQuestion
	solutionValuesToLog (AdditionalInformationGenerator $additional_info, array $solution_values)
	MUST convert the given solution values into an array or a string that can be stored in the log. More...
	solutionValuesToText (array $solution_values)
	MUST convert the given solution values into text. More...
	getQuestionAction ()
	isNonEmptyItemListPostSubmission (string $post_submission_field_name)
	savePreviewData (ilAssQuestionPreviewSession $preview_session)
	deletePageOfQuestion (int $question_id)
	cloneQuestionTypeSpecificProperties (self $target)
	removeAllImageFiles (string $image_target_path)
	onDuplicate (int $original_parent_id, int $original_question_id, int $duplicate_parent_id, int $duplicate_question_id)
	afterSyncWithOriginal (int $original_question_id, int $clone_question_id, int $original_parent_id, int $clone_parent_id)
	onCopy (int $sourceParentId, int $sourceQuestionId, int $targetParentId, int $targetQuestionId)
	duplicateComments (int $parent_source_id, int $source_id, int $parent_target_id, int $target_id)
	deleteComments ()
	getNotesManager ()
	getNotesDataService ()
	getNotesRepo ()
	cloneSuggestedSolutions (int $source_question_id, int $target_question_id)
	duplicateSuggestedSolutionFiles (int $parent_id, int $question_id)
	Duplicates the files of a suggested solution if the question is duplicated. More...
	cloneSuggestedSolutionFiles (int $source_question_id, int $target_question_id)
	copySuggestedSolutions (int $target_question_id)
	ensureNonNegativePoints (float $points)
	purifyAndPrepareTextAreaOutput (string $content)
	getRTETextWithMediaObjects ()
	getSelfAssessmentFormatter ()
	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)
	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)
	duplicateQuestionHints (int $original_question_id, int $duplicate_question_id)
	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 ()
	getSuggestedSolutionsRepo ()
	loadSuggestedSolutions ()
	answerToLog (AdditionalInformationGenerator $additional_info, int $active_id, int $pass)

Protected Attributes
PassPresentedVariablesRepo	$pass_presented_variables_repo
Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true
GeneralQuestionPropertiesRepository	$questionrepository
RequestDataCollector	$questionpool_request
QuestionFiles	$question_files
ilAssQuestionProcessLocker	$processLocker
ilTestQuestionConfig	$testQuestionConfig
SuggestedSolutionsDatabaseRepository	$suggestedsolution_repo
ILIAS	$ilias
ilGlobalPageTemplate	$tpl
ilLanguage	$lng
ilDBInterface	$db
ilObjUser	$current_user
SkillUsageService	$skillUsageService
HTTPServices	$http
Refinery	$refinery
Transformation	$shuffler
LoggingServices	$log
Container	$dic
ilAssQuestionLifecycle	$lifecycle
ilAssQuestionPage	$page
int	$id
string	$title
string	$comment
int	$owner
string	$author
int	$thumb_size
string	$question
float	$points = 0.0
bool	$shuffle = true
int	$test_id
int	$obj_id = 0
int	$original_id = null
int	$lastChange = null
string	$external_id = null
int	$step = null
array	$suggested_solutions

Private Member Functions
	buildVariablesForLog (array $variables, string $none_tag)
	buildResultsForLog (array $results, string $none_tag)

Private Attributes
array	$variables
array	$results
array	$resultunits
ilUnitConfigurationRepository	$unitrepository

Additional Inherited Members
Static Public Member Functions inherited from assQuestion
static	setForcePassResultUpdateEnabled (bool $force_pass_results_update_enabled)
static	isForcePassResultUpdateEnabled ()
static	_getSuggestedSolutionOutput (int $question_id)
static	_getReachedPoints (int $active_id, int $question_id, int $pass)
static	isFileAvailable (string $file)
static	saveOriginalId (int $questionId, int $originalId)
static	resetOriginalId (int $questionId)
static	instantiateQuestion (int $question_id)
static	_getSolutionMaxPass (int $question_id, int $active_id)
	Returns the maximum pass a users question solution. More...
static	_setReachedPoints (int $active_id, int $question_id, float $points, float $maxpoints, int $pass, bool $manualscoring)
	Sets the points, a learner has reached answering the question Additionally objective results are updated. More...
static	getFeedbackClassNameByQuestionType (string $questionType)
static	_questionExistsInTest (int $question_id, int $test_id)
static	lookupParentObjId (int $question_id)
static	implodeKeyValues (array $keyValues)
static	explodeKeyValues (string $keyValues)
static	convertISO8601FormatH_i_s_ExtendedToSeconds (string $time)
static	extendedTrim (string $value)
	Trim non-printable characters from the beginning and end of a string. More...
Data Fields inherited from assQuestion
const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'
const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'
const	TRIM_PATTERN = '/^[\p{C}\p{Z}]+|[\p{C}\p{Z}]+$/u'
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)
Static Protected Attributes inherited from assQuestion
static	$force_pass_results_update_enabled = false
static	$imageSourceFixReplaceMap

Detailed Description

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

Author

Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Version

Id

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

\

Definition at line 31 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 39 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 = [];
        $this->results = [];
        $this->resultunits = [];
        $this->unitrepository = new ilUnitConfigurationRepository(0);
        $this->pass_presented_variables_repo = new PassPresentedVariablesRepo($this->db);
    }

Here is the call graph for this function:

Member Function Documentation

addResult()

assFormulaQuestion::addResult

(

assFormulaQuestionResult

$result

)

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

References assFormulaQuestionResult\getResult().

Referenced by loadFromDb(), and parseQuestionText().

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

Here is the call graph for this function:

Here is the caller graph for this function:

addResultUnit()

assFormulaQuestion::addResultUnit	(	?assFormulaQuestionResult	$result,
		?assFormulaQuestionUnit	$unit
	)

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

References $resultunits, assFormulaQuestionUnit\getId(), assFormulaQuestionResult\getResult(), and null.

Referenced by loadFromDb().

     : void {
        if ($result === null || $unit === null) {
            return;
        }

        if (!array_key_exists($result->getResult(), $this->resultunits) ||
            !is_array($this->resultunits[$result->getResult()])) {
            $this->resultunits[$result->getResult()] = [];
        }
        $this->resultunits[$result->getResult()][$unit->getId()] = $unit;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addResultUnits()

assFormulaQuestion::addResultUnits	(	?assFormulaQuestionResult	$result,
		?array	$unit_ids
	)

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

References assQuestion\$id, assFormulaQuestionResult\getResult(), getUnitrepository(), and null.

     : void {
        $this->resultunits[$result->getResult()] = [];
        if ($result === null || $unit_ids === null) {
            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

(

assFormulaQuestionVariable

$variable

)

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

References assFormulaQuestionVariable\getVariable().

Referenced by loadFromDb(), and parseQuestionText().

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

Here is the call graph for this function:

Here is the caller graph for this function:

buildResultsForLog()

assFormulaQuestion::buildResultsForLog ( array  $results, string  $none_tag  )

private

Parameters

array<assFormulaQuestionResult>

$variables

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

References $c, $r, assFormulaQuestionResult\getFormula(), assFormulaQuestionResult\getPoints(), assFormulaQuestionResult\getPrecision(), assFormulaQuestionResult\getRangeMaxTxt(), assFormulaQuestionResult\getRangeMinTxt(), assFormulaQuestionResult\getResult(), assFormulaQuestionResult\getResultType(), assFormulaQuestionResult\getTolerance(), and assFormulaQuestionResult\getUnit().

Referenced by toLog().

                                                                         : array
    {
        return array_reduce(
            $results,
            function (array $c, assFormulaQuestionResult $r) use ($none_tag): array {
                $c[$r->getResult()] = [
                    AdditionalInformationGenerator::KEY_QUESTION_FORMULA_RESULT_TYPE => $r->getResultType(),
                    AdditionalInformationGenerator::KEY_QUESTION_FORMULA_FORMULA => $r->getFormula(),
                    AdditionalInformationGenerator::KEY_QUESTION_REACHABLE_POINTS => $r->getPoints(),
                    AdditionalInformationGenerator::KEY_QUESTION_LOWER_LIMIT => $r->getRangeMinTxt(),
                    AdditionalInformationGenerator::KEY_QUESTION_UPPER_LIMIT => $r->getRangeMaxTxt(),
                    AdditionalInformationGenerator::KEY_QUESTION_FORMULA_TOLERANCE => $r->getTolerance(),
                    AdditionalInformationGenerator::KEY_QUESTION_FORMULA_PRECISION => $r->getPrecision(),
                    AdditionalInformationGenerator::KEY_QUESTION_FORMULA_UNIT => $r->getUnit() ?? $none_tag
                ];
                return $c;
            },
            []
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildVariablesForLog()

assFormulaQuestion::buildVariablesForLog ( array  $variables, string  $none_tag  )

private

Parameters

array<assFormulaQuestionVariable>

$variables

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

References $c, assFormulaQuestionVariable\getIntprecision(), assFormulaQuestionVariable\getPrecision(), assFormulaQuestionVariable\getRangeMaxTxt(), assFormulaQuestionVariable\getRangeMinTxt(), assFormulaQuestionVariable\getUnit(), and assFormulaQuestionVariable\getVariable().

Referenced by toLog().

                                                                             : array
    {
        return array_reduce(
            $variables,
            function (array $c, assFormulaQuestionVariable $v) use ($none_tag): array {
                $c[$v->getVariable()] = [
                    AdditionalInformationGenerator::KEY_QUESTION_LOWER_LIMIT => $v->getRangeMinTxt(),
                    AdditionalInformationGenerator::KEY_QUESTION_UPPER_LIMIT => $v->getRangeMaxTxt(),
                    AdditionalInformationGenerator::KEY_QUESTION_FORMULA_PRECISION => $v->getPrecision(),
                    AdditionalInformationGenerator::KEY_QUESTION_FORMULA_INTPRECISION => $v->getIntprecision(),
                    AdditionalInformationGenerator::KEY_QUESTION_FORMULA_UNIT => $v->getUnit() ?? $none_tag
                ];
                return $c;
            },
            []
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

calculateReachedPoints()

assFormulaQuestion::calculateReachedPoints	(	int	$active_id,
		?int	$pass = null,
		bool	$authorized_solution = true
	)

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

References assQuestion\$points, getResults(), assQuestion\getSolutionMaxPass(), assQuestion\getSolutionValues(), getVariable(), getVariables(), null, and ILIAS\Repository\refinery().

Referenced by getUserQuestionResult().

     : float {
        if ($pass === null) {
            $pass = $this->getSolutionMaxPass($active_id);
        }
        $solutions = $this->getSolutionValues($active_id, $pass, $authorized_solution);
        $user_solution = [];
        foreach ($solutions as $solution_value) {
            if (preg_match('/^(\$v\d+)$/', $solution_value['value1'], $matches)) {
                $user_solution[$matches[1]] = $solution_value['value2'];
                $var_obj = $this->getVariable($solution_value['value1']);
                $var_obj->setValue($solution_value['value2']);
                continue;
            }

            if (preg_match('/^(\$r\d+)$/', $solution_value['value1'], $matches)) {
                if (!array_key_exists($matches[1], $user_solution)) {
                    $user_solution[$matches[1]] = [];
                }
                $user_solution[$matches[1]]['value'] = $solution_value['value2'];
                continue;
            }

            if (preg_match('/^(\$r\d+)_unit$/', $solution_value['value1'], $matches)) {
                if (!array_key_exists($matches[1], $user_solution)) {
                    $user_solution[$matches[1]] = [];
                }
                $user_solution[$matches[1]]['unit'] = $this->unitrepository->getUnit(
                    $this->refinery->kindlyTo()->int()->transform($solution_value['value2']),
                );
            }
        }

        $points = 0;
        foreach ($this->getResults() as $result) {
            $points += $result->getReachedPoints(
                $this->getVariables(),
                $this->getResults(),
                $user_solution[$result->getResult()]['value'] ?? '',
                $user_solution[$result->getResult()]['unit'] ?? null,
                $this->unitrepository->getUnits()
            );
        }

        return (float) $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 844 of file class.assFormulaQuestion.php.

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

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

        $points = 0;
        foreach ($this->getResults() as $result) {
            $unit_id = $user_solution[$result->getResult() . '_unit'] ?? null;
            $points += $result->getReachedPoints(
                $this->getVariables(),
                $this->getResults(),
                $user_solution[$result->getResult()] ?? '',
                $unit_id !== null ? $this->unitrepository->getUnit($unit_id) : null,
                $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 540 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 193 of file class.assFormulaQuestion.php.

References assQuestion\getQuestion().

                                              : bool
    {
        if (preg_match_all('/(\$r\d+)/im', $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 183 of file class.assFormulaQuestion.php.

References assQuestion\getQuestion().

                                                : bool
    {
        if (preg_match_all('/(\$v\d+)/im', $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 77 of file class.assFormulaQuestion.php.

Referenced by parseQuestionText().

                                  : void
    {
        $this->results = [];
    }

Here is the caller graph for this function:

clearVariables()

assFormulaQuestion::clearVariables

(

)

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

Referenced by parseQuestionText().

                                    : void
    {
        $this->variables = [];
    }

Here is the caller graph for this function:

cloneQuestionTypeSpecificProperties()

assFormulaQuestion::cloneQuestionTypeSpecificProperties ( \assQuestion  $target )

protected

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

References assQuestion\getId().

     : \assQuestion {
        $this->unitrepository->cloneUnits($this->getId(), $target->getId());
        return $target;
    }

Here is the call graph for this function:

deleteAnswers()

assFormulaQuestion::deleteAnswers

(

int

$question_id

)

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

                                                   : void
    {
        $affectedRows = $this->db->manipulateF(
            "DELETE FROM il_qpl_qst_fq_var WHERE question_fi = %s",
            ['integer'],
            [$question_id]
        );

        $affectedRows = $this->db->manipulateF(
            "DELETE FROM il_qpl_qst_fq_res WHERE question_fi = %s",
            ['integer'],
            [$question_id]
        );

        $affectedRows = $this->db->manipulateF(
            "DELETE FROM il_qpl_qst_fq_res_unit WHERE question_fi = %s",
            ['integer'],
            [$question_id]
        );

        $affectedRows = $this->db->manipulateF(
            "DELETE FROM il_qpl_qst_fq_ucat WHERE question_fi = %s",
            ['integer'],
            [$question_id]
        );

        $affectedRows = $this->db->manipulateF(
            "DELETE FROM il_qpl_qst_fq_unit WHERE question_fi = %s",
            ['integer'],
            [$question_id]
        );
    }

fetchAllResults()

assFormulaQuestion::fetchAllResults

(

$questionText

)

Parameters

string

$questionText

Returns

assFormulaQuestionResult[] $resObjects

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

References getResult(), and null.

Referenced by getInitialVariableSolutionValues().

                                                  : array
    {
        $resObjects = [];
        $matches = null;

        if (preg_match_all('/(\$r\d+)/im', $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

(

string

$question_text

)

Returns

list<assFormulaQuestionVariable>

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

References $c, getVariable(), and null.

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

                                                            : array
    {
        $var_objects = [];
        $matches = null;

        if (preg_match_all('/(\$v\d+)/im', $question_text, $matches)) {
            $var_objects = array_reduce(
                $matches[1],
                function (array $c, string $v): array {
                    $vo = $this->getVariable($v);
                    if ($vo !== null) {
                        $c[] = $vo;
                    }
                    return $c;
                },
                []
            );
        }

        return $var_objects;
    }

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

(

)

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

                                            : string
    {
        return "";
    }

getAllResultUnits()

assFormulaQuestion::getAllResultUnits

(

)

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

References $resultunits.

                                       : array
    {
        return $this->resultunits;
    }

getAnswerTableName()

assFormulaQuestion::getAnswerTableName

(

)

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

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

References getResult(), getResults(), and null.

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

Here is the call graph for this function:

getBestSolution()

assFormulaQuestion::getBestSolution

(

array

$solutions

)

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

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

Referenced by getCorrectSolutionForTextOutput().

                                                     : array
    {
        $user_solution = [];

        foreach ($solutions as $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]] = [];
                }
                $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]] = [];
                }
                $user_solution[$matches[1]]['unit'] = $solution_value['value2'];
            }
        }
        foreach ($this->getResults() as $result) {
            $resVal = $result->calculateFormula($this->getVariables(), $this->getResults(), $this->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'] ?? null, $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((float) $user_solution[$result->getResult()]['value'], $result->getPrecision());
            }
        }
        return $user_solution;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCorrectSolutionForTextOutput()

assFormulaQuestion::getCorrectSolutionForTextOutput	(	int	$active_id,
		int	$pass
	)

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

References getBestSolution(), and assQuestion\getSolutionValues().

                                                                              : array
    {
        $best_solution = $this->getBestSolution($this->getSolutionValues($active_id, $pass));
        return array_map(
            function (string $v) use ($best_solution): string {
                $solution = "{$v} = {$best_solution[$v]['value']}";
                if (isset($best_solution['unit'])) {
                    $solution .= "{$this->unitrepository->getUnit($best_solution['unit'])->getUnit()}";
                }
                return $solution;
            },
            array_keys($best_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 1215 of file class.assFormulaQuestion.php.

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

                                        : array
    {
        return [
            iQuestionCondition::PercentageResultExpression,
            iQuestionCondition::NumericResultExpression,
            iQuestionCondition::EmptyAnswerExpression,
        ];
    }

getInitialVariableSolutionValues()

assFormulaQuestion::getInitialVariableSolutionValues

(

)

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

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

Referenced by getVariableSolutionValuesForPass().

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

        $variableSolutionValues = [];

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

        return $variableSolutionValues;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMaximumPoints()

assFormulaQuestion::getMaximumPoints

(

)

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

See also

$points

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

References assQuestion\$points.

Referenced by getUserQuestionResult(), 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

(

string

$expression

)

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

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

                                                    : array
    {
        return ilOperatorsExpressionMapping::getOperatorsByExpression($expression);
    }

getQuestionType()

assFormulaQuestion::getQuestionType

(

)

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

Referenced by toLog().

                                     : string
    {
        return "assFormulaQuestion";
    }

Here is the caller graph for this function:

getResult()

assFormulaQuestion::getResult

(

string

$result

)

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

References null.

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

                                             : ?assFormulaQuestionResult
    {
        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 82 of file class.assFormulaQuestion.php.

References $results.

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

                                : array
    {
        return $this->results;
    }

Here is the caller graph for this function:

getResultUnits()

assFormulaQuestion::getResultUnits

(

assFormulaQuestionResult

$result

)

Definition at line 130 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 fn(assFormulaQuestionUnit $a, assFormulaQuestionUnit $b) =>
                $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

(

)

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

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

getSolutionSubmit()

assFormulaQuestion::getSolutionSubmit ( )

protected

Returns

array<string>

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

References Vendor\Package\$a, $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

(

)

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

References $unitrepository.

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

                                       : ilUnitConfigurationRepository
    {
        return $this->unitrepository;
    }

Here is the caller graph for this function:

getUserQuestionResult()

assFormulaQuestion::getUserQuestionResult	(	int	$active_id,
		int	$pass
	)

Get the user solution for a question by active_id and the test pass.

Implements iQuestionCondition.

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

References $data, assQuestion\$points, calculateReachedPoints(), assQuestion\getId(), getMaximumPoints(), assQuestion\lookupMaxStep(), and null.

     : ilUserQuestionResult {
        $result = new ilUserQuestionResult($this, $active_id, $pass);

        $maxStep = $this->lookupMaxStep($active_id, $pass);
        if ($maxStep > 0) {
            $data = $this->db->queryF(
                "SELECT value1, value2 FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND step = %s",
                ['integer', 'integer', 'integer','integer'],
                [$active_id, $pass, $this->getId(), $maxStep]
            );
        } else {
            $data = $this->db->queryF(
                "SELECT value1, value2 FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s",
                ['integer', 'integer', 'integer'],
                [$active_id, $pass, $this->getId()]
            );
        }

        while ($row = $this->db->fetchAssoc($data)) {
            if (strstr($row['value1'], '$r') && $row['value2'] != null) {
                $result->addKeyValue(str_replace('$r', "", $row['value1']), $row['value2']);
            }
        }

        $points = $this->calculateReachedPoints($active_id, $pass);
        $max_points = $this->getMaximumPoints();

        $result->setReachedPercentage(($points / $max_points) * 100);

        return $result;
    }

Here is the call graph for this function:

getVariable()

assFormulaQuestion::getVariable

(

string

$variable

)

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

References null.

Referenced by calculateReachedPoints(), fetchAllVariables(), getBestSolution(), getVariablesAsTextArray(), and solutionValuesToLog().

                                                 : ?assFormulaQuestionVariable
    {
        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 59 of file class.assFormulaQuestion.php.

References $variables.

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

                                  : array
    {
        return $this->variables;
    }

Here is the caller graph for this function:

getVariablesAsTextArray()

assFormulaQuestion::getVariablesAsTextArray	(	int	$active_id,
		int	$pass
	)

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

References getVariable(), getVariableSolutionValuesForPass(), and null.

                                                                      : array
    {
        $variables = $this->getVariableSolutionValuesForPass($active_id, $pass);
        return array_map(
            function (string $v) use ($variables): string {
                $variable = "{$v} = {$variables[$v]}";
                if ($this->getVariable($v)->getUnit() !== null) {
                    $variable .= $this->getVariable($v)->getUnit()->getUnit();
                }
                return $variable;
            },
            array_keys($variables)
        );
    }

Here is the call graph for this function:

getVariableSolutionValuesForPass()

assFormulaQuestion::getVariableSolutionValuesForPass	(	int	$active_id,
		int	$pass
	)

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

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

Referenced by getVariablesAsTextArray(), and saveCurrentSolution().

     : array {
        $question_id = $this->getId();
        $values = $this->pass_presented_variables_repo->getFor(
            $question_id,
            $active_id,
            $pass
        );
        if (is_null($values)) {
            $values = $this->getInitialVariableSolutionValues();
            $this->pass_presented_variables_repo->store(
                $question_id,
                $active_id,
                $pass,
                $values
            );
        }
        return $values;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasRequiredVariableSolutionValues()

assFormulaQuestion::hasRequiredVariableSolutionValues

(

array

$userSolution

)

Parameters

array

$userSolution

Returns

bool

Definition at line 250 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 ($userSolution[$varObj->getVariable()] === '') {
                return false;
            }
        }

        return true;
    }

Here is the call graph for this function:

hasResultUnit()

assFormulaQuestion::hasResultUnit	(	assFormulaQuestionResult	$result,
		int	$unit_id
	)

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

References $resultunits, and assFormulaQuestionResult\getResult().

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

        return false;
    }

Here is the call graph for this function:

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 573 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 ( string  $submittedValue )

protected

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

Referenced by validateSolutionSubmit().

                                                                         : bool
    {
        $submittedValue = str_replace(',', '.', $submittedValue);

        if (is_numeric($submittedValue)) {
            return true;
        }

        if (preg_match('/^[-+]?\d+\/\d+$/', $submittedValue)) {
            return true;
        }

        return false;
    }

Here is the caller graph for this function:

loadFromDb()

assFormulaQuestion::loadFromDb

(

int

$question_id

)

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

References $data, Vendor\Package\$e, 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
    {
        $result = $this->db->queryF(
            "SELECT qpl_questions.* FROM qpl_questions WHERE question_id = %s",
            ['integer'],
            [$question_id]
        );
        if ($result->numRows() == 1) {
            $data = $this->db->fetchAssoc($result);
            $this->setId($question_id);
            $this->setTitle((string) $data["title"]);
            $this->setComment((string) $data["description"]);
            $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);

            $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc((string) $data["question_text"], 1));

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

            // load result units
            $result = $this->db->queryF(
                "SELECT * FROM il_qpl_qst_fq_res_unit WHERE question_fi = %s",
                ['integer'],
                [$question_id]
            );
            if ($result->numRows() > 0) {
                while ($data = $this->db->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	$active_id,
		int	$pass
	)

Returns

array<'authorized' => bool, 'intermediate' => bool>

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

References assQuestion\getId(), assQuestion\getStep(), and null.

                                                                         : array
    {
        $return = [
            'authorized' => false,
            'intermediate' => false
        ];

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

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

        $query .= "
                        GROUP BY authorized
                ";

        $result = $this->db->query($query);

        while ($row = $this->db->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 164 of file class.assFormulaQuestion.php.

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

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

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

Here is the call graph for this function:

removeExistingSolutions()

assFormulaQuestion::removeExistingSolutions	(	int	$active_id,
		int	$pass
	)

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

References assQuestion\getId(), assQuestion\getStep(), and null.

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

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

        return $this->db->manipulate($query);
    }

Here is the call graph for this function:

saveCurrentSolution()

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

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

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

Referenced by saveWorkingData().

                                                                                                                          : int
    {
        $init_solution_vars = $this->getVariableSolutionValuesForPass($active_id, $pass);
        foreach ($init_solution_vars as $val1 => $val2) {
            $this->db->manipulateF(
                "DELETE FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s AND value1 = %s",
                ['integer', 'integer','integer', 'text'],
                [$active_id, $this->getId(), $pass, $val1]
            );
            parent::saveCurrentSolution($active_id, $pass, $val1, $val2, $authorized);
        }
        return parent::saveCurrentSolution($active_id, $pass, $value1, $value2, $authorized, $tstamp);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

savePreviewData()

assFormulaQuestion::savePreviewData ( ilAssQuestionPreviewSession  $previewSession )

protected

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

References ilAssQuestionPreviewSession\getParticipantsSolution(), getSolutionSubmit(), null, 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

(

?int

$original_id = null

)

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

References assQuestion\$original_id, assQuestion\getId(), getResultUnits(), ILIAS\Repository\int(), null, and assQuestion\saveQuestionDataToDb().

                                                      : void
    {
        $this->saveQuestionDataToDb($original_id);
        // save variables
        $affectedRows = $this->db->manipulateF(
            "
                DELETE FROM il_qpl_qst_fq_var
                WHERE question_fi = %s",
            ['integer'],
            [$this->getId()]
        );

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

        foreach ($this->results as $result) {
            $next_id = $this->db->nextId('il_qpl_qst_fq_res');
            if (is_object($result->getUnit())) {
                $tmp_result_unit = $result->getUnit()->getId();
            } else {
                $tmp_result_unit = null;
            }

            $formula = null;
            if ($result->getFormula() !== null) {
                $formula = str_replace(",", ".", $result->getFormula());
            }

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

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

        parent::saveToDb();
    }

Here is the call graph for this function:

saveWorkingData()

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

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

References ilObjTest\_getPass(), assQuestion\getId(), assQuestion\getProcessLocker(), getSolutionSubmit(), assQuestion\getStep(), null, and saveCurrentSolution().

     : bool {
        if (is_null($pass)) {
            $pass = ilObjTest::_getPass($active_id);
        }

        $answer = $this->getSolutionSubmit();
        $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(
            function () use ($answer, $active_id, $pass, $authorized) {
                foreach ($answer as $key => $value) {
                    $matches = null;
                    if (preg_match('/^result_(\$r\d+)$/', $key, $matches) !== false) {
                        $queryResult = "SELECT solution_id FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND authorized = %s  AND " . $this->db->like('value1', 'clob', $matches[1]);

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

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

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

                    if (preg_match('/^result_(\$r\d+)_unit$/', $key, $matches) !== false) {
                        $queryResultUnit = "SELECT solution_id FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND authorized = %s AND " . $this->db->like('value1', 'clob', $matches[1] . "_unit");

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

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

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

        return true;
    }

Here is the call graph for this function:

setId()

assFormulaQuestion::setId

(

int

$id = -1

)

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

(

\ilUnitConfigurationRepository

$unitrepository

)

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

References $unitrepository.

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

solutionValuesToLog()

assFormulaQuestion::solutionValuesToLog ( AdditionalInformationGenerator  $additional_info, array  $solution_values  )

protected

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

References $c, ILIAS\Test\Logging\AdditionalInformationGenerator\getNoneTag(), getUnitrepository(), getVariable(), and null.

     : array {
        return array_reduce(
            $solution_values,
            function (array $c, array $v) use ($additional_info): array {
                if (str_starts_with($v['value1'], '$v')) {
                    $var = $this->getVariable($v['value1']);
                    if ($var === null) {
                        $c[$v['value1']] = $additional_info->getNoneTag();
                        return $c;
                    }
                    if ($var->getUnit() !== null) {
                        $c[$v['value1']] = $v['value2'] . $var->getUnit()->getUnit();
                        return $c;
                    }
                }

                if (strpos($v['value1'], '_unit')) {
                    $unit = $this->getUnitrepository()->getUnit($v['value2']);
                    $c[$v['value1']] = $unit->getUnit() ?? $additional_info->getNoneTag();
                    return $c;
                }

                $c[$v['value1']] = $v['value2'];
                return $c;
            },
            []
        );
    }

Here is the call graph for this function:

solutionValuesToText()

assFormulaQuestion::solutionValuesToText

(

array

$solution_values

)

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

References $c.

                                                                : array
    {
        ksort($solution_values);
        return array_reduce(
            $solution_values,
            function (array $c, array $v): array {
                if (!str_starts_with($v['value1'], '$r')) {
                    return $c;
                }
                if (!strpos($v['value1'], '_unit')) {
                    $c[$v['value1']] = "{$v['value1']} = {$v['value2']}";
                    return $c;
                }
                $k = substr($v['value1'], 0, -5);
                if (array_key_exists($k, $c)) {
                    $c[$k] .= $v['value2'];
                }
                return $c;
            },
            []
        );
    }

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

References assFormulaQuestionResult\convertDecimalToCoprimeFraction(), fetchAllVariables(), generateResultInputHTML(), ILIAS\Survey\Mode\getId(), assQuestion\getQuestion(), getResult(), getResults(), getResultUnits(), getUnitrepository(), getVariables(), ILIAS\Repository\lng(), null, 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 = '';
            if ($varObj->getValue() !== null) {
                $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+)/im', $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, (string) $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 (!str_contains($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 (isset($userdata[$result]["frac_helper"]) && is_array($userdata) && $userdata[$result]["frac_helper"] !== '') {
                            if (!str_contains($value, '/')) {
                                $units .= ' &asymp; ' . $userdata[$result]["frac_helper"] . ', ';
                            }
                        }
                        $units .= ' ' . $this->lng->txt('expected_result_type') . ': ' . $this->lng->txt('result_co_frac');
                        break;
                    case assFormulaQuestionResult::RESULT_NO_SELECTION:
                        break;
                }
                $checkSign = "";
                if ($graphicalOutput) {
                    $resunit = null;
                    $user_value = '';
                    if (is_array($userdata) && is_array($userdata[$result])) {
                        if (isset($userdata[$result]["unit"]) && $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, 'components/ILIAS/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, 'components/ILIAS/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:

toLog()

assFormulaQuestion::toLog

(

AdditionalInformationGenerator

$additional_info

)

Implements ILIAS\TestQuestionPool\Questions\Question.

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

References buildResultsForLog(), buildVariablesForLog(), assQuestion\formatSAQuestion(), ILIAS\Test\Logging\AdditionalInformationGenerator\getNoneTag(), assQuestion\getQuestion(), getQuestionType(), getResults(), assQuestion\getTitleForHTMLOutput(), and getVariables().

                                                                          : array
    {
        return [
            AdditionalInformationGenerator::KEY_QUESTION_TYPE => (string) $this->getQuestionType(),
            AdditionalInformationGenerator::KEY_QUESTION_TITLE => $this->getTitleForHTMLOutput(),
            AdditionalInformationGenerator::KEY_QUESTION_TEXT => $this->formatSAQuestion($this->getQuestion()),
            AdditionalInformationGenerator::KEY_QUESTION_FORMULA_VARIABLES => $this->buildVariablesForLog(
                $this->getVariables(),
                $additional_info->getNoneTag()
            ),
            AdditionalInformationGenerator::KEY_QUESTION_FORMULA_RESULTS => $this->buildResultsForLog(
                $this->getResults(),
                $additional_info->getNoneTag()
            ),
            AdditionalInformationGenerator::KEY_FEEDBACK => [
                AdditionalInformationGenerator::KEY_QUESTION_FEEDBACK_ON_INCOMPLETE => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
                AdditionalInformationGenerator::KEY_QUESTION_FEEDBACK_ON_COMPLETE => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
            ]
        ];
    }

Here is the call graph for this function:

validateSolutionSubmit()

assFormulaQuestion::validateSolutionSubmit

(

)

Implements ILIAS\TestQuestionPool\Questions\Question.

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

References getSolutionSubmit(), isValidSolutionResultValue(), and ILIAS\Repository\lng().

                                            : bool
    {
        foreach ($this->getSolutionSubmit() as $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

$pass_presented_variables_repo

PassPresentedVariablesRepo assFormulaQuestion::$pass_presented_variables_repo

protected

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

$results

array assFormulaQuestion::$results

private

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

Referenced by getResults().

$resultunits

array assFormulaQuestion::$resultunits

private

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

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

$unitrepository

ilUnitConfigurationRepository assFormulaQuestion::$unitrepository

private

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

Referenced by getUnitrepository(), and setUnitrepository().

$variables

array assFormulaQuestion::$variables

private

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

Referenced by getVariables().

---

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

• components/ILIAS/TestQuestionPool/classes/class.assFormulaQuestion.php