Class for a new question type. More...
Inheritance diagram for assQuestionTypeTemplate:
Collaboration diagram for assQuestionTypeTemplate:
Public Member Functions | |
| assQuestionTypeTemplate ($title="", $comment="", $author="", $owner=-1, $question="") | |
| assQuestionTypeTemplate constructor | |
| isComplete () | |
| Returns true, if a question is complete for use. | |
| fromXML (&$item, $questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping) | |
| Imports the question from an QTI XML file. | |
| to_xml ($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. | |
| saveToDb ($original_id="") | |
| Saves a the question object in the ILIAS database. | |
| loadFromDb ($question_id) | |
| Loads the question object from the ILIAS database. | |
| duplicate ($for_test=true, $title="", $author="", $owner="") | |
| Duplicates a question. | |
| copyObject ($target_questionpool, $title="") | |
| Copies the question into another question pool. | |
| getQuestion () | |
| Returns the value of the question attribute. | |
| setQuestion ($question="") | |
| Sets the value of the question attribute. | |
| getMaximumPoints () | |
| Returns the maximum points, a learner can reach answering the question. | |
| calculateReachedPoints ($active_id, $pass=NULL) | |
| Returns the points, a learner has reached answering the question. | |
| saveWorkingData ($active_id, $pass=NULL) | |
| Saves the learners input of the question to the database. | |
| syncWithOriginal () | |
| Synchronizes the "original" of the question with the question data. | |
| getQuestionType () | |
| Returns the question type of the question. | |
| getAdditionalTableName () | |
| Returns the name of the additional question data table in the database (if one exists). | |
| getAnswerTableName () | |
| Returns the name of the additional answer table in the database (if one exists). | |
Data Fields | |
| $question | |
Detailed Description
Class for a new question type.
assQuestionTypeTemplate is a class for a new question type
- Version:
- Id:
- class.assQuestionTypeTemplate.php 12336 2006-10-24 17:24:28Z hschottm
class.assQuestionTypeTemplate.php Assessment
Definition at line 34 of file class.assQuestionTypeTemplate.php.
Member Function Documentation
| assQuestionTypeTemplate::assQuestionTypeTemplate | ( | $ | title = "", |
|
| $ | comment = "", |
|||
| $ | author = "", |
|||
| $ | owner = -1, |
|||
| $ | question = "" | |||
| ) |
assQuestionTypeTemplate constructor
The constructor takes possible arguments an creates an instance of the assQuestionTypeTemplate object.
- Parameters:
-
string $title A title string to describe the question string $comment A comment string to describe the question string $author A string containing the name of the questions author integer $owner A numerical ID to identify the owner/creator string $question The question string of the new question type public
- See also:
- assQuestion:assQuestion()
Definition at line 58 of file class.assQuestionTypeTemplate.php.
References assQuestion::$author, assQuestion::$comment, assQuestion::$owner, $question, assQuestion::$title, and assQuestion::assQuestion().
{
$this->assQuestion($title, $comment, $author, $owner);
// do your own initialization stuff here
$this->question = $question;
}
Here is the call graph for this function:
| assQuestionTypeTemplate::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 $active_id The active ID of the tst_active database table integer $pass The test pass of the given user public
Definition at line 432 of file class.assQuestionTypeTemplate.php.
References assQuestion::$points, $query, $result, assQuestion::getId(), and assQuestion::getSolutionMaxPass().
{
// this method is inherited from assQuestion
// overwrite it here and define your own code to calculate the reached points of a given user of the question
// what you have to do is to check the user solutions in the database
// table tst_solutions for the given active id, the question id and the given pass
global $ilDB;
$found_values = 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);
// no you have to do something with the values
$points = .... some calculations
// then call the calculateReachedPoints method of the parent class to check
// for special test settings
$points = parent::calculateReachedPoints($active_id, $pass = NULL, $points);
return $points;
}
Here is the call graph for this function:
| assQuestionTypeTemplate::copyObject | ( | $ | target_questionpool, | |
| $ | title = "" | |||
| ) |
Copies the question into another question pool.
Copies the question into another question pool
- Parameters:
-
integer $target_questionpool The ID of the target question pool string $title A new title of the question, if given public
Definition at line 338 of file class.assQuestionTypeTemplate.php.
References assQuestion::$title, assQuestion::_getOriginalId(), assQuestion::getId(), and assQuestion::getObjId().
{
if ($this->getId() <= 0)
{
// The question has not been saved. It cannot be duplicated
return;
}
// duplicate the question in database
$clone = $this;
include_once ("./assessment/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);
// the following varies for different question types
// copy XHTML media objects
$clone->copyXHTMLMediaObjectsOfQuestion($original_id);
// duplicate the image
$clone->copyImages($original_id, $source_questionpool);
return $clone->id;
}
Here is the call graph for this function:
| assQuestionTypeTemplate::duplicate | ( | $ | for_test = true, |
|
| $ | title = "", |
|||
| $ | author = "", |
|||
| $ | owner = "" | |||
| ) |
Duplicates a question.
Duplicates a question
public
Definition at line 281 of file class.assQuestionTypeTemplate.php.
References assQuestion::$author, assQuestion::$owner, assQuestion::$title, and assQuestion::_getOriginalId().
{
if ($this->id <= 0)
{
// The question has not been saved. It cannot be duplicated
return;
}
// duplicate the question in database
$clone = $this;
include_once ("./assessment/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($original_id);
// the following varies for different question types
// copy XHTML media objects
$clone->copyXHTMLMediaObjectsOfQuestion($original_id);
// duplicate the images
$clone->duplicateImages($original_id);
return $clone->id;
}
Here is the call graph for this function:
| assQuestionTypeTemplate::fromXML | ( | &$ | item, | |
| $ | questionpool_id, | |||
| &$ | tst_id, | |||
| &$ | tst_object, | |||
| &$ | question_counter, | |||
| &$ | import_mapping | |||
| ) |
Imports the question from an QTI XML file.
Receives parameters from a QTI parser and creates a valid ILIAS question object
- Parameters:
-
object $item The QTI item object integer $questionpool_id The id of the parent questionpool integer $tst_id The id of the parent test if the question is part of a test object $tst_object A reference to the parent test object integer $question_counter A reference to a question counter to count the questions of an imported question pool array $import_mapping An array containing references to included ILIAS objects public
Definition at line 109 of file class.assQuestionTypeTemplate.php.
{
// you have to define your own import code. please check the other question type for example code
}
| assQuestionTypeTemplate::getAdditionalTableName | ( | ) |
Returns the name of the additional question data table in the database (if one exists).
Returns the name of the additional question data table in the database (if one exists)
- Returns:
- string The additional table name public
Reimplemented from assQuestion.
Definition at line 594 of file class.assQuestionTypeTemplate.php.
{
return "qpl_question_mytype";
}
| assQuestionTypeTemplate::getAnswerTableName | ( | ) |
Returns the name of the additional answer table in the database (if one exists).
Returns the name of the additional answer table in the database (if one exists)
- Returns:
- string The answer table name public
Reimplemented from assQuestion.
Definition at line 607 of file class.assQuestionTypeTemplate.php.
{
return "qpl_answer_mytype";
}
| assQuestionTypeTemplate::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 411 of file class.assQuestionTypeTemplate.php.
References assQuestion::$points.
Referenced by isComplete(), saveToDb(), and syncWithOriginal().
{
// this method is inherited from assQuestion
// overwrite it here and define your own code to calculate the maximum points of the question
// the following code is example code and you have to exchange it with your own code:
$points = 3;
return $points;
}
Here is the caller graph for this function:
| assQuestionTypeTemplate::getQuestion | ( | ) |
Returns the value of the question attribute.
Returns the value of the question attribute
- Returns:
- string The value of the question attribute public
- See also:
- $question
Definition at line 380 of file class.assQuestionTypeTemplate.php.
Referenced by isComplete().
{
// this has to be done for every attribute
// you have to defined a getter and setter method for every attribute.
return $this->question;
}
Here is the caller graph for this function:
| assQuestionTypeTemplate::getQuestionType | ( | ) |
Returns the question type of the question.
Returns the question type of the question which is the database ID of the qpl_question_type database table entry of this question type
- Returns:
- integer The question type of the question public
Definition at line 580 of file class.assQuestionTypeTemplate.php.
{
$question_type = 13;
return $question_type;
}
| assQuestionTypeTemplate::isComplete | ( | ) |
Returns true, if a question is complete for use.
Returns true, if a question is complete for use
- Returns:
- boolean True, if the question is complete for use, otherwise false public
Reimplemented from assQuestion.
Definition at line 80 of file class.assQuestionTypeTemplate.php.
References assQuestion::getAuthor(), getMaximumPoints(), getQuestion(), and assQuestion::getTitle().
Referenced by saveToDb(), and syncWithOriginal().
{
// this method is inherited from assQuestion
// overwrite it here and define your own code which checks the completion status of this question
// the following code is example code and you have to exchange it with your own code:
if ((strlen($this->getTitle())) and (strlen($this->getAuthor())) and (strlen($this->getQuestion())) 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:
| assQuestionTypeTemplate::loadFromDb | ( | $ | question_id | ) |
Loads the question object from the ILIAS database.
Loads the question object from the ILIAS database
- Parameters:
-
integer $question_id A unique key containing the database key of the question public
Reimplemented from assQuestion.
Definition at line 245 of file class.assQuestionTypeTemplate.php.
References $data, $query, $result, assQuestion::setComment(), assQuestion::setId(), and assQuestion::setTitle().
{
// this method is inherited from assQuestion
// overwrite it here and define your own code to load the question from the ILIAS database
// the following code is example code and you have to exchange it with your own code:
global $ilDB;
$hasimages = 0;
$query = sprintf("SELECT qpl_questions.*, qpl_question_mytype.* FROM qpl_questions, qpl_question_mytype WHERE question_id = %s AND qpl_questions.question_id = qpl_question_mytype.question_fi",
$ilDB->quote($question_id)
);
$result = $ilDB->query($query);
if (strcmp(strtolower(get_class($result)), db_result) == 0)
{
if ($result->numRows() == 1)
{
$data = $result->fetchRow(DB_FETCHMODE_ASSOC);
$this->setId($question_id);
$this->setTitle($data["title"]);
$this->setComment($data["comment"]);
// ... and so on
}
}
// call the parent class to load the suggested solutions
parent::loadFromDb($question_id);
}
Here is the call graph for this function:
| assQuestionTypeTemplate::saveToDb | ( | $ | original_id = "" |
) |
Saves a the question object in the ILIAS database.
Saves a the question object in the ILIAS database
- Parameters:
-
integer $original_id The question ID of the question from which this question is cloned public
Reimplemented from assQuestion.
Definition at line 136 of file class.assQuestionTypeTemplate.php.
References $query, $result, assQuestion::createPageObject(), assQuestion::getEstimatedWorkingTime(), assQuestion::getId(), getMaximumPoints(), assQuestion::getTestId(), assQuestion::insertIntoTest(), isComplete(), and assQuestion::setId().
{
// this method is inherited from assQuestion
// overwrite it here and define your own code to save the question into the ILIAS database
// the following code is example code and you have to exchange it with your own code:
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";
}
if ($this->getId() == -1)
{
// create a new dataset
$now = getdate();
$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, points, working_time, complete, created, original_id, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, NULL)",
$ilDB->quote("1"),
$ilDB->quote($this->obj_id),
$ilDB->quote($this->title),
$ilDB->quote($this->comment),
$ilDB->quote($this->author),
$ilDB->quote($this->owner),
$ilDB->quote($this->question),
$ilDB->quote($this->getMaximumPoints() . ""),
$ilDB->quote($estw_time),
$ilDB->quote("$complete"),
$ilDB->quote($created),
$original_id
);
$result = $ilDB->query($query);
if ($result == DB_OK)
{
// maybe you have more fields than the qpl_question table offers.
// so you have to write this content in your question type table which
// could look like the following code
$this->setId($ilDB->getLastInsertId());
$query = sprintf("INSERT INTO qpl_question_mytype (question_fi, myattribute) VALUES (%s, %s)",
$ilDB->quote($this->getId() . ""),
$ilDB->quote($this->getMyAttribute())
);
$ilDB->query($query);
// create a page object of question (always necessary!!!!!)
$this->createPageObject();
// this is used then the question should be inserted into a test
if ($this->getTestId() > 0)
{
$this->insertIntoTest($this->getTestId());
}
}
}
else
{
// update an existing dataset
$query = sprintf("UPDATE qpl_questions SET obj_fi = %s, title = %s, comment = %s, author = %s, question_text = %s, points = %s, working_time=%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($this->question),
$ilDB->quote($this->getMaximumPoints() . ""),
$ilDB->quote($estw_time),
$ilDB->quote("$complete"),
$ilDB->quote($this->getId())
);
$result = $ilDB->query($query);
// maybe you have more fields than the qpl_question table offers.
// so you have to write this content in your question type table which
// could look like the following code
$query = sprintf("UPDATE qpl_question_mytype SET myattribute = %s WHERE question_fi = %s",
$ilDB->quote($this->getMyAttribute()),
$ilDB->quote($this->getId() . "")
);
$result = $ilDB->query($query);
}
// call the save method of the parent class (assQuestion)
// to store the suggested solutions
parent::saveToDb($original_id);
}
Here is the call graph for this function:
| assQuestionTypeTemplate::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
- Parameters:
-
integer $active_id The active ID of the tst_active database table integer $pass The test pass of the given user public
Reimplemented from assQuestion.
Definition at line 473 of file class.assQuestionTypeTemplate.php.
References $query, $result, $row, ilObjTest::_getPass(), and assQuestion::getId().
{
// this method is inherited from assQuestion
// overwrite it here and define your own code to save the results of a users input during a test
// what you have to do is to check the POST values of a user
// who works through this question in a test and save the values
// in the tst_solutions database table
// The rules say that it is not allowed to work with $_GET and $_POST variables
// in non-GUI classes. I will change this in a future version but for now you
// should do it the same way
global $ilDB;
global $ilUser;
include_once "./assessment/classes/class.ilObjTest.php";
$activepass = ilObjTest::_getPass($active_id);
$entered_values = 0;
$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($activepass . "")
);
$result = $ilDB->query($query);
$row = $result->fetchRow(DB_FETCHMODE_OBJECT);
$update = $row->solution_id;
if ($update)
{
// update your dataset in the tst_solutions table
}
else
{
// create a new dataset in the tst_solutions table from the
// POST values of the user
}
// call the saveWorkingData method of the parent class
// This method calls the calculateReachedPoints method and saves
// the reached points of the user in the tst_test_result table
// for a better performance.
parent::saveWorkingData($active_id, $pass);
return TRUE;
}
Here is the call graph for this function:
| assQuestionTypeTemplate::setQuestion | ( | $ | question = "" |
) |
Sets the value of the question attribute.
Sets the value of the question attribute
- Parameters:
-
string $question A string containing the value of the question attribute public
- See also:
- $question
Definition at line 396 of file class.assQuestionTypeTemplate.php.
References $question.
{
// this has to be done for every attribute
// you have to defined a getter and setter method for every attribute.
$this->question = $question;
}
| assQuestionTypeTemplate::syncWithOriginal | ( | ) |
Synchronizes the "original" of the question with the question data.
Synchronizes the "original" of the question with the question data
public
Reimplemented from assQuestion.
Definition at line 527 of file class.assQuestionTypeTemplate.php.
References $query, $result, assQuestion::getEstimatedWorkingTime(), getMaximumPoints(), and isComplete().
{
// this method is inherited from assQuestion
// overwrite it here and define your own code to synchronize the original of the question
// with the question data
global $ilDB;
if ($this->original_id)
{
$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']);
$query = sprintf("UPDATE qpl_questions SET obj_fi = %s, title = %s, comment = %s, author = %s, question_text = %s, points = %s, working_time=%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($this->question. ""),
$ilDB->quote($this->getMaximumPoints() . ""),
$ilDB->quote($estw_time. ""),
$ilDB->quote($complete. ""),
$ilDB->quote($this->original_id. "")
);
$result = $ilDB->query($query);
// do your own synchronization on your additional question database table if there is one
$query = sprintf("UPDATE qpl_question_mytype SET myattribute = %s WHERE question_fi = %s",
$ilDB->quote($this->getMyAttribute()),
$ilDB->quote($this->original_id . "")
);
$result = $ilDB->query($query);
// call the synchronization method of the parent class
parent::syncWithOriginal();
}
}
Here is the call graph for this function:
| assQuestionTypeTemplate::to_xml | ( | $ | 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.
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 public
Definition at line 123 of file class.assQuestionTypeTemplate.php.
{
// you have to define your own export code. please check the other question type for example code
}
Field Documentation
| assQuestionTypeTemplate::$question |
Definition at line 43 of file class.assQuestionTypeTemplate.php.
Referenced by assQuestionTypeTemplate(), and setQuestion().
The documentation for this class was generated from the following file:
- assessment/classes/class.assQuestionTypeTemplate.php
