b3c8d9f3058ac66026a2c5d9683f1ca005e10628
[moodle.git] / mod / choice / 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-choice
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 /** @global int $CHOICE_COLUMN_HEIGHT */
25 global $CHOICE_COLUMN_HEIGHT;
26 $CHOICE_COLUMN_HEIGHT = 300;
28 /** @global int $CHOICE_COLUMN_WIDTH */
29 global $CHOICE_COLUMN_WIDTH;
30 $CHOICE_COLUMN_WIDTH = 300;
32 define('CHOICE_PUBLISH_ANONYMOUS', '0');
33 define('CHOICE_PUBLISH_NAMES',     '1');
35 define('CHOICE_SHOWRESULTS_NOT',          '0');
36 define('CHOICE_SHOWRESULTS_AFTER_ANSWER', '1');
37 define('CHOICE_SHOWRESULTS_AFTER_CLOSE',  '2');
38 define('CHOICE_SHOWRESULTS_ALWAYS',       '3');
40 define('CHOICE_DISPLAY_HORIZONTAL',  '0');
41 define('CHOICE_DISPLAY_VERTICAL',    '1');
43 /** @global array $CHOICE_PUBLISH */
44 global $CHOICE_PUBLISH;
45 $CHOICE_PUBLISH = array (CHOICE_PUBLISH_ANONYMOUS  => get_string('publishanonymous', 'choice'),
46                          CHOICE_PUBLISH_NAMES      => get_string('publishnames', 'choice'));
48 /** @global array $CHOICE_SHOWRESULTS */
49 global $CHOICE_SHOWRESULTS;
50 $CHOICE_SHOWRESULTS = array (CHOICE_SHOWRESULTS_NOT          => get_string('publishnot', 'choice'),
51                          CHOICE_SHOWRESULTS_AFTER_ANSWER => get_string('publishafteranswer', 'choice'),
52                          CHOICE_SHOWRESULTS_AFTER_CLOSE  => get_string('publishafterclose', 'choice'),
53                          CHOICE_SHOWRESULTS_ALWAYS       => get_string('publishalways', 'choice'));
55 /** @global array $CHOICE_DISPLAY */
56 global $CHOICE_DISPLAY;
57 $CHOICE_DISPLAY = array (CHOICE_DISPLAY_HORIZONTAL   => get_string('displayhorizontal', 'choice'),
58                          CHOICE_DISPLAY_VERTICAL     => get_string('displayvertical','choice'));
60 /// Standard functions /////////////////////////////////////////////////////////
62 /**
63  * @global object
64  * @param object $course
65  * @param object $user
66  * @param object $mod
67  * @param object $choice
68  * @return object|null
69  */
70 function choice_user_outline($course, $user, $mod, $choice) {
71     global $DB;
72     if ($answer = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id))) {
73         $result = new stdClass();
74         $result->info = "'".format_string(choice_get_option_text($choice, $answer->optionid))."'";
75         $result->time = $answer->timemodified;
76         return $result;
77     }
78     return NULL;
79 }
81 /**
82  * @global object
83  * @param object $course
84  * @param object $user
85  * @param object $mod
86  * @param object $choice
87  * @return string|void
88  */
89 function choice_user_complete($course, $user, $mod, $choice) {
90     global $DB;
91     if ($answer = $DB->get_record('choice_answers', array("choiceid" => $choice->id, "userid" => $user->id))) {
92         $result = new stdClass();
93         $result->info = "'".format_string(choice_get_option_text($choice, $answer->optionid))."'";
94         $result->time = $answer->timemodified;
95         echo get_string("answered", "choice").": $result->info. ".get_string("updated", '', userdate($result->time));
96     } else {
97         print_string("notanswered", "choice");
98     }
99 }
101 /**
102  * Given an object containing all the necessary data,
103  * (defined by the form in mod_form.php) this function
104  * will create a new instance and return the id number
105  * of the new instance.
106  *
107  * @global object
108  * @param object $choice
109  * @return int
110  */
111 function choice_add_instance($choice) {
112     global $DB;
114     $choice->timemodified = time();
116     if (empty($choice->timerestrict)) {
117         $choice->timeopen = 0;
118         $choice->timeclose = 0;
119     }
121     //insert answers
122     $choice->id = $DB->insert_record("choice", $choice);
123     foreach ($choice->option as $key => $value) {
124         $value = trim($value);
125         if (isset($value) && $value <> '') {
126             $option = new stdClass();
127             $option->text = $value;
128             $option->choiceid = $choice->id;
129             if (isset($choice->limit[$key])) {
130                 $option->maxanswers = $choice->limit[$key];
131             }
132             $option->timemodified = time();
133             $DB->insert_record("choice_options", $option);
134         }
135     }
137     return $choice->id;
140 /**
141  * Given an object containing all the necessary data,
142  * (defined by the form in mod_form.php) this function
143  * will update an existing instance with new data.
144  *
145  * @global object
146  * @param object $choice
147  * @return bool
148  */
149 function choice_update_instance($choice) {
150     global $DB;
152     $choice->id = $choice->instance;
153     $choice->timemodified = time();
156     if (empty($choice->timerestrict)) {
157         $choice->timeopen = 0;
158         $choice->timeclose = 0;
159     }
161     //update, delete or insert answers
162     foreach ($choice->option as $key => $value) {
163         $value = trim($value);
164         $option = new stdClass();
165         $option->text = $value;
166         $option->choiceid = $choice->id;
167         if (isset($choice->limit[$key])) {
168             $option->maxanswers = $choice->limit[$key];
169         }
170         $option->timemodified = time();
171         if (isset($choice->optionid[$key]) && !empty($choice->optionid[$key])){//existing choice record
172             $option->id=$choice->optionid[$key];
173             if (isset($value) && $value <> '') {
174                 $DB->update_record("choice_options", $option);
175             } else { //empty old option - needs to be deleted.
176                 $DB->delete_records("choice_options", array("id"=>$option->id));
177             }
178         } else {
179             if (isset($value) && $value <> '') {
180                 $DB->insert_record("choice_options", $option);
181             }
182         }
183     }
185     return $DB->update_record('choice', $choice);
189 /**
190  * @global object
191  * @param object $choice
192  * @param object $user
193  * @param object $coursemodule
194  * @param array $allresponses
195  * @return array
196  */
197 function choice_prepare_options($choice, $user, $coursemodule, $allresponses) {
198     global $DB;
200     $cdisplay = array('options'=>array());
202     $cdisplay['limitanswers'] = true;
203     $context = get_context_instance(CONTEXT_MODULE, $coursemodule->id);
205     foreach ($choice->option as $optionid => $text) {
206         if (isset($text)) { //make sure there are no dud entries in the db with blank text values.
207             $option = new stdClass;
208             $option->attributes = new stdClass;
209             $option->attributes->value = $optionid;
210             $option->text = $text;
211             $option->maxanswers = $choice->maxanswers[$optionid];
212             $option->displaylayout = $choice->display;
214             if (isset($allresponses[$optionid])) {
215                 $option->countanswers = count($allresponses[$optionid]);
216             } else {
217                 $option->countanswers = 0;
218             }
219             if ($DB->record_exists('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id, 'optionid' => $optionid))) {
220                 $option->attributes->checked = true;
221             }
222             if ( $choice->limitanswers && ($option->countanswers >= $option->maxanswers) && empty($option->attributes->checked)) {
223                 $option->attributes->disabled = true;
224                 }
225             $cdisplay['options'][] = $option;
226             }
227         }
229     $cdisplay['hascapability'] = is_enrolled($context, NULL, 'mod/choice:choose'); //only enrolled users are allowed to make a choice
231     if ($choice->allowupdate && $DB->record_exists('choice_answers', array('choiceid'=> $choice->id, 'userid'=> $user->id))) {
232         $cdisplay['allowupdate'] = true;
233                 }
235     return $cdisplay;
236                     }
238 /**
239  * @global object
240  * @param int $formanswer
241  * @param object $choice
242  * @param int $userid
243  * @param object $course Course object
244  * @param object $cm
245  */
246 function choice_user_submit_response($formanswer, $choice, $userid, $course, $cm) {
247     global $DB;
248     $current = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'userid' => $userid));
249     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
251     $countanswers=0;
252     if($choice->limitanswers) {
253         // Find out whether groups are being used and enabled
254         if (groups_get_activity_groupmode($cm) > 0) {
255             $currentgroup = groups_get_activity_group($cm);
256         } else {
257             $currentgroup = 0;
258         }
259         if($currentgroup) {
260             // If groups are being used, retrieve responses only for users in
261             // current group
262             global $CFG;
263             $answers = $DB->get_records_sql("
264 SELECT
265     ca.*
266 FROM
267     {choice_answers} ca
268     INNER JOIN {groups_members} gm ON ca.userid=gm.userid
269 WHERE
270     optionid=?
271     AND gm.groupid=?", array($formanswer, $currentgroup));
272         } else {
273             // Groups are not used, retrieve all answers for this option ID
274             $answers = $DB->get_records("choice_answers", array("optionid" => $formanswer));
275         }
277         if ($answers) {
278             foreach ($answers as $a) { //only return enrolled users.
279                 if (is_enrolled($context, $a->userid, 'mod/choice:choose')) {
280                     $countanswers++;
281                 }
282             }
283         }
284         $maxans = $choice->maxanswers[$formanswer];
285     }
287     if (!($choice->limitanswers && ($countanswers >= $maxans) )) {
288         if ($current) {
290             $newanswer = $current;
291             $newanswer->optionid = $formanswer;
292             $newanswer->timemodified = time();
293             $DB->update_record("choice_answers", $newanswer);
294             add_to_log($course->id, "choice", "choose again", "view.php?id=$cm->id", $choice->id, $cm->id);
295         } else {
296             $newanswer = NULL;
297             $newanswer->choiceid = $choice->id;
298             $newanswer->userid = $userid;
299             $newanswer->optionid = $formanswer;
300             $newanswer->timemodified = time();
301             $DB->insert_record("choice_answers", $newanswer);
303             // Update completion state
304             $completion = new completion_info($course);
305             if ($completion->is_enabled($cm) && $choice->completionsubmit) {
306                 $completion->update_state($cm, COMPLETION_COMPLETE);
307             }
308             add_to_log($course->id, "choice", "choose", "view.php?id=$cm->id", $choice->id, $cm->id);
309         }
310     } else {
311         if (!($current->optionid==$formanswer)) { //check to see if current choice already selected - if not display error
312             print_error('choicefull', 'choice');
313         }
314     }
317 /**
318  * @param array $user
319  * @param object $cm
320  * @return void Output is echo'd
321  */
322 function choice_show_reportlink($user, $cm) {
323     $responsecount =0;
324     foreach($user as $optionid => $userlist) {
325         if ($optionid) {
326             $responsecount += count($userlist);
327         }
328     }
330     echo '<div class="reportlink">';
331     echo "<a href=\"report.php?id=$cm->id\">".get_string("viewallresponses", "choice", $responsecount)."</a>";
332     echo '</div>';
335 /**
336  * @global object
337  * @param object $choice
338  * @param object $course
339  * @param object $coursemodule
340  * @param array $allresponses
342  *  * @param bool $allresponses
343  * @return object
344  */
345 function prepare_choice_show_results($choice, $course, $cm, $allresponses, $forcepublish=false) {
346     global $CFG, $CHOICE_COLUMN_HEIGHT, $FULLSCRIPT, $PAGE, $OUTPUT, $DB;
348     $display = clone($choice);
349     $display->coursemoduleid = $cm->id;
350     $display->courseid = $course->id;
352     //overwrite options value;
353     $display->options = array();
354     $totaluser = 0;
355     foreach ($choice->option as $optionid => $optiontext) {
356         $display->options[$optionid] = new stdClass;
357         $display->options[$optionid]->text = $optiontext;
358         $display->options[$optionid]->maxanswer = $choice->maxanswers[$optionid];
360         if (array_key_exists($optionid, $allresponses)) {
361             $display->options[$optionid]->user = $allresponses[$optionid]; //->user;
362             $totaluser += count($allresponses[$optionid]);
363         }
364     }
365     unset($display->option);
366     unset($display->maxanswers);
368     $display->numberofuser = $totaluser;
369     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
370     $display->viewresponsecapability = has_capability('mod/choice:readresponses', $context);
371     $display->deleterepsonsecapability = has_capability('mod/choice:deleteresponses',$context);
372     $display->fullnamecapability = has_capability('moodle/site:viewfullnames', $context);
374     if (empty($allresponses)) {
375         echo $OUTPUT->heading(get_string("nousersyet"));
376         return false;
377     }
380     $totalresponsecount = 0;
381     foreach ($allresponses as $optionid => $userlist) {
382         if ($choice->showunanswered || $optionid) {
383             $totalresponsecount += count($userlist);
384         }
385     }
387     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
389     $hascapfullnames = has_capability('moodle/site:viewfullnames', $context);
391     $viewresponses = has_capability('mod/choice:readresponses', $context);
392     switch ($forcepublish) {
393         case CHOICE_PUBLISH_NAMES:
394             echo '<div id="tablecontainer">';
395             if ($viewresponses) {
396                 echo '<form id="attemptsform" method="post" action="'.$FULLSCRIPT.'" onsubmit="var menu = document.getElementById(\'menuaction\'); return (menu.options[menu.selectedIndex].value == \'delete\' ? \''.addslashes_js(get_string('deleteattemptcheck','quiz')).'\' : true);">';
397                 echo '<div>';
398                 echo '<input type="hidden" name="id" value="'.$cm->id.'" />';
399                 echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
400                 echo '<input type="hidden" name="mode" value="overview" />';
401             }
403             echo "<table cellpadding=\"5\" cellspacing=\"10\" class=\"results names\">";
404             echo "<tr>";
406             $columncount = array(); // number of votes in each column
407             if ($choice->showunanswered) {
408                 $columncount[0] = 0;
409                 echo "<th class=\"col0 header\" scope=\"col\">";
410                 print_string('notanswered', 'choice');
411                 echo "</th>";
412             }
413             $count = 1;
414             foreach ($choice->option as $optionid => $optiontext) {
415                 $columncount[$optionid] = 0; // init counters
416                 echo "<th class=\"col$count header\" scope=\"col\">";
417                 echo format_string($optiontext);
418                 echo "</th>";
419                 $count++;
420             }
421             echo "</tr><tr>";
423             if ($choice->showunanswered) {
424                 echo "<td class=\"col$count data\" >";
425                 // added empty row so that when the next iteration is empty,
426                 // we do not get <table></table> error from w3c validator
427                 // MDL-7861
428                 echo "<table class=\"choiceresponse\"><tr><td></td></tr>";
429                 if (!empty($allresponses[0])) {
430                     foreach ($allresponses[0] as $user) {
431                         echo "<tr>";
432                         echo "<td class=\"picture\">";
433                         echo $OUTPUT->user_picture($user, array('courseid'=>$course->id));
434                         echo "</td><td class=\"fullname\">";
435                         echo "<a href=\"$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">";
436                         echo fullname($user, $hascapfullnames);
437                         echo "</a>";
438                         echo "</td></tr>";
439                     }
440                 }
441                 echo "</table></td>";
442             }
443             $count = 1;
444             foreach ($choice->option as $optionid => $optiontext) {
445                     echo '<td class="col'.$count.' data" >';
447                     // added empty row so that when the next iteration is empty,
448                     // we do not get <table></table> error from w3c validator
449                     // MDL-7861
450                     echo '<table class="choiceresponse"><tr><td></td></tr>';
451                     if (isset($allresponses[$optionid])) {
452                         foreach ($allresponses[$optionid] as $user) {
453                             $columncount[$optionid] += 1;
454                             echo '<tr><td class="attemptcell">';
455                             if ($viewresponses and has_capability('mod/choice:deleteresponses',$context)) {
456                                 echo '<input type="checkbox" name="attemptid[]" value="'. $user->id. '" />';
457                             }
458                             echo '</td><td class="picture">';
459                             echo $OUTPUT->user_picture($user, array('courseid'=>$course->id));
460                             echo '</td><td class="fullname">';
461                             echo "<a href=\"$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">";
462                             echo fullname($user, $hascapfullnames);
463                             echo '</a>';
464                             echo '</td></tr>';
465                        }
466                     }
467                     $count++;
468                     echo '</table></td>';
469             }
470             echo "</tr><tr>";
471             $count = 1;
473             if ($choice->showunanswered) {
474                 echo "<td></td>";
475             }
477             foreach ($choice->option as $optionid => $optiontext) {
478                 echo "<td align=\"center\" class=\"col$count count\">";
479                 if ($choice->limitanswers) {
480                     echo get_string("taken", "choice").":";
481                     echo $columncount[$optionid];
482                     echo "<br/>";
483                     echo get_string("limit", "choice").":";
484                     echo $choice->maxanswers[$optionid];
485                 } else {
486                     if (isset($columncount[$optionid])) {
487                         echo $columncount[$optionid];
488                     }
489                 }
490                 echo "</td>";
491                 $count++;
492             }
493             echo "</tr>";
495             /// Print "Select all" etc.
496             if ($viewresponses and has_capability('mod/choice:deleteresponses',$context)) {
497                 echo '<tr><td></td><td>';
498                 echo '<a href="javascript:select_all_in(\'DIV\',null,\'tablecontainer\');">'.get_string('selectall').'</a> / ';
499                 echo '<a href="javascript:deselect_all_in(\'DIV\',null,\'tablecontainer\');">'.get_string('deselectall').'</a> ';
500                 echo '&nbsp;&nbsp;';
501                 echo html_writer::label(get_string('withselected', 'choice'), 'menuaction');
502                 echo html_writer::select(array('delete' => get_string('delete')), 'action', '', array(''=>get_string('withselectedusers')), array('id'=>'menuaction'));
503                 $PAGE->requires->js_init_call('M.util.init_select_autosubmit', array('attemptsform', 'menuaction', ''));
504                 echo '<noscript id="noscriptmenuaction" style="display:inline">';
505                 echo '<div>';
506                 echo '<input type="submit" value="'.get_string('go').'" /></div></noscript>';
507                 echo '</td><td></td></tr>';
508             }
510             echo "</table></div>";
511             if ($viewresponses) {
512                 echo "</form></div>";
513             }
514             break;
515     }
516     return $display;
519 /**
520  * @global object
521  * @param array $attemptids
522  * @param object $choice Choice main table row
523  * @param object $cm Course-module object
524  * @param object $course Course object
525  * @return bool
526  */
527 function choice_delete_responses($attemptids, $choice, $cm, $course) {
528     global $DB;
529     if(!is_array($attemptids) || empty($attemptids)) {
530         return false;
531     }
533     foreach($attemptids as $num => $attemptid) {
534         if(empty($attemptid)) {
535             unset($attemptids[$num]);
536         }
537     }
539     $completion = new completion_info($course);
540     foreach($attemptids as $attemptid) {
541         if ($todelete = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'userid' => $attemptid))) {
542             $DB->delete_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $attemptid));
543             // Update completion state
544             if ($completion->is_enabled($cm) && $choice->completionsubmit) {
545                 $completion->update_state($cm, COMPLETION_INCOMPLETE, $attemptid);
546             }
547         }
548     }
549     return true;
553 /**
554  * Given an ID of an instance of this module,
555  * this function will permanently delete the instance
556  * and any data that depends on it.
557  *
558  * @global object
559  * @param int $id
560  * @return bool
561  */
562 function choice_delete_instance($id) {
563     global $DB;
565     if (! $choice = $DB->get_record("choice", array("id"=>"$id"))) {
566         return false;
567     }
569     $result = true;
571     if (! $DB->delete_records("choice_answers", array("choiceid"=>"$choice->id"))) {
572         $result = false;
573     }
575     if (! $DB->delete_records("choice_options", array("choiceid"=>"$choice->id"))) {
576         $result = false;
577     }
579     if (! $DB->delete_records("choice", array("id"=>"$choice->id"))) {
580         $result = false;
581     }
583     return $result;
586 /**
587  * Returns the users with data in one choice
588  * (users with records in choice_responses, students)
589  *
590  * @param int $choiceid
591  * @return array
592  */
593 function choice_get_participants($choiceid) {
594     global $DB;
596     //Get students
597     $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
598                                  FROM {user} u,
599                                       {choice_answers} a
600                                  WHERE a.choiceid = ? AND
601                                        u.id = a.userid", array($choiceid));
603     //Return students array (it contains an array of unique users)
604     return ($students);
607 /**
608  * Returns text string which is the answer that matches the id
609  *
610  * @global object
611  * @param object $choice
612  * @param int $id
613  * @return string
614  */
615 function choice_get_option_text($choice, $id) {
616     global $DB;
618     if ($result = $DB->get_record("choice_options", array("id" => $id))) {
619         return $result->text;
620     } else {
621         return get_string("notanswered", "choice");
622     }
625 /**
626  * Gets a full choice record
627  *
628  * @global object
629  * @param int $choiceid
630  * @return object|bool The choice or false
631  */
632 function choice_get_choice($choiceid) {
633     global $DB;
635     if ($choice = $DB->get_record("choice", array("id" => $choiceid))) {
636         if ($options = $DB->get_records("choice_options", array("choiceid" => $choiceid), "id")) {
637             foreach ($options as $option) {
638                 $choice->option[$option->id] = $option->text;
639                 $choice->maxanswers[$option->id] = $option->maxanswers;
640             }
641             return $choice;
642         }
643     }
644     return false;
647 /**
648  * @return array
649  */
650 function choice_get_view_actions() {
651     return array('view','view all','report');
654 /**
655  * @return array
656  */
657 function choice_get_post_actions() {
658     return array('choose','choose again');
662 /**
663  * Implementation of the function for printing the form elements that control
664  * whether the course reset functionality affects the choice.
665  *
666  * @param object $mform form passed by reference
667  */
668 function choice_reset_course_form_definition(&$mform) {
669     $mform->addElement('header', 'choiceheader', get_string('modulenameplural', 'choice'));
670     $mform->addElement('advcheckbox', 'reset_choice', get_string('removeresponses','choice'));
673 /**
674  * Course reset form defaults.
675  *
676  * @return array
677  */
678 function choice_reset_course_form_defaults($course) {
679     return array('reset_choice'=>1);
682 /**
683  * Actual implementation of the reset course functionality, delete all the
684  * choice responses for course $data->courseid.
685  *
686  * @global object
687  * @global object
688  * @param object $data the data submitted from the reset course.
689  * @return array status array
690  */
691 function choice_reset_userdata($data) {
692     global $CFG, $DB;
694     $componentstr = get_string('modulenameplural', 'choice');
695     $status = array();
697     if (!empty($data->reset_choice)) {
698         $choicessql = "SELECT ch.id
699                        FROM {choice} ch
700                        WHERE ch.course=?";
702         $DB->delete_records_select('choice_answers', "choiceid IN ($choicessql)", array($data->courseid));
703         $status[] = array('component'=>$componentstr, 'item'=>get_string('removeresponses', 'choice'), 'error'=>false);
704     }
706     /// updating dates - shift may be negative too
707     if ($data->timeshift) {
708         shift_course_mod_dates('choice', array('timeopen', 'timeclose'), $data->timeshift, $data->courseid);
709         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
710     }
712     return $status;
715 /**
716  * @global object
717  * @global object
718  * @global object
719  * @uses CONTEXT_MODULE
720  * @param object $choice
721  * @param object $cm
722  * @param int $groupmode
723  * @return array
724  */
725 function choice_get_response_data($choice, $cm, $groupmode) {
726     global $CFG, $USER, $DB;
728     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
730 /// Get the current group
731     if ($groupmode > 0) {
732         $currentgroup = groups_get_activity_group($cm);
733     } else {
734         $currentgroup = 0;
735     }
737 /// Initialise the returned array, which is a matrix:  $allresponses[responseid][userid] = responseobject
738     $allresponses = array();
740 /// First get all the users who have access here
741 /// To start with we assume they are all "unanswered" then move them later
742     $allresponses[0] = get_enrolled_users($context, 'mod/choice:choose', $currentgroup, user_picture::fields('u', array('idnumber')), 'u.lastname ASC,u.firstname ASC');
744 /// Get all the recorded responses for this choice
745     $rawresponses = $DB->get_records('choice_answers', array('choiceid' => $choice->id));
747 /// Use the responses to move users into the correct column
749     if ($rawresponses) {
750         foreach ($rawresponses as $response) {
751             if (isset($allresponses[0][$response->userid])) {   // This person is enrolled and in correct group
752                 $allresponses[0][$response->userid]->timemodified = $response->timemodified;
753                 $allresponses[$response->optionid][$response->userid] = clone($allresponses[0][$response->userid]);
754                 unset($allresponses[0][$response->userid]);   // Remove from unanswered column
755             }
756         }
757     }
758     return $allresponses;
761 /**
762  * Returns all other caps used in module
763  *
764  * @return array
765  */
766 function choice_get_extra_capabilities() {
767     return array('moodle/site:accessallgroups');
770 /**
771  * @uses FEATURE_GROUPS
772  * @uses FEATURE_GROUPINGS
773  * @uses FEATURE_GROUPMEMBERSONLY
774  * @uses FEATURE_MOD_INTRO
775  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
776  * @uses FEATURE_GRADE_HAS_GRADE
777  * @uses FEATURE_GRADE_OUTCOMES
778  * @param string $feature FEATURE_xx constant for requested feature
779  * @return mixed True if module supports feature, null if doesn't know
780  */
781 function choice_supports($feature) {
782     switch($feature) {
783         case FEATURE_GROUPS:                  return true;
784         case FEATURE_GROUPINGS:               return true;
785         case FEATURE_GROUPMEMBERSONLY:        return true;
786         case FEATURE_MOD_INTRO:               return true;
787         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
788         case FEATURE_COMPLETION_HAS_RULES:    return true;
789         case FEATURE_GRADE_HAS_GRADE:         return false;
790         case FEATURE_GRADE_OUTCOMES:          return false;
791         case FEATURE_BACKUP_MOODLE2:          return true;
793         default: return null;
794     }
797 /**
798  * Adds module specific settings to the settings block
799  *
800  * @param settings_navigation $settings The settings navigation object
801  * @param navigation_node $choicenode The node to add module settings to
802  */
803 function choice_extend_settings_navigation(settings_navigation $settings, navigation_node $choicenode) {
804     global $PAGE;
806     if (has_capability('mod/choice:readresponses', $PAGE->cm->context)) {
808         $groupmode = groups_get_activity_groupmode($PAGE->cm);
809         if ($groupmode) {
810             groups_get_activity_group($PAGE->cm, true);
811         }
812         // We only actually need the choice id here
813         $choice = new stdClass;
814         $choice->id = $PAGE->cm->instance;
815         $allresponses = choice_get_response_data($choice, $PAGE->cm, $groupmode);   // Big function, approx 6 SQL calls per user
817         $responsecount =0;
818         foreach($allresponses as $optionid => $userlist) {
819             if ($optionid) {
820                 $responsecount += count($userlist);
821             }
822         }
823         $choicenode->add(get_string("viewallresponses", "choice", $responsecount), new moodle_url('/mod/choice/report.php', array('id'=>$PAGE->cm->id)));
824     }
827 /**
828  * Obtains the automatic completion state for this choice based on any conditions
829  * in forum settings.
830  *
831  * @param object $course Course
832  * @param object $cm Course-module
833  * @param int $userid User ID
834  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
835  * @return bool True if completed, false if not, $type if conditions not set.
836  */
837 function choice_get_completion_state($course, $cm, $userid, $type) {
838     global $CFG,$DB;
840     // Get choice details
841     $choice = $DB->get_record('choice', array('id'=>$cm->instance), '*',
842             MUST_EXIST);
844     // If completion option is enabled, evaluate it and return true/false 
845     if($choice->completionsubmit) {
846         return $DB->record_exists('choice_answers', array(
847                 'choiceid'=>$choice->id, 'userid'=>$userid));
848     } else {
849         // Completion option is not enabled so just return $type
850         return $type;
851     }