ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
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

 __construct ($title="", $description="", $author="", $questiontext="", $owner=-1, $orientation=1)
 SurveySingleChoiceQuestion constructor. More...
 
& getCategoriesForPhrase ($phrase_id)
 Gets the available categories for a given phrase. More...
 
 addPhrase ($phrase_id)
 Adds a phrase to the question. More...
 
 getQuestionDataArray ($id)
 Returns the question data fields from the database. More...
 
 loadFromDb ($id)
 Loads a SurveySingleChoiceQuestion object from the database. More...
 
 isComplete ()
 Returns true if the question is complete for use. More...
 
 saveToDb ($original_id="")
 Saves a SurveySingleChoiceQuestion object to a database. More...
 
 saveCategoriesToDb ()
 
 toXML ($a_include_header=TRUE, $obligatory_state="")
 Returns an xml representation of the question. More...
 
 insertXML (&$a_xml_writer, $a_include_header=TRUE)
 Adds the question XML to a given XMLWriter object. More...
 
 importAdditionalMetadata ($a_meta)
 Import additional meta data from the question import file. More...
 
 addStandardNumbers ($lower_limit, $upper_limit)
 Adds standard numbers as categories. More...
 
 savePhrase ($title)
 Saves a set of categories to a default phrase. More...
 
 getQuestionType ()
 Returns the question type of the question. More...
 
 getAdditionalTableName ()
 Returns the name of the additional question data table in the database. More...
 
& getWorkingDataFromUserInput ($post_data)
 Creates the user data of the svy_answer table from the POST data. More...
 
 checkUserInput ($post_data, $survey_id)
 Checks the input of the active user for obligatory status and entered values. More...
 
 saveUserInput ($post_data, $active_id, $a_return=false)
 
 importResponses ($a_data)
 Import response data from the question import file. More...
 
 usableForPrecondition ()
 Returns if the question is usable for preconditions. More...
 
 getAvailableRelations ()
 Returns the available relations for the question. More...
 
 getPreconditionOptions ()
 Returns the options for preconditions. More...
 
 getPreconditionSelectValue ($default="", $title, $variable)
 Creates a form property for the precondition value. More...
 
 getPreconditionValueOutput ($value)
 Returns the output for a precondition value. More...
 
 getCategories ()
 
- Public Member Functions inherited from SurveyQuestion
 __construct ($title="", $description="", $author="", $questiontext="", $owner=-1)
 SurveyQuestion constructor The constructor takes possible arguments an creates an instance of the SurveyQuestion object. More...
 
 setComplete ($a_complete)
 Sets the complete state of the question. More...
 
 isComplete ()
 Returns 1, if a question is complete for use. More...
 
 questionTitleExists ($title, $questionpool_object="")
 Returns TRUE if the question title exists in the database. More...
 
 setTitle ($title="")
 Sets the title string of the SurveyQuestion object. More...
 
 setObligatory ($obligatory=1)
 Sets the obligatory state of the question. More...
 
 setOrientation ($orientation=0)
 Sets the orientation of the question output. More...
 
 setId ($id=-1)
 Sets the id of the SurveyQuestion object. More...
 
 setSurveyId ($id=-1)
 Sets the survey id of the SurveyQuestion object. More...
 
 setDescription ($description="")
 Sets the description string of the SurveyQuestion object. More...
 
 addMaterials ($materials_file, $materials_name="")
 Sets the materials uri. More...
 
 setMaterialsfile ($materials_filename, $materials_tempfilename="", $materials_name="")
 Sets and uploads the materials uri. More...
 
 deleteMaterial ($materials_name="")
 Deletes a materials uri with a given name. More...
 
 flushMaterials ()
 Deletes all materials uris. More...
 
 setAuthor ($author="")
 Sets the authors name of the SurveyQuestion object. More...
 
 setQuestiontext ($questiontext="")
 Sets the questiontext of the SurveyQuestion object. More...
 
 setOwner ($owner="")
 Sets the creator/owner ID of the SurveyQuestion object. More...
 
 getTitle ()
 Gets the title string of the SurveyQuestion object. More...
 
 getLabel ()
 
 getId ()
 Gets the id of the SurveyQuestion object. More...
 
 getObligatory ($survey_id="")
 Gets the obligatory state of the question. More...
 
 getSurveyId ()
 Gets the survey id of the SurveyQuestion object. More...
 
 getOrientation ()
 Gets the orientation of the question output. More...
 
 getDescription ()
 Gets the description string of the SurveyQuestion object. More...
 
 getAuthor ()
 Gets the authors name of the SurveyQuestion object. More...
 
 getOwner ()
 Gets the creator/owner ID of the SurveyQuestion object. More...
 
 getQuestiontext ()
 Gets the questiontext of the SurveyQuestion object. More...
 
 getObjId ()
 Get the reference id of the container object. More...
 
 setObjId ($obj_id=0)
 Set the reference id of the container object. More...
 
 duplicate ($for_survey=true, $title="", $author="", $owner="", $a_survey_id=0)
 Duplicates a survey question. More...
 
 copyObject ($target_questionpool, $title="")
 Copies an assOrderingQuestion object. More...
 
 copyXHTMLMediaObjectsOfQuestion ($a_q_id)
 Increases the media object usage counter when a question is duplicated. More...
 
 loadFromDb ($question_id)
 Loads a SurveyQuestion object from the database. More...
 
 saveCompletionStatus ($original_id="")
 Saves the complete flag to the database. More...
 
 saveToDb ($original_id="")
 Saves a SurveyQuestion object to a database. More...
 
 saveMaterial ()
 save material to db More...
 
 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. More...
 
 saveWorkingData ($limit_to=LIMIT_NO_LIMIT)
 Saves the learners input of the question to the database. More...
 
 getImagePath ()
 Returns the image path for web accessable images of a question. More...
 
 getMaterialsPath ()
 Returns the materials path for web accessable materials of a question. More...
 
 getImagePathWeb ()
 Returns the web image path for web accessable images of a question. More...
 
 getMaterialsPathWeb ()
 Returns the web image path for web accessable images of a question. More...
 
 saveCategoryToDb ($categorytext, $neutral=0)
 Saves a category to the database. More...
 
 deleteAdditionalTableData ($question_id)
 Deletes datasets from the additional question table in the database. More...
 
 delete ($question_id)
 Deletes a question and all materials from the database. More...
 
 syncWithOriginal ()
 
 getPhrase ($phrase_id)
 Returns a phrase for a given database id. More...
 
 phraseExists ($title)
 Returns true if the phrase title already exists for the current user. More...
 
 addInternalLink ($material_id, $title="")
 
 deleteMaterials ($a_array)
 Deletes materials. More...
 
 duplicateMaterials ($question_id)
 Duplicates the materials of a question. More...
 
 addMaterial ($obj_material)
 
 setMaterial ($material_id="", $is_import=false, $material_title="")
 Sets a material link for the question. More...
 
 getQuestionTypeID ()
 Returns the question type ID of the question. More...
 
 getQuestionType ()
 Returns the question type of the question. More...
 
 isHTML ($a_text)
 Checks if a given string contains HTML or not. More...
 
 QTIMaterialToString ($a_material)
 Reads an QTI material tag an creates a text string. More...
 
 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. More...
 
 prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
 Prepares a string for a text area output in surveys. More...
 
 getQuestionDataArray ($id)
 Returns the question data fields from the database. More...
 
& getWorkingDataFromUserInput ($post_data)
 Creates the user data of the svy_answer table from the POST data. More...
 
 importAdditionalMetadata ($a_meta)
 Import additional meta data from the question import file. More...
 
 importResponses ($a_data)
 Import response data from the question import file. More...
 
 importAdjectives ($a_data)
 Import bipolar adjectives from the question import file. More...
 
 importMatrix ($a_data)
 Import matrix rows from the question import file. More...
 
 usableForPrecondition ()
 Returns if the question is usable for preconditions. More...
 
 getAvailableRelations ()
 Returns the available relations for the question. More...
 
 getPreconditionOptions ()
 Returns the options for preconditions. More...
 
 getPreconditionValueOutput ($value)
 Returns the output for a precondition value. More...
 
 getPreconditionSelectValue ($default="", $title, $variable)
 Creates a form property for the precondition value. More...
 
 setOriginalId ($original_id)
 
 getOriginalId ()
 
 getMaterial ()
 
 setSubtype ($a_subtype)
 
 getSubtype ()
 
 __get ($value)
 Object getter. More...
 
 __set ($key, $value)
 Object setter. More...
 
 getCopyIds ($a_group_by_survey=false)
 
 hasCopies ()
 
 stripSlashesAddSpaceFallback ($a_str)
 Strip slashes with add space fallback, see https://mantis.ilias.de/view.php?id=19727 and https://mantis.ilias.de/view.php?id=24200. More...
 

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 _isComplete ($question_id)
 Checks whether the question is complete or not. More...
 
static _getQuestionType ($question_id)
 Returns the question type of a question with a given id. More...
 
static _getTitle ($question_id)
 Returns the question title of a question with a given id. More...
 
static _getOriginalId ($question_id, $a_return_question_id_if_no_original=true)
 Returns the original id of a question. More...
 
static _questionExists ($question_id)
 Returns true if the question already exists in the database. More...
 
static _resolveInternalLink ($internal_link)
 
static _resolveIntLinks ($question_id)
 
static _getInternalLinkHref ($target="", $a_parent_ref_id=null)
 
static _isWriteable ($question_id, $user_id)
 Returns true if the question is writeable by a certain user. More...
 
static _includeClass ($question_type, $gui=0)
 Include the php class file for a given question type. More...
 
static _getQuestionTypeName ($type_tag)
 Return the translation for a given question type tag. More...
 
static _instanciateQuestion ($question_id)
 Creates an instance of a question with a given question id. More...
 
static _instanciateQuestionGUI ($question_id)
 Creates an instance of a question GUI with a given question id. More...
 
static _instanciateQuestionEvaluation ($question_id, array $a_finished_ids=null)
 Creates an instance of a question evaluation with a given question id. More...
 
static _changeOriginalId ($a_question_id, $a_original_id, $a_object_id)
 Change original id of existing question in db. More...
 
static _lookupSurveyObjId ($a_question_id)
 
static lookupObjFi ($a_qid)
 Lookip obj fi. More...
 
- Protected Attributes inherited from SurveyQuestion
 $cumulated
 An array containing the cumulated results of the question for a given survey. More...
 
 $log
 

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$

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

Constructor & Destructor Documentation

◆ __construct()

SurveySingleChoiceQuestion::__construct (   $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 @access public

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

58 {
59 parent::__construct($title, $description, $author, $questiontext, $owner);
60
61 include_once "./Modules/SurveyQuestionPool/classes/class.SurveyCategories.php";
62 $this->orientation = $orientation;
63 $this->categories = new SurveyCategories();
64 }
SurveyCategories
Class SurveyCategories.
Definition: class.SurveyCategories.php:35

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

Member Function Documentation

◆ addPhrase()

SurveySingleChoiceQuestion::addPhrase (   $phrase_id)

Adds a phrase to the question.

Parameters
integer$phrase_idThe database id of the given phrase @access public

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

102 {
103 global $ilUser;
104 global $ilDB;
105
106 $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",
107 array('integer', 'integer'),
108 array($phrase_id, $ilUser->getId())
109 );
110 while ($row = $ilDB->fetchAssoc($result))
111 {
112 $neutral = $row["neutral"];
113 if (($row["defaultvalue"] == 1) and ($row["owner_fi"] == 0))
114 {
115 $this->categories->addCategory($this->lng->txt($row["title"]), 0, $neutral);
116 }
117 else
118 {
119 $this->categories->addCategory($row["title"], 0, $neutral);
120 }
121 }
122 }
$result
$result
Definition: CleanUpTest.php:407
$ilDB
global $ilDB
Definition: storeScorm2004.php:19
$ilUser
$ilUser
Definition: imgupload.php:18

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

◆ addStandardNumbers()

SurveySingleChoiceQuestion::addStandardNumbers (   $lower_limit,
  $upper_limit 
)

Adds standard numbers as categories.

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

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

405 {
406 for ($i = $lower_limit; $i <= $upper_limit; $i++)
407 {
408 $this->categories->addCategory($i);
409 }
410 }

◆ checkUserInput()

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 @access public

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

512 {
513 $entered_value = $post_data[$this->getId() . "_value"];
514
515 $this->log->debug("Entered value = ".$entered_value);
516
517 if ((!$this->getObligatory($survey_id)) && (strlen($entered_value) == 0)) return "";
518
519 if (strlen($entered_value) == 0) return $this->lng->txt("question_not_checked");
520
521 for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
522 {
523 $cat = $this->categories->getCategory($i);
524 if ($cat->other)
525 {
526 if ($i == $entered_value)
527 {
528 if (array_key_exists($this->getId() . "_" . $entered_value . "_other", $post_data) && !strlen($post_data[$this->getId() . "_" . $entered_value . "_other"]))
529 {
530 return $this->lng->txt("question_mr_no_other_answer");
531 }
532 }
533 else
534 {
535 if (strlen($post_data[$this->getId() . "_" . $i . "_other"]))
536 {
537 return $this->lng->txt("question_sr_no_other_answer_checked");
538 }
539 }
540 }
541 }
542
543 return "";
544 }
SurveyQuestion\getId
getId()
Gets the id of the SurveyQuestion object.
Definition: class.SurveyQuestion.php:460
SurveyQuestion\getObligatory
getObligatory($survey_id="")
Gets the obligatory state of the question.
Definition: class.SurveyQuestion.php:471

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

+ Here is the call graph for this function:

◆ getAdditionalTableName()

SurveySingleChoiceQuestion::getAdditionalTableName ( )

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

Returns
string The additional table name @access public

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

467 {
468 return "svy_qst_sc";
469 }

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

+ Here is the caller graph for this function:

◆ getAvailableRelations()

SurveySingleChoiceQuestion::getAvailableRelations ( )

Returns the available relations for the question.

Returns
array An array containing the available relations @access public

Reimplemented from SurveyQuestion.

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

619 {
620 return array("<", "<=", "=", "<>", ">=", ">");
621 }

◆ getCategories()

SurveySingleChoiceQuestion::getCategories ( )

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

676 {
677 return $this->categories;
678 }

References $categories.

◆ getCategoriesForPhrase()

& 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 @access public

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

74 {
75 global $ilDB;
76 $categories = array();
77 $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",
78 array('integer'),
79 array($phrase_id)
80 );
81 while ($row = $ilDB->fetchAssoc($result))
82 {
83 if (($row["defaultvalue"] == 1) and ($row["owner_fi"] == 0))
84 {
85 $categories[$row["category_id"]] = $this->lng->txt($row["title"]);
86 }
87 else
88 {
89 $categories[$row["category_id"]] = $row["title"];
90 }
91 }
92 return $categories;
93 }

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

◆ getPreconditionOptions()

SurveySingleChoiceQuestion::getPreconditionOptions ( )

Returns the options for preconditions.

Returns
array

Reimplemented from SurveyQuestion.

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

629 {
630 global $lng;
631
632 $options = array();
633 for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
634 {
635 $category = $this->categories->getCategory($i);
636 $options[$category->scale-1] = $category->scale . " - " . $category->title;
637 }
638 return $options;
639 }
$options
if(!is_array($argv)) $options
Definition: tcpdf_addfont.php:137

References SurveyQuestion\$lng, and $options.

Referenced by getPreconditionSelectValue().

+ Here is the caller graph for this function:

◆ getPreconditionSelectValue()

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

Creates a form property for the precondition value.

Returns
The ILIAS form element @access public

Reimplemented from SurveyQuestion.

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

648 {
649 include_once "./Services/Form/classes/class.ilSelectInputGUI.php";
650 $step3 = new ilSelectInputGUI($title, $variable);
651 $options = $this->getPreconditionOptions();
652 $step3->setOptions($options);
653 $step3->setValue($default);
654 return $step3;
655 }
SurveySingleChoiceQuestion\getPreconditionOptions
getPreconditionOptions()
Returns the options for preconditions.
Definition: class.SurveySingleChoiceQuestion.php:628
ilSelectInputGUI
This class represents a selection list property in a property form.
Definition: class.ilSelectInputGUI.php:18

References $options, SurveyQuestion\$title, and getPreconditionOptions().

+ Here is the call graph for this function:

◆ getPreconditionValueOutput()

SurveySingleChoiceQuestion::getPreconditionValueOutput (   $value)

Returns the output for a precondition value.

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

Reimplemented from SurveyQuestion.

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

665 {
666 // #18136
667 $category = $this->categories->getCategoryForScale($value+1);
668
669 // #17895 - see getPreconditionOptions()
670 return $category->scale .
671 " - " .
672 ((strlen($category->title)) ? $category->title : $this->lng->txt('other_answer'));
673 }

◆ getQuestionDataArray()

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 @access public

Reimplemented from SurveyQuestion.

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

132 {
133 global $ilDB;
134
135 $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",
136 array('integer'),
137 array($id)
138 );
139 if ($result->numRows() == 1)
140 {
141 return $ilDB->fetchAssoc($result);
142 }
143 else
144 {
145 return array();
146 }
147 }
SurveySingleChoiceQuestion\getAdditionalTableName
getAdditionalTableName()
Returns the name of the additional question data table in the database.
Definition: class.SurveySingleChoiceQuestion.php:466

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

+ Here is the call graph for this function:

◆ getQuestionType()

SurveySingleChoiceQuestion::getQuestionType ( )

Returns the question type of the question.

Returns
integer The question type of the question @access public

Reimplemented from SurveyQuestion.

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

456 {
457 return "SurveySingleChoiceQuestion";
458 }

◆ getWorkingDataFromUserInput()

& 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 @access public

Reimplemented from SurveyQuestion.

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

478 {
479 $entered_value = $post_data[$this->getId() . "_value"];
480 $data = array();
481 if (strlen($entered_value))
482 {
483 array_push($data, array("value" => $entered_value, "textanswer" => $post_data[$this->getId() . '_' . $entered_value . '_other']));
484 }
485 for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
486 {
487 $cat = $this->categories->getCategory($i);
488 if ($cat->other)
489 {
490 if ($i != $entered_value)
491 {
492 if (strlen($post_data[$this->getId() . "_" . $i . "_other"]))
493 {
494 array_push($data, array("value" => $i, "textanswer" => $post_data[$this->getId() . '_' . $i . '_other'], "uncheck" => true));
495 }
496 }
497 }
498 }
499 return $data;
500 }

References $data, and SurveyQuestion\getId().

+ Here is the call graph for this function:

◆ importAdditionalMetadata()

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 @access public

Reimplemented from SurveyQuestion.

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

385 {
386 foreach ($a_meta as $key => $value)
387 {
388 switch ($value["label"])
389 {
390 case "orientation":
391 $this->setOrientation($value["entry"]);
392 break;
393 }
394 }
395 }
SurveyQuestion\setOrientation
setOrientation($orientation=0)
Sets the orientation of the question output.
Definition: class.SurveyQuestion.php:274

References SurveyQuestion\setOrientation().

+ Here is the call graph for this function:

◆ importResponses()

SurveySingleChoiceQuestion::importResponses (   $a_data)

Import response data from the question import file.

Returns
array $a_data Array containing the response data @access public

Reimplemented from SurveyQuestion.

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

583 {
584 foreach ($a_data as $id => $data)
585 {
586 $categorytext = "";
587 foreach ($data["material"] as $material)
588 {
589 $categorytext .= $material["text"];
590 }
591 $this->categories->addCategory(
592 $categorytext,
593 strlen($data['other']) ? $data['other'] : 0,
594 strlen($data['neutral']) ? $data['neutral'] : 0,
595 strlen($data['label']) ? $data['label'] : null,
596 strlen($data['scale']) ? $data['scale'] : null
597 );
598 }
599 }

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

◆ insertXML()

SurveySingleChoiceQuestion::insertXML ( &  $a_xml_writer,
  $a_include_header = TRUE 
)

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 @access public

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

305 {
306 $attrs = array(
307 "id" => $this->getId(),
308 "title" => $this->getTitle(),
309 "type" => $this->getQuestiontype(),
310 "obligatory" => $this->getObligatory()
311 );
312 $a_xml_writer->xmlStartTag("question", $attrs);
313
314 $a_xml_writer->xmlElement("description", NULL, $this->getDescription());
315 $a_xml_writer->xmlElement("author", NULL, $this->getAuthor());
316 if (strlen($this->label))
317 {
318 $attrs = array(
319 "label" => $this->label,
320 );
321 }
322 else
323 {
324 $attrs = array();
325 }
326 $a_xml_writer->xmlStartTag("questiontext", $attrs);
327 $this->addMaterialTag($a_xml_writer, $this->getQuestiontext());
328 $a_xml_writer->xmlEndTag("questiontext");
329
330 $a_xml_writer->xmlStartTag("responses");
331
332 for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
333 {
334 $attrs = array(
335 "id" => $i
336 );
337 if (strlen($this->categories->getCategory($i)->other)) $attrs['other'] = $this->categories->getCategory($i)->other;
338 if (strlen($this->categories->getCategory($i)->neutral)) $attrs['neutral'] = $this->categories->getCategory($i)->neutral;
339 if (strlen($this->categories->getCategory($i)->label)) $attrs['label'] = $this->categories->getCategory($i)->label;
340 if (strlen($this->categories->getCategory($i)->scale)) $attrs['scale'] = $this->categories->getCategory($i)->scale;
341 $a_xml_writer->xmlStartTag("response_single", $attrs);
342 $this->addMaterialTag($a_xml_writer, $this->categories->getCategory($i)->title);
343 $a_xml_writer->xmlEndTag("response_single");
344 }
345
346 $a_xml_writer->xmlEndTag("responses");
347
348 if (count($this->material))
349 {
350 if (preg_match("/il_(\d*?)_(\w+)_(\d+)/", $this->material["internal_link"], $matches))
351 {
352 $attrs = array(
353 "label" => $this->material["title"]
354 );
355 $a_xml_writer->xmlStartTag("material", $attrs);
356 $intlink = "il_" . IL_INST_ID . "_" . $matches[2] . "_" . $matches[3];
357 if (strcmp($matches[1], "") != 0)
358 {
359 $intlink = $this->material["internal_link"];
360 }
361 $a_xml_writer->xmlElement("mattext", NULL, $intlink);
362 $a_xml_writer->xmlEndTag("material");
363 }
364 }
365
366 $a_xml_writer->xmlStartTag("metadata");
367 $a_xml_writer->xmlStartTag("metadatafield");
368 $a_xml_writer->xmlElement("fieldlabel", NULL, "orientation");
369 $a_xml_writer->xmlElement("fieldentry", NULL, $this->getOrientation());
370 $a_xml_writer->xmlEndTag("metadatafield");
371 $a_xml_writer->xmlEndTag("metadata");
372
373 $a_xml_writer->xmlEndTag("question");
374 }
SurveyQuestion\getDescription
getDescription()
Gets the description string of the SurveyQuestion object.
Definition: class.SurveyQuestion.php:518
SurveyQuestion\getAuthor
getAuthor()
Gets the authors name of the SurveyQuestion object.
Definition: class.SurveyQuestion.php:530
SurveyQuestion\getQuestiontext
getQuestiontext()
Gets the questiontext of the SurveyQuestion object.
Definition: class.SurveyQuestion.php:554
SurveyQuestion\getTitle
getTitle()
Gets the title string of the SurveyQuestion object.
Definition: class.SurveyQuestion.php:443
SurveyQuestion\addMaterialTag
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.
Definition: class.SurveyQuestion.php:1878
SurveyQuestion\getOrientation
getOrientation()
Gets the orientation of the question output.
Definition: class.SurveyQuestion.php:495

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

Referenced by toXML().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isComplete()

SurveySingleChoiceQuestion::isComplete ( )

Returns true if the question is complete for use.

Returns
boolean True if the question is complete for use, otherwise false @access public

Reimplemented from SurveyQuestion.

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

203 {
204 if (
205 strlen($this->getTitle()) &&
206 strlen($this->getAuthor()) &&
207 strlen($this->getQuestiontext()) &&
208 $this->categories->getCategoryCount()
209 )
210 {
211 return 1;
212 }
213 else
214 {
215 return 0;
216 }
217 }

References SurveyQuestion\getAuthor(), SurveyQuestion\getQuestiontext(), and SurveyQuestion\getTitle().

+ Here is the call graph for this function:

◆ loadFromDb()

SurveySingleChoiceQuestion::loadFromDb (   $id)

Loads a SurveySingleChoiceQuestion object from the database.

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

Reimplemented from SurveyQuestion.

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

156 {
157 global $ilDB;
158
159 $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",
160 array('integer'),
161 array($id)
162 );
163 if ($result->numRows() == 1)
164 {
165 $data = $ilDB->fetchAssoc($result);
166 $this->setId($data["question_id"]);
167 $this->setTitle($data["title"]);
168 $this->label = $data['label'];
169 $this->setDescription($data["description"]);
170 $this->setObjId($data["obj_fi"]);
171 $this->setAuthor($data["author"]);
172 $this->setOwner($data["owner_fi"]);
173 include_once("./Services/RTE/classes/class.ilRTE.php");
174 $this->setQuestiontext(ilRTE::_replaceMediaObjectImageSrc($data["questiontext"], 1));
175 $this->setObligatory($data["obligatory"]);
176 $this->setComplete($data["complete"]);
177 $this->setOriginalId($data["original_id"]);
178 $this->setOrientation($data["orientation"]);
179
180 $this->categories->flushCategories();
181 $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",
182 array('integer'),
183 array($id)
184 );
185 if ($result->numRows() > 0)
186 {
187 while ($data = $ilDB->fetchAssoc($result))
188 {
189 $this->categories->addCategory($data["title"], $data["other"], $data["neutral"], null, ($data['scale']) ? $data['scale'] : ($data['sequence'] + 1));
190 }
191 }
192 }
193 parent::loadFromDb($id);
194 }
SurveyQuestion\setQuestiontext
setQuestiontext($questiontext="")
Sets the questiontext of the SurveyQuestion object.
Definition: class.SurveyQuestion.php:419
SurveyQuestion\setId
setId($id=-1)
Sets the id of the SurveyQuestion object.
Definition: class.SurveyQuestion.php:286
SurveyQuestion\setAuthor
setAuthor($author="")
Sets the authors name of the SurveyQuestion object.
Definition: class.SurveyQuestion.php:403
SurveyQuestion\setDescription
setDescription($description="")
Sets the description string of the SurveyQuestion object.
Definition: class.SurveyQuestion.php:310
SurveyQuestion\setObjId
setObjId($obj_id=0)
Set the reference id of the container object.
Definition: class.SurveyQuestion.php:577
SurveyQuestion\setOriginalId
setOriginalId($original_id)
Definition: class.SurveyQuestion.php:2056
SurveyQuestion\setComplete
setComplete($a_complete)
Sets the complete state of the question.
Definition: class.SurveyQuestion.php:201
SurveyQuestion\setOwner
setOwner($owner="")
Sets the creator/owner ID of the SurveyQuestion object.
Definition: class.SurveyQuestion.php:431
SurveyQuestion\setTitle
setTitle($title="")
Sets the title string of the SurveyQuestion object.
Definition: class.SurveyQuestion.php:250
SurveyQuestion\setObligatory
setObligatory($obligatory=1)
Sets the obligatory state of the question.
Definition: class.SurveyQuestion.php:262
ilRTE\_replaceMediaObjectImageSrc
static _replaceMediaObjectImageSrc($a_text, $a_direction=0, $nic=IL_INST_ID)
Replaces image source from mob image urls with the mob id or replaces mob id with the correct image s...
Definition: class.ilRTE.php:237

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().

+ Here is the call graph for this function:

◆ saveCategoriesToDb()

SurveySingleChoiceQuestion::saveCategoriesToDb ( )

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

250 {
251 global $ilDB;
252
253 $this->log->debug("DELETE from svy_variable before the INSERT into svy_variable. if scale > 0 we get scale value else we get null");
254
255 $affectedRows = $ilDB->manipulateF("DELETE FROM svy_variable WHERE question_fi = %s",
256 array('integer'),
257 array($this->getId())
258 );
259
260 for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
261 {
262 $cat = $this->categories->getCategory($i);
263 $category_id = $this->saveCategoryToDb($cat->title, $cat->neutral);
264 $next_id = $ilDB->nextId('svy_variable');
265 $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)",
266 array('integer','integer','integer','float','integer','integer', 'integer','integer'),
267 array($next_id, $category_id, $this->getId(), ($i + 1), $cat->other, $i, ($cat->scale > 0) ? $cat->scale : null, time())
268 );
269
270 $debug_scale = ($cat->scale > 0) ? $cat->scale : null;
271 $this->log->debug("INSERT INTO svy_variable category_fi= ".$category_id." question_fi= ".$this->getId()." value1= ".($i + 1)." other= ".$cat->other." sequence= ".$i." scale =".$debug_scale);
272 }
273 $this->saveCompletionStatus();
274 }
SurveyQuestion\saveCategoryToDb
saveCategoryToDb($categorytext, $neutral=0)
Saves a category to the database.
Definition: class.SurveyQuestion.php:969
SurveyQuestion\saveCompletionStatus
saveCompletionStatus($original_id="")
Saves the complete flag to the database.
Definition: class.SurveyQuestion.php:739

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

Referenced by saveToDb().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ savePhrase()

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 @access public

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

420 {
421 global $ilUser;
422 global $ilDB;
423
424 $next_id = $ilDB->nextId('svy_phrase');
425 $affectedRows = $ilDB->manipulateF("INSERT INTO svy_phrase (phrase_id, title, defaultvalue, owner_fi, tstamp) VALUES (%s, %s, %s, %s, %s)",
426 array('integer','text','text','integer','integer'),
427 array($next_id, $title, 1, $ilUser->getId(), time())
428 );
429 $phrase_id = $next_id;
430
431 $counter = 1;
432 foreach ($_SESSION['save_phrase_data'] as $data)
433 {
434 $next_id = $ilDB->nextId('svy_category');
435 $affectedRows = $ilDB->manipulateF("INSERT INTO svy_category (category_id, title, defaultvalue, owner_fi, tstamp, neutral) VALUES (%s, %s, %s, %s, %s, %s)",
436 array('integer','text','text','integer','integer','text'),
437 array($next_id, $data['answer'], 1, $ilUser->getId(), time(), $data['neutral'])
438 );
439 $category_id = $next_id;
440 $next_id = $ilDB->nextId('svy_phrase_cat');
441 $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)",
442 array('integer', 'integer', 'integer','integer', 'integer', 'integer'),
443 array($next_id, $phrase_id, $category_id, $counter, ($data['other']) ? 1 : 0, $data['scale'])
444 );
445 $counter++;
446 }
447 }
$_SESSION
$_SESSION["AccountId"]
Definition: cfg.phpunit.template.php:10
$counter
$counter
Definition: config-scanner.php:59

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

◆ saveToDb()

SurveySingleChoiceQuestion::saveToDb (   $original_id = "")

Saves a SurveySingleChoiceQuestion object to a database.

@access public

Reimplemented from SurveyQuestion.

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

225 {
226 global $ilDB;
227
228 $affectedRows = parent::saveToDb($original_id);
229 if ($affectedRows == 1)
230 {
231 $this->log->debug("Before save Category-> DELETE from svy_qst_sc WHERE question_fi = ".$this->getId()." AND INSERT again the same id and orientation in svy_qst_sc");
232 $affectedRows = $ilDB->manipulateF("DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
233 array('integer'),
234 array($this->getId())
235 );
236 $affectedRows = $ilDB->manipulateF("INSERT INTO " . $this->getAdditionalTableName() . " (question_fi, orientation) VALUES (%s, %s)",
237 array('integer', 'text'),
238 array(
239 $this->getId(),
240 $this->getOrientation()
241 )
242 );
243
244 $this->saveMaterial();
245 $this->saveCategoriesToDb();
246 }
247 }
SurveyQuestion\saveMaterial
saveMaterial()
save material to db
Definition: class.SurveyQuestion.php:825

References $ilDB, getAdditionalTableName(), SurveyQuestion\getId(), SurveyQuestion\getOrientation(), saveCategoriesToDb(), and SurveyQuestion\saveMaterial().

+ Here is the call graph for this function:

◆ saveUserInput()

SurveySingleChoiceQuestion::saveUserInput (   $post_data,
  $active_id,
  $a_return = false 
)

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

547 {
548 global $ilDB;
549
550 $entered_value = $post_data[$this->getId() . "_value"];
551
552 if($a_return)
553 {
554 return array(array("value"=>$entered_value,
555 "textanswer"=>$post_data[$this->getId() . "_" . $entered_value . "_other"]));
556 }
557 if (strlen($entered_value) == 0) return;
558
559 $next_id = $ilDB->nextId('svy_answer');
560 #20216
561 $fields = array();
562 $fields['answer_id'] = array("integer", $next_id);
563 $fields['question_fi'] = array("integer", $this->getId());
564 $fields['active_fi'] = array("integer", $active_id);
565 $fields['value'] = array("float", (strlen($entered_value)) ? $entered_value : NULL);
566 $fields['textanswer'] = array("clob", ($post_data[$this->getId() . "_" . $entered_value . "_other"]) ? $post_data[$this->getId() . "_" . $entered_value . "_other"] : null);
567 $fields['tstamp'] = array("integer", time());
568
569 $affectedRows = $ilDB->insert("svy_answer", $fields);
570
571 $debug_value = (strlen($entered_value)) ? $entered_value : "NULL";
572 $debug_answer = ($post_data[$this->getId() . "_" . $entered_value . "_other"]) ? $post_data[$this->getId() . "_" . $entered_value . "_other"] : "NULL";
573 $this->log->debug("INSERT svy_answer answer_id=".$next_id." question_fi=".$this->getId()." active_fi=".$active_id." value=".$debug_value. " textanswer=".$debug_answer);
574 }

References $ilDB, and SurveyQuestion\getId().

+ Here is the call graph for this function:

◆ toXML()

SurveySingleChoiceQuestion::toXML (   $a_include_header = TRUE,
  $obligatory_state = "" 
)

Returns an xml representation of the question.

Returns
string The xml representation of the question @access public

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

283 {
284 include_once("./Services/Xml/classes/class.ilXmlWriter.php");
285 $a_xml_writer = new ilXmlWriter;
286 $a_xml_writer->xmlHeader();
287 $this->insertXML($a_xml_writer, $a_include_header, $obligatory_state);
288 $xml = $a_xml_writer->xmlDumpMem(FALSE);
289 if (!$a_include_header)
290 {
291 $pos = strpos($xml, "?>");
292 $xml = substr($xml, $pos + 2);
293 }
294 return $xml;
295 }
SurveySingleChoiceQuestion\insertXML
insertXML(&$a_xml_writer, $a_include_header=TRUE)
Adds the question XML to a given XMLWriter object.
Definition: class.SurveySingleChoiceQuestion.php:304
ilXmlWriter
XML writer class.
Definition: class.ilXmlWriter.php:18
ilXmlWriter\xmlHeader
xmlHeader()
Writes xml header @access public.
Definition: class.ilXmlWriter.php:297

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

+ Here is the call graph for this function:

◆ usableForPrecondition()

SurveySingleChoiceQuestion::usableForPrecondition ( )

Returns if the question is usable for preconditions.

Returns
boolean TRUE if the question is usable for a precondition, FALSE otherwise @access public

Reimplemented from SurveyQuestion.

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

608 {
609 return TRUE;
610 }

Field Documentation

◆ $categories

SurveySingleChoiceQuestion::$categories

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

Referenced by getCategories(), and getCategoriesForPhrase().

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