056ed9b4a59b413a6dce2fba01c67cff0152d81c
[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     return $DB->get_records_sql("SELECT u.id, u.firstname, u.lastname, u.picture, MAX(a.time) as time
337                                    FROM {survey_answers} a
338                                    JOIN {user} u ON a.userid = u.id
339                             $groupsjoin
340                                   WHERE a.survey = :surveyid
341                                GROUP BY u.id, u.firstname, u.lastname, u.picture
342                                ORDER BY time ASC", $params);
345 /**
346  * @global object
347  * @param int $survey
348  * @param int $user
349  * @return array
350  */
351 function survey_get_analysis($survey, $user) {
352     global $DB;
354     return $DB->get_record_sql("SELECT notes
355                                   FROM {survey_analysis}
356                                  WHERE survey=? AND userid=?", array($survey, $user));
359 /**
360  * @global object
361  * @param int $survey
362  * @param int $user
363  * @param string $notes
364  */
365 function survey_update_analysis($survey, $user, $notes) {
366     global $DB;
368     return $DB->execute("UPDATE {survey_analysis}
369                             SET notes=?
370                           WHERE survey=?
371                             AND userid=?", array($notes, $survey, $user));
374 /**
375  * @global object
376  * @param int $surveyid
377  * @param int $groupid
378  * @param string $sort
379  * @return array
380  */
381 function survey_get_user_answers($surveyid, $questionid, $groupid, $sort="sa.answer1,sa.answer2 ASC") {
382     global $DB;
384     $params = array('surveyid'=>$surveyid, 'questionid'=>$questionid, 'groupid'=>$groupid);
386     if ($groupid) {
387         $groupsql = "AND gm.groupid = :groupid AND u.id = gm.userid";
388     } else {
389         $groupsql = "";
390     }
392     return $DB->get_records_sql("SELECT sa.*,u.firstname,u.lastname,u.picture
393                                    FROM {survey_answers} sa,  {user} u, {groups_members} gm
394                                   WHERE sa.survey = :surveyid
395                                         AND sa.question = :questionid
396                                         AND u.id = sa.userid $groupsql
397                                ORDER BY $sort", $params);
400 /**
401  * @global object
402  * @param int $surveyid
403  * @param int $questionid
404  * @param int $userid
405  * @return array
406  */
407 function survey_get_user_answer($surveyid, $questionid, $userid) {
408     global $DB;
410     return $DB->get_record_sql("SELECT sa.*
411                                   FROM {survey_answers} sa
412                                  WHERE sa.survey = ?
413                                        AND sa.question = ?
414                                        AND sa.userid = ?", array($surveyid, $questionid, $userid));
417 // MODULE FUNCTIONS ////////////////////////////////////////////////////////
418 /**
419  * @global object
420  * @param int $survey
421  * @param int $user
422  * @param string $notes
423  * @return bool|int
424  */
425 function survey_add_analysis($survey, $user, $notes) {
426     global $DB;
428     $record = new object();
429     $record->survey = $survey;
430     $record->userid = $user;
431     $record->notes = $notes;
433     return $DB->insert_record("survey_analysis", $record, false);
435 /**
436  * @global object
437  * @param int $survey
438  * @param int $user
439  * @return bool
440  */
441 function survey_already_done($survey, $user) {
442     global $DB;
444     return $DB->record_exists("survey_answers", array("survey"=>$survey, "userid"=>$user));
446 /**
447  * @param int $surveyid
448  * @param int $groupid
449  * @param int $groupingid
450  * @return int
451  */
452 function survey_count_responses($surveyid, $groupid, $groupingid) {
453     if ($responses = survey_get_responses($surveyid, $groupid, $groupingid)) {
454         return count($responses);
455     } else {
456         return 0;
457     }
460 /**
461  * @param int $cmid
462  * @param array $results
463  * @param int $courseid
464  */
465 function survey_print_all_responses($cmid, $results, $courseid) {
466     global $OUTPUT;
467     $table = new html_table();
468     $table->head  = array ("", get_string("name"),  get_string("time"));
469     $table->align = array ("", "left", "left");
470     $table->size = array (35, "", "" );
472     foreach ($results as $a) {
473         $table->data[] = array($OUTPUT->user_picture($a, array('courseid'=>$courseid)),
474                html_writer::link("report.php?action=student&student=$a->id&id=$cmid", fullname($a)),
475                userdate($a->time));
476     }
478     echo html_writer::table($table);
481 /**
482  * @global object
483  * @param int $templateid
484  * @return string
485  */
486 function survey_get_template_name($templateid) {
487     global $DB;
489     if ($templateid) {
490         if ($ss = $DB->get_record("surveys", array("id"=>$templateid))) {
491             return $ss->name;
492         }
493     } else {
494         return "";
495     }
499 /**
500  * @param string $name
501  * @param array $numwords
502  * @return string
503  */
504 function survey_shorten_name ($name, $numwords) {
505     $words = explode(" ", $name);
506     for ($i=0; $i < $numwords; $i++) {
507         $output .= $words[$i]." ";
508     }
509     return $output;
512 /**
513  * @todo Check this function
514  *
515  * @global object
516  * @global object
517  * @global int
518  * @global void This is never defined
519  * @global object This is defined twice?
520  * @param object $question
521  */
522 function survey_print_multi($question) {
523     global $USER, $DB, $qnum, $checklist, $DB, $OUTPUT;
525     $stripreferthat = get_string("ipreferthat", "survey");
526     $strifoundthat = get_string("ifoundthat", "survey");
527     $strdefault    = get_string('notyetanswered', 'survey');
528     $strresponses  = get_string('responses', 'survey');
530     echo $OUTPUT->heading($question->text, 3, 'questiontext');
531     echo "\n<table width=\"90%\" cellpadding=\"4\" cellspacing=\"1\" border=\"0\" class=\"surveytable\">";
533     $options = explode( ",", $question->options);
534     $numoptions = count($options);
536     $oneanswer = ($question->type == 1 || $question->type == 2) ? true : false;
537     if ($question->type == 2) {
538         $P = "P";
539     } else {
540         $P = "";
541     }
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         echo "<tr class=\"$rowclass rblock\">";
566         if ($oneanswer) {
567             echo "<th scope=\"row\" class=\"optioncell\">";
568             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
569             echo $q->text ."</th>\n";
571             $default = get_accesshide($strdefault);
572             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>";
574             for ($i=1;$i<=$numoptions;$i++) {
575                 $hiddentext = get_accesshide($options[$i-1]);
576                 $id = "q$P" . $q->id . "_$i";
577                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"q$P$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
578             }            
579             $checklist["q$P$q->id"] = 0; 
581         } else { 
582             // yu : fix for MDL-7501, possibly need to use user flag as this is quite ugly.
583             echo "<th scope=\"row\" class=\"optioncell\">";
584             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
585             $qnum++;
586             echo "<span class=\"preferthat smalltext\">$stripreferthat</span> &nbsp; ";
587             echo "<span class=\"option\">$q->text</span></th>\n";
589             $default = get_accesshide($strdefault);
590             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>';
593             for ($i=1;$i<=$numoptions;$i++) {
594                 $hiddentext = get_accesshide($options[$i-1]);
595                 $id = "qP" . $q->id . "_$i";
596                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"qP$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
597             }
598             echo "</tr>";
600             echo "<tr class=\"$rowclass rblock\">";
601             echo "<th scope=\"row\" class=\"optioncell\">";
602             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
603             echo "<span class=\"foundthat smalltext\">$strifoundthat</span> &nbsp; ";
604             echo "<span class=\"option\">$q->text</span></th>\n";
606             $default = get_accesshide($strdefault);
607             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>';
608           
609             for ($i=1;$i<=$numoptions;$i++) {
610                 $hiddentext = get_accesshide($options[$i-1]);
611                 $id = "q" . $q->id . "_$i";
612                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"q$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
613             }
614             
615             $checklist["qP$q->id"] = 0;
616             $checklist["q$q->id"] = 0;
617         }
618         echo "</tr>\n";
619     }
620     echo "</table>";
624 /**
625  * @global object
626  * @global int
627  * @param object $question
628  */
629 function survey_print_single($question) {
630     global $DB, $qnum, $OUTPUT;
632     $rowclass = survey_question_rowclass(0);
634     $qnum++;
636     echo "<br />\n";
637     echo "<table width=\"90%\" cellpadding=\"4\" cellspacing=\"0\">\n";
638     echo "<tr class=\"$rowclass\">";
639     echo "<th scope=\"row\" class=\"optioncell\"><label for=\"q$question->id\"><b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
640     echo "<span class=\"questioncell\">$question->text</span></label></th>\n";
641     echo "<td class=\"questioncell smalltext\">\n";
644     if ($question->type == 0) {           // Plain text field
645         echo "<textarea rows=\"3\" cols=\"30\" name=\"q$question->id\" id=\"q$question->id\">$question->options</textarea>";
647     } else if ($question->type > 0) {     // Choose one of a number
648         $strchoose = get_string("choose");
649         echo "<select name=\"q$question->id\" id=\"q$question->id\">";
650         echo "<option value=\"0\" selected=\"selected\">$strchoose...</option>";
651         $options = explode( ",", $question->options);
652         foreach ($options as $key => $val) {
653             $key++;
654             echo "<option value=\"$key\">$val</option>";
655         }
656         echo "</select>";
658     } else if ($question->type < 0) {     // Choose several of a number
659         $options = explode( ",", $question->options);
660         echo $OUTPUT->notification("This question type not supported yet");
661     }
663     echo "</td></tr></table>";
667 /**
668  *
669  * @param int $qnum
670  * @return string
671  */
672 function survey_question_rowclass($qnum) {
674     if ($qnum) {
675         return $qnum % 2 ? 'r0' : 'r1';
676     } else {
677         return 'r0';
678     }
681 /**
682  * @global object
683  * @global int
684  * @global int
685  * @param string $url
686  */
687 function survey_print_graph($url) {
688     global $CFG, $SURVEY_GHEIGHT, $SURVEY_GWIDTH;
690     if (empty($CFG->gdversion)) {
691         echo "(".get_string("gdneed").")";
693     } else {
694         echo "<img class='resultgraph' height=\"$SURVEY_GHEIGHT\" width=\"$SURVEY_GWIDTH\"".
695              " src=\"$CFG->wwwroot/mod/survey/graph.php?$url\" alt=\"".get_string("surveygraph", "survey")."\" />";
696     }
699 /**
700  * @return array
701  */
702 function survey_get_view_actions() {
703     return array('download','view all','view form','view graph','view report');
706 /**
707  * @return array
708  */
709 function survey_get_post_actions() {
710     return array('submit');
714 /**
715  * Implementation of the function for printing the form elements that control
716  * whether the course reset functionality affects the survey.
717  *
718  * @param object $mform form passed by reference
719  */
720 function survey_reset_course_form_definition(&$mform) {
721     $mform->addElement('header', 'surveyheader', get_string('modulenameplural', 'survey'));
722     $mform->addElement('checkbox', 'reset_survey_answers', get_string('deleteallanswers','survey'));
723     $mform->addElement('checkbox', 'reset_survey_analysis', get_string('deleteanalysis','survey'));
724     $mform->disabledIf('reset_survey_analysis', 'reset_survey_answers', 'checked');
727 /**
728  * Course reset form defaults.
729  * @return array
730  */
731 function survey_reset_course_form_defaults($course) {
732     return array('reset_survey_answers'=>1, 'reset_survey_analysis'=>1);
735 /**
736  * Actual implementation of the rest coures functionality, delete all the
737  * survey responses for course $data->courseid.
738  *
739  * @global object
740  * @param $data the data submitted from the reset course.
741  * @return array status array
742  */
743 function survey_reset_userdata($data) {
744     global $DB;
746     $componentstr = get_string('modulenameplural', 'survey');
747     $status = array();
749     $surveyssql = "SELECT ch.id
750                      FROM {survey} ch
751                     WHERE ch.course=?";
752     $params = array($data->courseid);
754     if (!empty($data->reset_survey_answers)) {
755         $DB->delete_records_select('survey_answers', "survey IN ($surveyssql)", $params);
756         $DB->delete_records_select('survey_analysis', "survey IN ($surveyssql)", $params);
757         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallanswers', 'survey'), 'error'=>false);
758     }
760     if (!empty($data->reset_survey_analysis)) {
761         $DB->delete_records_select('survey_analysis', "survey IN ($surveyssql)", $params);
762         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallanswers', 'survey'), 'error'=>false);
763     }
765     // no date shifting
766     return $status;
769 /**
770  * Returns all other caps used in module
771  *
772  * @return array
773  */
774 function survey_get_extra_capabilities() {
775     return array('moodle/site:accessallgroups');
778 /**
779  * @uses FEATURE_GROUPS
780  * @uses FEATURE_GROUPINGS
781  * @uses FEATURE_GROUPMEMBERSONLY
782  * @uses FEATURE_MOD_INTRO
783  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
784  * @uses FEATURE_GRADE_HAS_GRADE
785  * @uses FEATURE_GRADE_OUTCOMES
786  * @param string $feature FEATURE_xx constant for requested feature
787  * @return mixed True if module supports feature, false if not, null if doesn't know
788  */
789 function survey_supports($feature) {
790     switch($feature) {
791         case FEATURE_GROUPS:                  return true;
792         case FEATURE_GROUPINGS:               return true;
793         case FEATURE_GROUPMEMBERSONLY:        return true;
794         case FEATURE_MOD_INTRO:               return true;
795         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
796         case FEATURE_GRADE_HAS_GRADE:         return true;
797         case FEATURE_GRADE_OUTCOMES:          return true;
799         default: return null;
800     }
803 /**
804  * This fucntion extends the global navigaiton for the site.
805  * It is important to note that you should not rely on PAGE objects within this
806  * body of code as there is no guarantee that during an AJAX request they are
807  * available
808  *
809  * @param navigation_node $navigation The quiz node within the global navigation
810  * @param stdClass $course The course object returned from the DB
811  * @param stdClass $module The module object returned from the DB
812  * @param stdClass $cm The course module isntance returned from the DB
813  */
814 function survey_extend_navigation($navigation, $course, $module, $cm) {
815     /**
816      * This is currently just a stub so  that it can be easily expanded upon.
817      * When expanding just remove this comment and the line below and then add
818      * you content.
819      */
820     $navigation->nodetype = navigation_node::NODETYPE_LEAF;
823 /**
824  * This function extends the settings navigation block for the site.
825  *
826  * It is safe to rely on PAGE here as we will only ever be within the module
827  * context when this is called
828  *
829  * @param navigation_node $settings
830  * @param navigation_node $surveynode
831  */
832 function survey_extend_settings_navigation($settings, $surveynode) {
833     global $PAGE;
835     if (has_capability('mod/survey:readresponses', $PAGE->cm->context)) {
836         $responsesnode = $surveynode->add(get_string("responsereports", "survey"));
838         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'summary'));
839         $responsesnode->add(get_string("summary", "survey"), $url);
841         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'scales'));
842         $responsesnode->add(get_string("scales", "survey"), $url);
844         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'questions'));
845         $responsesnode->add(get_string("question", "survey"), $url);
847         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'students'));
848         $responsesnode->add(get_string('participants'), $url);
850         if (has_capability('mod/survey:download', $PAGE->cm->context)) {
851             $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'download'));
852             $surveynode->add(get_string('downloadresults', 'survey'), $url);
853         }
854     }