ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields
assOrderingQuestion Class Reference
Modules/TestQuestionPool

Class for ordering questions. More...

+ Inheritance diagram for assOrderingQuestion:
+ Collaboration diagram for assOrderingQuestion:

Public Member Functions

 assOrderingQuestion ($title="", $comment="", $author="", $owner=-1, $question="", $ordering_type=OQ_TERMS)
 assOrderingQuestion constructor
 isComplete ()
 Returns true, if a ordering question is complete for use.
 saveToDb ($original_id="")
 Saves a assOrderingQuestion object to a database.
 loadFromDb ($question_id)
 Loads a assOrderingQuestion object from a database.
 duplicate ($for_test=true, $title="", $author="", $owner="")
 Duplicates an assOrderingQuestion.
 copyObject ($target_questionpool, $title="")
 Copies an assOrderingQuestion object.
 duplicateImages ($question_id)
 copyImages ($question_id, $source_questionpool)
 setOrderingType ($ordering_type=OQ_TERMS)
 Sets the ordering question type.
 getOrderingType ()
 Returns the ordering question type.
 addAnswer ($answertext="", $points=0.0, $order=0, $solution_order=0)
 Adds an answer for an ordering question.
 getAnswer ($index=0)
 Returns an ordering answer.
 deleteAnswer ($index=0)
 Deletes an answer.
 flushAnswers ()
 Deletes all answers.
 getAnswerCount ()
 Returns the number of answers.
 getMaxSolutionOrder ()
 Returns the maximum solution order.
 calculateReachedPoints ($active_id, $pass=NULL)
 Returns the points, a learner has reached answering the question.
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question.
 setImageFile ($image_filename, $image_tempfilename="")
 Sets the image file.
 checkSaveData ()
 Checks the data to be saved for consistency.
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database.
 pc_array_shuffle ($array)
 getQuestionType ()
 Returns the question type of the question.
 getAdditionalTableName ()
 Returns the name of the additional question data table in the database.
 getAnswerTableName ()
 Returns the name of the answer table in the database.
 getRTETextWithMediaObjects ()
 Collects all text in the question which could contain media objects which were created with the Rich Text Editor.
& getAnswers ()
 Returns the answers array.
 supportsJavascriptOutput ()
 Returns true if the question type supports JavaScript output.
 setExportDetailsXLS (&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
 Creates an Excel worksheet for the detailed cumulated results of this question.
- Public Member Functions inherited from assQuestion
 assQuestion ($title="", $comment="", $author="", $owner=-1, $question="")
 assQuestion constructor
 _assQuestion ()
 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.
 questionTitleExists ($questionpool_id, $title)
 Returns TRUE if the question title exists in the database.
 setTitle ($title="")
 Sets the title string.
 setId ($id=-1)
 Sets the id.
 setTestId ($id=-1)
 Sets the test id.
 setComment ($comment="")
 Sets the comment.
 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.
 setOwner ($owner="")
 Sets the creator/owner.
 getTitle ()
 Gets the title string.
 getId ()
 Gets the id.
 getShuffle ()
 Gets the shuffle flag.
 getTestId ()
 Gets the test id.
 getComment ()
 Gets the comment.
 getOutputType ()
 Gets the output type.
 getEstimatedWorkingTime ()
 Gets the estimated working time of a question.
 getAuthor ()
 Gets the authors name.
 getOwner ()
 Gets the creator/owner.
 getObjId ()
 Get the object id of the container object.
 setObjId ($obj_id=0)
 Set the object id of the container object.
 createPageObject ()
 create page object of question
 insertIntoTest ($test_id)
 Insert the question into a test.
 _getMaximumPoints ($question_id)
 Returns the maximum points, a learner can reach answering the question.
& _getQuestionInfo ($question_id)
 Returns question information from the database.
 _getSuggestedSolutionCount ($question_id)
 Returns the number of suggested solutions associated with a question.
& _getSuggestedSolution ($question_id, $subquestion_index=0)
 Returns a suggested solution for a given subquestion index.
 _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.
 _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.
 getJavaPath ()
 Returns the image path for web accessable images of a question.
 getImagePath ()
 Returns the image path for web accessable images of a question.
 getFlashPath ()
 Returns the image path for web accessable flash files of a question.
 getJavaPathWeb ()
 Returns the web image path for web accessable java applets of a question.
 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.
 copyXHTMLMediaObjectsOfQuestion ($a_q_id)
 syncXHTMLMediaObjectsOfQuestion ()
 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 ()
 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.
 saveSuggestedSolution ($solution_id="", $subquestion_index=0)
 Saves a suggested solution for the question.
 _resolveInternalLink ($internal_link)
 _resolveIntLinks ($question_id)
 _getInternalLinkHref ($target="")
 _getOriginalId ($question_id)
 Returns the original id of a question.
 syncWithOriginal ()
 createRandomSolution ($test_id, $user_id)
 _questionExists ($question_id)
 Returns true if the question already exists in the database.
& _instanciateQuestion ($question_id)
 Creates an instance of a question with a given question id.
 getPoints ()
 Returns the maximum available points for the question.
 setPoints ($a_points)
 Sets the maximum available points for the question.
 getSolutionMaxPass ($active_id)
 Returns the maximum pass a users question solution.
 _getSolutionMaxPass ($question_id, $active_id)
 Returns the maximum pass a users question solution.
 _isWriteable ($question_id, $user_id)
 Returns true if the question is writeable by a certain user.
 _isUsedInRandomTest ($question_id="")
 Checks whether the question is used in a random test or not.
 calculateReachedPoints ($active_id, $pass=NULL, $points=0)
 Returns the points, a learner has reached answering the question.
 _isWorkedThrough ($active_id, $question_id, $pass=NULL)
 Returns true if the question was worked through in the given pass.
 getMultilineAnswerSetting ()
 setMultilineAnswerSetting ($a_setting=0)
 _areAnswered ($a_user_id, $a_question_ids)
 Checks if an array of question ids is answered by an user or not.
 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)
 Sets the points, a learner has reached answering the question Additionally objective results are updated.
 getQuestion ()
 Gets the question text.
 setQuestion ($question="")
 Sets the question text.
 getQuestionTypeID ()
 Returns the question type of the question.
 saveFeedbackGeneric ($correctness, $feedback)
 Saves generic feedback to the database.
 getFeedbackGeneric ($correctness)
 Returns the generic feedback for a given question state.
 duplicateFeedbackGeneric ($original_id)
 Duplicates the generic feedback of a question.
 syncFeedbackGeneric ()
 cleanupMediaObjectUsage ()
 synchronises appearances of media objects in the question with media object usage table
& getInstances ()
 Gets all instances of the question.
 _needsManualScoring ($question_id)
 getActiveUserData ($active_id)
 Returns the user id and the test id for a given active id.
& _instanciateQuestionGUI ($question_id)
 Creates an instance of a question gui with a given question id.

Data Fields

 $answers
 $ordering_type
- Data Fields inherited from assQuestion
 $id
 $title
 $comment
 $owner
 $author
 $question
 $points
 $est_working_time
 $shuffle
 $test_id
 $obj_id
 $ilias
 $tpl
 $lng
 $domxml
 $outputType
 $suggested_solutions
 $original_id

Additional Inherited Members

- Static Public Member Functions inherited from assQuestion
static _includeClass ($question_type, $gui=0)
 Include the php class file for a given question type.
static _getQuestionTypeName ($type_tag)
 Return the translation for a given question type tag.
- Protected Member Functions inherited from assQuestion
 deletePageOfQuestion ($question_id)
 Deletes the page object of a question with a given ID.

Detailed Description

Class for ordering questions.

assOrderingQuestion is a class for ordering 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.assOrderingQuestion.php 17579 2008-10-02 21:43:23Z hschottm

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

Member Function Documentation

assOrderingQuestion::addAnswer (   $answertext = "",
  $points = 0.0,
  $order = 0,
  $solution_order = 0 
)

Adds an answer for an ordering question.

Adds an answer for an ordering choice question. The students have to fill in an order for the answer. The answer is an ASS_AnswerOrdering object that 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)
integer$orderA possible display order of the answer
integer$solution_orderAn unique integer value representing the correct order of that answer in the solution of a question public
See Also
$answers
ASS_AnswerOrdering

Definition at line 463 of file class.assOrderingQuestion.php.

References assQuestion\$points.

{
$found = -1;
foreach ($this->answers as $key => $value)
{
if ($value->getOrder() == $order)
{
$found = $order;
}
}
include_once "./Modules/TestQuestionPool/classes/class.assAnswerOrdering.php";
if ($found >= 0)
{
// Antwort einfügen
$answer = new ASS_AnswerOrdering($answertext, $points, $found, $solution_order);
array_push($this->answers, $answer);
for ($i = $found + 1; $i < count($this->answers); $i++)
{
$this->answers[$i] = $this->answers[$i-1];
}
$this->answers[$found] = $answer;
}
else
{
// Anwort anhängen
$answer = new ASS_AnswerOrdering($answertext, $points,
count($this->answers), $solution_order);
array_push($this->answers, $answer);
}
}
assOrderingQuestion::assOrderingQuestion (   $title = "",
  $comment = "",
  $author = "",
  $owner = -1,
  $question = "",
  $ordering_type = OQ_TERMS 
)

assOrderingQuestion constructor

The constructor takes possible arguments an creates an instance of the assOrderingQuestion 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 ordering test public

Definition at line 69 of file class.assOrderingQuestion.php.

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

{
$this->assQuestion($title, $comment, $author, $owner, $question);
$this->answers = array();
$this->ordering_type = $ordering_type;
}

+ Here is the call graph for this function:

assOrderingQuestion::calculateReachedPoints (   $active_id,
  $pass = NULL 
)

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

Returns the points, a learner has reached answering the question The points are calculated from the given answers including checks for all special scoring options in the test container.

Parameters
integer$user_idThe database ID of the learner
integer$test_idThe database Id of the test containing the question public

Definition at line 619 of file class.assOrderingQuestion.php.

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

{
global $ilDB;
$found_value1 = array();
$found_value2 = array();
if (is_null($pass))
{
$pass = $this->getSolutionMaxPass($active_id);
}
$query = sprintf("SELECT * FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
$ilDB->quote($active_id . ""),
$ilDB->quote($this->getId() . ""),
$ilDB->quote($pass . "")
);
$result = $ilDB->query($query);
$user_order = array();
while ($data = $result->fetchRow(MDB2_FETCHMODE_OBJECT))
{
if ((strcmp($data->value1, "") != 0) && (strcmp($data->value2, "") != 0))
{
$user_order[$data->value2] = $data->value1;
}
}
ksort($user_order);
$user_order = array_values($user_order);
$answer_order = array();
foreach ($this->answers as $key => $answer)
{
$answer_order[$answer->getSolutionOrder()] = $key;
}
ksort($answer_order);
$answer_order = array_values($answer_order);
$points = 0;
foreach ($answer_order as $index => $answer_id)
{
if (strcmp($user_order[$index], "") != 0)
{
if ($answer_id == $user_order[$index])
{
$points += $this->answers[$answer_id]->getPoints();
}
}
}
$points = parent::calculateReachedPoints($active_id, $pass = NULL, $points);
return $points;
}

+ Here is the call graph for this function:

assOrderingQuestion::checkSaveData ( )

Checks the data to be saved for consistency. 

  Checks the data to be saved for consistency
Returns
boolean True, if the check was ok, False otherwise public
See Also
$answers

Definition at line 739 of file class.assOrderingQuestion.php.

References $result, assQuestion\getOutputType(), OUTPUT_JAVASCRIPT, and ilUtil\sendInfo().

Referenced by saveWorkingData().

{
$result = true;
if ($this->getOutputType() == OUTPUT_JAVASCRIPT)
{
if (strlen($_POST["orderresult"]))
{
return $result;
}
}
$order_values = array();
foreach ($_POST as $key => $value)
{
if (preg_match("/^order_(\d+)/", $key, $matches))
{
if (strcmp($value, "") != 0)
{
array_push($order_values, $value);
}
}
}
$check_order = array_flip($order_values);
if (count($check_order) != count($order_values))
{
// duplicate order values!!!
$result = false;
ilUtil::sendInfo($this->lng->txt("duplicate_order_values_entered"), TRUE);
}
return $result;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assOrderingQuestion::copyImages (   $question_id,
  $source_questionpool 
)

Definition at line 397 of file class.assOrderingQuestion.php.

References $filename, assQuestion\getImagePath(), getOrderingType(), ilUtil\makeDirParents(), and OQ_PICTURES.

{
if ($this->getOrderingType() == OQ_PICTURES)
{
$imagepath = $this->getImagePath();
$imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
$imagepath_original = str_replace("/$this->obj_id/", "/$source_questionpool/", $imagepath_original);
if (!file_exists($imagepath)) {
ilUtil::makeDirParents($imagepath);
}
foreach ($this->answers as $answer)
{
$filename = $answer->getAnswertext();
if (!copy($imagepath_original . $filename, $imagepath . $filename)) {
print "image could not be copied!!!! ";
}
if (!copy($imagepath_original . $filename . ".thumb.jpg", $imagepath . $filename . ".thumb.jpg")) {
print "image thumbnail could not be copied!!!! ";
}
}
}
}

+ Here is the call graph for this function:

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

Copies an assOrderingQuestion object.

Copies an assOrderingQuestion object

public

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

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

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

+ Here is the call graph for this function:

assOrderingQuestion::deleteAnswer (   $index = 0)

Deletes an answer.

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 528 of file class.assOrderingQuestion.php.

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

Duplicates an assOrderingQuestion.

Duplicates an assOrderingQuestion

public

Definition at line 289 of file class.assOrderingQuestion.php.

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

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

+ Here is the call graph for this function:

assOrderingQuestion::duplicateImages (   $question_id)

Definition at line 375 of file class.assOrderingQuestion.php.

References $filename, assQuestion\getImagePath(), getOrderingType(), ilUtil\makeDirParents(), and OQ_PICTURES.

{
if ($this->getOrderingType() == OQ_PICTURES)
{
$imagepath = $this->getImagePath();
$imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
if (!file_exists($imagepath)) {
ilUtil::makeDirParents($imagepath);
}
foreach ($this->answers as $answer)
{
$filename = $answer->getAnswertext();
if (!copy($imagepath_original . $filename, $imagepath . $filename)) {
print "image could not be duplicated!!!! ";
}
if (!copy($imagepath_original . $filename . ".thumb.jpg", $imagepath . $filename . ".thumb.jpg")) {
print "image thumbnail could not be duplicated!!!! ";
}
}
}
}

+ Here is the call graph for this function:

assOrderingQuestion::flushAnswers ( )

Deletes all answers.

Deletes all answers

public

See Also
$answers

Definition at line 561 of file class.assOrderingQuestion.php.

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

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

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 906 of file class.assOrderingQuestion.php.

{
return "qpl_question_ordering";
}
assOrderingQuestion::getAnswer (   $index = 0)

Returns an ordering answer.

Returns an ordering 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_AnswerOrdering-Object public
See Also
$answers

Definition at line 510 of file class.assOrderingQuestion.php.

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

Returns the number of answers.

Returns the number of answers

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

Definition at line 575 of file class.assOrderingQuestion.php.

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

Returns the answers array.

Definition at line 942 of file class.assOrderingQuestion.php.

References $answers.

Referenced by setExportDetailsXLS().

{
return $this->answers;
}

+ Here is the caller graph for this function:

assOrderingQuestion::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns the name of the answer table in the database

Returns
string The answer table name public

Reimplemented from assQuestion.

Definition at line 919 of file class.assOrderingQuestion.php.

{
return "qpl_answer_ordering";
}
assOrderingQuestion::getMaximumPoints ( )

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

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

public

See Also
$points

Reimplemented from assQuestion.

Definition at line 676 of file class.assOrderingQuestion.php.

References assQuestion\$points.

Referenced by isComplete(), and saveToDb().

{
$points = 0;
foreach ($this->answers as $key => $value)
{
$points += $value->getPoints();
}
return $points;
}

+ Here is the caller graph for this function:

assOrderingQuestion::getMaxSolutionOrder ( )

Returns the maximum solution order.

Returns the maximum solution order of all ordering answers

Returns
integer The maximum solution order of all ordering answers public

Definition at line 588 of file class.assOrderingQuestion.php.

{
if (count($this->answers) == 0)
{
$max = 0;
}
else
{
$max = $this->answers[0]->getSolutionOrder();
}
foreach ($this->answers as $key => $value)
{
if ($value->getSolutionOrder() > $max)
{
$max = $value->getSolutionOrder();
}
}
return $max;
}
assOrderingQuestion::getOrderingType ( )

Returns the ordering question type.

Returns the ordering question type

Returns
integer The ordering question type public
See Also
$ordering_type

Definition at line 443 of file class.assOrderingQuestion.php.

References $ordering_type.

Referenced by copyImages(), and duplicateImages().

{
return $this->ordering_type;
}

+ Here is the caller graph for this function:

assOrderingQuestion::getQuestionType ( )

Returns the question type of the question.

Returns the question type of the question

Returns
integer The question type of the question public

Reimplemented from assQuestion.

Definition at line 893 of file class.assOrderingQuestion.php.

{
return "assOrderingQuestion";
}
assOrderingQuestion::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 928 of file class.assOrderingQuestion.php.

{
$text = parent::getRTETextWithMediaObjects();
foreach ($this->answers as $index => $answer)
{
$answer_obj = $this->answers[$index];
$text .= $answer_obj->getAnswertext();
}
return $text;
}
assOrderingQuestion::isComplete ( )

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

Returns true, if a ordering question is complete for use

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

Reimplemented from assQuestion.

Definition at line 91 of file class.assOrderingQuestion.php.

References getMaximumPoints().

Referenced by saveToDb().

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assOrderingQuestion::loadFromDb (   $question_id)

Loads a assOrderingQuestion object from a database.

Loads a assOrderingQuestion object from a database (experimental)

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

Reimplemented from assQuestion.

Definition at line 239 of file class.assOrderingQuestion.php.

References $data, $result, ilRTE\_replaceMediaObjectImageSrc(), and assQuestion\setEstimatedWorkingTime().

{
global $ilDB;
$query = sprintf("SELECT qpl_questions.*, qpl_question_ordering.* FROM qpl_questions, qpl_question_ordering WHERE question_id = %s AND qpl_questions.question_id = qpl_question_ordering.question_fi",
$ilDB->quote($question_id)
);
$result = $ilDB->query($query);
if ($result->numRows() == 1)
{
$data = $result->fetchRow(MDB2_FETCHMODE_OBJECT);
$this->id = $question_id;
$this->title = $data->title;
$this->obj_id = $data->obj_fi;
$this->comment = $data->comment;
$this->original_id = $data->original_id;
$this->author = $data->author;
$this->owner = $data->owner;
include_once("./Services/RTE/classes/class.ilRTE.php");
$this->question = ilRTE::_replaceMediaObjectImageSrc($data->question_text, 1);
$this->solution_hint = $data->solution_hint;
$this->ordering_type = $data->ordering_type;
$this->points = $data->points;
$this->setEstimatedWorkingTime(substr($data->working_time, 0, 2), substr($data->working_time, 3, 2), substr($data->working_time, 6, 2));
$query = sprintf("SELECT * FROM qpl_answer_ordering WHERE question_fi = %s ORDER BY aorder ASC",
$ilDB->quote($question_id)
);
$result = $ilDB->query($query);
include_once "./Modules/TestQuestionPool/classes/class.assAnswerOrdering.php";
if ($result->numRows() > 0)
{
while ($data = $result->fetchRow(MDB2_FETCHMODE_OBJECT))
{
include_once("./Services/RTE/classes/class.ilRTE.php");
$data->answertext = ilRTE::_replaceMediaObjectImageSrc($data->answertext, 1);
array_push($this->answers, new ASS_AnswerOrdering($data->answertext, $data->points, $data->aorder, $data->solution_order));
}
}
}
parent::loadFromDb($question_id);
}

+ Here is the call graph for this function:

assOrderingQuestion::pc_array_shuffle (   $array)

Definition at line 868 of file class.assOrderingQuestion.php.

{
mt_srand((double)microtime()*1000000);
$i = count($array);
while(--$i)
{
$j = mt_rand(0, $i);
if ($i != $j)
{
// swap elements
$tmp = $array[$j];
$array[$j] = $array[$i];
$array[$i] = $tmp;
}
}
return $array;
}
assOrderingQuestion::saveToDb (   $original_id = "")

Saves a assOrderingQuestion object to a database.

Saves a assOrderingQuestion object to a database (experimental)

Parameters
object$dbA pear DB object public

Reimplemented from assQuestion.

Definition at line 111 of file class.assOrderingQuestion.php.

References assQuestion\$ilias, assQuestion\$original_id, $result, ilRTE\_replaceMediaObjectImageSrc(), assQuestion\createPageObject(), assQuestion\getEstimatedWorkingTime(), getMaximumPoints(), assQuestion\getQuestionTypeID(), assQuestion\getTestId(), assQuestion\insertIntoTest(), and isComplete().

{
global $ilDB;
$complete = 0;
if ($this->isComplete())
{
$complete = 1;
}
$estw_time = $this->getEstimatedWorkingTime();
$estw_time = sprintf("%02d:%02d:%02d", $estw_time['h'], $estw_time['m'], $estw_time['s']);
if ($original_id)
{
$original_id = $ilDB->quote($original_id);
}
else
{
$original_id = "NULL";
}
include_once("./Services/RTE/classes/class.ilRTE.php");
if ($this->id == -1)
{
// Neuen Datensatz schreiben
$now = getdate();
$question_type = $this->getQuestionTypeID();
$created = sprintf("%04d%02d%02d%02d%02d%02d", $now['year'], $now['mon'], $now['mday'], $now['hours'], $now['minutes'], $now['seconds']);
$query = sprintf("INSERT INTO qpl_questions (question_id, question_type_fi, obj_fi, title, comment, author, owner, question_text, working_time, points, complete, created, original_id, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, NULL)",
$ilDB->quote($question_type . ""),
$ilDB->quote($this->obj_id . ""),
$ilDB->quote($this->title . ""),
$ilDB->quote($this->comment . ""),
$ilDB->quote($this->author . ""),
$ilDB->quote($this->owner . ""),
$ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($this->question, 0)),
$ilDB->quote($estw_time . ""),
$ilDB->quote($this->getMaximumPoints() . ""),
$ilDB->quote($complete . ""),
$ilDB->quote($created . ""),
$original_id
);
$result = $ilDB->query($query);
if (PEAR::isError($result))
{
global $ilias;
$ilias->raiseError($result->getMessage());
}
else
{
$this->id = $ilDB->getLastInsertId();
$query = sprintf("INSERT INTO qpl_question_ordering (question_fi, ordering_type) VALUES (%s, %s)",
$ilDB->quote($this->id . ""),
$ilDB->quote($this->ordering_type . "")
);
$ilDB->query($query);
// create page object of question
$this->createPageObject();
if ($this->getTestId() > 0)
{
$this->insertIntoTest($this->getTestId());
}
}
}
else
{
// Vorhandenen Datensatz aktualisieren
$query = sprintf("UPDATE qpl_questions SET obj_fi = %s, title = %s, comment = %s, author = %s, question_text = %s, working_time = %s, points = %s, complete = %s WHERE question_id = %s",
$ilDB->quote($this->obj_id. ""),
$ilDB->quote($this->title . ""),
$ilDB->quote($this->comment . ""),
$ilDB->quote($this->author . ""),
$ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($this->question, 0)),
$ilDB->quote($estw_time . ""),
$ilDB->quote($this->getMaximumPoints() . ""),
$ilDB->quote($complete . ""),
$ilDB->quote($this->id . "")
);
$result = $ilDB->query($query);
$query = sprintf("UPDATE qpl_question_ordering SET ordering_type = %s WHERE question_fi = %s",
$ilDB->quote($this->ordering_type . ""),
$ilDB->quote($this->id . "")
);
$result = $ilDB->query($query);
}
if (PEAR::isError($result))
{
global $ilias;
$ilias->raiseError($result->getMessage());
}
else
{
// Antworten schreiben
// alte Antworten löschen
$query = sprintf("DELETE FROM qpl_answer_ordering WHERE question_fi = %s",
$ilDB->quote($this->id)
);
$result = $ilDB->query($query);
// Anworten wegschreiben
foreach ($this->answers as $key => $value)
{
$answer_obj = $this->answers[$key];
$query = sprintf("INSERT INTO qpl_answer_ordering (answer_id, question_fi, answertext, points, aorder, solution_order) VALUES (NULL, %s, %s, %s, %s, %s)",
$ilDB->quote($this->id),
$ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($answer_obj->getAnswertext(), 0)),
$ilDB->quote($answer_obj->getPoints() . ""),
$ilDB->quote($answer_obj->getOrder() . ""),
$ilDB->quote($answer_obj->getSolutionOrder() . "")
);
$answer_result = $ilDB->query($query);
}
}
parent::saveToDb($original_id);
}

+ Here is the call graph for this function:

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

Saves the learners input of the question to the database. 

  Saves the learners input of the question to the database

  @param integer $test_id The database id of the test containing this question
Returns
boolean Indicates the save status (true if saved successful, false otherwise) public
See Also
$answers

Reimplemented from assQuestion.

Definition at line 780 of file class.assOrderingQuestion.php.

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

{
global $ilDB;
global $ilUser;
$saveWorkingDataResult = $this->checkSaveData();
$entered_values = 0;
if ($saveWorkingDataResult)
{
if (is_null($pass))
{
include_once "./Modules/Test/classes/class.ilObjTest.php";
$pass = ilObjTest::_getPass($active_id);
}
$query = sprintf("DELETE FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
$ilDB->quote($active_id . ""),
$ilDB->quote($this->getId() . ""),
$ilDB->quote($pass . "")
);
$result = $ilDB->query($query);
if (array_key_exists("orderresult", $_POST))
{
$orderresult = $_POST["orderresult"];
if (strlen($orderresult))
{
$orderarray = explode(":", $orderresult);
$ordervalue = 1;
foreach ($orderarray as $index)
{
$query = sprintf("INSERT INTO tst_solutions (solution_id, active_fi, question_fi, value1, value2, pass, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, NULL)",
$ilDB->quote($active_id . ""),
$ilDB->quote($this->getId() . ""),
$ilDB->quote(trim($index) . ""),
$ilDB->quote(trim($ordervalue) . ""),
$ilDB->quote($pass . "")
);
$result = $ilDB->query($query);
$ordervalue++;
$entered_values++;
}
}
}
else
{
foreach ($_POST as $key => $value)
{
if (preg_match("/^order_(\d+)/", $key, $matches))
{
if (!(preg_match("/initial_value_\d+/", $value)))
{
if (strlen($value))
{
$query = sprintf("INSERT INTO tst_solutions (solution_id, active_fi, question_fi, value1, value2, pass, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, NULL)",
$ilDB->quote($active_id . ""),
$ilDB->quote($this->getId() . ""),
$ilDB->quote($matches[1] . ""),
$ilDB->quote($value . ""),
$ilDB->quote($pass . "")
);
$result = $ilDB->query($query);
$entered_values++;
}
}
}
}
}
}
if ($entered_values)
{
include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
if (ilObjAssessmentFolder::_enabledAssessmentLogging())
{
$this->logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
}
}
else
{
include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
if (ilObjAssessmentFolder::_enabledAssessmentLogging())
{
$this->logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
}
}
parent::saveWorkingData($active_id, $pass);
return $saveWorkingDataResult;
}

+ Here is the call graph for this function:

assOrderingQuestion::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 972 of file class.assOrderingQuestion.php.

References $answers, $pass, ilExcelUtils\_convert_text(), getAnswers(), assQuestion\getSolutionValues(), and assQuestion\getTitle().

{
include_once ("./classes/class.ilExcelUtils.php");
$solutions = $this->getSolutionValues($active_id, $pass);
$sol = array();
foreach ($solutions as $solution)
{
$sol[$solution["value1"]] = $solution["value2"];
}
asort($sol);
$sol = array_keys($sol);
$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;
$answers = $this->getAnswers();
foreach ($sol as $idx)
{
foreach ($solutions as $solution)
{
if ($solution["value1"] == $idx) $worksheet->writeString($startrow + $i, 0, ilExcelUtils::_convert_text($solution["value2"]));
}
$worksheet->writeString($startrow + $i, 1, ilExcelUtils::_convert_text($answers[$idx]->getAnswertext()));
$i++;
}
return $startrow + $i + 1;
}

+ Here is the call graph for this function:

assOrderingQuestion::setImageFile (   $image_filename,
  $image_tempfilename = "" 
)

Sets the image file.

Sets the image file and uploads the image to the object's image directory.

Parameters
string$image_filenameName of the original image file
string$image_tempfilenameName of the temporary uploaded image file
Returns
integer An errorcode if the image upload fails, 0 otherwise public

Definition at line 696 of file class.assOrderingQuestion.php.

References $result, ilUtil\convertImage(), assQuestion\getImagePath(), ilObjMediaObject\getMimeType(), ilUtil\makeDirParents(), and ilUtil\moveUploadedFile().

{
$result = 0;
if (!empty($image_tempfilename))
{
$imagepath = $this->getImagePath();
if (!file_exists($imagepath))
{
ilUtil::makeDirParents($imagepath);
}
if (!ilUtil::moveUploadedFile($image_tempfilename,$image_filename, $imagepath.$image_filename))
{
$result = 2;
}
else
{
include_once "./Services/MediaObjects/classes/class.ilObjMediaObject.php";
$mimetype = ilObjMediaObject::getMimeType($imagepath . $image_filename);
if (!preg_match("/^image/", $mimetype))
{
unlink($imagepath . $image_filename);
$result = 1;
}
else
{
// create thumbnail file
$thumbpath = $imagepath . $image_filename . "." . "thumb.jpg";
ilUtil::convertImage($imagepath.$image_filename, $thumbpath, strtoupper($extension), 100);
}
}
}
return $result;
}

+ Here is the call graph for this function:

assOrderingQuestion::setOrderingType (   $ordering_type = OQ_TERMS)

Sets the ordering question type.

Sets the ordering question type

Parameters
integer$ordering_typeThe question ordering type public
See Also
$ordering_type

Definition at line 429 of file class.assOrderingQuestion.php.

References $ordering_type.

{
$this->ordering_type = $ordering_type;
}
assOrderingQuestion::supportsJavascriptOutput ( )

Returns true if the question type supports JavaScript output.

Returns true if the question type supports JavaScript output

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

Reimplemented from assQuestion.

Definition at line 955 of file class.assOrderingQuestion.php.

{
return TRUE;
}

Field Documentation

assOrderingQuestion::$answers

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

Referenced by getAnswers(), and setExportDetailsXLS().

assOrderingQuestion::$ordering_type

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

Referenced by assOrderingQuestion(), getOrderingType(), and setOrderingType().

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