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

Class for multiple choice tests. More...

+ Inheritance diagram for assMultipleChoice:
+ Collaboration diagram for assMultipleChoice:

Public Member Functions

 assMultipleChoice ($title="", $comment="", $author="", $owner=-1, $question="", $output_type=OUTPUT_ORDER)
 assMultipleChoice constructor
 isComplete ()
 Returns true, if a multiple choice question is complete for use.
 saveToDb ($original_id="")
 Saves a assMultipleChoice object to a database.
 loadFromDb ($question_id)
 Loads a assMultipleChoice object from a database.
 duplicate ($for_test=true, $title="", $author="", $owner="")
 Adds an answer to the question.
 copyObject ($target_questionpool, $title="")
 Copies an assMultipleChoice object.
 getOutputType ()
 Gets the multiple choice output type.
 setOutputType ($output_type=OUTPUT_ORDER)
 Sets the multiple choice output type.
 addAnswer ($answertext="", $points=0.0, $points_unchecked=0.0, $order=0, $answerimage="")
 Adds a possible answer for a multiple choice question.
 getAnswerCount ()
 Returns the number of answers.
 getAnswer ($index=0)
 Returns an answer.
 deleteAnswer ($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.
 syncFeedbackSingleAnswers ()
 Synchronizes the single answer feedback with an original question.
 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.
 getGraphicalAnswerSetting ()
 setGraphicalAnswerSetting ($a_setting=0)
 setImageFile ($image_filename, $image_tempfilename="")
 Sets the image file.
 deleteImage ($image_filename)
 Deletes an image file.
 duplicateImages ($question_id)
 copyImages ($question_id, $source_questionpool)
 saveFeedbackSingleAnswer ($answer_index, $feedback)
 Saves feedback for a single selected answer to the database.
 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.
& getAnswers ()
 Returns a reference to the answers array.
 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.
 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.
 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
 $output_type
- 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

Protected Member Functions

 syncImages ()
 Sync images of a MC question on synchronisation with the original question.
- Protected Member Functions inherited from assQuestion
 deletePageOfQuestion ($question_id)
 Deletes the page object of a question with a given 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.

Detailed Description

Class for multiple choice tests.

assMultipleChoice is a class for multiple choice 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.assMultipleChoice.php 26271 2010-11-01 13:30:48Z hschottm

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

Member Function Documentation

assMultipleChoice::addAnswer (   $answertext = "",
  $points = 0.0,
  $points_unchecked = 0.0,
  $order = 0,
  $answerimage = "" 
)

Adds a possible answer for a multiple choice question.

Adds a possible answer for a multiple choice question. A ASS_AnswerBinaryStateImage 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)
boolean$stateDefines the answer as correct (TRUE) or incorrect (FALSE)
integer$orderA possible display order of the answer
double$pointsThe points for not selecting the answer (even negative points can be used) public
See Also
$answers
ASS_AnswerBinaryStateImage

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

References assQuestion\$points.

{
$found = -1;
foreach ($this->answers as $key => $value)
{
if ($value->getOrder() == $order)
{
$found = $order;
}
}
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMultipleResponseImage.php";
if ($found >= 0)
{
// Antwort einfügen
$answer = new ASS_AnswerMultipleResponseImage($answertext, $points, $found, $points_unchecked, $answerimage);
array_push($this->answers, $answer);
for ($i = $found + 1; $i < count($this->answers); $i++)
{
$this->answers[$i] = $this->answers[$i-1];
}
$this->answers[$found] = $answer;
}
else
{
// Anwort anhängen
$answer = new ASS_AnswerMultipleResponseImage($answertext, $points, count($this->answers), $points_unchecked, $answerimage);
array_push($this->answers, $answer);
}
}
assMultipleChoice::assMultipleChoice (   $title = "",
  $comment = "",
  $author = "",
  $owner = -1,
  $question = "",
  $output_type = OUTPUT_ORDER 
)

assMultipleChoice constructor

The constructor takes possible arguments an creates an instance of the assMultipleChoice 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$output_typeThe output order of the multiple choice answers public
See Also
assQuestion:assQuestion()

Definition at line 70 of file class.assMultipleChoice.php.

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

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

+ Here is the call graph for this function:

assMultipleChoice::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 600 of file class.assMultipleChoice.php.

References $data, $pass, assQuestion\$points, $result, ilObjTest\_getMCScoring(), 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;
foreach ($this->answers as $key => $answer)
{
if (in_array($key, $found_values))
{
$points += $answer->getPoints();
}
else
{
$points += $answer->getPointsUnchecked();
}
}
include_once "./Modules/Test/classes/class.ilObjTest.php";
$mc_scoring = ilObjTest::_getMCScoring($active_id);
if (($mc_scoring == 0) && (count($found_values) == 0))
{
$points = 0;
}
$points = parent::calculateReachedPoints($active_id, $pass = NULL, $points);
return $points;
}

+ Here is the call graph for this function:

assMultipleChoice::copyImages (   $question_id,
  $source_questionpool 
)

Definition at line 906 of file class.assMultipleChoice.php.

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

{
global $ilLog;
$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);
foreach ($this->answers as $answer)
{
$filename = $answer->getImage();
if (strlen($filename))
{
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
if (!copy($imagepath_original . $filename, $imagepath . $filename))
{
$ilLog->write("image could not be duplicated!!!!", $ilLog->ERROR);
$ilLog->write("object: " . print_r($this, TRUE), $ilLog->ERROR);
}
if (!copy($imagepath_original . $filename . ".thumb.jpg", $imagepath . $filename . ".thumb.jpg"))
{
$ilLog->write("image thumbnail could not be duplicated!!!!", $ilLog->ERROR);
$ilLog->write("object: " . print_r($this, TRUE), $ilLog->ERROR);
}
}
}
}

+ Here is the call graph for this function:

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

Copies an assMultipleChoice object.

Copies an assMultipleChoice object

public

Definition at line 375 of file class.assMultipleChoice.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 image
$clone->copyImages($original_id, $source_questionpool);
// duplicate the generic feedback
$clone->duplicateFeedbackGeneric($original_id);
// duplicate the answer specific feedback
$clone->duplicateFeedbackAnswer($original_id);
return $clone->id;
}

+ Here is the call graph for this function:

assMultipleChoice::deleteAnswer (   $index = 0)

Deletes an answer.

Deletes 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 public
See Also
$answers

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

References deleteImage().

{
if ($index < 0) return;
if (count($this->answers) < 1) return;
if ($index >= count($this->answers)) return;
$answer = $this->answers[$index];
if (strlen($answer->getImage())) $this->deleteImage($answer->getImage());
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);
}
}
}

+ Here is the call graph for this function:

assMultipleChoice::deleteImage (   $image_filename)

Deletes an image file.

Deletes an image file

Parameters
string$image_filenameName of the image file to delete private

Definition at line 870 of file class.assMultipleChoice.php.

References assQuestion\getImagePath().

Referenced by deleteAnswer().

{
$imagepath = $this->getImagePath();
unlink($imagepath . $image_filename);
$thumbpath = $imagepath . $image_filename . "." . "thumb.jpg";
unlink($thumbpath);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assMultipleChoice::duplicate (   $for_test = true,
  $title = "",
  $author = "",
  $owner = "" 
)

Adds an answer to the question.

Adds an answer to the question

public Duplicates an assMultipleChoiceQuestion

Duplicates an assMultipleChoiceQuestion

public

Definition at line 318 of file class.assMultipleChoice.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 images
$clone->duplicateImages($this_id);
// duplicate the generic feedback
$clone->duplicateFeedbackGeneric($this_id);
// duplicate the answer specific feedback
$clone->duplicateFeedbackAnswer($this_id);
return $clone->id;
}

+ Here is the call graph for this function:

assMultipleChoice::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 1044 of file class.assMultipleChoice.php.

References assQuestion\$original_id, and $result.

{
global $ilDB;
$feedback = "";
$query = sprintf("SELECT * FROM qpl_feedback_multiplechoice 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_multiplechoice VALUES (NULL, %s, %s, %s, NULL)",
$ilDB->quote($this->getId() . ""),
$ilDB->quote($row["answer"] . ""),
$ilDB->quote($row["feedback"] . "")
);
$duplicateresult = $ilDB->query($duplicatequery);
}
}
}
assMultipleChoice::duplicateImages (   $question_id)

Definition at line 878 of file class.assMultipleChoice.php.

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

{
global $ilLog;
$imagepath = $this->getImagePath();
$imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
foreach ($this->answers as $answer)
{
$filename = $answer->getImage();
if (strlen($filename))
{
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
if (!copy($imagepath_original . $filename, $imagepath . $filename))
{
$ilLog->write("image could not be duplicated!!!!", $ilLog->ERROR);
$ilLog->write("object: " . print_r($this, TRUE), $ilLog->ERROR);
}
if (!copy($imagepath_original . $filename . ".thumb.jpg", $imagepath . $filename . ".thumb.jpg"))
{
$ilLog->write("image thumbnail could not be duplicated!!!!", $ilLog->ERROR);
$ilLog->write("object: " . print_r($this, TRUE), $ilLog->ERROR);
}
}
}
}

+ Here is the call graph for this function:

assMultipleChoice::flushAnswers ( )

Deletes all answers.

Deletes all answers

public

See Also
$answers

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

{
$this->answers = array();
}
assMultipleChoice::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 780 of file class.assMultipleChoice.php.

{
return "qpl_question_multiplechoice";
}
assMultipleChoice::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_AnswerBinaryStateImage-Object containing the answer public
See Also
$answers

Definition at line 513 of file class.assMultipleChoice.php.

{
if ($index < 0) return NULL;
if (count($this->answers) < 1) return NULL;
if ($index >= count($this->answers)) return NULL;
return $this->answers[$index];
}
assMultipleChoice::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 497 of file class.assMultipleChoice.php.

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

Returns a reference to the answers array.

Definition at line 1086 of file class.assMultipleChoice.php.

References $answers.

Referenced by setExportDetailsXLS().

{
return $this->answers;
}

+ Here is the caller graph for this function:

assMultipleChoice::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 793 of file class.assMultipleChoice.php.

{
return "qpl_answer_multiplechoice";
}
assMultipleChoice::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 1017 of file class.assMultipleChoice.php.

References $result, and ilRTE\_replaceMediaObjectImageSrc().

Referenced by getRTETextWithMediaObjects().

{
global $ilDB;
$feedback = "";
$query = sprintf("SELECT * FROM qpl_feedback_multiplechoice 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:

assMultipleChoice::getGraphicalAnswerSetting ( )

Definition at line 798 of file class.assMultipleChoice.php.

{
global $ilUser;
$graphicalAnswerSetting = $ilUser->getPref("graphicalAnswerSetting");
if ($graphicalAnswerSetting != 1)
{
$graphicalAnswerSetting = 0;
}
return $graphicalAnswerSetting;
}
assMultipleChoice::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 571 of file class.assMultipleChoice.php.

References assQuestion\$points.

Referenced by isComplete(), and saveToDb().

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

+ Here is the caller graph for this function:

assMultipleChoice::getOutputType ( )

Gets the multiple choice output type.

Gets the multiple choice output type which is either OUTPUT_ORDER (=0) or OUTPUT_RANDOM (=1).

Returns
integer The output type of the assMultipleChoice object public
See Also
$output_type

Reimplemented from assQuestion.

Definition at line 418 of file class.assMultipleChoice.php.

References $output_type.

{
return $this->output_type;
}
assMultipleChoice::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 767 of file class.assMultipleChoice.php.

{
return "assMultipleChoice";
}
assMultipleChoice::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 1071 of file class.assMultipleChoice.php.

References getFeedbackSingleAnswer().

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

+ Here is the call graph for this function:

assMultipleChoice::isComplete ( )

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

Returns true, if a multiple choice question is complete for use

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

Reimplemented from assQuestion.

Definition at line 92 of file class.assMultipleChoice.php.

References getMaximumPoints().

Referenced by saveToDb().

{
if (($this->title) and ($this->author) and ($this->question) 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:

assMultipleChoice::loadFromDb (   $question_id)

Loads a assMultipleChoice object from a database.

Loads a assMultipleChoice 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 247 of file class.assMultipleChoice.php.

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

{
global $ilDB;
$hasimages = 0;
$query = sprintf("SELECT qpl_questions.*, qpl_question_multiplechoice.* FROM qpl_questions, qpl_question_multiplechoice WHERE question_id = %s AND qpl_questions.question_id = qpl_question_multiplechoice.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->title = $data->title;
$this->comment = $data->comment;
$this->solution_hint = $data->solution_hint;
$this->original_id = $data->original_id;
$this->obj_id = $data->obj_fi;
$this->author = $data->author;
$this->owner = $data->owner;
$this->points = $data->points;
include_once("./Services/RTE/classes/class.ilRTE.php");
$this->question = ilRTE::_replaceMediaObjectImageSrc($data->question_text, 1);
$this->setShuffle($data->shuffle);
$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_multiplechoice WHERE question_fi = %s ORDER BY aorder ASC",
$ilDB->quote($question_id));
$result = $ilDB->query($query);
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMultipleResponseImage.php";
if ($result->numRows() > 0)
{
while ($data = $result->fetchRow(MDB2_FETCHMODE_OBJECT))
{
$imagefilename = $this->getImagePath() . $data->imagefile;
if (!@file_exists($imagefilename))
{
$data->imagefile = "";
}
include_once("./Services/RTE/classes/class.ilRTE.php");
$data->answertext = ilRTE::_replaceMediaObjectImageSrc($data->answertext, 1);
if (strlen($data->imagefile)) $hasimages = 1;
array_push($this->answers, new ASS_AnswerMultipleResponseImage($data->answertext, $data->points, $data->aorder, $data->points_unchecked, $data->imagefile));
}
}
}
$this->setGraphicalAnswerSetting($hasimages);
parent::loadFromDb($question_id);
}

+ Here is the call graph for this function:

assMultipleChoice::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 987 of file class.assMultipleChoice.php.

References $result, and ilRTE\_replaceMediaObjectImageSrc().

{
global $ilDB;
$query = sprintf("DELETE FROM qpl_feedback_multiplechoice 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_multiplechoice 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:

assMultipleChoice::saveToDb (   $original_id = "")

Saves a assMultipleChoice object to a database.

Saves a assMultipleChoice object to a database (experimental)

Parameters
object$dbA pear DB object public

Reimplemented from assQuestion.

Definition at line 112 of file class.assMultipleChoice.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";
}
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, points, working_time, 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($this->getMaximumPoints() . ""),
$ilDB->quote($estw_time),
$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();
$query = sprintf("INSERT INTO qpl_question_multiplechoice (question_fi, shuffle) VALUES (%s, %s)",
$ilDB->quote($this->id . ""),
$ilDB->quote("$this->shuffle")
);
$ilDB->query($query);
// create page object of question
$this->createPageObject();
// Falls die Frage in einen Test eingefügt werden soll, auch diese Verbindung erstellen
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, points = %s, working_time=%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($this->getMaximumPoints() . ""),
$ilDB->quote($estw_time),
$ilDB->quote("$complete"),
$ilDB->quote($this->id)
);
$result = $ilDB->query($query);
$query = sprintf("UPDATE qpl_question_multiplechoice SET shuffle = %s WHERE question_fi = %s",
$ilDB->quote("$this->shuffle"),
$ilDB->quote($this->id . "")
);
$result = $ilDB->query($query);
}
if (PEAR::isError($result))
{
global $ilias;
$ilias->raiseError($result->getMessage());
}
else
{
// Antworten schreiben
// alte Antworten löschen
$query = sprintf("DELETE FROM qpl_answer_multiplechoice 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];
$query = sprintf("INSERT INTO qpl_answer_multiplechoice (answer_id, question_fi, answertext, points, points_unchecked, aorder, imagefile) VALUES (NULL, %s, %s, %s, %s, %s, %s)",
$ilDB->quote($this->id),
$ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($answer_obj->getAnswertext(), 0)),
$ilDB->quote($answer_obj->getPoints() . ""),
$ilDB->quote($answer_obj->getPointsUnchecked() . ""),
$ilDB->quote($answer_obj->getOrder() . ""),
$ilDB->quote($answer_obj->getImage() . "")
);
$answer_result = $ilDB->query($query);
}
}
parent::saveToDb($original_id);
}

+ Here is the call graph for this function:

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

  @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 654 of file class.assMultipleChoice.php.

References $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);
}
$entered_values = 0;
$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);
foreach ($_POST as $key => $value)
{
if (preg_match("/^multiple_choice_result_(\d+)/", $key, $matches))
{
if (strlen($value))
{
$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($value),
$ilDB->quote($pass . "")
);
$result = $ilDB->query($query);
$entered_values++;
}
}
}
if ($entered_values)
{
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:

assMultipleChoice::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 1103 of file class.assMultipleChoice.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->getAnswertext()), $format_bold);
$checked = FALSE;
foreach ($solution as $solutionvalue)
{
if ($id == $solutionvalue["value1"])
{
$checked = TRUE;
}
}
if ($checked)
{
$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:

assMultipleChoice::setGraphicalAnswerSetting (   $a_setting = 0)

Definition at line 810 of file class.assMultipleChoice.php.

Referenced by loadFromDb().

{
global $ilUser;
$ilUser->writePref("graphicalAnswerSetting", $a_setting);
}

+ Here is the caller graph for this function:

assMultipleChoice::setImageFile (   $image_filename,
  $image_tempfilename = "" 
)

Sets the image file.

Sets the image file and uploads the image to the object's image directory.

Parameters
string$image_filenameName of the original image file
string$image_tempfilenameName of the temporary uploaded image file
Returns
integer An errorcode if the image upload fails, 0 otherwise public

Definition at line 826 of file class.assMultipleChoice.php.

References $result, ilUtil\convertImage(), assQuestion\getImagePath(), ilObjMediaObject\getMimeType(), ilUtil\makeDirParents(), and ilUtil\moveUploadedFile().

{
$result = 0;
if (!empty($image_tempfilename))
{
$image_filename = str_replace(" ", "_", $image_filename);
$imagepath = $this->getImagePath();
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
//if (!move_uploaded_file($image_tempfilename, $imagepath . $image_filename))
if (!ilUtil::moveUploadedFile($image_tempfilename, $image_filename, $imagepath.$image_filename))
{
$result = 2;
}
else
{
include_once "./Services/MediaObjects/classes/class.ilObjMediaObject.php";
$mimetype = ilObjMediaObject::getMimeType($imagepath . $image_filename);
if (!preg_match("/^image/", $mimetype))
{
unlink($imagepath . $image_filename);
$result = 1;
}
else
{
// create thumbnail file
$thumbpath = $imagepath . $image_filename . "." . "thumb.jpg";
ilUtil::convertImage($imagepath.$image_filename, $thumbpath, "JPEG", 100);
}
}
}
return $result;
}

+ Here is the call graph for this function:

assMultipleChoice::setOutputType (   $output_type = OUTPUT_ORDER)

Sets the multiple choice output type.

Sets the output type of the assMultipleChoice object

Parameters
integer$output_typeA nonnegative integer value specifying the output type. It is OUTPUT_ORDER (=0) or OUTPUT_RANDOM (=1). public
See Also
$response

Reimplemented from assQuestion.

Definition at line 432 of file class.assMultipleChoice.php.

References $output_type.

{
$this->output_type = $output_type;
}
assMultipleChoice::syncFeedbackSingleAnswers ( )

Synchronizes the single answer feedback with an original question.

Synchronizes the single answer feedback with an original question

public

Definition at line 716 of file class.assMultipleChoice.php.

References $result.

Referenced by syncWithOriginal().

{
global $ilDB;
$feedback = "";
// delete generic feedback of the original
$deletequery = sprintf("DELETE FROM qpl_feedback_multiplechoice 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_multiplechoice 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_multiplechoice 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:

assMultipleChoice::syncImages ( )
protected

Sync images of a MC question on synchronisation with the original question.

Definition at line 938 of file class.assMultipleChoice.php.

References $filename, $ilLog, ilUtil\delDir(), assQuestion\getImagePath(), assQuestion\getOriginalId(), and ilUtil\makeDirParents().

Referenced by syncWithOriginal().

{
global $ilLog;
$question_id = $this->getOriginalId();
$imagepath = $this->getImagePath();
$imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
ilUtil::delDir($imagepath_original);
foreach ($this->answers as $answer)
{
$filename = $answer->getImage();
if (strlen($filename))
{
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
if (!file_exists($imagepath_original))
{
ilUtil::makeDirParents($imagepath_original);
}
if (@file_exists($imagepath . $filename))
{
if (!@copy($imagepath . $filename, $imagepath_original . $filename))
{
$ilLog->write("image could not be duplicated!!!!", $ilLog->ERROR);
$ilLog->write("object: " . print_r($this, TRUE), $ilLog->ERROR);
}
}
if (@file_exists($imagepath . $filename . ".thumb.jpg"))
{
if (!@copy($imagepath . $filename . ".thumb.jpg", $imagepath_original . $filename . ".thumb.jpg"))
{
$ilLog->write("image thumbnail could not be duplicated!!!!", $ilLog->ERROR);
$ilLog->write("object: " . print_r($this, TRUE), $ilLog->ERROR);
}
}
}
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assMultipleChoice::syncWithOriginal ( )

Reimplemented from assQuestion.

Definition at line 749 of file class.assMultipleChoice.php.

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

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

+ Here is the call graph for this function:

Field Documentation

assMultipleChoice::$answers

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

Referenced by getAnswers().

assMultipleChoice::$output_type

Definition at line 54 of file class.assMultipleChoice.php.

Referenced by assMultipleChoice(), getOutputType(), and setOutputType().

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