ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
class.SurveySingleChoiceQuestionGUI.php
Go to the documentation of this file.
1 <?php
2 
3 /* Copyright (c) 1998-2019 ILIAS open source, Extended GPL, see docs/LICENSE */
4 
13 class SurveySingleChoiceQuestionGUI extends SurveyQuestionGUI
14 {
15  protected function initObject()
16  {
17  $this->object = new SurveySingleChoiceQuestion();
18  }
19 
20 
21  //
22  // EDITOR
23  //
24 
25  public function setQuestionTabs()
26  {
27  $this->setQuestionTabsForClass("surveysinglechoicequestiongui");
28  }
29 
30  protected function addFieldsToEditForm(ilPropertyFormGUI $a_form)
31  {
32  // orientation
33  $orientation = new ilRadioGroupInputGUI($this->lng->txt("orientation"), "orientation");
34  $orientation->setRequired(false);
35  $orientation->addOption(new ilRadioOption($this->lng->txt('vertical'), 0));
36  $orientation->addOption(new ilRadioOption($this->lng->txt('horizontal'), 1));
37  $orientation->addOption(new ilRadioOption($this->lng->txt('combobox'), 2));
38  $a_form->addItem($orientation);
39 
40  // Answers
41  $answers = new ilCategoryWizardInputGUI($this->lng->txt("answers"), "answers");
42  $answers->setRequired(false);
43  $answers->setAllowMove(true);
44  $answers->setShowWizard(true);
45  $answers->setShowSavePhrase(true);
46  $answers->setUseOtherAnswer(true);
47  $answers->setShowNeutralCategory(true);
48  $answers->setNeutralCategoryTitle($this->lng->txt('svy_neutral_answer'));
49  $answers->setDisabledScale(false);
50  $a_form->addItem($answers);
51 
52  // values
53  $orientation->setValue($this->object->getOrientation());
54  if (!$this->object->getCategories()->getCategoryCount()) {
55  $this->object->getCategories()->addCategory("");
56  }
57  $answers->setValues($this->object->getCategories());
58  }
59 
60  protected function importEditFormValues(ilPropertyFormGUI $a_form)
61  {
62  $this->log->debug("importing edit values");
63 
64  $this->object->setOrientation($a_form->getInput("orientation"));
65 
66  $this->object->categories->flushCategories();
67  foreach ($_POST['answers']['answer'] as $key => $value) {
68  if (strlen($value)) {
69  $this->object->getCategories()->addCategory($value, $_POST['answers']['other'][$key], 0, null, $_POST['answers']['scale'][$key]);
70  }
71  }
72  if (strlen($_POST['answers']['neutral'])) {
73  $this->object->getCategories()->addCategory($_POST['answers']['neutral'], 0, 1, null, $_POST['answers_neutral_scale']);
74  }
75  }
76 
77  public function getParsedAnswers(array $a_working_data = null, $a_only_user_anwers = false)
78  {
79  if (is_array($a_working_data)) {
80  $user_answer = $a_working_data[0];
81  }
82 
83  $options = array();
84  for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) {
85  $cat = $this->object->categories->getCategory($i);
86  $value = ($cat->scale) ? ($cat->scale - 1) : $i;
87 
88  $checked = "unchecked";
89  $text = null;
90  if (is_array($a_working_data) &&
91  is_array($user_answer)) {
92  if ($value == $user_answer["value"]) {
93  $checked = "checked";
94  if ($user_answer["textanswer"]) {
95  $text = $user_answer["textanswer"];
96  }
97  }
98  }
99 
100  // "other" options have to be last or horizontal will be screwed
101  $idx = $cat->other . "_" . $value;
102 
103  if (!$a_only_user_anwers || $checked == "checked") {
104  $options[$idx] = array(
105  "value" => $value
106  ,"title" => trim($cat->title)
107  ,"other" => (bool) $cat->other
108  ,"checked" => $checked
109  ,"textanswer" => $text
110  );
111  }
112 
113  ksort($options);
114  }
115 
116  return array_values($options);
117  }
118 
124  public function getPrintView($question_title = 1, $show_questiontext = 1, $survey_id = null, array $a_working_data = null)
125  {
126  $options = $this->getParsedAnswers($a_working_data);
127 
128  // rendering
129 
130  $template = new ilTemplate("tpl.il_svy_qpl_sc_printview.html", true, true, "Modules/SurveyQuestionPool");
131  switch ($this->object->orientation) {
132  case 0:
133  // vertical orientation
134  foreach ($options as $option) {
135  if ($option["other"]) {
136  $template->setCurrentBlock("other_row");
137  $template->setVariable("IMAGE_RADIO", ilUtil::getHtmlPath(ilUtil::getImagePath("radiobutton_" . $option["checked"] . ".png")));
138  $template->setVariable("ALT_RADIO", $this->lng->txt($option["checked"]));
139  $template->setVariable("TITLE_RADIO", $this->lng->txt($option["checked"]));
140  $template->setVariable("OTHER_LABEL", ilUtil::prepareFormOutput($option["title"]));
141  $template->setVariable("OTHER_ANSWER", $option["textanswer"]
142  ? ilUtil::prepareFormOutput($option["textanswer"])
143  : "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;");
144  $template->parseCurrentBlock();
145  } else {
146  $template->setCurrentBlock("row");
147  $template->setVariable("IMAGE_RADIO", ilUtil::getHtmlPath(ilUtil::getImagePath("radiobutton_" . $option["checked"] . ".png")));
148  $template->setVariable("ALT_RADIO", $this->lng->txt($option["checked"]));
149  $template->setVariable("TITLE_RADIO", $this->lng->txt($option["checked"]));
150  $template->setVariable("TEXT_SC", ilUtil::prepareFormOutput($option["title"]));
151  $template->parseCurrentBlock();
152  }
153  }
154  break;
155  case 1:
156  // horizontal orientation
157  foreach ($options as $option) {
158  $template->setCurrentBlock("radio_col");
159  $template->setVariable("IMAGE_RADIO", ilUtil::getHtmlPath(ilUtil::getImagePath("radiobutton_" . $option["checked"] . ".png")));
160  $template->setVariable("ALT_RADIO", $this->lng->txt($option["checked"]));
161  $template->setVariable("TITLE_RADIO", $this->lng->txt($option["checked"]));
162  $template->parseCurrentBlock();
163  }
164  foreach ($options as $option) {
165  if ($option["other"]) {
166  $template->setCurrentBlock("other_text_col");
167  $template->setVariable("OTHER_LABEL", ilUtil::prepareFormOutput($option["title"]));
168  $template->setVariable("OTHER_ANSWER", $option["textanswer"]
169  ? ilUtil::prepareFormOutput($option["textanswer"])
170  : "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;");
171  $template->parseCurrentBlock();
172  } else {
173  $template->setCurrentBlock("text_col");
174  $template->setVariable("TEXT_SC", ilUtil::prepareFormOutput($option["title"]));
175  $template->parseCurrentBlock();
176  }
177  }
178  break;
179  case 2:
180  foreach ($options as $option) {
181  $template->setCurrentBlock("comborow");
182  $template->setVariable("TEXT_SC", ilUtil::prepareFormOutput($option["title"]));
183  $template->setVariable("VALUE_SC", $option["value"]);
184  if ($option["checked"] == "checked") {
185  $template->setVariable("SELECTED_SC", ' selected="selected"');
186  }
187  $template->parseCurrentBlock();
188  }
189  $template->setCurrentBlock("combooutput");
190  $template->setVariable("QUESTION_ID", $this->object->getId());
191  $template->setVariable("SELECT_OPTION", $this->lng->txt("select_option"));
192  $template->setVariable("TEXT_SELECTION", $this->lng->txt("selection"));
193  $template->parseCurrentBlock();
194  break;
195  }
196  if ($question_title) {
197  $template->setVariable("QUESTION_TITLE", $this->getPrintViewQuestionTitle($question_title));
198  }
199  if ($show_questiontext) {
200  $this->outQuestionText($template);
201  }
202  $template->parseCurrentBlock();
203  return $template->get();
204  }
205 
206 
207  //
208  // EXECUTION
209  //
210 
216  public function getWorkingForm($working_data = "", $question_title = 1, $show_questiontext = 1, $error_message = "", $survey_id = null)
217  {
218  $template = new ilTemplate("tpl.il_svy_out_sc.html", true, true, "Modules/SurveyQuestionPool");
219  $template->setCurrentBlock("material");
220  $template->setVariable("TEXT_MATERIAL", $this->getMaterialOutput());
221  $template->parseCurrentBlock();
222  switch ($this->object->orientation) {
223  case 0:
224  // vertical orientation
225  for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) {
226  $cat = $this->object->categories->getCategory($i);
227 
228  $debug_scale = ($cat->scale) ? ($cat->scale - 1) : $i;
229  $this->log->debug("Vertical orientation - Original scale = " . $cat->scale . " If(scale) scale -1 else i. The new scale value is = " . $debug_scale);
230 
231  if ($cat->other) {
232  $template->setCurrentBlock("other_row");
233  if (strlen($cat->title)) {
234  $template->setVariable("OTHER_LABEL", $cat->title);
235  }
236  $template->setVariable("VALUE_SC", ($cat->scale) ? ($cat->scale - 1) : $i);
237  $template->setVariable("QUESTION_ID", $this->object->getId());
238  if (is_array($working_data)) {
239  foreach ($working_data as $value) {
240  if (strlen($value["value"])) {
241  if ($value["value"] == $cat->scale - 1) {
242  if (strlen($value['textanswer'])) {
243  $template->setVariable("OTHER_VALUE", ' value="' . ilUtil::prepareFormOutput($value['textanswer']) . '"');
244  }
245  if (!$value['uncheck']) {
246  $template->setVariable("CHECKED_SC", " checked=\"checked\"");
247  }
248  }
249  }
250  }
251  }
252  $template->parseCurrentBlock();
253  } else {
254  $template->setCurrentBlock("row");
255  if ($cat->neutral) {
256  $template->setVariable('ROWCLASS', ' class="neutral"');
257  }
258  $template->setVariable("TEXT_SC", ilUtil::prepareFormOutput($cat->title));
259  $template->setVariable("VALUE_SC", ($cat->scale) ? ($cat->scale - 1) : $i);
260  $template->setVariable("QUESTION_ID", $this->object->getId());
261  if (is_array($working_data)) {
262  foreach ($working_data as $value) {
263  if (strcmp($value["value"], "") != 0) {
264  if ($value["value"] == $cat->scale - 1) {
265  if (!$value['uncheck']) {
266  $template->setVariable("CHECKED_SC", " checked=\"checked\"");
267  }
268  }
269  }
270  }
271  }
272  $template->parseCurrentBlock();
273  }
274  $template->touchBlock('outer_row');
275  }
276  break;
277  case 1:
278  // horizontal orientation
279  for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) {
280  $cat = $this->object->categories->getCategory($i);
281 
282  $debug_scale = ($cat->scale) ? ($cat->scale - 1) : $i;
283  $this->log->debug("Horizontal orientation - Original NEUTRAL scale = " . $cat->scale . " If(scale) scale -1 else i. The new scale value is = " . $debug_scale);
284 
285  $template->setCurrentBlock("radio_col");
286  if ($cat->neutral) {
287  $template->setVariable('COLCLASS', ' neutral');
288  }
289  $template->setVariable("VALUE_SC", ($cat->scale) ? ($cat->scale - 1) : $i);
290  $template->setVariable("QUESTION_ID", $this->object->getId());
291  if (is_array($working_data)) {
292  foreach ($working_data as $value) {
293  if (strcmp($value["value"], "") != 0) {
294  if ($value["value"] == $cat->scale - 1) {
295  if (!$value['uncheck']) {
296  $template->setVariable("CHECKED_SC", " checked=\"checked\"");
297  }
298  }
299  }
300  }
301  }
302  $template->parseCurrentBlock();
303  }
304  for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) {
305  $cat = $this->object->categories->getCategory($i);
306 
307  $debug_scale = ($cat->scale) ? ($cat->scale - 1) : $i;
308  $this->log->debug("Horizontal orientation - Original scale = " . $cat->scale . " If(scale) scale -1 else i. The new scale value is = " . $debug_scale);
309 
310  if ($cat->other) {
311  $template->setCurrentBlock("text_other_col");
312  $template->setVariable("VALUE_SC", ($cat->scale) ? ($cat->scale - 1) : $i);
313  $template->setVariable("QUESTION_ID", $this->object->getId());
314  if (strlen($cat->title)) {
315  $template->setVariable("OTHER_LABEL", $cat->title);
316  }
317  if (is_array($working_data)) {
318  foreach ($working_data as $value) {
319  if (strlen($value["value"])) {
320  if ($value["value"] == $cat->scale - 1 && strlen($value['textanswer'])) {
321  $template->setVariable("OTHER_VALUE", ' value="' . ilUtil::prepareFormOutput($value['textanswer']) . '"');
322  }
323  }
324  }
325  }
326  $template->parseCurrentBlock();
327  } else {
328  $template->setCurrentBlock("text_col");
329  if ($cat->neutral) {
330  $template->setVariable('COLCLASS', ' neutral');
331  }
332  $template->setVariable("VALUE_SC", ($cat->scale) ? ($cat->scale - 1) : $i);
333  $template->setVariable("TEXT_SC", ilUtil::prepareFormOutput($cat->title));
334  $template->setVariable("QUESTION_ID", $this->object->getId());
335  $template->parseCurrentBlock();
336  }
337  $template->touchBlock('text_outer_col');
338  }
339  break;
340  case 2:
341  // combobox output
342  for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) {
343  $cat = $this->object->categories->getCategory($i);
344 
345  $debug_scale = ($cat->scale) ? ($cat->scale - 1) : $i;
346  $this->log->debug("Combobox - Original scale = " . $cat->scale . " If(scale) scale -1 else i. The new scale value is = " . $debug_scale);
347 
348  $template->setCurrentBlock("comborow");
349  $template->setVariable("TEXT_SC", $cat->title);
350  $template->setVariable("VALUE_SC", ($cat->scale) ? ($cat->scale - 1) : $i);
351  if (is_array($working_data)) {
352  if (strcmp($working_data[0]["value"], "") != 0) {
353  if ($working_data[0]["value"] == $cat->scale - 1) {
354  $template->setVariable("SELECTED_SC", " selected=\"selected\"");
355  }
356  }
357  }
358  $template->parseCurrentBlock();
359  }
360  $template->setCurrentBlock("combooutput");
361  $template->setVariable("QUESTION_ID", $this->object->getId());
362  $template->setVariable("SELECT_OPTION", $this->lng->txt("select_option"));
363  $template->setVariable("TEXT_SELECTION", $this->lng->txt("selection"));
364  $template->parseCurrentBlock();
365  break;
366  }
367  if ($question_title) {
368  $template->setVariable("QUESTION_TITLE", $this->object->getTitle());
369  }
370  $template->setCurrentBlock("question_data");
371  if (strcmp($error_message, "") != 0) {
372  $template->setVariable("ERROR_MESSAGE", "<p class=\"warning\">$error_message</p>");
373  }
374  if ($show_questiontext) {
375  $this->outQuestionText($template);
376  }
377  $template->parseCurrentBlock();
378  return $template->get();
379  }
380 }
ilUtil\prepareFormOutput
static prepareFormOutput($a_str, $a_strip=false)
prepares string output for html forms public
Definition: class.ilUtil.php:2822
ilRadioOption
This class represents an option in a radio group.
Definition: class.ilRadioOption.php:31
SurveyQuestionGUI\getMaterialOutput
getMaterialOutput()
Creates the HTML output of the question material(s)
Definition: class.SurveyQuestionGUI.php:613
SurveySingleChoiceQuestionGUI\getParsedAnswers
getParsedAnswers(array $a_working_data=null, $a_only_user_anwers=false)
Definition: class.SurveySingleChoiceQuestionGUI.php:77
ilPropertyFormGUI
This class represents a property form user interface.
Definition: class.ilPropertyFormGUI.php:47
ilPropertyFormGUI\addItem
addItem($a_item)
Add Item (Property, SectionHeader).
Definition: class.ilPropertyFormGUI.php:311
SurveySingleChoiceQuestionGUI
SingleChoice survey question GUI representation.
Definition: class.SurveySingleChoiceQuestionGUI.php:13
SurveySingleChoiceQuestionGUI\getWorkingForm
getWorkingForm($working_data="", $question_title=1, $show_questiontext=1, $error_message="", $survey_id=null)
Creates the question output form for the learner.
Definition: class.SurveySingleChoiceQuestionGUI.php:216
ilRadioGroupInputGUI
This class represents a property in a property form.
Definition: class.ilRadioGroupInputGUI.php:33
ilUtil\getImagePath
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
Definition: class.ilUtil.php:80
ilPropertyFormGUI\getInput
getInput($a_post_var, $ensureValidation=true)
Returns the value of a HTTP-POST variable, identified by the passed id.
Definition: class.ilPropertyFormGUI.php:580
ilUtil\getHtmlPath
static getHtmlPath($relative_path)
get url of path
Definition: class.ilUtil.php:151
ilCategoryWizardInputGUI
This class represents a survey question category wizard property in a property form.
Definition: class.ilCategoryWizardInputGUI.php:31
SurveySingleChoiceQuestionGUI\getPrintView
getPrintView($question_title=1, $show_questiontext=1, $survey_id=null, array $a_working_data=null)
Creates a HTML representation of the question.
Definition: class.SurveySingleChoiceQuestionGUI.php:124
SurveyQuestionGUI\getPrintViewQuestionTitle
getPrintViewQuestionTitle($question_title=1)
Definition: class.SurveyQuestionGUI.php:554
SurveyQuestionGUI
Basic class for all survey question types.
Definition: class.SurveyQuestionGUI.php:34
$_POST
$_POST["username"]
Definition: cfg.phpunit.template.php:11
ilFormPropertyGUI\setRequired
setRequired($a_required)
Set Required.
Definition: class.ilFormPropertyGUI.php:185
$i
$i
Definition: metadata.php:24