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 = [];
30 public function __construct() {
31 parent
::__construct();
35 * Fetch object based on array of properties.
37 * @param array $params
38 * (reference ) an assoc array of name/value pairs.
39 * @param array $defaults
40 * (reference ) an assoc array to hold the flattened values.
42 * @return CRM_Member_BAO_MembershipType
44 public static function retrieve(&$params, &$defaults) {
45 $membershipType = new CRM_Member_DAO_MembershipType();
46 $membershipType->copyValues($params);
47 if ($membershipType->find(TRUE)) {
48 CRM_Core_DAO
::storeValues($membershipType, $defaults);
49 return $membershipType;
55 * Update the is_active flag in the db.
58 * Id of the database record.
59 * @param bool $is_active
60 * Value we want to set the is_active field.
63 * true if we found and updated the object, else false
65 public static function setIsActive($id, $is_active) {
66 return CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_MembershipType', $id, 'is_active', $is_active);
70 * Add the membership types.
72 * @param array $params
73 * Reference array contains the values submitted by the form.
75 * Array contains the id (deprecated).
77 * @return \CRM_Member_DAO_MembershipType
78 * @throws \CiviCRM_API3_Exception
80 public static function add(&$params, $ids = []) {
81 // DEPRECATED Check if membershipType ID was passed in via $ids
82 if (empty($params['id'])) {
83 if (isset($ids['membershipType'])) {
84 Civi
::log()->warning('Deprecated: Passing membershipType by $ids array in CRM_Member_BAO_MembershipType::add');
86 $params['id'] = $ids['membershipType'] ??
NULL;
89 $hook = empty($params['id']) ?
'create' : 'edit';
90 CRM_Utils_Hook
::pre($hook, 'MembershipType', CRM_Utils_Array
::value('id', $params), $params);
92 $membershipTypeId = $params['id'] ??
NULL;
94 if (!$membershipTypeId) {
95 if (!isset($params['is_active'])) {
97 $params['is_active'] = FALSE;
99 if (!isset($params['domain_id'])) {
100 $params['domain_id'] = CRM_Core_Config
::domainID();
104 // $previousID is the old organization id for membership type i.e 'member_of_contact_id'. This is used when an organization is changed.
106 if ($membershipTypeId) {
107 $previousID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $membershipTypeId, 'member_of_contact_id');
110 // action is taken depending upon the mode
111 $membershipType = new CRM_Member_DAO_MembershipType();
112 $membershipType->copyValues($params);
113 $membershipType->save();
115 if ($membershipTypeId) {
116 // on update we may need to retrieve some details for the price field function - otherwise we get e-notices on attempts to retrieve
117 // name etc - the presence of previous id tells us this is an update
118 $params = array_merge(civicrm_api3('membership_type', 'getsingle', ['id' => $membershipType->id
]), $params);
120 self
::createMembershipPriceField($params, $previousID, $membershipType->id
);
121 // update all price field value for quick config when membership type is set CRM-11718
122 if ($membershipTypeId) {
123 self
::updateAllPriceFieldValue($membershipTypeId, $params);
126 CRM_Utils_Hook
::post($hook, 'MembershipType', $membershipType->id
, $membershipType);
129 return $membershipType;
133 * Flush anywhere that membership types might be cached.
135 * @throws \CiviCRM_API3_Exception
137 public static function flush() {
138 CRM_Member_PseudoConstant
::membershipType(NULL, TRUE);
139 civicrm_api3('membership', 'getfields', ['cache_clear' => 1, 'fieldname' => 'membership_type_id']);
140 civicrm_api3('profile', 'getfields', ['action' => 'submit', 'cache_clear' => 1]);
141 Civi
::cache('metadata')->clear();
145 * Delete membership Types.
147 * @param int $membershipTypeId
150 * @throws CRM_Core_Exception
153 public static function del($membershipTypeId) {
155 static::deleteRecord(['id' => $membershipTypeId]);
158 catch (CRM_Core_Exception
$e) {
164 * Callback for hook_civicrm_pre().
165 * @param \Civi\Core\Event\PreEvent $event
166 * @throws CRM_Core_Exception
168 public static function on_hook_civicrm_pre(\Civi\Core\Event\PreEvent
$event) {
169 if ($event->action
=== 'delete' && $event->entity
=== 'RelationshipType') {
170 // When deleting relationship type, remove from membership types
171 $mems = civicrm_api3('MembershipType', 'get', [
172 'relationship_type_id' => ['LIKE' => "%{$event->id}%"],
173 'return' => ['id', 'relationship_type_id', 'relationship_direction'],
175 foreach ($mems['values'] as $membershipType) {
176 $pos = array_search($event->id
, $membershipType['relationship_type_id']);
177 // Api call may have returned false positives but currently the relationship_type_id uses
178 // nonstandard serialization which makes anything more accurate impossible.
179 if ($pos !== FALSE) {
180 unset($membershipType['relationship_type_id'][$pos], $membershipType['relationship_direction'][$pos]);
181 civicrm_api3('MembershipType', 'create', $membershipType);
185 if ($event->action
=== 'delete' && $event->entity
=== 'MembershipType') {
186 // Check dependencies.
190 'Membership' => 'membership_type_id',
191 'MembershipBlock' => 'membership_type_default',
194 foreach ($dependency as $name => $field) {
195 $baoString = 'CRM_Member_BAO_' . $name;
196 $dao = new $baoString();
197 $dao->$field = $event->id
;
198 if ($dao->find(TRUE)) {
205 $message = ts('This membership type cannot be deleted due to following reason(s):');
206 if (in_array('Membership', $status)) {
207 $findMembersURL = CRM_Utils_System
::url('civicrm/member/search', 'reset=1');
208 $deleteURL = CRM_Utils_System
::url('civicrm/contact/search/advanced', 'reset=1');
209 $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".', [
210 1 => $findMembersURL,
217 if (in_array('MembershipBlock', $status)) {
218 $deleteURL = CRM_Utils_System
::url('civicrm/admin/contribute', 'reset=1');
219 $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.', [
223 throw new CRM_Core_Exception($message);
226 CRM_Utils_Weight
::delWeight('CRM_Member_DAO_MembershipType', $event->id
);
231 * Convert membership type's 'start day' & 'rollover day' to human readable formats.
233 * @param array $membershipType
234 * An array of membershipType-details.
236 public static function convertDayFormat(&$membershipType) {
238 'fixed_period_start_day',
239 'fixed_period_rollover_day',
241 foreach ($membershipType as $id => $details) {
242 foreach ($periodDays as $pDay) {
243 if (!empty($details[$pDay])) {
244 if ($details[$pDay] > 31) {
245 $month = substr($details[$pDay], 0, strlen($details[$pDay]) - 2);
246 $day = substr($details[$pDay], -2);
261 $membershipType[$id][$pDay] = $monthMap[$month] . ' ' . $day;
264 $membershipType[$id][$pDay] = $details[$pDay];
272 * Get membership Types.
274 * @deprecated use getAllMembershipTypes.
276 * @param bool $public
280 public static function getMembershipTypes($public = TRUE) {
281 $membershipTypes = [];
282 $membershipType = new CRM_Member_DAO_MembershipType();
283 $membershipType->is_active
= 1;
285 $membershipType->visibility
= 'Public';
287 $membershipType->orderBy(' weight');
288 $membershipType->find();
289 while ($membershipType->fetch()) {
290 $membershipTypes[$membershipType->id
] = $membershipType->name
;
292 return $membershipTypes;
296 * Get membership Type Details.
298 * @deprecated use getMembershipType.
300 * @param int $membershipTypeId
304 public static function getMembershipTypeDetails($membershipTypeId) {
305 $membershipTypeDetails = [];
307 $membershipType = new CRM_Member_DAO_MembershipType();
308 $membershipType->is_active
= 1;
309 $membershipType->id
= $membershipTypeId;
310 if ($membershipType->find(TRUE)) {
311 CRM_Core_DAO
::storeValues($membershipType, $membershipTypeDetails);
312 return $membershipTypeDetails;
320 * Calculate start date and end date for new membership.
322 * @param int $membershipTypeId
323 * Membership type id.
324 * @param string $joinDate
325 * Member since ( in mysql date format ).
326 * @param string $startDate
327 * Start date ( in mysql date format ).
328 * @param null $endDate
329 * @param int $numRenewTerms
330 * How many membership terms are being added to end date (default is 1).
333 * associated array with start date, end date and join date for the membership
335 public static function getDatesForMembershipType($membershipTypeId, $joinDate = NULL, $startDate = NULL, $endDate = NULL, $numRenewTerms = 1) {
336 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipTypeId);
338 // Convert all dates to 'Y-m-d' format.
344 if (!empty($
$dateParam)) {
345 $
$dateParam = CRM_Utils_Date
::processDate($
$dateParam, NULL, FALSE, 'Y-m-d');
349 $joinDate = CRM_Utils_Time
::date('Y-m-d');
351 $actualStartDate = $joinDate;
353 $actualStartDate = $startDate;
356 $fixed_period_rollover = FALSE;
357 if (CRM_Utils_Array
::value('period_type', $membershipTypeDetails) == 'rolling') {
359 $startDate = $joinDate;
361 $actualStartDate = $startDate;
363 elseif (CRM_Utils_Array
::value('period_type', $membershipTypeDetails) == 'fixed') {
364 // calculate start date
365 // if !$startDate then use $joinDate
366 $toDay = explode('-', (empty($startDate) ?
$joinDate : $startDate));
371 if ($membershipTypeDetails['duration_unit'] == 'year') {
373 //get start fixed day
374 $startMonth = substr($membershipTypeDetails['fixed_period_start_day'], 0,
375 strlen($membershipTypeDetails['fixed_period_start_day']) - 2
377 $startDay = substr($membershipTypeDetails['fixed_period_start_day'], -2);
379 if (date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year)) <= date('Y-m-d', mktime(0, 0, 0, $month, $day, $year))) {
380 $actualStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year));
383 $actualStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year - 1));
386 $fixed_period_rollover = self
::isDuringFixedAnnualRolloverPeriod($joinDate, $membershipTypeDetails, $year, $actualStartDate);
389 $startDate = $actualStartDate;
392 elseif ($membershipTypeDetails['duration_unit'] == 'month') {
393 // Check if we are on or after rollover day of the month - CRM-10585
394 // If so, set fixed_period_rollover TRUE so we increment end_date month below.
395 $dateParts = explode('-', $actualStartDate);
396 if ($dateParts[2] >= $membershipTypeDetails['fixed_period_rollover_day']) {
397 $fixed_period_rollover = TRUE;
400 // Start date is always first day of actualStartDate month
402 $actualStartDate = $startDate = $year . '-' . $month . '-01';
407 // Calculate end date if it is not passed by user.
409 //end date calculation
410 $date = explode('-', $actualStartDate);
415 switch ($membershipTypeDetails['duration_unit']) {
417 $year = $year +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
418 //extend membership date by duration interval.
419 if ($fixed_period_rollover) {
425 $month = $month +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
426 //duration interval is month
427 if ($fixed_period_rollover) {
434 $day = $day +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
436 if ($fixed_period_rollover) {
437 //Fix Me: Currently we don't allow rollover if
438 //duration interval is day
443 if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
447 $endDate = date('Y-m-d', mktime(0, 0, 0, $month, $day - 1, $year));
452 'start_date' => CRM_Utils_Date
::customFormat($startDate, '%Y%m%d'),
453 'end_date' => CRM_Utils_Date
::customFormat($endDate, '%Y%m%d'),
454 'join_date' => CRM_Utils_Date
::customFormat($joinDate, '%Y%m%d'),
457 return $membershipDates;
461 * Does this membership start between the rollover date and the start of the next period.
462 * (in which case they will get an extra membership period)
463 * ie if annual memberships run June - May & the rollover is in May memberships between
464 * May and June will return TRUE and between June and May will return FALSE
466 * @param string $startDate start date of current membership period
467 * @param array $membershipTypeDetails
469 * @param string $actualStartDate
470 * @return bool is this in the window where the membership gets an extra part-period added
472 public static function isDuringFixedAnnualRolloverPeriod($startDate, $membershipTypeDetails, $year, $actualStartDate) {
474 $rolloverMonth = substr($membershipTypeDetails['fixed_period_rollover_day'], 0,
475 strlen($membershipTypeDetails['fixed_period_rollover_day']) - 2
477 $rolloverDay = substr($membershipTypeDetails['fixed_period_rollover_day'], -2);
479 $calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year));
481 //CRM-7825 -membership date rules are :
482 //1. Membership should not be start in future.
483 //2. rollover window should be subset of membership window.
485 //get the fixed end date here.
486 $dateParts = explode('-', $actualStartDate);
487 $endDateOfFirstYearMembershipPeriod = date('Y-m-d', mktime(0, 0, 0,
493 //we know the month and day of the rollover date but not the year (we're just
494 //using the start date year at the moment. So if it's after the end
495 // of the first year of membership then it's the next period & we'll adjust back a year. If it's
496 // before the start_date then it's too early & we'll adjust forward.
497 if ($endDateOfFirstYearMembershipPeriod < $calculatedRolloverDate) {
498 $calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year - 1));
500 if ($calculatedRolloverDate < $actualStartDate) {
501 $calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year +
1));
504 if ($calculatedRolloverDate <= $startDate) {
511 * Calculate start date and end date for membership updates.
513 * Note that this function is called by the api for any membership update although it was
514 * originally written for renewal (which feels a bit fragile but hey....).
516 * @param int $membershipId
517 * @param $changeToday
518 * If provided, specify an alternative date to use as "today" for renewal
519 * @param int $membershipTypeID
520 * If provided, overrides the membership type of the $membershipID membership.
521 * @param int $numRenewTerms
522 * How many membership terms are being added to end date (default is 1).
524 * CRM-7297 Membership Upsell - Added $membershipTypeID param to facilitate calculations of dates when membership type changes
527 * array fo the start date, end date and join date of the membership
529 public static function getRenewalDatesForMembershipType($membershipId, $changeToday = NULL, $membershipTypeID = NULL, $numRenewTerms = 1) {
530 $params = ['id' => $membershipId];
531 $membershipDetails = CRM_Member_BAO_Membership
::getValues($params, $values);
532 $membershipDetails = $membershipDetails[$membershipId];
533 $statusID = $membershipDetails->status_id
;
534 $membershipDates = [];
535 if (!empty($membershipDetails->join_date
)) {
536 $membershipDates['join_date'] = CRM_Utils_Date
::customFormat($membershipDetails->join_date
, '%Y%m%d');
539 $oldPeriodType = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
540 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id'), 'period_type');
542 // CRM-7297 Membership Upsell
543 if (is_null($membershipTypeID)) {
544 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipDetails->membership_type_id
);
547 $membershipTypeDetails = self
::getMembershipTypeDetails($membershipTypeID);
549 $statusDetails = CRM_Member_BAO_MembershipStatus
::getMembershipStatus($statusID);
551 if ($statusDetails['is_current_member'] == 1) {
552 $startDate = $membershipDetails->start_date
;
553 // CRM=7297 Membership Upsell: we need to handle null end_date in case we are switching
554 // from a lifetime to a different membership type
555 if (is_null($membershipDetails->end_date
)) {
556 $date = CRM_Utils_Time
::date('Y-m-d');
559 $date = $membershipDetails->end_date
;
561 $date = explode('-', $date);
562 // We have to add 1 day first in case it's the end of the month, then subtract afterwards
563 // eg. 2018-02-28 should renew to 2018-03-31, if we just added 1 month we'd get 2018-03-28
564 $logStartDate = date('Y-m-d', mktime(0, 0, 0,
566 (double) ($date[2] +
1),
570 $date = explode('-', $logStartDate);
575 switch ($membershipTypeDetails['duration_unit']) {
577 //need to check if the upsell is from rolling to fixed and adjust accordingly
578 if ($membershipTypeDetails['period_type'] == 'fixed' && $oldPeriodType == 'rolling') {
579 $month = substr($membershipTypeDetails['fixed_period_start_day'], 0, strlen($membershipTypeDetails['fixed_period_start_day']) - 2);
580 $day = substr($membershipTypeDetails['fixed_period_start_day'], -2);
584 $year = $year +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
589 $month = $month +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
593 $day = $day +
($numRenewTerms * $membershipTypeDetails['duration_interval']);
596 if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
600 $endDate = date('Y-m-d', mktime(0, 0, 0,
606 $today = CRM_Utils_Time
::date('Y-m-d');
607 $membershipDates['today'] = CRM_Utils_Date
::customFormat($today, '%Y%m%d');
608 $membershipDates['start_date'] = CRM_Utils_Date
::customFormat($startDate, '%Y%m%d');
609 $membershipDates['end_date'] = CRM_Utils_Date
::customFormat($endDate, '%Y%m%d');
610 $membershipDates['log_start_date'] = CRM_Utils_Date
::customFormat($logStartDate, '%Y%m%d');
613 $today = CRM_Utils_Time
::date('Y-m-d');
615 $today = CRM_Utils_Date
::processDate($changeToday, NULL, FALSE, 'Y-m-d');
617 // Calculate new start/end dates when join date is today
618 $renewalDates = self
::getDatesForMembershipType($membershipTypeDetails['id'],
619 $today, NULL, NULL, $numRenewTerms
621 $membershipDates['today'] = CRM_Utils_Date
::customFormat($today, '%Y%m%d');
622 $membershipDates['start_date'] = $renewalDates['start_date'];
623 $membershipDates['end_date'] = $renewalDates['end_date'];
624 $membershipDates['log_start_date'] = $renewalDates['start_date'];
625 // CRM-18503 - set join_date as today in case the membership type is fixed.
626 if ($membershipTypeDetails['period_type'] == 'fixed' && !isset($membershipDates['join_date'])) {
627 $membershipDates['join_date'] = $renewalDates['join_date'];
630 if (!isset($membershipDates['join_date'])) {
631 $membershipDates['join_date'] = $membershipDates['start_date'];
634 return $membershipDates;
638 * Retrieve all Membership Types with Member of Contact id.
640 * @param array $membershipTypes
641 * array of membership type ids
643 * array of the details of membership types with Member of Contact id
645 public static function getMemberOfContactByMemTypes($membershipTypes) {
646 $memTypeOrganizations = [];
647 if (empty($membershipTypes)) {
648 return $memTypeOrganizations;
651 $result = CRM_Core_DAO
::executeQuery("SELECT id, member_of_contact_id FROM civicrm_membership_type WHERE id IN (" . implode(',', $membershipTypes) . ")");
652 while ($result->fetch()) {
653 $memTypeOrganizations[$result->id
] = $result->member_of_contact_id
;
656 return $memTypeOrganizations;
660 * The function returns all the Organization for all membershipTypes .
662 * @param int $membershipTypeId
666 public static function getMembershipTypeOrganization($membershipTypeId = NULL) {
667 $allMembershipTypes = [];
669 $membershipType = new CRM_Member_DAO_MembershipType();
671 if (isset($membershipTypeId)) {
672 $membershipType->id
= $membershipTypeId;
674 $membershipType->find();
676 while ($membershipType->fetch()) {
677 $allMembershipTypes[$membershipType->id
] = $membershipType->member_of_contact_id
;
679 return $allMembershipTypes;
683 * Function to retrieve organization and associated membership
687 * arrays of organization and membership types
690 public static function getMembershipTypeInfo() {
691 if (!self
::$_membershipTypeInfo) {
694 $query = 'SELECT memType.id, memType.name, memType.member_of_contact_id, c.sort_name
695 FROM civicrm_membership_type memType INNER JOIN civicrm_contact c ON c.id = memType.member_of_contact_id
696 WHERE memType.is_active = 1 ';
697 $dao = CRM_Core_DAO
::executeQuery($query);
698 while ($dao->fetch()) {
699 $orgs[$dao->member_of_contact_id
] = $dao->sort_name
;
700 $types[$dao->member_of_contact_id
][$dao->id
] = $dao->name
;
703 self
::$_membershipTypeInfo = [$orgs, $types];
705 return self
::$_membershipTypeInfo;
709 * @param array $params
710 * @param int $previousID
711 * @param int $membershipTypeId
713 public static function createMembershipPriceField($params, $previousID, $membershipTypeId) {
715 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
717 if (!empty($params['member_of_contact_id'])) {
718 $fieldName = $params['member_of_contact_id'];
721 $fieldName = $previousID;
723 $fieldLabel = 'Membership Amount';
726 'price_set_id ' => $priceSetId,
727 'name' => $fieldName,
730 CRM_Price_BAO_PriceField
::retrieve($fieldParams, $results);
731 if (empty($results)) {
733 $fieldParams['label'] = $fieldLabel;
734 $fieldParams['name'] = $fieldName;
735 $fieldParams['price_set_id'] = $priceSetId;
736 $fieldParams['html_type'] = 'Radio';
737 $fieldParams['is_display_amounts'] = $fieldParams['is_required'] = 0;
738 $fieldParams['weight'] = $fieldParams['option_weight'][1] = 1;
739 $fieldParams['option_label'][1] = $params['name'];
740 $fieldParams['option_description'][1] = $params['description'] ??
NULL;
742 $fieldParams['membership_type_id'][1] = $membershipTypeId;
743 $fieldParams['option_amount'][1] = empty($params['minimum_fee']) ?
0 : $params['minimum_fee'];
744 $fieldParams['financial_type_id'] = $params['financial_type_id'] ??
NULL;
747 CRM_Member_Form_MembershipType
::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
748 $fieldParams['option_id'] = $optionsIds['option_id'] ??
NULL;
750 CRM_Price_BAO_PriceField
::create($fieldParams);
753 $fieldID = $results['id'];
754 $fieldValueParams = [
755 'price_field_id' => $fieldID,
756 'membership_type_id' => $membershipTypeId,
759 CRM_Price_BAO_PriceFieldValue
::retrieve($fieldValueParams, $results);
760 if (!empty($results)) {
761 $results['label'] = $results['name'] = $params['name'];
762 $results['amount'] = empty($params['minimum_fee']) ?
0 : $params['minimum_fee'];
766 'price_field_id' => $fieldID,
767 'name' => $params['name'],
768 'label' => $params['name'],
769 'amount' => empty($params['minimum_fee']) ?
0 : $params['minimum_fee'],
770 'membership_type_id' => $membershipTypeId,
776 CRM_Member_Form_MembershipType
::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
777 if (!empty($optionsIds['option_id'])) {
778 $results['id'] = current($optionsIds['option_id']);
781 $results['financial_type_id'] = $params['financial_type_id'] ??
NULL;
782 $results['description'] = $params['description'] ??
NULL;
783 CRM_Price_BAO_PriceFieldValue
::add($results);
788 * This function updates all price field value for quick config
789 * price set which has membership type
791 * @param int $membershipTypeId membership type id
793 * @param array $params
795 public static function updateAllPriceFieldValue($membershipTypeId, $params) {
798 'financial_type_id' => 'financial_type_id',
800 'minimum_fee' => 'amount',
801 'description' => 'description',
802 'visibility' => 'visibility_id',
804 $priceFieldValueBAO = new CRM_Price_BAO_PriceFieldValue();
805 $priceFieldValueBAO->membership_type_id
= $membershipTypeId;
806 $priceFieldValueBAO->find();
807 while ($priceFieldValueBAO->fetch()) {
809 'id' => $priceFieldValueBAO->id
,
810 'price_field_id' => $priceFieldValueBAO->price_field_id
,
812 //Get priceset details.
813 $fieldParams = ['fid' => $priceFieldValueBAO->price_field_id
];
814 $setID = CRM_Price_BAO_PriceSet
::getSetId($fieldParams);
815 $setParams = ['id' => $setID];
816 $setValues = CRM_Price_BAO_PriceSet
::retrieve($setParams, $defaults);
817 if (!empty($setValues->is_quick_config
) && $setValues->name
!= 'default_membership_type_amount') {
818 foreach ($fieldsToUpdate as $key => $value) {
819 if ($value == 'visibility_id' && !empty($params['visibility'])) {
820 $updateParams['visibility_id'] = CRM_Price_BAO_PriceField
::getVisibilityOptionID(strtolower($params['visibility']));
823 $updateParams[$value] = $params[$key] ??
NULL;
826 CRM_Price_BAO_PriceFieldValue
::add($updateParams);
832 * Cached wrapper for membership types.
834 * Since this is used from the batched script caching helps.
836 * Caching is by domain - if that hits any issues we should add a new function getDomainMembershipTypes
837 * or similar rather than 'just add another param'! but this is closer to earlier behaviour so 'should' be OK.
840 * List of membershipType details keyed by membershipTypeID
841 * @throws \CiviCRM_API3_Exception
843 public static function getAllMembershipTypes(): array {
844 $cacheString = __CLASS__
. __FUNCTION__
. CRM_Core_Config
::domainID() . '_' . CRM_Core_I18n
::getLocale();
845 if (!Civi
::cache('metadata')->has($cacheString)) {
846 $types = civicrm_api3('MembershipType', 'get', ['options' => ['limit' => 0, 'sort' => 'weight']])['values'];
847 $taxRates = CRM_Core_PseudoConstant
::getTaxRates();
848 $keys = ['description', 'relationship_type_id', 'relationship_direction', 'max_related', 'auto_renew'];
849 // In order to avoid down-stream e-notices we undo api v3 filtering of NULL values. This is covered
850 // in Unit tests & ideally we might switch to apiv4 but I would argue we should build caching
851 // of metadata entities like this directly into apiv4.
852 foreach ($types as $id => $type) {
853 foreach ($keys as $key) {
854 if (!isset($type[$key])) {
855 $types[$id][$key] = NULL;
858 if (isset($type['contribution_type_id'])) {
859 unset($types[$id]['contribution_type_id']);
861 $types[$id]['tax_rate'] = (float) ($taxRates[$type['financial_type_id']] ??
0.0);
863 if ($types[$id]['tax_rate'] !== 0.0) {
864 $multiplier +
= ($types[$id]['tax_rate'] / 100);
866 if (!array_key_exists('minimum_fee', $types[$id])) {
867 $types[$id]['minimum_fee'] = 0;
869 $types[$id]['minimum_fee_with_tax'] = (float) $types[$id]['minimum_fee'] * $multiplier;
871 Civi
::cache('metadata')->set($cacheString, $types);
873 return Civi
::cache('metadata')->get($cacheString);
877 * Get a specific membership type (leveraging the cache).
882 * @throws \CiviCRM_API3_Exception
884 public static function getMembershipType($id) {
885 return self
::getAllMembershipTypes()[$id];