Merge branch 'MDL-27675_master' of git://github.com/grabs/moodle
[moodle.git] / mod / feedback / item / textarea / 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_textarea extends feedback_item_base {
21     protected $type = "textarea";
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('textarea_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         $width_and_height = explode('|', $item->presentation);
52         if (isset($width_and_height[0]) AND $width_and_height[0] >= 5) {
53             $itemwidth = $width_and_height[0];
54         } else {
55             $itemwidth = 30;
56         }
58         if (isset($width_and_height[1])) {
59             $itemheight = $width_and_height[1];
60         } else {
61             $itemheight = 5;
62         }
63         $item->itemwidth = $itemwidth;
64         $item->itemheight = $itemheight;
66         //all items for dependitem
67         $feedbackitems = feedback_get_depend_candidates_for_item($feedback, $item);
68         $commonparams = array('cmid'=>$cm->id,
69                              'id'=>isset($item->id) ? $item->id : null,
70                              'typ'=>$item->typ,
71                              'items'=>$feedbackitems,
72                              'feedback'=>$feedback->id);
74         //build the form
75         $customdata = array('item' => $item,
76                             'common' => $commonparams,
77                             'positionlist' => $positionlist,
78                             'position' => $position);
80         $this->item_form = new feedback_textarea_form('edit_item.php', $customdata);
81     }
83     //this function only can used after the call of build_editform()
84     public function show_editform() {
85         $this->item_form->display();
86     }
88     public function is_cancelled() {
89         return $this->item_form->is_cancelled();
90     }
92     public function get_data() {
93         if ($this->item = $this->item_form->get_data()) {
94             return true;
95         }
96         return false;
97     }
99     public function save_item() {
100         global $DB;
102         if (!$item = $this->item_form->get_data()) {
103             return false;
104         }
106         if (isset($item->clone_item) AND $item->clone_item) {
107             $item->id = ''; //to clone this item
108             $item->position++;
109         }
111         $item->hasvalue = $this->get_hasvalue();
112         if (!$item->id) {
113             $item->id = $DB->insert_record('feedback_item', $item);
114         } else {
115             $DB->update_record('feedback_item', $item);
116         }
118         return $DB->get_record('feedback_item', array('id'=>$item->id));
119     }
122     //liefert eine Struktur ->name, ->data = array(mit Antworten)
123     public function get_analysed($item, $groupid = false, $courseid = false) {
124         global $DB;
126         $analysed_val = new stdClass();
127         $analysed_val->data = array();
128         $analysed_val->name = $item->name;
130         $values = feedback_get_group_values($item, $groupid, $courseid);
131         if ($values) {
132             $data = array();
133             foreach ($values as $value) {
134                 $data[] = str_replace("\n", '<br />', $value->value);
135             }
136             $analysed_val->data = $data;
137         }
138         return $analysed_val;
139     }
141     public function get_printval($item, $value) {
143         if (!isset($value->value)) {
144             return '';
145         }
147         return $value->value;
148     }
150     public function print_analysed($item, $itemnr = '', $groupid = false, $courseid = false) {
151         $values = feedback_get_group_values($item, $groupid, $courseid);
152         if ($values) {
153             echo '<tr><th colspan="2" align="left">';
154             echo $itemnr.'&nbsp;('.$item->label.') '.$item->name;
155             echo '</th></tr>';
156             foreach ($values as $value) {
157                 echo '<tr>';
158                 echo '<td valign="top" align="left">';
159                 echo '-&nbsp;&nbsp;';
160                 echo '</td>';
161                 echo '<td align="left" valign="top">';
162                 echo str_replace("\n", '<br />', $value->value);
163                 echo '</td>';
164                 echo '</tr>';
165             }
166         }
167     }
169     public function excelprint_item(&$worksheet, $row_offset,
170                              $xls_formats, $item,
171                              $groupid, $courseid = false) {
173         $analysed_item = $this->get_analysed($item, $groupid, $courseid);
175         $worksheet->write_string($row_offset, 0, $item->label, $xls_formats->head2);
176         $worksheet->write_string($row_offset, 1, $item->name, $xls_formats->head2);
177         $data = $analysed_item->data;
178         if (is_array($data)) {
179             if (isset($data[0])) {
180                 $worksheet->write_string($row_offset, 2, $data[0], $xls_formats->value_bold);
181             }
182             $row_offset++;
183             $sizeofdata = count($data);
184             for ($i = 1; $i < $sizeofdata; $i++) {
185                 $worksheet->write_string($row_offset, 2, $data[$i], $xls_formats->default);
186                 $row_offset++;
187             }
188         }
189         $row_offset++;
190         return $row_offset;
191     }
193     /**     
194      * print the item at the edit-page of feedback
195      *
196      * @global object
197      * @param object $item
198      * @return void
199      */
200     public function print_item_preview($item) {
201         global $OUTPUT, $DB;
203         $align = right_to_left() ? 'right' : 'left';
204         $str_required_mark = '<span class="feedback_required_mark">*</span>';
206         $presentation = explode ("|", $item->presentation);
207         $requiredmark =  ($item->required == 1) ? $str_required_mark : '';
208         //print the question and label
209         echo '<div class="feedback_item_label_'.$align.'">';
210         echo '('.$item->label.') ';
211         echo format_text($item->name.$requiredmark, true, false, false);
212         if ($item->dependitem) {
213             if ($dependitem = $DB->get_record('feedback_item', array('id'=>$item->dependitem))) {
214                 echo ' <span class="feedback_depend">';
215                 echo '('.$dependitem->label.'-&gt;'.$item->dependvalue.')';
216                 echo '</span>';
217             }
218         }
219         echo '</div>';
221         //print the presentation
222         echo '<div class="feedback_item_presentation_'.$align.'">';
223         echo '<span class="feedback_item_textarea">';
224         echo '<textarea name="'.$item->typ.'_'.$item->id.'" '.
225                        'cols="'.$presentation[0].'" '.
226                        'rows="'.$presentation[1].'">';
227         echo '</textarea>';
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         $str_required_mark = '<span class="feedback_required_mark">*</span>';
246         $presentation = explode ("|", $item->presentation);
247         if ($highlightrequire AND $item->required AND strval($value) == '') {
248             $highlight = ' missingrequire';
249         } else {
250             $highlight = '';
251         }
252         $requiredmark = ($item->required == 1) ? $str_required_mark :'';
254         //print the question and label
255         echo '<div class="feedback_item_label_'.$align.$highlight.'">';
256             echo format_text($item->name . $requiredmark, true, false, false);
257         echo '</div>';
259         //print the presentation
260         echo '<div class="feedback_item_presentation_'.$align.$highlight.'">';
261         echo '<span class="feedback_item_textarea">';
262         echo '<textarea name="'.$item->typ.'_'.$item->id.'" '.
263                        'cols="'.$presentation[0].'" '.
264                        'rows="'.$presentation[1].'">';
265         echo $value;
266         echo '</textarea>';
267         echo '</span>';
268         echo '</div>';
269     }
271     /**     
272      * print the item at the complete-page of feedback
273      *
274      * @global object
275      * @param object $item
276      * @param string $value
277      * @return void
278      */
279     public function print_item_show_value($item, $value = '') {
280         global $OUTPUT;
281         $align = right_to_left() ? 'right' : 'left';
282         $str_required_mark = '<span class="feedback_required_mark">*</span>';
284         $presentation = explode ("|", $item->presentation);
285         $requiredmark = ($item->required == 1) ? $str_required_mark : '';
287         //print the question and label
288         echo '<div class="feedback_item_label_'.$align.'">';
289             echo '('.$item->label.') ';
290             echo format_text($item->name . $requiredmark, true, false, false);
291         echo '</div>';
293         //print the presentation
294         echo $OUTPUT->box_start('generalbox boxalign'.$align);
295         echo $value ? str_replace("\n", '<br />', $value) : '&nbsp;';
296         echo $OUTPUT->box_end();
297     }
299     public function check_value($value, $item) {
300         //if the item is not required, so the check is true if no value is given
301         if ((!isset($value) OR $value == '') AND $item->required != 1) {
302             return true;
303         }
304         if ($value == "") {
305             return false;
306         }
307         return true;
308     }
310     public function create_value($data) {
311         $data = s($data);
312         return $data;
313     }
315     //compares the dbvalue with the dependvalue
316     //dbvalue is the value put in by the user
317     //dependvalue is the value that is compared
318     public function compare_value($item, $dbvalue, $dependvalue) {
319         if ($dbvalue == $dependvalue) {
320             return true;
321         }
322         return false;
323     }
325     public function get_presentation($data) {
326         return $data->itemwidth.'|'.$data->itemheight;
327     }
329     public function get_hasvalue() {
330         return 1;
331     }
333     public function can_switch_require() {
334         return true;
335     }
337     public function value_type() {
338         return PARAM_RAW;
339     }
341     public function clean_input_value($value) {
342         return s($value);
343     }