ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
assOrderingHorizontal Class Reference
Modules/TestQuestionPool

Class for horizontal ordering questions. More...

+ Inheritance diagram for assOrderingHorizontal:
+ Collaboration diagram for assOrderingHorizontal:

Public Member Functions

 __construct ($title="", $comment="", $author="", $owner=-1, $question="")
 assOrderingHorizontal constructor
 isComplete ()
 Returns true, if a single choice question is complete for use.
 saveToDb ($original_id="")
 Saves a assOrderingHorizontal object to a database.
 loadFromDb ($question_id)
 Loads a assOrderingHorizontal object from a database.
 duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
 Duplicates an assOrderingHorizontal.
 copyObject ($target_questionpool, $title="")
 Copies an assOrderingHorizontal object.
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question.
 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.
 moveRight ($position, $active_id, $pass=null)
 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.
 getOrderingElements ()
 Get ordering elements from order text.
 getRandomOrderingElements ()
 Get ordering elements from order text in random sequence.
 getOrderText ()
 Get order text.
 setOrderText ($a_value)
 Set order text.
 getTextSize ()
 Get text size.
 setTextSize ($a_value)
 Set text size.
 getSeparator ()
 Get order text separator.
 setSeparator ($a_value)
 Set order text separator.
 __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.
 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
 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.
 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.
 getFeedbackSingleAnswer ($answer_index)
 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.
 isAnswered ($active_id, $pass=null)
 returns boolean wether the question is answered during test pass or not
 setObligationsToBeConsidered ($obligationsToBeConsidered=true)
 sets the flag wether obligations are to be considered or not
 areObligationsToBeConsidered ()
 gets the flag wether obligations are to be considered or not
 isAutosaveable ()
 getHtmlUserSolutionPurifier ()

Protected Member Functions

 reworkWorkingData ($active_id, $pass, $obligationsAnswered)
 Reworks the allready saved working data if neccessary.
- Protected Member Functions inherited from assQuestion
 deletePageOfQuestion ($question_id)
 Deletes the page object of a question with a given ID.
 onDuplicate ($originalParentId, $originalQuestionId, $duplicateParentId, $duplicateQuestionId)
 Will be called when a question is duplicated (inside a question pool or for insertion in a test)
 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)
 deleteFeedbackSpecific ($question_id)

Protected Attributes

 $ordertext
 $textsize
 $separator = "::"
 $answer_separator = '{::}'
- 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

Private Member Functions

 splitAndTrimOrderElementText ($in_string, $separator)
 Splits the answer string either by space(s) or the separator (eg.

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 _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.
static isObligationPossible ($questionId)
 returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration
- Static Protected Member Functions inherited from assQuestion
static doesSolutionRecordsExist ($activeId, $pass, $questionId)
 checks wether there are existing solution records for the given test active / pass and given question id

Detailed Description

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

Definition at line 19 of file class.assOrderingHorizontal.php.

Constructor & Destructor Documentation

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

assOrderingHorizontal 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 38 of file class.assOrderingHorizontal.php.

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

{
parent::__construct($title, $comment, $author, $owner, $question);
$this->ordertext = "";
}

Member Function Documentation

assOrderingHorizontal::__get (   $value)

Object getter.

Reimplemented from assQuestion.

Definition at line 660 of file class.assOrderingHorizontal.php.

References getOrderText(), getSeparator(), and getTextSize().

{
switch ($value)
{
case "ordertext":
return $this->getOrderText();
break;
case "textsize":
return $this->getTextSize();
break;
case "separator":
return $this->getSeparator();
break;
default:
return parent::__get($value);
break;
}
}

+ Here is the call graph for this function:

assOrderingHorizontal::__set (   $key,
  $value 
)

Object setter.

Reimplemented from assQuestion.

Definition at line 682 of file class.assOrderingHorizontal.php.

References setOrderText(), setSeparator(), and setTextSize().

{
switch ($key)
{
case "ordertext":
$this->setOrderText($value);
break;
case "textsize":
$this->setTextSize($value);
break;
case "separator":
$this->setSeparator($value);
break;
default:
parent::__set($key, $value);
break;
}
}

+ Here is the call graph for this function:

assOrderingHorizontal::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 249 of file class.assOrderingHorizontal.php.

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

Referenced by moveRight().

{
if( $returndetails )
{
throw new ilTestException('return details not implemented for '.__METHOD__);
}
global $ilDB;
$found_values = array();
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)
);
$points = 0;
$data = $ilDB->fetchAssoc($result);
$data["value1"] = $this->splitAndTrimOrderElementText($data["value1"], $this->answer_separator);
$data['value1'] = join($data['value1'], $this->answer_separator);
if (strcmp($data["value1"], join($this->getOrderingElements(), $this->answer_separator)) == 0)
{
$points = $this->getPoints();
}
return $points;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Copies an assOrderingHorizontal object.

Definition at line 197 of file class.assOrderingHorizontal.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->duplicateGenericFeedback($original_id);
$clone->onCopy($this->getObjId(), $this->getId());
return $clone->id;
}

+ Here is the call graph for this function:

assOrderingHorizontal::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 489 of file class.assOrderingHorizontal.php.

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

Duplicates an assOrderingHorizontal.

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

+ Here is the call graph for this function:

assOrderingHorizontal::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 541 of file class.assOrderingHorizontal.php.

{
include_once "./Modules/TestQuestionPool/classes/import/qti12/class.assOrderingHorizontalImport.php";
$import = new assOrderingHorizontalImport($this);
$import->fromXML($item, $questionpool_id, $tst_id, $tst_object, $question_counter, $import_mapping);
}
assOrderingHorizontal::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 469 of file class.assOrderingHorizontal.php.

Referenced by loadFromDb(), and saveToDb().

{
return "qpl_qst_horder";
}

+ Here is the caller graph for this function:

assOrderingHorizontal::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns
string The answer table name

Reimplemented from assQuestion.

Definition at line 479 of file class.assOrderingHorizontal.php.

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

{
$user_solution = array();
return $user_solution;
}
assOrderingHorizontal::getMaximumPoints ( )

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

See Also
$points

Reimplemented from assQuestion.

Definition at line 234 of file class.assOrderingHorizontal.php.

References assQuestion\getPoints().

Referenced by isComplete().

{
return $this->getPoints();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assOrderingHorizontal::getOrderingElements ( )

Get ordering elements from order text.

Returns
array Ordering elements

Definition at line 577 of file class.assOrderingHorizontal.php.

References getOrderText(), and splitAndTrimOrderElementText().

Referenced by calculateReachedPoints(), getRandomOrderingElements(), and toJSON().

{
return $this->splitAndTrimOrderElementText($this->getOrderText(), $this->separator);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assOrderingHorizontal::getOrderText ( )

Get order text.

Returns
string Order text

Definition at line 599 of file class.assOrderingHorizontal.php.

References $ordertext.

Referenced by __get(), getOrderingElements(), and saveToDb().

{
return $this->ordertext;
}

+ Here is the caller graph for this function:

assOrderingHorizontal::getQuestionType ( )

Returns the question type of the question.

Returns
integer The question type of the question

Reimplemented from assQuestion.

Definition at line 459 of file class.assOrderingHorizontal.php.

Referenced by toJSON().

{
return "assOrderingHorizontal";
}

+ Here is the caller graph for this function:

assOrderingHorizontal::getRandomOrderingElements ( )

Get ordering elements from order text in random sequence.

Returns
array Ordering elements

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

References getOrderingElements().

{
$elements = $this->getOrderingElements();
shuffle($elements);
return $elements;
}

+ Here is the call graph for this function:

assOrderingHorizontal::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 497 of file class.assOrderingHorizontal.php.

{
$text = parent::getRTETextWithMediaObjects();
return $text;
}
assOrderingHorizontal::getSeparator ( )

Get order text separator.

Returns
string Separator

Definition at line 642 of file class.assOrderingHorizontal.php.

References $separator.

Referenced by __get().

{
return $this->separator;
}

+ Here is the caller graph for this function:

assOrderingHorizontal::getTextSize ( )

Get text size.

Returns
double Text size in percent

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

References $textsize.

Referenced by __get(), and saveToDb().

{
return $this->textsize;
}

+ Here is the caller graph for this function:

assOrderingHorizontal::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 55 of file class.assOrderingHorizontal.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:

assOrderingHorizontal::loadFromDb (   $question_id)

Loads a assOrderingHorizontal object from a 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 101 of file class.assOrderingHorizontal.php.

References $data, $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), assQuestion\setNrOfTries(), assQuestion\setObjId(), setOrderText(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), 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->setOrderText($data["ordertext"]);
$this->setTextSize($data["textsize"]);
$this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
}
parent::loadFromDb($question_id);
}

+ Here is the call graph for this function:

assOrderingHorizontal::moveRight (   $position,
  $active_id,
  $pass = null 
)

Definition at line 387 of file class.assOrderingHorizontal.php.

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

{
global $ilDB;
global $ilUser;
if (is_null($pass))
{
include_once "./Modules/Test/classes/class.ilObjTest.php";
$pass = ilObjTest::_getPass($active_id);
}
$solutions =& $this->getSolutionValues($active_id, $pass);
$elements = array();
if (count($solutions) == 1)
{
$elements = split("{::}", $solutions[0]["value1"]);
}
else
{
$elements = $_SESSION['qst_ordering_horizontal_elements'];
}
if (count($elements))
{
$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)
);
if ($position < count($elements)-1)
{
$temp = $elements[$position];
$elements[$position] = $elements[$position+1];
$elements[$position+1] = $temp;
}
$entered_values = false;
$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", join($elements, '{::}')),
"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());
}
}
$this->calculateReachedPoints($active_id, $pass);
}
}

+ Here is the call graph for this function:

assOrderingHorizontal::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 379 of file class.assOrderingHorizontal.php.

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

Saves a assOrderingHorizontal object to a database.

Reimplemented from assQuestion.

Definition at line 71 of file class.assOrderingHorizontal.php.

References assQuestion\$original_id, getAdditionalTableName(), assQuestion\getId(), getOrderText(), 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, ordertext, textsize) VALUES (%s, %s, %s)",
array("integer", "text", "float"),
array(
$this->getId(),
$this->getOrderText(),
($this->getTextSize() < 10) ? NULL : $this->getTextSize()
)
);
parent::saveToDb();
}

+ Here is the call graph for this function:

assOrderingHorizontal::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 320 of file class.assOrderingHorizontal.php.

References $_POST, $ilUser, $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["orderresult"]))
{
$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", $_POST['orderresult']),
"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());
}
}
return true;
}

+ Here is the call graph for this function:

assOrderingHorizontal::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 514 of file class.assOrderingHorizontal.php.

References $pass, ilExcelUtils\_convert_text(), 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);
$solutionvalue = "";
$solutions =& $this->getSolutionValues($active_id, $pass);
$solutionvalue = str_replace("{::}", " ", $solutions[0]["value1"]);
$i = 1;
$worksheet->writeString($startrow+$i, 0, ilExcelUtils::_convert_text($solutionvalue));
$i++;
return $startrow + $i + 1;
}

+ Here is the call graph for this function:

assOrderingHorizontal::setOrderText (   $a_value)

Set order text.

Parameters
string$a_valueOrder text

Definition at line 609 of file class.assOrderingHorizontal.php.

Referenced by __set(), and loadFromDb().

{
$this->ordertext = $a_value;
}

+ Here is the caller graph for this function:

assOrderingHorizontal::setSeparator (   $a_value)

Set order text separator.

Parameters
string$a_valueSeparator

Definition at line 652 of file class.assOrderingHorizontal.php.

Referenced by __set().

{
$this->separator = $a_value;
}

+ Here is the caller graph for this function:

assOrderingHorizontal::setTextSize (   $a_value)

Set text size.

Parameters
double$a_valueText size in percent

Definition at line 629 of file class.assOrderingHorizontal.php.

Referenced by __set(), and loadFromDb().

{
if ($a_value >= 10)
{
$this->textsize = $a_value;
}
}

+ Here is the caller graph for this function:

assOrderingHorizontal::splitAndTrimOrderElementText (   $in_string,
  $separator 
)
private

Splits the answer string either by space(s) or the separator (eg.

::) and trims the resulting array elements.

Parameters
string$in_stringOrderElements
string$separatorto be used for splitting.
Returns
array

Definition at line 290 of file class.assOrderingHorizontal.php.

References $result, $separator, and ilStr\strPos().

Referenced by calculateReachedPoints(), and getOrderingElements().

{
$result = array();
include_once "./Services/Utilities/classes/class.ilStr.php";
if (ilStr::strPos($in_string, $separator) === false)
{
$result = preg_split("/\\s+/", $in_string);
}
else
{
$result = split($separator, $in_string);
}
foreach ($result as $key => $value)
{
$result[$key] = trim($value);
}
return $result;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assOrderingHorizontal::toJSON ( )

Returns a JSON representation of the question.

Definition at line 704 of file class.assOrderingHorizontal.php.

References $mobs, $result, ilObjMediaObject\_getMobsOfObject(), ilRTE\_replaceMediaObjectImageSrc(), assQuestion\formatSAQuestion(), assQuestion\getFeedbackGeneric(), assQuestion\getId(), assQuestion\getNrOfTries(), getOrderingElements(), assQuestion\getPoints(), assQuestion\getQuestion(), getQuestionType(), 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) true;
$result['points'] = (bool) $this->getPoints();
$result['feedback'] = array(
"onenotcorrect" => nl2br(ilRTE::_replaceMediaObjectImageSrc($this->getFeedbackGeneric(0), 0)),
"allcorrect" => nl2br(ilRTE::_replaceMediaObjectImageSrc($this->getFeedbackGeneric(1), 0))
);
$arr = array();
foreach ($this->getOrderingElements() as $order => $answer)
{
array_push($arr, array(
"answertext" => (string) $answer,
"order" => (int) $order+1
));
}
$result['answers'] = $arr;
$mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
$result['mobs'] = $mobs;
return json_encode($result);
}

+ Here is the call graph for this function:

assOrderingHorizontal::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 554 of file class.assOrderingHorizontal.php.

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

Field Documentation

assOrderingHorizontal::$answer_separator = '{::}'
protected

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

assOrderingHorizontal::$ordertext
protected

Definition at line 21 of file class.assOrderingHorizontal.php.

Referenced by getOrderText().

assOrderingHorizontal::$separator = "::"
protected

Definition at line 23 of file class.assOrderingHorizontal.php.

Referenced by getSeparator(), and splitAndTrimOrderElementText().

assOrderingHorizontal::$textsize
protected

Definition at line 22 of file class.assOrderingHorizontal.php.

Referenced by getTextSize().

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