survey MDL-23324 survey form generation was assuming that subquestions would always...
[moodle.git] / mod / survey / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package   mod-survey
20  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
21  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
24 /**
25  * Graph size
26  * @global int $SURVEY_GHEIGHT
27  */
28 global $SURVEY_GHEIGHT;
29 $SURVEY_GHEIGHT = 500;
30 /**
31  * Graph size
32  * @global int $SURVEY_GWIDTH
33  */
34 global $SURVEY_GWIDTH;
35 $SURVEY_GWIDTH  = 900;
36 /**
37  * Question Type
38  * @global array $SURVEY_QTYPE
39  */
40 global $SURVEY_QTYPE;
41 $SURVEY_QTYPE = array (
42         "-3" => "Virtual Actual and Preferred",
43         "-2" => "Virtual Preferred",
44         "-1" => "Virtual Actual",
45          "0" => "Text",
46          "1" => "Actual",
47          "2" => "Preferred",
48          "3" => "Actual and Preferred",
49         );
52 define("SURVEY_COLLES_ACTUAL",           "1");
53 define("SURVEY_COLLES_PREFERRED",        "2");
54 define("SURVEY_COLLES_PREFERRED_ACTUAL", "3");
55 define("SURVEY_ATTLS",                   "4");
56 define("SURVEY_CIQ",                     "5");
59 // STANDARD FUNCTIONS ////////////////////////////////////////////////////////
60 /**
61  * Given an object containing all the necessary data,
62  * (defined by the form in mod_form.php) this function
63  * will create a new instance and return the id number
64  * of the new instance.
65  *
66  * @global object
67  * @param object $survey
68  * @return int|bool
69  */
70 function survey_add_instance($survey) {
71     global $DB;
73     if (!$template = $DB->get_record("survey", array("id"=>$survey->template))) {
74         return 0;
75     }
77     $survey->questions    = $template->questions;
78     $survey->timecreated  = time();
79     $survey->timemodified = $survey->timecreated;
81     return $DB->insert_record("survey", $survey);
83 }
85 /**
86  * Given an object containing all the necessary data,
87  * (defined by the form in mod_form.php) this function
88  * will update an existing instance with new data.
89  *
90  * @global object
91  * @param object $survey
92  * @return bool
93  */
94 function survey_update_instance($survey) {
95     global $DB;
97     if (!$template = $DB->get_record("survey", array("id"=>$survey->template))) {
98         return 0;
99     }
101     $survey->id           = $survey->instance;
102     $survey->questions    = $template->questions;
103     $survey->timemodified = time();
105     return $DB->update_record("survey", $survey);
108 /**
109  * Given an ID of an instance of this module,
110  * this function will permanently delete the instance
111  * and any data that depends on it.
112  *
113  * @global object
114  * @param int $id
115  * @return bool
116  */
117 function survey_delete_instance($id) {
118     global $DB;
120     if (! $survey = $DB->get_record("survey", array("id"=>$id))) {
121         return false;
122     }
124     $result = true;
126     if (! $DB->delete_records("survey_analysis", array("survey"=>$survey->id))) {
127         $result = false;
128     }
130     if (! $DB->delete_records("survey_answers", array("survey"=>$survey->id))) {
131         $result = false;
132     }
134     if (! $DB->delete_records("survey", array("id"=>$survey->id))) {
135         $result = false;
136     }
138     return $result;
141 /**
142  * @global object
143  * @param object $course
144  * @param object $user
145  * @param object $mod
146  * @param object $survey
147  * @return $result
148  */
149 function survey_user_outline($course, $user, $mod, $survey) {
150     global $DB;
152     if ($answers = $DB->get_records("survey_answers", array('survey'=>$survey->id, 'userid'=>$user->id))) {
153         $lastanswer = array_pop($answers);
155         $result = new object();
156         $result->info = get_string("done", "survey");
157         $result->time = $lastanswer->time;
158         return $result;
159     }
160     return NULL;
163 /**
164  * @global stdObject
165  * @global object
166  * @uses SURVEY_CIQ
167  * @param object $course
168  * @param object $user
169  * @param object $mod
170  * @param object $survey
171  */
172 function survey_user_complete($course, $user, $mod, $survey) {
173     global $CFG, $DB, $OUTPUT;
175     if (survey_already_done($survey->id, $user->id)) {
176         if ($survey->template == SURVEY_CIQ) { // print out answers for critical incidents
177             $table = new html_table();
178             $table->align = array("left", "left");
180             $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions));
181             $questionorder = explode(",", $survey->questions);
183             foreach ($questionorder as $key=>$val) {
184                 $question = $questions[$val];
185                 $questiontext = get_string($question->shorttext, "survey");
187                 if ($answer = survey_get_user_answer($survey->id, $question->id, $user->id)) {
188                     $answertext = "$answer->answer1";
189                 } else {
190                     $answertext = "No answer";
191                 }
192                 $table->data[] = array("<b>$questiontext</b>", $answertext);
193             }
194             echo html_writer::table($table);
196         } else {
198             survey_print_graph("id=$mod->id&amp;sid=$user->id&amp;type=student.png");
199         }
201     } else {
202         print_string("notdone", "survey");
203     }
206 /**
207  * @global stdClass
208  * @global object
209  * @param object $course
210  * @param mixed $viewfullnames
211  * @param int $timestamp
212  * @return bool
213  */
214 function survey_print_recent_activity($course, $viewfullnames, $timestart) {
215     global $CFG, $DB, $OUTPUT;
217     $modinfo = get_fast_modinfo($course);
218     $ids = array();
219     foreach ($modinfo->cms as $cm) {
220         if ($cm->modname != 'survey') {
221             continue;
222         }
223         if (!$cm->uservisible) {
224             continue;
225         }
226         $ids[$cm->instance] = $cm->instance;
227     }
229     if (!$ids) {
230         return false;
231     }
233     $slist = implode(',', $ids); // there should not be hundreds of glossaries in one course, right?
235     if (!$rs = $DB->get_recordset_sql("SELECT sa.userid, sa.survey, MAX(sa.time) AS time,
236                                               u.firstname, u.lastname, u.email, u.picture
237                                          FROM {survey_answers} sa
238                                          JOIN {user} u ON u.id = sa.userid
239                                         WHERE sa.survey IN ($slist) AND sa.time > ?
240                                      GROUP BY sa.userid, sa.survey, u.firstname, u.lastname, u.email, u.picture
241                                      ORDER BY time ASC", array($timestart))) {
242         return false;
243     }
245     $surveys = array();
247     foreach ($rs as $survey) {
248         $cm = $modinfo->instances['survey'][$survey->survey];
249         $survey->name = $cm->name;
250         $survey->cmid = $cm->id;
251         $surveys[] = $survey;
252     }
253     $rs->close();
255     if (!$surveys) {
256         return false;
257     }
259     echo $OUTPUT->heading(get_string('newsurveyresponses', 'survey').':');
260     foreach ($surveys as $survey) {
261         $url = $CFG->wwwroot.'/mod/survey/view.php?id='.$survey->cmid;
262         print_recent_activity_note($survey->time, $survey, $survey->name, $url, false, $viewfullnames);
263     }
265     return true;
268 /**
269  * Returns the users with data in one survey
270  * (users with records in survey_analysis and survey_answers, students)
271  *
272  * @global object
273  * @param int $surveyid
274  * @return array
275  */
276 function survey_get_participants($surveyid) {
277     global $DB;
279     //Get students from survey_analysis
280     $st_analysis = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
281                                            FROM {user} u, {survey_analysis} a
282                                           WHERE a.survey = ? AND
283                                                 u.id = a.userid", array($surveyid));
284     //Get students from survey_answers
285     $st_answers = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
286                                           FROM {user} u, {survey_answers} a
287                                          WHERE a.survey = ? AND
288                                                u.id = a.userid", array($surveyid));
290     //Add st_answers to st_analysis
291     if ($st_answers) {
292         foreach ($st_answers as $st_answer) {
293             $st_analysis[$st_answer->id] = $st_answer;
294         }
295     }
296     //Return st_analysis array (it contains an array of unique users)
297     return ($st_analysis);
300 // SQL FUNCTIONS ////////////////////////////////////////////////////////
302 /**
303  * @global object
304  * @param sting $log
305  * @return array
306  */
307 function survey_log_info($log) {
308     global $DB;
309     return $DB->get_record_sql("SELECT s.name, u.firstname, u.lastname, u.picture
310                                   FROM {survey} s, {user} u
311                                  WHERE s.id = ?  AND u.id = ?", array($log->info, $log->userid));
314 /**
315  * @global object
316  * @param int $surveyid
317  * @param int $groupid
318  * @param int $groupingid
319  * @return array
320  */
321 function survey_get_responses($surveyid, $groupid, $groupingid) {
322     global $DB;
324     $params = array('surveyid'=>$surveyid, 'groupid'=>$groupid, 'groupingid'=>$groupingid);
326     if ($groupid) {
327         $groupsjoin = "JOIN {groups_members} gm ON u.id = gm.userid AND gm.groupid = :groupid ";
329     } else if ($groupingid) {
330         $groupsjoin = "JOIN {groups_members} gm ON u.id = gm.userid
331                        JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid ";
332     } else {
333         $groupsjoin = "";
334     }
336     $userfields = user_picture::fields('u');
337     return $DB->get_records_sql("SELECT $userfields, MAX(a.time) as time
338                                    FROM {survey_answers} a
339                                    JOIN {user} u ON a.userid = u.id
340                             $groupsjoin
341                                   WHERE a.survey = :surveyid
342                                GROUP BY $userfields
343                                ORDER BY time ASC", $params);
346 /**
347  * @global object
348  * @param int $survey
349  * @param int $user
350  * @return array
351  */
352 function survey_get_analysis($survey, $user) {
353     global $DB;
355     return $DB->get_record_sql("SELECT notes
356                                   FROM {survey_analysis}
357                                  WHERE survey=? AND userid=?", array($survey, $user));
360 /**
361  * @global object
362  * @param int $survey
363  * @param int $user
364  * @param string $notes
365  */
366 function survey_update_analysis($survey, $user, $notes) {
367     global $DB;
369     return $DB->execute("UPDATE {survey_analysis}
370                             SET notes=?
371                           WHERE survey=?
372                             AND userid=?", array($notes, $survey, $user));
375 /**
376  * @global object
377  * @param int $surveyid
378  * @param int $groupid
379  * @param string $sort
380  * @return array
381  */
382 function survey_get_user_answers($surveyid, $questionid, $groupid, $sort="sa.answer1,sa.answer2 ASC") {
383     global $DB;
385     $params = array('surveyid'=>$surveyid, 'questionid'=>$questionid);
387     if ($groupid) {
388         $groupfrom = ', {groups_members} gm';
389         $groupsql  = 'AND gm.groupid = :groupid AND u.id = gm.userid';
390         $params['groupid'] = $groupid;
391     } else {
392         $groupfrom = '';
393         $groupsql  = '';
394     }
396     $userfields = user_picture::fields('u');
397     return $DB->get_records_sql("SELECT sa.*, $userfields
398                                    FROM {survey_answers} sa,  {user} u $groupfrom
399                                   WHERE sa.survey = :surveyid
400                                         AND sa.question = :questionid
401                                         AND u.id = sa.userid $groupsql
402                                ORDER BY $sort", $params);
405 /**
406  * @global object
407  * @param int $surveyid
408  * @param int $questionid
409  * @param int $userid
410  * @return array
411  */
412 function survey_get_user_answer($surveyid, $questionid, $userid) {
413     global $DB;
415     return $DB->get_record_sql("SELECT sa.*
416                                   FROM {survey_answers} sa
417                                  WHERE sa.survey = ?
418                                        AND sa.question = ?
419                                        AND sa.userid = ?", array($surveyid, $questionid, $userid));
422 // MODULE FUNCTIONS ////////////////////////////////////////////////////////
423 /**
424  * @global object
425  * @param int $survey
426  * @param int $user
427  * @param string $notes
428  * @return bool|int
429  */
430 function survey_add_analysis($survey, $user, $notes) {
431     global $DB;
433     $record = new object();
434     $record->survey = $survey;
435     $record->userid = $user;
436     $record->notes = $notes;
438     return $DB->insert_record("survey_analysis", $record, false);
440 /**
441  * @global object
442  * @param int $survey
443  * @param int $user
444  * @return bool
445  */
446 function survey_already_done($survey, $user) {
447     global $DB;
449     return $DB->record_exists("survey_answers", array("survey"=>$survey, "userid"=>$user));
451 /**
452  * @param int $surveyid
453  * @param int $groupid
454  * @param int $groupingid
455  * @return int
456  */
457 function survey_count_responses($surveyid, $groupid, $groupingid) {
458     if ($responses = survey_get_responses($surveyid, $groupid, $groupingid)) {
459         return count($responses);
460     } else {
461         return 0;
462     }
465 /**
466  * @param int $cmid
467  * @param array $results
468  * @param int $courseid
469  */
470 function survey_print_all_responses($cmid, $results, $courseid) {
471     global $OUTPUT;
472     $table = new html_table();
473     $table->head  = array ("", get_string("name"),  get_string("time"));
474     $table->align = array ("", "left", "left");
475     $table->size = array (35, "", "" );
477     foreach ($results as $a) {
478         $table->data[] = array($OUTPUT->user_picture($a, array('courseid'=>$courseid)),
479                html_writer::link("report.php?action=student&student=$a->id&id=$cmid", fullname($a)),
480                userdate($a->time));
481     }
483     echo html_writer::table($table);
486 /**
487  * @global object
488  * @param int $templateid
489  * @return string
490  */
491 function survey_get_template_name($templateid) {
492     global $DB;
494     if ($templateid) {
495         if ($ss = $DB->get_record("surveys", array("id"=>$templateid))) {
496             return $ss->name;
497         }
498     } else {
499         return "";
500     }
504 /**
505  * @param string $name
506  * @param array $numwords
507  * @return string
508  */
509 function survey_shorten_name ($name, $numwords) {
510     $words = explode(" ", $name);
511     for ($i=0; $i < $numwords; $i++) {
512         $output .= $words[$i]." ";
513     }
514     return $output;
517 /**
518  * @todo Check this function
519  *
520  * @global object
521  * @global object
522  * @global int
523  * @global void This is never defined
524  * @global object This is defined twice?
525  * @param object $question
526  */
527 function survey_print_multi($question) {
528     global $USER, $DB, $qnum, $checklist, $DB, $OUTPUT;
530     $stripreferthat = get_string("ipreferthat", "survey");
531     $strifoundthat = get_string("ifoundthat", "survey");
532     $strdefault    = get_string('notyetanswered', 'survey');
533     $strresponses  = get_string('responses', 'survey');
535     echo $OUTPUT->heading($question->text, 3, 'questiontext');
536     echo "\n<table width=\"90%\" cellpadding=\"4\" cellspacing=\"1\" border=\"0\" class=\"surveytable\">";
538     $options = explode( ",", $question->options);
539     $numoptions = count($options);
541     $oneanswer = ($question->type == 1 || $question->type == 2) ? true : false;
543     echo "<tr class=\"smalltext\"><th scope=\"row\">$strresponses</th>";
544     echo "<th scope=\"col\" class=\"hresponse\">". get_string('notyetanswered', 'survey'). "</th>";
545     while (list ($key, $val) = each ($options)) {
546         echo "<th scope=\"col\" class=\"hresponse\">$val</th>\n";
547     }
548     echo "</tr>\n";
550     if ($oneanswer) {
551         echo "<tr><th scope=\"col\" colspan=\"7\">$question->intro</th></tr>\n";
552     } else {
553         echo "<tr><th scope=\"col\" colspan=\"7\">$question->intro</th></tr>\n";
554     }
556     $subquestions = $DB->get_records_list("survey_questions", "id", explode(',', $question->multi));
558     foreach ($subquestions as $q) {
559         $qnum++;
560         $rowclass = survey_question_rowclass($qnum);
561         if ($q->text) {
562             $q->text = get_string($q->text, "survey");
563         }
565         $oneanswer = ($q->type == 1 || $q->type == 2) ? true : false;
566         if ($q->type == 2) {
567             $P = "P";
568         } else {
569             $P = "";
570         }
572         echo "<tr class=\"$rowclass rblock\">";
573         if ($oneanswer) {
574             echo "<th scope=\"row\" class=\"optioncell\">";
575             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
576             echo $q->text ."</th>\n";
578             $default = get_accesshide($strdefault);
579             echo "<td class=\"whitecell\"><label for=\"q$P$q->id\"><input type=\"radio\" name=\"q$P$q->id\" id=\"q$P" . $q->id . "_D\" value=\"0\" checked=\"checked\" />$default</label></td>";
581             for ($i=1;$i<=$numoptions;$i++) {
582                 $hiddentext = get_accesshide($options[$i-1]);
583                 $id = "q$P" . $q->id . "_$i";
584                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"q$P$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
585             }            
586             $checklist["q$P$q->id"] = 0; 
588         } else { 
589             // yu : fix for MDL-7501, possibly need to use user flag as this is quite ugly.
590             echo "<th scope=\"row\" class=\"optioncell\">";
591             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
592             $qnum++;
593             echo "<span class=\"preferthat smalltext\">$stripreferthat</span> &nbsp; ";
594             echo "<span class=\"option\">$q->text</span></th>\n";
596             $default = get_accesshide($strdefault);
597             echo '<td class="whitecell"><label for="qP'. $P.$q->id .'"><input type="radio" name="qP'.$P.$q->id. '" id="qP'. $q->id .'" value="0" checked="checked" />'.$default.'</label></td>';
600             for ($i=1;$i<=$numoptions;$i++) {
601                 $hiddentext = get_accesshide($options[$i-1]);
602                 $id = "qP" . $q->id . "_$i";
603                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"qP$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
604             }
605             echo "</tr>";
607             echo "<tr class=\"$rowclass rblock\">";
608             echo "<th scope=\"row\" class=\"optioncell\">";
609             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
610             echo "<span class=\"foundthat smalltext\">$strifoundthat</span> &nbsp; ";
611             echo "<span class=\"option\">$q->text</span></th>\n";
613             $default = get_accesshide($strdefault);
614             echo '<td class="whitecell"><label for="q'. $q->id .'"><input type="radio" name="q'.$q->id. '" id="q'. $q->id .'" value="0" checked="checked" />'.$default.'</label></td>';
615           
616             for ($i=1;$i<=$numoptions;$i++) {
617                 $hiddentext = get_accesshide($options[$i-1]);
618                 $id = "q" . $q->id . "_$i";
619                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"q$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
620             }
621             
622             $checklist["qP$q->id"] = 0;
623             $checklist["q$q->id"] = 0;
624         }
625         echo "</tr>\n";
626     }
627     echo "</table>";
631 /**
632  * @global object
633  * @global int
634  * @param object $question
635  */
636 function survey_print_single($question) {
637     global $DB, $qnum, $OUTPUT;
639     $rowclass = survey_question_rowclass(0);
641     $qnum++;
643     echo "<br />\n";
644     echo "<table width=\"90%\" cellpadding=\"4\" cellspacing=\"0\">\n";
645     echo "<tr class=\"$rowclass\">";
646     echo "<th scope=\"row\" class=\"optioncell\"><label for=\"q$question->id\"><b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
647     echo "<span class=\"questioncell\">$question->text</span></label></th>\n";
648     echo "<td class=\"questioncell smalltext\">\n";
651     if ($question->type == 0) {           // Plain text field
652         echo "<textarea rows=\"3\" cols=\"30\" name=\"q$question->id\" id=\"q$question->id\">$question->options</textarea>";
654     } else if ($question->type > 0) {     // Choose one of a number
655         $strchoose = get_string("choose");
656         echo "<select name=\"q$question->id\" id=\"q$question->id\">";
657         echo "<option value=\"0\" selected=\"selected\">$strchoose...</option>";
658         $options = explode( ",", $question->options);
659         foreach ($options as $key => $val) {
660             $key++;
661             echo "<option value=\"$key\">$val</option>";
662         }
663         echo "</select>";
665     } else if ($question->type < 0) {     // Choose several of a number
666         $options = explode( ",", $question->options);
667         echo $OUTPUT->notification("This question type not supported yet");
668     }
670     echo "</td></tr></table>";
674 /**
675  *
676  * @param int $qnum
677  * @return string
678  */
679 function survey_question_rowclass($qnum) {
681     if ($qnum) {
682         return $qnum % 2 ? 'r0' : 'r1';
683     } else {
684         return 'r0';
685     }
688 /**
689  * @global object
690  * @global int
691  * @global int
692  * @param string $url
693  */
694 function survey_print_graph($url) {
695     global $CFG, $SURVEY_GHEIGHT, $SURVEY_GWIDTH;
697     if (empty($CFG->gdversion)) {
698         echo "(".get_string("gdneed").")";
700     } else {
701         echo "<img class='resultgraph' height=\"$SURVEY_GHEIGHT\" width=\"$SURVEY_GWIDTH\"".
702              " src=\"$CFG->wwwroot/mod/survey/graph.php?$url\" alt=\"".get_string("surveygraph", "survey")."\" />";
703     }
706 /**
707  * @return array
708  */
709 function survey_get_view_actions() {
710     return array('download','view all','view form','view graph','view report');
713 /**
714  * @return array
715  */
716 function survey_get_post_actions() {
717     return array('submit');
721 /**
722  * Implementation of the function for printing the form elements that control
723  * whether the course reset functionality affects the survey.
724  *
725  * @param object $mform form passed by reference
726  */
727 function survey_reset_course_form_definition(&$mform) {
728     $mform->addElement('header', 'surveyheader', get_string('modulenameplural', 'survey'));
729     $mform->addElement('checkbox', 'reset_survey_answers', get_string('deleteallanswers','survey'));
730     $mform->addElement('checkbox', 'reset_survey_analysis', get_string('deleteanalysis','survey'));
731     $mform->disabledIf('reset_survey_analysis', 'reset_survey_answers', 'checked');
734 /**
735  * Course reset form defaults.
736  * @return array
737  */
738 function survey_reset_course_form_defaults($course) {
739     return array('reset_survey_answers'=>1, 'reset_survey_analysis'=>1);
742 /**
743  * Actual implementation of the rest coures functionality, delete all the
744  * survey responses for course $data->courseid.
745  *
746  * @global object
747  * @param $data the data submitted from the reset course.
748  * @return array status array
749  */
750 function survey_reset_userdata($data) {
751     global $DB;
753     $componentstr = get_string('modulenameplural', 'survey');
754     $status = array();
756     $surveyssql = "SELECT ch.id
757                      FROM {survey} ch
758                     WHERE ch.course=?";
759     $params = array($data->courseid);
761     if (!empty($data->reset_survey_answers)) {
762         $DB->delete_records_select('survey_answers', "survey IN ($surveyssql)", $params);
763         $DB->delete_records_select('survey_analysis', "survey IN ($surveyssql)", $params);
764         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallanswers', 'survey'), 'error'=>false);
765     }
767     if (!empty($data->reset_survey_analysis)) {
768         $DB->delete_records_select('survey_analysis', "survey IN ($surveyssql)", $params);
769         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallanswers', 'survey'), 'error'=>false);
770     }
772     // no date shifting
773     return $status;
776 /**
777  * Returns all other caps used in module
778  *
779  * @return array
780  */
781 function survey_get_extra_capabilities() {
782     return array('moodle/site:accessallgroups');
785 /**
786  * @uses FEATURE_GROUPS
787  * @uses FEATURE_GROUPINGS
788  * @uses FEATURE_GROUPMEMBERSONLY
789  * @uses FEATURE_MOD_INTRO
790  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
791  * @uses FEATURE_GRADE_HAS_GRADE
792  * @uses FEATURE_GRADE_OUTCOMES
793  * @param string $feature FEATURE_xx constant for requested feature
794  * @return mixed True if module supports feature, false if not, null if doesn't know
795  */
796 function survey_supports($feature) {
797     switch($feature) {
798         case FEATURE_GROUPS:                  return true;
799         case FEATURE_GROUPINGS:               return true;
800         case FEATURE_GROUPMEMBERSONLY:        return true;
801         case FEATURE_MOD_INTRO:               return true;
802         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
803         case FEATURE_GRADE_HAS_GRADE:         return true;
804         case FEATURE_GRADE_OUTCOMES:          return true;
805         case FEATURE_BACKUP_MOODLE2:          return true;
807         default: return null;
808     }
811 /**
812  * This fucntion extends the global navigation for the site.
813  * It is important to note that you should not rely on PAGE objects within this
814  * body of code as there is no guarantee that during an AJAX request they are
815  * available
816  *
817  * @param navigation_node $navigation The quiz node within the global navigation
818  * @param stdClass $course The course object returned from the DB
819  * @param stdClass $module The module object returned from the DB
820  * @param stdClass $cm The course module instance returned from the DB
821  */
822 function survey_extend_navigation($navigation, $course, $module, $cm) {
823     /**
824      * This is currently just a stub so  that it can be easily expanded upon.
825      * When expanding just remove this comment and the line below and then add
826      * you content.
827      */
828     $navigation->nodetype = navigation_node::NODETYPE_LEAF;
831 /**
832  * This function extends the settings navigation block for the site.
833  *
834  * It is safe to rely on PAGE here as we will only ever be within the module
835  * context when this is called
836  *
837  * @param navigation_node $settings
838  * @param navigation_node $surveynode
839  */
840 function survey_extend_settings_navigation($settings, $surveynode) {
841     global $PAGE;
843     if (has_capability('mod/survey:readresponses', $PAGE->cm->context)) {
844         $responsesnode = $surveynode->add(get_string("responsereports", "survey"));
846         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'summary'));
847         $responsesnode->add(get_string("summary", "survey"), $url);
849         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'scales'));
850         $responsesnode->add(get_string("scales", "survey"), $url);
852         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'questions'));
853         $responsesnode->add(get_string("question", "survey"), $url);
855         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'students'));
856         $responsesnode->add(get_string('participants'), $url);
858         if (has_capability('mod/survey:download', $PAGE->cm->context)) {
859             $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'download'));
860             $surveynode->add(get_string('downloadresults', 'survey'), $url);
861         }
862     }