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

Inheritance diagram for assNumeric:

Collaboration diagram for assNumeric:

Public Member Functions
	__construct ( $title="", $comment="", $author="", $owner=-1, $question="")
	assNumeric constructor More...

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

	saveToDb ($original_id="")
	Saves a assNumeric object to a database. More...

	duplicate (bool $for_test=true, string $title="", string $author="", int $owner=-1, $testObjId=null)
	Duplicates an assNumericQuestion. More...

	copyObject ($target_questionpool_id, $title="")
	Copies an assNumeric object. More...

	createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")

	getLowerLimit ()

	getUpperLimit ()

	setLowerLimit ($a_limit)

	setUpperLimit ($a_limit)

	getMaximumPoints ()
	Returns the maximum points, a learner can reach answering the question. More...

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

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

	validateSolutionSubmit ()

	getSolutionSubmit ()

	isValidSolutionSubmit ($numeric_solution)

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

	setExportDetailsXLSX (ilAssExcelFormatHelper $worksheet, int $startrow, int $col, int $active_id, int $pass)
	{} More...

	getOperators ($expression)
	Get all available operations for a specific question. More...

	getExpressionTypes ()
	Get all available expression types for a specific question. More...

	getAvailableAnswerOptions ($index=null)
	If index is null, the function returns an array with all anwser options Else it returns the specific answer option. More...

	getAnswerTableName ()

Public Member Functions inherited from assQuestion
	__construct (string $title="", string $comment="", string $author="", int $owner=-1, string $question="")
	assQuestion constructor More...

	getShuffler ()

	setShuffler (Transformation $shuffler)

	setProcessLocker (ilAssQuestionProcessLocker $processLocker)

	getProcessLocker ()

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

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

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

	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 $authorizedSolution=true)
	returns the reached points ... More...

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

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

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

	validateSolutionSubmit ()

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

	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, $pass=null)

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

	getAdditionalTableName ()

	getAnswerTableName ()

	deleteAnswers (int $question_id)

	deleteAdditionalTableData (int $question_id)

	delete (int $question_id)

	getTotalAnswers ()

	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)

	syncXHTMLMediaObjectsOfQuestion ()

	createPageObject ()

	copyPageOfQuestion (int $a_q_id)

	getPageOfQuestion ()

	setOriginalId (?int $original_id)

	getOriginalId ()

	fixSvgToPng (string $imageFilenameContainingString)

	fixUnavailableSkinImageSources (string $html)

	loadFromDb (int $question_id)

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

	saveQuestionDataToDb (int $original_id=-1)

	saveToDb ()

	deleteSuggestedSolutions ()

	getSuggestedSolution (int $subquestion_index=0)

	resolveInternalLink (string $internal_link)

	resolveSuggestedSolutionLinks ()

	syncWithOriginal ()

	getPoints ()

	setPoints (float $points)

	getSolutionMaxPass (int $active_id)

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

	deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $previewSession, $reachedPoints)

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

	isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)

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

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

	getQuestion ()

	getQuestionForHTMLOutput ()

	setQuestion (string $question="")

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

	getQuestionTypeID ()

	syncHints ()

	cleanupMediaObjectUsage ()

	getInstances ()

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

	hasSpecificFeedback ()

	setExportDetailsXLSX (ilAssExcelFormatHelper $worksheet, int $startrow, int $col, int $active_id, int $pass)

	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 ($lastChange)

	getLastChange ()

	removeIntermediateSolution (int $active_id, int $pass)

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

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

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

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

	setStep ($step)

	getStep ()

	toJSON ()

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

	intermediateSolutionExists (int $active_id, int $pass)

	authorizedSolutionExists (int $active_id, ?int $pass)

	authorizedOrIntermediateSolutionExists (int $active_id, int $pass)

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

	isAddableAnswerOptionValue (int $qIndex, string $answerOptionValue)

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

	removeAllExistingSolutions ()

	removeExistingSolutions (int $activeId, int $pass)

	resetUsersAnswer (int $activeId, int $pass)

	removeResultRecord (int $activeId, int $pass)

	fetchValuePairsFromIndexedValues (array $indexedValues)

	fetchIndexedValuesFromValuePairs (array $valuePairs)

	areObligationsToBeConsidered ()

	setObligationsToBeConsidered (bool $obligationsToBeConsidered)

	updateTimestamp ()

	getTestPresentationConfig ()

Public Member Functions inherited from ilObjQuestionScoringAdjustable
	saveAdditionalQuestionDataToDb ()
	Saves a record to the question types additional data table. More...

Public Member Functions inherited from ilObjAnswerScoringAdjustable
	saveAnswerSpecificDataToDb ()
	Saves the answer specific records into a question types answer table. More...

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

Data Fields
	$maxchars

Data Fields inherited from assQuestion
const	TRIM_PATTERN = '/^[\p{C}\p{Z}]+\|[\p{C}\p{Z}]+$/u'

const	ADDITIONAL_CONTENT_EDITING_MODE_RTE = 'default'

const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = 'pageobject'

ilAssQuestionFeedback	$feedbackOBJ

bool	$prevent_rte_usage = false

bool	$selfassessmenteditingmode = false

int	$defaultnroftries = 0

string	$questionActionCmd = 'handleQuestionAction'

const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'

Data Fields inherited from iQuestionCondition
const	StringResultExpression = '~TEXT~'

const	PercentageResultExpression = '%n%'

const	NumericResultExpression = '#n#'

const	MatchingResultExpression = ';n:m;'

const	OrderingResultExpression = '$n,m,o,p$'

const	NumberOfResultExpression = '+n+'

const	ExclusiveResultExpression = 'n,m,o,p'

const	EmptyAnswerExpression = "?"

Protected Member Functions
	isValidNumericSubmitValue ($submittedValue)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

Protected Member Functions inherited from assQuestion
	getQuestionAction ()

	isNonEmptyItemListPostSubmission (string $postSubmissionFieldname)

	log (int $active_id, string $langVar)

	savePreviewData (ilAssQuestionPreviewSession $previewSession)

	deletePageOfQuestion (int $question_id)

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

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

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

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

	duplicateComments (int $parent_source_id, int $source_id, int $parent_target_id, int $target_id)

	deleteComments ()

	getNotesManager ()

	getNotesDataService ()

	getNotesRepo ()

	syncSuggestedSolutions (int $target_question_id, int $target_obj_id)

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

	syncSuggestedSolutionFiles (int $target_question_id, int $target_obj_id)

	copySuggestedSolutionFiles (int $source_questionpool_id, int $source_question_id)

	copySuggestedSolutions (int $target_question_id)

	ensureNonNegativePoints ($points)

	purifyAndPrepareTextAreaOutput (string $content)

	getRTETextWithMediaObjects ()

	getSelfAssessmentFormatter ()

	lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

	lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

	duplicateQuestionHints (int $originalQuestionId, int $duplicateQuestionId)

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

	buildQuestionDataQuery ()

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

	removeSolutionRecordById (int $solutionId)

	getSolutionRecordById (int $solutionId)

	deleteDummySolutionRecord (int $activeId, int $passIndex)

	isDummySolutionRecord (array $solutionRecord)

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

	duplicateIntermediateSolutionAuthorized (int $activeId, int $passIndex)

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

	lookupMaxStep (int $active_id, int $pass)

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

	getSuggestedSolutionsRepo ()

	loadSuggestedSolutions ()

Protected Attributes
	$lower_limit

	$upper_limit

Protected Attributes inherited from assQuestion
const	HAS_SPECIFIC_FEEDBACK = true

ILIAS TestQuestionPool QuestionInfoService	$questioninfo

ILIAS Test TestParticipantInfoService	$testParticipantInfo

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ILIAS TestQuestionPool QuestionFilesService	$questionFilesService

ILIAS DI LoggingServices	$ilLog

int	$id

string	$title

string	$comment

string	$owner

string	$author

int	$thumb_size

string	$question
	The question text. More...

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

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

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

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

	$ilias

ilGlobalPageTemplate	$tpl

ilLanguage	$lng

ilDBInterface	$db

Container	$dic

array	$suggested_solutions

int	$original_id = null

	$page

string	$external_id = null

ilAssQuestionProcessLocker	$processLocker

	$step

	$lastChange

Transformation	$shuffler

ilTestQuestionConfig	$testQuestionConfig

ilAssQuestionLifecycle	$lifecycle

ilObjUser	$current_user

SkillUsageService	$skillUsageService

assQuestionSuggestedSolutionsDatabaseRepository	$suggestedsolution_repo = null

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

static	isForcePassResultUpdateEnabled ()

static	_getSuggestedSolutionOutput (int $question_id)

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

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

static	isFileAvailable (string $file)

static	saveOriginalId (int $questionId, int $originalId)

static	resetOriginalId (int $questionId)

static	_getInternalLinkHref (string $target="")

static	instantiateQuestion (int $question_id)

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

static	_isWriteable (int $question_id, int $user_id)

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

static	_needsManualScoring (int $question_id)

static	getFeedbackClassNameByQuestionType (string $questionType)

static	instantiateQuestionGUI (int $a_question_id)

static	_questionExistsInTest (int $question_id, int $test_id)

static	lookupParentObjId (int $questionId)

static	isObligationPossible (int $questionId)

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	$forcePassResultsUpdateEnabled = false

static	$imageSourceFixReplaceMap

Detailed Description

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

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

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

Constructor & Destructor Documentation

◆ __construct()

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

assNumeric constructor

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

Parameters

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

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

References assQuestion\$author, assQuestion\$comment, assQuestion\$owner, assQuestion\$question, assQuestion\$title, and ILIAS\MetaData\Repository\Validation\Data\__construct().

       {
         parent::__construct($title, $comment, $author, $owner, $question);
         $this->maxchars = 6;
     }

Here is the call graph for this function:

Member Function Documentation

◆ calculateReachedPointsFromPreviewSession()

assNumeric::calculateReachedPointsFromPreviewSession ( ilAssQuestionPreviewSession $previewSession )

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

References $data, $DIC, $ilDB, assQuestion\$points, assQuestion\calculateReachedPoints(), contains(), assQuestion\deductHintPointsFromReachedPoints(), assQuestion\ensureNonNegativePoints(), assQuestion\getCurrentSolutionResultSet(), ilAssQuestionPreviewSession\getParticipantsSolution(), assQuestion\getPoints(), and assQuestion\getSolutionMaxPass().

     {
         $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 380 of file class.assNumeric.php.

References getUpperLimit().

Referenced by calculateReachedPointsFromPreviewSession().

                                     : bool
     {
         $eval = new EvalMath();
         $eval->suppress_errors = true;
         $result = $eval->e($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:

◆ copyObject()

assNumeric::copyObject	(	$target_questionpool_id,
		$title = `""`
	)

Copies an assNumeric object.

Parameters

integer	$target_questionpool_id
string	$title

Returns: void|integer Id of the clone or nothing.

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

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

     {
         if ($this->id <= 0) {
             // The question has not been saved. It cannot be duplicated
             return;
         }
         // duplicate the question in database
         $clone = $this;
 
         $original_id = $this->questioninfo->getOriginalId($this->id);
         $clone->id = -1;
         $source_questionpool_id = $this->getObjId();
         $clone->setObjId($target_questionpool_id);
         if ($title) {
             $clone->setTitle($title);
         }
         $clone->saveToDb();
 
         // copy question page content
         $clone->copyPageOfQuestion($original_id);
         // copy XHTML media objects
         $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
 
         $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

assNumeric::createNewOriginalFromThisDuplicate	(	$targetParentId,
		$targetQuestionTitle = `""`
	)

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

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

                                                                                                   : int
     {
         if ($this->getId() <= 0) {
             throw new RuntimeException('The question has not been saved. It cannot be duplicated');
         }
 
         $sourceQuestionId = $this->id;
         $sourceParentId = $this->getObjId();
 
         // duplicate the question in database
         $clone = $this;
         $clone->id = -1;
 
         $clone->setObjId($targetParentId);
 
         if ($targetQuestionTitle) {
             $clone->setTitle($targetQuestionTitle);
         }
 
         $clone->saveToDb();
         // copy question page content
         $clone->copyPageOfQuestion($sourceQuestionId);
         // copy XHTML media objects
         $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
 
         $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ duplicate()

assNumeric::duplicate	(	bool	$for_test = `true`,
		string	$title = `""`,
		string	$author = `""`,
		int	$owner = `-1`,
			$testObjId = `null`
	)

Duplicates an assNumericQuestion.

Parameters

bool	$for_test
string	$title
string	$author
string	$owner
integer \| null	$testObjId

Returns: void|integer Id of the clone or nothing.

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

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

                                                                                                                                  : int
     {
         if ($this->id <= 0) {
             // The question has not been saved. It cannot be duplicated
             return -1;
         }
         // duplicate the question in database
         $this_id = $this->getId();
         $thisObjId = $this->getObjId();
 
         $clone = $this;
 
         $original_id = $this->questioninfo->getOriginalId($this->id);
         $clone->id = -1;
 
         if ((int) $testObjId > 0) {
             $clone->setObjId($testObjId);
         }
 
         if ($title) {
             $clone->setTitle($title);
         }
 
         if ($author) {
             $clone->setAuthor($author);
         }
         if ($owner) {
             $clone->setOwner($owner);
         }
 
         if ($for_test) {
             $clone->saveToDb($original_id);
         } else {
             $clone->saveToDb();
         }
 
         // copy question page content
         $clone->copyPageOfQuestion($this_id);
         // copy XHTML media objects
         $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
 
         $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ getAdditionalTableName()

assNumeric::getAdditionalTableName ( )

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

Returns: string The additional table name

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

Referenced by savePreviewData(), and saveToDb().

                                             : string
     {
         return "qpl_qst_numeric";
     }

Here is the caller graph for this function:

◆ getAnswerTableName()

assNumeric::getAnswerTableName ( )

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

     {
         return '';
     }

◆ getAvailableAnswerOptions()

assNumeric::getAvailableAnswerOptions ( $index = null )

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

Parameters

null | int $index

Returns: array|ASS_AnswerSimple

Implements iQuestionCondition.

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

References getLowerLimit(), and getUpperLimit().

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

Here is the call graph for this function:

◆ getExpressionTypes()

assNumeric::getExpressionTypes ( )

Get all available expression types for a specific question.

Returns: array

Implements iQuestionCondition.

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

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

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

Here is the call graph for this function:

◆ getLowerLimit()

assNumeric::getLowerLimit ( )

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

References $lower_limit.

Referenced by getAvailableAnswerOptions(), and savePreviewData().

     {
         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 579 of file class.assNumeric.php.

References $maxchars.

Referenced by savePreviewData().

     {
         return $this->maxchars;
     }

Here is the caller graph for this function:

◆ getMaximumPoints()

assNumeric::getMaximumPoints ( )

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

See also: $points

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

References assQuestion\getPoints().

Referenced by getExpressionTypes(), 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 ( $expression )

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

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

References ilOperatorsExpressionMapping\getOperatorsByExpression().

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

Here is the call graph for this function:

◆ getQuestionType()

assNumeric::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question

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

                                      : string
     {
         return "assNumeric";
     }

◆ 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 608 of file class.assNumeric.php.

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

◆ getSolutionSubmit()

assNumeric::getSolutionSubmit ( )

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

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

                                        : string
     {
         return trim(str_replace(",", ".", $_POST["numeric_result"]));
     }

Here is the caller graph for this function:

◆ getUpperLimit()

assNumeric::getUpperLimit ( )

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

References $upper_limit.

Referenced by contains(), getAvailableAnswerOptions(), and savePreviewData().

     {
         return $this->upper_limit;
     }

Here is the caller graph for this function:

◆ isComplete()

assNumeric::isComplete ( )

Returns true, if a numeric question is complete for use.

Returns: boolean True, if the numeric question is complete for use, otherwise false

Definition at line 71 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:

◆ isValidNumericSubmitValue()

assNumeric::isValidNumericSubmitValue ( $submittedValue )

protected

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

Referenced by validateSolutionSubmit().

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

Here is the caller graph for this function:

◆ isValidSolutionSubmit()

assNumeric::isValidSolutionSubmit ( $numeric_solution )

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

References $DIC, $ilDB, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), assQuestion\getCurrentSolutionResultSet(), assQuestion\getId(), assQuestion\getProcessLocker(), getSolutionSubmit(), ILIAS\Repository\lng(), assQuestion\logAction(), assQuestion\removeSolutionRecordById(), assQuestion\saveCurrentSolution(), assQuestion\saveWorkingData(), and assQuestion\updateCurrentSolution().

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

Here is the call graph for this function:

◆ savePreviewData()

assNumeric::savePreviewData ( ilAssQuestionPreviewSession $previewSession )

protected

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

References $DIC, $ilDB, getAdditionalTableName(), assQuestion\getId(), getLowerLimit(), getMaxChars(), assQuestion\getPoints(), getSolutionSubmit(), getUpperLimit(), ilObjQuestionScoringAdjustable\saveAdditionalQuestionDataToDb(), ilObjAnswerScoringAdjustable\saveAnswerSpecificDataToDb(), and ilAssQuestionPreviewSession\setParticipantsSolution().

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

Here is the call graph for this function:

◆ saveToDb()

assNumeric::saveToDb ( $original_id = "" )

Saves a assNumeric object to a database.

Parameters

string $original_id

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

References $data, $DIC, Vendor\Package\$e, $ilDB, assQuestion\$original_id, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), assQuestion\loadFromDb(), ilObjQuestionScoringAdjustable\saveAdditionalQuestionDataToDb(), ilObjAnswerScoringAdjustable\saveAnswerSpecificDataToDb(), assQuestion\saveQuestionDataToDb(), 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
     {
         if ($original_id == "") {
             $this->saveQuestionDataToDb();
         } else {
             $this->saveQuestionDataToDb($original_id);
         }
 
         $this->saveAdditionalQuestionDataToDb();
         $this->saveAnswerSpecificDataToDb();
         parent::saveToDb($original_id);
     }

Here is the call graph for this function:

◆ setExportDetailsXLSX()

assNumeric::setExportDetailsXLSX	(	ilAssExcelFormatHelper	$worksheet,
		int	$startrow,
		int	$col,
		int	$active_id,
		int	$pass
	)

{}

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

References ilExcel\getColumnCoord(), assQuestion\getSolutionValues(), ILIAS\Repository\lng(), ilExcel\setBold(), and ilAssExcelFormatHelper\setCell().

                                                                                                                                : int
     {
         parent::setExportDetailsXLSX($worksheet, $startrow, $col, $active_id, $pass);
 
         $solutions = $this->getSolutionValues($active_id, $pass);
 
         $i = 1;
         $worksheet->setCell($startrow + $i, $col, $this->lng->txt("result"));
         $worksheet->setBold($worksheet->getColumnCoord($col) . ($startrow + $i));
 
         $worksheet->setBold($worksheet->getColumnCoord($col) . ($startrow + $i));
         if (array_key_exists(0, $solutions) &&
             array_key_exists('value1', $solutions[0]) &&
             strlen($solutions[0]["value1"])) {
             $worksheet->setCell($startrow + $i, $col + 2, $solutions[0]["value1"]);
         }
         $i++;
 
         return $startrow + $i + 1;
     }

Here is the call graph for this function:

◆ setLowerLimit()

assNumeric::setLowerLimit ( $a_limit )

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

Referenced by saveToDb().

                                            : void
     {
         $a_limit = str_replace(',', '.', $a_limit);
         $this->lower_limit = $a_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 589 of file class.assNumeric.php.

References $maxchars.

Referenced by saveToDb().

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

Here is the caller graph for this function:

◆ setUpperLimit()

assNumeric::setUpperLimit ( $a_limit )

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

Referenced by saveToDb().

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

Here is the caller graph for this function:

◆ validateSolutionSubmit()

assNumeric::validateSolutionSubmit ( )

Implements assQuestionInterface.

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

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

                                             : bool
     {
         if (strlen($this->getSolutionSubmit()) && !$this->isValidNumericSubmitValue($this->getSolutionSubmit())) {
             $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 38 of file class.assNumeric.php.

Referenced by getLowerLimit().

◆ $maxchars

assNumeric::$maxchars

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

Referenced by getMaxChars(), and setMaxChars().

◆ $upper_limit

assNumeric::$upper_limit

protected

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

Referenced by getUpperLimit().

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

Modules/TestQuestionPool/classes/class.assNumeric.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ calculateReachedPointsFromPreviewSession()

◆ contains()

◆ copyObject()

◆ createNewOriginalFromThisDuplicate()

◆ duplicate()

◆ getAdditionalTableName()

◆ getAnswerTableName()

◆ getAvailableAnswerOptions()

◆ getExpressionTypes()

◆ getLowerLimit()

◆ getMaxChars()

◆ getMaximumPoints()

◆ getOperators()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSolutionSubmit()

◆ getUpperLimit()

◆ isComplete()

◆ isValidNumericSubmitValue()

◆ isValidSolutionSubmit()

◆ savePreviewData()

◆ saveToDb()

◆ setExportDetailsXLSX()

◆ setLowerLimit()

◆ setMaxChars()

◆ setUpperLimit()

◆ validateSolutionSubmit()

Field Documentation

◆ $lower_limit

◆ $maxchars

◆ $upper_limit