Text survey question. More...
Inheritance diagram for SurveyTextQuestion:
Collaboration diagram for SurveyTextQuestion:
Public Member Functions | |
| SurveyTextQuestion ($title="", $description="", $author="", $questiontext="", $owner=-1) | |
| SurveyTextQuestion constructor. | |
| loadFromDb ($id) | |
| Loads a SurveyTextQuestion object from the database. | |
| isComplete () | |
| Returns true if the question is complete for use. | |
| setMaxChars ($maxchars=0) | |
| Sets the maximum number of allowed characters for the text answer. | |
| getMaxChars () | |
| Returns the maximum number of allowed characters for the text answer. | |
| saveToDb ($original_id="") | |
| Saves a SurveyTextQuestion object to a database. | |
| from_xml ($xml_text) | |
| Imports a question from XML. | |
| to_xml ($a_include_header=true, $obligatory_state="") | |
| Returns a QTI xml representation of the question. | |
| syncWithOriginal () | |
| _getMaxChars ($question_id) | |
| Returns the maxium number of allowed characters for the text answer. | |
Data Fields | |
| $maxchars | |
Detailed Description
Text survey question.
The SurveyTextQuestion class defines and encapsulates basic methods and attributes for text survey question types.
- Version:
- Id:
- class.SurveyTextQuestion.php 6379 2004-12-23 06:39:39Z hschottm
class.SurveyTextQuestion.php Survey
Definition at line 39 of file class.SurveyTextQuestion.php.
Member Function Documentation
| SurveyTextQuestion::_getMaxChars | ( | $ | question_id | ) |
Returns the maxium number of allowed characters for the text answer.
Returns the maxium number of allowed characters for the text answer
- Returns:
- integer The maximum number of characters public
Definition at line 477 of file class.SurveyTextQuestion.php.
References $query, $result, and $row.
Referenced by ilObjSurveyGUI::runObject().
{
global $ilDB;
$query = sprintf("SELECT maxchars FROM survey_question WHERE question_id = %s",
$ilDB->quote($question_id . "")
);
$result = $ilDB->query($query);
if ($result->numRows())
{
$row = $result->fetchRow(DB_FETCHMODE_ASSOC);
return $row["maxchars"];
}
return 0;
}
Here is the caller graph for this function:
| SurveyTextQuestion::from_xml | ( | $ | xml_text | ) |
Imports a question from XML.
Sets the attributes of the question from the XML text passed as argument
- Returns:
- boolean True, if the import succeeds, false otherwise public
Definition at line 221 of file class.SurveyTextQuestion.php.
References SurveyQuestion::$material, $result, domxml_open_mem(), SurveyQuestion::getId(), saveToDb(), SurveyQuestion::setAuthor(), SurveyQuestion::setDescription(), SurveyQuestion::setMaterial(), setMaxChars(), SurveyQuestion::setObligatory(), SurveyQuestion::setQuestiontext(), and SurveyQuestion::setTitle().
{
$result = false;
if (!empty($this->domxml))
{
$this->domxml->free();
}
$xml_text = preg_replace("/>\s*?</", "><", $xml_text);
$this->domxml = domxml_open_mem($xml_text);
if (!empty($this->domxml))
{
$root = $this->domxml->document_element();
$item = $root->first_child();
$this->setTitle($item->get_attribute("title"));
$this->gaps = array();
$itemnodes = $item->child_nodes();
foreach ($itemnodes as $index => $node)
{
switch ($node->node_name())
{
case "qticomment":
$comment = $node->get_content();
if (strpos($comment, "ILIAS Version=") !== false)
{
}
elseif (strpos($comment, "Questiontype=") !== false)
{
}
elseif (strpos($comment, "Author=") !== false)
{
$comment = str_replace("Author=", "", $comment);
$this->setAuthor($comment);
}
else
{
$this->setDescription($comment);
}
break;
case "itemmetadata":
$qtimetadata = $node->first_child();
$metadata_fields = $qtimetadata->child_nodes();
foreach ($metadata_fields as $index => $metadata_field)
{
$fieldlabel = $metadata_field->first_child();
$fieldentry = $fieldlabel->next_sibling();
switch ($fieldlabel->get_content())
{
case "obligatory":
$this->setObligatory($fieldentry->get_content());
break;
case "maxchars":
$this->setMaxChars($fieldentry->get_content());
break;
}
}
break;
case "presentation":
$flow = $node->first_child();
$flownodes = $flow->child_nodes();
foreach ($flownodes as $idx => $flownode)
{
if (strcmp($flownode->node_name(), "material") == 0)
{
$mattext = $flownode->first_child();
$this->setQuestiontext($mattext->get_content());
}
elseif (strcmp($flownode->node_name(), "response_str") == 0)
{
$ident = $flownode->get_attribute("ident");
$response_lid_nodes = $flownode->child_nodes();
foreach ($response_lid_nodes as $resp_lid_id => $resp_lid_node)
{
switch ($resp_lid_node->node_name())
{
case "material":
$matlabel = $resp_lid_node->get_attribute("label");
$mattype = $resp_lid_node->first_child();
if (strcmp($mattype->node_name(), "mattext") == 0)
{
$material = $mattype->get_content();
if ($material)
{
if ($this->getId() < 1)
{
$this->saveToDb();
}
$this->setMaterial($material, true, $matlabel);
}
}
break;
}
}
}
}
break;
}
}
$result = true;
}
return $result;
}
Here is the call graph for this function:
| SurveyTextQuestion::getMaxChars | ( | ) |
Returns the maximum number of allowed characters for the text answer.
Returns the maximum number of allowed characters for the text answer
public
Definition at line 138 of file class.SurveyTextQuestion.php.
Referenced by to_xml().
{
return $this->maxchars;
}
Here is the caller graph for this function:
| SurveyTextQuestion::isComplete | ( | ) |
Returns true if the question is complete for use.
Returns true if the question is complete for use
- Returns:
- boolean True if the question is complete for use, otherwise false public
Reimplemented from SurveyQuestion.
Definition at line 107 of file class.SurveyTextQuestion.php.
Referenced by saveToDb(), and syncWithOriginal().
{
if ($this->title and $this->author and $this->questiontext)
{
return 1;
}
else
{
return 0;
}
}
Here is the caller graph for this function:
| SurveyTextQuestion::loadFromDb | ( | $ | id | ) |
Loads a SurveyTextQuestion object from the database.
Loads a SurveyTextQuestion object from the database
- Parameters:
-
integer $id The database id of the text survey question public
Reimplemented from SurveyQuestion.
Definition at line 73 of file class.SurveyTextQuestion.php.
References $data, SurveyQuestion::$id, $query, $result, and SurveyQuestion::loadMaterialFromDb().
{
$query = sprintf("SELECT * FROM survey_question WHERE question_id = %s",
$this->ilias->db->quote($id)
);
$result = $this->ilias->db->query($query);
if (strcmp(strtolower(get_class($result)), db_result) == 0) {
if ($result->numRows() == 1) {
$data = $result->fetchRow(DB_FETCHMODE_OBJECT);
$this->id = $data->question_id;
$this->title = $data->title;
$this->description = $data->description;
$this->obj_id = $data->obj_fi;
$this->author = $data->author;
$this->obligatory = $data->obligatory;
$this->owner = $data->owner_fi;
$this->original_id = $data->original_id;
$this->maxchars = $data->maxchars;
$this->questiontext = $data->questiontext;
$this->complete = $data->complete;
}
// loads materials uris from database
$this->loadMaterialFromDb($id);
}
parent::loadFromDb($id);
}
Here is the call graph for this function:
| SurveyTextQuestion::saveToDb | ( | $ | original_id = "" |
) |
Saves a SurveyTextQuestion object to a database.
Saves a SurveyTextQuestion object to a database
public
Reimplemented from SurveyQuestion.
Definition at line 150 of file class.SurveyTextQuestion.php.
References $maxchars, $query, $result, isComplete(), and SurveyQuestion::saveMaterialsToDb().
Referenced by from_xml().
{
$maxchars = "NULL";
if ($this->maxchars)
{
$maxchars = $this->ilias->db->quote($this->maxchars . "");
}
$complete = 0;
if ($this->isComplete()) {
$complete = 1;
}
if ($original_id)
{
$original_id = $this->ilias->db->quote($original_id);
}
else
{
$original_id = "NULL";
}
if ($this->id == -1) {
// Write 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 survey_question (question_id, questiontype_fi, obj_fi, owner_fi, title, description, author, questiontext, obligatory, maxchars, complete, created, original_id, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, NULL)",
$this->ilias->db->quote("4"),
$this->ilias->db->quote($this->obj_id),
$this->ilias->db->quote($this->owner),
$this->ilias->db->quote($this->title),
$this->ilias->db->quote($this->description),
$this->ilias->db->quote($this->author),
$this->ilias->db->quote($this->questiontext),
$this->ilias->db->quote(sprintf("%d", $this->obligatory)),
$maxchars,
$this->ilias->db->quote("$complete"),
$this->ilias->db->quote($created),
$original_id
);
$result = $this->ilias->db->query($query);
if ($result == DB_OK) {
$this->id = $this->ilias->db->getLastInsertId();
}
} else {
// update existing dataset
$query = sprintf("UPDATE survey_question SET title = %s, description = %s, author = %s, questiontext = %s, obligatory = %s, maxchars = %s, complete = %s WHERE question_id = %s",
$this->ilias->db->quote($this->title),
$this->ilias->db->quote($this->description),
$this->ilias->db->quote($this->author),
$this->ilias->db->quote($this->questiontext),
$this->ilias->db->quote(sprintf("%d", $this->obligatory)),
$maxchars,
$this->ilias->db->quote("$complete"),
$this->ilias->db->quote($this->id)
);
$result = $this->ilias->db->query($query);
}
if ($result == DB_OK) {
// saving material uris in the database
$this->saveMaterialsToDb();
}
parent::saveToDb($original_id);
}
Here is the call graph for this function:
Here is the caller graph for this function:
| SurveyTextQuestion::setMaxChars | ( | $ | maxchars = 0 |
) |
Sets the maximum number of allowed characters for the text answer.
Sets the maximum number of allowed characters for the text answer
public
Definition at line 126 of file class.SurveyTextQuestion.php.
References $maxchars.
Referenced by from_xml().
{
$this->maxchars = $maxchars;
}
Here is the caller graph for this function:
| SurveyTextQuestion::SurveyTextQuestion | ( | $ | title = "", |
|
| $ | description = "", |
|||
| $ | author = "", |
|||
| $ | questiontext = "", |
|||
| $ | owner = -1 | |||
| ) |
SurveyTextQuestion constructor.
The constructor takes possible arguments an creates an instance of the SurveyTextQuestion object.
- Parameters:
-
string $title A title string to describe the question string $description A description 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 public
Definition at line 52 of file class.SurveyTextQuestion.php.
References SurveyQuestion::$author, SurveyQuestion::$description, SurveyQuestion::$owner, SurveyQuestion::$questiontext, SurveyQuestion::$title, and SurveyQuestion::SurveyQuestion().
{
$this->SurveyQuestion($title, $description, $author, $questiontext, $owner);
$this->maxchars = 0;
}
Here is the call graph for this function:
| SurveyTextQuestion::syncWithOriginal | ( | ) |
Reimplemented from SurveyQuestion.
Definition at line 447 of file class.SurveyTextQuestion.php.
References $query, $result, and isComplete().
{
if ($this->original_id)
{
$complete = 0;
if ($this->isComplete()) {
$complete = 1;
}
$query = sprintf("UPDATE survey_question SET title = %s, description = %s, author = %s, questiontext = %s, obligatory = %s, complete = %s WHERE question_id = %s",
$this->ilias->db->quote($this->title . ""),
$this->ilias->db->quote($this->description . ""),
$this->ilias->db->quote($this->author . ""),
$this->ilias->db->quote($this->questiontext . ""),
$this->ilias->db->quote(sprintf("%d", $this->obligatory) . ""),
$this->ilias->db->quote($complete . ""),
$this->ilias->db->quote($this->original_id . "")
);
$result = $this->ilias->db->query($query);
}
parent::syncWithOriginal();
}
Here is the call graph for this function:
| SurveyTextQuestion::to_xml | ( | $ | a_include_header = true, |
|
| $ | obligatory_state = "" | |||
| ) |
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 332 of file class.SurveyTextQuestion.php.
References $pos, $xml, domxml_open_mem(), SurveyQuestion::getAuthor(), SurveyQuestion::getDescription(), SurveyQuestion::getId(), getMaxChars(), SurveyQuestion::getObligatory(), SurveyQuestion::getQuestiontext(), SurveyQuestion::getTitle(), and SurveyQuestion::setObligatory().
{
if (!empty($this->domxml))
{
$this->domxml->free();
}
$xml_header = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
$xml_header .= "<questestinterop></questestinterop>\n";
$this->domxml = domxml_open_mem($xml_header);
$root = $this->domxml->document_element();
// qti ident
$qtiIdent = $this->domxml->create_element("item");
$qtiIdent->set_attribute("ident", $this->getId());
$qtiIdent->set_attribute("title", $this->getTitle());
$root->append_child($qtiIdent);
// add qti comment
$qtiComment = $this->domxml->create_element("qticomment");
$qtiCommentText = $this->domxml->create_text_node($this->getDescription());
$qtiComment->append_child($qtiCommentText);
$qtiIdent->append_child($qtiComment);
$qtiComment = $this->domxml->create_element("qticomment");
$qtiCommentText = $this->domxml->create_text_node("ILIAS Version=".$this->ilias->getSetting("ilias_version"));
$qtiComment->append_child($qtiCommentText);
$qtiIdent->append_child($qtiComment);
$qtiComment = $this->domxml->create_element("qticomment");
$qtiCommentText = $this->domxml->create_text_node("Questiontype=".TEXT_QUESTION_IDENTIFIER);
$qtiComment->append_child($qtiCommentText);
$qtiIdent->append_child($qtiComment);
$qtiComment = $this->domxml->create_element("qticomment");
$qtiCommentText = $this->domxml->create_text_node("Author=".$this->getAuthor());
$qtiComment->append_child($qtiCommentText);
$qtiIdent->append_child($qtiComment);
$qtiItemMetadata = $this->domxml->create_element("itemmetadata");
$qtiMetadata = $this->domxml->create_element("qtimetadata");
// obligatory state
$qtiMetadatafield = $this->domxml->create_element("qtimetadatafield");
$qtiFieldLabel = $this->domxml->create_element("fieldlabel");
$qtiFieldLabelText = $this->domxml->create_text_node("obligatory");
$qtiFieldLabel->append_child($qtiFieldLabelText);
$qtiFieldEntry = $this->domxml->create_element("fieldentry");
if (strcmp($obligatory_state, "") != 0)
{
$this->setObligatory($obligatory_state);
}
$qtiFieldEntryText = $this->domxml->create_text_node(sprintf("%d", $this->getObligatory()));
$qtiFieldEntry->append_child($qtiFieldEntryText);
$qtiMetadatafield->append_child($qtiFieldLabel);
$qtiMetadatafield->append_child($qtiFieldEntry);
$qtiMetadata->append_child($qtiMetadatafield);
// maxchars
$qtiMetadatafield = $this->domxml->create_element("qtimetadatafield");
$qtiFieldLabel = $this->domxml->create_element("fieldlabel");
$qtiFieldLabelText = $this->domxml->create_text_node("maxchars");
$qtiFieldLabel->append_child($qtiFieldLabelText);
$qtiFieldEntry = $this->domxml->create_element("fieldentry");
$qtiFieldEntryText = $this->domxml->create_text_node(sprintf("%d", $this->getMaxChars()));
$qtiFieldEntry->append_child($qtiFieldEntryText);
$qtiMetadatafield->append_child($qtiFieldLabel);
$qtiMetadatafield->append_child($qtiFieldEntry);
$qtiMetadata->append_child($qtiMetadatafield);
$qtiItemMetadata->append_child($qtiMetadata);
$qtiIdent->append_child($qtiItemMetadata);
// PART I: qti presentation
$qtiPresentation = $this->domxml->create_element("presentation");
$qtiPresentation->set_attribute("label", $this->getTitle());
// add flow to presentation
$qtiFlow = $this->domxml->create_element("flow");
// add material with question text to presentation
$qtiMaterial = $this->domxml->create_element("material");
$qtiMatText = $this->domxml->create_element("mattext");
$qtiMatTextText = $this->domxml->create_text_node($this->getQuestiontext());
$qtiMatText->append_child($qtiMatTextText);
$qtiMaterial->append_child($qtiMatText);
$qtiFlow->append_child($qtiMaterial);
// add answers to presentation
$qtiResponseStr = $this->domxml->create_element("response_str");
$qtiResponseStr->set_attribute("ident", "TEXT");
$qtiResponseStr->set_attribute("rcardinality", "Single");
if (count($this->material))
{
if (preg_match("/il_(\d*?)_(\w+)_(\d+)/", $this->material["internal_link"], $matches))
{
$qtiMaterial = $this->domxml->create_element("material");
$qtiMaterial->set_attribute("label", $this->material["title"]);
$qtiMatText = $this->domxml->create_element("mattext");
$intlink = "il_" . IL_INST_ID . "_" . $matches[2] . "_" . $matches[3];
if (strcmp($matches[1], "") != 0)
{
$intlink = $this->material["internal_link"];
}
$qtiMatTextText = $this->domxml->create_text_node($intlink);
$qtiMatText->append_child($qtiMatTextText);
$qtiMaterial->append_child($qtiMatText);
$qtiResponseStr->append_child($qtiMaterial);
}
}
$qtiFlow->append_child($qtiResponseStr);
$qtiPresentation->append_child($qtiFlow);
$qtiIdent->append_child($qtiPresentation);
$xml = $this->domxml->dump_mem(true);
if (!$a_include_header)
{
$pos = strpos($xml, "?>");
$xml = substr($xml, $pos + 2);
}
//echo htmlentities($xml);
return $xml;
}
Here is the call graph for this function:
Field Documentation
| SurveyTextQuestion::$maxchars |
Definition at line 40 of file class.SurveyTextQuestion.php.
Referenced by saveToDb(), and setMaxChars().
The documentation for this class was generated from the following file:
- survey/classes/class.SurveyTextQuestion.php
