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