Merge branch 'MDL-55611-master' of git://github.com/danpoltawski/moodle
[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     $id = $DB->insert_record("survey", $survey);
83     $completiontimeexpected = !empty($survey->completionexpected) ? $survey->completionexpected : null;
84     \core_completion\api::update_completion_date_event($survey->coursemodule, 'survey', $id, $completiontimeexpected);
86     return $id;
88 }
90 /**
91  * Given an object containing all the necessary data,
92  * (defined by the form in mod_form.php) this function
93  * will update an existing instance with new data.
94  *
95  * @global object
96  * @param object $survey
97  * @return bool
98  */
99 function survey_update_instance($survey) {
100     global $DB;
102     if (!$template = $DB->get_record("survey", array("id"=>$survey->template))) {
103         return 0;
104     }
106     $survey->id           = $survey->instance;
107     $survey->questions    = $template->questions;
108     $survey->timemodified = time();
110     $completiontimeexpected = !empty($survey->completionexpected) ? $survey->completionexpected : null;
111     \core_completion\api::update_completion_date_event($survey->coursemodule, 'survey', $survey->id, $completiontimeexpected);
113     return $DB->update_record("survey", $survey);
116 /**
117  * Given an ID of an instance of this module,
118  * this function will permanently delete the instance
119  * and any data that depends on it.
120  *
121  * @global object
122  * @param int $id
123  * @return bool
124  */
125 function survey_delete_instance($id) {
126     global $DB;
128     if (! $survey = $DB->get_record("survey", array("id"=>$id))) {
129         return false;
130     }
132     $cm = get_coursemodule_from_instance('survey', $id);
133     \core_completion\api::update_completion_date_event($cm->id, 'survey', $id, null);
135     $result = true;
137     if (! $DB->delete_records("survey_analysis", array("survey"=>$survey->id))) {
138         $result = false;
139     }
141     if (! $DB->delete_records("survey_answers", array("survey"=>$survey->id))) {
142         $result = false;
143     }
145     if (! $DB->delete_records("survey", array("id"=>$survey->id))) {
146         $result = false;
147     }
149     return $result;
152 /**
153  * @global object
154  * @param object $course
155  * @param object $user
156  * @param object $mod
157  * @param object $survey
158  * @return $result
159  */
160 function survey_user_outline($course, $user, $mod, $survey) {
161     global $DB;
163     if ($answers = $DB->get_records("survey_answers", array('survey'=>$survey->id, 'userid'=>$user->id))) {
164         $lastanswer = array_pop($answers);
166         $result = new stdClass();
167         $result->info = get_string("done", "survey");
168         $result->time = $lastanswer->time;
169         return $result;
170     }
171     return NULL;
174 /**
175  * @global stdObject
176  * @global object
177  * @uses SURVEY_CIQ
178  * @param object $course
179  * @param object $user
180  * @param object $mod
181  * @param object $survey
182  */
183 function survey_user_complete($course, $user, $mod, $survey) {
184     global $CFG, $DB, $OUTPUT;
186     if (survey_already_done($survey->id, $user->id)) {
187         if ($survey->template == SURVEY_CIQ) { // print out answers for critical incidents
188             $table = new html_table();
189             $table->align = array("left", "left");
191             $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions));
192             $questionorder = explode(",", $survey->questions);
194             foreach ($questionorder as $key=>$val) {
195                 $question = $questions[$val];
196                 $questiontext = get_string($question->shorttext, "survey");
198                 if ($answer = survey_get_user_answer($survey->id, $question->id, $user->id)) {
199                     $answertext = "$answer->answer1";
200                 } else {
201                     $answertext = "No answer";
202                 }
203                 $table->data[] = array("<b>$questiontext</b>", s($answertext));
204             }
205             echo html_writer::table($table);
207         } else {
209             survey_print_graph("id=$mod->id&amp;sid=$user->id&amp;type=student.png");
210         }
212     } else {
213         print_string("notdone", "survey");
214     }
217 /**
218  * @global stdClass
219  * @global object
220  * @param object $course
221  * @param mixed $viewfullnames
222  * @param int $timestamp
223  * @return bool
224  */
225 function survey_print_recent_activity($course, $viewfullnames, $timestart) {
226     global $CFG, $DB, $OUTPUT;
228     $modinfo = get_fast_modinfo($course);
229     $ids = array();
230     foreach ($modinfo->cms as $cm) {
231         if ($cm->modname != 'survey') {
232             continue;
233         }
234         if (!$cm->uservisible) {
235             continue;
236         }
237         $ids[$cm->instance] = $cm->instance;
238     }
240     if (!$ids) {
241         return false;
242     }
244     $slist = implode(',', $ids); // there should not be hundreds of glossaries in one course, right?
246     $allusernames = user_picture::fields('u');
247     $rs = $DB->get_recordset_sql("SELECT sa.userid, sa.survey, MAX(sa.time) AS time,
248                                          $allusernames
249                                     FROM {survey_answers} sa
250                                     JOIN {user} u ON u.id = sa.userid
251                                    WHERE sa.survey IN ($slist) AND sa.time > ?
252                                 GROUP BY sa.userid, sa.survey, $allusernames
253                                 ORDER BY time ASC", array($timestart));
254     if (!$rs->valid()) {
255         $rs->close(); // Not going to iterate (but exit), close rs
256         return false;
257     }
259     $surveys = array();
261     foreach ($rs as $survey) {
262         $cm = $modinfo->instances['survey'][$survey->survey];
263         $survey->name = $cm->name;
264         $survey->cmid = $cm->id;
265         $surveys[] = $survey;
266     }
267     $rs->close();
269     if (!$surveys) {
270         return false;
271     }
273     echo $OUTPUT->heading(get_string('newsurveyresponses', 'survey').':', 3);
274     foreach ($surveys as $survey) {
275         $url = $CFG->wwwroot.'/mod/survey/view.php?id='.$survey->cmid;
276         print_recent_activity_note($survey->time, $survey, $survey->name, $url, false, $viewfullnames);
277     }
279     return true;
282 // SQL FUNCTIONS ////////////////////////////////////////////////////////
284 /**
285  * @global object
286  * @param sting $log
287  * @return array
288  */
289 function survey_log_info($log) {
290     global $DB;
291     return $DB->get_record_sql("SELECT s.name, u.firstname, u.lastname, u.picture
292                                   FROM {survey} s, {user} u
293                                  WHERE s.id = ?  AND u.id = ?", array($log->info, $log->userid));
296 /**
297  * @global object
298  * @param int $surveyid
299  * @param int $groupid
300  * @param int $groupingid
301  * @return array
302  */
303 function survey_get_responses($surveyid, $groupid, $groupingid) {
304     global $DB;
306     $params = array('surveyid'=>$surveyid, 'groupid'=>$groupid, 'groupingid'=>$groupingid);
308     if ($groupid) {
309         $groupsjoin = "JOIN {groups_members} gm ON u.id = gm.userid AND gm.groupid = :groupid ";
311     } else if ($groupingid) {
312         $groupsjoin = "JOIN {groups_members} gm ON u.id = gm.userid
313                        JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid ";
314     } else {
315         $groupsjoin = "";
316     }
318     $userfields = user_picture::fields('u');
319     return $DB->get_records_sql("SELECT $userfields, MAX(a.time) as time
320                                    FROM {survey_answers} a
321                                    JOIN {user} u ON a.userid = u.id
322                             $groupsjoin
323                                   WHERE a.survey = :surveyid
324                                GROUP BY $userfields
325                                ORDER BY time ASC", $params);
328 /**
329  * @global object
330  * @param int $survey
331  * @param int $user
332  * @return array
333  */
334 function survey_get_analysis($survey, $user) {
335     global $DB;
337     return $DB->get_record_sql("SELECT notes
338                                   FROM {survey_analysis}
339                                  WHERE survey=? AND userid=?", array($survey, $user));
342 /**
343  * @global object
344  * @param int $survey
345  * @param int $user
346  * @param string $notes
347  */
348 function survey_update_analysis($survey, $user, $notes) {
349     global $DB;
351     return $DB->execute("UPDATE {survey_analysis}
352                             SET notes=?
353                           WHERE survey=?
354                             AND userid=?", array($notes, $survey, $user));
357 /**
358  * @global object
359  * @param int $surveyid
360  * @param int $groupid
361  * @param string $sort
362  * @return array
363  */
364 function survey_get_user_answers($surveyid, $questionid, $groupid, $sort="sa.answer1,sa.answer2 ASC") {
365     global $DB;
367     $params = array('surveyid'=>$surveyid, 'questionid'=>$questionid);
369     if ($groupid) {
370         $groupfrom = ', {groups_members} gm';
371         $groupsql  = 'AND gm.groupid = :groupid AND u.id = gm.userid';
372         $params['groupid'] = $groupid;
373     } else {
374         $groupfrom = '';
375         $groupsql  = '';
376     }
378     $userfields = user_picture::fields('u');
379     return $DB->get_records_sql("SELECT sa.*, $userfields
380                                    FROM {survey_answers} sa,  {user} u $groupfrom
381                                   WHERE sa.survey = :surveyid
382                                         AND sa.question = :questionid
383                                         AND u.id = sa.userid $groupsql
384                                ORDER BY $sort", $params);
387 /**
388  * @global object
389  * @param int $surveyid
390  * @param int $questionid
391  * @param int $userid
392  * @return array
393  */
394 function survey_get_user_answer($surveyid, $questionid, $userid) {
395     global $DB;
397     return $DB->get_record_sql("SELECT sa.*
398                                   FROM {survey_answers} sa
399                                  WHERE sa.survey = ?
400                                        AND sa.question = ?
401                                        AND sa.userid = ?", array($surveyid, $questionid, $userid));
404 // MODULE FUNCTIONS ////////////////////////////////////////////////////////
405 /**
406  * @global object
407  * @param int $survey
408  * @param int $user
409  * @param string $notes
410  * @return bool|int
411  */
412 function survey_add_analysis($survey, $user, $notes) {
413     global $DB;
415     $record = new stdClass();
416     $record->survey = $survey;
417     $record->userid = $user;
418     $record->notes = $notes;
420     return $DB->insert_record("survey_analysis", $record, false);
422 /**
423  * @global object
424  * @param int $survey
425  * @param int $user
426  * @return bool
427  */
428 function survey_already_done($survey, $user) {
429     global $DB;
431     return $DB->record_exists("survey_answers", array("survey"=>$survey, "userid"=>$user));
433 /**
434  * @param int $surveyid
435  * @param int $groupid
436  * @param int $groupingid
437  * @return int
438  */
439 function survey_count_responses($surveyid, $groupid, $groupingid) {
440     if ($responses = survey_get_responses($surveyid, $groupid, $groupingid)) {
441         return count($responses);
442     } else {
443         return 0;
444     }
447 /**
448  * @param int $cmid
449  * @param array $results
450  * @param int $courseid
451  */
452 function survey_print_all_responses($cmid, $results, $courseid) {
453     global $OUTPUT;
454     $table = new html_table();
455     $table->head  = array ("", get_string("name"),  get_string("time"));
456     $table->align = array ("", "left", "left");
457     $table->size = array (35, "", "" );
459     foreach ($results as $a) {
460         $table->data[] = array($OUTPUT->user_picture($a, array('courseid'=>$courseid)),
461                html_writer::link("report.php?action=student&student=$a->id&id=$cmid", fullname($a)),
462                userdate($a->time));
463     }
465     echo html_writer::table($table);
468 /**
469  * @global object
470  * @param int $templateid
471  * @return string
472  */
473 function survey_get_template_name($templateid) {
474     global $DB;
476     if ($templateid) {
477         if ($ss = $DB->get_record("surveys", array("id"=>$templateid))) {
478             return $ss->name;
479         }
480     } else {
481         return "";
482     }
486 /**
487  * @param string $name
488  * @param array $numwords
489  * @return string
490  */
491 function survey_shorten_name ($name, $numwords) {
492     $words = explode(" ", $name);
493     $output = '';
494     for ($i=0; $i < $numwords; $i++) {
495         $output .= $words[$i]." ";
496     }
497     return $output;
500 /**
501  * @todo Check this function
502  *
503  * @global object
504  * @global object
505  * @global int
506  * @global void This is never defined
507  * @global object This is defined twice?
508  * @param object $question
509  */
510 function survey_print_multi($question) {
511     global $USER, $DB, $qnum, $DB, $OUTPUT; //TODO: this is sloppy globals abuse
513     $stripreferthat = get_string("ipreferthat", "survey");
514     $strifoundthat = get_string("ifoundthat", "survey");
515     $strdefault    = get_string('notyetanswered', 'survey');
516     $strresponses  = get_string('responses', 'survey');
518     echo $OUTPUT->heading($question->text, 3);
519     echo "\n<table width=\"90%\" cellpadding=\"4\" cellspacing=\"1\" border=\"0\" class=\"surveytable\">";
521     $options = explode( ",", $question->options);
522     $numoptions = count($options);
524     // COLLES Actual (which is having questions of type 1) and COLLES Preferred (type 2)
525     // expect just one answer per question. COLLES Actual and Preferred (type 3) expects
526     // two answers per question. ATTLS (having a single question of type 1) expects one
527     // answer per question. CIQ is not using multiquestions (i.e. a question with subquestions).
528     // Note that the type of subquestions does not really matter, it's the type of the
529     // question itself that determines everything.
530     $oneanswer = ($question->type == 1 || $question->type == 2) ? true : false;
532     // COLLES Preferred (having questions of type 2) will use the radio elements with the name
533     // like qP1, qP2 etc. COLLES Actual and ATTLS have radios like q1, q2 etc.
534     if ($question->type == 2) {
535         $P = "P";
536     } else {
537         $P = "";
538     }
540     echo "<tr class=\"smalltext\"><th scope=\"row\">$strresponses</th>";
541     echo "<th scope=\"col\" class=\"hresponse\">". get_string('notyetanswered', 'survey'). "</th>";
542     while (list ($key, $val) = each ($options)) {
543         echo "<th scope=\"col\" class=\"hresponse\">$val</th>\n";
544     }
545     echo "</tr>\n";
547     echo "<tr><th scope=\"col\" colspan=\"7\">$question->intro</th></tr>\n";
549     $subquestions = survey_get_subquestions($question);
551     foreach ($subquestions as $q) {
552         $qnum++;
553         if ($oneanswer) {
554             $rowclass = survey_question_rowclass($qnum);
555         } else {
556             $rowclass = survey_question_rowclass(round($qnum / 2));
557         }
558         if ($q->text) {
559             $q->text = get_string($q->text, "survey");
560         }
562         echo "<tr class=\"$rowclass rblock\">";
563         if ($oneanswer) {
564             echo "<th scope=\"row\" class=\"optioncell\">";
565             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
566             echo $q->text ."</th>\n";
568             $default = get_accesshide($strdefault);
569             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\" data-survey-default=\"true\" />$default</label></td>";
571             for ($i=1;$i<=$numoptions;$i++) {
572                 $hiddentext = get_accesshide($options[$i-1]);
573                 $id = "q$P" . $q->id . "_$i";
574                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"q$P$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
575             }
576         } else {
577             echo "<th scope=\"row\" class=\"optioncell\">";
578             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
579             $qnum++;
580             echo "<span class=\"preferthat\">$stripreferthat</span> &nbsp; ";
581             echo "<span class=\"option\">$q->text</span></th>\n";
583             $default = get_accesshide($strdefault);
584             echo '<td class="whitecell"><label for="qP'.$q->id.'"><input type="radio" name="qP'.$q->id.'" id="qP'.$q->id.'" value="0" checked="checked" data-survey-default="true" />'.$default.'</label></td>';
587             for ($i=1;$i<=$numoptions;$i++) {
588                 $hiddentext = get_accesshide($options[$i-1]);
589                 $id = "qP" . $q->id . "_$i";
590                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"qP$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
591             }
592             echo "</tr>";
594             echo "<tr class=\"$rowclass rblock\">";
595             echo "<th scope=\"row\" class=\"optioncell\">";
596             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
597             echo "<span class=\"foundthat\">$strifoundthat</span> &nbsp; ";
598             echo "<span class=\"option\">$q->text</span></th>\n";
600             $default = get_accesshide($strdefault);
601             echo '<td class="whitecell"><label for="q'. $q->id .'"><input type="radio" name="q'.$q->id. '" id="q'. $q->id .'" value="0" checked="checked" data-survey-default="true" />'.$default.'</label></td>';
603             for ($i=1;$i<=$numoptions;$i++) {
604                 $hiddentext = get_accesshide($options[$i-1]);
605                 $id = "q" . $q->id . "_$i";
606                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"q$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
607             }
608         }
609         echo "</tr>\n";
610     }
611     echo "</table>";
615 /**
616  * @global object
617  * @global int
618  * @param object $question
619  */
620 function survey_print_single($question) {
621     global $DB, $qnum, $OUTPUT;
623     $rowclass = survey_question_rowclass(0);
625     $qnum++;
627     echo "<br />\n";
628     echo "<table width=\"90%\" cellpadding=\"4\" cellspacing=\"0\">\n";
629     echo "<tr class=\"$rowclass\">";
630     echo "<th scope=\"row\" class=\"optioncell\"><label for=\"q$question->id\"><b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
631     echo "<span class=\"questioncell\">$question->text</span></label></th>\n";
632     echo "<td class=\"questioncell smalltext\">\n";
635     if ($question->type == 0) {           // Plain text field
636         echo "<textarea rows=\"3\" cols=\"30\" class=\"form-control\" name=\"q$question->id\" id=\"q$question->id\">$question->options</textarea>";
638     } else if ($question->type > 0) {     // Choose one of a number
639         $strchoose = get_string("choose");
640         echo "<select name=\"q$question->id\" id=\"q$question->id\" class=\"custom-select\">";
641         echo "<option value=\"0\" selected=\"selected\">$strchoose...</option>";
642         $options = explode( ",", $question->options);
643         foreach ($options as $key => $val) {
644             $key++;
645             echo "<option value=\"$key\">$val</option>";
646         }
647         echo "</select>";
649     } else if ($question->type < 0) {     // Choose several of a number
650         $options = explode( ",", $question->options);
651         echo $OUTPUT->notification("This question type not supported yet");
652     }
654     echo "</td></tr></table>";
658 /**
659  *
660  * @param int $qnum
661  * @return string
662  */
663 function survey_question_rowclass($qnum) {
665     if ($qnum) {
666         return $qnum % 2 ? 'r0' : 'r1';
667     } else {
668         return 'r0';
669     }
672 /**
673  * @global object
674  * @global int
675  * @global int
676  * @param string $url
677  */
678 function survey_print_graph($url) {
679     global $CFG, $SURVEY_GHEIGHT, $SURVEY_GWIDTH;
681     echo "<img class='resultgraph' height=\"$SURVEY_GHEIGHT\" width=\"$SURVEY_GWIDTH\"".
682          " src=\"$CFG->wwwroot/mod/survey/graph.php?$url\" alt=\"".get_string("surveygraph", "survey")."\" />";
685 /**
686  * List the actions that correspond to a view of this module.
687  * This is used by the participation report.
688  *
689  * Note: This is not used by new logging system. Event with
690  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
691  *       be considered as view action.
692  *
693  * @return array
694  */
695 function survey_get_view_actions() {
696     return array('download','view all','view form','view graph','view report');
699 /**
700  * List the actions that correspond to a post of this module.
701  * This is used by the participation report.
702  *
703  * Note: This is not used by new logging system. Event with
704  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
705  *       will be considered as post action.
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 reset course 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_MOD_INTRO
782  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
783  * @uses FEATURE_GRADE_HAS_GRADE
784  * @uses FEATURE_GRADE_OUTCOMES
785  * @param string $feature FEATURE_xx constant for requested feature
786  * @return mixed True if module supports feature, false if not, null if doesn't know
787  */
788 function survey_supports($feature) {
789     switch($feature) {
790         case FEATURE_GROUPS:                  return true;
791         case FEATURE_GROUPINGS:               return true;
792         case FEATURE_MOD_INTRO:               return true;
793         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
794         case FEATURE_COMPLETION_HAS_RULES:    return true;
795         case FEATURE_GRADE_HAS_GRADE:         return false;
796         case FEATURE_GRADE_OUTCOMES:          return false;
797         case FEATURE_BACKUP_MOODLE2:          return true;
798         case FEATURE_SHOW_DESCRIPTION:        return true;
800         default: return null;
801     }
804 /**
805  * This function extends the settings navigation block for the site.
806  *
807  * It is safe to rely on PAGE here as we will only ever be within the module
808  * context when this is called
809  *
810  * @param navigation_node $settings
811  * @param navigation_node $surveynode
812  */
813 function survey_extend_settings_navigation($settings, $surveynode) {
814     global $PAGE;
816     if (has_capability('mod/survey:readresponses', $PAGE->cm->context)) {
817         $responsesnode = $surveynode->add(get_string("responsereports", "survey"));
819         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'summary'));
820         $responsesnode->add(get_string("summary", "survey"), $url);
822         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'scales'));
823         $responsesnode->add(get_string("scales", "survey"), $url);
825         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'questions'));
826         $responsesnode->add(get_string("question", "survey"), $url);
828         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'students'));
829         $responsesnode->add(get_string('participants'), $url);
831         if (has_capability('mod/survey:download', $PAGE->cm->context)) {
832             $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'download'));
833             $surveynode->add(get_string('downloadresults', 'survey'), $url);
834         }
835     }
838 /**
839  * Return a list of page types
840  * @param string $pagetype current page type
841  * @param stdClass $parentcontext Block's parent context
842  * @param stdClass $currentcontext Current context of block
843  */
844 function survey_page_type_list($pagetype, $parentcontext, $currentcontext) {
845     $module_pagetype = array('mod-survey-*'=>get_string('page-mod-survey-x', 'survey'));
846     return $module_pagetype;
849 /**
850  * Mark the activity completed (if required) and trigger the course_module_viewed event.
851  *
852  * @param  stdClass $survey     survey object
853  * @param  stdClass $course     course object
854  * @param  stdClass $cm         course module object
855  * @param  stdClass $context    context object
856  * @param  string $viewed       which page viewed
857  * @since Moodle 3.0
858  */
859 function survey_view($survey, $course, $cm, $context, $viewed) {
861     // Trigger course_module_viewed event.
862     $params = array(
863         'context' => $context,
864         'objectid' => $survey->id,
865         'courseid' => $course->id,
866         'other' => array('viewed' => $viewed)
867     );
869     $event = \mod_survey\event\course_module_viewed::create($params);
870     $event->add_record_snapshot('course_modules', $cm);
871     $event->add_record_snapshot('course', $course);
872     $event->add_record_snapshot('survey', $survey);
873     $event->trigger();
875     // Completion.
876     $completion = new completion_info($course);
877     $completion->set_module_viewed($cm);
880 /**
881  * Helper function for ordering a set of questions by the given ids.
882  *
883  * @param  array $questions     array of questions objects
884  * @param  array $questionorder array of questions ids indicating the correct order
885  * @return array                list of questions ordered
886  * @since Moodle 3.0
887  */
888 function survey_order_questions($questions, $questionorder) {
890     $finalquestions = array();
891     foreach ($questionorder as $qid) {
892         $finalquestions[] = $questions[$qid];
893     }
894     return $finalquestions;
897 /**
898  * Translate the question texts and options.
899  *
900  * @param  stdClass $question question object
901  * @return stdClass question object with all the text fields translated
902  * @since Moodle 3.0
903  */
904 function survey_translate_question($question) {
906     if ($question->text) {
907         $question->text = get_string($question->text, "survey");
908     }
910     if ($question->shorttext) {
911         $question->shorttext = get_string($question->shorttext, "survey");
912     }
914     if ($question->intro) {
915         $question->intro = get_string($question->intro, "survey");
916     }
918     if ($question->options) {
919         $question->options = get_string($question->options, "survey");
920     }
921     return $question;
924 /**
925  * Returns the questions for a survey (ordered).
926  *
927  * @param  stdClass $survey survey object
928  * @return array list of questions ordered
929  * @since Moodle 3.0
930  * @throws  moodle_exception
931  */
932 function survey_get_questions($survey) {
933     global $DB;
935     $questionids = explode(',', $survey->questions);
936     if (! $questions = $DB->get_records_list("survey_questions", "id", $questionids)) {
937         throw new moodle_exception('cannotfindquestion', 'survey');
938     }
940     return survey_order_questions($questions, $questionids);
943 /**
944  * Returns subquestions for a given question (ordered).
945  *
946  * @param  stdClass $question questin object
947  * @return array list of subquestions ordered
948  * @since Moodle 3.0
949  */
950 function survey_get_subquestions($question) {
951     global $DB;
953     $questionids = explode(',', $question->multi);
954     $questions = $DB->get_records_list("survey_questions", "id", $questionids);
956     return survey_order_questions($questions, $questionids);
959 /**
960  * Save the answer for the given survey
961  *
962  * @param  stdClass $survey   a survey object
963  * @param  array $answersrawdata the answers to be saved
964  * @param  stdClass $course   a course object (required for trigger the submitted event)
965  * @param  stdClass $context  a context object (required for trigger the submitted event)
966  * @since Moodle 3.0
967  */
968 function survey_save_answers($survey, $answersrawdata, $course, $context) {
969     global $DB, $USER;
971     $answers = array();
973     // Sort through the data and arrange it.
974     // This is necessary because some of the questions may have two answers, eg Question 1 -> 1 and P1.
975     foreach ($answersrawdata as $key => $val) {
976         if ($key != "userid" && $key != "id") {
977             if (substr($key, 0, 1) == "q") {
978                 $key = clean_param(substr($key, 1), PARAM_ALPHANUM);   // Keep everything but the 'q', number or P number.
979             }
980             if (substr($key, 0, 1) == "P") {
981                 $realkey = (int) substr($key, 1);
982                 $answers[$realkey][1] = $val;
983             } else {
984                 $answers[$key][0] = $val;
985             }
986         }
987     }
989     // Now store the data.
990     $timenow = time();
991     $answerstoinsert = array();
992     foreach ($answers as $key => $val) {
993         if ($key != 'sesskey') {
994             $newdata = new stdClass();
995             $newdata->time = $timenow;
996             $newdata->userid = $USER->id;
997             $newdata->survey = $survey->id;
998             $newdata->question = $key;
999             if (!empty($val[0])) {
1000                 $newdata->answer1 = $val[0];
1001             } else {
1002                 $newdata->answer1 = "";
1003             }
1004             if (!empty($val[1])) {
1005                 $newdata->answer2 = $val[1];
1006             } else {
1007                 $newdata->answer2 = "";
1008             }
1010             $answerstoinsert[] = $newdata;
1011         }
1012     }
1014     if (!empty($answerstoinsert)) {
1015         $DB->insert_records("survey_answers", $answerstoinsert);
1016     }
1018     // Update completion state.
1019     $cm = get_coursemodule_from_instance('survey', $survey->id, $course->id);
1020     $completion = new completion_info($course);
1021     if (isloggedin() && !isguestuser() && $completion->is_enabled($cm) && $survey->completionsubmit) {
1022         $completion->update_state($cm, COMPLETION_COMPLETE);
1023     }
1025     $params = array(
1026         'context' => $context,
1027         'courseid' => $course->id,
1028         'other' => array('surveyid' => $survey->id)
1029     );
1030     $event = \mod_survey\event\response_submitted::create($params);
1031     $event->trigger();
1034 /**
1035  * Obtains the automatic completion state for this survey based on the condition
1036  * in feedback settings.
1037  *
1038  * @param object $course Course
1039  * @param object $cm Course-module
1040  * @param int $userid User ID
1041  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
1042  * @return bool True if completed, false if not, $type if conditions not set.
1043  */
1044 function survey_get_completion_state($course, $cm, $userid, $type) {
1045     global $DB;
1047     // Get survey details.
1048     $survey = $DB->get_record('survey', array('id' => $cm->instance), '*', MUST_EXIST);
1050     // If completion option is enabled, evaluate it and return true/false.
1051     if ($survey->completionsubmit) {
1052         $params = array('userid' => $userid, 'survey' => $survey->id);
1053         return $DB->record_exists('survey_answers', $params);
1054     } else {
1055         // Completion option is not enabled so just return $type.
1056         return $type;
1057     }
1060 /**
1061  * Check if the module has any update that affects the current user since a given time.
1062  *
1063  * @param  cm_info $cm course module data
1064  * @param  int $from the time to check updates from
1065  * @param  array $filter  if we need to check only specific updates
1066  * @return stdClass an object with the different type of areas indicating if they were updated or not
1067  * @since Moodle 3.2
1068  */
1069 function survey_check_updates_since(cm_info $cm, $from, $filter = array()) {
1070     global $DB, $USER;
1072     $updates = new stdClass();
1073     if (!has_capability('mod/survey:participate', $cm->context)) {
1074         return $updates;
1075     }
1076     $updates = course_check_module_updates_since($cm, $from, array(), $filter);
1078     $updates->answers = (object) array('updated' => false);
1079     $select = 'survey = ? AND userid = ? AND time > ?';
1080     $params = array($cm->instance, $USER->id, $from);
1081     $answers = $DB->get_records_select('survey_answers', $select, $params, '', 'id');
1082     if (!empty($answers)) {
1083         $updates->answers->updated = true;
1084         $updates->answers->itemids = array_keys($answers);
1085     }
1087     // Now, teachers should see other students updates.
1088     if (has_capability('mod/survey:readresponses', $cm->context)) {
1089         $select = 'survey = ? AND time > ?';
1090         $params = array($cm->instance, $from);
1092         if (groups_get_activity_groupmode($cm) == SEPARATEGROUPS) {
1093             $groupusers = array_keys(groups_get_activity_shared_group_members($cm));
1094             if (empty($groupusers)) {
1095                 return $updates;
1096             }
1097             list($insql, $inparams) = $DB->get_in_or_equal($groupusers);
1098             $select .= ' AND userid ' . $insql;
1099             $params = array_merge($params, $inparams);
1100         }
1102         $updates->useranswers = (object) array('updated' => false);
1103         $answers = $DB->get_records_select('survey_answers', $select, $params, '', 'id');
1104         if (!empty($answers)) {
1105             $updates->useranswers->updated = true;
1106             $updates->useranswers->itemids = array_keys($answers);
1107         }
1108     }
1109     return $updates;
1112 /**
1113  * Handles creating actions for events.
1114  *
1115  * @param calendar_event $event
1116  * @param \core_calendar\action_factory $factory
1117  * @return \core_calendar\local\event\value_objects\action|\core_calendar\local\interfaces\action_interface|null
1118  */
1119 function mod_survey_core_calendar_provide_event_action(calendar_event $event,
1120                                                       \core_calendar\action_factory $factory) {
1121     $cm = get_fast_modinfo($event->courseid)->instances['survey'][$event->instance];
1122     $context = context_module::instance($cm->id);
1124     if (!has_capability('mod/survey:participate', $context)) {
1125         return null;
1126     }
1128     $course = new stdClass();
1129     $course->id = $event->courseid;
1130     $completion = new \completion_info($course);
1132     $completiondata = $completion->get_data($cm, false);
1134     if ($completiondata->completionstate != COMPLETION_INCOMPLETE) {
1135         return null;
1136     }
1138     return $factory->create_instance(
1139         get_string('view'),
1140         new \moodle_url('/mod/survey/view.php', ['id' => $cm->id]),
1141         1,
1142         true
1143     );