77a2b040b5c15c36a7e512abae8b49e8fd8b84a8
[moodle.git] / mod / feedback / item / multichoicerated / lib.php
1 <?php
2 defined('MOODLE_INTERNAL') OR die('not allowed');
3 require_once($CFG->dirroot.'/mod/feedback/item/feedback_item_class.php');
5 define('FEEDBACK_RADIORATED_ADJUST_SEP', '<<<<<');
7 define('FEEDBACK_MULTICHOICERATED_MAXCOUNT', 10); //count of possible items
8 define('FEEDBACK_MULTICHOICERATED_VALUE_SEP', '####');
9 define('FEEDBACK_MULTICHOICERATED_VALUE_SEP2', '/');
10 define('FEEDBACK_MULTICHOICERATED_TYPE_SEP', '>>>>>');
11 define('FEEDBACK_MULTICHOICERATED_LINE_SEP', '|');
12 define('FEEDBACK_MULTICHOICERATED_ADJUST_SEP', '<<<<<');
13 define('FEEDBACK_MULTICHOICERATED_IGNOREEMPTY', 'i');
14 define('FEEDBACK_MULTICHOICERATED_HIDENOSELECT', 'h');
16 class feedback_item_multichoicerated extends feedback_item_base {
17     var $type = "multichoicerated";
18     var $commonparams;
19     var $item_form;
20     var $item;
22     function init() {
24     }
26     function build_editform($item, $feedback, $cm) {
27         global $DB, $CFG;
28         require_once('multichoicerated_form.php');
30         //get the lastposition number of the feedback_items
31         $position = $item->position;
32         $lastposition = $DB->count_records('feedback_item', array('feedback'=>$feedback->id));
33         if($position == -1){
34             $i_formselect_last = $lastposition + 1;
35             $i_formselect_value = $lastposition + 1;
36             $item->position = $lastposition + 1;
37         }else {
38             $i_formselect_last = $lastposition;
39             $i_formselect_value = $item->position;
40         }
41         //the elements for position dropdownlist
42         $positionlist = array_slice(range(0,$i_formselect_last),1,$i_formselect_last,true);
44         $item->presentation = empty($item->presentation) ? '' : $item->presentation;
45         $info = $this->get_info($item);
47         $item->ignoreempty = $this->ignoreempty($item);
48         $item->hidenoselect = $this->hidenoselect($item);
50         //all items for dependitem
51         $feedbackitems = feedback_get_depend_candidates_for_item($feedback, $item);
52         $commonparams = array('cmid'=>$cm->id,
53                              'id'=>isset($item->id) ? $item->id : NULL,
54                              'typ'=>$item->typ,
55                              'items'=>$feedbackitems,
56                              'feedback'=>$feedback->id);
58         //build the form
59         $this->item_form = new feedback_multichoicerated_form('edit_item.php', array('item'=>$item, 'common'=>$commonparams, 'positionlist'=>$positionlist, 'position'=>$position, 'info'=>$info));
60     }
62     //this function only can used after the call of build_editform()
63     function show_editform() {
64         $this->item_form->display();
65     }
67     function is_cancelled() {
68         return $this->item_form->is_cancelled();
69     }
71     function get_data() {
72         if($this->item = $this->item_form->get_data()) {
73             return true;
74         }
75         return false;
76     }
78     function save_item() {
79         global $DB;
81         if(!$item = $this->item_form->get_data()) {
82             return false;
83         }
85         if(isset($item->clone_item) AND $item->clone_item) {
86             $item->id = ''; //to clone this item
87             $item->position++;
88         }
90         $this->set_ignoreempty($item, $item->ignoreempty);
91         $this->set_hidenoselect($item, $item->hidenoselect);
93         $item->hasvalue = $this->get_hasvalue();
94         if(!$item->id) {
95             $item->id = $DB->insert_record('feedback_item', $item);
96         }else {
97             $DB->update_record('feedback_item', $item);
98         }
100         return $DB->get_record('feedback_item', array('id'=>$item->id));
101     }
104     //liefert ein eindimensionales Array mit drei Werten(typ, name, XXX)
105     //XXX ist ein eindimensionales Array (Mittelwert der Werte der Antworten bei Typ Radio_rated) Jedes Element ist eine Struktur (answertext, avg)
106     function get_analysed($item, $groupid = false, $courseid = false) {
107         $analysedItem = array();
108         $analysedItem[] = $item->typ;
109         $analysedItem[] = $item->name;
111         //die moeglichen Antworten extrahieren
112         $info = $this->get_info($item);
113         $lines = null;
114         $lines = explode (FEEDBACK_MULTICHOICERATED_LINE_SEP, $info->presentation);
115         if(!is_array($lines)) return null;
117         //die Werte holen
118         $values = feedback_get_group_values($item, $groupid, $courseid, $this->ignoreempty($item));
119         if(!$values) return null;
120         //schleife ueber den Werten und ueber die Antwortmoeglichkeiten
122         $analysedAnswer = array();
123         $sizeoflines = sizeof($lines);
124         for($i = 1; $i <= $sizeoflines; $i++) {
125             $item_values = explode(FEEDBACK_MULTICHOICERATED_VALUE_SEP, $lines[$i-1]);
126             $ans = null;
127             $ans->answertext = $item_values[1];
128             $avg = 0.0;
129             $anscount = 0;
130             foreach($values as $value) {
131                 //ist die Antwort gleich dem index der Antworten + 1?
132                 if ($value->value == $i) {
133                     $avg += $item_values[0]; //erst alle Werte aufsummieren
134                     $anscount++;
135                 }
136             }
137             $ans->answercount = $anscount;
138             $ans->avg = doubleval($avg) / doubleval(sizeof($values));
139             $ans->value = $item_values[0];
140             $ans->quotient = $ans->answercount / sizeof($values);
141             $analysedAnswer[] = $ans;
142         }
143         $analysedItem[] = $analysedAnswer;
144         return $analysedItem;
145     }
147     function get_printval($item, $value) {
148         $printval = '';
150         if(!isset($value->value)) return $printval;
152         $info = $this->get_info($item);
154         $presentation = explode (FEEDBACK_MULTICHOICERATED_LINE_SEP, $info->presentation);
155         $index = 1;
156         foreach($presentation as $pres){
157             if($value->value == $index){
158                 $item_label = explode(FEEDBACK_MULTICHOICERATED_VALUE_SEP, $pres);
159                 $printval = $item_label[1];
160                 break;
161             }
162             $index++;
163         }
164         return $printval;
165     }
167     function print_analysed($item, $itemnr = '', $groupid = false, $courseid = false) {
168         $sep_dec = get_string('separator_decimal', 'feedback');
169         if(substr($sep_dec, 0, 2) == '[['){
170             $sep_dec = FEEDBACK_DECIMAL;
171         }
173         $sep_thous = get_string('separator_thousand', 'feedback');
174         if(substr($sep_thous, 0, 2) == '[['){
175             $sep_thous = FEEDBACK_THOUSAND;
176         }
178         $analysedItem = $this->get_analysed($item, $groupid, $courseid);
179         if($analysedItem) {
180             //echo '<table>';
181             // $itemnr++;
182             echo '<tr><th colspan="2" align="left">'. $itemnr . '&nbsp;('. $item->label .') ' . $analysedItem[1] .'</th></tr>';
183             $analysedVals = $analysedItem[2];
184             $pixnr = 0;
185             $avg = 0.0;
186             foreach($analysedVals as $val) {
187                 if( function_exists("bcmod")) {
188                     $intvalue = bcmod($pixnr, 10);
189                 }else {
190                     $intvalue = 0;
191                 }
192                 $pix = "pics/$intvalue.gif";
193                 $pixnr++;
194                 $pixwidth = intval($val->quotient * FEEDBACK_MAX_PIX_LENGTH);
196                 $avg += $val->avg;
197                 $quotient = number_format(($val->quotient * 100), 2, $sep_dec, $sep_thous);
198                 echo '<tr><td align="left" valign="top">-&nbsp;&nbsp;' . trim($val->answertext) . ' ('.$val->value.'):</td><td align="left" style="width: '.FEEDBACK_MAX_PIX_LENGTH.'"><img alt="'.$intvalue.'" src="'.$pix.'" height="5" width="'.$pixwidth.'" />' . $val->answercount. (($val->quotient > 0)?'&nbsp;('. $quotient . '&nbsp;%)':'') . '</td></tr>';
199             }
200             $avg = number_format(($avg), 2, $sep_dec, $sep_thous);
201             echo '<tr><td align="left" colspan="2"><b>'.get_string('average', 'feedback').': '.$avg.'</b></td></tr>';
202             //echo '</table>';
203         }
204         // return $itemnr;
205     }
207     function excelprint_item(&$worksheet, $rowOffset, $xlsFormats, $item, $groupid, $courseid = false) {
208         $analysed_item = $this->get_analysed($item, $groupid, $courseid);
210         $data = $analysed_item[2];
212         // $worksheet->setFormat("<l><f><ro2><vo><c:green>");
213         //frage schreiben
214         $worksheet->write_string($rowOffset, 0, $item->label, $xlsFormats->head2);
215         $worksheet->write_string($rowOffset, 1, $analysed_item[1], $xlsFormats->head2);
216         if(is_array($data)) {
217             $avg = 0.0;
218             $sizeofdata = sizeof($data);
219             for($i = 0; $i < $sizeofdata; $i++) {
220                 $aData = $data[$i];
222                 // $worksheet->setFormat("<l><f><ro2><vo><c:blue>");
223                 $worksheet->write_string($rowOffset, $i + 2, trim($aData->answertext).' ('.$aData->value.')', $xlsFormats->value_bold);
225                 // $worksheet->setFormat("<l><vo>");
226                 $worksheet->write_number($rowOffset + 1, $i + 2, $aData->answercount, $xlsFormats->default);
227                 //$worksheet->setFormat("<l><f><vo>");
228                 //$worksheet->write_number($rowOffset + 2, $i + 1, $aData->avg);
229                 $avg += $aData->avg;
230             }
231             //mittelwert anzeigen
232             // $worksheet->setFormat("<l><f><ro2><vo><c:red>");
233             $worksheet->write_string($rowOffset, sizeof($data) + 2, get_string('average', 'feedback'), $xlsFormats->value_bold);
235             // $worksheet->setFormat("<l><f><vo>");
236             $worksheet->write_number($rowOffset + 1, sizeof($data) + 2, $avg, $xlsFormats->value_bold);
237         }
238         $rowOffset +=2 ;
239         return $rowOffset;
240     }
242     /**
243      * print the item at the edit-page of feedback
244      *
245      * @global object
246      * @param object $item
247      * @return void
248      */
249     function print_item_preview($item) {
250         global $OUTPUT, $DB;
252         $align = right_to_left() ? 'right' : 'left';
253         $info = $this->get_info($item);
255         $lines = explode (FEEDBACK_MULTICHOICERATED_LINE_SEP, $info->presentation);
256         $requiredmark =  ($item->required == 1)?'<span class="feedback_required_mark">*</span>':'';
257         //print the question and label
258         echo '<div class="feedback_item_label_'.$align.'">';
259         echo '('.$item->label.') ';
260         echo format_text($item->name.$requiredmark, true, false, false);
261         if($item->dependitem) {
262             if($dependitem = $DB->get_record('feedback_item', array('id'=>$item->dependitem))) {
263                 echo ' <span class="feedback_depend">('.$dependitem->label.'-&gt;'.$item->dependvalue.')</span>';
264             }
265         }
266         echo '</div>';
268         //print the presentation
269         echo '<div class="feedback_item_presentation_'.$align.'">';
270         switch($info->subtype) {
271             case 'r':
272                 $this->print_item_radio($item, false, $info, $align, true, $lines);
273                 break;
274             case 'd':
275                 $this->print_item_dropdown($item, false, $info, $align, true, $lines);
276                 break;
277         }
278         echo '</div>';
279     }
281     /**
282      * print the item at the complete-page of feedback
283      *
284      * @global object
285      * @param object $item
286      * @param string $value
287      * @param bool $highlightrequire
288      * @return void
289      */
290     function print_item_complete($item, $value = '', $highlightrequire = false) {
291         global $OUTPUT;
292         $align = right_to_left() ? 'right' : 'left';
293         $info = $this->get_info($item);
295         $lines = explode (FEEDBACK_MULTICHOICERATED_LINE_SEP, $info->presentation);
296         $requiredmark =  ($item->required == 1)?'<span class="feedback_required_mark">*</span>':'';
297         if($highlightrequire AND $item->required AND intval($value) <= 0) {
298             $highlight = ' missingrequire';
299         }else {
300             $highlight = '';
301         }
303         //print the question and label
304         echo '<div class="feedback_item_label_'.$align.$highlight.'">';
305             echo format_text($item->name.$requiredmark, true, false, false);
306         echo '</div>';
308         //print the presentation
309         echo '<div class="feedback_item_presentation_'.$align.$highlight.'">';
310         switch($info->subtype) {
311             case 'r':
312                 $this->print_item_radio($item, $value, $info, $align, false, $lines);
313                 break;
314             case 'd':
315                 $this->print_item_dropdown($item, $value, $info, $align, false, $lines);
316                 break;
317         }
318         echo '</div>';
319     }
321     /**
322      * print the item at the complete-page of feedback
323      *
324      * @global object
325      * @param object $item
326      * @param string $value
327      * @return void
328      */
329     function print_item_show_value($item, $value = '') {
330         global $OUTPUT;
331         $align = right_to_left() ? 'right' : 'left';
332         $info = $this->get_info($item);
334         $lines = explode (FEEDBACK_MULTICHOICERATED_LINE_SEP, $info->presentation);
335         $requiredmark =  ($item->required == 1)?'<span class="feedback_required_mark">*</span>':'';
337         //print the question and label
338         echo '<div class="feedback_item_label_'.$align.'">';
339             echo '('.$item->label.') ';
340             echo format_text($item->name . $requiredmark, true, false, false);
341         echo '</div>';
343         //print the presentation
344         echo '<div class="feedback_item_presentation_'.$align.'">';
345         $index = 1;
346         foreach($lines as $line){
347             if($value == $index){
348                 $item_value = explode(FEEDBACK_MULTICHOICERATED_VALUE_SEP, $line);
349                 echo $OUTPUT->box_start('generalbox boxalign'.$align);
350                 echo text_to_html($item_value[1], true, false, false);
351                 echo $OUTPUT->box_end();
352                 break;
353             }
354             $index++;
355         }
356         echo '</div>';
357     }
359     function check_value($value, $item) {
360         if((!isset($value) OR $value == '' OR $value == 0) AND $item->required != 1) return true;
361         if(intval($value) > 0)return true;
362         return false;
363     }
365     function create_value($data) {
366         $data = trim($data);
367         return $data;
368     }
370     //compares the dbvalue with the dependvalue
371     //dbvalue is the number of one selection
372     //dependvalue is the presentation of one selection
373     function compare_value($item, $dbvalue, $dependvalue) {
375         if (is_array($dbvalue)) {
376             $dbvalues = $dbvalue;
377         }else {
378             $dbvalues = explode(FEEDBACK_MULTICHOICERATED_LINE_SEP, $dbvalue);
379         }
381         $info = $this->get_info($item);
382         $presentation = explode (FEEDBACK_MULTICHOICERATED_LINE_SEP, $info->presentation);
383         $index = 1;
384         foreach($presentation as $pres) {
385             $presvalues = explode(FEEDBACK_MULTICHOICERATED_VALUE_SEP, $pres);
387             foreach($dbvalues as $dbval) {
388                 if($dbval == $index AND trim($presvalues[1]) == $dependvalue) {
389                     return true;
390                 }
391             }
392             $index++;
393         }
394         return false;
395     }
396     function get_presentation($data) {
397         // $present = str_replace("\n", FEEDBACK_MULTICHOICERATED_LINE_SEP, trim($data->itemvalues));
398         $present = $this->prepare_presentation_values_save(trim($data->itemvalues), FEEDBACK_MULTICHOICERATED_VALUE_SEP2, FEEDBACK_MULTICHOICERATED_VALUE_SEP);
399         // $present = str_replace("\n", FEEDBACK_MULTICHOICERATED_LINE_SEP, trim($data->itemvalues));
400         if(!isset($data->subtype)) {
401             $subtype = 'r';
402         }else {
403             $subtype = substr($data->subtype, 0, 1);
404         }
405         if(isset($data->horizontal) AND $data->horizontal == 1 AND $subtype != 'd') {
406             $present .= FEEDBACK_MULTICHOICERATED_ADJUST_SEP.'1';
407         }
408         return $subtype.FEEDBACK_MULTICHOICERATED_TYPE_SEP.$present;
409     }
411     function get_hasvalue() {
412         return 1;
413     }
415     function get_info($item) {
416         $presentation = empty($item->presentation) ? '' : $item->presentation;
418         $info = new stdClass();
419         //check the subtype of the multichoice
420         //it can be check(c), radio(r) or dropdown(d)
421         $info->subtype = '';
422         $info->presentation = '';
423         $info->horizontal = false;
425         @list($info->subtype, $info->presentation) = explode(FEEDBACK_MULTICHOICERATED_TYPE_SEP, $item->presentation);
427         if(!isset($info->subtype)) {
428             $info->subtype = 'r';
429         }
432         if($info->subtype != 'd') {
433             @list($info->presentation, $info->horizontal) = explode(FEEDBACK_MULTICHOICERATED_ADJUST_SEP, $info->presentation);
435             if(isset($info->horizontal) AND $info->horizontal == 1) {
436                 $info->horizontal = true;
437             }else {
438                 $info->horizontal = false;
439             }
440         }
442         $info->values = $this->prepare_presentation_values_print($info->presentation, FEEDBACK_MULTICHOICERATED_VALUE_SEP, FEEDBACK_MULTICHOICERATED_VALUE_SEP2);
443         return $info;
444     }
446     function print_item_radio($item, $value, $info, $align, $showrating, $lines) {
447         $index = 1;
448         $checked = '';
450         if($info->horizontal) {
451             $hv = 'h';
452         }else {
453             $hv = 'v';
454         }
455         echo '<ul>';
456         if(!$this->hidenoselect($item)) {
457             ?>
458                 <li class="feedback_item_radio_<?php echo $hv.'_'.$align;?>">
459                     <span class="feedback_item_radio_<?php echo $hv.'_'.$align;?>">
460                         <input type="radio" name="<?php echo $item->typ . '_' . $item->id ;?>" id="<?php echo $item->typ . '_' . $item->id.'_xxx';?>" value="" checked="checked" />
461                     </span>
462                     <span class="feedback_item_radiolabel_<?php echo $hv.'_'.$align;?>">
463                         <label for="<?php echo $item->typ . '_' . $item->id.'_xxx';?>"><?php print_string('not_selected', 'feedback');?>&nbsp;</label>
464                     </span>
465                 </li>
466             <?php
467         }
468         foreach($lines as $line){
469             if($value == $index){
470                 $checked = 'checked="checked"';
471             }else{
472                 $checked = '';
473             }
474             $radio_value = explode(FEEDBACK_MULTICHOICERATED_VALUE_SEP, $line);
475             $inputname = $item->typ . '_' . $item->id;
476             $inputid = $inputname.'_'.$index;
477         ?>
478             <li class="feedback_item_radio_<?php echo $hv.'_'.$align;?>">
479                 <span class="feedback_item_radio_<?php echo $hv.'_'.$align;?>">
480                     <input type="radio" name="<?php echo $inputname;?>" id="<?php echo $inputid;?>" value="<?php echo $index;?>" <?php echo $checked;?> />
481                 </span>
482                 <span class="feedback_item_radiolabel_<?php echo $hv.'_'.$align;?>">
483                     <label for="<?php echo $inputid;?>">
484                         <?php
485                             if($showrating) {
486                                 echo text_to_html('('.$radio_value[0].') '.$radio_value[1], true, false, false);
487                             }else {
488                                 echo text_to_html($radio_value[1], true, false, false);
489                             }
490                         ?>
491                     </label>
492                 </span>
493             </li>
494         <?php
495             $index++;
496         }
497         echo '</ul>';
498     }
500     function print_item_dropdown($item, $value, $info, $align, $showrating, $lines) {
501         if($info->horizontal) {
502             $hv = 'h';
503         }else {
504             $hv = 'v';
505         }
506         echo '<ul>';
507         ?>
508         <li class="feedback_item_select_<?php echo $hv.'_'.$align;?>">
509             <select name="<?php echo $item->typ.'_'.$item->id;?>">
510                 <option value="0">&nbsp;</option>
511                 <?php
512                 $index = 1;
513                 $checked = '';
514                 foreach($lines as $line){
515                     if($value == $index){
516                         $selected = 'selected="selected"';
517                     }else{
518                         $selected = '';
519                     }
520                     $dropdown_value = explode(FEEDBACK_MULTICHOICERATED_VALUE_SEP, $line);
521                     if($showrating) {
522                         echo '<option value="'.$index.'" '.$selected.'>'.clean_text('('.$dropdown_value[0].') '.$dropdown_value[1]).'</option>';
523                     }else {
524                         echo '<option value="'.$index.'" '.$selected.'>'.clean_text($dropdown_value[1]).'</option>';
525                     }
526                     $index++;
527                 }
528                 ?>
529             </select>
530         </li>
531         <?php
532         echo '</ul>';
533     }
535     function prepare_presentation_values($linesep1, $linesep2, $valuestring, $valuesep1, $valuesep2) {
536         $lines = explode($linesep1, $valuestring);
537         $newlines = array();
538         foreach($lines as $line) {
539             $value = '';
540             $text = '';
541             if(strpos($line, $valuesep1) === false) {
542                 $value = 0;
543                 $text = $line;
544             }else {
545                 @list($value, $text) = explode($valuesep1, $line, 2);
546             }
548             $value = intval($value);
549             $newlines[] = $value.$valuesep2.$text;
550         }
551         $newlines = implode($linesep2, $newlines);
552         return $newlines;
553     }
555     function prepare_presentation_values_print($valuestring, $valuesep1, $valuesep2) {
556         return $this->prepare_presentation_values(FEEDBACK_MULTICHOICERATED_LINE_SEP, "\n", $valuestring, $valuesep1, $valuesep2);
557     }
559     function prepare_presentation_values_save($valuestring, $valuesep1, $valuesep2) {
560         return $this->prepare_presentation_values("\n", FEEDBACK_MULTICHOICERATED_LINE_SEP, $valuestring, $valuesep1, $valuesep2);
561     }
563     function set_ignoreempty($item, $ignoreempty=true) {
564         $item->options = str_replace(FEEDBACK_MULTICHOICERATED_IGNOREEMPTY, '', $item->options);
565         if($ignoreempty) {
566             $item->options .= FEEDBACK_MULTICHOICERATED_IGNOREEMPTY;
567         }
568     }
570     function ignoreempty($item) {
571         if(strstr($item->options, FEEDBACK_MULTICHOICERATED_IGNOREEMPTY)) {
572             return true;
573         }
574         return false;
575     }
577     function set_hidenoselect($item, $hidenoselect=true) {
578         $item->options = str_replace(FEEDBACK_MULTICHOICERATED_HIDENOSELECT, '', $item->options);
579         if($hidenoselect) {
580             $item->options .= FEEDBACK_MULTICHOICERATED_HIDENOSELECT;
581         }
582     }
584     function hidenoselect($item) {
585         if(strstr($item->options, FEEDBACK_MULTICHOICERATED_HIDENOSELECT)) {
586             return true;
587         }
588         return false;
589     }
591     function can_switch_require() {
592         return true;
593     }