ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
assTextQuestion Class Reference

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="", $testObjId=null)
 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.
 getMinimumPoints ()
 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, $returndetails=FALSE)
 Returns the points, a learner has reached answering the question.
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database.
 createRandomSolution ($test_id, $user_id)
 getQuestionType ()
 Returns the question type of the question.
 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.
 getAnswerCount ()
 addAnswer ($answertext="", $points=0.0, $points_unchecked=0.0, $order=0, $answerimage="")
 Adds a possible answer for a multiple choice question.
 getAnswers ()
 getAnswer ($index=0)
 Returns an answer with a given index.
 deleteAnswer ($index=0)
 Deletes an answer with a given index.
 getAnswerTableName ()
 Returns the name of the answer table in the database.
 flushAnswers ()
 Deletes all answers.
 setAnswers ($answers)
 duplicateAnswers ($original_id)
 getKeywordRelation ()
 setKeywordRelation ($a_relation)
 This method implements a default behaviour.
 getFeedbackSingleAnswer ($answer_index)
 Returns the feedback for a single selected answer.
 isAnswered ($active_id, $pass)
 returns boolean wether the question is answered during test pass or not
- 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.
 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)
 _updateTestPassResults ($active_id, $pass, $obligationsEnabled=false)
 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 ()
 _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.
 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.
 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 ()
 getHtmlUserSolutionPurifier ()

Static Public Member Functions

static getValidScoringModes ()
static getScoringModesWithPointsByQuestion ()
static getScoringModesWithPointsByKeyword ()
static isObligationPossible ($questionId)
 returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration
- 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 _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 _getQuestionTypeName ($type_tag)
 Return the translation for a given question type tag.

Data Fields

 $maxNumOfChars
 $keywords
 $answers
 $text_rating
 $keyword_relation

Protected Member Functions

 reworkWorkingData ($active_id, $pass, $obligationsAnswered)
 Reworks the allready saved working data if neccessary.
 deleteFeedbackSpecific ($question_id)
- 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)
 duplicateQuestionHints ($originalQuestionId, $duplicateQuestionId)

Private Member Functions

 isValidTextRating ($textRating)

Private Attributes

 $matchcondition

Additional Inherited Members

- 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

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
Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de
Version
$Id$

Definition at line 21 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 68 of file class.assTextQuestion.php.

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

{
$this->maxNumOfChars = 0;
$this->points = 1;
$this->answers = array();
$this->matchcondition = 0;
}

Member Function Documentation

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

Adds a possible answer for a multiple choice question.

A ASS_AnswerBinaryStateImage object will be created and assigned to the array $this->answers.

Parameters
string$answertextThe answer text
double$pointsThe points for selecting the answer (even negative points can be used)
boolean$stateDefines the answer as correct (TRUE) or incorrect (FALSE)
integer$orderA possible display order of the answer
double$pointsThe points for not selecting the answer (even negative points can be used) public
See Also
$answers
ASS_AnswerBinaryStateImage

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

References assQuestion\$points.

Referenced by loadFromDb(), and setAnswers().

{
include_once "./Modules/TestQuestionPool/classes/class.assAnswerMultipleResponseImage.php";
// add answer
$answer = new ASS_AnswerMultipleResponseImage($answertext, $points);
$this->answers[] = $answer;
}

+ Here is the caller graph for this function:

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

References $answers, $pass, assQuestion\$points, $result, $row, getAnswers(), assQuestion\getId(), getKeywordRelation(), getMaximumPoints(), getMinimumPoints(), assQuestion\getSolutionMaxPass(), and isKeywordMatching().

{
if( $returndetails )
{
throw new ilTestException('return details not implemented for '.__METHOD__);
}
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)
);
// Return min points when no answer was given.
if ($ilDB->numRows($result) == 0)
{
return $this->getMinimumPoints();
}
// Return points of points are already on the row.
$row = $ilDB->fetchAssoc($result);
if ($row["points"] != NULL)
{
return $row["points"];
}
// Return min points when keyword relation is NON KEYWORDS
if( $this->getKeywordRelation() == 'non' )
{
return $this->getMinimumPoints();
}
// Return min points if there are no answers present.
$answers = $this->getAnswers();
if (count($answers) == 0)
{
return $this->getMinimumPoints();
}
switch( $this->getKeywordRelation() )
{
case 'any':
$points = 0;
foreach ($answers as $answer)
{
$qst_answer = $answer->answertext;
$user_answer = ' '.$row['value1'];
if( $this->isKeywordMatching( $user_answer, $qst_answer ) )
{
$points += $answer->points;
}
}
break;
case 'all':
foreach ($answers as $answer)
{
$qst_answer = $answer->answertext;
$user_answer = ' '.$row['value1'];
if( !$this->isKeywordMatching( $user_answer, $qst_answer ) )
{
$points = 0;
break;
}
}
break;
case 'one':
$points = 0;
foreach ($answers as $answer)
{
$qst_answer = $answer->answertext;
$user_answer = ' '.$row['value1'];
if( $this->isKeywordMatching( $user_answer, $qst_answer ) )
{
break;
}
}
break;
}
return $points;
}

+ Here is the call graph for this function:

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

Copies an assTextQuestion object.

public

Definition at line 278 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");
$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->duplicateGenericFeedback($original_id);
// duplicate answers
#$clone->duplicateAnswers($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 706 of file class.assTextQuestion.php.

{
}
assTextQuestion::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 888 of file class.assTextQuestion.php.

{
if ($index < 0) return;
if (count($this->answers) < 1) return;
if ($index >= count($this->answers)) return;
$answer = $this->answers[$index];
if (strlen($answer->getImage())) $this->deleteImage($answer->getImage());
unset($this->answers[$index]);
$this->answers = array_values($this->answers);
for ($i = 0; $i < count($this->answers); $i++)
{
if ($this->answers[$i]->getOrder() > $index)
{
$this->answers[$i]->setOrder($i);
}
}
}
assTextQuestion::deleteFeedbackSpecific (   $question_id)
protected

Reimplemented from assQuestion.

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

{
global $ilDB;
$ilDB->manipulateF(
'DELETE
FROM qpl_fb_essay
WHERE question_fi = %s',
array('integer'),
array($question_id)
);
}
assTextQuestion::duplicate (   $for_test = true,
  $title = "",
  $author = "",
  $owner = "",
  $testObjId = null 
)

Duplicates an assTextQuestion.

public

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

+ Here is the call graph for this function:

assTextQuestion::duplicateAnswers (   $original_id)

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

References assQuestion\$original_id, $result, $row, and assQuestion\getId().

{
global $ilDB;
$result = $ilDB->queryF("SELECT * FROM qpl_a_essay WHERE question_fi = %s",
array('integer'),
array($original_id)
);
if ($result->numRows())
{
while ($row = $ilDB->fetchAssoc($result))
{
$next_id = $ilDB->nextId('qpl_a_essay');
$affectedRows = $ilDB->manipulateF(
"INSERT INTO qpl_a_essay (answer_id, question_fi, answertext, points)
VALUES (%s, %s, %s, %s)",
array('integer','integer','text','integer'),
array($next_id, $this->getId(), $row["answertext"], $row["points"])
);
}
}
}

+ Here is the call graph for this function:

assTextQuestion::flushAnswers ( )

Deletes all answers.

public

See Also
$answers

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

Referenced by loadFromDb(), and setAnswers().

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

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

Referenced by loadFromDb(), and saveToDb().

{
return "qpl_qst_essay";
}

+ Here is the caller graph for this function:

assTextQuestion::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_AnswerBinaryStateImage-Object containing the answer public
See Also
$answers

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

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

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

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

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

References $answers.

Referenced by calculateReachedPoints().

{
return $this->answers;
}

+ Here is the caller graph for this function:

assTextQuestion::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns
string The answer table name public

Reimplemented from assQuestion.

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

{
return 'qpl_a_essay';
}
assTextQuestion::getFeedbackSingleAnswer (   $answer_index)

Returns the feedback for a single selected answer.

Parameters
integer$answer_indexThe index of the answer
Returns
string Feedback text public

Reimplemented from assQuestion.

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

References $result, $row, ilRTE\_replaceMediaObjectImageSrc(), and assQuestion\getId().

{
global $ilDB;
$feedback = "";
$result = $ilDB->queryF("SELECT * FROM qpl_fb_essay WHERE question_fi = %s AND answer = %s",
array('integer','integer'),
array($this->getId(), $answer_index)
);
if ($result->numRows())
{
$row = $ilDB->fetchAssoc($result);
include_once("./Services/RTE/classes/class.ilRTE.php");
$feedback = ilRTE::_replaceMediaObjectImageSrc($row["feedback"], 1);
}
return $feedback;
}

+ Here is the call graph for this function:

assTextQuestion::getKeywordRelation ( )

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

References $keyword_relation.

Referenced by calculateReachedPoints(), getMaximumPoints(), getMinimumPoints(), and saveToDb().

+ 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 349 of file class.assTextQuestion.php.

References assQuestion\$points, getKeywordRelation(), and assQuestion\getPoints().

Referenced by calculateReachedPoints(), and isComplete().

{
if( in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion()) )
{
}
$points = 0;
foreach ($this->answers as $answer)
{
if ($answer->points > 0)
{
$points = $points + $answer->points;
}
}
return $points;
}

+ Here is the call graph for this function:

+ 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 319 of file class.assTextQuestion.php.

References $maxNumOfChars.

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

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

+ Here is the caller graph for this function:

assTextQuestion::getMinimumPoints ( )

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

References assQuestion\$points, and getKeywordRelation().

Referenced by calculateReachedPoints().

{
if( in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion()) )
{
return 0;
}
$points = 0;
foreach ($this->answers as $answer)
{
if ($answer->points < 0)
{
$points = $points + $answer->points;
}
}
return $points;
}

+ Here is the call graph for this function:

+ 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 716 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 774 of file class.assTextQuestion.php.

static assTextQuestion::getScoringModesWithPointsByKeyword ( )
static

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

Referenced by assTextQuestionGUI\getBestAnswer().

{
return array('any');
}

+ Here is the caller graph for this function:

static assTextQuestion::getScoringModesWithPointsByQuestion ( )
static

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

{
return array('non', 'all', 'one');
}
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 728 of file class.assTextQuestion.php.

References $text_rating.

Referenced by isKeywordMatching(), and saveToDb().

{
}

+ Here is the caller graph for this function:

static assTextQuestion::getValidScoringModes ( )
static

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

{
return array_merge(self::getScoringModesWithPointsByQuestion(), self::getScoringModesWithPointsByKeyword());
}
assTextQuestion::isAnswered (   $active_id,
  $pass 
)

returns boolean wether the question is answered during test pass or not

(overwrites method in class assQuestion)

Parameters
integer$active_id
integer$pass
Returns
boolean $answered

Reimplemented from assQuestion.

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

References $pass, assQuestion\doesSolutionRecordsExist(), and assQuestion\getId().

{
$answered = assQuestion::doesSolutionRecordsExist($active_id, $pass, $this->getId());
return $answered;
}

+ Here is the call 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 89 of file class.assTextQuestion.php.

References getMaximumPoints().

{
if (strlen($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 445 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)
{
if (ilStr::strPos(ilStr::strToLower($answertext), ilStr::strToLower($a_keyword)) !== false) return TRUE;
break;
if (ilStr::strPos($answertext, $a_keyword) !== false) return TRUE;
break;
}
// "<p>red</p>" would not match "red" even with distance of 5
$answertext = strip_tags($answertext);
$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)
{
if (levenshtein($a_original, $a_keyword) <= 1) return TRUE;
break;
if (levenshtein($a_original, $a_keyword) <= 2) return TRUE;
break;
if (levenshtein($a_original, $a_keyword) <= 3) return TRUE;
break;
if (levenshtein($a_original, $a_keyword) <= 4) return TRUE;
break;
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:

static assTextQuestion::isObligationPossible (   $questionId)
static

returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration

(overwrites method in class assQuestion)

Parameters
integer$questionId
Returns
boolean $obligationPossible

Reimplemented from assQuestion.

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

{
return true;
}
assTextQuestion::isValidTextRating (   $textRating)
private
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 160 of file class.assTextQuestion.php.

References $data, $result, $row, ilRTE\_replaceMediaObjectImageSrc(), addAnswer(), flushAnswers(), getAdditionalTableName(), assQuestion\getId(), isValidTextRating(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), setKeywordRelation(), setMaxNumOfChars(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setShuffle(), setTextRating(), assQuestion\setTitle(), and TEXTGAP_RATING_CASEINSENSITIVE.

{
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 ($ilDB->numRows($result) == 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"]);
if(0 != (int)$data["points"])
{
$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->setTextRating($this->isValidTextRating($data["textgap_rating"]) ? $data["textgap_rating"] : TEXTGAP_RATING_CASEINSENSITIVE);
$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));
$this->setKeywordRelation(($data['keyword_relation']));
}
$result = $ilDB->queryF("SELECT * FROM qpl_a_essay WHERE question_fi = %s",
array("integer"),
array($this->getId())
);
$this->flushAnswers();
while ($row = $ilDB->fetchAssoc($result))
{
$this->addAnswer($row['answertext'], $row['points']);
}
parent::loadFromDb($question_id);
}

+ Here is the call graph for this function:

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

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

Saves a assTextQuestion object to a database.

Parameters
object$dbA pear DB object public

Reimplemented from assQuestion.

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

References assQuestion\$original_id, getAdditionalTableName(), assQuestion\getId(), getKeywordRelation(), getMaxNumOfChars(), getTextRating(), and assQuestion\saveQuestionDataToDb().

{
global $ilDB;
// 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, keyword_relation) VALUES (%s, %s, %s, %s, %s, %s)",
array("integer", "integer", "text", "text", 'integer', 'text'),
array(
$this->getId(),
$this->getMaxNumOfChars(),
NULL,
$this->getTextRating(),
$this->matchcondition,
)
);
$ilDB->manipulateF("DELETE FROM qpl_a_essay WHERE question_fi = %s",
array("integer"),
array($this->getId())
);
foreach ($this->answers as $answer)
{
$nextID = $ilDB->nextId('qpl_a_essay');
$ilDB->manipulateF("INSERT INTO qpl_a_essay (answer_id, question_fi, answertext, points) VALUES (%s, %s, %s, %s)",
array("integer", "integer", "text", 'float'),
array(
$nextID,
$this->getId(),
$answer->answertext,
$answer->points
)
);
}
}

+ Here is the call graph for this function:

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

References $_POST, $ilUser, $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");
{
$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");
{
$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:

assTextQuestion::setAnswers (   $answers)

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

References $answers, addAnswer(), and flushAnswers().

{
if( isset($answers['answer']) )
{
$count = count($answers['answer']);
$withPoints = true;
}
else
{
$count = count($answers);
$withPoints = false;
}
$this->flushAnswers();
for( $i = 0; $i < $count; $i++ )
{
if($withPoints)
{
$this->addAnswer($answers['answer'][$i], $answers['points'][$i]);
}
else
{
$this->addAnswer($answers[$i], 0);
}
}
}

+ 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 791 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::setKeywordRelation (   $a_relation)

This method implements a default behaviour.

During the creation of a text question, the record which holds the keyword relation is not existing, so keyword_relation defaults to 'one'.

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

Referenced by loadFromDb().

{
$this->keyword_relation = $a_relation;
}

+ 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 338 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 397 of file class.assTextQuestion.php.

References $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 740 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)
{
$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 810 of file class.assTextQuestion.php.

References $result, assQuestion\formatSAQuestion(), 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'] = $this->formatSAQuestion($this->getQuestion());
$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::$answers

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

Referenced by calculateReachedPoints(), getAnswers(), and setAnswers().

assTextQuestion::$keyword_relation

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

Referenced by getKeywordRelation().

assTextQuestion::$keywords

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

assTextQuestion::$matchcondition
private

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

assTextQuestion::$maxNumOfChars

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

Referenced by getMaxNumOfChars().

assTextQuestion::$text_rating

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

Referenced by getTextRating().


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