9bbacea23c2426044a10345af8f4041baae51bf7
[moodle.git] / mod / feedback / item / numeric / 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_numeric extends feedback_item_base {
21     protected $type = "numeric";
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('numeric_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         $range_from_to = explode('|', $item->presentation);
51         if (isset($range_from_to[0]) AND is_numeric($range_from_to[0])) {
52             $range_from = $this->format_float($range_from_to[0]);
53         } else {
54             $range_from = '-';
55         }
57         if (isset($range_from_to[1]) AND is_numeric($range_from_to[1])) {
58             $range_to = $this->format_float($range_from_to[1]);
59         } else {
60             $range_to = '-';
61         }
63         $item->rangefrom = $range_from;
64         $item->rangeto = $range_to;
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_numeric_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 = new stdClass();
127         $analysed->data = array();
128         $analysed->name = $item->name;
129         $values = feedback_get_group_values($item, $groupid, $courseid);
131         $avg = 0.0;
132         $counter = 0;
133         if ($values) {
134             $data = array();
135             foreach ($values as $value) {
136                 if (is_numeric($value->value)) {
137                     $data[] = $value->value;
138                     $avg += $value->value;
139                     $counter++;
140                 }
141             }
142             $avg = $counter > 0 ? $avg / $counter : null;
143             $analysed->data = $data;
144             $analysed->avg = $avg;
145         }
146         return $analysed;
147     }
149     public function get_printval($item, $value) {
150         if (!isset($value->value)) {
151             return '';
152         }
154         return $value->value;
155     }
157     public function print_analysed($item, $itemnr = '', $groupid = false, $courseid = false) {
159         $values = $this->get_analysed($item, $groupid, $courseid);
161         if (isset($values->data) AND is_array($values->data)) {
162             echo '<tr><th colspan="2" align="left">';
163             echo $itemnr . ' ';
164             if (strval($item->label) !== '') {
165                 echo '('. format_string($item->label).') ';
166             }
167             echo format_text($item->name, FORMAT_HTML, array('noclean' => true, 'para' => false));
168             echo '</th></tr>';
170             foreach ($values->data as $value) {
171                 echo '<tr><td colspan="2" valign="top" align="left">';
172                 echo '-&nbsp;&nbsp;'.$this->format_float($value);
173                 echo '</td></tr>';
174             }
176             if (isset($values->avg)) {
177                 $avg = format_float($values->avg, 2);
178             } else {
179                 $avg = '-';
180             }
181             echo '<tr><td align="left" colspan="2"><b>';
182             echo get_string('average', 'feedback').': '.$avg;
183             echo '</b></td></tr>';
184         }
185     }
187     public function excelprint_item(&$worksheet, $row_offset,
188                              $xls_formats, $item,
189                              $groupid, $courseid = false) {
191         $analysed_item = $this->get_analysed($item, $groupid, $courseid);
193         $worksheet->write_string($row_offset, 0, $item->label, $xls_formats->head2);
194         $worksheet->write_string($row_offset, 1, $item->name, $xls_formats->head2);
195         $data = $analysed_item->data;
196         if (is_array($data)) {
198             // Export average.
199             $worksheet->write_string($row_offset,
200                                      2,
201                                      get_string('average', 'feedback'),
202                                      $xls_formats->value_bold);
204             if (isset($analysed_item->avg)) {
205                 $worksheet->write_number($row_offset + 1,
206                                          2,
207                                          $analysed_item->avg,
208                                          $xls_formats->value_bold);
209             } else {
210                 $worksheet->write_string($row_offset + 1,
211                                          2,
212                                          '',
213                                          $xls_formats->value_bold);
214             }
215             $row_offset++;
216         }
217         $row_offset++;
218         return $row_offset;
219     }
221     /**
222      * print the item at the edit-page of feedback
223      *
224      * @global object
225      * @param object $item
226      * @return void
227      */
228     public function print_item_preview($item) {
229         global $OUTPUT, $DB;
231         $align = right_to_left() ? 'right' : 'left';
232         $strrequiredmark = '<img class="req" title="'.get_string('requiredelement', 'form').'" alt="'.
233             get_string('requiredelement', 'form').'" src="'.$OUTPUT->pix_url('req') .'" />';
235         //get the range
236         $range_from_to = explode('|', $item->presentation);
238         //get the min-value
239         if (isset($range_from_to[0]) AND is_numeric($range_from_to[0])) {
240             $range_from = floatval($range_from_to[0]);
241         } else {
242             $range_from = '-';
243         }
245         //get the max-value
246         if (isset($range_from_to[1]) AND is_numeric($range_from_to[1])) {
247             $range_to = floatval($range_from_to[1]);
248         } else {
249             $range_to = '-';
250         }
252         $requiredmark = ($item->required == 1) ? $strrequiredmark : '';
253         //print the question and label
254         $inputname = $item->typ . '_' . $item->id;
255         echo '<div class="feedback_item_label_'.$align.'">';
256         echo '<label for="'. $inputname .'">';
257         if (strval($item->label) !== '') {
258             echo '('. format_string($item->label).') ';
259         }
260         echo format_text($item->name . $requiredmark, FORMAT_HTML, array('noclean' => true, 'para' => false));
261         if ($item->dependitem) {
262             $params = array('id'=>$item->dependitem);
263             if ($dependitem = $DB->get_record('feedback_item', $params)) {
264                 echo ' <span class="feedback_depend">';
265                 echo '('.format_string($dependitem->label).'-&gt;'.$item->dependvalue.')';
266                 echo '</span>';
267             }
268         }
269         echo '<span class="feedback_item_numinfo">';
270         switch(true) {
271             case ($range_from === '-' AND is_numeric($range_to)):
272                 echo ' ('.get_string('maximal', 'feedback').
273                         ': '.$this->format_float($range_to).')';
274                 break;
275             case (is_numeric($range_from) AND $range_to === '-'):
276                 echo ' ('.get_string('minimal', 'feedback').
277                         ': '.$this->format_float($range_from).')';
278                 break;
279             case ($range_from === '-' AND $range_to === '-'):
280                 break;
281             default:
282                 echo ' ('.$this->format_float($range_from).
283                         ' - '.$this->format_float($range_to).')';
284                 break;
285         }
286         echo '</span>';
287         echo '</label>';
288         echo '</div>';
290         //print the presentation
291         echo '<div class="feedback_item_presentation_'.$align.'">';
292         echo '<span class="feedback_item_textfield">';
293         echo '<input type="text" '.
294                     'id="'.$inputname.'" '.
295                     'name="'.$inputname.'" '.
296                     'size="10" '.
297                     'maxlength="10" '.
298                     'value="" />';
300         echo '</span>';
301         echo '</div>';
302     }
304     /**
305      * Prints the float nicely in the localized format
306      *
307      * Similar to format_float() but automatically calculates the number of decimal places
308      *
309      * @param float $value The float to print
310      * @return string
311      */
312     protected function format_float($value) {
313         if (!is_numeric($value)) {
314             return null;
315         }
316         $decimal = is_int($value) ? 0 : strlen(substr(strrchr($value, '.'), 1));
317         return format_float($value, $decimal);
318     }
320     /**
321      * print the item at the complete-page of feedback
322      *
323      * @global object
324      * @param object $item
325      * @param string $value
326      * @param bool $highlightrequire
327      * @return void
328      */
329     public function print_item_complete($item, $value = '', $highlightrequire = false) {
330         global $OUTPUT;
331         $align = right_to_left() ? 'right' : 'left';
332         $strrequiredmark = '<img class="req" title="'.get_string('requiredelement', 'form').'" alt="'.
333             get_string('requiredelement', 'form').'" src="'.$OUTPUT->pix_url('req') .'" />';
335         //get the range
336         $range_from_to = explode('|', $item->presentation);
338         //get the min-value
339         if (isset($range_from_to[0]) AND is_numeric($range_from_to[0])) {
340             $range_from = floatval($range_from_to[0]);
341         } else {
342             $range_from = '-';
343         }
345         //get the max-value
346         if (isset($range_from_to[1]) AND is_numeric($range_from_to[1])) {
347             $range_to = floatval($range_from_to[1]);
348         } else {
349             $range_to = '-';
350         }
352         $requiredmark = ($item->required == 1) ? $strrequiredmark : '';
354         //print the question and label
355         $inputname = $item->typ . '_' . $item->id;
356         echo '<div class="feedback_item_label_'.$align.'">';
357         echo '<label for="'. $inputname .'">';
358         echo format_text($item->name . $requiredmark, FORMAT_HTML, array('noclean' => true, 'para' => false));
359         echo '<span class="feedback_item_numinfo">';
360         switch(true) {
361             case ($range_from === '-' AND is_numeric($range_to)):
362                 echo ' ('.get_string('maximal', 'feedback').
363                         ': '.$this->format_float($range_to).')';
364                 break;
365             case (is_numeric($range_from) AND $range_to === '-'):
366                 echo ' ('.get_string('minimal', 'feedback').
367                         ': '.$this->format_float($range_from).')';
368                 break;
369             case ($range_from === '-' AND $range_to === '-'):
370                 break;
371             default:
372                 echo ' ('.$this->format_float($range_from).
373                         ' - '.$this->format_float($range_to).')';
374                 break;
375         }
376         echo '</span>';
377         if ($highlightrequire AND (!$this->check_value($value, $item))) {
378             echo '<br class="error"><span id="id_error_'.$inputname.'" class="error"> '.get_string('err_required', 'form').
379                 '</span><br id="id_error_break_'.$inputname.'" class="error" >';
380         }
381         echo '</label>';
382         echo '</div>';
384         //print the presentation
385         echo '<div class="feedback_item_presentation_'.$align.'">';
386         echo '<span class="feedback_item_textfield">';
387         echo '<input type="text" '.
388                      'id="'.$inputname.'" '.
389                      'name="'.$item->typ.'_'.$item->id.'" '.
390                      'size="10" '.
391                      'maxlength="10" '.
392                      'value="'.$value.'" />';
394         echo '</span>';
395         echo '</div>';
396     }
398     /**
399      * print the item at the complete-page of feedback
400      *
401      * @global object
402      * @param object $item
403      * @param string $value
404      * @return void
405      */
406     public function print_item_show_value($item, $value = '') {
407         global $OUTPUT;
408         $align = right_to_left() ? 'right' : 'left';
409         $strrequiredmark = '<img class="req" title="'.get_string('requiredelement', 'form').'" alt="'.
410             get_string('requiredelement', 'form').'" src="'.$OUTPUT->pix_url('req') .'" />';
412         //get the range
413         $range_from_to = explode('|', $item->presentation);
414         //get the min-value
415         if (isset($range_from_to[0]) AND is_numeric($range_from_to[0])) {
416             $range_from = floatval($range_from_to[0]);
417         } else {
418             $range_from = '-';
419         }
420         //get the max-value
421         if (isset($range_from_to[1]) AND is_numeric($range_from_to[1])) {
422             $range_to = floatval($range_from_to[1]);
423         } else {
424             $range_to = '-';
425         }
426         $requiredmark = ($item->required == 1) ? $strrequiredmark : '';
428         //print the question and label
429         echo '<div class="feedback_item_label_'.$align.'">';
430         if (strval($item->label) !== '') {
431             echo '('. format_string($item->label).') ';
432         }
433         echo format_text($item->name . $requiredmark, FORMAT_HTML, array('noclean' => true, 'para' => false));
434         switch(true) {
435             case ($range_from === '-' AND is_numeric($range_to)):
436                 echo ' ('.get_string('maximal', 'feedback').
437                     ': '.$this->format_float($range_to).')';
438                 break;
439             case (is_numeric($range_from) AND $range_to === '-'):
440                 echo ' ('.get_string('minimal', 'feedback').
441                     ': '.$this->format_float($range_from).')';
442                 break;
443             case ($range_from === '-' AND $range_to === '-'):
444                 break;
445             default:
446                 echo ' ('.$this->format_float($range_from).
447                     ' - '.$this->format_float($range_to).')';
448                 break;
449         }
450         echo '</div>';
452         //print the presentation
453         echo '<div class="feedback_item_presentation_'.$align.'">';
454         echo $OUTPUT->box_start('generalbox boxalign'.$align);
455         if (is_numeric($value)) {
456             $str_num_value = $this->format_float($value);
457         } else {
458             $str_num_value = '&nbsp;';
459         }
460         echo $str_num_value;
461         echo $OUTPUT->box_end();
462         echo '</div>';
463     }
465     public function check_value($value, $item) {
466         $value = unformat_float($value, true);
467         //if the item is not required, so the check is true if no value is given
468         if ((!isset($value) OR $value == '') AND $item->required != 1) {
469             return true;
470         }
471         if (!is_numeric($value)) {
472             return false;
473         }
475         $range_from_to = explode('|', $item->presentation);
476         if (isset($range_from_to[0]) AND is_numeric($range_from_to[0])) {
477             $range_from = floatval($range_from_to[0]);
478         } else {
479             $range_from = '-';
480         }
481         if (isset($range_from_to[1]) AND is_numeric($range_from_to[1])) {
482             $range_to = floatval($range_from_to[1]);
483         } else {
484             $range_to = '-';
485         }
487         switch(true) {
488             case ($range_from === '-' AND is_numeric($range_to)):
489                 if (floatval($value) <= $range_to) {
490                     return true;
491                 }
492                 break;
493             case (is_numeric($range_from) AND $range_to === '-'):
494                 if (floatval($value) >= $range_from) {
495                     return true;
496                 }
497                 break;
498             case ($range_from === '-' AND $range_to === '-'):
499                 return true;
500                 break;
501             default:
502                 if (floatval($value) >= $range_from AND floatval($value) <= $range_to) {
503                     return true;
504                 }
505                 break;
506         }
508         return false;
509     }
511     public function create_value($data) {
512         $data = unformat_float($data, true);
514         if (is_numeric($data)) {
515             $data = floatval($data);
516         } else {
517             $data = '';
518         }
519         return $data;
520     }
522     //compares the dbvalue with the dependvalue
523     //dbvalue is the number put in by the user
524     //dependvalue is the value that is compared
525     public function compare_value($item, $dbvalue, $dependvalue) {
526         if ($dbvalue == $dependvalue) {
527             return true;
528         }
529         return false;
530     }
532     public function get_presentation($data) {
533         $num1 = unformat_float($data->numericrangefrom, true);
534         if (is_numeric($num1)) {
535             $num1 = floatval($num1);
536         } else {
537             $num1 = '-';
538         }
540         $num2 = unformat_float($data->numericrangeto, true);
541         if (is_numeric($num2)) {
542             $num2 = floatval($num2);
543         } else {
544             $num2 = '-';
545         }
547         if ($num1 === '-' OR $num2 === '-') {
548             return $num1 . '|'. $num2;
549         }
551         if ($num1 > $num2) {
552             return $num2 . '|'. $num1;
553         } else {
554             return $num1 . '|'. $num2;
555         }
556     }
558     public function get_hasvalue() {
559         return 1;
560     }
562     public function can_switch_require() {
563         return true;
564     }
566     public function value_type() {
567         return PARAM_TEXT;
568     }
570     public function clean_input_value($value) {
571         $value = unformat_float($value, true);
572         if (!is_numeric($value)) {
573             if ($value == '') {
574                 return null; //an empty string should be null
575             } else {
576                 return clean_param($value, PARAM_TEXT); //we have to know the value if it is wrong
577             }
578         }
579         return clean_param($value, PARAM_FLOAT);
580     }