forked from PoetOS/moodle-mod_questionnaire
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlocallib.php
1064 lines (970 loc) · 42.5 KB
/
locallib.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/>.
/**
* This library replaces the phpESP application with Moodle specific code. It will eventually
* replace all of the phpESP application, removing the dependency on that.
*/
/**
* Updates the contents of the survey with the provided data. If no data is provided,
* it checks for posted data.
*
* @param int $survey_id The id of the survey to update.
* @param string $old_tab The function that was being executed.
* @param object $sdata The data to update the survey with.
*
* @return string|boolean The function to go to, or false on error.
*
*/
require_once($CFG->libdir.'/eventslib.php');
require_once($CFG->dirroot.'/calendar/lib.php');
// Constants.
define ('QUESTIONNAIREUNLIMITED', 0);
define ('QUESTIONNAIREONCE', 1);
define ('QUESTIONNAIREDAILY', 2);
define ('QUESTIONNAIREWEEKLY', 3);
define ('QUESTIONNAIREMONTHLY', 4);
define ('QUESTIONNAIRE_STUDENTVIEWRESPONSES_NEVER', 0);
define ('QUESTIONNAIRE_STUDENTVIEWRESPONSES_WHENANSWERED', 1);
define ('QUESTIONNAIRE_STUDENTVIEWRESPONSES_WHENCLOSED', 2);
define ('QUESTIONNAIRE_STUDENTVIEWRESPONSES_ALWAYS', 3);
define('QUESTIONNAIRE_MAX_EVENT_LENGTH', 5 * 24 * 60 * 60); // 5 days maximum.
define('QUESTIONNAIRE_DEFAULT_PAGE_COUNT', 20);
global $questionnairetypes;
$questionnairetypes = array (QUESTIONNAIREUNLIMITED => get_string('qtypeunlimited', 'questionnaire'),
QUESTIONNAIREONCE => get_string('qtypeonce', 'questionnaire'),
QUESTIONNAIREDAILY => get_string('qtypedaily', 'questionnaire'),
QUESTIONNAIREWEEKLY => get_string('qtypeweekly', 'questionnaire'),
QUESTIONNAIREMONTHLY => get_string('qtypemonthly', 'questionnaire'));
global $questionnairerespondents;
$questionnairerespondents = array ('fullname' => get_string('respondenttypefullname', 'questionnaire'),
'anonymous' => get_string('respondenttypeanonymous', 'questionnaire'));
global $questionnairerealms;
$questionnairerealms = array ('private' => get_string('private', 'questionnaire'),
'public' => get_string('public', 'questionnaire'),
'template' => get_string('template', 'questionnaire'));
global $questionnaireresponseviewers;
$questionnaireresponseviewers = array (
QUESTIONNAIRE_STUDENTVIEWRESPONSES_WHENANSWERED => get_string('responseviewstudentswhenanswered', 'questionnaire'),
QUESTIONNAIRE_STUDENTVIEWRESPONSES_WHENCLOSED => get_string('responseviewstudentswhenclosed', 'questionnaire'),
QUESTIONNAIRE_STUDENTVIEWRESPONSES_ALWAYS => get_string('responseviewstudentsalways', 'questionnaire'));
global $autonumbering;
$autonumbering = array (0 => get_string('autonumberno', 'questionnaire'),
1 => get_string('autonumberquestions', 'questionnaire'),
2 => get_string('autonumberpages', 'questionnaire'),
3 => get_string('autonumberpagesandquestions', 'questionnaire'));
function questionnaire_check_date ($thisdate, $insert=false) {
$dateformat = get_string('strfdate', 'questionnaire');
if (preg_match('/(%[mdyY])(.+)(%[mdyY])(.+)(%[mdyY])/', $dateformat, $matches)) {
$datepieces = explode($matches[2], $thisdate);
foreach ($datepieces as $datepiece) {
if (!is_numeric($datepiece)) {
return 'wrongdateformat';
}
}
$pattern = "/[^dmy]/i";
$dateorder = strtolower(preg_replace($pattern, '', $dateformat));
$countpieces = count($datepieces);
if ($countpieces == 1) { // Assume only year entered.
switch ($dateorder) {
case 'dmy': // Most countries.
case 'mdy': // USA.
$datepieces[2] = $datepieces[0]; // year
$datepieces[0] = '1'; // Assumed 1st month of year.
$datepieces[1] = '1'; // Assumed 1st day of month.
break;
case 'ymd': // ISO 8601 standard
$datepieces[1] = '1'; // Assumed 1st month of year.
$datepieces[2] = '1'; // Assumed 1st day of month.
break;
}
}
if ($countpieces == 2) { // Assume only month and year entered.
switch ($dateorder) {
case 'dmy': // Most countries.
$datepieces[2] = $datepieces[1]; // Year.
$datepieces[1] = $datepieces[0]; // Month.
$datepieces[0] = '1'; // Assumed 1st day of month.
break;
case 'mdy': // USA
$datepieces[2] = $datepieces[1]; // Year.
$datepieces[0] = $datepieces[0]; // Month.
$datepieces[1] = '1'; // Assumed 1st day of month.
break;
case 'ymd': // ISO 8601 standard
$datepieces[2] = '1'; // Assumed 1st day of month.
break;
}
}
if (count($datepieces) > 1) {
if ($matches[1] == '%m') {
$month = $datepieces[0];
}
if ($matches[1] == '%d') {
$day = $datepieces[0];
}
if ($matches[1] == '%y') {
$year = strftime('%C').$datepieces[0];
}
if ($matches[1] == '%Y') {
$year = $datepieces[0];
}
if ($matches[3] == '%m') {
$month = $datepieces[1];
}
if ($matches[3] == '%d') {
$day = $datepieces[1];
}
if ($matches[3] == '%y') {
$year = strftime('%C').$datepieces[1];
}
if ($matches[3] == '%Y') {
$year = $datepieces[1];
}
if ($matches[5] == '%m') {
$month = $datepieces[2];
}
if ($matches[5] == '%d') {
$day = $datepieces[2];
}
if ($matches[5] == '%y') {
$year = strftime('%C').$datepieces[2];
}
if ($matches[5] == '%Y') {
$year = $datepieces[2];
}
$month = min(12, $month);
$month = max(1, $month);
if ($month == 2) {
$day = min(29, $day);
} else if ($month == 4 || $month == 6 || $month == 9 || $month == 11) {
$day = min(30, $day);
} else {
$day = min(31, $day);
}
$day = max(1, $day);
if (!$thisdate = gmmktime(0, 0, 0, $month, $day, $year)) {
return 'wrongdaterange';
} else {
if ($insert) {
$thisdate = trim(userdate ($thisdate, '%Y-%m-%d', '1', false));
} else {
$thisdate = trim(userdate ($thisdate, $dateformat, '1', false));
}
}
return $thisdate;
}
} else {
return ('wrongdateformat');
}
}
// A variant of Moodle's notify function, with a different formatting.
function questionnaire_notify($message) {
$message = clean_text($message);
$errorstart = '<div class="notifyproblem">';
$errorend = '</div>';
$output = $errorstart.$message.$errorend;
echo $output;
}
function questionnaire_choice_values($content) {
// If we run the content through format_text first, any filters we want to use (e.g. multilanguage) should work.
// examines the content of a possible answer from radio button, check boxes or rate question
// returns ->text to be displayed, ->image if present, ->modname name of modality, image ->title.
$contents = new stdClass();
$contents->text = '';
$contents->image = '';
$contents->modname = '';
$contents->title = '';
// Has image.
if (preg_match('/(<img)\s .*(src="(.[^"]{1,})")/isxmU', $content, $matches)) {
$contents->image = $matches[0];
$imageurl = $matches[3];
// Image has a title or alt text: use one of them.
if (preg_match('/(title=.)([^"]{1,})/', $content, $matches)
|| preg_match('/(alt=.)([^"]{1,})/', $content, $matches) ) {
$contents->title = $matches[2];
} else {
// Image has no title nor alt text: use its filename (without the extension).
preg_match("/.*\/(.*)\..*$/", $imageurl, $matches);
$contents->title = $matches[1];
}
// Content has text or named modality plus an image.
if (preg_match('/(.*)(<img.*)/', $content, $matches)) {
$content = $matches[1];
} else {
// Just an image.
return $contents;
}
}
// Check for score value first (used e.g. by personality test feature).
$r = preg_match_all("/^(\d{1,2}=)(.*)$/", $content, $matches);
if ($r) {
$content = $matches[2][0];
}
// Look for named modalities.
$contents->text = $content;
// DEV JR from version 2.5, a double colon :: must be used here instead of the equal sign.
if ($pos = strpos($content, '::')) {
$contents->text = substr($content, $pos + 2);
$contents->modname = substr($content, 0, $pos);
}
return $contents;
}
/**
* Get the information about the standard questionnaire JavaScript module.
* @return array a standard jsmodule structure.
*/
function questionnaire_get_js_module() {
return array(
'name' => 'mod_questionnaire',
'fullpath' => '/mod/questionnaire/module.js',
'requires' => array('base', 'dom', 'event-delegate', 'event-key',
'core_question_engine', 'moodle-core-formchangechecker'),
'strings' => array(
array('cancel', 'moodle'),
array('flagged', 'question'),
array('functiondisabledbysecuremode', 'quiz'),
array('startattempt', 'quiz'),
array('timesup', 'quiz'),
array('changesmadereallygoaway', 'moodle'),
),
);
}
/**
* Get all the questionnaire responses for a user
*/
function questionnaire_get_user_responses($surveyid, $userid, $complete=true) {
global $DB;
$andcomplete = '';
if ($complete) {
$andcomplete = " AND complete = 'y' ";
}
return $DB->get_records_sql ("SELECT *
FROM {questionnaire_response}
WHERE survey_id = ?
AND username = ?
".$andcomplete."
ORDER BY submitted ASC ", array($surveyid, $userid));
}
/**
* get the capabilities for the questionnaire
* @param int $cmid
* @return object the available capabilities from current user
*/
function questionnaire_load_capabilities($cmid) {
static $cb;
if (isset($cb)) {
return $cb;
}
$context = questionnaire_get_context($cmid);
$cb = new stdClass();
$cb->view = has_capability('mod/questionnaire:view', $context);
$cb->submit = has_capability('mod/questionnaire:submit', $context);
$cb->viewsingleresponse = has_capability('mod/questionnaire:viewsingleresponse', $context);
$cb->downloadresponses = has_capability('mod/questionnaire:downloadresponses', $context);
$cb->deleteresponses = has_capability('mod/questionnaire:deleteresponses', $context);
$cb->manage = has_capability('mod/questionnaire:manage', $context);
$cb->editquestions = has_capability('mod/questionnaire:editquestions', $context);
$cb->createtemplates = has_capability('mod/questionnaire:createtemplates', $context);
$cb->createpublic = has_capability('mod/questionnaire:createpublic', $context);
$cb->readownresponses = has_capability('mod/questionnaire:readownresponses', $context);
$cb->readallresponses = has_capability('mod/questionnaire:readallresponses', $context);
$cb->readallresponseanytime = has_capability('mod/questionnaire:readallresponseanytime', $context);
$cb->printblank = has_capability('mod/questionnaire:printblank', $context);
$cb->preview = has_capability('mod/questionnaire:preview', $context);
$cb->viewhiddenactivities = has_capability('moodle/course:viewhiddenactivities', $context, null, false);
return $cb;
}
/**
* returns the context-id related to the given coursemodule-id
* @param int $cmid the coursemodule-id
* @return object $context
*/
function questionnaire_get_context($cmid) {
static $context;
if (isset($context)) {
return $context;
}
if (!$context = context_module::instance($cmid)) {
print_error('badcontext');
}
return $context;
}
// This function *really* shouldn't be needed, but since sometimes we can end up with
// orphaned surveys, this will clean them up.
function questionnaire_cleanup() {
global $DB;
// Find surveys that don't have questionnaires associated with them.
$sql = 'SELECT qs.* FROM {questionnaire_survey} qs '.
'LEFT JOIN {questionnaire} q ON q.sid = qs.id '.
'WHERE q.sid IS NULL';
if ($surveys = $DB->get_records_sql($sql)) {
foreach ($surveys as $survey) {
questionnaire_delete_survey($survey->id, 0);
}
}
// Find deleted questions and remove them from database (with their associated choices, etc.).
return true;
}
function questionnaire_record_submission(&$questionnaire, $userid, $rid=0) {
global $DB;
$attempt['qid'] = $questionnaire->id;
$attempt['userid'] = $userid;
$attempt['rid'] = $rid;
$attempt['timemodified'] = time();
return $DB->insert_record("questionnaire_attempts", (object)$attempt, false);
}
function questionnaire_delete_survey($sid, $questionnaireid) {
global $DB;
$status = true;
// Delete all survey attempts and responses.
if ($responses = $DB->get_records('questionnaire_response', array('survey_id' => $sid), 'id')) {
foreach ($responses as $response) {
$status = $status && questionnaire_delete_response($response);
}
}
// There really shouldn't be any more, but just to make sure...
$DB->delete_records('questionnaire_response', array('survey_id' => $sid));
$DB->delete_records('questionnaire_attempts', array('qid' => $questionnaireid));
// Delete all question data for the survey.
if ($questions = $DB->get_records('questionnaire_question', array('survey_id' => $sid), 'id')) {
foreach ($questions as $question) {
$DB->delete_records('questionnaire_quest_choice', array('question_id' => $question->id));
}
$status = $status && $DB->delete_records('questionnaire_question', array('survey_id' => $sid));
}
// Delete all feedback sections and feedback messages for the survey.
if ($fbsections = $DB->get_records('questionnaire_fb_sections', array('survey_id' => $sid), 'id')) {
foreach ($fbsections as $fbsection) {
$DB->delete_records('questionnaire_feedback', array('section_id' => $fbsection->id));
}
$status = $status && $DB->delete_records('questionnaire_fb_sections', array('survey_id' => $sid));
}
$status = $status && $DB->delete_records('questionnaire_survey', array('id' => $sid));
return $status;
}
function questionnaire_delete_response($response, $questionnaire='') {
global $DB;
$status = true;
$cm = '';
$rid = $response->id;
// The questionnaire_delete_survey function does not send the questionnaire array.
if ($questionnaire != '') {
$cm = get_coursemodule_from_instance("questionnaire", $questionnaire->id, $questionnaire->course->id);
}
// Delete all of the response data for a response.
$DB->delete_records('questionnaire_response_bool', array('response_id' => $rid));
$DB->delete_records('questionnaire_response_date', array('response_id' => $rid));
$DB->delete_records('questionnaire_resp_multiple', array('response_id' => $rid));
$DB->delete_records('questionnaire_response_other', array('response_id' => $rid));
$DB->delete_records('questionnaire_response_rank', array('response_id' => $rid));
$DB->delete_records('questionnaire_resp_single', array('response_id' => $rid));
$DB->delete_records('questionnaire_response_text', array('response_id' => $rid));
$status = $status && $DB->delete_records('questionnaire_response', array('id' => $rid));
$status = $status && $DB->delete_records('questionnaire_attempts', array('rid' => $rid));
if ($status && $cm) {
// Update completion state if necessary.
$completion = new completion_info($questionnaire->course);
if ($completion->is_enabled($cm) == COMPLETION_TRACKING_AUTOMATIC && $questionnaire->completionsubmit) {
$completion->update_state($cm, COMPLETION_INCOMPLETE, $response->username);
}
}
return $status;
}
function questionnaire_delete_responses($qid) {
global $DB;
$status = true;
// Delete all of the response data for a question.
$DB->delete_records('questionnaire_response_bool', array('question_id' => $qid));
$DB->delete_records('questionnaire_response_date', array('question_id' => $qid));
$DB->delete_records('questionnaire_resp_multiple', array('question_id' => $qid));
$DB->delete_records('questionnaire_response_other', array('question_id' => $qid));
$DB->delete_records('questionnaire_response_rank', array('question_id' => $qid));
$DB->delete_records('questionnaire_resp_single', array('question_id' => $qid));
$DB->delete_records('questionnaire_response_text', array('question_id' => $qid));
$status = $status && $DB->delete_records('questionnaire_response', array('id' => $qid));
$status = $status && $DB->delete_records('questionnaire_attempts', array('rid' => $qid));
return $status;
}
function questionnaire_get_survey_list($courseid=0, $type='') {
global $DB;
if ($courseid == 0) {
if (isadmin()) {
$sql = "SELECT id,name,owner,realm,status " .
"{questionnaire_survey} " .
"ORDER BY realm,name ";
$params = null;
} else {
return false;
}
} else {
$castsql = $DB->sql_cast_char2int('s.owner');
if ($type == 'public') {
$sql = "SELECT s.id,s.name,s.owner,s.realm,s.status,s.title,q.id as qid,q.name as qname " .
"FROM {questionnaire} q " .
"INNER JOIN {questionnaire_survey} s ON s.id = q.sid AND ".$castsql." = q.course " .
"WHERE realm = ? " .
"ORDER BY realm,name ";
$params = array($type);
} else if ($type == 'template') {
$sql = "SELECT s.id,s.name,s.owner,s.realm,s.status,s.title,q.id as qid,q.name as qname " .
"FROM {questionnaire} q " .
"INNER JOIN {questionnaire_survey} s ON s.id = q.sid AND ".$castsql." = q.course " .
"WHERE (realm = ?) " .
"ORDER BY realm,name ";
$params = array($type);
} else if ($type == 'private') {
$sql = "SELECT s.id,s.name,s.owner,s.realm,s.status,q.id as qid,q.name as qname " .
"FROM {questionnaire} q " .
"INNER JOIN {questionnaire_survey} s ON s.id = q.sid " .
"WHERE owner = ? and realm = ? " .
"ORDER BY realm,name ";
$params = array($courseid, $type);
} else {
// Current get_survey_list is called from function questionnaire_reset_userdata so we need to get a
// complete list of all questionnaires in current course to reset them.
$sql = "SELECT s.id,s.name,s.owner,s.realm,s.status,q.id as qid,q.name as qname " .
"FROM {questionnaire} q " .
"INNER JOIN {questionnaire_survey} s ON s.id = q.sid AND ".$castsql." = q.course " .
"WHERE owner = ? " .
"ORDER BY realm,name ";
$params = array($courseid);
}
}
return $DB->get_records_sql($sql, $params);
}
function questionnaire_get_survey_select($courseid=0, $type='') {
global $OUTPUT, $DB;
$surveylist = array();
if ($surveys = questionnaire_get_survey_list($courseid, $type)) {
$strpreview = get_string('preview_questionnaire', 'questionnaire');
foreach ($surveys as $survey) {
$originalcourse = $DB->get_record('course', array('id' => $survey->owner));
if (!$originalcourse) {
// This should not happen, but we found a case where a public survey
// still existed in a course that had been deleted, and so this
// code lead to a notice, and a broken link. Since that is useless
// we just skip surveys like this.
continue;
}
// Prevent creating a copy of a public questionnaire IN THE SAME COURSE as the original.
if ($type == 'public' && $survey->owner == $courseid) {
continue;
} else {
$args = "sid={$survey->id}&popup=1";
if (!empty($survey->qid)) {
$args .= "&qid={$survey->qid}";
}
$link = new moodle_url("/mod/questionnaire/preview.php?{$args}");
$action = new popup_action('click', $link);
$label = $OUTPUT->action_link($link, $survey->qname.' ['.$originalcourse->fullname.']',
$action, array('title' => $strpreview));
$surveylist[$type.'-'.$survey->id] = $label;
}
}
}
return $surveylist;
}
function questionnaire_get_type ($id) {
switch ($id) {
case 1:
return get_string('yesno', 'questionnaire');
case 2:
return get_string('textbox', 'questionnaire');
case 3:
return get_string('essaybox', 'questionnaire');
case 4:
return get_string('radiobuttons', 'questionnaire');
case 5:
return get_string('checkboxes', 'questionnaire');
case 6:
return get_string('dropdown', 'questionnaire');
case 8:
return get_string('ratescale', 'questionnaire');
case 9:
return get_string('date', 'questionnaire');
case 10:
return get_string('numeric', 'questionnaire');
case 100:
return get_string('sectiontext', 'questionnaire');
case 99:
return get_string('sectionbreak', 'questionnaire');
default:
return $id;
}
}
/**
* This creates new events given as opendate and closedate by $questionnaire.
* @param object $questionnaire
* @return void
*/
/* added by JR 16 march 2009 based on lesson_process_post_save script */
function questionnaire_set_events($questionnaire) {
// Adding the questionnaire to the eventtable.
global $DB;
if ($events = $DB->get_records('event', array('modulename' => 'questionnaire', 'instance' => $questionnaire->id))) {
foreach ($events as $event) {
$event = calendar_event::load($event);
$event->delete();
}
}
// The open-event.
$event = new stdClass;
$event->description = $questionnaire->name;
$event->courseid = $questionnaire->course;
$event->groupid = 0;
$event->userid = 0;
$event->modulename = 'questionnaire';
$event->instance = $questionnaire->id;
$event->eventtype = 'open';
$event->timestart = $questionnaire->opendate;
$event->visible = instance_is_visible('questionnaire', $questionnaire);
$event->timeduration = ($questionnaire->closedate - $questionnaire->opendate);
if ($questionnaire->closedate && $questionnaire->opendate && ($event->timeduration <= QUESTIONNAIRE_MAX_EVENT_LENGTH)) {
// Single event for the whole questionnaire.
$event->name = $questionnaire->name;
calendar_event::create($event);
} else {
// Separate start and end events.
$event->timeduration = 0;
if ($questionnaire->opendate) {
$event->name = $questionnaire->name.' ('.get_string('questionnaireopens', 'questionnaire').')';
calendar_event::create($event);
unset($event->id); // So we can use the same object for the close event.
}
if ($questionnaire->closedate) {
$event->name = $questionnaire->name.' ('.get_string('questionnairecloses', 'questionnaire').')';
$event->timestart = $questionnaire->closedate;
$event->eventtype = 'close';
calendar_event::create($event);
}
}
}
/**
* Get users who have not completed the questionnaire
*
* @global object
* @uses CONTEXT_MODULE
* @param object $cm
* @param int $group single groupid
* @param string $sort
* @param int $startpage
* @param int $pagecount
* @return object the userrecords
*/
function questionnaire_get_incomplete_users($cm, $sid,
$group = false,
$sort = '',
$startpage = false,
$pagecount = false) {
global $DB;
$context = context_module::instance($cm->id);
// First get all users who can complete this questionnaire.
$cap = 'mod/questionnaire:submit';
$fields = 'u.id, u.username';
if (!$allusers = get_users_by_capability($context,
$cap,
$fields,
$sort,
'',
'',
$group,
'',
true)) {
return false;
}
$allusers = array_keys($allusers);
// Nnow get all completed questionnaires.
$params = array('survey_id' => $sid, 'complete' => 'y');
$sql = "SELECT username FROM {questionnaire_response} " .
"WHERE survey_id = :survey_id AND complete = :complete " .
"GROUP BY username ";
if (!$completedusers = $DB->get_records_sql($sql, $params)) {
return $allusers;
}
$completedusers = array_keys($completedusers);
// Now strike all completedusers from allusers.
$allusers = array_diff($allusers, $completedusers);
// For paging I use array_slice().
if (($startpage !== false) && ($pagecount !== false)) {
$allusers = array_slice($allusers, $startpage, $pagecount);
}
return $allusers;
}
/**
* Called by HTML editor in showrespondents and Essay question. Based on question/essay/renderer.
* Pending general solution to using the HTML editor outside of moodleforms in Moodle pages.
*/
function questionnaire_get_editor_options($context) {
return array(
'subdirs' => 0,
'maxbytes' => 0,
'maxfiles' => -1,
'context' => $context,
'noclean' => 0,
'trusttext' => 0
);
}
// Skip logic: we need to find out how many questions will actually be displayed on next page/section.
function questionnaire_nb_questions_on_page ($questionsinquestionnaire, $questionsinsection, $rid) {
global $DB;
$questionstodisplay = array();
foreach ($questionsinsection as $question) {
if ($question->dependquestion != 0) {
switch ($questionsinquestionnaire[$question->dependquestion]->type_id) {
case QUESYESNO:
if ($question->dependchoice == 0) {
$questiondependchoice = "'y'";
} else {
$questiondependchoice = "'n'";
}
$responsetable = 'response_bool';
break;
default:
$questiondependchoice = $question->dependchoice;
$responsetable = 'resp_single';
}
$params = array('response_id' => $rid,
'question_id' => $question->dependquestion,
'choice_id' => $questiondependchoice);
if ($DB->record_exists('questionnaire_'.$responsetable, $params)) {
$questionstodisplay [] = $question->id;
}
} else {
$questionstodisplay [] = $question->id;
}
}
return $questionstodisplay;
}
function questionnaire_get_dependencies($questions, $position) {
$dependencies = array();
$dependencies[''][0] = get_string('choosedots');
foreach ($questions as $question) {
if (($question->type_id == QUESRADIO || $question->type_id == QUESDROP || $question->type_id == QUESYESNO)
&& $question->position < $position) {
if (($question->type_id == QUESRADIO || $question->type_id == QUESDROP) && $question->name != '') {
foreach ($question->choices as $key => $choice) {
$contents = questionnaire_choice_values($choice->content);
if ($contents->modname) {
$choice->content = $contents->modname;
} else if ($contents->title) { // Must be an image; use its title for the dropdown list.
$choice->content = $contents->title;
} else {
$choice->content = $contents->text;
}
$dependencies[$question->name][$question->id.','.$key] = $question->name.'->'.$choice->content;
}
}
if ($question->type_id == QUESYESNO && $question->name != '') {
$dependencies[$question->name][$question->id.',0'] = $question->name.'->'.get_string('yes');
$dependencies[$question->name][$question->id.',1'] = $question->name.'->'.get_string('no');
}
}
}
return $dependencies;
}
// Get the parent of a child question.
function questionnaire_get_parent ($question) {
global $DB;
$qid = $question->id;
$parent = array();
$dependquestion = $DB->get_record('questionnaire_question', array('id' => $question->dependquestion),
$fields = 'id, position, name, type_id');
if (is_object($dependquestion)) {
$qdependchoice = '';
switch ($dependquestion->type_id) {
case QUESRADIO:
case QUESDROP:
$dependchoice = $DB->get_record('questionnaire_quest_choice', array('id' => $question->dependchoice),
$fields = 'id,content');
$qdependchoice = $dependchoice->id;
$dependchoice = $dependchoice->content;
$contents = questionnaire_choice_values($dependchoice);
if ($contents->modname) {
$dependchoice = $contents->modname;
}
break;
case QUESYESNO:
switch ($question->dependchoice) {
case 0:
$dependchoice = get_string('yes');
$qdependchoice = 'y';
break;
case 1:
$dependchoice = get_string('no');
$qdependchoice = 'n';
break;
}
break;
}
// Qdependquestion, parenttype and qdependchoice fields to be used in preview mode.
$parent [$qid]['qdependquestion'] = 'q'.$dependquestion->id;
$parent [$qid]['qdependchoice'] = $qdependchoice;
$parent [$qid]['parenttype'] = $dependquestion->type_id;
// Other fields to be used in Questions edit mode.
$parent [$qid]['position'] = $question->position;
$parent [$qid]['name'] = $question->name;
$parent [$qid]['content'] = $question->content;
$parent [$qid]['parentposition'] = $dependquestion->position;
$parent [$qid]['parent'] = $dependquestion->name.'->'.$dependchoice;
}
return $parent;
}
// Get parent position of all child questions in current questionnaire.
function questionnaire_get_parent_positions ($questions) {
$parentpositions = array();
foreach ($questions as $question) {
$dependquestion = $question->dependquestion;
if ($dependquestion != 0) {
$childid = $question->id;
$parentpos = $questions[$dependquestion]->position;
$parentpositions[$childid] = $parentpos;
}
}
return $parentpositions;
}
// Get child position of all parent questions in current questionnaire.
function questionnaire_get_child_positions ($questions) {
$childpositions = array();
foreach ($questions as $question) {
$dependquestion = $question->dependquestion;
if ($dependquestion != 0) {
$parentid = $questions[$dependquestion]->id;
if (!isset($firstchildfound[$parentid])) {
$firstchildfound[$parentid] = true;
$childpos = $question->position;
$childpositions[$parentid] = $childpos;
}
}
}
return $childpositions;
}
// Check if current questionnaire contains child questions.
function questionnaire_has_dependencies($questions) {
foreach ($questions as $question) {
if ($question->dependquestion != 0) {
return true;
break;
}
}
return false;
}
// Check that the needed page breaks are present to separate child questions.
function questionnaire_check_page_breaks($questionnaire) {
global $DB;
$msg = '';
// Store the new page breaks ids.
$newpbids = array();
$delpb = 0;
$sid = $questionnaire->survey->id;
$questions = $DB->get_records('questionnaire_question', array('survey_id' => $sid, 'deleted' => 'n'), 'id');
$positions = array();
foreach ($questions as $key => $qu) {
$positions[$qu->position]['question_id'] = $key;
$positions[$qu->position]['dependquestion'] = $qu->dependquestion;
$positions[$qu->position]['dependchoice'] = $qu->dependchoice;
$positions[$qu->position]['type_id'] = $qu->type_id;
$positions[$qu->position]['qname'] = $qu->name;
$positions[$qu->position]['qpos'] = $qu->position;
}
$count = count($positions);
for ($i = $count; $i > 0; $i--) {
$qu = $positions[$i];
$questionnb = $i;
if ($qu['type_id'] == QUESPAGEBREAK) {
$questionnb--;
// If more than one consecutive page breaks, remove extra one(s).
$prevqu = null;
$prevtypeid = null;
if ($i > 1) {
$prevqu = $positions[$i - 1];
$prevtypeid = $prevqu['type_id'];
}
// If $i == $count then remove that extra page break in last position.
if ($prevtypeid == QUESPAGEBREAK || $i == $count || $qu['qpos'] == 1) {
$qid = $qu['question_id'];
$delpb ++;
$msg .= get_string("checkbreaksremoved", "questionnaire", $delpb).'<br />';
// Need to reload questions.
$questions = $DB->get_records('questionnaire_question', array('survey_id' => $sid, 'deleted' => 'n'), 'id');
$DB->set_field('questionnaire_question', 'deleted', 'y', array('id' => $qid, 'survey_id' => $sid));
$select = 'survey_id = '.$sid.' AND deleted = \'n\' AND position > '.
$questions[$qid]->position;
if ($records = $DB->get_records_select('questionnaire_question', $select, null, 'position ASC')) {
foreach ($records as $record) {
$DB->set_field('questionnaire_question', 'position', $record->position - 1, array('id' => $record->id));
}
}
}
}
// Add pagebreak between question child and not dependent question that follows.
if ($qu['type_id'] != QUESPAGEBREAK) {
$j = $i - 1;
if ($j != 0) {
$prevtypeid = $positions[$j]['type_id'];
$prevdependquestion = $positions[$j]['dependquestion'];
$prevdependchoice = $positions[$j]['dependchoice'];
if (($prevtypeid != QUESPAGEBREAK && ($prevdependquestion != $qu['dependquestion']
|| $prevdependchoice != $qu['dependchoice']))
|| ($qu['dependquestion'] == 0 && $prevdependquestion != 0)) {
$sql = 'SELECT MAX(position) as maxpos FROM {questionnaire_question} '.
'WHERE survey_id = '.$questionnaire->survey->id.' AND deleted = \'n\'';
if ($record = $DB->get_record_sql($sql)) {
$pos = $record->maxpos + 1;
} else {
$pos = 1;
}
$question = new stdClass();
$question->survey_id = $questionnaire->survey->id;
$question->type_id = QUESPAGEBREAK;
$question->position = $pos;
$question->content = 'break';
if (!($newqid = $DB->insert_record('questionnaire_question', $question))) {
return(false);
}
$newpbids[] = $newqid;
$movetopos = $i;
$questionnaire = new questionnaire($questionnaire->id, null, $course, $cm);
$questionnaire->move_question($newqid, $movetopos);
}
}
}
}
if (empty($newpbids) && !$msg) {
$msg = get_string('checkbreaksok', 'questionnaire');
} else if ($newpbids) {
$msg .= get_string('checkbreaksadded', 'questionnaire').' ';
$newpbids = array_reverse ($newpbids);
$questionnaire = new questionnaire($questionnaire->id, null, $course, $cm);
foreach ($newpbids as $newpbid) {
$msg .= $questionnaire->questions[$newpbid]->position.' ';
}
}
return($msg);
}
// Get all descendants and choices for questions with descendants.
function questionnaire_get_descendants_and_choices ($questions) {
$questions = array_reverse($questions, true);
$qu = array();
foreach ($questions as $question) {
if ($question->dependquestion) {
$dq = $question->dependquestion;
$dc = $question->dependchoice;
$qid = $question->id;
$qu['descendants'][$dq][] = 'qn-'.$qid;
if (array_key_exists($qid, $qu['descendants'])) {
foreach ($qu['descendants'][$qid] as $q) {
$qu['descendants'][$dq][] = $q;
}
}
$qu['choices'][$dq][$dc][] = 'qn-'.$qid;
}
}
return($qu);
}
// Get all descendants for a question to be deleted.
function questionnaire_get_descendants ($questions, $questionid) {
$questions = array_reverse($questions, true);
$qu = array();
foreach ($questions as $question) {
if ($question->dependquestion) {
$dq = $question->dependquestion;
$qid = $question->id;
$qu[$dq][] = $qid;
if (array_key_exists($qid, $qu)) {
foreach ($qu[$qid] as $q) {
$qu[$dq][] = $q;
}
}
}
}
$descendants = array();
if (isset($qu[$questionid])) {
foreach ($qu[$questionid] as $descendant) {
$childquestion = $questions[$descendant];
$descendants += questionnaire_get_parent ($childquestion);
}
uasort($descendants, 'questionnaire_cmp');
}
return($descendants);
}
// Function to sort descendants array in questionnaire_get_descendants function.
function questionnaire_cmp($a, $b) {
if ($a == $b) {
return 0;
} else if ($a < $b) {
return -1;
} else {
return 1;
}
}