Metric survey question. More...
Inheritance diagram for SurveyMetricQuestion:
Collaboration diagram for SurveyMetricQuestion:
Public Member Functions | |
| SurveyMetricQuestion ($title="", $description="", $author="", $questiontext="", $owner=-1, $subtype=SUBTYPE_NON_RATIO) | |
| SurveyMetricQuestion constructor. | |
| setSubtype ($subtype=SUBTYPE_NON_RATIO) | |
| Sets the question subtype. | |
| setMinimum ($minimum=0) | |
| Sets the minimum value. | |
| setMaximum ($maximum="") | |
| Sets the maximum value. | |
| getSubtype () | |
| Gets the question subtype. | |
| getMinimum () | |
| Returns the minimum value of the question. | |
| getMaximum () | |
| Returns the maximum value of the question. | |
| _getQuestionDataArray ($id) | |
| Returns the question data fields from the database. | |
| loadFromDb ($id) | |
| Loads a SurveyMetricQuestion object from the database. | |
| isComplete () | |
| Returns true if the question is complete for use. | |
| saveToDb ($original_id="") | |
| Saves a SurveyMetricQuestion object to a database. | |
| 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 () | |
| getQuestionTypeID () | |
| Returns the question type ID of the question. | |
| 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. | |
| 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. | |
| 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. | |
| outPreconditionSelectValue (&$template) | |
| Creates a value selection for preconditions. | |
| getPreconditionSelectValue ($default="") | |
| Creates a value selection for preconditions. | |
| outChart ($survey_id, $type="") | |
| Creates an image visualising the results of the question. | |
| getMinMaxText () | |
| Creates a text for the input range of the metric question. | |
Data Fields | |
| $subtype | |
| $minimum | |
| $maximum | |
Detailed Description
Metric survey question.
The SurveyMetricQuestion class defines and encapsulates basic methods and attributes for metric survey question types.
- Version:
- Id:
- class.SurveyMetricQuestion.php 15209 2007-11-05 22:17:52Z hschottm
Definition at line 42 of file class.SurveyMetricQuestion.php.
Member Function Documentation
| SurveyMetricQuestion::_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 195 of file class.SurveyMetricQuestion.php.
References SurveyQuestion::$id.
{
global $ilDB;
$query = sprintf("SELECT survey_question.*, survey_question_metric.* FROM survey_question, survey_question_metric WHERE survey_question.question_id = %s AND survey_question.question_id = survey_question_metric.question_fi",
$ilDB->quote($id)
);
$result = $ilDB->query($query);
if ($result->numRows() == 1)
{
return $result->fetchRow(DB_FETCHMODE_ASSOC);
}
else
{
return array();
}
}
| SurveyMetricQuestion::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 925 of file class.SurveyMetricQuestion.php.
References SurveyQuestion::getId().
{
if (count($resultset["answers"][$this->getId()]))
{
foreach ($resultset["answers"][$this->getId()] as $key => $answer)
{
array_push($a_array, $answer["value"]);
}
}
else
{
array_push($a_array, $this->lng->txt("skipped"));
}
}
Here is the call graph for this function:
| SurveyMetricQuestion::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 685 of file class.SurveyMetricQuestion.php.
References SurveyQuestion::$survey_id, SurveyQuestion::getId(), getMaximum(), getMinimum(), and SurveyQuestion::getObligatory().
{
$entered_value = $post_data[$this->getId() . "_metric_question"];
// replace german notation with international notation
$entered_value = str_replace(",", ".", $entered_value);
if ((!$this->getObligatory($survey_id)) && (strlen($entered_value) == 0)) return "";
if (strlen($entered_value) == 0) return $this->lng->txt("survey_question_obligatory");
if (strlen($this->getMinimum()))
{
if ($entered_value < $this->getMinimum())
{
return $this->lng->txt("metric_question_out_of_bounds");
}
}
if (strlen($this->getMaximum()))
{
if (($this->getMaximum() == 1) && ($this->getMaximum() < $this->getMinimum()))
{
// old &infty; values as maximum
}
else
{
if ($entered_value > $this->getMaximum())
{
return $this->lng->txt("metric_question_out_of_bounds");
}
}
}
if (!is_numeric($entered_value))
{
return $this->lng->txt("metric_question_not_a_value");
}
if (($this->getSubType() == SUBTYPE_RATIO_ABSOLUTE) && (intval($entered_value) != doubleval($entered_value)))
{
return $this->lng->txt("metric_question_floating_point");
}
return "";
}
Here is the call graph for this function:
| SurveyMetricQuestion::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 649 of file class.SurveyMetricQuestion.php.
{
return "survey_question_metric";
}
| SurveyMetricQuestion::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 1005 of file class.SurveyMetricQuestion.php.
{
return array("<", "<=", "=", "<>", ">=", ">");
}
| & SurveyMetricQuestion::getCumulatedResults | ( | $ | survey_id, | |
| $ | nr_of_users | |||
| ) |
Definition at line 756 of file class.SurveyMetricQuestion.php.
References SurveyQuestion::$survey_id, $total, 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);
while ($row = $result->fetchRow(DB_FETCHMODE_OBJECT))
{
$cumulated["$row->value"]++;
}
asort($cumulated, SORT_NUMERIC);
end($cumulated);
$numrows = $result->numRows();
$result_array["USERS_ANSWERED"] = $result->numRows();
$result_array["USERS_SKIPPED"] = $nr_of_users - $result->numRows();
$result_array["MODE"] = key($cumulated);
$result_array["MODE_VALUE"] = key($cumulated);
$result_array["MODE_NR_OF_SELECTIONS"] = $cumulated[key($cumulated)];
ksort($cumulated, SORT_NUMERIC);
$counter = 0;
foreach ($cumulated as $value => $nr_of_users)
{
$percentage = 0;
if ($numrows > 0)
{
$percentage = (float)($nr_of_users/$numrows);
}
$result_array["values"][$counter++] = array("value" => $value, "selected" => (int)$nr_of_users, "percentage" => $percentage);
}
$median = array();
$total = 0;
$x_i = 0;
$p_i = 1;
$x_i_inv = 0;
$sum_part_zero = false;
foreach ($cumulated as $value => $key)
{
$total += $key;
for ($i = 0; $i < $key; $i++)
{
array_push($median, $value);
$x_i += $value;
$p_i *= $value;
if ($value != 0)
{
$sum_part_zero = true;
$x_i_inv += 1/$value;
}
}
}
if ($total > 0)
{
if (($total % 2) == 0)
{
$median_value = 0.5 * ($median[($total/2)-1] + $median[($total/2)]);
}
else
{
$median_value = $median[(($total+1)/2)-1];
}
}
else
{
$median_value = "";
}
if ($total > 0)
{
if (($x_i/$total) == (int)($x_i/$total))
{
$result_array["ARITHMETIC_MEAN"] = $x_i/$total;
}
else
{
$result_array["ARITHMETIC_MEAN"] = sprintf("%.2f", $x_i/$total);
}
}
else
{
$result_array["ARITHMETIC_MEAN"] = "";
}
$result_array["MEDIAN"] = $median_value;
$result_array["QUESTION_TYPE"] = "SurveyMetricQuestion";
return $result_array;
}
Here is the call graph for this function:
Here is the caller graph for this function:
| SurveyMetricQuestion::getMaximum | ( | ) |
Returns the maximum value of the question.
Returns the maximum value of the question
- Returns:
- double The maximum value of the question public
- See also:
- $maximum
Definition at line 181 of file class.SurveyMetricQuestion.php.
Referenced by checkUserInput(), getMinMaxText(), and insertXML().
{
return $this->maximum;
}
Here is the caller graph for this function:
| SurveyMetricQuestion::getMinimum | ( | ) |
Returns the minimum value of the question.
Returns the minimum value of the question
- Returns:
- double The minimum value of the question public
- See also:
- $minimum
Definition at line 163 of file class.SurveyMetricQuestion.php.
References getSubtype().
Referenced by checkUserInput(), getMinMaxText(), and insertXML().
{
if ((strlen($this->minimum) == 0) && ($this->getSubtype() > 3))
{
$this->minimum = 0;
}
return $this->minimum;
}
Here is the call graph for this function:
Here is the caller graph for this function:
| SurveyMetricQuestion::getMinMaxText | ( | ) |
Creates a text for the input range of the metric question.
Creates a text for the input range of the metric question
- Returns:
- string Range text private
Definition at line 1091 of file class.SurveyMetricQuestion.php.
References getMaximum(), and getMinimum().
{
$min = $this->getMinimum();
$max = $this->getMaximum();
if (strlen($min) && strlen($max))
{
return "(" . $min . " " . strtolower($this->lng->txt("to")) . " " . $max . ")";
}
else if (strlen($min))
{
return "(>= " . $min . ")";
}
else if (strlen($max))
{
return "(<= " . $max . ")";
}
else
{
return "";
}
}
Here is the call graph for this function:
| SurveyMetricQuestion::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 1033 of file class.SurveyMetricQuestion.php.
References SurveyQuestion::$lng, and ilUtil::prepareFormOutput().
{
global $lng;
include_once "./classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_svy_svy_precondition_select_value_textfield.html", TRUE, TRUE, "Modules/Survey");
if (strlen($default))
{
$template->setCurrentBlock("textfield");
$template->setVariable("TEXTFIELD_VALUE", " value=\"" . ilUtil::prepareFormOutput($default) . "\"");
$template->parseCurrentBlock();
}
else
{
$template->touchBlock("textfield");
}
$template->setVariable("SELECT_VALUE", $lng->txt("step") . " 3: " . $lng->txt("enter_value"));
return $template->get();
}
Here is the call graph for this function:
| SurveyMetricQuestion::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 636 of file class.SurveyMetricQuestion.php.
{
return "SurveyMetricQuestion";
}
| SurveyMetricQuestion::getQuestionTypeID | ( | ) |
Returns the question type ID of the question.
Returns the question type ID of the question
- Returns:
- integer The question type of the question public
Reimplemented from SurveyQuestion.
Definition at line 617 of file class.SurveyMetricQuestion.php.
{
global $ilDB;
$query = sprintf("SELECT questiontype_id FROM survey_questiontype WHERE type_tag = %s",
$ilDB->quote($this->getQuestionType())
);
$result = $ilDB->query($query);
$row = $result->fetchRow(DB_FETCHMODE_ASSOC);
return $row["questiontype_id"];
}
| SurveyMetricQuestion::getSubtype | ( | ) |
Gets the question subtype.
Gets the question subtype
- Returns:
- integer The question subtype public
- See also:
- $subtype
Definition at line 149 of file class.SurveyMetricQuestion.php.
Referenced by getMinimum(), insertXML(), and setExportDetailsXLS().
{
return $this->subtype;
}
Here is the caller graph for this function:
| & SurveyMetricQuestion::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 949 of file class.SurveyMetricQuestion.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))
{
$answers[$row["active_fi"]] = $row["value"];
}
return $answers;
}
Here is the call graph for this function:
| & SurveyMetricQuestion::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 662 of file class.SurveyMetricQuestion.php.
References $data, and SurveyQuestion::getId().
{
$entered_value = $post_data[$this->getId() . "_metric_question"];
$data = array();
if (strlen($entered_value))
{
array_push($data, array("value" => $entered_value));
}
return $data;
}
Here is the call graph for this function:
| SurveyMetricQuestion::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 975 of file class.SurveyMetricQuestion.php.
References $data, SurveyQuestion::$id, setMaximum(), and setMinimum().
{
foreach ($a_data as $id => $data)
{
$this->setMinimum($data["min"]);
$this->setMaximum($data["max"]);
}
}
Here is the call graph for this function:
| SurveyMetricQuestion::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 449 of file class.SurveyMetricQuestion.php.
References SurveyQuestion::addMaterialTag(), SurveyQuestion::getAuthor(), SurveyQuestion::getDescription(), SurveyQuestion::getId(), getMaximum(), getMinimum(), SurveyQuestion::getObligatory(), 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");
switch ($this->getSubtype())
{
case 3:
$attrs = array(
"id" => "0",
"format" => "double"
);
if (strlen($this->getMinimum()))
{
$attrs["min"] = $this->getMinimum();
}
if (strlen($this->getMaximum()))
{
$attrs["max"] = $this->getMaximum();
}
break;
case 4:
$attrs = array(
"id" => "0",
"format" => "double"
);
if (strlen($this->getMinimum()))
{
$attrs["min"] = $this->getMinimum();
}
if (strlen($this->getMaximum()))
{
$attrs["max"] = $this->getMaximum();
}
break;
case 5:
$attrs = array(
"id" => "0",
"format" => "integer"
);
if (strlen($this->getMinimum()))
{
$attrs["min"] = $this->getMinimum();
}
if (strlen($this->getMaximum()))
{
$attrs["max"] = $this->getMaximum();
}
break;
}
$a_xml_writer->xmlStartTag("response_num", $attrs);
$a_xml_writer->xmlEndTag("response_num");
$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->xmlEndTag("question");
}
Here is the call graph for this function:
Here is the caller graph for this function:
| SurveyMetricQuestion::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 280 of file class.SurveyMetricQuestion.php.
Referenced by saveToDb(), and syncWithOriginal().
{
if ($this->title and $this->author and $this->questiontext)
{
return 1;
}
else
{
return 0;
}
}
Here is the caller graph for this function:
| SurveyMetricQuestion::loadFromDb | ( | $ | id | ) |
Loads a SurveyMetricQuestion object from the database.
Loads a SurveyMetricQuestion object from the database
- Parameters:
-
integer $id The database id of the metric survey question public
Reimplemented from SurveyQuestion.
Definition at line 221 of file class.SurveyMetricQuestion.php.
References $data, SurveyQuestion::$id, ilRTE::_replaceMediaObjectImageSrc(), and SurveyQuestion::loadMaterialFromDb().
{
global $ilDB;
$query = sprintf("SELECT survey_question.*, survey_question_metric.* FROM survey_question, survey_question_metric WHERE survey_question.question_id = %s AND survey_question.question_id = survey_question_metric.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->obligatory = $data->obligatory;
$this->author = $data->author;
$this->subtype = $data->subtype;
$this->original_id = $data->original_id;
$this->owner = $data->owner_fi;
include_once("./Services/RTE/classes/class.ilRTE.php");
$this->questiontext = ilRTE::_replaceMediaObjectImageSrc($data->questiontext, 1);
$this->complete = $data->complete;
}
// loads materials uris from database
$this->loadMaterialFromDb($id);
$query = sprintf("SELECT survey_variable.* FROM survey_variable WHERE survey_variable.question_fi = %s",
$ilDB->quote($id)
);
$result = $ilDB->query($query);
if (strcmp(strtolower(get_class($result)), db_result) == 0)
{
if ($data = $result->fetchRow(DB_FETCHMODE_OBJECT))
{
$this->minimum = $data->value1;
if (($data->value2 < 0) or (strcmp($data->value2, "") == 0))
{
$this->maximum = "";
}
else
{
$this->maximum = $data->value2;
}
}
}
}
parent::loadFromDb($id);
}
Here is the call graph for this function:
| SurveyMetricQuestion::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 1063 of file class.SurveyMetricQuestion.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["values"] 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["values"]);
}
Here is the call graph for this function:
| SurveyMetricQuestion::outPreconditionSelectValue | ( | &$ | template | ) |
Creates a value selection for preconditions.
Creates a value selection for preconditions
- Parameters:
-
object $template The template for the value selection (usually tpl.svy_svy_add_constraint.html) public
Definition at line 1018 of file class.SurveyMetricQuestion.php.
{
$template->setCurrentBlock("textfield");
$template->setVariable("TEXTFIELD_VALUE", "");
$template->parseCurrentBlock();
}
| SurveyMetricQuestion::saveToDb | ( | $ | original_id = "" |
) |
Saves a SurveyMetricQuestion object to a database.
Saves a SurveyMetricQuestion object to a database
public
Reimplemented from SurveyQuestion.
Definition at line 299 of file class.SurveyMetricQuestion.php.
References ilRTE::_cleanupMediaObjectUsage(), ilRTE::_replaceMediaObjectImageSrc(), SurveyQuestion::getId(), isComplete(), 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_metric (question_fi, subtype) VALUES (%s, %s)",
$ilDB->quote($this->id . ""),
$ilDB->quote($this->getSubType() . "")
);
$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_metric SET subtype = %s WHERE question_fi = %s",
$ilDB->quote($this->getSubType() . ""),
$ilDB->quote($this->id . "")
);
$result = $ilDB->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",
$ilDB->quote($this->id)
);
$result = $ilDB->query($query);
// create new category relations
if (strcmp($this->minimum, "") == 0)
{
$min = "NULL";
}
else
{
$min = $ilDB->quote($this->minimum);
}
if (preg_match("/[\D]/", $this->maximum) or (strcmp($this->maximum, "∞") == 0))
{
$max = -1;
}
else
{
if (strcmp($this->maximum, "") == 0)
{
$max = "NULL";
}
else
{
$max = $ilDB->quote($this->maximum);
}
}
$query = sprintf("INSERT INTO survey_variable (variable_id, category_fi, question_fi, value1, value2, sequence, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, NULL)",
$ilDB->quote(0),
$ilDB->quote($this->id),
$min,
$max,
$ilDB->quote(0)
);
$answer_result = $ilDB->query($query);
}
parent::saveToDb($original_id);
}
Here is the call graph for this function:
| SurveyMetricQuestion::saveUserInput | ( | $ | post_data, | |
| $ | active_id | |||
| ) |
Definition at line 730 of file class.SurveyMetricQuestion.php.
References SurveyQuestion::getId().
{
global $ilDB;
$entered_value = $post_data[$this->getId() . "_metric_question"];
if (strlen($entered_value) == 0) return;
// replace german notation with international notation
$entered_value = str_replace(",", ".", $entered_value);
if (strlen($entered_value) == 0)
{
$entered_value = "NULL";
}
else
{
$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:
| SurveyMetricQuestion::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 861 of file class.SurveyMetricQuestion.php.
References ilExcelUtils::_convert_text(), SurveyQuestion::getQuestiontext(), getSubtype(), 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, $this->lng->txt("subtype"), $format_bold);
switch ($this->getSubtype())
{
case SUBTYPE_NON_RATIO:
$worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($this->lng->txt("non_ratio")), $format_bold);
break;
case SUBTYPE_RATIO_NON_ABSOLUTE:
$worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($this->lng->txt("ratio_non_absolute")), $format_bold);
break;
case SUBTYPE_RATIO_ABSOLUTE:
$worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($this->lng->txt("ratio_absolute")), $format_bold);
break;
}
$worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("mode")), $format_bold);
$worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($eval_data["MODE"]));
$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("median")), $format_bold);
$worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($eval_data["MEDIAN"]));
$worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("arithmetic_mean")), $format_bold);
$worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($eval_data["ARITHMETIC_MEAN"]));
$worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("values")), $format_bold);
$worksheet->write($rowcounter, 1, ilExcelUtils::_convert_text($this->lng->txt("value")), $format_title);
$worksheet->write($rowcounter, 2, ilExcelUtils::_convert_text($this->lng->txt("category_nr_selected")), $format_title);
$worksheet->write($rowcounter++, 3, ilExcelUtils::_convert_text($this->lng->txt("percentage_of_selections")), $format_title);
$values = "";
if (is_array($eval_data["values"]))
{
foreach ($eval_data["values"] as $key => $value)
{
$worksheet->write($rowcounter, 1, ilExcelUtils::_convert_text($value["value"]));
$worksheet->write($rowcounter, 2, ilExcelUtils::_convert_text($value["selected"]));
$worksheet->write($rowcounter++, 3, ilExcelUtils::_convert_text($value["percentage"]), $format_percent);
}
}
}
Here is the call graph for this function:
| SurveyMetricQuestion::setMaximum | ( | $ | maximum = "" |
) |
Sets the maximum value.
Sets the maximum value
- Parameters:
-
double $maximum The maximum value public
- See also:
- $maximum
Definition at line 135 of file class.SurveyMetricQuestion.php.
References $maximum.
Referenced by importResponses().
{
$this->maximum = $maximum;
}
Here is the caller graph for this function:
| SurveyMetricQuestion::setMinimum | ( | $ | minimum = 0 |
) |
Sets the minimum value.
Sets the minimum value
- Parameters:
-
double $minimum The minimum value public
- See also:
- $minimum
Definition at line 121 of file class.SurveyMetricQuestion.php.
References $minimum.
Referenced by importResponses().
{
$this->minimum = $minimum;
}
Here is the caller graph for this function:
| SurveyMetricQuestion::setSubtype | ( | $ | subtype = SUBTYPE_NON_RATIO |
) |
Sets the question subtype.
Sets the question subtype
- Parameters:
-
integer $subtype The question subtype public
- See also:
- $subtype
Definition at line 107 of file class.SurveyMetricQuestion.php.
References $subtype.
{
$this->subtype = $subtype;
}
| SurveyMetricQuestion::SurveyMetricQuestion | ( | $ | title = "", |
|
| $ | description = "", |
|||
| $ | author = "", |
|||
| $ | questiontext = "", |
|||
| $ | owner = -1, |
|||
| $ | subtype = SUBTYPE_NON_RATIO | |||
| ) |
SurveyMetricQuestion constructor.
The constructor takes possible arguments an creates an instance of the SurveyMetricQuestion 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 82 of file class.SurveyMetricQuestion.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->minimum = "";
$this->maximum = "";
}
Here is the call graph for this function:
| SurveyMetricQuestion::syncWithOriginal | ( | ) |
Reimplemented from SurveyQuestion.
Definition at line 538 of file class.SurveyMetricQuestion.php.
References isComplete().
{
global $ilDB;
if ($this->original_id)
{
$complete = 0;
if ($this->isComplete())
{
$complete = 1;
}
$query = sprintf("UPDATE survey_question SET title = %s, description = %s, author = %s, questiontext = %s, obligatory = %s, complete = %s WHERE question_id = %s",
$ilDB->quote($this->title . ""),
$ilDB->quote($this->description . ""),
$ilDB->quote($this->author . ""),
$ilDB->quote($this->questiontext . ""),
$ilDB->quote(sprintf("%d", $this->obligatory) . ""),
$ilDB->quote($complete . ""),
$ilDB->quote($this->original_id . "")
);
$result = $ilDB->query($query);
$query = sprintf("UPDATE survey_question_metric SET subtype = %s WHERE question_fi = %s",
$ilDB->quote($this->getSubType() . ""),
$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
if (strcmp($this->minimum, "") == 0)
{
$min = "NULL";
}
else
{
$min = $ilDB->quote($this->minimum . "");
}
if (preg_match("/[\D]/", $this->maximum) or (strcmp($this->maximum, "∞") == 0))
{
$max = -1;
}
else
{
if (strcmp($this->maximum, "") == 0)
{
$max = "NULL";
}
else
{
$max = $ilDB->quote($this->maximum . "");
}
}
$query = sprintf("INSERT INTO survey_variable (variable_id, category_fi, question_fi, value1, value2, sequence, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, NULL)",
$ilDB->quote("0"),
$ilDB->quote($this->original_id . ""),
$min,
$max,
$ilDB->quote("0")
);
$answer_result = $ilDB->query($query);
}
}
parent::syncWithOriginal();
}
Here is the call graph for this function:
| SurveyMetricQuestion::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 424 of file class.SurveyMetricQuestion.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:
| SurveyMetricQuestion::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 992 of file class.SurveyMetricQuestion.php.
{
return TRUE;
}
Field Documentation
| SurveyMetricQuestion::$maximum |
Definition at line 69 of file class.SurveyMetricQuestion.php.
Referenced by setMaximum().
| SurveyMetricQuestion::$minimum |
Definition at line 60 of file class.SurveyMetricQuestion.php.
Referenced by setMinimum().
| SurveyMetricQuestion::$subtype |
Definition at line 51 of file class.SurveyMetricQuestion.php.
Referenced by setSubtype(), and SurveyMetricQuestion().
The documentation for this class was generated from the following file:
- Modules/SurveyQuestionPool/classes/class.SurveyMetricQuestion.php
