-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlib.php
More file actions
3767 lines (3276 loc) · 136 KB
/
lib.php
File metadata and controls
3767 lines (3276 loc) · 136 KB
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/>.
/**
* Library of functions and constants for module individualfeedback
* includes the main-part of individualfeedback-functions
*
* @package mod_individualfeedback
* @copyright Andreas Grabs
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
// Include forms lib.
require_once($CFG->libdir.'/formslib.php');
define('INDIVIDUALFEEDBACK_ANONYMOUS_YES', 1);
define('INDIVIDUALFEEDBACK_ANONYMOUS_NO', 2);
define('INDIVIDUALFEEDBACK_MIN_ANONYMOUS_COUNT_IN_GROUP', 2);
define('INDIVIDUALFEEDBACK_DECIMAL', '.');
define('INDIVIDUALFEEDBACK_THOUSAND', ',');
define('INDIVIDUALFEEDBACK_RESETFORM_RESET', 'individualfeedback_reset_data_');
define('INDIVIDUALFEEDBACK_RESETFORM_DROP', 'individualfeedback_drop_individualfeedback_');
define('INDIVIDUALFEEDBACK_MAX_PIX_LENGTH', '400'); //max. Breite des grafischen Balkens in der Auswertung
define('INDIVIDUALFEEDBACK_DEFAULT_PAGE_COUNT', 20);
// Event types.
define('INDIVIDUALFEEDBACK_EVENT_TYPE_OPEN', 'open');
define('INDIVIDUALFEEDBACK_EVENT_TYPE_CLOSE', 'close');
/**
* Returns all other caps used in module.
*
* @return array
*/
function individualfeedback_get_extra_capabilities() {
return array('moodle/site:accessallgroups');
}
/**
* @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 individualfeedback_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;
}
}
/**
* this will create a new instance and return the id number
* of the new instance.
*
* @global object
* @param object $individualfeedback the object given by mod_individualfeedback_mod_form
* @return int
*/
function individualfeedback_add_instance($individualfeedback) {
global $DB;
$individualfeedback->timemodified = time();
$individualfeedback->id = '';
if (empty($individualfeedback->site_after_submit)) {
$individualfeedback->site_after_submit = '';
}
//saving the individualfeedback in db
$individualfeedbackid = $DB->insert_record("individualfeedback", $individualfeedback);
$individualfeedback->id = $individualfeedbackid;
individualfeedback_set_events($individualfeedback);
if (!isset($individualfeedback->coursemodule)) {
$cm = get_coursemodule_from_id('individualfeedback', $individualfeedback->id);
$individualfeedback->coursemodule = $cm->id;
}
$context = context_module::instance($individualfeedback->coursemodule);
if (!empty($individualfeedback->completionexpected)) {
\core_completion\api::update_completion_date_event($individualfeedback->coursemodule, 'individualfeedback', $individualfeedback->id,
$individualfeedback->completionexpected);
}
$editoroptions = individualfeedback_get_editor_options();
// process the custom wysiwyg editor in page_after_submit
if ($draftitemid = $individualfeedback->page_after_submit_editor['itemid']) {
$individualfeedback->page_after_submit = file_save_draft_area_files($draftitemid, $context->id,
'mod_individualfeedback', 'page_after_submit',
0, $editoroptions,
$individualfeedback->page_after_submit_editor['text']);
$individualfeedback->page_after_submitformat = $individualfeedback->page_after_submit_editor['format'];
}
$DB->update_record('individualfeedback', $individualfeedback);
return $individualfeedbackid;
}
/**
* this will update a given instance
*
* @global object
* @param object $individualfeedback the object given by mod_individualfeedback_mod_form
* @return boolean
*/
function individualfeedback_update_instance($individualfeedback) {
global $DB;
$individualfeedback->timemodified = time();
$individualfeedback->id = $individualfeedback->instance;
if (empty($individualfeedback->site_after_submit)) {
$individualfeedback->site_after_submit = '';
}
//save the individualfeedback into the db
$DB->update_record("individualfeedback", $individualfeedback);
//create or update the new events
individualfeedback_set_events($individualfeedback);
$completionexpected = (!empty($individualfeedback->completionexpected)) ? $individualfeedback->completionexpected : null;
\core_completion\api::update_completion_date_event($individualfeedback->coursemodule, 'individualfeedback', $individualfeedback->id, $completionexpected);
$context = context_module::instance($individualfeedback->coursemodule);
$editoroptions = individualfeedback_get_editor_options();
// process the custom wysiwyg editor in page_after_submit
if ($draftitemid = $individualfeedback->page_after_submit_editor['itemid']) {
$individualfeedback->page_after_submit = file_save_draft_area_files($draftitemid, $context->id,
'mod_individualfeedback', 'page_after_submit',
0, $editoroptions,
$individualfeedback->page_after_submit_editor['text']);
$individualfeedback->page_after_submitformat = $individualfeedback->page_after_submit_editor['format'];
}
$DB->update_record('individualfeedback', $individualfeedback);
return true;
}
/**
* Serves the files included in individualfeedback items like label. Implements needed access control ;-)
*
* There are two situations in general where the files will be sent.
* 1) filearea = item, 2) filearea = template
*
* @package mod_individualfeedback
* @category files
* @param stdClass $course course object
* @param stdClass $cm course module object
* @param stdClass $context context object
* @param string $filearea file area
* @param array $args extra arguments
* @param bool $forcedownload whether or not force download
* @param array $options additional options affecting the file serving
* @return bool false if file not found, does not return if found - justsend the file
*/
function individualfeedback_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
global $CFG, $DB;
if ($filearea === 'item' or $filearea === 'template') {
$itemid = (int)array_shift($args);
//get the item what includes the file
if (!$item = $DB->get_record('individualfeedback_item', array('id'=>$itemid))) {
return false;
}
$individualfeedbackid = $item->individualfeedback;
$templateid = $item->template;
}
if ($filearea === 'page_after_submit' or $filearea === 'item') {
if (! $individualfeedback = $DB->get_record("individualfeedback", array("id"=>$cm->instance))) {
return false;
}
$individualfeedbackid = $individualfeedback->id;
//if the filearea is "item" so we check the permissions like view/complete the individualfeedback
$canload = false;
//first check whether the user has the complete capability
if (has_capability('mod/individualfeedback:complete', $context)) {
$canload = true;
}
//now we check whether the user has the view capability
if (has_capability('mod/individualfeedback:view', $context)) {
$canload = true;
}
//if the individualfeedback is on frontpage and anonymous and the fullanonymous is allowed
//so the file can be loaded too.
if (isset($CFG->individualfeedback_allowfullanonymous)
AND $CFG->individualfeedback_allowfullanonymous
AND $course->id == SITEID
AND $individualfeedback->anonymous == INDIVIDUALFEEDBACK_ANONYMOUS_YES ) {
$canload = true;
}
if (!$canload) {
return false;
}
} else if ($filearea === 'template') { //now we check files in templates
if (!$template = $DB->get_record('individualfeedback_template', array('id'=>$templateid))) {
return false;
}
//if the file is not public so the capability edititems has to be there
if (!$template->ispublic) {
if (!has_capability('mod/individualfeedback:edititems', $context)) {
return false;
}
} else { //on public templates, at least the user has to be logged in
if (!isloggedin()) {
return false;
}
}
} else {
return false;
}
if ($context->contextlevel == CONTEXT_MODULE) {
if ($filearea !== 'item' and $filearea !== 'page_after_submit') {
return false;
}
}
if ($context->contextlevel == CONTEXT_COURSE || $context->contextlevel == CONTEXT_SYSTEM) {
if ($filearea !== 'template') {
return false;
}
}
$relativepath = implode('/', $args);
if ($filearea === 'page_after_submit') {
$fullpath = "/{$context->id}/mod_individualfeedback/$filearea/$relativepath";
} else {
$fullpath = "/{$context->id}/mod_individualfeedback/$filearea/{$item->id}/$relativepath";
}
$fs = get_file_storage();
if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
return false;
}
// finally send the file
send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
return false;
}
/**
* this will delete a given instance.
* all referenced data also will be deleted
*
* @global object
* @param int $id the instanceid of individualfeedback
* @return boolean
*/
function individualfeedback_delete_instance($id) {
global $DB;
//get all referenced items
$individualfeedbackitems = $DB->get_records('individualfeedback_item', array('individualfeedback'=>$id));
//deleting all referenced items and values
if (is_array($individualfeedbackitems)) {
foreach ($individualfeedbackitems as $individualfeedbackitem) {
$DB->delete_records("individualfeedback_value", array("item"=>$individualfeedbackitem->id));
$DB->delete_records("individualfeedback_valuetmp", array("item"=>$individualfeedbackitem->id));
}
if ($delitems = $DB->get_records("individualfeedback_item", array("individualfeedback"=>$id))) {
foreach ($delitems as $delitem) {
individualfeedback_delete_item($delitem->id, false);
}
}
}
//deleting the completeds
$DB->delete_records("individualfeedback_completed", array("individualfeedback"=>$id));
//deleting the unfinished completeds
$DB->delete_records("indfeedback_completedtmp", array("individualfeedback"=>$id));
// Delete the activity from the linked table.
if ($linkedid = individualfeedback_get_linkedid($id)) {
$DB->delete_records('individualfeedback_linked', array('individualfeedbackid' => $id));
// If there is only 1 record left, delete that record as well.
if ($DB->count_records('individualfeedback_linked', array('linkedid' => $linkedid)) < 2) {
$DB->delete_records('individualfeedback_linked', array('linkedid' => $linkedid));
}
}
//deleting old events
$DB->delete_records('event', array('modulename'=>'individualfeedback', 'instance'=>$id));
return $DB->delete_records("individualfeedback", array("id"=>$id));
}
/**
* Return a small object with summary information about what a
* user has done with a given particular instance of this module
* Used for user activity reports.
* $return->time = the time they did it
* $return->info = a short text description
*
* @param stdClass $course
* @param stdClass $user
* @param cm_info|stdClass $mod
* @param stdClass $individualfeedback
* @return stdClass
*/
function individualfeedback_user_outline($course, $user, $mod, $individualfeedback) {
global $DB;
$outline = (object)['info' => '', 'time' => 0];
if ($individualfeedback->anonymous != INDIVIDUALFEEDBACK_ANONYMOUS_NO) {
// Do not disclose any user info if individualfeedback is anonymous.
return $outline;
}
$params = array('userid' => individualfeedback_hash_userid($user->id), 'individualfeedback' => $individualfeedback->id,
'anonymous_response' => INDIVIDUALFEEDBACK_ANONYMOUS_NO);
$status = null;
$context = context_module::instance($mod->id);
if ($completed = $DB->get_record('individualfeedback_completed', $params)) {
// User has completed individualfeedback.
$outline->info = get_string('completed', 'individualfeedback');
$outline->time = $completed->timemodified;
} else if ($completedtmp = $DB->get_record('indfeedback_completedtmp', $params)) {
// User has started but not completed individualfeedback.
$outline->info = get_string('started', 'individualfeedback');
$outline->time = $completedtmp->timemodified;
} else if (has_capability('mod/individualfeedback:complete', $context, $user)) {
// User has not started individualfeedback but has capability to do so.
$outline->info = get_string('not_started', 'individualfeedback');
}
return $outline;
}
/**
* Returns all users who has completed a specified individualfeedback since a given time
* many thanks to Manolescu Dorel, who contributed these two functions
*
* @global object
* @global object
* @global object
* @global object
* @uses CONTEXT_MODULE
* @param array $activities Passed by reference
* @param int $index Passed by reference
* @param int $timemodified Timestamp
* @param int $courseid
* @param int $cmid
* @param int $userid
* @param int $groupid
* @return void
*/
function individualfeedback_get_recent_mod_activity(&$activities, &$index,
$timemodified, $courseid,
$cmid, $userid="", $groupid="") {
global $CFG, $COURSE, $USER, $DB;
if ($COURSE->id == $courseid) {
$course = $COURSE;
} else {
$course = $DB->get_record('course', array('id'=>$courseid));
}
$modinfo = get_fast_modinfo($course);
$cm = $modinfo->cms[$cmid];
$sqlargs = array();
$userfields = user_picture::fields('u', null, 'useridagain');
$sql = " SELECT fk . * , fc . * , $userfields
FROM {individualfeedback_completed} fc
JOIN {individualfeedback} fk ON fk.id = fc.individualfeedback
JOIN {user} u ON u.id = fc.userid ";
if ($groupid) {
$sql .= " JOIN {groups_members} gm ON gm.userid=u.id ";
}
$sql .= " WHERE fc.timemodified > ?
AND fk.id = ?
AND fc.anonymous_response = ?";
$sqlargs[] = $timemodified;
$sqlargs[] = $cm->instance;
$sqlargs[] = INDIVIDUALFEEDBACK_ANONYMOUS_NO;
if ($userid) {
$sql .= " AND u.id = ? ";
$sqlargs[] = $userid;
}
if ($groupid) {
$sql .= " AND gm.groupid = ? ";
$sqlargs[] = $groupid;
}
if (!$individualfeedbackitems = $DB->get_records_sql($sql, $sqlargs)) {
return;
}
$cm_context = context_module::instance($cm->id);
if (!has_capability('mod/individualfeedback:view', $cm_context)) {
return;
}
$accessallgroups = has_capability('moodle/site:accessallgroups', $cm_context);
$viewfullnames = has_capability('moodle/site:viewfullnames', $cm_context);
$groupmode = groups_get_activity_groupmode($cm, $course);
$aname = format_string($cm->name, true);
foreach ($individualfeedbackitems as $individualfeedbackitem) {
if ($individualfeedbackitem->userid != $USER->id) {
if ($groupmode == SEPARATEGROUPS and !$accessallgroups) {
$usersgroups = groups_get_all_groups($course->id,
$individualfeedbackitem->userid,
$cm->groupingid);
if (!is_array($usersgroups)) {
continue;
}
$usersgroups = array_keys($usersgroups);
$intersect = array_intersect($usersgroups, $modinfo->get_groups($cm->groupingid));
if (empty($intersect)) {
continue;
}
}
}
$tmpactivity = new stdClass();
$tmpactivity->type = 'individualfeedback';
$tmpactivity->cmid = $cm->id;
$tmpactivity->name = $aname;
$tmpactivity->sectionnum= $cm->sectionnum;
$tmpactivity->timestamp = $individualfeedbackitem->timemodified;
$tmpactivity->content = new stdClass();
$tmpactivity->content->individualfeedbackid = $individualfeedbackitem->id;
$tmpactivity->content->individualfeedbackuserid = $individualfeedbackitem->userid;
$tmpactivity->user = user_picture::unalias($individualfeedbackitem, null, 'useridagain');
$tmpactivity->user->fullname = fullname($individualfeedbackitem, $viewfullnames);
$activities[$index++] = $tmpactivity;
}
return;
}
/**
* Prints all users who has completed a specified individualfeedback since a given time
* many thanks to Manolescu Dorel, who contributed these two functions
*
* @global object
* @param object $activity
* @param int $courseid
* @param string $detail
* @param array $modnames
* @return void Output is echo'd
*/
function individualfeedback_print_recent_mod_activity($activity, $courseid, $detail, $modnames) {
global $CFG, $OUTPUT;
echo '<table border="0" cellpadding="3" cellspacing="0" class="forum-recent">';
echo "<tr><td class=\"userpicture\" valign=\"top\">";
echo $OUTPUT->user_picture($activity->user, array('courseid'=>$courseid));
echo "</td><td>";
if ($detail) {
$modname = $modnames[$activity->type];
echo '<div class="title">';
echo $OUTPUT->image_icon('icon', $modname, $activity->type);
echo "<a href=\"$CFG->wwwroot/mod/individualfeedback/view.php?id={$activity->cmid}\">{$activity->name}</a>";
echo '</div>';
}
echo '<div class="title">';
echo '</div>';
echo '<div class="user">';
echo "<a href=\"$CFG->wwwroot/user/view.php?id={$activity->user->id}&course=$courseid\">"
."{$activity->user->fullname}</a> - ".userdate($activity->timestamp);
echo '</div>';
echo "</td></tr></table>";
return;
}
/**
* Obtains the automatic completion state for this individualfeedback based on the condition
* in individualfeedback 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 individualfeedback_get_completion_state($course, $cm, $userid, $type) {
global $CFG, $DB;
// Get individualfeedback details
$individualfeedback = $DB->get_record('individualfeedback', array('id'=>$cm->instance), '*', MUST_EXIST);
// If completion option is enabled, evaluate it and return true/false
if ($individualfeedback->completionsubmit) {
$params = array('userid'=>individualfeedback_hash_userid($userid), 'individualfeedback'=>$individualfeedback->id);
return $DB->record_exists('individualfeedback_completed', $params);
} else {
// Completion option is not enabled so just return $type
return $type;
}
}
/**
* Print a detailed representation of what a user has done with
* a given particular instance of this module, for user activity reports.
*
* @param stdClass $course
* @param stdClass $user
* @param cm_info|stdClass $mod
* @param stdClass $individualfeedback
*/
function individualfeedback_user_complete($course, $user, $mod, $individualfeedback) {
global $DB;
if ($individualfeedback->anonymous != INDIVIDUALFEEDBACK_ANONYMOUS_NO) {
// Do not disclose any user info if individualfeedback is anonymous.
return;
}
$params = array('userid' => individualfeedback_hash_userid($user->id), 'individualfeedback' => $individualfeedback->id,
'anonymous_response' => INDIVIDUALFEEDBACK_ANONYMOUS_NO);
$url = $status = null;
$context = context_module::instance($mod->id);
if ($completed = $DB->get_record('individualfeedback_completed', $params)) {
// User has completed individualfeedback.
if (has_capability('mod/individualfeedback:viewreports', $context)) {
$url = new moodle_url('/mod/individualfeedback/show_entries.php',
['id' => $mod->id, 'userid' => $user->id,
'showcompleted' => $completed->id]);
}
$status = get_string('completedon', 'individualfeedback', userdate($completed->timemodified));
} else if ($completedtmp = $DB->get_record('indfeedback_completedtmp', $params)) {
// User has started but not completed individualfeedback.
$status = get_string('startedon', 'individualfeedback', userdate($completedtmp->timemodified));
} else if (has_capability('mod/individualfeedback:complete', $context, $user)) {
// User has not started individualfeedback but has capability to do so.
$status = get_string('not_started', 'individualfeedback');
}
if ($url && $status) {
echo html_writer::link($url, $status);
} else if ($status) {
echo html_writer::div($status);
}
}
/**
* @return bool true
*/
function individualfeedback_cron () {
return true;
}
/**
* @return bool false
*/
function individualfeedback_scale_used ($individualfeedbackid, $scaleid) {
return false;
}
/**
* Checks if scale is being used by any instance of individualfeedback
*
* This is used to find out if scale used anywhere
* @param $scaleid int
* @return boolean True if the scale is used by any assignment
*/
function individualfeedback_scale_used_anywhere($scaleid) {
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 individualfeedback_get_view_actions() {
return array('view', 'view all');
}
/**
* 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 individualfeedback_get_post_actions() {
return array('submit');
}
/**
* This function is used by the reset_course_userdata function in moodlelib.
* This function will remove all responses from the specified individualfeedback
* and clean up any related data.
*
* @global object
* @global object
* @uses INDIVIDUALFEEDBACK_RESETFORM_RESET
* @uses INDIVIDUALFEEDBACK_RESETFORM_DROP
* @param object $data the data submitted from the reset course.
* @return array status array
*/
function individualfeedback_reset_userdata($data) {
global $CFG, $DB;
$resetindividualfeedbacks = array();
$dropindividualfeedbacks = array();
$status = array();
$componentstr = get_string('modulenameplural', 'individualfeedback');
//get the relevant entries from $data
foreach ($data as $key => $value) {
switch(true) {
case substr($key, 0, strlen(INDIVIDUALFEEDBACK_RESETFORM_RESET)) == INDIVIDUALFEEDBACK_RESETFORM_RESET:
if ($value == 1) {
$templist = explode('_', $key);
if (isset($templist[3])) {
$resetindividualfeedbacks[] = intval($templist[3]);
}
}
break;
case substr($key, 0, strlen(INDIVIDUALFEEDBACK_RESETFORM_DROP)) == INDIVIDUALFEEDBACK_RESETFORM_DROP:
if ($value == 1) {
$templist = explode('_', $key);
if (isset($templist[3])) {
$dropindividualfeedbacks[] = intval($templist[3]);
}
}
break;
}
}
//reset the selected individualfeedbacks
foreach ($resetindividualfeedbacks as $id) {
$individualfeedback = $DB->get_record('individualfeedback', array('id'=>$id));
individualfeedback_delete_all_completeds($individualfeedback);
$status[] = array('component'=>$componentstr.':'.$individualfeedback->name,
'item'=>get_string('resetting_data', 'individualfeedback'),
'error'=>false);
}
// Updating dates - shift may be negative too.
if ($data->timeshift) {
$shifterror = !shift_course_mod_dates('individualfeedback', array('timeopen', 'timeclose'), $data->timeshift, $data->courseid);
$status[] = array('component' => $componentstr, 'item' => get_string('datechanged'), 'error' => $shifterror);
}
return $status;
}
/**
* Called by course/reset.php
*
* @global object
* @uses INDIVIDUALFEEDBACK_RESETFORM_RESET
* @param object $mform form passed by reference
*/
function individualfeedback_reset_course_form_definition(&$mform) {
global $COURSE, $DB;
$mform->addElement('header', 'individualfeedbackheader', get_string('modulenameplural', 'individualfeedback'));
if (!$individualfeedbacks = $DB->get_records('individualfeedback', array('course'=>$COURSE->id), 'name')) {
return;
}
$mform->addElement('static', 'hint', get_string('resetting_data', 'individualfeedback'));
foreach ($individualfeedbacks as $individualfeedback) {
$mform->addElement('checkbox', INDIVIDUALFEEDBACK_RESETFORM_RESET.$individualfeedback->id, $individualfeedback->name);
}
}
/**
* Course reset form defaults.
*
* @global object
* @uses INDIVIDUALFEEDBACK_RESETFORM_RESET
* @param object $course
*/
function individualfeedback_reset_course_form_defaults($course) {
global $DB;
$return = array();
if (!$individualfeedbacks = $DB->get_records('individualfeedback', array('course'=>$course->id), 'name')) {
return;
}
foreach ($individualfeedbacks as $individualfeedback) {
$return[INDIVIDUALFEEDBACK_RESETFORM_RESET.$individualfeedback->id] = true;
}
return $return;
}
/**
* Called by course/reset.php and shows the formdata by coursereset.
* it prints checkboxes for each individualfeedback available at the given course
* there are two checkboxes:
* 1) delete userdata and keep the individualfeedback
* 2) delete userdata and drop the individualfeedback
*
* @global object
* @uses INDIVIDUALFEEDBACK_RESETFORM_RESET
* @uses INDIVIDUALFEEDBACK_RESETFORM_DROP
* @param object $course
* @return void
*/
function individualfeedback_reset_course_form($course) {
global $DB, $OUTPUT;
echo get_string('resetting_individualfeedbacks', 'individualfeedback'); echo ':<br />';
if (!$individualfeedbacks = $DB->get_records('individualfeedback', array('course'=>$course->id), 'name')) {
return;
}
foreach ($individualfeedbacks as $individualfeedback) {
echo '<p>';
echo get_string('name', 'individualfeedback').': '.$individualfeedback->name.'<br />';
echo html_writer::checkbox(INDIVIDUALFEEDBACK_RESETFORM_RESET.$individualfeedback->id,
1, true,
get_string('resetting_data', 'individualfeedback'));
echo '<br />';
echo html_writer::checkbox(INDIVIDUALFEEDBACK_RESETFORM_DROP.$individualfeedback->id,
1, false,
get_string('drop_individualfeedback', 'individualfeedback'));
echo '</p>';
}
}
/**
* This gets an array with default options for the editor
*
* @return array the options
*/
function individualfeedback_get_editor_options() {
return array('maxfiles' => EDITOR_UNLIMITED_FILES,
'trusttext'=>true);
}
/**
* This creates new events given as timeopen and closeopen by $individualfeedback.
*
* @global object
* @param object $individualfeedback
* @return void
*/
function individualfeedback_set_events($individualfeedback) {
global $DB, $CFG;
// Include calendar/lib.php.
require_once($CFG->dirroot.'/calendar/lib.php');
// Get CMID if not sent as part of $individualfeedback.
if (!isset($individualfeedback->coursemodule)) {
$cm = get_coursemodule_from_instance('individualfeedback', $individualfeedback->id, $individualfeedback->course);
$individualfeedback->coursemodule = $cm->id;
}
// individualfeedback start calendar events.
$eventid = $DB->get_field('event', 'id',
array('modulename' => 'individualfeedback', 'instance' => $individualfeedback->id, 'eventtype' => INDIVIDUALFEEDBACK_EVENT_TYPE_OPEN));
if (isset($individualfeedback->timeopen) && $individualfeedback->timeopen > 0) {
$event = new stdClass();
$event->eventtype = INDIVIDUALFEEDBACK_EVENT_TYPE_OPEN;
$event->type = empty($individualfeedback->timeclose) ? CALENDAR_EVENT_TYPE_ACTION : CALENDAR_EVENT_TYPE_STANDARD;
$event->name = get_string('calendarstart', 'individualfeedback', $individualfeedback->name);
$event->description = format_module_intro('individualfeedback', $individualfeedback, $individualfeedback->coursemodule, false);
$event->format = FORMAT_HTML;
$event->timestart = $individualfeedback->timeopen;
$event->timesort = $individualfeedback->timeopen;
$event->visible = instance_is_visible('individualfeedback', $individualfeedback);
$event->timeduration = 0;
if ($eventid) {
// Calendar event exists so update it.
$event->id = $eventid;
$calendarevent = calendar_event::load($event->id);
$calendarevent->update($event);
} else {
// Event doesn't exist so create one.
$event->courseid = $individualfeedback->course;
$event->groupid = 0;
$event->userid = 0;
$event->modulename = 'individualfeedback';
$event->instance = $individualfeedback->id;
$event->eventtype = INDIVIDUALFEEDBACK_EVENT_TYPE_OPEN;
calendar_event::create($event);
}
} else if ($eventid) {
// Calendar event is on longer needed.
$calendarevent = calendar_event::load($eventid);
$calendarevent->delete();
}
// individualfeedback close calendar events.
$eventid = $DB->get_field('event', 'id',
array('modulename' => 'individualfeedback', 'instance' => $individualfeedback->id, 'eventtype' => INDIVIDUALFEEDBACK_EVENT_TYPE_CLOSE));
if (isset($individualfeedback->timeclose) && $individualfeedback->timeclose > 0) {
$event = new stdClass();
$event->type = CALENDAR_EVENT_TYPE_ACTION;
$event->eventtype = INDIVIDUALFEEDBACK_EVENT_TYPE_CLOSE;
$event->name = get_string('calendarend', 'individualfeedback', $individualfeedback->name);
$event->description = format_module_intro('individualfeedback', $individualfeedback, $individualfeedback->coursemodule, false);
$event->format = FORMAT_HTML;
$event->timestart = $individualfeedback->timeclose;
$event->timesort = $individualfeedback->timeclose;
$event->visible = instance_is_visible('individualfeedback', $individualfeedback);
$event->timeduration = 0;
if ($eventid) {
// Calendar event exists so update it.
$event->id = $eventid;
$calendarevent = calendar_event::load($event->id);
$calendarevent->update($event);
} else {
// Event doesn't exist so create one.
$event->courseid = $individualfeedback->course;
$event->groupid = 0;
$event->userid = 0;
$event->modulename = 'individualfeedback';
$event->instance = $individualfeedback->id;
calendar_event::create($event);
}
} else if ($eventid) {
// Calendar event is on longer needed.
$calendarevent = calendar_event::load($eventid);
$calendarevent->delete();
}
}
/**
* This standard function will check all instances of this module
* and make sure there are up-to-date events created for each of them.
* If courseid = 0, then every individualfeedback event in the site is checked, else
* only individualfeedback events belonging to the course specified are checked.
* This function is used, in its new format, by restore_refresh_events()
*
* @param int $courseid
* @param int|stdClass $instance individualfeedback module instance or ID.
* @param int|stdClass $cm Course module object or ID (not used in this module).
* @return bool
*/
function individualfeedback_refresh_events($courseid = 0, $instance = null, $cm = null) {
global $DB;
// If we have instance information then we can just update the one event instead of updating all events.
if (isset($instance)) {
if (!is_object($instance)) {
$instance = $DB->get_record('individualfeedback', array('id' => $instance), '*', MUST_EXIST);
}
individualfeedback_set_events($instance);
return true;
}
if ($courseid) {
if (! $individualfeedbacks = $DB->get_records("individualfeedback", array("course" => $courseid))) {
return true;
}
} else {
if (! $individualfeedbacks = $DB->get_records("individualfeedback")) {
return true;
}
}
foreach ($individualfeedbacks as $individualfeedback) {
individualfeedback_set_events($individualfeedback);
}
return true;
}
/**
* this function is called by {@link individualfeedback_delete_userdata()}
* it drops the individualfeedback-instance from the course_module table
*
* @global object
* @param int $id the id from the coursemodule
* @return boolean
*/
function individualfeedback_delete_course_module($id) {
global $DB;
if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
return true;
}
return $DB->delete_records('course_modules', array('id'=>$cm->id));
}
////////////////////////////////////////////////
//functions to handle capabilities
////////////////////////////////////////////////
/**
* returns the context-id related to the given coursemodule-id
*
* @deprecated since 3.1
* @staticvar object $context
* @param int $cmid the coursemodule-id
* @return object $context
*/
function individualfeedback_get_context($cmid) {
debugging('Function individualfeedback_get_context() is deprecated because it was not used.',
DEBUG_DEVELOPER);
static $context;
if (isset($context)) {
return $context;
}
$context = context_module::instance($cmid);
return $context;
}
/**
* returns true if the current role is faked by switching role feature
*
* @param int courseid - the id of the course
* @return boolean
*/
function individualfeedback_check_is_switchrole($courseid) {
return is_role_switched($courseid);
}
/**
* Returns true if the current users is logged in as someone else.
*
* @global object
* @return boolean
*/
function individualfeedback_check_is_loggedinas() {
global $USER;
if (isset($USER->realuser) && $USER->realuser != $USER->id) {
return true;
}
return false;
}
/**
* count users which have not completed the individualfeedback