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

Class for matching questions. More...

+ Inheritance diagram for assMatchingQuestion:
+ Collaboration diagram for assMatchingQuestion:

Public Member Functions

 assMatchingQuestion ($title="", $comment="", $author="", $owner=-1, $question="", $matching_type=MT_TERMS_DEFINITIONS)
 assMatchingQuestion constructor
 isComplete ()
 Returns true, if a matching question is complete for use.
 saveToDb ($original_id="")
 Saves a assMatchingQuestion object to a database.
 loadFromDb ($question_id)
 Loads a assMatchingQuestion object from a database.
 duplicate ($for_test=true, $title="", $author="", $owner="")
 Duplicates an assMatchingQuestion.
 copyObject ($target_questionpool, $title="")
 Copies an assMatchingQuestion.
 duplicateImages ($question_id)
 copyImages ($question_id, $source_questionpool)
 setMatchingType ($matching_type=MT_TERMS_DEFINITIONS)
 Sets the matching question type.
 get_matching_type ()
 Returns the matching question type.
 getMatchingType ()
 addMatchingPair ($term="", $picture_or_definition="", $points=0.0, $term_id=0, $picture_or_definition_id=0)
 Adds an matching pair for an matching question.
 get_matchingpair ($index=0)
 Returns a matching pair.
 getMatchingPair ($index=0)
 Returns a matching pair.
 delete_matchingpair ($index=0)
 Deletes a matching pair.
 flush_matchingpairs ()
 Deletes all matching pairs.
 getMatchingPairCount ()
 Returns the number of matching pairs.
 getTerms ()
 Returns the terms of the matching question.
 getTermWithID ($id)
 Returns a term with a given ID.
 getTermCount ()
 Returns the number of terms.
 addTerm ($term)
 Adds a term.
 flushTerms ()
 Deletes all terms.
 deleteTerm ($term_id)
 Deletes a term.
 setTerm ($term, $index)
 Sets a specific term.
 calculateReachedPoints ($active_id, $pass=NULL)
 Returns the points, a learner has reached answering the question.
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question.
 setImageFile ($image_filename, $image_tempfilename="")
 Sets the image file.
 checkSaveData ()
 Checks the data to be saved for consistency.
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database.
 get_random_id ()
 pc_array_shuffle ($array)
 setShuffle ($shuffle)
 Sets the shuffle flag.
 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.
 getRTETextWithMediaObjects ()
 Collects all text in the question which could contain media objects which were created with the Rich Text Editor.
& getMatchingPairs ()
 Returns the matchingpairs array.
 supportsJavascriptOutput ()
 Returns true if the question type supports JavaScript output.
 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.
 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.
 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.
 syncWithOriginal ()
 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

 $matchingpairs
 $matching_type
 $terms
- 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 matching questions.

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

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

Member Function Documentation

assMatchingQuestion::addMatchingPair (   $term = "",
  $picture_or_definition = "",
  $points = 0.0,
  $term_id = 0,
  $picture_or_definition_id = 0 
)

Adds an matching pair for an matching question.

Adds an matching pair for an matching choice question. The students have to fill in an order for the matching pair. The matching pair is an ASS_AnswerMatching object that will be created and assigned to the array $this->matchingpairs.

Parameters
string$answertextThe answer text
string$matchingtextThe matching text of the answer text
double$pointsThe points for selecting the matching pair (even negative points can be used)
integer$orderA possible display order of the matching pair public
See Also
$matchingpairs
ASS_AnswerMatching

Definition at line 527 of file class.assMatchingQuestion.php.

References assQuestion\$points, and get_random_id().

{
// append answer
if ($term_id == 0)
{
$term_id = $this->get_random_id();
}
if ($picture_or_definition_id == 0)
{
$picture_or_definition_id = $this->get_random_id();
}
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatching.php";
$matchingpair = new ASS_AnswerMatching($term, $points, $term_id, $picture_or_definition, $picture_or_definition_id);
array_push($this->matchingpairs, $matchingpair);
}

+ Here is the call graph for this function:

assMatchingQuestion::addTerm (   $term)

Adds a term.

Adds a term

Parameters
string$termThe text of the term public
See Also
$terms

Definition at line 702 of file class.assMatchingQuestion.php.

{
$newkey = count($this->terms);
while (array_key_exists("term_" . $newkey, $this->terms))
{
$newkey += 11;
}
$this->terms["term_" . $newkey] = $term;
}
assMatchingQuestion::assMatchingQuestion (   $title = "",
  $comment = "",
  $author = "",
  $owner = -1,
  $question = "",
  $matching_type = MT_TERMS_DEFINITIONS 
)

assMatchingQuestion constructor

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

Definition at line 76 of file class.assMatchingQuestion.php.

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

{
$this->assQuestion($title, $comment, $author, $owner, $question);
$this->matchingpairs = array();
$this->matching_type = $matching_type;
$this->terms = array();
}

+ Here is the call graph for this function:

assMatchingQuestion::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 765 of file class.assMatchingQuestion.php.

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

{
global $ilDB;
$found_value1 = array();
$found_value2 = 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_value1, $data->value1);
array_push($found_value2, $data->value2);
}
}
$points = 0;
foreach ($found_value2 as $key => $value)
{
foreach ($this->matchingpairs as $answer_key => $answer_value)
{
if (($answer_value->getDefinitionId() == $value) and ($answer_value->getTerm() == $found_value1[$key]))
{
$points += $answer_value->getPoints();
}
}
}
$points = parent::calculateReachedPoints($active_id, $pass = NULL, $points);
return $points;
}

+ Here is the call graph for this function:

assMatchingQuestion::checkSaveData ( )

Checks the data to be saved for consistency. 

  Checks the data to be saved for consistency
Returns
boolean True, if the check was ok, False otherwise public
See Also
$answers

Definition at line 881 of file class.assMatchingQuestion.php.

References $result, and ilUtil\sendInfo().

Referenced by saveWorkingData().

{
$result = true;
$matching_values = array();
foreach ($_POST as $key => $value)
{
if (preg_match("/^sel_matching_(\d+)/", $key, $matches))
{
if ((strcmp($value, "") != 0) && ($value != -1))
{
array_push($matching_values, $value);
}
}
}
$check_matching = array_flip($matching_values);
if (count($check_matching) != count($matching_values))
{
// duplicate matching values!!!
$result = false;
ilUtil::sendInfo($this->lng->txt("duplicate_matching_values_selected"), TRUE);
}
return $result;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assMatchingQuestion::copyImages (   $question_id,
  $source_questionpool 
)

Definition at line 454 of file class.assMatchingQuestion.php.

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

{
if ($this->get_matching_type() == MT_TERMS_PICTURES)
{
$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->matchingpairs as $answer)
{
$filename = $answer->getPicture();
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
if (!copy($imagepath_original . $filename, $imagepath . $filename))
{
print "image could not be duplicated!!!! ";
}
if (!copy($imagepath_original . $filename . ".thumb.jpg", $imagepath . $filename . ".thumb.jpg"))
{
print "image thumbnail could not be duplicated!!!! ";
}
}
}
}

+ Here is the call graph for this function:

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

Copies an assMatchingQuestion.

Copies an assMatchingQuestion

public

Definition at line 397 of file class.assMatchingQuestion.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;
if ($title)
{
$clone->setTitle($title);
}
$source_questionpool = $this->getObjId();
$clone->setObjId($target_questionpool);
$clone->saveToDb();
// copy question page content
$clone->copyPageOfQuestion($original_id);
// copy XHTML media objects
$clone->copyXHTMLMediaObjectsOfQuestion($original_id);
// duplicate the generic feedback
$clone->duplicateFeedbackGeneric($original_id);
// duplicate the image
$clone->copyImages($original_id, $source_questionpool);
return $clone->id;
}

+ Here is the call graph for this function:

assMatchingQuestion::delete_matchingpair (   $index = 0)

Deletes a matching pair.

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

Parameters
integer$indexA nonnegative index of the n-th matching pair public
See Also
$matchingpairs

Definition at line 604 of file class.assMatchingQuestion.php.

{
if ($index < 0)
{
return;
}
if (count($this->matchingpairs) < 1)
{
return;
}
if ($index >= count($this->matchingpairs))
{
return;
}
unset($this->matchingpairs[$index]);
$this->matchingpairs = array_values($this->matchingpairs);
}
assMatchingQuestion::deleteTerm (   $term_id)

Deletes a term.

Deletes a term

Parameters
string$term_idThe id of the term to delete public
See Also
$terms

Definition at line 734 of file class.assMatchingQuestion.php.

{
unset($this->terms[$term_id]);
}
assMatchingQuestion::duplicate (   $for_test = true,
  $title = "",
  $author = "",
  $owner = "" 
)

Duplicates an assMatchingQuestion.

Duplicates an assMatchingQuestion

public

Definition at line 344 of file class.assMatchingQuestion.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 image
$clone->duplicateImages($this_id);
return $clone->id;
}

+ Here is the call graph for this function:

assMatchingQuestion::duplicateImages (   $question_id)

Definition at line 429 of file class.assMatchingQuestion.php.

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

{
if ($this->get_matching_type() == MT_TERMS_PICTURES)
{
$imagepath = $this->getImagePath();
$imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
foreach ($this->matchingpairs as $answer)
{
$filename = $answer->getPicture();
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
if (!copy($imagepath_original . $filename, $imagepath . $filename))
{
print "image could not be duplicated!!!! ";
}
if (!copy($imagepath_original . $filename . ".thumb.jpg", $imagepath . $filename . ".thumb.jpg"))
{
print "image thumbnail could not be duplicated!!!! ";
}
}
}
}

+ Here is the call graph for this function:

assMatchingQuestion::flush_matchingpairs ( )

Deletes all matching pairs.

Deletes all matching pairs

public

See Also
$matchingpairs

Definition at line 630 of file class.assMatchingQuestion.php.

{
$this->matchingpairs = array();
}
assMatchingQuestion::flushTerms ( )

Deletes all terms.

Deletes all terms

public

See Also
$terms

Definition at line 720 of file class.assMatchingQuestion.php.

{
$this->terms = array();
}
assMatchingQuestion::get_matching_type ( )

Returns the matching question type.

Returns the matching question type

Returns
integer The matching question type public
See Also
$matching_type

Definition at line 503 of file class.assMatchingQuestion.php.

References $matching_type.

Referenced by copyImages(), and duplicateImages().

{
return $this->matching_type;
}

+ Here is the caller graph for this function:

assMatchingQuestion::get_matchingpair (   $index = 0)

Returns a matching pair.

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

Parameters
integer$indexA nonnegative index of the n-th matching pair
Returns
object ASS_AnswerMatching-Object public
See Also
$matchingpairs

Definition at line 561 of file class.assMatchingQuestion.php.

References getMatchingPair().

{
return $this->getMatchingPair($index);
}

+ Here is the call graph for this function:

assMatchingQuestion::get_random_id ( )

Definition at line 976 of file class.assMatchingQuestion.php.

Referenced by addMatchingPair().

{
mt_srand((double)microtime()*1000000);
$random_number = mt_rand(1, 100000);
$found = FALSE;
while ($found)
{
$found = FALSE;
foreach ($this->matchingpairs as $key => $value)
{
if (($value->getTermId() == $random_number) || ($value->getDefinitionId() == $random_number))
{
$found = TRUE;
$random_number++;
}
}
}
return $random_number;
}

+ Here is the caller graph for this function:

assMatchingQuestion::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 1059 of file class.assMatchingQuestion.php.

{
return "qpl_question_matching";
}
assMatchingQuestion::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 1072 of file class.assMatchingQuestion.php.

{
return array("qpl_answer_matching", "qpl_answer_matching_term");
}
assMatchingQuestion::getMatchingPair (   $index = 0)

Returns a matching pair.

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

Parameters
integer$indexA nonnegative index of the n-th matching pair
Returns
object ASS_AnswerMatching-Object public
See Also
$matchingpairs

Definition at line 577 of file class.assMatchingQuestion.php.

Referenced by get_matchingpair().

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

+ Here is the caller graph for this function:

assMatchingQuestion::getMatchingPairCount ( )

Returns the number of matching pairs.

Returns the number of matching pairs

Returns
integer The number of matching pairs of the matching question public
See Also
$matchingpairs

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

{
return count($this->matchingpairs);
}
& assMatchingQuestion::getMatchingPairs ( )

Returns the matchingpairs array.

Definition at line 1089 of file class.assMatchingQuestion.php.

References $matchingpairs.

Referenced by setExportDetailsXLS().

{
return $this->matchingpairs;
}

+ Here is the caller graph for this function:

assMatchingQuestion::getMatchingType ( )

Definition at line 508 of file class.assMatchingQuestion.php.

References $matching_type.

{
return $this->matching_type;
}
assMatchingQuestion::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 813 of file class.assMatchingQuestion.php.

References assQuestion\$points.

Referenced by isComplete(), and saveToDb().

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

+ Here is the caller graph for this function:

assMatchingQuestion::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 1046 of file class.assMatchingQuestion.php.

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

{
return parent::getRTETextWithMediaObjects();
}
assMatchingQuestion::getTermCount ( )

Returns the number of terms.

Returns the number of terms

Returns
integer The number of terms public
See Also
$terms

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

{
return count($this->terms);
}
assMatchingQuestion::getTerms ( )

Returns the terms of the matching question.

Returns the terms of the matching question

Returns
array An array containing the terms (sorted alphabetically) public
See Also
$terms

Definition at line 658 of file class.assMatchingQuestion.php.

References $terms.

Referenced by setExportDetailsXLS().

{
natcasesort($this->terms);
return $this->terms;
}

+ Here is the caller graph for this function:

assMatchingQuestion::getTermWithID (   $id)

Returns a term with a given ID.

Returns a term with a given ID

Parameters
string$idThe id of the term
Returns
string The term public
See Also
$terms

Definition at line 674 of file class.assMatchingQuestion.php.

References assQuestion\$id.

{
return $this->terms[$id];
}
assMatchingQuestion::isComplete ( )

Returns true, if a matching question is complete for use.

Returns true, if a matching question is complete for use

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

Reimplemented from assQuestion.

Definition at line 99 of file class.assMatchingQuestion.php.

References getMaximumPoints().

Referenced by saveToDb().

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

assMatchingQuestion::loadFromDb (   $question_id)

Loads a assMatchingQuestion object from a database.

Loads a assMatchingQuestion 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 281 of file class.assMatchingQuestion.php.

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

{
global $ilDB;
$query = sprintf("SELECT qpl_questions.*, qpl_question_matching.* FROM qpl_questions, qpl_question_matching WHERE question_id = %s AND qpl_questions.question_id = qpl_question_matching.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->author = $data->author;
$this->solution_hint = $data->solution_hint;
$this->obj_id = $data->obj_fi;
$this->original_id = $data->original_id;
$this->owner = $data->owner;
$this->matching_type = $data->matching_type;
include_once("./Services/RTE/classes/class.ilRTE.php");
$this->question = ilRTE::_replaceMediaObjectImageSrc($data->question_text, 1);
$this->points = $data->points;
$this->shuffle = $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_matching WHERE question_fi = %s ORDER BY answer_id ASC",
$ilDB->quote($question_id)
);
$result = $ilDB->query($query);
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatching.php";
if ($result->numRows() > 0)
{
while ($data = $result->fetchRow(MDB2_FETCHMODE_OBJECT))
{
array_push($this->matchingpairs, new ASS_AnswerMatching($data->answertext, $data->points, $data->aorder, $data->matchingtext, $data->matching_order));
}
}
$query = sprintf("SELECT * FROM qpl_answer_matching_term WHERE question_fi = %s ORDER BY term ASC",
$ilDB->quote($question_id)
);
$result = $ilDB->query($query);
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatching.php";
if ($result->numRows() > 0)
{
while ($data = $result->fetchRow(MDB2_FETCHMODE_OBJECT))
{
$this->terms[$data->term_id] = $data->term;
}
}
}
parent::loadFromDb($question_id);
}

+ Here is the call graph for this function:

assMatchingQuestion::pc_array_shuffle (   $array)

Definition at line 996 of file class.assMatchingQuestion.php.

{
$i = count($array);
mt_srand((double)microtime()*1000000);
while(--$i)
{
$j = mt_rand(0, $i);
if ($i != $j)
{
// swap elements
$tmp = $array[$j];
$array[$j] = $array[$i];
$array[$i] = $tmp;
}
}
return $array;
}
assMatchingQuestion::saveToDb (   $original_id = "")

Saves a assMatchingQuestion object to a database.

Saves a assMatchingQuestion object to a database (experimental)

Parameters
object$dbA pear DB object public

Reimplemented from assQuestion.

Definition at line 119 of file class.assMatchingQuestion.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();
$query = sprintf("INSERT INTO qpl_question_matching (question_fi, shuffle, matching_type) VALUES (%s, %s, %s)",
$ilDB->quote($this->id . ""),
$ilDB->quote($this->shuffle . ""),
$ilDB->quote($this->matching_type. "")
);
$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, 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_matching SET shuffle = %s, matching_type = %s WHERE question_fi = %s",
$ilDB->quote($this->shuffle . ""),
$ilDB->quote($this->matching_type. ""),
$ilDB->quote($this->id . "")
);
$result = $ilDB->query($query);
}
if (PEAR::isError($result))
{
global $ilias;
$ilias->raiseError($result->getMessage());
}
else
{
// Antworten schreiben
// delete old terms
$query = sprintf("DELETE FROM qpl_answer_matching_term WHERE question_fi = %s",
$ilDB->quote($this->id)
);
$result = $ilDB->query($query);
// write terms
$newterms = array();
foreach ($this->terms as $key => $value)
{
$query = sprintf("INSERT INTO qpl_answer_matching_term (term_id, question_fi, term) VALUES (NULL, %s, %s)",
$ilDB->quote($this->getId()),
$ilDB->quote($value . "")
);
$term_result = $ilDB->query($query);
$newTermID = $ilDB->getLastInsertId();
$newterms[$newTermID] = $value;
foreach ($this->matchingpairs as $mkey => $mvalue)
{
if (strcmp($this->matchingpairs[$mkey]->getTerm(), $key) == 0)
{
$this->matchingpairs[$mkey]->setTerm($newTermID);
}
}
}
$this->terms = $newterms;
// alte Antworten löschen
$query = sprintf("DELETE FROM qpl_answer_matching WHERE question_fi = %s",
$ilDB->quote($this->id)
);
$result = $ilDB->query($query);
// Anworten wegschreiben
foreach ($this->matchingpairs as $key => $value)
{
$matching_obj = $this->matchingpairs[$key];
$query = sprintf("INSERT INTO qpl_answer_matching (answer_id, question_fi, answertext, points, aorder, matchingtext, matching_order) VALUES (NULL, %s, %s, %s, %s, %s, %s)",
$ilDB->quote($this->id),
$ilDB->quote($matching_obj->getTerm() . ""),
$ilDB->quote($matching_obj->getPoints() . ""),
$ilDB->quote($matching_obj->getTerm() . ""),
$ilDB->quote($matching_obj->getDefinition() . ""),
$ilDB->quote($matching_obj->getDefinitionId() . "")
);
$matching_result = $ilDB->query($query);
}
}
parent::saveToDb($original_id);
}

+ Here is the call graph for this function:

assMatchingQuestion::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 915 of file class.assMatchingQuestion.php.

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

{
global $ilDB;
global $ilUser;
$saveWorkingDataResult = $this->checkSaveData();
$entered_values = 0;
if ($saveWorkingDataResult)
{
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);
foreach ($_POST as $key => $value)
{
if (preg_match("/^sel_matching_(\d+)/", $key, $matches))
{
if ($value > -1) // -1 is the unselected value in the non javascript version
{
$entered_values++;
$query = sprintf("INSERT INTO tst_solutions (solution_id, active_fi, question_fi, value1, value2, pass, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, NULL)",
$ilDB->quote($active_id),
$ilDB->quote($this->getId()),
$ilDB->quote(trim($value)),
$ilDB->quote(trim($matches[1])),
$ilDB->quote($pass . "")
);
$result = $ilDB->query($query);
}
}
}
$saveWorkingDataResult = true;
}
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 $saveWorkingDataResult;
}

+ Here is the call graph for this function:

assMatchingQuestion::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 1119 of file class.assMatchingQuestion.php.

References $pass, $terms, ilExcelUtils\_convert_text(), assQuestion\getImagePath(), getMatchingPairs(), assQuestion\getSolutionValues(), getTerms(), and assQuestion\getTitle().

{
include_once ("./classes/class.ilExcelUtils.php");
$solutions = $this->getSolutionValues($active_id, $pass);
$worksheet->writeString($startrow, 0, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())), $format_title);
$worksheet->writeString($startrow, 1, ilExcelUtils::_convert_text($this->getTitle()), $format_title);
$imagepath = $this->getImagePath();
$i = 1;
$terms = $this->getTerms();
foreach ($solutions as $solution)
{
$matches_written = FALSE;
foreach ($this->getMatchingPairs() as $idx => $answer)
{
if (!$matches_written) $worksheet->writeString($startrow + $i, 1, ilExcelUtils::_convert_text($this->lng->txt("matches")));
$matches_written = TRUE;
if ($answer->getDefinitionId() == $solution["value2"])
{
if (strlen($answer->getDefinition())) $worksheet->writeString($startrow + $i, 0, ilExcelUtils::_convert_text($answer->getDefinition()));
}
if ($answer->getTermId() == $solution["value1"])
{
if (strlen($answer->getTerm())) $worksheet->writeString($startrow + $i, 2, ilExcelUtils::_convert_text($terms[$answer->getTermId()]));
}
}
$i++;
}
return $startrow + $i + 1;
}

+ Here is the call graph for this function:

assMatchingQuestion::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 836 of file class.assMatchingQuestion.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:

assMatchingQuestion::setMatchingType (   $matching_type = MT_TERMS_DEFINITIONS)

Sets the matching question type.

Sets the matching question type

Parameters
integer$matching_typeThe question matching type public
See Also
$matching_type

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

References $matching_type.

{
$this->matching_type = $matching_type;
}
assMatchingQuestion::setShuffle (   $shuffle)

Sets the shuffle flag.

Sets the shuffle flag

Parameters
boolean$shuffleA flag indicating whether the answers are shuffled or not public
See Also
$shuffle

Reimplemented from assQuestion.

Definition at line 1022 of file class.assMatchingQuestion.php.

References assQuestion\$shuffle.

{
switch ($shuffle)
{
case 0:
case 1:
case 2:
case 3:
$this->shuffle = $shuffle;
break;
default:
$this->shuffle = 1;
break;
}
}
assMatchingQuestion::setTerm (   $term,
  $index 
)

Sets a specific term.

Sets a specific term

Parameters
string$termThe text of the term
string$indexThe index of the term public
See Also
$terms

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

{
$this->terms[$index] = $term;
}
assMatchingQuestion::supportsJavascriptOutput ( )

Returns true if the question type supports JavaScript output.

Returns true if the question type supports JavaScript output

Returns
boolean TRUE if the question type supports JavaScript output, FALSE otherwise public

Reimplemented from assQuestion.

Definition at line 1102 of file class.assMatchingQuestion.php.

{
return TRUE;
}

Field Documentation

assMatchingQuestion::$matching_type

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

Referenced by assMatchingQuestion(), get_matching_type(), getMatchingType(), and setMatchingType().

assMatchingQuestion::$matchingpairs

Definition at line 45 of file class.assMatchingQuestion.php.

Referenced by getMatchingPairs().

assMatchingQuestion::$terms

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

Referenced by getTerms(), and setExportDetailsXLS().

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