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