Nominal survey question. More...
Inheritance diagram for SurveyNominalQuestion:
Collaboration diagram for SurveyNominalQuestion:
Public Member Functions | |
| SurveyNominalQuestion ($title="", $description="", $author="", $questiontext="", $owner=-1, $subtype=0) | |
| SurveyNominalQuestion constructor. | |
| setSubtype ($subtype=SUBTYPE_MCSR) | |
| Sets the question subtype. | |
| getSubtype () | |
| Gets the question subtype. | |
| loadFromDb ($id) | |
| Loads a SurveyNominalQuestion object from the database. | |
| isComplete () | |
| Returns true if the question is complete for use. | |
| saveToDb ($original_id="", $withanswers=true) | |
| Saves a SurveyNominalQuestion 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 () | |
| getQuestionType () | |
| Returns the question type of the question. | |
Data Fields | |
| $subtype | |
| $categories | |
Detailed Description
Nominal survey question.
The SurveyNominalQuestion class defines and encapsulates basic methods and attributes for nominal survey question types.
- Version:
- Id:
- class.SurveyNominalQuestion.php 10882 2006-05-17 22:11:38Z hschottm
class.SurveyNominalQuestion.php Survey
Definition at line 38 of file class.SurveyNominalQuestion.php.
Member Function Documentation
| SurveyNominalQuestion::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 268 of file class.SurveyNominalQuestion.php.
References $idx, SurveyQuestion::$material, $result, domxml_open_mem(), SurveyQuestion::getId(), saveToDb(), SurveyQuestion::setAuthor(), SurveyQuestion::setDescription(), SurveyQuestion::setMaterial(), SurveyQuestion::setObligatory(), SurveyQuestion::setOrientation(), SurveyQuestion::setQuestiontext(), setSubtype(), 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 "orientation":
$this->setOrientation($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_lid") == 0)
{
$ident = $flownode->get_attribute("ident");
if (strcmp($ident, "MCSR") == 0)
{
$this->setSubtype(SUBTYPE_MCSR);
}
else
{
$this->setSubtype(SUBTYPE_MCMR);
}
$shuffle = "";
$response_lid_nodes = $flownode->child_nodes();
foreach ($response_lid_nodes as $resp_lid_id => $resp_lid_node)
{
switch ($resp_lid_node->node_name())
{
case "render_choice":
$render_choice = $resp_lid_node;
$labels = $render_choice->child_nodes();
foreach ($labels as $lidx => $response_label)
{
$material = $response_label->first_child();
$mattext = $material->first_child();
$shuf = 0;
$this->categories->addCategoryAtPosition($mattext->get_content(), $response_label->get_attribute("ident"));
}
break;
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:
| SurveyNominalQuestion::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 565 of file class.SurveyNominalQuestion.php.
Referenced by saveToDb().
{
return 1;
}
Here is the caller graph for this function:
| SurveyNominalQuestion::getSubtype | ( | ) |
Gets the question subtype.
Gets the question subtype
- Returns:
- integer The question subtype public
- See also:
- $subtype
Definition at line 108 of file class.SurveyNominalQuestion.php.
Referenced by to_xml().
{
return $this->subtype;
}
Here is the caller graph for this function:
| SurveyNominalQuestion::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 172 of file class.SurveyNominalQuestion.php.
Referenced by saveToDb(), and syncWithOriginal().
{
if (strlen($this->title) && strlen($this->author) && strlen($this->questiontext) && $this->categories->getCategoryCount())
{
return 1;
}
else
{
return 0;
}
}
Here is the caller graph for this function:
| SurveyNominalQuestion::loadFromDb | ( | $ | id | ) |
Loads a SurveyNominalQuestion object from the database.
Loads a SurveyNominalQuestion object from the database
- Parameters:
-
integer $id The database id of the nominal survey question public
Reimplemented from SurveyQuestion.
Definition at line 121 of file class.SurveyNominalQuestion.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->subtype = $data->subtype;
$this->orientation = $data->orientation;
$this->obligatory = $data->obligatory;
$this->owner = $data->owner_fi;
$this->questiontext = $data->questiontext;
$this->complete = $data->complete;
$this->original_id = $data->original_id;
}
// loads materials uris from database
$this->loadMaterialFromDb($id);
$this->categories->flushCategories();
$query = sprintf("SELECT survey_variable.*, survey_category.title FROM survey_variable, survey_category WHERE survey_variable.question_fi = %s AND survey_variable.category_fi = survey_category.category_id ORDER BY sequence ASC",
$this->ilias->db->quote($id)
);
$result = $this->ilias->db->query($query);
if (strcmp(strtolower(get_class($result)), db_result) == 0)
{
while ($data = $result->fetchRow(DB_FETCHMODE_OBJECT))
{
$this->categories->addCategory($data->title);
}
}
}
parent::loadFromDb($id);
}
Here is the call graph for this function:
| SurveyNominalQuestion::saveToDb | ( | $ | original_id = "", |
|
| $ | withanswers = true | |||
| ) |
Saves a SurveyNominalQuestion object to a database.
Saves a SurveyNominalQuestion object to a database
public
Definition at line 191 of file class.SurveyNominalQuestion.php.
References $query, $result, getQuestionType(), isComplete(), SurveyQuestion::saveCategoriesToDb(), and SurveyQuestion::saveMaterialsToDb().
Referenced by from_xml().
{
$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, subtype, questiontype_fi, obj_fi, owner_fi, title, description, author, questiontext, obligatory, orientation, complete, created, original_id, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, NULL)",
$this->ilias->db->quote("$this->subtype"),
$this->ilias->db->quote($this->getQuestionType()),
$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)),
$this->ilias->db->quote(sprintf("%d", $this->orientation)),
$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, subtype = %s, description = %s, author = %s, questiontext = %s, obligatory = %s, orientation = %s, complete = %s WHERE question_id = %s",
$this->ilias->db->quote($this->title),
$this->ilias->db->quote("$this->subtype"),
$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(sprintf("%d", $this->orientation)),
$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();
if ($withanswers)
{
$this->saveCategoriesToDb();
}
}
parent::saveToDb($original_id);
}
Here is the call graph for this function:
Here is the caller graph for this function:
| SurveyNominalQuestion::setSubtype | ( | $ | subtype = SUBTYPE_MCSR |
) |
Sets the question subtype.
Sets the question subtype
- Parameters:
-
integer $subtype The question subtype public
- See also:
- $subtype
Definition at line 94 of file class.SurveyNominalQuestion.php.
References $subtype.
Referenced by from_xml().
{
$this->subtype = $subtype;
}
Here is the caller graph for this function:
| SurveyNominalQuestion::SurveyNominalQuestion | ( | $ | title = "", |
|
| $ | description = "", |
|||
| $ | author = "", |
|||
| $ | questiontext = "", |
|||
| $ | owner = -1, |
|||
| $ | subtype = 0 | |||
| ) |
SurveyNominalQuestion constructor.
The constructor takes possible arguments an creates an instance of the SurveyNominalQuestion 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 69 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::$author, SurveyQuestion::$description, SurveyQuestion::$owner, SurveyQuestion::$questiontext, $subtype, SurveyQuestion::$title, and SurveyQuestion::SurveyQuestion().
{
$this->SurveyQuestion($title, $description, $author, $questiontext, $owner);
$this->subtype = $subtype;
include_once "./survey/classes/class.SurveyCategories.php";
$this->categories = new SurveyCategories();
}
Here is the call graph for this function:
| SurveyNominalQuestion::syncWithOriginal | ( | ) |
Reimplemented from SurveyQuestion.
Definition at line 511 of file class.SurveyNominalQuestion.php.
References $query, $result, isComplete(), and SurveyQuestion::saveCategoryToDb().
{
if ($this->original_id)
{
$complete = 0;
if ($this->isComplete())
{
$complete = 1;
}
$query = sprintf("UPDATE survey_question SET title = %s, subtype = %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->subtype . ""),
$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);
if ($result == DB_OK) {
// save categories
// delete existing category relations
$query = sprintf("DELETE FROM survey_variable WHERE question_fi = %s",
$this->ilias->db->quote($this->original_id . "")
);
$result = $this->ilias->db->query($query);
// create new category relations
for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
{
$category_id = $this->saveCategoryToDb($this->categories->getCategory($i));
$query = sprintf("INSERT INTO survey_variable (variable_id, category_fi, question_fi, value1, sequence, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, NULL)",
$this->ilias->db->quote($category_id . ""),
$this->ilias->db->quote($this->original_id . ""),
$this->ilias->db->quote(($i + 1) . ""),
$this->ilias->db->quote($i . "")
);
$answer_result = $this->ilias->db->query($query);
}
}
}
parent::syncWithOriginal();
}
Here is the call graph for this function:
| SurveyNominalQuestion::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 399 of file class.SurveyNominalQuestion.php.
References $pos, $xml, SurveyQuestion::getAuthor(), SurveyQuestion::getDescription(), SurveyQuestion::getId(), SurveyQuestion::getObligatory(), SurveyQuestion::getOrientation(), SurveyQuestion::getQuestiontext(), getSubtype(), 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=".NOMINAL_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, "orientation");
$a_xml_writer->xmlElement("fieldentry", NULL, sprintf("%d", $this->getOrientation()));
$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
$a_xml_writer->xmlStartTag("material");
$a_xml_writer->xmlElement("mattext", NULL, $this->getQuestiontext());
$a_xml_writer->xmlEndTag("material");
// add answers to presentation
$ident = "MCMR";
$rcardinality = "Multiple";
if ($this->getSubtype() == SUBTYPE_MCSR)
{
$ident = "MCSR";
$rcardinality = "Single";
}
$attrs = array(
"ident" => $ident,
"rcardinality" => $rcardinality
);
$a_xml_writer->xmlStartTag("response_lid", $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");
}
}
$attrs = array(
"shuffle" => "no"
);
$a_xml_writer->xmlStartTag("render_choice", $attrs);
// add categories
for ($index = 0; $index < $this->categories->getCategoryCount(); $index++)
{
$category = $this->categories->getCategory($index);
$attrs = array(
"ident" => "$index"
);
$a_xml_writer->xmlStartTag("response_label", $attrs);
$a_xml_writer->xmlStartTag("material");
$a_xml_writer->xmlElement("mattext", NULL, $category);
$a_xml_writer->xmlEndTag("material");
$a_xml_writer->xmlEndTag("response_label");
}
$a_xml_writer->xmlEndTag("render_choice");
$a_xml_writer->xmlEndTag("response_lid");
$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
| SurveyNominalQuestion::$categories |
Definition at line 56 of file class.SurveyNominalQuestion.php.
| SurveyNominalQuestion::$subtype |
Definition at line 47 of file class.SurveyNominalQuestion.php.
Referenced by setSubtype(), and SurveyNominalQuestion().
The documentation for this class was generated from the following file:
- survey/classes/class.SurveyNominalQuestion.php
