ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields | Protected Member Functions
assImagemapQuestion Class Reference
Modules/TestQuestionPool

Class for image map questions. More...

+ Inheritance diagram for assImagemapQuestion:
+ Collaboration diagram for assImagemapQuestion:

Public Member Functions

 __construct ($title="", $comment="", $author="", $owner=-1, $question="", $image_filename="")
 assImagemapQuestion constructor
 isComplete ()
 Returns true, if a imagemap question is complete for use.
 saveToDb ($original_id="")
 Saves a assImagemapQuestion object to a database.
 duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
 Duplicates an assImagemapQuestion.
 copyObject ($target_questionpool, $title="")
 Copies an assImagemapQuestion object.
 duplicateImage ($question_id, $objectId=null)
 copyImage ($question_id, $source_questionpool)
 loadFromDb ($question_id)
 Loads a assImagemapQuestion object from a database.
 uploadImagemap ($imagemap_filename="")
 Uploads an image map and takes over the areas.
 getImageFilename ()
 setImageFilename ($image_filename, $image_tempfilename="")
 Sets the image file name.
 get_imagemap_contents ($href="#")
 Gets the imagemap file contents.
 addAnswer ($answertext="", $points=0.0, $order=0, $coords="", $area="")
 Adds a possible answer for a imagemap question.
 getAnswerCount ()
 Returns the number of answers.
 getAnswer ($index=0)
 Returns an answer.
& getAnswers ()
 Returns the answer array.
 deleteArea ($index=0)
 Deletes an answer.
 flushAnswers ()
 Deletes all answers.
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question.
 calculateReachedPoints ($active_id, $pass=NULL, $returndetails=FALSE)
 Returns the points, a learner has reached answering the question.
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database.
 syncWithOriginal ()
 getQuestionType ()
 Returns the question type of the question.
 getAdditionalTableName ()
 Returns the name of the additional question data table in the database.
 getAnswerTableName ()
 Returns the name of the answer table in the database.
 getFeedbackSingleAnswer ($answer_index)
 Returns the feedback for a single selected answer.
 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.
 deleteImage ()
 Deletes the image file.
 toJSON ()
 Returns a JSON representation of the 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.
 getAdjustedReachedPoints ($active_id, $pass=NULL)
 returns the reached points ...
 calculateResultsFromSolution ($active_id, $pass=NULL, $obligationsEnabled=false)
 Calculates the question results from a previously saved question solution.
 persistWorkingState ($active_id, $pass=NULL, $obligationsEnabled=false)
 persists the working state for current testactive and testpass
 _updateTestResultCache ($active_id)
 _updateTestPassResults ($active_id, $pass, $obligationsEnabled=false)
 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
 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.
 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.
 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.
 adjustReachedPointsByScoringOptions ($points, $active_id, $pass=NULL)
 Adjust the given reached points by 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, $manualscoring, $obligationsEnabled)
 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.
 isAnswered ($active_id, $pass=null)
 returns boolean wether the question is answered during test pass or not
 setObligationsToBeConsidered ($obligationsToBeConsidered=true)
 sets the flag wether obligations are to be considered or not
 areObligationsToBeConsidered ()
 gets the flag wether obligations are to be considered or not
 isAutosaveable ()
 getHtmlUserSolutionPurifier ()

Data Fields

 $answers
 $image_filename
 $imagemap_contents
 $coords

Protected Member Functions

 reworkWorkingData ($active_id, $pass, $obligationsAnswered)
 Reworks the allready saved working data if neccessary.
- 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)
 duplicateQuestionHints ($originalQuestionId, $duplicateQuestionId)
 deleteFeedbackSpecific ($question_id)

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 _instanciateQuestion ($question_id)
 Creates an instance of a question with a given question id.
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.
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.
static isObligationPossible ($questionId)
 returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration
- 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
- 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 image map questions.

assImagemapQuestion is a class for imagemap question.

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
Version
$Id$

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

Constructor & Destructor Documentation

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

assImagemapQuestion constructor

The constructor takes possible arguments an creates an instance of the assImagemapQuestion 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$image_fileThe image file name of the imagemap question
string$questionThe question string of the imagemap question public

Definition at line 65 of file class.assImagemapQuestion.php.

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

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

Member Function Documentation

assImagemapQuestion::addAnswer (   $answertext = "",
  $points = 0.0,
  $order = 0,
  $coords = "",
  $area = "" 
)

Adds a possible answer for a imagemap question.

Adds a possible answer for a imagemap question. A ASS_AnswerImagemap object will be created and assigned to the array $this->answers.

Parameters
string$answertextThe answer text
double$pointsThe points for selecting the answer (even negative points can be used)
integer$statusThe state of the answer (set = 1 or unset = 0)
integer$orderA possible display order of the answer public
See Also
$answers
ASS_AnswerImagemap

Definition at line 437 of file class.assImagemapQuestion.php.

References $coords, and assQuestion\$points.

Referenced by uploadImagemap().

{
include_once "./Modules/TestQuestionPool/classes/class.assAnswerImagemap.php";
if (array_key_exists($order, $this->answers))
{
// Insert answer
$answer = new ASS_AnswerImagemap($answertext, $points, $order, $coords, $area);
for ($i = count($this->answers) - 1; $i >= $order; $i--)
{
$this->answers[$i+1] = $this->answers[$i];
$this->answers[$i+1]->setOrder($i+1);
}
$this->answers[$order] = $answer;
}
else
{
// Append answer
$answer = new ASS_AnswerImagemap($answertext, $points, count($this->answers), $coords, $area);
array_push($this->answers, $answer);
}
}

+ Here is the caller graph for this function:

assImagemapQuestion::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 !!)

Reimplemented from assQuestion.

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

References $data, $pass, assQuestion\$points, $result, 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)
);
while ($data = $ilDB->fetchAssoc($result))
{
if (strcmp($data["value1"], "") != 0)
{
array_push($found_values, $data["value1"]);
}
}
$points = 0;
if (count($found_values) > 0)
{
foreach ($this->answers as $key => $answer)
{
if (in_array($key, $found_values))
{
$points += $answer->getPoints();
}
}
}
return $points;
}

+ Here is the call graph for this function:

assImagemapQuestion::copyImage (   $question_id,
  $source_questionpool 
)

Definition at line 273 of file class.assImagemapQuestion.php.

References $filename, getImageFilename(), assQuestion\getImagePath(), and ilUtil\makeDirParents().

{
$imagepath = $this->getImagePath();
$imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
$imagepath_original = str_replace("/$this->obj_id/", "/$source_questionpool/", $imagepath_original);
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
$filename = $this->getImageFilename();
if (!copy($imagepath_original . $filename, $imagepath . $filename))
{
print "image could not be copied!!!! ";
}
}

+ Here is the call graph for this function:

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

Copies an assImagemapQuestion object.

Copies an assImagemapQuestion object

public

Definition at line 219 of file class.assImagemapQuestion.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->duplicateGenericFeedback($original_id);
// duplicate the answer specific feedback
$clone->duplicateFeedbackAnswer($original_id);
// duplicate the image
$clone->copyImage($original_id, $source_questionpool);
$clone->onCopy($this->getObjId(), $this->getId());
return $clone->id;
}

+ Here is the call graph for this function:

assImagemapQuestion::deleteArea (   $index = 0)

Deletes an answer.

Deletes an area with a given index. The index of the first area is 0, the index of the second area is 1 and so on.

Parameters
integer$indexA nonnegative index of the n-th answer public
See Also
$answers

Definition at line 520 of file class.assImagemapQuestion.php.

{
if ($index < 0) return;
if (count($this->answers) < 1) return;
if ($index >= count($this->answers)) return;
unset($this->answers[$index]);
$this->answers = array_values($this->answers);
for ($i = 0; $i < count($this->answers); $i++) {
if ($this->answers[$i]->getOrder() > $index) {
$this->answers[$i]->setOrder($i);
}
}
}
assImagemapQuestion::deleteImage ( )

Deletes the image file.

Definition at line 915 of file class.assImagemapQuestion.php.

References $file, flushAnswers(), getImageFilename(), and assQuestion\getImagePath().

{
$file = $this->getImagePath() . $this->getImageFilename();
@unlink($file);
$this->flushAnswers();
$this->image_filename = "";
}

+ Here is the call graph for this function:

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

Duplicates an assImagemapQuestion.

public

Definition at line 149 of file class.assImagemapQuestion.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->duplicateGenericFeedback($this_id);
// duplicate the answer specific feedback
$clone->duplicateFeedbackAnswer($this_id);
// duplicate the image
$clone->duplicateImage($this_id, $thisObjId);
$clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
return $clone->id;
}

+ Here is the call graph for this function:

assImagemapQuestion::duplicateImage (   $question_id,
  $objectId = null 
)

Definition at line 254 of file class.assImagemapQuestion.php.

References $filename, getImageFilename(), assQuestion\getImagePath(), and ilUtil\makeDirParents().

{
$imagepath = $this->getImagePath();
$imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
if( (int)$objectId > 0 )
{
$imagepath_original = str_replace("/$this->obj_id/", "/$objectId/", $imagepath_original);
}
if (!file_exists($imagepath)) {
ilUtil::makeDirParents($imagepath);
}
$filename = $this->getImageFilename();
if (!copy($imagepath_original . $filename, $imagepath . $filename)) {
print "image could not be duplicated!!!! ";
}
}

+ Here is the call graph for this function:

assImagemapQuestion::flushAnswers ( )

Deletes all answers.

Deletes all answers

public

See Also
$answers

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

Referenced by deleteImage().

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

+ Here is the caller graph for this function:

assImagemapQuestion::get_imagemap_contents (   $href = "#")

Gets the imagemap file contents.

Gets the imagemap file contents

Returns
string The imagemap file contents of the assImagemapQuestion object public
See Also
$imagemap_contents

Definition at line 411 of file class.assImagemapQuestion.php.

References $imagemap_contents.

{
$imagemap_contents = "<map name=\"".$this->title."\"> ";
for ($i = 0; $i < count($this->answers); $i++) {
$imagemap_contents .= "<area alt=\"".$this->answers[$i]->getAnswertext()."\" ";
$imagemap_contents .= "shape=\"".$this->answers[$i]->getArea()."\" ";
$imagemap_contents .= "coords=\"".$this->answers[$i]->getCoords()."\" ";
$imagemap_contents .= "href=\"$href&selimage=" . $this->answers[$i]->getOrder() . "\" /> ";
}
$imagemap_contents .= "</map>";
return $imagemap_contents;
}
assImagemapQuestion::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

Reimplemented from assQuestion.

Definition at line 713 of file class.assImagemapQuestion.php.

Referenced by loadFromDb(), and saveToDb().

{
return "qpl_qst_imagemap";
}

+ Here is the caller graph for this function:

assImagemapQuestion::getAnswer (   $index = 0)

Returns an answer.

Returns an answer with a given index. The index of the first answer is 0, the index of the second answer is 1 and so on.

Parameters
integer$indexA nonnegative index of the n-th answer
Returns
object ASS_AnswerImagemap-Object containing the answer public
See Also
$answers

Definition at line 489 of file class.assImagemapQuestion.php.

{
if ($index < 0) return NULL;
if (count($this->answers) < 1) return NULL;
if ($index >= count($this->answers)) return NULL;
return $this->answers[$index];
}
assImagemapQuestion::getAnswerCount ( )

Returns the number of answers.

Returns the number of answers

Returns
integer The number of answers of the multiple choice question public
See Also
$answers

Definition at line 474 of file class.assImagemapQuestion.php.

{
return count($this->answers);
}
& assImagemapQuestion::getAnswers ( )

Returns the answer array.

Returns the answer array

Returns
array The answer array public
See Also
$answers

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

References $answers.

Referenced by setExportDetailsXLS(), and toJSON().

{
return $this->answers;
}

+ Here is the caller graph for this function:

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

Reimplemented from assQuestion.

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

{
return "qpl_a_imagemap";
}
assImagemapQuestion::getFeedbackSingleAnswer (   $answer_index)

Returns the feedback for a single selected answer.

Parameters
integer$answer_indexThe index of the answer
Returns
string Feedback text public

Reimplemented from assQuestion.

Definition at line 812 of file class.assImagemapQuestion.php.

References $result, $row, ilRTE\_replaceMediaObjectImageSrc(), and assQuestion\getId().

Referenced by getRTETextWithMediaObjects(), and toJSON().

{
global $ilDB;
$feedback = "";
$result = $ilDB->queryF("SELECT * FROM qpl_fb_imap WHERE question_fi = %s AND answer = %s",
array('integer','integer'),
array($this->getId(), $answer_index)
);
if ($result->numRows())
{
$row = $ilDB->fetchAssoc($result);
include_once("./Services/RTE/classes/class.ilRTE.php");
$feedback = ilRTE::_replaceMediaObjectImageSrc($row["feedback"], 1);
}
return $feedback;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assImagemapQuestion::getImageFilename ( )

Definition at line 368 of file class.assImagemapQuestion.php.

References $image_filename.

Referenced by copyImage(), deleteImage(), duplicateImage(), and toJSON().

{
return $this->image_filename;
}

+ Here is the caller graph for this function:

assImagemapQuestion::getMaximumPoints ( )

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

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

public

See Also
$points

Reimplemented from assQuestion.

Definition at line 554 of file class.assImagemapQuestion.php.

References assQuestion\$points.

Referenced by isComplete().

{
$points = 0;
foreach ($this->answers as $key => $value) {
if ($value->getPoints() > $points)
{
$points = $value->getPoints();
}
}
return $points;
}

+ Here is the caller graph for this function:

assImagemapQuestion::getQuestionType ( )

Returns the question type of the question.

Returns the question type of the question

Returns
integer The question type of the question public

Reimplemented from assQuestion.

Definition at line 700 of file class.assImagemapQuestion.php.

Referenced by toJSON().

{
return "assImagemapQuestion";
}

+ Here is the caller graph for this function:

assImagemapQuestion::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 867 of file class.assImagemapQuestion.php.

References getFeedbackSingleAnswer().

{
$text = parent::getRTETextWithMediaObjects();
foreach ($this->answers as $index => $answer)
{
$text .= $this->getFeedbackSingleAnswer($index);
}
return $text;
}

+ Here is the call graph for this function:

assImagemapQuestion::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 86 of file class.assImagemapQuestion.php.

References getMaximumPoints().

{
if (strlen($this->title) and ($this->author) and ($this->question) and ($this->image_filename) and (count($this->answers)) and ($this->getMaximumPoints() > 0))
{
return true;
}
else
{
return false;
}
}

+ Here is the call graph for this function:

assImagemapQuestion::loadFromDb (   $question_id)

Loads a assImagemapQuestion object from a database.

Loads a assImagemapQuestion 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 298 of file class.assImagemapQuestion.php.

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

{
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->setTitle($data["title"]);
$this->setComment($data["description"]);
$this->setOriginalId($data["original_id"]);
$this->setNrOfTries($data['nr_of_tries']);
$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->setImageFilename($data["image_file"]);
$this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
$result = $ilDB->queryF("SELECT * FROM qpl_a_imagemap WHERE question_fi = %s ORDER BY aorder ASC",
array("integer"),
array($question_id)
);
include_once "./Modules/TestQuestionPool/classes/class.assAnswerImagemap.php";
if ($result->numRows() > 0)
{
while ($data = $ilDB->fetchAssoc($result))
{
array_push($this->answers, new ASS_AnswerImagemap($data["answertext"], $data["points"], $data["aorder"], $data["coords"], $data["area"]));
}
}
}
parent::loadFromDb($question_id);
}

+ Here is the call graph for this function:

assImagemapQuestion::reworkWorkingData (   $active_id,
  $pass,
  $obligationsAnswered 
)
protected

Reworks the allready saved working data if neccessary.

protected

Parameters
integer$active_id
integer$pass
boolean$obligationsAnswered

Reimplemented from assQuestion.

Definition at line 678 of file class.assImagemapQuestion.php.

{
// nothing to rework!
}
assImagemapQuestion::saveToDb (   $original_id = "")

Saves a assImagemapQuestion object to a database.

Saves a assImagemapQuestion object to a database (experimental)

Parameters
object$dbA pear DB object public

Reimplemented from assQuestion.

Definition at line 106 of file class.assImagemapQuestion.php.

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

{
global $ilDB;
$this->saveQuestionDataToDb($original_id);
// 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) VALUES (%s, %s)",
array("integer", "text"),
array(
$this->getId(),
$this->image_filename
)
);
$affectedRows = $ilDB->manipulateF("DELETE FROM qpl_a_imagemap WHERE question_fi = %s",
array("integer"),
array($this->getId())
);
// Anworten wegschreiben
foreach ($this->answers as $key => $value)
{
$answer_obj = $this->answers[$key];
$next_id = $ilDB->nextId('qpl_a_imagemap');
$affectedRows = $ilDB->manipulateF("INSERT INTO qpl_a_imagemap (answer_id, question_fi, answertext, points, aorder, coords, area) VALUES (%s, %s, %s, %s, %s, %s, %s)",
array("integer","integer","text","float","integer","text","text"),
array($next_id, $this->id, $answer_obj->getAnswertext(), $answer_obj->getPoints(), $answer_obj->getOrder(), $answer_obj->getCoords(), $answer_obj->getArea())
);
}
parent::saveToDb($original_id);
}

+ Here is the call graph for this function:

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

Saves the learners input of the question to the database.

public

Parameters
integer$active_idActive id of the user
integer$passTest pass
Returns
boolean $status

Reimplemented from assQuestion.

Definition at line 623 of file class.assImagemapQuestion.php.

References $_GET, $ilUser, $pass, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), assQuestion\getId(), and assQuestion\logAction().

{
global $ilDB;
global $ilUser;
if (is_null($pass))
{
include_once "./Modules/Test/classes/class.ilObjTest.php";
$pass = ilObjTest::_getPass($active_id);
}
$affectedRows = $ilDB->manipulateF("DELETE FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
array("integer","integer","integer"),
array($active_id, $this->getId(), $pass)
);
if (strlen($_GET["selImage"]))
{
$next_id = $ilDB->nextId('tst_solutions');
$affectedRows = $ilDB->insert("tst_solutions", array(
"solution_id" => array("integer", $next_id),
"active_fi" => array("integer", $active_id),
"question_fi" => array("integer", $this->getId()),
"value1" => array("clob", $_GET['selImage']),
"value2" => array("clob", null),
"pass" => array("integer", $pass),
"tstamp" => array("integer", time())
));
include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
if (ilObjAssessmentFolder::_enabledAssessmentLogging())
{
$this->logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
}
}
else
{
include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
if (ilObjAssessmentFolder::_enabledAssessmentLogging())
{
$this->logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
}
}
return true;
}

+ Here is the call graph for this function:

assImagemapQuestion::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 889 of file class.assImagemapQuestion.php.

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

{
include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
$solution = $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 ($this->getAnswers() as $id => $answer)
{
$worksheet->writeString($startrow + $i, 0, ilExcelUtils::_convert_text($answer->getArea() . ": " . $answer->getCoords()), $format_bold);
if ($id == $solution[0]["value1"])
{
$worksheet->write($startrow + $i, 1, 1);
}
else
{
$worksheet->write($startrow + $i, 1, 0);
}
$i++;
}
return $startrow + $i + 1;
}

+ Here is the call graph for this function:

assImagemapQuestion::setImageFilename (   $image_filename,
  $image_tempfilename = "" 
)

Sets the image file name.

Parameters
string$image_filename. public
See Also
$image_filename

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

References $ilLog, $image_filename, assQuestion\getImagePath(), ilUtil\makeDirParents(), and ilUtil\moveUploadedFile().

Referenced by loadFromDb().

{
if (!empty($image_filename))
{
$image_filename = str_replace(" ", "_", $image_filename);
$this->image_filename = $image_filename;
}
if (!empty($image_tempfilename))
{
$imagepath = $this->getImagePath();
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
if (!ilUtil::moveUploadedFile($image_tempfilename, $image_filename, $imagepath.$image_filename))
{
$this->ilias->raiseError("The image could not be uploaded!", $this->ilias->error_obj->MESSAGE);
}
global $ilLog; $ilLog->write("gespeichert: " . $imagepath.$image_filename);
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assImagemapQuestion::syncWithOriginal ( )

Reimplemented from assQuestion.

Definition at line 683 of file class.assImagemapQuestion.php.

References assQuestion\getOriginalId().

{
if ($this->getOriginalId())
{
parent::syncWithOriginal();
$this->syncFeedbackSingleAnswers();
}
}

+ Here is the call graph for this function:

assImagemapQuestion::toJSON ( )

Returns a JSON representation of the question.

Definition at line 926 of file class.assImagemapQuestion.php.

References $answers, $mobs, $result, ilObjMediaObject\_getMobsOfObject(), ilRTE\_replaceMediaObjectImageSrc(), assQuestion\formatSAQuestion(), getAnswers(), assQuestion\getFeedbackGeneric(), getFeedbackSingleAnswer(), assQuestion\getId(), getImageFilename(), assQuestion\getImagePathWeb(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), and assQuestion\getTitle().

{
include_once("./Services/RTE/classes/class.ilRTE.php");
$result = array();
$result['id'] = (int) $this->getId();
$result['type'] = (string) $this->getQuestionType();
$result['title'] = (string) $this->getTitle();
$result['question'] = $this->formatSAQuestion($this->getQuestion());
$result['nr_of_tries'] = (int) $this->getNrOfTries();
$result['shuffle'] = (bool) $this->getShuffle();
$result['feedback'] = array(
"onenotcorrect" => nl2br(ilRTE::_replaceMediaObjectImageSrc($this->getFeedbackGeneric(0), 0)),
"allcorrect" => nl2br(ilRTE::_replaceMediaObjectImageSrc($this->getFeedbackGeneric(1), 0))
);
$result['image'] = (string) $this->getImagePathWeb() . $this->getImageFilename();
$answers = array();
foreach ($this->getAnswers() as $key => $answer_obj)
{
array_push($answers, array(
"answertext" => (string) $answer_obj->getAnswertext(),
"points" => (float) $answer_obj->getPoints(),
"order" => (int) $answer_obj->getOrder(),
"coords" => $answer_obj->getCoords(),
"state" => $answer_obj->getState(),
"area" => $answer_obj->getArea(),
"feedback" => ilRTE::_replaceMediaObjectImageSrc($this->getFeedbackSingleAnswer($key), 0)
));
}
$result['answers'] = $answers;
$mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
$result['mobs'] = $mobs;
return json_encode($result);
}

+ Here is the call graph for this function:

assImagemapQuestion::uploadImagemap (   $imagemap_filename = "")

Uploads an image map and takes over the areas.

Parameters
string$imagemap_filenameImagemap filename
Returns
integer number of areas added

Definition at line 345 of file class.assImagemapQuestion.php.

References $coords, and addAnswer().

{
$added = 0;
if (!empty($imagemap_filename))
{
$fp = fopen($imagemap_filename, "r");
$contents = fread($fp, filesize($imagemap_filename));
fclose($fp);
if (preg_match_all("/<area(.+)>/siU", $contents, $matches))
{
for ($i=0; $i< count($matches[1]); $i++)
{
preg_match("/alt\s*=\s*\"(.+)\"\s*/siU", $matches[1][$i], $alt);
preg_match("/coords\s*=\s*\"(.+)\"\s*/siU", $matches[1][$i], $coords);
preg_match("/shape\s*=\s*\"(.+)\"\s*/siU", $matches[1][$i], $shape);
$this->addAnswer($alt[1], 0.0, count($this->answers), $coords[1], $shape[1]);
$added++;
}
}
}
return $added;
}

+ Here is the call graph for this function:

Field Documentation

assImagemapQuestion::$answers

Definition at line 31 of file class.assImagemapQuestion.php.

Referenced by getAnswers(), and toJSON().

assImagemapQuestion::$coords

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

Referenced by addAnswer(), and uploadImagemap().

assImagemapQuestion::$image_filename

Definition at line 40 of file class.assImagemapQuestion.php.

Referenced by __construct(), getImageFilename(), and setImageFilename().

assImagemapQuestion::$imagemap_contents

Definition at line 49 of file class.assImagemapQuestion.php.

Referenced by get_imagemap_contents().

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