CRM/Member/BAO/MembershipType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
  18
  19   /**
  20    * Static holder for the default Membership Type.
  21    * @var int
  22    */
  23   public static $_defaultMembershipType = NULL;
  24
  25   public static $_membershipTypeInfo = [];
  26
  27   /**
  28    * Class constructor.
  29    */
  30   public function __construct() {
  31     parent::__construct();
  32   }
  33
  34   /**
  35    * Fetch object based on array of properties.
  36    *
  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.
  41    *
  42    * @return CRM_Member_BAO_MembershipType
  43    */
  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;
  50     }
  51     return NULL;
  52   }
  53
  54   /**
  55    * Update the is_active flag in the db.
  56    *
  57    * @param int $id
  58    *   Id of the database record.
  59    * @param bool $is_active
  60    *   Value we want to set the is_active field.
  61    *
  62    * @return bool
  63    *   true if we found and updated the object, else false
  64    */
  65   public static function setIsActive($id, $is_active) {
  66     return CRM_Core_DAO::setFieldValue('CRM_Member_DAO_MembershipType', $id, 'is_active', $is_active);
  67   }
  68
  69   /**
  70    * Add the membership types.
  71    *
  72    * @param array $params
  73    *   Reference array contains the values submitted by the form.
  74    * @param array $ids
  75    *   Array contains the id (deprecated).
  76    *
  77    * @return \CRM_Member_DAO_MembershipType
  78    * @throws \CiviCRM_API3_Exception
  79    */
  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');
  85       }
  86       $params['id'] = $ids['membershipType'] ?? NULL;
  87     }
  88
  89     $hook = empty($params['id']) ? 'create' : 'edit';
  90     CRM_Utils_Hook::pre($hook, 'MembershipType', CRM_Utils_Array::value('id', $params), $params);
  91
  92     $membershipTypeId = $params['id'] ?? NULL;
  93
  94     if (!$membershipTypeId) {
  95       if (!isset($params['is_active'])) {
  96         // do we need this?
  97         $params['is_active'] = FALSE;
  98       }
  99       if (!isset($params['domain_id'])) {
 100         $params['domain_id'] = CRM_Core_Config::domainID();
 101       }
 102     }
 103
 104     // $previousID is the old organization id for membership type i.e 'member_of_contact_id'. This is used when an organization is changed.
 105     $previousID = NULL;
 106     if ($membershipTypeId) {
 107       $previousID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $membershipTypeId, 'member_of_contact_id');
 108     }
 109
 110     // action is taken depending upon the mode
 111     $membershipType = new CRM_Member_DAO_MembershipType();
 112     $membershipType->copyValues($params);
 113     $membershipType->save();
 114
 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);
 119     }
 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);
 124     }
 125
 126     CRM_Utils_Hook::post($hook, 'MembershipType', $membershipType->id, $membershipType);
 127
 128     self::flush();
 129     return $membershipType;
 130   }
 131
 132   /**
 133    * Flush anywhere that membership types might be cached.
 134    *
 135    * @throws \CiviCRM_API3_Exception
 136    */
 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();
 142   }
 143
 144   /**
 145    * Delete membership Types.
 146    *
 147    * @param int $membershipTypeId
 148    *
 149    * @throws CRM_Core_Exception
 150    * @return bool|mixed
 151    */
 152   public static function del($membershipTypeId) {
 153     // Check dependencies.
 154     $check = FALSE;
 155     $status = [];
 156     $dependency = [
 157       'Membership' => 'membership_type_id',
 158       'MembershipBlock' => 'membership_type_default',
 159     ];
 160
 161     foreach ($dependency as $name => $field) {
 162       $baoString = 'CRM_Member_BAO_' . $name;
 163       $dao = new $baoString();
 164       $dao->$field = $membershipTypeId;
 165       /** @noinspection PhpUndefinedMethodInspection */
 166       if ($dao->find(TRUE)) {
 167         $check = TRUE;
 168         $status[] = $name;
 169       }
 170     }
 171     if ($check) {
 172       $cnt = 1;
 173       $message = ts('This membership type cannot be deleted due to following reason(s):');
 174       if (in_array('Membership', $status)) {
 175         $findMembersURL = CRM_Utils_System::url('civicrm/member/search', 'reset=1');
 176         $deleteURL = CRM_Utils_System::url('civicrm/contact/search/advanced', 'reset=1');
 177         $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".', [
 178           1 => $findMembersURL,
 179           2 => $deleteURL,
 180           3 => $cnt,
 181         ]);
 182         $cnt++;
 183       }
 184
 185       if (in_array('MembershipBlock', $status)) {
 186         $deleteURL = CRM_Utils_System::url('civicrm/admin/contribute', 'reset=1');
 187         $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.', [
 188           1 => $deleteURL,
 189           2 => $cnt,
 190         ]);
 191         throw new CRM_Core_Exception($message);
 192       }
 193     }
 194     CRM_Utils_Weight::delWeight('CRM_Member_DAO_MembershipType', $membershipTypeId);
 195     //delete from membership Type table
 196     $membershipType = new CRM_Member_DAO_MembershipType();
 197     $membershipType->id = $membershipTypeId;
 198
 199     //fix for membership type delete api
 200     $result = FALSE;
 201     if ($membershipType->find(TRUE)) {
 202       return $membershipType->delete();
 203     }
 204
 205     return $result;
 206   }
 207
 208   /**
 209    * Convert membership type's 'start day' & 'rollover day' to human readable formats.
 210    *
 211    * @param array $membershipType
 212    *   An array of membershipType-details.
 213    */
 214   public static function convertDayFormat(&$membershipType) {
 215     $periodDays = [
 216       'fixed_period_start_day',
 217       'fixed_period_rollover_day',
 218     ];
 219     foreach ($membershipType as $id => $details) {
 220       foreach ($periodDays as $pDay) {
 221         if (!empty($details[$pDay])) {
 222           if ($details[$pDay] > 31) {
 223             $month = substr($details[$pDay], 0, strlen($details[$pDay]) - 2);
 224             $day = substr($details[$pDay], -2);
 225             $monthMap = [
 226               '1' => 'Jan',
 227               '2' => 'Feb',
 228               '3' => 'Mar',
 229               '4' => 'Apr',
 230               '5' => 'May',
 231               '6' => 'Jun',
 232               '7' => 'Jul',
 233               '8' => 'Aug',
 234               '9' => 'Sep',
 235               '10' => 'Oct',
 236               '11' => 'Nov',
 237               '12' => 'Dec',
 238             ];
 239             $membershipType[$id][$pDay] = $monthMap[$month] . ' ' . $day;
 240           }
 241           else {
 242             $membershipType[$id][$pDay] = $details[$pDay];
 243           }
 244         }
 245       }
 246     }
 247   }
 248
 249   /**
 250    * Get membership Types.
 251    *
 252    * @deprecated  use getAllMembershipTypes.
 253    *
 254    * @param bool $public
 255    *
 256    * @return array
 257    */
 258   public static function getMembershipTypes($public = TRUE) {
 259     $membershipTypes = [];
 260     $membershipType = new CRM_Member_DAO_MembershipType();
 261     $membershipType->is_active = 1;
 262     if ($public) {
 263       $membershipType->visibility = 'Public';
 264     }
 265     $membershipType->orderBy(' weight');
 266     $membershipType->find();
 267     while ($membershipType->fetch()) {
 268       $membershipTypes[$membershipType->id] = $membershipType->name;
 269     }
 270     return $membershipTypes;
 271   }
 272
 273   /**
 274    * Get membership Type Details.
 275    *
 276    * @deprecated use getMembershipType.
 277    *
 278    * @param int $membershipTypeId
 279    *
 280    * @return array|null
 281    */
 282   public static function getMembershipTypeDetails($membershipTypeId) {
 283     $membershipTypeDetails = [];
 284
 285     $membershipType = new CRM_Member_DAO_MembershipType();
 286     $membershipType->is_active = 1;
 287     $membershipType->id = $membershipTypeId;
 288     if ($membershipType->find(TRUE)) {
 289       CRM_Core_DAO::storeValues($membershipType, $membershipTypeDetails);
 290       return $membershipTypeDetails;
 291     }
 292     else {
 293       return NULL;
 294     }
 295   }
 296
 297   /**
 298    * Calculate start date and end date for new membership.
 299    *
 300    * @param int $membershipTypeId
 301    *   Membership type id.
 302    * @param string $joinDate
 303    *   Member since ( in mysql date format ).
 304    * @param string $startDate
 305    *   Start date ( in mysql date format ).
 306    * @param null $endDate
 307    * @param int $numRenewTerms
 308    *   How many membership terms are being added to end date (default is 1).
 309    *
 310    * @return array
 311    *   associated array with  start date, end date and join date for the membership
 312    */
 313   public static function getDatesForMembershipType($membershipTypeId, $joinDate = NULL, $startDate = NULL, $endDate = NULL, $numRenewTerms = 1) {
 314     $membershipTypeDetails = self::getMembershipTypeDetails($membershipTypeId);
 315
 316     // Convert all dates to 'Y-m-d' format.
 317     foreach ([
 318       'joinDate',
 319       'startDate',
 320       'endDate',
 321     ] as $dateParam) {
 322       if (!empty($$dateParam)) {
 323         $$dateParam = CRM_Utils_Date::processDate($$dateParam, NULL, FALSE, 'Y-m-d');
 324       }
 325     }
 326     if (!$joinDate) {
 327       $joinDate = CRM_Utils_Time::date('Y-m-d');
 328     }
 329     $actualStartDate = $joinDate;
 330     if ($startDate) {
 331       $actualStartDate = $startDate;
 332     }
 333
 334     $fixed_period_rollover = FALSE;
 335     if (CRM_Utils_Array::value('period_type', $membershipTypeDetails) == 'rolling') {
 336       if (!$startDate) {
 337         $startDate = $joinDate;
 338       }
 339       $actualStartDate = $startDate;
 340     }
 341     elseif (CRM_Utils_Array::value('period_type', $membershipTypeDetails) == 'fixed') {
 342       // calculate start date
 343       // if !$startDate then use $joinDate
 344       $toDay = explode('-', (empty($startDate) ? $joinDate : $startDate));
 345       $year = $toDay[0];
 346       $month = $toDay[1];
 347       $day = $toDay[2];
 348
 349       if ($membershipTypeDetails['duration_unit'] == 'year') {
 350
 351         //get start fixed day
 352         $startMonth = substr($membershipTypeDetails['fixed_period_start_day'], 0,
 353           strlen($membershipTypeDetails['fixed_period_start_day']) - 2
 354         );
 355         $startDay = substr($membershipTypeDetails['fixed_period_start_day'], -2);
 356
 357         if (date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year)) <= date('Y-m-d', mktime(0, 0, 0, $month, $day, $year))) {
 358           $actualStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year));
 359         }
 360         else {
 361           $actualStartDate = date('Y-m-d', mktime(0, 0, 0, $startMonth, $startDay, $year - 1));
 362         }
 363
 364         $fixed_period_rollover = self::isDuringFixedAnnualRolloverPeriod($joinDate, $membershipTypeDetails, $year, $actualStartDate);
 365
 366         if (!$startDate) {
 367           $startDate = $actualStartDate;
 368         }
 369       }
 370       elseif ($membershipTypeDetails['duration_unit'] == 'month') {
 371         // Check if we are on or after rollover day of the month - CRM-10585
 372         // If so, set fixed_period_rollover TRUE so we increment end_date month below.
 373         $dateParts = explode('-', $actualStartDate);
 374         if ($dateParts[2] >= $membershipTypeDetails['fixed_period_rollover_day']) {
 375           $fixed_period_rollover = TRUE;
 376         }
 377
 378         // Start date is always first day of actualStartDate month
 379         if (!$startDate) {
 380           $actualStartDate = $startDate = $year . '-' . $month . '-01';
 381         }
 382       }
 383     }
 384
 385     // Calculate end date if it is not passed by user.
 386     if (!$endDate) {
 387       //end date calculation
 388       $date = explode('-', $actualStartDate);
 389       $year = $date[0];
 390       $month = $date[1];
 391       $day = $date[2];
 392
 393       switch ($membershipTypeDetails['duration_unit']) {
 394         case 'year':
 395           $year = $year + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
 396           //extend membership date by duration interval.
 397           if ($fixed_period_rollover) {
 398             $year += 1;
 399           }
 400           break;
 401
 402         case 'month':
 403           $month = $month + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
 404           //duration interval is month
 405           if ($fixed_period_rollover) {
 406             //CRM-10585
 407             $month += 1;
 408           }
 409           break;
 410
 411         case 'day':
 412           $day = $day + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
 413
 414           if ($fixed_period_rollover) {
 415             //Fix Me: Currently we don't allow rollover if
 416             //duration interval is day
 417           }
 418           break;
 419       }
 420
 421       if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
 422         $endDate = NULL;
 423       }
 424       else {
 425         $endDate = date('Y-m-d', mktime(0, 0, 0, $month, $day - 1, $year));
 426       }
 427     }
 428
 429     $membershipDates = [
 430       'start_date' => CRM_Utils_Date::customFormat($startDate, '%Y%m%d'),
 431       'end_date' => CRM_Utils_Date::customFormat($endDate, '%Y%m%d'),
 432       'join_date' => CRM_Utils_Date::customFormat($joinDate, '%Y%m%d'),
 433     ];
 434
 435     return $membershipDates;
 436   }
 437
 438   /**
 439    * Does this membership start between the rollover date and the start of the next period.
 440    * (in which case they will get an extra membership period)
 441    *  ie if annual memberships run June - May & the rollover is in May memberships between
 442    * May and June will return TRUE and between June and May will return FALSE
 443    *
 444    * @param string $startDate start date of current membership period
 445    * @param array $membershipTypeDetails
 446    * @param int $year
 447    * @param string $actualStartDate
 448    * @return bool is this in the window where the membership gets an extra part-period added
 449    */
 450   public static function isDuringFixedAnnualRolloverPeriod($startDate, $membershipTypeDetails, $year, $actualStartDate) {
 451
 452     $rolloverMonth = substr($membershipTypeDetails['fixed_period_rollover_day'], 0,
 453       strlen($membershipTypeDetails['fixed_period_rollover_day']) - 2
 454     );
 455     $rolloverDay = substr($membershipTypeDetails['fixed_period_rollover_day'], -2);
 456
 457     $calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year));
 458
 459     //CRM-7825 -membership date rules are :
 460     //1. Membership should not be start in future.
 461     //2. rollover window should be subset of membership window.
 462
 463     //get the fixed end date here.
 464     $dateParts = explode('-', $actualStartDate);
 465     $endDateOfFirstYearMembershipPeriod = date('Y-m-d', mktime(0, 0, 0,
 466       $dateParts[1],
 467       $dateParts[2] - 1,
 468       $dateParts[0] + 1
 469     ));
 470
 471     //we know the month and day of the rollover date but not the year (we're just
 472     //using the start date year at the moment. So if it's after the end
 473     // of the first year of membership then it's the next period & we'll adjust back a year. If it's
 474     // before the start_date then it's too early & we'll adjust forward.
 475     if ($endDateOfFirstYearMembershipPeriod < $calculatedRolloverDate) {
 476       $calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year - 1));
 477     }
 478     if ($calculatedRolloverDate < $actualStartDate) {
 479       $calculatedRolloverDate = date('Y-m-d', mktime(0, 0, 0, $rolloverMonth, $rolloverDay, $year + 1));
 480     }
 481
 482     if ($calculatedRolloverDate <= $startDate) {
 483       return TRUE;
 484     }
 485     return FALSE;
 486   }
 487
 488   /**
 489    * Calculate start date and end date for membership updates.
 490    *
 491    * Note that this function is called by the api for any membership update although it was
 492    * originally written for renewal (which feels a bit fragile but hey....).
 493    *
 494    * @param int $membershipId
 495    * @param $changeToday
 496    *   If provided, specify an alternative date to use as "today" for renewal
 497    * @param int $membershipTypeID
 498    *   If provided, overrides the membership type of the $membershipID membership.
 499    * @param int $numRenewTerms
 500    *   How many membership terms are being added to end date (default is 1).
 501    *
 502    * CRM-7297 Membership Upsell - Added $membershipTypeID param to facilitate calculations of dates when membership type changes
 503    *
 504    * @return array
 505    *   array fo the start date, end date and join date of the membership
 506    */
 507   public static function getRenewalDatesForMembershipType($membershipId, $changeToday = NULL, $membershipTypeID = NULL, $numRenewTerms = 1) {
 508     $params = ['id' => $membershipId];
 509     $membershipDetails = CRM_Member_BAO_Membership::getValues($params, $values);
 510     $membershipDetails = $membershipDetails[$membershipId];
 511     $statusID = $membershipDetails->status_id;
 512     $membershipDates = [];
 513     if (!empty($membershipDetails->join_date)) {
 514       $membershipDates['join_date'] = CRM_Utils_Date::customFormat($membershipDetails->join_date, '%Y%m%d');
 515     }
 516
 517     $oldPeriodType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 518       CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id'), 'period_type');
 519
 520     // CRM-7297 Membership Upsell
 521     if (is_null($membershipTypeID)) {
 522       $membershipTypeDetails = self::getMembershipTypeDetails($membershipDetails->membership_type_id);
 523     }
 524     else {
 525       $membershipTypeDetails = self::getMembershipTypeDetails($membershipTypeID);
 526     }
 527     $statusDetails = CRM_Member_BAO_MembershipStatus::getMembershipStatus($statusID);
 528
 529     if ($statusDetails['is_current_member'] == 1) {
 530       $startDate = $membershipDetails->start_date;
 531       // CRM=7297 Membership Upsell: we need to handle null end_date in case we are switching
 532       // from a lifetime to a different membership type
 533       if (is_null($membershipDetails->end_date)) {
 534         $date = CRM_Utils_Time::date('Y-m-d');
 535       }
 536       else {
 537         $date = $membershipDetails->end_date;
 538       }
 539       $date = explode('-', $date);
 540       // We have to add 1 day first in case it's the end of the month, then subtract afterwards
 541       // eg. 2018-02-28 should renew to 2018-03-31, if we just added 1 month we'd get 2018-03-28
 542       $logStartDate = date('Y-m-d', mktime(0, 0, 0,
 543         (double) $date[1],
 544         (double) ($date[2] + 1),
 545         (double) $date[0]
 546       ));
 547
 548       $date = explode('-', $logStartDate);
 549       $year = $date[0];
 550       $month = $date[1];
 551       $day = $date[2];
 552
 553       switch ($membershipTypeDetails['duration_unit']) {
 554         case 'year':
 555           //need to check if the upsell is from rolling to fixed and adjust accordingly
 556           if ($membershipTypeDetails['period_type'] == 'fixed' && $oldPeriodType == 'rolling') {
 557             $month = substr($membershipTypeDetails['fixed_period_start_day'], 0, strlen($membershipTypeDetails['fixed_period_start_day']) - 2);
 558             $day = substr($membershipTypeDetails['fixed_period_start_day'], -2);
 559             $year += 1;
 560           }
 561           else {
 562             $year = $year + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
 563           }
 564           break;
 565
 566         case 'month':
 567           $month = $month + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
 568           break;
 569
 570         case 'day':
 571           $day = $day + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
 572           break;
 573       }
 574       if ($membershipTypeDetails['duration_unit'] == 'lifetime') {
 575         $endDate = NULL;
 576       }
 577       else {
 578         $endDate = date('Y-m-d', mktime(0, 0, 0,
 579           $month,
 580           $day - 1,
 581           $year
 582         ));
 583       }
 584       $today = CRM_Utils_Time::date('Y-m-d');
 585       $membershipDates['today'] = CRM_Utils_Date::customFormat($today, '%Y%m%d');
 586       $membershipDates['start_date'] = CRM_Utils_Date::customFormat($startDate, '%Y%m%d');
 587       $membershipDates['end_date'] = CRM_Utils_Date::customFormat($endDate, '%Y%m%d');
 588       $membershipDates['log_start_date'] = CRM_Utils_Date::customFormat($logStartDate, '%Y%m%d');
 589     }
 590     else {
 591       $today = CRM_Utils_Time::date('Y-m-d');
 592       if ($changeToday) {
 593         $today = CRM_Utils_Date::processDate($changeToday, NULL, FALSE, 'Y-m-d');
 594       }
 595       // Calculate new start/end dates when join date is today
 596       $renewalDates = self::getDatesForMembershipType($membershipTypeDetails['id'],
 597         $today, NULL, NULL, $numRenewTerms
 598       );
 599       $membershipDates['today'] = CRM_Utils_Date::customFormat($today, '%Y%m%d');
 600       $membershipDates['start_date'] = $renewalDates['start_date'];
 601       $membershipDates['end_date'] = $renewalDates['end_date'];
 602       $membershipDates['log_start_date'] = $renewalDates['start_date'];
 603       // CRM-18503 - set join_date as today in case the membership type is fixed.
 604       if ($membershipTypeDetails['period_type'] == 'fixed' && !isset($membershipDates['join_date'])) {
 605         $membershipDates['join_date'] = $renewalDates['join_date'];
 606       }
 607     }
 608     if (!isset($membershipDates['join_date'])) {
 609       $membershipDates['join_date'] = $membershipDates['start_date'];
 610     }
 611
 612     return $membershipDates;
 613   }
 614
 615   /**
 616    * Retrieve all Membership Types with Member of Contact id.
 617    *
 618    * @param array $membershipTypes
 619    *   array of membership type ids
 620    * @return array
 621    *   array of the details of membership types with Member of Contact id
 622    */
 623   public static function getMemberOfContactByMemTypes($membershipTypes) {
 624     $memTypeOrganizations = [];
 625     if (empty($membershipTypes)) {
 626       return $memTypeOrganizations;
 627     }
 628
 629     $result = CRM_Core_DAO::executeQuery("SELECT id, member_of_contact_id FROM civicrm_membership_type WHERE id IN (" . implode(',', $membershipTypes) . ")");
 630     while ($result->fetch()) {
 631       $memTypeOrganizations[$result->id] = $result->member_of_contact_id;
 632     }
 633
 634     return $memTypeOrganizations;
 635   }
 636
 637   /**
 638    * The function returns all the Organization for all membershipTypes .
 639    *
 640    * @param int $membershipTypeId
 641    *
 642    * @return array
 643    */
 644   public static function getMembershipTypeOrganization($membershipTypeId = NULL) {
 645     $allMembershipTypes = [];
 646
 647     $membershipType = new CRM_Member_DAO_MembershipType();
 648
 649     if (isset($membershipTypeId)) {
 650       $membershipType->id = $membershipTypeId;
 651     }
 652     $membershipType->find();
 653
 654     while ($membershipType->fetch()) {
 655       $allMembershipTypes[$membershipType->id] = $membershipType->member_of_contact_id;
 656     }
 657     return $allMembershipTypes;
 658   }
 659
 660   /**
 661    * Function to retrieve organization and associated membership
 662    * types
 663    *
 664    * @return array
 665    *   arrays of organization and membership types
 666    *
 667    */
 668   public static function getMembershipTypeInfo() {
 669     if (!self::$_membershipTypeInfo) {
 670       $orgs = $types = [];
 671
 672       $query = 'SELECT memType.id, memType.name, memType.member_of_contact_id, c.sort_name
 673         FROM civicrm_membership_type memType INNER JOIN civicrm_contact c ON c.id = memType.member_of_contact_id
 674         WHERE memType.is_active = 1 ';
 675       $dao = CRM_Core_DAO::executeQuery($query);
 676       while ($dao->fetch()) {
 677         $orgs[$dao->member_of_contact_id] = $dao->sort_name;
 678         $types[$dao->member_of_contact_id][$dao->id] = $dao->name;
 679       }
 680
 681       self::$_membershipTypeInfo = [$orgs, $types];
 682     }
 683     return self::$_membershipTypeInfo;
 684   }
 685
 686   /**
 687    * @param array $params
 688    * @param int $previousID
 689    * @param int $membershipTypeId
 690    */
 691   public static function createMembershipPriceField($params, $previousID, $membershipTypeId) {
 692
 693     $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
 694
 695     if (!empty($params['member_of_contact_id'])) {
 696       $fieldName = $params['member_of_contact_id'];
 697     }
 698     else {
 699       $fieldName = $previousID;
 700     }
 701     $fieldLabel = 'Membership Amount';
 702     $optionsIds = NULL;
 703     $fieldParams = [
 704       'price_set_id ' => $priceSetId,
 705       'name' => $fieldName,
 706     ];
 707     $results = [];
 708     CRM_Price_BAO_PriceField::retrieve($fieldParams, $results);
 709     if (empty($results)) {
 710       $fieldParams = [];
 711       $fieldParams['label'] = $fieldLabel;
 712       $fieldParams['name'] = $fieldName;
 713       $fieldParams['price_set_id'] = $priceSetId;
 714       $fieldParams['html_type'] = 'Radio';
 715       $fieldParams['is_display_amounts'] = $fieldParams['is_required'] = 0;
 716       $fieldParams['weight'] = $fieldParams['option_weight'][1] = 1;
 717       $fieldParams['option_label'][1] = $params['name'];
 718       $fieldParams['option_description'][1] = $params['description'] ?? NULL;
 719
 720       $fieldParams['membership_type_id'][1] = $membershipTypeId;
 721       $fieldParams['option_amount'][1] = empty($params['minimum_fee']) ? 0 : $params['minimum_fee'];
 722       $fieldParams['financial_type_id'] = $params['financial_type_id'] ?? NULL;
 723
 724       if ($previousID) {
 725         CRM_Member_Form_MembershipType::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
 726         $fieldParams['option_id'] = $optionsIds['option_id'] ?? NULL;
 727       }
 728       CRM_Price_BAO_PriceField::create($fieldParams);
 729     }
 730     else {
 731       $fieldID = $results['id'];
 732       $fieldValueParams = [
 733         'price_field_id' => $fieldID,
 734         'membership_type_id' => $membershipTypeId,
 735       ];
 736       $results = [];
 737       CRM_Price_BAO_PriceFieldValue::retrieve($fieldValueParams, $results);
 738       if (!empty($results)) {
 739         $results['label'] = $results['name'] = $params['name'];
 740         $results['amount'] = empty($params['minimum_fee']) ? 0 : $params['minimum_fee'];
 741       }
 742       else {
 743         $results = [
 744           'price_field_id' => $fieldID,
 745           'name' => $params['name'],
 746           'label' => $params['name'],
 747           'amount' => empty($params['minimum_fee']) ? 0 : $params['minimum_fee'],
 748           'membership_type_id' => $membershipTypeId,
 749           'is_active' => 1,
 750         ];
 751       }
 752
 753       if ($previousID) {
 754         CRM_Member_Form_MembershipType::checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, $optionsIds);
 755         if (!empty($optionsIds['option_id'])) {
 756           $results['id'] = current($optionsIds['option_id']);
 757         }
 758       }
 759       $results['financial_type_id'] = $params['financial_type_id'] ?? NULL;
 760       $results['description'] = $params['description'] ?? NULL;
 761       CRM_Price_BAO_PriceFieldValue::add($results);
 762     }
 763   }
 764
 765   /**
 766    * This function updates all price field value for quick config
 767    * price set which has membership type
 768    *
 769    * @param int $membershipTypeId membership type id
 770    *
 771    * @param array $params
 772    */
 773   public static function updateAllPriceFieldValue($membershipTypeId, $params) {
 774     $defaults = [];
 775     $fieldsToUpdate = [
 776       'financial_type_id' => 'financial_type_id',
 777       'name' => 'label',
 778       'minimum_fee' => 'amount',
 779       'description' => 'description',
 780       'visibility' => 'visibility_id',
 781     ];
 782     $priceFieldValueBAO = new CRM_Price_BAO_PriceFieldValue();
 783     $priceFieldValueBAO->membership_type_id = $membershipTypeId;
 784     $priceFieldValueBAO->find();
 785     while ($priceFieldValueBAO->fetch()) {
 786       $updateParams = [
 787         'id' => $priceFieldValueBAO->id,
 788         'price_field_id' => $priceFieldValueBAO->price_field_id,
 789       ];
 790       //Get priceset details.
 791       $fieldParams = ['fid' => $priceFieldValueBAO->price_field_id];
 792       $setID = CRM_Price_BAO_PriceSet::getSetId($fieldParams);
 793       $setParams = ['id' => $setID];
 794       $setValues = CRM_Price_BAO_PriceSet::retrieve($setParams, $defaults);
 795       if (!empty($setValues->is_quick_config) && $setValues->name != 'default_membership_type_amount') {
 796         foreach ($fieldsToUpdate as $key => $value) {
 797           if ($value == 'visibility_id' && !empty($params['visibility'])) {
 798             $updateParams['visibility_id'] = CRM_Price_BAO_PriceField::getVisibilityOptionID(strtolower($params['visibility']));
 799           }
 800           else {
 801             $updateParams[$value] = $params[$key] ?? NULL;
 802           }
 803         }
 804         CRM_Price_BAO_PriceFieldValue::add($updateParams);
 805       }
 806     }
 807   }
 808
 809   /**
 810    * Cached wrapper for membership types.
 811    *
 812    * Since this is used from the batched script caching helps.
 813    *
 814    * Caching is by domain - if that hits any issues we should add a new function getDomainMembershipTypes
 815    * or similar rather than 'just add another param'! but this is closer to earlier behaviour so 'should' be OK.
 816    *
 817    * @return array
 818    *   List of membershipType details keyed by membershipTypeID
 819    * @throws \CiviCRM_API3_Exception
 820    */
 821   public static function getAllMembershipTypes(): array {
 822     $cacheString = __CLASS__ . __FUNCTION__ . CRM_Core_Config::domainID() . '_' . CRM_Core_I18n::getLocale();
 823     if (!Civi::cache('metadata')->has($cacheString)) {
 824       $types = civicrm_api3('MembershipType', 'get', ['options' => ['limit' => 0, 'sort' => 'weight']])['values'];
 825       $taxRates = CRM_Core_PseudoConstant::getTaxRates();
 826       $keys = ['description', 'relationship_type_id', 'relationship_direction', 'max_related', 'auto_renew'];
 827       // In order to avoid down-stream e-notices we undo api v3 filtering of NULL values. This is covered
 828       // in Unit tests & ideally we might switch to apiv4 but I would argue we should build caching
 829       // of metadata entities like this directly into apiv4.
 830       foreach ($types as $id => $type) {
 831         foreach ($keys as $key) {
 832           if (!isset($type[$key])) {
 833             $types[$id][$key] = NULL;
 834           }
 835         }
 836         if (isset($type['contribution_type_id'])) {
 837           unset($types[$id]['contribution_type_id']);
 838         }
 839         $types[$id]['tax_rate'] = (float) ($taxRates[$type['financial_type_id']] ?? 0.0);
 840         $multiplier = 1;
 841         if ($types[$id]['tax_rate'] !== 0.0) {
 842           $multiplier += ($types[$id]['tax_rate'] / 100);
 843         }
 844         if (!array_key_exists('minimum_fee', $types[$id])) {
 845           $types[$id]['minimum_fee'] = 0;
 846         }
 847         $types[$id]['minimum_fee_with_tax'] = (float) $types[$id]['minimum_fee'] * $multiplier;
 848       }
 849       Civi::cache('metadata')->set($cacheString, $types);
 850     }
 851     return Civi::cache('metadata')->get($cacheString);
 852   }
 853
 854   /**
 855    * Get a specific membership type (leveraging the cache).
 856    *
 857    * @param int $id
 858    *
 859    * @return mixed
 860    * @throws \CiviCRM_API3_Exception
 861    */
 862   public static function getMembershipType($id) {
 863     return self::getAllMembershipTypes()[$id];
 864   }
 865
 866 }