ILIAS  Release_4_1_x_branch Revision 61804
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields | Private Attributes
assTextQuestion Class Reference
Modules/TestQuestionPool

Class for text questions. More...

+ Inheritance diagram for assTextQuestion:
+ Collaboration diagram for assTextQuestion:

Public Member Functions

 __construct ($title="", $comment="", $author="", $owner=-1, $question="")
 assTextQuestion constructor
 isComplete ()
 Returns true, if a multiple choice question is complete for use.
 saveToDb ($original_id="")
 Saves a assTextQuestion object to a database.
 loadFromDb ($question_id)
 Loads a assTextQuestion object from a database.
 duplicate ($for_test=true, $title="", $author="", $owner="")
 Duplicates an assTextQuestion.
 copyObject ($target_questionpool, $title="")
 Copies an assTextQuestion object.
 getMaxNumOfChars ()
 Gets the maximum number of characters for the text solution.
 setMaxNumOfChars ($maxchars=0)
 Sets the maximum number of characters for the text solution.
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question.
 setReachedPoints ($active_id, $points, $pass=NULL)
 Sets the points, a learner has reached answering the question.
 isKeywordMatching ($answertext, $a_keyword)
 Checks if one of the keywords matches the answertext.
 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.
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database.
 createRandomSolution ($test_id, $user_id)
 getQuestionType ()
 Returns the question type of the question.
 getKeywords ()
 Returns the keywords of the question.
 setKeywords ($a_keywords)
 Sets the keywords of the question.
& getKeywordList ()
 Returns the keywords of the question in an array.
 getTextRating ()
 Returns the rating option for text comparisons.
 setTextRating ($a_text_rating)
 Sets the rating option for text comparisons.
 getAdditionalTableName ()
 Returns the name of the additional question data 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.
 toJSON ()
 Returns a JSON representation of the question.
- Public Member Functions inherited from assQuestion
 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.
 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 ()
 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
 getAnswerTableName ()
 Returns the name of the answer table in the database.
 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 ()
 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="")
 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.
 updateSuggestedSolutions ($original_id="")
 Update the suggested solutions of a question based on the suggested solution array attribute.
 saveSuggestedSolution ($type, $solution_id="", $subquestion_index=0, $value="")
 Saves a suggested solution for the question.
 _resolveInternalLink ($internal_link)
 _resolveIntLinks ($question_id)
 _getInternalLinkHref ($target="")
 _getOriginalId ($question_id)
 Returns the original id of a question.
 syncWithOriginal ()
 _questionExists ($question_id)
 Returns true if the question already exists in the database.
& _instanciateQuestion ($question_id)
 Creates an instance of a question with a given question id.
 getPoints ()
 Returns the maximum available points for the question.
 setPoints ($a_points)
 Sets the maximum available points for the question.
 getSolutionMaxPass ($active_id)
 Returns the maximum pass a users question solution.
 _getSolutionMaxPass ($question_id, $active_id)
 Returns the maximum pass a users question solution.
 _isWriteable ($question_id, $user_id)
 Returns true if the question is writeable by a certain user.
 _isUsedInRandomTest ($question_id="")
 Checks whether the question is used in a random test or not.
 calculateReachedPoints ($active_id, $pass=NULL, $points=0)
 Returns the points, a learner has reached answering the question 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.
 saveFeedbackGeneric ($correctness, $feedback)
 Saves generic feedback to the database.
 getFeedbackGeneric ($correctness)
 Returns the generic feedback for a given question state.
 duplicateFeedbackGeneric ($original_id)
 Duplicates the generic feedback of a question.
 syncFeedbackGeneric ()
 cleanupMediaObjectUsage ()
 synchronises appearances of media objects in the question with media object usage table
& getInstances ()
 Gets all instances of the question.
 _needsManualScoring ($question_id)
 getActiveUserData ($active_id)
 Returns the user id and the test id for a given active id.
& _instanciateQuestionGUI ($question_id)
 Creates an instance of a question gui with a given question id.
 __get ($value)
 Object getter.
 __set ($key, $value)
 Object setter.
 getNrOfTries ()
 setNrOfTries ($a_nr_of_tries)

Data Fields

 $maxNumOfChars
 $keywords
 $text_rating

Private Attributes

 $matchcondition

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 _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.
- Protected Member Functions inherited from assQuestion
 deletePageOfQuestion ($question_id)
 Deletes the page object of a question with a given ID.
 onDuplicate ($source_question_id)
 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 ($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 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

Detailed Description

Class for text questions.

assTextQuestion is a class for text 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.assTextQuestion.php 25050 2010-08-10 10:07:10Z hschottm

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

Constructor & Destructor Documentation

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

assTextQuestion constructor

The constructor takes possible arguments an creates an instance of the assTextQuestion 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 text question public
See Also
assQuestion:assQuestion()

Reimplemented from assQuestion.

Definition at line 79 of file class.assTextQuestion.php.

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

{
parent::__construct($title, $comment, $author, $owner, $question);
$this->maxNumOfChars = 0;
$this->points = 0;
$this->keywords = "";
$this->matchcondition = 0;
}

Member Function Documentation

assTextQuestion::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 408 of file class.assTextQuestion.php.

References $ilDB, $keywords, $pass, assQuestion\$points, $result, $row, assQuestion\getId(), getKeywordList(), getMaximumPoints(), assQuestion\getSolutionMaxPass(), and isKeywordMatching().

{
global $ilDB;
$points = 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)
);
if ($result->numRows() == 1)
{
$row = $ilDB->fetchAssoc($result);
if ($row["points"])
{
$points = $row["points"];
}
else
{
$keywords =& $this->getKeywordList();
if (count($keywords))
{
if ($this->matchcondition == 0)
{
$foundkeyword = false;
}
else
{
$foundkeyword = true;
}
foreach ($keywords as $keyword)
{
if ($this->matchcondition == 0)
{
// OR: only one keyword needs to match
$foundkeyword = $foundkeyword | $this->isKeywordMatching($row["value1"], $keyword);
}
else
{
// AND: all keywords needs to match
$foundkeyword = $foundkeyword & $this->isKeywordMatching($row["value1"], $keyword);
}
}
if ($foundkeyword) $points = $this->getMaximumPoints();
}
}
}
$points = parent::calculateReachedPoints($active_id, $pass = NULL, $points);
return $points;
}

+ Here is the call graph for this function:

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

Copies an assTextQuestion object.

public

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

+ Here is the call graph for this function:

assTextQuestion::createRandomSolution (   $test_id,
  $user_id 
)

Reimplemented from assQuestion.

Definition at line 544 of file class.assTextQuestion.php.

{
}
assTextQuestion::duplicate (   $for_test = true,
  $title = "",
  $author = "",
  $owner = "" 
)

Duplicates an assTextQuestion.

public

Definition at line 188 of file class.assTextQuestion.php.

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

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

+ Here is the call graph for this function:

assTextQuestion::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 644 of file class.assTextQuestion.php.

Referenced by loadFromDb(), and saveToDb().

{
return "qpl_qst_essay";
}

+ Here is the caller graph for this function:

& assTextQuestion::getKeywordList ( )

Returns the keywords of the question in an array.

Returns
array The keywords of the question public

Definition at line 587 of file class.assTextQuestion.php.

References $keywords.

Referenced by calculateReachedPoints().

{
$keywords = array();
if (preg_match_all("/([^\s]+)/", $this->keywords, $matches))
{
foreach ($matches[1] as $keyword)
{
array_push($keywords, trim($keyword));
}
}
return $keywords;
}

+ Here is the caller graph for this function:

assTextQuestion::getKeywords ( )

Returns the keywords of the question.

Returns
string The keywords of the question public

Definition at line 565 of file class.assTextQuestion.php.

References $keywords.

Referenced by saveToDb().

{
return $this->keywords;
}

+ Here is the caller graph for this function:

assTextQuestion::getMaximumPoints ( )

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

public

See Also
$points

Reimplemented from assQuestion.

Definition at line 308 of file class.assTextQuestion.php.

References assQuestion\$points.

Referenced by calculateReachedPoints(), and isComplete().

{
return $this->points;
}

+ Here is the caller graph for this function:

assTextQuestion::getMaxNumOfChars ( )

Gets the maximum number of characters for the text solution.

Returns
integer The maximum number of characters for the text solution public
See Also
$maxNumOfChars

Definition at line 278 of file class.assTextQuestion.php.

References $maxNumOfChars.

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

{
if (strcmp($this->maxNumOfChars, "") == 0)
{
return 0;
}
else
{
return $this->maxNumOfChars;
}
}

+ Here is the caller graph for this function:

assTextQuestion::getQuestionType ( )

Returns the question type of the question.

Returns
integer The question type of the question public

Reimplemented from assQuestion.

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

Referenced by toJSON().

{
return "assTextQuestion";
}

+ Here is the caller graph for this function:

assTextQuestion::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 653 of file class.assTextQuestion.php.

{
return parent::getRTETextWithMediaObjects();
}
assTextQuestion::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 607 of file class.assTextQuestion.php.

References $text_rating.

Referenced by isKeywordMatching(), and saveToDb().

{
return $this->text_rating;
}

+ Here is the caller graph for this function:

assTextQuestion::isComplete ( )

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

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

Reimplemented from assQuestion.

Definition at line 100 of file class.assTextQuestion.php.

References getMaximumPoints().

{
if (($this->title) and ($this->author) and ($this->question) and ($this->getMaximumPoints() > 0))
{
return true;
}
else
{
return false;
}
}

+ Here is the call graph for this function:

assTextQuestion::isKeywordMatching (   $answertext,
  $a_keyword 
)

Checks if one of the keywords matches the answertext.

Parameters
string$answertextThe answertext of the user
string$a_keywordThe keyword which should be checked
Returns
boolean TRUE if the keyword matches, FALSE otherwise private

Definition at line 353 of file class.assTextQuestion.php.

References $result, getTextRating(), ilStr\strPos(), 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().

{
$result = FALSE;
$textrating = $this->getTextRating();
include_once "./Services/Utilities/classes/class.ilStr.php";
switch ($textrating)
{
case TEXTGAP_RATING_CASEINSENSITIVE:
if (ilStr::strPos(ilStr::strToLower($answertext), ilStr::strToLower($a_keyword)) !== false) return TRUE;
break;
case TEXTGAP_RATING_CASESENSITIVE:
if (ilStr::strPos($answertext, $a_keyword) !== false) return TRUE;
break;
}
$answerwords = array();
if (preg_match_all("/([^\s.]+)/", $answertext, $matches))
{
foreach ($matches[1] as $answerword)
{
array_push($answerwords, trim($answerword));
}
}
foreach ($answerwords as $a_original)
{
switch ($textrating)
{
case TEXTGAP_RATING_LEVENSHTEIN1:
if (levenshtein($a_original, $a_keyword) <= 1) return TRUE;
break;
case TEXTGAP_RATING_LEVENSHTEIN2:
if (levenshtein($a_original, $a_keyword) <= 2) return TRUE;
break;
case TEXTGAP_RATING_LEVENSHTEIN3:
if (levenshtein($a_original, $a_keyword) <= 3) return TRUE;
break;
case TEXTGAP_RATING_LEVENSHTEIN4:
if (levenshtein($a_original, $a_keyword) <= 4) return TRUE;
break;
case TEXTGAP_RATING_LEVENSHTEIN5:
if (levenshtein($a_original, $a_keyword) <= 5) return TRUE;
break;
}
}
return $result;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assTextQuestion::loadFromDb (   $question_id)

Loads a assTextQuestion object from a database.

Parameters
object$dbA pear DB object
integer$question_idA unique key which defines the text question in the database public

Reimplemented from assQuestion.

Definition at line 151 of file class.assTextQuestion.php.

References $data, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), setKeywords(), setMaxNumOfChars(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setShuffle(), 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->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->setShuffle($data["shuffle"]);
$this->setMaxNumOfChars($data["maxnumofchars"]);
$this->setKeywords($data["keywords"]);
$this->setTextRating($data["textgap_rating"]);
$this->matchcondition = (strlen($data['matchcondition'])) ? $data['matchcondition'] : 0;
$this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
}
parent::loadFromDb($question_id);
}

+ Here is the call graph for this function:

assTextQuestion::saveToDb (   $original_id = "")

Saves a assTextQuestion object to a database.

Parameters
object$dbA pear DB object public

Reimplemented from assQuestion.

Definition at line 118 of file class.assTextQuestion.php.

References $ilDB, assQuestion\$original_id, getAdditionalTableName(), assQuestion\getId(), getKeywords(), getMaxNumOfChars(), getTextRating(), 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, maxnumofchars, keywords, textgap_rating, matchcondition) VALUES (%s, %s, %s, %s, %s)",
array("integer", "integer", "text", "text", 'integer'),
array(
$this->getId(),
$this->getMaxNumOfChars(),
(strlen($this->getKeywords())) ? $this->getKeywords() : NULL,
$this->getTextRating(),
$this->matchcondition
)
);
parent::saveToDb($original_id);
}

+ Here is the call graph for this function:

assTextQuestion::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) public
See Also
$answers

Reimplemented from assQuestion.

Definition at line 471 of file class.assTextQuestion.php.

References $_POST, $ilDB, $pass, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), assQuestion\getId(), getMaxNumOfChars(), assQuestion\isHTML(), assQuestion\logAction(), ilUtil\stripSlashes(), ilStr\strLen(), and ilStr\subStr().

{
global $ilDB;
global $ilUser;
include_once "./Services/Utilities/classes/class.ilStr.php";
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)
);
$text = ilUtil::stripSlashes($_POST["TEXT"], FALSE);
if ($this->getMaxNumOfChars())
{
include_once "./Services/Utilities/classes/class.ilStr.php";
$text_without_tags = preg_replace("/<[^>*?]>/is", "", $text);
$len_with_tags = ilStr::strLen($text);
$len_without_tags = ilStr::strLen($text_without_tags);
if ($this->getMaxNumOfChars() < $len_without_tags)
{
if (!$this->isHTML($text))
{
$text = ilStr::subStr($text, 0, $this->getMaxNumOfChars());
}
}
}
if ($this->isHTML($text))
{
$text = preg_replace("/<[^>]*$/ims", "", $text);
}
else
{
//$text = htmlentities($text, ENT_QUOTES, "UTF-8");
}
$entered_values = 0;
if (strlen($text))
{
$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($text)),
"value2" => array("clob", null),
"pass" => array("integer", $pass),
"tstamp" => array("integer", time())
));
$entered_values++;
}
if ($entered_values)
{
include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
if (ilObjAssessmentFolder::_enabledAssessmentLogging())
{
$this->logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
}
}
else
{
include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
if (ilObjAssessmentFolder::_enabledAssessmentLogging())
{
$this->logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
}
}
parent::saveWorkingData($active_id, $pass);
return true;
}

+ Here is the call graph for this function:

assTextQuestion::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 670 of file class.assTextQuestion.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;
$worksheet->writeString($startrow + $i, 0, ilExcelUtils::_convert_text($this->lng->txt("result")), $format_bold);
if (strlen($solutions[0]["value1"]))
{
$worksheet->write($startrow + $i, 1, ilExcelUtils::_convert_text($solutions[0]["value1"]));
}
$i++;
return $startrow + $i + 1;
}

+ Here is the call graph for this function:

assTextQuestion::setKeywords (   $a_keywords)

Sets the keywords of the question.

Parameters
string$a_keywordsThe keywords of the question public

Definition at line 576 of file class.assTextQuestion.php.

Referenced by loadFromDb().

{
$this->keywords = $a_keywords;
}

+ Here is the caller graph for this function:

assTextQuestion::setMaxNumOfChars (   $maxchars = 0)

Sets the maximum number of characters for the text solution.

Parameters
integer$maxcharsThe maximum number of characters for the text solution public
See Also
$maxNumOfChars

Definition at line 297 of file class.assTextQuestion.php.

Referenced by loadFromDb().

{
$this->maxNumOfChars = $maxchars;
}

+ Here is the caller graph for this function:

assTextQuestion::setReachedPoints (   $active_id,
  $points,
  $pass = NULL 
)

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

Parameters
integer$user_idThe database ID of the learner
integer$test_idThe database Id of the test containing the question
integer$pointsThe points the user has reached answering the question
Returns
boolean true on success, otherwise false public

Definition at line 322 of file class.assTextQuestion.php.

References $ilDB, $pass, assQuestion\$points, assQuestion\_updateTestPassResults(), assQuestion\getId(), assQuestion\getPoints(), and assQuestion\getSolutionMaxPass().

{
global $ilDB;
if (($points > 0) && ($points <= $this->getPoints()))
{
if (is_null($pass))
{
$pass = $this->getSolutionMaxPass($active_id);
}
$affectedRows = $ilDB->manipulateF("UPDATE tst_test_result SET points = %s WHERE active_fi = %s AND question_fi = %s AND pass = %s",
array('float','integer','integer','integer'),
array($points, $active_id, $this->getId(), $pass)
);
$this->_updateTestPassResults($active_id, $pass);
return TRUE;
}
else
{
return TRUE;
}
}

+ Here is the call graph for this function:

assTextQuestion::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 619 of file class.assTextQuestion.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:

assTextQuestion::toJSON ( )

Returns a JSON representation of the question.

Definition at line 689 of file class.assTextQuestion.php.

References $result, ilRTE\_replaceMediaObjectImageSrc(), assQuestion\getId(), getMaxNumOfChars(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), 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'] = (string) ilRTE::_replaceMediaObjectImageSrc($this->getQuestion(), 0);
$result['nr_of_tries'] = (int) $this->getNrOfTries();
$result['shuffle'] = (bool) $this->getShuffle();
$result['maxlength'] = (int) $this->getMaxNumOfChars();
return json_encode($result);
}

+ Here is the call graph for this function:

Field Documentation

assTextQuestion::$keywords

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

Referenced by calculateReachedPoints(), getKeywordList(), and getKeywords().

assTextQuestion::$matchcondition
private

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

assTextQuestion::$maxNumOfChars

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

Referenced by getMaxNumOfChars().

assTextQuestion::$text_rating

Definition at line 61 of file class.assTextQuestion.php.

Referenced by getTextRating().

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