-
-
Notifications
You must be signed in to change notification settings - Fork 812
/
UFGroup.php
3614 lines (3306 loc) · 119 KB
/
UFGroup.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
/*
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC. All rights reserved. |
| |
| This work is published under the GNU AGPLv3 license with some |
| permitted exceptions and without any warranty. For full license |
| and copyright information, see https://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC https://civicrm.org/licensing
*/
/**
* UF group BAO class.
*/
class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup {
const PUBLIC_VISIBILITY = 1,
ADMIN_VISIBILITY = 2,
LISTINGS_VISIBILITY = 4;
/**
* Cache the match clause used in this transaction.
*
* @var string
*/
public static $_matchFields = NULL;
/**
* Fetch object based on array of properties.
*
* @param array $params
* (reference) an assoc array of name/value pairs.
* @param array $defaults
* (reference) an assoc array to hold the flattened values.
*
* @return object
* CRM_Core_DAO_UFGroup object
*/
public static function retrieve(&$params, &$defaults) {
return CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_UFGroup', $params, $defaults);
}
/**
* Retrieve the first non-generic contact type
*
* @param int $id
* Id of uf_group.
*
* @return string
* contact type
*/
public static function getContactType($id) {
$validTypes = array_filter(array_keys(CRM_Core_SelectValues::contactType()));
$validSubTypes = CRM_Contact_BAO_ContactType::subTypeInfo();
$typesParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $id, 'group_type'));
$types = explode(',', $typesParts[0]);
$cType = NULL;
foreach ($types as $type) {
if (in_array($type, $validTypes)) {
$cType = $type;
}
elseif (array_key_exists($type, $validSubTypes)) {
$cType = $validSubTypes[$type]['parent'] ?? NULL;
}
if ($cType) {
break;
}
}
return $cType;
}
/**
* Get the form title.
*
* @param int $id
* Id of uf_form.
*
* @return string
* title
*
*/
public static function getTitle($id) {
return CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $id, 'title');
}
/**
* Update the is_active flag in the db.
*
* @param int $id
* Id of the database record.
* @param bool $is_active
* Value we want to set the is_active field.
*
* @return bool
* true if we found and updated the object, else false
*/
public static function setIsActive($id, $is_active) {
return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_UFGroup', $id, 'is_active', $is_active);
}
/**
* Get all the registration fields.
*
* @param int $action
* What action are we doing.
* @param int $mode
* Mode.
*
* @param string $ctype
*
* @return array
* the fields that are needed for registration
*
* @throws \Exception
*/
public static function getRegistrationFields($action, $mode, $ctype = NULL) {
if ($mode & CRM_Profile_Form::MODE_REGISTER) {
$ufGroups = CRM_Core_BAO_UFGroup::getModuleUFGroup('User Registration');
}
else {
$ufGroups = CRM_Core_BAO_UFGroup::getModuleUFGroup('Profile');
}
if (!is_array($ufGroups)) {
return FALSE;
}
$fields = [];
foreach ($ufGroups as $id => $title) {
if ($ctype) {
$fieldType = CRM_Core_BAO_UFField::getProfileType($id);
if (($fieldType != 'Contact') &&
($fieldType != $ctype) &&
!CRM_Contact_BAO_ContactType::isExtendsContactType($fieldType, $ctype)
) {
continue;
}
if (CRM_Contact_BAO_ContactType::isaSubType($fieldType)) {
$profileSubType = $fieldType;
}
}
$subset = self::getFields($id, TRUE, $action,
NULL, NULL, FALSE, NULL, TRUE, $ctype
);
// we do not allow duplicates. the first field is the winner
foreach ($subset as $name => $field) {
if (empty($fields[$name])) {
$fields[$name] = $field;
}
}
}
return $fields;
}
/**
* Get all the listing fields.
*
* @param int $action
* What action are we doing.
* @param int $visibility
* Visibility of fields we are interested in.
* @param bool $considerSelector
* Whether to consider the in_selector parameter.
* @param array $ufGroupIds
* @param bool $searchable
*
* @param null $restrict
* @param bool $skipPermission
* @param int $permissionType
*
* @return array
* the fields that are listings related
*
* @throws \Exception
*/
public static function getListingFields(
$action,
$visibility,
$considerSelector = FALSE,
$ufGroupIds = NULL,
$searchable = NULL,
$restrict = NULL,
$skipPermission = FALSE,
$permissionType = CRM_Core_Permission::SEARCH
) {
if ($ufGroupIds) {
$subset = self::getFields($ufGroupIds, FALSE, $action,
$visibility, $searchable,
FALSE, $restrict,
$skipPermission,
NULL,
$permissionType
);
if ($considerSelector) {
// drop the fields not meant for the selector
foreach ($subset as $name => $field) {
if (!$field['in_selector']) {
unset($subset[$name]);
}
}
}
$fields = $subset;
}
else {
$ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id');
$fields = [];
foreach ($ufGroups as $id => $title) {
$subset = self::getFields($id, FALSE, $action,
$visibility, $searchable,
FALSE, $restrict,
$skipPermission,
NULL,
$permissionType
);
if ($considerSelector) {
// drop the fields not meant for the selector
foreach ($subset as $name => $field) {
if (!$field['in_selector']) {
unset($subset[$name]);
}
}
}
$fields = array_merge($fields, $subset);
}
}
return $fields;
}
/**
* Get all the fields that belong to the group with the name title,
* and format for use with buildProfile. This is the SQL analog of
* formatUFFields().
*
* @param mix $id
* The id of the UF group or ids of ufgroup.
* @param bool|int $register are we interested in registration fields
* @param int $action
* What action are we doing.
* @param int $visibility
* Visibility of fields we are interested in.
* @param $searchable
* @param bool $showAll
* @param string $restrict
* Should we restrict based on a specified profile type.
* @param bool $skipPermission
* @param null $ctype
* @param int $permissionType
* @param string $orderBy
* @param null $orderProfiles
*
* @param bool $eventProfile
*
* @return array
* The fields that belong to this ufgroup(s)
*
* @throws \CRM_Core_Exception
*/
public static function getFields(
$id,
$register = FALSE,
$action = NULL,
$visibility = NULL,
$searchable = NULL,
$showAll = FALSE,
$restrict = NULL,
$skipPermission = FALSE,
$ctype = NULL,
$permissionType = CRM_Core_Permission::CREATE,
$orderBy = 'field_name',
$orderProfiles = NULL,
$eventProfile = FALSE
) {
if (!is_array($id)) {
$id = CRM_Utils_Type::escape($id, 'Positive');
$profileIds = [$id];
}
else {
$profileIds = $id;
}
$gids = implode(',', $profileIds);
$params = [];
if ($restrict) {
$query = "SELECT g.* from civicrm_uf_group g
LEFT JOIN civicrm_uf_join j ON (j.uf_group_id = g.id)
WHERE g.id IN ( {$gids} )
AND ((j.uf_group_id IN ( {$gids} ) AND j.module = %1) OR g.is_reserved = 1 )
";
$params = [1 => [$restrict, 'String']];
}
else {
$query = "SELECT g.* from civicrm_uf_group g WHERE g.id IN ( {$gids} ) ";
}
if (!$showAll) {
$query .= " AND g.is_active = 1";
}
$checkPermission = [
[
'administer CiviCRM',
'manage event profiles',
],
];
if ($eventProfile && CRM_Core_Permission::check($checkPermission)) {
$skipPermission = TRUE;
}
// add permissioning for profiles only if not registration
if (!$skipPermission) {
$permissionClause = CRM_Core_Permission::ufGroupClause($permissionType, 'g.');
$query .= " AND $permissionClause ";
}
if ($orderProfiles and count($profileIds) > 1) {
$query .= " ORDER BY FIELD( g.id, {$gids} )";
}
$group = CRM_Core_DAO::executeQuery($query, $params);
$fields = [];
$validGroup = FALSE;
while ($group->fetch()) {
$validGroup = TRUE;
$query = self::createUFFieldQuery($group->id, $searchable, $showAll, $visibility, $orderBy);
$field = CRM_Core_DAO::executeQuery($query);
$importableFields = self::getProfileFieldMetadata($showAll);
list($customFields, $addressCustomFields) = self::getCustomFields($ctype);
while ($field->fetch()) {
list($name, $formattedField) = self::formatUFField($group, $field, $customFields, $addressCustomFields, $importableFields, $permissionType);
if ($formattedField !== NULL) {
$fields[$name] = $formattedField;
}
}
}
if (empty($fields) && !$validGroup) {
throw new CRM_Core_Exception(ts('The requested Profile (gid=%1) is disabled OR it is not configured to be used for \'Profile\' listings in its Settings OR there is no Profile with that ID OR you do not have permission to access this profile. Please contact the site administrator if you need assistance.',
[1 => implode(',', $profileIds)]
));
}
else {
self::reformatProfileFields($fields);
}
return $fields;
}
/**
* Format a list of UFFields for use with buildProfile. This is the in-memory analog
* of getFields().
*
* @param array $groupArr
* (mimic CRM_UF_DAO_UFGroup).
* @param array $fieldArrs
* List of fields (each mimics CRM_UF_DAO_UFField).
* @param bool $visibility
* Visibility of fields we are interested in.
* @param bool $searchable
* @param bool $showAll
* @param null $ctype
* @param int $permissionType
*
* @return array
* @see self::getFields
*/
public static function formatUFFields(
$groupArr,
$fieldArrs,
$visibility = NULL,
$searchable = NULL,
$showAll = FALSE,
$ctype = NULL,
$permissionType = CRM_Core_Permission::CREATE
) {
// $group = new CRM_Core_DAO_UFGroup();
// $group->copyValues($groupArr); // no... converts string('') to string('null')
$group = (object) $groupArr;
// Refactoring note: The $fieldArrs here may be slightly different than the $ufFields
// used by calculateGroupType, but I don't think the missing fields matter, and -- if
// they did -- the obvious fix would produce mutual recursion.
$ufGroupType = self::_calculateGroupType($fieldArrs);
$profileType = CRM_Core_BAO_UFField::calculateProfileType(implode(',', $ufGroupType));
$contactActivityProfile = CRM_Core_BAO_UFField::checkContactActivityProfileTypeByGroupType(implode(',', $ufGroupType));
$importableFields = self::getImportableFields($showAll, $profileType, $contactActivityProfile);
list($customFields, $addressCustomFields) = self::getCustomFields($ctype);
$formattedFields = [];
foreach ($fieldArrs as $fieldArr) {
$field = (object) $fieldArr;
if (!self::filterUFField($field, $searchable, $showAll, $visibility)) {
continue;
}
list($name, $formattedField) = self::formatUFField($group, $field, $customFields, $addressCustomFields, $importableFields, $permissionType);
if ($formattedField !== NULL) {
$formattedFields[$name] = $formattedField;
}
}
return $formattedFields;
}
/**
* Prepare a field for rendering with CRM_Core_BAO_UFGroup::buildProfile.
*
* @param CRM_Core_DAO_UFGroup|CRM_Core_DAO $group
* @param CRM_Core_DAO_UFField|CRM_Core_DAO $field
* @param array $customFields
* @param array $addressCustomFields
* @param array $importableFields
* @param int $permissionType
* Eg CRM_Core_Permission::CREATE.
*
* @return array
*/
protected static function formatUFField(
$group,
$field,
$customFields,
$addressCustomFields,
$importableFields,
$permissionType = CRM_Core_Permission::CREATE
) {
$name = $field->field_name;
$title = $field->label;
$addressCustom = FALSE;
if (in_array($permissionType, [CRM_Core_Permission::CREATE, CRM_Core_Permission::EDIT]) &&
in_array($field->field_name, array_keys($addressCustomFields))
) {
$addressCustom = TRUE;
$name = "address_{$name}";
}
if ($field->field_name == 'url') {
$name .= "-{$field->website_type_id}";
}
elseif (!empty($field->location_type_id)) {
$name .= "-{$field->location_type_id}";
}
else {
$locationFields = self::getLocationFields();
if (in_array($field->field_name, $locationFields) || $addressCustom) {
$name .= '-Primary';
}
}
if (isset($field->phone_type_id)) {
$name .= "-{$field->phone_type_id}";
}
$fieldMetaData = CRM_Utils_Array::value($name, $importableFields, ($importableFields[$field->field_name] ?? []));
// No lie: this is bizarre; why do we need to mix so many UFGroup properties into UFFields?
// I guess to make field self sufficient with all the required data and avoid additional calls
$formattedField = [
'name' => $name,
'groupTitle' => $group->title,
'groupName' => $group->name,
'groupDisplayTitle' => (!empty($group->frontend_title)) ? $group->frontend_title : $group->title,
'groupHelpPre' => empty($group->help_pre) ? '' : $group->help_pre,
'groupHelpPost' => empty($group->help_post) ? '' : $group->help_post,
'title' => $title,
'where' => CRM_Utils_Array::value('where', CRM_Utils_Array::value($field->field_name, $importableFields)),
'attributes' => CRM_Core_DAO::makeAttribute(CRM_Utils_Array::value($field->field_name, $importableFields)),
'is_required' => $field->is_required,
'is_view' => $field->is_view,
'help_pre' => $field->help_pre,
'help_post' => $field->help_post,
'visibility' => $field->visibility,
'in_selector' => $field->in_selector,
'rule' => CRM_Utils_Array::value('rule', CRM_Utils_Array::value($field->field_name, $importableFields)),
'location_type_id' => $field->location_type_id ?? NULL,
'website_type_id' => $field->website_type_id ?? NULL,
'phone_type_id' => $field->phone_type_id ?? NULL,
'group_id' => $group->id,
'add_to_group_id' => $group->add_to_group_id ?? NULL,
'add_captcha' => $group->add_captcha ?? NULL,
'field_type' => $field->field_type,
'field_id' => $field->id,
'pseudoconstant' => CRM_Utils_Array::value(
'pseudoconstant',
CRM_Utils_Array::value($field->field_name, $importableFields)
),
// obsolete this when we remove the name / dbName discrepancy with gender/suffix/prefix
'dbName' => CRM_Utils_Array::value(
'dbName',
CRM_Utils_Array::value($field->field_name, $importableFields)
),
'skipDisplay' => 0,
'data_type' => CRM_Utils_Type::getDataTypeFromFieldMetadata($fieldMetaData),
'bao' => $fieldMetaData['bao'] ?? NULL,
];
$formattedField = CRM_Utils_Date::addDateMetadataToField($fieldMetaData, $formattedField);
//adding custom field property
if (substr($field->field_name, 0, 6) == 'custom' ||
substr($field->field_name, 0, 14) === 'address_custom'
) {
// if field is not present in customFields, that means the user
// DOES NOT HAVE permission to access that field
if (array_key_exists($field->field_name, $customFields)) {
$formattedField['is_search_range'] = $customFields[$field->field_name]['is_search_range'];
// fix for CRM-1994
$formattedField['options_per_line'] = $customFields[$field->field_name]['options_per_line'];
$formattedField['html_type'] = $customFields[$field->field_name]['html_type'];
if (CRM_Utils_Array::value('html_type', $formattedField) == 'Select Date') {
$formattedField['date_format'] = $customFields[$field->field_name]['date_format'];
$formattedField['time_format'] = $customFields[$field->field_name]['time_format'];
$formattedField['is_datetime_field'] = TRUE;
$formattedField['smarty_view_format'] = CRM_Utils_Date::getDateFieldViewFormat($formattedField['date_format']);
}
$formattedField['is_multi_summary'] = $field->is_multi_summary;
return [$name, $formattedField];
}
else {
$formattedField = NULL;
return [$name, $formattedField];
}
}
return [$name, $formattedField];
}
/**
* Create a query to find all visible UFFields in a UFGroup.
*
* This is the SQL-variant of checkUFFieldDisplayable().
*
* @param int $groupId
* @param bool $searchable
* @param bool $showAll
* @param int $visibility
* @param string $orderBy
* Comma-delimited list of SQL columns.
*
* @return string
*/
protected static function createUFFieldQuery($groupId, $searchable, $showAll, $visibility, $orderBy) {
$where = " WHERE uf_group_id = {$groupId}";
if ($searchable) {
$where .= " AND is_searchable = 1";
}
if (!$showAll) {
$where .= " AND is_active = 1";
}
if ($visibility) {
$clause = [];
if ($visibility & self::PUBLIC_VISIBILITY) {
$clause[] = 'visibility = "Public Pages"';
}
if ($visibility & self::ADMIN_VISIBILITY) {
$clause[] = 'visibility = "User and User Admin Only"';
}
if ($visibility & self::LISTINGS_VISIBILITY) {
$clause[] = 'visibility = "Public Pages and Listings"';
}
if (!empty($clause)) {
$where .= ' AND ( ' . implode(' OR ', $clause) . ' ) ';
}
}
$query = "SELECT * FROM civicrm_uf_field $where ORDER BY weight";
if ($orderBy) {
$query .= ", " . $orderBy;
return $query;
}
return $query;
}
/**
* Create a query to find all visible UFFields in a UFGroup.
*
* This is the PHP in-memory variant of createUFFieldQuery().
*
* @param CRM_Core_DAO_UFField|CRM_Core_DAO $field
* @param bool $searchable
* @param bool $showAll
* @param int $visibility
*
* @return bool
* TRUE if field is displayable
*/
protected static function filterUFField($field, $searchable, $showAll, $visibility) {
if ($searchable && $field->is_searchable != 1) {
return FALSE;
}
if (!$showAll && $field->is_active != 1) {
return FALSE;
}
if ($visibility) {
$allowedVisibilities = [];
if ($visibility & self::PUBLIC_VISIBILITY) {
$allowedVisibilities[] = 'Public Pages';
}
if ($visibility & self::ADMIN_VISIBILITY) {
$allowedVisibilities[] = 'User and User Admin Only';
}
if ($visibility & self::LISTINGS_VISIBILITY) {
$allowedVisibilities[] = 'Public Pages and Listings';
}
// !empty($allowedVisibilities) seems silly to me, but it is equivalent to the pre-existing SQL
if (!empty($allowedVisibilities) && !in_array($field->visibility, $allowedVisibilities)) {
return FALSE;
}
}
return TRUE;
}
/**
* Get a list of filtered field metadata.
*
* @param $showAll
* @param $profileType
* @param $contactActivityProfile
* @param bool $filterMode
* Filter mode means you are using importable fields for filtering rather than just getting metadata.
* With filter mode = FALSE BOTH activity fields and component fields are returned.
* I can't see why you would ever want to use this function in filter mode as the component fields are
* still unfiltered. However, I feel scared enough to leave it as it is. I have marked this function as
* deprecated and am recommending the wrapper 'getProfileFieldMetadata' in order to try to
* send this confusion to history.
*
* @return array
* @deprecated use getProfileFieldMetadata
*
*/
protected static function getImportableFields($showAll, $profileType, $contactActivityProfile, $filterMode = TRUE) {
if (!$showAll) {
$importableFields = CRM_Contact_BAO_Contact::importableFields('All', FALSE, FALSE, FALSE, TRUE, TRUE);
}
else {
$importableFields = CRM_Contact_BAO_Contact::importableFields('All', FALSE, TRUE, FALSE, TRUE, TRUE);
}
$activityFields = CRM_Activity_BAO_Activity::getProfileFields();
$componentFields = CRM_Core_Component::getQueryFields();
if ($filterMode == TRUE) {
if ($profileType == 'Activity' || $contactActivityProfile) {
$importableFields = array_merge($importableFields, $activityFields);
}
else {
$importableFields = array_merge($importableFields, $componentFields);
}
}
else {
$importableFields = array_merge($importableFields, $activityFields, $componentFields);
}
$importableFields['group']['title'] = ts('Group(s)');
$importableFields['group']['where'] = NULL;
$importableFields['tag']['title'] = ts('Tag(s)');
$importableFields['tag']['where'] = NULL;
return $importableFields;
}
/**
* Get the metadata for all potential profile fields.
*
* @param bool $isIncludeInactive
* Should disabled fields be included.
*
* @return array
* Field metadata for all fields that might potentially be in a profile.
*/
protected static function getProfileFieldMetadata($isIncludeInactive) {
return self::getImportableFields($isIncludeInactive, NULL, NULL, NULL, TRUE);
}
/**
* Get the fields relating to locations.
*
* @return array
*/
public static function getLocationFields() {
static $locationFields = [
'street_address',
'supplemental_address_1',
'supplemental_address_2',
'supplemental_address_3',
'city',
'postal_code',
'postal_code_suffix',
'geo_code_1',
'geo_code_2',
'state_province',
'country',
'county',
'phone',
'phone_and_ext',
'email',
'im',
'address_name',
'phone_ext',
];
return $locationFields;
}
/**
* @param $ctype
*
* @return mixed
*/
protected static function getCustomFields($ctype) {
$cacheKey = 'uf_group_custom_fields_' . $ctype;
if (!Civi::cache('metadata')->has($cacheKey)) {
$customFields = CRM_Core_BAO_CustomField::getFieldsForImport($ctype, FALSE, FALSE, FALSE, TRUE, TRUE);
// hack to add custom data for components
$components = ['Contribution', 'Participant', 'Membership', 'Activity', 'Case'];
foreach ($components as $value) {
$customFields = array_merge($customFields, CRM_Core_BAO_CustomField::getFieldsForImport($value));
}
$addressCustomFields = CRM_Core_BAO_CustomField::getFieldsForImport('Address');
$customFields = array_merge($customFields, $addressCustomFields);
Civi::cache('metadata')->set($cacheKey, [$customFields, $addressCustomFields]);
}
return Civi::cache('metadata')->get($cacheKey);
}
/**
* Check the data validity.
*
* @param int $userID
* The user id that we are actually editing.
* @param string $name
* The machine-name of the group we are interested in.
* @param bool $register
* @param int $action
* The action of the form.
*
* @pram boolean $register is this the registrtion form
* @return bool
* true if form is valid
*/
public static function isValid($userID, $name, $register = FALSE, $action = NULL) {
if ($register) {
$controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
ts('Dynamic Form Creator'),
$action
);
$controller->set('id', $userID);
$controller->set('register', 1);
$controller->process();
return $controller->validate();
}
else {
// make sure we have a valid group
$group = new CRM_Core_DAO_UFGroup();
$group->name = $name;
if ($group->find(TRUE) && $userID) {
$controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic', ts('Dynamic Form Creator'), $action);
$controller->set('gid', $group->id);
$controller->set('id', $userID);
$controller->set('register', 0);
$controller->process();
return $controller->validate();
}
return TRUE;
}
}
/**
* Get the html for the form that represents this particular group.
*
* @param int $userID
* The user id that we are actually editing.
* @param string $title
* The title of the group we are interested in.
* @param int $action
* The action of the form.
* @param bool $register
* Is this the registration form.
* @param bool $reset
* Should we reset the form?.
* @param int $profileID
* Do we have the profile ID?.
*
* @param bool $doNotProcess
* @param null $ctype
*
* @return string
* the html for the form on success, otherwise empty string
*/
public static function getEditHTML(
$userID,
$title,
$action = NULL,
$register = FALSE,
$reset = FALSE,
$profileID = NULL,
$doNotProcess = FALSE,
$ctype = NULL
) {
if ($register) {
$controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
ts('Dynamic Form Creator'),
$action
);
if ($reset || $doNotProcess) {
// hack to make sure we do not process this form
$oldQFDefault = CRM_Utils_Array::value('_qf_default',
$_POST
);
unset($_POST['_qf_default']);
unset($_REQUEST['_qf_default']);
if ($reset) {
$controller->reset();
}
}
$controller->set('id', $userID);
$controller->set('register', 1);
$controller->set('skipPermission', 1);
$controller->set('ctype', $ctype);
$controller->process();
if ($doNotProcess || !empty($_POST)) {
$controller->validate();
}
$controller->setEmbedded(TRUE);
//CRM-5839 - though we want to process form, get the control back.
$controller->setSkipRedirection(!$doNotProcess);
$controller->run();
// we are done processing so restore the POST/REQUEST vars
if (($reset || $doNotProcess) && $oldQFDefault) {
$_POST['_qf_default'] = $_REQUEST['_qf_default'] = $oldQFDefault;
}
$template = CRM_Core_Smarty::singleton();
// Hide CRM error messages if they are displayed using drupal form_set_error.
if (!empty($_POST)) {
$template->assign('suppressForm', TRUE);
}
return trim($template->fetch('CRM/Profile/Form/Dynamic.tpl'));
}
else {
if (!$profileID) {
// make sure we have a valid group
$group = new CRM_Core_DAO_UFGroup();
$group->title = $title;
if ($group->find(TRUE)) {
$profileID = $group->id;
}
}
if ($profileID) {
// make sure profileID and ctype match if ctype exists
if ($ctype) {
$profileType = CRM_Core_BAO_UFField::getProfileType($profileID);
if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) {
$profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType);
}
if (($profileType != 'Contact') && ($profileType != $ctype)) {
return NULL;
}
}
$controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
ts('Dynamic Form Creator'),
$action
);
if ($reset) {
$controller->reset();
}
$controller->set('gid', $profileID);
$controller->set('id', $userID);
$controller->set('register', 0);
$controller->set('skipPermission', 1);
if ($ctype) {
$controller->set('ctype', $ctype);
}
$controller->process();
$controller->setEmbedded(TRUE);
//CRM-5846 - give the control back to drupal.
$controller->setSkipRedirection(!$doNotProcess);
$controller->run();
$template = CRM_Core_Smarty::singleton();
// Hide CRM error messages if they are displayed using drupal form_set_error.
if (!empty($_POST) && CRM_Core_Config::singleton()->userFramework == 'Drupal') {
if (arg(0) == 'user' || (arg(0) == 'admin' && arg(1) == 'people')) {
$template->assign('suppressForm', TRUE);
}
}
$templateFile = "CRM/Profile/Form/{$profileID}/Dynamic.tpl";
if (!$template->template_exists($templateFile)) {
$templateFile = 'CRM/Profile/Form/Dynamic.tpl';
}
return trim($template->fetch($templateFile));
}
else {
$userEmail = CRM_Contact_BAO_Contact_Location::getEmailDetails($userID);
// if post not empty then only proceed
if (!empty($_POST)) {
// get the new email
$config = CRM_Core_Config::singleton();
$email = $_POST['mail'] ?? NULL;
if (CRM_Utils_Rule::email($email) && ($email != $userEmail[1])) {
CRM_Core_BAO_UFMatch::updateContactEmail($userID, $email);
}
}
}
}
return '';
}
/**
* Given a contact id and a field set, return the values from the db.
*
* @param int $cid
* @param array $fields
* The profile fields of interest.
* @param array $values
* The values for the above fields.
* @param bool $searchable
* Searchable or not.
* @param array $componentWhere
* Component condition.
* @param bool $absolute
* Return urls in absolute form (useful when sending an email).
* @param null $additionalWhereClause
*
* @return null|array
*/
public static function getValues(
$cid, &$fields, &$values,
$searchable = TRUE, $componentWhere = NULL,
$absolute = FALSE, $additionalWhereClause = NULL
) {
if (empty($cid) && empty($componentWhere)) {
return NULL;
}
// get the contact details (hier)
$returnProperties = CRM_Contact_BAO_Contact::makeHierReturnProperties($fields);
$params = $cid ? [['contact_id', '=', $cid, 0, 0]] : [];
// add conditions specified by components. eg partcipant_id etc
if (!empty($componentWhere)) {
$params = array_merge($params, $componentWhere);
}
$query = new CRM_Contact_BAO_Query($params, $returnProperties, $fields);
$details = $query->searchQuery(0, 0, NULL, FALSE, FALSE,
FALSE, FALSE, FALSE, $additionalWhereClause);
while ($details->fetch()) {
if (!$details) {
return;
}
}
$query->convertToPseudoNames($details);
$locationTypes = CRM_Core_BAO_Address::buildOptions('location_type_id', 'validate');
$imProviders = CRM_Core_DAO_IM::buildOptions('provider_id');
$websiteTypes = CRM_Core_DAO_Website::buildOptions('website_type_id');
$multipleFields = ['url'];
//start of code to set the default values
foreach ($fields as $name => $field) {