Nominal survey question. More...
Inheritance diagram for SurveyNominalQuestion:
Collaboration diagram for SurveyNominalQuestion:
Public Member Functions | |
| SurveyNominalQuestion ($title="", $description="", $author="", $questiontext="", $owner=-1, $subtype=SUBTYPE_MCSR, $orientation=0) | |
| SurveyNominalQuestion constructor. | |
| setSubtype ($subtype=SUBTYPE_MCSR) | |
| Sets the question subtype. | |
| getSubtype () | |
| Gets the question subtype. | |
| _getQuestionDataArray ($id) | |
| Returns the question data fields from the database. | |
| 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. | |
| saveCategoriesToDb () | |
| toXML ($a_include_header=TRUE, $obligatory_state="") | |
| Returns an xml representation of the question. | |
| insertXML (&$a_xml_writer, $a_include_header=TRUE, $obligatory_state="") | |
| Adds the question XML to a given XMLWriter object. | |
| syncWithOriginal () | |
| getQuestionType () | |
| Returns the question type of the question. | |
| getAdditionalTableName () | |
| Returns the name of the additional question data table in the database. | |
| & | getWorkingDataFromUserInput ($post_data) |
| Creates the user data of the survey_answer table from the POST data. | |
| checkUserInput ($post_data, $survey_id) | |
| Checks the input of the active user for obligatory status and entered values. | |
| saveUserInput ($post_data, $active_id) | |
| & | getCumulatedResults ($survey_id, $nr_of_users) |
| setExportDetailsXLS (&$workbook, &$format_title, &$format_bold, &$eval_data) | |
| Creates an Excel worksheet for the detailed cumulated results of this question. | |
| addUserSpecificResultsExportTitles (&$a_array) | |
| Adds the entries for the title row of the user specific results. | |
| addUserSpecificResultsData (&$a_array, &$resultset) | |
| Adds the values for the user specific results export for a given user. | |
| & | getUserAnswers ($survey_id) |
| Returns an array containing all answers to this question in a given survey. | |
| importAdditionalMetadata ($a_meta) | |
| Import additional meta data from the question import file. | |
| importResponses ($a_data) | |
| Import response data from the question import file. | |
| usableForPrecondition () | |
| Returns if the question is usable for preconditions. | |
| getAvailableRelations () | |
| Returns the available relations for the question. | |
| getPreconditionSelectValue ($default="") | |
| Creates a value selection for preconditions. | |
| getPreconditionValueOutput ($value) | |
| Returns the output for a precondition value. | |
| outChart ($survey_id, $type="") | |
| Creates an image visualising the results 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 15515 2007-12-07 07:24:12Z hschottm
Definition at line 41 of file class.SurveyNominalQuestion.php.
Member Function Documentation
| SurveyNominalQuestion::_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 127 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::$id.
{
global $ilDB;
$query = sprintf("SELECT survey_question.*, survey_question_nominal.* FROM survey_question, survey_question_nominal WHERE survey_question.question_id = %s AND survey_question.question_id = survey_question_nominal.question_fi",
$ilDB->quote($id)
);
$result = $ilDB->query($query);
if ($result->numRows() == 1)
{
return $result->fetchRow(DB_FETCHMODE_ASSOC);
}
else
{
return array();
}
}
| SurveyNominalQuestion::addUserSpecificResultsData | ( | &$ | a_array, | |
| &$ | resultset | |||
| ) |
Adds the values for the user specific results export for a given user.
Adds the values for the user specific results export for a given user
- Parameters:
-
array $a_array An array which is used to append the values array $resultset The evaluation data for a given user public
Reimplemented from SurveyQuestion.
Definition at line 774 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::getId(), and getSubtype().
{
if (count($resultset["answers"][$this->getId()]))
{
if ($this->getSubtype() == SUBTYPE_MCMR)
{
array_push($a_array, "");
for ($index = 0; $index < $this->categories->getCategoryCount(); $index++)
{
$category = $this->categories->getCategory($index);
$found = 0;
foreach ($resultset["answers"][$this->getId()] as $answerdata)
{
if (strcmp($index, $answerdata["value"]) == 0)
{
$found = 1;
}
}
if ($found)
{
array_push($a_array, "1");
}
else
{
array_push($a_array, "0");
}
}
}
else
{
array_push($a_array, $resultset["answers"][$this->getId()][0]["value"]+1);
}
}
else
{
array_push($a_array, $this->lng->txt("skipped"));
if ($this->getSubtype() == SUBTYPE_MCMR)
{
for ($index = 0; $index < $this->categories->getCategoryCount(); $index++)
{
array_push($a_array, "");
}
}
}
}
Here is the call graph for this function:
| SurveyNominalQuestion::addUserSpecificResultsExportTitles | ( | &$ | a_array | ) |
Adds the entries for the title row of the user specific results.
Adds the entries for the title row of the user specific results
- Parameters:
-
array $a_array An array which is used to append the title row entries public
Reimplemented from SurveyQuestion.
Definition at line 752 of file class.SurveyNominalQuestion.php.
References getSubtype().
{
parent::addUserSpecificResultsExportTitles($a_array);
if ($this->getSubtype() == SUBTYPE_MCMR)
{
for ($index = 0; $index < $this->categories->getCategoryCount(); $index++)
{
$category = $this->categories->getCategory($index);
array_push($a_array, ($index+1) . " - $category");
}
}
}
Here is the call graph for this function:
| SurveyNominalQuestion::checkUserInput | ( | $ | post_data, | |
| $ | survey_id | |||
| ) |
Checks the input of the active user for obligatory status and entered values.
Checks the input of the active user for obligatory status and entered values
- Parameters:
-
array $post_data The contents of the $_POST array integer $survey_id The database ID of the active survey
- Returns:
- string Empty string if the input is ok, an error message otherwise public
Definition at line 559 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::$survey_id, SurveyQuestion::getId(), and SurveyQuestion::getObligatory().
{
// multiple response questions are always non-obligatory
// if ($this->getSubType() == SUBTYPE_MCMR) return "";
$entered_value = $post_data[$this->getId() . "_value"];
if ($this->getSubType() == SUBTYPE_MCMR)
{
if (!$this->getObligatory($survey_id)) return "";
if (!is_array($entered_value))
{
return $this->lng->txt("nominal_question_mr_not_checked");
}
}
else
{
if ((!$this->getObligatory($survey_id)) && (strlen($entered_value) == 0)) return "";
if (strlen($entered_value) == 0) return $this->lng->txt("nominal_question_not_checked");
}
return "";
}
Here is the call graph for this function:
| SurveyNominalQuestion::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 513 of file class.SurveyNominalQuestion.php.
{
return "survey_question_nominal";
}
| SurveyNominalQuestion::getAvailableRelations | ( | ) |
Returns the available relations for the question.
Returns the available relations for the question
- Returns:
- array An array containing the available relations public
Reimplemented from SurveyQuestion.
Definition at line 917 of file class.SurveyNominalQuestion.php.
{
return array("=", "<>");
}
| & SurveyNominalQuestion::getCumulatedResults | ( | $ | survey_id, | |
| $ | nr_of_users | |||
| ) |
Definition at line 619 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::$survey_id, and SurveyQuestion::getId().
Referenced by outChart().
{
global $ilDB;
$question_id = $this->getId();
$result_array = array();
$cumulated = array();
$query = sprintf("SELECT survey_answer.* FROM survey_answer, survey_finished WHERE survey_answer.question_fi = %s AND survey_finished.survey_fi = %s AND survey_finished.finished_id = survey_answer.active_fi",
$ilDB->quote($question_id),
$ilDB->quote($survey_id)
);
$result = $ilDB->query($query);
$numrows = $result->numRows();
// count the answers for every answer value
while ($row = $result->fetchRow(DB_FETCHMODE_OBJECT))
{
$cumulated["$row->value"]++;
}
asort($cumulated, SORT_NUMERIC);
end($cumulated);
if ($this->getSubType() == SUBTYPE_MCMR)
{
$query = sprintf("SELECT survey_answer.answer_id, concat( survey_answer.question_fi, \"_\", survey_answer.active_fi) AS groupval FROM survey_answer, survey_finished WHERE survey_answer.question_fi = %s AND survey_finished.survey_fi = %s AND survey_finished.finished_id = survey_answer.active_fi GROUP BY groupval",
$ilDB->quote($question_id),
$ilDB->quote($survey_id)
);
$mcmr_result = $ilDB->query($query);
$result_array["USERS_ANSWERED"] = $mcmr_result->numRows();
$result_array["USERS_SKIPPED"] = $nr_of_users - $mcmr_result->numRows();
$numrows = $mcmr_result->numRows();
}
else
{
$result_array["USERS_ANSWERED"] = $result->numRows();
$result_array["USERS_SKIPPED"] = $nr_of_users - $result->numRows();
}
$result_array["MEDIAN"] = "";
$result_array["ARITHMETIC_MEAN"] = "";
$prefix = "";
if (strcmp(key($cumulated), "") != 0)
{
$prefix = (key($cumulated)+1) . " - ";
}
$result_array["MODE"] = $prefix . $this->categories->getCategory(key($cumulated));
$result_array["MODE_VALUE"] = key($cumulated)+1;
$result_array["MODE_NR_OF_SELECTIONS"] = $cumulated[key($cumulated)];
$result_array["QUESTION_TYPE"] = "SurveyNominalQuestion";
$maxvalues = 0;
for ($key = 0; $key < $this->categories->getCategoryCount(); $key++)
{
$maxvalues += $cumulated[$key];
}
for ($key = 0; $key < $this->categories->getCategoryCount(); $key++)
{
$percentage = 0;
if ($numrows > 0)
{
if ($this->getSubType() == SUBTYPE_MCMR)
{
if ($maxvalues > 0)
{
$percentage = ($result_array["USERS_ANSWERED"] > 0) ? (float)((int)$cumulated[$key]/$result_array["USERS_ANSWERED"]) : 0;
}
}
else
{
$percentage = ($numrows > 0) ? (float)((int)$cumulated[$key]/$numrows) : 0;
}
}
$result_array["variables"][$key] = array("title" => $this->categories->getCategory($key), "selected" => (int)$cumulated[$key], "percentage" => $percentage);
}
return $result_array;
}
Here is the call graph for this function:
Here is the caller graph for this function:
| SurveyNominalQuestion::getPreconditionSelectValue | ( | $ | default = "" |
) |
Creates a value selection for preconditions.
Creates a value selection for preconditions
- Returns:
- The HTML code for the precondition value selection public
Reimplemented from SurveyQuestion.
Definition at line 930 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::$lng.
{
global $lng;
include_once "./classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_svy_svy_precondition_select_value_combobox.html", TRUE, TRUE, "Modules/Survey");
for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
{
$template->setCurrentBlock("option_v");
$template->setVariable("OPTION_VALUE", $i);
$template->setVariable("OPTION_TEXT", ($i+1) . " - " . $this->categories->getCategory($i));
if ($i == $default)
{
$template->setVariable("OPTION_CHECKED", " selected=\"selected\"");
}
$template->parseCurrentBlock();
}
$template->setVariable("SELECT_VALUE", $lng->txt("step") . " 3: " . $lng->txt("select_value"));
return $template->get();
}
| SurveyNominalQuestion::getPreconditionValueOutput | ( | $ | value | ) |
Returns the output for a precondition value.
Returns the output for a precondition value
- Parameters:
-
string $value The precondition value
- Returns:
- string The output of the precondition value public
Reimplemented from SurveyQuestion.
Definition at line 960 of file class.SurveyNominalQuestion.php.
{
return ($value + 1) . " - " . $this->categories->getCategory($value);
}
| 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 500 of file class.SurveyNominalQuestion.php.
{
return "SurveyNominalQuestion";
}
| SurveyNominalQuestion::getSubtype | ( | ) |
Gets the question subtype.
Gets the question subtype
- Returns:
- integer The question subtype public
- See also:
- $subtype
Definition at line 113 of file class.SurveyNominalQuestion.php.
Referenced by addUserSpecificResultsData(), addUserSpecificResultsExportTitles(), and insertXML().
{
return $this->subtype;
}
Here is the caller graph for this function:
| & SurveyNominalQuestion::getUserAnswers | ( | $ | survey_id | ) |
Returns an array containing all answers to this question in a given survey.
Returns an array containing all answers to this question in a given survey
- Parameters:
-
integer $survey_id The database ID of the survey
- Returns:
- array An array containing the answers to the question. The keys are either the user id or the anonymous id public
Reimplemented from SurveyQuestion.
Definition at line 829 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::$survey_id, and SurveyQuestion::getId().
{
global $ilDB;
$answers = array();
$query = sprintf("SELECT survey_answer.* FROM survey_answer, survey_finished WHERE survey_finished.survey_fi = %s AND survey_answer.question_fi = %s AND survey_finished.finished_id = survey_answer.active_fi",
$ilDB->quote($survey_id),
$ilDB->quote($this->getId())
);
$result = $ilDB->query($query);
while ($row = $result->fetchRow(DB_FETCHMODE_ASSOC))
{
$category = $this->categories->getCategory($row["value"]);
if (!is_array($answers[$row["active_fi"]]))
{
$answers[$row["active_fi"]] = array();
}
array_push($answers[$row["active_fi"]], $row["value"] + 1 . " - " . $category);
}
return $answers;
}
Here is the call graph for this function:
| & SurveyNominalQuestion::getWorkingDataFromUserInput | ( | $ | post_data | ) |
Creates the user data of the survey_answer table from the POST data.
Creates the user data of the survey_answer table from the POST data
- Returns:
- array User data according to the survey_answer table public
Reimplemented from SurveyQuestion.
Definition at line 526 of file class.SurveyNominalQuestion.php.
References $data, and SurveyQuestion::getId().
{
$entered_value = $post_data[$this->getId() . "_value"];
$data = array();
if ($this->getSubType() == SUBTYPE_MCMR)
{
if (is_array($entered_value))
{
foreach ($entered_value as $value)
{
array_push($data, array("value" => $value));
}
}
}
else
{
array_push($data, array("value" => $entered_value));
}
return $data;
}
Here is the call graph for this function:
| SurveyNominalQuestion::importAdditionalMetadata | ( | $ | a_meta | ) |
Import additional meta data from the question import file.
Import additional meta data from the question import file. Usually the meta data section is used to store question elements which are not part of the standard XML schema.
- Returns:
- array $a_meta Array containing the additional meta data public
Reimplemented from SurveyQuestion.
Definition at line 862 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::setOrientation().
{
foreach ($a_meta as $key => $value)
{
switch ($value["label"])
{
case "orientation":
$this->setOrientation($value["entry"]);
break;
}
}
}
Here is the call graph for this function:
| SurveyNominalQuestion::importResponses | ( | $ | a_data | ) |
Import response data from the question import file.
Import response data from the question import file
- Returns:
- array $a_data Array containing the response data public
Reimplemented from SurveyQuestion.
Definition at line 883 of file class.SurveyNominalQuestion.php.
References $data, SurveyQuestion::$id, and SurveyQuestion::$material.
| SurveyNominalQuestion::insertXML | ( | &$ | a_xml_writer, | |
| $ | a_include_header = TRUE, |
|||
| $ | obligatory_state = "" | |||
| ) |
Adds the question XML to a given XMLWriter object.
Adds the question XML to a given XMLWriter object
- Parameters:
-
object $a_xml_writer The XMLWriter object boolean $a_include_header Determines wheather or not the XML should be used string $obligatory_state The value of the obligatory state public
Definition at line 365 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::addMaterialTag(), SurveyQuestion::getAuthor(), SurveyQuestion::getDescription(), SurveyQuestion::getId(), SurveyQuestion::getObligatory(), SurveyQuestion::getOrientation(), SurveyQuestion::getQuestiontext(), getSubtype(), and SurveyQuestion::getTitle().
Referenced by toXML().
{
$attrs = array(
"id" => $this->getId(),
"title" => $this->getTitle(),
"type" => $this->getQuestiontype(),
"subtype" => $this->getSubtype(),
"obligatory" => $this->getObligatory()
);
$a_xml_writer->xmlStartTag("question", $attrs);
$a_xml_writer->xmlElement("description", NULL, $this->getDescription());
$a_xml_writer->xmlElement("author", NULL, $this->getAuthor());
$a_xml_writer->xmlStartTag("questiontext");
$this->addMaterialTag($a_xml_writer, $this->getQuestiontext());
$a_xml_writer->xmlEndTag("questiontext");
$a_xml_writer->xmlStartTag("responses");
for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
{
$attrs = array(
"id" => $i
);
switch ($this->getSubtype())
{
case 1:
$a_xml_writer->xmlStartTag("response_single", $attrs);
break;
case 2:
$a_xml_writer->xmlStartTag("response_multiple", $attrs);
break;
}
$this->addMaterialTag($a_xml_writer, $this->categories->getCategory($i));
switch ($this->getSubtype())
{
case 1:
$a_xml_writer->xmlEndTag("response_single");
break;
case 2:
$a_xml_writer->xmlEndTag("response_multiple");
break;
}
}
$a_xml_writer->xmlEndTag("responses");
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->xmlStartTag("metadata");
$a_xml_writer->xmlStartTag("metadatafield");
$a_xml_writer->xmlElement("fieldlabel", NULL, "orientation");
$a_xml_writer->xmlElement("fieldentry", NULL, $this->getOrientation());
$a_xml_writer->xmlEndTag("metadatafield");
$a_xml_writer->xmlEndTag("metadata");
$a_xml_writer->xmlEndTag("question");
}
Here is the call graph for this function:
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 206 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 153 of file class.SurveyNominalQuestion.php.
References $data, SurveyQuestion::$id, ilRTE::_replaceMediaObjectImageSrc(), and SurveyQuestion::loadMaterialFromDb().
{
global $ilDB;
$query = sprintf("SELECT survey_question.*, survey_question_nominal.* FROM survey_question, survey_question_nominal WHERE survey_question.question_id = %s AND survey_question.question_id = survey_question_nominal.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->subtype = $data->subtype;
$this->orientation = $data->orientation;
$this->obligatory = $data->obligatory;
$this->owner = $data->owner_fi;
include_once("./Services/RTE/classes/class.ilRTE.php");
$this->questiontext = ilRTE::_replaceMediaObjectImageSrc($data->questiontext, 1);
$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",
$ilDB->quote($id)
);
$result = $ilDB->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::outChart | ( | $ | survey_id, | |
| $ | type = "" | |||
| ) |
Creates an image visualising the results of the question.
Creates an image visualising the results of the question
- Parameters:
-
integer $survey_id The database ID of the survey string $type An additional parameter to allow to draw more than one chart per question. Must be interpreted by the question. Default is an empty string
- Returns:
- binary Image with the visualisation private
Reimplemented from SurveyQuestion.
Definition at line 976 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::$survey_id, ilObjSurvey::_getNrOfParticipants(), getCumulatedResults(), and SurveyQuestion::getTitle().
{
if (count($this->cumulated) == 0)
{
include_once "./Modules/Survey/classes/class.ilObjSurvey.php";
$nr_of_users = ilObjSurvey::_getNrOfParticipants($survey_id);
$this->cumulated =& $this->getCumulatedResults($survey_id, $nr_of_users);
}
foreach ($this->cumulated["variables"] as $key => $value)
{
foreach ($value as $key2 => $value2)
{
$this->cumulated["variables"][$key][$key2] = utf8_decode($value2);
}
}
include_once "./Modules/SurveyQuestionPool/classes/class.SurveyChart.php";
$b1 = new SurveyChart("bars",400,250,utf8_decode($this->getTitle()),utf8_decode($this->lng->txt("answers")),utf8_decode($this->lng->txt("users_answered")),$this->cumulated["variables"]);
}
Here is the call graph for this function:
| SurveyNominalQuestion::saveCategoriesToDb | ( | ) |
Definition at line 308 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::saveCategoryToDb(), and SurveyQuestion::saveCompletionStatus().
Referenced by saveToDb().
{
// 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
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->id . ""),
$this->ilias->db->quote(($i + 1) . ""),
$this->ilias->db->quote($i . "")
);
$answer_result = $this->ilias->db->query($query);
}
$this->saveCompletionStatus();
}
Here is the call graph for this function:
Here is the caller 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 225 of file class.SurveyNominalQuestion.php.
References ilRTE::_cleanupMediaObjectUsage(), ilRTE::_replaceMediaObjectImageSrc(), SurveyQuestion::getId(), isComplete(), saveCategoriesToDb(), and SurveyQuestion::saveMaterialsToDb().
{
global $ilDB;
$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->getQuestionTypeID()),
$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_nominal (question_fi, subtype, orientation) VALUES (%s, %s, %s)",
$ilDB->quote($this->id . ""),
$ilDB->quote($this->getSubType() . ""),
$ilDB->quote(sprintf("%d", $this->orientation))
);
$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_nominal SET subtype = %s, orientation = %s WHERE question_fi = %s",
$ilDB->quote($this->getSubType() . ""),
$ilDB->quote(sprintf("%d", $this->orientation)),
$ilDB->quote($this->id . "")
);
$result = $ilDB->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:
| SurveyNominalQuestion::saveUserInput | ( | $ | post_data, | |
| $ | active_id | |||
| ) |
Definition at line 582 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::getId().
{
global $ilDB;
if (is_array($post_data[$this->getId() . "_value"]))
{
foreach ($post_data[$this->getId() . "_value"] as $value)
{
$entered_value = $value;
if (strlen($entered_value) > 0)
{
$entered_value = $ilDB->quote($entered_value . "");
$query = sprintf("INSERT INTO survey_answer (answer_id, question_fi, active_fi, value, textanswer, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, NULL)",
$ilDB->quote($this->getId() . ""),
$ilDB->quote($active_id . ""),
$entered_value,
"NULL"
);
$result = $ilDB->query($query);
}
}
}
else
{
$entered_value = $post_data[$this->getId() . "_value"];
if (strlen($entered_value) == 0) return;
$entered_value = $ilDB->quote($entered_value . "");
$query = sprintf("INSERT INTO survey_answer (answer_id, question_fi, active_fi, value, textanswer, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, NULL)",
$ilDB->quote($this->getId() . ""),
$ilDB->quote($active_id . ""),
$entered_value,
"NULL"
);
$result = $ilDB->query($query);
}
}
Here is the call graph for this function:
| SurveyNominalQuestion::setExportDetailsXLS | ( | &$ | workbook, | |
| &$ | format_title, | |||
| &$ | format_bold, | |||
| &$ | eval_data | |||
| ) |
Creates an Excel worksheet for the detailed cumulated results of this question.
Creates an Excel worksheet for the detailed cumulated results of this question
- Parameters:
-
object $workbook Reference to the parent excel workbook object $format_title Excel title format object $format_bold Excel bold format array $eval_data Cumulated evaluation data public
Reimplemented from SurveyQuestion.
Definition at line 708 of file class.SurveyNominalQuestion.php.
References ilExcelUtils::_convert_text(), SurveyQuestion::getQuestiontext(), and SurveyQuestion::getTitle().
{
include_once ("./classes/class.ilExcelUtils.php");
$worksheet =& $workbook->addWorksheet();
$worksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("title")), $format_bold);
$worksheet->writeString(0, 1, ilExcelUtils::_convert_text($this->getTitle()));
$worksheet->writeString(1, 0, ilExcelUtils::_convert_text($this->lng->txt("question")), $format_bold);
$worksheet->writeString(1, 1, ilExcelUtils::_convert_text($this->getQuestiontext()));
$worksheet->writeString(2, 0, ilExcelUtils::_convert_text($this->lng->txt("question_type")), $format_bold);
$worksheet->writeString(2, 1, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())));
$worksheet->writeString(3, 0, ilExcelUtils::_convert_text($this->lng->txt("users_answered")), $format_bold);
$worksheet->write(3, 1, $eval_data["USERS_ANSWERED"]);
$worksheet->writeString(4, 0, ilExcelUtils::_convert_text($this->lng->txt("users_skipped")), $format_bold);
$worksheet->write(4, 1, $eval_data["USERS_SKIPPED"]);
$rowcounter = 5;
$worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("mode")), $format_bold);
$worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($eval_data["MODE_VALUE"]));
$worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("mode_text")), $format_bold);
$worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($eval_data["MODE"]));
$worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("mode_nr_of_selections")), $format_bold);
$worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($eval_data["MODE_NR_OF_SELECTIONS"]));
$worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("categories")), $format_bold);
$worksheet->write($rowcounter, 1, ilExcelUtils::_convert_text($this->lng->txt("title")), $format_title);
$worksheet->write($rowcounter, 2, ilExcelUtils::_convert_text($this->lng->txt("value")), $format_title);
$worksheet->write($rowcounter, 3, ilExcelUtils::_convert_text($this->lng->txt("category_nr_selected")), $format_title);
$worksheet->write($rowcounter++, 4, ilExcelUtils::_convert_text($this->lng->txt("percentage_of_selections")), $format_title);
foreach ($eval_data["variables"] as $key => $value)
{
$worksheet->write($rowcounter, 1, ilExcelUtils::_convert_text($value["title"]));
$worksheet->write($rowcounter, 2, $key+1);
$worksheet->write($rowcounter, 3, ilExcelUtils::_convert_text($value["selected"]));
$worksheet->write($rowcounter++, 4, ilExcelUtils::_convert_text($value["percentage"]), $format_percent);
}
}
Here is the call 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 99 of file class.SurveyNominalQuestion.php.
References $subtype.
{
$this->subtype = $subtype;
}
| SurveyNominalQuestion::SurveyNominalQuestion | ( | $ | title = "", |
|
| $ | description = "", |
|||
| $ | author = "", |
|||
| $ | questiontext = "", |
|||
| $ | owner = -1, |
|||
| $ | subtype = SUBTYPE_MCSR, |
|||
| $ | orientation = 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 72 of file class.SurveyNominalQuestion.php.
References SurveyQuestion::$author, SurveyQuestion::$description, SurveyQuestion::$orientation, SurveyQuestion::$owner, SurveyQuestion::$questiontext, $subtype, SurveyQuestion::$title, and SurveyQuestion::SurveyQuestion().
{
$this->SurveyQuestion($title, $description, $author, $questiontext, $owner);
$this->subtype = $subtype;
$this->orientation = $orientation;
include_once "./Modules/SurveyQuestionPool/classes/class.SurveyCategories.php";
$this->categories = new SurveyCategories();
}
Here is the call graph for this function:
| SurveyNominalQuestion::syncWithOriginal | ( | ) |
Reimplemented from SurveyQuestion.
Definition at line 440 of file class.SurveyNominalQuestion.php.
References isComplete(), and SurveyQuestion::saveCategoryToDb().
{
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_nominal SET subtype = %s, orientation = %s WHERE question_fi = %s",
$ilDB->quote($this->getSubType() . ""),
$ilDB->quote($this->getOrientation() . ""),
$ilDB->quote($this->original_id . "")
);
$result = $ilDB->query($query);
if ($result == DB_OK) {
// save categories
// delete existing category relations
$query = sprintf("DELETE FROM survey_variable WHERE question_fi = %s",
$ilDB->quote($this->original_id . "")
);
$result = $ilDB->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)",
$ilDB->quote($category_id . ""),
$ilDB->quote($this->original_id . ""),
$ilDB->quote(($i + 1) . ""),
$ilDB->quote($i . "")
);
$answer_result = $ilDB->query($query);
}
}
}
parent::syncWithOriginal();
}
Here is the call graph for this function:
| SurveyNominalQuestion::toXML | ( | $ | a_include_header = TRUE, |
|
| $ | obligatory_state = "" | |||
| ) |
Returns an xml representation of the question.
Returns an xml representation of the question
- Returns:
- string The xml representation of the question public
Definition at line 340 of file class.SurveyNominalQuestion.php.
References insertXML().
{
include_once("./classes/class.ilXmlWriter.php");
$a_xml_writer = new ilXmlWriter;
$a_xml_writer->xmlHeader();
$this->insertXML($a_xml_writer, $a_include_header, $obligatory_state);
$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:
| SurveyNominalQuestion::usableForPrecondition | ( | ) |
Returns if the question is usable for preconditions.
Returns if the question is usable for preconditions
- Returns:
- boolean TRUE if the question is usable for a precondition, FALSE otherwise public
Reimplemented from SurveyQuestion.
Definition at line 904 of file class.SurveyNominalQuestion.php.
{
return TRUE;
}
Field Documentation
| SurveyNominalQuestion::$categories |
Definition at line 59 of file class.SurveyNominalQuestion.php.
| SurveyNominalQuestion::$subtype |
Definition at line 50 of file class.SurveyNominalQuestion.php.
Referenced by setSubtype(), and SurveyNominalQuestion().
The documentation for this class was generated from the following file:
- Modules/SurveyQuestionPool/classes/class.SurveyNominalQuestion.php
