ILIAS  Release_4_1_x_branch Revision 61804
 All Data Structures Namespaces Files Functions Variables Groups Pages
assOrderingQuestion Class Reference

Class for ordering questions. More...

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

Public Member Functions

 __construct ($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="", $solution_order=-1)
 Adds an answer for an ordering choice question.
 moveAnswerUp ($position)
 moveAnswerDown ($position)
 getAnswer ($index=0)
 Returns an ordering answer with a given index.
 deleteAnswer ($index=0)
 Deletes an answer with a given index.
 flushAnswers ()
 Deletes all answers.
 getAnswerCount ()
 Returns the number of answers.
 getMaxSolutionOrder ()
 Returns the maximum solution order of all ordering answers.
 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.
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question.
 getEncryptedFilename ($filename)
 deleteImagefile ($filename)
 setImageFile ($image_tempfilename, $image_filename, $previous_filename)
 Sets the image file and uploads the image to the object's image directory.
 checkSaveData ()
 Checks the data to be saved for consistency.
 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.
 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.
 getThumbGeometry ()
 getThumbSize ()
 setThumbGeometry ($a_geometry)
 getElementHeight ()
 setElementHeight ($a_height)
 rebuildThumbnails ()
 getThumbPrefix ()
 toJSON ()
 Returns a JSON representation of the question.
 removeAnswerImage ($index)
- Public Member Functions inherited from assQuestion
 __construct ($title="", $comment="", $author="", $owner=-1, $question="")
 assQuestion constructor
 fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
 Receives parameters from a QTI parser and creates a valid ILIAS question object.
 toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $force_image_references=false)
 Returns a QTI xml representation of the question.
 questionTitleExists ($questionpool_id, $title)
 Returns TRUE if the question title exists in the database.
 setTitle ($title="")
 Sets the title string of the assQuestion object.
 setId ($id=-1)
 Sets the id of the assQuestion object.
 setTestId ($id=-1)
 Sets the test id of the assQuestion object.
 setComment ($comment="")
 Sets the comment string of the assQuestion object.
 setOutputType ($outputType=OUTPUT_HTML)
 Sets the output type.
 setShuffle ($shuffle=true)
 Sets the shuffle flag.
 setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)
 Sets the estimated working time of a question.
 keyInArray ($searchkey, $array)
 returns TRUE if the key occurs in an array
 setAuthor ($author="")
 Sets the authors name of the assQuestion object.
 setOwner ($owner="")
 Sets the creator/owner ID of the assQuestion object.
 getTitle ()
 Gets the title string of the assQuestion object.
 getId ()
 Gets the id of the assQuestion object.
 getShuffle ()
 Gets the shuffle flag.
 getTestId ()
 Gets the test id of the assQuestion object.
 getComment ()
 Gets the comment string of the assQuestion object.
 getOutputType ()
 Gets the output type.
 getEstimatedWorkingTime ()
 Gets the estimated working time of a question.
 getAuthor ()
 Gets the authors name of the assQuestion object.
 getOwner ()
 Gets the creator/owner ID of the assQuestion object.
 getObjId ()
 Get the object id of the container object.
 setObjId ($obj_id=0)
 Set the object id of the container object.
 _getMaximumPoints ($question_id)
 Returns the maximum points, a learner can reach answering the question.
_getQuestionInfo ($question_id)
 Returns question information from the database.
 getSuggestedSolutionOutput ()
_getSuggestedSolution ($question_id, $subquestion_index=0)
 Returns a suggested solution for a given subquestion index.
 getSuggestedSolutions ()
 Return the suggested solutions.
 _getReachedPoints ($active_id, $question_id, $pass=NULL)
 Returns the points, a learner has reached answering the question.
 getReachedPoints ($active_id, $pass=NULL)
 Returns the points, a learner has reached answering the question This is the fast way to get the points directly from the database.
 calculateResultsFromSolution ($active_id, $pass=NULL)
 Calculates the question results from a previously saved question solution.
 _updateTestResultCache ($active_id)
 _updateTestPassResults ($active_id, $pass)
 logAction ($logtext="", $active_id="", $question_id="")
 Logs an action into the Test&Assessment log.
 _logAction ($logtext="", $active_id="", $question_id="")
 Logs an action into the Test&Assessment log.
 moveUploadedMediaFile ($file, $name)
 Move an uploaded media file to an public accessible temp dir to present it.
 getSuggestedSolutionPath ()
 Returns the path for a suggested solution.
 getJavaPath ()
 Returns the image path for web accessable images of a question.
 getImagePath ()
 Returns the image path for web accessable images of a question.
 getFlashPath ()
 Returns the image path for web accessable flash files of a question.
 getJavaPathWeb ()
 Returns the web image path for web accessable java applets of a question.
 getSuggestedSolutionPathWeb ()
 Returns the web path for a suggested solution.
 getImagePathWeb ()
 Returns the web image path for web accessable images of a question.
 getFlashPathWeb ()
 Returns the web image path for web accessable flash applications of a question.
getSolutionValues ($active_id, $pass=NULL)
 Loads solutions of a given user from the database an returns it.
 isInUse ($question_id="")
 Checks whether the question is in use or not.
 isClone ($question_id="")
 Checks whether the question is a clone of another question or not.
 pcArrayShuffle ($array)
 Shuffles the values of a given array.
 getQuestionTypeFromDb ($question_id)
 get question type for question id
 deleteAnswers ($question_id)
 Deletes datasets from answers tables.
 deleteAdditionalTableData ($question_id)
 Deletes datasets from the additional question table in the database.
 delete ($question_id)
 Deletes a question and all materials from the database.
 getTotalAnswers ()
 get total number of answers
 _getTotalAnswers ($a_q_id)
 get number of answers for question id (static) note: do not use $this inside this method
 _getTotalRightAnswers ($a_q_id)
 get number of answers for question id (static) note: do not use $this inside this method
 _getTitle ($a_q_id)
 Returns the title of a question.
 _getQuestionText ($a_q_id)
 Returns question text.
 copyXHTMLMediaObjectsOfQuestion ($a_q_id)
 syncXHTMLMediaObjectsOfQuestion ()
 createPageObject ()
 create page object of question
 copyPageOfQuestion ($a_q_id)
 getPageOfQuestion ()
 _getQuestionType ($question_id)
 Returns the question type of a question with a given id.
 _getQuestionTitle ($question_id)
 Returns the question title of a question with a given id.
 setOriginalId ($original_id)
 getOriginalId ()
 createNewQuestion ()
 Creates a new question without an owner when a new question is created This assures that an ID is given to the question if a file upload or something else occurs.
 saveQuestionDataToDb ($original_id="")
 deleteSuggestedSolutions ()
 Deletes all suggestes solutions in the database.
 getSuggestedSolution ($subquestion_index=0)
 Returns a suggested solution for a given subquestion index.
 getSuggestedSolutionTitle ($subquestion_index=0)
 Returns the title of a suggested solution at a given subquestion_index.
 setSuggestedSolution ($solution_id="", $subquestion_index=0, $is_import=false)
 Sets a suggested solution for the question.
 updateSuggestedSolutions ($original_id="")
 Update the suggested solutions of a question based on the suggested solution array attribute.
 saveSuggestedSolution ($type, $solution_id="", $subquestion_index=0, $value="")
 Saves a suggested solution for the question.
 _resolveInternalLink ($internal_link)
 _resolveIntLinks ($question_id)
 _getInternalLinkHref ($target="")
 _getOriginalId ($question_id)
 Returns the original id of a question.
 syncWithOriginal ()
 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 The points are calculated from the given answers including checks for all special scoring options in the test container.
 isHTML ($a_text)
 Checks if a given string contains HTML or not.
 prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
 Prepares a string for a text area output in tests.
 QTIMaterialToString ($a_material)
 Reads an QTI material tag an creates a text string.
 addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE)
 Creates a QTI material tag from a plain text or xhtml text.
 createNewImageFileName ($image_filename)
 _setReachedPoints ($active_id, $question_id, $points, $maxpoints, $pass=NULL, $manualscoring=FALSE)
 Sets the points, a learner has reached answering the question Additionally objective results are updated.
 getQuestion ()
 Gets the question string of the question object.
 setQuestion ($question="")
 Sets the question string of the question object.
 getQuestionTypeID ()
 Returns the question type of the question.
 saveFeedbackGeneric ($correctness, $feedback)
 Saves generic feedback to the database.
 getFeedbackGeneric ($correctness)
 Returns the generic feedback for a given question state.
 duplicateFeedbackGeneric ($original_id)
 Duplicates the generic feedback of a question.
 syncFeedbackGeneric ()
 cleanupMediaObjectUsage ()
 synchronises appearances of media objects in the question with media object usage table
getInstances ()
 Gets all instances of the question.
 _needsManualScoring ($question_id)
 getActiveUserData ($active_id)
 Returns the user id and the test id for a given active id.
_instanciateQuestionGUI ($question_id)
 Creates an instance of a question gui with a given question id.
 __get ($value)
 Object getter.
 __set ($key, $value)
 Object setter.
 getNrOfTries ()
 setNrOfTries ($a_nr_of_tries)

Data Fields

 $answers
 $ordering_type
 $thumb_geometry = 100
 $element_height

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from assQuestion
static _getSuggestedSolutionCount ($question_id)
 Returns the number of suggested solutions associated with a question.
static _getSuggestedSolutionOutput ($question_id)
 Returns the output of the suggested solution.
static _isWorkedThrough ($active_id, $question_id, $pass=NULL)
 Returns true if the question was worked through in the given pass Worked through means that the user entered at least one value.
static _areAnswered ($a_user_id, $a_question_ids)
 Checks if an array of question ids is answered by an user or not.
static _includeClass ($question_type, $gui=0)
 Include the php class file for a given question type.
static _getQuestionTypeName ($type_tag)
 Return the translation for a given question type tag.
- Protected Attributes inherited from assQuestion
 $id
 $title
 $comment
 $owner
 $author
 $question
 $points
 $est_working_time
 $shuffle
 $test_id
 $obj_id
 $ilias
 $tpl
 $lng
 $outputType
 $suggested_solutions
 $original_id
 $page

Detailed Description

Class for 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 26654 2010-11-21 14:11:48Z hschottm

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

Constructor & Destructor Documentation

assOrderingQuestion::__construct (   $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 83 of file class.assOrderingQuestion.php.

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

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

Member Function Documentation

assOrderingQuestion::addAnswer (   $answertext = "",
  $solution_order = -1 
)

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

References getRandomID().

{
include_once "./Modules/TestQuestionPool/classes/class.assAnswerOrdering.php";
$answer = new ASS_AnswerOrdering($answertext, $this->getRandomID());
if (($solution_order >= 0) && ($solution_order < count($this->answers)))
{
$part1 = array_slice($this->answers, 0, $solution_order);
$part2 = array_slice($this->answers, $solution_order);
$this->answers = array_merge($part1, array($answer), $part2);
}
else
{
array_push($this->answers, $answer);
}
}

+ Here is the call graph for this function:

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

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

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

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

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

{
global $ilDB;
$found_value1 = array();
$found_value2 = 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)
);
$user_order = array();
while ($data = $ilDB->fetchAssoc($result))
{
if ((strcmp($data["value1"], "") != 0) && (strcmp($data["value2"], "") != 0))
{
$user_order[$data["value2"]] = $data["value1"];
}
}
ksort($user_order);
$user_order = array_values($user_order);
$points = 0;
$correctcount = 0;
foreach ($this->answers as $index => $answer)
{
if ($index == $user_order[$index])
{
$correctcount++;
}
}
if ($correctcount == count($this->answers))
{
$points = $this->getPoints();
}
return $points;
}

+ Here is the call graph for this function:

assOrderingQuestion::checkSaveData ( )

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

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

Referenced by saveWorkingData().

{
$result = true;
{
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::cleanImagefiles ( )
protected

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

References ilUtil\delDir(), getAnswers(), ilUtil\getDir(), assQuestion\getImagePath(), getOrderingType(), getThumbPrefix(), and OQ_PICTURES.

Referenced by saveToDb().

{
if ($this->getOrderingType() == OQ_PICTURES)
{
if (@file_exists($this->getImagePath()))
{
$contents = ilUtil::getDir($this->getImagePath());
foreach ($contents as $f)
{
if (strcmp($f['type'], 'file') == 0)
{
$found = false;
foreach ($this->getAnswers() as $answer)
{
if (strcmp($f['entry'], $answer->getAnswertext()) == 0) $found = true;
if (strcmp($f['entry'], $this->getThumbPrefix() . $answer->getAnswertext()) == 0) $found = true;
}
if (!$found)
{
if (@file_exists($this->getImagePath() . $f['entry'])) @unlink($this->getImagePath() . $f['entry']);
}
}
}
}
}
else
{
if (@file_exists($this->getImagePath()))
{
}
}
}

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

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

{
global $ilLog;
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)) {
}
foreach ($this->answers as $answer)
{
$filename = $answer->getAnswertext();
if (!@copy($imagepath_original . $filename, $imagepath . $filename))
{
$ilLog->write("Ordering Question image could not be copied: $imagepath_original$filename");
}
if (@file_exists($imagepath_original. $this->getThumbPrefix(). $filename))
{
if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename))
{
$ilLog->write("Ordering Question image thumbnail could not be copied: $imagepath_original" . $this->getThumbPrefix() . $filename);
}
}
}
}
}

+ Here is the call graph for this function:

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

Copies an assOrderingQuestion object.

public

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

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

{
if ($this->id <= 0)
{
// The question has not been saved. It cannot be duplicated
return;
}
// duplicate the question in database
$clone = $this;
include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
$clone->id = -1;
$source_questionpool = $this->getObjId();
$clone->setObjId($target_questionpool);
if ($title)
{
$clone->setTitle($title);
}
$clone->saveToDb();
// copy question page content
$clone->copyPageOfQuestion($original_id);
// copy XHTML media objects
$clone->copyXHTMLMediaObjectsOfQuestion($original_id);
// duplicate the generic feedback
$clone->duplicateFeedbackGeneric($original_id);
// duplicate the image
$clone->copyImages($original_id, $source_questionpool);
$clone->onCopy($this->getObjId(), $this->getId());
return $clone->id;
}

+ Here is the call graph for this function:

assOrderingQuestion::deleteAnswer (   $index = 0)

Deletes an answer with a given index.

The index of the first answer is 0, the index of the second answer is 1 and so on.

Parameters
integer$indexA nonnegative index of the n-th answer public
See Also
$answers

Definition at line 497 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::deleteImagefile (   $filename)

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

References $filename, $result, assQuestion\getImagePath(), and getThumbPrefix().

Referenced by removeAnswerImage(), and setImageFile().

{
$deletename = $$filename;
$result = @unlink($this->getImagePath().$deletename);
$result = $result & @unlink($this->getImagePath().$this->getThumbPrefix() . $deletename);
return $result;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assOrderingQuestion::duplicate (   $for_test = true,
  $title = "",
  $author = "",
  $owner = "" 
)

Duplicates an assOrderingQuestion.

public

Definition at line 234 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");
$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);
$clone->onDuplicate($this_id);
return $clone->id;
}

+ Here is the call graph for this function:

assOrderingQuestion::duplicateImages (   $question_id)

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

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

{
global $ilLog;
if ($this->getOrderingType() == OQ_PICTURES)
{
$imagepath = $this->getImagePath();
$imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
if (!file_exists($imagepath)) {
}
foreach ($this->answers as $answer)
{
$filename = $answer->getAnswertext();
if (!@copy($imagepath_original . $filename, $imagepath . $filename))
{
$ilLog->write("image could not be duplicated!!!!");
}
if (@file_exists($imagepath_original. $this->getThumbPrefix(). $filename))
{
if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename))
{
$ilLog->write("image thumbnail could not be duplicated!!!!");
}
}
}
}
}

+ Here is the call graph for this function:

assOrderingQuestion::flushAnswers ( )

Deletes all answers.

public

See Also
$answers

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

{
$this->answers = array();
}
assOrderingQuestion::generateThumbForFile (   $path,
  $file 
)
protected

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

References $file, $filename, $path, ilUtil\convertImage(), getThumbGeometry(), and getThumbPrefix().

Referenced by rebuildThumbnails().

{
if (@file_exists($filename))
{
$thumbpath = $path . $this->getThumbPrefix() . $file;
$path_info = @pathinfo($filename);
$ext = "";
switch (strtoupper($path_info['extension']))
{
case 'PNG':
$ext = 'PNG';
break;
case 'GIF':
$ext = 'GIF';
break;
default:
$ext = 'JPEG';
break;
}
ilUtil::convertImage($filename, $thumbpath, $ext, $this->getThumbGeometry());
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assOrderingQuestion::getAdditionalTableName ( )

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

Returns
string The additional table name public

Reimplemented from assQuestion.

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

Referenced by loadFromDb(), and saveToDb().

{
return "qpl_qst_ordering";
}

+ Here is the caller graph for this function:

assOrderingQuestion::getAnswer (   $index = 0)

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 481 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
integer The number of answers of the ordering question public
See Also
$answers

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

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

Returns the answers array.

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

References $answers.

Referenced by cleanImagefiles(), getRandomID(), rebuildThumbnails(), saveWorkingData(), setExportDetailsXLS(), and toJSON().

{
}

+ Here is the caller graph for this function:

assOrderingQuestion::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns
string The answer table name public

Reimplemented from assQuestion.

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

{
return "qpl_a_ordering";
}
assOrderingQuestion::getElementHeight ( )

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

References $element_height.

Referenced by saveToDb().

{
}

+ Here is the caller graph for this function:

assOrderingQuestion::getEncryptedFilename (   $filename)

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

References $filename.

{
$extension = "";
if (preg_match("/.*\\.(\\w+)$/", $filename, $matches))
{
$extension = $matches[1];
}
return md5($filename) . "." . $extension;
}
assOrderingQuestion::getMaximumPoints ( )

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

Returns
double Points
See Also
$points

Reimplemented from assQuestion.

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

assOrderingQuestion::getMaxSolutionOrder ( )

Returns the maximum solution order of all ordering answers.

Returns
integer The maximum solution order of all ordering answers public

Definition at line 551 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
integer The ordering question type public
See Also
$ordering_type

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

References $ordering_type.

Referenced by cleanImagefiles(), copyImages(), duplicateImages(), rebuildThumbnails(), and saveToDb().

{
}

+ Here is the caller graph for this function:

assOrderingQuestion::getQuestionType ( )

Returns the question type of the question.

Returns
integer The question type of the question public

Reimplemented from assQuestion.

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

Referenced by toJSON().

{
return "assOrderingQuestion";
}

+ Here is the caller graph for this function:

assOrderingQuestion::getRandomID ( )
protected

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

References getAnswers().

Referenced by addAnswer().

{
$random_number = mt_rand(1, 100000);
$found = true;
while ($found)
{
$found = false;
foreach ($this->getAnswers() as $answer)
{
if ($answer->getRandomID() == $random_number)
{
$found = true;
$random_number++;
}
}
}
return $random_number;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

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

References $thumb_geometry.

Referenced by generateThumbForFile(), getThumbSize(), and saveToDb().

{
}

+ Here is the caller graph for this function:

assOrderingQuestion::getThumbPrefix ( )

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

Referenced by cleanImagefiles(), copyImages(), deleteImagefile(), duplicateImages(), generateThumbForFile(), and setImageFile().

{
return "thumb.";
}

+ Here is the caller graph for this function:

assOrderingQuestion::getThumbSize ( )

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

References getThumbGeometry().

{
return $this->getThumbGeometry();
}

+ Here is the call graph for this function:

assOrderingQuestion::isComplete ( )

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

References getMaximumPoints().

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

assOrderingQuestion::loadFromDb (   $question_id)

Loads a assOrderingQuestion object from a database.

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

References $data, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), OQ_TERMS, assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), 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->setAuthor($data["author"]);
$this->setNrOfTries($data['nr_of_tries']);
$this->setPoints($data["points"]);
$this->setOwner($data["owner"]);
include_once("./Services/RTE/classes/class.ilRTE.php");
$this->ordering_type = strlen($data["ordering_type"]) ? $data["ordering_type"] : OQ_TERMS;
$this->thumb_geometry = $data["thumb_geometry"];
$this->element_height = $data["element_height"];
$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_ordering WHERE question_fi = %s ORDER BY solution_order ASC",
array('integer'),
array($question_id)
);
include_once "./Modules/TestQuestionPool/classes/class.assAnswerOrdering.php";
if ($result->numRows() > 0)
{
while ($data = $ilDB->fetchAssoc($result))
{
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["random_id"]));
}
}
parent::loadFromDb($question_id);
}

+ Here is the call graph for this function:

assOrderingQuestion::moveAnswerDown (   $position)

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

{
if ($position < count($this->answers)-1)
{
$temp = $this->answers[$position+1];
$this->answers[$position+1] = $this->answers[$position];
$this->answers[$position] = $temp;
}
}
assOrderingQuestion::moveAnswerUp (   $position)

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

{
if ($position > 0)
{
$temp = $this->answers[$position-1];
$this->answers[$position-1] = $this->answers[$position];
$this->answers[$position] = $temp;
}
}
assOrderingQuestion::rebuildThumbnails ( )

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

References generateThumbForFile(), getAnswers(), assQuestion\getImagePath(), getOrderingType(), and OQ_PICTURES.

Referenced by saveToDb().

{
if ($this->getOrderingType() == OQ_PICTURES)
{
foreach ($this->getAnswers() as $answer)
{
$this->generateThumbForFile($this->getImagePath(), $answer->getAnswertext());
}
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assOrderingQuestion::removeAnswerImage (   $index)

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

References deleteImagefile().

{
$answer = $this->answers[$index];
if (is_object($answer))
{
$this->deleteImagefile($answer->getAnswertext());
$answer->setAnswertext('');
}
}

+ Here is the call graph for this function:

assOrderingQuestion::saveToDb (   $original_id = "")

Saves a assOrderingQuestion object to a database.

Parameters
object$dbA pear DB object public

Reimplemented from assQuestion.

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

References $ilDB, assQuestion\$original_id, ilRTE\_replaceMediaObjectImageSrc(), cleanImagefiles(), getAdditionalTableName(), getElementHeight(), assQuestion\getId(), getOrderingType(), getThumbGeometry(), OQ_PICTURES, rebuildThumbnails(), and assQuestion\saveQuestionDataToDb().

{
global $ilDB;
// save additional data
$affectedRows = $ilDB->manipulateF("DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
array("integer"),
array($this->getId())
);
$affectedRows = $ilDB->manipulateF("INSERT INTO " . $this->getAdditionalTableName() . " (question_fi, ordering_type, thumb_geometry, element_height) VALUES (%s, %s, %s, %s)",
array("integer", "text","integer","integer"),
array(
$this->getId(),
$this->ordering_type,
$this->getThumbGeometry(),
($this->getElementHeight() > 20) ? $this->getElementHeight() : NULL
)
);
$affectedRows = $ilDB->manipulateF("DELETE FROM qpl_a_ordering WHERE question_fi = %s",
array('integer'),
array($this->getId())
);
// Anworten wegschreiben
foreach ($this->answers as $key => $value)
{
$answer_obj = $this->answers[$key];
$next_id = $ilDB->nextId('qpl_a_ordering');
$affectedRows = $ilDB->manipulateF("INSERT INTO qpl_a_ordering (answer_id, question_fi, answertext, solution_order, ".
"random_id, tstamp) VALUES (%s, %s, %s, %s, %s, %s)",
array('integer','integer','text','integer','integer','integer'),
array(
$next_id,
$this->getId(),
ilRTE::_replaceMediaObjectImageSrc($answer_obj->getAnswertext(), 0),
$key,
$answer_obj->getRandomID(),
time()
)
);
}
if ($this->getOrderingType() == OQ_PICTURES)
{
}
$this->cleanImagefiles();
}

+ Here is the call graph for this function:

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

Saves the learners input of the question to the database.

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

Reimplemented from assQuestion.

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

References $_POST, $ilDB, $pass, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), checkSaveData(), getAnswers(), 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);
}
$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 (array_key_exists("orderresult", $_POST))
{
$orderresult = $_POST["orderresult"];
if (strlen($orderresult))
{
$orderarray = explode(":", $orderresult);
$ordervalue = 1;
foreach ($orderarray as $index)
{
if (preg_match("/id_(\\d+)/", $index, $idmatch))
{
$randomid = $idmatch[1];
foreach ($this->getAnswers() as $answeridx => $answer)
{
if ($answer->getRandomID() == $randomid)
{
$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", $answeridx),
"value2" => array("clob", trim($ordervalue)),
"pass" => array("integer", $pass),
"tstamp" => array("integer", time())
));
$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))
{
foreach ($this->getAnswers() as $answeridx => $answer)
{
if ($answer->getRandomID() == $matches[1])
{
$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", $answeridx),
"value2" => array("clob", $value),
"pass" => array("integer", $pass),
"tstamp" => array("integer", time())
));
$entered_values++;
}
}
}
}
}
}
}
}
if ($entered_values)
{
include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
{
$this->logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
}
}
else
{
include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
{
$this->logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
}
}
return $saveWorkingDataResult;
}

+ Here is the call graph for this function:

assOrderingQuestion::setElementHeight (   $a_height)

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

{
$this->element_height = ($a_height < 20) ? "" : $a_height;
}
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 968 of file class.assOrderingQuestion.php.

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

{
include_once ("./Services/Excel/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_tempfilename,
  $image_filename,
  $previous_filename 
)

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

References $result, ilUtil\convertImage(), deleteImagefile(), assQuestion\getImagePath(), getThumbPrefix(), ilUtil\makeDirParents(), and ilUtil\moveUploadedFile().

{
$result = TRUE;
if (strlen($image_tempfilename))
{
$image_filename = str_replace(" ", "_", $image_filename);
$imagepath = $this->getImagePath();
if (!file_exists($imagepath))
{
}
$savename = $image_filename;
if (!ilUtil::moveUploadedFile($image_tempfilename, $savename, $imagepath.$savename))
{
$result = FALSE;
}
else
{
// create thumbnail file
$thumbpath = $imagepath . $this->getThumbPrefix() . $savename;
ilUtil::convertImage($imagepath.$savename, $thumbpath, "JPEG", $this->getThumbGeometry());
}
if ($result && (strcmp($image_filename, $previous_filename) != 0) && (strlen($previous_filename)))
{
$this->deleteImagefile($previous_filename);
}
}
return $result;
}

+ Here is the call graph for this function:

assOrderingQuestion::setOrderingType (   $ordering_type = OQ_TERMS)

Sets the ordering question type.

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

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

References $ordering_type.

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

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

{
$this->thumb_geometry = ($a_geometry < 1) ? 100 : $a_geometry;
}
assOrderingQuestion::supportsJavascriptOutput ( )

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

{
return TRUE;
}
assOrderingQuestion::toJSON ( )

Returns a JSON representation of the question.

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

References $answers, $mobs, $result, ilObjMediaObject\_getMobsOfObject(), ilRTE\_replaceMediaObjectImageSrc(), getAnswers(), assQuestion\getFeedbackGeneric(), assQuestion\getId(), assQuestion\getNrOfTries(), assQuestion\getPoints(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getTitle(), and assQuestion\pcArrayShuffle().

{
include_once("./Services/RTE/classes/class.ilRTE.php");
$result = array();
$result['id'] = (int) $this->getId();
$result['type'] = (string) $this->getQuestionType();
$result['title'] = (string) $this->getTitle();
$result['question'] = (string) ilRTE::_replaceMediaObjectImageSrc($this->getQuestion(), 0);
$result['nr_of_tries'] = (int) $this->getNrOfTries();
$result['shuffle'] = (bool) 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))
);
$counter = 1;
$answers = array();
foreach ($this->getAnswers() as $answer_obj)
{
$answers[$counter] = $answer_obj->getAnswertext();
$counter++;
}
$arr = array();
foreach ($answers as $order => $answer)
{
array_push($arr, array(
"answertext" => (string) $answer,
"order" => (int) $order
));
}
$result['answers'] = $arr;
$result['mobs'] = $mobs;
return json_encode($result);
}

+ Here is the call graph for this function:

Field Documentation

assOrderingQuestion::$answers

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

Referenced by getAnswers(), setExportDetailsXLS(), and toJSON().

assOrderingQuestion::$element_height

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

Referenced by getElementHeight().

assOrderingQuestion::$ordering_type

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

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

assOrderingQuestion::$thumb_geometry = 100

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

Referenced by getThumbGeometry().


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