MDL-53638 mod_feedback: change items classes
[moodle.git] / mod / feedback / item / info / 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_info extends feedback_item_base {
21     protected $type = "info";
23     /** Mode recording response time (for non-anonymous feedbacks only) */
24     const MODE_RESPONSETIME = 1;
25     /** Mode recording current course */
26     const MODE_COURSE = 2;
27     /** Mode recording current course category */
28     const MODE_CATEGORY = 3;
30     public function build_editform($item, $feedback, $cm) {
31         global $DB, $CFG;
32         require_once('info_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) ? 1 : $item->presentation;
49         $item->required = 0;
51         //all items for dependitem
52         $feedbackitems = feedback_get_depend_candidates_for_item($feedback, $item);
53         $commonparams = array('cmid'=>$cm->id,
54                              'id'=>isset($item->id) ? $item->id : null,
55                              'typ'=>$item->typ,
56                              'items'=>$feedbackitems,
57                              'feedback'=>$feedback->id);
59         //build the form
60         $this->item_form = new feedback_info_form('edit_item.php',
61                                                   array('item'=>$item,
62                                                   'common'=>$commonparams,
63                                                   'positionlist'=>$positionlist,
64                                                   'position' => $position));
65     }
67     public function save_item() {
68         global $DB;
70         if (!$item = $this->item_form->get_data()) {
71             return false;
72         }
74         if (isset($item->clone_item) AND $item->clone_item) {
75             $item->id = ''; //to clone this item
76             $item->position++;
77         }
79         $item->hasvalue = $this->get_hasvalue();
80         if (!$item->id) {
81             $item->id = $DB->insert_record('feedback_item', $item);
82         } else {
83             $DB->update_record('feedback_item', $item);
84         }
86         return $DB->get_record('feedback_item', array('id'=>$item->id));
87     }
89     /**
90      * Helper function for collected data, both for analysis page and export to excel
91      *
92      * @param stdClass $item the db-object from feedback_item
93      * @param int|false $groupid
94      * @param int $courseid
95      * @return stdClass
96      */
97     protected function get_analysed($item, $groupid = false, $courseid = false) {
99         $presentation = $item->presentation;
100         $analysed_val = new stdClass();
101         $analysed_val->data = null;
102         $analysed_val->name = $item->name;
103         $values = feedback_get_group_values($item, $groupid, $courseid);
104         if ($values) {
105             $data = array();
106             foreach ($values as $value) {
107                 $datavalue = new stdClass();
109                 switch($presentation) {
110                     case self::MODE_RESPONSETIME:
111                         $datavalue->value = $value->value;
112                         $datavalue->show = userdate($datavalue->value);
113                         break;
114                     case self::MODE_COURSE:
115                         $datavalue->value = $value->value;
116                         $datavalue->show = $datavalue->value;
117                         break;
118                     case self::MODE_CATEGORY:
119                         $datavalue->value = $value->value;
120                         $datavalue->show = $datavalue->value;
121                         break;
122                 }
124                 $data[] = $datavalue;
125             }
126             $analysed_val->data = $data;
127         }
128         return $analysed_val;
129     }
131     public function get_printval($item, $value) {
133         if (!isset($value->value)) {
134             return '';
135         }
136         return $item->presentation == self::MODE_RESPONSETIME ?
137                 userdate($value->value) : $value->value;
138     }
140     public function print_analysed($item, $itemnr = '', $groupid = false, $courseid = false) {
141         $analysed_item = $this->get_analysed($item, $groupid, $courseid);
142         $data = $analysed_item->data;
143         if (is_array($data)) {
144             echo '<tr><th colspan="2" align="left">';
145             echo $itemnr . ' ';
146             if (strval($item->label) !== '') {
147                 echo '('. format_string($item->label).') ';
148             }
149             echo format_text($item->name, FORMAT_HTML, array('noclean' => true, 'para' => false));
150             echo '</th></tr>';
151             $sizeofdata = count($data);
152             for ($i = 0; $i < $sizeofdata; $i++) {
153                 echo '<tr><td colspan="2" valign="top" align="left">-&nbsp;&nbsp;';
154                 echo str_replace("\n", '<br />', $data[$i]->show);
155                 echo '</td></tr>';
156             }
157         }
158     }
160     public function excelprint_item(&$worksheet, $row_offset,
161                              $xls_formats, $item,
162                              $groupid, $courseid = false) {
163         $analysed_item = $this->get_analysed($item, $groupid, $courseid);
165         $worksheet->write_string($row_offset, 0, $item->label, $xls_formats->head2);
166         $worksheet->write_string($row_offset, 1, $item->name, $xls_formats->head2);
167         $data = $analysed_item->data;
168         if (is_array($data)) {
169             $worksheet->write_string($row_offset, 2, $data[0]->show, $xls_formats->value_bold);
170             $row_offset++;
171             $sizeofdata = count($data);
172             for ($i = 1; $i < $sizeofdata; $i++) {
173                 $worksheet->write_string($row_offset, 2, $data[$i]->show, $xls_formats->default);
174                 $row_offset++;
175             }
176         }
177         $row_offset++;
178         return $row_offset;
179     }
181     /**
182      * Calculates the value of the item (time, course, course category)
183      *
184      * @param stdClass $item
185      * @param stdClass $feedback
186      * @param int $courseid
187      * @return string
188      */
189     protected function get_current_value($item, $feedback, $courseid) {
190         global $DB;
191         switch ($item->presentation) {
192             case self::MODE_RESPONSETIME:
193                 if ($feedback->anonymous != FEEDBACK_ANONYMOUS_YES) {
194                     // Response time is not allowed in anonymous feedbacks.
195                     return time();
196                 }
197                 break;
198             case self::MODE_COURSE:
199                 $course = get_course($courseid);
200                 return format_string($course->shortname, true,
201                         array('context' => context_course::instance($course->id)));
202                 break;
203             case self::MODE_CATEGORY:
204                 if ($courseid !== SITEID) {
205                     $coursecategory = $DB->get_record_sql('SELECT cc.id, cc.name FROM {course_categories} cc, {course} c '
206                             . 'WHERE c.category = cc.id AND c.id = ?', array($courseid));
207                     return format_string($coursecategory->name, true,
208                             array('context' => context_coursecat::instance($coursecategory->id)));
209                 }
210                 break;
211         }
212         return '';
213     }
215     /**
216      * Adds an input element to the complete form
217      *
218      * @param stdClass $item
219      * @param mod_feedback_complete_form $form
220      */
221     public function complete_form_element($item, $form) {
222         if ($form->get_mode() == mod_feedback_complete_form::MODE_VIEW_RESPONSE) {
223             $value = strval($form->get_item_value($item));
224         } else {
225             $value = $this->get_current_value($item,
226                     $form->get_feedback(), $form->get_current_course_id());
227         }
228         $printval = $this->get_printval($item, (object)['value' => $value]);
230         $class = '';
231         switch ($item->presentation) {
232             case self::MODE_RESPONSETIME:
233                 $class = 'info-responsetime';
234                 break;
235             case self::MODE_COURSE:
236                 $class = 'info-course';
237                 break;
238             case self::MODE_CATEGORY:
239                 $class = 'info-category';
240                 break;
241         }
243         $name = $this->get_display_name($item);
244         $inputname = $item->typ . '_' . $item->id;
246         $element = $form->add_form_element($item,
247                 ['select', $inputname, $name,
248                     array($value => $printval),
249                     array('class' => $class)],
250                 false,
251                 false);
252         $form->set_element_default($inputname, $value);
253         $element->freeze();
254         if ($form->get_mode() == mod_feedback_complete_form::MODE_COMPLETE) {
255             $element->setPersistantFreeze(true);
256         }
257     }
259     public function can_switch_require() {
260         return false;
261     }