-
Notifications
You must be signed in to change notification settings - Fork 3
/
lib.php
1067 lines (962 loc) · 37.1 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/>.
/**
* Helper functions
*
* @package block
* @subpackage coursefeedback
* @copyright 2023 innoCampus, Technische Universität Berlin
* @author 2011-2023 onwards Jan Eberhardt
* @author 2022 onwards Felix Di Lenarda
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined("MOODLE_INTERNAL") || die();
define("COURSEFEEDBACK_DEFAULT", "DEFAULT");
define("COURSEFEEDBACK_ALL", "ALL");
define("COURSEFEEDBACK_EMPTY_ACTIVE", 0);
/**
* Fixes holes in question id order.
*
* @param int $feedbackid
* @param bool $checkonly don"t change database entries
* @return 0 if operation failed or order is incorrect (checkonly), 1 if order is correct and 2 if order has succesful been changed
*/
function block_coursefeedback_order_questions($feedbackid, $checkonly = true) {
global $CFG, $DB;
$feedbackid = intval($feedbackid);
$max = block_coursefeedback_get_questionid($feedbackid) - 1;
$currentid = 1;
$sql = array();
if ($max > 0) {
while ($currentid < $max) {
if (!$DB->record_exists("block_coursefeedback_questns",
array("coursefeedbackid" => $feedbackid, "questionid" => $currentid))) {
while (!$DB->record_exists("block_coursefeedback_questns",
array("coursefeedbackid" => $feedbackid, "questionid" => $max)) && $max > 0) {
// Don"t use other spots.
$max--;
}
$sql = array("query" => "UPDATE {block_coursefeedback_questns}
SET questionid = :currentid,timemodified = :modified
WHERE coursefeedbackid = :fid
AND questionid = :max",
"params" => array("currentid" => $currentid,
"modified" => time(),
"fid" => $feedbackid,
"max" => $max));
$max--;
}
$currentid++;
}
if (empty($sql)) {
return 1;
} else if (!$checkonly) {
if (block_coursefeedback_execute_sql_arr($sql)) {
return 2;
} else {
return 0;
}
}
}
}
/**
* If the function returns a negative number, it indicates a false validation (i.e. use of blacklisted characters).
*
* @param string $feedbackname
* @param string $heading
* @param string $infotext
* @param bool $returnid Should the id of the newly created record entry be returned?
* @return int|bool - record id or false on failure.
*/
function block_coursefeedback_insert_feedback($feedbackname, $heading = null, $infotext = null, $infotextformat = null,
$returnid = true) {
global $DB;
if (strpos($feedbackname, ";") === false) {
$record = new stdClass();
$record->name = $feedbackname;
$record->timemodified = time();
$record->heading = $heading;
$record->infotext = $infotext;
$record->infotextformat = $infotextformat;
return $DB->insert_record("block_coursefeedback", $record, $returnid);
} else {
return -1;
}
}
/**
* If the return is a negative number, it indicates a false validation (i.e. use of blacklisted characters).
*
* @param int $feedbackid
* @param string $feedbackname
* @param string $heading
* @param string $infotext
* @return int|bool - Success of operation.
*/
function block_coursefeedback_edit_feedback($feedbackid, $feedbackname, $heading = null, $infotext = null, $infotextformat = null) {
global $DB;
if (strpos($feedbackname, ";")) {
return -1;
}
if ($record = $DB->get_record("block_coursefeedback", array("id" => $feedbackid))) {
$record->name = $feedbackname;
$record->timemodified = time();
$record->heading = $heading;
$record->infotext = $infotext;
$record->infotextformat = $infotextformat;
return clean_param($DB->update_record("block_coursefeedback", $record), PARAM_BOOL);
} else {
return false;
}
}
/**
* If the function returns a negative number, it indicates a false validation (i.e. use of blacklisted characters).
*
* @param int $oldfbid
* @param int $fbname
* @param string $heading
* @param string $infotext
* @return int|false - $newid or false.
*/
function block_coursefeedback_copy_feedback($oldfbid, $fbname, $heading = null, $infotext = null, $infotextformat = null) {
global $DB;
$oldfbid = clean_param($oldfbid, PARAM_INT);
$newid = block_coursefeedback_insert_feedback($fbname, $heading, $infotext, $infotextformat);
if ($newid === -1) {
return -1;
} else if ($newid > 0 && $questions = $DB->get_records("block_coursefeedback_questns", array("coursefeedbackid" => $oldfbid))) {
$a = $newid;
foreach ($questions as $question) {
if (!block_coursefeedback_insert_question(
$question->question, $newid, $question->questionid, $question->language, $question->questiontype)) {
// If one fails the whole operation fails.
$a = false;
// Remove inserted and not correctly duplicated fb.
block_coursefeedback_delete_feedback($newid);
break;
}
}
}
return $a;
}
/**
* @param int $feedbackid
* @return bool Success of operation.
*/
function block_coursefeedback_delete_feedback($feedbackid) {
global $DB;
if ($DB->delete_records("block_coursefeedback_answers", array("coursefeedbackid" => $feedbackid))
&& $DB->delete_records("block_coursefeedback_questns", array("coursefeedbackid" => $feedbackid))
&& $DB->delete_records("block_coursefeedback", array("id" => $feedbackid))
&& $DB->delete_records("block_coursefeedback_uidansw", array("coursefeedbackid" => $feedbackid))) {
// If the first fails, the second won't be executed (because of &&).
return true;
} else {
// If one fails, the whole operation fails.
return false;
}
}
/**
* @param string $question
* @param int $feedbackid
* @param int $questionid
* @param string $language
* @param int $questiontype
* @param bool $returnid Return the id of the newly created record? If false, a boolean is returned.
* @return bool|int
*/
function block_coursefeedback_insert_question($question, $feedbackid, $questionid, $language, $questiontype, $returnid = true) {
global $DB;
$feedbackid = intval($feedbackid);
$questionid = intval($questionid);
$questiontype = intval($questiontype);
$language = preg_replace("/[^a-z\_]/", "", strtolower($language));
if (!$DB->record_exists("block_coursefeedback_questns",
array("coursefeedbackid" => $feedbackid, "questionid" => $questionid, "language" => $language))) {
$languages = block_coursefeedback_get_implemented_languages($feedbackid, $questionid, true, true);
// Ceck if language already exists.
if ($languages && in_array($language, $languages)) {
$record = new stdClass();
$record->question = $question;
$record->coursefeedbackid = $feedbackid;
$record->questionid = $questionid;
$record->language = $language;
$record->timemodified = time();
$record->questiontype = $questiontype;
return $DB->insert_record("block_coursefeedback_questns", $record);
}
}
return false;
}
/**
* @param int $feedbackid
* @param int $oldpos
* @param int $newpos
* @return bool Success of operation
*/
function block_coursefeedback_swap_questions($feedbackid, $oldpos, $newpos) {
global $DB;
$feedbackid = intval($feedbackid);
$oldpos = intval($oldpos);
$newpos = intval($newpos);
$tmppos = block_coursefeedback_get_questionid($feedbackid);
if ($DB->record_exists("block_coursefeedback_questns", array("coursefeedbackid" => $feedbackid, "questionid" => $oldpos))
&& $DB->record_exists("block_coursefeedback_questns", array("coursefeedbackid" => $feedbackid, "questionid" => $newpos))) {
$sql = array();
// Set temporary position.
$sql[] = array(
"query" => "UPDATE {block_coursefeedback_questns}
SET questionid = :tmppos
WHERE coursefeedbackid = :feedbackid
AND questionid = :newpos",
"params" => array(
"tmppos" => $tmppos,
"feedbackid" => $feedbackid,
"newpos" => $newpos,
)
);
// Move to new position.
$sql[] = array(
"query" => "UPDATE {block_coursefeedback_questns}
SET questionid = :newpos, timemodified = :modified
WHERE coursefeedbackid = :fid
AND questionid = :oldpos",
"params" => array(
"newpos" => $newpos,
"modified" => time(),
"fid" => $feedbackid,
"oldpos" => $oldpos,
)
);
// Restore old position.
$sql[] = array(
"query" => "UPDATE {block_coursefeedback_questns}
SET questionid = :oldpos, timemodified = :modified
WHERE coursefeedbackid = :fid
AND questionid = :tmppos",
"params" => array(
"oldpos" => $oldpos,
"modified" => time(),
"fid" => $feedbackid,
"tmppos" => $tmppos,
)
);
return block_coursefeedback_execute_sql_arr($sql);
} else {
return false;
}
}
/**
* @param int $feedbackid
* @param int $questionid
* @param string $question
* @param string $language
* @param bool $deleteanswers
* @return bool Success of operation
*/
function block_coursefeedback_update_question($feedbackid, $questionid, $question, $language, $questiontype) {
global $DB;
$feedbackid = intval($feedbackid);
$questionid = intval($questionid);
$questiontype = intval($questiontype);
if (in_array($language, block_coursefeedback_get_implemented_languages($feedbackid, $questionid))) {
$record = $DB->get_record("block_coursefeedback_questns", array("coursefeedbackid" => $feedbackid,
"questionid" => $questionid,
"language" => $language));
$record->question = $question;
$record->timemodified = time();
$record->questiontype = $questiontype;
return clean_param($DB->update_record("block_coursefeedback_questns", $record), PARAM_BOOL);
}
return false;
}
/**
*
* @param int $feedbackid
* @param int $questionid
* @param String|COURSEFEEDBACK_ALL $language (default is all languages)
* @return bool Success of operation
*/
function block_coursefeedback_delete_question($feedbackid, $questionid, $language = COURSEFEEDBACK_ALL) {
global $DB;
$feedbackid = intval($feedbackid);
$questionid = intval($questionid);
if ($language == COURSEFEEDBACK_ALL) {
$success = $DB->delete_records("block_coursefeedback_questns", array("coursefeedbackid" => $feedbackid,
"questionid" => $questionid));
} else if (array_key_exists($language, get_string_manager()->get_list_of_translations())) {
$success = $DB->delete_records("block_coursefeedback_questns", array("coursefeedbackid" => $feedbackid,
"questionid" => $questionid,
"language" => $language));
} else {
$success = false;
}
$success = clean_param($success, PARAM_BOOL);
if ($success) {
block_coursefeedback_order_questions($feedbackid, false);
}
return $success;
}
/**
* @param int $feedbackid
* @param array|string $language Array of language codes or language code
* @return int|bool - number of deleted records or false on fail
*/
function block_coursefeedback_delete_questions($feedbackid, $languages) {
global $DB;
$feedbackid = intval($feedbackid);
if (!is_array($languages)) {
$languages = array($languages);
} // Ensure array.
$implemented = block_coursefeedback_get_implemented_languages($feedbackid);
$conditions = array("coursefeedbackid" => $feedbackid);
$succeeded = 0;
foreach ($languages as $langcode) {
$conditions["language"] = $langcode;
if (in_array($langcode, $implemented) && $DB->delete_records("block_coursefeedback_questns", $conditions)) {
$succeeded++;
}
}
if ($succeeded > 0) {
block_coursefeedback_order_questions($feedbackid);
}
return $succeeded;
}
/**
* @param int $feedbackid
* @return bool Succes of operation
*/
function block_coursefeedback_delete_answers($feedbackid) {
global $DB;
$conditions = array("coursefeedbackid" => intval($feedbackid));
$dbtrans = $DB->start_delegated_transaction();
try {
$DB->delete_records("block_coursefeedback_uidansw", array("coursefeedbackid" => $feedbackid));
$DB->delete_records("block_coursefeedback_answers", $conditions);
$DB->delete_records("block_coursefeedback_textans", $conditions);
$dbtrans->allow_commit();
return true;
} catch (Exception $e) {
// Rollback the transaction in case of an error
$dbtrans->rollback($e);
return false;
}
}
/**
* Get all language codes for which questions are well-defined (question in default language exists)
*
* @param int $feedbackid | COURSEFEEDBACK_DEFAULT
* @param bool $codesonly
* @return array Language codes
*/
function block_coursefeedback_get_combined_languages($feedbackid = COURSEFEEDBACK_DEFAULT, $codesonly = true) {
global $CFG, $DB;
// Clean params.
if ($feedbackid === COURSEFEEDBACK_DEFAULT) {
$feedbackid = get_config("block_coursefeedback", "active_feedback");
} else {
$feedbackid = intval($feedbackid);
}
$codesonly = clean_param($codesonly, PARAM_BOOL);
$count = block_coursefeedback_get_questionid($feedbackid) - 1;
$select = "coursefeedbackid = :fid GROUP BY language HAVING COUNT(language) = :count";
$params = array("fid" => $feedbackid, "count" => $count);
$langs = $DB->get_records_select("block_coursefeedback_questns", $select, $params, "", "language");
$langs = array_keys($langs);
if ($langs && !$codesonly) {
$listoflanguages = get_string_manager()->get_list_of_translations();
$languages = array();
foreach ($langs as $langcode) {
$languages[$langcode] = isset($listoflanguages[$langcode])
? $listoflanguages[$langcode]
: get_string("adminpage_html_notinstalled", "block_coursefeedback", $langcode);
}
$langs = $languages;
}
return ($langs ? $langs : array());
}
/**
* @param int $feedbackid
* @param int $questionid
* @param bool $codesonly
* @param bool $inverted
* @return array - All languages of the feedback, which are listed in database. Array data type depends on input parameters.
*/
function block_coursefeedback_get_implemented_languages($feedbackid, $questionid = null, $langcodesonly = true, $inverted = false) {
global $CFG, $DB;
$feedbackid = intval($feedbackid);
$sql = "SELECT language
FROM {block_coursefeedback_questns}
WHERE coursefeedbackid = :fid ";
if (is_int($questionid) && $questionid > 0) {
$sql .= "AND questionid = :qid ";
}
$sql .= "GROUP BY language";
$implemented = $DB->get_fieldset_sql($sql, array("fid" => $feedbackid, "qid" => $questionid));
if (!$implemented) {
$implemented = array();
}
$installed = get_string_manager()->get_list_of_translations();
if ($langcodesonly) {
$languages = ($inverted)
? array_diff(array_keys($installed), $implemented)
: $implemented;
} else if ($inverted) { // Case !$langcodesonly && $inverted.
foreach ($implemented as $i) {
unset($installed[$i]);
}
$languages = $installed;
} else {
// Case !$langcodesonly && !$inverted.
$languages = array();
foreach ($implemented as $i) {
$languages[$i] = $installed[$i];
}
}
return $languages;
}
/**
* Computes the next free questionid, is also used to detect the amount of questions the FB has.
*
* @param int $feedbackid
* @return int - Next availble question id number.
*/
function block_coursefeedback_get_questionid($feedbackid) {
global $DB;
$feedbackid = intval($feedbackid);
$n = $DB->get_field("block_coursefeedback_questns", "MAX(questionid)", array("coursefeedbackid" => $feedbackid));
return $n ? ($n + 1) : 1;
}
/**
* @param int $feedbackid - If no record is found or if left blank "untitled" will be returned.
* @return string - Feedback name.
*/
function block_coursefeedback_get_feedbackname($feedbackid = null) {
global $DB;
if (is_number($feedbackid)) {
$name = $DB->get_field("block_coursefeedback", "name", array("id" => $feedbackid));
}
if (empty($name)) {
$name = get_string("untitled", "block_coursefeedback");
}
return htmlentities($name);
}
/**
* This function gets the amount of votes for each answeroption (1-6) and each schoolgrade question.
* It calculates the amount of counted choices, the amount of abstentions and the average rating for each question
*
* @param int $courseid
* @param string $sort
* @return array - 2-dimensional array of answers, ordered by question id as follows:
* [ "<questionid>" =>
* [ "1" => <answercount>, ..., "6" => <answercount>, "average" =>..., "choicessum" =>..., "abstentions" => ... ]]
* @throws moodle_exception
*/
function block_coursefeedback_get_qanswercounts($course, $feedbackid) {
global $DB;
$config = get_config("block_coursefeedback");
$answers = array();
$course = clean_param($course, PARAM_INT);
if ($course <= 0) {
throw new moodle_exception("invalidcourseid");
}
// Get all the questions of the feedback
$questions = block_coursefeedback_get_questions_by_language($feedbackid, [current_language()],
CFB_QUESTIONTYPE_SCHOOLGRADE);
$params = array("fid" => $feedbackid, "course" => $course);
// For each question and each answerpossibility, count the amount of the given answers
foreach ($questions as $question) {
$choicessum = 0;
$avsum = 0;
$questionid = $question->questionid;
$params["qid"] = $questionid;
$sql = "SELECT answer,COUNT(*) AS count
FROM {block_coursefeedback_answers}
WHERE coursefeedbackid = :fid
AND questionid = :qid
AND course = :course
GROUP BY answer";
// Create array for the question and fill in zeros for each answeroption
$answers[$questionid] = array_fill(1, 6, 0);
$abstentions = 0;
// If answers for question exist, replace the zero at the right index and calculate average and choicessum
$results = $DB->get_records_sql($sql, $params);
foreach ($results as $answer) {
// Abstentions are not counted for average and choicessum
if ($answer->answer == 0) {
$abstentions = $answer->count;
} else {
$answers[$questionid][$answer->answer] = $answer->count;
$choicessum += $answer->count;
$avsum += $answer->answer * $answer->count;
}
}
// Calculate choices and average for each question
$average = $choicessum > 0 ? ($avsum / $choicessum) : 0;
$answers[$questionid]['average'] = number_format($average, 2);
$answers[$questionid]['choicessum'] = $choicessum;
$answers[$questionid]['abstentions'] = $abstentions;
}
return $answers;
}
/**
* Returns an array of questions in a well defined lang for the given feedback
*
* @param int $coursfeedback_id - Feedback Id of questions to be shown
* @param array|string $languages - array or string of language codes (sorted by priority)
* @param int|null $questiontype - Which questiontype to get, null if all questions wanted
* @param string $sort
* @param string $fields
* @param int|null $questionid
* @return array - array of question objects
*/
function block_coursefeedback_get_questions_by_language($feedbackid,
$languages,
$questiontype = null,
$sort = "questionid",
$fields = "questionid,question,coursefeedbackid,questiontype",
$questionid = null) {
global $DB, $USER, $COURSE, $CFG;
$feedbackid = intval($feedbackid);
// If no languagearray was given (only languagestring instead), build array from default languages.
if (!is_array($languages)) {
$fbdefaultlang = get_config("block_coursefeedback", "default_language");
$languages = [$languages];
$languages[] = $USER->lang;
$languages[] = $COURSE->lang;
$languages[] = $CFG->lang;
$languages[] = $fbdefaultlang;
}
$fblanguages = block_coursefeedback_get_combined_languages($feedbackid);
$conditions = ["coursefeedbackid" => $feedbackid];
// Only get the questions needed (which questiontype and which questionlanguage).
if ($fblanguages && $language = current(array_intersect($languages, $fblanguages))) {
$conditions["language"] = $language;
} else if ($fblanguages) {
$conditions["language"] = $fblanguages[0];
}
// Do we need all questions or only a specific type?
if (!is_null($questiontype)) {
$conditions['questiontype'] = $questiontype;
}
// Do we need all questions or only a specific id?
if (!is_null($questionid)) {
$conditions['questionid'] = $questionid;
}
$questions = $DB->get_records("block_coursefeedback_questns",
$conditions,
$sort,
$fields);
// If the search is for a specific questionid, only one entry is allowed to be found.
if (isset($questionid)) {
if (count($questions) != 1) {
throw new moodle_exception(get_string("except_invalid_questionid","block_coursefeedback"));
}
}
return $questions;
}
/**
* @param string $feedbackid
* @return multitype:
*/
function block_coursefeedback_get_question_ids($feedbackid = COURSEFEEDBACK_DEFAULT) {
global $DB;
if ($feedbackid === COURSEFEEDBACK_DEFAULT) {
$feedbackid = get_config("block_coursefeedback", "default_language");
}
$feedbackid = intval($feedbackid);
$select = "coursefeedbackid = ? GROUP BY questionid ORDER BY questionid";
return $DB->get_fieldset_select("block_coursefeedback_questns", "questionid", $select, array($feedbackid));
}
/**
* @param int $feedbackid
* @param bool $return
* @return array - Array of strings with error messages if editing is not allowed (may be empty).
*/
function block_coursefeedback_get_editerrors($feedbackid) {
global $DB;
$feedbackid = intval($feedbackid);
$perm = array();
// This feedback is currently active -> editing not possible.
if ($feedbackid == get_config("block_coursefeedback", "active_feedback")) {
$perm["erroractive"] = get_string("perm_html_erroractive", "block_coursefeedback");
}
// There is already at least one answer for this specific feedback -> editing not possible
if (block_coursefeedback_answers_exist($feedbackid)) {
$perm["answersexists"] = get_string("perm_html_answersexists", "block_coursefeedback");
}
return $perm;
}
/**
* Sets the feedback with the given ID as active by updating the configuration setting.
* Deletes the user-ID answers of the previously active feedback if they exist.
*
* @param int $feedbackid
* @return bool - false, if specified feedback doesn"t exists
*/
function block_coursefeedback_set_active($feedbackid) {
global $DB;
if ($feedbackid == 0 || $DB->record_exists("block_coursefeedback", array("id" => $feedbackid))) {
$oldfeedbackid = get_config("block_coursefeedback", "active_feedback");
if (block_coursefeedback_answers_exist($oldfeedbackid)) {
// If answers for the last FB exist -> delete the saved userids.
// It will not be possible to reactivate a FB for which answers exist
$DB->delete_records("block_coursefeedback_uidansw", array("coursefeedbackid" => $oldfeedbackid));
}
set_config("active_feedback", $feedbackid, "block_coursefeedback");
return true;
} else {
return false;
}
}
/**
* Prints standard header for coursefeedback question administration
*
* @param bool $editable
* @param int|NULL $feedbackid
*/
function block_coursefeedback_print_header($editable = false, $feedbackid = null) {
global $CFG, $OUTPUT;
$editable = clean_param($editable, PARAM_BOOL);
$div = html_writer::start_tag("div", array("style" => "margin-left:3em;margin-bottom:1em;"));
if ($editable) {
$url1 = block_coursefeedback_adminurl("questions", "new", $feedbackid);
$url2 = block_coursefeedback_adminurl("questions", "dlang", $feedbackid);
$div .= html_writer::link($url1, get_string("page_link_newquestion", "block_coursefeedback")) . "<br/>"
. html_writer::link($url2, get_string("page_link_deletelanguage", "block_coursefeedback")) . "<br/>";
}
$url1 = block_coursefeedback_adminurl("feedback", "view");
$url2 = new moodle_url("/" . $CFG->admin . "/settings.php", array("section" => "blocksettingcoursefeedback"));
$div .= html_writer::link($url1, get_string("page_link_backtofeedbackview", "block_coursefeedback")) . "<br/>"
. html_writer::link($url2, get_string("page_link_backtoconfig", "block_coursefeedback")) . "<br/>"
. html_writer::end_div();
echo $OUTPUT->box($div);
if (is_int($feedbackid)) {
$notes = block_coursefeedback_validate($feedbackid, true);
if (!empty($notes)) {
$p = html_writer::tag("p", get_string("page_html_intronotifications", "block_coursefeedback"));
echo $OUTPUT->notification($p . html_writer::alist($notes));
}
}
}
/**
* Prints notification box for coursefeedback question administration.
*
* @param array $errors
* @param int $feedbackid
*/
function block_coursefeedback_print_noperm_page($errors, $feedbackid) {
global $OUTPUT;
$html = html_writer::tag("h4",
get_string("perm_header_editnotpermitted", "block_coursefeedback"),
array("style" => "text-align:center;"))
. html_writer::alist($errors, array("style" => "margin-left:3em;margin-right:3em;"));
if (isset($errors["answersexists"])) {
$html .= html_writer::tag("p",
get_string("perm_html_danswerslink", "block_coursefeedback", $feedbackid),
array("style" => "margin-left:3em;margin-right:3em;"));
} else if (isset($errors["erroractive"])) {
$html .= html_writer::tag("p",
get_string("perm_html_duplicatelink", "block_coursefeedback", $feedbackid),
array("style" => "margin-left:3em;margin-right:3em;"));
}
echo $OUTPUT->box($html);
}
/**
* @param int $feedbackid
* @param string $value - Displayed text
*/
function block_coursefeedback_create_activate_button($feedbackid, $value = "") {
global $DB;
if ($DB->record_exists("block_coursefeedback_answers", array("coursefeedbackid" => $feedbackid))) {
// Reactivation of FB's for whom answers exist is not possible.
return get_string("page_html_wasactive", "block_coursefeedback", $feedbackid);
}
if (!is_string($value) || $value === "") {
$value = get_string("page_link_use", "block_coursefeedback");
}
$url = block_coursefeedback_adminurl("feedback", "activate", $feedbackid);
return html_writer::link($url, $value);
}
/**
* Only alias for now.
* TODO: Provide space in DB for descriptions in different language and get it here.
*
* @param int $feedbackid - not used for now
*/
function block_coursefeedback_get_description($feedbackid) {
/*
global $DB, $USER, $COURSE;
$lang = $USER->lang;
$alternatives = array($COURSE->lang, $CFG->lang);
while (!$DB->record_exists("block_coursefeedback",
array("coursefeedbackid" => $feedbackid, "questionid" => 0, "language" => $lang)))
{
$lang = array_shift($alternatives);
}
return $DB->get_field("block_coursefeedback_questns",
"question",
array("coursefeedbackid" => $feedbackid,
"questionid" => 0,
"language" => $lang));
*/
return "";
}
/**
* Reimplementation of the moodle 1.9 execute_sql_arr.
*
* Secrurity WARNING: All statements won't be validated, before they are executed!
*
* @param array $sqlarr Each field is one query, one query contains the query string (key "query") and his parameters (key "params")
* @return boolean
*/
function block_coursefeedback_execute_sql_arr($sqlarr) {
global $DB;
// Transaction handling; improves db consistancy.
$dbtrans = $DB->start_delegated_transaction();
$success = true;
foreach ($sqlarr as $sql) {
// Check if for null-pointer warnings before execution.
if (!isset($sql["query"]) || !isset($sql["params"])) {
continue;
}
if (!$DB->execute($sql["query"], $sql["params"])) {
$success = false;
break;
}
}
if ($success) {
$dbtrans->allow_commit();
} else {
$dbtrans->rollback(new dbtransfer_exception("dbupdatefailed"));
}
return $success;
}
/**
* Fill missing values of an existing array.
*
* @param array $array
* @param int $start
* @param int $num
* @param mixed $value
*/
function block_coursefeedback_array_fill_spaces(&$array, $start, $num, $value) {
for ($i = $start; $i < $num; $i++) {
if (!isset($array[$i])) {
$array[$i] = $value;
}
}
ksort($array);
}
/**
* @param mixed $printable
* @param bool Should the execution of the script come to an end?
*/
function block_coursefeedback_debug($printable, $die = false) {
if (is_bool($printable)) {
$printable = $printable ? "TRUE" : "FALSE";
}
$string = "<pre>" . print_r($printable, true) . "</pre>";
if ($die) {
die($string);
} else {
echo $string;
}
}
/**
* @param array|bool $bools
* @return String a comma-seperated list of "TRUE" or "FALSE"
*/
function block_coursefeedback_check_bools($bools = array()) {
if (!is_array($bools)) {
$bools = array($bools);
}
foreach ($bools as &$boolean) {
$boolean = $boolean ? "TRUE" : "FALSE";
}
return join(" ", $bools);
}
/**
* @param string $langcode
* @return string - Gives the human readable language string
*/
function block_coursefeedback_get_language($langcode) {
$list = get_string_manager()->get_list_of_translations();
$language = (isset($list[$langcode])) ? $list[$langcode] : "[undefined]";
return $language;
}
/**
* Checks if there are questions to display for coursefeedback
*
* @param string $feedbackid
* @return boolean
*/
function block_coursefeedback_questions_exist($feedbackid = COURSEFEEDBACK_DEFAULT) {
global $DB, $CFG, $COURSE, $USER;
$config = get_config("block_coursefeedback");
$feedbackid = ($feedbackid === COURSEFEEDBACK_DEFAULT) ? $config->active_feedback : intval($feedbackid);
$langs = block_coursefeedback_get_combined_languages($feedbackid);
return in_array($USER->lang, $langs)
|| in_array($COURSE->lang, $langs)
|| in_array($CFG->lang, $langs)
|| in_array($config->default_language, $langs);
}
/**
* Check if there are answers for this coursefeedback
*
* @param string $feedbackid
* @return boolean
*/
function block_coursefeedback_answers_exist($feedbackid) {
global $DB;
return $DB->record_exists("block_coursefeedback_answers", ["coursefeedbackid" => $feedbackid]);
}
/**
* Checks feedback on useableness
*
* @param int $feedbackid
* @param boolean $returnerrors
* @return multitype:array boolean
*/
function block_coursefeedback_validate($feedbackid, $returnerrors = false) {
$notifications = array();
$feedbackid = intval($feedbackid);
$defaultlang[] = get_config("block_coursefeedback", "default_language");
if ($feedbackid > 0) {
$langs = block_coursefeedback_get_combined_languages($feedbackid);
if (empty($langs)) {
$notifications[] = get_string("page_html_norelations", "block_coursefeedback");
} elseif (!array_intersect($langs, $defaultlang)) {
$notifications[] = get_string("page_html_servedefaultlang",
"block_coursefeedback",
$defaultlang);
}
}
if ($returnerrors) {
return $notifications;
} else {
return empty($notifications);
}
}
function format($string) {
return format_text(stripslashes($string), FORMAT_PLAIN);
}
/**
* @param string $mode feedback|question|questions
* @param string $action view|edit|delete
* @param array $other params of the url.
* @return moodle_url to admin.php with given params.
*/
function block_coursefeedback_adminurl($mode, $action, $fid = null, array $other = array()) {
$url = new moodle_url("/blocks/coursefeedback/admin.php");
$params = array_merge($other, array("mode" => $mode, "action" => $action));
if (is_number($fid)) {
$params["fid"] = $fid;
}
$url->params($params);
return $url;
}
/**
* Returns the next open quesiton to answer if there is one
*
* @return array|null
* @throws \moodle_exception
*/
function block_coursefeedback_get_open_question() {
global $DB, $COURSE, $USER;
$config = get_config("block_coursefeedback");
$currentlang[] = current_language();
// Check if FB is active just in case
if (isset($config->active_feedback) && $config->active_feedback != 0) {
$questions = block_coursefeedback_get_questions_by_language($config->active_feedback, $currentlang);
foreach ($questions as $question) {
$params = [
"userid" => $USER->id,
"course" => $COURSE->id, "questionid" => $question->questionid,
"coursefeedbackid" => $config->active_feedback
];
if (!$DB->record_exists("block_coursefeedback_uidansw", $params)) {
// Diese Frage ist noch offen;
return array(
'currentopenqstn' => $question,
'questionsum' => count($questions)
);
}
}
// Keine offene Fragen vorhanden
return null;