ILIAS  Release_4_2_x_branch Revision 61807
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields
assJavaApplet Class Reference
Modules/TestQuestionPool

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
 splitParams ($params="")
 Sets the applet parameters from a parameter string containing all parameters in a list.
 buildParams ()
 Returns a string containing the applet parameters.
 buildParamsOnly ()
 Returns a string containing the additional applet parameters.
 isComplete ()
 Returns true, if a imagemap question is complete for use.
 saveToDb ($original_id="")
 Saves a assJavaApplet object to a database.
 loadFromDb ($question_id)
 Loads a assJavaApplet object from a database.
 duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
 Duplicates an assJavaApplet.
 copyObject ($target_questionpool, $title="")
 Copies an assJavaApplet object.
 duplicateApplet ($question_id, $objectId=null)
 copyApplet ($question_id, $source_questionpool)
 getJavaCode ()
 Returns the java applet code parameter.
 getJavaCodebase ()
 Returns the java applet codebase parameter.
 getJavaArchive ()
 Returns the java applet archive parameter.
 setJavaCode ($java_code="")
 Sets the java applet code parameter.
 setJavaCodebase ($java_codebase="")
 Sets the java applet codebase parameter.
 setJavaArchive ($java_archive="")
 Sets the java applet archive parameter.
 getJavaWidth ()
 Returns the java applet width parameter.
 setJavaWidth ($java_width="")
 Sets the java applet width parameter.
 getJavaHeight ()
 Returns the java applet height parameter.
 setJavaHeight ($java_height="")
 Sets the java applet height parameter.
 calculateReachedPoints ($active_id, $pass=NULL)
 Returns the points, a learner has reached answering the question.
 getReachedInformation ($active_id, $pass=NULL)
 Returns the evaluation data, a learner has entered to answer the question.
 addParameter ($name="", $value="")
 Adds a new parameter value to the parameter list.
 addParameterAtIndex ($index=0, $name="", $value="")
 removeParameter ($index)
 Removes a parameter value from the parameter list.
 getParameter ($index)
 Returns the paramter at a given index.
 getParameterIndex ($name)
 Returns the index of an applet parameter.
 getParameterCount ()
 Returns the number of additional applet parameters.
 flushParams ()
 Removes all applet parameters.
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database.
 getJavaAppletFilename ()
 Gets the java applet file name.
 setJavaAppletFilename ($javaapplet_filename, $javaapplet_tempfilename="")
 Sets the java applet file name.
 deleteJavaAppletFilename ()
 getQuestionType ()
 Returns the question type of the question.
 getAdditionalTableName ()
 Returns the name of the additional question data table in the database.
 getRTETextWithMediaObjects ()
 Collects all text in the question which could contain media objects which were created with the Rich Text Editor.
 setExportDetailsXLS (&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
 Creates an Excel worksheet for the detailed cumulated results of this question.
- Public Member Functions inherited from assQuestion
 __construct ($title="", $comment="", $author="", $owner=-1, $question="")
 assQuestion constructor
 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.
 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.
 questionTitleExists ($questionpool_id, $title)
 Returns TRUE if the question title exists in the database.
 setTitle ($title="")
 Sets the title string of the assQuestion object.
 setId ($id=-1)
 Sets the id of the assQuestion object.
 setTestId ($id=-1)
 Sets the test id of the assQuestion object.
 setComment ($comment="")
 Sets the comment string of the assQuestion object.
 setOutputType ($outputType=OUTPUT_HTML)
 Sets the output type.
 setShuffle ($shuffle=true)
 Sets the shuffle flag.
 setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)
 Sets the estimated working time of a question.
 keyInArray ($searchkey, $array)
 returns TRUE if the key occurs in an array
 setAuthor ($author="")
 Sets the authors name of the assQuestion object.
 setOwner ($owner="")
 Sets the creator/owner ID of the assQuestion object.
 getTitle ()
 Gets the title string of the assQuestion object.
 getId ()
 Gets the id of the assQuestion object.
 getShuffle ()
 Gets the shuffle flag.
 getTestId ()
 Gets the test id of the assQuestion object.
 getComment ()
 Gets the comment string of the assQuestion object.
 getOutputType ()
 Gets the output type.
 supportsJavascriptOutput ()
 Returns true if the question type supports JavaScript output.
 getEstimatedWorkingTime ()
 Gets the estimated working time of a question.
 getAuthor ()
 Gets the authors name of the assQuestion object.
 getOwner ()
 Gets the creator/owner ID of the assQuestion object.
 getObjId ()
 Get the object id of the container object.
 setObjId ($obj_id=0)
 Set the object id of the container object.
 _getMaximumPoints ($question_id)
 Returns the maximum points, a learner can reach answering the question.
& _getQuestionInfo ($question_id)
 Returns question information from the database.
 getSuggestedSolutionOutput ()
& _getSuggestedSolution ($question_id, $subquestion_index=0)
 Returns a suggested solution for a given subquestion index.
 getSuggestedSolutions ()
 Return the suggested solutions.
 _getReachedPoints ($active_id, $question_id, $pass=NULL)
 Returns the points, a learner has reached answering the question.
 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.
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question.
 calculateResultsFromSolution ($active_id, $pass=NULL)
 Calculates the question results from a previously saved question solution.
 _updateTestResultCache ($active_id)
 _updateTestPassResults ($active_id, $pass)
 logAction ($logtext="", $active_id="", $question_id="")
 Logs an action into the Test&Assessment log.
 _logAction ($logtext="", $active_id="", $question_id="")
 Logs an action into the Test&Assessment log.
 moveUploadedMediaFile ($file, $name)
 Move an uploaded media file to an public accessible temp dir to present it.
 getSuggestedSolutionPath ()
 Returns the path for a suggested solution.
 getJavaPath ()
 Returns the image path for web accessable images of a question.
 getImagePath ($question_id=null, $object_id=null)
 Returns the image path for web accessable images of a question.
 getFlashPath ()
 Returns the image path for web accessable flash files of a question.
 getJavaPathWeb ()
 Returns the web image path for web accessable java applets of a question.
 getSuggestedSolutionPathWeb ()
 Returns the web path for a suggested solution.
 getImagePathWeb ()
 Returns the web image path for web accessable images of a question.
 getFlashPathWeb ()
 Returns the web image path for web accessable flash applications of a question.
& getSolutionValues ($active_id, $pass=NULL)
 Loads solutions of a given user from the database an returns it.
 isInUse ($question_id="")
 Checks whether the question is in use or not.
 isClone ($question_id="")
 Checks whether the question is a clone of another question or not.
 pcArrayShuffle ($array)
 Shuffles the values of a given array.
 getQuestionTypeFromDb ($question_id)
 get question type for question id
 getAnswerTableName ()
 Returns the name of the answer table in the database.
 deleteAnswers ($question_id)
 Deletes datasets from answers tables.
 deleteAdditionalTableData ($question_id)
 Deletes datasets from the additional question table in the database.
 delete ($question_id)
 Deletes a question and all materials from the database.
 getTotalAnswers ()
 get total number of answers
 _getTotalAnswers ($a_q_id)
 get number of answers for question id (static) note: do not use $this inside this method
 _getTotalRightAnswers ($a_q_id)
 get number of answers for question id (static) note: do not use $this inside this method
 _getTitle ($a_q_id)
 Returns the title of a question.
 _getQuestionText ($a_q_id)
 Returns question text.
 copyXHTMLMediaObjectsOfQuestion ($a_q_id)
 syncXHTMLMediaObjectsOfQuestion ()
 createPageObject ()
 create page object of question
 copyPageOfQuestion ($a_q_id)
 getPageOfQuestion ()
 _getQuestionType ($question_id)
 Returns the question type of a question with a given id.
 _getQuestionTitle ($question_id)
 Returns the question title of a question with a given id.
 setOriginalId ($original_id)
 getOriginalId ()
 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.
 saveQuestionDataToDb ($original_id="")
 setNewOriginalId ($newId)
 deleteSuggestedSolutions ()
 Deletes all suggestes solutions in the database.
 getSuggestedSolution ($subquestion_index=0)
 Returns a suggested solution for a given subquestion index.
 getSuggestedSolutionTitle ($subquestion_index=0)
 Returns the title of a suggested solution at a given subquestion_index.
 setSuggestedSolution ($solution_id="", $subquestion_index=0, $is_import=false)
 Sets a suggested solution for the question.
 _resolveInternalLink ($internal_link)
 _resolveIntLinks ($question_id)
 _getInternalLinkHref ($target="")
 _getOriginalId ($question_id)
 Returns the original id of a question.
 syncWithOriginal ()
 createRandomSolution ($test_id, $user_id)
 _questionExists ($question_id)
 Returns true if the question already exists in the database.
 _questionExistsInPool ($question_id)
 Returns true if the question already exists in the database and is assigned to a question pool.
& _instanciateQuestion ($question_id)
 Creates an instance of a question with a given question id.
 getPoints ()
 Returns the maximum available points for the question.
 setPoints ($a_points)
 Sets the maximum available points for the question.
 getSolutionMaxPass ($active_id)
 Returns the maximum pass a users question solution.
 _getSolutionMaxPass ($question_id, $active_id)
 Returns the maximum pass a users question solution.
 _isWriteable ($question_id, $user_id)
 Returns true if the question is writeable by a certain user.
 _isUsedInRandomTest ($question_id="")
 Checks whether the question is used in a random test or not.
 calculateReachedPoints ($active_id, $pass=NULL, $points=0)
 Returns the points, a learner has reached answering the question The points are calculated from the given answers including checks for all special scoring options in the test container.
 isHTML ($a_text)
 Checks if a given string contains HTML or not.
 prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
 Prepares a string for a text area output in tests.
 QTIMaterialToString ($a_material)
 Reads an QTI material tag an creates a text string.
 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.
 createNewImageFileName ($image_filename)
 _setReachedPoints ($active_id, $question_id, $points, $maxpoints, $pass=NULL, $manualscoring=FALSE)
 Sets the points, a learner has reached answering the question Additionally objective results are updated.
 getQuestion ()
 Gets the question string of the question object.
 setQuestion ($question="")
 Sets the question string of the question object.
 getQuestionTypeID ()
 Returns the question type of the question.
 getFeedbackGeneric ($correctness)
 Returns the generic feedback for a given question state.
 cleanupMediaObjectUsage ()
 synchronises appearances of media objects in the question with media object usage table
& getInstances ()
 Gets all instances of the question.
 _needsManualScoring ($question_id)
 getActiveUserData ($active_id)
 Returns the user id and the test id for a given active id.
& _instanciateQuestionGUI ($question_id)
 Creates an instance of a question gui with a given question id.
 __get ($value)
 Object getter.
 __set ($key, $value)
 Object setter.
 getNrOfTries ()
 setNrOfTries ($a_nr_of_tries)
 setExportImagePath ($a_path)
 _questionExistsInTest ($question_id, $test_id)
 formatSAQuestion ($a_q)
 Format self assessment question.

Data Fields

 $javaapplet_filename
 $java_code
 $java_codebase
 $java_archive
 $java_width
 $java_height
 $parameters

Additional Inherited Members

- Static Public Member Functions inherited from assQuestion
static _getSuggestedSolutionCount ($question_id)
 Returns the number of suggested solutions associated with a question.
static _getSuggestedSolutionOutput ($question_id)
 Returns the output of the suggested solution.
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)
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.
static _areAnswered ($a_user_id, $a_question_ids)
 Checks if an array of question ids is answered by an user or not.
static _includeClass ($question_type, $gui=0)
 Include the php class file for a given question type.
static _getQuestionTypeName ($type_tag)
 Return the translation for a given question type tag.
- Protected Member Functions inherited from assQuestion
 deletePageOfQuestion ($question_id)
 Deletes the page object of a question with a given ID.
 onDuplicate ($originalParentId, $originalQuestionId, $duplicateParentId, $duplicateQuestionId)
 Will be called when a question is duplicated (inside a question pool or for insertion in a test)
 onCopy ($source_questionpool_id, $source_question_id)
 Will be called when a question is copied (into another question pool)
 duplicateSuggestedSolutionFiles ($parent_id, $question_id)
 Duplicates the files of a suggested solution if the question is duplicated.
 syncSuggestedSolutionFiles ($original_id)
 Syncs the files of a suggested solution if the question is synced.
 copySuggestedSolutionFiles ($source_questionpool_id, $source_question_id)
- 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

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
Version
Id:
class.assJavaApplet.php 47446 2014-01-22 17:07:12Z bheyser

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

Constructor & Destructor Documentation

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$titleA title string to describe the question
string$commentA comment string to describe the question
string$authorA string containing the name of the questions author
integer$ownerA numerical ID to identify the owner/creator
string$questionThe question string of the multiple choice question
integer$responseIndicates the response type of the multiple choice question
integer$output_typeThe output order of the multiple choice answers public
See Also
assQuestion:assQuestion()

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

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

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

Member Function Documentation

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

Adds a new parameter value to the parameter list.

Parameters
string$nameThe name of the parameter value
string$valueThe value of the parameter value public
See Also
$parameters

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

References 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:

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

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

{
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));
}
}
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 public

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

Referenced by saveToDb().

{
$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($params_array, "<separator>");
}

+ Here is the caller graph for this function:

assJavaApplet::buildParamsOnly ( )

Returns a string containing the additional applet parameters.

Returns a string containing the additional applet parameters

Returns
string All additional applet parameters public

Definition at line 221 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($params_array, "<separator>");
}
assJavaApplet::calculateReachedPoints (   $active_id,
  $pass = NULL 
)

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

Returns the points, a learner has reached answering the question The points are calculated from the given answers including checks for all special scoring options in the test container.

Parameters
integer$user_idThe database ID of the learner
integer$test_idThe database Id of the test containing the question public

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

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

{
global $ilDB;
$found_values = array();
if (is_null($pass))
{
$pass = $this->getSolutionMaxPass($active_id);
}
$result = $ilDB->queryF("SELECT points 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"];
}
$points = parent::calculateReachedPoints($active_id, $pass = NULL, $points);
return $points;
}

+ Here is the call graph for this function:

assJavaApplet::copyApplet (   $question_id,
  $source_questionpool 
)

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

assJavaApplet::copyObject (   $target_questionpool,
  $title = "" 
)

Copies an assJavaApplet object.

Copies an assJavaApplet object

public

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

References assQuestion\$original_id, 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
$clone = $this;
include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
$original_id = assQuestion::_getOriginalId($this->id);
$clone->id = -1;
$source_questionpool = $this->getObjId();
$clone->setObjId($target_questionpool);
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 generic feedback
$clone->duplicateFeedbackGeneric($original_id);
// duplicate the image
$clone->copyApplet($original_id, $source_questionpool);
$clone->onCopy($this->getObjId(), $this->getId());
return $clone->id;
}

+ Here is the call graph for this function:

assJavaApplet::deleteJavaAppletFilename ( )

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

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

Duplicates an assJavaApplet.

public

Definition at line 336 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();
if( (int)$testObjId > 0 )
{
$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 generic feedback
$clone->duplicateFeedbackGeneric($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:

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

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

assJavaApplet::flushParams ( )

Removes all applet parameters.

public

See Also
$parameters

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

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

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

Returns
string The additional table name public

Reimplemented from assQuestion.

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

Referenced by loadFromDb(), and saveToDb().

{
return "qpl_qst_javaapplet";
}

+ Here is the caller graph for this function:

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 821 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:

assJavaApplet::getJavaArchive ( )

Returns the java applet archive parameter.

Returns the java applet archive parameter

Returns
string java applet archive parameter public

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

References $java_archive.

Referenced by isComplete().

{
return $this->java_archive;
}

+ Here is the caller graph for this function:

assJavaApplet::getJavaCode ( )

Returns the java applet code parameter.

Returns the java applet code parameter

Returns
string java applet code parameter public

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

References $java_code.

{
return $this->java_code;
}
assJavaApplet::getJavaCodebase ( )

Returns the java applet codebase parameter.

Returns the java applet codebase parameter

Returns
string java applet codebase parameter public

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

References $java_codebase.

Referenced by isComplete().

{
return $this->java_codebase;
}

+ Here is the caller graph for this function:

assJavaApplet::getJavaHeight ( )

Returns the java applet height parameter.

Returns the java applet height parameter

Returns
integer java applet height parameter public

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

References $java_height.

{
return $this->java_height;
}
assJavaApplet::getJavaWidth ( )

Returns the java applet width parameter.

Returns the java applet width parameter

Returns
integer java applet width parameter public

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

References $java_width.

{
return $this->java_width;
}
assJavaApplet::getParameter (   $index)

Returns the paramter at a given index.

Parameters
intege$indexThe index value of the parameter
Returns
array The parameter at the given index public
See Also
$parameters

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

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

Returns the number of additional applet parameters.

Returns
integer The number of additional applet parameters public
See Also
$parameters

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

{
return count($this->parameters);
}
assJavaApplet::getParameterIndex (   $name)

Returns the index of an applet parameter.

Parameters
string$nameThe 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 765 of file class.assJavaApplet.php.

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:

assJavaApplet::getQuestionType ( )

Returns the question type of the question.

Returns
integer The question type of the question public

Reimplemented from assQuestion.

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

{
return "assJavaApplet";
}
assJavaApplet::getReachedInformation (   $active_id,
  $pass = NULL 
)

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

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

Parameters
integer$user_idThe database ID of the learner
integer$test_idThe database Id of the test containing the question public

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

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

{
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)
);
$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:

assJavaApplet::getRTETextWithMediaObjects ( )

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

Reimplemented from assQuestion.

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

{
return parent::getRTETextWithMediaObjects();
}
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 public

Reimplemented from assQuestion.

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

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

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

+ Here is the call graph for this function:

assJavaApplet::loadFromDb (   $question_id)

Loads a assJavaApplet object from a database.

Loads a assJavaApplet object from a database (experimental)

Parameters
object$dbA pear DB object
integer$question_idA unique key which defines the multiple choice test in the database public

Reimplemented from assQuestion.

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

References $data, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), setJavaAppletFilename(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setTitle(), and splitParams().

{
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->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));
}
parent::loadFromDb($question_id);
}

+ Here is the call graph for this function:

assJavaApplet::removeParameter (   $index)

Removes a parameter value from the parameter list.

Parameters
integer$indexThe parameter index public
See Also
$parameters

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

{
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);
}
assJavaApplet::saveToDb (   $original_id = "")

Saves a assJavaApplet object to a database.

Saves a assJavaApplet object to a database (experimental)

Parameters
object$dbA pear DB object public

Reimplemented from assQuestion.

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

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

{
global $ilDB;
$this->saveQuestionDataToDb($original_id);
$params = $this->buildParams();
// save additional data
$affectedRows = $ilDB->manipulateF("DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
array("integer"),
array($this->getId())
);
$affectedRows = $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
)
);
parent::saveToDb($original_id);
}

+ Here is the call graph for this function:

assJavaApplet::saveWorkingData (   $active_id,
  $pass = NULL 
)

Saves the learners input of the question to the database. 

  @param integer $test_id The database id of the test containing this question
Returns
boolean Indicates the save status (true if saved successful, false otherwise) public
See Also
$answers

Reimplemented from assQuestion.

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

References $pass.

{
parent::saveWorkingData($active_id, $pass);
return true;
}
assJavaApplet::setExportDetailsXLS ( &  $worksheet,
  $startrow,
  $active_id,
  $pass,
&  $format_title,
&  $format_bold 
)

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

Parameters
object$worksheetReference to the parent excel worksheet
object$startrowStartrow of the output in the excel worksheet
object$active_idActive id of the participant
object$passTest pass
object$format_titleExcel title format
object$format_boldExcel bold format
array$eval_dataCumulated evaluation data public

Reimplemented from assQuestion.

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

References $pass, ilExcelUtils\_convert_text(), assQuestion\getSolutionValues(), and assQuestion\getTitle().

{
include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
$solutions = $this->getSolutionValues($active_id, $pass);
$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);
$i = 1;
foreach ($solutions as $solution)
{
$worksheet->write($startrow + $i, 1, ilExcelUtils::_convert_text($this->lng->txt("result") . " $i"));
if (strlen($solution["value1"])) $worksheet->write($startrow + $i, 1, ilExcelUtils::_convert_text($solution["value1"]));
if (strlen($solution["value2"])) $worksheet->write($startrow + $i, 2, ilExcelUtils::_convert_text($solution["value2"]));
$i++;
}
return $startrow + $i + 1;
}

+ Here is the call graph for this function:

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

Sets the java applet file name.

Parameters
string$javaapplet_file,.public
See Also
$javaapplet_filename

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

References $ilLog, $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:

assJavaApplet::setJavaArchive (   $java_archive = "")

Sets the java applet archive parameter.

Sets the java applet archive parameter

Parameters
stringjava applet archive parameter public

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

References $java_archive.

Referenced by setJavaAppletFilename().

{
$this->java_archive = $java_archive;
}

+ Here is the caller graph for this function:

assJavaApplet::setJavaCode (   $java_code = "")

Sets the java applet code parameter.

Sets the java applet code parameter

Parameters
stringjava applet code parameter public

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

References $java_code.

{
$this->java_code = $java_code;
}
assJavaApplet::setJavaCodebase (   $java_codebase = "")

Sets the java applet codebase parameter.

Sets the java applet codebase parameter

Parameters
stringjava applet codebase parameter public

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

References $java_codebase.

Referenced by setJavaAppletFilename().

{
$this->java_codebase = $java_codebase;
}

+ Here is the caller graph for this function:

assJavaApplet::setJavaHeight (   $java_height = "")

Sets the java applet height parameter.

Sets the java applet height parameter

Parameters
integerjava applet height parameter public

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

References $java_height.

{
$this->java_height = $java_height;
}
assJavaApplet::setJavaWidth (   $java_width = "")

Sets the java applet width parameter.

Sets the java applet width parameter

Parameters
integerjava applet width parameter public

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

References $java_width.

{
$this->java_width = $java_width;
}
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$paramsAll applet parameters in a list public

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

Referenced by loadFromDb().

{
$params_array = split("<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

assJavaApplet::$java_archive

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

Referenced by getJavaArchive(), and setJavaArchive().

assJavaApplet::$java_code

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

Referenced by getJavaCode(), and setJavaCode().

assJavaApplet::$java_codebase

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

Referenced by getJavaCodebase(), and setJavaCodebase().

assJavaApplet::$java_height

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

Referenced by getJavaHeight(), and setJavaHeight().

assJavaApplet::$java_width

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

Referenced by getJavaWidth(), and setJavaWidth().

assJavaApplet::$javaapplet_filename

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

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

assJavaApplet::$parameters

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

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