mirrored from git://git.moodle.org/moodle.git
/
provider.php
1981 lines (1784 loc) · 84.5 KB
/
provider.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/>.
/**
* Data provider.
*
* @package core_competency
* @copyright 2018 Frédéric Massart
* @author Frédéric Massart <fred@branchup.tech>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core_competency\privacy;
defined('MOODLE_INTERNAL') || die();
use context;
use context_course;
use context_helper;
use context_module;
use context_system;
use context_user;
use moodle_recordset;
use core_competency\api;
use core_competency\competency;
use core_competency\competency_framework;
use core_competency\course_competency;
use core_competency\course_competency_settings;
use core_competency\course_module_competency;
use core_competency\evidence;
use core_competency\plan;
use core_competency\plan_competency;
use core_competency\related_competency;
use core_competency\template;
use core_competency\template_cohort;
use core_competency\template_competency;
use core_competency\user_competency;
use core_competency\user_competency_course;
use core_competency\user_competency_plan;
use core_competency\user_evidence;
use core_competency\user_evidence_competency;
use core_competency\external\performance_helper;
use core_privacy\local\metadata\collection;
use core_privacy\local\request\contextlist;
use core_privacy\local\request\approved_contextlist;
use core_privacy\local\request\transform;
use core_privacy\local\request\writer;
/**
* Data provider class.
*
* @package core_competency
* @copyright 2018 Frédéric Massart
* @author Frédéric Massart <fred@branchup.tech>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class provider implements
\core_privacy\local\metadata\provider,
\core_privacy\local\request\subsystem\provider {
/**
* Returns metadata.
*
* @param collection $collection The initialised collection to add items to.
* @return collection A listing of user data stored through this system.
*/
public static function get_metadata(collection $collection) : collection {
// Tables not related to users aside from the editing information.
$collection->add_database_table('competency', [
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency');
$collection->add_database_table('competency_coursecompsetting', [
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_coursecompsetting');
$collection->add_database_table('competency_framework', [
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_framework');
$collection->add_database_table('competency_coursecomp', [
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_coursecomp');
$collection->add_database_table('competency_template', [
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_template');
$collection->add_database_table('competency_templatecomp', [
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_templatecomp');
$collection->add_database_table('competency_templatecohort', [
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_templatecohort');
$collection->add_database_table('competency_relatedcomp', [
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_relatedcomp');
$collection->add_database_table('competency_modulecomp', [
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_modulecomp');
// Tables containing user data.
$collection->add_database_table('competency_plan', [
'name' => 'privacy:metadata:plan:name',
'description' => 'privacy:metadata:plan:description',
'userid' => 'privacy:metadata:plan:userid',
'status' => 'privacy:metadata:plan:status',
'duedate' => 'privacy:metadata:plan:duedate',
'reviewerid' => 'privacy:metadata:plan:reviewerid',
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_plan');
$collection->add_database_table('competency_usercomp', [
'userid' => 'privacy:metadata:usercomp:userid',
'status' => 'privacy:metadata:usercomp:status',
'reviewerid' => 'privacy:metadata:usercomp:reviewerid',
'proficiency' => 'privacy:metadata:usercomp:proficiency',
'grade' => 'privacy:metadata:usercomp:grade',
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_usercomp');
$collection->add_database_table('competency_usercompcourse', [
'userid' => 'privacy:metadata:usercomp:userid',
'proficiency' => 'privacy:metadata:usercomp:proficiency',
'grade' => 'privacy:metadata:usercomp:grade',
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_usercompcourse');
$collection->add_database_table('competency_usercompplan', [
'userid' => 'privacy:metadata:usercomp:userid',
'proficiency' => 'privacy:metadata:usercomp:proficiency',
'grade' => 'privacy:metadata:usercomp:grade',
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_usercompplan');
$collection->add_database_table('competency_plancomp', [
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_plancomp');
$collection->add_database_table('competency_evidence', [
'action' => 'privacy:metadata:evidence:action',
'actionuserid' => 'privacy:metadata:evidence:actionuserid',
'descidentifier' => 'privacy:metadata:evidence:descidentifier',
'desccomponent' => 'privacy:metadata:evidence:desccomponent',
'desca' => 'privacy:metadata:evidence:desca',
'url' => 'privacy:metadata:evidence:url',
'grade' => 'privacy:metadata:evidence:grade',
'note' => 'privacy:metadata:evidence:note',
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_evidence');
$collection->add_database_table('competency_userevidence', [
'name' => 'privacy:metadata:userevidence:name',
'description' => 'privacy:metadata:userevidence:description',
'url' => 'privacy:metadata:userevidence:url',
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_userevidence');
$collection->add_database_table('competency_userevidencecomp', [
'timecreated' => 'privacy:metadata:timecreated',
'timemodified' => 'privacy:metadata:timemodified',
'usermodified' => 'privacy:metadata:usermodified',
], 'privacy:metadata:competency_userevidencecomp');
// Comments can be left on learning plans and competencies.
$collection->link_subsystem('core_comments', 'privacy:metadata:core_comments');
return $collection;
}
/**
* Get the list of contexts that contain user information for the specified user.
*
* @param int $userid The user to search.
* @return contextlist $contextlist The contextlist containing the list of contexts used in this plugin.
*/
public static function get_contexts_for_userid(int $userid) : contextlist {
global $DB;
$contextlist = new \core_privacy\local\request\contextlist();
// Find the contexts of the frameworks, and related data, modified by the user.
$sql = "
SELECT DISTINCT ctx.id
FROM {context} ctx
JOIN {" . competency_framework::TABLE . "} cf
ON cf.contextid = ctx.id
LEFT JOIN {" . competency::TABLE . "} c
ON c.competencyframeworkid = cf.id
LEFT JOIN {" . related_competency::TABLE . "} cr
ON cr.competencyid = c.id
WHERE cf.usermodified = :userid1
OR c.usermodified = :userid2
OR cr.usermodified = :userid3";
$params = ['userid1' => $userid, 'userid2' => $userid, 'userid3' => $userid];
$contextlist->add_from_sql($sql, $params);
// Find the contexts of the templates, and related data, modified by the user.
$sql = "
SELECT DISTINCT ctx.id
FROM {context} ctx
JOIN {" . template::TABLE . "} tpl
ON tpl.contextid = ctx.id
LEFT JOIN {" . template_cohort::TABLE . "} tch
ON tch.templateid = tpl.id
LEFT JOIN {" . template_competency::TABLE . "} tc
ON tc.templateid = tpl.id
WHERE tpl.usermodified = :userid1
OR tch.usermodified = :userid2
OR tc.usermodified = :userid3";
$params = ['userid1' => $userid, 'userid2' => $userid, 'userid3' => $userid];
$contextlist->add_from_sql($sql, $params);
// Find the possible course contexts.
$sql = "
SELECT DISTINCT ctx.id
FROM {" . course_competency::TABLE . "} cc
JOIN {context} ctx
ON ctx.instanceid = cc.courseid
AND ctx.contextlevel = :courselevel
WHERE cc.usermodified = :userid";
$params = ['courselevel' => CONTEXT_COURSE, 'userid' => $userid];
$contextlist->add_from_sql($sql, $params);
$sql = "
SELECT DISTINCT ctx.id
FROM {" . course_competency_settings::TABLE . "} ccs
JOIN {context} ctx
ON ctx.instanceid = ccs.courseid
AND ctx.contextlevel = :courselevel
WHERE ccs.usermodified = :userid";
$params = ['courselevel' => CONTEXT_COURSE, 'userid' => $userid];
$contextlist->add_from_sql($sql, $params);
$sql = "
SELECT DISTINCT ctx.id
FROM {" . user_competency_course::TABLE . "} ucc
JOIN {context} ctx
ON ctx.instanceid = ucc.courseid
AND ctx.contextlevel = :courselevel
WHERE ucc.usermodified = :userid";
$params = ['courselevel' => CONTEXT_COURSE, 'userid' => $userid];
$contextlist->add_from_sql($sql, $params);
// Find the possible module contexts.
$sql = "
SELECT DISTINCT ctx.id
FROM {" . course_module_competency::TABLE . "} cmc
JOIN {context} ctx
ON ctx.instanceid = cmc.cmid
AND ctx.contextlevel = :modulelevel
WHERE cmc.usermodified = :userid";
$params = ['modulelevel' => CONTEXT_MODULE, 'userid' => $userid];
$contextlist->add_from_sql($sql, $params);
// Add user contexts through usermodified/reviewing of plan related data.
$sql = "
SELECT DISTINCT ctx.id
FROM {" . plan::TABLE . "} p
JOIN {context} ctx
ON ctx.instanceid = p.userid
AND ctx.contextlevel = :userlevel
LEFT JOIN {" . plan_competency::TABLE . "} pc
ON pc.planid = p.id
LEFT JOIN {" . user_competency_plan::TABLE . "} upc
ON upc.planid = p.id
WHERE p.usermodified = :userid1
OR p.reviewerid = :userid2
OR pc.usermodified = :userid3
OR upc.usermodified = :userid4";
$params = [
'userlevel' => CONTEXT_USER,
'userid1' => $userid,
'userid2' => $userid,
'userid3' => $userid,
'userid4' => $userid,
];
$contextlist->add_from_sql($sql, $params);
// Add user contexts through usermodified/reviewing of competency data.
$sql = "
SELECT DISTINCT ctx.id
FROM {context} ctx
LEFT JOIN {" . user_competency::TABLE . "} uc
ON uc.userid = ctx.instanceid
AND ctx.contextlevel = :userlevel1
LEFT JOIN {" . evidence::TABLE . "} e
ON e.usercompetencyid = uc.id
LEFT JOIN {" . user_evidence::TABLE . "} ue
ON ue.userid = ctx.instanceid
AND ctx.contextlevel = :userlevel2
LEFT JOIN {" . user_evidence_competency::TABLE . "} uec
ON uec.userevidenceid = ue.id
WHERE uc.usermodified = :userid1
OR uc.reviewerid = :userid2
OR e.usermodified = :userid3
OR e.actionuserid = :userid4
OR ue.usermodified = :userid5
OR uec.usermodified = :userid6";
$params = [
'userlevel1' => CONTEXT_USER,
'userlevel2' => CONTEXT_USER,
'userid1' => $userid,
'userid2' => $userid,
'userid3' => $userid,
'userid4' => $userid,
'userid5' => $userid,
'userid6' => $userid,
];
$contextlist->add_from_sql($sql, $params);
// Now, the easy part, we fetch the user context for user plans and competencies.
// We also fetch the course context for the state of competencies for the user in courses.
$sql = "
SELECT DISTINCT ctx.id
FROM {context} ctx
LEFT JOIN {" . plan::TABLE . "} p
ON p.userid = ctx.instanceid
AND ctx.contextlevel = :userlevel1
LEFT JOIN {" . user_competency::TABLE . "} uc
ON uc.userid = ctx.instanceid
AND ctx.contextlevel = :userlevel2
LEFT JOIN {" . user_evidence::TABLE . "} ue
ON ue.userid = ctx.instanceid
AND ctx.contextlevel = :userlevel3
LEFT JOIN {" . user_competency_course::TABLE . "} ucc
ON ucc.courseid = ctx.instanceid AND ctx.contextlevel = :courselevel
WHERE p.userid = :userid1
OR uc.userid = :userid2
OR ue.userid = :userid3
OR ucc.userid = :userid4";
$params = [
'userlevel1' => CONTEXT_USER,
'userlevel2' => CONTEXT_USER,
'userlevel3' => CONTEXT_USER,
'courselevel' => CONTEXT_COURSE,
'userid1' => $userid,
'userid2' => $userid,
'userid3' => $userid,
'userid4' => $userid,
];
$contextlist->add_from_sql($sql, $params);
// Include the user contexts in which the user commented.
$sql = "
SELECT ctx.id
FROM {context} ctx
JOIN {comments} c
ON c.contextid = ctx.id
WHERE c.component = :component
AND c.commentarea IN (:planarea, :usercomparea)
AND c.userid = :userid";
$params = [
'component' => 'competency', // Must not be core_competency.
'planarea' => 'plan',
'usercomparea' => 'user_competency',
'userid' => $userid
];
$contextlist->add_from_sql($sql, $params);
return $contextlist;
}
/**
* Export all user data for the specified user, in the specified contexts.
*
* @param approved_contextlist $contextlist The approved contexts to export information for.
*/
public static function export_user_data(approved_contextlist $contextlist) {
$user = $contextlist->get_user();
$userid = $user->id;
// Re-arrange the contexts by context level.
$groupedcontexts = array_reduce($contextlist->get_contexts(), function($carry, $context) {
$contextlevel = $context->contextlevel;
if (!in_array($contextlevel, [CONTEXT_USER, CONTEXT_COURSE, CONTEXT_MODULE, CONTEXT_SYSTEM, CONTEXT_COURSECAT])) {
return $carry;
}
$carry[$contextlevel][] = $context;
return $carry;
}, [
CONTEXT_COURSE => [],
CONTEXT_COURSECAT => [],
CONTEXT_MODULE => [],
CONTEXT_SYSTEM => [],
CONTEXT_USER => [],
]);
// Process module contexts.
static::export_user_data_in_module_contexts($userid, $groupedcontexts[CONTEXT_MODULE]);
// Process course contexts.
static::export_user_data_in_course_contexts($userid, $groupedcontexts[CONTEXT_COURSE]);
// Process course categories context.
static::export_user_data_in_category_contexts($userid, $groupedcontexts[CONTEXT_COURSECAT]);
// Process system context.
if (!empty($groupedcontexts[CONTEXT_SYSTEM])) {
static::export_user_data_in_system_context($userid);
}
// Process user contexts.
static::export_user_data_in_user_contexts($userid, $groupedcontexts[CONTEXT_USER]);
}
/**
* Delete all data for all users in the specified context.
*
* @param context $context The specific context to delete data for.
*/
public static function delete_data_for_all_users_in_context(context $context) {
global $DB;
switch ($context->contextlevel) {
case CONTEXT_USER:
$userid = $context->instanceid;
static::delete_user_evidence_of_prior_learning($userid);
static::delete_user_plans($userid);
static::delete_user_competencies($userid);
break;
case CONTEXT_COURSE:
$courseid = $context->instanceid;
$DB->delete_records(user_competency_course::TABLE, ['courseid' => $courseid]);
break;
}
}
/**
* Delete all user data for the specified user, in the specified contexts.
*
* Here we only delete the private data of user, not whether they modified, are reviewing,
* or are associated with the record on at a second level. Only data directly linked to the
* user will be affected.
*
* @param approved_contextlist $contextlist The approved contexts and user information to delete information for.
*/
public static function delete_data_for_user(approved_contextlist $contextlist) {
$user = $contextlist->get_user();
$userid = $user->id;
foreach ($contextlist as $context) {
switch ($context->contextlevel) {
case CONTEXT_USER:
if ($context->instanceid != $userid) {
// Only delete the user's information when they requested their context to be deleted. We
// do not take any action on other user's contexts because we don't own the data there.
continue;
}
static::delete_user_evidence_of_prior_learning($userid);
static::delete_user_plans($userid);
static::delete_user_competencies($userid);
break;
case CONTEXT_COURSE:
static::delete_user_competencies_in_course($userid, $context->instanceid);
break;
}
}
}
/**
* Delete evidence of prior learning.
*
* @param int $userid The user ID.
* @return void
*/
protected static function delete_user_evidence_of_prior_learning($userid) {
global $DB;
$usercontext = context_user::instance($userid);
$ueids = $DB->get_fieldset_select(user_evidence::TABLE, 'id', 'userid = :userid', ['userid' => $userid]);
if (empty($ueids)) {
return;
}
list($insql, $inparams) = $DB->get_in_or_equal($ueids, SQL_PARAMS_NAMED);
// Delete competencies associated with user evidence.
$DB->delete_records_select(user_evidence_competency::TABLE, "userevidenceid $insql", $inparams);
// Delete the user evidence.
$DB->delete_records_select(user_evidence::TABLE, "id $insql", $inparams);
// Delete the user evidence files.
$fs = get_file_storage();
$fs->delete_area_files($usercontext->id, 'core_competency', 'userevidence');
}
/**
* User plans.
*
* @param int $userid The user ID.
* @return void
*/
protected static function delete_user_plans($userid) {
global $DB;
$usercontext = context_user::instance($userid);
// Remove all the comments made on plans.
\core_comment\privacy\provider::delete_comments_for_all_users($usercontext, 'competency', 'plan');
// Find the user plan IDs.
$planids = $DB->get_fieldset_select(plan::TABLE, 'id', 'userid = :userid', ['userid' => $userid]);
if (empty($planids)) {
return;
}
list($insql, $inparams) = $DB->get_in_or_equal($planids, SQL_PARAMS_NAMED);
// Delete all the competencies proficiency in the plans.
$DB->delete_records_select(user_competency_plan::TABLE, "planid $insql", $inparams);
// Delete all the competencies in the plans.
$DB->delete_records_select(plan_competency::TABLE, "planid $insql", $inparams);
// Delete all the plans.
$DB->delete_records_select(plan::TABLE, "id $insql", $inparams);
}
/**
* Delete user competency data.
*
* @param int $userid The user ID.
* @return void
*/
protected static function delete_user_competencies($userid) {
global $DB;
$usercontext = context_user::instance($userid);
// Remove all the comments made on user competencies.
\core_comment\privacy\provider::delete_comments_for_all_users($usercontext, 'competency', 'user_competency');
// Find the user competency IDs.
$ucids = $DB->get_fieldset_select(user_competency::TABLE, 'id', 'userid = :userid', ['userid' => $userid]);
if (empty($ucids)) {
return;
}
list($insql, $inparams) = $DB->get_in_or_equal($ucids, SQL_PARAMS_NAMED);
// Delete all the evidence associated with competencies.
$DB->delete_records_select(evidence::TABLE, "usercompetencyid $insql", $inparams);
// Delete all the record of competency.
$DB->delete_records_select(user_competency::TABLE, "id $insql", $inparams);
}
/**
* Delete the record of competencies for a user in a course.
*
* @param int $userid The user ID.
* @param int $courseid The course ID.
* @return void
*/
protected static function delete_user_competencies_in_course($userid, $courseid) {
global $DB;
$DB->delete_records(user_competency_course::TABLE, ['userid' => $userid, 'courseid' => $courseid]);
}
/**
* Export the user data in user context.
*
* @param int $userid The user ID.
* @param array $contexts The contexts.
* @return void
*/
protected static function export_user_data_in_user_contexts($userid, array $contexts) {
global $DB;
$mycontext = context_user::instance($userid);
$contextids = array_map(function($context) {
return $context->id;
}, $contexts);
$exportowncontext = in_array($mycontext->id, $contextids);
$othercontexts = array_filter($contextids, function($contextid) use ($mycontext) {
return $contextid != $mycontext->id;
});
if ($exportowncontext) {
static::export_user_data_learning_plans($mycontext);
static::export_user_data_competencies($mycontext);
static::export_user_data_user_evidence($mycontext);
}
foreach ($othercontexts as $contextid) {
static::export_user_data_learning_plans_related_to_me($userid, context::instance_by_id($contextid));
static::export_user_data_competencies_related_to_me($userid, context::instance_by_id($contextid));
static::export_user_data_user_evidence_related_to_me($userid, context::instance_by_id($contextid));
}
}
/**
* Export the user data in systen context.
*
* @param int $userid The user ID.
* @return void
*/
protected static function export_user_data_in_system_context($userid) {
static::export_user_data_frameworks_in_context($userid, context_system::instance());
static::export_user_data_templates_in_context($userid, context_system::instance());
}
/**
* Export the user data in category contexts.
*
* @param int $userid The user ID.
* @param array $contexts The contexts.
* @return void
*/
protected static function export_user_data_in_category_contexts($userid, array $contexts) {
$contexts = array_filter($contexts, function($context) {
return $context->contextlevel == CONTEXT_COURSECAT;
});
if (empty($contexts)) {
return;
}
foreach ($contexts as $context) {
static::export_user_data_frameworks_in_context($userid, $context);
static::export_user_data_templates_in_context($userid, $context);
}
}
/**
* Export the user data in course contexts.
*
* @param int $userid The user whose data we're exporting.
* @param array $contexts A list of contexts.
* @return void
*/
protected static function export_user_data_in_course_contexts($userid, array $contexts) {
global $DB;
$contexts = array_filter($contexts, function($context) {
return $context->contextlevel == CONTEXT_COURSE;
});
if (empty($contexts)) {
return;
}
$helper = new performance_helper();
$path = [get_string('competencies', 'core_competency')];
$courseids = array_map(function($context) {
return $context->instanceid;
}, $contexts);
// Fetch all the records of competency proficiency in the course.
$ffields = competency_framework::get_sql_fields('f', 'f_');
$compfields = competency::get_sql_fields('c', 'c_');
$uccfields = user_competency_course::get_sql_fields('ucc', 'ucc_');
$ctxfields = context_helper::get_preload_record_columns_sql('ctx');
list($insql, $inparams) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
$sql = "
SELECT $ffields, $compfields, $uccfields, $ctxfields
FROM {" . user_competency_course::TABLE . "} ucc
JOIN {" . competency::TABLE . "} c
ON c.id = ucc.competencyid
JOIN {" . competency_framework::TABLE . "} f
ON f.id = c.competencyframeworkid
JOIN {context} ctx
ON ctx.id = f.contextid
WHERE ucc.userid = :userid
AND ucc.courseid $insql
ORDER BY ucc.courseid, c.id";
$params = array_merge($inparams, ['userid' => $userid]);
// Export data.
$recordset = $DB->get_recordset_sql($sql, $params);
static::recordset_loop_and_export($recordset, 'ucc_courseid', [], function($carry, $record) use ($helper) {
context_helper::preload_from_record($record);
$framework = new competency_framework(null, competency_framework::extract_record($record, 'f_'));
$competency = new competency(null, competency::extract_record($record, 'c_'));
$ucc = new user_competency_course(null, user_competency_course::extract_record($record, 'ucc_'));
$helper->ingest_framework($framework);
$carry[] = array_merge(static::transform_competency_brief($competency), [
'rating' => [
'rating' => static::transform_competency_grade($competency, $ucc->get('grade'), $helper),
'proficient' => static::transform_proficiency($ucc->get('proficiency')),
'timecreated' => transform::datetime($ucc->get('timecreated')),
'timemodified' => transform::datetime($ucc->get('timemodified')),
]
]);
return $carry;
}, function($courseid, $data) use ($path) {
$context = context_course::instance($courseid);
writer::with_context($context)->export_data($path, (object) ['ratings' => $data]);
});
// Export usermodified data.
static::export_user_data_in_course_contexts_associations($userid, $courseids, $path);
static::export_user_data_in_course_contexts_settings($userid, $courseids, $path);
static::export_user_data_in_course_contexts_rated_by_me($userid, $courseids, $path, $helper);
}
/**
* Export the ratings given in a course.
*
* @param int $userid The user ID.
* @param array $courseids The course IDs.
* @param array $path The root path.
* @param performance_helper $helper The performance helper.
* @return void
*/
protected static function export_user_data_in_course_contexts_rated_by_me($userid, $courseids, $path,
performance_helper $helper) {
global $DB;
// Fetch all the records of competency proficiency in the course.
$ffields = competency_framework::get_sql_fields('f', 'f_');
$compfields = competency::get_sql_fields('c', 'c_');
$uccfields = user_competency_course::get_sql_fields('ucc', 'ucc_');
$ctxfields = context_helper::get_preload_record_columns_sql('ctx');
list($insql, $inparams) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
$sql = "
SELECT $ffields, $compfields, $uccfields, $ctxfields
FROM {" . user_competency_course::TABLE . "} ucc
JOIN {" . competency::TABLE . "} c
ON c.id = ucc.competencyid
JOIN {" . competency_framework::TABLE . "} f
ON f.id = c.competencyframeworkid
JOIN {context} ctx
ON ctx.id = f.contextid
WHERE ucc.usermodified = :userid
AND ucc.courseid $insql
ORDER BY ucc.courseid, ucc.id";
$params = array_merge($inparams, ['userid' => $userid]);
// Export the data.
static::recordset_loop_and_export($DB->get_recordset_sql($sql, $params), 'ucc_courseid', [],
function($carry, $record) use ($helper) {
context_helper::preload_from_record($record);
$framework = new competency_framework(null, competency_framework::extract_record($record, 'f_'));
$competency = new competency(null, competency::extract_record($record, 'c_'));
$ucc = new user_competency_course(null, user_competency_course::extract_record($record, 'ucc_'));
$helper->ingest_framework($framework);
$carry[] = array_merge(static::transform_competency_brief($competency), [
'rating' => [
'userid' => transform::user($ucc->get('userid')),
'rating' => static::transform_competency_grade($competency, $ucc->get('grade'), $helper),
'proficient' => static::transform_proficiency($ucc->get('proficiency')),
'timemodified' => transform::datetime($ucc->get('timemodified')),
]
]);
return $carry;
}, function($courseid, $data) use ($path) {
$context = context_course::instance($courseid);
writer::with_context($context)->export_related_data($path, 'rated_by_me', (object) [
'ratings' => $data
]);
}
);
}
/**
* Export user data in course contexts related to linked competencies.
*
* @param int $userid The user ID.
* @param array $courseids The course IDs.
* @param array $path The root path to export at.
* @return void
*/
protected static function export_user_data_in_course_contexts_associations($userid, $courseids, $path) {
global $DB;
// Fetch all the courses with associations we created or modified.
$compfields = competency::get_sql_fields('c', 'c_');
$ccfields = course_competency::get_sql_fields('cc', 'cc_');
$ctxfields = context_helper::get_preload_record_columns_sql('ctx');
list($insql, $inparams) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
$sql = "
SELECT $compfields, $ccfields, $ctxfields
FROM {" . course_competency::TABLE . "} cc
JOIN {" . competency::TABLE . "} c
ON c.id = cc.competencyid
JOIN {" . competency_framework::TABLE . "} f
ON f.id = c.competencyframeworkid
JOIN {context} ctx
ON ctx.id = f.contextid
WHERE cc.usermodified = :userid
AND cc.courseid $insql
ORDER BY cc.courseid, c.id";
$params = array_merge($inparams, ['userid' => $userid]);
$recordset = $DB->get_recordset_sql($sql, $params);
// Export the data.
static::recordset_loop_and_export($recordset, 'cc_courseid', [], function($carry, $record) {
context_helper::preload_from_record($record);
$competency = new competency(null, competency::extract_record($record, 'c_'));
$cc = new course_competency(null, course_competency::extract_record($record, 'cc_'));
$carry[] = array_merge(static::transform_competency_brief($competency), [
'timemodified' => transform::datetime($cc->get('timemodified')),
'created_or_modified_by_you' => transform::yesno(true)
]);
return $carry;
}, function($courseid, $data) use ($path, $userid, $DB) {
$context = context_course::instance($courseid);
writer::with_context($context)->export_related_data($path, 'associations', (object) ['competencies' => $data]);
});
}
/**
* Export user data in course contexts related to course settings.
*
* @param int $userid The user ID.
* @param array $courseids The course IDs.
* @param array $path The root path to export at.
* @return void
*/
protected static function export_user_data_in_course_contexts_settings($userid, $courseids, $path) {
global $DB;
// Fetch all the courses with associations we created or modified.
$ccsfields = course_competency_settings::get_sql_fields('ccs', 'ccs_');
list($insql, $inparams) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
$sql = "
SELECT $ccsfields
FROM {" . course_competency_settings::TABLE . "} ccs
WHERE ccs.usermodified = :userid
AND ccs.courseid $insql
ORDER BY ccs.courseid";
$params = array_merge($inparams, ['userid' => $userid]);
$recordset = $DB->get_recordset_sql($sql, $params);
// Export the data.
static::recordset_loop_and_export($recordset, 'ccs_courseid', [], function($carry, $record) {
$ccs = new course_competency_settings(null, course_competency_settings::extract_record($record, 'ccs_'));
return [
'timemodified' => transform::datetime($ccs->get('timemodified')),
'created_or_modified_by_you' => transform::yesno(true)
];
}, function($courseid, $data) use ($path, $userid, $DB) {
$context = context_course::instance($courseid);
writer::with_context($context)->export_related_data($path, 'settings', (object) $data);
});
}
/**
* Export the user data in module contexts.
*
* @param int $userid The user whose data we're exporting.
* @param array $contexts A list of contexts.
* @return void
*/
protected static function export_user_data_in_module_contexts($userid, array $contexts) {
global $DB;
$contexts = array_filter($contexts, function($context) {
return $context->contextlevel == CONTEXT_MODULE;
});
if (empty($contexts)) {
return;
}
$path = [get_string('competencies', 'core_competency')];
$cmids = array_map(function($context) {
return $context->instanceid;
}, $contexts);
// Fetch all the modules with associations we created or modified.
$compfields = competency::get_sql_fields('c', 'c_');
$cmcfields = course_module_competency::get_sql_fields('cmc', 'cmc_');
$ctxfields = context_helper::get_preload_record_columns_sql('ctx');
list($insql, $inparams) = $DB->get_in_or_equal($cmids, SQL_PARAMS_NAMED);
$sql = "
SELECT $compfields, $cmcfields, $ctxfields
FROM {" . course_module_competency::TABLE . "} cmc
JOIN {" . competency::TABLE . "} c
ON c.id = cmc.competencyid
JOIN {" . competency_framework::TABLE . "} f
ON f.id = c.competencyframeworkid
JOIN {context} ctx
ON ctx.id = f.contextid
WHERE cmc.usermodified = :userid
AND cmc.cmid $insql
ORDER BY cmc.cmid";
$params = array_merge($inparams, ['userid' => $userid]);
// Export the data.
$recordset = $DB->get_recordset_sql($sql, $params);
static::recordset_loop_and_export($recordset, 'cmc_cmid', [], function($carry, $record) {
context_helper::preload_from_record($record);
$competency = new competency(null, competency::extract_record($record, 'c_'));
$cmc = new course_module_competency(null, course_module_competency::extract_record($record, 'cmc_'));
$carry[] = array_merge(static::transform_competency_brief($competency), [
'timecreated' => transform::datetime($cmc->get('timecreated')),
'timemodified' => transform::datetime($cmc->get('timemodified')),
'created_or_modified_by_you' => transform::yesno(true)
]);
return $carry;
}, function($cmid, $data) use ($path) {
$context = context_module::instance($cmid);
writer::with_context($context)->export_data($path, (object) ['associations' => $data]);
});
}
/**
* Export a user's competencies.
*
* @param context_user $context The context of the user requesting the export.
* @return void
*/
protected static function export_user_data_competencies(context_user $context) {
global $DB;
$userid = $context->instanceid;
$path = [get_string('competencies', 'core_competency'), get_string('competencies', 'core_competency')];
$helper = new performance_helper();
$cfields = competency::get_sql_fields('c', 'c_');
$ucfields = user_competency::get_sql_fields('uc', 'uc_');
$efields = evidence::get_sql_fields('e', 'e_');
$makecomppath = function($competencyid, $data) use ($path) {
return array_merge($path, [$data['name'] . ' (' . $competencyid . ')']);
};
$sql = "
SELECT $cfields, $ucfields, $efields
FROM {" . user_competency::TABLE . "} uc
JOIN {" . competency::TABLE . "} c
ON c.id = uc.competencyid
LEFT JOIN {" . evidence::TABLE . "} e
ON uc.id = e.usercompetencyid
WHERE uc.userid = :userid
ORDER BY c.id, e.timecreated DESC, e.id DESC";
$params = ['userid' => $userid];
$recordset = $DB->get_recordset_sql($sql, $params);
static::recordset_loop_and_export($recordset, 'c_id', null, function($carry, $record)
use ($context, $userid, $helper, $makecomppath) {
$competency = new competency(null, competency::extract_record($record, 'c_'));
if ($carry === null) {
$uc = new user_competency(null, user_competency::extract_record($record, 'uc_'));
$carry = array_merge(static::transform_competency_brief($competency), [
'rating' => static::transform_user_competency($userid, $uc, $competency, $helper),
'evidence' => []
]);
\core_comment\privacy\provider::export_comments($context, 'competency', 'user_competency',
$uc->get('id'), $makecomppath($competency->get('id'), $carry), false);
}
// There is an evidence in this record.
if (!empty($record->e_id)) {
$evidence = new evidence(null, evidence::extract_record($record, 'e_'));
$carry['evidence'][] = static::transform_evidence($userid, $evidence, $competency, $helper);
}