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

SingleChoice survey question. More...

+ Inheritance diagram for SurveySingleChoiceQuestion:
+ Collaboration diagram for SurveySingleChoiceQuestion:

Public Member Functions

 SurveySingleChoiceQuestion ($title="", $description="", $author="", $questiontext="", $owner=-1, $orientation=1)
 SurveySingleChoiceQuestion constructor.
& getCategoriesForPhrase ($phrase_id)
 Gets the available categories for a given phrase.
 addPhrase ($phrase_id)
 Adds a phrase to the question.
 _getQuestionDataArray ($id)
 Returns the question data fields from the database.
 loadFromDb ($id)
 Loads a SurveySingleChoiceQuestion object from the database.
 isComplete ()
 Returns true if the question is complete for use.
 saveToDb ($original_id="")
 Saves a SurveySingleChoiceQuestion 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.
 importAdditionalMetadata ($a_meta)
 Import additional meta data from the question import file.
 addStandardNumbers ($lower_limit, $upper_limit)
 Adds standard numbers as categories.
 savePhrase ($title)
 Saves a set of categories to a default phrase.
 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.
 addUserSpecificResultsExportTitles (&$a_array, $a_export_label="")
 overwritten addUserSpecificResultsExportTitles
 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.
 getPreconditionOptions ()
 Returns the options for preconditions.
 getPreconditionSelectValue ($default="", $title, $variable)
 Creates a form property for the precondition value.
 getPreconditionValueOutput ($value)
 Returns the output for a precondition value.
 outChart ($survey_id, $type="")
 Creates an image visualising the results of the question.
 getCategories ()
- 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.
 getQuestionTypeID ()
 Returns the question type ID of the question.
& _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.
 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.
 setOriginalId ($original_id)
 getOriginalId ()
 getMaterial ()
 setSubtype ($a_subtype)
 getSubtype ()
 getCumulatedResultData ($survey_id, $counter)
 Creates a the cumulated results data for the question.
 __get ($value)
 Object getter.
 __set ($key, $value)
 Object setter.

Data Fields

 $categories
- 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

SingleChoice survey question.

The SurveySingleChoiceQuestion class defines and encapsulates basic methods and attributes for single choice 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.SurveySingleChoiceQuestion.php 31573 2011-11-10 12:24:48Z hschottm

Definition at line 38 of file class.SurveySingleChoiceQuestion.php.

Member Function Documentation

SurveySingleChoiceQuestion::_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 137 of file class.SurveySingleChoiceQuestion.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:

SurveySingleChoiceQuestion::addPhrase (   $phrase_id)

Adds a phrase to the question.

Parameters
integer$phrase_idThe database id of the given phrase public

Definition at line 108 of file class.SurveySingleChoiceQuestion.php.

References $ilDB, $result, and $row.

{
global $ilUser;
global $ilDB;
$result = $ilDB->queryF("SELECT svy_category.* FROM svy_category, svy_phrase_cat WHERE svy_phrase_cat.category_fi = svy_category.category_id AND svy_phrase_cat.phrase_fi = %s AND (svy_category.owner_fi = 0 OR svy_category.owner_fi = %s) ORDER BY svy_phrase_cat.sequence",
array('integer', 'integer'),
array($phrase_id, $ilUser->getId())
);
while ($row = $ilDB->fetchAssoc($result))
{
if (($row["defaultvalue"] == 1) and ($row["owner_fi"] == 0))
{
$this->categories->addCategory($this->lng->txt($row["title"]));
}
else
{
$this->categories->addCategory($row["title"]);
}
}
}
SurveySingleChoiceQuestion::addStandardNumbers (   $lower_limit,
  $upper_limit 
)

Adds standard numbers as categories.

Parameters
integer$lower_limitThe lower limit
integer$upper_limitThe upper limit public

Definition at line 400 of file class.SurveySingleChoiceQuestion.php.

{
for ($i = $lower_limit; $i <= $upper_limit; $i++)
{
$this->categories->addCategory($i);
}
}
SurveySingleChoiceQuestion::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 803 of file class.SurveySingleChoiceQuestion.php.

References SurveyQuestion\getId().

{
// check if text answer column is needed
$other = false;
for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
{
$cat = $this->categories->getCategory($i);
if ($cat->other)
{
$other = true;
break;
}
}
// add the text answer from the selected option
if (count($resultset["answers"][$this->getId()]))
{
foreach ($resultset["answers"][$this->getId()] as $key => $answer)
{
array_push($a_array, $answer["value"]+1);
if ($other)
{
array_push($a_array, $answer["textanswer"]);
}
}
}
else
{
array_push($a_array, $this->lng->txt("skipped"));
if ($other)
{
array_push($a_array, "");
}
}
}

+ Here is the call graph for this function:

SurveySingleChoiceQuestion::addUserSpecificResultsExportTitles ( &  $a_array,
  $a_export_label = "" 
)

overwritten addUserSpecificResultsExportTitles

Adds the entries for the title row of the user specific results

Parameters
array$a_arrayAn array which is used to append the title row entries public

Reimplemented from SurveyQuestion.

Definition at line 765 of file class.SurveySingleChoiceQuestion.php.

References SurveyQuestion\$title.

{
// add label dependent title
switch($a_export_label)
{
case "label_only":
$title = $this->label ? $this->label : $this->title;
break;
case "title_only":
$title = $this->title;
break;
default:
$title = $this->label ? $this->title.' - '.$this->label : $this->title;
break;
}
array_push($a_array, $title);
// optionally add header for text answer
for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
{
$cat = $this->categories->getCategory($i);
if ($cat->other)
{
array_push($a_array, $title. ' - '. $this->lng->txt('other'));
break;
}
}
}
SurveySingleChoiceQuestion::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 507 of file class.SurveySingleChoiceQuestion.php.

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

{
$entered_value = $post_data[$this->getId() . "_value"];
if ((!$this->getObligatory($survey_id)) && (strlen($entered_value) == 0)) return "";
if (strlen($entered_value) == 0) return $this->lng->txt("question_not_checked");
for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
{
$cat = $this->categories->getCategory($i);
if ($cat->other)
{
if ($i == $entered_value)
{
if (array_key_exists($this->getId() . "_" . $entered_value . "_other", $post_data) && !strlen($post_data[$this->getId() . "_" . $entered_value . "_other"]))
{
return $this->lng->txt("question_mr_no_other_answer");
}
}
else
{
if (strlen($post_data[$this->getId() . "_" . $i . "_other"]))
{
return $this->lng->txt("question_sr_no_other_answer_checked");
}
}
}
}
return "";
}

+ Here is the call graph for this function:

SurveySingleChoiceQuestion::getAdditionalTableName ( )

Returns the name of the additional question data table in the database.

Returns
string The additional table name public

Definition at line 462 of file class.SurveySingleChoiceQuestion.php.

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

{
return "svy_qst_sc";
}

+ Here is the caller graph for this function:

SurveySingleChoiceQuestion::getAvailableRelations ( )

Returns the available relations for the question.

Returns
array An array containing the available relations public

Reimplemented from SurveyQuestion.

Definition at line 908 of file class.SurveySingleChoiceQuestion.php.

{
return array("<", "<=", "=", "<>", ">=", ">");
}
SurveySingleChoiceQuestion::getCategories ( )

Definition at line 988 of file class.SurveySingleChoiceQuestion.php.

References $categories.

{
return $this->categories;
}
& SurveySingleChoiceQuestion::getCategoriesForPhrase (   $phrase_id)

Gets the available categories for a given phrase.

Parameters
integer$phrase_idThe database id of the given phrase
Returns
array All available categories public

Definition at line 80 of file class.SurveySingleChoiceQuestion.php.

References $categories, $ilDB, $result, and $row.

{
global $ilDB;
$categories = array();
$result = $ilDB->queryF("SELECT svy_category.* FROM svy_category, svy_phrase_cat WHERE svy_phrase_cat.category_fi = svy_category.category_id AND svy_phrase_cat.phrase_fi = %s ORDER BY svy_phrase_cat.sequence",
array('integer'),
array($phrase_id)
);
while ($row = $ilDB->fetchAssoc($result))
{
if (($row["defaultvalue"] == 1) and ($row["owner_fi"] == 0))
{
$categories[$row["category_id"]] = $this->lng->txt($row["title"]);
}
else
{
$categories[$row["category_id"]] = $row["title"];
}
}
return $categories;
}
& SurveySingleChoiceQuestion::getCumulatedResults (   $survey_id,
  $nr_of_users 
)

Definition at line 571 of file class.SurveySingleChoiceQuestion.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"]]++;
// add text value to result array
if ($row["textanswer"])
{
$result_array["textanswers"][$row["value"]][] = $row["textanswer"];
}
}
// sort textanswers by value
if (is_array($result_array["textanswers"]))
{
ksort($result_array["textanswers"], SORT_NUMERIC);
}
asort($cumulated, SORT_NUMERIC);
end($cumulated);
$numrows = $result->numRows();
$result_array["USERS_ANSWERED"] = $result->numRows();
$result_array["USERS_SKIPPED"] = $nr_of_users - $result->numRows();
$prefix = "";
if (strcmp(key($cumulated), "") != 0)
{
$prefix = (key($cumulated)+1) . " - ";
}
$category = $this->categories->getCategoryForScale(key($cumulated)+1);
$result_array["MODE"] = $prefix . $category->title;
$result_array["MODE_VALUE"] = key($cumulated)+1;
$result_array["MODE_NR_OF_SELECTIONS"] = $cumulated[key($cumulated)];
for ($key = 0; $key < $this->categories->getCategoryCount(); $key++)
{
$cat = $this->categories->getCategory($key);
$percentage = 0;
if ($numrows > 0)
{
$percentage = (float)((int)$cumulated[$cat->scale-1]/$numrows);
}
if ($cat->other)
{
$result_array["variables"][$key] = array("title" => (strlen($cat->title)) ? $cat->title : $this->lng->txt('other_answer'), "selected" => (int)$cumulated[$cat->scale-1], "percentage" => $percentage);
}
else
{
$result_array["variables"][$key] = array("title" => $cat->title, "selected" => (int)$cumulated[$cat->scale-1], "percentage" => $percentage);
}
}
ksort($cumulated, SORT_NUMERIC);
$median = array();
$total = 0;
foreach ($cumulated as $value => $key)
{
$total += $key;
for ($i = 0; $i < $key; $i++)
{
array_push($median, $value+1);
}
}
if ($total > 0)
{
if (($total % 2) == 0)
{
$median_value = 0.5 * ($median[($total/2)-1] + $median[($total/2)]);
if (round($median_value) != $median_value)
{
$median_value = $median_value . "<br />" . "(" . $this->lng->txt("median_between") . " " . (floor($median_value)) . "-" . $this->categories->getCategory((int)floor($median_value)-1)->title . " " . $this->lng->txt("and") . " " . (ceil($median_value)) . "-" . $this->categories->getCategory((int)ceil($median_value)-1)->title . ")";
}
}
else
{
$median_value = $median[(($total+1)/2)-1];
}
}
else
{
$median_value = "";
}
$result_array["ARITHMETIC_MEAN"] = "";
$result_array["MEDIAN"] = $median_value;
$result_array["QUESTION_TYPE"] = "SurveySingleChoiceQuestion";
return $result_array;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

SurveySingleChoiceQuestion::getPreconditionOptions ( )

Returns the options for preconditions.

Returns
array

Reimplemented from SurveyQuestion.

Definition at line 918 of file class.SurveySingleChoiceQuestion.php.

References SurveyQuestion\$lng.

Referenced by getPreconditionSelectValue().

{
global $lng;
$options = array();
for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
{
$category = $this->categories->getCategory($i);
$options[$i] = ($i+1) . " - " . $category->title;
}
return $options;
}

+ Here is the caller graph for this function:

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

Creates a form property for the precondition value.

Returns
The ILIAS form element public

Reimplemented from SurveyQuestion.

Definition at line 937 of file class.SurveySingleChoiceQuestion.php.

References SurveyQuestion\$title, and getPreconditionOptions().

{
include_once "./Services/Form/classes/class.ilSelectInputGUI.php";
$step3 = new ilSelectInputGUI($title, $variable);
$options = $this->getPreconditionOptions();
$step3->setOptions($options);
$step3->setValue($default);
return $step3;
}

+ Here is the call graph for this function:

SurveySingleChoiceQuestion::getPreconditionValueOutput (   $value)

Returns the output for a precondition value.

Parameters
string$valueThe precondition value
Returns
string The output of the precondition value public

Reimplemented from SurveyQuestion.

Definition at line 954 of file class.SurveySingleChoiceQuestion.php.

{
$category = $this->categories->getCategory($value);
return ($value + 1) . " - " . ((strlen($category->title)) ? $category->title : $this->lng->txt('other_answer'));
}
SurveySingleChoiceQuestion::getQuestionType ( )

Returns the question type of the question.

Returns
integer The question type of the question public

Reimplemented from SurveyQuestion.

Definition at line 451 of file class.SurveySingleChoiceQuestion.php.

{
return "SurveySingleChoiceQuestion";
}
& SurveySingleChoiceQuestion::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 846 of file class.SurveySingleChoiceQuestion.php.

References $ilDB, $result, $row, SurveyQuestion\$survey_id, SurveyQuestion\$title, 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))
{
$category = $this->categories->getCategoryForScale($row["value"]+1);
$title = $row["value"] + 1 . " - " . $category->title;
if ($category->other) $title .= ": " . $row["textanswer"];
$answers[$row["active_fi"]] = $title;
}
return $answers;
}

+ Here is the call graph for this function:

& SurveySingleChoiceQuestion::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 473 of file class.SurveySingleChoiceQuestion.php.

References $data, and SurveyQuestion\getId().

{
$entered_value = $post_data[$this->getId() . "_value"];
$data = array();
if (strlen($entered_value))
{
array_push($data, array("value" => $entered_value, "textanswer" => $post_data[$this->getId() . '_' . $entered_value . '_other']));
}
for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
{
$cat = $this->categories->getCategory($i);
if ($cat->other)
{
if ($i != $entered_value)
{
if (strlen($post_data[$this->getId() . "_" . $i . "_other"]))
{
array_push($data, array("value" => $i, "textanswer" => $post_data[$this->getId() . '_' . $i . '_other'], "uncheck" => true));
}
}
}
}
return $data;
}

+ Here is the call graph for this function:

SurveySingleChoiceQuestion::importAdditionalMetadata (   $a_meta)

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 380 of file class.SurveySingleChoiceQuestion.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:

SurveySingleChoiceQuestion::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 872 of file class.SurveySingleChoiceQuestion.php.

References $data, SurveyQuestion\$id, and SurveyQuestion\$material.

{
foreach ($a_data as $id => $data)
{
$categorytext = "";
foreach ($data["material"] as $material)
{
$categorytext .= $material["text"];
}
$this->categories->addCategory(
$categorytext,
strlen($data['other']) ? $data['other'] : 0,
strlen($data['neutral']) ? $data['neutral'] : 0,
strlen($data['label']) ? $data['label'] : null,
strlen($data['scale']) ? $data['scale'] : null
);
}
}
SurveySingleChoiceQuestion::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 300 of file class.SurveySingleChoiceQuestion.php.

References SurveyQuestion\addMaterialTag(), SurveyQuestion\getAuthor(), SurveyQuestion\getDescription(), SurveyQuestion\getId(), SurveyQuestion\getObligatory(), SurveyQuestion\getOrientation(), SurveyQuestion\getQuestiontext(), and SurveyQuestion\getTitle().

Referenced by toXML().

{
$attrs = array(
"id" => $this->getId(),
"title" => $this->getTitle(),
"type" => $this->getQuestiontype(),
"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());
if (strlen($this->label))
{
$attrs = array(
"label" => $this->label,
);
}
else
{
$attrs = array();
}
$a_xml_writer->xmlStartTag("questiontext", $attrs);
$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
);
if (strlen($this->categories->getCategory($i)->other)) $attrs['other'] = $this->categories->getCategory($i)->other;
if (strlen($this->categories->getCategory($i)->neutral)) $attrs['neutral'] = $this->categories->getCategory($i)->neutral;
if (strlen($this->categories->getCategory($i)->label)) $attrs['label'] = $this->categories->getCategory($i)->label;
if (strlen($this->categories->getCategory($i)->scale)) $attrs['scale'] = $this->categories->getCategory($i)->scale;
$a_xml_writer->xmlStartTag("response_single", $attrs);
$this->addMaterialTag($a_xml_writer, $this->categories->getCategory($i)->title);
$a_xml_writer->xmlEndTag("response_single");
}
$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:

SurveySingleChoiceQuestion::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 208 of file class.SurveySingleChoiceQuestion.php.

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

Loads a SurveySingleChoiceQuestion object from the database.

Parameters
integer$idThe database id of the single choice survey question public

Reimplemented from SurveyQuestion.

Definition at line 161 of file class.SurveySingleChoiceQuestion.php.

References $data, SurveyQuestion\$id, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), SurveyQuestion\setAuthor(), SurveyQuestion\setComplete(), SurveyQuestion\setDescription(), SurveyQuestion\setId(), SurveyQuestion\setObjId(), SurveyQuestion\setObligatory(), SurveyQuestion\setOrientation(), SurveyQuestion\setOriginalId(), SurveyQuestion\setOwner(), SurveyQuestion\setQuestiontext(), 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->label = $data['label'];
$this->setDescription($data["description"]);
$this->setObjId($data["obj_fi"]);
$this->setAuthor($data["author"]);
$this->setOwner($data["owner_fi"]);
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->setOrientation($data["orientation"]);
$this->categories->flushCategories();
$result = $ilDB->queryF("SELECT svy_variable.*, svy_category.title, svy_category.neutral FROM svy_variable, svy_category WHERE svy_variable.question_fi = %s AND svy_variable.category_fi = svy_category.category_id ORDER BY sequence ASC",
array('integer'),
array($id)
);
if ($result->numRows() > 0)
{
while ($data = $ilDB->fetchAssoc($result))
{
$this->categories->addCategory($data["title"], $data["other"], $data["neutral"], null, ($data['scale']) ? $data['scale'] : ($data['sequence'] + 1));
}
}
}
parent::loadFromDb($id);
}

+ Here is the call graph for this function:

SurveySingleChoiceQuestion::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 968 of file class.SurveySingleChoiceQuestion.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:

SurveySingleChoiceQuestion::saveCategoriesToDb ( )

Definition at line 249 of file class.SurveySingleChoiceQuestion.php.

References $ilDB, SurveyQuestion\getId(), SurveyQuestion\saveCategoryToDb(), and SurveyQuestion\saveCompletionStatus().

Referenced by saveToDb().

{
global $ilDB;
$affectedRows = $ilDB->manipulateF("DELETE FROM svy_variable WHERE question_fi = %s",
array('integer'),
array($this->getId())
);
for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
{
$cat = $this->categories->getCategory($i);
$category_id = $this->saveCategoryToDb($cat->title, $cat->neutral);
$next_id = $ilDB->nextId('svy_variable');
$affectedRows = $ilDB->manipulateF("INSERT INTO svy_variable (variable_id, category_fi, question_fi, value1, other, sequence, scale, tstamp) VALUES (%s, %s, %s, %s, %s, %s, %s, %s)",
array('integer','integer','integer','float','integer','integer', 'integer','integer'),
array($next_id, $category_id, $this->getId(), ($i + 1), $cat->other, $i, ($cat->scale > 0) ? $cat->scale : null, time())
);
}
$this->saveCompletionStatus();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

SurveySingleChoiceQuestion::savePhrase (   $title)

Saves a set of categories to a default phrase.

Parameters
array$phrasesThe database ids of the seleted phrases
string$titleThe title of the default phrase public

Definition at line 415 of file class.SurveySingleChoiceQuestion.php.

References $_SESSION, $data, $ilDB, and SurveyQuestion\$title.

{
global $ilUser;
global $ilDB;
$next_id = $ilDB->nextId('svy_phrase');
$affectedRows = $ilDB->manipulateF("INSERT INTO svy_phrase (phrase_id, title, defaultvalue, owner_fi, tstamp) VALUES (%s, %s, %s, %s, %s)",
array('integer','text','text','integer','integer'),
array($next_id, $title, 1, $ilUser->getId(), time())
);
$phrase_id = $next_id;
$counter = 1;
foreach ($_SESSION['save_phrase_data'] as $data)
{
$next_id = $ilDB->nextId('svy_category');
$affectedRows = $ilDB->manipulateF("INSERT INTO svy_category (category_id, title, defaultvalue, owner_fi, tstamp) VALUES (%s, %s, %s, %s, %s)",
array('integer','text','text','integer','integer'),
array($next_id, $data['answer'], 1, $ilUser->getId(), time())
);
$category_id = $next_id;
$next_id = $ilDB->nextId('svy_phrase_cat');
$affectedRows = $ilDB->manipulateF("INSERT INTO svy_phrase_cat (phrase_category_id, phrase_fi, category_fi, sequence, other, scale) VALUES (%s, %s, %s, %s, %s, %s)",
array('integer', 'integer', 'integer','integer', 'integer', 'integer'),
array($next_id, $phrase_id, $category_id, $counter, ($data['other']) ? 1 : 0, $data['scale'])
);
$counter++;
}
}
SurveySingleChoiceQuestion::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.SurveySingleChoiceQuestion.php.

References $ilDB, and SurveyQuestion\getId().

{
global $ilDB;
// single response
$category = rand(0, $this->categories->getCategoryCount()-1);
$cat = $this->categories->getCategory($category);
$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, $category, ($cat->other) ? "Random Data" : null, time())
);
}

+ Here is the call graph for this function:

SurveySingleChoiceQuestion::saveToDb (   $original_id = "")

Saves a SurveySingleChoiceQuestion object to a database.

public

Reimplemented from SurveyQuestion.

Definition at line 225 of file class.SurveySingleChoiceQuestion.php.

References $ilDB, getAdditionalTableName(), SurveyQuestion\getId(), SurveyQuestion\getOrientation(), saveCategoriesToDb(), 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, orientation) VALUES (%s, %s)",
array('integer', 'text'),
array(
$this->getId(),
$this->getOrientation()
)
);
$this->saveMaterial();
$this->saveCategoriesToDb();
}
}

+ Here is the call graph for this function:

SurveySingleChoiceQuestion::saveUserInput (   $post_data,
  $active_id 
)

Definition at line 558 of file class.SurveySingleChoiceQuestion.php.

References $ilDB, and SurveyQuestion\getId().

{
global $ilDB;
$entered_value = $post_data[$this->getId() . "_value"];
if (strlen($entered_value) == 0) return;
$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, ($post_data[$this->getId() . "_" . $entered_value . "_other"]) ? $post_data[$this->getId() . "_" . $entered_value . "_other"] : null, time())
);
}

+ Here is the call graph for this function:

SurveySingleChoiceQuestion::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 677 of file class.SurveySingleChoiceQuestion.php.

References SurveyQuestion\$title, ilExcelUtils\_convert_text(), SurveyQuestion\getQuestiontext(), and SurveyQuestion\getTitle().

{
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++;
preg_match("/(.*?)\s+-\s+(.*)/", $eval_data["MODE"], $matches);
$worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("mode")), $format_bold);
$worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($matches[1]));
$worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("mode_text")), $format_bold);
$worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($matches[2]));
$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(str_replace("<br />", " ", $eval_data["MEDIAN"])));
$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"]));
$category = $this->categories->getCategory($key);
$worksheet->write($rowcounter, 2, $category->scale);
$worksheet->write($rowcounter, 3, ilExcelUtils::_convert_text($value["selected"]));
$worksheet->write($rowcounter++, 4, ilExcelUtils::_convert_text($value["percentage"]), $format_percent);
}
// add text answers to detailed results
if (is_array($eval_data["textanswers"]))
{
$worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("freetext_answers")), $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("answer")), $format_title);
foreach ($eval_data["textanswers"] as $key => $answers)
{
$title = $eval_data["variables"][$key]["title"];
foreach ($answers as $answer)
{
$worksheet->write($rowcounter, 1, ilExcelUtils::_convert_text($title));
$worksheet->write($rowcounter++, 2, ilExcelUtils::_convert_text($answer));
}
}
}
}

+ Here is the call graph for this function:

SurveySingleChoiceQuestion::SurveySingleChoiceQuestion (   $title = "",
  $description = "",
  $author = "",
  $questiontext = "",
  $owner = -1,
  $orientation = 1 
)

SurveySingleChoiceQuestion constructor.

The constructor takes possible arguments an creates an instance of the SurveySingleChoiceQuestion 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 58 of file class.SurveySingleChoiceQuestion.php.

References SurveyQuestion\$author, SurveyQuestion\$description, SurveyQuestion\$orientation, SurveyQuestion\$owner, SurveyQuestion\$questiontext, SurveyQuestion\$title, and SurveyQuestion\SurveyQuestion().

{
$this->SurveyQuestion($title, $description, $author, $questiontext, $owner);
include_once "./Modules/SurveyQuestionPool/classes/class.SurveyCategories.php";
$this->orientation = $orientation;
$this->categories = new SurveyCategories();
}

+ Here is the call graph for this function:

SurveySingleChoiceQuestion::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 277 of file class.SurveySingleChoiceQuestion.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:

SurveySingleChoiceQuestion::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 897 of file class.SurveySingleChoiceQuestion.php.

{
return TRUE;
}

Field Documentation

SurveySingleChoiceQuestion::$categories

Definition at line 45 of file class.SurveySingleChoiceQuestion.php.

Referenced by getCategories(), and getCategoriesForPhrase().

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