Class for Java Applet Questions. More...

Inheritance diagram for assJavaApplet:

Collaboration diagram for assJavaApplet:

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

	splitParams ($params="")
	Sets the applet parameters from a parameter string containing all parameters in a list. More...

	buildParams ()
	Returns a string containing the applet parameters. More...

	buildParamsOnly ()
	Returns a string containing the additional applet parameters. More...

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

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

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

	loadFromDb ($question_id)
	Loads a assJavaApplet object from a database. More...

	duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
	Duplicates an assJavaApplet. More...

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

	createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")

	duplicateApplet ($question_id, $objectId=null)

	copyApplet ($question_id, $source_questionpool)

	getJavaCode ()
	Returns the java applet code parameter. More...

	getJavaCodebase ()
	Returns the java applet codebase parameter. More...

	getJavaArchive ()
	Returns the java applet archive parameter. More...

	setJavaCode ($java_code="")
	Sets the java applet code parameter. More...

	setJavaCodebase ($java_codebase="")
	Sets the java applet codebase parameter. More...

	setJavaArchive ($java_archive="")
	Sets the java applet archive parameter. More...

	getJavaWidth ()
	Returns the java applet width parameter. More...

	setJavaWidth ($java_width="")
	Sets the java applet width parameter. More...

	getJavaHeight ()
	Returns the java applet height parameter. More...

	setJavaHeight ($java_height="")
	Sets the java applet height parameter. More...

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

	calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)

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

	getSolutionValuesRegardlessOfAuthorization ($active_id, $pass=null)

	getReachedInformation ($active_id, $pass=null)
	Returns the evaluation data, a learner has entered to answer the question. More...

	addParameter ($name="", $value="")
	Adds a new parameter value to the parameter list. More...

	addParameterAtIndex ($index=0, $name="", $value="")

	removeParameter ($index)
	Removes a parameter value from the parameter list. More...

	getParameter ($index)
	Returns the paramter at a given index. More...

	getParameterIndex ($name)
	Returns the index of an applet parameter. More...

	getParameterCount ()
	Returns the number of additional applet parameters. More...

	flushParams ()
	Removes all applet parameters. More...

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

	getJavaAppletFilename ()
	Gets the java applet file name. More...

	setJavaAppletFilename ($javaapplet_filename, $javaapplet_tempfilename="")
	Sets the java applet file name. More...

	deleteJavaAppletFilename ()

	getQuestionType ()
	Returns the question type of the question. 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)
	{} More...

	isAutosaveable ()

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

	buildTestPresentationConfig ()
	Get the test question configuration. More...

Public Member Functions inherited from assQuestion
	getShuffler ()

	setShuffler (ilArrayElementShuffler $shuffler)

	setProcessLocker ($processLocker)

	getProcessLocker ()

	fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping, array $solutionhints=[])
	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...

	getDescriptionForHTMLOutput ()

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

	getAuthorForHTMLOutput ()

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

	getLifecycle ()

	setLifecycle (ilAssQuestionLifecycle $lifecycle)

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

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

	getQuestionForHTMLOutput ()

	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)

	isAddableAnswerOptionValue ($qIndex, $answerOptionValue)

	addAnswerOptionValue ($qIndex, $answerOptionValue, $points)

	removeAllExistingSolutions ()

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

	savePartial ()

	isInActiveTest ()

Data Fields
	$javaapplet_filename

	$java_code

	$java_codebase

	$java_archive

	$java_width

	$java_height

	$parameters

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_RTE = 'default'
	constant for additional content editing mode "default" More...

const	ADDITIONAL_CONTENT_EDITING_MODE_IPE = '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
	savePreviewData (ilAssQuestionPreviewSession $previewSession)

Protected Member Functions inherited from assQuestion
	getQuestionAction ()

	isNonEmptyItemListPostSubmission ($postSubmissionFieldname)

	ensureCurrentTestPass ($active_id, $pass)

	lookupCurrentTestPass ($active_id, $pass)

	lookupTestId ($active_id)

	log ($active_id, $langVar)

	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)

	purifyAndPrepareTextAreaOutput (string $content)

	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)

	isDummySolutionRecord ($solutionRecord)

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

	duplicateIntermediateSolutionAuthorized ($activeId, $passIndex)

	forceExistingIntermediateSolution ($activeId, $passIndex, $considerDummyRecordCreation)

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

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

Protected Attributes inherited from assQuestion
	$id

	$title

	$comment

	$owner

	$author

	$question

	$points

	$est_working_time

	$shuffle

	$test_id

	$obj_id

	$ilias

	$tpl

	$lng

	$db

	$refinery

	$outputType = OUTPUT_JAVASCRIPT

	$suggested_solutions

	$original_id

	$page

	$external_id = ''

	$questionChangeListeners = array()

	$processLocker

	$step = null

	$lastChange

	$shuffler

	$testQuestionConfig

	$lifecycle

Static Protected Attributes inherited from assQuestion
static	$allowedFileExtensionsByMimeType

static	$allowedCharsetsByMimeType

static	$allowedImageMaterialFileExtensionsByMimeType

static	$forcePassResultsUpdateEnabled = false

static	$imageSourceFixReplaceMap

Detailed Description

Class for Java Applet Questions.

assJavaApplet is a class for Java Applet Questions.

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m; 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 23 of file class.assJavaApplet.php.

Constructor & Destructor Documentation

◆ __construct()

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

assJavaApplet constructor

The constructor takes possible arguments an creates an instance of the assJavaApplet 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 multiple choice question.
string	$javaapplet_filename	Applet filename.

Returns

Definition at line 102 of file class.assJavaApplet.php.

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

       {
         parent::__construct($title, $comment, $author, $owner, $question);
         $this->javaapplet_filename = $javaapplet_filename;
         $this->parameters = array();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addParameter()

assJavaApplet::addParameter	(	$name = `""`,
		$value = `""`
	)

Adds a new parameter value to the parameter list.

Parameters

string	$name	The name of the parameter value
string	$value	The value of the parameter value public

See also: $parameters

Definition at line 726 of file class.assJavaApplet.php.

References $index, $name, and getParameterIndex().

     {
         $index = $this->getParameterIndex($name);
         if ($index > -1) {
             $this->parameters[$index] = array("name" => $name, "value" => $value);
         } else {
             array_push($this->parameters, array("name" => $name, "value" => $value));
         }
     }

Here is the call graph for this function:

◆ addParameterAtIndex()

assJavaApplet::addParameterAtIndex	(	$index = `0`,
		$name = `""`,
		$value = `""`
	)

Definition at line 736 of file class.assJavaApplet.php.

References $i, $index, and $name.

     {
         if (array_key_exists($index, $this->parameters)) {
             // insert parameter
             $newparams = array();
             for ($i = 0; $i < $index; $i++) {
                 array_push($newparams, $this->parameters[$i]);
             }
             array_push($newparams, array($name, $value));
             for ($i = $index; $i < count($this->parameters); $i++) {
                 array_push($newparams, $this->parameters[$i]);
             }
             $this->parameters = $newparams;
         } else {
             array_push($this->parameters, array($name, $value));
         }
     }

◆ buildParams()

assJavaApplet::buildParams ( )

Returns a string containing the applet parameters.

Returns a string containing the applet parameters. This is used for saving the applet data to database

Returns: string All applet parameters

Definition at line 161 of file class.assJavaApplet.php.

Referenced by saveAdditionalQuestionDataToDb().

     {
         $params_array = array();
         if ($this->java_code) {
             array_push($params_array, "java_code=$this->java_code");
         }
         if ($this->java_codebase) {
             array_push($params_array, "java_codebase=$this->java_codebase");
         }
         if ($this->java_archive) {
             array_push($params_array, "java_archive=$this->java_archive");
         }
         if ($this->java_width) {
             array_push($params_array, "java_width=$this->java_width");
         }
         if ($this->java_height) {
             array_push($params_array, "java_height=$this->java_height");
         }
         foreach ($this->parameters as $key => $value) {
             array_push($params_array, "param_name_$key=" . $value["name"]);
             array_push($params_array, "param_value_$key=" . $value["value"]);
         }
         
         return join("<separator>", $params_array);
     }

Here is the caller graph for this function:

◆ buildParamsOnly()

assJavaApplet::buildParamsOnly ( )

Returns a string containing the additional applet parameters.

Returns: string All additional applet parameters

Definition at line 192 of file class.assJavaApplet.php.

     {
         $params_array = array();
         if ($this->java_code) {
             array_push($params_array, "java_code=$this->java_code");
             array_push($params_array, "java_codebase=$this->java_codebase");
             array_push($params_array, "java_archive=$this->java_archive");
         }
         foreach ($this->parameters as $key => $value) {
             array_push($params_array, "param_name_$key=" . $value["name"]);
             array_push($params_array, "param_value_$key=" . $value["value"]);
         }
         return join("<separator>", $params_array);
     }

◆ buildTestPresentationConfig()

assJavaApplet::buildTestPresentationConfig ( )

Get the test question configuration.

Returns: ilTestQuestionConfig

Definition at line 1028 of file class.assJavaApplet.php.

     {
         // hey: refactored identifiers
         return parent::buildTestPresentationConfig()
         // hey.
             ->setFormChangeDetectionEnabled(false)
             ->setBackgroundChangeDetectionEnabled(true);
     }

◆ calculateReachedPoints()

assJavaApplet::calculateReachedPoints	(	$active_id,
		$pass = `null`,
		$authorizedSolution = `true`,
		$returndetails = `false`
	)

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

The points are calculated from the given answers.

Parameters

integer	$active_id
integer	$pass
boolean	$returndetails	(deprecated !!)

Exceptions

ilTestException

Returns: integer/array $points/$details (array $details is deprecated !!)

Definition at line 617 of file class.assJavaApplet.php.

References $data, $DIC, $ilDB, $pass, assQuestion\$points, $result, assQuestion\getCurrentSolutionResultSet(), and assQuestion\getSolutionMaxPass().

Referenced by getUserQuestionResult().

     {
         if ($returndetails) {
             throw new ilTestException('return details not implemented for ' . __METHOD__);
         }
         
         global $DIC;
         $ilDB = $DIC['ilDB'];
         
         $found_values = array();
         if (is_null($pass)) {
             $pass = $this->getSolutionMaxPass($active_id);
         }
         
         $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);
         
         $points = 0;
         while ($data = $ilDB->fetchAssoc($result)) {
             $points += $data["points"];
         }
 
         return $points;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateReachedPointsFromPreviewSession()

assJavaApplet::calculateReachedPointsFromPreviewSession ( ilAssQuestionPreviewSession $previewSession )

Definition at line 641 of file class.assJavaApplet.php.

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

     {
         $points = 0;
         foreach ($previewSession->getParticipantsSolution() as $solution) {
             if (isset($solution['points'])) {
                 $points += $solution['points'];
             }
         }
 
         $reachedPoints = $this->deductHintPointsFromReachedPoints($previewSession, $points);
         
         return $this->ensureNonNegativePoints($reachedPoints);
     }

Here is the call graph for this function:

◆ copyApplet()

assJavaApplet::copyApplet	(	$question_id,
		$source_questionpool
	)

Definition at line 463 of file class.assJavaApplet.php.

References $filename, getJavaAppletFilename(), assQuestion\getJavaPath(), and ilUtil\makeDirParents().

     {
         $javapath = $this->getJavaPath();
         $javapath_original = preg_replace("/([^\d])$this->id([^\d])/", "\${1}$question_id\${2}", $javapath);
         $javapath_original = str_replace("/$this->obj_id/", "/$source_questionpool/", $javapath_original);
         if (!file_exists($javapath)) {
             ilUtil::makeDirParents($javapath);
         }
         $filename = $this->getJavaAppletFilename();
         if (!copy($javapath_original . $filename, $javapath . $filename)) {
             print "java applet could not be copied!!!! ";
         }
     }

Here is the call graph for this function:

◆ copyObject()

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

Copies an assJavaApplet object.

Copies an assJavaApplet object

public

Definition at line 380 of file class.assJavaApplet.php.

References assQuestion\$original_id, assQuestion\$title, assQuestion\_getOriginalId(), 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;
         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);
         // duplicate the image
         $clone->copyApplet($original_id, $source_questionpool_id);
         
         $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
         
         return $clone->id;
     }

Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

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

Definition at line 410 of file class.assJavaApplet.php.

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

     {
         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);
         // duplicate the image
         $clone->copyApplet($sourceQuestionId, $sourceParentId);
 
         $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
 
         return $clone->id;
     }

Here is the call graph for this function:

◆ deleteJavaAppletFilename()

assJavaApplet::deleteJavaAppletFilename ( )

Definition at line 899 of file class.assJavaApplet.php.

References getJavaAppletFilename(), and assQuestion\getJavaPath().

     {
         @unlink($this->getJavaPath() . $this->getJavaAppletFilename());
         $this->javaapplet_filename = "";
     }

Here is the call graph for this function:

◆ duplicate()

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

Duplicates an assJavaApplet.

public

Definition at line 327 of file class.assJavaApplet.php.

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

     {
         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;
         include_once("./Modules/TestQuestionPool/classes/class.assQuestion.php");
         $original_id = assQuestion::_getOriginalId($this->id);
         $clone->id = -1;
         
         if ((int) $testObjId > 0) {
             $clone->setObjId($testObjId);
         }
         
         if ($title) {
             $clone->setTitle($title);
         }
         if ($author) {
             $clone->setAuthor($author);
         }
         if ($owner) {
             $clone->setOwner($owner);
         }
         if ($for_test) {
             $clone->saveToDb($original_id);
         } else {
             $clone->saveToDb();
         }
 
         // copy question page content
         $clone->copyPageOfQuestion($this_id);
         // copy XHTML media objects
         $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
         // duplicate the image
         $clone->duplicateApplet($this_id, $thisObjId);
 
         $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
         
         return $clone->id;
     }

Here is the call graph for this function:

◆ duplicateApplet()

assJavaApplet::duplicateApplet	(	$question_id,
		$objectId = `null`
	)

Definition at line 445 of file class.assJavaApplet.php.

References $filename, getJavaAppletFilename(), assQuestion\getJavaPath(), and ilUtil\makeDirParents().

     {
         $javapath = $this->getJavaPath();
         $javapath_original = preg_replace("/([^\d])$this->id([^\d])/", "\${1}$question_id\${2}", $javapath);
         
         if ((int) $objectId > 0) {
             $javapath_original = str_replace("/$this->obj_id/", "/$objectId/", $javapath_original);
         }
         
         if (!file_exists($javapath)) {
             ilUtil::makeDirParents($javapath);
         }
         $filename = $this->getJavaAppletFilename();
         if (!copy($javapath_original . $filename, $javapath . $filename)) {
             print "java applet could not be duplicated!!!! ";
         }
     }

Here is the call graph for this function:

◆ flushParams()

assJavaApplet::flushParams ( )

Removes all applet parameters.

public

See also: $parameters

Definition at line 828 of file class.assJavaApplet.php.

     {
         $this->parameters = array();
     }

◆ getAdditionalTableName()

assJavaApplet::getAdditionalTableName ( )

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

Returns: string The additional table name

Definition at line 920 of file class.assJavaApplet.php.

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

     {
         return "qpl_qst_javaapplet";
     }

Here is the caller graph for this function:

◆ getAvailableAnswerOptions()

assJavaApplet::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 1017 of file class.assJavaApplet.php.

     {
         return array();
     }

◆ getExpressionTypes()

assJavaApplet::getExpressionTypes ( )

Get all available expression types for a specific question.

Returns: array

Implements iQuestionCondition.

Definition at line 981 of file class.assJavaApplet.php.

References iQuestionCondition\EmptyAnswerExpression, and iQuestionCondition\PercentageResultExpression.

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

◆ getJavaAppletFilename()

assJavaApplet::getJavaAppletFilename ( )

Gets the java applet file name.

Returns: string The java applet file of the assJavaApplet object public

See also: $javaapplet_filename

Definition at line 866 of file class.assJavaApplet.php.

References $javaapplet_filename.

Referenced by copyApplet(), deleteJavaAppletFilename(), and duplicateApplet().

     {
         return $this->javaapplet_filename;
     }

Here is the caller graph for this function:

◆ getJavaArchive()

assJavaApplet::getJavaArchive ( )

Returns the java applet archive parameter.

Returns the java applet archive parameter

Returns: string java applet archive parameter public

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

References $java_archive.

Referenced by isComplete().

     {
         return $this->java_archive;
     }

Here is the caller graph for this function:

◆ getJavaCode()

assJavaApplet::getJavaCode ( )

Returns the java applet code parameter.

Returns the java applet code parameter

Returns: string java applet code parameter public

Definition at line 485 of file class.assJavaApplet.php.

References $java_code.

     {
         return $this->java_code;
     }

◆ getJavaCodebase()

assJavaApplet::getJavaCodebase ( )

Returns the java applet codebase parameter.

Returns the java applet codebase parameter

Returns: string java applet codebase parameter public

Definition at line 498 of file class.assJavaApplet.php.

References $java_codebase.

Referenced by isComplete().

     {
         return $this->java_codebase;
     }

Here is the caller graph for this function:

◆ getJavaHeight()

assJavaApplet::getJavaHeight ( )

Returns the java applet height parameter.

Returns the java applet height parameter

Returns: integer java applet height parameter public

Definition at line 588 of file class.assJavaApplet.php.

References $java_height.

     {
         return $this->java_height;
     }

◆ getJavaWidth()

assJavaApplet::getJavaWidth ( )

Returns the java applet width parameter.

Returns the java applet width parameter

Returns: integer java applet width parameter public

Definition at line 563 of file class.assJavaApplet.php.

References $java_width.

     {
         return $this->java_width;
     }

◆ getOperators()

assJavaApplet::getOperators ( $expression )

Get all available operations for a specific question.

Parameters

$expression

Implements iQuestionCondition.

Definition at line 971 of file class.assJavaApplet.php.

References ilOperatorsExpressionMapping\getOperatorsByExpression().

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

Here is the call graph for this function:

◆ getParameter()

assJavaApplet::getParameter ( $index )

Returns the paramter at a given index.

Parameters

intege $index The index value of the parameter

Returns: array The parameter at the given index public

See also: $parameters

Definition at line 784 of file class.assJavaApplet.php.

References $index.

     {
         if (($index < 0) or ($index >= count($this->parameters))) {
             return undef;
         }
         return $this->parameters[$index];
     }

◆ getParameterCount()

assJavaApplet::getParameterCount ( )

Returns the number of additional applet parameters.

Returns: integer The number of additional applet parameters public

See also: $parameters

Definition at line 817 of file class.assJavaApplet.php.

     {
         return count($this->parameters);
     }

◆ getParameterIndex()

assJavaApplet::getParameterIndex ( $name )

Returns the index of an applet parameter.

Parameters

string $name The name of the parameter value

Returns: integer The index of the applet parameter or -1 if the parameter wasn't found private

See also: $parameters

Definition at line 800 of file class.assJavaApplet.php.

References $name.

Referenced by addParameter().

     {
         foreach ($this->parameters as $key => $value) {
             if (array_key_exists($name, $value)) {
                 return $key;
             }
         }
         return -1;
     }

Here is the caller graph for this function:

◆ getQuestionType()

assJavaApplet::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question

Definition at line 910 of file class.assJavaApplet.php.

     {
         return "assJavaApplet";
     }

◆ getReachedInformation()

assJavaApplet::getReachedInformation	(	$active_id,
		$pass = `null`
	)

Returns the evaluation data, a learner has entered to answer the question.

Parameters

	$active_id
null	$pass

Returns: array

Definition at line 684 of file class.assJavaApplet.php.

References $data, $DIC, $ilDB, $pass, $result, assQuestion\getId(), and assQuestion\getSolutionMaxPass().

Referenced by getSolutionValuesRegardlessOfAuthorization().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         
         $found_values = array();
         if (is_null($pass)) {
             $pass = $this->getSolutionMaxPass($active_id);
         }
         $result = $ilDB->queryF(
             "SELECT * FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
             array('integer','integer','integer'),
             array($active_id, $this->getId(), $pass)
         );
         $counter = 1;
         $user_result = array();
         while ($data = $ilDB->fetchAssoc($result)) {
             $true = 0;
             if ($data["points"] > 0) {
                 $true = 1;
             }
             $solution = array(
                 "order" => $counter,
                 "points" => $data["points"],
                 "true" => $true,
                 "value1" => $data["value1"],
                 "value2" => $data["value2"],
             );
             $counter++;
             array_push($user_result, $solution);
         }
         return $user_result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assJavaApplet::getRTETextWithMediaObjects ( )

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

Definition at line 929 of file class.assJavaApplet.php.

     {
         return parent::getRTETextWithMediaObjects();
     }

◆ getSolutionValues()

assJavaApplet::getSolutionValues	(	$active_id,
		$pass = `null`,
		$authorized = `true`
	)

Definition at line 657 of file class.assJavaApplet.php.

References $pass, and getSolutionValuesRegardlessOfAuthorization().

Referenced by setExportDetailsXLS().

     {
         if (!$authorized) {
             return array();
         }
         
         return $this->getSolutionValuesRegardlessOfAuthorization($active_id, $pass);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSolutionValuesRegardlessOfAuthorization()

assJavaApplet::getSolutionValuesRegardlessOfAuthorization	(	$active_id,
		$pass = `null`
	)

Definition at line 666 of file class.assJavaApplet.php.

References $pass, and getReachedInformation().

Referenced by getSolutionValues().

     {
         // - similar to getSolutionValues in general
         // - does not consider "step" in any kind
         // - returns a customized associative array
         // - is the original implementation for qtype
         return $this->getReachedInformation($active_id, $pass);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserQuestionResult()

assJavaApplet::getUserQuestionResult	(	$active_id,
		$pass
	)

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

Parameters

int	$active_id
int	$pass

Returns: ilUserQuestionResult

Implements iQuestionCondition.

Definition at line 997 of file class.assJavaApplet.php.

References $pass, assQuestion\$points, $result, calculateReachedPoints(), and assQuestion\getMaximumPoints().

     {
         $result = new ilUserQuestionResult($this, $active_id, $pass);
 
         $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:

◆ isAutosaveable()

assJavaApplet::isAutosaveable ( )

Definition at line 958 of file class.assJavaApplet.php.

     {
         return false;
     }

◆ isComplete()

assJavaApplet::isComplete ( )

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

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

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

References getJavaArchive(), getJavaCodebase(), and assQuestion\getPoints().

     {
         if (strlen($this->title)
             && $this->author
             && $this->question
             && $this->javaapplet_filename
             && $this->java_width
             && $this->java_height
             && $this->getPoints() > 0
         ) {
             return true;
         } elseif (strlen($this->title)
             && $this->author
             && $this->question
             && $this->getJavaArchive()
             && $this->getJavaCodebase()
             && $this->java_width
             && $this->java_height
             && $this->getPoints() > 0
         ) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ loadFromDb()

assJavaApplet::loadFromDb ( $question_id )

Loads a assJavaApplet object from a database.

Parameters

integer $question_id A unique key which defines the multiple choice test in the database

Definition at line 281 of file class.assJavaApplet.php.

References $data, $DIC, Vendor\Package\$e, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), setJavaAppletFilename(), assQuestion\setLifecycle(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setTitle(), and splitParams().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $result = $ilDB->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",
             array("integer"),
             array($question_id)
         );
         if ($result->numRows() == 1) {
             $data = $ilDB->fetchAssoc($result);
             $this->setId($question_id);
             $this->setObjId($data["obj_fi"]);
             $this->setNrOfTries($data['nr_of_tries']);
             $this->setTitle($data["title"]);
             $this->setComment($data["description"]);
             $this->setOriginalId($data["original_id"]);
             $this->setAuthor($data["author"]);
             $this->setPoints($data["points"]);
             $this->setOwner($data["owner"]);
             include_once("./Services/RTE/classes/class.ilRTE.php");
             $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
             $this->setJavaAppletFilename($data["image_file"]);
             $this->splitParams($data["params"]);
             $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
             
             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) {
             }
         }
         parent::loadFromDb($question_id);
     }

Here is the call graph for this function:

◆ removeParameter()

assJavaApplet::removeParameter ( $index )

Removes a parameter value from the parameter list.

Parameters

integer $index The parameter index public

See also: $parameters

Definition at line 761 of file class.assJavaApplet.php.

References $index.

     {
         if ($index < 0) {
             return;
         }
         if (count($this->parameters) < 1) {
             return;
         }
         if ($index >= count($this->parameters)) {
             return;
         }
         unset($this->parameters[$index]);
         $this->parameters = array_values($this->parameters);
     }

◆ saveAdditionalQuestionDataToDb()

assJavaApplet::saveAdditionalQuestionDataToDb ( )

Saves a record to the question types additional data table.

Returns: mixed

Implements ilObjQuestionScoringAdjustable.

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

References $DIC, $ilDB, buildParams(), getAdditionalTableName(), and assQuestion\getId().

Referenced by saveToDb().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $params = $this->buildParams();
         // save additional data
         $ilDB->manipulateF(
             "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
             array( "integer" ),
             array( $this->getId() )
         );
         $ilDB->manipulateF(
             "INSERT INTO " . $this->getAdditionalTableName(
                                                             ) . " (question_fi, image_file, params) VALUES (%s, %s, %s)",
             array( "integer", "text", "text" ),
             array(
                                 $this->getId(),
                                 $this->javaapplet_filename,
                                 $params
                             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePreviewData()

assJavaApplet::savePreviewData ( ilAssQuestionPreviewSession $previewSession )

protected

Definition at line 852 of file class.assJavaApplet.php.

     {
         // nothing to save!
 
         return true;
     }

◆ saveToDb()

assJavaApplet::saveToDb ( $original_id = "" )

Saves a assJavaApplet object to a database.

Parameters

string $original_id

Returns: mixed|void

Definition at line 245 of file class.assJavaApplet.php.

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

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

Here is the call graph for this function:

◆ saveWorkingData()

assJavaApplet::saveWorkingData	(	$active_id,
		$pass = `null`,
		$authorized = `true`
	)

Saves the learners input of the question to the database.

public

Parameters

integer	$active_id	Active id of the user
integer	$pass	Test pass

Returns: boolean $status

Definition at line 841 of file class.assJavaApplet.php.

     {
         // nothing to save!
 
         //$this->getProcessLocker()->requestUserSolutionUpdateLock();
         // store in tst_solutions
         //$this->getProcessLocker()->releaseUserSolutionUpdateLock();
         
         return true;
     }

◆ setExportDetailsXLS()

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

{}

Definition at line 937 of file class.assJavaApplet.php.

References $i, $pass, and getSolutionValues().

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

Here is the call graph for this function:

◆ setJavaAppletFilename()

assJavaApplet::setJavaAppletFilename	(	$javaapplet_filename,
		$javaapplet_tempfilename = `""`
	)

Sets the java applet file name.

Parameters

	$javaapplet_filename
string	$javaapplet_tempfilename

See also: $javaapplet_filename

Definition at line 879 of file class.assJavaApplet.php.

References $javaapplet_filename, assQuestion\getJavaPath(), ilUtil\makeDirParents(), ilUtil\moveUploadedFile(), setJavaArchive(), and setJavaCodebase().

Referenced by loadFromDb().

     {
         if (!empty($javaapplet_filename)) {
             $this->javaapplet_filename = $javaapplet_filename;
         }
         if (!empty($javaapplet_tempfilename)) {
             $javapath = $this->getJavaPath();
             if (!file_exists($javapath)) {
                 ilUtil::makeDirParents($javapath);
             }
             
             if (!ilUtil::moveUploadedFile($javaapplet_tempfilename, $javaapplet_filename, $javapath . $javaapplet_filename)) {
                 $ilLog->write("ERROR: java applet question: java applet not uploaded: $javaapplet_filename");
             } else {
                 $this->setJavaCodebase();
                 $this->setJavaArchive();
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setJavaArchive()

assJavaApplet::setJavaArchive ( $java_archive = "" )

Sets the java applet archive parameter.

Sets the java applet archive parameter

Parameters

string java applet archive parameter public

Definition at line 550 of file class.assJavaApplet.php.

References $java_archive.

Referenced by setJavaAppletFilename().

     {
         $this->java_archive = $java_archive;
     }

Here is the caller graph for this function:

◆ setJavaCode()

assJavaApplet::setJavaCode ( $java_code = "" )

Sets the java applet code parameter.

Sets the java applet code parameter

Parameters

string java applet code parameter public

Definition at line 524 of file class.assJavaApplet.php.

References $java_code.

     {
         $this->java_code = $java_code;
     }

◆ setJavaCodebase()

assJavaApplet::setJavaCodebase ( $java_codebase = "" )

Sets the java applet codebase parameter.

Sets the java applet codebase parameter

Parameters

string java applet codebase parameter public

Definition at line 537 of file class.assJavaApplet.php.

References $java_codebase.

Referenced by setJavaAppletFilename().

     {
         $this->java_codebase = $java_codebase;
     }

Here is the caller graph for this function:

◆ setJavaHeight()

assJavaApplet::setJavaHeight ( $java_height = "" )

Sets the java applet height parameter.

Sets the java applet height parameter

Parameters

integer java applet height parameter public

Definition at line 601 of file class.assJavaApplet.php.

References $java_height.

     {
         $this->java_height = $java_height;
     }

◆ setJavaWidth()

assJavaApplet::setJavaWidth ( $java_width = "" )

Sets the java applet width parameter.

Sets the java applet width parameter

Parameters

string $java_width applet width parameter

Definition at line 575 of file class.assJavaApplet.php.

References $java_width.

     {
         $this->java_width = $java_width;
     }

◆ splitParams()

assJavaApplet::splitParams ( $params = "" )

Sets the applet parameters from a parameter string containing all parameters in a list.

Sets the applet parameters from a parameter string containing all parameters in a list

Parameters

string $params All applet parameters in a list

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

Referenced by loadFromDb().

     {
         $params_array = explode("<separator>", $params);
         foreach ($params_array as $pair) {
             if (preg_match("/(.*?)\=(.*)/", $pair, $matches)) {
                 switch ($matches[1]) {
                     case "java_code":
                         $this->java_code = $matches[2];
                         break;
                     case "java_codebase":
                         $this->java_codebase = $matches[2];
                         break;
                     case "java_archive":
                         $this->java_archive = $matches[2];
                         break;
                     case "java_width":
                         $this->java_width = $matches[2];
                         break;
                     case "java_height":
                         $this->java_height = $matches[2];
                         break;
                 }
                 if (preg_match("/param_name_(\d+)/", $matches[1], $found_key)) {
                     $this->parameters[$found_key[1]]["name"] = $matches[2];
                 }
                 if (preg_match("/param_value_(\d+)/", $matches[1], $found_key)) {
                     $this->parameters[$found_key[1]]["value"] = $matches[2];
                 }
             }
         }
     }

Here is the caller graph for this function:

Field Documentation

◆ $java_archive

assJavaApplet::$java_archive

Definition at line 59 of file class.assJavaApplet.php.

Referenced by getJavaArchive(), and setJavaArchive().

◆ $java_code

assJavaApplet::$java_code

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

Referenced by getJavaCode(), and setJavaCode().

◆ $java_codebase

assJavaApplet::$java_codebase

Definition at line 50 of file class.assJavaApplet.php.

Referenced by getJavaCodebase(), and setJavaCodebase().

◆ $java_height

assJavaApplet::$java_height

Definition at line 77 of file class.assJavaApplet.php.

Referenced by getJavaHeight(), and setJavaHeight().

◆ $java_width

assJavaApplet::$java_width

Definition at line 68 of file class.assJavaApplet.php.

Referenced by getJavaWidth(), and setJavaWidth().

◆ $javaapplet_filename

assJavaApplet::$javaapplet_filename

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

Referenced by __construct(), getJavaAppletFilename(), and setJavaAppletFilename().

◆ $parameters

assJavaApplet::$parameters

Definition at line 86 of file class.assJavaApplet.php.

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

Modules/TestQuestionPool/classes/class.assJavaApplet.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addParameter()

◆ addParameterAtIndex()

◆ buildParams()

◆ buildParamsOnly()

◆ buildTestPresentationConfig()

◆ calculateReachedPoints()

◆ calculateReachedPointsFromPreviewSession()

◆ copyApplet()

◆ copyObject()

◆ createNewOriginalFromThisDuplicate()

◆ deleteJavaAppletFilename()

◆ duplicate()

◆ duplicateApplet()

◆ flushParams()

◆ getAdditionalTableName()

◆ getAvailableAnswerOptions()

◆ getExpressionTypes()

◆ getJavaAppletFilename()

◆ getJavaArchive()

◆ getJavaCode()

◆ getJavaCodebase()

◆ getJavaHeight()

◆ getJavaWidth()

◆ getOperators()

◆ getParameter()

◆ getParameterCount()

◆ getParameterIndex()

◆ getQuestionType()

◆ getReachedInformation()

◆ getRTETextWithMediaObjects()

◆ getSolutionValues()

◆ getSolutionValuesRegardlessOfAuthorization()

◆ getUserQuestionResult()

◆ isAutosaveable()

◆ isComplete()

◆ loadFromDb()

◆ removeParameter()

◆ saveAdditionalQuestionDataToDb()

◆ savePreviewData()

◆ saveToDb()

◆ saveWorkingData()

◆ setExportDetailsXLS()

◆ setJavaAppletFilename()

◆ setJavaArchive()

◆ setJavaCode()

◆ setJavaCodebase()

◆ setJavaHeight()

◆ setJavaWidth()

◆ splitParams()

Field Documentation

◆ $java_archive

◆ $java_code

◆ $java_codebase

◆ $java_height

◆ $java_width

◆ $javaapplet_filename

◆ $parameters