Class for numeric questions. More...

Inheritance diagram for assNumeric:

Collaboration diagram for assNumeric:

Public Member Functions
	isComplete ()

	saveToDb (?int $original_id=null)

	loadFromDb (int $question_id)

	getLowerLimit ()

	getUpperLimit ()

	setLowerLimit (string $limit)

	setUpperLimit (string $limit)

	getMaximumPoints ()

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

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

	contains ($value)
	Checks for a given value within the range. More...

	validateSolutionSubmit ()

	isValidSolutionSubmit ($numeric_solution)

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

	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...

	saveAnswerSpecificDataToDb ()
	Saves the answer specific records into a question types answer table. More...

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

	getMaxChars ()
	Returns the maximum number of characters for the numeric input field. More...

	setMaxChars ($maxchars)
	Sets the maximum number of characters for the numeric input field. More...

	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...

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

	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 (?int $index=null)
	If index is null, the function returns an array with all anwser options else it returns the specific answer option. More...

	getAnswerTableName ()

	toLog (AdditionalInformationGenerator $additional_info)

	solutionValuesToText (array $solution_values)

	getCorrectSolutionForTextOutput (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)

Data Fields
	$maxchars = 6

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 = "?"

Protected Member Functions
	getSolutionSubmit ()

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	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
	$lower_limit

	$upper_limit

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

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

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

assNumeric is a class for numeric questions. To solve a numeric question, a learner has to enter a numerical value in a defined range.

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m; Nina Gharib nina@.nosp@m.wgse.nosp@m.rve.d.nosp@m.e; Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de; Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

Definition at line 39 of file class.assNumeric.php.

Member Function Documentation

◆ calculateReachedPoints()

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

Definition at line 154 of file class.assNumeric.php.

References $data, assQuestion\$points, contains(), assQuestion\getCurrentSolutionResultSet(), assQuestion\getPoints(), assQuestion\getSolutionMaxPass(), and null.

Referenced by getUserQuestionResult().

      : float {
         if ($pass === null) {
             $pass = $this->getSolutionMaxPass($active_id);
         }
         $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorized_solution);
         $data = $this->db->fetchAssoc($result);
         $enteredvalue = '';
         if (is_array($data) && array_key_exists('value1', $data)) {
             $enteredvalue = $data["value1"];
         }
 
         $points = 0.0;
         if ($this->contains($enteredvalue)) {
             $points = $this->getPoints();
         }
 
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPointsFromPreviewSession()

assNumeric::calculateReachedPointsFromPreviewSession ( ilAssQuestionPreviewSession $previewSession )

Definition at line 142 of file class.assNumeric.php.

References assQuestion\$points, contains(), assQuestion\deductHintPointsFromReachedPoints(), assQuestion\ensureNonNegativePoints(), ilAssQuestionPreviewSession\getParticipantsSolution(), and assQuestion\getPoints().

                                                                                                          : float
     {
         $points = 0;
         if ($this->contains($previewSession->getParticipantsSolution())) {
             $points = $this->getPoints();
         }
 
         $reachedPoints = $this->deductHintPointsFromReachedPoints($previewSession, $points);
 
         return $this->ensureNonNegativePoints($reachedPoints);
     }

Here is the call graph for this function:

◆ contains()

assNumeric::contains ( $value )

Checks for a given value within the range.

See also: $upperlimit; $lowerlimit

Parameters

double $value The value to check

Returns: boolean TRUE if the value is in the range, FALSE otherwise

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

References getUpperLimit().

Referenced by calculateReachedPoints(), and calculateReachedPointsFromPreviewSession().

                                     : bool
     {
         $eval = new EvalMath();
         $eval->suppress_errors = true;
         $result = $eval->e((string) $value);
         if (($result === false) || ($result === true)) {
             return false;
         }
 
         if (($result >= $eval->e($this->getLowerLimit())) && ($result <= $eval->e($this->getUpperLimit()))) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdditionalTableName()

assNumeric::getAdditionalTableName ( )

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

Returns: string The additional table name

Definition at line 346 of file class.assNumeric.php.

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

                                             : string
     {
         return "qpl_qst_numeric";
     }

Here is the caller graph for this function:

◆ getAnswerTableName()

assNumeric::getAnswerTableName ( )

Definition at line 415 of file class.assNumeric.php.

                                         : string
     {
         return '';
     }

◆ getAvailableAnswerOptions()

assNumeric::getAvailableAnswerOptions ( ?int $index = null )

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

Implements iQuestionCondition.

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

References getLowerLimit(), and getUpperLimit().

                                                                  : array
     {
         return [
             "lower" => $this->getLowerLimit(),
             "upper" => $this->getUpperLimit()
         ];
     }

Here is the call graph for this function:

◆ getCorrectSolutionForTextOutput()

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

Definition at line 459 of file class.assNumeric.php.

                                                                               : string
     {
         return "{$this->getLowerLimit()}-{$this->getUpperLimit()}";
     }

◆ getExpressionTypes()

assNumeric::getExpressionTypes ( )

Get all available expression types for a specific question.

Returns: array

Implements iQuestionCondition.

Definition at line 365 of file class.assNumeric.php.

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

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

◆ getLowerLimit()

assNumeric::getLowerLimit ( )

Definition at line 117 of file class.assNumeric.php.

References $lower_limit.

Referenced by getAvailableAnswerOptions(), saveAnswerSpecificDataToDb(), and toLog().

     {
         return $this->lower_limit;
     }

Here is the caller graph for this function:

◆ getMaxChars()

assNumeric::getMaxChars ( )

Returns the maximum number of characters for the numeric input field.

Returns: integer The maximum number of characters

Definition at line 326 of file class.assNumeric.php.

References $maxchars.

Referenced by saveAdditionalQuestionDataToDb(), and toLog().

     {
         return $this->maxchars;
     }

Here is the caller graph for this function:

◆ getMaximumPoints()

assNumeric::getMaximumPoints ( )

Definition at line 137 of file class.assNumeric.php.

References assQuestion\getPoints().

Referenced by getUserQuestionResult(), and isComplete().

                                       : float
     {
         return $this->getPoints();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOperators()

assNumeric::getOperators ( string $expression )

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

Definition at line 360 of file class.assNumeric.php.

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

◆ getQuestionType()

assNumeric::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question

Definition at line 316 of file class.assNumeric.php.

Referenced by toLog().

                                      : string
     {
         return "assNumeric";
     }

Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assNumeric::getRTETextWithMediaObjects ( )

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

Definition at line 355 of file class.assNumeric.php.

                                                 : string
     {
         return parent::getRTETextWithMediaObjects();
     }

◆ getSolutionSubmit()

assNumeric::getSolutionSubmit ( )

protected

Definition at line 212 of file class.assNumeric.php.

References null.

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

                                           : ?float
     {
         return $this->questionpool_request->float('numeric_result') ?? null;
     }

Here is the caller graph for this function:

◆ getUpperLimit()

assNumeric::getUpperLimit ( )

Definition at line 122 of file class.assNumeric.php.

References $upper_limit.

Referenced by contains(), getAvailableAnswerOptions(), saveAnswerSpecificDataToDb(), and toLog().

     {
         return $this->upper_limit;
     }

Here is the caller graph for this function:

◆ getUserQuestionResult()

assNumeric::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 374 of file class.assNumeric.php.

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

      : ilUserQuestionResult {
         $result = new ilUserQuestionResult($this, $active_id, $pass);
 
         $maxStep = $this->lookupMaxStep($active_id, $pass);
         if ($maxStep > 0) {
             $data = $this->db->queryF(
                 "SELECT value1 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 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)) {
             $result->addKeyValue(1, $row["value1"]);
         }
 
         $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:

◆ isComplete()

assNumeric::isComplete ( )

Definition at line 45 of file class.assNumeric.php.

References getMaximumPoints().

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

Here is the call graph for this function:

◆ isValidSolutionSubmit()

assNumeric::isValidSolutionSubmit ( $numeric_solution )

Definition at line 217 of file class.assNumeric.php.

                                                             : bool
     {
         $math = new EvalMath();
         $math->suppress_errors = true;
         $result = $math->evaluate($numeric_solution);
 
         return !(
             ($result === false || $result === true) && strlen($numeric_solution) > 0
         );
     }

◆ loadFromDb()

assNumeric::loadFromDb ( int $question_id )

PhpAssignmentInConditionInspection

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

References $data, Vendor\Package\$e, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setId(), assQuestion\setLifecycle(), setLowerLimit(), setMaxChars(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setTitle(), and setUpperLimit().

                                                 : void
     {
         $result = $this->db->queryF(
             "SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
             ["integer"],
             [$question_id]
         );
         if ($result->numRows() == 1) {
             $data = $this->db->fetchAssoc($result);
             $this->setId($question_id);
             $this->setObjId($data["obj_fi"]);
             $this->setTitle((string) $data["title"]);
             $this->setComment((string) $data["description"]);
             $this->setNrOfTries($data['nr_of_tries']);
             $this->setOriginalId($data["original_id"]);
             $this->setAuthor($data["author"]);
             $this->setPoints($data["points"]);
             $this->setOwner($data["owner"]);
             $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc((string) $data["question_text"], 1));
             $this->setMaxChars($data["maxnumofchars"]);
 
             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) {
             }
         }
 
         $result = $this->db->queryF(
             "SELECT * FROM qpl_num_range WHERE question_fi = %s ORDER BY aorder ASC",
             ['integer'],
             [$question_id]
         );
 
         if ($result->numRows() > 0) {
             while ($data = $this->db->fetchAssoc($result)) {
                 $this->setPoints($data['points']);
                 $this->setLowerLimit($data['lowerlimit']);
                 $this->setUpperLimit($data['upperlimit']);
             }
         }
 
         parent::loadFromDb($question_id);
     }

Here is the call graph for this function:

◆ saveAdditionalQuestionDataToDb()

assNumeric::saveAdditionalQuestionDataToDb ( )

Saves a record to the question types additional data table.

Returns: mixed

Implements ilObjQuestionScoringAdjustable.

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

References getAdditionalTableName(), assQuestion\getId(), and getMaxChars().

Referenced by saveToDb().

     {
         // save additional data
         $this->db->manipulateF(
             "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
             [ "integer" ],
             [ $this->getId() ]
         );
 
         $this->db->manipulateF(
             "INSERT INTO " . $this->getAdditionalTableName(
             ) . " (question_fi, maxnumofchars) VALUES (%s, %s)",
             [ "integer", "integer" ],
             [
                                 $this->getId(),
                                 ($this->getMaxChars()) ? $this->getMaxChars() : 0
                             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAnswerSpecificDataToDb()

assNumeric::saveAnswerSpecificDataToDb ( )

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

Returns: mixed

Implements ilObjAnswerScoringAdjustable.

Definition at line 292 of file class.assNumeric.php.

References assQuestion\getId(), getLowerLimit(), assQuestion\getPoints(), and getUpperLimit().

Referenced by saveToDb().

     {
         // Write range to the database
         $this->db->manipulateF(
             "DELETE FROM qpl_num_range WHERE question_fi = %s",
             [ 'integer' ],
             [ $this->getId() ]
         );
 
         $next_id = $this->db->nextId('qpl_num_range');
         $this->db->manipulateF(
             "INSERT INTO qpl_num_range (range_id, question_fi, lowerlimit, upperlimit, points, aorder, tstamp)
                                                          VALUES (%s, %s, %s, %s, %s, %s, %s)",
             [ 'integer', 'integer', 'text', 'text', 'float', 'integer', 'integer' ],
             [ $next_id, $this->id, $this->getLowerLimit(), $this->getUpperLimit(
             ), $this->getPoints(), 0, time() ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePreviewData()

assNumeric::savePreviewData ( ilAssQuestionPreviewSession $previewSession )

protected

Definition at line 266 of file class.assNumeric.php.

References getSolutionSubmit(), and ilAssQuestionPreviewSession\setParticipantsSolution().

                                                                                    : void
     {
         $numericSolution = $this->getSolutionSubmit();
         $previewSession->setParticipantsSolution($numericSolution);
     }

Here is the call graph for this function:

◆ saveToDb()

assNumeric::saveToDb ( ?int $original_id = null )

Definition at line 58 of file class.assNumeric.php.

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

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

Here is the call graph for this function:

◆ saveWorkingData()

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

Definition at line 228 of file class.assNumeric.php.

References ilObjTest\_getPass(), assQuestion\getCurrentSolutionResultSet(), assQuestion\getProcessLocker(), getSolutionSubmit(), null, assQuestion\removeSolutionRecordById(), assQuestion\saveCurrentSolution(), and assQuestion\updateCurrentSolution().

      : bool {
         if (is_null($pass)) {
             $pass = ilObjTest::_getPass($active_id);
         }
 
         $answer = $this->getSolutionSubmit();
         $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(
             function () use ($answer, $active_id, $pass, $authorized) {
                 $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorized);
                 $update = -1;
                 if ($this->db->numRows($result) !== 0) {
                     $row = $this->db->fetchAssoc($result);
                     $update = $row['solution_id'];
                 }
 
                 if ($update !== -1
                     && $answer === '') {
                     $this->removeSolutionRecordById($update);
                     return;
                 }
                 if ($update !== -1) {
                     $this->updateCurrentSolution($update, $answer, null, $authorized);
                     return;
                 }
 
                 if ($answer !== '') {
                     $this->saveCurrentSolution($active_id, $pass, $answer, null, $authorized);
                 }
             }
         );
 
         return true;
     }

Here is the call graph for this function:

◆ setLowerLimit()

assNumeric::setLowerLimit ( string $limit )

Definition at line 127 of file class.assNumeric.php.

Referenced by loadFromDb().

                                                 : void
     {
         $this->lower_limit = str_replace(',', '.', $limit);
     }

Here is the caller graph for this function:

◆ setMaxChars()

assNumeric::setMaxChars ( $maxchars )

Sets the maximum number of characters for the numeric input field.

Parameters

integer $maxchars The maximum number of characters

Definition at line 336 of file class.assNumeric.php.

References $maxchars.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ setUpperLimit()

assNumeric::setUpperLimit ( string $limit )

Definition at line 132 of file class.assNumeric.php.

Referenced by loadFromDb().

                                                 : void
     {
         $this->upper_limit = str_replace(',', '.', $limit);
     }

Here is the caller graph for this function:

◆ solutionValuesToLog()

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

protected

Definition at line 439 of file class.assNumeric.php.

      : string {
         if (!array_key_exists(0, $solution_values) ||
             !array_key_exists('value1', $solution_values[0])) {
             return '';
         }
         return $solution_values[0]['value1'];
     }

◆ solutionValuesToText()

assNumeric::solutionValuesToText ( array $solution_values )

Definition at line 450 of file class.assNumeric.php.

                                                                 : string
     {
         if (!array_key_exists(0, $solution_values) ||
             !array_key_exists('value1', $solution_values[0])) {
             return '';
         }
         return $solution_values[0]['value1'];
     }

◆ toLog()

assNumeric::toLog ( AdditionalInformationGenerator $additional_info )

Implements ILIAS\TestQuestionPool\Questions\Question.

Definition at line 420 of file class.assNumeric.php.

References assQuestion\formatSAQuestion(), getLowerLimit(), getMaxChars(), assQuestion\getPoints(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), assQuestion\getTitleForHTMLOutput(), ILIAS\Test\Logging\AdditionalInformationGenerator\getTrueFalseTagForBool(), and getUpperLimit().

                                                                           : 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_SHUFFLE_ANSWER_OPTIONS => $additional_info
                 ->getTrueFalseTagForBool($this->getShuffle()),
             AdditionalInformationGenerator::KEY_QUESTION_MAXCHARS => $this->getMaxChars(),
             AdditionalInformationGenerator::KEY_QUESTION_REACHABLE_POINTS => $this->getPoints(),
             AdditionalInformationGenerator::KEY_QUESTION_LOWER_LIMIT => $this->getLowerLimit(),
             AdditionalInformationGenerator::KEY_QUESTION_UPPER_LIMIT => $this->getUpperLimit(),
             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()

assNumeric::validateSolutionSubmit ( )

Implements ILIAS\TestQuestionPool\Questions\Question.

Definition at line 202 of file class.assNumeric.php.

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

                                             : bool
     {
         if ($this->getSolutionSubmit() === null) {
             $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

◆ $lower_limit

assNumeric::$lower_limit

protected

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

Referenced by getLowerLimit().

◆ $maxchars

assNumeric::$maxchars = 6

Definition at line 43 of file class.assNumeric.php.

Referenced by getMaxChars(), and setMaxChars().

◆ $upper_limit

assNumeric::$upper_limit

protected

Definition at line 42 of file class.assNumeric.php.

Referenced by getUpperLimit().

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

components/ILIAS/TestQuestionPool/classes/class.assNumeric.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ calculateReachedPoints()

◆ calculateReachedPointsFromPreviewSession()

◆ contains()

◆ getAdditionalTableName()

◆ getAnswerTableName()

◆ getAvailableAnswerOptions()

◆ getCorrectSolutionForTextOutput()

◆ getExpressionTypes()

◆ getLowerLimit()

◆ getMaxChars()

◆ getMaximumPoints()

◆ getOperators()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSolutionSubmit()

◆ getUpperLimit()

◆ getUserQuestionResult()

◆ isComplete()

◆ isValidSolutionSubmit()

◆ loadFromDb()

◆ saveAdditionalQuestionDataToDb()

◆ saveAnswerSpecificDataToDb()

◆ savePreviewData()

◆ saveToDb()

◆ saveWorkingData()

◆ setLowerLimit()

◆ setMaxChars()

◆ setUpperLimit()

◆ solutionValuesToLog()

◆ solutionValuesToText()

◆ toLog()

◆ validateSolutionSubmit()

Field Documentation

◆ $lower_limit

◆ $maxchars

◆ $upper_limit