ILIAS  Release_4_4_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields | Protected Member Functions
assTextSubset Class Reference
Modules/TestQuestionPool

Class for TextSubset questions. More...

+ Inheritance diagram for assTextSubset:
+ Collaboration diagram for assTextSubset:

Public Member Functions

 __construct ($title="", $comment="", $author="", $owner=-1, $question="")
 assTextSubset constructor
 isComplete ()
 Returns true, if a TextSubset question is complete for use.
 saveToDb ($original_id="")
 Saves a assTextSubset object to a database.
 loadFromDb ($question_id)
 Loads a assTextSubset object from a database.
 addAnswer ($answertext, $points, $order)
 Adds an answer to the question.
 duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
 Duplicates an assTextSubsetQuestion.
 copyObject ($target_questionpool_id, $title="")
 Copies an assTextSubset object.
 createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")
 getAnswerCount ()
 Returns the number of answers.
 getAnswer ($index=0)
 Returns an answer with a given index.
 deleteAnswer ($index=0)
 Deletes an answer with a given index.
 flushAnswers ()
 Deletes all answers.
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question.
& getAvailableAnswers ()
 Returns the available answers for the question.
 isAnswerCorrect ($answers, $answer)
 Returns the index of the found answer, if the given answer is in the set of correct answers and matchess the matching options, otherwise FALSE is returned.
 getTextRating ()
 Returns the rating option for text comparisons.
 setTextRating ($a_text_rating)
 Sets the rating option for text comparisons.
 calculateReachedPoints ($active_id, $pass=NULL, $returndetails=FALSE)
 Returns the points, a learner has reached answering the question.
 setCorrectAnswers ($a_correct_answers)
 Sets the number of correct answers needed to solve the question.
 getCorrectAnswers ()
 Returns the number of correct answers needed to solve the question.
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database.
 getQuestionType ()
 Returns the question type of the question.
& joinAnswers ()
 Returns the answers of the question as a comma separated string.
 getMaxTextboxWidth ()
 Returns the maximum width needed for the answer textboxes.
 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.
 setExportDetailsXLS (&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
 Creates an Excel worksheet for the detailed cumulated results of this question.
 getAnswers ()
 toJSON ()
 Returns a JSON representation of the question.
- Public Member Functions inherited from assQuestion
 setProcessLocker ($processLocker)
 getProcessLocker ()
 fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
 Receives parameters from a QTI parser and creates a valid ILIAS question object.
 toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $force_image_references=false)
 Returns a QTI xml representation of the question.
 questionTitleExists ($questionpool_id, $title)
 Returns TRUE if the question title exists in the database.
 setTitle ($title="")
 Sets the title string of the assQuestion object.
 setId ($id=-1)
 Sets the id of the assQuestion object.
 setTestId ($id=-1)
 Sets the test id of the assQuestion object.
 setComment ($comment="")
 Sets the comment string of the assQuestion object.
 setOutputType ($outputType=OUTPUT_HTML)
 Sets the output type.
 setShuffle ($shuffle=true)
 Sets the shuffle flag.
 setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)
 Sets the estimated working time of a question.
 keyInArray ($searchkey, $array)
 returns TRUE if the key occurs in an array
 setAuthor ($author="")
 Sets the authors name of the assQuestion object.
 setOwner ($owner="")
 Sets the creator/owner ID of the assQuestion object.
 getTitle ()
 Gets the title string of the assQuestion object.
 getId ()
 Gets the id of the assQuestion object.
 getShuffle ()
 Gets the shuffle flag.
 getTestId ()
 Gets the test id of the assQuestion object.
 getComment ()
 Gets the comment string of the assQuestion object.
 getOutputType ()
 Gets the output type.
 supportsJavascriptOutput ()
 Returns true if the question type supports JavaScript output.
 supportsNonJsOutput ()
 requiresJsSwitch ()
 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.
 setExternalId ($external_id)
 getExternalId ()
 _getMaximumPoints ($question_id)
 Returns the maximum points, a learner can reach answering the question.
& _getQuestionInfo ($question_id)
 Returns question information from the database.
 getSuggestedSolutionOutput ()
& _getSuggestedSolution ($question_id, $subquestion_index=0)
 Returns a suggested solution for a given subquestion index.
 getSuggestedSolutions ()
 Return the suggested solutions.
 _getReachedPoints ($active_id, $question_id, $pass=NULL)
 Returns the points, a learner has reached answering the question.
 getReachedPoints ($active_id, $pass=NULL)
 Returns the points, a learner has reached answering the question This is the fast way to get the points directly from the database.
 getAdjustedReachedPoints ($active_id, $pass=NULL)
 returns the reached points ...
 calculateResultsFromSolution ($active_id, $pass=NULL, $obligationsEnabled=false)
 Calculates the question results from a previously saved question solution.
 persistWorkingState ($active_id, $pass=NULL, $obligationsEnabled=false)
 persists the working state for current testactive and testpass
 _updateTestResultCache ($active_id, ilAssQuestionProcessLocker $processLocker=null)
 Move this to a proper place.
 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="")
 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.
 getPoints ()
 Returns the maximum available points for the question.
 setPoints ($a_points)
 Sets the maximum available points for the question.
 getSolutionMaxPass ($active_id)
 Returns the maximum pass a users question solution.
 _getSolutionMaxPass ($question_id, $active_id)
 Returns the maximum pass a users question solution.
 _isWriteable ($question_id, $user_id)
 Returns true if the question is writeable by a certain user.
 _isUsedInRandomTest ($question_id="")
 Checks whether the question is used in a random test or not.
 adjustReachedPointsByScoringOptions ($points, $active_id, $pass=NULL)
 Adjust the given reached points by checks for all special scoring options in the test container.
 isHTML ($a_text)
 Checks if a given string contains HTML or not.
 prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
 Prepares a string for a text area output in tests.
 QTIMaterialToString ($a_material)
 Reads an QTI material tag an creates a text string.
 addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE)
 Creates a QTI material tag from a plain text or xhtml text.
 createNewImageFileName ($image_filename)
 _setReachedPoints ($active_id, $question_id, $points, $maxpoints, $pass, $manualscoring, $obligationsEnabled)
 Sets the points, a learner has reached answering the question Additionally objective results are updated.
 getQuestion ()
 Gets the question string of the question object.
 setQuestion ($question="")
 Sets the question string of the question object.
 getQuestionTypeID ()
 Returns the question type of the question.
 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.
 __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.
 setPreventRteUsage ($a_val)
 Set prevent rte usage.
 getPreventRteUsage ()
 Get prevent rte usage.
 setSelfAssessmentEditingMode ($a_selfassessmenteditingmode)
 Set Self-Assessment Editing Mode.
 getSelfAssessmentEditingMode ()
 Get Self-Assessment Editing Mode.
 setDefaultNrOfTries ($a_defaultnroftries)
 Set Default Nr of Tries.
 getDefaultNrOfTries ()
 Get Default Nr of Tries.
 isAnswered ($active_id, $pass=null)
 returns boolean wether the question is answered during test pass or not
 setObligationsToBeConsidered ($obligationsToBeConsidered=true)
 sets the flag wether obligations are to be considered or not
 areObligationsToBeConsidered ()
 gets the flag wether obligations are to be considered or not
 isAutosaveable ()
 getAdditionalContentEditingMode ()
 getter for additional content editing mode for this question
 setAdditionalContentEditingMode ($additinalContentEditingMode)
 setter for additional content editing mode for this question
 isAdditionalContentEditingModePageObject ()
 isser for additional "pageobject" content editing mode
 isValidAdditionalContentEditingMode ($additionalContentEditingMode)
 returns the fact wether the passed additional content mode is valid or not
 getValidAdditionalContentEditingModes ()
 getter for valid additional content editing modes
 addQuestionChangeListener (ilQuestionChangeListener $listener)
 getQuestionChangeListeners ()
 getHtmlUserSolutionPurifier ()
- Public Member Functions inherited from ilObjQuestionScoringAdjustable
 saveAdditionalQuestionDataToDb ()
 Saves a record to the question types additional data table.
- Public Member Functions inherited from ilObjAnswerScoringAdjustable
 saveAnswerSpecificDataToDb ()
 Saves the answer specific records into a question types answer table.

Data Fields

 $answers
 $correctanswers
 $text_rating
- Data Fields inherited from assQuestion
const ADDITIONAL_CONTENT_EDITING_MODE_DEFAULT = 'default'
 constant for additional content editing mode "default"
const ADDITIONAL_CONTENT_EDITING_MODE_PAGE_OBJECT = 'pageobject'
 constant for additional content editing mode "pageobject"
 $feedbackOBJ = null
 $prevent_rte_usage = false
 $selfassessmenteditingmode = false
 $defaultnroftries = false

Protected Member Functions

 reworkWorkingData ($active_id, $pass, $obligationsAnswered)
 Reworks the allready saved working data if neccessary.
- Protected Member Functions inherited from assQuestion
 deletePageOfQuestion ($question_id)
 Deletes the page object of a question with a given ID.
 onDuplicate ($originalParentId, $originalQuestionId, $duplicateParentId, $duplicateQuestionId)
 Will be called when a question is duplicated (inside a question pool or for insertion in a test)
 onSyncWithOriginal ($originalQuestionId, $duplicateQuestionId)
 onCopy ($sourceParentId, $sourceQuestionId, $targetParentId, $targetQuestionId)
 Will be called when a question is copied (into another question pool)
 duplicateSuggestedSolutionFiles ($parent_id, $question_id)
 Duplicates the files of a suggested solution if the question is duplicated.
 syncSuggestedSolutionFiles ($original_id)
 Syncs the files of a suggested solution if the question is synced.
 copySuggestedSolutionFiles ($source_questionpool_id, $source_question_id)
 duplicateQuestionHints ($originalQuestionId, $duplicateQuestionId)

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 _getOriginalId ($question_id)
 Returns the original id of a question.
static originalQuestionExists ($questionId)
static _instanciateQuestion ($question_id)
 Creates an instance of a question with a given question id.
static _instantiateQuestion ($question_id)
static _isWorkedThrough ($active_id, $question_id, $pass=NULL)
 Returns true if the question was worked through in the given pass Worked through means that the user entered at least one value.
static _areAnswered ($a_user_id, $a_question_ids)
 Checks if an array of question ids is answered by an user or not.
static _includeClass ($question_type, $gui=0)
 Include the php class file for a given question type.
static getGuiClassNameByQuestionType ($questionType)
static getObjectClassNameByQuestionType ($questionType)
static getFeedbackClassNameByQuestionType ($questionType)
static isCoreQuestionType ($questionType)
static includeCoreClass ($questionType, $withGuiClass)
static includePluginClass ($questionType, $withGuiClass)
static _getQuestionTypeName ($type_tag)
 Return the translation for a given question type tag.
static & _instanciateQuestionGUI ($question_id)
 Creates an instance of a question gui with a given question id.
static instantiateQuestionGUI ($a_question_id)
 Creates an instance of a question gui with a given question id.
static lookupParentObjId ($questionId)
 ilDB $ilDB
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 isObligationPossible ($questionId)
 returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration
- Static Protected Member Functions inherited from assQuestion
static doesSolutionRecordsExist ($activeId, $pass, $questionId)
 checks wether there are existing solution records for the given test active / pass and given question id
- Protected Attributes inherited from assQuestion
 $id
 $title
 $comment
 $owner
 $author
 $question
 $points
 $est_working_time
 $shuffle
 $test_id
 $obj_id
 $ilias
 $tpl
 $lng
 $outputType
 $suggested_solutions
 $original_id
 $page
 $external_id = ''
 $questionChangeListeners = array()
 $processLocker

Detailed Description

Class for TextSubset questions.

assTextSubset is a class for TextSubset questions. To solve a TextSubset question, a learner has to enter a TextSubsetal value in a defined range

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
Nina Gharib nina@.nosp@m.wgse.nosp@m.rve.d.nosp@m.e
Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de
Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de
Version
Id:
class.assTextSubset.php 61560 2016-01-31 07:56:19Z gitmgr

Definition at line 24 of file class.assTextSubset.php.

Constructor & Destructor Documentation

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

assTextSubset constructor

The constructor takes possible arguments an creates an instance of the assTextSubset 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 TextSubsetal ID to identify the owner/creator
string$questionThe question string of the TextSubset question

Reimplemented from assQuestion.

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

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

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

Member Function Documentation

assTextSubset::addAnswer (   $answertext,
  $points,
  $order 
)

Adds an answer to the question.

public

Definition at line 179 of file class.assTextSubset.php.

References $changed, and assQuestion\$points.

{
include_once "./Modules/TestQuestionPool/classes/class.assAnswerBinaryStateImage.php";
if (array_key_exists($order, $this->answers))
{
// insert answer
$answer = new ASS_AnswerBinaryStateImage($answertext, $points, $order);
$newchoices = array();
for ($i = 0; $i < $order; $i++)
{
array_push($newchoices, $this->answers[$i]);
}
array_push($newchoices, $answer);
for ($i = $order; $i < count($this->answers); $i++)
{
$changed = $this->answers[$i];
$changed->setOrder($i+1);
array_push($newchoices, $changed);
}
$this->answers = $newchoices;
}
else
{
// add answer
array_push($this->answers, new ASS_AnswerBinaryStateImage($answertext, $points, count($this->answers)));
}
}
assTextSubset::calculateReachedPoints (   $active_id,
  $pass = NULL,
  $returndetails = FALSE 
)

Returns the points, a learner has reached answering the question.

The points are calculated from the given answers.

public

Parameters
integer$active_id
integer$pass
boolean$returndetails(deprecated !!)
Returns
integer/array $points/$details (array $details is deprecated !!)

Reimplemented from assQuestion.

Definition at line 534 of file class.assTextSubset.php.

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

{
if( $returndetails )
{
throw new ilTestException('return details not implemented for '.__METHOD__);
}
global $ilDB;
$available_answers =& $this->getAvailableAnswers();
$found_counter = 0;
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))
{
$enteredtext = $data["value1"];
$index = $this->isAnswerCorrect($available_answers, $enteredtext);
if ($index !== FALSE)
{
unset($available_answers[$index]);
$points += $this->answers[$index]->getPoints();
}
}
return $points;
}

+ Here is the call graph for this function:

assTextSubset::copyObject (   $target_questionpool_id,
  $title = "" 
)

Copies an assTextSubset object.

public

Definition at line 271 of file class.assTextSubset.php.

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

{
if ($this->id <= 0)
{
// The question has not been saved. It cannot be duplicated
return;
}
// duplicate the question in database
$clone = $this;
include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
$original_id = assQuestion::_getOriginalId($this->id);
$clone->id = -1;
$source_questionpool_id = $this->getObjId();
$clone->setObjId($target_questionpool_id);
if ($title)
{
$clone->setTitle($title);
}
$clone->saveToDb();
// copy question page content
$clone->copyPageOfQuestion($original_id);
// copy XHTML media objects
$clone->copyXHTMLMediaObjectsOfQuestion($original_id);
$clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
return $clone->id;
}

+ Here is the call graph for this function:

assTextSubset::createNewOriginalFromThisDuplicate (   $targetParentId,
  $targetQuestionTitle = "" 
)

Definition at line 300 of file class.assTextSubset.php.

References assQuestion\$id, and assQuestion\getObjId().

{
if ($this->id <= 0)
{
// The question has not been saved. It cannot be duplicated
return;
}
include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
$sourceQuestionId = $this->id;
$sourceParentId = $this->getObjId();
// duplicate the question in database
$clone = $this;
$clone->id = -1;
$clone->setObjId($targetParentId);
if ($targetQuestionTitle)
{
$clone->setTitle($targetQuestionTitle);
}
$clone->saveToDb();
// copy question page content
$clone->copyPageOfQuestion($sourceQuestionId);
// copy XHTML media objects
$clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
$clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
return $clone->id;
}

+ Here is the call graph for this function:

assTextSubset::deleteAnswer (   $index = 0)

Deletes an answer with a given index.

The index of the first answer is 0, the index of the second answer is 1 and so on.

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

Definition at line 373 of file class.assTextSubset.php.

{
if ($index < 0) return;
if (count($this->answers) < 1) return;
if ($index >= count($this->answers)) return;
unset($this->answers[$index]);
$this->answers = array_values($this->answers);
for ($i = 0; $i < count($this->answers); $i++)
{
if ($this->answers[$i]->getOrder() > $index)
{
$this->answers[$i]->setOrder($i);
}
}
}
assTextSubset::duplicate (   $for_test = true,
  $title = "",
  $author = "",
  $owner = "",
  $testObjId = null 
)

Duplicates an assTextSubsetQuestion.

public

Reimplemented from assQuestion.

Definition at line 212 of file class.assTextSubset.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();
$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);
$clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
return $clone->id;
}

+ Here is the call graph for this function:

assTextSubset::flushAnswers ( )

Deletes all answers.

public

See Also
$answers

Definition at line 395 of file class.assTextSubset.php.

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

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 777 of file class.assTextSubset.php.

Referenced by loadFromDb().

{
return "qpl_qst_textsubset";
}

+ Here is the caller graph for this function:

assTextSubset::getAnswer (   $index = 0)

Returns an answer with a given index.

The index of the first answer is 0, the index of the second answer is 1 and so on.

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

Definition at line 356 of file class.assTextSubset.php.

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

Returns the number of answers.

Returns
integer The number of answers of the TextSubset question public
See Also
$ranges

Definition at line 342 of file class.assTextSubset.php.

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

Definition at line 829 of file class.assTextSubset.php.

References $answers.

Referenced by toJSON().

{
return $this->answers;
}

+ Here is the caller graph for this function:

assTextSubset::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns
string The answer table name public

Reimplemented from assQuestion.

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

{
return "qpl_a_textsubset";
}
& assTextSubset::getAvailableAnswers ( )

Returns the available answers for the question.

private

See Also
$answers

Definition at line 431 of file class.assTextSubset.php.

Referenced by calculateReachedPoints().

{
$available_answers = array();
foreach ($this->answers as $answer)
{
array_push($available_answers, $answer->getAnswertext());
}
return $available_answers;
}

+ Here is the caller graph for this function:

assTextSubset::getCorrectAnswers ( )

Returns the number of correct answers needed to solve the question.

Returns
integer The number of correct answers public

Definition at line 585 of file class.assTextSubset.php.

References $correctanswers.

Referenced by getMaximumPoints(), and toJSON().

{
return $this->correctanswers;
}

+ Here is the caller graph for this function:

assTextSubset::getMaximumPoints ( )

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

public

See Also
$points

Reimplemented from assQuestion.

Definition at line 406 of file class.assTextSubset.php.

References assQuestion\$points, and getCorrectAnswers().

Referenced by isComplete().

{
$points = array();
foreach ($this->answers as $answer)
{
if ($answer->getPoints() > 0)
{
array_push($points, $answer->getPoints());
}
}
rsort($points, SORT_NUMERIC);
$maxpoints = 0;
for ($counter = 0; $counter < $this->getCorrectAnswers(); $counter++)
{
$maxpoints += $points[$counter];
}
return $maxpoints;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assTextSubset::getMaxTextboxWidth ( )

Returns the maximum width needed for the answer textboxes.

Returns
integer Maximum textbox width public

Definition at line 760 of file class.assTextSubset.php.

{
$maxwidth = 0;
foreach ($this->answers as $answer)
{
$len = strlen($answer->getAnswertext());
if ($len > $maxwidth) $maxwidth = $len;
}
return $maxwidth + 3;
}
assTextSubset::getQuestionType ( )

Returns the question type of the question.

Returns
integer The question type of the question public

Reimplemented from assQuestion.

Definition at line 729 of file class.assTextSubset.php.

Referenced by toJSON().

{
return "assTextSubset";
}

+ Here is the caller graph for this function:

assTextSubset::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 797 of file class.assTextSubset.php.

{
return parent::getRTETextWithMediaObjects();
}
assTextSubset::getTextRating ( )

Returns the rating option for text comparisons.

Returns
string The rating option for text comparisons
See Also
$text_rating User interface

Definition at line 493 of file class.assTextSubset.php.

References $text_rating.

Referenced by isAnswerCorrect(), and toJSON().

{
return $this->text_rating;
}

+ Here is the caller graph for this function:

assTextSubset::isAnswerCorrect (   $answers,
  $answer 
)

Returns the index of the found answer, if the given answer is in the set of correct answers and matchess the matching options, otherwise FALSE is returned.

Parameters
array$answersAn array containing the correct answers
string$answerThe text of the given answer
Returns
mixed The index of the correct answer, FALSE otherwise public

Definition at line 451 of file class.assTextSubset.php.

References $answers, $result, assQuestion\getPoints(), getTextRating(), ilStr\strToLower(), TEXTGAP_RATING_CASEINSENSITIVE, TEXTGAP_RATING_CASESENSITIVE, TEXTGAP_RATING_LEVENSHTEIN1, TEXTGAP_RATING_LEVENSHTEIN2, TEXTGAP_RATING_LEVENSHTEIN3, TEXTGAP_RATING_LEVENSHTEIN4, and TEXTGAP_RATING_LEVENSHTEIN5.

Referenced by calculateReachedPoints().

{
include_once "./Services/Utilities/classes/class.ilStr.php";
$result = 0;
$textrating = $this->getTextRating();
foreach ($answers as $key => $value)
{
switch ($textrating)
{
case TEXTGAP_RATING_CASEINSENSITIVE:
if (strcmp(ilStr::strToLower($value), ilStr::strToLower($answer)) == 0 && $this->answers[$key]->getPoints() > 0) return $key;
break;
case TEXTGAP_RATING_CASESENSITIVE:
if (strcmp($value, $answer) == 0 && $this->answers[$key]->getPoints() > 0) return $key;
break;
case TEXTGAP_RATING_LEVENSHTEIN1:
if (levenshtein($value, $answer) <= 1 && $this->answers[$key]->getPoints() > 0) return $key;
break;
case TEXTGAP_RATING_LEVENSHTEIN2:
if (levenshtein($value, $answer) <= 2 && $this->answers[$key]->getPoints() > 0) return $key;
break;
case TEXTGAP_RATING_LEVENSHTEIN3:
if (levenshtein($value, $answer) <= 3 && $this->answers[$key]->getPoints() > 0) return $key;
break;
case TEXTGAP_RATING_LEVENSHTEIN4:
if (levenshtein($value, $answer) <= 4 && $this->answers[$key]->getPoints() > 0) return $key;
break;
case TEXTGAP_RATING_LEVENSHTEIN5:
if (levenshtein($value, $answer) <= 5 && $this->answers[$key]->getPoints() > 0) return $key;
break;
}
}
return FALSE;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assTextSubset::isComplete ( )

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

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

Reimplemented from assQuestion.

Definition at line 83 of file class.assTextSubset.php.

References getMaximumPoints().

{
if (
strlen($this->title)
&& $this->author
&& $this->question &&
count($this->answers) >= $this->correctanswers
&& $this->getMaximumPoints() > 0
)
{
return true;
}
return false;
}

+ Here is the call graph for this function:

& assTextSubset::joinAnswers ( )

Returns the answers of the question as a comma separated string.

Returns
string The answer string public

Definition at line 740 of file class.assTextSubset.php.

{
$join = array();
foreach ($this->answers as $answer)
{
if (!is_array($join[$answer->getPoints() . ""]))
{
$join[$answer->getPoints() . ""] = array();
}
array_push($join[$answer->getPoints() . ""], $answer->getAnswertext());
}
return $join;
}
assTextSubset::loadFromDb (   $question_id)

Loads a assTextSubset object from a database.

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 122 of file class.assTextSubset.php.

References $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), setCorrectAnswers(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), setTextRating(), 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->setNrOfTries($data['nr_of_tries']);
$this->setTitle($data["title"]);
$this->setComment($data["description"]);
$this->setOriginalId($data["original_id"]);
$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->setCorrectAnswers($data["correctanswers"]);
$this->setTextRating($data["textgap_rating"]);
$this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
try
{
$this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
}
catch(ilTestQuestionPoolException $e)
{
}
}
$result = $ilDB->queryF("SELECT * FROM qpl_a_textsubset WHERE question_fi = %s ORDER BY aorder ASC",
array('integer'),
array($question_id)
);
include_once "./Modules/TestQuestionPool/classes/class.assAnswerBinaryStateImage.php";
if ($result->numRows() > 0)
{
while ($data = $ilDB->fetchAssoc($result))
{
array_push($this->answers, new ASS_AnswerBinaryStateImage($data["answertext"], $data["points"], $data["aorder"]));
}
}
parent::loadFromDb($question_id);
}

+ Here is the call graph for this function:

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

Reworks the allready saved working data if neccessary.

protected

Parameters
integer$active_id
integer$pass
boolean$obligationsAnswered

Reimplemented from assQuestion.

Definition at line 718 of file class.assTextSubset.php.

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

Saves a assTextSubset object to a database.

Parameters
string$original_id

Reimplemented from assQuestion.

Definition at line 104 of file class.assTextSubset.php.

References assQuestion\$original_id, ilObjQuestionScoringAdjustable\saveAdditionalQuestionDataToDb(), ilObjAnswerScoringAdjustable\saveAnswerSpecificDataToDb(), and assQuestion\saveQuestionDataToDb().

{
global $ilDB;
$this->saveQuestionDataToDb($original_id);
$this->saveAdditionalQuestionDataToDb();
$this->saveAnswerSpecificDataToDb();
parent::saveToDb($original_id);
}

+ Here is the call graph for this function:

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

Saves the learners input of the question to the database.

public

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

Reimplemented from assQuestion.

Definition at line 598 of file class.assTextSubset.php.

References $_POST, $ilUser, $pass, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), assQuestion\getId(), assQuestion\getProcessLocker(), assQuestion\logAction(), and ilUtil\secureString().

{
global $ilDB;
global $ilUser;
if (is_null($pass))
{
include_once "./Modules/Test/classes/class.ilObjTest.php";
$pass = ilObjTest::_getPass($active_id);
}
$entered_values = 0;
$this->getProcessLocker()->requestUserSolutionUpdateLock();
$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)
);
require_once 'Services/Utilities/classes/class.ilUtil.php';
foreach ($_POST as $key => $value)
{
if (preg_match("/^TEXTSUBSET_(\d+)/", $key, $matches))
{
if (strlen($value))
{
$value = ilUtil::secureString($value);
$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", trim($value)),
"value2" => array("clob", null),
"pass" => array("integer", $pass),
"tstamp" => array("integer", time())
));
$entered_values++;
}
}
}
$this->getProcessLocker()->releaseUserSolutionUpdateLock();
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());
}
}
return true;
}

+ Here is the call graph for this function:

assTextSubset::setCorrectAnswers (   $a_correct_answers)

Sets the number of correct answers needed to solve the question.

Parameters
integer$a_correct_anwersThe number of correct answers public

Definition at line 574 of file class.assTextSubset.php.

Referenced by loadFromDb().

{
$this->correctanswers = $a_correct_answers;
}

+ Here is the caller graph for this function:

assTextSubset::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 814 of file class.assTextSubset.php.

References $pass, ilExcelUtils\_convert_text(), 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);
$i = 1;
foreach ($solutions as $solution)
{
$worksheet->write($startrow + $i, 0, ilExcelUtils::_convert_text($solution["value1"]));
$i++;
}
return $startrow + $i + 1;
}

+ Here is the call graph for this function:

assTextSubset::setTextRating (   $a_text_rating)

Sets the rating option for text comparisons.

Parameters
string$a_textgap_ratingThe rating option for text comparisons
See Also
$textgap_rating User interface

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

References TEXTGAP_RATING_CASEINSENSITIVE, TEXTGAP_RATING_CASESENSITIVE, TEXTGAP_RATING_LEVENSHTEIN1, TEXTGAP_RATING_LEVENSHTEIN2, TEXTGAP_RATING_LEVENSHTEIN3, TEXTGAP_RATING_LEVENSHTEIN4, and TEXTGAP_RATING_LEVENSHTEIN5.

Referenced by loadFromDb().

{
switch ($a_text_rating)
{
case TEXTGAP_RATING_CASEINSENSITIVE:
case TEXTGAP_RATING_CASESENSITIVE:
case TEXTGAP_RATING_LEVENSHTEIN1:
case TEXTGAP_RATING_LEVENSHTEIN2:
case TEXTGAP_RATING_LEVENSHTEIN3:
case TEXTGAP_RATING_LEVENSHTEIN4:
case TEXTGAP_RATING_LEVENSHTEIN5:
$this->text_rating = $a_text_rating;
break;
default:
$this->text_rating = TEXTGAP_RATING_CASEINSENSITIVE;
break;
}
}

+ Here is the caller graph for this function:

assTextSubset::toJSON ( )

Returns a JSON representation of the question.

Definition at line 837 of file class.assTextSubset.php.

References $answers, $mobs, $result, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), getAnswers(), getCorrectAnswers(), assQuestion\getId(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), getTextRating(), and assQuestion\getTitle().

{
include_once("./Services/RTE/classes/class.ilRTE.php");
$result = array();
$result['id'] = (int) $this->getId();
$result['type'] = (string) $this->getQuestionType();
$result['title'] = (string) $this->getTitle();
$result['question'] = $this->formatSAQuestion($this->getQuestion());
$result['nr_of_tries'] = (int) $this->getNrOfTries();
$result['matching_method'] = (string) $this->getTextRating();
$result['feedback'] = array(
"onenotcorrect" => $this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false),
"allcorrect" => $this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true)
);
$answers = array();
foreach ($this->getAnswers() as $key => $answer_obj)
{
array_push($answers, array(
"answertext" => (string) $answer_obj->getAnswertext(),
"points" => (float)$answer_obj->getPoints(),
"order" => (int)$answer_obj->getOrder()
));
}
$result['correct_answers'] = $answers;
$answers = array();
for($loop = 1; $loop <= (int) $this->getCorrectAnswers(); $loop++)
{
array_push($answers, array(
"answernr" => $loop
));
}
$result['answers'] = $answers;
$mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
$result['mobs'] = $mobs;
return json_encode($result);
}

+ Here is the call graph for this function:

Field Documentation

assTextSubset::$answers

Definition at line 33 of file class.assTextSubset.php.

Referenced by getAnswers(), isAnswerCorrect(), and toJSON().

assTextSubset::$correctanswers

Definition at line 42 of file class.assTextSubset.php.

Referenced by getCorrectAnswers().

assTextSubset::$text_rating

Definition at line 51 of file class.assTextSubset.php.

Referenced by getTextRating().

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