ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields
SurveyOrdinalQuestion Class Reference
Modules/SurveyQuestionPool

Ordinal survey question. More...

+ Inheritance diagram for SurveyOrdinalQuestion:
+ Collaboration diagram for SurveyOrdinalQuestion:

Public Member Functions

 SurveyOrdinalQuestion ($title="", $description="", $author="", $questiontext="", $owner=-1, $orientation=1)
 SurveyOrdinalQuestion 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 SurveyOrdinalQuestion object from the database.
 isComplete ()
 Returns true if the question is complete for use.
 saveToDb ($original_id="", $withanswers=true)
 Saves a SurveyOrdinalQuestion object to a database.
 saveCategoriesToDb ()
 toXML ($a_include_header=TRUE, $obligatory_state="")
 Returns an xml representation of the question.
 insertXML (&$a_xml_writer, $a_include_header=TRUE, $obligatory_state="")
 Adds the question XML to a given XMLWriter object.
 syncWithOriginal ()
 addStandardNumbers ($lower_limit, $upper_limit)
 Adds standard numbers as categories.
 savePhrase ($phrases, $title)
 Saves a set of categories to a default phrase.
 getQuestionType ()
 Returns the question type of the question.
 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.
 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)
 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.
 getPreconditionSelectValue ($default="")
 Creates a value selection for preconditions.
 getPreconditionValueOutput ($value)
 Returns the output for a precondition value.
 outChart ($survey_id, $type="")
 Creates an image visualising the results of the question.
- Public Member Functions inherited from SurveyQuestion
 SurveyQuestion ($title="", $description="", $author="", $questiontext="", $owner=-1)
 SurveyQuestion constructor.
 _SurveyQuestion ()
 questionTitleExists ($title, $questionpool_object="")
 Returns TRUE if the question title exists in the database.
 setTitle ($title="")
 Sets the title string.
 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.
 setSurveyId ($id=-1)
 Sets the survey id.
 setDescription ($description="")
 Sets the description.
 addMaterials ($materials_file, $materials_name="")
 Sets the materials uri.
 keyInArray ($searchkey, $array)
 returns TRUE if the key occurs in an array
 setMaterialsfile ($materials_filename, $materials_tempfilename="", $materials_name="")
 Sets and uploads the materials uri.
 deleteMaterial ($materials_name="")
 Deletes a materials uri.
 flushMaterials ()
 Deletes all materials uris.
 setAuthor ($author="")
 Sets the authors name.
 setQuestiontext ($questiontext="")
 Sets the questiontext.
 setOwner ($owner="")
 Sets the creator/owner.
 getTitle ()
 Gets the title string.
 getId ()
 Gets the id.
 getObligatory ($survey_id="")
 Gets the obligatory state of the question.
 getSurveyId ()
 Gets the survey id.
 getOrientation ()
 Gets the orientation of the question output.
 getDescription ()
 Gets the description.
 getAuthor ()
 Gets the authors name.
 getOwner ()
 Gets the creator/owner.
 getQuestiontext ()
 Gets the questiontext.
 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.
 duplicateMaterials ($question_id)
 Duplicates the materials of a question.
 _isComplete ($question_id)
 Checks wheather the question is complete or not.
 saveCompletionStatus ($original_id="")
 Saves the complete flag to the database.
 saveToDb ($original_id="")
 Saves a SurveyQuestion object to a database.
 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 material 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.
 saveMaterialsToDb ()
 Saves a materials to a database.
 loadMaterialFromDb ($question_id)
 Loads materials uris from a database.
 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 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.
 _getRefIdFromObjId ($obj_id)
 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.
 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)
 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)
 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)
 Creates the Excel output for the cumulated results of this question.
& setExportCumulatedCVS (&$eval_data)
 Creates the CSV output for the cumulated results of this question.
 setOriginalId ($original_id)
 getOriginalId ()

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

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.

Detailed Description

Ordinal survey question.

The SurveyOrdinalQuestion class defines and encapsulates basic methods and attributes for ordinal 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.SurveyOrdinalQuestion.php 19759 2009-04-21 10:45:44Z hschottm

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

Member Function Documentation

SurveyOrdinalQuestion::_getQuestionDataArray (   $id)

Returns the question data fields from the database.

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 147 of file class.SurveyOrdinalQuestion.php.

References SurveyQuestion\$id, and $result.

{
global $ilDB;
$query = sprintf("SELECT survey_question.*, survey_question_ordinal.* FROM survey_question, survey_question_ordinal WHERE survey_question.question_id = %s AND survey_question.question_id = survey_question_ordinal.question_fi",
$ilDB->quote($id)
);
$result = $ilDB->query($query);
if ($result->numRows() == 1)
{
return $result->fetchRow(MDB2_FETCHMODE_ASSOC);
}
else
{
return array();
}
}
SurveyOrdinalQuestion::addPhrase (   $phrase_id)

Adds a phrase to the question.

Adds a phrase to the question

Parameters
integer$phrase_idThe database id of the given phrase public

Definition at line 115 of file class.SurveyOrdinalQuestion.php.

References $result.

{
global $ilUser;
global $ilDB;
$query = sprintf("SELECT survey_category.* FROM survey_category, survey_phrase_category WHERE survey_phrase_category.category_fi = survey_category.category_id AND survey_phrase_category.phrase_fi = %s AND (survey_category.owner_fi = 0 OR survey_category.owner_fi = %s) ORDER BY survey_phrase_category.sequence",
$ilDB->quote($phrase_id),
$ilDB->quote($ilUser->id)
);
$result = $ilDB->query($query);
while ($row = $result->fetchRow(MDB2_FETCHMODE_OBJECT))
{
if (($row->defaultvalue == 1) and ($row->owner_fi == 0))
{
$this->categories->addCategory($this->lng->txt($row->title));
}
else
{
$this->categories->addCategory($row->title);
}
}
}
SurveyOrdinalQuestion::addStandardNumbers (   $lower_limit,
  $upper_limit 
)

Adds standard numbers as categories.

Adds standard numbers as categories

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

Definition at line 511 of file class.SurveyOrdinalQuestion.php.

{
for ($i = $lower_limit; $i <= $upper_limit; $i++)
{
$this->categories->addCategory($i);
}
}
SurveyOrdinalQuestion::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_arrayAn array which is used to append the values
array$resultsetThe evaluation data for a given user public

Reimplemented from SurveyQuestion.

Definition at line 801 of file class.SurveyOrdinalQuestion.php.

References SurveyQuestion\getId().

{
if (count($resultset["answers"][$this->getId()]))
{
foreach ($resultset["answers"][$this->getId()] as $key => $answer)
{
array_push($a_array, $answer["value"]+1);
}
}
else
{
array_push($a_array, $this->lng->txt("skipped"));
}
}

+ Here is the call graph for this function:

SurveyOrdinalQuestion::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_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 618 of file class.SurveyOrdinalQuestion.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("ordinal_question_not_checked");
return "";
}

+ Here is the call graph for this function:

SurveyOrdinalQuestion::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 582 of file class.SurveyOrdinalQuestion.php.

{
return "survey_question_ordinal";
}
SurveyOrdinalQuestion::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 886 of file class.SurveyOrdinalQuestion.php.

{
return array("<", "<=", "=", "<>", ">=", ">");
}
& SurveyOrdinalQuestion::getCategoriesForPhrase (   $phrase_id)

Gets the available categories for a given phrase.

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 85 of file class.SurveyOrdinalQuestion.php.

References $categories, and $result.

{
global $ilDB;
$categories = array();
$query = sprintf("SELECT survey_category.* FROM survey_category, survey_phrase_category WHERE survey_phrase_category.category_fi = survey_category.category_id AND survey_phrase_category.phrase_fi = %s ORDER BY survey_phrase_category.sequence",
$ilDB->quote($phrase_id)
);
$result = $ilDB->query($query);
while ($row = $result->fetchRow(MDB2_FETCHMODE_OBJECT))
{
if (($row->defaultvalue == 1) and ($row->owner_fi == 0))
{
$categories[$row->category_id] = $this->lng->txt($row->title);
}
else
{
$categories[$row->category_id] = $row->title;
}
}
return $categories;
}
& SurveyOrdinalQuestion::getCumulatedResults (   $survey_id,
  $nr_of_users 
)

Definition at line 663 of file class.SurveyOrdinalQuestion.php.

References $result, 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(MDB2_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();
$prefix = "";
if (strcmp(key($cumulated), "") != 0)
{
$prefix = (key($cumulated)+1) . " - ";
}
$result_array["MODE"] = $prefix . $this->categories->getCategory(key($cumulated));
$result_array["MODE_VALUE"] = key($cumulated)+1;
$result_array["MODE_NR_OF_SELECTIONS"] = $cumulated[key($cumulated)];
for ($key = 0; $key < $this->categories->getCategoryCount(); $key++)
{
$percentage = 0;
if ($numrows > 0)
{
$percentage = (float)((int)$cumulated[$key]/$numrows);
}
$result_array["variables"][$key] = array("title" => $this->categories->getCategory($key), "selected" => (int)$cumulated[$key], "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) . " " . $this->lng->txt("and") . " " . (ceil($median_value)) . "-" . $this->categories->getCategory((int)ceil($median_value)-1) . ")";
}
}
else
{
$median_value = $median[(($total+1)/2)-1];
}
}
else
{
$median_value = "";
}
$result_array["ARITHMETIC_MEAN"] = "";
$result_array["MEDIAN"] = $median_value;
$result_array["QUESTION_TYPE"] = "SurveyOrdinalQuestion";
return $result_array;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

SurveyOrdinalQuestion::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 899 of file class.SurveyOrdinalQuestion.php.

References SurveyQuestion\$lng.

{
global $lng;
include_once "./classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_svy_svy_precondition_select_value_combobox.html", TRUE, TRUE, "Modules/Survey");
for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
{
$template->setCurrentBlock("option_v");
$template->setVariable("OPTION_VALUE", $i);
$template->setVariable("OPTION_TEXT", ($i+1) . " - " . $this->categories->getCategory($i));
if ($i == $default)
{
$template->setVariable("OPTION_CHECKED", " selected=\"selected\"");
}
$template->parseCurrentBlock();
}
$template->setVariable("SELECT_VALUE", $lng->txt("step") . " 3: " . $lng->txt("select_value"));
return $template->get();
}
SurveyOrdinalQuestion::getPreconditionValueOutput (   $value)

Returns the output for a precondition 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 929 of file class.SurveyOrdinalQuestion.php.

{
return ($value + 1) . " - " . $this->categories->getCategory($value);
}
SurveyOrdinalQuestion::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 569 of file class.SurveyOrdinalQuestion.php.

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

References $result, 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(MDB2_FETCHMODE_ASSOC))
{
$category = $this->categories->getCategory($row["value"]);
$answers[$row["active_fi"]] = $row["value"] + 1 . " - " . $category;
}
return $answers;
}

+ Here is the call graph for this function:

& SurveyOrdinalQuestion::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 595 of file class.SurveyOrdinalQuestion.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));
}
return $data;
}

+ Here is the call graph for this function:

SurveyOrdinalQuestion::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 852 of file class.SurveyOrdinalQuestion.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);
}
}
SurveyOrdinalQuestion::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_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 389 of file class.SurveyOrdinalQuestion.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());
$a_xml_writer->xmlStartTag("questiontext");
$this->addMaterialTag($a_xml_writer, $this->getQuestiontext());
$a_xml_writer->xmlEndTag("questiontext");
$a_xml_writer->xmlStartTag("responses");
for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
{
$attrs = array(
"id" => $i
);
$a_xml_writer->xmlStartTag("response_single", $attrs);
$this->addMaterialTag($a_xml_writer, $this->categories->getCategory($i));
$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:

SurveyOrdinalQuestion::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 222 of file class.SurveyOrdinalQuestion.php.

Referenced by saveToDb(), and syncWithOriginal().

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

+ Here is the caller graph for this function:

SurveyOrdinalQuestion::loadFromDb (   $id)

Loads a SurveyOrdinalQuestion object from the database.

Loads a SurveyOrdinalQuestion object from the database

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

Reimplemented from SurveyQuestion.

Definition at line 173 of file class.SurveyOrdinalQuestion.php.

References $data, SurveyQuestion\$id, $result, ilRTE\_replaceMediaObjectImageSrc(), and SurveyQuestion\loadMaterialFromDb().

{
global $ilDB;
$query = sprintf("SELECT survey_question.*, survey_question_ordinal.* FROM survey_question, survey_question_ordinal WHERE survey_question.question_id = %s AND survey_question.question_id = survey_question_ordinal.question_fi",
$ilDB->quote($id)
);
$result = $ilDB->query($query);
if ($result->numRows() == 1)
{
$data = $result->fetchRow(MDB2_FETCHMODE_OBJECT);
$this->id = $data->question_id;
$this->title = $data->title;
$this->description = $data->description;
$this->obj_id = $data->obj_fi;
$this->orientation = $data->orientation;
$this->author = $data->author;
$this->owner = $data->owner_fi;
include_once("./Services/RTE/classes/class.ilRTE.php");
$this->questiontext = ilRTE::_replaceMediaObjectImageSrc($data->questiontext, 1);
$this->obligatory = $data->obligatory;
$this->complete = $data->complete;
$this->original_id = $data->original_id;
// loads materials uris from database
$this->loadMaterialFromDb($id);
$this->categories->flushCategories();
$query = sprintf("SELECT survey_variable.*, survey_category.title FROM survey_variable, survey_category WHERE survey_variable.question_fi = %s AND survey_variable.category_fi = survey_category.category_id ORDER BY sequence ASC",
$ilDB->quote($id)
);
$result = $ilDB->query($query);
if ($result->numRows() > 0)
{
while ($data = $result->fetchRow(MDB2_FETCHMODE_OBJECT))
{
$this->categories->addCategory($data->title);
}
}
}
parent::loadFromDb($id);
}

+ Here is the call graph for this function:

SurveyOrdinalQuestion::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_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 944 of file class.SurveyOrdinalQuestion.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:

SurveyOrdinalQuestion::saveCategoriesToDb ( )

Definition at line 332 of file class.SurveyOrdinalQuestion.php.

References $result, SurveyQuestion\saveCategoryToDb(), and SurveyQuestion\saveCompletionStatus().

Referenced by saveToDb().

{
// save categories
// delete existing category relations
$query = sprintf("DELETE FROM survey_variable WHERE question_fi = %s",
$this->ilias->db->quote($this->id)
);
$result = $this->ilias->db->query($query);
// create new category relations
for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
{
$category_id = $this->saveCategoryToDb($this->categories->getCategory($i));
$query = sprintf("INSERT INTO survey_variable (variable_id, category_fi, question_fi, value1, sequence, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, NULL)",
$this->ilias->db->quote($category_id . ""),
$this->ilias->db->quote($this->id . ""),
$this->ilias->db->quote(($i + 1) . ""),
$this->ilias->db->quote($i . "")
);
$answer_result = $this->ilias->db->query($query);
}
$this->saveCompletionStatus();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

SurveyOrdinalQuestion::savePhrase (   $phrases,
  $title 
)

Saves a set of categories to a default phrase.

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 528 of file class.SurveyOrdinalQuestion.php.

References $result, and SurveyQuestion\$title.

{
global $ilUser;
global $ilDB;
$query = sprintf("INSERT INTO survey_phrase (phrase_id, title, defaultvalue, owner_fi, TIMESTAMP) VALUES (NULL, %s, %s, %s, NULL)",
$ilDB->quote($title . ""),
$ilDB->quote("1"),
$ilDB->quote($ilUser->id . "")
);
$result = $ilDB->query($query);
$phrase_id = $ilDB->getLastInsertId();
$counter = 1;
foreach ($phrases as $category)
{
$query = sprintf("INSERT INTO survey_category (category_id, title, defaultvalue, owner_fi, TIMESTAMP) VALUES (NULL, %s, %s, %s, NULL)",
$ilDB->quote($this->categories->getCategory($category) . ""),
$ilDB->quote("1"),
$ilDB->quote($ilUser->id . "")
);
$result = $ilDB->query($query);
$category_id = $ilDB->getLastInsertId();
$query = sprintf("INSERT INTO survey_phrase_category (phrase_category_id, phrase_fi, category_fi, sequence) VALUES (NULL, %s, %s, %s)",
$ilDB->quote($phrase_id . ""),
$ilDB->quote($category_id . ""),
$ilDB->quote($counter . "")
);
$result = $ilDB->query($query);
$counter++;
}
}
SurveyOrdinalQuestion::saveRandomData (   $active_id)

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

Parameters
integer$active_idThe database ID of the active user

Definition at line 634 of file class.SurveyOrdinalQuestion.php.

References $result.

{
global $ilDB;
// single response
$category = rand(0, $this->categories->getCategoryCount()-1);
$query = sprintf("INSERT INTO survey_answer (answer_id, question_fi, active_fi, value, textanswer, TIMESTAMP) VALUES (NULL, %s, %s, %s, NULL, NULL)",
$ilDB->quote($this->getId()),
$ilDB->quote($active_id),
$ilDB->quote($category)
);
$result = $ilDB->query($query);
}
SurveyOrdinalQuestion::saveToDb (   $original_id = "",
  $withanswers = true 
)

Saves a SurveyOrdinalQuestion object to a database.

Saves a SurveyOrdinalQuestion object to a database

public

Definition at line 241 of file class.SurveyOrdinalQuestion.php.

References SurveyQuestion\$ilias, $result, ilRTE\_cleanupMediaObjectUsage(), ilRTE\_replaceMediaObjectImageSrc(), SurveyQuestion\getId(), isComplete(), saveCategoriesToDb(), and SurveyQuestion\saveMaterialsToDb().

{
global $ilDB;
$complete = 0;
if ($this->isComplete()) {
$complete = 1;
}
if ($original_id)
{
$original_id = $ilDB->quote($original_id);
}
else
{
$original_id = "NULL";
}
// cleanup RTE images which are not inserted into the question text
include_once("./Services/RTE/classes/class.ilRTE.php");
ilRTE::_cleanupMediaObjectUsage($this->questiontext, "spl:html",
$this->getId());
if ($this->id == -1)
{
// Write new dataset
$now = getdate();
$created = sprintf("%04d%02d%02d%02d%02d%02d", $now['year'], $now['mon'], $now['mday'], $now['hours'], $now['minutes'], $now['seconds']);
$query = sprintf("INSERT INTO survey_question (question_id, questiontype_fi, obj_fi, owner_fi, title, description, author, questiontext, obligatory, complete, created, original_id, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, NULL)",
$ilDB->quote($this->getQuestionTypeID()),
$ilDB->quote($this->obj_id),
$ilDB->quote($this->owner),
$ilDB->quote($this->title),
$ilDB->quote($this->description),
$ilDB->quote($this->author),
$ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($this->questiontext, 0)),
$ilDB->quote(sprintf("%d", $this->obligatory)),
$ilDB->quote("$complete"),
$ilDB->quote($created),
$original_id
);
$result = $ilDB->query($query);
if (PEAR::isError($result))
{
global $ilias;
$ilias->raiseError($result->getMessage());
}
else
{
$this->id = $ilDB->getLastInsertId();
$query = sprintf("INSERT INTO survey_question_ordinal (question_fi, orientation) VALUES (%s, %s)",
$ilDB->quote($this->id . ""),
$ilDB->quote(sprintf("%d", $this->orientation))
);
$ilDB->query($query);
}
}
else
{
// update existing dataset
$query = sprintf("UPDATE survey_question SET title = %s, description = %s, author = %s, questiontext = %s, obligatory = %s, complete = %s WHERE question_id = %s",
$ilDB->quote($this->title),
$ilDB->quote($this->description),
$ilDB->quote($this->author),
$ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($this->questiontext, 0)),
$ilDB->quote(sprintf("%d", $this->obligatory)),
$ilDB->quote("$complete"),
$ilDB->quote($this->id)
);
$result = $ilDB->query($query);
$query = sprintf("UPDATE survey_question_ordinal SET orientation = %s WHERE question_fi = %s",
$ilDB->quote(sprintf("%d", $this->orientation)),
$ilDB->quote($this->id . "")
);
$result = $ilDB->query($query);
}
if (PEAR::isError($result))
{
global $ilias;
$ilias->raiseError($result->getMessage());
}
else
{
// saving material uris in the database
$this->saveMaterialsToDb();
if ($withanswers)
{
$this->saveCategoriesToDb();
}
}
parent::saveToDb($original_id);
}

+ Here is the call graph for this function:

SurveyOrdinalQuestion::saveUserInput (   $post_data,
  $active_id 
)

Definition at line 647 of file class.SurveyOrdinalQuestion.php.

References $result, and SurveyQuestion\getId().

{
global $ilDB;
$entered_value = $post_data[$this->getId() . "_value"];
if (strlen($entered_value) == 0) return;
$entered_value = $ilDB->quote($entered_value . "");
$query = sprintf("INSERT INTO survey_answer (answer_id, question_fi, active_fi, value, textanswer, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, NULL)",
$ilDB->quote($this->getId() . ""),
$ilDB->quote($active_id . ""),
$entered_value,
"NULL"
);
$result = $ilDB->query($query);
}

+ Here is the call graph for this function:

SurveyOrdinalQuestion::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$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 752 of file class.SurveyOrdinalQuestion.php.

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

{
include_once ("./classes/class.ilExcelUtils.php");
$worksheet =& $workbook->addWorksheet();
$worksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("title")), $format_bold);
$worksheet->writeString(0, 1, ilExcelUtils::_convert_text($this->getTitle()));
$worksheet->writeString(1, 0, ilExcelUtils::_convert_text($this->lng->txt("question")), $format_bold);
$worksheet->writeString(1, 1, ilExcelUtils::_convert_text($this->getQuestiontext()));
$worksheet->writeString(2, 0, ilExcelUtils::_convert_text($this->lng->txt("question_type")), $format_bold);
$worksheet->writeString(2, 1, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())));
$worksheet->writeString(3, 0, ilExcelUtils::_convert_text($this->lng->txt("users_answered")), $format_bold);
$worksheet->write(3, 1, $eval_data["USERS_ANSWERED"]);
$worksheet->writeString(4, 0, ilExcelUtils::_convert_text($this->lng->txt("users_skipped")), $format_bold);
$worksheet->write(4, 1, $eval_data["USERS_SKIPPED"]);
$rowcounter = 5;
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"]));
$worksheet->write($rowcounter, 2, $key+1);
$worksheet->write($rowcounter, 3, ilExcelUtils::_convert_text($value["selected"]));
$worksheet->write($rowcounter++, 4, ilExcelUtils::_convert_text($value["percentage"]), $format_percent);
}
}

+ Here is the call graph for this function:

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

SurveyOrdinalQuestion constructor.

The constructor takes possible arguments an creates an instance of the SurveyOrdinalQuestion 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 60 of file class.SurveyOrdinalQuestion.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:

SurveyOrdinalQuestion::syncWithOriginal ( )

Reimplemented from SurveyQuestion.

Definition at line 447 of file class.SurveyOrdinalQuestion.php.

References SurveyQuestion\$ilias, $result, isComplete(), and SurveyQuestion\saveCategoryToDb().

{
global $ilDB;
if ($this->original_id)
{
$complete = 0;
if ($this->isComplete()) {
$complete = 1;
}
$query = sprintf("UPDATE survey_question SET title = %s, description = %s, author = %s, questiontext = %s, obligatory = %s, complete = %s WHERE question_id = %s",
$ilDB->quote($this->title . ""),
$ilDB->quote($this->description . ""),
$ilDB->quote($this->author . ""),
$ilDB->quote($this->questiontext . ""),
$ilDB->quote(sprintf("%d", $this->obligatory) . ""),
$ilDB->quote($complete . ""),
$ilDB->quote($this->original_id . "")
);
$result = $ilDB->query($query);
$query = sprintf("UPDATE survey_question_ordinal SET orientation = %s WHERE question_fi = %s",
$ilDB->quote($this->getOrientation() . ""),
$ilDB->quote($this->original_id . "")
);
$result = $ilDB->query($query);
if (PEAR::isError($result))
{
global $ilias;
$ilias->raiseError($result->getMessage());
}
else
{
// save categories
// delete existing category relations
$query = sprintf("DELETE FROM survey_variable WHERE question_fi = %s",
$ilDB->quote($this->original_id . "")
);
$result = $ilDB->query($query);
// create new category relations
for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
{
$category_id = $this->saveCategoryToDb($this->categories->getCategory($i));
$query = sprintf("INSERT INTO survey_variable (variable_id, category_fi, question_fi, value1, sequence, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, NULL)",
$ilDB->quote($category_id . ""),
$ilDB->quote($this->original_id . ""),
$ilDB->quote(($i + 1) . ""),
$ilDB->quote($i . "")
);
$answer_result = $ilDB->query($query);
}
}
}
parent::syncWithOriginal();
}

+ Here is the call graph for this function:

SurveyOrdinalQuestion::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 364 of file class.SurveyOrdinalQuestion.php.

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

{
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:

SurveyOrdinalQuestion::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 873 of file class.SurveyOrdinalQuestion.php.

{
return TRUE;
}

Field Documentation

SurveyOrdinalQuestion::$categories

Definition at line 47 of file class.SurveyOrdinalQuestion.php.

Referenced by getCategoriesForPhrase().

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