Class for numeric questions. 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 ($for_test=true, $title="", $author="", $owner="", $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...

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

{Creates an Excel worksheet for the detailed cumulated results of this question.

Parameters

object	$worksheet	Reference to the parent excel worksheet
object	$startrow	Startrow of the output in the excel worksheet
object	$active_id	Active id of the participant
object	$pass	Test pass

Returns: object

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

Public Member Functions inherited from assQuestion

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

assQuestion constructor More...

getShuffler ()

setShuffler (ilArrayElementShuffler $shuffler)

setProcessLocker ($processLocker)

getProcessLocker ()

fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)

Receives parameters from a QTI parser and creates a valid ILIAS question object. More...

toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $force_image_references=false)

Returns a QTI xml representation of the question. More...

isComplete ()

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

questionTitleExists ($questionpool_id, $title)

Returns TRUE if the question title exists in the database. More...

setTitle ($title="")

Sets the title string of the assQuestion object. More...

setId ($id=-1)

Sets the id of the assQuestion object. More...

setTestId ($id=-1)

Sets the test id of the assQuestion object. More...

setComment ($comment="")

Sets the comment string of the assQuestion object. More...

setOutputType ($outputType=OUTPUT_HTML)

Sets the output type. More...

setShuffle ($shuffle=true)

Sets the shuffle flag. More...

setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)

Sets the estimated working time of a question from given hour, minute and second. More...

setEstimatedWorkingTimeFromDurationString ($durationString)

Sets the estimated working time of a question from a given datetime string. More...

keyInArray ($searchkey, $array)

returns TRUE if the key occurs in an array More...

setAuthor ($author="")

Sets the authors name of the assQuestion object. More...

setOwner ($owner="")

Sets the creator/owner ID of the assQuestion object. More...

getTitle ()

Gets the title string of the assQuestion object. More...

getTitleFilenameCompliant ()

returns the object title prepared to be used as a filename More...

getId ()

Gets the id of the assQuestion object. More...

getShuffle ()

Gets the shuffle flag. More...

getTestId ()

Gets the test id of the assQuestion object. More...

getComment ()

Gets the comment string of the assQuestion object. More...

getOutputType ()

Gets the output type. More...

supportsJavascriptOutput ()

Returns true if the question type supports JavaScript output. More...

supportsNonJsOutput ()

requiresJsSwitch ()

getEstimatedWorkingTime ()

Gets the estimated working time of a question. More...

getAuthor ()

Gets the authors name of the assQuestion object. More...

getOwner ()

Gets the creator/owner ID of the assQuestion object. More...

getObjId ()

Get the object id of the container object. More...

setObjId ($obj_id=0)

Set the object id of the container object. More...

setExternalId ($external_id)

getExternalId ()

getSuggestedSolutionOutput ()

& _getSuggestedSolution ($question_id, $subquestion_index=0)

Returns a suggested solution for a given subquestion index. More...

getSuggestedSolutions ()

Return the suggested solutions. More...

getReachedPoints ($active_id, $pass=NULL)

Returns the points, a learner has reached answering the question This is the fast way to get the points directly from the database. More...

getMaximumPoints ()

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

getAdjustedReachedPoints ($active_id, $pass=NULL, $authorizedSolution=true)

returns the reached points ... More...

calculateResultsFromSolution ($active_id, $pass=NULL, $obligationsEnabled=false)

Calculates the question results from a previously saved question solution. More...

persistWorkingState ($active_id, $pass=NULL, $obligationsEnabled=false, $authorized=true)

persists the working state for current testactive and testpass More...

persistPreviewState (ilAssQuestionPreviewSession $previewSession)

persists the preview state for current user and question More...

validateSolutionSubmit ()

saveWorkingData ($active_id, $pass=NULL, $authorized=true)

Saves the learners input of the question to the database. More...

moveUploadedMediaFile ($file, $name)

Move an uploaded media file to an public accessible temp dir to present it. More...

getSuggestedSolutionPath ()

Returns the path for a suggested solution. More...

getJavaPath ()

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

getImagePath ($question_id=null, $object_id=null)

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

buildImagePath ($questionId, $parentObjectId)

getFlashPath ()

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

getJavaPathWeb ()

Returns the web image path for web accessable java applets of a question. More...

getSuggestedSolutionPathWeb ()

Returns the web path for a suggested solution. More...

getImagePathWeb ()

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

getFlashPathWeb ()

Returns the web image path for web accessable flash applications of a question. More...

getTestOutputSolutions ($activeId, $pass)

getUserSolutionPreferingIntermediate ($active_id, $pass=NULL)

getSolutionValues ($active_id, $pass=NULL, $authorized=true)

Loads solutions of a given user from the database an returns it. More...

isInUse ($question_id="")

Checks whether the question is in use or not. More...

isClone ($question_id="")

Checks whether the question is a clone of another question or not. More...

pcArrayShuffle ($array)

Shuffles the values of a given array. More...

getAdditionalTableName ()

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

getAnswerTableName ()

Returns the name of the answer table in the database. More...

deleteAnswers ($question_id)

Deletes datasets from answers tables. More...

deleteAdditionalTableData ($question_id)

Deletes datasets from the additional question table in the database. More...

delete ($question_id)

Deletes a question and all materials from the database. More...

getTotalAnswers ()

get total number of answers More...

_getTotalAnswers ($a_q_id)

get number of answers for question id (static) note: do not use $this inside this method More...

copyXHTMLMediaObjectsOfQuestion ($a_q_id)

syncXHTMLMediaObjectsOfQuestion ()

createPageObject ()

create page object of question More...

copyPageOfQuestion ($a_q_id)

getPageOfQuestion ()

setOriginalId ($original_id)

getOriginalId ()

fixSvgToPng ($imageFilenameContainingString)

fixUnavailableSkinImageSources ($html)

loadFromDb ($question_id)

Loads the question from the database. More...

createNewQuestion ($a_create_page=true)

Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...

saveQuestionDataToDb ($original_id="")

saveToDb ($original_id="")

Saves the question to the database. More...

setNewOriginalId ($newId)

deleteSuggestedSolutions ()

Deletes all suggestes solutions in the database. More...

getSuggestedSolution ($subquestion_index=0)

Returns a suggested solution for a given subquestion index. More...

getSuggestedSolutionTitle ($subquestion_index=0)

Returns the title of a suggested solution at a given subquestion_index. More...

setSuggestedSolution ($solution_id="", $subquestion_index=0, $is_import=false)

Sets a suggested solution for the question. More...

_resolveInternalLink ($internal_link)

_resolveIntLinks ($question_id)

syncWithOriginal ()

createRandomSolution ($test_id, $user_id)

_questionExists ($question_id)

Returns true if the question already exists in the database. More...

_questionExistsInPool ($question_id)

Returns true if the question already exists in the database and is assigned to a question pool. More...

getPoints ()

Returns the maximum available points for the question. More...

setPoints ($a_points)

Sets the maximum available points for the question. More...

getSolutionMaxPass ($active_id)

Returns the maximum pass a users question solution. More...

calculateReachedPoints ($active_id, $pass=NULL, $authorizedSolution=true, $returndetails=FALSE)

Returns the points, a learner has reached answering the question. More...

deductHintPointsFromReachedPoints (ilAssQuestionPreviewSession $previewSession, $reachedPoints)

calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)

adjustReachedPointsByScoringOptions ($points, $active_id, $pass=NULL)

Adjust the given reached points by checks for all special scoring options in the test container. More...

isHTML ($a_text)

Checks if a given string contains HTML or not. More...

prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE, $omitNl2BrWhenTextArea=false)

Prepares a string for a text area output in tests. More...

QTIMaterialToString ($a_material)

Reads an QTI material tag an creates a text string. More...

addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE)

Creates a QTI material tag from a plain text or xhtml text. More...

buildHashedImageFilename ($plain_image_filename, $unique=false)

getQuestion ()

Gets the question string of the question object. More...

setQuestion ($question="")

Sets the question string of the question object. More...

getQuestionType ()

Returns the question type of the question. More...

getQuestionTypeID ()

Returns the question type of the question. More...

cleanupMediaObjectUsage ()

synchronises appearances of media objects in the question with media object usage table More...

& getInstances ()

Gets all instances of the question. More...

getActiveUserData ($active_id)

Returns the user id and the test id for a given active id. More...

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

Creates an Excel worksheet for the detailed cumulated results of this question. More...

__get ($value)

Object getter. More...

__set ($key, $value)

Object setter. More...

getNrOfTries ()

setNrOfTries ($a_nr_of_tries)

setExportImagePath ($a_path)

formatSAQuestion ($a_q)

Format self assessment question. More...

setPreventRteUsage ($a_val)

Set prevent rte usage. More...

getPreventRteUsage ()

Get prevent rte usage. More...

migrateContentForLearningModule (ilAssSelfAssessmentMigrator $migrator)

setSelfAssessmentEditingMode ($a_selfassessmenteditingmode)

Set Self-Assessment Editing Mode. More...

getSelfAssessmentEditingMode ()

Get Self-Assessment Editing Mode. More...

setDefaultNrOfTries ($a_defaultnroftries)

Set Default Nr of Tries. More...

getDefaultNrOfTries ()

Get Default Nr of Tries. More...

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

isAnswered ($active_id, $pass=null)

returns boolean wether the question is answered during test pass or not More...

isAutosaveable ()

getAdditionalContentEditingMode ()

getter for additional content editing mode for this question More...

setAdditionalContentEditingMode ($additinalContentEditingMode)

setter for additional content editing mode for this question More...

isAdditionalContentEditingModePageObject ()

isser for additional "pageobject" content editing mode More...

isValidAdditionalContentEditingMode ($additionalContentEditingMode)

returns the fact wether the passed additional content mode is valid or not More...

getValidAdditionalContentEditingModes ()

getter for valid additional content editing modes More...

addQuestionChangeListener (ilQuestionChangeListener $listener)

getQuestionChangeListeners ()

getHtmlUserSolutionPurifier ()

getHtmlQuestionContentPurifier ()

setLastChange ($lastChange)

getLastChange ()

removeIntermediateSolution ($active_id, $pass)

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

saveCurrentSolution ($active_id, $pass, $value1, $value2, $authorized=true, $tstamp=null)

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

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

setStep ($step)

getStep ()

toJSON ()

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

intermediateSolutionExists ($active_id, $pass)

authorizedSolutionExists ($active_id, $pass)

authorizedOrIntermediateSolutionExists ($active_id, $pass)

removeExistingSolutions ($activeId, $pass)

resetUsersAnswer ($activeId, $pass)

removeResultRecord ($activeId, $pass)

fetchValuePairsFromIndexedValues (array $indexedValues)

fetchIndexedValuesFromValuePairs (array $valuePairs)

areObligationsToBeConsidered ()

setObligationsToBeConsidered ($obligationsToBeConsidered)

updateTimestamp ()

getTestPresentationConfig ()

Get the test question configuration (initialised once) More...

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

getOperators ($expression)

Get all available operations for a specific question. More...

getExpressionTypes ()

Get all available expression types for a specific question. More...

getUserQuestionResult ($active_id, $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...

Data Fields
	$maxchars

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

const	IMG_MIME_TYPE_PNG = 'image/png'

const	IMG_MIME_TYPE_GIF = 'image/gif'

const	ADDITIONAL_CONTENT_EDITING_MODE_DEFAULT = 'default'
	constant for additional content editing mode "default" More...

const	ADDITIONAL_CONTENT_EDITING_MODE_PAGE_OBJECT = 'pageobject'
	constant for additional content editing mode "pageobject" More...

	$feedbackOBJ = null

	$prevent_rte_usage = false

	$selfassessmenteditingmode = false

	$defaultnroftries = 0

	$questionActionCmd = 'handleQuestionAction'

const	KEY_VALUES_IMPLOSION_SEPARATOR = ':'

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

const	PercentageResultExpression = '%n%'

const	NumericResultExpression = '#n#'

const	MatchingResultExpression = ';n:m;'

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

const	NumberOfResultExpression = '+n+'

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

const	EmptyAnswerExpression = "?"

Protected Member Functions

isValidNumericSubmitValue ($submittedValue)

savePreviewData (ilAssQuestionPreviewSession $previewSession)

reworkWorkingData ($active_id, $pass, $obligationsAnswered, $authorized)

{Reworks the allready saved working data if neccessary.

Parameters

integer	$active_id
integer	$pass
boolean	$obligationsAnswered
boolean	$authorized

} More...

Protected Member Functions inherited from assQuestion

getQuestionAction ()

isNonEmptyItemListPostSubmission ($postSubmissionFieldname)

ensureCurrentTestPass ($active_id, $pass)

lookupCurrentTestPass ($active_id, $pass)

lookupTestId ($active_id)

log ($active_id, $langVar)

reworkWorkingData ($active_id, $pass, $obligationsAnswered, $authorized)

Reworks the allready saved working data if neccessary. More...

savePreviewData (ilAssQuestionPreviewSession $previewSession)

deletePageOfQuestion ($question_id)

Deletes the page object of a question with a given ID. More...

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

Will be called when a question is duplicated (inside a question pool or for insertion in a test) More...

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

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

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

Will be called when a question is copied (into another question pool) More...

duplicateSuggestedSolutionFiles ($parent_id, $question_id)

Duplicates the files of a suggested solution if the question is duplicated. More...

syncSuggestedSolutionFiles ($original_id)

Syncs the files of a suggested solution if the question is synced. More...

copySuggestedSolutionFiles ($source_questionpool_id, $source_question_id)

ensureNonNegativePoints ($points)

getRTETextWithMediaObjects ()

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

getSelfAssessmentFormatter ()

lmMigrateQuestionTypeGenericContent (ilAssSelfAssessmentMigrator $migrator)

lmMigrateQuestionTypeSpecificContent (ilAssSelfAssessmentMigrator $migrator)

duplicateQuestionHints ($originalQuestionId, $duplicateQuestionId)

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

buildQuestionDataQuery ()

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

Get a restulset for the current user solution for a this question by active_id and pass. More...

removeSolutionRecordById ($solutionId)

getSolutionRecordById ($solutionId)

deleteDummySolutionRecord ($activeId, $passIndex)

deleteSolutionRecordByValues ($activeId, $passIndex, $authorized, $matchValues)

duplicateIntermediateSolutionAuthorized ($activeId, $passIndex)

forceExistingIntermediateSolution ($activeId, $passIndex, $considerDummyRecordCreation)

buildTestPresentationConfig ()

build basic test question configuration instance More...

Protected Attributes
	$lower_limit

	$upper_limit

Protected Attributes inherited from assQuestion
	$id

	$title

	$comment

	$owner

	$author

	$question

	$points

	$est_working_time

	$shuffle

	$test_id

	$obj_id

	$ilias

	$tpl

	$lng

	$db

	$outputType = OUTPUT_JAVASCRIPT

	$suggested_solutions

	$original_id

	$page

	$external_id = ''

	$questionChangeListeners = array()

	$processLocker

	$step = null

	$lastChange

	$shuffler

	$testQuestionConfig

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

static	isForcePassResultUpdateEnabled ()

static	isAllowedImageMimeType ($mimeType)

static	fetchMimeTypeIdentifier ($contentTypeString)

static	getAllowedFileExtensionsForMimeType ($mimeType)

static	isAllowedImageFileExtension ($mimeType, $fileExtension)

static	getAllowedImageMaterialFileExtensions ()

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

static	_getQuestionInfo ($question_id)
	Returns question information from the database. More...

static	_getSuggestedSolutionCount ($question_id)
	Returns the number of suggested solutions associated with a question. More...

static	_getSuggestedSolutionOutput ($question_id)
	Returns the output of the suggested solution. More...

static	_getReachedPoints ($active_id, $question_id, $pass=NULL)
	Returns the points, a learner has reached answering the question. More...

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

static	logAction ($logtext="", $active_id="", $question_id="")
	Logs an action into the Test&Assessment log. More...

static	getQuestionTypeFromDb ($question_id)
	get question type for question id More...

static	_getTotalRightAnswers ($a_q_id)
	get number of answers for question id (static) note: do not use $this inside this method More...

static	_getTitle ($a_q_id)
	Returns the title of a question. More...

static	_getQuestionText ($a_q_id)
	Returns question text. More...

static	isFileAvailable ($file)

static	_getQuestionType ($question_id)
	Returns the question type of a question with a given id. More...

static	_getQuestionTitle ($question_id)
	Returns the question title of a question with a given id. More...

static	saveOriginalId ($questionId, $originalId)

static	resetOriginalId ($questionId)

static	_getInternalLinkHref ($target="")

static	_getOriginalId ($question_id)
	Returns the original id of a question. More...

static	originalQuestionExists ($questionId)

static	_instanciateQuestion ($question_id)
	Creates an instance of a question with a given question id. More...

static	_instantiateQuestion ($question_id)

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

static	_isWriteable ($question_id, $user_id)
	Returns true if the question is writeable by a certain user. More...

static	_isUsedInRandomTest ($question_id="")
	Checks whether the question is used in a random test or not. More...

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

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

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

static	_needsManualScoring ($question_id)

static	_includeClass ($question_type, $gui=0)
	Include the php class file for a given question type. More...

static	getGuiClassNameByQuestionType ($questionType)

static	getObjectClassNameByQuestionType ($questionType)

static	getFeedbackClassNameByQuestionType ($questionType)

static	isCoreQuestionType ($questionType)

static	includeCoreClass ($questionType, $withGuiClass)

static	includePluginClass ($questionType, $withGuiClass)

static	_getQuestionTypeName ($type_tag)
	Return the translation for a given question type tag. More...

static &	_instanciateQuestionGUI ($question_id)
	Creates an instance of a question gui with a given question id. More...

static	instantiateQuestionGUI ($a_question_id)
	Creates an instance of a question gui with a given question id. More...

static	_questionExistsInTest ($question_id, $test_id)

static	lookupParentObjId ($questionId)
	@global ilDBInterface $ilDB More...

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

static	isObligationPossible ($questionId)
	returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration More...

static	implodeKeyValues ($keyValues)

static	explodeKeyValues ($keyValues)

static	setResultGateway ($resultGateway)

static	getResultGateway ()

static	sumTimesInISO8601FormatH_i_s_Extended ($time1, $time2)

static	convertISO8601FormatH_i_s_ExtendedToSeconds ($time)

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

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

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

Static Protected Member Functions inherited from assQuestion
static	getNumExistingSolutionRecords ($activeId, $pass, $questionId)
	returns the number of existing solution records for the given test active / pass and given question id More...

static	getKeyValuesImplosionSeparator ()

Static Protected Attributes inherited from assQuestion
static	$allowedFileExtensionsByMimeType

static	$allowedCharsetsByMimeType

static	$allowedImageMaterialFileExtensionsByMimeType

static	$forcePassResultsUpdateEnabled = 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 26 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

Reimplemented from assQuestion.

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

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

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

Member Function Documentation

◆ calculateReachedPointsFromPreviewSession()

assNumeric::calculateReachedPointsFromPreviewSession ( ilAssQuestionPreviewSession $previewSession )

Reimplemented from assQuestion.

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

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

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

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

        {
                require_once './Services/Math/classes/class.EvalMath.php';
                $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;
        }

References $result, e(), and getUpperLimit().

Referenced by calculateReachedPointsFromPreviewSession().

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

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

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

Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

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

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

        {
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }
 
                include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
 
                $sourceQuestionId = $this->id;
                $sourceParentId = $this->getObjId();
 
                // duplicate the question in database
                $clone = $this;
                $clone->id = -1;
 
                $clone->setObjId($targetParentId);
 
                if ($targetQuestionTitle)
                {
                        $clone->setTitle($targetQuestionTitle);
                }
 
                $clone->saveToDb();
                // copy question page content
                $clone->copyPageOfQuestion($sourceQuestionId);
                // copy XHTML media objects
                $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
 
                $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
 
                return $clone->id;
        }

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

Here is the call graph for this function:

◆ duplicate()

assNumeric::duplicate	(	$for_test = `true`,
		$title = `""`,
		$author = `""`,
		$owner = `""`,
		$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.

Reimplemented from assQuestion.

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

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

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

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

Reimplemented from assQuestion.

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

        {
                return "qpl_qst_numeric";
        }

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

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

References getLowerLimit(), and 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 677 of file class.assNumeric.php.

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

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

◆ getLowerLimit()

assNumeric::getLowerLimit ( )

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

        {
                return $this->lower_limit;
        }

References $lower_limit.

Referenced by getAvailableAnswerOptions().

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

        {
                return $this->maxchars;
        }

References $maxchars.

◆ getMaximumPoints()

assNumeric::getMaximumPoints ( )

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

See also: $points

Reimplemented from assQuestion.

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

        {
                return $this->getPoints();
        }

References assQuestion\getPoints().

Referenced by isComplete().

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

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

References ilOperatorsExpressionMapping\getOperatorsByExpression().

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

Reimplemented from assQuestion.

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

        {
                return "assNumeric";
        }

◆ getRTETextWithMediaObjects()

assNumeric::getRTETextWithMediaObjects ( )

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

Reimplemented from assQuestion.

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

        {
                return parent::getRTETextWithMediaObjects();
        }

◆ getSolutionSubmit()

assNumeric::getSolutionSubmit ( )

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

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

References $_POST.

Referenced by savePreviewData(), and validateSolutionSubmit().

Here is the caller graph for this function:

◆ getUpperLimit()

assNumeric::getUpperLimit ( )

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

        {
                return $this->upper_limit;
        }

References $upper_limit.

Referenced by contains(), and getAvailableAnswerOptions().

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

Reimplemented from assQuestion.

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

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

References getMaximumPoints().

Here is the call graph for this function:

◆ isValidNumericSubmitValue()

assNumeric::isValidNumericSubmitValue ( $submittedValue )

protected

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

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

Referenced by validateSolutionSubmit().

Here is the caller graph for this function:

◆ isValidSolutionSubmit()

assNumeric::isValidSolutionSubmit ( $numeric_solution )

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

        {
                require_once './Services/Math/classes/class.EvalMath.php';
                $math = new EvalMath();
                $math->suppress_errors = TRUE;
                $result = $math->evaluate($numeric_solution);
                
                return !(
                        ($result === FALSE || $result === TRUE) && strlen($numeric_solution) > 0
                );
        }

References $result.

◆ reworkWorkingData()

assNumeric::reworkWorkingData	(	$active_id,
		$pass,
		$obligationsAnswered,
		$authorized
	)

protected

{Reworks the allready saved working data if neccessary.

Parameters

integer	$active_id
integer	$pass
boolean	$obligationsAnswered
boolean	$authorized

}

Reimplemented from assQuestion.

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

        {
                // nothing to rework!
        }

◆ savePreviewData()

assNumeric::savePreviewData ( ilAssQuestionPreviewSession $previewSession )

protected

Reimplemented from assQuestion.

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

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

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

Here is the call graph for this function:

◆ saveToDb()

assNumeric::saveToDb ( $original_id = "" )

Saves a assNumeric object to a database.

Parameters

string $original_id

Reimplemented from assQuestion.

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

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

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

Here is the call graph for this function:

◆ setExportDetailsXLS()

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

{Creates an Excel worksheet for the detailed cumulated results of this question.

Parameters

object	$worksheet	Reference to the parent excel worksheet
object	$startrow	Startrow of the output in the excel worksheet
object	$active_id	Active id of the participant
object	$pass	Test pass

Returns: object

}

Reimplemented from assQuestion.

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

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

References $pass, $worksheet, and assQuestion\getSolutionValues().

Here is the call graph for this function:

◆ setLowerLimit()

assNumeric::setLowerLimit ( $a_limit )

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

        {
                $a_limit = str_replace(',', '.', $a_limit);
                $this->lower_limit = $a_limit;
        }

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

        {
                $this->maxchars = $maxchars;
        }

References $maxchars.

◆ setUpperLimit()

assNumeric::setUpperLimit ( $a_limit )

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

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

◆ validateSolutionSubmit()

assNumeric::validateSolutionSubmit ( )

Reimplemented from assQuestion.

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

        {
                if( strlen($this->getSolutionSubmit()) && !$this->isValidNumericSubmitValue($this->getSolutionSubmit()) )
                {
                        ilUtil::sendFailure($this->lng->txt("err_no_numeric_value"), true);
                        return false;
                }
                
                return true;
        }

References getSolutionSubmit(), isValidNumericSubmitValue(), and ilUtil\sendFailure().

Here is the call graph for this function:

Field Documentation

◆ $lower_limit

assNumeric::$lower_limit

protected

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

Referenced by getLowerLimit().

◆ $maxchars

assNumeric::$maxchars

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

Referenced by getMaxChars(), and setMaxChars().

◆ $upper_limit

assNumeric::$upper_limit

protected

Definition at line 29 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()

◆ getAvailableAnswerOptions()

◆ getExpressionTypes()

◆ getLowerLimit()

◆ getMaxChars()

◆ getMaximumPoints()

◆ getOperators()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getSolutionSubmit()

◆ getUpperLimit()

◆ isComplete()

◆ isValidNumericSubmitValue()

◆ isValidSolutionSubmit()

◆ reworkWorkingData()

◆ savePreviewData()

◆ saveToDb()

◆ setExportDetailsXLS()

◆ setLowerLimit()

◆ setMaxChars()

◆ setUpperLimit()

◆ validateSolutionSubmit()

Field Documentation

◆ $lower_limit

◆ $maxchars

◆ $upper_limit