forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lib.php
1393 lines (1208 loc) · 47.3 KB
/
lib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* @package mod_choice
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/** @global int $CHOICE_COLUMN_HEIGHT */
global $CHOICE_COLUMN_HEIGHT;
$CHOICE_COLUMN_HEIGHT = 300;
/** @global int $CHOICE_COLUMN_WIDTH */
global $CHOICE_COLUMN_WIDTH;
$CHOICE_COLUMN_WIDTH = 300;
define('CHOICE_PUBLISH_ANONYMOUS', '0');
define('CHOICE_PUBLISH_NAMES', '1');
define('CHOICE_SHOWRESULTS_NOT', '0');
define('CHOICE_SHOWRESULTS_AFTER_ANSWER', '1');
define('CHOICE_SHOWRESULTS_AFTER_CLOSE', '2');
define('CHOICE_SHOWRESULTS_ALWAYS', '3');
define('CHOICE_DISPLAY_HORIZONTAL', '0');
define('CHOICE_DISPLAY_VERTICAL', '1');
define('CHOICE_EVENT_TYPE_OPEN', 'open');
define('CHOICE_EVENT_TYPE_CLOSE', 'close');
/** @global array $CHOICE_PUBLISH */
global $CHOICE_PUBLISH;
$CHOICE_PUBLISH = array (CHOICE_PUBLISH_ANONYMOUS => get_string('publishanonymous', 'choice'),
CHOICE_PUBLISH_NAMES => get_string('publishnames', 'choice'));
/** @global array $CHOICE_SHOWRESULTS */
global $CHOICE_SHOWRESULTS;
$CHOICE_SHOWRESULTS = array (CHOICE_SHOWRESULTS_NOT => get_string('publishnot', 'choice'),
CHOICE_SHOWRESULTS_AFTER_ANSWER => get_string('publishafteranswer', 'choice'),
CHOICE_SHOWRESULTS_AFTER_CLOSE => get_string('publishafterclose', 'choice'),
CHOICE_SHOWRESULTS_ALWAYS => get_string('publishalways', 'choice'));
/** @global array $CHOICE_DISPLAY */
global $CHOICE_DISPLAY;
$CHOICE_DISPLAY = array (CHOICE_DISPLAY_HORIZONTAL => get_string('displayhorizontal', 'choice'),
CHOICE_DISPLAY_VERTICAL => get_string('displayvertical','choice'));
/// Standard functions /////////////////////////////////////////////////////////
/**
* @global object
* @param object $course
* @param object $user
* @param object $mod
* @param object $choice
* @return object|null
*/
function choice_user_outline($course, $user, $mod, $choice) {
global $DB;
if ($answer = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id))) {
$result = new stdClass();
$result->info = "'".format_string(choice_get_option_text($choice, $answer->optionid))."'";
$result->time = $answer->timemodified;
return $result;
}
return NULL;
}
/**
* Callback for the "Complete" report - prints the activity summary for the given user
*
* @param object $course
* @param object $user
* @param object $mod
* @param object $choice
*/
function choice_user_complete($course, $user, $mod, $choice) {
global $DB;
if ($answers = $DB->get_records('choice_answers', array("choiceid" => $choice->id, "userid" => $user->id))) {
$info = [];
foreach ($answers as $answer) {
$info[] = "'" . format_string(choice_get_option_text($choice, $answer->optionid)) . "'";
}
core_collator::asort($info);
echo get_string("answered", "choice") . ": ". join(', ', $info) . ". " .
get_string("updated", '', userdate($answer->timemodified));
} else {
print_string("notanswered", "choice");
}
}
/**
* Given an object containing all the necessary data,
* (defined by the form in mod_form.php) this function
* will create a new instance and return the id number
* of the new instance.
*
* @global object
* @param object $choice
* @return int
*/
function choice_add_instance($choice) {
global $DB, $CFG;
require_once($CFG->dirroot.'/mod/choice/locallib.php');
$choice->timemodified = time();
//insert answers
$choice->id = $DB->insert_record("choice", $choice);
foreach ($choice->option as $key => $value) {
$value = trim($value);
if (isset($value) && $value <> '') {
$option = new stdClass();
$option->text = $value;
$option->choiceid = $choice->id;
if (isset($choice->limit[$key])) {
$option->maxanswers = $choice->limit[$key];
}
$option->timemodified = time();
$DB->insert_record("choice_options", $option);
}
}
// Add calendar events if necessary.
choice_set_events($choice);
if (!empty($choice->completionexpected)) {
\core_completion\api::update_completion_date_event($choice->coursemodule, 'choice', $choice->id,
$choice->completionexpected);
}
return $choice->id;
}
/**
* Given an object containing all the necessary data,
* (defined by the form in mod_form.php) this function
* will update an existing instance with new data.
*
* @global object
* @param object $choice
* @return bool
*/
function choice_update_instance($choice) {
global $DB, $CFG;
require_once($CFG->dirroot.'/mod/choice/locallib.php');
$choice->id = $choice->instance;
$choice->timemodified = time();
//update, delete or insert answers
foreach ($choice->option as $key => $value) {
$value = trim($value);
$option = new stdClass();
$option->text = $value;
$option->choiceid = $choice->id;
if (isset($choice->limit[$key])) {
$option->maxanswers = $choice->limit[$key];
}
$option->timemodified = time();
if (isset($choice->optionid[$key]) && !empty($choice->optionid[$key])){//existing choice record
$option->id=$choice->optionid[$key];
if (isset($value) && $value <> '') {
$DB->update_record("choice_options", $option);
} else {
// Remove the empty (unused) option.
$DB->delete_records("choice_options", array("id" => $option->id));
// Delete any answers associated with this option.
$DB->delete_records("choice_answers", array("choiceid" => $choice->id, "optionid" => $option->id));
}
} else {
if (isset($value) && $value <> '') {
$DB->insert_record("choice_options", $option);
}
}
}
// Add calendar events if necessary.
choice_set_events($choice);
$completionexpected = (!empty($choice->completionexpected)) ? $choice->completionexpected : null;
\core_completion\api::update_completion_date_event($choice->coursemodule, 'choice', $choice->id, $completionexpected);
return $DB->update_record('choice', $choice);
}
/**
* @global object
* @param object $choice
* @param object $user
* @param object $coursemodule
* @param array $allresponses
* @return array
*/
function choice_prepare_options($choice, $user, $coursemodule, $allresponses) {
global $DB;
$cdisplay = array('options'=>array());
$cdisplay['limitanswers'] = $choice->limitanswers;
$cdisplay['showavailable'] = $choice->showavailable;
$context = context_module::instance($coursemodule->id);
foreach ($choice->option as $optionid => $text) {
if (isset($text)) { //make sure there are no dud entries in the db with blank text values.
$option = new stdClass;
$option->attributes = new stdClass;
$option->attributes->value = $optionid;
$option->text = format_string($text);
$option->maxanswers = $choice->maxanswers[$optionid];
$option->displaylayout = $choice->display;
if (isset($allresponses[$optionid])) {
$option->countanswers = count($allresponses[$optionid]);
} else {
$option->countanswers = 0;
}
if ($DB->record_exists('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id, 'optionid' => $optionid))) {
$option->attributes->checked = true;
}
if ( $choice->limitanswers && ($option->countanswers >= $option->maxanswers) && empty($option->attributes->checked)) {
$option->attributes->disabled = true;
}
$cdisplay['options'][] = $option;
}
}
$cdisplay['hascapability'] = is_enrolled($context, NULL, 'mod/choice:choose'); //only enrolled users are allowed to make a choice
if ($choice->allowupdate && $DB->record_exists('choice_answers', array('choiceid'=> $choice->id, 'userid'=> $user->id))) {
$cdisplay['allowupdate'] = true;
}
if ($choice->showpreview && $choice->timeopen > time()) {
$cdisplay['previewonly'] = true;
}
return $cdisplay;
}
/**
* Modifies responses of other users adding the option $newoptionid to them
*
* @param array $userids list of users to add option to (must be users without any answers yet)
* @param array $answerids list of existing attempt ids of users (will be either appended or
* substituted with the newoptionid, depending on $choice->allowmultiple)
* @param int $newoptionid
* @param stdClass $choice choice object, result of {@link choice_get_choice()}
* @param stdClass $cm
* @param stdClass $course
*/
function choice_modify_responses($userids, $answerids, $newoptionid, $choice, $cm, $course) {
// Get all existing responses and the list of non-respondents.
$groupmode = groups_get_activity_groupmode($cm);
$onlyactive = $choice->includeinactive ? false : true;
$allresponses = choice_get_response_data($choice, $cm, $groupmode, $onlyactive);
// Check that the option value is valid.
if (!$newoptionid || !isset($choice->option[$newoptionid])) {
return;
}
// First add responses for users who did not make any choice yet.
foreach ($userids as $userid) {
if (isset($allresponses[0][$userid])) {
choice_user_submit_response($newoptionid, $choice, $userid, $course, $cm);
}
}
// Create the list of all options already selected by each user.
$optionsbyuser = []; // Mapping userid=>array of chosen choice options.
$usersbyanswer = []; // Mapping answerid=>userid (which answer belongs to each user).
foreach ($allresponses as $optionid => $responses) {
if ($optionid > 0) {
foreach ($responses as $userid => $userresponse) {
$optionsbyuser += [$userid => []];
$optionsbyuser[$userid][] = $optionid;
$usersbyanswer[$userresponse->answerid] = $userid;
}
}
}
// Go through the list of submitted attemptids and find which users answers need to be updated.
foreach ($answerids as $answerid) {
if (isset($usersbyanswer[$answerid])) {
$userid = $usersbyanswer[$answerid];
if (!in_array($newoptionid, $optionsbyuser[$userid])) {
$options = $choice->allowmultiple ?
array_merge($optionsbyuser[$userid], [$newoptionid]) : $newoptionid;
choice_user_submit_response($options, $choice, $userid, $course, $cm);
}
}
}
}
/**
* Process user submitted answers for a choice,
* and either updating them or saving new answers.
*
* @param int|array $formanswer the id(s) of the user submitted choice options.
* @param object $choice the selected choice.
* @param int $userid user identifier.
* @param object $course current course.
* @param object $cm course context.
* @return void
*/
function choice_user_submit_response($formanswer, $choice, $userid, $course, $cm) {
global $DB, $CFG, $USER;
require_once($CFG->libdir.'/completionlib.php');
$continueurl = new moodle_url('/mod/choice/view.php', array('id' => $cm->id));
if (empty($formanswer)) {
print_error('atleastoneoption', 'choice', $continueurl);
}
if (is_array($formanswer)) {
if (!$choice->allowmultiple) {
print_error('multiplenotallowederror', 'choice', $continueurl);
}
$formanswers = $formanswer;
} else {
$formanswers = array($formanswer);
}
$options = $DB->get_records('choice_options', array('choiceid' => $choice->id), '', 'id');
foreach ($formanswers as $key => $val) {
if (!isset($options[$val])) {
print_error('cannotsubmit', 'choice', $continueurl);
}
}
// Start lock to prevent synchronous access to the same data
// before it's updated, if using limits.
if ($choice->limitanswers) {
$timeout = 10;
$locktype = 'mod_choice_choice_user_submit_response';
// Limiting access to this choice.
$resouce = 'choiceid:' . $choice->id;
$lockfactory = \core\lock\lock_config::get_lock_factory($locktype);
// Opening the lock.
$choicelock = $lockfactory->get_lock($resouce, $timeout, MINSECS);
if (!$choicelock) {
print_error('cannotsubmit', 'choice', $continueurl);
}
}
$current = $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $userid));
// Array containing [answerid => optionid] mapping.
$existinganswers = array_map(function($answer) {
return $answer->optionid;
}, $current);
$context = context_module::instance($cm->id);
$choicesexceeded = false;
$countanswers = array();
foreach ($formanswers as $val) {
$countanswers[$val] = 0;
}
if($choice->limitanswers) {
// Find out whether groups are being used and enabled
if (groups_get_activity_groupmode($cm) > 0) {
$currentgroup = groups_get_activity_group($cm);
} else {
$currentgroup = 0;
}
list ($insql, $params) = $DB->get_in_or_equal($formanswers, SQL_PARAMS_NAMED);
if($currentgroup) {
// If groups are being used, retrieve responses only for users in
// current group
global $CFG;
$params['groupid'] = $currentgroup;
$sql = "SELECT ca.*
FROM {choice_answers} ca
INNER JOIN {groups_members} gm ON ca.userid=gm.userid
WHERE optionid $insql
AND gm.groupid= :groupid";
} else {
// Groups are not used, retrieve all answers for this option ID
$sql = "SELECT ca.*
FROM {choice_answers} ca
WHERE optionid $insql";
}
$answers = $DB->get_records_sql($sql, $params);
if ($answers) {
foreach ($answers as $a) { //only return enrolled users.
if (is_enrolled($context, $a->userid, 'mod/choice:choose')) {
$countanswers[$a->optionid]++;
}
}
}
foreach ($countanswers as $opt => $count) {
// Ignore the user's existing answers when checking whether an answer count has been exceeded.
// A user may wish to update their response with an additional choice option and shouldn't be competing with themself!
if (in_array($opt, $existinganswers)) {
continue;
}
if ($count >= $choice->maxanswers[$opt]) {
$choicesexceeded = true;
break;
}
}
}
// Check the user hasn't exceeded the maximum selections for the choice(s) they have selected.
$answersnapshots = array();
$deletedanswersnapshots = array();
if (!($choice->limitanswers && $choicesexceeded)) {
if ($current) {
// Update an existing answer.
foreach ($current as $c) {
if (in_array($c->optionid, $formanswers)) {
$DB->set_field('choice_answers', 'timemodified', time(), array('id' => $c->id));
} else {
$deletedanswersnapshots[] = $c;
$DB->delete_records('choice_answers', array('id' => $c->id));
}
}
// Add new ones.
foreach ($formanswers as $f) {
if (!in_array($f, $existinganswers)) {
$newanswer = new stdClass();
$newanswer->optionid = $f;
$newanswer->choiceid = $choice->id;
$newanswer->userid = $userid;
$newanswer->timemodified = time();
$newanswer->id = $DB->insert_record("choice_answers", $newanswer);
$answersnapshots[] = $newanswer;
}
}
} else {
// Add new answer.
foreach ($formanswers as $answer) {
$newanswer = new stdClass();
$newanswer->choiceid = $choice->id;
$newanswer->userid = $userid;
$newanswer->optionid = $answer;
$newanswer->timemodified = time();
$newanswer->id = $DB->insert_record("choice_answers", $newanswer);
$answersnapshots[] = $newanswer;
}
// Update completion state
$completion = new completion_info($course);
if ($completion->is_enabled($cm) && $choice->completionsubmit) {
$completion->update_state($cm, COMPLETION_COMPLETE);
}
}
} else {
// This is a choice with limited options, and one of the options selected has just run over its limit.
$choicelock->release();
print_error('choicefull', 'choice', $continueurl);
}
// Release lock.
if (isset($choicelock)) {
$choicelock->release();
}
// Trigger events.
foreach ($deletedanswersnapshots as $answer) {
\mod_choice\event\answer_deleted::create_from_object($answer, $choice, $cm, $course)->trigger();
}
foreach ($answersnapshots as $answer) {
\mod_choice\event\answer_created::create_from_object($answer, $choice, $cm, $course)->trigger();
}
}
/**
* @param array $user
* @param object $cm
* @return void Output is echo'd
*/
function choice_show_reportlink($user, $cm) {
$userschosen = array();
foreach($user as $optionid => $userlist) {
if ($optionid) {
$userschosen = array_merge($userschosen, array_keys($userlist));
}
}
$responsecount = count(array_unique($userschosen));
echo '<div class="reportlink">';
echo "<a href=\"report.php?id=$cm->id\">".get_string("viewallresponses", "choice", $responsecount)."</a>";
echo '</div>';
}
/**
* @global object
* @param object $choice
* @param object $course
* @param object $coursemodule
* @param array $allresponses
* * @param bool $allresponses
* @return object
*/
function prepare_choice_show_results($choice, $course, $cm, $allresponses) {
global $OUTPUT;
$display = clone($choice);
$display->coursemoduleid = $cm->id;
$display->courseid = $course->id;
if (!empty($choice->showunanswered)) {
$choice->option[0] = get_string('notanswered', 'choice');
$choice->maxanswers[0] = 0;
}
// Remove from the list of non-respondents the users who do not have access to this activity.
if (!empty($display->showunanswered) && $allresponses[0]) {
$info = new \core_availability\info_module(cm_info::create($cm));
$allresponses[0] = $info->filter_user_list($allresponses[0]);
}
//overwrite options value;
$display->options = array();
$allusers = [];
foreach ($choice->option as $optionid => $optiontext) {
$display->options[$optionid] = new stdClass;
$display->options[$optionid]->text = format_string($optiontext, true,
['context' => context_module::instance($cm->id)]);
$display->options[$optionid]->maxanswer = $choice->maxanswers[$optionid];
if (array_key_exists($optionid, $allresponses)) {
$display->options[$optionid]->user = $allresponses[$optionid];
$allusers = array_merge($allusers, array_keys($allresponses[$optionid]));
}
}
unset($display->option);
unset($display->maxanswers);
$display->numberofuser = count(array_unique($allusers));
$context = context_module::instance($cm->id);
$display->viewresponsecapability = has_capability('mod/choice:readresponses', $context);
$display->deleterepsonsecapability = has_capability('mod/choice:deleteresponses',$context);
$display->fullnamecapability = has_capability('moodle/site:viewfullnames', $context);
if (empty($allresponses)) {
echo $OUTPUT->heading(get_string("nousersyet"), 3, null);
return false;
}
return $display;
}
/**
* @global object
* @param array $attemptids
* @param object $choice Choice main table row
* @param object $cm Course-module object
* @param object $course Course object
* @return bool
*/
function choice_delete_responses($attemptids, $choice, $cm, $course) {
global $DB, $CFG, $USER;
require_once($CFG->libdir.'/completionlib.php');
if(!is_array($attemptids) || empty($attemptids)) {
return false;
}
foreach($attemptids as $num => $attemptid) {
if(empty($attemptid)) {
unset($attemptids[$num]);
}
}
$completion = new completion_info($course);
foreach($attemptids as $attemptid) {
if ($todelete = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid))) {
// Trigger the event answer deleted.
\mod_choice\event\answer_deleted::create_from_object($todelete, $choice, $cm, $course)->trigger();
$DB->delete_records('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid));
}
}
// Update completion state.
if ($completion->is_enabled($cm) && $choice->completionsubmit) {
$completion->update_state($cm, COMPLETION_INCOMPLETE);
}
return true;
}
/**
* Given an ID of an instance of this module,
* this function will permanently delete the instance
* and any data that depends on it.
*
* @global object
* @param int $id
* @return bool
*/
function choice_delete_instance($id) {
global $DB;
if (! $choice = $DB->get_record("choice", array("id"=>"$id"))) {
return false;
}
$result = true;
if (! $DB->delete_records("choice_answers", array("choiceid"=>"$choice->id"))) {
$result = false;
}
if (! $DB->delete_records("choice_options", array("choiceid"=>"$choice->id"))) {
$result = false;
}
if (! $DB->delete_records("choice", array("id"=>"$choice->id"))) {
$result = false;
}
// Remove old calendar events.
if (! $DB->delete_records('event', array('modulename' => 'choice', 'instance' => $choice->id))) {
$result = false;
}
return $result;
}
/**
* Returns text string which is the answer that matches the id
*
* @global object
* @param object $choice
* @param int $id
* @return string
*/
function choice_get_option_text($choice, $id) {
global $DB;
if ($result = $DB->get_record("choice_options", array("id" => $id))) {
return $result->text;
} else {
return get_string("notanswered", "choice");
}
}
/**
* Gets a full choice record
*
* @global object
* @param int $choiceid
* @return object|bool The choice or false
*/
function choice_get_choice($choiceid) {
global $DB;
if ($choice = $DB->get_record("choice", array("id" => $choiceid))) {
if ($options = $DB->get_records("choice_options", array("choiceid" => $choiceid), "id")) {
foreach ($options as $option) {
$choice->option[$option->id] = $option->text;
$choice->maxanswers[$option->id] = $option->maxanswers;
}
return $choice;
}
}
return false;
}
/**
* List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array
*/
function choice_get_view_actions() {
return array('view','view all','report');
}
/**
* List the actions that correspond to a post of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array
*/
function choice_get_post_actions() {
return array('choose','choose again');
}
/**
* Implementation of the function for printing the form elements that control
* whether the course reset functionality affects the choice.
*
* @param object $mform form passed by reference
*/
function choice_reset_course_form_definition(&$mform) {
$mform->addElement('header', 'choiceheader', get_string('modulenameplural', 'choice'));
$mform->addElement('advcheckbox', 'reset_choice', get_string('removeresponses','choice'));
}
/**
* Course reset form defaults.
*
* @return array
*/
function choice_reset_course_form_defaults($course) {
return array('reset_choice'=>1);
}
/**
* Actual implementation of the reset course functionality, delete all the
* choice responses for course $data->courseid.
*
* @global object
* @global object
* @param object $data the data submitted from the reset course.
* @return array status array
*/
function choice_reset_userdata($data) {
global $CFG, $DB;
$componentstr = get_string('modulenameplural', 'choice');
$status = array();
if (!empty($data->reset_choice)) {
$choicessql = "SELECT ch.id
FROM {choice} ch
WHERE ch.course=?";
$DB->delete_records_select('choice_answers', "choiceid IN ($choicessql)", array($data->courseid));
$status[] = array('component'=>$componentstr, 'item'=>get_string('removeresponses', 'choice'), 'error'=>false);
}
/// updating dates - shift may be negative too
if ($data->timeshift) {
// Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
// See MDL-9367.
shift_course_mod_dates('choice', array('timeopen', 'timeclose'), $data->timeshift, $data->courseid);
$status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
}
return $status;
}
/**
* @global object
* @global object
* @global object
* @uses CONTEXT_MODULE
* @param object $choice
* @param object $cm
* @param int $groupmode
* @param bool $onlyactive Whether to get response data for active users only.
* @return array
*/
function choice_get_response_data($choice, $cm, $groupmode, $onlyactive) {
global $CFG, $USER, $DB;
$context = context_module::instance($cm->id);
/// Get the current group
if ($groupmode > 0) {
$currentgroup = groups_get_activity_group($cm);
} else {
$currentgroup = 0;
}
/// Initialise the returned array, which is a matrix: $allresponses[responseid][userid] = responseobject
$allresponses = array();
/// First get all the users who have access here
/// To start with we assume they are all "unanswered" then move them later
$extrafields = get_extra_user_fields($context);
$allresponses[0] = get_enrolled_users($context, 'mod/choice:choose', $currentgroup,
user_picture::fields('u', $extrafields), null, 0, 0, $onlyactive);
/// Get all the recorded responses for this choice
$rawresponses = $DB->get_records('choice_answers', array('choiceid' => $choice->id));
/// Use the responses to move users into the correct column
if ($rawresponses) {
$answeredusers = array();
foreach ($rawresponses as $response) {
if (isset($allresponses[0][$response->userid])) { // This person is enrolled and in correct group
$allresponses[0][$response->userid]->timemodified = $response->timemodified;
$allresponses[$response->optionid][$response->userid] = clone($allresponses[0][$response->userid]);
$allresponses[$response->optionid][$response->userid]->answerid = $response->id;
$answeredusers[] = $response->userid;
}
}
foreach ($answeredusers as $answereduser) {
unset($allresponses[0][$answereduser]);
}
}
return $allresponses;
}
/**
* @uses FEATURE_GROUPS
* @uses FEATURE_GROUPINGS
* @uses FEATURE_MOD_INTRO
* @uses FEATURE_COMPLETION_TRACKS_VIEWS
* @uses FEATURE_GRADE_HAS_GRADE
* @uses FEATURE_GRADE_OUTCOMES
* @param string $feature FEATURE_xx constant for requested feature
* @return mixed True if module supports feature, null if doesn't know
*/
function choice_supports($feature) {
switch($feature) {
case FEATURE_GROUPS: return true;
case FEATURE_GROUPINGS: return true;
case FEATURE_MOD_INTRO: return true;
case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
case FEATURE_COMPLETION_HAS_RULES: return true;
case FEATURE_GRADE_HAS_GRADE: return false;
case FEATURE_GRADE_OUTCOMES: return false;
case FEATURE_BACKUP_MOODLE2: return true;
case FEATURE_SHOW_DESCRIPTION: return true;
default: return null;
}
}
/**
* Adds module specific settings to the settings block
*
* @param settings_navigation $settings The settings navigation object
* @param navigation_node $choicenode The node to add module settings to
*/
function choice_extend_settings_navigation(settings_navigation $settings, navigation_node $choicenode) {
global $PAGE;
if (has_capability('mod/choice:readresponses', $PAGE->cm->context)) {
$groupmode = groups_get_activity_groupmode($PAGE->cm);
if ($groupmode) {
groups_get_activity_group($PAGE->cm, true);
}
$choice = choice_get_choice($PAGE->cm->instance);
// Check if we want to include responses from inactive users.
$onlyactive = $choice->includeinactive ? false : true;
// Big function, approx 6 SQL calls per user.
$allresponses = choice_get_response_data($choice, $PAGE->cm, $groupmode, $onlyactive);
$allusers = [];
foreach($allresponses as $optionid => $userlist) {
if ($optionid) {
$allusers = array_merge($allusers, array_keys($userlist));
}
}
$responsecount = count(array_unique($allusers));
$choicenode->add(get_string("viewallresponses", "choice", $responsecount), new moodle_url('/mod/choice/report.php', array('id'=>$PAGE->cm->id)));
}
}
/**
* Obtains the automatic completion state for this choice based on any conditions
* in forum settings.
*
* @param object $course Course
* @param object $cm Course-module
* @param int $userid User ID
* @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
* @return bool True if completed, false if not, $type if conditions not set.
*/
function choice_get_completion_state($course, $cm, $userid, $type) {
global $CFG,$DB;
// Get choice details
$choice = $DB->get_record('choice', array('id'=>$cm->instance), '*',
MUST_EXIST);
// If completion option is enabled, evaluate it and return true/false
if($choice->completionsubmit) {
return $DB->record_exists('choice_answers', array(
'choiceid'=>$choice->id, 'userid'=>$userid));
} else {
// Completion option is not enabled so just return $type
return $type;
}
}
/**
* Return a list of page types
* @param string $pagetype current page type
* @param stdClass $parentcontext Block's parent context
* @param stdClass $currentcontext Current context of block
*/
function choice_page_type_list($pagetype, $parentcontext, $currentcontext) {
$module_pagetype = array('mod-choice-*'=>get_string('page-mod-choice-x', 'choice'));
return $module_pagetype;
}
/**
* @deprecated since Moodle 3.3, when the block_course_overview block was removed.
*/
function choice_print_overview() {
throw new coding_exception('choice_print_overview() can not be used any more and is obsolete.');
}
/**
* Get responses of a given user on a given choice.
*
* @param stdClass $choice Choice record
* @param int $userid User id
* @return array of choice answers records
* @since Moodle 3.6
*/
function choice_get_user_response($choice, $userid) {
global $DB;
return $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $userid), 'optionid');
}
/**
* Get my responses on a given choice.
*
* @param stdClass $choice Choice record
* @return array of choice answers records
* @since Moodle 3.0
*/
function choice_get_my_response($choice) {
global $USER;
return choice_get_user_response($choice, $USER->id);
}
/**
* Get all the responses on a given choice.
*
* @param stdClass $choice Choice record
* @return array of choice answers records
* @since Moodle 3.0
*/
function choice_get_all_responses($choice) {
global $DB;
return $DB->get_records('choice_answers', array('choiceid' => $choice->id));
}
/**
* Return true if we are allowd to view the choice results.
*
* @param stdClass $choice Choice record
* @param rows|null $current my choice responses
* @param bool|null $choiceopen if the choice is open
* @return bool true if we can view the results, false otherwise.
* @since Moodle 3.0
*/
function choice_can_view_results($choice, $current = null, $choiceopen = null) {
if (is_null($choiceopen)) {
$timenow = time();
if ($choice->timeopen != 0 && $timenow < $choice->timeopen) {
// If the choice is not available, we can't see the results.
return false;
}
if ($choice->timeclose != 0 && $timenow > $choice->timeclose) {
$choiceopen = false;
} else {
$choiceopen = true;
}
}
if (empty($current)) {
$current = choice_get_my_response($choice);
}