4e799c8908b0386018ac880885858e31ff66654b
[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  * Callback for the "Complete" report - prints the activity summary for the given user
83  *
84  * @param object $course
85  * @param object $user
86  * @param object $mod
87  * @param object $choice
88  */
89 function choice_user_complete($course, $user, $mod, $choice) {
90     global $DB;
91     if ($answers = $DB->get_records('choice_answers', array("choiceid" => $choice->id, "userid" => $user->id))) {
92         $info = [];
93         foreach ($answers as $answer) {
94             $info[] = "'" . format_string(choice_get_option_text($choice, $answer->optionid)) . "'";
95         }
96         core_collator::asort($info);
97         echo get_string("answered", "choice") . ": ". join(', ', $info) . ". " .
98                 get_string("updated", '', userdate($answer->timemodified));
99     } else {
100         print_string("notanswered", "choice");
101     }
104 /**
105  * Given an object containing all the necessary data,
106  * (defined by the form in mod_form.php) this function
107  * will create a new instance and return the id number
108  * of the new instance.
109  *
110  * @global object
111  * @param object $choice
112  * @return int
113  */
114 function choice_add_instance($choice) {
115     global $DB, $CFG;
116     require_once($CFG->dirroot.'/mod/choice/locallib.php');
118     $choice->timemodified = time();
120     if (empty($choice->timerestrict)) {
121         $choice->timeopen = 0;
122         $choice->timeclose = 0;
123     }
125     //insert answers
126     $choice->id = $DB->insert_record("choice", $choice);
127     foreach ($choice->option as $key => $value) {
128         $value = trim($value);
129         if (isset($value) && $value <> '') {
130             $option = new stdClass();
131             $option->text = $value;
132             $option->choiceid = $choice->id;
133             if (isset($choice->limit[$key])) {
134                 $option->maxanswers = $choice->limit[$key];
135             }
136             $option->timemodified = time();
137             $DB->insert_record("choice_options", $option);
138         }
139     }
141     // Add calendar events if necessary.
142     choice_set_events($choice);
144     return $choice->id;
147 /**
148  * Given an object containing all the necessary data,
149  * (defined by the form in mod_form.php) this function
150  * will update an existing instance with new data.
151  *
152  * @global object
153  * @param object $choice
154  * @return bool
155  */
156 function choice_update_instance($choice) {
157     global $DB, $CFG;
158     require_once($CFG->dirroot.'/mod/choice/locallib.php');
160     $choice->id = $choice->instance;
161     $choice->timemodified = time();
164     if (empty($choice->timerestrict)) {
165         $choice->timeopen = 0;
166         $choice->timeclose = 0;
167     }
169     //update, delete or insert answers
170     foreach ($choice->option as $key => $value) {
171         $value = trim($value);
172         $option = new stdClass();
173         $option->text = $value;
174         $option->choiceid = $choice->id;
175         if (isset($choice->limit[$key])) {
176             $option->maxanswers = $choice->limit[$key];
177         }
178         $option->timemodified = time();
179         if (isset($choice->optionid[$key]) && !empty($choice->optionid[$key])){//existing choice record
180             $option->id=$choice->optionid[$key];
181             if (isset($value) && $value <> '') {
182                 $DB->update_record("choice_options", $option);
183             } else { //empty old option - needs to be deleted.
184                 $DB->delete_records("choice_options", array("id"=>$option->id));
185             }
186         } else {
187             if (isset($value) && $value <> '') {
188                 $DB->insert_record("choice_options", $option);
189             }
190         }
191     }
193     // Add calendar events if necessary.
194     choice_set_events($choice);
196     return $DB->update_record('choice', $choice);
200 /**
201  * @global object
202  * @param object $choice
203  * @param object $user
204  * @param object $coursemodule
205  * @param array $allresponses
206  * @return array
207  */
208 function choice_prepare_options($choice, $user, $coursemodule, $allresponses) {
209     global $DB;
211     $cdisplay = array('options'=>array());
213     $cdisplay['limitanswers'] = true;
214     $context = context_module::instance($coursemodule->id);
216     foreach ($choice->option as $optionid => $text) {
217         if (isset($text)) { //make sure there are no dud entries in the db with blank text values.
218             $option = new stdClass;
219             $option->attributes = new stdClass;
220             $option->attributes->value = $optionid;
221             $option->text = format_string($text);
222             $option->maxanswers = $choice->maxanswers[$optionid];
223             $option->displaylayout = $choice->display;
225             if (isset($allresponses[$optionid])) {
226                 $option->countanswers = count($allresponses[$optionid]);
227             } else {
228                 $option->countanswers = 0;
229             }
230             if ($DB->record_exists('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id, 'optionid' => $optionid))) {
231                 $option->attributes->checked = true;
232             }
233             if ( $choice->limitanswers && ($option->countanswers >= $option->maxanswers) && empty($option->attributes->checked)) {
234                 $option->attributes->disabled = true;
235             }
236             $cdisplay['options'][] = $option;
237         }
238     }
240     $cdisplay['hascapability'] = is_enrolled($context, NULL, 'mod/choice:choose'); //only enrolled users are allowed to make a choice
242     if ($choice->allowupdate && $DB->record_exists('choice_answers', array('choiceid'=> $choice->id, 'userid'=> $user->id))) {
243         $cdisplay['allowupdate'] = true;
244     }
246     if ($choice->showpreview && $choice->timeopen > time()) {
247         $cdisplay['previewonly'] = true;
248     }
250     return $cdisplay;
253 /**
254  * Process user submitted answers for a choice,
255  * and either updating them or saving new answers.
256  *
257  * @param int $formanswer users submitted answers.
258  * @param object $choice the selected choice.
259  * @param int $userid user identifier.
260  * @param object $course current course.
261  * @param object $cm course context.
262  * @return void
263  */
264 function choice_user_submit_response($formanswer, $choice, $userid, $course, $cm) {
265     global $DB, $CFG;
266     require_once($CFG->libdir.'/completionlib.php');
268     $continueurl = new moodle_url('/mod/choice/view.php', array('id' => $cm->id));
270     if (empty($formanswer)) {
271         print_error('atleastoneoption', 'choice', $continueurl);
272     }
274     if (is_array($formanswer)) {
275         if (!$choice->allowmultiple) {
276             print_error('multiplenotallowederror', 'choice', $continueurl);
277         }
278         $formanswers = $formanswer;
279     } else {
280         $formanswers = array($formanswer);
281     }
283     $options = $DB->get_records('choice_options', array('choiceid' => $choice->id), '', 'id');
284     foreach ($formanswers as $key => $val) {
285         if (!isset($options[$val])) {
286             print_error('cannotsubmit', 'choice', $continueurl);
287         }
288     }
289     // Start lock to prevent synchronous access to the same data
290     // before it's updated, if using limits.
291     if ($choice->limitanswers) {
292         $timeout = 10;
293         $locktype = 'mod_choice_choice_user_submit_response';
294         // Limiting access to this choice.
295         $resouce = 'choiceid:' . $choice->id;
296         $lockfactory = \core\lock\lock_config::get_lock_factory($locktype);
298         // Opening the lock.
299         $choicelock = $lockfactory->get_lock($resouce, $timeout);
300         if (!$choicelock) {
301             print_error('cannotsubmit', 'choice', $continueurl);
302         }
303     }
305     $current = $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $userid));
306     $context = context_module::instance($cm->id);
308     $choicesexceeded = false;
309     $countanswers = array();
310     foreach ($formanswers as $val) {
311         $countanswers[$val] = 0;
312     }
313     if($choice->limitanswers) {
314         // Find out whether groups are being used and enabled
315         if (groups_get_activity_groupmode($cm) > 0) {
316             $currentgroup = groups_get_activity_group($cm);
317         } else {
318             $currentgroup = 0;
319         }
321         list ($insql, $params) = $DB->get_in_or_equal($formanswers, SQL_PARAMS_NAMED);
323         if($currentgroup) {
324             // If groups are being used, retrieve responses only for users in
325             // current group
326             global $CFG;
328             $params['groupid'] = $currentgroup;
329             $sql = "SELECT ca.*
330                       FROM {choice_answers} ca
331                 INNER JOIN {groups_members} gm ON ca.userid=gm.userid
332                      WHERE optionid $insql
333                        AND gm.groupid= :groupid";
334         } else {
335             // Groups are not used, retrieve all answers for this option ID
336             $sql = "SELECT ca.*
337                       FROM {choice_answers} ca
338                      WHERE optionid $insql";
339         }
341         $answers = $DB->get_records_sql($sql, $params);
342         if ($answers) {
343             foreach ($answers as $a) { //only return enrolled users.
344                 if (is_enrolled($context, $a->userid, 'mod/choice:choose')) {
345                     $countanswers[$a->optionid]++;
346                 }
347             }
348         }
349         foreach ($countanswers as $opt => $count) {
350             if ($count >= $choice->maxanswers[$opt]) {
351                 $choicesexceeded = true;
352                 break;
353             }
354         }
355     }
357     // Check the user hasn't exceeded the maximum selections for the choice(s) they have selected.
358     if (!($choice->limitanswers && $choicesexceeded)) {
359         $answersnapshots = array();
360         if ($current) {
361             // Update an existing answer.
362             $existingchoices = array();
363             foreach ($current as $c) {
364                 if (in_array($c->optionid, $formanswers)) {
365                     $existingchoices[] = $c->optionid;
366                     $DB->set_field('choice_answers', 'timemodified', time(), array('id' => $c->id));
367                     $answersnapshots[] = $c;
368                 } else {
369                     $DB->delete_records('choice_answers', array('id' => $c->id));
370                 }
371             }
373             // Add new ones.
374             foreach ($formanswers as $f) {
375                 if (!in_array($f, $existingchoices)) {
376                     $newanswer = new stdClass();
377                     $newanswer->optionid = $f;
378                     $newanswer->choiceid = $choice->id;
379                     $newanswer->userid = $userid;
380                     $newanswer->timemodified = time();
381                     $newanswer->id = $DB->insert_record("choice_answers", $newanswer);
382                     $answersnapshots[] = $newanswer;
383                 }
384             }
386             // Initialised as true, meaning we updated the answer.
387             $answerupdated = true;
388         } else {
389             // Add new answer.
390             foreach ($formanswers as $answer) {
391                 $newanswer = new stdClass();
392                 $newanswer->choiceid = $choice->id;
393                 $newanswer->userid = $userid;
394                 $newanswer->optionid = $answer;
395                 $newanswer->timemodified = time();
396                 $newanswer->id = $DB->insert_record("choice_answers", $newanswer);
397                 $answersnapshots[] = $newanswer;
398             }
400             // Update completion state
401             $completion = new completion_info($course);
402             if ($completion->is_enabled($cm) && $choice->completionsubmit) {
403                 $completion->update_state($cm, COMPLETION_COMPLETE);
404             }
406             // Initalised as false, meaning we submitted a new answer.
407             $answerupdated = false;
408         }
409     } else {
410         // Check to see if current choice already selected - if not display error.
411         $currentids = array_keys($current);
413         if (array_diff($currentids, $formanswers) || array_diff($formanswers, $currentids) ) {
414             // Release lock before error.
415             $choicelock->release();
416             print_error('choicefull', 'choice', $continueurl);
417         }
418     }
420     // Release lock.
421     if (isset($choicelock)) {
422         $choicelock->release();
423     }
425     // Now record completed event.
426     if (isset($answerupdated)) {
427         $eventdata = array();
428         $eventdata['context'] = $context;
429         $eventdata['objectid'] = $choice->id;
430         $eventdata['userid'] = $userid;
431         $eventdata['courseid'] = $course->id;
432         $eventdata['other'] = array();
433         $eventdata['other']['choiceid'] = $choice->id;
435         if ($answerupdated) {
436             $eventdata['other']['optionid'] = $formanswer;
437             $event = \mod_choice\event\answer_updated::create($eventdata);
438         } else {
439             $eventdata['other']['optionid'] = $formanswers;
440             $event = \mod_choice\event\answer_submitted::create($eventdata);
441         }
442         $event->add_record_snapshot('course', $course);
443         $event->add_record_snapshot('course_modules', $cm);
444         $event->add_record_snapshot('choice', $choice);
445         foreach ($answersnapshots as $record) {
446             $event->add_record_snapshot('choice_answers', $record);
447         }
448         $event->trigger();
449     }
452 /**
453  * @param array $user
454  * @param object $cm
455  * @return void Output is echo'd
456  */
457 function choice_show_reportlink($user, $cm) {
458     $userschosen = array();
459     foreach($user as $optionid => $userlist) {
460         if ($optionid) {
461             $userschosen = array_merge($userschosen, array_keys($userlist));
462         }
463     }
464     $responsecount = count(array_unique($userschosen));
466     echo '<div class="reportlink">';
467     echo "<a href=\"report.php?id=$cm->id\">".get_string("viewallresponses", "choice", $responsecount)."</a>";
468     echo '</div>';
471 /**
472  * @global object
473  * @param object $choice
474  * @param object $course
475  * @param object $coursemodule
476  * @param array $allresponses
478  *  * @param bool $allresponses
479  * @return object
480  */
481 function prepare_choice_show_results($choice, $course, $cm, $allresponses) {
482     global $OUTPUT;
484     $display = clone($choice);
485     $display->coursemoduleid = $cm->id;
486     $display->courseid = $course->id;
488     //overwrite options value;
489     $display->options = array();
490     $allusers = [];
491     foreach ($choice->option as $optionid => $optiontext) {
492         $display->options[$optionid] = new stdClass;
493         $display->options[$optionid]->text = $optiontext;
494         $display->options[$optionid]->maxanswer = $choice->maxanswers[$optionid];
496         if (array_key_exists($optionid, $allresponses)) {
497             $display->options[$optionid]->user = $allresponses[$optionid];
498             $allusers = array_merge($allusers, array_keys($allresponses[$optionid]));
499         }
500     }
501     unset($display->option);
502     unset($display->maxanswers);
504     $display->numberofuser = count(array_unique($allusers));
505     $context = context_module::instance($cm->id);
506     $display->viewresponsecapability = has_capability('mod/choice:readresponses', $context);
507     $display->deleterepsonsecapability = has_capability('mod/choice:deleteresponses',$context);
508     $display->fullnamecapability = has_capability('moodle/site:viewfullnames', $context);
510     if (empty($allresponses)) {
511         echo $OUTPUT->heading(get_string("nousersyet"), 3, null);
512         return false;
513     }
515     return $display;
518 /**
519  * @global object
520  * @param array $attemptids
521  * @param object $choice Choice main table row
522  * @param object $cm Course-module object
523  * @param object $course Course object
524  * @return bool
525  */
526 function choice_delete_responses($attemptids, $choice, $cm, $course) {
527     global $DB, $CFG, $USER;
528     require_once($CFG->libdir.'/completionlib.php');
530     if(!is_array($attemptids) || empty($attemptids)) {
531         return false;
532     }
534     foreach($attemptids as $num => $attemptid) {
535         if(empty($attemptid)) {
536             unset($attemptids[$num]);
537         }
538     }
540     $context = context_module::instance($cm->id);
541     $completion = new completion_info($course);
542     foreach($attemptids as $attemptid) {
543         if ($todelete = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid))) {
544             // Trigger the event answer deleted.
545             $eventdata = array();
546             $eventdata['objectid'] = $todelete->id;
547             $eventdata['context'] = $context;
548             $eventdata['userid'] = $USER->id;
549             $eventdata['courseid'] = $course->id;
550             $eventdata['relateduserid'] = $todelete->userid;
551             $eventdata['other'] = array();
552             $eventdata['other']['choiceid'] = $choice->id;
553             $eventdata['other']['optionid'] = $todelete->optionid;
554             $event = \mod_choice\event\answer_deleted::create($eventdata);
555             $event->add_record_snapshot('course', $course);
556             $event->add_record_snapshot('course_modules', $cm);
557             $event->add_record_snapshot('choice', $choice);
558             $event->add_record_snapshot('choice_answers', $todelete);
559             $event->trigger();
561             $DB->delete_records('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid));
562         }
563     }
565     // Update completion state.
566     if ($completion->is_enabled($cm) && $choice->completionsubmit) {
567         $completion->update_state($cm, COMPLETION_INCOMPLETE);
568     }
570     return true;
574 /**
575  * Given an ID of an instance of this module,
576  * this function will permanently delete the instance
577  * and any data that depends on it.
578  *
579  * @global object
580  * @param int $id
581  * @return bool
582  */
583 function choice_delete_instance($id) {
584     global $DB;
586     if (! $choice = $DB->get_record("choice", array("id"=>"$id"))) {
587         return false;
588     }
590     $result = true;
592     if (! $DB->delete_records("choice_answers", array("choiceid"=>"$choice->id"))) {
593         $result = false;
594     }
596     if (! $DB->delete_records("choice_options", array("choiceid"=>"$choice->id"))) {
597         $result = false;
598     }
600     if (! $DB->delete_records("choice", array("id"=>"$choice->id"))) {
601         $result = false;
602     }
603     // Remove old calendar events.
604     if (! $DB->delete_records('event', array('modulename' => 'choice', 'instance' => $choice->id))) {
605         $result = false;
606     }
608     return $result;
611 /**
612  * Returns text string which is the answer that matches the id
613  *
614  * @global object
615  * @param object $choice
616  * @param int $id
617  * @return string
618  */
619 function choice_get_option_text($choice, $id) {
620     global $DB;
622     if ($result = $DB->get_record("choice_options", array("id" => $id))) {
623         return $result->text;
624     } else {
625         return get_string("notanswered", "choice");
626     }
629 /**
630  * Gets a full choice record
631  *
632  * @global object
633  * @param int $choiceid
634  * @return object|bool The choice or false
635  */
636 function choice_get_choice($choiceid) {
637     global $DB;
639     if ($choice = $DB->get_record("choice", array("id" => $choiceid))) {
640         if ($options = $DB->get_records("choice_options", array("choiceid" => $choiceid), "id")) {
641             foreach ($options as $option) {
642                 $choice->option[$option->id] = $option->text;
643                 $choice->maxanswers[$option->id] = $option->maxanswers;
644             }
645             return $choice;
646         }
647     }
648     return false;
651 /**
652  * List the actions that correspond to a view of this module.
653  * This is used by the participation report.
654  *
655  * Note: This is not used by new logging system. Event with
656  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
657  *       be considered as view action.
658  *
659  * @return array
660  */
661 function choice_get_view_actions() {
662     return array('view','view all','report');
665 /**
666  * List the actions that correspond to a post of this module.
667  * This is used by the participation report.
668  *
669  * Note: This is not used by new logging system. Event with
670  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
671  *       will be considered as post action.
672  *
673  * @return array
674  */
675 function choice_get_post_actions() {
676     return array('choose','choose again');
680 /**
681  * Implementation of the function for printing the form elements that control
682  * whether the course reset functionality affects the choice.
683  *
684  * @param object $mform form passed by reference
685  */
686 function choice_reset_course_form_definition(&$mform) {
687     $mform->addElement('header', 'choiceheader', get_string('modulenameplural', 'choice'));
688     $mform->addElement('advcheckbox', 'reset_choice', get_string('removeresponses','choice'));
691 /**
692  * Course reset form defaults.
693  *
694  * @return array
695  */
696 function choice_reset_course_form_defaults($course) {
697     return array('reset_choice'=>1);
700 /**
701  * Actual implementation of the reset course functionality, delete all the
702  * choice responses for course $data->courseid.
703  *
704  * @global object
705  * @global object
706  * @param object $data the data submitted from the reset course.
707  * @return array status array
708  */
709 function choice_reset_userdata($data) {
710     global $CFG, $DB;
712     $componentstr = get_string('modulenameplural', 'choice');
713     $status = array();
715     if (!empty($data->reset_choice)) {
716         $choicessql = "SELECT ch.id
717                        FROM {choice} ch
718                        WHERE ch.course=?";
720         $DB->delete_records_select('choice_answers', "choiceid IN ($choicessql)", array($data->courseid));
721         $status[] = array('component'=>$componentstr, 'item'=>get_string('removeresponses', 'choice'), 'error'=>false);
722     }
724     /// updating dates - shift may be negative too
725     if ($data->timeshift) {
726         shift_course_mod_dates('choice', array('timeopen', 'timeclose'), $data->timeshift, $data->courseid);
727         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
728     }
730     return $status;
733 /**
734  * @global object
735  * @global object
736  * @global object
737  * @uses CONTEXT_MODULE
738  * @param object $choice
739  * @param object $cm
740  * @param int $groupmode
741  * @param bool $onlyactive Whether to get response data for active users only.
742  * @return array
743  */
744 function choice_get_response_data($choice, $cm, $groupmode, $onlyactive) {
745     global $CFG, $USER, $DB;
747     $context = context_module::instance($cm->id);
749 /// Get the current group
750     if ($groupmode > 0) {
751         $currentgroup = groups_get_activity_group($cm);
752     } else {
753         $currentgroup = 0;
754     }
756 /// Initialise the returned array, which is a matrix:  $allresponses[responseid][userid] = responseobject
757     $allresponses = array();
759 /// First get all the users who have access here
760 /// To start with we assume they are all "unanswered" then move them later
761     $allresponses[0] = get_enrolled_users($context, 'mod/choice:choose', $currentgroup,
762             user_picture::fields('u', array('idnumber')), null, 0, 0, $onlyactive);
764 /// Get all the recorded responses for this choice
765     $rawresponses = $DB->get_records('choice_answers', array('choiceid' => $choice->id));
767 /// Use the responses to move users into the correct column
769     if ($rawresponses) {
770         $answeredusers = array();
771         foreach ($rawresponses as $response) {
772             if (isset($allresponses[0][$response->userid])) {   // This person is enrolled and in correct group
773                 $allresponses[0][$response->userid]->timemodified = $response->timemodified;
774                 $allresponses[$response->optionid][$response->userid] = clone($allresponses[0][$response->userid]);
775                 $allresponses[$response->optionid][$response->userid]->answerid = $response->id;
776                 $answeredusers[] = $response->userid;
777             }
778         }
779         foreach ($answeredusers as $answereduser) {
780             unset($allresponses[0][$answereduser]);
781         }
782     }
783     return $allresponses;
786 /**
787  * Returns all other caps used in module
788  *
789  * @return array
790  */
791 function choice_get_extra_capabilities() {
792     return array('moodle/site:accessallgroups');
795 /**
796  * @uses FEATURE_GROUPS
797  * @uses FEATURE_GROUPINGS
798  * @uses FEATURE_MOD_INTRO
799  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
800  * @uses FEATURE_GRADE_HAS_GRADE
801  * @uses FEATURE_GRADE_OUTCOMES
802  * @param string $feature FEATURE_xx constant for requested feature
803  * @return mixed True if module supports feature, null if doesn't know
804  */
805 function choice_supports($feature) {
806     switch($feature) {
807         case FEATURE_GROUPS:                  return true;
808         case FEATURE_GROUPINGS:               return true;
809         case FEATURE_MOD_INTRO:               return true;
810         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
811         case FEATURE_COMPLETION_HAS_RULES:    return true;
812         case FEATURE_GRADE_HAS_GRADE:         return false;
813         case FEATURE_GRADE_OUTCOMES:          return false;
814         case FEATURE_BACKUP_MOODLE2:          return true;
815         case FEATURE_SHOW_DESCRIPTION:        return true;
817         default: return null;
818     }
821 /**
822  * Adds module specific settings to the settings block
823  *
824  * @param settings_navigation $settings The settings navigation object
825  * @param navigation_node $choicenode The node to add module settings to
826  */
827 function choice_extend_settings_navigation(settings_navigation $settings, navigation_node $choicenode) {
828     global $PAGE;
830     if (has_capability('mod/choice:readresponses', $PAGE->cm->context)) {
832         $groupmode = groups_get_activity_groupmode($PAGE->cm);
833         if ($groupmode) {
834             groups_get_activity_group($PAGE->cm, true);
835         }
837         $choice = choice_get_choice($PAGE->cm->instance);
839         // Check if we want to include responses from inactive users.
840         $onlyactive = $choice->includeinactive ? false : true;
842         // Big function, approx 6 SQL calls per user.
843         $allresponses = choice_get_response_data($choice, $PAGE->cm, $groupmode, $onlyactive);
845         $allusers = [];
846         foreach($allresponses as $optionid => $userlist) {
847             if ($optionid) {
848                 $allusers = array_merge($allusers, array_keys($userlist));
849             }
850         }
851         $responsecount = count(array_unique($allusers));
852         $choicenode->add(get_string("viewallresponses", "choice", $responsecount), new moodle_url('/mod/choice/report.php', array('id'=>$PAGE->cm->id)));
853     }
856 /**
857  * Obtains the automatic completion state for this choice based on any conditions
858  * in forum settings.
859  *
860  * @param object $course Course
861  * @param object $cm Course-module
862  * @param int $userid User ID
863  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
864  * @return bool True if completed, false if not, $type if conditions not set.
865  */
866 function choice_get_completion_state($course, $cm, $userid, $type) {
867     global $CFG,$DB;
869     // Get choice details
870     $choice = $DB->get_record('choice', array('id'=>$cm->instance), '*',
871             MUST_EXIST);
873     // If completion option is enabled, evaluate it and return true/false
874     if($choice->completionsubmit) {
875         return $DB->record_exists('choice_answers', array(
876                 'choiceid'=>$choice->id, 'userid'=>$userid));
877     } else {
878         // Completion option is not enabled so just return $type
879         return $type;
880     }
883 /**
884  * Return a list of page types
885  * @param string $pagetype current page type
886  * @param stdClass $parentcontext Block's parent context
887  * @param stdClass $currentcontext Current context of block
888  */
889 function choice_page_type_list($pagetype, $parentcontext, $currentcontext) {
890     $module_pagetype = array('mod-choice-*'=>get_string('page-mod-choice-x', 'choice'));
891     return $module_pagetype;
894 /**
895  * Prints choice summaries on MyMoodle Page
896  *
897  * Prints choice name, due date and attempt information on
898  * choice activities that have a deadline that has not already passed
899  * and it is available for completing.
900  * @uses CONTEXT_MODULE
901  * @param array $courses An array of course objects to get choice instances from.
902  * @param array $htmlarray Store overview output array( course ID => 'choice' => HTML output )
903  */
904 function choice_print_overview($courses, &$htmlarray) {
905     global $USER, $DB, $OUTPUT;
907     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
908         return;
909     }
910     if (!$choices = get_all_instances_in_courses('choice', $courses)) {
911         return;
912     }
914     $now = time();
915     foreach ($choices as $choice) {
916         if ($choice->timeclose != 0                                      // If this choice is scheduled.
917             and $choice->timeclose >= $now                               // And the deadline has not passed.
918             and ($choice->timeopen == 0 or $choice->timeopen <= $now)) { // And the choice is available.
920             // Visibility.
921             $class = (!$choice->visible) ? 'dimmed' : '';
923             // Link to activity.
924             $url = new moodle_url('/mod/choice/view.php', array('id' => $choice->coursemodule));
925             $url = html_writer::link($url, format_string($choice->name), array('class' => $class));
926             $str = $OUTPUT->box(get_string('choiceactivityname', 'choice', $url), 'name');
928              // Deadline.
929             $str .= $OUTPUT->box(get_string('choicecloseson', 'choice', userdate($choice->timeclose)), 'info');
931             // Display relevant info based on permissions.
932             if (has_capability('mod/choice:readresponses', context_module::instance($choice->coursemodule))) {
933                 $attempts = $DB->count_records_sql('SELECT COUNT(DISTINCT userid) FROM {choice_answers} WHERE choiceid = ?',
934                     [$choice->id]);
935                 $url = new moodle_url('/mod/choice/report.php', ['id' => $choice->coursemodule]);
936                 $str .= $OUTPUT->box(html_writer::link($url, get_string('viewallresponses', 'choice', $attempts)), 'info');
938             } else if (has_capability('mod/choice:choose', context_module::instance($choice->coursemodule))) {
939                 // See if the user has submitted anything.
940                 $answers = $DB->count_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id));
941                 if ($answers > 0) {
942                     // User has already selected an answer, nothing to show.
943                     $str = '';
944                 } else {
945                     // User has not made a selection yet.
946                     $str .= $OUTPUT->box(get_string('notanswered', 'choice'), 'info');
947                 }
948             } else {
949                 // Does not have permission to do anything on this choice activity.
950                 $str = '';
951             }
953             // Make sure we have something to display.
954             if (!empty($str)) {
955                 // Generate the containing div.
956                 $str = $OUTPUT->box($str, 'choice overview');
958                 if (empty($htmlarray[$choice->course]['choice'])) {
959                     $htmlarray[$choice->course]['choice'] = $str;
960                 } else {
961                     $htmlarray[$choice->course]['choice'] .= $str;
962                 }
963             }
964         }
965     }
966     return;
970 /**
971  * Get my responses on a given choice.
972  *
973  * @param stdClass $choice Choice record
974  * @return array of choice answers records
975  * @since  Moodle 3.0
976  */
977 function choice_get_my_response($choice) {
978     global $DB, $USER;
979     return $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id));
983 /**
984  * Get all the responses on a given choice.
985  *
986  * @param stdClass $choice Choice record
987  * @return array of choice answers records
988  * @since  Moodle 3.0
989  */
990 function choice_get_all_responses($choice) {
991     global $DB;
992     return $DB->get_records('choice_answers', array('choiceid' => $choice->id));
996 /**
997  * Return true if we are allowd to view the choice results.
998  *
999  * @param stdClass $choice Choice record
1000  * @param rows|null $current my choice responses
1001  * @param bool|null $choiceopen if the choice is open
1002  * @return bool true if we can view the results, false otherwise.
1003  * @since  Moodle 3.0
1004  */
1005 function choice_can_view_results($choice, $current = null, $choiceopen = null) {
1007     if (is_null($choiceopen)) {
1008         $timenow = time();
1009         if ($choice->timeclose != 0 && $timenow > $choice->timeclose) {
1010             $choiceopen = false;
1011         } else {
1012             $choiceopen = true;
1013         }
1014     }
1015     if (empty($current)) {
1016         $current = choice_get_my_response($choice);
1017     }
1019     if ($choice->showresults == CHOICE_SHOWRESULTS_ALWAYS or
1020        ($choice->showresults == CHOICE_SHOWRESULTS_AFTER_ANSWER and !empty($current)) or
1021        ($choice->showresults == CHOICE_SHOWRESULTS_AFTER_CLOSE and !$choiceopen)) {
1022         return true;
1023     }
1024     return false;
1027 /**
1028  * Mark the activity completed (if required) and trigger the course_module_viewed event.
1029  *
1030  * @param  stdClass $choice     choice object
1031  * @param  stdClass $course     course object
1032  * @param  stdClass $cm         course module object
1033  * @param  stdClass $context    context object
1034  * @since Moodle 3.0
1035  */
1036 function choice_view($choice, $course, $cm, $context) {
1038     // Trigger course_module_viewed event.
1039     $params = array(
1040         'context' => $context,
1041         'objectid' => $choice->id
1042     );
1044     $event = \mod_choice\event\course_module_viewed::create($params);
1045     $event->add_record_snapshot('course_modules', $cm);
1046     $event->add_record_snapshot('course', $course);
1047     $event->add_record_snapshot('choice', $choice);
1048     $event->trigger();
1050     // Completion.
1051     $completion = new completion_info($course);
1052     $completion->set_module_viewed($cm);
1055 /**
1056  * Check if a choice is available for the current user.
1057  *
1058  * @param  stdClass  $choice            choice record
1059  * @return array                       status (available or not and possible warnings)
1060  */
1061 function choice_get_availability_status($choice) {
1062     $available = true;
1063     $warnings = array();
1065     if ($choice->timeclose != 0) {
1066         $timenow = time();
1068         if ($choice->timeopen > $timenow) {
1069             $available = false;
1070             $warnings['notopenyet'] = userdate($choice->timeopen);
1071         } else if ($timenow > $choice->timeclose) {
1072             $available = false;
1073             $warnings['expired'] = userdate($choice->timeclose);
1074         }
1075     }
1076     if (!$choice->allowupdate && choice_get_my_response($choice)) {
1077         $available = false;
1078         $warnings['choicesaved'] = '';
1079     }
1081     // Choice is available.
1082     return array($available, $warnings);
1085 /**
1086  * This standard function will check all instances of this module
1087  * and make sure there are up-to-date events created for each of them.
1088  * If courseid = 0, then every chat event in the site is checked, else
1089  * only chat events belonging to the course specified are checked.
1090  * This function is used, in its new format, by restore_refresh_events()
1091  *
1092  * @param int $courseid
1093  * @return bool
1094  */
1095 function choice_refresh_events($courseid = 0) {
1096     global $DB, $CFG;
1097     require_once($CFG->dirroot.'/mod/choice/locallib.php');
1099     if ($courseid) {
1100         if (! $choices = $DB->get_records("choice", array("course" => $courseid))) {
1101             return true;
1102         }
1103     } else {
1104         if (! $choices = $DB->get_records("choice")) {
1105             return true;
1106         }
1107     }
1109     foreach ($choices as $choice) {
1110         choice_set_events($choice);
1111     }
1112     return true;