mirrored from git://git.moodle.org/moodle.git
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
/
lib.php
1017 lines (911 loc) · 33.8 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/>.
/**
* Profile field API library file.
*
* @package core_user
* @copyright 2007 onwards Shane Elliot {@link http://pukunui.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Visible to anyone who has the moodle/site:viewuseridentity permission.
* Editable by the profile owner if they have the moodle/user:editownprofile capability
* or any user with the moodle/user:update capability.
*/
define('PROFILE_VISIBLE_TEACHERS', '3');
/**
* Visible to anyone who can view the user.
* Editable by the profile owner if they have the moodle/user:editownprofile capability
* or any user with the moodle/user:update capability.
*/
define('PROFILE_VISIBLE_ALL', '2');
/**
* Visible to the profile owner or anyone with the moodle/user:viewalldetails capability.
* Editable by the profile owner if they have the moodle/user:editownprofile capability
* or any user with moodle/user:viewalldetails and moodle/user:update capabilities.
*/
define('PROFILE_VISIBLE_PRIVATE', '1');
/**
* Only visible to users with the moodle/user:viewalldetails capability.
* Only editable by users with the moodle/user:viewalldetails and moodle/user:update capabilities.
*/
define('PROFILE_VISIBLE_NONE', '0');
/**
* Base class for the customisable profile fields.
*
* @package core_user
* @copyright 2007 onwards Shane Elliot {@link http://pukunui.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class profile_field_base {
// These 2 variables are really what we're interested in.
// Everything else can be extracted from them.
/** @var int */
public $fieldid;
/** @var int */
public $userid;
/** @var stdClass */
public $field;
/** @var string */
public $inputname;
/** @var mixed */
public $data;
/** @var string */
public $dataformat;
/** @var string name of the user profile category */
protected $categoryname;
/**
* Constructor method.
* @param int $fieldid id of the profile from the user_info_field table
* @param int $userid id of the user for whom we are displaying data
* @param stdClass $fielddata optional data for the field object plus additional fields 'hasuserdata', 'data' and 'dataformat'
* with user data. (If $fielddata->hasuserdata is empty, user data is not available and we should use default data).
* If this parameter is passed, constructor will not call load_data() at all.
*/
public function __construct($fieldid=0, $userid=0, $fielddata=null) {
global $CFG;
if ($CFG->debugdeveloper) {
// In Moodle 3.4 the new argument $fielddata was added to the constructor. Make sure that
// plugin constructor properly passes this argument.
$backtrace = debug_backtrace();
if (isset($backtrace[1]['class']) && $backtrace[1]['function'] === '__construct' &&
in_array(self::class, class_parents($backtrace[1]['class']))) {
// If this constructor is called from the constructor of the plugin make sure that the third argument was passed through.
if (count($backtrace[1]['args']) >= 3 && count($backtrace[0]['args']) < 3) {
debugging($backtrace[1]['class'].'::__construct() must support $fielddata as the third argument ' .
'and pass it to the parent constructor', DEBUG_DEVELOPER);
}
}
}
$this->set_fieldid($fieldid);
$this->set_userid($userid);
if ($fielddata) {
$this->set_field($fielddata);
if ($userid > 0 && !empty($fielddata->hasuserdata)) {
$this->set_user_data($fielddata->data, $fielddata->dataformat);
}
} else {
$this->load_data();
}
}
/**
* Old syntax of class constructor. Deprecated in PHP7.
*
* @deprecated since Moodle 3.1
*/
public function profile_field_base($fieldid=0, $userid=0) {
debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
self::__construct($fieldid, $userid);
}
/**
* Abstract method: Adds the profile field to the moodle form class
* @abstract The following methods must be overwritten by child classes
* @param MoodleQuickForm $mform instance of the moodleform class
*/
public function edit_field_add($mform) {
throw new \moodle_exception('mustbeoveride', 'debug', '', 'edit_field_add');
}
/**
* Display the data for this field
* @return string
*/
public function display_data() {
$options = new stdClass();
$options->para = false;
return format_text($this->data, FORMAT_MOODLE, $options);
}
/**
* Display the name of the profile field.
*
* @param bool $escape
* @return string
*/
public function display_name(bool $escape = true): string {
return format_string($this->field->name, true, [
'context' => context_system::instance(),
'escape' => $escape,
]);
}
/**
* Print out the form field in the edit profile page
* @param MoodleQuickForm $mform instance of the moodleform class
* @return bool
*/
public function edit_field($mform) {
if (!$this->is_editable()) {
return false;
}
$this->edit_field_add($mform);
$this->edit_field_set_default($mform);
$this->edit_field_set_required($mform);
return true;
}
/**
* Tweaks the edit form
* @param MoodleQuickForm $mform instance of the moodleform class
* @return bool
*/
public function edit_after_data($mform) {
if (!$this->is_editable()) {
return false;
}
$this->edit_field_set_locked($mform);
return true;
}
/**
* Saves the data coming from form
* @param stdClass $usernew data coming from the form
*/
public function edit_save_data($usernew) {
global $DB;
if (!isset($usernew->{$this->inputname})) {
// Field not present in form, probably locked and invisible - skip it.
return;
}
$data = new stdClass();
$usernew->{$this->inputname} = $this->edit_save_data_preprocess($usernew->{$this->inputname}, $data);
if (!isset($usernew->{$this->inputname})) {
// Field cannot be set to null, set the default value.
$usernew->{$this->inputname} = $this->field->defaultdata;
}
$data->userid = $usernew->id;
$data->fieldid = $this->field->id;
$data->data = $usernew->{$this->inputname};
if ($dataid = $DB->get_field('user_info_data', 'id', array('userid' => $data->userid, 'fieldid' => $data->fieldid))) {
$data->id = $dataid;
$DB->update_record('user_info_data', $data);
} else {
$DB->insert_record('user_info_data', $data);
}
}
/**
* Validate the form field from profile page
*
* @param stdClass $usernew
* @return array error messages for the form validation
*/
public function edit_validate_field($usernew) {
global $DB;
$errors = array();
// Get input value.
if (isset($usernew->{$this->inputname})) {
if (is_array($usernew->{$this->inputname}) && isset($usernew->{$this->inputname}['text'])) {
$value = $usernew->{$this->inputname}['text'];
} else {
$value = $usernew->{$this->inputname};
}
} else {
$value = '';
}
// Check for uniqueness of data if required.
if ($this->is_unique() && (($value !== '') || $this->is_required())) {
$data = $DB->get_records_sql('
SELECT id, userid
FROM {user_info_data}
WHERE fieldid = ?
AND ' . $DB->sql_compare_text('data', 255) . ' = ' . $DB->sql_compare_text('?', 255),
array($this->field->id, $value));
if ($data) {
$existing = false;
foreach ($data as $v) {
if ($v->userid == $usernew->id) {
$existing = true;
break;
}
}
if (!$existing) {
$errors[$this->inputname] = get_string('valuealreadyused');
}
}
}
return $errors;
}
/**
* Sets the default data for the field in the form object
* @param MoodleQuickForm $mform instance of the moodleform class
*/
public function edit_field_set_default($mform) {
if (isset($this->field->defaultdata)) {
$mform->setDefault($this->inputname, $this->field->defaultdata);
}
}
/**
* Sets the required flag for the field in the form object
*
* @param MoodleQuickForm $mform instance of the moodleform class
*/
public function edit_field_set_required($mform) {
global $USER;
if ($this->is_required() && ($this->userid == $USER->id || isguestuser())) {
$mform->addRule($this->inputname, get_string('required'), 'required', null, 'client');
}
}
/**
* HardFreeze the field if locked.
* @param MoodleQuickForm $mform instance of the moodleform class
*/
public function edit_field_set_locked($mform) {
if (!$mform->elementExists($this->inputname)) {
return;
}
if ($this->is_locked() and !has_capability('moodle/user:update', context_system::instance())) {
$mform->hardFreeze($this->inputname);
$mform->setConstant($this->inputname, $this->data);
}
}
/**
* Hook for child classess to process the data before it gets saved in database
* @param stdClass $data
* @param stdClass $datarecord The object that will be used to save the record
* @return mixed
*/
public function edit_save_data_preprocess($data, $datarecord) {
return $data;
}
/**
* Loads a user object with data for this field ready for the edit profile
* form
* @param stdClass $user a user object
*/
public function edit_load_user_data($user) {
if ($this->data !== null) {
$user->{$this->inputname} = $this->data;
}
}
/**
* Check if the field data should be loaded into the user object
* By default it is, but for field types where the data may be potentially
* large, the child class should override this and return false
* @return bool
*/
public function is_user_object_data() {
return true;
}
/**
* Accessor method: set the userid for this instance
* @internal This method should not generally be overwritten by child classes.
* @param integer $userid id from the user table
*/
public function set_userid($userid) {
$this->userid = $userid;
}
/**
* Accessor method: set the fieldid for this instance
* @internal This method should not generally be overwritten by child classes.
* @param integer $fieldid id from the user_info_field table
*/
public function set_fieldid($fieldid) {
$this->fieldid = $fieldid;
}
/**
* Sets the field object and default data and format into $this->data and $this->dataformat
*
* This method should be called before {@link self::set_user_data}
*
* @param stdClass $field
* @throws coding_exception
*/
public function set_field($field) {
global $CFG;
if ($CFG->debugdeveloper) {
$properties = ['id', 'shortname', 'name', 'datatype', 'description', 'descriptionformat', 'categoryid', 'sortorder',
'required', 'locked', 'visible', 'forceunique', 'signup', 'defaultdata', 'defaultdataformat', 'param1', 'param2',
'param3', 'param4', 'param5'];
foreach ($properties as $property) {
if (!property_exists($field, $property)) {
debugging('The \'' . $property . '\' property must be set.', DEBUG_DEVELOPER);
}
}
}
if ($this->fieldid && $this->fieldid != $field->id) {
throw new coding_exception('Can not set field object after a different field id was set');
}
$this->fieldid = $field->id;
$this->field = $field;
$this->inputname = 'profile_field_' . $this->field->shortname;
$this->data = $this->field->defaultdata;
$this->dataformat = FORMAT_HTML;
}
/**
* Sets user id and user data for the field
*
* @param mixed $data
* @param int $dataformat
*/
public function set_user_data($data, $dataformat) {
$this->data = $data;
$this->dataformat = $dataformat;
}
/**
* Set the name for the profile category where this field is
*
* @param string $categoryname
*/
public function set_category_name($categoryname) {
$this->categoryname = $categoryname;
}
/**
* Return field short name
*
* @return string
*/
public function get_shortname(): string {
return $this->field->shortname;
}
/**
* Returns the name of the profile category where this field is
*
* @return string
*/
public function get_category_name() {
global $DB;
if ($this->categoryname === null) {
$this->categoryname = $DB->get_field('user_info_category', 'name', ['id' => $this->field->categoryid]);
}
return $this->categoryname;
}
/**
* Accessor method: Load the field record and user data associated with the
* object's fieldid and userid
*
* @internal This method should not generally be overwritten by child classes.
*/
public function load_data() {
global $DB;
// Load the field object.
if (($this->fieldid == 0) or (!($field = $DB->get_record('user_info_field', array('id' => $this->fieldid))))) {
$this->field = null;
$this->inputname = '';
} else {
$this->set_field($field);
}
if (!empty($this->field) && $this->userid > 0) {
$params = array('userid' => $this->userid, 'fieldid' => $this->fieldid);
if ($data = $DB->get_record('user_info_data', $params, 'data, dataformat')) {
$this->set_user_data($data->data, $data->dataformat);
}
} else {
$this->data = null;
}
}
/**
* Check if the field data is visible to the current user
* @internal This method should not generally be overwritten by child classes.
*
* @param context|null $context
* @return bool
*/
public function is_visible(?context $context = null): bool {
global $USER, $COURSE;
if ($context === null) {
$context = ($this->userid > 0) ? context_user::instance($this->userid) : context_system::instance();
}
switch ($this->field->visible) {
case PROFILE_VISIBLE_TEACHERS:
if ($this->is_signup_field() && (empty($this->userid) || isguestuser($this->userid))) {
return true;
} else if ($this->userid == $USER->id) {
return true;
} else if ($this->userid > 0) {
return has_capability('moodle/user:viewalldetails', $context);
} else {
$coursecontext = context_course::instance($COURSE->id);
return has_capability('moodle/site:viewuseridentity', $coursecontext);
}
case PROFILE_VISIBLE_ALL:
return true;
case PROFILE_VISIBLE_PRIVATE:
if ($this->is_signup_field() && (empty($this->userid) || isguestuser($this->userid))) {
return true;
} else if ($this->userid == $USER->id) {
return true;
} else {
return has_capability('moodle/user:viewalldetails', $context);
}
default:
// PROFILE_VISIBLE_NONE, so let's check capabilities at system level.
if ($this->userid > 0) {
$context = context_system::instance();
}
return has_capability('moodle/user:viewalldetails', $context);
}
}
/**
* Check if the field data is editable for the current user
* This method should not generally be overwritten by child classes.
* @return bool
*/
public function is_editable() {
global $USER;
if (!$this->is_visible()) {
return false;
}
if ($this->is_signup_field() && (empty($this->userid) || isguestuser($this->userid))) {
// Allow editing the field on the signup page.
return true;
}
$systemcontext = context_system::instance();
if ($this->userid == $USER->id && has_capability('moodle/user:editownprofile', $systemcontext)) {
return true;
}
if (has_capability('moodle/user:update', $systemcontext)) {
return true;
}
// Checking for mentors have capability to edit user's profile.
if ($this->userid > 0) {
$usercontext = context_user::instance($this->userid);
if ($this->userid != $USER->id && has_capability('moodle/user:editprofile', $usercontext, $USER->id)) {
return true;
}
}
return false;
}
/**
* Check if the field data is considered empty
* @internal This method should not generally be overwritten by child classes.
* @return boolean
*/
public function is_empty() {
return ( ($this->data != '0') and empty($this->data));
}
/**
* Check if the field is required on the edit profile page
* @internal This method should not generally be overwritten by child classes.
* @return bool
*/
public function is_required() {
return (boolean)$this->field->required;
}
/**
* Check if the field is locked on the edit profile page
* @internal This method should not generally be overwritten by child classes.
* @return bool
*/
public function is_locked() {
return (boolean)$this->field->locked;
}
/**
* Check if the field data should be unique
* @internal This method should not generally be overwritten by child classes.
* @return bool
*/
public function is_unique() {
return (boolean)$this->field->forceunique;
}
/**
* Check if the field should appear on the signup page
* @internal This method should not generally be overwritten by child classes.
* @return bool
*/
public function is_signup_field() {
return (boolean)$this->field->signup;
}
/**
* Return the field settings suitable to be exported via an external function.
* By default it return all the field settings.
*
* @return array all the settings
* @since Moodle 3.2
*/
public function get_field_config_for_external() {
return (array) $this->field;
}
/**
* Return the field type and null properties.
* This will be used for validating the data submitted by a user.
*
* @return array the param type and null property
* @since Moodle 3.2
*/
public function get_field_properties() {
return array(PARAM_RAW, NULL_NOT_ALLOWED);
}
/**
* Whether to display the field and content to the user
*
* @param context|null $context
* @return bool
*/
public function show_field_content(?context $context = null): bool {
return $this->is_visible($context) && !$this->is_empty();
}
/**
* Check if the field should convert the raw data into user-friendly data when exporting
*
* @return bool
*/
public function is_transform_supported(): bool {
return false;
}
}
/**
* Return profile field instance for given type
*
* @param string $type
* @param int $fieldid
* @param int $userid
* @param stdClass|null $fielddata
* @return profile_field_base
*/
function profile_get_user_field(string $type, int $fieldid = 0, int $userid = 0, ?stdClass $fielddata = null): profile_field_base {
global $CFG;
require_once("{$CFG->dirroot}/user/profile/field/{$type}/field.class.php");
// Return instance of profile field type.
$profilefieldtype = "profile_field_{$type}";
return new $profilefieldtype($fieldid, $userid, $fielddata);
}
/**
* Returns an array of all custom field records with any defined data (or empty data), for the specified user id.
* @param int $userid
* @return profile_field_base[]
*/
function profile_get_user_fields_with_data(int $userid): array {
global $DB;
// Join any user info data present with each user info field for the user object.
$sql = 'SELECT uif.*, uic.name AS categoryname ';
if ($userid > 0) {
$sql .= ', uind.id AS hasuserdata, uind.data, uind.dataformat ';
}
$sql .= 'FROM {user_info_field} uif ';
$sql .= 'LEFT JOIN {user_info_category} uic ON uif.categoryid = uic.id ';
if ($userid > 0) {
$sql .= 'LEFT JOIN {user_info_data} uind ON uif.id = uind.fieldid AND uind.userid = :userid ';
}
$sql .= 'ORDER BY uic.sortorder ASC, uif.sortorder ASC ';
$fields = $DB->get_records_sql($sql, ['userid' => $userid]);
$data = [];
foreach ($fields as $field) {
$field->hasuserdata = !empty($field->hasuserdata);
$fieldobject = profile_get_user_field($field->datatype, $field->id, $userid, $field);
$fieldobject->set_category_name($field->categoryname);
unset($field->categoryname);
$data[] = $fieldobject;
}
return $data;
}
/**
* Returns an array of all custom field records with any defined data (or empty data), for the specified user id, by category.
* @param int $userid
* @return profile_field_base[][]
*/
function profile_get_user_fields_with_data_by_category(int $userid): array {
$fields = profile_get_user_fields_with_data($userid);
$data = [];
foreach ($fields as $field) {
$data[$field->field->categoryid][] = $field;
}
return $data;
}
/**
* Loads user profile field data into the user object.
* @param stdClass $user
*/
function profile_load_data(stdClass $user): void {
$fields = profile_get_user_fields_with_data($user->id);
foreach ($fields as $formfield) {
$formfield->edit_load_user_data($user);
}
}
/**
* Print out the customisable categories and fields for a users profile
*
* @param MoodleQuickForm $mform instance of the moodleform class
* @param int $userid id of user whose profile is being edited or 0 for the new user
*/
function profile_definition(MoodleQuickForm $mform, int $userid = 0): void {
$categories = profile_get_user_fields_with_data_by_category($userid);
foreach ($categories as $categoryid => $fields) {
// Check first if *any* fields will be displayed.
$fieldstodisplay = [];
foreach ($fields as $formfield) {
if ($formfield->is_editable()) {
$fieldstodisplay[] = $formfield;
}
}
if (empty($fieldstodisplay)) {
continue;
}
// Display the header and the fields.
$mform->addElement('header', 'category_'.$categoryid, format_string($fields[0]->get_category_name()));
foreach ($fieldstodisplay as $formfield) {
$formfield->edit_field($mform);
}
}
}
/**
* Adds profile fields to user edit forms.
* @param MoodleQuickForm $mform
* @param int $userid
*/
function profile_definition_after_data(MoodleQuickForm $mform, int $userid): void {
$userid = ($userid < 0) ? 0 : (int)$userid;
$fields = profile_get_user_fields_with_data($userid);
foreach ($fields as $formfield) {
$formfield->edit_after_data($mform);
}
}
/**
* Validates profile data.
* @param stdClass $usernew
* @param array $files
* @return array array of errors, same as in {@see moodleform::validation()}
*/
function profile_validation(stdClass $usernew, array $files): array {
$err = array();
$fields = profile_get_user_fields_with_data($usernew->id);
foreach ($fields as $formfield) {
$err += $formfield->edit_validate_field($usernew, $files);
}
return $err;
}
/**
* Saves profile data for a user.
* @param stdClass $usernew
*/
function profile_save_data(stdClass $usernew): void {
global $CFG;
$fields = profile_get_user_fields_with_data($usernew->id);
foreach ($fields as $formfield) {
$formfield->edit_save_data($usernew);
}
}
/**
* Retrieves a list of profile fields that must be displayed in the sign-up form.
*
* @return array list of profile fields info
* @since Moodle 3.2
*/
function profile_get_signup_fields(): array {
$profilefields = array();
$fieldobjects = profile_get_user_fields_with_data(0);
foreach ($fieldobjects as $fieldobject) {
$field = (object)$fieldobject->get_field_config_for_external();
if ($fieldobject->get_category_name() !== null && $fieldobject->is_signup_field() && $field->visible <> 0) {
$profilefields[] = (object) array(
'categoryid' => $field->categoryid,
'categoryname' => $fieldobject->get_category_name(),
'fieldid' => $field->id,
'datatype' => $field->datatype,
'object' => $fieldobject
);
}
}
return $profilefields;
}
/**
* Adds code snippet to a moodle form object for custom profile fields that
* should appear on the signup page
* @param MoodleQuickForm $mform moodle form object
*/
function profile_signup_fields(MoodleQuickForm $mform): void {
if ($fields = profile_get_signup_fields()) {
foreach ($fields as $field) {
// Check if we change the categories.
if (!isset($currentcat) || $currentcat != $field->categoryid) {
$currentcat = $field->categoryid;
$mform->addElement('header', 'category_'.$field->categoryid, format_string($field->categoryname));
};
$field->object->edit_field($mform);
}
}
}
/**
* Returns an object with the custom profile fields set for the given user
* @param int $userid
* @param bool $onlyinuserobject True if you only want the ones in $USER.
* @return stdClass object where properties names are shortnames of custom profile fields
*/
function profile_user_record(int $userid, bool $onlyinuserobject = true): stdClass {
$usercustomfields = new stdClass();
$fields = profile_get_user_fields_with_data($userid);
foreach ($fields as $formfield) {
if (!$onlyinuserobject || $formfield->is_user_object_data()) {
$usercustomfields->{$formfield->field->shortname} = $formfield->data;
}
}
return $usercustomfields;
}
/**
* Obtains a list of all available custom profile fields, indexed by id.
*
* Some profile fields are not included in the user object data (see
* profile_user_record function above). Optionally, you can obtain only those
* fields that are included in the user object.
*
* To be clear, this function returns the available fields, and does not
* return the field values for a particular user.
*
* @param bool $onlyinuserobject True if you only want the ones in $USER
* @return array Array of field objects from database (indexed by id)
* @since Moodle 2.7.1
*/
function profile_get_custom_fields(bool $onlyinuserobject = false): array {
$fieldobjects = profile_get_user_fields_with_data(0);
$fields = [];
foreach ($fieldobjects as $fieldobject) {
if (!$onlyinuserobject || $fieldobject->is_user_object_data()) {
$fields[$fieldobject->fieldid] = (object)$fieldobject->get_field_config_for_external();
}
}
ksort($fields);
return $fields;
}
/**
* Load custom profile fields into user object
*
* @param stdClass $user user object
*/
function profile_load_custom_fields($user) {
$user->profile = (array)profile_user_record($user->id);
}
/**
* Save custom profile fields for a user.
*
* @param int $userid The user id
* @param array $profilefields The fields to save
*/
function profile_save_custom_fields($userid, $profilefields) {
global $DB;
$fields = profile_get_user_fields_with_data(0);
if ($fields) {
foreach ($fields as $fieldobject) {
$field = (object)$fieldobject->get_field_config_for_external();
if (isset($profilefields[$field->shortname])) {
$conditions = array('fieldid' => $field->id, 'userid' => $userid);
$id = $DB->get_field('user_info_data', 'id', $conditions);
$data = $profilefields[$field->shortname];
if ($id) {
$DB->set_field('user_info_data', 'data', $data, array('id' => $id));
} else {
$record = array('fieldid' => $field->id, 'userid' => $userid, 'data' => $data);
$DB->insert_record('user_info_data', $record);
}
}
}
}
}
/**
* Gets basic data about custom profile fields. This is minimal data that is cached within the
* current request for all fields so that it can be used quickly.
*
* @param string $shortname Shortname of custom profile field
* @param bool $casesensitive Whether to perform case-sensitive matching of shortname. Note current limitations of custom profile
* fields allow the same shortname to exist differing only by it's case
* @return stdClass|null Object with properties id, shortname, name, visible, datatype, categoryid, etc
*/
function profile_get_custom_field_data_by_shortname(string $shortname, bool $casesensitive = true): ?stdClass {
$cache = \cache::make_from_params(cache_store::MODE_REQUEST, 'core_profile', 'customfields',
[], ['simplekeys' => true, 'simpledata' => true]);
$data = $cache->get($shortname);
if ($data === false) {
// If we don't have data, we get and cache it for all fields to avoid multiple DB requests.
$fields = profile_get_custom_fields();
$data = null;
foreach ($fields as $field) {
$cache->set($field->shortname, $field);
// Perform comparison according to case sensitivity parameter.
$shortnamematch = $casesensitive
? strcmp($field->shortname, $shortname) === 0
: strcasecmp($field->shortname, $shortname) === 0;
if ($shortnamematch) {
$data = $field;
}
}
}
return $data;
}
/**
* Trigger a user profile viewed event.
*
* @param stdClass $user user object
* @param stdClass $context context object (course or user)
* @param stdClass $course course object
* @since Moodle 2.9
*/
function profile_view($user, $context, $course = null) {
$eventdata = array(
'objectid' => $user->id,
'relateduserid' => $user->id,
'context' => $context
);
if (!empty($course)) {
$eventdata['courseid'] = $course->id;
$eventdata['other'] = array(
'courseid' => $course->id,
'courseshortname' => $course->shortname,
'coursefullname' => $course->fullname
);
}
$event = \core\event\user_profile_viewed::create($eventdata);
$event->add_record_snapshot('user', $user);
$event->trigger();
}
/**
* Does the user have all required custom fields set?
*
* Internal, to be exclusively used by {@link user_not_fully_set_up()} only.
*
* Note that if users have no way to fill a required field via editing their
* profiles (e.g. the field is not visible or it is locked), we still return true.
* So this is actually checking if we should redirect the user to edit their
* profile, rather than whether there is a value in the database.
*
* @param int $userid
* @return bool
*/
function profile_has_required_custom_fields_set($userid) {
$profilefields = profile_get_user_fields_with_data($userid);
foreach ($profilefields as $profilefield) {
if ($profilefield->is_required() && !$profilefield->is_locked() &&
$profilefield->is_empty() && $profilefield->get_field_config_for_external()['visible']) {
return false;
}
}
return true;
}
/**
* Return the list of valid custom profile user fields.
*
* @return array array of profile field names
*/
function get_profile_field_names(): array {
$profilefields = profile_get_user_fields_with_data(0);
$profilefieldnames = [];
foreach ($profilefields as $field) {
$profilefieldnames[] = $field->inputname;
}
return $profilefieldnames;
}
/**
* Return the list of profile fields
* in a format they can be used for choices in a group select menu.