bcc1d898aec5838ecf77004417b43966532378dd
[moodle.git] / mod / feedback / item / textfield / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 defined('MOODLE_INTERNAL') OR die('not allowed');
18 require_once($CFG->dirroot.'/mod/feedback/item/feedback_item_class.php');
20 class feedback_item_textfield extends feedback_item_base {
21     protected $type = "textfield";
22     private $commonparams;
23     private $item_form;
24     private $item;
26     public function init() {
28     }
30     public function build_editform($item, $feedback, $cm) {
31         global $DB, $CFG;
32         require_once('textfield_form.php');
34         //get the lastposition number of the feedback_items
35         $position = $item->position;
36         $lastposition = $DB->count_records('feedback_item', array('feedback'=>$feedback->id));
37         if ($position == -1) {
38             $i_formselect_last = $lastposition + 1;
39             $i_formselect_value = $lastposition + 1;
40             $item->position = $lastposition + 1;
41         } else {
42             $i_formselect_last = $lastposition;
43             $i_formselect_value = $item->position;
44         }
45         //the elements for position dropdownlist
46         $positionlist = array_slice(range(0, $i_formselect_last), 1, $i_formselect_last, true);
48         $item->presentation = empty($item->presentation) ? '' : $item->presentation;
50         $size_and_length = explode('|', $item->presentation);
52         if (isset($size_and_length[0]) AND $size_and_length[0] >= 5) {
53             $itemsize = $size_and_length[0];
54         } else {
55             $itemsize = 30;
56         }
58         $itemlength = isset($size_and_length[1]) ? $size_and_length[1] : 255;
60         $item->itemsize = $itemsize;
61         $item->itemmaxlength = $itemlength;
63         //all items for dependitem
64         $feedbackitems = feedback_get_depend_candidates_for_item($feedback, $item);
65         $commonparams = array('cmid' => $cm->id,
66                              'id' => isset($item->id) ? $item->id : null,
67                              'typ' => $item->typ,
68                              'items' => $feedbackitems,
69                              'feedback' => $feedback->id);
71         //build the form
72         $customdata = array('item' => $item,
73                             'common' => $commonparams,
74                             'positionlist' => $positionlist,
75                             'position' => $position);
77         $this->item_form = new feedback_textfield_form('edit_item.php', $customdata);
78     }
80     //this function only can used after the call of build_editform()
81     public function show_editform() {
82         $this->item_form->display();
83     }
85     public function is_cancelled() {
86         return $this->item_form->is_cancelled();
87     }
89     public function get_data() {
90         if ($this->item = $this->item_form->get_data()) {
91             return true;
92         }
93         return false;
94     }
96     public function save_item() {
97         global $DB;
99         if (!$item = $this->item_form->get_data()) {
100             return false;
101         }
103         if (isset($item->clone_item) AND $item->clone_item) {
104             $item->id = ''; //to clone this item
105             $item->position++;
106         }
108         $item->hasvalue = $this->get_hasvalue();
109         if (!$item->id) {
110             $item->id = $DB->insert_record('feedback_item', $item);
111         } else {
112             $DB->update_record('feedback_item', $item);
113         }
115         return $DB->get_record('feedback_item', array('id'=>$item->id));
116     }
119     //liefert eine Struktur ->name, ->data = array(mit Antworten)
120     public function get_analysed($item, $groupid = false, $courseid = false) {
121         global $DB;
123         $analysed_val = new stdClass();
124         $analysed_val->data = null;
125         $analysed_val->name = $item->name;
127         $values = feedback_get_group_values($item, $groupid, $courseid);
128         if ($values) {
129             $data = array();
130             foreach ($values as $value) {
131                 $data[] = str_replace("\n", '<br />', $value->value);
132             }
133             $analysed_val->data = $data;
134         }
135         return $analysed_val;
136     }
138     public function get_printval($item, $value) {
140         if (!isset($value->value)) {
141             return '';
142         }
143         return $value->value;
144     }
146     public function print_analysed($item, $itemnr = '', $groupid = false, $courseid = false) {
147         $values = feedback_get_group_values($item, $groupid, $courseid);
148         if ($values) {
149             echo '<tr><th colspan="2" align="left">';
150             echo $itemnr . ' ';
151             if (strval($item->label) !== '') {
152                 echo '('. format_string($item->label).') ';
153             }
154             echo format_text($item->name, FORMAT_HTML, array('noclean' => true, 'para' => false));
155             echo '</th></tr>';
156             foreach ($values as $value) {
157                 echo '<tr><td colspan="2" valign="top" align="left">';
158                 echo '-&nbsp;&nbsp;'.str_replace("\n", '<br />', $value->value);
159                 echo '</td></tr>';
160             }
161         }
162     }
164     public function excelprint_item(&$worksheet, $row_offset,
165                              $xls_formats, $item,
166                              $groupid, $courseid = false) {
168         $analysed_item = $this->get_analysed($item, $groupid, $courseid);
170         $worksheet->write_string($row_offset, 0, $item->label, $xls_formats->head2);
171         $worksheet->write_string($row_offset, 1, $item->name, $xls_formats->head2);
172         $data = $analysed_item->data;
173         if (is_array($data)) {
174             $worksheet->write_string($row_offset, 2, htmlspecialchars_decode($data[0], ENT_QUOTES), $xls_formats->value_bold);
175             $row_offset++;
176             $sizeofdata = count($data);
177             for ($i = 1; $i < $sizeofdata; $i++) {
178                 $worksheet->write_string($row_offset, 2, htmlspecialchars_decode($data[$i], ENT_QUOTES), $xls_formats->default);
179                 $row_offset++;
180             }
181         }
182         $row_offset++;
183         return $row_offset;
184     }
186     /**
187      * print the item at the edit-page of feedback
188      *
189      * @global object
190      * @param object $item
191      * @return void
192      */
193     public function print_item_preview($item) {
194         global $OUTPUT, $DB;
195         $align = right_to_left() ? 'right' : 'left';
196         $strrequiredmark = '<img class="req" title="'.get_string('requiredelement', 'form').'" alt="'.
197             get_string('requiredelement', 'form').'" src="'.$OUTPUT->pix_url('req') .'" />';
199         $presentation = explode ("|", $item->presentation);
200         $requiredmark = ($item->required == 1) ? $strrequiredmark : '';
201         //print the question and label
202         $inputname = $item->typ . '_' . $item->id;
203         echo '<div class="feedback_item_label_'.$align.'">';
204         echo '<label for="'. $inputname .'">';
205         if (strval($item->label) !== '') {
206             echo '('. format_string($item->label).') ';
207         }
208         echo format_text($item->name . $requiredmark, FORMAT_HTML, array('noclean' => true, 'para' => false));
209         if ($item->dependitem) {
210             if ($dependitem = $DB->get_record('feedback_item', array('id'=>$item->dependitem))) {
211                 echo ' <span class="feedback_depend">';
212                 echo '('.format_string($dependitem->label).'-&gt;'.$item->dependvalue.')';
213                 echo '</span>';
214             }
215         }
216         echo '</label>';
217         echo '</div>';
219         //print the presentation
220         echo '<div class="feedback_item_presentation_'.$align.'">';
221         echo '<span class="feedback_item_textfield">';
222         echo '<input type="text" '.
223                     'id="'.$inputname.'" '.
224                     'name="'.$inputname.'" '.
225                     'size="'.$presentation[0].'" '.
226                     'maxlength="'.$presentation[1].'" '.
227                     'value="" />';
228         echo '</span>';
229         echo '</div>';
230     }
232     /**
233      * print the item at the complete-page of feedback
234      *
235      * @global object
236      * @param object $item
237      * @param string $value
238      * @param bool $highlightrequire
239      * @return void
240      */
241     public function print_item_complete($item, $value = '', $highlightrequire = false) {
242         global $OUTPUT;
243         $align = right_to_left() ? 'right' : 'left';
244         $strrequiredmark = '<img class="req" title="'.get_string('requiredelement', 'form').'" alt="'.
245             get_string('requiredelement', 'form').'" src="'.$OUTPUT->pix_url('req') .'" />';
247         $presentation = explode ("|", $item->presentation);
248         $requiredmark = ($item->required == 1) ? $strrequiredmark : '';
250         //print the question and label
251         $inputname = $item->typ . '_' . $item->id;
252         echo '<div class="feedback_item_label_'.$align.'">';
253         echo '<label for="'. $inputname .'">';
254         echo format_text($item->name . $requiredmark, FORMAT_HTML, array('noclean' => true, 'para' => false));
255         if ($highlightrequire AND $item->required AND strval($value) == '') {
256             echo '<br class="error"><span id="id_error_'.$inputname.'" class="error"> '.get_string('err_required', 'form').
257                 '</span><br id="id_error_break_'.$inputname.'" class="error" >';
258         }
259         echo '</label>';
260         echo '</div>';
262         //print the presentation
263         echo '<div class="feedback_item_presentation_'.$align.'">';
264         echo '<span class="feedback_item_textfield">';
265         echo '<input type="text" '.
266                     'id="'.$inputname.'" '.
267                     'name="'.$inputname.'" '.
268                     'size="'.$presentation[0].'" '.
269                     'maxlength="'.$presentation[1].'" '.
270                     'value="'.$value.'" />';
271         echo '</span>';
272         echo '</div>';
273     }
275     /**
276      * print the item at the complete-page of feedback
277      *
278      * @global object
279      * @param object $item
280      * @param string $value
281      * @return void
282      */
283     public function print_item_show_value($item, $value = '') {
284         global $OUTPUT;
285         $align = right_to_left() ? 'right' : 'left';
286         $strrequiredmark = '<img class="req" title="'.get_string('requiredelement', 'form').'" alt="'.
287             get_string('requiredelement', 'form').'" src="'.$OUTPUT->pix_url('req') .'" />';
289         $presentation = explode ("|", $item->presentation);
290         $requiredmark = ($item->required == 1) ? $strrequiredmark : '';
292         //print the question and label
293         echo '<div class="feedback_item_label_'.$align.'">';
294         if (strval($item->label) !== '') {
295             echo '('. format_string($item->label).') ';
296         }
297         echo format_text($item->name . $requiredmark, FORMAT_HTML, array('noclean' => true, 'para' => false));
298         echo '</div>';
299         echo $OUTPUT->box_start('generalbox boxalign'.$align);
300         echo $value ? $value : '&nbsp;';
301         echo $OUTPUT->box_end();
302     }
304     public function check_value($value, $item) {
305         //if the item is not required, so the check is true if no value is given
306         if ((!isset($value) OR $value == '') AND $item->required != 1) {
307             return true;
308         }
309         if ($value == "") {
310             return false;
311         }
312         return true;
313     }
315     public function create_value($data) {
316         $data = s($data);
317         return $data;
318     }
320     //compares the dbvalue with the dependvalue
321     //dbvalue is the value put in by the user
322     //dependvalue is the value that is compared
323     public function compare_value($item, $dbvalue, $dependvalue) {
324         if ($dbvalue == $dependvalue) {
325             return true;
326         }
327         return false;
328     }
330     public function get_presentation($data) {
331         return $data->itemsize . '|'. $data->itemmaxlength;
332     }
334     public function get_hasvalue() {
335         return 1;
336     }
338     public function can_switch_require() {
339         return true;
340     }
342     public function value_type() {
343         return PARAM_RAW;
344     }
346     public function clean_input_value($value) {
347         return s($value);
348     }