ILIAS  Release_4_1_x_branch Revision 61804
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields
SurveyMetricQuestion Class Reference
Modules/SurveyQuestionPool

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.
 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 svy_answer table from the POST data.
 checkUserInput ($post_data, $survey_id)
 Checks the input of the active user for obligatory status and entered values.
 saveRandomData ($active_id)
 Saves random answers for a given active user in the database.
 saveUserInput ($post_data, $active_id)
& getCumulatedResults ($survey_id, $nr_of_users)
 setExportDetailsXLS (&$workbook, &$format_title, &$format_bold, &$eval_data, $export_label)
 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="", $title, $variable)
 Creates a form property for the precondition value.
 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.
- Public Member Functions inherited from SurveyQuestion
 SurveyQuestion ($title="", $description="", $author="", $questiontext="", $owner=-1)
 SurveyQuestion constructor The constructor takes possible arguments an creates an instance of the SurveyQuestion object.
 _SurveyQuestion ()
 setComplete ($a_complete)
 Sets the complete state of the question.
 questionTitleExists ($title, $questionpool_object="")
 Returns TRUE if the question title exists in the database.
 setTitle ($title="")
 Sets the title string of the SurveyQuestion object.
 setObligatory ($obligatory=1)
 Sets the obligatory state of the question.
 setOrientation ($orientation=0)
 Sets the orientation of the question output.
 setId ($id=-1)
 Sets the id of the SurveyQuestion object.
 setSurveyId ($id=-1)
 Sets the survey id of the SurveyQuestion object.
 setDescription ($description="")
 Sets the description string of the SurveyQuestion object.
 addMaterials ($materials_file, $materials_name="")
 Sets the materials uri.
 setMaterialsfile ($materials_filename, $materials_tempfilename="", $materials_name="")
 Sets and uploads the materials uri.
 deleteMaterial ($materials_name="")
 Deletes a materials uri with a given name.
 flushMaterials ()
 Deletes all materials uris.
 setAuthor ($author="")
 Sets the authors name of the SurveyQuestion object.
 setQuestiontext ($questiontext="")
 Sets the questiontext of the SurveyQuestion object.
 setOwner ($owner="")
 Sets the creator/owner ID of the SurveyQuestion object.
 getTitle ()
 Gets the title string of the SurveyQuestion object.
 getId ()
 Gets the id of the SurveyQuestion object.
 getObligatory ($survey_id="")
 Gets the obligatory state of the question.
 getSurveyId ()
 Gets the survey id of the SurveyQuestion object.
 getOrientation ()
 Gets the orientation of the question output.
 getDescription ()
 Gets the description string of the SurveyQuestion object.
 getAuthor ()
 Gets the authors name of the SurveyQuestion object.
 getOwner ()
 Gets the creator/owner ID of the SurveyQuestion object.
 getQuestiontext ()
 Gets the questiontext of the SurveyQuestion object.
 getObjId ()
 Get the reference id of the container object.
 setObjId ($obj_id=0)
 Set the reference id of the container object.
 duplicate ($for_survey=true, $title="", $author="", $owner="")
 Duplicates a survey question.
 copyObject ($target_questionpool, $title="")
 Copies an assOrderingQuestion object.
 copyXHTMLMediaObjectsOfQuestion ($a_q_id)
 Increases the media object usage counter when a question is duplicated.
 _isComplete ($question_id)
 Checks whether the question is complete or not.
 saveCompletionStatus ($original_id="")
 Saves the complete flag to the database.
 saveMaterial ()
 save material to db
 createNewQuestion ()
 Creates a new question with a 0 timestamp when a new question is created This assures that an ID is given to the question if a file upload or something else occurs.
 saveWorkingData ($limit_to=LIMIT_NO_LIMIT)
 Saves the learners input of the question to the database.
 getImagePath ()
 Returns the image path for web accessable images of a question.
 getMaterialsPath ()
 Returns the materials path for web accessable materials of a question.
 getImagePathWeb ()
 Returns the web image path for web accessable images of a question.
 getMaterialsPathWeb ()
 Returns the web image path for web accessable images of a question.
 saveCategoryToDb ($categorytext, $neutral=0)
 Saves a category to the database.
 deleteAdditionalTableData ($question_id)
 Deletes datasets from the additional question table in the database.
 delete ($question_id)
 Deletes a question and all materials from the database.
 _getQuestionType ($question_id)
 Returns the question type of a question with a given id.
 _getTitle ($question_id)
 Returns the question title of a question with a given id.
 _getOriginalId ($question_id)
 Returns the original id of a question.
 syncWithOriginal ()
 getPhrase ($phrase_id)
 Returns a phrase for a given database id.
 phraseExists ($title)
 Returns true if the phrase title already exists for the current user.
 _questionExists ($question_id)
 Returns true if the question already exists in the database.
 addInternalLink ($material_id, $title="")
 deleteMaterials ($a_array)
 Deletes materials.
 duplicateMaterials ($question_id)
 Duplicates the materials of a question.
 addMaterial ($obj_material)
 setMaterial ($material_id="", $is_import=false, $material_title="")
 Sets a material link for the question.
 _resolveInternalLink ($internal_link)
 _resolveIntLinks ($question_id)
 _getInternalLinkHref ($target="")
 _isWriteable ($question_id, $user_id)
 Returns true if the question is writeable by a certain user.
& _instanciateQuestion ($question_id)
 Creates an instance of a question with a given question id.
& _instanciateQuestionGUI ($question_id)
 Creates an instance of a question GUI with a given question id.
 isHTML ($a_text)
 Checks if a given string contains HTML or not.
 QTIMaterialToString ($a_material)
 Reads an QTI material tag an creates a text string.
 addMaterialTag (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE, $a_attrs=null)
 Creates an XML material tag from a plain text or xhtml text.
 prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
 Prepares a string for a text area output in surveys.
 addUserSpecificResultsExportTitles (&$a_array, $a_export_label="")
 Adds the entries for the title row of the user specific results.
 importAdditionalMetadata ($a_meta)
 Import additional meta data from the question import file.
 importAdjectives ($a_data)
 Import bipolar adjectives from the question import file.
 importMatrix ($a_data)
 Import matrix rows from the question import file.
 setExportCumulatedXLS (&$worksheet, &$format_title, &$format_bold, &$eval_data, $row, $export_label)
 Creates the Excel output for the cumulated results of this question.
& setExportCumulatedCVS (&$eval_data, $export_label)
 Creates the CSV output for the cumulated results of this question.
 getPreconditionOptions ()
 Returns the options for preconditions.
 getPreconditionValueOutput ($value)
 Returns the output for a precondition value.
 setOriginalId ($original_id)
 getOriginalId ()
 getMaterial ()
 getCumulatedResultData ($survey_id, $counter)
 Creates a the cumulated results data for the question.
 __get ($value)
 Object getter.
 __set ($key, $value)
 Object setter.

Data Fields

 $subtype
 $minimum
 $maximum
- Data Fields inherited from SurveyQuestion
 $id
 $title
 $description
 $owner
 $author
 $materials
 $survey_id
 $obj_id
 $questiontext
 $obligatory
 $ilias
 $tpl
 $lng
 $orientation
 $material
 $complete

Additional Inherited Members

- Static Public Member Functions inherited from SurveyQuestion
static _includeClass ($question_type, $gui=0)
 Include the php class file for a given question type.
static _getQuestionTypeName ($type_tag)
 Return the translation for a given question type tag.
- Protected Member Functions inherited from SurveyQuestion
& calculateCumulatedResults ($survey_id)
- Protected Attributes inherited from SurveyQuestion
 $cumulated
 An array containing the cumulated results of the question for a given survey.

Detailed Description

Metric survey question.

The SurveyMetricQuestion class defines and encapsulates basic methods and attributes for metric survey question types.

Author
Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m
Version
Id:
class.SurveyMetricQuestion.php 28081 2011-03-13 15:23:20Z hschottm

Definition at line 42 of file class.SurveyMetricQuestion.php.

Member Function Documentation

SurveyMetricQuestion::_getQuestionDataArray (   $id)

Returns the question data fields from the database.

Parameters
integer$idThe question ID from the database
Returns
array Array containing the question fields and data from the database public

Reimplemented from SurveyQuestion.

Definition at line 176 of file class.SurveyMetricQuestion.php.

References SurveyQuestion\$id, $ilDB, $result, and getAdditionalTableName().

{
global $ilDB;
$result = $ilDB->queryF("SELECT svy_question.*, " . $this->getAdditionalTableName() . ".* FROM svy_question, " . $this->getAdditionalTableName() . " WHERE svy_question.question_id = %s AND svy_question.question_id = " . $this->getAdditionalTableName() . ".question_fi",
array('integer'),
array($id)
);
if ($result->numRows() == 1)
{
return $ilDB->fetchAssoc($result);
}
else
{
return array();
}
}

+ Here is the call graph for this function:

SurveyMetricQuestion::addUserSpecificResultsData ( &  $a_array,
&  $resultset 
)

Adds the values for the user specific results export for a given user.

Parameters
array$a_arrayAn array which is used to append the values
array$resultsetThe evaluation data for a given user public

Reimplemented from SurveyQuestion.

Definition at line 757 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.

Parameters
array$post_dataThe contents of the $_POST array
integer$survey_idThe database ID of the active survey
Returns
string Empty string if the input is ok, an error message otherwise public

Definition at line 495 of file class.SurveyMetricQuestion.php.

References SurveyQuestion\$survey_id, SurveyQuestion\getId(), getMaximum(), getMinimum(), SurveyQuestion\getObligatory(), and SUBTYPE_RATIO_ABSOLUTE.

{
$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
string The additional table name public

Definition at line 464 of file class.SurveyMetricQuestion.php.

Referenced by _getQuestionDataArray(), loadFromDb(), and saveToDb().

{
return "svy_qst_metric";
}

+ Here is the caller graph for this function:

SurveyMetricQuestion::getAvailableRelations ( )

Returns the available relations for the question.

Returns
array An array containing the available relations public

Reimplemented from SurveyQuestion.

Definition at line 828 of file class.SurveyMetricQuestion.php.

{
return array("<", "<=", "=", "<>", ">=", ">");
}
& SurveyMetricQuestion::getCumulatedResults (   $survey_id,
  $nr_of_users 
)

Definition at line 572 of file class.SurveyMetricQuestion.php.

References SurveyQuestion\$cumulated, $ilDB, $result, $row, SurveyQuestion\$survey_id, $total, and SurveyQuestion\getId().

Referenced by outChart().

{
global $ilDB;
$question_id = $this->getId();
$result_array = array();
$cumulated = array();
$result = $ilDB->queryF("SELECT svy_answer.* FROM svy_answer, svy_finished WHERE svy_answer.question_fi = %s AND svy_finished.survey_fi = %s AND svy_finished.finished_id = svy_answer.active_fi",
array('integer', 'integer'),
array($question_id, $survey_id)
);
while ($row = $ilDB->fetchAssoc($result))
{
$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
double The maximum value of the question public
See Also
$maximum

Definition at line 164 of file class.SurveyMetricQuestion.php.

Referenced by checkUserInput(), getMinMaxText(), insertXML(), saveRandomData(), and saveToDb().

{
return (strlen($this->maximum)) ? $this->maximum : NULL;
}

+ Here is the caller graph for this function:

SurveyMetricQuestion::getMinimum ( )

Returns the minimum value of the question.

Returns
double The minimum value of the question public
See Also
$minimum

Definition at line 148 of file class.SurveyMetricQuestion.php.

References getSubtype().

Referenced by checkUserInput(), getMinMaxText(), insertXML(), saveRandomData(), and saveToDb().

{
if ((strlen($this->minimum) == 0) && ($this->getSubtype() > 3))
{
$this->minimum = 0;
}
return (strlen($this->minimum)) ? $this->minimum : NULL;
}

+ 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.

Returns
string Range text private

Definition at line 894 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 "(&gt;= " . $min . ")";
}
else if (strlen($max))
{
return "(&lt;= " . $max . ")";
}
else
{
return "";
}
}

+ Here is the call graph for this function:

SurveyMetricQuestion::getPreconditionSelectValue (   $default = "",
  $title,
  $variable 
)

Creates a form property for the precondition value.

Returns
The ILIAS form element public

Reimplemented from SurveyQuestion.

Definition at line 852 of file class.SurveyMetricQuestion.php.

References SurveyQuestion\$title.

{
include_once "./Services/Form/classes/class.ilNumberInputGUI.php";
$step3 = new ilNumberInputGUI($title, $variable);
$step3->setValue($default);
return $step3;
}
SurveyMetricQuestion::getQuestionType ( )

Returns the question type of the question.

Returns
integer The question type of the question public

Reimplemented from SurveyQuestion.

Definition at line 453 of file class.SurveyMetricQuestion.php.

Referenced by getQuestionTypeID().

{
return "SurveyMetricQuestion";
}

+ Here is the caller graph for this function:

SurveyMetricQuestion::getQuestionTypeID ( )

Returns the question type ID of the question.

Returns
integer The question type of the question public

Reimplemented from SurveyQuestion.

Definition at line 436 of file class.SurveyMetricQuestion.php.

References $ilDB, $result, $row, and getQuestionType().

{
global $ilDB;
$result = $ilDB->queryF("SELECT questiontype_id FROM svy_qtype WHERE type_tag = %s",
array('text'),
array($this->getQuestionType())
);
$row = $ilDB->fetchAssoc($result);
return $row["questiontype_id"];
}

+ Here is the call graph for this function:

SurveyMetricQuestion::getSubtype ( )

Gets the question subtype.

Returns
integer The question subtype public
See Also
$subtype

Reimplemented from SurveyQuestion.

Definition at line 136 of file class.SurveyMetricQuestion.php.

References $subtype.

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.

Parameters
integer$survey_idThe 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 779 of file class.SurveyMetricQuestion.php.

References $ilDB, $result, $row, SurveyQuestion\$survey_id, and SurveyQuestion\getId().

{
global $ilDB;
$answers = array();
$result = $ilDB->queryF("SELECT svy_answer.* FROM svy_answer, svy_finished WHERE svy_finished.survey_fi = %s AND svy_answer.question_fi = %s AND svy_finished.finished_id = svy_answer.active_fi",
array('integer','integer'),
array($survey_id, $this->getId())
);
while ($row = $ilDB->fetchAssoc($result))
{
$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 svy_answer table from the POST data.

Returns
array User data according to the svy_answer table public

Reimplemented from SurveyQuestion.

Definition at line 475 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.

Returns
array $a_data Array containing the response data public

Reimplemented from SurveyQuestion.

Definition at line 802 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.

Parameters
object$a_xml_writerThe XMLWriter object
boolean$a_include_headerDetermines wheather or not the XML should be used
string$obligatory_stateThe value of the obligatory state public

Definition at line 341 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
boolean True if the question is complete for use, otherwise false public

Reimplemented from SurveyQuestion.

Definition at line 254 of file class.SurveyMetricQuestion.php.

{
if ($this->title and $this->author and $this->questiontext)
{
return 1;
}
else
{
return 0;
}
}
SurveyMetricQuestion::loadFromDb (   $id)

Loads a SurveyMetricQuestion object from the database.

Parameters
integer$idThe database id of the metric survey question public

Reimplemented from SurveyQuestion.

Definition at line 200 of file class.SurveyMetricQuestion.php.

References $data, SurveyQuestion\$id, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), SurveyQuestion\setAuthor(), SurveyQuestion\setComplete(), SurveyQuestion\setDescription(), SurveyQuestion\setId(), SurveyQuestion\setObjId(), SurveyQuestion\setObligatory(), SurveyQuestion\setOriginalId(), SurveyQuestion\setOwner(), SurveyQuestion\setQuestiontext(), setSubtype(), and SurveyQuestion\setTitle().

{
global $ilDB;
$result = $ilDB->queryF("SELECT svy_question.*, " . $this->getAdditionalTableName() . ".* FROM svy_question LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = svy_question.question_id WHERE svy_question.question_id = %s",
array('integer'),
array($id)
);
if ($result->numRows() == 1)
{
$data = $ilDB->fetchAssoc($result);
$this->setId($data["question_id"]);
$this->setTitle($data["title"]);
$this->setDescription($data["description"]);
$this->setObjId($data["obj_fi"]);
$this->setAuthor($data["author"]);
$this->setOwner($data["owner_fi"]);
$this->label = $data['label'];
include_once("./Services/RTE/classes/class.ilRTE.php");
$this->setQuestiontext(ilRTE::_replaceMediaObjectImageSrc($data["questiontext"], 1));
$this->setObligatory($data["obligatory"]);
$this->setComplete($data["complete"]);
$this->setOriginalId($data["original_id"]);
$this->setSubtype($data["subtype"]);
$result = $ilDB->queryF("SELECT svy_variable.* FROM svy_variable WHERE svy_variable.question_fi = %s",
array('integer'),
array($id)
);
if ($result->numRows() > 0)
{
if ($data = $ilDB->fetchAssoc($result))
{
$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.

Parameters
integer$survey_idThe database ID of the survey
string$typeAn 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 868 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.

Parameters
object$templateThe template for the value selection (usually tpl.svy_svy_add_constraint.html) public

Definition at line 839 of file class.SurveyMetricQuestion.php.

{
$template->setCurrentBlock("textfield");
$template->setVariable("TEXTFIELD_VALUE", "");
$template->parseCurrentBlock();
}
SurveyMetricQuestion::saveRandomData (   $active_id)

Saves random answers for a given active user in the database.

Parameters
integer$active_idThe database ID of the active user

Reimplemented from SurveyQuestion.

Definition at line 545 of file class.SurveyMetricQuestion.php.

References $ilDB, SurveyQuestion\getId(), getMaximum(), and getMinimum().

{
global $ilDB;
// single response
$number = rand($this->getMinimum(), (strlen($this->getMaximum())) ? $this->getMaximum() : 100);
$next_id = $ilDB->nextId('svy_answer');
$affectedRows = $ilDB->manipulateF("INSERT INTO svy_answer (answer_id, question_fi, active_fi, value, textanswer, tstamp) VALUES (%s, %s, %s, %s, %s, %s)",
array('integer','integer','integer','float','text','integer'),
array($next_id, $this->getId(), $active_id, $number, NULL, time())
);
}

+ Here is the call graph for this function:

SurveyMetricQuestion::saveToDb (   $original_id = "")

Saves a SurveyMetricQuestion object to a database.

public

Reimplemented from SurveyQuestion.

Definition at line 271 of file class.SurveyMetricQuestion.php.

References $ilDB, getAdditionalTableName(), SurveyQuestion\getId(), getMaximum(), getMinimum(), and SurveyQuestion\saveMaterial().

{
global $ilDB;
$affectedRows = parent::saveToDb($original_id);
if ($affectedRows == 1)
{
$affectedRows = $ilDB->manipulateF("DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
array('integer'),
array($this->getId())
);
$affectedRows = $ilDB->manipulateF("INSERT INTO " . $this->getAdditionalTableName() . " (question_fi, subtype) VALUES (%s, %s)",
array('integer', 'text'),
array($this->getId(), $this->getSubType())
);
// saving material uris in the database
$this->saveMaterial();
// save categories
$affectedRows = $ilDB->manipulateF("DELETE FROM svy_variable WHERE question_fi = %s",
array('integer'),
array($this->getId())
);
if (preg_match("/[\D]/", $this->maximum) or (strcmp($this->maximum, "&infin;") == 0))
{
$max = -1;
}
else
{
$max = $this->getMaximum();
}
$next_id = $ilDB->nextId('svy_variable');
$affectedRows = $ilDB->manipulateF("INSERT INTO svy_variable (variable_id, category_fi, question_fi, value1, value2, sequence, tstamp) VALUES (%s, %s, %s, %s, %s, %s, %s)",
array('integer','integer','integer','float','float','integer','integer'),
array($next_id, 0, $this->getId(), $this->getMinimum(), $max, 0, time())
);
}
}

+ Here is the call graph for this function:

SurveyMetricQuestion::saveUserInput (   $post_data,
  $active_id 
)

Definition at line 557 of file class.SurveyMetricQuestion.php.

References $ilDB, and 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);
$next_id = $ilDB->nextId('svy_answer');
$affectedRows = $ilDB->manipulateF("INSERT INTO svy_answer (answer_id, question_fi, active_fi, value, textanswer, tstamp) VALUES (%s, %s, %s, %s, %s, %s)",
array('integer','integer','integer','float','text','integer'),
array($next_id, $this->getId(), $active_id, (strlen($entered_value)) ? $entered_value : NULL, NULL, time())
);
}

+ Here is the call graph for this function:

SurveyMetricQuestion::setExportDetailsXLS ( &  $workbook,
&  $format_title,
&  $format_bold,
&  $eval_data,
  $export_label 
)

Creates an Excel worksheet for the detailed cumulated results of this question.

Parameters
object$workbookReference to the parent excel workbook
object$format_titleExcel title format
object$format_boldExcel bold format
array$eval_dataCumulated evaluation data public

Reimplemented from SurveyQuestion.

Definition at line 674 of file class.SurveyMetricQuestion.php.

References ilExcelUtils\_convert_text(), SurveyQuestion\getQuestiontext(), getSubtype(), SurveyQuestion\getTitle(), SUBTYPE_NON_RATIO, SUBTYPE_RATIO_ABSOLUTE, and SUBTYPE_RATIO_NON_ABSOLUTE.

{
include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
$worksheet =& $workbook->addWorksheet();
$rowcounter = 0;
switch ($export_label)
{
case 'label_only':
$worksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("label")), $format_bold);
$worksheet->writeString(0, 1, ilExcelUtils::_convert_text($this->label));
break;
case 'title_only':
$worksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("title")), $format_bold);
$worksheet->writeString(0, 1, ilExcelUtils::_convert_text($this->getTitle()));
break;
default:
$worksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("title")), $format_bold);
$worksheet->writeString(0, 1, ilExcelUtils::_convert_text($this->getTitle()));
$rowcounter++;
$worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("label")), $format_bold);
$worksheet->writeString($rowcounter, 1, ilExcelUtils::_convert_text($this->label));
break;
}
$rowcounter++;
$worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("question")), $format_bold);
$worksheet->writeString($rowcounter, 1, ilExcelUtils::_convert_text($this->getQuestiontext()));
$rowcounter++;
$worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("question_type")), $format_bold);
$worksheet->writeString($rowcounter, 1, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())));
$rowcounter++;
$worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("users_answered")), $format_bold);
$worksheet->write($rowcounter, 1, $eval_data["USERS_ANSWERED"]);
$rowcounter++;
$worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("users_skipped")), $format_bold);
$worksheet->write($rowcounter, 1, $eval_data["USERS_SKIPPED"]);
$rowcounter++;
$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.

Parameters
double$maximumThe maximum value public
See Also
$maximum

Definition at line 124 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.

Parameters
double$minimumThe minimum value public
See Also
$minimum

Definition at line 112 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.

Parameters
integer$subtypeThe question subtype public
See Also
$subtype

Reimplemented from SurveyQuestion.

Definition at line 100 of file class.SurveyMetricQuestion.php.

References $subtype.

Referenced by loadFromDb().

{
$this->subtype = $subtype;
}

+ Here is the caller graph for this function:

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$titleA title string to describe the question
string$descriptionA description string to describe the question
string$authorA string containing the name of the questions author
integer$ownerA numerical ID to identify the owner/creator public

Definition at line 78 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::toXML (   $a_include_header = TRUE,
  $obligatory_state = "" 
)

Returns an xml representation of the question.

Returns
string The xml representation of the question public

Definition at line 318 of file class.SurveyMetricQuestion.php.

References insertXML(), and ilXmlWriter\xmlHeader().

{
include_once("./Services/Xml/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
boolean TRUE if the question is usable for a precondition, FALSE otherwise public

Reimplemented from SurveyQuestion.

Definition at line 817 of file class.SurveyMetricQuestion.php.

{
return TRUE;
}

Field Documentation

SurveyMetricQuestion::$maximum

Definition at line 65 of file class.SurveyMetricQuestion.php.

Referenced by setMaximum().

SurveyMetricQuestion::$minimum

Definition at line 58 of file class.SurveyMetricQuestion.php.

Referenced by setMinimum().

SurveyMetricQuestion::$subtype

Definition at line 51 of file class.SurveyMetricQuestion.php.

Referenced by getSubtype(), setSubtype(), and SurveyMetricQuestion().

The documentation for this class was generated from the following file: