Text survey question. More...
Inheritance diagram for SurveyTextQuestion:
Collaboration diagram for SurveyTextQuestion:
Public Member Functions | |
| SurveyTextQuestion ($title="", $description="", $author="", $questiontext="", $owner=-1) | |
| SurveyTextQuestion constructor. | |
| _getQuestionDataArray ($id) | |
| Returns the question data fields from the database. | |
| 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. | |
| getQuestionType () | |
| Returns the question type of the question. | |
| getAdditionalTableName () | |
| Returns the name of the additional question data table in the database. | |
| checkUserInput ($post_data) | |
| saveUserInput ($post_data, $survey_id, $user_id, $anonymous_id) | |
| & | getCumulatedResults ($survey_id, $nr_of_users) |
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 12339 2006-10-25 05:37:05Z hschottm
class.SurveyTextQuestion.php Survey
Definition at line 38 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 511 of file class.SurveyTextQuestion.php.
| SurveyTextQuestion::_getQuestionDataArray | ( | $ | id | ) |
Returns the question data fields from the database.
Returns the question data fields from the database
- Parameters:
-
integer $id The question ID from the database
- Returns:
- array Array containing the question fields and data from the database public
Reimplemented from SurveyQuestion.
Definition at line 74 of file class.SurveyTextQuestion.php.
References SurveyQuestion::$id, $query, and $result.
{
global $ilDB;
$query = sprintf("SELECT survey_question.*, survey_question_text.* FROM survey_question, survey_question_text WHERE survey_question.question_id = %s AND survey_question.question_id = survey_question_text.question_fi",
$ilDB->quote($id)
);
$result = $ilDB->query($query);
if ($result->numRows() == 1)
{
return $result->fetchRow(DB_FETCHMODE_ASSOC);
}
else
{
return array();
}
}
| SurveyTextQuestion::checkUserInput | ( | $ | post_data | ) |
Definition at line 552 of file class.SurveyTextQuestion.php.
References SurveyQuestion::getId(), and SurveyQuestion::getObligatory().
{
$entered_value = $post_data[$this->getId() . "_text_question"];
if ((!$this->getObligatory()) && (strlen($entered_value) == 0)) return "";
if (strlen($entered_value) == 0) return $this->lng->txt("text_question_not_filled_out");
return "";
}
Here is the call 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 272 of file class.SurveyTextQuestion.php.
References $idx, 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::getAdditionalTableName | ( | ) |
Returns the name of the additional question data table in the database.
Returns the name of the additional question data table in the database
- Returns:
- string The additional table name public
Definition at line 547 of file class.SurveyTextQuestion.php.
{
return "survey_question_text";
}
| & SurveyTextQuestion::getCumulatedResults | ( | $ | survey_id, | |
| $ | nr_of_users | |||
| ) |
Definition at line 587 of file class.SurveyTextQuestion.php.
References $query, $result, $row, SurveyQuestion::$survey_id, and SurveyQuestion::getId().
{
global $ilDB;
$question_id = $this->getId();
$result_array = array();
$cumulated = array();
$textvalues = array();
$query = sprintf("SELECT * FROM survey_answer WHERE question_fi = %s AND survey_fi = %s",
$ilDB->quote($question_id),
$ilDB->quote($survey_id)
);
$result = $ilDB->query($query);
while ($row = $result->fetchRow(DB_FETCHMODE_OBJECT))
{
$cumulated["$row->value"]++;
array_push($textvalues, $row->textanswer);
}
asort($cumulated, SORT_NUMERIC);
end($cumulated);
$numrows = $result->numRows();
$result_array["USERS_ANSWERED"] = $result->numRows();
$result_array["USERS_SKIPPED"] = $nr_of_users - $result->numRows();
$result_array["QUESTION_TYPE"] = "SurveyTextQuestion";
$result_array["textvalues"] = $textvalues;
return $result_array;
}
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 170 of file class.SurveyTextQuestion.php.
Referenced by saveUserInput(), and to_xml().
{
return $this->maxchars;
}
Here is the caller graph for this function:
| SurveyTextQuestion::getQuestionType | ( | ) |
Returns the question type of the question.
Returns the question type of the question
- Returns:
- integer The question type of the question public
Reimplemented from SurveyQuestion.
Definition at line 534 of file class.SurveyTextQuestion.php.
{
return 4;
}
| 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 139 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 100 of file class.SurveyTextQuestion.php.
References $data, SurveyQuestion::$id, $query, $result, ilRTE::_replaceMediaObjectImageSrc(), and SurveyQuestion::loadMaterialFromDb().
{
global $ilDB;
$query = sprintf("SELECT survey_question.*, survey_question_text.* FROM survey_question, survey_question_text WHERE survey_question.question_id = %s AND survey_question.question_id = survey_question_text.question_fi",
$ilDB->quote($id)
);
$result = $ilDB->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;
include_once("./Services/RTE/classes/class.ilRTE.php");
$this->questiontext = ilRTE::_replaceMediaObjectImageSrc($data->questiontext, 1);
$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 182 of file class.SurveyTextQuestion.php.
References $maxchars, $query, $result, ilRTE::_cleanupMediaObjectUsage(), ilRTE::_replaceMediaObjectImageSrc(), SurveyQuestion::getId(), isComplete(), and SurveyQuestion::saveMaterialsToDb().
Referenced by from_xml().
{
global $ilDB;
$maxchars = "NULL";
if ($this->maxchars)
{
$maxchars = $ilDB->quote($this->maxchars . "");
}
$complete = 0;
if ($this->isComplete()) {
$complete = 1;
}
if ($original_id)
{
$original_id = $ilDB->quote($original_id);
}
else
{
$original_id = "NULL";
}
// cleanup RTE images which are not inserted into the question text
include_once("./Services/RTE/classes/class.ilRTE.php");
ilRTE::_cleanupMediaObjectUsage($this->questiontext, "spl:html",
$this->getId());
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, complete, created, original_id, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, NULL)",
$ilDB->quote($this->getQuestionType() . ""),
$ilDB->quote($this->obj_id),
$ilDB->quote($this->owner),
$ilDB->quote($this->title),
$ilDB->quote($this->description),
$ilDB->quote($this->author),
$ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($this->questiontext, 0)),
$ilDB->quote(sprintf("%d", $this->obligatory)),
$ilDB->quote("$complete"),
$ilDB->quote($created),
$original_id
);
$result = $ilDB->query($query);
if ($result == DB_OK)
{
$this->id = $ilDB->getLastInsertId();
$query = sprintf("INSERT INTO survey_question_text (question_fi, maxchars) VALUES (%s, %s)",
$ilDB->quote($this->id . ""),
$maxchars
);
$ilDB->query($query);
}
}
else
{
// update existing dataset
$query = sprintf("UPDATE survey_question SET title = %s, description = %s, author = %s, questiontext = %s, obligatory = %s, complete = %s WHERE question_id = %s",
$ilDB->quote($this->title),
$ilDB->quote($this->description),
$ilDB->quote($this->author),
$ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($this->questiontext, 0)),
$ilDB->quote(sprintf("%d", $this->obligatory)),
$ilDB->quote("$complete"),
$ilDB->quote($this->id)
);
$result = $ilDB->query($query);
$query = sprintf("UPDATE survey_question_text SET maxchars = %s WHERE question_fi = %s",
$maxchars,
$ilDB->quote($this->id . "")
);
$result = $ilDB->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::saveUserInput | ( | $ | post_data, | |
| $ | survey_id, | |||
| $ | user_id, | |||
| $ | anonymous_id | |||
| ) |
Definition at line 563 of file class.SurveyTextQuestion.php.
References $maxchars, $query, $result, SurveyQuestion::$survey_id, $user_id, SurveyQuestion::getId(), getMaxChars(), and ilUtil::stripSlashes().
{
global $ilDB;
include_once "./classes/class.ilUtil.php";
$entered_value = ilUtil::stripSlashes($post_data[$this->getId() . "_text_question"]);
$maxchars = $this->getMaxChars();
if ($maxchars > 0)
{
$entered_value = substr($entered_value, 0, $maxchars);
}
if (strlen($entered_value) == 0) return;
$entered_value = $ilDB->quote($entered_value . "");
$query = sprintf("INSERT INTO survey_answer (answer_id, survey_fi, question_fi, user_fi, anonymous_id, value, textanswer, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, %s, NULL)",
$ilDB->quote($survey_id . ""),
$ilDB->quote($this->getId() . ""),
$ilDB->quote($user_id . ""),
$ilDB->quote($anonymous_id . ""),
"NULL",
$entered_value
);
$result = $ilDB->query($query);
}
Here is the call 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 158 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 474 of file class.SurveyTextQuestion.php.
References $query, $result, and isComplete().
{
global $ilDB;
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",
$ilDB->quote($this->title . ""),
$ilDB->quote($this->description . ""),
$ilDB->quote($this->author . ""),
$ilDB->quote($this->questiontext . ""),
$ilDB->quote(sprintf("%d", $this->obligatory) . ""),
$ilDB->quote($complete . ""),
$ilDB->quote($this->original_id . "")
);
$result = $ilDB->query($query);
$query = sprintf("UPDATE survey_question_text SET maxchars = %s WHERE question_fi = %s",
$ilDB->quote($this->getMaxChars() . ""),
$ilDB->quote($this->original_id . "")
);
$result = $ilDB->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 383 of file class.SurveyTextQuestion.php.
References $pos, SurveyQuestion::addQTIMaterial(), SurveyQuestion::getAuthor(), SurveyQuestion::getDescription(), SurveyQuestion::getId(), getMaxChars(), SurveyQuestion::getObligatory(), SurveyQuestion::getQuestiontext(), SurveyQuestion::getTitle(), and SurveyQuestion::setObligatory().
{
include_once("./classes/class.ilXmlWriter.php");
$a_xml_writer = new ilXmlWriter;
// set xml header
$a_xml_writer->xmlHeader();
$a_xml_writer->xmlStartTag("questestinterop");
$attrs = array(
"ident" => $this->getId(),
"title" => $this->getTitle()
);
$a_xml_writer->xmlStartTag("item", $attrs);
// add question description
$a_xml_writer->xmlElement("qticomment", NULL, $this->getDescription());
$a_xml_writer->xmlElement("qticomment", NULL, "ILIAS Version=".$this->ilias->getSetting("ilias_version"));
$a_xml_writer->xmlElement("qticomment", NULL, "Questiontype=".TEXT_QUESTION_IDENTIFIER);
$a_xml_writer->xmlElement("qticomment", NULL, "Author=".$this->getAuthor());
// add ILIAS specific metadata
$a_xml_writer->xmlStartTag("itemmetadata");
$a_xml_writer->xmlStartTag("qtimetadata");
$a_xml_writer->xmlStartTag("qtimetadatafield");
$a_xml_writer->xmlElement("fieldlabel", NULL, "obligatory");
if (strcmp($obligatory_state, "") != 0)
{
$this->setObligatory($obligatory_state);
}
$a_xml_writer->xmlElement("fieldentry", NULL, sprintf("%d", $this->getObligatory()));
$a_xml_writer->xmlEndTag("qtimetadatafield");
$a_xml_writer->xmlStartTag("qtimetadatafield");
$a_xml_writer->xmlElement("fieldlabel", NULL, "maxchars");
if (!$this->getMaxChars())
{
$a_xml_writer->xmlElement("fieldentry", NULL, "");
}
else
{
$a_xml_writer->xmlElement("fieldentry", NULL, sprintf("%d", $this->getMaxChars()));
}
$a_xml_writer->xmlEndTag("qtimetadatafield");
$a_xml_writer->xmlEndTag("qtimetadata");
$a_xml_writer->xmlEndTag("itemmetadata");
// PART I: qti presentation
$attrs = array(
"label" => $this->getTitle()
);
$a_xml_writer->xmlStartTag("presentation", $attrs);
// add flow to presentation
$a_xml_writer->xmlStartTag("flow");
// add material with question text to presentation
$this->addQTIMaterial($a_xml_writer, $this->getQuestiontext());
// add answers to presentation
$attrs = array(
"ident" => "TEXT",
"rcardinality" => "Single"
);
$a_xml_writer->xmlStartTag("response_str", $attrs);
if (count($this->material))
{
if (preg_match("/il_(\d*?)_(\w+)_(\d+)/", $this->material["internal_link"], $matches))
{
$attrs = array(
"label" => $this->material["title"]
);
$a_xml_writer->xmlStartTag("material", $attrs);
$intlink = "il_" . IL_INST_ID . "_" . $matches[2] . "_" . $matches[3];
if (strcmp($matches[1], "") != 0)
{
$intlink = $this->material["internal_link"];
}
$a_xml_writer->xmlElement("mattext", NULL, $intlink);
$a_xml_writer->xmlEndTag("material");
}
}
$a_xml_writer->xmlEndTag("response_str");
$a_xml_writer->xmlEndTag("flow");
$a_xml_writer->xmlEndTag("presentation");
$a_xml_writer->xmlEndTag("item");
$a_xml_writer->xmlEndTag("questestinterop");
$xml = $a_xml_writer->xmlDumpMem(FALSE);
if (!$a_include_header)
{
$pos = strpos($xml, "?>");
$xml = substr($xml, $pos + 2);
}
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(), saveUserInput(), and setMaxChars().
The documentation for this class was generated from the following file:
- survey/classes/class.SurveyTextQuestion.php
