3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 class CRM_Member_BAO_MembershipType
extends CRM_Member_DAO_MembershipType
implements \Civi\Test\HookInterface
{
20 * Static holder for the default Membership Type.
23 public static $_defaultMembershipType = NULL;
25 public static $_membershipTypeInfo = [];
28 * Fetch object based on array of properties.
30 * @param array $params
31 * (reference ) an assoc array of name/value pairs.
32 * @param array $defaults
33 * (reference ) an assoc array to hold the flattened values.
35 * @return CRM_Member_BAO_MembershipType
37 public static function retrieve(&$params, &$defaults) {
38 $membershipType = new CRM_Member_DAO_MembershipType();
39 $membershipType->copyValues($params);
40 if ($membershipType->find(TRUE)) {
41 CRM_Core_DAO
::storeValues($membershipType, $defaults);
42 return $membershipType;
48 * Update the is_active flag in the db.
51 * Id of the database record.
52 * @param bool $is_active
53 * Value we want to set the is_active field.
56 * true if we found and updated the object, else false
58 public static function setIsActive($id, $is_active) {
59 return CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_MembershipType', $id, 'is_active', $is_active);
63 * Add the membership types.
65 * @param array $params
66 * Reference array contains the values submitted by the form.
68 * Array contains the id (deprecated).
70 * @return \CRM_Member_DAO_MembershipType
71 * @throws \CiviCRM_API3_Exception
73 public static function add(&$params, $ids = []) {
74 // DEPRECATED Check if membershipType ID was passed in via $ids
75 if (empty($params['id'])) {
76 if (isset($ids['membershipType'])) {
77 Civi
::log()->warning('Deprecated: Passing membershipType by $ids array in CRM_Member_BAO_MembershipType::add');
79 $params['id'] = $ids['membershipType'] ??
NULL;
82 $hook = empty($params['id']) ?
'create' : 'edit';
83 CRM_Utils_Hook
::pre($hook, 'MembershipType', CRM_Utils_Array
::value('id', $params), $params);
85 $membershipTypeId = $params['id'] ??
NULL;
87 if (!$membershipTypeId && !isset($params['domain_id'])) {
88 $params['domain_id'] = CRM_Core_Config
::domainID();
91 // $previousID is the old organization id for membership type i.e 'member_of_contact_id'. This is used when an organization is changed.
93 if ($membershipTypeId) {
94 $previousID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $membershipTypeId, 'member_of_contact_id');
97 // action is taken depending upon the mode
98 $membershipType = new CRM_Member_DAO_MembershipType();
99 $membershipType->copyValues($params);
100 $membershipType->save();
102 if ($membershipTypeId) {
103 // on update we may need to retrieve some details for the price field function - otherwise we get e-notices on attempts to retrieve
104 // name etc - the presence of previous id tells us this is an update
105 $params = array_merge(civicrm_api3('membership_type', 'getsingle', ['id' => $membershipType->id
]), $params);
107 self
::createMembershipPriceField($params, $previousID, $membershipType->id
);
108 // update all price field value for quick config when membership type is set CRM-11718
109 if ($membershipTypeId) {
110 self
::updateAllPriceFieldValue($membershipTypeId, $params);
113 CRM_Utils_Hook
::post($hook, 'MembershipType', $membershipType->id
, $membershipType);
116 return $membershipType;
120 * Flush anywhere that membership types might be cached.
122 * @throws \CiviCRM_API3_Exception
124 public static function flush() {
125 CRM_Member_PseudoConstant
::membershipType(NULL, TRUE);
126 civicrm_api3('membership', 'getfields', ['cache_clear' => 1, 'fieldname' => 'membership_type_id']);
127 civicrm_api3('profile', 'getfields', ['action' => 'submit', 'cache_clear' => 1]);
128 Civi
::cache('metadata')->clear();
132 * Delete membership Types.
134 * @param int $membershipTypeId
137 * @throws CRM_Core_Exception
140 public static function del($membershipTypeId) {
142 static::deleteRecord(['id' => $membershipTypeId]);
145 catch (CRM_Core_Exception
$e) {
151 * Callback for hook_civicrm_pre().
152 * @param \Civi\Core\Event\PreEvent $event
153 * @throws CRM_Core_Exception
155 public static function on_hook_civicrm_pre(\Civi\Core\Event\PreEvent
$event) {
156 if ($event->action
=== 'delete' && $event->entity
=== 'RelationshipType') {
157 // When deleting relationship type, remove from membership types
158 $mems = civicrm_api3('MembershipType', 'get', [
159 'relationship_type_id' => ['LIKE' => "%{$event->id}%"],
160 'return' => ['id', 'relationship_type_id', 'relationship_direction'],
162 foreach ($mems['values'] as $membershipType) {
163 $pos = array_search($event->id
, $membershipType['relationship_type_id']);
164 // Api call may have returned false positives but currently the relationship_type_id uses
165 // nonstandard serialization which makes anything more accurate impossible.
166 if ($pos !== FALSE) {
167 unset($membershipType['relationship_type_id'][$pos], $membershipType['relationship_direction'][$pos]);
168 civicrm_api3('MembershipType', 'create', $membershipType);
172 if ($event->action
=== 'delete' && $event->entity
=== 'MembershipType') {
173 // Check dependencies.
177 'Membership' => 'membership_type_id',
178 'MembershipBlock' => 'membership_type_default',
181 foreach ($dependency as $name => $field) {
182 $baoString = 'CRM_Member_BAO_' . $name;
183 $dao = new $baoString();
184 $dao->$field = $event->id
;
185 if ($dao->find(TRUE)) {
192 $message = ts('This membership type cannot be deleted due to following reason(s):');
193 if (in_array('Membership', $status)) {
194 $findMembersURL = CRM_Utils_System
::url('civicrm/member/search', 'reset=1');
195 $deleteURL = CRM_Utils_System
::url('civicrm/contact/search/advanced', 'reset=1');
196 $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".', [
197 1 => $findMembersURL,
204 if (in_array('MembershipBlock', $status)) {
205 $deleteURL = CRM_Utils_System
::url('civicrm/admin/contribute', 'reset=1');
206 $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.', [
210 throw new CRM_Core_Exception($message);
213 CRM_Utils_Weight
::delWeight('CRM_Member_DAO_MembershipType', $event->id
);
218 * Convert membership type's 'start day' & 'rollover day' to human readable formats.
220 * @param array $membershipType
221 * An array of membershipType-details.
223 public static function convertDayFormat(&$membershipType) {
225 'fixed_period_start_day',
226 'fixed_period_rollover_day',
228 foreach ($membershipType as $id => $details) {
229 foreach ($periodDays as $pDay) {
230 if (!empty($details[$pDay])) {
231 if ($details[$pDay] > 31) {
232 $month = substr($details[$pDay], 0, strlen($details[$pDay]) - 2);
233 $day = substr($details[$pDay], -2);
248 $membershipType[$id][$pDay] = $monthMap[$month] . ' ' . $day;
251 $membershipType[$id][$pDay] = $details[$pDay];
259 * Get membership Types.
261 * @deprecated use getAllMembershipTypes.
263 * @param bool $public
267 public static function getMembershipTypes($public = TRUE) {
268 $membershipTypes = [];
269 $membershipType = new CRM_Member_DAO_MembershipType();
270 $membershipType->is_active
= 1;
272 $membershipType->visibility
= 'Public';
274 $membershipType->orderBy(' weight');
275 $membershipType->find();
276 while ($membershipType->fetch()) {
277 $membershipTypes[$membershipType->id
] = $membershipType->name
;
279 return $membershipTypes;
283 * Get membership Type Details.
285 * @deprecated use getMembershipType.
287 * @param int $membershipTypeId
291 public static function getMembershipTypeDetails($membershipTypeId) {
292 $membershipTypeDetails = [];
294 $membershipType = new CRM_Member_DAO_MembershipType();
295 $membershipType->is_active
= 1;
296 $membershipType->id
= $membershipTypeId;
297 if ($membershipType->find(TRUE)) {
298 CRM_Core_DAO
::storeValues($membershipType, $membershipTypeDetails);
299 return $membershipTypeDetails;
307 * Calculate start date and end date for new membership.
309 * @param int $membershipTypeId
310 * Membership type id.
311 * @param string $joinDate
312 * Member since ( in mysql date format ).
313 * @param string $startDate
314 * Start date ( in mysql date format ).
315 * @param null $endDate
316 * @param int $numRenewTerms
317 * How many membership terms are being added to end date (default is 1).
320 * associated array with start date, end date and join date for the membership
322 public static function getDatesForMembershipType($membershipTypeId, $joinDate = NULL, $startDate = NULL, $endDate = NULL, $numRenewTerms = 1) {
323 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipTypeId);
325 // Convert all dates to 'Y-m-d' format.
331 if (!empty($
$dateParam)) {
332 $
$dateParam = CRM_Utils_Date
::processDate($
$dateParam, NULL, FALSE, 'Y-m-d');
336 $joinDate = CRM_Utils_Time
::date('Y-m-d');
338 $actualStartDate = $joinDate;
340 $actualStartDate = $startDate;
343 $fixed_period_rollover = FALSE;
344 if (CRM_Utils_Array
::value('period_type', $membershipTypeDetails) == 'rolling') {
346 $startDate = $joinDate;
348 $actualStartDate = $startDate;
350 elseif (CRM_Utils_Array
::value('period_type', $membershipTypeDetails) == 'fixed') {
351 // calculate start date
352 // if !$startDate then use $joinDate
353 $toDay = explode('-', (empty($startDate) ?
$joinDate : $startDate));
358 if ($membershipTypeDetails['duration_unit'] == 'year') {
360 //get start fixed day
361 $startMonth = substr($membershipTypeDetails['fixed_period_start_day'], 0,
362 strlen($membershipTypeDetails['fixed_period_start_day']) - 2
364 $startDay = substr($membershipTypeDetails['fixed_period_start_day'], -2);
366 if (date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year)) <= date('Y-m-d', mktime(0, 0, 0, $month, $day, $year))) {
367 $actualStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year));
370 $actualStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year - 1));
373 $fixed_period_rollover = self
::isDuringFixedAnnualRolloverPeriod($joinDate, $membershipTypeDetails, $year, $actualStartDate);
376 $startDate = $actualStartDate;
379 elseif ($membershipTypeDetails['duration_unit'] == 'month') {
380 // Check if we are on or after rollover day of the month - CRM-10585
381 // If so, set fixed_period_rollover TRUE so we increment end_date month below.
382 $dateParts = explode('-', $actualStartDate);
383 if ($dateParts[2] >= $membershipTypeDetails['fixed_period_rollover_day']) {
384 $fixed_period_rollover = TRUE;
387 // Start date is always first day of actualStartDate month
389 $actualStartDate = $startDate = $year . '-' . $month . '-01';
394 // Calculate end date if it is not passed by user.
396 //end date calculation
397 $date = explode('-', $actualStartDate);
402 switch ($membershipTypeDetails['duration_unit']) {
404 $year = $year +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
405 //extend membership date by duration interval.
406 if ($fixed_period_rollover) {
412 $month = $month +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
413 //duration interval is month
414 if ($fixed_period_rollover) {
421 $day = $day +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
423 if ($fixed_period_rollover) {
424 //Fix Me: Currently we don't allow rollover if
425 //duration interval is day
430 if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
434 $endDate = date('Y-m-d', mktime(0, 0, 0, $month, $day - 1, $year));
439 'start_date' => CRM_Utils_Date
::customFormat($startDate, '%Y%m%d'),
440 'end_date' => CRM_Utils_Date
::customFormat($endDate, '%Y%m%d'),
441 'join_date' => CRM_Utils_Date
::customFormat($joinDate, '%Y%m%d'),
444 return $membershipDates;
448 * Does this membership start between the rollover date and the start of the next period.
449 * (in which case they will get an extra membership period)
450 * ie if annual memberships run June - May & the rollover is in May memberships between
451 * May and June will return TRUE and between June and May will return FALSE
453 * @param string $startDate start date of current membership period
454 * @param array $membershipTypeDetails
456 * @param string $actualStartDate
457 * @return bool is this in the window where the membership gets an extra part-period added
459 public static function isDuringFixedAnnualRolloverPeriod($startDate, $membershipTypeDetails, $year, $actualStartDate) {
461 $rolloverMonth = substr($membershipTypeDetails['fixed_period_rollover_day'], 0,
462 strlen($membershipTypeDetails['fixed_period_rollover_day']) - 2
464 $rolloverDay = substr($membershipTypeDetails['fixed_period_rollover_day'], -2);
466 $calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year));
468 //CRM-7825 -membership date rules are :
469 //1. Membership should not be start in future.
470 //2. rollover window should be subset of membership window.
472 //get the fixed end date here.
473 $dateParts = explode('-', $actualStartDate);
474 $endDateOfFirstYearMembershipPeriod = date('Y-m-d', mktime(0, 0, 0,
480 //we know the month and day of the rollover date but not the year (we're just
481 //using the start date year at the moment. So if it's after the end
482 // of the first year of membership then it's the next period & we'll adjust back a year. If it's
483 // before the start_date then it's too early & we'll adjust forward.
484 if ($endDateOfFirstYearMembershipPeriod < $calculatedRolloverDate) {
485 $calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year - 1));
487 if ($calculatedRolloverDate < $actualStartDate) {
488 $calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year +
1));
491 if ($calculatedRolloverDate <= $startDate) {
498 * Calculate start date and end date for membership updates.
500 * Note that this function is called by the api for any membership update although it was
501 * originally written for renewal (which feels a bit fragile but hey....).
503 * @param int $membershipId
504 * @param $changeToday
505 * If provided, specify an alternative date to use as "today" for renewal
506 * @param int $membershipTypeID
507 * If provided, overrides the membership type of the $membershipID membership.
508 * @param int $numRenewTerms
509 * How many membership terms are being added to end date (default is 1).
511 * CRM-7297 Membership Upsell - Added $membershipTypeID param to facilitate calculations of dates when membership type changes
514 * array fo the start date, end date and join date of the membership
516 public static function getRenewalDatesForMembershipType($membershipId, $changeToday = NULL, $membershipTypeID = NULL, $numRenewTerms = 1) {
517 $params = ['id' => $membershipId];
518 $membershipDetails = CRM_Member_BAO_Membership
::getValues($params, $values);
519 $membershipDetails = $membershipDetails[$membershipId];
520 $statusID = $membershipDetails->status_id
;
521 $membershipDates = [];
522 if (!empty($membershipDetails->join_date
)) {
523 $membershipDates['join_date'] = CRM_Utils_Date
::customFormat($membershipDetails->join_date
, '%Y%m%d');
526 $oldPeriodType = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
527 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id'), 'period_type');
529 // CRM-7297 Membership Upsell
530 if (is_null($membershipTypeID)) {
531 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipDetails->membership_type_id
);
534 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipTypeID);
536 $statusDetails = CRM_Member_BAO_MembershipStatus
::getMembershipStatus($statusID);
538 if ($statusDetails['is_current_member'] == 1) {
539 $startDate = $membershipDetails->start_date
;
540 // CRM=7297 Membership Upsell: we need to handle null end_date in case we are switching
541 // from a lifetime to a different membership type
542 if (is_null($membershipDetails->end_date
)) {
543 $date = CRM_Utils_Time
::date('Y-m-d');
546 $date = $membershipDetails->end_date
;
548 $date = explode('-', $date);
549 // We have to add 1 day first in case it's the end of the month, then subtract afterwards
550 // eg. 2018-02-28 should renew to 2018-03-31, if we just added 1 month we'd get 2018-03-28
551 $logStartDate = date('Y-m-d', mktime(0, 0, 0,
553 (double) ($date[2] +
1),
557 $date = explode('-', $logStartDate);
562 switch ($membershipTypeDetails['duration_unit']) {
564 //need to check if the upsell is from rolling to fixed and adjust accordingly
565 if ($membershipTypeDetails['period_type'] == 'fixed' && $oldPeriodType == 'rolling') {
566 $month = substr($membershipTypeDetails['fixed_period_start_day'], 0, strlen($membershipTypeDetails['fixed_period_start_day']) - 2);
567 $day = substr($membershipTypeDetails['fixed_period_start_day'], -2);
571 $year = $year +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
576 $month = $month +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
580 $day = $day +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
583 if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
587 $endDate = date('Y-m-d', mktime(0, 0, 0,
593 $today = CRM_Utils_Time
::date('Y-m-d');
594 $membershipDates['today'] = CRM_Utils_Date
::customFormat($today, '%Y%m%d');
595 $membershipDates['start_date'] = CRM_Utils_Date
::customFormat($startDate, '%Y%m%d');
596 $membershipDates['end_date'] = CRM_Utils_Date
::customFormat($endDate, '%Y%m%d');
597 $membershipDates['log_start_date'] = CRM_Utils_Date
::customFormat($logStartDate, '%Y%m%d');
600 $today = CRM_Utils_Time
::date('Y-m-d');
602 $today = CRM_Utils_Date
::processDate($changeToday, NULL, FALSE, 'Y-m-d');
604 // Calculate new start/end dates when join date is today
605 $renewalDates = self
::getDatesForMembershipType($membershipTypeDetails['id'],
606 $today, NULL, NULL, $numRenewTerms
608 $membershipDates['today'] = CRM_Utils_Date
::customFormat($today, '%Y%m%d');
609 $membershipDates['start_date'] = $renewalDates['start_date'];
610 $membershipDates['end_date'] = $renewalDates['end_date'];
611 $membershipDates['log_start_date'] = $renewalDates['start_date'];
612 // CRM-18503 - set join_date as today in case the membership type is fixed.
613 if ($membershipTypeDetails['period_type'] == 'fixed' && !isset($membershipDates['join_date'])) {
614 $membershipDates['join_date'] = $renewalDates['join_date'];
617 if (!isset($membershipDates['join_date'])) {
618 $membershipDates['join_date'] = $membershipDates['start_date'];
621 return $membershipDates;
625 * Retrieve all Membership Types with Member of Contact id.
627 * @param array $membershipTypes
628 * array of membership type ids
630 * array of the details of membership types with Member of Contact id
632 public static function getMemberOfContactByMemTypes($membershipTypes) {
633 $memTypeOrganizations = [];
634 if (empty($membershipTypes)) {
635 return $memTypeOrganizations;
638 $result = CRM_Core_DAO
::executeQuery("SELECT id, member_of_contact_id FROM civicrm_membership_type WHERE id IN (" . implode(',', $membershipTypes) . ")");
639 while ($result->fetch()) {
640 $memTypeOrganizations[$result->id
] = $result->member_of_contact_id
;
643 return $memTypeOrganizations;
647 * The function returns all the Organization for all membershipTypes .
649 * @param int $membershipTypeId
653 public static function getMembershipTypeOrganization($membershipTypeId = NULL) {
654 $allMembershipTypes = [];
656 $membershipType = new CRM_Member_DAO_MembershipType();
658 if (isset($membershipTypeId)) {
659 $membershipType->id
= $membershipTypeId;
661 $membershipType->find();
663 while ($membershipType->fetch()) {
664 $allMembershipTypes[$membershipType->id
] = $membershipType->member_of_contact_id
;
666 return $allMembershipTypes;
670 * Function to retrieve organization and associated membership
674 * arrays of organization and membership types
677 public static function getMembershipTypeInfo() {
678 if (!self
::$_membershipTypeInfo) {
681 $query = 'SELECT memType.id, memType.name, memType.member_of_contact_id, c.sort_name
682 FROM civicrm_membership_type memType INNER JOIN civicrm_contact c ON c.id = memType.member_of_contact_id
683 WHERE memType.is_active = 1 ';
684 $dao = CRM_Core_DAO
::executeQuery($query);
685 while ($dao->fetch()) {
686 $orgs[$dao->member_of_contact_id
] = $dao->sort_name
;
687 $types[$dao->member_of_contact_id
][$dao->id
] = $dao->name
;
690 self
::$_membershipTypeInfo = [$orgs, $types];
692 return self
::$_membershipTypeInfo;
696 * @param array $params
697 * @param int $previousID
698 * @param int $membershipTypeId
700 public static function createMembershipPriceField($params, $previousID, $membershipTypeId) {
702 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
704 if (!empty($params['member_of_contact_id'])) {
705 $fieldName = $params['member_of_contact_id'];
708 $fieldName = $previousID;
710 $fieldLabel = 'Membership Amount';
713 'price_set_id ' => $priceSetId,
714 'name' => $fieldName,
717 CRM_Price_BAO_PriceField
::retrieve($fieldParams, $results);
718 if (empty($results)) {
720 $fieldParams['label'] = $fieldLabel;
721 $fieldParams['name'] = $fieldName;
722 $fieldParams['price_set_id'] = $priceSetId;
723 $fieldParams['html_type'] = 'Radio';
724 $fieldParams['is_display_amounts'] = $fieldParams['is_required'] = 0;
725 $fieldParams['weight'] = $fieldParams['option_weight'][1] = 1;
726 $fieldParams['option_label'][1] = $params['name'];
727 $fieldParams['option_description'][1] = $params['description'] ??
NULL;
729 $fieldParams['membership_type_id'][1] = $membershipTypeId;
730 $fieldParams['option_amount'][1] = empty($params['minimum_fee']) ?
0 : $params['minimum_fee'];
731 $fieldParams['financial_type_id'] = $params['financial_type_id'] ??
NULL;
734 CRM_Member_Form_MembershipType
::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
735 $fieldParams['option_id'] = $optionsIds['option_id'] ??
NULL;
737 CRM_Price_BAO_PriceField
::create($fieldParams);
740 $fieldID = $results['id'];
741 $fieldValueParams = [
742 'price_field_id' => $fieldID,
743 'membership_type_id' => $membershipTypeId,
746 CRM_Price_BAO_PriceFieldValue
::retrieve($fieldValueParams, $results);
747 if (!empty($results)) {
748 $results['label'] = $results['name'] = $params['name'];
749 $results['amount'] = empty($params['minimum_fee']) ?
0 : $params['minimum_fee'];
753 'price_field_id' => $fieldID,
754 'name' => $params['name'],
755 'label' => $params['name'],
756 'amount' => empty($params['minimum_fee']) ?
0 : $params['minimum_fee'],
757 'membership_type_id' => $membershipTypeId,
763 CRM_Member_Form_MembershipType
::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
764 if (!empty($optionsIds['option_id'])) {
765 $results['id'] = current($optionsIds['option_id']);
768 $results['financial_type_id'] = $params['financial_type_id'] ??
NULL;
769 $results['description'] = $params['description'] ??
NULL;
770 CRM_Price_BAO_PriceFieldValue
::add($results);
775 * This function updates all price field value for quick config
776 * price set which has membership type
778 * @param int $membershipTypeId membership type id
780 * @param array $params
782 public static function updateAllPriceFieldValue($membershipTypeId, $params) {
785 'financial_type_id' => 'financial_type_id',
787 'minimum_fee' => 'amount',
788 'description' => 'description',
789 'visibility' => 'visibility_id',
791 $priceFieldValueBAO = new CRM_Price_BAO_PriceFieldValue();
792 $priceFieldValueBAO->membership_type_id
= $membershipTypeId;
793 $priceFieldValueBAO->find();
794 while ($priceFieldValueBAO->fetch()) {
796 'id' => $priceFieldValueBAO->id
,
797 'price_field_id' => $priceFieldValueBAO->price_field_id
,
799 //Get priceset details.
800 $fieldParams = ['fid' => $priceFieldValueBAO->price_field_id
];
801 $setID = CRM_Price_BAO_PriceSet
::getSetId($fieldParams);
802 $setParams = ['id' => $setID];
803 $setValues = CRM_Price_BAO_PriceSet
::retrieve($setParams, $defaults);
804 if (!empty($setValues->is_quick_config
) && $setValues->name
!= 'default_membership_type_amount') {
805 foreach ($fieldsToUpdate as $key => $value) {
806 if ($value == 'visibility_id' && !empty($params['visibility'])) {
807 $updateParams['visibility_id'] = CRM_Price_BAO_PriceField
::getVisibilityOptionID(strtolower($params['visibility']));
810 $updateParams[$value] = $params[$key] ??
NULL;
813 CRM_Price_BAO_PriceFieldValue
::add($updateParams);
819 * Cached wrapper for membership types.
821 * Since this is used from the batched script caching helps.
823 * Caching is by domain - if that hits any issues we should add a new function getDomainMembershipTypes
824 * or similar rather than 'just add another param'! but this is closer to earlier behaviour so 'should' be OK.
827 * List of membershipType details keyed by membershipTypeID
828 * @throws \CiviCRM_API3_Exception
830 public static function getAllMembershipTypes(): array {
831 $cacheString = __CLASS__
. __FUNCTION__
. CRM_Core_Config
::domainID() . '_' . CRM_Core_I18n
::getLocale();
832 if (!Civi
::cache('metadata')->has($cacheString)) {
833 $types = civicrm_api3('MembershipType', 'get', ['options' => ['limit' => 0, 'sort' => 'weight']])['values'];
834 $taxRates = CRM_Core_PseudoConstant
::getTaxRates();
835 $keys = ['description', 'relationship_type_id', 'relationship_direction', 'max_related', 'auto_renew'];
836 // In order to avoid down-stream e-notices we undo api v3 filtering of NULL values. This is covered
837 // in Unit tests & ideally we might switch to apiv4 but I would argue we should build caching
838 // of metadata entities like this directly into apiv4.
839 foreach ($types as $id => $type) {
840 foreach ($keys as $key) {
841 if (!isset($type[$key])) {
842 $types[$id][$key] = NULL;
845 if (isset($type['contribution_type_id'])) {
846 unset($types[$id]['contribution_type_id']);
848 $types[$id]['tax_rate'] = (float) ($taxRates[$type['financial_type_id']] ??
0.0);
850 if ($types[$id]['tax_rate'] !== 0.0) {
851 $multiplier +
= ($types[$id]['tax_rate'] / 100);
853 if (!array_key_exists('minimum_fee', $types[$id])) {
854 $types[$id]['minimum_fee'] = 0;
856 $types[$id]['minimum_fee_with_tax'] = (float) $types[$id]['minimum_fee'] * $multiplier;
858 Civi
::cache('metadata')->set($cacheString, $types);
860 return Civi
::cache('metadata')->get($cacheString);
864 * Get a specific membership type (leveraging the cache).
869 * @throws \CiviCRM_API3_Exception
871 public static function getMembershipType($id) {
872 return self
::getAllMembershipTypes()[$id];