Ordinal survey question. More...
Inheritance diagram for SurveyOrdinalQuestion:
Collaboration diagram for SurveyOrdinalQuestion:Public Member Functions | |
| SurveyOrdinalQuestion ($title="", $description="", $author="", $questiontext="", $owner=-1) | |
| SurveyOrdinalQuestion constructor. | |
| & | getAvailablePhrases ($useronly=0) |
| Gets the available phrases from the database. | |
| & | getCategoriesForPhrase ($phrase_id) |
| Gets the available categories for a given phrase. | |
| addPhrase ($phrase_id) | |
| Adds a phrase to the question. | |
| loadFromDb ($id) | |
| Loads a SurveyOrdinalQuestion object from the database. | |
| isComplete () | |
| Returns true if the question is complete for use. | |
| saveToDb ($original_id="", $withanswers=true) | |
| Saves a SurveyOrdinalQuestion 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 () | |
| addStandardNumbers ($lower_limit, $upper_limit) | |
| Adds standard numbers as categories. | |
| savePhrase ($phrases, $title) | |
| Saves a set of categories to a default phrase. | |
| getQuestionType () | |
| Returns the question type of the question. | |
Data Fields | |
| $categories | |
Ordinal survey question.
The SurveyOrdinalQuestion class defines and encapsulates basic methods and attributes for ordinal survey question types.
class.SurveyOrdinalQuestion.php Survey
Definition at line 38 of file class.SurveyOrdinalQuestion.php.
| SurveyOrdinalQuestion::addPhrase | ( | $ | phrase_id | ) |
Adds a phrase to the question.
Adds a phrase to the question
| integer | $phrase_id The database id of the given phrase public |
Definition at line 156 of file class.SurveyOrdinalQuestion.php.
References $ilUser, $query, $result, and $row.
{
global $ilUser;
$query = sprintf("SELECT survey_category.* FROM survey_category, survey_phrase_category WHERE survey_phrase_category.category_fi = survey_category.category_id AND survey_phrase_category.phrase_fi = %s AND (survey_category.owner_fi = 0 OR survey_category.owner_fi = %s) ORDER BY survey_phrase_category.sequence",
$this->ilias->db->quote($phrase_id),
$this->ilias->db->quote($ilUser->id)
);
$result = $this->ilias->db->query($query);
while ($row = $result->fetchRow(DB_FETCHMODE_OBJECT))
{
if (($row->defaultvalue == 1) and ($row->owner_fi == 0))
{
$this->categories->addCategory($this->lng->txt($row->title));
}
else
{
$this->categories->addCategory($row->title);
}
}
}
| SurveyOrdinalQuestion::addStandardNumbers | ( | $ | lower_limit, | |
| $ | upper_limit | |||
| ) |
Adds standard numbers as categories.
Adds standard numbers as categories
| integer | $lower_limit The lower limit | |
| integer | $upper_limit The upper limit public |
Definition at line 615 of file class.SurveyOrdinalQuestion.php.
{
for ($i = $lower_limit; $i <= $upper_limit; $i++)
{
$this->categories->addCategory($i);
}
}
| SurveyOrdinalQuestion::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 333 of file class.SurveyOrdinalQuestion.php.
References $idx, SurveyQuestion::$material, $result, domxml_open_mem(), SurveyQuestion::getId(), saveToDb(), SurveyQuestion::setAuthor(), SurveyQuestion::setDescription(), SurveyQuestion::setMaterial(), SurveyQuestion::setObligatory(), SurveyQuestion::setOrientation(), 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 "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");
$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:| & SurveyOrdinalQuestion::getAvailablePhrases | ( | $ | useronly = 0 |
) |
Gets the available phrases from the database.
Gets the available phrases from the database
| boolean | $useronly Returns only the user defined phrases if set to true. The default is false. |
Definition at line 83 of file class.SurveyOrdinalQuestion.php.
References $ilUser, $query, $result, and $row.
{
global $ilUser;
$phrases = array();
$query = sprintf("SELECT * FROM survey_phrase WHERE defaultvalue = '1' OR owner_fi = %s ORDER BY title",
$this->ilias->db->quote($ilUser->id)
);
$result = $this->ilias->db->query($query);
while ($row = $result->fetchRow(DB_FETCHMODE_OBJECT))
{
if (($row->defaultvalue == 1) and ($row->owner_fi == 0))
{
if (!$useronly)
{
$phrases[$row->phrase_id] = array(
"title" => $this->lng->txt($row->title),
"owner" => $row->owner_fi
);
}
}
else
{
if ($ilUser->getId() == $row->owner_fi)
{
$phrases[$row->phrase_id] = array(
"title" => $row->title,
"owner" => $row->owner_fi
);
}
}
}
return $phrases;
}
| & SurveyOrdinalQuestion::getCategoriesForPhrase | ( | $ | phrase_id | ) |
Gets the available categories for a given phrase.
Gets the available categories for a given phrase
| integer | $phrase_id The database id of the given phrase |
Definition at line 127 of file class.SurveyOrdinalQuestion.php.
References $categories, $query, $result, and $row.
{
$categories = array();
$query = sprintf("SELECT survey_category.* FROM survey_category, survey_phrase_category WHERE survey_phrase_category.category_fi = survey_category.category_id AND survey_phrase_category.phrase_fi = %s ORDER BY survey_phrase_category.sequence",
$this->ilias->db->quote($phrase_id)
);
$result = $this->ilias->db->query($query);
while ($row = $result->fetchRow(DB_FETCHMODE_OBJECT))
{
if (($row->defaultvalue == 1) and ($row->owner_fi == 0))
{
$categories[$row->category_id] = $this->lng->txt($row->title);
}
else
{
$categories[$row->category_id] = $row->title;
}
}
return $categories;
}
| SurveyOrdinalQuestion::getQuestionType | ( | ) |
Returns the question type of the question.
Returns the question type of the question
Reimplemented from SurveyQuestion.
Definition at line 672 of file class.SurveyOrdinalQuestion.php.
Referenced by saveToDb().
{
return 2;
}
Here is the caller graph for this function:| SurveyOrdinalQuestion::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 237 of file class.SurveyOrdinalQuestion.php.
Referenced by saveToDb(), and syncWithOriginal().
{
if ($this->title and $this->author and $this->questiontext and $this->categories->getCategoryCount())
{
return 1;
}
else
{
return 0;
}
}
Here is the caller graph for this function:| SurveyOrdinalQuestion::loadFromDb | ( | $ | id | ) |
Loads a SurveyOrdinalQuestion object from the database.
Loads a SurveyOrdinalQuestion object from the database
| integer | $id The database id of the ordinal survey question public |
Reimplemented from SurveyQuestion.
Definition at line 186 of file class.SurveyOrdinalQuestion.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->orientation = $data->orientation;
$this->author = $data->author;
$this->owner = $data->owner_fi;
$this->questiontext = $data->questiontext;
$this->obligatory = $data->obligatory;
$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:| SurveyOrdinalQuestion::savePhrase | ( | $ | phrases, | |
| $ | title | |||
| ) |
Saves a set of categories to a default phrase.
Saves a set of categories to a default phrase
| array | $phrases The database ids of the seleted phrases | |
| string | $title The title of the default phrase public |
Definition at line 632 of file class.SurveyOrdinalQuestion.php.
References $counter, $ilUser, $query, $result, and SurveyQuestion::$title.
{
global $ilUser;
$query = sprintf("INSERT INTO survey_phrase (phrase_id, title, defaultvalue, owner_fi, TIMESTAMP) VALUES (NULL, %s, %s, %s, NULL)",
$this->ilias->db->quote($title . ""),
$this->ilias->db->quote("1"),
$this->ilias->db->quote($ilUser->id . "")
);
$result = $this->ilias->db->query($query);
$phrase_id = $this->ilias->db->getLastInsertId();
$counter = 1;
foreach ($phrases as $category)
{
$query = sprintf("INSERT INTO survey_category (category_id, title, defaultvalue, owner_fi, TIMESTAMP) VALUES (NULL, %s, %s, %s, NULL)",
$this->ilias->db->quote($this->categories->getCategory($category) . ""),
$this->ilias->db->quote("1"),
$this->ilias->db->quote($ilUser->id . "")
);
$result = $this->ilias->db->query($query);
$category_id = $this->ilias->db->getLastInsertId();
$query = sprintf("INSERT INTO survey_phrase_category (phrase_category_id, phrase_fi, category_fi, sequence) VALUES (NULL, %s, %s, %s)",
$this->ilias->db->quote($phrase_id . ""),
$this->ilias->db->quote($category_id . ""),
$this->ilias->db->quote($counter . "")
);
$result = $this->ilias->db->query($query);
$counter++;
}
}
| SurveyOrdinalQuestion::saveToDb | ( | $ | original_id = "", |
|
| $ | withanswers = true | |||
| ) |
Saves a SurveyOrdinalQuestion object to a database.
Saves a SurveyOrdinalQuestion object to a database
public
Definition at line 256 of file class.SurveyOrdinalQuestion.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("0"),
$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("0"),
$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:| SurveyOrdinalQuestion::SurveyOrdinalQuestion | ( | $ | title = "", |
|
| $ | description = "", |
|||
| $ | author = "", |
|||
| $ | questiontext = "", |
|||
| $ | owner = -1 | |||
| ) |
SurveyOrdinalQuestion constructor.
The constructor takes possible arguments an creates an instance of the SurveyOrdinalQuestion 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 60 of file class.SurveyOrdinalQuestion.php.
References SurveyQuestion::$author, SurveyQuestion::$description, SurveyQuestion::$owner, SurveyQuestion::$questiontext, SurveyQuestion::$title, and SurveyQuestion::SurveyQuestion().
{
$this->SurveyQuestion($title, $description, $author, $questiontext, $owner);
include_once "./survey/classes/class.SurveyCategories.php";
$this->categories = new SurveyCategories();
}
Here is the call graph for this function:| SurveyOrdinalQuestion::syncWithOriginal | ( | ) |
Reimplemented from SurveyQuestion.
Definition at line 562 of file class.SurveyOrdinalQuestion.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("0"),
$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:| SurveyOrdinalQuestion::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 457 of file class.SurveyOrdinalQuestion.php.
References $pos, $xml, SurveyQuestion::getAuthor(), SurveyQuestion::getDescription(), SurveyQuestion::getId(), SurveyQuestion::getObligatory(), SurveyQuestion::getOrientation(), 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=".ORDINAL_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
$attrs = array(
"ident" => "MCSR",
"rcardinality" => "Single"
);
$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:| SurveyOrdinalQuestion::$categories |
Definition at line 47 of file class.SurveyOrdinalQuestion.php.
Referenced by getCategoriesForPhrase().
1.7.1