ILIAS  release_8 Revision v8.24
class.SurveyTextQuestionGUI.php
Go to the documentation of this file.
1<?php
2
26{
27 protected function initObject(): void
28 {
29 $this->object = new SurveyTextQuestion();
30 }
31
32
33 //
34 // EDITOR
35 //
36
37 public function setQuestionTabs(): void
38 {
39 $this->setQuestionTabsForClass("surveytextquestiongui");
40 }
41
42 protected function addFieldsToEditForm(ilPropertyFormGUI $a_form): void
43 {
44 // maximum number of characters
45 $maxchars = new ilNumberInputGUI($this->lng->txt("maxchars"), "maxchars");
46 $maxchars->setRequired(false);
47 $maxchars->setSize(5);
48 $maxchars->setDecimals(0);
49 $a_form->addItem($maxchars);
50
51 // textwidth
52 $textwidth = new ilNumberInputGUI($this->lng->txt("width"), "textwidth");
53 $textwidth->setRequired(true);
54 $textwidth->setSize(3);
55 $textwidth->setDecimals(0);
56 $textwidth->setMinValue(10, true);
57 $a_form->addItem($textwidth);
58
59 // textheight
60 $textheight = new ilNumberInputGUI($this->lng->txt("height"), "textheight");
61 $textheight->setRequired(true);
62 $textheight->setSize(3);
63
64 $textheight->setDecimals(0);
65 $textheight->setMinValue(1);
66 $a_form->addItem($textheight);
67
68 // values
69 if ($this->object->getMaxChars() > 0) {
70 $maxchars->setValue($this->object->getMaxChars());
71 }
72 $textwidth->setValue($this->object->getTextWidth());
73 $textheight->setValue($this->object->getTextHeight());
74 }
75
76 protected function importEditFormValues(ilPropertyFormGUI $a_form): void
77 {
78 $max = $a_form->getInput("maxchars");
79 $this->object->setMaxChars((int) $max);
80 $this->object->setTextWidth($a_form->getInput("textwidth"));
81 $this->object->setTextHeight($a_form->getInput("textheight"));
82 }
83
84 public function getParsedAnswers(
85 array $a_working_data = null,
86 $a_only_user_anwers = false
87 ): array {
88 $res = array();
89 if (is_array($a_working_data) && isset($a_working_data[0])) {
90 $res[] = array("textanswer" => trim($a_working_data[0]["textanswer"] ?? ""));
91 }
92
93 return $res;
94 }
95
96 public function getPrintView(
97 int $question_title = 1,
98 bool $show_questiontext = true,
99 ?int $survey_id = null,
100 ?array $working_data = null
101 ): string {
102 $user_answer = null;
103 if ($working_data) {
104 $user_answer = $this->getParsedAnswers($working_data);
105 $user_answer = $user_answer[0]["textanswer"];
106 }
107
108 $template = new ilTemplate("tpl.il_svy_qpl_text_printview.html", true, true, "Modules/SurveyQuestionPool");
109 if ($show_questiontext) {
110 $this->outQuestionText($template);
111 }
112 if ($question_title) {
113 $template->setVariable("QUESTION_TITLE", $this->getPrintViewQuestionTitle($question_title));
114 }
115 $template->setVariable("QUESTION_ID", $this->object->getId());
116 $template->setVariable("TEXT_ANSWER", $this->lng->txt("answer"));
117 if (is_array($working_data) && trim($user_answer)) {
118 $template->setVariable("TEXT", nl2br($user_answer));
119 } else {
120 $template->setVariable("TEXTBOX_IMAGE", ilUtil::getHtmlPath(ilUtil::getImagePath("textbox.png")));
121 $template->setVariable("TEXTBOX", $this->lng->txt("textbox"));
122 $template->setVariable("TEXTBOX_WIDTH", $this->object->getTextWidth() * 16);
123 $template->setVariable("TEXTBOX_HEIGHT", $this->object->getTextHeight() * 16);
124 }
125 if ($this->object->getMaxChars()) {
126 $template->setVariable("TEXT_MAXCHARS", sprintf($this->lng->txt("text_maximum_chars_allowed"), $this->object->getMaxChars()));
127 }
128 return $template->get();
129 }
130
131
132 //
133 // EXECUTION
134 //
135
139 public function getWorkingForm(
140 array $working_data = null,
141 int $question_title = 1,
142 bool $show_questiontext = true,
143 string $error_message = "",
144 int $survey_id = null,
145 bool $compress_view = false
146 ): string {
147 $template = new ilTemplate("tpl.il_svy_out_text.html", true, true, "Modules/SurveyQuestionPool");
148 $template->setCurrentBlock("material_text");
149 $template->setVariable("TEXT_MATERIAL", $this->getMaterialOutput());
150 $template->parseCurrentBlock();
151
152 if ($this->object->getTextHeight() === 1) {
153 $template->setCurrentBlock("textinput");
154 if (is_array($working_data)) {
155 if (isset($working_data[0]["textanswer"])) {
156 $template->setVariable("VALUE_ANSWER", " value=\"" . ilLegacyFormElementsUtil::prepareFormOutput($working_data[0]["textanswer"]) . "\"");
157 }
158 }
159 $template->setVariable("QUESTION_ID", $this->object->getId());
160 $template->setVariable("WIDTH", $this->object->getTextWidth());
161 if ($this->object->getMaxChars()) {
162 $template->setVariable("MAXLENGTH", " maxlength=\"" . $this->object->getMaxChars() . "\"");
163 }
164 } else {
165 $template->setCurrentBlock("textarea");
166 if (is_array($working_data) && isset($working_data[0]["textanswer"])) {
167 $template->setVariable("VALUE_ANSWER", ilLegacyFormElementsUtil::prepareFormOutput($working_data[0]["textanswer"]));
168 }
169 $template->setVariable("QUESTION_ID", $this->object->getId());
170 $template->setVariable("WIDTH", $this->object->getTextWidth());
171 $template->setVariable("HEIGHT", $this->object->getTextHeight());
172 }
173 $template->parseCurrentBlock();
174 $template->setCurrentBlock("question_data_text");
175 if ($show_questiontext) {
176 $this->outQuestionText($template);
177 }
178 $template->setVariable("QUESTION_TITLE", $this->getQuestionTitle($question_title));
179 $template->setVariable("TEXT_ANSWER", $this->lng->txt("answer"));
180 $template->setVariable("LABEL_QUESTION_ID", $this->object->getId());
181 if (strcmp($error_message, "") !== 0) {
182 $template->setVariable("ERROR_MESSAGE", "<p class=\"warning\">$error_message</p>");
183 }
184 if ($this->object->getMaxChars()) {
185 $template->setVariable("TEXT_MAXCHARS", sprintf($this->lng->txt("text_maximum_chars_allowed"), $this->object->getMaxChars()));
186 }
187 $template->parseCurrentBlock();
188 return $template->get();
189 }
190}
Basic class for all survey question types The SurveyQuestionGUI class defines and encapsulates basic ...
setQuestionTabsForClass(string $guiclass)
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
addFieldsToEditForm(ilPropertyFormGUI $a_form)
getWorkingForm(array $working_data=null, int $question_title=1, bool $show_questiontext=true, string $error_message="", int $survey_id=null, bool $compress_view=false)
Creates the question output form for the learner.
importEditFormValues(ilPropertyFormGUI $a_form)
getPrintView(int $question_title=1, bool $show_questiontext=true, ?int $survey_id=null, ?array $working_data=null)
getParsedAnswers(array $a_working_data=null, $a_only_user_anwers=false)
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
return true
static prepareFormOutput($a_str, bool $a_strip=false)
This class represents a number property in a property form.
This class represents a property form user interface.
getInput(string $a_post_var, bool $ensureValidation=true)
Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-...
special template class to simplify handling of ITX/PEAR
setCurrentBlock(string $part=ilGlobalTemplateInterface::DEFAULT_BLOCK)
static getHtmlPath(string $relative_path)
get url of path
static getImagePath(string $img, string $module_path="", string $mode="output", bool $offline=false)
get image path (for images located in a template directory)
$res
Definition: ltiservices.php:69