Nominal survey question. More...
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. | |
getCategoryCount () | |
Returns the number of categories contained in that question. | |
addCategoryWithIndex ($categoryname, $index) | |
Adds a category to the question at a given index. | |
addCategory ($categoryname) | |
Adds a category to the question. | |
addCategoryArray ($categories) | |
Adds a category array to the question. | |
removeCategory ($index) | |
Removes a category from the list of categories. | |
removeCategories ($array) | |
Removes many categories from the list of categories. | |
removeCategoryWithName ($name) | |
Removes a category from the list of categories. | |
getCategory ($index) | |
Returns the name of a category for a given index. | |
flushCategories () | |
Empties the categories list. | |
loadFromDb ($id) | |
Loads a SurveyNominalQuestion object from the database. | |
isComplete () | |
Returns true if the question is complete for use. | |
saveToDb ($original_id="") | |
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 () | |
Data Fields | |
$subtype | |
$categories |
Nominal survey question.
The SurveyNominalQuestion class defines and encapsulates basic methods and attributes for nominal survey question types.
class.SurveyNominalQuestion.php Survey
Definition at line 42 of file class.SurveyNominalQuestion.php.
SurveyNominalQuestion::addCategory | ( | $ | categoryname | ) |
Adds a category to the question.
Adds a category to the question
integer | $categoryname The name of the category public |
Definition at line 153 of file class.SurveyNominalQuestion.php.
{ array_push($this->categories, $categoryname); }
SurveyNominalQuestion::addCategoryArray | ( | $ | categories | ) |
Adds a category array to the question.
Adds a category array to the question
array | $categories An array with categories public |
Definition at line 167 of file class.SurveyNominalQuestion.php.
References $categories.
{ $this->categories = array_merge($this->categories, $categories); }
SurveyNominalQuestion::addCategoryWithIndex | ( | $ | categoryname, | |
$ | index | |||
) |
Adds a category to the question at a given index.
Adds a category to the question at a given index
string | $categoryname The name of the category | |
integer | $index The index of the category public |
Definition at line 139 of file class.SurveyNominalQuestion.php.
Referenced by from_xml().
{ $this->categories[$index] = $categoryname; }
SurveyNominalQuestion::flushCategories | ( | ) |
Empties the categories list.
Empties the categories list
public
Definition at line 242 of file class.SurveyNominalQuestion.php.
Referenced by loadFromDb().
{ $this->categories = array(); }
SurveyNominalQuestion::from_xml | ( | $ | xml_text | ) |
Imports a question from XML.
Sets the attributes of the question from the XML text passed as argument
Definition at line 406 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::$material, $result, addCategoryWithIndex(), domxml_open_mem(), SurveyQuestion::getId(), saveToDb(), SurveyQuestion::setAuthor(), SurveyQuestion::setDescription(), SurveyQuestion::setMaterial(), SurveyQuestion::setObligatory(), 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; } } 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->addCategoryWithIndex($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; }
SurveyNominalQuestion::getCategory | ( | $ | index | ) |
Returns the name of a category for a given index.
Returns the name of a category for a given index
integer | $index The index of the category |
Definition at line 229 of file class.SurveyNominalQuestion.php.
Referenced by to_xml().
{
return $this->categories[$index];
}
SurveyNominalQuestion::getCategoryCount | ( | ) |
Returns the number of categories contained in that question.
Returns the number of categories contained in that question
Definition at line 124 of file class.SurveyNominalQuestion.php.
Referenced by to_xml().
{
return count($this->categories);
}
SurveyNominalQuestion::getSubtype | ( | ) |
Gets the question subtype.
Gets the question subtype
Definition at line 110 of file class.SurveyNominalQuestion.php.
Referenced by to_xml().
{
return $this->subtype;
}
SurveyNominalQuestion::isComplete | ( | ) |
Returns true if the question is complete for use.
Returns true if the question is complete for use
Reimplemented from SurveyQuestion.
Definition at line 300 of file class.SurveyNominalQuestion.php.
Referenced by saveToDb(), and syncWithOriginal().
{ if ($this->title and $this->author and $this->questiontext and count($this->categories)) { return 1; } else { return 0; } }
SurveyNominalQuestion::loadFromDb | ( | $ | id | ) |
Loads a SurveyNominalQuestion object from the database.
Loads a SurveyNominalQuestion object from the database
integer | $id The database id of the nominal survey question public |
Reimplemented from SurveyQuestion.
Definition at line 254 of file class.SurveyNominalQuestion.php.
References $data, SurveyQuestion::$id, $query, $result, flushCategories(), 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->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)) { array_push($this->categories, $data->title); } } } parent::loadFromDb($id); }
SurveyNominalQuestion::removeCategories | ( | $ | array | ) |
Removes many categories from the list of categories.
Removes many categories from the list of categories
array | $array An array containing the index positions of the categories to be removed public |
Definition at line 195 of file class.SurveyNominalQuestion.php.
{
foreach ($array as $index)
{
unset($this->categories[$index]);
}
$this->categories = array_values($this->categories);
}
SurveyNominalQuestion::removeCategory | ( | $ | index | ) |
Removes a category from the list of categories.
Removes a category from the list of categories
integer | $index The index of the category to be removed public |
Definition at line 181 of file class.SurveyNominalQuestion.php.
Referenced by removeCategoryWithName().
{ array_splice($this->categories, $index, 1); }
SurveyNominalQuestion::removeCategoryWithName | ( | $ | name | ) |
Removes a category from the list of categories.
Removes a category from the list of categories
string | $name The name of the category to be removed public |
Definition at line 213 of file class.SurveyNominalQuestion.php.
References removeCategory().
{ $index = array_search($name, $this->categories); $this->removeCategory($index); }
SurveyNominalQuestion::saveToDb | ( | $ | original_id = "" |
) |
Saves a SurveyNominalQuestion object to a database.
Saves a SurveyNominalQuestion object to a database
public
Reimplemented from SurveyQuestion.
Definition at line 319 of file class.SurveyNominalQuestion.php.
References $query, $result, isComplete(), SurveyQuestion::saveCategoryToDb(), 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("1"), $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(); // save categories // delete existing category relations $query = sprintf("DELETE FROM survey_variable WHERE question_fi = %s", $this->ilias->db->quote($this->id) ); $result = $this->ilias->db->query($query); // create new category relations foreach ($this->categories as $key => $value) { $category_id = $this->saveCategoryToDb($value); $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->id), $this->ilias->db->quote(($key + 1)), $this->ilias->db->quote($key) ); $answer_result = $this->ilias->db->query($query); } } parent::saveToDb($original_id); }
SurveyNominalQuestion::setSubtype | ( | $ | subtype = SUBTYPE_MCSR |
) |
Sets the question subtype.
Sets the question subtype
integer | $subtype The question subtype public |
Definition at line 96 of file class.SurveyNominalQuestion.php.
References $subtype.
Referenced by from_xml().
{ $this->subtype = $subtype; }
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.
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 72 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; $this->categories = array(); }
SurveyNominalQuestion::syncWithOriginal | ( | ) |
Reimplemented from SurveyQuestion.
Definition at line 662 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 foreach ($this->categories as $key => $value) { $category_id = $this->saveCategoryToDb($value); $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(($key + 1) . ""), $this->ilias->db->quote($key . "") ); $answer_result = $this->ilias->db->query($query); } } } parent::syncWithOriginal(); }
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
Definition at line 534 of file class.SurveyNominalQuestion.php.
References $pos, $xml, domxml_open_mem(), SurveyQuestion::getAuthor(), getCategory(), getCategoryCount(), SurveyQuestion::getDescription(), SurveyQuestion::getId(), SurveyQuestion::getObligatory(), SurveyQuestion::getQuestiontext(), getSubtype(), 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=".NOMINAL_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); $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 $qtiResponseLid = $this->domxml->create_element("response_lid"); if ($this->getSubtype() == SUBTYPE_MCSR) { $qtiResponseLid->set_attribute("ident", "MCSR"); $qtiResponseLid->set_attribute("rcardinality", "Single"); } else { $qtiResponseLid->set_attribute("ident", "MCMR"); $qtiResponseLid->set_attribute("rcardinality", "Multiple"); } 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); $qtiResponseLid->append_child($qtiMaterial); } } $qtiRenderChoice = $this->domxml->create_element("render_choice"); $qtiRenderChoice->set_attribute("shuffle", "no"); // add categories for ($index = 0; $index < $this->getCategoryCount(); $index++) { $category = $this->getCategory($index); $qtiResponseLabel = $this->domxml->create_element("response_label"); $qtiResponseLabel->set_attribute("ident", $index); $qtiMaterial = $this->domxml->create_element("material"); $qtiMatText = $this->domxml->create_element("mattext"); $qtiMatTextText = $this->domxml->create_text_node($category); $qtiMatText->append_child($qtiMatTextText); $qtiMaterial->append_child($qtiMatText); $qtiResponseLabel->append_child($qtiMaterial); $qtiRenderChoice->append_child($qtiResponseLabel); } $qtiResponseLid->append_child($qtiRenderChoice); $qtiFlow->append_child($qtiResponseLid); $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; }
SurveyNominalQuestion::$categories |
Definition at line 59 of file class.SurveyNominalQuestion.php.
Referenced by addCategoryArray().
SurveyNominalQuestion::$subtype |
Definition at line 50 of file class.SurveyNominalQuestion.php.
Referenced by setSubtype(), and SurveyNominalQuestion().