CRM/Member/BAO/MembershipType.php

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