MDL-18910 moving modedit features to modname_supports()
[moodle.git] / mod / survey / lib.php
1 <?php // $Id$
3 // Graph size
4 $SURVEY_GHEIGHT = 500;
5 $SURVEY_GWIDTH  = 900;
7 $SURVEY_QTYPE = array (
8         "-3" => "Virtual Actual and Preferred",
9         "-2" => "Virtual Preferred",
10         "-1" => "Virtual Actual",
11          "0" => "Text",
12          "1" => "Actual",
13          "2" => "Preferred",
14          "3" => "Actual and Preferred",
15         );
18 define("SURVEY_COLLES_ACTUAL",           "1");
19 define("SURVEY_COLLES_PREFERRED",        "2");
20 define("SURVEY_COLLES_PREFERRED_ACTUAL", "3");
21 define("SURVEY_ATTLS",                   "4");
22 define("SURVEY_CIQ",                     "5");
25 // STANDARD FUNCTIONS ////////////////////////////////////////////////////////
27 function survey_add_instance($survey) {
28     global $DB;
29 // Given an object containing all the necessary data, 
30 // (defined by the form in mod_form.php) this function 
31 // will create a new instance and return the id number 
32 // of the new instance.
34     if (!$template = $DB->get_record("survey", array("id"=>$survey->template))) {
35         return 0;
36     }
38     $survey->questions    = $template->questions; 
39     $survey->timecreated  = time();
40     $survey->timemodified = $survey->timecreated;
42     return $DB->insert_record("survey", $survey);
44 }
47 function survey_update_instance($survey) {
48     global $DB;
49 // Given an object containing all the necessary data, 
50 // (defined by the form in mod_form.php) this function 
51 // will update an existing instance with new data.
53     if (!$template = $DB->get_record("survey", array("id"=>$survey->template))) {
54         return 0;
55     }
57     $survey->id           = $survey->instance; 
58     $survey->questions    = $template->questions; 
59     $survey->timemodified = time();
61     return $DB->update_record("survey", $survey);
62 }
64 function survey_delete_instance($id) {
65     global $DB;
66 // Given an ID of an instance of this module, 
67 // this function will permanently delete the instance 
68 // and any data that depends on it.  
70     if (! $survey = $DB->get_record("survey", array("id"=>$id))) {
71         return false;
72     }
74     $result = true;
76     if (! $DB->delete_records("survey_analysis", array("survey"=>$survey->id))) {
77         $result = false;
78     }
80     if (! $DB->delete_records("survey_answers", array("survey"=>$survey->id))) {
81         $result = false;
82     }
84     if (! $DB->delete_records("survey", array("id"=>$survey->id))) {
85         $result = false;
86     }
88     return $result;
89 }
91 function survey_user_outline($course, $user, $mod, $survey) {
92     global $DB;
94     if ($answers = $DB->get_records("survey_answers", array('survey'=>$survey->id, 'userid'=>$user->id))) {
95         $lastanswer = array_pop($answers);
97         $result = new object();
98         $result->info = get_string("done", "survey");
99         $result->time = $lastanswer->time;
100         return $result;
101     }
102     return NULL;
106 function survey_user_complete($course, $user, $mod, $survey) {
107     global $CFG, $DB;
109     if (survey_already_done($survey->id, $user->id)) {
110         if ($survey->template == SURVEY_CIQ) { // print out answers for critical incidents
111             $table = NULL;
112             $table->align = array("left", "left");
114             $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions));
115             $questionorder = explode(",", $survey->questions);
116             
117             foreach ($questionorder as $key=>$val) {
118                 $question = $questions[$val];
119                 $questiontext = get_string($question->shorttext, "survey");
120                 
121                 if ($answer = survey_get_user_answer($survey->id, $question->id, $user->id)) {
122                     $answertext = "$answer->answer1";
123                 } else {
124                     $answertext = "No answer";
125                 }
126                 $table->data[] = array("<b>$questiontext</b>", $answertext);
127             }
128             print_table($table);
129             
130         } else {
131         
132             survey_print_graph("id=$mod->id&amp;sid=$user->id&amp;type=student.png");
133         }
134         
135     } else {
136         print_string("notdone", "survey");
137     }
140 function survey_print_recent_activity($course, $viewfullnames, $timestart) {
141     global $CFG, $DB;
143     $modinfo = get_fast_modinfo($course);
144     $ids = array();
145     foreach ($modinfo->cms as $cm) {
146         if ($cm->modname != 'survey') {
147             continue;
148         }
149         if (!$cm->uservisible) {
150             continue;
151         }
152         $ids[$cm->instance] = $cm->instance;
153     }
155     if (!$ids) {
156         return false;
157     }
159     $slist = implode(',', $ids); // there should not be hundreds of glossaries in one course, right?
161     if (!$rs = $DB->get_recordset_sql("SELECT sa.userid, sa.survey, MAX(sa.time) AS time,
162                                               u.firstname, u.lastname, u.email, u.picture
163                                          FROM {survey_answers} sa
164                                          JOIN {user} u ON u.id = sa.userid
165                                         WHERE sa.survey IN ($slist) AND sa.time > ?
166                                      GROUP BY sa.userid, sa.survey, u.firstname, u.lastname, u.email, u.picture
167                                      ORDER BY time ASC", array($timestart))) {
168         return false;
169     }
171     $surveys = array();
173     foreach ($rs as $survey) {
174         $cm = $modinfo->instances['survey'][$survey->survey];
175         $survey->name = $cm->name;
176         $survey->cmid = $cm->id;
177         $surveys[] = $survey;
178     } 
179     $rs->close();
181     if (!$surveys) {
182         return false;
183     }
185     print_headline(get_string('newsurveyresponses', 'survey').':');
186     foreach ($surveys as $survey) {
187         $url = $CFG->wwwroot.'/mod/survey/view.php?id='.$survey->cmid;
188         print_recent_activity_note($survey->time, $survey, $survey->name, $url, false, $viewfullnames);
189     }
190  
191     return true;
194 function survey_get_participants($surveyid) {
195 //Returns the users with data in one survey
196 //(users with records in survey_analysis and survey_answers, students)
197     global $DB;
199     //Get students from survey_analysis
200     $st_analysis = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
201                                            FROM {user} u, {survey_analysis} a
202                                           WHERE a.survey = ? AND
203                                                 u.id = a.userid", array($surveyid));
204     //Get students from survey_answers
205     $st_answers = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
206                                           FROM {user} u, {survey_answers} a
207                                          WHERE a.survey = ? AND
208                                                u.id = a.userid", array($surveyid));
210     //Add st_answers to st_analysis
211     if ($st_answers) {
212         foreach ($st_answers as $st_answer) {
213             $st_analysis[$st_answer->id] = $st_answer;
214         }
215     }
216     //Return st_analysis array (it contains an array of unique users)
217     return ($st_analysis);
220 // SQL FUNCTIONS ////////////////////////////////////////////////////////
223 function survey_log_info($log) {
224     global $DB;
225     return $DB->get_record_sql("SELECT s.name, u.firstname, u.lastname, u.picture
226                                   FROM {survey} s, {user} u
227                                  WHERE s.id = ?  AND u.id = ?", array($log->info, $log->userid));
230 function survey_get_responses($surveyid, $groupid, $groupingid) {
231     global $DB;
233     $params = array('surveyid'=>$surveyid, 'groupid'=>$groupid, 'groupingid'=>$groupingid); 
235     if ($groupid) {
236         $groupsjoin = "JOIN {groups_members} gm ON u.id = gm.userid AND gm.groupid = :groupid ";
238     } else if ($groupingid) {
239         $groupsjoin = "JOIN {groups_members} gm ON u.id = gm.userid
240                        JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid ";
241     } else {
242         $groupsjoin = "";
243     }
245     return $DB->get_records_sql("SELECT u.id, u.firstname, u.lastname, u.picture, MAX(a.time) as time
246                                    FROM {survey_answers} a
247                                    JOIN {user} u ON a.userid = u.id
248                             $groupsjoin
249                                   WHERE a.survey = :surveyid
250                                GROUP BY u.id, u.firstname, u.lastname, u.picture
251                                ORDER BY time ASC", $params);
254 function survey_get_analysis($survey, $user) {
255     global $DB;
257     return $DB->get_record_sql("SELECT notes 
258                                   FROM {survey_analysis}
259                                  WHERE survey=? AND userid=?", array($survey, $user));
262 function survey_update_analysis($survey, $user, $notes) {
263     global $DB;
265     return $DB->execute("UPDATE {survey_analysis}
266                             SET notes=? 
267                           WHERE survey=? 
268                             AND userid=?", array($notes, $survey, $user));
272 function survey_get_user_answers($surveyid, $questionid, $groupid, $sort="sa.answer1,sa.answer2 ASC") {
273     global $DB;
275     $params = array('surveyid'=>$surveyid, 'questionid'=>$questionid, 'groupid'=>$groupid);
277     if ($groupid) {
278         $groupsql = "AND gm.groupid = :groupid AND u.id = gm.userid";
279     } else {
280         $groupsql = "";
281     }
283     return $DB->get_records_sql("SELECT sa.*,u.firstname,u.lastname,u.picture 
284                                    FROM {survey_answers} sa,  {user} u, {groups_members} gm 
285                                   WHERE sa.survey = :surveyid 
286                                         AND sa.question = :questionid 
287                                         AND u.id = sa.userid $groupsql
288                                ORDER BY $sort", $params);
291 function survey_get_user_answer($surveyid, $questionid, $userid) {
292     global $DB;
294     return $DB->get_record_sql("SELECT sa.* 
295                                   FROM {survey_answers} sa
296                                  WHERE sa.survey = ? 
297                                        AND sa.question = ? 
298                                        AND sa.userid = ?", array($surveyid, $questionid, $userid));
301 // MODULE FUNCTIONS ////////////////////////////////////////////////////////
303 function survey_add_analysis($survey, $user, $notes) {
304     global $DB;
306     $record = new object();
307     $record->survey = $survey;
308     $record->userid = $user;
309     $record->notes = $notes;
311     return $DB->insert_record("survey_analysis", $record, false);
314 function survey_already_done($survey, $user) {
315     global $DB;
317     return $DB->record_exists("survey_answers", array("survey"=>$survey, "userid"=>$user));
320 function survey_count_responses($surveyid, $groupid, $groupingid) {
321     if ($responses = survey_get_responses($surveyid, $groupid, $groupingid)) {
322         return count($responses);
323     } else {
324         return 0;
325     }
329 function survey_print_all_responses($cmid, $results, $courseid) {
331     $table = new object();
332     $table->head  = array ("", get_string("name"),  get_string("time"));
333     $table->align = array ("", "left", "left");
334     $table->size = array (35, "", "" );
336     foreach ($results as $a) {
337         $table->data[] = array(print_user_picture($a->id, $courseid, $a->picture, false, true, false),
338                "<a href=\"report.php?action=student&amp;student=$a->id&amp;id=$cmid\">".fullname($a)."</a>", 
339                userdate($a->time));
340     }
342     print_table($table);
346 function survey_get_template_name($templateid) {
347     global $DB;
349     if ($templateid) {
350         if ($ss = $DB->get_record("surveys", array("id"=>$templateid))) {
351             return $ss->name;
352         }
353     } else {
354         return "";
355     }
360 function survey_shorten_name ($name, $numwords) {
361     $words = explode(" ", $name);
362     for ($i=0; $i < $numwords; $i++) {
363         $output .= $words[$i]." ";
364     }
365     return $output;
370 function survey_print_multi($question) {
371     global $USER, $DB, $qnum, $checklist, $DB;
373     $stripreferthat = get_string("ipreferthat", "survey");
374     $strifoundthat = get_string("ifoundthat", "survey");
375     $strdefault    = get_string('default');
376     $strresponses  = get_string('responses', 'survey');
378     print_heading($question->text, null, 3, 'questiontext');
379     echo "\n<table width=\"90%\" cellpadding=\"4\" cellspacing=\"1\" border=\"0\">";
381     $options = explode( ",", $question->options);
382     $numoptions = count($options);
384     $oneanswer = ($question->type == 1 || $question->type == 2) ? true : false;
385     if ($question->type == 2) {
386         $P = "P";
387     } else {
388         $P = "";
389     }
391     echo "<tr class=\"smalltext\"><th scope=\"row\">$strresponses</th>";
392     while (list ($key, $val) = each ($options)) {
393         echo "<th scope=\"col\" class=\"hresponse\">$val</th>\n";
394     }
395     echo "<th>&nbsp;</th></tr>\n";
397     if ($oneanswer) {
398         echo "<tr><th scope=\"col\" colspan=\"6\">$question->intro</th></tr>\n";
399     } else {
400         echo "<tr><th scope=\"col\" colspan=\"7\">$question->intro</th></tr>\n"; 
401     }
403     $subquestions = $DB->get_records_list("survey_questions", "id", explode(',', $question->multi));
405     foreach ($subquestions as $q) {
406         $qnum++;
407         $rowclass = survey_question_rowclass($qnum);
408         if ($q->text) {
409             $q->text = get_string($q->text, "survey");
410         }
412         echo "<tr class=\"$rowclass rblock\">";
413         if ($oneanswer) {
415             echo "<th scope=\"row\" class=\"optioncell\">";
416             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
417             echo $q->text ."</th>\n";
418             for ($i=1;$i<=$numoptions;$i++) {
419                 $hiddentext = get_accesshide($options[$i-1]);
420                 $id = "q$P" . $q->id . "_$i";
421                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"q$P$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
422             }
423             $default = get_accesshide($strdefault, 'label', '', "for=\"q$P$q->id\"");
424             echo "<td class=\"whitecell\"><input type=\"radio\" name=\"q$P$q->id\" id=\"q$P" . $q->id . "_D\" value=\"0\" checked=\"checked\" />$default</td>";
425             $checklist["q$P$q->id"] = $numoptions;
426         
427         } else { 
428             // yu : fix for MDL-7501, possibly need to use user flag as this is quite ugly.
429             echo "<th scope=\"row\" class=\"optioncell\">";
430             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
431             $qnum++;
432             echo "<span class=\"preferthat smalltext\">$stripreferthat</span> &nbsp; ";
433             echo "<span class=\"option\">$q->text</span></th>\n";
434             for ($i=1;$i<=$numoptions;$i++) {
435                 $hiddentext = get_accesshide($options[$i-1]);
436                 $id = "qP" . $q->id . "_$i";
437                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"qP$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
438             }
439             $default = get_accesshide($strdefault, 'label', '', "for=\"qP$q->id\"");
440             echo "<td><input type=\"radio\" name=\"qP$q->id\" id=\"qP$q->id\" value=\"0\" checked=\"checked\" />$default</td>";
441             echo "</tr>";
443             echo "<tr class=\"$rowclass rblock\">";
444             echo "<th scope=\"row\" class=\"optioncell\">";
445             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
446             echo "<span class=\"foundthat smalltext\">$strifoundthat</span> &nbsp; ";
447             echo "<span class=\"option\">$q->text</span></th>\n";
448             for ($i=1;$i<=$numoptions;$i++) {
449                 $hiddentext = get_accesshide($options[$i-1]);
450                 $id = "q" . $q->id . "_$i";
451                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"q$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
452             }
453             $default = get_accesshide($strdefault, 'label', '', "for=\"q$q->id\"");
454             echo "<td class=\"buttoncell\"><input type=\"radio\" name=\"q$q->id\" id=\"q$q->id\" value=\"0\" checked=\"checked\" />$default</td>";
455             $checklist["qP$q->id"] = $numoptions;
456             $checklist["q$q->id"] = $numoptions;            
457         }
458         echo "</tr>\n";
459     }
460     echo "</table>";
465 function survey_print_single($question) {
466     global $DB, $qnum;
468     $rowclass = survey_question_rowclass(0);
470     $qnum++;
472     echo "<br />\n";
473     echo "<table width=\"90%\" cellpadding=\"4\" cellspacing=\"0\">\n";
474     echo "<tr class=\"$rowclass\">";
475     echo "<th scope=\"row\" class=\"optioncell\"><label for=\"q$question->id\"><b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
476     echo "<span class=\"questioncell\">$question->text</span></label></th>\n";
477     echo "<td class=\"questioncell smalltext\">\n";
480     if ($question->type == 0) {           // Plain text field
481         echo "<textarea rows=\"3\" cols=\"30\" name=\"q$question->id\" id=\"q$question->id\">$question->options</textarea>";
483     } else if ($question->type > 0) {     // Choose one of a number
484         $strchoose = get_string("choose");
485         echo "<select name=\"q$question->id\" id=\"q$question->id\">";
486         echo "<option value=\"0\" selected=\"selected\">$strchoose...</option>";
487         $options = explode( ",", $question->options);
488         foreach ($options as $key => $val) {
489             $key++;
490             echo "<option value=\"$key\">$val</option>";
491         }
492         echo "</select>";
494     } else if ($question->type < 0) {     // Choose several of a number
495         $options = explode( ",", $question->options);
496         notify("This question type not supported yet");
497     }
499     echo "</td></tr></table>";
503 function survey_question_rowclass($qnum) {
505     if ($qnum) {
506         return $qnum % 2 ? 'r0' : 'r1';
507     } else {
508         return 'r0';
509     }
512 function survey_print_graph($url) {
513     global $CFG, $SURVEY_GHEIGHT, $SURVEY_GWIDTH;
515     if (empty($CFG->gdversion)) {
516         echo "(".get_string("gdneed").")";
518     } else {
519         echo "<img class='resultgraph' height=\"$SURVEY_GHEIGHT\" width=\"$SURVEY_GWIDTH\"".
520              " src=\"$CFG->wwwroot/mod/survey/graph.php?$url\" alt=\"".get_string("surveygraph", "survey")."\" />";
521     }
524 function survey_get_view_actions() {
525     return array('download','view all','view form','view graph','view report');
528 function survey_get_post_actions() {
529     return array('submit');
533 /**
534  * Implementation of the function for printing the form elements that control
535  * whether the course reset functionality affects the survey.
536  * @param $mform form passed by reference
537  */
538 function survey_reset_course_form_definition(&$mform) {
539     $mform->addElement('header', 'surveyheader', get_string('modulenameplural', 'survey'));
540     $mform->addElement('checkbox', 'reset_survey_answers', get_string('deleteallanswers','survey'));
541     $mform->addElement('checkbox', 'reset_survey_analysis', get_string('deleteanalysis','survey'));
542     $mform->disabledIf('reset_survey_analysis', 'reset_survey_answers', 'checked');
545 /**
546  * Course reset form defaults.
547  */
548 function survey_reset_course_form_defaults($course) {
549     return array('reset_survey_answers'=>1, 'reset_survey_analysis'=>1);
552 /**
553  * Actual implementation of the rest coures functionality, delete all the
554  * survey responses for course $data->courseid.
555  * @param $data the data submitted from the reset course.
556  * @return array status array
557  */
558 function survey_reset_userdata($data) {
559     global $DB;
561     $componentstr = get_string('modulenameplural', 'survey');
562     $status = array();
564     $surveyssql = "SELECT ch.id
565                      FROM {survey} ch
566                     WHERE ch.course=?";
567     $params = array($data->courseid);
569     if (!empty($data->reset_survey_answers)) {
570         $DB->delete_records_select('survey_answers', "survey IN ($surveyssql)", $params);
571         $DB->delete_records_select('survey_analysis', "survey IN ($surveyssql)", $params);
572         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallanswers', 'survey'), 'error'=>false);
573     }
575     if (!empty($data->reset_survey_analysis)) {
576         $DB->delete_records_select('survey_analysis', "survey IN ($surveyssql)", $params);
577         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallanswers', 'survey'), 'error'=>false);
578     }
580     // no date shifting
581     return $status;
584 /**
585  * Returns all other caps used in module
586  */
587 function survey_get_extra_capabilities() {
588     return array('moodle/site:accessallgroups');
591 /**
592  * @param string $feature FEATURE_xx constant for requested feature
593  * @return mixed True if module supports feature, null if doesn't know
594  */
595 function survey_supports($feature) {
596     switch($feature) {
597         case FEATURE_GROUPS:                  return true;
598         case FEATURE_GROUPINGS:               return true;
599         case FEATURE_GROUPMEMBERSONLY:        return true;
600         case FEATURE_MODEDIT_INTRO_EDITOR:    return true;
601         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
602         case FEATURE_GRADE_HAS_GRADE:         return true;
603         case FEATURE_GRADE_OUTCOMES:          return true;
605         default: return null;
606     }