Class for Flash based questions. More...

Inheritance diagram for assFlashQuestion:

Collaboration diagram for assFlashQuestion:

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

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

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

	saveAdditionalQuestionDataToDb ()

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

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

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

	createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")

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

	calculateReachedPoints ($active_id, $pass=NULL, $returndetails=FALSE)
	Returns the points, a learner has reached answering the question. More...

	sendToHost ($url, $data, $optional_headers=null)

	moveUploadedFile ($tmpfile, $flashfile)
	Uploads a flash file. More...

	deleteApplet ()

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

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

	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, &$format_title, &$format_bold)
	Creates an Excel worksheet for the detailed cumulated results of this question. More...

	fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
	Creates a question from a QTI file. 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 and sets the internal domxml variable with the DOM XML representation of the QTI xml representation. More...

	getBestSolution ($active_id, $pass)
	Returns the best solution for a given pass of a participant. More...

	setHeight ($a_height)

	getHeight ()

	setWidth ($a_width)

	getWidth ()

	setApplet ($a_applet)

	getApplet ()

	addParameter ($name, $value)

	setParameters ($params)

	removeParameter ($name)

	clearParameters ()

	getParameters ()

	isAutosaveable ()

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

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

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

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

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

	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, $question_id, $pass=NULL)
	Returns the points, a learner has reached answering the question. 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)
	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)
	persists the working state for current testactive and testpass More...

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

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

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

	_logAction ($logtext="", $active_id="", $question_id="")
	Logs an action into the Test&Assessment log. 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...

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

&	getSolutionValues ($active_id, $pass=NULL)
	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...

	getQuestionTypeFromDb ($question_id)
	get question type for question id 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...

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

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

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

	copyXHTMLMediaObjectsOfQuestion ($a_q_id)

	syncXHTMLMediaObjectsOfQuestion ()

	createPageObject ()
	create page object of question More...

	copyPageOfQuestion ($a_q_id)

	getPageOfQuestion ()

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

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

	setOriginalId ($original_id)

	getOriginalId ()

	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)

	_getInternalLinkHref ($target="")

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

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

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

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

	calculateReachedPoints ($active_id, $pass=NULL, $returndetails=FALSE)
	Returns the points, a learner has reached answering the question. More...

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

	createNewImageFileName ($image_filename)

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

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

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

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

&	getInstances ()
	Gets all instances of the question. More...

	_needsManualScoring ($question_id)

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

	setExportDetailsXLS (&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
	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)

	_questionExistsInTest ($question_id, $test_id)

	formatSAQuestion ($a_q)
	Format self assessment question. More...

	setPreventRteUsage ($a_val)
	Set prevent rte usage. More...

	getPreventRteUsage ()
	Get prevent rte usage. More...

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

	isAnswered ($active_id, $pass=null)
	returns boolean wether the question is answered during test pass or not More...

	setObligationsToBeConsidered ($obligationsToBeConsidered=true)
	sets the flag wether obligations are to be considered or not More...

	areObligationsToBeConsidered ()
	gets the flag wether obligations are to be considered 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 ()

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

Protected Member Functions
	duplicateApplet ($question_id, $objectId=null)
	Duplicate the flash applet. More...

	copyApplet ($question_id, $source_questionpool)
	Copy the flash applet. More...

	reworkWorkingData ($active_id, $pass, $obligationsAnswered)
	Reworks the allready saved working data if neccessary. More...

Protected Member Functions inherited from assQuestion
	reworkWorkingData ($active_id, $pass, $obligationsAnswered)
	Reworks the allready saved working data if neccessary. More...

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

	onSyncWithOriginal ($originalQuestionId, $duplicateQuestionId)

	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)

	duplicateQuestionHints ($originalQuestionId, $duplicateQuestionId)

Private Attributes
	$width

	$height

	$parameters

	$applet

Additional Inherited Members
Static Public Member Functions inherited from assQuestion
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	_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	_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	_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	lookupParentObjId ($questionId)
	ilDB $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...

Data Fields inherited from assQuestion
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 = false

Static Protected Member Functions inherited from assQuestion
static	doesSolutionRecordsExist ($activeId, $pass, $questionId)
	checks wether there are existing solution records for the given test active / pass and given question id More...

Protected Attributes inherited from assQuestion
	$id

	$title

	$comment

	$owner

	$author

	$question

	$points

	$est_working_time

	$shuffle

	$test_id

	$obj_id

	$ilias

	$tpl

	$lng

	$outputType

	$suggested_solutions

	$original_id

	$page

	$external_id = ''

	$questionChangeListeners = array()

	$processLocker

Detailed Description

Class for Flash based 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 19 of file class.assFlashQuestion.php.

Constructor & Destructor Documentation

◆ __construct()

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

assFlashQuestion constructor

The constructor takes possible arguments an creates an instance of the assFlashQuestion 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 single choice question public

See also: assQuestion:assQuestion()

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

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

         {
                 parent::__construct($title, $comment, $author, $owner, $question);
                 $this->parameters = array();
                 $this->width = 540;
                 $this->height = 400;
                 $this->applet = "";
         }

Member Function Documentation

◆ addParameter()

assFlashQuestion::addParameter	(	$name,
		$value
	)

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

         {
                 $this->parameters[$name] = $value;
         }

◆ calculateReachedPoints()

assFlashQuestion::calculateReachedPoints	(	$active_id,
		$pass = `NULL`,
		$returndetails = `FALSE`
	)

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

The points are calculated from the given answers.

public

Parameters

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

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

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

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

         {
                 if( $returndetails )
                 {
                         throw new ilTestException('return details not implemented for '.__METHOD__);
                 }
                 
                 global $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)
                 );
 
                 $points = 0;
                 while ($data = $ilDB->fetchAssoc($result))
                 {
                         $points += $data["points"];
                 }
 
                 return $points;
         }

Here is the call graph for this function:

◆ clearParameters()

assFlashQuestion::clearParameters ( )

Definition at line 676 of file class.assFlashQuestion.php.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ copyApplet()

assFlashQuestion::copyApplet	(	$question_id,
		$source_questionpool
	)

protected

Copy the flash applet.

public

See also: $points

Definition at line 343 of file class.assFlashQuestion.php.

References $filename, getApplet(), assQuestion\getFlashPath(), and ilUtil\makeDirParents().

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

Here is the call graph for this function:

◆ copyObject()

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

Copies an assFlashQuestion object.

Copies an assFlashQuestion object

public

Definition at line 242 of file class.assFlashQuestion.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 applet
                 $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()

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

Definition at line 274 of file class.assFlashQuestion.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 applet
                 $clone->copyApplet($sourceQuestionId, $sourceParentId);
 
                 $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
 
                 return $clone->id;
         }

Here is the call graph for this function:

◆ deleteAnswers()

assFlashQuestion::deleteAnswers ( $question_id )

Deletes datasets from answers tables.

Parameters

integer $question_id The question id which should be deleted in the answers table public

Definition at line 542 of file class.assFlashQuestion.php.

543 {

544 }

◆ deleteApplet()

assFlashQuestion::deleteApplet ( )

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

References getApplet(), and assQuestion\getFlashPath().

         {
                 @unlink($this->getFlashPath() . $this->getApplet());
                 $this->applet = "";
         }

Here is the call graph for this function:

◆ duplicate()

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

Duplicates an assFlashQuestion.

Duplicates an assFlashQuestion

public

Definition at line 179 of file class.assFlashQuestion.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 applet
                 $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()

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

protected

Duplicate the flash applet.

public

See also: $points

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

References $filename, getApplet(), assQuestion\getFlashPath(), and ilUtil\makeDirParents().

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

Here is the call graph for this function:

◆ fromXML()

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

Creates a question from a QTI file.

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

Parameters

object	$item	The QTI item object
integer	$questionpool_id	The id of the parent questionpool
integer	$tst_id	The id of the parent test if the question is part of a test
object	$tst_object	A reference to the parent test object
integer	$question_counter	A reference to a question counter to count the questions of an imported question pool
array	$import_mapping	An array containing references to included ILIAS objects public

Definition at line 589 of file class.assFlashQuestion.php.

         {
                 include_once "./Modules/TestQuestionPool/classes/import/qti12/class.assFlashQuestionImport.php";
                 $import = new assFlashQuestionImport($this);
                 $import->fromXML($item, $questionpool_id, $tst_id, $tst_object, $question_counter, $import_mapping);
         }

◆ getAdditionalTableName()

assFlashQuestion::getAdditionalTableName ( )

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

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

Returns: string The additional table name public

Definition at line 518 of file class.assFlashQuestion.php.

Referenced by loadFromDb(), and saveAdditionalQuestionDataToDb().

         {
                 return "qpl_qst_flash";
         }

Here is the caller graph for this function:

◆ getAnswerTableName()

assFlashQuestion::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns the name of the answer table in the database

Returns: string The answer table name public

Definition at line 531 of file class.assFlashQuestion.php.

         {
                 return "";
         }

◆ getApplet()

assFlashQuestion::getApplet ( )

Definition at line 649 of file class.assFlashQuestion.php.

References $applet.

Referenced by copyApplet(), deleteApplet(), duplicateApplet(), isComplete(), and saveAdditionalQuestionDataToDb().

         {
                 return $this->applet;
         }

Here is the caller graph for this function:

◆ getBestSolution()

assFlashQuestion::getBestSolution	(	$active_id,
		$pass
	)

Returns the best solution for a given pass of a participant.

Returns: array An associated array containing the best solution public

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

         {
                 $user_solution = array();
                 return $user_solution;
         }

◆ getHeight()

assFlashQuestion::getHeight ( )

Definition at line 628 of file class.assFlashQuestion.php.

References $height.

Referenced by saveAdditionalQuestionDataToDb().

         {
                 return $this->height;
         }

Here is the caller graph for this function:

◆ getMaximumPoints()

assFlashQuestion::getMaximumPoints ( )

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

public

See also: $points

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

References assQuestion\$points.

Referenced by isComplete().

         {
                 return $this->points;
         }

Here is the caller graph for this function:

◆ getParameters()

assFlashQuestion::getParameters ( )

Definition at line 681 of file class.assFlashQuestion.php.

References $parameters.

Referenced by saveAdditionalQuestionDataToDb().

         {
                 return $this->parameters;
         }

Here is the caller graph for this function:

◆ getQuestionType()

assFlashQuestion::getQuestionType ( )

Returns the question type of the question.

Returns the question type of the question

Returns: integer The question type of the question public

Definition at line 505 of file class.assFlashQuestion.php.

         {
                 return "assFlashQuestion";
         }

◆ getRTETextWithMediaObjects()

assFlashQuestion::getRTETextWithMediaObjects ( )

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

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

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

◆ getWidth()

assFlashQuestion::getWidth ( )

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

References $width.

Referenced by saveAdditionalQuestionDataToDb().

         {
                 return $this->width;
         }

Here is the caller graph for this function:

◆ isAutosaveable()

assFlashQuestion::isAutosaveable ( )

Definition at line 686 of file class.assFlashQuestion.php.

         {
                 return FALSE;
         }

◆ isComplete()

assFlashQuestion::isComplete ( )

Returns true, if a single choice question is complete for use.

Returns: boolean True, if the single choice question is complete for use, otherwise false public

Definition at line 60 of file class.assFlashQuestion.php.

References getApplet(), and getMaximumPoints().

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

Here is the call graph for this function:

◆ loadFromDb()

assFlashQuestion::loadFromDb ( $question_id )

Loads a assFlashQuestion object from a database.

Parameters

object	$db	A pear DB object
integer	$question_id	A unique key which defines the multiple choice test in the database public

Definition at line 120 of file class.assFlashQuestion.php.

References $_SESSION, $data, $result, ilRTE\_replaceMediaObjectImageSrc(), clearParameters(), ilDB\fetchAssoc(), getAdditionalTableName(), assQuestion\setAdditionalContentEditingMode(), setApplet(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), setHeight(), assQuestion\setId(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setSuggestedSolution(), assQuestion\setTitle(), and setWidth().

         {
                 global $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->setNrOfTries($data['nr_of_tries']);
                         $this->setTitle($data["title"]);
                         $this->setComment($data["description"]);
                         $this->setSuggestedSolution($data["solution_hint"]);
                         $this->setOriginalId($data["original_id"]);
                         $this->setObjId($data["obj_fi"]);
                         $this->setAuthor($data["author"]);
                         $this->setOwner($data["owner"]);
                         $this->setPoints($data["points"]);
 
                         include_once("./Services/RTE/classes/class.ilRTE.php");
                         $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
                         $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
                         
                         try
                         {
                                 $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
                         }
                         catch(ilTestQuestionPoolException $e)
                         {
                         }
                         
                         // load additional data
                         $result = $ilDB->queryF("SELECT * FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
                                 array("integer"),
                                 array($question_id)
                         );
                         if ($result->numRows() == 1)
                         {
                                 $data = $ilDB->fetchAssoc($result);
                                 $this->setWidth($data["width"]);
                                 $this->setHeight($data["height"]);
                                 $this->setApplet($data["applet"]);
                                 $this->parameters = unserialize($data["params"]);
                                 if (!is_array($this->parameters)) $this->clearParameters();
                                 unset($_SESSION["flash_upload_filename"]);
                         }
                 }
                 parent::loadFromDb($question_id);
         }

Here is the call graph for this function:

◆ moveUploadedFile()

assFlashQuestion::moveUploadedFile	(	$tmpfile,
		$flashfile
	)

Uploads a flash file.

Parameters

string	$flashfile	Name of the original flash file
string	$tmpfile	Name of the temporary uploaded flash file

Returns: string Name of the file public

Definition at line 440 of file class.assFlashQuestion.php.

References $result, assQuestion\getFlashPath(), ilUtil\makeDirParents(), and ilUtil\moveUploadedFile().

         {
                 $result = "";
                 if (!empty($tmpfile))
                 {
                         $flashfile = str_replace(" ", "_", $flashfile);
                         $flashpath = $this->getFlashPath();
                         if (!file_exists($flashpath))
                         {
                                 ilUtil::makeDirParents($flashpath);
                         }
                         if (ilUtil::moveUploadedFile($tmpfile, $flashfile, $flashpath.$flashfile))
                         {
                                 $result = $flashfile;
                         }
                 }
                 return $result;
         }

Here is the call graph for this function:

◆ removeParameter()

assFlashQuestion::removeParameter ( $name )

Definition at line 671 of file class.assFlashQuestion.php.

         {
                 unset($this->parameters[$name]);
         }

◆ reworkWorkingData()

assFlashQuestion::reworkWorkingData	(	$active_id,
		$pass,
		$obligationsAnswered
	)

protected

Reworks the allready saved working data if neccessary.

protected

Parameters

integer	$active_id
integer	$pass
boolean	$obligationsAnswered

Definition at line 492 of file class.assFlashQuestion.php.

         {
                 // nothing to rework!
         }

◆ saveAdditionalQuestionDataToDb()

assFlashQuestion::saveAdditionalQuestionDataToDb ( )

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

References $_SESSION, $path, getAdditionalTableName(), getApplet(), assQuestion\getFlashPath(), getHeight(), assQuestion\getId(), getParameters(), getWidth(), and ilUtil\makeDirParents().

Referenced by saveToDb().

         {
                 global $ilDB;
                 $ilDB->manipulateF( "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
                                                         array( "integer" ),
                                                         array( $this->getId() )
                 );
                 $ilDB->manipulateF( "INSERT INTO " . $this->getAdditionalTableName(
                                                                                                                                                            ) . " (question_fi, width, height, applet, params) VALUES (%s, %s, %s, %s, %s)",
                                                         array( "integer", "integer", "integer", "text", "text" ),
                                                         array(
                                                                 $this->getId(),
                                                                 (strlen( $this->getWidth() )) ? $this->getWidth() : 550,
                                                                 (strlen( $this->getHeight() )) ? $this->getHeight() : 400,
                                                                 $this->getApplet(),
                                                                 serialize( $this->getParameters() )
                                                         )
                 );
                 if ($_SESSION["flash_upload_filename"])
                 {
                         $path = $this->getFlashPath();
                         ilUtil::makeDirParents( $path );
                         @rename( $_SESSION["flash_upload_filename"], $path . $this->getApplet() );
                         unset($_SESSION["flash_upload_filename"]);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveToDb()

assFlashQuestion::saveToDb ( $original_id = "" )

Saves a assFlashQuestion object to a database.

public

Definition at line 79 of file class.assFlashQuestion.php.

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

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

Here is the call graph for this function:

◆ saveWorkingData()

assFlashQuestion::saveWorkingData	(	$active_id,
		$pass = `NULL`
	)

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 473 of file class.assFlashQuestion.php.

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

◆ sendToHost()

assFlashQuestion::sendToHost	(	$url,
		$data,
		$optional_headers = `null`
	)

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

References $data.

         {
                 $params = array('http' => array(
                         'method' => 'POST',
                         'content' => $data
                 ));
                 if ($optional_headers !== null) 
                 {
                         $params['http']['header'] = $optional_headers;
                 }
                 $ctx = stream_context_create($params);
                 $fp = @fopen($url, 'rb', false, $ctx);
                 if (!$fp) 
                 {
                         throw new Exception("Problem with $url, $php_errormsg");
                 }
                 $response = @stream_get_contents($fp);
                 if ($response === false) 
                 {
                         throw new Exception("Problem reading data from $url, $php_errormsg");
                 }
                 return $response;
         }

◆ setApplet()

assFlashQuestion::setApplet ( $a_applet )

Definition at line 644 of file class.assFlashQuestion.php.

Referenced by loadFromDb().

         {
                 $this->applet = $a_applet;
         }

Here is the caller graph for this function:

◆ setExportDetailsXLS()

assFlashQuestion::setExportDetailsXLS	(	&	$worksheet,
			$startrow,
			$active_id,
			$pass,
		&	$format_title,
		&	$format_bold
	)

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
object	$format_title	Excel title format
object	$format_bold	Excel bold format
array	$eval_data	Cumulated evaluation data public

Definition at line 568 of file class.assFlashQuestion.php.

References ilExcelUtils\_convert_text(), and assQuestion\getTitle().

         {
                 include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
                 $worksheet->writeString($startrow, 0, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())), $format_title);
                 $worksheet->writeString($startrow, 1, ilExcelUtils::_convert_text($this->getTitle()), $format_title);
                 return $startrow + 1;
         }

Here is the call graph for this function:

◆ setHeight()

assFlashQuestion::setHeight ( $a_height )

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

Referenced by loadFromDb().

         {
                 if (!$a_height) $a_height = 400;
                 $this->height = $a_height;
         }

Here is the caller graph for this function:

◆ setParameters()

assFlashQuestion::setParameters ( $params )

Definition at line 659 of file class.assFlashQuestion.php.

         {
                 if (is_array($params))
                 {
                         $this->parameters = $params;
                 }
                 else
                 {
                         $this->parameters = array();
                 }
         }

◆ setWidth()

assFlashQuestion::setWidth ( $a_width )

Definition at line 633 of file class.assFlashQuestion.php.

Referenced by loadFromDb().

         {
                 if (!$a_width) $a_width = 550;
                 $this->width = $a_width;
         }

Here is the caller graph for this function:

◆ toXML()

assFlashQuestion::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 and sets the internal domxml variable with the DOM XML representation of the QTI xml representation.

Returns: string The QTI xml representation of the question public

Definition at line 603 of file class.assFlashQuestion.php.

         {
                 include_once "./Modules/TestQuestionPool/classes/export/qti12/class.assFlashQuestionExport.php";
                 $export = new assFlashQuestionExport($this);
                 return $export->toXML($a_include_header, $a_include_binary, $a_shuffle, $test_output, $force_image_references);
         }

Field Documentation

◆ $applet

assFlashQuestion::$applet

private

Definition at line 24 of file class.assFlashQuestion.php.

Referenced by getApplet().

◆ $height

assFlashQuestion::$height

private

Definition at line 22 of file class.assFlashQuestion.php.

Referenced by getHeight().

◆ $parameters

assFlashQuestion::$parameters

private

Definition at line 23 of file class.assFlashQuestion.php.

Referenced by getParameters().

◆ $width

assFlashQuestion::$width

private

Definition at line 21 of file class.assFlashQuestion.php.

Referenced by getWidth().

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

Modules/TestQuestionPool/classes/class.assFlashQuestion.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addParameter()

◆ calculateReachedPoints()

◆ clearParameters()

◆ copyApplet()

◆ copyObject()

◆ createNewOriginalFromThisDuplicate()

◆ deleteAnswers()

◆ deleteApplet()

◆ duplicate()

◆ duplicateApplet()

◆ fromXML()

◆ getAdditionalTableName()

◆ getAnswerTableName()

◆ getApplet()

◆ getBestSolution()

◆ getHeight()

◆ getMaximumPoints()

◆ getParameters()

◆ getQuestionType()

◆ getRTETextWithMediaObjects()

◆ getWidth()

◆ isAutosaveable()

◆ isComplete()

◆ loadFromDb()

◆ moveUploadedFile()

◆ removeParameter()

◆ reworkWorkingData()

◆ saveAdditionalQuestionDataToDb()

◆ saveToDb()

◆ saveWorkingData()

◆ sendToHost()

◆ setApplet()

◆ setExportDetailsXLS()

◆ setHeight()

◆ setParameters()

◆ setWidth()

◆ toXML()

Field Documentation

◆ $applet

◆ $height

◆ $parameters

◆ $width