/
MembershipType.php
850 lines (776 loc) · 30.8 KB
/
MembershipType.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
<?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
*/
class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType implements \Civi\Core\HookInterface {
/**
* Static holder for the default Membership Type.
* @var int
*/
public static $_defaultMembershipType = NULL;
public static $_membershipTypeInfo = [];
/**
* @deprecated
* @param array $params
* @param array $defaults
* @return self|null
*/
public static function retrieve($params, &$defaults) {
return self::commonRetrieve(self::class, $params, $defaults);
}
/**
* @deprecated - this bypasses hooks.
* @param int $id
* @param bool $is_active
* @return bool
*/
public static function setIsActive($id, $is_active) {
CRM_Core_Error::deprecatedFunctionWarning('writeRecord');
return CRM_Core_DAO::setFieldValue('CRM_Member_DAO_MembershipType', $id, 'is_active', $is_active);
}
/**
* Add the membership types.
*
* @param array $params
* Reference array contains the values submitted by the form.
*
* @return \CRM_Member_DAO_MembershipType
* @throws \CRM_Core_Exception
*/
public static function add(&$params) {
$hook = empty($params['id']) ? 'create' : 'edit';
$membershipTypeID = $params['id'] ?? NULL;
CRM_Utils_Hook::pre($hook, 'MembershipType', $membershipTypeID, $params);
if (!$membershipTypeID && !isset($params['domain_id'])) {
$params['domain_id'] = CRM_Core_Config::domainID();
}
// $previousID is the old organization id for membership type i.e 'member_of_contact_id'. This is used when an organization is changed.
$previousID = NULL;
if ($membershipTypeID) {
$previousID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $membershipTypeID, 'member_of_contact_id');
}
$membershipType = new CRM_Member_DAO_MembershipType();
$membershipType->copyValues($params);
$membershipType->save();
if ($membershipTypeID) {
// on update we may need to retrieve some details for the price field function - otherwise we get e-notices on attempts to retrieve
// name etc - the presence of previous id tells us this is an update
$params = array_merge(civicrm_api3('membership_type', 'getsingle', ['id' => $membershipType->id]), $params);
}
self::createMembershipPriceField($params, $previousID, $membershipType->id);
// update all price field value for quick config when membership type is set CRM-11718
if ($membershipTypeID) {
self::updateAllPriceFieldValue($membershipTypeID, $params);
}
CRM_Utils_Hook::post($hook, 'MembershipType', $membershipType->id, $membershipType);
self::flush();
return $membershipType;
}
/**
* Flush anywhere that membership types might be cached.
*
* @throws \CRM_Core_Exception
*/
public static function flush() {
CRM_Member_PseudoConstant::membershipType(NULL, TRUE);
civicrm_api3('membership', 'getfields', ['cache_clear' => 1, 'fieldname' => 'membership_type_id']);
civicrm_api3('profile', 'getfields', ['action' => 'submit', 'cache_clear' => 1]);
Civi::cache('metadata')->clear();
}
/**
* Delete membership Types.
*
* @param int $membershipTypeId
*
* @deprecated
* @throws CRM_Core_Exception
* @return bool
*/
public static function del($membershipTypeId) {
CRM_Core_Error::deprecatedFunctionWarning('deleteRecord');
try {
static::deleteRecord(['id' => $membershipTypeId]);
return TRUE;
}
catch (CRM_Core_Exception $e) {
return FALSE;
}
}
/**
* Callback for hook_civicrm_pre().
* @param \Civi\Core\Event\PreEvent $event
* @throws CRM_Core_Exception
*/
public static function on_hook_civicrm_pre(\Civi\Core\Event\PreEvent $event) {
if ($event->action === 'delete' && $event->entity === 'RelationshipType') {
// When deleting relationship type, remove from membership types
$mems = civicrm_api3('MembershipType', 'get', [
'relationship_type_id' => ['LIKE' => "%{$event->id}%"],
'return' => ['id', 'relationship_type_id', 'relationship_direction'],
]);
foreach ($mems['values'] as $membershipType) {
$pos = array_search($event->id, $membershipType['relationship_type_id']);
// Api call may have returned false positives but currently the relationship_type_id uses
// nonstandard serialization which makes anything more accurate impossible.
if ($pos !== FALSE) {
unset($membershipType['relationship_type_id'][$pos], $membershipType['relationship_direction'][$pos]);
civicrm_api3('MembershipType', 'create', $membershipType);
}
}
}
if ($event->action === 'delete' && $event->entity === 'MembershipType') {
// Check dependencies.
$check = FALSE;
$status = [];
$dependency = [
'Membership' => 'membership_type_id',
'MembershipBlock' => 'membership_type_default',
];
foreach ($dependency as $name => $field) {
$baoString = 'CRM_Member_BAO_' . $name;
$dao = new $baoString();
$dao->$field = $event->id;
if ($dao->find(TRUE)) {
$check = TRUE;
$status[] = $name;
}
}
if ($check) {
$cnt = 1;
$message = ts('This membership type cannot be deleted due to following reason(s):');
if (in_array('Membership', $status)) {
$findMembersURL = CRM_Utils_System::url('civicrm/member/search', 'reset=1');
$deleteURL = CRM_Utils_System::url('civicrm/contact/search/advanced', 'reset=1');
$message .= '<br/>' . ts('%3. There are some contacts who have this membership type assigned to them. Search for contacts with this membership type from <a href=\'%1\'>Find Members</a>. If you are still getting this message after deleting these memberships, there may be contacts in the Trash (deleted) with this membership type. Try using <a href="%2">Advanced Search</a> and checking "Search in Trash".', [
1 => $findMembersURL,
2 => $deleteURL,
3 => $cnt,
]);
$cnt++;
}
if (in_array('MembershipBlock', $status)) {
$deleteURL = CRM_Utils_System::url('civicrm/admin/contribute', 'reset=1');
$message .= ts('%2. This Membership Type is used in an <a href=\'%1\'>Online Contribution page</a>. Uncheck this membership type in the Memberships tab.', [
1 => $deleteURL,
2 => $cnt,
]);
throw new CRM_Core_Exception($message);
}
}
CRM_Utils_Weight::delWeight('CRM_Member_DAO_MembershipType', $event->id);
}
}
/**
* Convert membership type's 'start day' & 'rollover day' to human readable formats.
*
* @param array $membershipType
* An array of membershipType-details.
*/
public static function convertDayFormat(&$membershipType) {
$periodDays = [
'fixed_period_start_day',
'fixed_period_rollover_day',
];
foreach ($membershipType as $id => $details) {
foreach ($periodDays as $pDay) {
if (!empty($details[$pDay])) {
if ($details[$pDay] > 31) {
$month = substr($details[$pDay], 0, strlen($details[$pDay]) - 2);
$day = substr($details[$pDay], -2);
$monthMap = [
'1' => 'Jan',
'2' => 'Feb',
'3' => 'Mar',
'4' => 'Apr',
'5' => 'May',
'6' => 'Jun',
'7' => 'Jul',
'8' => 'Aug',
'9' => 'Sep',
'10' => 'Oct',
'11' => 'Nov',
'12' => 'Dec',
];
$membershipType[$id][$pDay] = $monthMap[$month] . ' ' . $day;
}
else {
$membershipType[$id][$pDay] = $details[$pDay];
}
}
}
}
}
/**
* Get membership Types.
*
* @deprecated use getAllMembershipTypes.
*
* @param bool $public
*
* @return array
*/
public static function getMembershipTypes($public = TRUE) {
$membershipTypes = [];
$membershipType = new CRM_Member_DAO_MembershipType();
$membershipType->is_active = 1;
if ($public) {
$membershipType->visibility = 'Public';
}
$membershipType->orderBy(' weight');
$membershipType->find();
while ($membershipType->fetch()) {
$membershipTypes[$membershipType->id] = $membershipType->name;
}
return $membershipTypes;
}
/**
* Get membership Type Details.
*
* @deprecated use getMembershipType.
*
* @param int $membershipTypeId
*
* @return array|null
*/
public static function getMembershipTypeDetails($membershipTypeId) {
$membershipTypeDetails = [];
$membershipType = new CRM_Member_DAO_MembershipType();
$membershipType->is_active = 1;
$membershipType->id = $membershipTypeId;
if ($membershipType->find(TRUE)) {
CRM_Core_DAO::storeValues($membershipType, $membershipTypeDetails);
return $membershipTypeDetails;
}
else {
return NULL;
}
}
/**
* Calculate start date and end date for new membership.
*
* @param int $membershipTypeId
* Membership type id.
* @param string $joinDate
* Member since ( in mysql date format ).
* @param string $startDate
* Start date ( in mysql date format ).
* @param null $endDate
* @param int $numRenewTerms
* How many membership terms are being added to end date (default is 1).
*
* @return array
* associated array with start date, end date and join date for the membership
*/
public static function getDatesForMembershipType($membershipTypeId, $joinDate = NULL, $startDate = NULL, $endDate = NULL, $numRenewTerms = 1) {
$membershipTypeDetails = self::getMembershipTypeDetails($membershipTypeId);
// Convert all dates to 'Y-m-d' format.
foreach ([
'joinDate',
'startDate',
'endDate',
] as $dateParam) {
if (!empty($$dateParam)) {
$$dateParam = CRM_Utils_Date::processDate($$dateParam, NULL, FALSE, 'Y-m-d');
}
}
if (!$joinDate) {
$joinDate = CRM_Utils_Time::date('Y-m-d');
}
$actualStartDate = $joinDate;
if ($startDate) {
$actualStartDate = $startDate;
}
$fixed_period_rollover = FALSE;
if (($membershipTypeDetails['period_type'] ?? NULL) == 'rolling') {
if (!$startDate) {
$startDate = $joinDate;
}
$actualStartDate = $startDate;
}
elseif (($membershipTypeDetails['period_type'] ?? NULL) == 'fixed') {
// calculate start date
// if !$startDate then use $joinDate
$toDay = explode('-', (empty($startDate) ? $joinDate : $startDate));
$year = $toDay[0];
$month = $toDay[1];
$day = $toDay[2];
if ($membershipTypeDetails['duration_unit'] == 'year') {
//get start fixed day
$startMonth = substr($membershipTypeDetails['fixed_period_start_day'], 0,
strlen($membershipTypeDetails['fixed_period_start_day']) - 2
);
$startDay = substr($membershipTypeDetails['fixed_period_start_day'], -2);
if (date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year)) <= date('Y-m-d', mktime(0, 0, 0, $month, $day, $year))) {
$actualStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year));
}
else {
$actualStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year - 1));
}
$fixed_period_rollover = self::isDuringFixedAnnualRolloverPeriod($joinDate, $membershipTypeDetails, $year, $actualStartDate);
if (!$startDate) {
$startDate = $actualStartDate;
}
}
elseif ($membershipTypeDetails['duration_unit'] == 'month') {
// Check if we are on or after rollover day of the month - CRM-10585
// If so, set fixed_period_rollover TRUE so we increment end_date month below.
$dateParts = explode('-', $actualStartDate);
if ($dateParts[2] >= $membershipTypeDetails['fixed_period_rollover_day']) {
$fixed_period_rollover = TRUE;
}
// Start date is always first day of actualStartDate month
if (!$startDate) {
$actualStartDate = $startDate = $year . '-' . $month . '-01';
}
}
}
// Calculate end date if it is not passed by user.
if (!$endDate) {
//end date calculation
$date = explode('-', $actualStartDate);
$year = $date[0];
$month = $date[1];
$day = $date[2];
switch ($membershipTypeDetails['duration_unit']) {
case 'year':
$year = $year + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
//extend membership date by duration interval.
if ($fixed_period_rollover) {
$year += 1;
}
break;
case 'month':
$month = $month + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
//duration interval is month
if ($fixed_period_rollover) {
//CRM-10585
$month += 1;
}
break;
case 'day':
$day = $day + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
if ($fixed_period_rollover) {
//Fix Me: Currently we don't allow rollover if
//duration interval is day
}
break;
}
if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
$endDate = NULL;
}
else {
$endDate = date('Y-m-d', mktime(0, 0, 0, $month, $day - 1, $year));
}
}
$membershipDates = [
'start_date' => CRM_Utils_Date::customFormat($startDate, '%Y%m%d'),
'end_date' => CRM_Utils_Date::customFormat($endDate, '%Y%m%d'),
'join_date' => CRM_Utils_Date::customFormat($joinDate, '%Y%m%d'),
];
return $membershipDates;
}
/**
* Does this membership start between the rollover date and the start of the next period.
* (in which case they will get an extra membership period)
* ie if annual memberships run June - May & the rollover is in May memberships between
* May and June will return TRUE and between June and May will return FALSE
*
* @param string $startDate start date of current membership period
* @param array $membershipTypeDetails
* @param int $year
* @param string $actualStartDate
* @return bool is this in the window where the membership gets an extra part-period added
*/
public static function isDuringFixedAnnualRolloverPeriod($startDate, $membershipTypeDetails, $year, $actualStartDate) {
$rolloverMonth = substr($membershipTypeDetails['fixed_period_rollover_day'], 0,
strlen($membershipTypeDetails['fixed_period_rollover_day']) - 2
);
$rolloverDay = substr($membershipTypeDetails['fixed_period_rollover_day'], -2);
$calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year));
//CRM-7825 -membership date rules are :
//1. Membership should not be start in future.
//2. rollover window should be subset of membership window.
//get the fixed end date here.
$dateParts = explode('-', $actualStartDate);
$endDateOfFirstYearMembershipPeriod = date('Y-m-d', mktime(0, 0, 0,
$dateParts[1],
$dateParts[2] - 1,
$dateParts[0] + 1
));
//we know the month and day of the rollover date but not the year (we're just
//using the start date year at the moment. So if it's after the end
// of the first year of membership then it's the next period & we'll adjust back a year. If it's
// before the start_date then it's too early & we'll adjust forward.
if ($endDateOfFirstYearMembershipPeriod < $calculatedRolloverDate) {
$calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year - 1));
}
if ($calculatedRolloverDate < $actualStartDate) {
$calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year + 1));
}
if ($calculatedRolloverDate <= $startDate) {
return TRUE;
}
return FALSE;
}
/**
* Calculate start date and end date for membership updates.
*
* Note that this function is called by the api for any membership update although it was
* originally written for renewal (which feels a bit fragile but hey....).
*
* @param int $membershipId
* @param $changeToday
* If provided, specify an alternative date to use as "today" for renewal
* @param int $membershipTypeID
* If provided, overrides the membership type of the $membershipID membership.
* @param int $numRenewTerms
* How many membership terms are being added to end date (default is 1).
*
* CRM-7297 Membership Upsell - Added $membershipTypeID param to facilitate calculations of dates when membership type changes
*
* @return array
* array fo the start date, end date and join date of the membership
*/
public static function getRenewalDatesForMembershipType($membershipId, $changeToday = NULL, $membershipTypeID = NULL, $numRenewTerms = 1) {
$params = ['id' => $membershipId];
$membershipDetails = CRM_Member_BAO_Membership::getValues($params, $values);
$membershipDetails = $membershipDetails[$membershipId];
$statusID = $membershipDetails->status_id;
$membershipDates = [];
if (!empty($membershipDetails->join_date)) {
$membershipDates['join_date'] = CRM_Utils_Date::customFormat($membershipDetails->join_date, '%Y%m%d');
}
$oldPeriodType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id'), 'period_type');
// CRM-7297 Membership Upsell
if (is_null($membershipTypeID)) {
$membershipTypeDetails = self::getMembershipTypeDetails($membershipDetails->membership_type_id);
}
else {
$membershipTypeDetails = self::getMembershipTypeDetails($membershipTypeID);
}
$statusDetails = CRM_Member_BAO_MembershipStatus::getMembershipStatus($statusID);
if ($statusDetails['is_current_member'] == 1) {
$startDate = $membershipDetails->start_date;
// CRM=7297 Membership Upsell: we need to handle null end_date in case we are switching
// from a lifetime to a different membership type
if (is_null($membershipDetails->end_date)) {
$date = CRM_Utils_Time::date('Y-m-d');
}
else {
$date = $membershipDetails->end_date;
}
$date = explode('-', $date);
// We have to add 1 day first in case it's the end of the month, then subtract afterwards
// eg. 2018-02-28 should renew to 2018-03-31, if we just added 1 month we'd get 2018-03-28
$logStartDate = date('Y-m-d', mktime(0, 0, 0,
(double) $date[1],
(double) ($date[2] + 1),
(double) $date[0]
));
$date = explode('-', $logStartDate);
$year = $date[0];
$month = $date[1];
$day = $date[2];
switch ($membershipTypeDetails['duration_unit']) {
case 'year':
//need to check if the upsell is from rolling to fixed and adjust accordingly
if ($membershipTypeDetails['period_type'] == 'fixed' && $oldPeriodType == 'rolling') {
$month = substr($membershipTypeDetails['fixed_period_start_day'], 0, strlen($membershipTypeDetails['fixed_period_start_day']) - 2);
$day = substr($membershipTypeDetails['fixed_period_start_day'], -2);
$year += 1;
}
else {
$year = $year + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
}
break;
case 'month':
$month = $month + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
break;
case 'day':
$day = $day + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
break;
}
if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
$endDate = NULL;
}
else {
$endDate = date('Y-m-d', mktime(0, 0, 0,
$month,
$day - 1,
$year
));
}
$today = CRM_Utils_Time::date('Y-m-d');
$membershipDates['today'] = CRM_Utils_Date::customFormat($today, '%Y%m%d');
$membershipDates['start_date'] = CRM_Utils_Date::customFormat($startDate, '%Y%m%d');
$membershipDates['end_date'] = CRM_Utils_Date::customFormat($endDate, '%Y%m%d');
$membershipDates['log_start_date'] = CRM_Utils_Date::customFormat($logStartDate, '%Y%m%d');
}
else {
$today = CRM_Utils_Time::date('Y-m-d');
if ($changeToday) {
$today = CRM_Utils_Date::processDate($changeToday, NULL, FALSE, 'Y-m-d');
}
// Calculate new start/end dates when join date is today
$renewalDates = self::getDatesForMembershipType($membershipTypeDetails['id'],
$today, NULL, NULL, $numRenewTerms
);
$membershipDates['today'] = CRM_Utils_Date::customFormat($today, '%Y%m%d');
$membershipDates['start_date'] = $renewalDates['start_date'];
$membershipDates['end_date'] = $renewalDates['end_date'];
$membershipDates['log_start_date'] = $renewalDates['start_date'];
// CRM-18503 - set join_date as today in case the membership type is fixed.
if ($membershipTypeDetails['period_type'] == 'fixed' && !isset($membershipDates['join_date'])) {
$membershipDates['join_date'] = $renewalDates['join_date'];
}
}
if (!isset($membershipDates['join_date'])) {
$membershipDates['join_date'] = $membershipDates['start_date'];
}
return $membershipDates;
}
/**
* Retrieve all Membership Types with Member of Contact id.
*
* @param array $membershipTypes
* array of membership type ids
* @return array
* array of the details of membership types with Member of Contact id
*/
public static function getMemberOfContactByMemTypes($membershipTypes) {
$memTypeOrganizations = [];
if (empty($membershipTypes)) {
return $memTypeOrganizations;
}
$result = CRM_Core_DAO::executeQuery("SELECT id, member_of_contact_id FROM civicrm_membership_type WHERE id IN (" . implode(',', $membershipTypes) . ")");
while ($result->fetch()) {
$memTypeOrganizations[$result->id] = $result->member_of_contact_id;
}
return $memTypeOrganizations;
}
/**
* The function returns all the Organization for all membershipTypes .
*
* @param int $membershipTypeId
*
* @return array
*/
public static function getMembershipTypeOrganization($membershipTypeId = NULL) {
$allMembershipTypes = [];
$membershipType = new CRM_Member_DAO_MembershipType();
if (isset($membershipTypeId)) {
$membershipType->id = $membershipTypeId;
}
$membershipType->find();
while ($membershipType->fetch()) {
$allMembershipTypes[$membershipType->id] = $membershipType->member_of_contact_id;
}
return $allMembershipTypes;
}
/**
* Function to retrieve organization and associated membership
* types
*
* @return array
* arrays of organization and membership types
*
*/
public static function getMembershipTypeInfo() {
if (!self::$_membershipTypeInfo) {
$orgs = $types = [];
$query = 'SELECT memType.id, memType.name, memType.member_of_contact_id, c.sort_name
FROM civicrm_membership_type memType INNER JOIN civicrm_contact c ON c.id = memType.member_of_contact_id
WHERE memType.is_active = 1 ';
$dao = CRM_Core_DAO::executeQuery($query);
while ($dao->fetch()) {
$orgs[$dao->member_of_contact_id] = $dao->sort_name;
$types[$dao->member_of_contact_id][$dao->id] = $dao->name;
}
self::$_membershipTypeInfo = [$orgs, $types];
}
return self::$_membershipTypeInfo;
}
/**
* @param array $params
* @param int $previousID
* @param int $membershipTypeId
*/
public static function createMembershipPriceField($params, $previousID, $membershipTypeId) {
$priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
if (!empty($params['member_of_contact_id'])) {
$fieldName = $params['member_of_contact_id'];
}
else {
$fieldName = $previousID;
}
$fieldLabel = 'Membership Amount';
$optionsIds = NULL;
$fieldParams = [
'price_set_id ' => $priceSetId,
'name' => $fieldName,
];
$results = [];
CRM_Price_BAO_PriceField::retrieve($fieldParams, $results);
if (empty($results)) {
$fieldParams = [];
$fieldParams['label'] = $fieldLabel;
$fieldParams['name'] = $fieldName;
$fieldParams['price_set_id'] = $priceSetId;
$fieldParams['html_type'] = 'Radio';
$fieldParams['is_display_amounts'] = $fieldParams['is_required'] = 0;
$fieldParams['weight'] = $fieldParams['option_weight'][1] = 1;
$fieldParams['option_label'][1] = $params['name'];
$fieldParams['option_description'][1] = $params['description'] ?? NULL;
$fieldParams['membership_type_id'][1] = $membershipTypeId;
$fieldParams['option_amount'][1] = empty($params['minimum_fee']) ? 0 : $params['minimum_fee'];
$fieldParams['financial_type_id'] = $params['financial_type_id'] ?? NULL;
if ($previousID) {
CRM_Member_Form_MembershipType::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
$fieldParams['option_id'] = $optionsIds['option_id'] ?? NULL;
}
CRM_Price_BAO_PriceField::create($fieldParams);
}
else {
$fieldID = $results['id'];
$fieldValueParams = [
'price_field_id' => $fieldID,
'membership_type_id' => $membershipTypeId,
];
$results = [];
CRM_Price_BAO_PriceFieldValue::retrieve($fieldValueParams, $results);
if (!empty($results)) {
$results['label'] = $results['name'] = $params['name'];
$results['amount'] = empty($params['minimum_fee']) ? 0 : $params['minimum_fee'];
}
else {
$results = [
'price_field_id' => $fieldID,
'name' => $params['name'],
'label' => $params['name'],
'amount' => empty($params['minimum_fee']) ? 0 : $params['minimum_fee'],
'membership_type_id' => $membershipTypeId,
'is_active' => 1,
];
}
if ($previousID) {
CRM_Member_Form_MembershipType::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
if (!empty($optionsIds['option_id'])) {
$results['id'] = current($optionsIds['option_id']);
}
}
$results['financial_type_id'] = $params['financial_type_id'] ?? NULL;
$results['description'] = $params['description'] ?? NULL;
CRM_Price_BAO_PriceFieldValue::add($results);
}
}
/**
* This function updates all price field value for quick config
* price set which has membership type
*
* @param int $membershipTypeId membership type id
*
* @param array $params
*/
public static function updateAllPriceFieldValue($membershipTypeId, $params) {
$defaults = [];
$fieldsToUpdate = [
'financial_type_id' => 'financial_type_id',
'name' => 'label',
'minimum_fee' => 'amount',
'description' => 'description',
'visibility' => 'visibility_id',
];
$priceFieldValueBAO = new CRM_Price_BAO_PriceFieldValue();
$priceFieldValueBAO->membership_type_id = $membershipTypeId;
$priceFieldValueBAO->find();
while ($priceFieldValueBAO->fetch()) {
$updateParams = [
'id' => $priceFieldValueBAO->id,
'price_field_id' => $priceFieldValueBAO->price_field_id,
];
//Get priceset details.
$fieldParams = ['fid' => $priceFieldValueBAO->price_field_id];
$setID = CRM_Price_BAO_PriceSet::getSetId($fieldParams);
$setParams = ['id' => $setID];
$setValues = CRM_Price_BAO_PriceSet::retrieve($setParams, $defaults);
if (!empty($setValues->is_quick_config) && $setValues->name != 'default_membership_type_amount') {
foreach ($fieldsToUpdate as $key => $value) {
if ($value == 'visibility_id' && !empty($params['visibility'])) {
$updateParams['visibility_id'] = CRM_Price_BAO_PriceField::getVisibilityOptionID(strtolower($params['visibility']));
}
else {
$updateParams[$value] = $params[$key] ?? NULL;
}
}
CRM_Price_BAO_PriceFieldValue::add($updateParams);
}
}
}
/**
* Cached wrapper for membership types.
*
* Since this is used from the batched script caching helps.
*
* Caching is by domain - if that hits any issues we should add a new function getDomainMembershipTypes
* or similar rather than 'just add another param'! but this is closer to earlier behaviour so 'should' be OK.
*
* @return array
* List of membershipType details keyed by membershipTypeID
* @throws \CRM_Core_Exception
*/
public static function getAllMembershipTypes(): array {
$cacheString = __CLASS__ . __FUNCTION__ . CRM_Core_Config::domainID() . '_' . CRM_Core_I18n::getLocale();
if (!Civi::cache('metadata')->has($cacheString)) {
$types = civicrm_api3('MembershipType', 'get', ['options' => ['limit' => 0, 'sort' => 'weight']])['values'];
$taxRates = CRM_Core_PseudoConstant::getTaxRates();
$keys = ['description', 'relationship_type_id', 'relationship_direction', 'max_related', 'auto_renew'];
// In order to avoid down-stream e-notices we undo api v3 filtering of NULL values. This is covered
// in Unit tests & ideally we might switch to apiv4 but I would argue we should build caching
// of metadata entities like this directly into apiv4.
foreach ($types as $id => $type) {
foreach ($keys as $key) {
if (!isset($type[$key])) {
$types[$id][$key] = NULL;
}
}
if (isset($type['contribution_type_id'])) {
unset($types[$id]['contribution_type_id']);
}
$types[$id]['tax_rate'] = (float) ($taxRates[$type['financial_type_id']] ?? 0.0);
$multiplier = 1;
if ($types[$id]['tax_rate'] !== 0.0) {
$multiplier += ($types[$id]['tax_rate'] / 100);
}
if (!array_key_exists('minimum_fee', $types[$id])) {
$types[$id]['minimum_fee'] = 0;
}
$types[$id]['minimum_fee_with_tax'] = (float) $types[$id]['minimum_fee'] * $multiplier;
}
Civi::cache('metadata')->set($cacheString, $types);
}
return Civi::cache('metadata')->get($cacheString);
}
/**
* Get a specific membership type (leveraging the cache).
*
* @param int $id
*
* @return mixed
* @throws \CRM_Core_Exception
*/
public static function getMembershipType($id) {
return self::getAllMembershipTypes()[$id];
}
}