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

Class for matching questions. More...

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

Public Member Functions

 __construct ($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="", $testObjId=null)
 Duplicates an assMatchingQuestion.
 copyObject ($target_questionpool, $title="")
 Copies an assMatchingQuestion.
 duplicateImages ($question_id, $objectId=null)
 copyImages ($question_id, $source_questionpool)
 insertMatchingPair ($position, $term=null, $definition=null, $points=0.0)
 Inserts a matching pair for an matching choice question.
 addMatchingPair ($term=null, $definition=null, $points=0.0)
 Adds an matching pair for an matching choice question.
 getTermWithIdentifier ($a_identifier)
 Returns a term with a given identifier.
 getDefinitionWithIdentifier ($a_identifier)
 Returns a definition with a given identifier.
 getMatchingPair ($index=0)
 Returns a matching pair with a given index.
 deleteMatchingPair ($index=0)
 Deletes a matching pair with a given index.
 flushMatchingPairs ()
 Deletes all matching pairs.
 getMatchingPairCount ()
 Returns the number of matching pairs.
 getTerms ()
 Returns the terms of the matching question.
 getDefinitions ()
 Returns the definitions of the matching question.
 getTermCount ()
 Returns the number of terms.
 getDefinitionCount ()
 Returns the number of definitions.
 addTerm ($term)
 Adds a term.
 addDefinition ($definition)
 Adds a definition.
 insertTerm ($position, $term=null)
 Inserts a term.
 insertDefinition ($position, $definition=null)
 Inserts a definition.
 flushTerms ()
 Deletes all terms.
 flushDefinitions ()
 Deletes all definitions.
 deleteTerm ($position)
 Deletes a term.
 deleteDefinition ($position)
 Deletes a definition.
 setTerm ($term, $index)
 Sets a specific term.
 calculateReachedPoints ($active_id, $pass=NULL)
 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.
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question.
 getEncryptedFilename ($filename)
 Returns the encrypted save filename of a matching picture Images are saved with an encrypted filename to prevent users from cheating by guessing the solution from the image filename.
 removeTermImage ($index)
 removeDefinitionImage ($index)
 deleteImagefile ($filename)
 Deletes an imagefile from the system if the file is deleted manually.
 setImageFile ($image_tempfilename, $image_filename, $previous_filename= '')
 Sets the image file and uploads the image to the object's image directory.
 checkSaveData ()
 Checks the data to be saved for consistency.
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database.
 getRandomId ()
 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.
 getThumbGeometry ()
 Get the thumbnail geometry.
 getThumbSize ()
 Get the thumbnail geometry.
 setThumbGeometry ($a_geometry)
 Set the thumbnail geometry.
 getElementHeight ()
 Get the minimum element height.
 setElementHeight ($a_height)
 Set the minimum element height.
 rebuildThumbnails ()
 Rebuild the thumbnail images with a new thumbnail size.
 getThumbPrefix ()
 getEstimatedElementHeight ()
 toJSON ()
 Returns a JSON representation of the question TODO.
- Public Member Functions inherited from assQuestion
 __construct ($title="", $comment="", $author="", $owner=-1, $question="")
 assQuestion constructor
 fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
 Receives parameters from a QTI parser and creates a valid ILIAS question object.
 toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $force_image_references=false)
 Returns a QTI xml representation of the question.
 questionTitleExists ($questionpool_id, $title)
 Returns TRUE if the question title exists in the database.
 setTitle ($title="")
 Sets the title string of the assQuestion object.
 setId ($id=-1)
 Sets the id of the assQuestion object.
 setTestId ($id=-1)
 Sets the test id of the assQuestion object.
 setComment ($comment="")
 Sets the comment string of the assQuestion object.
 setOutputType ($outputType=OUTPUT_HTML)
 Sets the output type.
 setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)
 Sets the estimated working time of a question.
 keyInArray ($searchkey, $array)
 returns TRUE if the key occurs in an array
 setAuthor ($author="")
 Sets the authors name of the assQuestion object.
 setOwner ($owner="")
 Sets the creator/owner ID of the assQuestion object.
 getTitle ()
 Gets the title string of the assQuestion object.
 getId ()
 Gets the id of the assQuestion object.
 getShuffle ()
 Gets the shuffle flag.
 getTestId ()
 Gets the test id of the assQuestion object.
 getComment ()
 Gets the comment string of the assQuestion object.
 getOutputType ()
 Gets the output type.
 getEstimatedWorkingTime ()
 Gets the estimated working time of a question.
 getAuthor ()
 Gets the authors name of the assQuestion object.
 getOwner ()
 Gets the creator/owner ID of the assQuestion object.
 getObjId ()
 Get the object id of the container object.
 setObjId ($obj_id=0)
 Set the object id of the container object.
 _getMaximumPoints ($question_id)
 Returns the maximum points, a learner can reach answering the question.
& _getQuestionInfo ($question_id)
 Returns question information from the database.
 getSuggestedSolutionOutput ()
& _getSuggestedSolution ($question_id, $subquestion_index=0)
 Returns a suggested solution for a given subquestion index.
 getSuggestedSolutions ()
 Return the suggested solutions.
 _getReachedPoints ($active_id, $question_id, $pass=NULL)
 Returns the points, a learner has reached answering the question.
 getReachedPoints ($active_id, $pass=NULL)
 Returns the points, a learner has reached answering the question This is the fast way to get the points directly from the database.
 calculateResultsFromSolution ($active_id, $pass=NULL)
 Calculates the question results from a previously saved question solution.
 _updateTestResultCache ($active_id)
 _updateTestPassResults ($active_id, $pass)
 logAction ($logtext="", $active_id="", $question_id="")
 Logs an action into the Test&Assessment log.
 _logAction ($logtext="", $active_id="", $question_id="")
 Logs an action into the Test&Assessment log.
 moveUploadedMediaFile ($file, $name)
 Move an uploaded media file to an public accessible temp dir to present it.
 getSuggestedSolutionPath ()
 Returns the path for a suggested solution.
 getJavaPath ()
 Returns the image path for web accessable images of a question.
 getImagePath ($question_id=null, $object_id=null)
 Returns the image path for web accessable images of a question.
 getFlashPath ()
 Returns the image path for web accessable flash files of a question.
 getJavaPathWeb ()
 Returns the web image path for web accessable java applets of a question.
 getSuggestedSolutionPathWeb ()
 Returns the web path for a suggested solution.
 getImagePathWeb ()
 Returns the web image path for web accessable images of a question.
 getFlashPathWeb ()
 Returns the web image path for web accessable flash applications of a question.
& getSolutionValues ($active_id, $pass=NULL)
 Loads solutions of a given user from the database an returns it.
 isInUse ($question_id="")
 Checks whether the question is in use or not.
 isClone ($question_id="")
 Checks whether the question is a clone of another question or not.
 pcArrayShuffle ($array)
 Shuffles the values of a given array.
 getQuestionTypeFromDb ($question_id)
 get question type for question id
 deleteAnswers ($question_id)
 Deletes datasets from answers tables.
 deleteAdditionalTableData ($question_id)
 Deletes datasets from the additional question table in the database.
 delete ($question_id)
 Deletes a question and all materials from the database.
 getTotalAnswers ()
 get total number of answers
 _getTotalAnswers ($a_q_id)
 get number of answers for question id (static) note: do not use $this inside this method
 _getTotalRightAnswers ($a_q_id)
 get number of answers for question id (static) note: do not use $this inside this method
 _getTitle ($a_q_id)
 Returns the title of a question.
 _getQuestionText ($a_q_id)
 Returns question text.
 copyXHTMLMediaObjectsOfQuestion ($a_q_id)
 syncXHTMLMediaObjectsOfQuestion ()
 createPageObject ()
 create page object of question
 copyPageOfQuestion ($a_q_id)
 getPageOfQuestion ()
 _getQuestionType ($question_id)
 Returns the question type of a question with a given id.
 _getQuestionTitle ($question_id)
 Returns the question title of a question with a given id.
 setOriginalId ($original_id)
 getOriginalId ()
 createNewQuestion ($a_create_page=true)
 Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs.
 saveQuestionDataToDb ($original_id="")
 setNewOriginalId ($newId)
 deleteSuggestedSolutions ()
 Deletes all suggestes solutions in the database.
 getSuggestedSolution ($subquestion_index=0)
 Returns a suggested solution for a given subquestion index.
 getSuggestedSolutionTitle ($subquestion_index=0)
 Returns the title of a suggested solution at a given subquestion_index.
 setSuggestedSolution ($solution_id="", $subquestion_index=0, $is_import=false)
 Sets a suggested solution for the question.
 _resolveInternalLink ($internal_link)
 _resolveIntLinks ($question_id)
 _getInternalLinkHref ($target="")
 _getOriginalId ($question_id)
 Returns the original id of a question.
 syncWithOriginal ()
 createRandomSolution ($test_id, $user_id)
 _questionExists ($question_id)
 Returns true if the question already exists in the database.
 _questionExistsInPool ($question_id)
 Returns true if the question already exists in the database and is assigned to a question pool.
& _instanciateQuestion ($question_id)
 Creates an instance of a question with a given question id.
 getPoints ()
 Returns the maximum available points for the question.
 setPoints ($a_points)
 Sets the maximum available points for the question.
 getSolutionMaxPass ($active_id)
 Returns the maximum pass a users question solution.
 _getSolutionMaxPass ($question_id, $active_id)
 Returns the maximum pass a users question solution.
 _isWriteable ($question_id, $user_id)
 Returns true if the question is writeable by a certain user.
 _isUsedInRandomTest ($question_id="")
 Checks whether the question is used in a random test or not.
 calculateReachedPoints ($active_id, $pass=NULL, $points=0)
 Returns the points, a learner has reached answering the question The points are calculated from the given answers including checks for all special scoring options in the test container.
 isHTML ($a_text)
 Checks if a given string contains HTML or not.
 prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
 Prepares a string for a text area output in tests.
 QTIMaterialToString ($a_material)
 Reads an QTI material tag an creates a text string.
 addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE)
 Creates a QTI material tag from a plain text or xhtml text.
 createNewImageFileName ($image_filename)
 _setReachedPoints ($active_id, $question_id, $points, $maxpoints, $pass=NULL, $manualscoring=FALSE)
 Sets the points, a learner has reached answering the question Additionally objective results are updated.
 getQuestion ()
 Gets the question string of the question object.
 setQuestion ($question="")
 Sets the question string of the question object.
 getQuestionTypeID ()
 Returns the question type of the question.
 getFeedbackGeneric ($correctness)
 Returns the generic feedback for a given question state.
 cleanupMediaObjectUsage ()
 synchronises appearances of media objects in the question with media object usage table
& getInstances ()
 Gets all instances of the question.
 _needsManualScoring ($question_id)
 getActiveUserData ($active_id)
 Returns the user id and the test id for a given active id.
& _instanciateQuestionGUI ($question_id)
 Creates an instance of a question gui with a given question id.
 __get ($value)
 Object getter.
 __set ($key, $value)
 Object setter.
 getNrOfTries ()
 setNrOfTries ($a_nr_of_tries)
 setExportImagePath ($a_path)
 _questionExistsInTest ($question_id, $test_id)
 formatSAQuestion ($a_q)
 Format self assessment question.

Data Fields

 $matchingpairs
 $matching_type
 $thumb_geometry = 100
 $element_height

Protected Member Functions

 generateThumbForFile ($path, $file)
- Protected Member Functions inherited from assQuestion
 deletePageOfQuestion ($question_id)
 Deletes the page object of a question with a given ID.
 onDuplicate ($originalParentId, $originalQuestionId, $duplicateParentId, $duplicateQuestionId)
 Will be called when a question is duplicated (inside a question pool or for insertion in a test)
 onCopy ($source_questionpool_id, $source_question_id)
 Will be called when a question is copied (into another question pool)
 duplicateSuggestedSolutionFiles ($parent_id, $question_id)
 Duplicates the files of a suggested solution if the question is duplicated.
 syncSuggestedSolutionFiles ($original_id)
 Syncs the files of a suggested solution if the question is synced.
 copySuggestedSolutionFiles ($source_questionpool_id, $source_question_id)

Protected Attributes

 $terms
 $definitions
- Protected Attributes inherited from assQuestion
 $id
 $title
 $comment
 $owner
 $author
 $question
 $points
 $est_working_time
 $shuffle
 $test_id
 $obj_id
 $ilias
 $tpl
 $lng
 $outputType
 $suggested_solutions
 $original_id
 $page

Additional Inherited Members

- Static Public Member Functions inherited from assQuestion
static _getSuggestedSolutionCount ($question_id)
 Returns the number of suggested solutions associated with a question.
static _getSuggestedSolutionOutput ($question_id)
 Returns the output of the suggested solution.
static lookupOriginalParentObjId ($originalQuestionId)
 returns the parent object id for given original question id (should be a qpl id, but theoretically it can be a tst id, too)
static _isWorkedThrough ($active_id, $question_id, $pass=NULL)
 Returns true if the question was worked through in the given pass Worked through means that the user entered at least one value.
static _areAnswered ($a_user_id, $a_question_ids)
 Checks if an array of question ids is answered by an user or not.
static _includeClass ($question_type, $gui=0)
 Include the php class file for a given question type.
static _getQuestionTypeName ($type_tag)
 Return the translation for a given question type tag.

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 47446 2014-01-22 17:07:12Z bheyser

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

Constructor & Destructor Documentation

assMatchingQuestion::__construct (   $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 91 of file class.assMatchingQuestion.php.

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

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

Member Function Documentation

assMatchingQuestion::addDefinition (   $definition)

Adds a definition.

Parameters
object$definitionThe definition
See Also
$definitions

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

{
array_push($this->definitions, $definition);
}
assMatchingQuestion::addMatchingPair (   $term = null,
  $definition = null,
  $points = 0.0 
)

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
object$termA matching term
object$definitionA matching definition
double$pointsThe points for selecting the matching pair (even negative points can be used)
See Also
$matchingpairs

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

References assQuestion\$points.

{
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingPair.php";
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingTerm.php";
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingDefinition.php";
if (is_null($term)) $term = new assAnswerMatchingTerm();
if (is_null($definition)) $definition = new assAnswerMatchingDefinition();
$pair = new assAnswerMatchingPair($term, $definition, $points);
array_push($this->matchingpairs, $pair);
}
assMatchingQuestion::addTerm (   $term)

Adds a term.

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

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

{
array_push($this->terms, $term);
}
assMatchingQuestion::calculateReachedPoints (   $active_id,
  $pass = NULL 
)

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

References $data, $ilDB, $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);
}
$result = $ilDB->queryF("SELECT * FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
array('integer','integer','integer'),
array($active_id, $this->getId(), $pass)
);
while ($data = $ilDB->fetchAssoc($result))
{
if (strcmp($data["value1"], "") != 0)
{
array_push($found_value1, $data["value1"]);
array_push($found_value2, $data["value2"]);
}
}
$points = 0;
foreach ($found_value2 as $key => $value)
{
foreach ($this->matchingpairs as $pair)
{
if (($pair->definition->identifier == $value) && ($pair->term->identifier == $found_value1[$key]))
{
$points += $pair->points;
}
}
}
$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.

Returns
boolean True, if the check was ok, False otherwise
See Also
$answers

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

References $_POST, $result, assQuestion\getId(), and ilUtil\sendFailure().

Referenced by saveWorkingData().

{
$result = true;
$matching_values = array();
foreach ($_POST['matching'][$this->getId()] as $definition => $term)
{
if ($term > 0)
{
array_push($matching_values, $term);
}
}
$check_matching = array_flip($matching_values);
if (count($check_matching) != count($matching_values))
{
$result = false;
ilUtil::sendFailure($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 455 of file class.assMatchingQuestion.php.

References $filename, $ilLog, assQuestion\getImagePath(), getThumbPrefix(), 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->terms as $term)
{
if (strlen($term->picture))
{
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
$filename = $term->picture;
if (!@copy($imagepath_original . $filename, $imagepath . $filename))
{
$ilLog->write("matching question image could not be copied: $imagepath_original$filename");
}
if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename))
{
$ilLog->write("matching question image thumbnail could not be copied: $imagepath_original" . $this->getThumbPrefix() . $filename);
}
}
}
foreach ($this->definitions as $definition)
{
if (strlen($definition->picture))
{
$filename = $definition->picture;
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
if (!copy($imagepath_original . $filename, $imagepath . $filename))
{
$ilLog->write("matching question image could not be copied: $imagepath_original$filename");
}
if (!copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename))
{
$ilLog->write("matching question image thumbnail could not be copied: $imagepath_original" . $this->getThumbPrefix() . $filename);
}
}
}
}

+ Here is the call graph for this function:

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

Copies an assMatchingQuestion.

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

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

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

+ Here is the call graph for this function:

assMatchingQuestion::deleteDefinition (   $position)

Deletes a definition.

Parameters
integer$positionThe position of the definition in the definition array
See Also
$definitions

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

{
unset($this->definitions[$position]);
$this->definitions = array_values($this->definitions);
}
assMatchingQuestion::deleteImagefile (   $filename)

Deletes an imagefile from the system if the file is deleted manually.

Parameters
string$filenameImage file filename
Returns
boolean Success

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

References $filename, $result, assQuestion\getImagePath(), and getThumbPrefix().

Referenced by removeDefinitionImage(), removeTermImage(), and setImageFile().

{
$deletename = $filename;
$result = @unlink($this->getImagePath().$deletename);
$result = $result & @unlink($this->getImagePath().$this->getThumbPrefix() . $deletename);
return $result;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assMatchingQuestion::deleteMatchingPair (   $index = 0)

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
See Also
$matchingpairs

Definition at line 607 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 (   $position)

Deletes a term.

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

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

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

Duplicates an assMatchingQuestion.

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

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

{
if ($this->id <= 0)
{
// The question has not been saved. It cannot be duplicated
return;
}
// duplicate the question in database
$this_id = $this->getId();
if( (int)$testObjId > 0 )
{
$thisObjId = $this->getObjId();
}
$clone = $this;
include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
$original_id = assQuestion::_getOriginalId($this->id);
$clone->id = -1;
if( (int)$testObjId > 0 )
{
$clone->setObjId($testObjId);
}
if ($title)
{
$clone->setTitle($title);
}
if ($author)
{
$clone->setAuthor($author);
}
if ($owner)
{
$clone->setOwner($owner);
}
if ($for_test)
{
$clone->saveToDb($original_id);
}
else
{
$clone->saveToDb();
}
// copy question page content
$clone->copyPageOfQuestion($this_id);
// copy XHTML media objects
$clone->copyXHTMLMediaObjectsOfQuestion($this_id);
// duplicate the generic feedback
$clone->duplicateFeedbackGeneric($this_id);
// duplicate the image
$clone->duplicateImages($this_id, $thisObjId);
$clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
return $clone->id;
}

+ Here is the call graph for this function:

assMatchingQuestion::duplicateImages (   $question_id,
  $objectId = null 
)

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

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

{
global $ilLog;
$imagepath = $this->getImagePath();
$imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
if( (int)$objectId > 0 )
{
$imagepath_original = str_replace("/$this->obj_id/", "/$objectId/", $imagepath_original);
}
foreach ($this->terms as $term)
{
if (strlen($term->picture))
{
$filename = $term->picture;
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
if (!@copy($imagepath_original . $filename, $imagepath . $filename))
{
$ilLog->write("matching question image could not be duplicated: $imagepath_original$filename");
}
if (@file_exists($imagepath_original . $this->getThumbPrefix() . $filename))
{
if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename))
{
$ilLog->write("matching question image thumbnail could not be duplicated: $imagepath_original" . $this->getThumbPrefix() . $filename);
}
}
}
}
foreach ($this->definitions as $definition)
{
if (strlen($definition->picture))
{
$filename = $definition->picture;
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
if (!@copy($imagepath_original . $filename, $imagepath . $filename))
{
$ilLog->write("matching question image could not be duplicated: $imagepath_original$filename");
}
if (@file_exists($imagepath_original . $this->getThumbPrefix() . $filename))
{
if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename))
{
$ilLog->write("matching question image thumbnail could not be duplicated: $imagepath_original" . $this->getThumbPrefix() . $filename);
}
}
}
}
}

+ Here is the call graph for this function:

assMatchingQuestion::flushDefinitions ( )

Deletes all definitions.

See Also
$definitions

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

{
$this->definitions = array();
}
assMatchingQuestion::flushMatchingPairs ( )

Deletes all matching pairs.

See Also
$matchingpairs

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

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

Deletes all terms.

See Also
$terms

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

{
$this->terms = array();
}
assMatchingQuestion::generateThumbForFile (   $path,
  $file 
)
protected

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

References $file, $filename, $path, ilUtil\convertImage(), getThumbGeometry(), and getThumbPrefix().

Referenced by rebuildThumbnails().

{
$filename = $path . $file;
if (@file_exists($filename))
{
$thumbpath = $path . $this->getThumbPrefix() . $file;
$path_info = @pathinfo($filename);
$ext = "";
switch (strtoupper($path_info['extension']))
{
case 'PNG':
$ext = 'PNG';
break;
case 'GIF':
$ext = 'GIF';
break;
default:
$ext = 'JPEG';
break;
}
ilUtil::convertImage($filename, $thumbpath, $ext, $this->getThumbGeometry());
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assMatchingQuestion::getAdditionalTableName ( )

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

Returns
string The additional table name

Reimplemented from assQuestion.

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

Referenced by loadFromDb(), and saveToDb().

{
return "qpl_qst_matching";
}

+ Here is the caller graph for this function:

assMatchingQuestion::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns
string The answer table name

Reimplemented from assQuestion.

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

{
return array("qpl_a_matching", "qpl_a_mterm");
}
assMatchingQuestion::getDefinitionCount ( )

Returns the number of definitions.

Returns
integer The number of definitions
See Also
$definitions

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

{
return count($this->definitions);
}
assMatchingQuestion::getDefinitions ( )

Returns the definitions of the matching question.

Returns
array An array containing the definitions
See Also
$terms

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

References $definitions.

{
return $this->definitions;
}
assMatchingQuestion::getDefinitionWithIdentifier (   $a_identifier)

Returns a definition with a given identifier.

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

{
foreach ($this->definitions as $definition)
{
if ($definition->identifier == $a_identifier) return $definition;
}
return null;
}
assMatchingQuestion::getElementHeight ( )

Get the minimum element height.

Returns
integer Height

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

References $element_height.

Referenced by getEstimatedElementHeight(), and saveToDb().

{
return $this->element_height;
}

+ Here is the caller graph for this function:

assMatchingQuestion::getEncryptedFilename (   $filename)

Returns the encrypted save filename of a matching picture Images are saved with an encrypted filename to prevent users from cheating by guessing the solution from the image filename.

Parameters
string$filenameOriginal filename
Returns
string Encrypted filename

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

References $filename.

{
$extension = "";
if (preg_match("/.*\\.(\\w+)$/", $filename, $matches))
{
$extension = $matches[1];
}
return md5($filename) . "." . $extension;
}
assMatchingQuestion::getEstimatedElementHeight ( )

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

References getElementHeight(), and getThumbSize().

{
$hasImages = false;
foreach ($this->terms as $term)
{
if (strlen($term->picture))
{
$hasImages = true;
}
}
foreach ($this->definitions as $definition)
{
if (strlen($definition->picture))
{
$hasImages = true;
}
}
if ($hasImages)
{ // 40 is approx. the height of the preview image
return max($this->getElementHeight(), $this->getThumbSize() + 40);
}
else
{
return ($this->getElementHeight()) ? $this->getElementHeight() : 0;
}
}

+ Here is the call graph for this function:

assMatchingQuestion::getMatchingPair (   $index = 0)

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
See Also
$matchingpairs

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

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

Returns the number of matching pairs.

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

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

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

Returns the matchingpairs array.

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

References $matchingpairs.

Referenced by saveToDb(), setExportDetailsXLS(), and toJSON().

{
return $this->matchingpairs;
}

+ Here is the caller graph for this function:

assMatchingQuestion::getMaximumPoints ( )

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

Reimplemented from assQuestion.

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

References assQuestion\$points.

Referenced by isComplete().

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

+ Here is the caller graph for this function:

assMatchingQuestion::getQuestionType ( )

Returns the question type of the question.

Returns
integer The question type of the question

Reimplemented from assQuestion.

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

Referenced by toJSON().

{
return "assMatchingQuestion";
}

+ Here is the caller graph for this function:

assMatchingQuestion::getRandomId ( )

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

{
mt_srand((double)microtime()*1000000);
$random_number = mt_rand(1, 100000);
$found = FALSE;
while ($found)
{
$found = FALSE;
foreach ($this->matchingpairs as $key => $pair)
{
if (($pair->term->identifier == $random_number) || ($pair->definition->identifier == $random_number))
{
$found = TRUE;
$random_number++;
}
}
}
return $random_number;
}
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 1133 of file class.assMatchingQuestion.php.

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

Returns the number of terms.

Returns
integer The number of terms
See Also
$terms

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

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

Returns the terms of the matching question.

Returns
array An array containing the terms
See Also
$terms

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

References $terms.

{
return $this->terms;
}
assMatchingQuestion::getTermWithIdentifier (   $a_identifier)

Returns a term with a given identifier.

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

{
foreach ($this->terms as $term)
{
if ($term->identifier == $a_identifier) return $term;
}
return null;
}
assMatchingQuestion::getThumbGeometry ( )

Get the thumbnail geometry.

Returns
integer Geometry

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

References $thumb_geometry.

Referenced by generateThumbForFile(), getThumbSize(), and saveToDb().

{
return $this->thumb_geometry;
}

+ Here is the caller graph for this function:

assMatchingQuestion::getThumbPrefix ( )

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

Referenced by copyImages(), deleteImagefile(), duplicateImages(), generateThumbForFile(), and setImageFile().

{
return "thumb.";
}

+ Here is the caller graph for this function:

assMatchingQuestion::getThumbSize ( )

Get the thumbnail geometry.

Returns
integer Geometry

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

References getThumbGeometry().

Referenced by getEstimatedElementHeight().

{
return $this->getThumbGeometry();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assMatchingQuestion::insertDefinition (   $position,
  $definition = null 
)

Inserts a definition.

Parameters
object$definitionThe definition
See Also
$definitions

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

{
if (is_null($definition))
{
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingDefinition.php";
$definition = new assAnswerMatchingDefinition();
}
if ($position < count($this->definitions))
{
$part1 = array_slice($this->definitions, 0, $position);
$part2 = array_slice($this->definitions, $position);
$this->definitions = array_merge($part1, array($definition), $part2);
}
else
{
array_push($this->definitions, $definition);
}
}
assMatchingQuestion::insertMatchingPair (   $position,
  $term = null,
  $definition = null,
  $points = 0.0 
)

Inserts a 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
integer$positionThe insert position in the matching pairs array
object$termA matching term
object$definitionA matching definition
double$pointsThe points for selecting the matching pair (even negative points can be used)
See Also
$matchingpairs

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

References assQuestion\$points.

{
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingPair.php";
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingTerm.php";
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingDefinition.php";
if (is_null($term)) $term = new assAnswerMatchingTerm();
if (is_null($definition)) $definition = new assAnswerMatchingDefinition();
$pair = new assAnswerMatchingPair($term, $definition, $points);
if ($position < count($this->matchingpairs))
{
$part1 = array_slice($this->matchingpairs, 0, $position);
$part2 = array_slice($this->matchingpairs, $position);
$this->matchingpairs = array_merge($part1, array($pair), $part2);
}
else
{
array_push($this->matchingpairs, $pair);
}
}
assMatchingQuestion::insertTerm (   $position,
  $term = null 
)

Inserts a term.

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

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

{
if (is_null($term))
{
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingTerm.php";
$term = new assAnswerMatchingTerm();
}
if ($position < count($this->terms))
{
$part1 = array_slice($this->terms, 0, $position);
$part2 = array_slice($this->terms, $position);
$this->terms = array_merge($part1, array($term), $part2);
}
else
{
array_push($this->terms, $term);
}
}
assMatchingQuestion::isComplete ( )

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

References getMaximumPoints().

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

assMatchingQuestion::loadFromDb (   $question_id)

Loads a assMatchingQuestion object from a database.

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

Reimplemented from assQuestion.

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

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

{
global $ilDB;
$result = $ilDB->queryF("SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
array("integer"),
array($question_id)
);
if ($result->numRows() == 1)
{
$data = $ilDB->fetchAssoc($result);
$this->setId($question_id);
$this->setObjId($data["obj_fi"]);
$this->setTitle($data["title"]);
$this->setComment($data["description"]);
$this->setOriginalId($data["original_id"]);
$this->setNrOfTries($data['nr_of_tries']);
$this->setAuthor($data["author"]);
$this->setPoints($data["points"]);
$this->setOwner($data["owner"]);
include_once("./Services/RTE/classes/class.ilRTE.php");
$this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
$this->setThumbGeometry($data["thumb_geometry"]);
$this->setElementHeight($data["element_height"]);
$this->setShuffle($data["shuffle"]);
$this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
}
$termids = array();
$result = $ilDB->queryF("SELECT * FROM qpl_a_mterm WHERE question_fi = %s ORDER BY term_id ASC",
array('integer'),
array($question_id)
);
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingTerm.php";
$this->terms = array();
if ($result->numRows() > 0)
{
while ($data = $ilDB->fetchAssoc($result))
{
$term = new assAnswerMatchingTerm($data['term'], $data['picture'], $data['term_id']);
array_push($this->terms, $term);
$termids[$data['term_id']] = $term;
}
}
$definitionids = array();
$result = $ilDB->queryF("SELECT * FROM qpl_a_mdef WHERE question_fi = %s ORDER BY def_id ASC",
array('integer'),
array($question_id)
);
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingDefinition.php";
$this->definitions = array();
if ($result->numRows() > 0)
{
while ($data = $ilDB->fetchAssoc($result))
{
$definition = new assAnswerMatchingDefinition($data['definition'], $data['picture'], $data['morder']);
array_push($this->definitions, $definition);
$definitionids[$data['def_id']] = $definition;
}
}
$this->matchingpairs = array();
$result = $ilDB->queryF("SELECT * FROM qpl_a_matching WHERE question_fi = %s ORDER BY answer_id",
array('integer'),
array($question_id)
);
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingPair.php";
if ($result->numRows() > 0)
{
while ($data = $ilDB->fetchAssoc($result))
{
array_push($this->matchingpairs, new assAnswerMatchingPair($termids[$data['term_fi']], $definitionids[$data['definition_fi']], $data['points']));
}
}
parent::loadFromDb($question_id);
}

+ Here is the call graph for this function:

assMatchingQuestion::rebuildThumbnails ( )

Rebuild the thumbnail images with a new thumbnail size.

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

References generateThumbForFile(), and assQuestion\getImagePath().

Referenced by saveToDb().

{
foreach ($this->terms as $term)
{
if (strlen($term->picture)) $this->generateThumbForFile($this->getImagePath(), $term->picture);
}
foreach ($this->definitions as $definition)
{
if (strlen($definition->picture)) $this->generateThumbForFile($this->getImagePath(), $definition->picture);
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assMatchingQuestion::removeDefinitionImage (   $index)

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

References deleteImagefile().

{
$definition = $this->definitions[$index];
if (is_object($definition))
{
$this->deleteImagefile($definition->picture);
$definition->picture = null;
}
}

+ Here is the call graph for this function:

assMatchingQuestion::removeTermImage (   $index)

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

References deleteImagefile().

{
$term = $this->terms[$index];
if (is_object($term))
{
$this->deleteImagefile($term->picture);
$term->picture = null;
}
}

+ Here is the call graph for this function:

assMatchingQuestion::saveToDb (   $original_id = "")

Saves a assMatchingQuestion object to a database.

Parameters
object$dbA pear DB object

Reimplemented from assQuestion.

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

References $ilDB, $matchingpairs, assQuestion\$original_id, getAdditionalTableName(), getElementHeight(), assQuestion\getId(), getMatchingPairs(), getThumbGeometry(), rebuildThumbnails(), and assQuestion\saveQuestionDataToDb().

{
global $ilDB;
$this->saveQuestionDataToDb($original_id);
// save additional data
$affectedRows = $ilDB->manipulateF("DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
array("integer"),
array($this->getId())
);
$affectedRows = $ilDB->manipulateF("INSERT INTO " . $this->getAdditionalTableName() . " (question_fi, shuffle, matching_type, thumb_geometry, element_height) VALUES (%s, %s, %s, %s, %s)",
array("integer", "text", "text","integer","integer"),
array(
$this->getId(),
$this->shuffle,
$this->matching_type,
$this->getThumbGeometry(),
($this->getElementHeight() >= 20) ? $this->getElementHeight() : NULL
)
);
// delete old terms
$affectedRows = $ilDB->manipulateF("DELETE FROM qpl_a_mterm WHERE question_fi = %s",
array('integer'),
array($this->getId())
);
// delete old definitions
$affectedRows = $ilDB->manipulateF("DELETE FROM qpl_a_mdef WHERE question_fi = %s",
array('integer'),
array($this->getId())
);
$termids = array();
// write terms
foreach ($this->terms as $key => $term)
{
$next_id = $ilDB->nextId('qpl_a_mterm');
$affectedRows = $ilDB->manipulateF("INSERT INTO qpl_a_mterm (term_id, question_fi, picture, term) VALUES (%s, %s, %s, %s)",
array('integer','integer','text', 'text'),
array($next_id, $this->getId(), $term->picture, $term->text)
);
$termids[$term->identifier] = $next_id;
}
$definitionids = array();
// write definitions
foreach ($this->definitions as $key => $definition)
{
$next_id = $ilDB->nextId('qpl_a_mdef');
$affectedRows = $ilDB->manipulateF("INSERT INTO qpl_a_mdef (def_id, question_fi, picture, definition, morder) VALUES (%s, %s, %s, %s, %s)",
array('integer','integer','text', 'text', 'integer'),
array($next_id, $this->getId(), $definition->picture, $definition->text, $definition->identifier)
);
$definitionids[$definition->identifier] = $next_id;
}
$affectedRows = $ilDB->manipulateF("DELETE FROM qpl_a_matching WHERE question_fi = %s",
array('integer'),
array($this->getId())
);
$matchingpairs = $this->getMatchingPairs();
foreach ($matchingpairs as $key => $pair)
{
$next_id = $ilDB->nextId('qpl_a_matching');
$affectedRows = $ilDB->manipulateF("INSERT INTO qpl_a_matching (answer_id, question_fi, points, term_fi, definition_fi) VALUES (%s, %s, %s, %s, %s)",
array('integer','integer','float','integer','integer'),
array(
$next_id,
$this->getId(),
$pair->points,
$termids[$pair->term->identifier],
$definitionids[$pair->definition->identifier]
)
);
}
$this->rebuildThumbnails();
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. 

  @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)

Reimplemented from assQuestion.

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

References $_POST, $ilDB, $pass, 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);
}
$affectedRows = $ilDB->manipulateF("DELETE FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
array('integer','integer','integer'),
array($active_id, $this->getId(), $pass)
);
foreach ($_POST['matching'][$this->getId()] as $definition => $term)
{
$entered_values++;
$next_id = $ilDB->nextId('tst_solutions');
$affectedRows = $ilDB->insert("tst_solutions", array(
"solution_id" => array("integer", $next_id),
"active_fi" => array("integer", $active_id),
"question_fi" => array("integer", $this->getId()),
"value1" => array("clob", $term),
"value2" => array("clob", $definition),
"pass" => array("integer", $pass),
"tstamp" => array("integer", time())
));
}
$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::setElementHeight (   $a_height)

Set the minimum element height.

Parameters
integer$a_heightHeight

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

Referenced by loadFromDb().

{
$this->element_height = ($a_height < 20) ? "" : $a_height;
}

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

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

{
include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
$solutions = $this->getSolutionValues($active_id, $pass);
$worksheet->writeString($startrow, 0, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())), $format_title);
$worksheet->writeString($startrow, 1, ilExcelUtils::_convert_text($this->getTitle()), $format_title);
$imagepath = $this->getImagePath();
$i = 1;
foreach ($solutions as $solution)
{
$matches_written = FALSE;
foreach ($this->getMatchingPairs() as $idx => $pair)
{
if (!$matches_written) $worksheet->writeString($startrow + $i, 1, ilExcelUtils::_convert_text($this->lng->txt("matches")));
$matches_written = TRUE;
if ($pair->definition->identifier == $solution["value2"])
{
if (strlen($pair->definition->text))
{
$worksheet->writeString($startrow + $i, 0, ilExcelUtils::_convert_text($pair->definition->text));
}
else
{
$worksheet->writeString($startrow + $i, 0, ilExcelUtils::_convert_text($pair->definition->picture));
}
}
if ($pair->term->identifier == $solution["value1"])
{
if (strlen($pair->term->text))
{
$worksheet->writeString($startrow + $i, 2, ilExcelUtils::_convert_text($pair->term->text));
}
else
{
$worksheet->writeString($startrow + $i, 2, ilExcelUtils::_convert_text($pair->term->picture));
}
}
}
$i++;
}
return $startrow + $i + 1;
}

+ Here is the call graph for this function:

assMatchingQuestion::setImageFile (   $image_tempfilename,
  $image_filename,
  $previous_filename = '' 
)

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

References $result, ilUtil\convertImage(), deleteImagefile(), assQuestion\getImagePath(), getThumbPrefix(), ilUtil\makeDirParents(), and ilUtil\moveUploadedFile().

{
$result = TRUE;
if (strlen($image_tempfilename))
{
$image_filename = str_replace(" ", "_", $image_filename);
$imagepath = $this->getImagePath();
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
$savename = $image_filename;
if (!ilUtil::moveUploadedFile($image_tempfilename, $savename, $imagepath.$savename))
{
$result = FALSE;
}
else
{
// create thumbnail file
$thumbpath = $imagepath . $this->getThumbPrefix() . $savename;
ilUtil::convertImage($imagepath.$savename, $thumbpath, "JPEG", $this->getThumbGeometry());
}
if ($result && (strcmp($image_filename, $previous_filename) != 0) && (strlen($previous_filename)))
{
$this->deleteImagefile($previous_filename);
}
}
return $result;
}

+ Here is the call graph for this function:

assMatchingQuestion::setShuffle (   $shuffle)

Sets the shuffle flag.

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

Reimplemented from assQuestion.

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

References assQuestion\$shuffle.

Referenced by loadFromDb().

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

+ Here is the caller graph for this function:

assMatchingQuestion::setTerm (   $term,
  $index 
)

Sets a specific term.

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

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

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

Set the thumbnail geometry.

Parameters
integer$a_geometryGeometry

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

Referenced by loadFromDb().

{
$this->thumb_geometry = ($a_geometry < 1) ? 100 : $a_geometry;
}

+ Here is the caller graph for this function:

assMatchingQuestion::supportsJavascriptOutput ( )

Returns true if the question type supports JavaScript output.

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

Reimplemented from assQuestion.

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

{
return TRUE;
}
assMatchingQuestion::toJSON ( )

Returns a JSON representation of the question TODO.

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

References $mobs, $result, $terms, ilObjMediaObject\_getMobsOfObject(), ilRTE\_replaceMediaObjectImageSrc(), assQuestion\formatSAQuestion(), assQuestion\getFeedbackGeneric(), assQuestion\getId(), getMatchingPairs(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getTitle(), and assQuestion\pcArrayShuffle().

{
include_once("./Services/RTE/classes/class.ilRTE.php");
$result = array();
$result['id'] = (int) $this->getId();
$result['type'] = (string) $this->getQuestionType();
$result['title'] = (string) $this->getTitle();
$result['question'] = $this->formatSAQuestion($this->getQuestion());
$result['nr_of_tries'] = (int) $this->getNrOfTries();
$result['shuffle'] = true;
$result['feedback'] = array(
"onenotcorrect" => nl2br(ilRTE::_replaceMediaObjectImageSrc($this->getFeedbackGeneric(0), 0)),
"allcorrect" => nl2br(ilRTE::_replaceMediaObjectImageSrc($this->getFeedbackGeneric(1), 0))
);
$terms = array();
foreach ($this->getMatchingPairs() as $pair)
{
$terms[(int)$pair->term->identifier] = array(
"term" => $pair->term->text,
"id" =>(int)$pair->term->identifier
);
}
$terms = $this->pcArrayShuffle($terms);
$pairs = array();
// alex 9.9.2010 as a fix for bug 6513 I added the question id
// to the "def_id" in the array. The $pair->definition->identifier is not
// unique, since it gets it value from the morder table field
// this value is not changed, when a question is copied.
// thus copying the same question on a page results in problems
// when the second one (the copy) is answered.
foreach ($this->getMatchingPairs() as $pair)
{
array_push($pairs, array(
"term_id" => (int) $pair->term->identifier,
"points" => (float) $pair->points,
"definition" => (string) $pair->definition->text,
"def_id" => (int) $this->getId().$pair->definition->identifier,
"terms" => $terms
));
}
$result['pairs'] = $pairs;
$mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
$result['mobs'] = $mobs;
return json_encode($result);
}

+ Here is the call graph for this function:

Field Documentation

assMatchingQuestion::$definitions
protected

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

Referenced by getDefinitions().

assMatchingQuestion::$element_height

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

Referenced by getElementHeight().

assMatchingQuestion::$matching_type

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

Referenced by __construct().

assMatchingQuestion::$matchingpairs

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

Referenced by getMatchingPairs(), and saveToDb().

assMatchingQuestion::$terms
protected

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

Referenced by getTerms(), and toJSON().

assMatchingQuestion::$thumb_geometry = 100

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

Referenced by getThumbGeometry().

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