MDL-61289 mod_choice: Add extra user fields to response data
[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 defined('MOODLE_INTERNAL') || die();
26 /** @global int $CHOICE_COLUMN_HEIGHT */
27 global $CHOICE_COLUMN_HEIGHT;
28 $CHOICE_COLUMN_HEIGHT = 300;
30 /** @global int $CHOICE_COLUMN_WIDTH */
31 global $CHOICE_COLUMN_WIDTH;
32 $CHOICE_COLUMN_WIDTH = 300;
34 define('CHOICE_PUBLISH_ANONYMOUS', '0');
35 define('CHOICE_PUBLISH_NAMES',     '1');
37 define('CHOICE_SHOWRESULTS_NOT',          '0');
38 define('CHOICE_SHOWRESULTS_AFTER_ANSWER', '1');
39 define('CHOICE_SHOWRESULTS_AFTER_CLOSE',  '2');
40 define('CHOICE_SHOWRESULTS_ALWAYS',       '3');
42 define('CHOICE_DISPLAY_HORIZONTAL',  '0');
43 define('CHOICE_DISPLAY_VERTICAL',    '1');
45 define('CHOICE_EVENT_TYPE_OPEN', 'open');
46 define('CHOICE_EVENT_TYPE_CLOSE', 'close');
48 /** @global array $CHOICE_PUBLISH */
49 global $CHOICE_PUBLISH;
50 $CHOICE_PUBLISH = array (CHOICE_PUBLISH_ANONYMOUS  => get_string('publishanonymous', 'choice'),
51                          CHOICE_PUBLISH_NAMES      => get_string('publishnames', 'choice'));
53 /** @global array $CHOICE_SHOWRESULTS */
54 global $CHOICE_SHOWRESULTS;
55 $CHOICE_SHOWRESULTS = array (CHOICE_SHOWRESULTS_NOT          => get_string('publishnot', 'choice'),
56                          CHOICE_SHOWRESULTS_AFTER_ANSWER => get_string('publishafteranswer', 'choice'),
57                          CHOICE_SHOWRESULTS_AFTER_CLOSE  => get_string('publishafterclose', 'choice'),
58                          CHOICE_SHOWRESULTS_ALWAYS       => get_string('publishalways', 'choice'));
60 /** @global array $CHOICE_DISPLAY */
61 global $CHOICE_DISPLAY;
62 $CHOICE_DISPLAY = array (CHOICE_DISPLAY_HORIZONTAL   => get_string('displayhorizontal', 'choice'),
63                          CHOICE_DISPLAY_VERTICAL     => get_string('displayvertical','choice'));
65 /// Standard functions /////////////////////////////////////////////////////////
67 /**
68  * @global object
69  * @param object $course
70  * @param object $user
71  * @param object $mod
72  * @param object $choice
73  * @return object|null
74  */
75 function choice_user_outline($course, $user, $mod, $choice) {
76     global $DB;
77     if ($answer = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id))) {
78         $result = new stdClass();
79         $result->info = "'".format_string(choice_get_option_text($choice, $answer->optionid))."'";
80         $result->time = $answer->timemodified;
81         return $result;
82     }
83     return NULL;
84 }
86 /**
87  * Callback for the "Complete" report - prints the activity summary for the given user
88  *
89  * @param object $course
90  * @param object $user
91  * @param object $mod
92  * @param object $choice
93  */
94 function choice_user_complete($course, $user, $mod, $choice) {
95     global $DB;
96     if ($answers = $DB->get_records('choice_answers', array("choiceid" => $choice->id, "userid" => $user->id))) {
97         $info = [];
98         foreach ($answers as $answer) {
99             $info[] = "'" . format_string(choice_get_option_text($choice, $answer->optionid)) . "'";
100         }
101         core_collator::asort($info);
102         echo get_string("answered", "choice") . ": ". join(', ', $info) . ". " .
103                 get_string("updated", '', userdate($answer->timemodified));
104     } else {
105         print_string("notanswered", "choice");
106     }
109 /**
110  * Given an object containing all the necessary data,
111  * (defined by the form in mod_form.php) this function
112  * will create a new instance and return the id number
113  * of the new instance.
114  *
115  * @global object
116  * @param object $choice
117  * @return int
118  */
119 function choice_add_instance($choice) {
120     global $DB, $CFG;
121     require_once($CFG->dirroot.'/mod/choice/locallib.php');
123     $choice->timemodified = time();
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);
143     if (!empty($choice->completionexpected)) {
144         \core_completion\api::update_completion_date_event($choice->coursemodule, 'choice', $choice->id,
145                 $choice->completionexpected);
146     }
148     return $choice->id;
151 /**
152  * Given an object containing all the necessary data,
153  * (defined by the form in mod_form.php) this function
154  * will update an existing instance with new data.
155  *
156  * @global object
157  * @param object $choice
158  * @return bool
159  */
160 function choice_update_instance($choice) {
161     global $DB, $CFG;
162     require_once($CFG->dirroot.'/mod/choice/locallib.php');
164     $choice->id = $choice->instance;
165     $choice->timemodified = time();
167     //update, delete or insert answers
168     foreach ($choice->option as $key => $value) {
169         $value = trim($value);
170         $option = new stdClass();
171         $option->text = $value;
172         $option->choiceid = $choice->id;
173         if (isset($choice->limit[$key])) {
174             $option->maxanswers = $choice->limit[$key];
175         }
176         $option->timemodified = time();
177         if (isset($choice->optionid[$key]) && !empty($choice->optionid[$key])){//existing choice record
178             $option->id=$choice->optionid[$key];
179             if (isset($value) && $value <> '') {
180                 $DB->update_record("choice_options", $option);
181             } else {
182                 // Remove the empty (unused) option.
183                 $DB->delete_records("choice_options", array("id" => $option->id));
184                 // Delete any answers associated with this option.
185                 $DB->delete_records("choice_answers", array("choiceid" => $choice->id, "optionid" => $option->id));
186             }
187         } else {
188             if (isset($value) && $value <> '') {
189                 $DB->insert_record("choice_options", $option);
190             }
191         }
192     }
194     // Add calendar events if necessary.
195     choice_set_events($choice);
196     $completionexpected = (!empty($choice->completionexpected)) ? $choice->completionexpected : null;
197     \core_completion\api::update_completion_date_event($choice->coursemodule, 'choice', $choice->id, $completionexpected);
199     return $DB->update_record('choice', $choice);
203 /**
204  * @global object
205  * @param object $choice
206  * @param object $user
207  * @param object $coursemodule
208  * @param array $allresponses
209  * @return array
210  */
211 function choice_prepare_options($choice, $user, $coursemodule, $allresponses) {
212     global $DB;
214     $cdisplay = array('options'=>array());
216     $cdisplay['limitanswers'] = true;
217     $context = context_module::instance($coursemodule->id);
219     foreach ($choice->option as $optionid => $text) {
220         if (isset($text)) { //make sure there are no dud entries in the db with blank text values.
221             $option = new stdClass;
222             $option->attributes = new stdClass;
223             $option->attributes->value = $optionid;
224             $option->text = format_string($text);
225             $option->maxanswers = $choice->maxanswers[$optionid];
226             $option->displaylayout = $choice->display;
228             if (isset($allresponses[$optionid])) {
229                 $option->countanswers = count($allresponses[$optionid]);
230             } else {
231                 $option->countanswers = 0;
232             }
233             if ($DB->record_exists('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id, 'optionid' => $optionid))) {
234                 $option->attributes->checked = true;
235             }
236             if ( $choice->limitanswers && ($option->countanswers >= $option->maxanswers) && empty($option->attributes->checked)) {
237                 $option->attributes->disabled = true;
238             }
239             $cdisplay['options'][] = $option;
240         }
241     }
243     $cdisplay['hascapability'] = is_enrolled($context, NULL, 'mod/choice:choose'); //only enrolled users are allowed to make a choice
245     if ($choice->allowupdate && $DB->record_exists('choice_answers', array('choiceid'=> $choice->id, 'userid'=> $user->id))) {
246         $cdisplay['allowupdate'] = true;
247     }
249     if ($choice->showpreview && $choice->timeopen > time()) {
250         $cdisplay['previewonly'] = true;
251     }
253     return $cdisplay;
256 /**
257  * Modifies responses of other users adding the option $newoptionid to them
258  *
259  * @param array $userids list of users to add option to (must be users without any answers yet)
260  * @param array $answerids list of existing attempt ids of users (will be either appended or
261  *      substituted with the newoptionid, depending on $choice->allowmultiple)
262  * @param int $newoptionid
263  * @param stdClass $choice choice object, result of {@link choice_get_choice()}
264  * @param stdClass $cm
265  * @param stdClass $course
266  */
267 function choice_modify_responses($userids, $answerids, $newoptionid, $choice, $cm, $course) {
268     // Get all existing responses and the list of non-respondents.
269     $groupmode = groups_get_activity_groupmode($cm);
270     $onlyactive = $choice->includeinactive ? false : true;
271     $allresponses = choice_get_response_data($choice, $cm, $groupmode, $onlyactive);
273     // Check that the option value is valid.
274     if (!$newoptionid || !isset($choice->option[$newoptionid])) {
275         return;
276     }
278     // First add responses for users who did not make any choice yet.
279     foreach ($userids as $userid) {
280         if (isset($allresponses[0][$userid])) {
281             choice_user_submit_response($newoptionid, $choice, $userid, $course, $cm);
282         }
283     }
285     // Create the list of all options already selected by each user.
286     $optionsbyuser = []; // Mapping userid=>array of chosen choice options.
287     $usersbyanswer = []; // Mapping answerid=>userid (which answer belongs to each user).
288     foreach ($allresponses as $optionid => $responses) {
289         if ($optionid > 0) {
290             foreach ($responses as $userid => $userresponse) {
291                 $optionsbyuser += [$userid => []];
292                 $optionsbyuser[$userid][] = $optionid;
293                 $usersbyanswer[$userresponse->answerid] = $userid;
294             }
295         }
296     }
298     // Go through the list of submitted attemptids and find which users answers need to be updated.
299     foreach ($answerids as $answerid) {
300         if (isset($usersbyanswer[$answerid])) {
301             $userid = $usersbyanswer[$answerid];
302             if (!in_array($newoptionid, $optionsbyuser[$userid])) {
303                 $options = $choice->allowmultiple ?
304                         array_merge($optionsbyuser[$userid], [$newoptionid]) : $newoptionid;
305                 choice_user_submit_response($options, $choice, $userid, $course, $cm);
306             }
307         }
308     }
311 /**
312  * Process user submitted answers for a choice,
313  * and either updating them or saving new answers.
314  *
315  * @param int $formanswer users submitted answers.
316  * @param object $choice the selected choice.
317  * @param int $userid user identifier.
318  * @param object $course current course.
319  * @param object $cm course context.
320  * @return void
321  */
322 function choice_user_submit_response($formanswer, $choice, $userid, $course, $cm) {
323     global $DB, $CFG, $USER;
324     require_once($CFG->libdir.'/completionlib.php');
326     $continueurl = new moodle_url('/mod/choice/view.php', array('id' => $cm->id));
328     if (empty($formanswer)) {
329         print_error('atleastoneoption', 'choice', $continueurl);
330     }
332     if (is_array($formanswer)) {
333         if (!$choice->allowmultiple) {
334             print_error('multiplenotallowederror', 'choice', $continueurl);
335         }
336         $formanswers = $formanswer;
337     } else {
338         $formanswers = array($formanswer);
339     }
341     $options = $DB->get_records('choice_options', array('choiceid' => $choice->id), '', 'id');
342     foreach ($formanswers as $key => $val) {
343         if (!isset($options[$val])) {
344             print_error('cannotsubmit', 'choice', $continueurl);
345         }
346     }
347     // Start lock to prevent synchronous access to the same data
348     // before it's updated, if using limits.
349     if ($choice->limitanswers) {
350         $timeout = 10;
351         $locktype = 'mod_choice_choice_user_submit_response';
352         // Limiting access to this choice.
353         $resouce = 'choiceid:' . $choice->id;
354         $lockfactory = \core\lock\lock_config::get_lock_factory($locktype);
356         // Opening the lock.
357         $choicelock = $lockfactory->get_lock($resouce, $timeout, MINSECS);
358         if (!$choicelock) {
359             print_error('cannotsubmit', 'choice', $continueurl);
360         }
361     }
363     $current = $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $userid));
364     $context = context_module::instance($cm->id);
366     $choicesexceeded = false;
367     $countanswers = array();
368     foreach ($formanswers as $val) {
369         $countanswers[$val] = 0;
370     }
371     if($choice->limitanswers) {
372         // Find out whether groups are being used and enabled
373         if (groups_get_activity_groupmode($cm) > 0) {
374             $currentgroup = groups_get_activity_group($cm);
375         } else {
376             $currentgroup = 0;
377         }
379         list ($insql, $params) = $DB->get_in_or_equal($formanswers, SQL_PARAMS_NAMED);
381         if($currentgroup) {
382             // If groups are being used, retrieve responses only for users in
383             // current group
384             global $CFG;
386             $params['groupid'] = $currentgroup;
387             $sql = "SELECT ca.*
388                       FROM {choice_answers} ca
389                 INNER JOIN {groups_members} gm ON ca.userid=gm.userid
390                      WHERE optionid $insql
391                        AND gm.groupid= :groupid";
392         } else {
393             // Groups are not used, retrieve all answers for this option ID
394             $sql = "SELECT ca.*
395                       FROM {choice_answers} ca
396                      WHERE optionid $insql";
397         }
399         $answers = $DB->get_records_sql($sql, $params);
400         if ($answers) {
401             foreach ($answers as $a) { //only return enrolled users.
402                 if (is_enrolled($context, $a->userid, 'mod/choice:choose')) {
403                     $countanswers[$a->optionid]++;
404                 }
405             }
406         }
407         foreach ($countanswers as $opt => $count) {
408             if ($count >= $choice->maxanswers[$opt]) {
409                 $choicesexceeded = true;
410                 break;
411             }
412         }
413     }
415     // Check the user hasn't exceeded the maximum selections for the choice(s) they have selected.
416     $answersnapshots = array();
417     $deletedanswersnapshots = array();
418     if (!($choice->limitanswers && $choicesexceeded)) {
419         if ($current) {
420             // Update an existing answer.
421             $existingchoices = array();
422             foreach ($current as $c) {
423                 if (in_array($c->optionid, $formanswers)) {
424                     $existingchoices[] = $c->optionid;
425                     $DB->set_field('choice_answers', 'timemodified', time(), array('id' => $c->id));
426                 } else {
427                     $deletedanswersnapshots[] = $c;
428                     $DB->delete_records('choice_answers', array('id' => $c->id));
429                 }
430             }
432             // Add new ones.
433             foreach ($formanswers as $f) {
434                 if (!in_array($f, $existingchoices)) {
435                     $newanswer = new stdClass();
436                     $newanswer->optionid = $f;
437                     $newanswer->choiceid = $choice->id;
438                     $newanswer->userid = $userid;
439                     $newanswer->timemodified = time();
440                     $newanswer->id = $DB->insert_record("choice_answers", $newanswer);
441                     $answersnapshots[] = $newanswer;
442                 }
443             }
444         } else {
445             // Add new answer.
446             foreach ($formanswers as $answer) {
447                 $newanswer = new stdClass();
448                 $newanswer->choiceid = $choice->id;
449                 $newanswer->userid = $userid;
450                 $newanswer->optionid = $answer;
451                 $newanswer->timemodified = time();
452                 $newanswer->id = $DB->insert_record("choice_answers", $newanswer);
453                 $answersnapshots[] = $newanswer;
454             }
456             // Update completion state
457             $completion = new completion_info($course);
458             if ($completion->is_enabled($cm) && $choice->completionsubmit) {
459                 $completion->update_state($cm, COMPLETION_COMPLETE);
460             }
461         }
462     } else {
463         // Check to see if current choice already selected - if not display error.
464         $currentids = array_keys($current);
466         if (array_diff($currentids, $formanswers) || array_diff($formanswers, $currentids) ) {
467             // Release lock before error.
468             $choicelock->release();
469             print_error('choicefull', 'choice', $continueurl);
470         }
471     }
473     // Release lock.
474     if (isset($choicelock)) {
475         $choicelock->release();
476     }
478     // Trigger events.
479     foreach ($deletedanswersnapshots as $answer) {
480         \mod_choice\event\answer_deleted::create_from_object($answer, $choice, $cm, $course)->trigger();
481     }
482     foreach ($answersnapshots as $answer) {
483         \mod_choice\event\answer_created::create_from_object($answer, $choice, $cm, $course)->trigger();
484     }
487 /**
488  * @param array $user
489  * @param object $cm
490  * @return void Output is echo'd
491  */
492 function choice_show_reportlink($user, $cm) {
493     $userschosen = array();
494     foreach($user as $optionid => $userlist) {
495         if ($optionid) {
496             $userschosen = array_merge($userschosen, array_keys($userlist));
497         }
498     }
499     $responsecount = count(array_unique($userschosen));
501     echo '<div class="reportlink">';
502     echo "<a href=\"report.php?id=$cm->id\">".get_string("viewallresponses", "choice", $responsecount)."</a>";
503     echo '</div>';
506 /**
507  * @global object
508  * @param object $choice
509  * @param object $course
510  * @param object $coursemodule
511  * @param array $allresponses
513  *  * @param bool $allresponses
514  * @return object
515  */
516 function prepare_choice_show_results($choice, $course, $cm, $allresponses) {
517     global $OUTPUT;
519     $display = clone($choice);
520     $display->coursemoduleid = $cm->id;
521     $display->courseid = $course->id;
523     if (!empty($choice->showunanswered)) {
524         $choice->option[0] = get_string('notanswered', 'choice');
525         $choice->maxanswers[0] = 0;
526     }
528     // Remove from the list of non-respondents the users who do not have access to this activity.
529     if (!empty($display->showunanswered) && $allresponses[0]) {
530         $info = new \core_availability\info_module(cm_info::create($cm));
531         $allresponses[0] = $info->filter_user_list($allresponses[0]);
532     }
534     //overwrite options value;
535     $display->options = array();
536     $allusers = [];
537     foreach ($choice->option as $optionid => $optiontext) {
538         $display->options[$optionid] = new stdClass;
539         $display->options[$optionid]->text = format_string($optiontext, true,
540             ['context' => context_module::instance($cm->id)]);
541         $display->options[$optionid]->maxanswer = $choice->maxanswers[$optionid];
543         if (array_key_exists($optionid, $allresponses)) {
544             $display->options[$optionid]->user = $allresponses[$optionid];
545             $allusers = array_merge($allusers, array_keys($allresponses[$optionid]));
546         }
547     }
548     unset($display->option);
549     unset($display->maxanswers);
551     $display->numberofuser = count(array_unique($allusers));
552     $context = context_module::instance($cm->id);
553     $display->viewresponsecapability = has_capability('mod/choice:readresponses', $context);
554     $display->deleterepsonsecapability = has_capability('mod/choice:deleteresponses',$context);
555     $display->fullnamecapability = has_capability('moodle/site:viewfullnames', $context);
557     if (empty($allresponses)) {
558         echo $OUTPUT->heading(get_string("nousersyet"), 3, null);
559         return false;
560     }
562     return $display;
565 /**
566  * @global object
567  * @param array $attemptids
568  * @param object $choice Choice main table row
569  * @param object $cm Course-module object
570  * @param object $course Course object
571  * @return bool
572  */
573 function choice_delete_responses($attemptids, $choice, $cm, $course) {
574     global $DB, $CFG, $USER;
575     require_once($CFG->libdir.'/completionlib.php');
577     if(!is_array($attemptids) || empty($attemptids)) {
578         return false;
579     }
581     foreach($attemptids as $num => $attemptid) {
582         if(empty($attemptid)) {
583             unset($attemptids[$num]);
584         }
585     }
587     $completion = new completion_info($course);
588     foreach($attemptids as $attemptid) {
589         if ($todelete = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid))) {
590             // Trigger the event answer deleted.
591             \mod_choice\event\answer_deleted::create_from_object($todelete, $choice, $cm, $course)->trigger();
592             $DB->delete_records('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid));
593         }
594     }
596     // Update completion state.
597     if ($completion->is_enabled($cm) && $choice->completionsubmit) {
598         $completion->update_state($cm, COMPLETION_INCOMPLETE);
599     }
601     return true;
605 /**
606  * Given an ID of an instance of this module,
607  * this function will permanently delete the instance
608  * and any data that depends on it.
609  *
610  * @global object
611  * @param int $id
612  * @return bool
613  */
614 function choice_delete_instance($id) {
615     global $DB;
617     if (! $choice = $DB->get_record("choice", array("id"=>"$id"))) {
618         return false;
619     }
621     $result = true;
623     if (! $DB->delete_records("choice_answers", array("choiceid"=>"$choice->id"))) {
624         $result = false;
625     }
627     if (! $DB->delete_records("choice_options", array("choiceid"=>"$choice->id"))) {
628         $result = false;
629     }
631     if (! $DB->delete_records("choice", array("id"=>"$choice->id"))) {
632         $result = false;
633     }
634     // Remove old calendar events.
635     if (! $DB->delete_records('event', array('modulename' => 'choice', 'instance' => $choice->id))) {
636         $result = false;
637     }
639     return $result;
642 /**
643  * Returns text string which is the answer that matches the id
644  *
645  * @global object
646  * @param object $choice
647  * @param int $id
648  * @return string
649  */
650 function choice_get_option_text($choice, $id) {
651     global $DB;
653     if ($result = $DB->get_record("choice_options", array("id" => $id))) {
654         return $result->text;
655     } else {
656         return get_string("notanswered", "choice");
657     }
660 /**
661  * Gets a full choice record
662  *
663  * @global object
664  * @param int $choiceid
665  * @return object|bool The choice or false
666  */
667 function choice_get_choice($choiceid) {
668     global $DB;
670     if ($choice = $DB->get_record("choice", array("id" => $choiceid))) {
671         if ($options = $DB->get_records("choice_options", array("choiceid" => $choiceid), "id")) {
672             foreach ($options as $option) {
673                 $choice->option[$option->id] = $option->text;
674                 $choice->maxanswers[$option->id] = $option->maxanswers;
675             }
676             return $choice;
677         }
678     }
679     return false;
682 /**
683  * List the actions that correspond to a view of this module.
684  * This is used by the participation report.
685  *
686  * Note: This is not used by new logging system. Event with
687  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
688  *       be considered as view action.
689  *
690  * @return array
691  */
692 function choice_get_view_actions() {
693     return array('view','view all','report');
696 /**
697  * List the actions that correspond to a post of this module.
698  * This is used by the participation report.
699  *
700  * Note: This is not used by new logging system. Event with
701  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
702  *       will be considered as post action.
703  *
704  * @return array
705  */
706 function choice_get_post_actions() {
707     return array('choose','choose again');
711 /**
712  * Implementation of the function for printing the form elements that control
713  * whether the course reset functionality affects the choice.
714  *
715  * @param object $mform form passed by reference
716  */
717 function choice_reset_course_form_definition(&$mform) {
718     $mform->addElement('header', 'choiceheader', get_string('modulenameplural', 'choice'));
719     $mform->addElement('advcheckbox', 'reset_choice', get_string('removeresponses','choice'));
722 /**
723  * Course reset form defaults.
724  *
725  * @return array
726  */
727 function choice_reset_course_form_defaults($course) {
728     return array('reset_choice'=>1);
731 /**
732  * Actual implementation of the reset course functionality, delete all the
733  * choice responses for course $data->courseid.
734  *
735  * @global object
736  * @global object
737  * @param object $data the data submitted from the reset course.
738  * @return array status array
739  */
740 function choice_reset_userdata($data) {
741     global $CFG, $DB;
743     $componentstr = get_string('modulenameplural', 'choice');
744     $status = array();
746     if (!empty($data->reset_choice)) {
747         $choicessql = "SELECT ch.id
748                        FROM {choice} ch
749                        WHERE ch.course=?";
751         $DB->delete_records_select('choice_answers', "choiceid IN ($choicessql)", array($data->courseid));
752         $status[] = array('component'=>$componentstr, 'item'=>get_string('removeresponses', 'choice'), 'error'=>false);
753     }
755     /// updating dates - shift may be negative too
756     if ($data->timeshift) {
757         // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
758         // See MDL-9367.
759         shift_course_mod_dates('choice', array('timeopen', 'timeclose'), $data->timeshift, $data->courseid);
760         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
761     }
763     return $status;
766 /**
767  * @global object
768  * @global object
769  * @global object
770  * @uses CONTEXT_MODULE
771  * @param object $choice
772  * @param object $cm
773  * @param int $groupmode
774  * @param bool $onlyactive Whether to get response data for active users only.
775  * @return array
776  */
777 function choice_get_response_data($choice, $cm, $groupmode, $onlyactive) {
778     global $CFG, $USER, $DB;
780     $context = context_module::instance($cm->id);
782 /// Get the current group
783     if ($groupmode > 0) {
784         $currentgroup = groups_get_activity_group($cm);
785     } else {
786         $currentgroup = 0;
787     }
789 /// Initialise the returned array, which is a matrix:  $allresponses[responseid][userid] = responseobject
790     $allresponses = array();
792 /// First get all the users who have access here
793 /// To start with we assume they are all "unanswered" then move them later
794     $extrafields = get_extra_user_fields($context);
795     $allresponses[0] = get_enrolled_users($context, 'mod/choice:choose', $currentgroup,
796             user_picture::fields('u', $extrafields), null, 0, 0, $onlyactive);
798 /// Get all the recorded responses for this choice
799     $rawresponses = $DB->get_records('choice_answers', array('choiceid' => $choice->id));
801 /// Use the responses to move users into the correct column
803     if ($rawresponses) {
804         $answeredusers = array();
805         foreach ($rawresponses as $response) {
806             if (isset($allresponses[0][$response->userid])) {   // This person is enrolled and in correct group
807                 $allresponses[0][$response->userid]->timemodified = $response->timemodified;
808                 $allresponses[$response->optionid][$response->userid] = clone($allresponses[0][$response->userid]);
809                 $allresponses[$response->optionid][$response->userid]->answerid = $response->id;
810                 $answeredusers[] = $response->userid;
811             }
812         }
813         foreach ($answeredusers as $answereduser) {
814             unset($allresponses[0][$answereduser]);
815         }
816     }
817     return $allresponses;
820 /**
821  * Returns all other caps used in module
822  *
823  * @return array
824  */
825 function choice_get_extra_capabilities() {
826     return array('moodle/site:accessallgroups');
829 /**
830  * @uses FEATURE_GROUPS
831  * @uses FEATURE_GROUPINGS
832  * @uses FEATURE_MOD_INTRO
833  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
834  * @uses FEATURE_GRADE_HAS_GRADE
835  * @uses FEATURE_GRADE_OUTCOMES
836  * @param string $feature FEATURE_xx constant for requested feature
837  * @return mixed True if module supports feature, null if doesn't know
838  */
839 function choice_supports($feature) {
840     switch($feature) {
841         case FEATURE_GROUPS:                  return true;
842         case FEATURE_GROUPINGS:               return true;
843         case FEATURE_MOD_INTRO:               return true;
844         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
845         case FEATURE_COMPLETION_HAS_RULES:    return true;
846         case FEATURE_GRADE_HAS_GRADE:         return false;
847         case FEATURE_GRADE_OUTCOMES:          return false;
848         case FEATURE_BACKUP_MOODLE2:          return true;
849         case FEATURE_SHOW_DESCRIPTION:        return true;
851         default: return null;
852     }
855 /**
856  * Adds module specific settings to the settings block
857  *
858  * @param settings_navigation $settings The settings navigation object
859  * @param navigation_node $choicenode The node to add module settings to
860  */
861 function choice_extend_settings_navigation(settings_navigation $settings, navigation_node $choicenode) {
862     global $PAGE;
864     if (has_capability('mod/choice:readresponses', $PAGE->cm->context)) {
866         $groupmode = groups_get_activity_groupmode($PAGE->cm);
867         if ($groupmode) {
868             groups_get_activity_group($PAGE->cm, true);
869         }
871         $choice = choice_get_choice($PAGE->cm->instance);
873         // Check if we want to include responses from inactive users.
874         $onlyactive = $choice->includeinactive ? false : true;
876         // Big function, approx 6 SQL calls per user.
877         $allresponses = choice_get_response_data($choice, $PAGE->cm, $groupmode, $onlyactive);
879         $allusers = [];
880         foreach($allresponses as $optionid => $userlist) {
881             if ($optionid) {
882                 $allusers = array_merge($allusers, array_keys($userlist));
883             }
884         }
885         $responsecount = count(array_unique($allusers));
886         $choicenode->add(get_string("viewallresponses", "choice", $responsecount), new moodle_url('/mod/choice/report.php', array('id'=>$PAGE->cm->id)));
887     }
890 /**
891  * Obtains the automatic completion state for this choice based on any conditions
892  * in forum settings.
893  *
894  * @param object $course Course
895  * @param object $cm Course-module
896  * @param int $userid User ID
897  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
898  * @return bool True if completed, false if not, $type if conditions not set.
899  */
900 function choice_get_completion_state($course, $cm, $userid, $type) {
901     global $CFG,$DB;
903     // Get choice details
904     $choice = $DB->get_record('choice', array('id'=>$cm->instance), '*',
905             MUST_EXIST);
907     // If completion option is enabled, evaluate it and return true/false
908     if($choice->completionsubmit) {
909         return $DB->record_exists('choice_answers', array(
910                 'choiceid'=>$choice->id, 'userid'=>$userid));
911     } else {
912         // Completion option is not enabled so just return $type
913         return $type;
914     }
917 /**
918  * Return a list of page types
919  * @param string $pagetype current page type
920  * @param stdClass $parentcontext Block's parent context
921  * @param stdClass $currentcontext Current context of block
922  */
923 function choice_page_type_list($pagetype, $parentcontext, $currentcontext) {
924     $module_pagetype = array('mod-choice-*'=>get_string('page-mod-choice-x', 'choice'));
925     return $module_pagetype;
928 /**
929  * Prints choice summaries on MyMoodle Page
930  *
931  * Prints choice name, due date and attempt information on
932  * choice activities that have a deadline that has not already passed
933  * and it is available for completing.
934  *
935  * @deprecated since 3.3
936  * @todo The final deprecation of this function will take place in Moodle 3.7 - see MDL-57487.
937  * @uses CONTEXT_MODULE
938  * @param array $courses An array of course objects to get choice instances from.
939  * @param array $htmlarray Store overview output array( course ID => 'choice' => HTML output )
940  */
941 function choice_print_overview($courses, &$htmlarray) {
942     global $USER, $DB, $OUTPUT;
944     debugging('The function choice_print_overview() is now deprecated.', DEBUG_DEVELOPER);
946     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
947         return;
948     }
949     if (!$choices = get_all_instances_in_courses('choice', $courses)) {
950         return;
951     }
953     $now = time();
954     foreach ($choices as $choice) {
955         if ($choice->timeclose != 0                                      // If this choice is scheduled.
956             and $choice->timeclose >= $now                               // And the deadline has not passed.
957             and ($choice->timeopen == 0 or $choice->timeopen <= $now)) { // And the choice is available.
959             // Visibility.
960             $class = (!$choice->visible) ? 'dimmed' : '';
962             // Link to activity.
963             $url = new moodle_url('/mod/choice/view.php', array('id' => $choice->coursemodule));
964             $url = html_writer::link($url, format_string($choice->name), array('class' => $class));
965             $str = $OUTPUT->box(get_string('choiceactivityname', 'choice', $url), 'name');
967              // Deadline.
968             $str .= $OUTPUT->box(get_string('choicecloseson', 'choice', userdate($choice->timeclose)), 'info');
970             // Display relevant info based on permissions.
971             if (has_capability('mod/choice:readresponses', context_module::instance($choice->coursemodule))) {
972                 $attempts = $DB->count_records_sql('SELECT COUNT(DISTINCT userid) FROM {choice_answers} WHERE choiceid = ?',
973                     [$choice->id]);
974                 $url = new moodle_url('/mod/choice/report.php', ['id' => $choice->coursemodule]);
975                 $str .= $OUTPUT->box(html_writer::link($url, get_string('viewallresponses', 'choice', $attempts)), 'info');
977             } else if (has_capability('mod/choice:choose', context_module::instance($choice->coursemodule))) {
978                 // See if the user has submitted anything.
979                 $answers = $DB->count_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id));
980                 if ($answers > 0) {
981                     // User has already selected an answer, nothing to show.
982                     $str = '';
983                 } else {
984                     // User has not made a selection yet.
985                     $str .= $OUTPUT->box(get_string('notanswered', 'choice'), 'info');
986                 }
987             } else {
988                 // Does not have permission to do anything on this choice activity.
989                 $str = '';
990             }
992             // Make sure we have something to display.
993             if (!empty($str)) {
994                 // Generate the containing div.
995                 $str = $OUTPUT->box($str, 'choice overview');
997                 if (empty($htmlarray[$choice->course]['choice'])) {
998                     $htmlarray[$choice->course]['choice'] = $str;
999                 } else {
1000                     $htmlarray[$choice->course]['choice'] .= $str;
1001                 }
1002             }
1003         }
1004     }
1005     return;
1009 /**
1010  * Get my responses on a given choice.
1011  *
1012  * @param stdClass $choice Choice record
1013  * @return array of choice answers records
1014  * @since  Moodle 3.0
1015  */
1016 function choice_get_my_response($choice) {
1017     global $DB, $USER;
1018     return $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id), 'optionid');
1022 /**
1023  * Get all the responses on a given choice.
1024  *
1025  * @param stdClass $choice Choice record
1026  * @return array of choice answers records
1027  * @since  Moodle 3.0
1028  */
1029 function choice_get_all_responses($choice) {
1030     global $DB;
1031     return $DB->get_records('choice_answers', array('choiceid' => $choice->id));
1035 /**
1036  * Return true if we are allowd to view the choice results.
1037  *
1038  * @param stdClass $choice Choice record
1039  * @param rows|null $current my choice responses
1040  * @param bool|null $choiceopen if the choice is open
1041  * @return bool true if we can view the results, false otherwise.
1042  * @since  Moodle 3.0
1043  */
1044 function choice_can_view_results($choice, $current = null, $choiceopen = null) {
1046     if (is_null($choiceopen)) {
1047         $timenow = time();
1049         if ($choice->timeopen != 0 && $timenow < $choice->timeopen) {
1050             // If the choice is not available, we can't see the results.
1051             return false;
1052         }
1054         if ($choice->timeclose != 0 && $timenow > $choice->timeclose) {
1055             $choiceopen = false;
1056         } else {
1057             $choiceopen = true;
1058         }
1059     }
1060     if (empty($current)) {
1061         $current = choice_get_my_response($choice);
1062     }
1064     if ($choice->showresults == CHOICE_SHOWRESULTS_ALWAYS or
1065        ($choice->showresults == CHOICE_SHOWRESULTS_AFTER_ANSWER and !empty($current)) or
1066        ($choice->showresults == CHOICE_SHOWRESULTS_AFTER_CLOSE and !$choiceopen)) {
1067         return true;
1068     }
1069     return false;
1072 /**
1073  * Mark the activity completed (if required) and trigger the course_module_viewed event.
1074  *
1075  * @param  stdClass $choice     choice object
1076  * @param  stdClass $course     course object
1077  * @param  stdClass $cm         course module object
1078  * @param  stdClass $context    context object
1079  * @since Moodle 3.0
1080  */
1081 function choice_view($choice, $course, $cm, $context) {
1083     // Trigger course_module_viewed event.
1084     $params = array(
1085         'context' => $context,
1086         'objectid' => $choice->id
1087     );
1089     $event = \mod_choice\event\course_module_viewed::create($params);
1090     $event->add_record_snapshot('course_modules', $cm);
1091     $event->add_record_snapshot('course', $course);
1092     $event->add_record_snapshot('choice', $choice);
1093     $event->trigger();
1095     // Completion.
1096     $completion = new completion_info($course);
1097     $completion->set_module_viewed($cm);
1100 /**
1101  * Check if a choice is available for the current user.
1102  *
1103  * @param  stdClass  $choice            choice record
1104  * @return array                       status (available or not and possible warnings)
1105  */
1106 function choice_get_availability_status($choice) {
1107     $available = true;
1108     $warnings = array();
1110     $timenow = time();
1112     if (!empty($choice->timeopen) && ($choice->timeopen > $timenow)) {
1113         $available = false;
1114         $warnings['notopenyet'] = userdate($choice->timeopen);
1115     } else if (!empty($choice->timeclose) && ($timenow > $choice->timeclose)) {
1116         $available = false;
1117         $warnings['expired'] = userdate($choice->timeclose);
1118     }
1119     if (!$choice->allowupdate && choice_get_my_response($choice)) {
1120         $available = false;
1121         $warnings['choicesaved'] = '';
1122     }
1124     // Choice is available.
1125     return array($available, $warnings);
1128 /**
1129  * This standard function will check all instances of this module
1130  * and make sure there are up-to-date events created for each of them.
1131  * If courseid = 0, then every choice event in the site is checked, else
1132  * only choice events belonging to the course specified are checked.
1133  * This function is used, in its new format, by restore_refresh_events()
1134  *
1135  * @param int $courseid
1136  * @param int|stdClass $instance Choice module instance or ID.
1137  * @param int|stdClass $cm Course module object or ID (not used in this module).
1138  * @return bool
1139  */
1140 function choice_refresh_events($courseid = 0, $instance = null, $cm = null) {
1141     global $DB, $CFG;
1142     require_once($CFG->dirroot.'/mod/choice/locallib.php');
1144     // If we have instance information then we can just update the one event instead of updating all events.
1145     if (isset($instance)) {
1146         if (!is_object($instance)) {
1147             $instance = $DB->get_record('choice', array('id' => $instance), '*', MUST_EXIST);
1148         }
1149         choice_set_events($instance);
1150         return true;
1151     }
1153     if ($courseid) {
1154         if (! $choices = $DB->get_records("choice", array("course" => $courseid))) {
1155             return true;
1156         }
1157     } else {
1158         if (! $choices = $DB->get_records("choice")) {
1159             return true;
1160         }
1161     }
1163     foreach ($choices as $choice) {
1164         choice_set_events($choice);
1165     }
1166     return true;
1169 /**
1170  * Check if the module has any update that affects the current user since a given time.
1171  *
1172  * @param  cm_info $cm course module data
1173  * @param  int $from the time to check updates from
1174  * @param  array $filter  if we need to check only specific updates
1175  * @return stdClass an object with the different type of areas indicating if they were updated or not
1176  * @since Moodle 3.2
1177  */
1178 function choice_check_updates_since(cm_info $cm, $from, $filter = array()) {
1179     global $DB;
1181     $updates = new stdClass();
1182     $choice = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
1183     list($available, $warnings) = choice_get_availability_status($choice);
1184     if (!$available) {
1185         return $updates;
1186     }
1188     $updates = course_check_module_updates_since($cm, $from, array(), $filter);
1190     if (!choice_can_view_results($choice)) {
1191         return $updates;
1192     }
1193     // Check if there are new responses in the choice.
1194     $updates->answers = (object) array('updated' => false);
1195     $select = 'choiceid = :id AND timemodified > :since';
1196     $params = array('id' => $choice->id, 'since' => $from);
1197     $answers = $DB->get_records_select('choice_answers', $select, $params, '', 'id');
1198     if (!empty($answers)) {
1199         $updates->answers->updated = true;
1200         $updates->answers->itemids = array_keys($answers);
1201     }
1203     return $updates;
1206 /**
1207  * This function receives a calendar event and returns the action associated with it, or null if there is none.
1208  *
1209  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
1210  * is not displayed on the block.
1211  *
1212  * @param calendar_event $event
1213  * @param \core_calendar\action_factory $factory
1214  * @return \core_calendar\local\event\entities\action_interface|null
1215  */
1216 function mod_choice_core_calendar_provide_event_action(calendar_event $event,
1217                                                        \core_calendar\action_factory $factory) {
1219     $cm = get_fast_modinfo($event->courseid)->instances['choice'][$event->instance];
1220     $now = time();
1222     if (!empty($cm->customdata['timeclose']) && $cm->customdata['timeclose'] < $now) {
1223         // The choice has closed so the user can no longer submit anything.
1224         return null;
1225     }
1227     // The choice is actionable if we don't have a start time or the start time is
1228     // in the past.
1229     $actionable = (empty($cm->customdata['timeopen']) || $cm->customdata['timeopen'] <= $now);
1231     if ($actionable && choice_get_my_response((object)['id' => $event->instance])) {
1232         // There is no action if the user has already submitted their choice.
1233         return null;
1234     }
1236     return $factory->create_instance(
1237         get_string('viewchoices', 'choice'),
1238         new \moodle_url('/mod/choice/view.php', array('id' => $cm->id)),
1239         1,
1240         $actionable
1241     );
1244 /**
1245  * This function calculates the minimum and maximum cutoff values for the timestart of
1246  * the given event.
1247  *
1248  * It will return an array with two values, the first being the minimum cutoff value and
1249  * the second being the maximum cutoff value. Either or both values can be null, which
1250  * indicates there is no minimum or maximum, respectively.
1251  *
1252  * If a cutoff is required then the function must return an array containing the cutoff
1253  * timestamp and error string to display to the user if the cutoff value is violated.
1254  *
1255  * A minimum and maximum cutoff return value will look like:
1256  * [
1257  *     [1505704373, 'The date must be after this date'],
1258  *     [1506741172, 'The date must be before this date']
1259  * ]
1260  *
1261  * @param calendar_event $event The calendar event to get the time range for
1262  * @param stdClass $choice The module instance to get the range from
1263  */
1264 function mod_choice_core_calendar_get_valid_event_timestart_range(\calendar_event $event, \stdClass $choice) {
1265     $mindate = null;
1266     $maxdate = null;
1268     if ($event->eventtype == CHOICE_EVENT_TYPE_OPEN) {
1269         if (!empty($choice->timeclose)) {
1270             $maxdate = [
1271                 $choice->timeclose,
1272                 get_string('openafterclose', 'choice')
1273             ];
1274         }
1275     } else if ($event->eventtype == CHOICE_EVENT_TYPE_CLOSE) {
1276         if (!empty($choice->timeopen)) {
1277             $mindate = [
1278                 $choice->timeopen,
1279                 get_string('closebeforeopen', 'choice')
1280             ];
1281         }
1282     }
1284     return [$mindate, $maxdate];
1287 /**
1288  * This function will update the choice module according to the
1289  * event that has been modified.
1290  *
1291  * It will set the timeopen or timeclose value of the choice instance
1292  * according to the type of event provided.
1293  *
1294  * @throws \moodle_exception
1295  * @param \calendar_event $event
1296  * @param stdClass $choice The module instance to get the range from
1297  */
1298 function mod_choice_core_calendar_event_timestart_updated(\calendar_event $event, \stdClass $choice) {
1299     global $DB;
1301     if (!in_array($event->eventtype, [CHOICE_EVENT_TYPE_OPEN, CHOICE_EVENT_TYPE_CLOSE])) {
1302         return;
1303     }
1305     $courseid = $event->courseid;
1306     $modulename = $event->modulename;
1307     $instanceid = $event->instance;
1308     $modified = false;
1310     // Something weird going on. The event is for a different module so
1311     // we should ignore it.
1312     if ($modulename != 'choice') {
1313         return;
1314     }
1316     if ($choice->id != $instanceid) {
1317         return;
1318     }
1320     $coursemodule = get_fast_modinfo($courseid)->instances[$modulename][$instanceid];
1321     $context = context_module::instance($coursemodule->id);
1323     // The user does not have the capability to modify this activity.
1324     if (!has_capability('moodle/course:manageactivities', $context)) {
1325         return;
1326     }
1328     if ($event->eventtype == CHOICE_EVENT_TYPE_OPEN) {
1329         // If the event is for the choice activity opening then we should
1330         // set the start time of the choice activity to be the new start
1331         // time of the event.
1332         if ($choice->timeopen != $event->timestart) {
1333             $choice->timeopen = $event->timestart;
1334             $modified = true;
1335         }
1336     } else if ($event->eventtype == CHOICE_EVENT_TYPE_CLOSE) {
1337         // If the event is for the choice activity closing then we should
1338         // set the end time of the choice activity to be the new start
1339         // time of the event.
1340         if ($choice->timeclose != $event->timestart) {
1341             $choice->timeclose = $event->timestart;
1342             $modified = true;
1343         }
1344     }
1346     if ($modified) {
1347         $choice->timemodified = time();
1348         // Persist the instance changes.
1349         $DB->update_record('choice', $choice);
1350         $event = \core\event\course_module_updated::create_from_cm($coursemodule, $context);
1351         $event->trigger();
1352     }
1355 /**
1356  * Get icon mapping for font-awesome.
1357  */
1358 function mod_choice_get_fontawesome_icon_map() {
1359     return [
1360         'mod_choice:row' => 'fa-info',
1361         'mod_choice:column' => 'fa-columns',
1362     ];
1365 /**
1366  * Add a get_coursemodule_info function in case any choice type wants to add 'extra' information
1367  * for the course (see resource).
1368  *
1369  * Given a course_module object, this function returns any "extra" information that may be needed
1370  * when printing this activity in a course listing.  See get_array_of_activities() in course/lib.php.
1371  *
1372  * @param stdClass $coursemodule The coursemodule object (record).
1373  * @return cached_cm_info An object on information that the courses
1374  *                        will know about (most noticeably, an icon).
1375  */
1376 function choice_get_coursemodule_info($coursemodule) {
1377     global $DB;
1379     $dbparams = ['id' => $coursemodule->instance];
1380     $fields = 'id, name, intro, introformat, completionsubmit, timeopen, timeclose';
1381     if (!$choice = $DB->get_record('choice', $dbparams, $fields)) {
1382         return false;
1383     }
1385     $result = new cached_cm_info();
1386     $result->name = $choice->name;
1388     if ($coursemodule->showdescription) {
1389         // Convert intro to html. Do not filter cached version, filters run at display time.
1390         $result->content = format_module_intro('choice', $choice, $coursemodule->id, false);
1391     }
1393     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
1394     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
1395         $result->customdata['customcompletionrules']['completionsubmit'] = $choice->completionsubmit;
1396     }
1397     // Populate some other values that can be used in calendar or on dashboard.
1398     if ($choice->timeopen) {
1399         $result->customdata['timeopen'] = $choice->timeopen;
1400     }
1401     if ($choice->timeclose) {
1402         $result->customdata['timeclose'] = $choice->timeclose;
1403     }
1405     return $result;
1408 /**
1409  * Callback which returns human-readable strings describing the active completion custom rules for the module instance.
1410  *
1411  * @param cm_info|stdClass $cm object with fields ->completion and ->customdata['customcompletionrules']
1412  * @return array $descriptions the array of descriptions for the custom rules.
1413  */
1414 function mod_choice_get_completion_active_rule_descriptions($cm) {
1415     // Values will be present in cm_info, and we assume these are up to date.
1416     if (empty($cm->customdata['customcompletionrules'])
1417         || $cm->completion != COMPLETION_TRACKING_AUTOMATIC) {
1418         return [];
1419     }
1421     $descriptions = [];
1422     foreach ($cm->customdata['customcompletionrules'] as $key => $val) {
1423         switch ($key) {
1424             case 'completionsubmit':
1425                 if (empty($val)) {
1426                     continue;
1427                 }
1428                 $descriptions[] = get_string('completionsubmit', 'choice');
1429                 break;
1430             default:
1431                 break;
1432         }
1433     }
1434     return $descriptions;