MDL-12296:
[moodle.git] / mod / survey / lib.php
CommitLineData
d1290cec 1<?php // $Id$
f9903ed0 2
3// Graph size
551b0b98 4$SURVEY_GHEIGHT = 500;
5$SURVEY_GWIDTH = 900;
f9903ed0 6
551b0b98 7$SURVEY_QTYPE = array (
f9903ed0 8 "-3" => "Virtual Actual and Preferred",
9 "-2" => "Virtual Preferred",
10 "-1" => "Virtual Actual",
11 "0" => "Text",
12 "1" => "Actual",
13 "2" => "Preferred",
14 "3" => "Actual and Preferred",
15 );
16
b6b3deb4 17
18define("SURVEY_COLLES_ACTUAL", "1");
19define("SURVEY_COLLES_PREFERRED", "2");
20define("SURVEY_COLLES_PREFERRED_ACTUAL", "3");
21define("SURVEY_ATTLS", "4");
22define("SURVEY_CIQ", "5");
23
24
66ea15f3 25// STANDARD FUNCTIONS ////////////////////////////////////////////////////////
04eba58f 26
27function survey_add_instance($survey) {
28// Given an object containing all the necessary data,
29// (defined by the form in mod.html) this function
30// will create a new instance and return the id number
31// of the new instance.
32
33 if (!$template = get_record("survey", "id", $survey->template)) {
34 return 0;
35 }
36
37 $survey->questions = $template->questions;
38 $survey->timecreated = time();
39 $survey->timemodified = $survey->timecreated;
40
41 return insert_record("survey", $survey);
42
43}
44
45
46function survey_update_instance($survey) {
47// Given an object containing all the necessary data,
48// (defined by the form in mod.html) this function
49// will update an existing instance with new data.
50
51 if (!$template = get_record("survey", "id", $survey->template)) {
52 return 0;
53 }
54
55 $survey->id = $survey->instance;
56 $survey->questions = $template->questions;
57 $survey->timemodified = time();
58
59 return update_record("survey", $survey);
60}
61
62function survey_delete_instance($id) {
63// Given an ID of an instance of this module,
64// this function will permanently delete the instance
65// and any data that depends on it.
66
67 if (! $survey = get_record("survey", "id", "$id")) {
68 return false;
69 }
70
71 $result = true;
72
73 if (! delete_records("survey_analysis", "survey", "$survey->id")) {
74 $result = false;
75 }
76
77 if (! delete_records("survey_answers", "survey", "$survey->id")) {
78 $result = false;
79 }
80
81 if (! delete_records("survey", "id", "$survey->id")) {
82 $result = false;
83 }
84
85 return $result;
86}
87
66ea15f3 88function survey_user_outline($course, $user, $mod, $survey) {
ebc3bd2b 89 if ($answers = get_records_select("survey_answers", "survey='$survey->id' AND userid='$user->id'")) {
66ea15f3 90
91 $lastanswer = array_pop($answers);
92
93 $result->info = get_string("done", "survey");
94 $result->time = $lastanswer->time;
95 return $result;
96 }
97 return NULL;
98}
99
100
101function survey_user_complete($course, $user, $mod, $survey) {
102 global $CFG;
103
104 if (survey_already_done($survey->id, $user->id)) {
b6b3deb4 105 if ($survey->template == SURVEY_CIQ) { // print out answers for critical incidents
106 $table = NULL;
107 $table->align = array("left", "left");
108
109 $questions = get_records_list("survey_questions", "id", $survey->questions);
110 $questionorder = explode(",", $survey->questions);
111
112 foreach ($questionorder as $key=>$val) {
113 $question = $questions[$val];
114 $questiontext = get_string($question->shorttext, "survey");
115
116 if ($answer = survey_get_user_answer($survey->id, $question->id, $user->id)) {
117 $answertext = "$answer->answer1";
118 } else {
119 $answertext = "No answer";
120 }
121 $table->data[] = array("<b>$questiontext</b>", $answertext);
122 }
123 print_table($table);
124
125 } else {
126
839f2456 127 survey_print_graph("id=$mod->id&amp;sid=$user->id&amp;type=student.png");
b6b3deb4 128 }
129
66ea15f3 130 } else {
131 print_string("notdone", "survey");
132 }
133}
134
1b5910c4 135function survey_print_recent_activity($course, $isteacher, $timestart) {
3d891989 136 global $CFG;
54634efc 137
138 $content = false;
139 $surveys = NULL;
140
8f7dc7f1 141 if (!$logs = get_records_select('log', 'time > \''.$timestart.'\' AND '.
142 'course = \''.$course->id.'\' AND '.
143 'module = \'survey\' AND '.
144 'action = \'submit\' ', 'time ASC')) {
1b5910c4 145 return false;
146 }
147
148 foreach ($logs as $log) {
149 //Create a temp valid module structure (course,id)
150 $tempmod->course = $log->course;
151 $tempmod->id = $log->info;
152 //Obtain the visible property from the instance
153 $modvisible = instance_is_visible($log->module,$tempmod);
154
155 //Only if the mod is visible
156 if ($modvisible) {
157 $surveys[$log->id] = survey_log_info($log);
158 $surveys[$log->id]->time = $log->time;
cfa56cff 159 $surveys[$log->id]->url = str_replace('&', '&amp;', $log->url);
54634efc 160 }
161 }
162
163 if ($surveys) {
164 $content = true;
8f7dc7f1 165 print_headline(get_string('newsurveyresponses', 'survey').':');
54634efc 166 foreach ($surveys as $survey) {
583b57b4 167 print_recent_activity_note($survey->time, $survey, $survey->name,
8f7dc7f1 168 $CFG->wwwroot.'/mod/survey/'.$survey->url);
54634efc 169 }
170 }
171
172 return $content;
173}
04eba58f 174
05855091 175function survey_get_participants($surveyid) {
176//Returns the users with data in one survey
177//(users with records in survey_analysis and survey_answers, students)
178
179 global $CFG;
180
181 //Get students from survey_analysis
95e72c12 182 $st_analysis = get_records_sql("SELECT DISTINCT u.id, u.id
05855091 183 FROM {$CFG->prefix}user u,
184 {$CFG->prefix}survey_analysis a
185 WHERE a.survey = '$surveyid' and
186 u.id = a.userid");
187 //Get students from survey_answers
95e72c12 188 $st_answers = get_records_sql("SELECT DISTINCT u.id, u.id
05855091 189 FROM {$CFG->prefix}user u,
190 {$CFG->prefix}survey_answers a
191 WHERE a.survey = '$surveyid' and
192 u.id = a.userid");
193
194 //Add st_answers to st_analysis
195 if ($st_answers) {
196 foreach ($st_answers as $st_answer) {
197 $st_analysis[$st_answer->id] = $st_answer;
198 }
199 }
200 //Return st_analysis array (it contains an array of unique users)
201 return ($st_analysis);
202}
66ea15f3 203
e323955d 204// SQL FUNCTIONS ////////////////////////////////////////////////////////
66ea15f3 205
f9903ed0 206
e323955d 207function survey_log_info($log) {
208 global $CFG;
7c8c335f 209 return get_record_sql("SELECT s.name, u.firstname, u.lastname, u.picture
e323955d 210 FROM {$CFG->prefix}survey s,
211 {$CFG->prefix}user u
212 WHERE s.id = '$log->info'
ebc3bd2b 213 AND u.id = '$log->userid'");
e323955d 214}
f9903ed0 215
07aa2057 216function survey_get_responses($surveyid, $groupid, $groupingid) {
e323955d 217 global $CFG;
a9ccbf60 218
219 if ($groupid) {
07aa2057 220 $groupsjoin = "INNER JOIN {$CFG->prefix}groups_members gm ON u.id = gm.userid AND gm.groupid = '$groupid' ";
1d684195 221
07aa2057 222 } else if ($groupingid) {
223 $groupsjoin = "INNER JOIN {$CFG->prefix}groups_members gm ON u.id = gm.userid
224 INNER JOIN {$CFG->prefix}groupings_groups gg ON gm.groupid = gg.groupid AND gg.groupingid = $groupingid ";
a9ccbf60 225 } else {
07aa2057 226 $groupsjoin = "";
a9ccbf60 227 }
228
87f47bec 229 return get_records_sql("SELECT u.id, u.firstname, u.lastname, u.picture, MAX(a.time) as time
07aa2057 230 FROM {$CFG->prefix}survey_answers a
231 INNER JOIN {$CFG->prefix}user u ON a.userid = u.id
232 $groupsjoin
87f47bec 233 WHERE a.survey = $surveyid
87f47bec 234 GROUP BY u.id, u.firstname, u.lastname, u.picture
235 ORDER BY time ASC");
e323955d 236}
237
238function survey_get_analysis($survey, $user) {
ebc3bd2b 239 global $CFG;
e323955d 240
241 return get_record_sql("SELECT notes
242 FROM {$CFG->prefix}survey_analysis
243 WHERE survey='$survey'
ebc3bd2b 244 AND userid='$user'");
e323955d 245}
246
247function survey_update_analysis($survey, $user, $notes) {
ebc3bd2b 248 global $CFG;
e323955d 249
ebc3bd2b 250 return execute_sql("UPDATE {$CFG->prefix}survey_analysis
e323955d 251 SET notes='$notes'
252 WHERE survey='$survey'
ebc3bd2b 253 AND userid='$user'");
e323955d 254}
255
256
a9ccbf60 257function survey_get_user_answers($surveyid, $questionid, $groupid, $sort="sa.answer1,sa.answer2 ASC") {
e323955d 258 global $CFG;
259
a9ccbf60 260 if ($groupid) {
261 $groupsql = "AND gm.groupid = $groupid AND u.id = gm.userid";
262 } else {
263 $groupsql = "";
264 }
265
e323955d 266 return get_records_sql("SELECT sa.*,u.firstname,u.lastname,u.picture
ebc3bd2b 267 FROM {$CFG->prefix}survey_answers sa,
a9ccbf60 268 {$CFG->prefix}user u,
269 {$CFG->prefix}groups_members gm
e323955d 270 WHERE sa.survey = '$surveyid'
271 AND sa.question = $questionid
a9ccbf60 272 AND u.id = sa.userid $groupsql
7c8c335f 273 ORDER BY $sort");
274}
275
276function survey_get_user_answer($surveyid, $questionid, $userid) {
277 global $CFG;
278
279 return get_record_sql("SELECT sa.*
280 FROM {$CFG->prefix}survey_answers sa
281 WHERE sa.survey = '$surveyid'
282 AND sa.question = '$questionid'
283 AND sa.userid = '$userid'");
e323955d 284}
285
286// MODULE FUNCTIONS ////////////////////////////////////////////////////////
287
ebc3bd2b 288function survey_add_analysis($survey, $user, $notes) {
289 global $CFG;
290
291 $record->survey = $survey;
292 $record->userid = $user;
293 $record->notes = $notes;
294
295 return insert_record("survey_analysis", $record, false);
296}
297
e323955d 298function survey_already_done($survey, $user) {
ebc3bd2b 299 return record_exists("survey_answers", "survey", $survey, "userid", $user);
551b0b98 300}
f9903ed0 301
07aa2057 302function survey_count_responses($surveyid, $groupid, $groupingid) {
303 if ($responses = survey_get_responses($surveyid, $groupid, $groupingid)) {
551b0b98 304 return count($responses);
305 } else {
306 return 0;
307 }
f9903ed0 308}
309
b416a1c3 310
7c8c335f 311function survey_print_all_responses($cmid, $results, $courseid) {
b416a1c3 312
a30f997e 313 $table->head = array ("", get_string("name"), get_string("time"));
314 $table->align = array ("", "left", "left");
315 $table->size = array (35, "", "" );
b416a1c3 316
317 foreach ($results as $a) {
7c8c335f 318 $table->data[] = array(print_user_picture($a->id, $courseid, $a->picture, false, true, false),
839f2456 319 "<a href=\"report.php?action=student&amp;student=$a->id&amp;id=$cmid\">".fullname($a)."</a>",
a30f997e 320 userdate($a->time));
b416a1c3 321 }
7c8c335f 322
323 print_table($table);
b416a1c3 324}
325
b416a1c3 326
551b0b98 327function survey_get_template_name($templateid) {
f9903ed0 328 global $db;
329
330 if ($templateid) {
e323955d 331 if ($ss = get_record("surveys", "id", $templateid)) {
332 return $ss->name;
f9903ed0 333 }
334 } else {
335 return "";
336 }
337}
338
0d22e7cc 339
f9903ed0 340
0e30c987 341function survey_shorten_name ($name, $numwords) {
342 $words = explode(" ", $name);
343 for ($i=0; $i < $numwords; $i++) {
344 $output .= $words[$i]." ";
345 }
346 return $output;
347}
f9903ed0 348
349
0e30c987 350
351function survey_print_multi($question) {
3a2e0fe9 352 GLOBAL $USER, $db, $qnum, $checklist;
0e30c987 353
98899fc0 354 $stripreferthat = get_string("ipreferthat", "survey");
355 $strifoundthat = get_string("ifoundthat", "survey");
caf261b0 356 echo "<br />\n";
795b56b3 357 echo "<span class='questiontext'><b>$question->text</b></span><br />";
358 echo "<div style=\"text-align:center\">";
359 echo "<table width=\"90%\" cellpadding=\"4\" cellspacing=\"1\" border=\"0\">";
0e30c987 360
361 $options = explode( ",", $question->options);
362 $numoptions = count($options);
363
364 $oneanswer = ($question->type == 1 || $question->type == 2) ? true : false;
8a12a132 365 if ($question->type == 2) {
366 $P = "P";
367 } else {
368 $P = "";
369 }
0e30c987 370
371 if ($oneanswer) {
caf261b0 372 echo "<tr><td colspan=\"2\">$question->intro</td>";
0e30c987 373 } else {
caf261b0 374 echo "<tr><td colspan=\"3\">$question->intro</td>";
0e30c987 375 }
376
377 while (list ($key, $val) = each ($options)) {
795b56b3 378 echo "<td class=\"smalltextcell\"><span class='smalltext'>$val</span></td>\n";
0e30c987 379 }
f1c1d2f1 380 echo "<td align=\"center\">&nbsp;</td></tr>\n";
0e30c987 381
e323955d 382 $subquestions = get_records_list("survey_questions", "id", $question->multi);
3a2e0fe9 383
0e30c987 384 foreach ($subquestions as $q) {
385 $qnum++;
f1c1d2f1 386 $rowclass = survey_question_rowclass($qnum);
f762c448 387 if ($q->text) {
388 $q->text = get_string($q->text, "survey");
389 }
390
f1c1d2f1 391 echo "<tr class=\"$rowclass\">";
0e30c987 392 if ($oneanswer) {
3a2e0fe9 393
795b56b3 394 echo "<td class=\"qnumtopcell\"><b>$qnum</b></td>";
caf261b0 395 echo "<td valign=\"top\">$q->text</td>";
3a2e0fe9 396 for ($i=1;$i<=$numoptions;$i++) {
4bcd49be 397 $screenreader = !empty($USER->screenreader)?"<label for=\"q$P" . $q->id . "_$i\">".$options[$i-1]."</label><br/>":'';
398 echo "<td class=\"screenreadertext\">".$screenreader."<input type=\"radio\" name=\"q$P$q->id\" id=\"q$P" . $q->id . "_$i\" value=\"$i\" alt=\"$i\" /></td>";
0e30c987 399 }
038bf621 400 echo "<td class=\"whitecell\"><input type=\"radio\" name=\"q$P$q->id\" value=\"0\" checked=\"checked\" alt=\"0\" /></td>";
0e30c987 401 $checklist["q$P$q->id"] = $numoptions;
402
3a2e0fe9 403 } else {
f40aee6f 404 // yu : fix for MDL-7501, possibly need to use user flag as this is quite ugly.
795b56b3 405 echo "<td class=\"qnummiddlecell\"><b>$qnum</b></td>";
5d1a5ef4 406 $qnum++;
795b56b3 407 echo "<td class=\"preferthat\"><span class='smalltext'>$stripreferthat&nbsp;</span></td>";
408 echo "<td class=\"optioncell\">$q->text</td>";
0e30c987 409 for ($i=1;$i<=$numoptions;$i++) {
4bcd49be 410 $screenreader = !empty($USER->screenreader)?"<label for=\"qP" . $q->id . "_$i\">".$options[$i-1]."</label><br/>":'';
411 echo "<td class=\"screenreadertext\">".$screenreader."<input type=\"radio\" name=\"qP$q->id\" id=\"qP" . $q->id . "_$i\" value=\"$i\" alt=\"$i\"/></td>";
0e30c987 412 }
f1c1d2f1 413 echo "<td><input type=\"radio\" name=\"qP$q->id\" value=\"0\" checked=\"checked\" alt=\"0\" /></td>";
d1290cec 414 echo "</tr>";
0e30c987 415
f1c1d2f1 416 echo "<tr class=\"$rowclass\">";
795b56b3 417 echo "<td class=\"qnumtopcell\"><b>$qnum</b></td>";
418 echo "<td class=\"foundthat\"><span class='smalltext'>$strifoundthat&nbsp;</span></td>";
419 echo "<td class=\"optioncell\">$q->text</td>";
0e30c987 420 for ($i=1;$i<=$numoptions;$i++) {
4bcd49be 421 $screenreader = !empty($USER->screenreader)?"<label for=\"q" . $q->id . "_$i\">".$options[$i-1]."</label><br/>":'';
422 echo "<td class=\"screenreadertext\">".$screenreader."<input type=\"radio\" name=\"q$q->id\" id=\"q" . $q->id . "_$i\" value=\"$i\" alt=\"$i\" /></td>";
0e30c987 423 }
795b56b3 424 echo "<td class=\"buttoncell\"><input type=\"radio\" name=\"q$q->id\" value=\"0\" checked=\"checked\" alt=\"0\" /></td>";
0e30c987 425 $checklist["qP$q->id"] = $numoptions;
5d1a5ef4 426 $checklist["q$q->id"] = $numoptions;
0e30c987 427 }
d1290cec 428 echo "</tr>\n";
3a2e0fe9 429
0e30c987 430 }
d1290cec 431 echo "</table>";
795b56b3 432 echo "</div>";
0e30c987 433}
434
435
436
437function survey_print_single($question) {
438 GLOBAL $db, $qnum;
439
f1c1d2f1 440 $rowclass = survey_question_rowclass(0);
0e30c987 441
442 $qnum++;
443
caf261b0 444 echo "<br />\n";
795b56b3 445 echo "<table width=\"90%\" cellpadding=\"4\" cellspacing=\"0\">\n";
f1c1d2f1 446 echo "<tr class=\"$rowclass\">";
d1290cec 447 echo "<td valign=\"top\"><b>$qnum</b></td>";
795b56b3 448 echo "<td class=\"questioncell\">$question->text</td>\n";
449 echo "<td class=\"questioncell\"><span class='smalltext'>\n";
0e30c987 450
451
452 if ($question->type == 0) { // Plain text field
8f414ab8 453 echo "<textarea rows=\"3\" cols=\"30\" name=\"q$question->id\">$question->options</textarea>";
0e30c987 454
455 } else if ($question->type > 0) { // Choose one of a number
98899fc0 456 $strchoose = get_string("choose");
8f414ab8 457 echo "<select name=\"q$question->id\">";
e0b7b090 458 echo "<option value=\"0\" selected=\"selected\">$strchoose...</option>";
0e30c987 459 $options = explode( ",", $question->options);
460 foreach ($options as $key => $val) {
461 $key++;
d1290cec 462 echo "<option value=\"$key\">$val</option>";
0e30c987 463 }
d1290cec 464 echo "</select>";
0e30c987 465
466 } else if ($question->type < 0) { // Choose several of a number
467 $options = explode( ",", $question->options);
f762c448 468 notify("This question type not supported yet");
0e30c987 469 }
470
795b56b3 471 echo "</span></td></tr></table>";
0e30c987 472
473}
474
f1c1d2f1 475function survey_question_rowclass($qnum) {
0e30c987 476
477 if ($qnum) {
f1c1d2f1 478 return $qnum % 2 ? 'r0' : 'r1';
0e30c987 479 } else {
f1c1d2f1 480 return 'r0';
0e30c987 481 }
482}
483
607809b3 484function survey_print_graph($url) {
485 global $CFG, $SURVEY_GHEIGHT, $SURVEY_GWIDTH;
486
487 if (empty($CFG->gdversion)) {
488 echo "(".get_string("gdneed").")";
489
490 } else {
795b56b3 491 echo "<img class='resultgraph' height=\"$SURVEY_GHEIGHT\" width=\"$SURVEY_GWIDTH\"".
7150b8ae 492 " src=\"$CFG->wwwroot/mod/survey/graph.php?$url\" alt=\"".get_string("surveygraph", "survey")."\" />";
607809b3 493 }
494}
495
f3221af9 496function survey_get_view_actions() {
497 return array('download','view all','view form','view graph','view report');
498}
499
500function survey_get_post_actions() {
501 return array('submit');
502}
503
f9903ed0 504?>