d6ae05121691365c8c9cd32872263d582c9db47b
[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 stdClass();
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     $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     if (!$rs->valid()) {
243         $rs->close(); // Not going to iterate (but exit), close rs
244         return false;
245     }
247     $surveys = array();
249     foreach ($rs as $survey) {
250         $cm = $modinfo->instances['survey'][$survey->survey];
251         $survey->name = $cm->name;
252         $survey->cmid = $cm->id;
253         $surveys[] = $survey;
254     }
255     $rs->close();
257     if (!$surveys) {
258         return false;
259     }
261     echo $OUTPUT->heading(get_string('newsurveyresponses', 'survey').':');
262     foreach ($surveys as $survey) {
263         $url = $CFG->wwwroot.'/mod/survey/view.php?id='.$survey->cmid;
264         print_recent_activity_note($survey->time, $survey, $survey->name, $url, false, $viewfullnames);
265     }
267     return true;
270 // SQL FUNCTIONS ////////////////////////////////////////////////////////
272 /**
273  * @global object
274  * @param sting $log
275  * @return array
276  */
277 function survey_log_info($log) {
278     global $DB;
279     return $DB->get_record_sql("SELECT s.name, u.firstname, u.lastname, u.picture
280                                   FROM {survey} s, {user} u
281                                  WHERE s.id = ?  AND u.id = ?", array($log->info, $log->userid));
284 /**
285  * @global object
286  * @param int $surveyid
287  * @param int $groupid
288  * @param int $groupingid
289  * @return array
290  */
291 function survey_get_responses($surveyid, $groupid, $groupingid) {
292     global $DB;
294     $params = array('surveyid'=>$surveyid, 'groupid'=>$groupid, 'groupingid'=>$groupingid);
296     if ($groupid) {
297         $groupsjoin = "JOIN {groups_members} gm ON u.id = gm.userid AND gm.groupid = :groupid ";
299     } else if ($groupingid) {
300         $groupsjoin = "JOIN {groups_members} gm ON u.id = gm.userid
301                        JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid ";
302     } else {
303         $groupsjoin = "";
304     }
306     $userfields = user_picture::fields('u');
307     return $DB->get_records_sql("SELECT $userfields, MAX(a.time) as time
308                                    FROM {survey_answers} a
309                                    JOIN {user} u ON a.userid = u.id
310                             $groupsjoin
311                                   WHERE a.survey = :surveyid
312                                GROUP BY $userfields
313                                ORDER BY time ASC", $params);
316 /**
317  * @global object
318  * @param int $survey
319  * @param int $user
320  * @return array
321  */
322 function survey_get_analysis($survey, $user) {
323     global $DB;
325     return $DB->get_record_sql("SELECT notes
326                                   FROM {survey_analysis}
327                                  WHERE survey=? AND userid=?", array($survey, $user));
330 /**
331  * @global object
332  * @param int $survey
333  * @param int $user
334  * @param string $notes
335  */
336 function survey_update_analysis($survey, $user, $notes) {
337     global $DB;
339     return $DB->execute("UPDATE {survey_analysis}
340                             SET notes=?
341                           WHERE survey=?
342                             AND userid=?", array($notes, $survey, $user));
345 /**
346  * @global object
347  * @param int $surveyid
348  * @param int $groupid
349  * @param string $sort
350  * @return array
351  */
352 function survey_get_user_answers($surveyid, $questionid, $groupid, $sort="sa.answer1,sa.answer2 ASC") {
353     global $DB;
355     $params = array('surveyid'=>$surveyid, 'questionid'=>$questionid);
357     if ($groupid) {
358         $groupfrom = ', {groups_members} gm';
359         $groupsql  = 'AND gm.groupid = :groupid AND u.id = gm.userid';
360         $params['groupid'] = $groupid;
361     } else {
362         $groupfrom = '';
363         $groupsql  = '';
364     }
366     $userfields = user_picture::fields('u');
367     return $DB->get_records_sql("SELECT sa.*, $userfields
368                                    FROM {survey_answers} sa,  {user} u $groupfrom
369                                   WHERE sa.survey = :surveyid
370                                         AND sa.question = :questionid
371                                         AND u.id = sa.userid $groupsql
372                                ORDER BY $sort", $params);
375 /**
376  * @global object
377  * @param int $surveyid
378  * @param int $questionid
379  * @param int $userid
380  * @return array
381  */
382 function survey_get_user_answer($surveyid, $questionid, $userid) {
383     global $DB;
385     return $DB->get_record_sql("SELECT sa.*
386                                   FROM {survey_answers} sa
387                                  WHERE sa.survey = ?
388                                        AND sa.question = ?
389                                        AND sa.userid = ?", array($surveyid, $questionid, $userid));
392 // MODULE FUNCTIONS ////////////////////////////////////////////////////////
393 /**
394  * @global object
395  * @param int $survey
396  * @param int $user
397  * @param string $notes
398  * @return bool|int
399  */
400 function survey_add_analysis($survey, $user, $notes) {
401     global $DB;
403     $record = new stdClass();
404     $record->survey = $survey;
405     $record->userid = $user;
406     $record->notes = $notes;
408     return $DB->insert_record("survey_analysis", $record, false);
410 /**
411  * @global object
412  * @param int $survey
413  * @param int $user
414  * @return bool
415  */
416 function survey_already_done($survey, $user) {
417     global $DB;
419     return $DB->record_exists("survey_answers", array("survey"=>$survey, "userid"=>$user));
421 /**
422  * @param int $surveyid
423  * @param int $groupid
424  * @param int $groupingid
425  * @return int
426  */
427 function survey_count_responses($surveyid, $groupid, $groupingid) {
428     if ($responses = survey_get_responses($surveyid, $groupid, $groupingid)) {
429         return count($responses);
430     } else {
431         return 0;
432     }
435 /**
436  * @param int $cmid
437  * @param array $results
438  * @param int $courseid
439  */
440 function survey_print_all_responses($cmid, $results, $courseid) {
441     global $OUTPUT;
442     $table = new html_table();
443     $table->head  = array ("", get_string("name"),  get_string("time"));
444     $table->align = array ("", "left", "left");
445     $table->size = array (35, "", "" );
447     foreach ($results as $a) {
448         $table->data[] = array($OUTPUT->user_picture($a, array('courseid'=>$courseid)),
449                html_writer::link("report.php?action=student&student=$a->id&id=$cmid", fullname($a)),
450                userdate($a->time));
451     }
453     echo html_writer::table($table);
456 /**
457  * @global object
458  * @param int $templateid
459  * @return string
460  */
461 function survey_get_template_name($templateid) {
462     global $DB;
464     if ($templateid) {
465         if ($ss = $DB->get_record("surveys", array("id"=>$templateid))) {
466             return $ss->name;
467         }
468     } else {
469         return "";
470     }
474 /**
475  * @param string $name
476  * @param array $numwords
477  * @return string
478  */
479 function survey_shorten_name ($name, $numwords) {
480     $words = explode(" ", $name);
481     $output = '';
482     for ($i=0; $i < $numwords; $i++) {
483         $output .= $words[$i]." ";
484     }
485     return $output;
488 /**
489  * @todo Check this function
490  *
491  * @global object
492  * @global object
493  * @global int
494  * @global void This is never defined
495  * @global object This is defined twice?
496  * @param object $question
497  */
498 function survey_print_multi($question) {
499     global $USER, $DB, $qnum, $checklist, $DB, $OUTPUT; //TODO: this is sloppy globals abuse
501     $stripreferthat = get_string("ipreferthat", "survey");
502     $strifoundthat = get_string("ifoundthat", "survey");
503     $strdefault    = get_string('notyetanswered', 'survey');
504     $strresponses  = get_string('responses', 'survey');
506     echo $OUTPUT->heading($question->text, 3, 'questiontext');
507     echo "\n<table width=\"90%\" cellpadding=\"4\" cellspacing=\"1\" border=\"0\" class=\"surveytable\">";
509     $options = explode( ",", $question->options);
510     $numoptions = count($options);
512     // COLLES Actual (which is having questions of type 1) and COLLES Preferred (type 2)
513     // expect just one answer per question. COLLES Actual and Preferred (type 3) expects
514     // two answers per question. ATTLS (having a single question of type 1) expects one
515     // answer per question. CIQ is not using multiquestions (i.e. a question with subquestions).
516     // Note that the type of subquestions does not really matter, it's the type of the
517     // question itself that determines everything.
518     $oneanswer = ($question->type == 1 || $question->type == 2) ? true : false;
520     // COLLES Preferred (having questions of type 2) will use the radio elements with the name
521     // like qP1, qP2 etc. COLLES Actual and ATTLS have radios like q1, q2 etc.
522     if ($question->type == 2) {
523         $P = "P";
524     } else {
525         $P = "";
526     }
528     echo "<tr class=\"smalltext\"><th scope=\"row\">$strresponses</th>";
529     echo "<th scope=\"col\" class=\"hresponse\">". get_string('notyetanswered', 'survey'). "</th>";
530     while (list ($key, $val) = each ($options)) {
531         echo "<th scope=\"col\" class=\"hresponse\">$val</th>\n";
532     }
533     echo "</tr>\n";
535     if ($oneanswer) {
536         echo "<tr><th scope=\"col\" colspan=\"7\">$question->intro</th></tr>\n";
537     } else {
538         echo "<tr><th scope=\"col\" colspan=\"7\">$question->intro</th></tr>\n";
539     }
541     $subquestions = $DB->get_records_list("survey_questions", "id", explode(',', $question->multi));
543     foreach ($subquestions as $q) {
544         $qnum++;
545         $rowclass = survey_question_rowclass($qnum);
546         if ($q->text) {
547             $q->text = get_string($q->text, "survey");
548         }
550         echo "<tr class=\"$rowclass rblock\">";
551         if ($oneanswer) {
552             echo "<th scope=\"row\" class=\"optioncell\">";
553             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
554             echo $q->text ."</th>\n";
556             $default = get_accesshide($strdefault);
557             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>";
559             for ($i=1;$i<=$numoptions;$i++) {
560                 $hiddentext = get_accesshide($options[$i-1]);
561                 $id = "q$P" . $q->id . "_$i";
562                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"q$P$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
563             }
564             $checklist["q$P$q->id"] = 0;
566         } else {
567             // yu : fix for MDL-7501, possibly need to use user flag as this is quite ugly.
568             echo "<th scope=\"row\" class=\"optioncell\">";
569             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
570             $qnum++;
571             echo "<span class=\"preferthat smalltext\">$stripreferthat</span> &nbsp; ";
572             echo "<span class=\"option\">$q->text</span></th>\n";
574             $default = get_accesshide($strdefault);
575             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>';
578             for ($i=1;$i<=$numoptions;$i++) {
579                 $hiddentext = get_accesshide($options[$i-1]);
580                 $id = "qP" . $q->id . "_$i";
581                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"qP$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
582             }
583             echo "</tr>";
585             echo "<tr class=\"$rowclass rblock\">";
586             echo "<th scope=\"row\" class=\"optioncell\">";
587             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
588             echo "<span class=\"foundthat smalltext\">$strifoundthat</span> &nbsp; ";
589             echo "<span class=\"option\">$q->text</span></th>\n";
591             $default = get_accesshide($strdefault);
592             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>';
594             for ($i=1;$i<=$numoptions;$i++) {
595                 $hiddentext = get_accesshide($options[$i-1]);
596                 $id = "q" . $q->id . "_$i";
597                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"q$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
598             }
600             $checklist["qP$q->id"] = 0;
601             $checklist["q$q->id"] = 0;
602         }
603         echo "</tr>\n";
604     }
605     echo "</table>";
609 /**
610  * @global object
611  * @global int
612  * @param object $question
613  */
614 function survey_print_single($question) {
615     global $DB, $qnum, $OUTPUT;
617     $rowclass = survey_question_rowclass(0);
619     $qnum++;
621     echo "<br />\n";
622     echo "<table width=\"90%\" cellpadding=\"4\" cellspacing=\"0\">\n";
623     echo "<tr class=\"$rowclass\">";
624     echo "<th scope=\"row\" class=\"optioncell\"><label for=\"q$question->id\"><b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
625     echo "<span class=\"questioncell\">$question->text</span></label></th>\n";
626     echo "<td class=\"questioncell smalltext\">\n";
629     if ($question->type == 0) {           // Plain text field
630         echo "<textarea rows=\"3\" cols=\"30\" name=\"q$question->id\" id=\"q$question->id\">$question->options</textarea>";
632     } else if ($question->type > 0) {     // Choose one of a number
633         $strchoose = get_string("choose");
634         echo "<select name=\"q$question->id\" id=\"q$question->id\">";
635         echo "<option value=\"0\" selected=\"selected\">$strchoose...</option>";
636         $options = explode( ",", $question->options);
637         foreach ($options as $key => $val) {
638             $key++;
639             echo "<option value=\"$key\">$val</option>";
640         }
641         echo "</select>";
643     } else if ($question->type < 0) {     // Choose several of a number
644         $options = explode( ",", $question->options);
645         echo $OUTPUT->notification("This question type not supported yet");
646     }
648     echo "</td></tr></table>";
652 /**
653  *
654  * @param int $qnum
655  * @return string
656  */
657 function survey_question_rowclass($qnum) {
659     if ($qnum) {
660         return $qnum % 2 ? 'r0' : 'r1';
661     } else {
662         return 'r0';
663     }
666 /**
667  * @global object
668  * @global int
669  * @global int
670  * @param string $url
671  */
672 function survey_print_graph($url) {
673     global $CFG, $SURVEY_GHEIGHT, $SURVEY_GWIDTH;
675     echo "<img class='resultgraph' height=\"$SURVEY_GHEIGHT\" width=\"$SURVEY_GWIDTH\"".
676          " src=\"$CFG->wwwroot/mod/survey/graph.php?$url\" alt=\"".get_string("surveygraph", "survey")."\" />";
679 /**
680  * @return array
681  */
682 function survey_get_view_actions() {
683     return array('download','view all','view form','view graph','view report');
686 /**
687  * @return array
688  */
689 function survey_get_post_actions() {
690     return array('submit');
694 /**
695  * Implementation of the function for printing the form elements that control
696  * whether the course reset functionality affects the survey.
697  *
698  * @param object $mform form passed by reference
699  */
700 function survey_reset_course_form_definition(&$mform) {
701     $mform->addElement('header', 'surveyheader', get_string('modulenameplural', 'survey'));
702     $mform->addElement('checkbox', 'reset_survey_answers', get_string('deleteallanswers','survey'));
703     $mform->addElement('checkbox', 'reset_survey_analysis', get_string('deleteanalysis','survey'));
704     $mform->disabledIf('reset_survey_analysis', 'reset_survey_answers', 'checked');
707 /**
708  * Course reset form defaults.
709  * @return array
710  */
711 function survey_reset_course_form_defaults($course) {
712     return array('reset_survey_answers'=>1, 'reset_survey_analysis'=>1);
715 /**
716  * Actual implementation of the reset course functionality, delete all the
717  * survey responses for course $data->courseid.
718  *
719  * @global object
720  * @param $data the data submitted from the reset course.
721  * @return array status array
722  */
723 function survey_reset_userdata($data) {
724     global $DB;
726     $componentstr = get_string('modulenameplural', 'survey');
727     $status = array();
729     $surveyssql = "SELECT ch.id
730                      FROM {survey} ch
731                     WHERE ch.course=?";
732     $params = array($data->courseid);
734     if (!empty($data->reset_survey_answers)) {
735         $DB->delete_records_select('survey_answers', "survey IN ($surveyssql)", $params);
736         $DB->delete_records_select('survey_analysis', "survey IN ($surveyssql)", $params);
737         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallanswers', 'survey'), 'error'=>false);
738     }
740     if (!empty($data->reset_survey_analysis)) {
741         $DB->delete_records_select('survey_analysis', "survey IN ($surveyssql)", $params);
742         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallanswers', 'survey'), 'error'=>false);
743     }
745     // no date shifting
746     return $status;
749 /**
750  * Returns all other caps used in module
751  *
752  * @return array
753  */
754 function survey_get_extra_capabilities() {
755     return array('moodle/site:accessallgroups');
758 /**
759  * @uses FEATURE_GROUPS
760  * @uses FEATURE_GROUPINGS
761  * @uses FEATURE_GROUPMEMBERSONLY
762  * @uses FEATURE_MOD_INTRO
763  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
764  * @uses FEATURE_GRADE_HAS_GRADE
765  * @uses FEATURE_GRADE_OUTCOMES
766  * @param string $feature FEATURE_xx constant for requested feature
767  * @return mixed True if module supports feature, false if not, null if doesn't know
768  */
769 function survey_supports($feature) {
770     switch($feature) {
771         case FEATURE_GROUPS:                  return true;
772         case FEATURE_GROUPINGS:               return true;
773         case FEATURE_GROUPMEMBERSONLY:        return true;
774         case FEATURE_MOD_INTRO:               return true;
775         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
776         case FEATURE_GRADE_HAS_GRADE:         return false;
777         case FEATURE_GRADE_OUTCOMES:          return false;
778         case FEATURE_BACKUP_MOODLE2:          return true;
779         case FEATURE_SHOW_DESCRIPTION:        return true;
781         default: return null;
782     }
785 /**
786  * This function extends the settings navigation block for the site.
787  *
788  * It is safe to rely on PAGE here as we will only ever be within the module
789  * context when this is called
790  *
791  * @param navigation_node $settings
792  * @param navigation_node $surveynode
793  */
794 function survey_extend_settings_navigation($settings, $surveynode) {
795     global $PAGE;
797     if (has_capability('mod/survey:readresponses', $PAGE->cm->context)) {
798         $responsesnode = $surveynode->add(get_string("responsereports", "survey"));
800         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'summary'));
801         $responsesnode->add(get_string("summary", "survey"), $url);
803         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'scales'));
804         $responsesnode->add(get_string("scales", "survey"), $url);
806         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'questions'));
807         $responsesnode->add(get_string("question", "survey"), $url);
809         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'students'));
810         $responsesnode->add(get_string('participants'), $url);
812         if (has_capability('mod/survey:download', $PAGE->cm->context)) {
813             $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'download'));
814             $surveynode->add(get_string('downloadresults', 'survey'), $url);
815         }
816     }
819 /**
820  * Return a list of page types
821  * @param string $pagetype current page type
822  * @param stdClass $parentcontext Block's parent context
823  * @param stdClass $currentcontext Current context of block
824  */
825 function survey_page_type_list($pagetype, $parentcontext, $currentcontext) {
826     $module_pagetype = array('mod-survey-*'=>get_string('page-mod-survey-x', 'survey'));
827     return $module_pagetype;