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

Class for error text questions. More...

+ Inheritance diagram for assErrorText:
+ Collaboration diagram for assErrorText:

Public Member Functions

 __construct ($title="", $comment="", $author="", $owner=-1, $question="")
 assErorText constructor
 isComplete ()
 Returns true, if a single choice question is complete for use.
 saveToDb ($original_id="")
 Saves a the object to the database.
 loadFromDb ($question_id)
 Loads the object from the database.
 duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
 Duplicates the object.
 copyObject ($target_questionpool, $title="")
 Copies an object.
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question.
 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.
 toggleSelection ($position, $active_id, $pass=null)
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database.
 getQuestionType ()
 Returns the question type of the question.
 getAdditionalTableName ()
 Returns the name of the additional question data table in the database.
 getAnswerTableName ()
 Returns the name of the answer table in the database.
 deleteAnswers ($question_id)
 Deletes datasets from answers tables.
 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.
 fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
 Creates a question from a QTI file.
 toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $force_image_references=false)
 Returns a QTI xml representation of the question and sets the internal domxml variable with the DOM XML representation of the QTI xml representation.
 getBestSolution ($active_id, $pass)
 Returns the best solution for a given pass of a participant.
 getErrorsFromText ($a_text="")
 setErrorData ($a_data)
 createErrorTextOutput ($selections=null, $graphicalOutput=false, $correct_solution=false)
 createErrorTextExport ($selections=null)
 getBestSelection ()
 flushErrorData ()
 Flush error data.
 addErrorData ($text_wrong, $text_correct, $points)
 getErrorData ()
 Get error data.
 getErrorText ()
 Get error text.
 setErrorText ($a_value)
 Set error text.
 getTextSize ()
 Set text size in percent.
 setTextSize ($a_value)
 Set text size in percent.
 getPointsWrong ()
 Get wrong points.
 setPointsWrong ($a_value)
 Set wrong points.
 __get ($value)
 Object getter.
 __set ($key, $value)
 Object setter.
 toJSON ()
 Returns a JSON representation of the question.
- Public Member Functions inherited from assQuestion
 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 ($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
 deleteAdditionalTableData ($question_id)
 Deletes datasets from the additional question table in the database.
 delete ($question_id)
 Deletes a question and all materials from the database.
 getTotalAnswers ()
 get total number of answers
 _getTotalAnswers ($a_q_id)
 get number of answers for question id (static) note: do not use $this inside this method
 _getTotalRightAnswers ($a_q_id)
 get number of answers for question id (static) note: do not use $this inside this method
 _getTitle ($a_q_id)
 Returns the title of a question.
 _getQuestionText ($a_q_id)
 Returns question text.
 copyXHTMLMediaObjectsOfQuestion ($a_q_id)
 syncXHTMLMediaObjectsOfQuestion ()
 createPageObject ()
 create page object of question
 copyPageOfQuestion ($a_q_id)
 getPageOfQuestion ()
 _getQuestionType ($question_id)
 Returns the question type of a question with a given id.
 _getQuestionTitle ($question_id)
 Returns the question title of a question with a given id.
 setOriginalId ($original_id)
 getOriginalId ()
 createNewQuestion ($a_create_page=true)
 Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs.
 saveQuestionDataToDb ($original_id="")
 setNewOriginalId ($newId)
 deleteSuggestedSolutions ()
 Deletes all suggestes solutions in the database.
 getSuggestedSolution ($subquestion_index=0)
 Returns a suggested solution for a given subquestion index.
 getSuggestedSolutionTitle ($subquestion_index=0)
 Returns the title of a suggested solution at a given subquestion_index.
 setSuggestedSolution ($solution_id="", $subquestion_index=0, $is_import=false)
 Sets a suggested solution for the question.
 _resolveInternalLink ($internal_link)
 _resolveIntLinks ($question_id)
 _getInternalLinkHref ($target="")
 _getOriginalId ($question_id)
 Returns the original id of a question.
 syncWithOriginal ()
 createRandomSolution ($test_id, $user_id)
 _questionExists ($question_id)
 Returns true if the question already exists in the database.
 _questionExistsInPool ($question_id)
 Returns true if the question already exists in the database and is assigned to a question pool.
& _instanciateQuestion ($question_id)
 Creates an instance of a question with a given question id.
 getPoints ()
 Returns the maximum available points for the question.
 setPoints ($a_points)
 Sets the maximum available points for the question.
 getSolutionMaxPass ($active_id)
 Returns the maximum pass a users question solution.
 _getSolutionMaxPass ($question_id, $active_id)
 Returns the maximum pass a users question solution.
 _isWriteable ($question_id, $user_id)
 Returns true if the question is writeable by a certain user.
 _isUsedInRandomTest ($question_id="")
 Checks whether the question is used in a random test or not.
 calculateReachedPoints ($active_id, $pass=NULL, $points=0)
 Returns the points, a learner has reached answering the question The points are calculated from the given answers including checks for all special scoring options in the test container.
 isHTML ($a_text)
 Checks if a given string contains HTML or not.
 prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
 Prepares a string for a text area output in tests.
 QTIMaterialToString ($a_material)
 Reads an QTI material tag an creates a text string.
 addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE)
 Creates a QTI material tag from a plain text or xhtml text.
 createNewImageFileName ($image_filename)
 _setReachedPoints ($active_id, $question_id, $points, $maxpoints, $pass=NULL, $manualscoring=FALSE)
 Sets the points, a learner has reached answering the question Additionally objective results are updated.
 getQuestion ()
 Gets the question string of the question object.
 setQuestion ($question="")
 Sets the question string of the question object.
 getQuestionTypeID ()
 Returns the question type of the question.
 getFeedbackGeneric ($correctness)
 Returns the generic feedback for a given question state.
 cleanupMediaObjectUsage ()
 synchronises appearances of media objects in the question with media object usage table
& getInstances ()
 Gets all instances of the question.
 _needsManualScoring ($question_id)
 getActiveUserData ($active_id)
 Returns the user id and the test id for a given active id.
& _instanciateQuestionGUI ($question_id)
 Creates an instance of a question gui with a given question id.
 getNrOfTries ()
 setNrOfTries ($a_nr_of_tries)
 setExportImagePath ($a_path)
 _questionExistsInTest ($question_id, $test_id)
 formatSAQuestion ($a_q)
 Format self assessment question.

Protected Member Functions

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

Protected Attributes

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

Additional Inherited Members

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

Detailed Description

Class for error 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.assErrorText.php 47446 2014-01-22 17:07:12Z bheyser

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

Constructor & Destructor Documentation

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

assErorText constructor

The constructor takes possible arguments an creates an instance of the assOrderingHorizontal 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 single choice question
See Also
assQuestion:__construct()

Reimplemented from assQuestion.

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

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

{
parent::__construct($title, $comment, $author, $owner, $question);
$this->errortext = "";
$this->textsize = 100.0;
$this->errordata = array();
}

Member Function Documentation

assErrorText::__get (   $value)

Object getter.

Reimplemented from assQuestion.

Definition at line 844 of file class.assErrorText.php.

References getErrorText(), getPointsWrong(), and getTextSize().

{
switch ($value)
{
case "errortext":
return $this->getErrorText();
break;
case "textsize":
return $this->getTextSize();
break;
case "points_wrong":
return $this->getPointsWrong();
break;
default:
return parent::__get($value);
break;
}
}

+ Here is the call graph for this function:

assErrorText::__set (   $key,
  $value 
)

Object setter.

Reimplemented from assQuestion.

Definition at line 866 of file class.assErrorText.php.

References setErrorText(), setPointsWrong(), and setTextSize().

{
switch ($key)
{
case "errortext":
$this->setErrorText($value);
break;
case "textsize":
$this->setTextSize($value);
break;
case "points_wrong":
$this->setPointsWrong($value);
break;
default:
parent::__set($key, $value);
break;
}
}

+ Here is the call graph for this function:

assErrorText::addErrorData (   $text_wrong,
  $text_correct,
  $points 
)

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

References assQuestion\$points.

{
include_once "./Modules/TestQuestionPool/classes/class.assAnswerErrorText.php";
array_push($this->errordata, new assAnswerErrorText($text_wrong, $text_correct, $points));
}
assErrorText::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

Definition at line 303 of file class.assErrorText.php.

References $ilDB, $pass, assQuestion\$points, $result, $row, assQuestion\getId(), getPointsForSelectedPositions(), and assQuestion\getSolutionMaxPass().

Referenced by toggleSelection().

{
global $ilDB;
$found_values = array();
if (is_null($pass))
{
$pass = $this->getSolutionMaxPass($active_id);
}
$result = $ilDB->queryF("SELECT value1 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 ($row = $ilDB->fetchAssoc($result))
{
array_push($found_values, $row['value1']);
}
$points = $this->getPointsForSelectedPositions($found_values);
$points = parent::calculateReachedPoints($active_id, $pass = NULL, $points);
return $points;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Copies an object.

Definition at line 248 of file class.assErrorText.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:

assErrorText::createErrorTextExport (   $selections = null)

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

References getErrorText(), and ilUtil\prepareFormOutput().

Referenced by setExportDetailsXLS().

{
$counter = 0;
$errorcounter = 0;
include_once "./Services/Utilities/classes/class.ilStr.php";
if (!is_array($selections)) $selections = array();
$textarray = preg_split("/[\n\r]+/", $this->getErrorText());
foreach ($textarray as $textidx => $text)
{
$items = preg_split("/\s+/", $text);
foreach ($items as $idx => $item)
{
if (strpos($item, '#') === 0)
{
$item = ilStr::substr($item, 1, ilStr::strlen($item));
if ($correct_solution)
{
$errorobject = $this->errordata[$errorcounter];
if (is_object($errorobject))
{
$item = $errorobject->text_correct;
}
$errorcounter++;
}
}
$word = "";
if (in_array($counter, $selections))
{
$word .= '#';
}
$word .= ilUtil::prepareFormOutput($item);
if (in_array($counter, $selections))
{
$word .= '#';
}
$items[$idx] = $word;
$counter++;
}
$textarray[$textidx] = join($items, " ");
}
return join($textarray, "\n");
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assErrorText::createErrorTextOutput (   $selections = null,
  $graphicalOutput = false,
  $correct_solution = false 
)

Definition at line 590 of file class.assErrorText.php.

References $img, getErrorText(), assQuestion\getImagePath(), getPointsForSelectedPositions(), and ilUtil\prepareFormOutput().

{
$counter = 0;
$errorcounter = 0;
include_once "./Services/Utilities/classes/class.ilStr.php";
if (!is_array($selections)) $selections = array();
$textarray = preg_split("/[\n\r]+/", $this->getErrorText());
foreach ($textarray as $textidx => $text)
{
$items = preg_split("/\s+/", $text);
foreach ($items as $idx => $item)
{
if (strpos($item, '#') === 0)
{
$item = ilStr::substr($item, 1, ilStr::strlen($item));
if ($correct_solution)
{
$errorobject = $this->errordata[$errorcounter];
if (is_object($errorobject))
{
$item = $errorobject->text_correct;
}
$errorcounter++;
}
}
$class = '';
$img = '';
if (in_array($counter, $selections))
{
$class = ' class="sel"';
if ($graphicalOutput)
{
if ($this->getPointsForSelectedPositions(array($counter)) >= 0)
{
$img = ' <img src="' . ilUtil::getImagePath("icon_ok.gif") . '" alt="' . $this->lng->txt("answer_is_right") . '" title="' . $this->lng->txt("answer_is_right") . '" /> ';
}
else
{
$img = ' <img src="' . ilUtil::getImagePath("icon_not_ok.gif") . '" alt="' . $this->lng->txt("answer_is_wrong") . '" title="' . $this->lng->txt("answer_is_wrong") . '" /> ';
}
}
}
$items[$idx] = '<a' . $class . ' href="#HREF' . $idx . '" onclick="javascript: return false;">' . ilUtil::prepareFormOutput($item) . '</a>' . $img;
$counter++;
}
$textarray[$textidx] = '<p>' . join($items, " ") . '</p>';
}
return join($textarray, "\n");
}

+ Here is the call graph for this function:

assErrorText::deleteAnswers (   $question_id)

Deletes datasets from answers tables.

Parameters
integer$question_idThe question id which should be deleted in the answers table

Reimplemented from assQuestion.

Definition at line 461 of file class.assErrorText.php.

{
}
assErrorText::duplicate (   $for_test = true,
  $title = "",
  $author = "",
  $owner = "",
  $testObjId = null 
)

Duplicates the object.

Definition at line 187 of file class.assErrorText.php.

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

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

+ Here is the call graph for this function:

assErrorText::flushErrorData ( )

Flush error data.

Definition at line 755 of file class.assErrorText.php.

{
$this->errordata = array();
}
assErrorText::fromXML ( &  $item,
&  $questionpool_id,
&  $tst_id,
&  $tst_object,
&  $question_counter,
&  $import_mapping 
)

Creates a question from a QTI file.

Receives parameters from a QTI parser and creates a valid ILIAS question object

Parameters
object$itemThe QTI item object
integer$questionpool_idThe id of the parent questionpool
integer$tst_idThe id of the parent test if the question is part of a test
object$tst_objectA reference to the parent test object
integer$question_counterA reference to a question counter to count the questions of an imported question pool
array$import_mappingAn array containing references to included ILIAS objects

Reimplemented from assQuestion.

Definition at line 523 of file class.assErrorText.php.

{
include_once "./Modules/TestQuestionPool/classes/import/qti12/class.assErrorTextImport.php";
$import = new assErrorTextImport($this);
$import->fromXML($item, $questionpool_id, $tst_id, $tst_object, $question_counter, $import_mapping);
}
assErrorText::getAdditionalTableName ( )

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

Returns
string The additional table name

Reimplemented from assQuestion.

Definition at line 441 of file class.assErrorText.php.

Referenced by loadFromDb(), and saveToDb().

{
return "qpl_qst_errortext";
}

+ Here is the caller graph for this function:

assErrorText::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns
string The answer table name

Reimplemented from assQuestion.

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

{
return "";
}
assErrorText::getBestSelection ( )

Definition at line 683 of file class.assErrorText.php.

References assQuestion\$points, getErrorText(), and getPointsWrong().

{
$words = array();
$counter = 0;
$errorcounter = 0;
$textarray = preg_split("/[\n\r]+/", $this->getErrorText());
foreach ($textarray as $textidx => $text)
{
$items = preg_split("/\s+/", $text);
foreach ($items as $word)
{
$points = $this->getPointsWrong();
if (strpos($word, '#') === 0)
{
$errorobject = $this->errordata[$errorcounter];
if (is_object($errorobject))
{
$points = $errorobject->points;
}
$errorcounter++;
}
$words[$counter] = array("word" => $word, "points" => $points);
$counter++;
}
}
$selections = array();
foreach ($words as $idx => $word)
{
if ($word['points'] > 0)
{
array_push($selections, $idx);
}
}
return $selections;
}

+ Here is the call graph for this function:

assErrorText::getBestSolution (   $active_id,
  $pass 
)

Returns the best solution for a given pass of a participant.

Returns
array An associated array containing the best solution

Definition at line 548 of file class.assErrorText.php.

{
$user_solution = array();
return $user_solution;
}
assErrorText::getErrorData ( )

Get error data.

Returns
array Error data

Definition at line 771 of file class.assErrorText.php.

References $errordata.

Referenced by toJSON().

{
return $this->errordata;
}

+ Here is the caller graph for this function:

assErrorText::getErrorsFromText (   $a_text = "")

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

References getErrorText().

{
if (strlen($a_text) == 0) $a_text = $this->getErrorText();
preg_match_all("/#([^\s]+)/is", $a_text, $matches);
if (is_array($matches[1]))
{
return $matches[1];
}
else
{
return array();
}
}

+ Here is the call graph for this function:

assErrorText::getErrorText ( )

Get error text.

Returns
string Error text

Definition at line 781 of file class.assErrorText.php.

References $errortext.

Referenced by __get(), createErrorTextExport(), createErrorTextOutput(), getBestSelection(), getErrorsFromText(), getPointsForSelectedPositions(), saveToDb(), and toJSON().

{
return $this->errortext;
}

+ Here is the caller graph for this function:

assErrorText::getMaximumPoints ( )

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

See Also
$points

Reimplemented from assQuestion.

Definition at line 285 of file class.assErrorText.php.

Referenced by isComplete().

{
$maxpoints = 0.0;
foreach ($this->errordata as $object)
{
if ($object->points > 0) $maxpoints += $object->points;
}
return $maxpoints;
}

+ Here is the caller graph for this function:

assErrorText::getPointsForSelectedPositions (   $positions)
protected

Definition at line 719 of file class.assErrorText.php.

References assQuestion\$points, $total, getErrorText(), and getPointsWrong().

Referenced by calculateReachedPoints(), and createErrorTextOutput().

{
$words = array();
$counter = 0;
$errorcounter = 0;
$textarray = preg_split("/[\n\r]+/", $this->getErrorText());
foreach ($textarray as $textidx => $text)
{
$items = preg_split("/\s+/", $text);
foreach ($items as $word)
{
$points = $this->getPointsWrong();
if (strpos($word, '#') === 0)
{
$errorobject = $this->errordata[$errorcounter];
if (is_object($errorobject))
{
$points = $errorobject->points;
}
$errorcounter++;
}
$words[$counter] = array("word" => $word, "points" => $points);
$counter++;
}
}
$total = 0;
foreach ($positions as $position)
{
$total += $words[$position]['points'];
}
return $total;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assErrorText::getPointsWrong ( )

Get wrong points.

Returns
double Points for wrong selection

Definition at line 826 of file class.assErrorText.php.

References $points_wrong.

Referenced by __get(), getBestSelection(), getPointsForSelectedPositions(), and saveToDb().

{
return $this->points_wrong;
}

+ Here is the caller graph for this function:

assErrorText::getQuestionType ( )

Returns the question type of the question.

Returns
integer The question type of the question

Reimplemented from assQuestion.

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

Referenced by toJSON().

{
return "assErrorText";
}

+ Here is the caller graph for this function:

assErrorText::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 469 of file class.assErrorText.php.

{
$text = parent::getRTETextWithMediaObjects();
return $text;
}
assErrorText::getTextSize ( )

Set text size in percent.

Returns
double Text size in percent

Definition at line 801 of file class.assErrorText.php.

References $textsize.

Referenced by __get(), and saveToDb().

{
return $this->textsize;
}

+ Here is the caller graph for this function:

assErrorText::isComplete ( )

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

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

Reimplemented from assQuestion.

Definition at line 71 of file class.assErrorText.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:

assErrorText::loadFromDb (   $question_id)

Loads the object from the database.

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

Reimplemented from assQuestion.

Definition at line 140 of file class.assErrorText.php.

References $data, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), assQuestion\setAuthor(), assQuestion\setComment(), setErrorText(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), setPointsWrong(), assQuestion\setQuestion(), setTextSize(), 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->setErrorText($data["errortext"]);
$this->setTextSize($data["textsize"]);
$this->setPointsWrong($data["points_wrong"]);
$this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
}
$result = $ilDB->queryF("SELECT * FROM qpl_a_errortext WHERE question_fi = %s ORDER BY sequence ASC",
array('integer'),
array($question_id)
);
include_once "./Modules/TestQuestionPool/classes/class.assAnswerErrorText.php";
if ($result->numRows() > 0)
{
while ($data = $ilDB->fetchAssoc($result))
{
array_push($this->errordata, new assAnswerErrorText($data["text_wrong"], $data["text_correct"], $data["points"]));
}
}
parent::loadFromDb($question_id);
}

+ Here is the call graph for this function:

assErrorText::saveToDb (   $original_id = "")

Saves a the object to the database.

Reimplemented from assQuestion.

Definition at line 87 of file class.assErrorText.php.

References $ilDB, assQuestion\$original_id, getAdditionalTableName(), getErrorText(), assQuestion\getId(), getPointsWrong(), getTextSize(), 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, errortext, textsize, points_wrong) VALUES (%s, %s, %s, %s)",
array("integer", "text", "float", "float"),
array(
$this->getId(),
$this->getErrorText(),
$this->getTextSize(),
$this->getPointsWrong()
)
);
$affectedRows = $ilDB->manipulateF("DELETE FROM qpl_a_errortext WHERE question_fi = %s",
array('integer'),
array($this->getId())
);
$sequence = 0;
foreach ($this->errordata as $object)
{
$next_id = $ilDB->nextId('qpl_a_errortext');
$affectedRows = $ilDB->manipulateF("INSERT INTO qpl_a_errortext (answer_id, question_fi, text_wrong, text_correct, points, sequence) VALUES (%s, %s, %s, %s, %s, %s)",
array('integer','integer','text','text','float', 'integer'),
array(
$next_id,
$this->getId(),
$object->text_wrong,
$object->text_correct,
$object->points,
$sequence++
)
);
}
parent::saveToDb();
}

+ Here is the call graph for this function:

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

Reimplemented from assQuestion.

Definition at line 371 of file class.assErrorText.php.

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

{
global $ilDB;
global $ilUser;
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)
);
$entered_values = false;
if (strlen($_POST["qst_" . $this->getId()]))
{
$selected = split(",", $_POST["qst_" . $this->getId()]);
foreach ($selected as $position)
{
$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", $position),
"value2" => array("clob", null),
"pass" => array("integer", $pass),
"tstamp" => array("integer", time())
));
}
$entered_values = true;
}
if ($entered_values)
{
include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
if (ilObjAssessmentFolder::_enabledAssessmentLogging())
{
$this->logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
}
}
else
{
include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
if (ilObjAssessmentFolder::_enabledAssessmentLogging())
{
$this->logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
}
}
parent::saveWorkingData($active_id, $pass);
return true;
}

+ Here is the call graph for this function:

assErrorText::setErrorData (   $a_data)

Definition at line 568 of file class.assErrorText.php.

References $errordata, and assQuestion\$points.

{
include_once "./Modules/TestQuestionPool/classes/class.assAnswerErrorText.php";
$temp = $this->errordata;
$this->errordata = array();
foreach ($a_data as $error)
{
$text_correct = "";
$points = 0.0;
foreach ($temp as $object)
{
if (strcmp($object->text_wrong, $error) == 0)
{
$text_correct = $object->text_correct;
$points = $object->points;
continue;
}
}
array_push($this->errordata, new assAnswerErrorText($error, $text_correct, $points));
}
}
assErrorText::setErrorText (   $a_value)

Set error text.

Parameters
string$a_valueError text

Definition at line 791 of file class.assErrorText.php.

Referenced by __set(), and loadFromDb().

{
$this->errortext = $a_value;
}

+ Here is the caller graph for this function:

assErrorText::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

Reimplemented from assQuestion.

Definition at line 486 of file class.assErrorText.php.

References $errortext, $pass, ilExcelUtils\_convert_text(), createErrorTextExport(), assQuestion\getSolutionValues(), and assQuestion\getTitle().

{
include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
$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= 0;
$selections = array();
$solutions =& $this->getSolutionValues($active_id, $pass);
if (is_array($solutions))
{
foreach ($solutions as $solution)
{
array_push($selections, $solution['value1']);
}
$errortext_value = join(",", $selections);
}
$errortext = $this->createErrorTextExport($selections);
$errortext = preg_replace("/#HREF\d+/is", "javascript:void(0);", $errortext);
$i++;
$worksheet->writeString($startrow+$i, 0, ilExcelUtils::_convert_text($errortext));
$i++;
return $startrow + $i + 1;
}

+ Here is the call graph for this function:

assErrorText::setPointsWrong (   $a_value)

Set wrong points.

Parameters
double$a_valuePoints for wrong selection

Definition at line 836 of file class.assErrorText.php.

Referenced by __set(), and loadFromDb().

{
$this->points_wrong = $a_value;
}

+ Here is the caller graph for this function:

assErrorText::setTextSize (   $a_value)

Set text size in percent.

Parameters
double$a_valuetext size in percent

Definition at line 811 of file class.assErrorText.php.

Referenced by __set(), and loadFromDb().

{
// in self-assesment-mode value should always be set (and must not be null)
if($a_value === null)
{
$a_value = 100;
}
$this->textsize = $a_value;
}

+ Here is the caller graph for this function:

assErrorText::toggleSelection (   $position,
  $active_id,
  $pass = null 
)

Definition at line 328 of file class.assErrorText.php.

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

{
global $ilDB;
global $ilUser;
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 AND value1 = %s",
array('integer','integer','integer', 'text'),
array($active_id, $this->getId(), $pass, $position)
);
if ($affectedRows == 0)
{
$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", $position),
"value2" => array("clob", null),
"pass" => array("integer", $pass),
"tstamp" => array("integer", time())
));
}
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());
}
$this->calculateReachedPoints($active_id, $pass);
}

+ Here is the call graph for this function:

assErrorText::toJSON ( )

Returns a JSON representation of the question.

Definition at line 889 of file class.assErrorText.php.

References $mobs, $result, ilObjMediaObject\_getMobsOfObject(), ilRTE\_replaceMediaObjectImageSrc(), assQuestion\formatSAQuestion(), getErrorData(), getErrorText(), assQuestion\getFeedbackGeneric(), assQuestion\getId(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), assQuestion\getTitle(), and ilUtil\prepareFormOutput().

{
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['text'] = (string) ilRTE::_replaceMediaObjectImageSrc($this->getErrorText(), 0);
$result['nr_of_tries'] = (int) $this->getNrOfTries();
$result['shuffle'] = (bool) $this->getShuffle();
$result['feedback'] = array(
"onenotcorrect" => ilRTE::_replaceMediaObjectImageSrc($this->getFeedbackGeneric(0), 0),
"allcorrect" => ilRTE::_replaceMediaObjectImageSrc($this->getFeedbackGeneric(1), 0)
);
$answers = array();
foreach ($this->getErrorData() as $idx => $answer_obj)
{
array_push($answers, array(
"answertext_wrong" => (string) $answer_obj->text_wrong,
"answertext_correct" => (string) $answer_obj->text_correct,
"points" => (float)$answer_obj->points,
"order" => (int)$idx+1
));
}
$result['correct_answers'] = $answers;
$answers = array();
$textarray = preg_split("/[\n\r]+/", $this->getErrorText());
foreach ($textarray as $textidx => $text)
{
$items = preg_split("/\s+/", trim($text));
foreach ($items as $idx => $item)
{
if(substr($item, 0, 1) == "#")
{
$item = substr($item, 1);
}
array_push($answers, array(
"answertext" => (string) ilUtil::prepareFormOutput($item),
"order" => $textidx."_".($idx+1)
));
}
if($textidx != sizeof($textarray)-1)
{
array_push($answers, array(
"answertext" => "###",
"order" => $textidx."_".($idx+2)
));
}
}
$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:

assErrorText::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 and sets the internal domxml variable with the DOM XML representation of the QTI xml representation.

Returns
string The QTI xml representation of the question

Reimplemented from assQuestion.

Definition at line 536 of file class.assErrorText.php.

{
include_once "./Modules/TestQuestionPool/classes/export/qti12/class.assErrorTextExport.php";
$export = new assErrorTextExport($this);
return $export->toXML($a_include_header, $a_include_binary, $a_shuffle, $test_output, $force_image_references);
}

Field Documentation

assErrorText::$errordata
protected

Definition at line 37 of file class.assErrorText.php.

Referenced by getErrorData(), and setErrorData().

assErrorText::$errortext
protected

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

Referenced by getErrorText(), and setExportDetailsXLS().

assErrorText::$points_wrong
protected

Definition at line 38 of file class.assErrorText.php.

Referenced by getPointsWrong().

assErrorText::$textsize
protected

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

Referenced by getTextSize().

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