ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields
assImagemapQuestion Class Reference
Modules/TestQuestionPool

Class for image map questions. More...

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

Public Member Functions

 assImagemapQuestion ($title="", $comment="", $author="", $owner=-1, $question="", $imagemap_filename="", $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="")
 Duplicates an assImagemapQuestion.
 copyObject ($target_questionpool, $title="")
 Copies an assImagemapQuestion object.
 duplicateImage ($question_id)
 copyImage ($question_id, $source_questionpool)
 loadFromDb ($question_id)
 Loads a assImagemapQuestion object from a database.
 get_imagemap_filename ()
 Gets the imagemap file name.
 setImagemapFilename ($imagemap_filename, $imagemap_tempfilename="")
 Sets the imagemap file name.
 get_image_filename ()
 Gets the image file name.
 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)
 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.
 saveFeedbackSingleAnswer ($answer_index, $feedback)
 Saves feedback for a single selected answer to the database.
 syncFeedbackSingleAnswers ()
 Synchronizes the single answer feedback with an original question.
 getFeedbackSingleAnswer ($answer_index)
 Returns the feedback for a single selected answer.
 duplicateFeedbackAnswer ($original_id)
 Duplicates the answer specific feedback.
 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
 assQuestion ($title="", $comment="", $author="", $owner=-1, $question="")
 assQuestion constructor
 _assQuestion ()
 fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
 Creates a question from a QTI file.
 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.
 setId ($id=-1)
 Sets the id.
 setTestId ($id=-1)
 Sets the test id.
 setComment ($comment="")
 Sets the comment.
 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.
 setOwner ($owner="")
 Sets the creator/owner.
 getTitle ()
 Gets the title string.
 getId ()
 Gets the id.
 getShuffle ()
 Gets the shuffle flag.
 getTestId ()
 Gets the test id.
 getComment ()
 Gets the comment.
 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.
 getOwner ()
 Gets the creator/owner.
 getObjId ()
 Get the object id of the container object.
 setObjId ($obj_id=0)
 Set the object id of the container object.
 createPageObject ()
 create page object of question
 insertIntoTest ($test_id)
 Insert the question into a test.
 _getMaximumPoints ($question_id)
 Returns the maximum points, a learner can reach answering the question.
& _getQuestionInfo ($question_id)
 Returns question information from the database.
 _getSuggestedSolutionCount ($question_id)
 Returns the number of suggested solutions associated with a question.
& _getSuggestedSolution ($question_id, $subquestion_index=0)
 Returns a suggested solution for a given subquestion index.
 _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.
 _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.
 getJavaPath ()
 Returns the image path for web accessable images of a question.
 getImagePath ()
 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.
 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.
 copyXHTMLMediaObjectsOfQuestion ($a_q_id)
 syncXHTMLMediaObjectsOfQuestion ()
 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 ()
 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.
 saveSuggestedSolution ($solution_id="", $subquestion_index=0)
 Saves 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.
& _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.
 _isWorkedThrough ($active_id, $question_id, $pass=NULL)
 Returns true if the question was worked through in the given pass.
 getMultilineAnswerSetting ()
 setMultilineAnswerSetting ($a_setting=0)
 _areAnswered ($a_user_id, $a_question_ids)
 Checks if an array of question ids is answered by an user or not.
 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)
 Sets the points, a learner has reached answering the question Additionally objective results are updated.
 getQuestion ()
 Gets the question text.
 setQuestion ($question="")
 Sets the question text.
 getQuestionTypeID ()
 Returns the question type of the question.
 saveFeedbackGeneric ($correctness, $feedback)
 Saves generic feedback to the database.
 getFeedbackGeneric ($correctness)
 Returns the generic feedback for a given question state.
 duplicateFeedbackGeneric ($original_id)
 Duplicates the generic feedback of a question.
 syncFeedbackGeneric ()
 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.

Data Fields

 $answers
 $imagemap_filename
 $image_filename
 $imagemap_contents
 $coords
- Data Fields inherited from assQuestion
 $id
 $title
 $comment
 $owner
 $author
 $question
 $points
 $est_working_time
 $shuffle
 $test_id
 $obj_id
 $ilias
 $tpl
 $lng
 $domxml
 $outputType
 $suggested_solutions
 $original_id

Additional Inherited Members

- Static Public Member Functions inherited from assQuestion
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.

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
Version
Id:
class.assImagemapQuestion.php 17941 2008-11-17 14:45:16Z hschottm

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

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

References $coords, and assQuestion\$points.

Referenced by setImagemapFilename().

{
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::assImagemapQuestion (   $title = "",
  $comment = "",
  $author = "",
  $owner = -1,
  $question = "",
  $imagemap_filename = "",
  $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$imagemap_fileThe imagemap file name of the imagemap question
string$image_fileThe image file name of the imagemap question
string$questionThe question string of the imagemap question public

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

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

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

+ Here is the call graph for this function:

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

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

{
global $ilDB;
$found_values = array();
if (is_null($pass))
{
$pass = $this->getSolutionMaxPass($active_id);
}
$query = sprintf("SELECT * FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
$ilDB->quote($active_id . ""),
$ilDB->quote($this->getId() . ""),
$ilDB->quote($pass . "")
);
$result = $ilDB->query($query);
while ($data = $result->fetchRow(MDB2_FETCHMODE_OBJECT))
{
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();
}
}
}
$points = parent::calculateReachedPoints($active_id, $pass = NULL, $points);
return $points;
}

+ Here is the call graph for this function:

assImagemapQuestion::copyImage (   $question_id,
  $source_questionpool 
)

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

References $filename, get_image_filename(), 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->get_image_filename();
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 317 of file class.assImagemapQuestion.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 = $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 answer specific feedback
$clone->duplicateFeedbackAnswer($original_id);
// duplicate the image
$clone->copyImage($original_id, $source_questionpool);
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 638 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::duplicate (   $for_test = true,
  $title = "",
  $author = "",
  $owner = "" 
)

Duplicates an assImagemapQuestion.

Duplicates an assImagemapQuestion

public

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

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

{
if ($this->id <= 0)
{
// The question has not been saved. It cannot be duplicated
return;
}
// duplicate the question in database
$this_id = $this->getId();
$clone = $this;
include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
$original_id = assQuestion::_getOriginalId($this->id);
$clone->id = -1;
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 answer specific feedback
$clone->duplicateFeedbackAnswer($this_id);
// duplicate the image
$clone->duplicateImage($this_id);
return $clone->id;
}

+ Here is the call graph for this function:

assImagemapQuestion::duplicateFeedbackAnswer (   $original_id)

Duplicates the answer specific feedback.

Duplicates the answer specific feedback

Parameters
integer$original_idThe database ID of the original question public

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

References assQuestion\$original_id, and $result.

{
global $ilDB;
$feedback = "";
$query = sprintf("SELECT * FROM qpl_feedback_imagemap WHERE question_fi = %s",
$ilDB->quote($original_id . "")
);
$result = $ilDB->query($query);
if ($result->numRows())
{
while ($row = $result->fetchRow(MDB2_FETCHMODE_ASSOC))
{
$duplicatequery = sprintf("INSERT INTO qpl_feedback_imagemap VALUES (NULL, %s, %s, %s, NULL)",
$ilDB->quote($this->getId() . ""),
$ilDB->quote($row["answer"] . ""),
$ilDB->quote($row["feedback"] . "")
);
$duplicateresult = $ilDB->query($duplicatequery);
}
}
}
assImagemapQuestion::duplicateImage (   $question_id)

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

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

{
$imagepath = $this->getImagePath();
$imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
if (!file_exists($imagepath)) {
ilUtil::makeDirParents($imagepath);
}
$filename = $this->get_image_filename();
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 659 of file class.assImagemapQuestion.php.

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

Gets the image file name.

Gets the image file name

Returns
string The image file name of the assImagemapQuestion object public
See Also
$image_filename

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

References $image_filename.

Referenced by copyImage(), and duplicateImage().

{
return $this->image_filename;
}

+ 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 529 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::get_imagemap_filename ( )

Gets the imagemap file name.

Gets the imagemap file name

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

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

References $imagemap_filename.

{
return $this->imagemap_filename;
}
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 818 of file class.assImagemapQuestion.php.

{
return "qpl_question_imagemap";
}
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 607 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 592 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 623 of file class.assImagemapQuestion.php.

References $answers.

Referenced by setExportDetailsXLS().

{
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 831 of file class.assImagemapQuestion.php.

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

Returns the feedback for a single selected answer.

Returns the feedback for a single selected answer

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

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

References $result, and ilRTE\_replaceMediaObjectImageSrc().

Referenced by getRTETextWithMediaObjects().

{
global $ilDB;
$feedback = "";
$query = sprintf("SELECT * FROM qpl_feedback_imagemap WHERE question_fi = %s AND answer = %s",
$ilDB->quote($this->getId() . ""),
$ilDB->quote($answer_index . "")
);
$result = $ilDB->query($query);
if ($result->numRows())
{
$row = $result->fetchRow(MDB2_FETCHMODE_ASSOC);
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 484 of file class.assImagemapQuestion.php.

References $image_filename.

{
return $this->image_filename;
}
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 671 of file class.assImagemapQuestion.php.

References assQuestion\$points.

Referenced by isComplete(), and saveToDb().

{
$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 805 of file class.assImagemapQuestion.php.

{
return "assImagemapQuestion";
}
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 969 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 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 116 of file class.assImagemapQuestion.php.

References getMaximumPoints().

Referenced by saveToDb().

{
if (($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:

+ Here is the caller 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 389 of file class.assImagemapQuestion.php.

References $data, $result, ilRTE\_replaceMediaObjectImageSrc(), and assQuestion\setEstimatedWorkingTime().

{
global $ilDB;
$query = sprintf("SELECT qpl_questions.*, qpl_question_imagemap.* FROM qpl_questions, qpl_question_imagemap WHERE question_id = %s AND qpl_questions.question_id = qpl_question_imagemap.question_fi",
$ilDB->quote($question_id)
);
$result = $ilDB->query($query);
if ($result->numRows() == 1)
{
$data = $result->fetchRow(MDB2_FETCHMODE_OBJECT);
$this->id = $question_id;
$this->obj_id = $data->obj_fi;
$this->title = $data->title;
$this->comment = $data->comment;
$this->author = $data->author;
$this->original_id = $data->original_id;
$this->solution_hint = $data->solution_hint;
$this->owner = $data->owner;
include_once("./Services/RTE/classes/class.ilRTE.php");
$this->question = ilRTE::_replaceMediaObjectImageSrc($data->question_text, 1);
$this->image_filename = $data->image_file;
$this->points = $data->points;
$this->setEstimatedWorkingTime(substr($data->working_time, 0, 2), substr($data->working_time, 3, 2), substr($data->working_time, 6, 2));
$query = sprintf("SELECT * FROM qpl_answer_imagemap WHERE question_fi = %s ORDER BY aorder ASC",
$ilDB->quote($question_id)
);
$result = $ilDB->query($query);
include_once "./Modules/TestQuestionPool/classes/class.assAnswerImagemap.php";
if ($result->numRows() > 0)
{
while ($data = $result->fetchRow(MDB2_FETCHMODE_OBJECT))
{
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::saveFeedbackSingleAnswer (   $answer_index,
  $feedback 
)

Saves feedback for a single selected answer to the database.

Saves feedback for a single selected answer to the database

Parameters
integer$answer_indexThe index of the answer
string$feedbackFeedback text public

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

References $result, and ilRTE\_replaceMediaObjectImageSrc().

{
global $ilDB;
$query = sprintf("DELETE FROM qpl_feedback_imagemap WHERE question_fi = %s AND answer = %s",
$ilDB->quote($this->getId() . ""),
$ilDB->quote($answer_index . "")
);
$result = $ilDB->query($query);
if (strlen($feedback))
{
include_once("./Services/RTE/classes/class.ilRTE.php");
$query = sprintf("INSERT INTO qpl_feedback_imagemap VALUES (NULL, %s, %s, %s, NULL)",
$ilDB->quote($this->getId() . ""),
$ilDB->quote($answer_index . ""),
$ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($feedback, 0))
);
$result = $ilDB->query($query);
}
}

+ Here is the call graph for this function:

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

References assQuestion\$ilias, assQuestion\$original_id, $result, ilRTE\_replaceMediaObjectImageSrc(), assQuestion\createPageObject(), assQuestion\getEstimatedWorkingTime(), getMaximumPoints(), assQuestion\getQuestionTypeID(), assQuestion\getTestId(), assQuestion\insertIntoTest(), and isComplete().

{
global $ilDB;
$complete = 0;
if ($this->isComplete())
{
$complete = 1;
}
$estw_time = $this->getEstimatedWorkingTime();
$estw_time = sprintf("%02d:%02d:%02d", $estw_time['h'], $estw_time['m'], $estw_time['s']);
if ($original_id)
{
$original_id = $ilDB->quote($original_id);
}
else
{
$original_id = "NULL";
}
// cleanup RTE images which are not inserted into the question text
include_once("./Services/RTE/classes/class.ilRTE.php");
if ($this->id == -1)
{
// Neuen Datensatz schreiben
$now = getdate();
$question_type = $this->getQuestionTypeID();
$created = sprintf("%04d%02d%02d%02d%02d%02d", $now['year'], $now['mon'], $now['mday'], $now['hours'], $now['minutes'], $now['seconds']);
$query = sprintf("INSERT INTO qpl_questions (question_id, question_type_fi, obj_fi, title, comment, author, owner, question_text, working_time, points, complete, created, original_id, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, NULL)",
$ilDB->quote($question_type),
$ilDB->quote($this->obj_id),
$ilDB->quote($this->title),
$ilDB->quote($this->comment),
$ilDB->quote($this->author),
$ilDB->quote($this->owner),
$ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($this->question, 0)),
$ilDB->quote($estw_time),
$ilDB->quote($this->getMaximumPoints() . ""),
$ilDB->quote("$complete"),
$ilDB->quote($created),
$original_id
);
$result = $ilDB->query($query);
if (PEAR::isError($result))
{
global $ilias;
$ilias->raiseError($result->getMessage());
}
else
{
$this->id = $ilDB->getLastInsertId();
$insertquery = sprintf("INSERT INTO qpl_question_imagemap (question_fi, image_file) VALUES (%s, %s)",
$ilDB->quote($this->id . ""),
$ilDB->quote($this->image_filename)
);
$ilDB->query($insertquery);
// create page object of question
$this->createPageObject();
if ($this->getTestId() > 0)
{
$this->insertIntoTest($this->getTestId());
}
}
}
else
{
// Vorhandenen Datensatz aktualisieren
$query = sprintf("UPDATE qpl_questions SET obj_fi = %s, title = %s, comment = %s, author = %s, question_text = %s, working_time = %s, points = %s, complete = %s WHERE question_id = %s",
$ilDB->quote($this->obj_id. ""),
$ilDB->quote($this->title),
$ilDB->quote($this->comment),
$ilDB->quote($this->author),
$ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($this->question, 0)),
$ilDB->quote($estw_time),
$ilDB->quote($this->getMaximumPoints() . ""),
$ilDB->quote("$complete"),
$ilDB->quote($this->id)
);
$result = $ilDB->query($query);
$query = sprintf("UPDATE qpl_question_imagemap SET image_file = %s WHERE question_fi = %s",
$ilDB->quote($this->image_filename),
$ilDB->quote($this->id)
);
$result = $ilDB->query($query);
}
if (PEAR::isError($result))
{
global $ilias;
$ilias->raiseError($result->getMessage());
}
else
{
$query = sprintf("DELETE FROM qpl_answer_imagemap WHERE question_fi = %s",
$ilDB->quote($this->id)
);
$result = $ilDB->query($query);
// Anworten wegschreiben
foreach ($this->answers as $key => $value)
{
$answer_obj = $this->answers[$key];
//print "id:".$this->id." answer tex:".$answer_obj->getAnswertext()." answer_obj->getOrder():".$answer_obj->getOrder()." answer_obj->getCoords():".$answer_obj->getCoords()." answer_obj->getArea():".$answer_obj->getArea();
$query = sprintf("INSERT INTO qpl_answer_imagemap (answer_id, question_fi, answertext, points, aorder, coords, area) VALUES (NULL, %s, %s, %s, %s, %s, %s)",
$ilDB->quote($this->id),
$ilDB->quote($answer_obj->getAnswertext() . ""),
$ilDB->quote($answer_obj->getPoints() . ""),
$ilDB->quote($answer_obj->getOrder() . ""),
$ilDB->quote($answer_obj->getCoords() . ""),
$ilDB->quote($answer_obj->getArea() . "")
);
$answer_result = $ilDB->query($query);
}
}
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.

Saves the learners input of the question to the database

Parameters
integer$test_idThe 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 741 of file class.assImagemapQuestion.php.

References $_GET, $pass, $result, 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);
}
$query = sprintf("DELETE FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
$ilDB->quote($active_id . ""),
$ilDB->quote($this->getId() . ""),
$ilDB->quote($pass . "")
);
$result = $ilDB->query($query);
if (strlen($_GET["selImage"]))
{
$query = sprintf("INSERT INTO tst_solutions (solution_id, active_fi, question_fi, value1, value2, pass, TIMESTAMP) VALUES (NULL, %s, %s, %s, NULL, %s, NULL)",
$ilDB->quote($active_id),
$ilDB->quote($this->getId()),
$ilDB->quote($_GET["selImage"]),
$ilDB->quote($pass . "")
);
$result = $ilDB->query($query);
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());
}
}
parent::saveWorkingData($active_id, $pass);
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 991 of file class.assImagemapQuestion.php.

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

{
include_once ("./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.

Sets the image file name

Parameters
string$image_filename. public
See Also
$image_filename

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

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

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

assImagemapQuestion::setImagemapFilename (   $imagemap_filename,
  $imagemap_tempfilename = "" 
)

Sets the imagemap file name.

Sets the imagemap file name

Parameters
string$imagemap_file,.public
See Also
$imagemap_filename

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

References $coords, $imagemap_filename, and addAnswer().

{
if (!empty($imagemap_filename)) {
$this->imagemap_filename = $imagemap_filename;
}
if (!empty($imagemap_tempfilename)) {
$fp = fopen($imagemap_tempfilename, "r");
$contents = fread($fp, filesize($imagemap_tempfilename));
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]);
}
}
}
}

+ Here is the call graph for this function:

assImagemapQuestion::syncFeedbackSingleAnswers ( )

Synchronizes the single answer feedback with an original question.

Synchronizes the single answer feedback with an original question

public

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

References $result.

Referenced by syncWithOriginal().

{
global $ilDB;
$feedback = "";
// delete generic feedback of the original
$deletequery = sprintf("DELETE FROM qpl_feedback_imagemap WHERE question_fi = %s",
$ilDB->quote($this->original_id . "")
);
$result = $ilDB->query($deletequery);
// get generic feedback of the actual question
$query = sprintf("SELECT * FROM qpl_feedback_imagemap WHERE question_fi = %s",
$ilDB->quote($this->getId() . "")
);
$result = $ilDB->query($query);
// save generic feedback to the original
if ($result->numRows())
{
while ($row = $result->fetchRow(MDB2_FETCHMODE_ASSOC))
{
$duplicatequery = sprintf("INSERT INTO qpl_feedback_imagemap VALUES (NULL, %s, %s, %s, NULL)",
$ilDB->quote($this->original_id . ""),
$ilDB->quote($row["answer"] . ""),
$ilDB->quote($row["feedback"] . "")
);
$duplicateresult = $ilDB->query($duplicatequery);
}
}
}

+ Here is the caller graph for this function:

assImagemapQuestion::syncWithOriginal ( )

Reimplemented from assQuestion.

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

References assQuestion\getOriginalId(), and syncFeedbackSingleAnswers().

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

+ Here is the call graph for this function:

Field Documentation

assImagemapQuestion::$answers

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

Referenced by getAnswers().

assImagemapQuestion::$coords

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

Referenced by addAnswer(), and setImagemapFilename().

assImagemapQuestion::$image_filename

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

Referenced by assImagemapQuestion(), get_image_filename(), getImageFilename(), and setImageFilename().

assImagemapQuestion::$imagemap_contents

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

Referenced by get_imagemap_contents().

assImagemapQuestion::$imagemap_filename

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

Referenced by assImagemapQuestion(), get_imagemap_filename(), and setImagemapFilename().

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