CRM/Member/BAO/Membership.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_Membership extends CRM_Member_DAO_Membership {
  18
  19   /**
  20    * Static field for all the membership information that we can potentially import.
  21    *
  22    * @var array
  23    */
  24   public static $_importableFields = NULL;
  25
  26   public static $_renewalActType = NULL;
  27
  28   public static $_signupActType = NULL;
  29
  30   /**
  31    * Class constructor.
  32    */
  33   public function __construct() {
  34     parent::__construct();
  35   }
  36
  37   /**
  38    * Takes an associative array and creates a membership object.
  39    *
  40    * the function extracts all the params it needs to initialize the created
  41    * membership object. The params array could contain additional unused name/value
  42    * pairs
  43    *
  44    * @param array $params
  45    *   (reference ) an assoc array of name/value pairs.
  46    *
  47    * @return CRM_Member_BAO_Membership
  48    * @throws \CiviCRM_API3_Exception
  49    */
  50   public static function add(&$params) {
  51     $oldStatus = $oldType = NULL;
  52     if ($params['id']) {
  53       CRM_Utils_Hook::pre('edit', 'Membership', $params['id'], $params);
  54     }
  55     else {
  56       CRM_Utils_Hook::pre('create', 'Membership', NULL, $params);
  57     }
  58     $id = $params['id'];
  59     // we do this after the hooks are called in case it has been altered
  60     if ($id) {
  61       $membershipObj = new CRM_Member_DAO_Membership();
  62       $membershipObj->id = $id;
  63       $membershipObj->find();
  64       while ($membershipObj->fetch()) {
  65         $oldStatus = $membershipObj->status_id;
  66         $oldType = $membershipObj->membership_type_id;
  67       }
  68     }
  69
  70     if (array_key_exists('is_override', $params) && !$params['is_override']) {
  71       $params['is_override'] = 'null';
  72     }
  73
  74     $membership = new CRM_Member_BAO_Membership();
  75     $membership->copyValues($params);
  76     $membership->id = $id;
  77
  78     $membership->save();
  79
  80     if (empty($membership->contact_id) || empty($membership->status_id)) {
  81       // this means we are in renewal mode and are just updating the membership
  82       // record or this is an API update call and all fields are not present in the update record
  83       // however the hooks don't care and want all data CRM-7784
  84       $tempMembership = new CRM_Member_DAO_Membership();
  85       $tempMembership->id = $membership->id;
  86       $tempMembership->find(TRUE);
  87       $membership = $tempMembership;
  88     }
  89
  90     //get the log start date.
  91     //it is set during renewal of membership.
  92     $logStartDate = $params['log_start_date'] ?? NULL;
  93     $logStartDate = ($logStartDate) ? CRM_Utils_Date::isoToMysql($logStartDate) : CRM_Utils_Date::isoToMysql($membership->start_date);
  94     $values = self::getStatusANDTypeValues($membership->id);
  95
  96     $membershipLog = [
  97       'membership_id' => $membership->id,
  98       'status_id' => $membership->status_id,
  99       'start_date' => $logStartDate,
 100       'end_date' => CRM_Utils_Date::isoToMysql($membership->end_date),
 101       'modified_date' => date('Ymd'),
 102       'membership_type_id' => $values[$membership->id]['membership_type_id'],
 103       'max_related' => $membership->max_related,
 104     ];
 105
 106     if (!empty($params['modified_id'])) {
 107       $membershipLog['modified_id'] = $params['modified_id'];
 108     }
 109     // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
 110     elseif (CRM_Core_Session::singleton()->get('userID')) {
 111       $membershipLog['modified_id'] = CRM_Core_Session::singleton()->get('userID');
 112     }
 113     else {
 114       $membershipLog['modified_id'] = $membership->contact_id;
 115     }
 116
 117     CRM_Member_BAO_MembershipLog::add($membershipLog);
 118
 119     // reset the group contact cache since smart groups might be affected due to this
 120     CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 121
 122     $allStatus = CRM_Member_BAO_Membership::buildOptions('status_id', 'get');
 123     $activityParams = [
 124       'status_id' => $params['membership_activity_status'] ?? 'Completed',
 125     ];
 126     if (in_array($allStatus[$membership->status_id], ['Pending', 'Grace'])) {
 127       $activityParams['status_id'] = 'Scheduled';
 128     }
 129     $activityParams['status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', $activityParams['status_id']);
 130
 131     $targetContactID = $membership->contact_id;
 132     if (!empty($params['is_for_organization'])) {
 133       // @todo - deprecate is_for_organization, require modified_id
 134       $targetContactID = $params['modified_id'] ?? NULL;
 135     }
 136
 137     // add custom field values
 138     if (!empty($params['custom']) && is_array($params['custom'])
 139     ) {
 140       CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_membership', $membership->id);
 141     }
 142
 143     if ($id) {
 144       if ($membership->status_id != $oldStatus) {
 145         CRM_Activity_BAO_Activity::addActivity($membership,
 146           'Change Membership Status',
 147           NULL,
 148           [
 149             'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$membership->status_id]}",
 150             'source_contact_id' => $membershipLog['modified_id'],
 151             'priority_id' => 'Normal',
 152           ]
 153         );
 154       }
 155       if (isset($membership->membership_type_id) && $membership->membership_type_id != $oldType) {
 156         $membershipTypes = CRM_Member_BAO_Membership::buildOptions('membership_type_id', 'get');
 157         CRM_Activity_BAO_Activity::addActivity($membership,
 158           'Change Membership Type',
 159           NULL,
 160           [
 161             'subject' => "Type changed from {$membershipTypes[$oldType]} to {$membershipTypes[$membership->membership_type_id]}",
 162             'source_contact_id' => $membershipLog['modified_id'],
 163             'priority_id' => 'Normal',
 164           ]
 165         );
 166       }
 167
 168       foreach (['Membership Signup', 'Membership Renewal'] as $activityType) {
 169         $activityParams['id'] = civicrm_api3('Activity', 'Get', [
 170           'source_record_id' => $membership->id,
 171           'activity_type_id' => $activityType,
 172           'status_id' => 'Scheduled',
 173         ])['id'] ?? NULL;
 174         // 1. Update Schedule Membership Signup/Renwal activity to completed on successful payment of pending membership
 175         // 2. OR Create renewal activity scheduled if its membership renewal will be paid later
 176         if (!empty($params['membership_activity_status']) && (!empty($activityParams['id']) || $activityType == 'Membership Renewal')) {
 177           CRM_Activity_BAO_Activity::addActivity($membership, $activityType, $targetContactID, $activityParams);
 178           break;
 179         }
 180       }
 181
 182       CRM_Utils_Hook::post('edit', 'Membership', $membership->id, $membership);
 183     }
 184     else {
 185       CRM_Activity_BAO_Activity::addActivity($membership, 'Membership Signup', $targetContactID, $activityParams);
 186       CRM_Utils_Hook::post('create', 'Membership', $membership->id, $membership);
 187     }
 188
 189     return $membership;
 190   }
 191
 192   /**
 193    * Fetch the object and store the values in the values array.
 194    *
 195    * @param array $params
 196    *   Input parameters to find object.
 197    * @param array $values
 198    *   Output values of the object.
 199    * @param bool $active
 200    *   Do you want only active memberships to.
 201    *                        be returned
 202    *
 203    * @return CRM_Member_BAO_Membership|null
 204    *   The found object or null
 205    */
 206   public static function &getValues(&$params, &$values, $active = FALSE) {
 207     if (empty($params)) {
 208       return NULL;
 209     }
 210     $membership = new CRM_Member_BAO_Membership();
 211
 212     $membership->copyValues($params);
 213     $membership->find();
 214     $memberships = [];
 215     while ($membership->fetch()) {
 216       if ($active &&
 217         (!CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus',
 218           $membership->status_id,
 219           'is_current_member'
 220         ))
 221       ) {
 222         continue;
 223       }
 224
 225       CRM_Core_DAO::storeValues($membership, $values[$membership->id]);
 226       $memberships[$membership->id] = $membership;
 227     }
 228
 229     return $memberships;
 230   }
 231
 232   /**
 233    * Takes an associative array and creates a membership object.
 234    *
 235    * @param array $params
 236    *   (reference ) an assoc array of name/value pairs.
 237    * @param array $ids
 238    *   Deprecated parameter The array that holds all the db ids.
 239    *
 240    * @return CRM_Member_BAO_Membership|CRM_Core_Error
 241    * @throws \CiviCRM_API3_Exception
 242    *
 243    * @throws CRM_Core_Exception
 244    */
 245   public static function create(&$params, &$ids = []) {
 246     // always calculate status if is_override/skipStatusCal is not true.
 247     // giving respect to is_override during import.  CRM-4012
 248
 249     // To skip status calculation we should use 'skipStatusCal'.
 250     // eg pay later membership, membership update cron CRM-3984
 251
 252     if (empty($params['is_override']) && empty($params['skipStatusCal'])) {
 253       // @todo - we should be able to count on dates being correctly formatted by they time they hit the BAO.
 254       // Maybe do some tests & throw some deprecation warnings if they aren't?
 255       $params['start_date'] = trim($params['start_date']) ? date('Ymd', strtotime(trim($params['start_date']))) : 'null';
 256       $params['end_date'] = trim($params['end_date']) ? date('Ymd', strtotime(trim($params['end_date']))) : 'null';
 257       $params['join_date'] = trim($params['join_date']) ? date('Ymd', strtotime(trim($params['join_date']))) : 'null';
 258
 259       //fix for CRM-3570, during import exclude the statuses those having is_admin = 1
 260       $excludeIsAdmin = $params['exclude_is_admin'] ?? FALSE;
 261
 262       //CRM-3724 always skip is_admin if is_override != true.
 263       if (!$excludeIsAdmin && empty($params['is_override'])) {
 264         $excludeIsAdmin = TRUE;
 265       }
 266
 267       $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($params['start_date'], $params['end_date'], $params['join_date'],
 268         'now', $excludeIsAdmin, $params['membership_type_id'] ?? NULL, $params
 269       );
 270       if (empty($calcStatus)) {
 271         throw new CRM_Core_Exception(ts("The membership cannot be saved because the status cannot be calculated for start_date: {$params['start_date']} end_date {$params['end_date']} join_date {$params['join_date']} as at " . date('Y-m-d H:i:s')));
 272       }
 273       $params['status_id'] = $calcStatus['id'];
 274     }
 275
 276     // data cleanup only: all verifications on number of related memberships are done upstream in:
 277     // CRM_Member_BAO_Membership::createRelatedMemberships()
 278     // CRM_Contact_BAO_Relationship::relatedMemberships()
 279     if (!empty($params['owner_membership_id'])) {
 280       unset($params['max_related']);
 281     }
 282     else {
 283       // if membership allows related, default max_related to value in membership_type
 284       if (!array_key_exists('max_related', $params) && !empty($params['membership_type_id'])) {
 285         $membershipType = CRM_Member_BAO_MembershipType::getMembershipType($params['membership_type_id']);
 286         if (isset($membershipType['relationship_type_id'])) {
 287           $params['max_related'] = $membershipType['max_related'] ?? NULL;
 288         }
 289       }
 290     }
 291
 292     $transaction = new CRM_Core_Transaction();
 293
 294     $params['id'] = $params['id'] ?? $ids['membership'] ?? NULL;
 295     $membership = self::add($params);
 296
 297     if (is_a($membership, 'CRM_Core_Error')) {
 298       $transaction->rollback();
 299       return $membership;
 300     }
 301
 302     $params['membership_id'] = $membership->id;
 303     // @todo further cleanup required to remove use of $ids['contribution'] from here
 304     if (isset($ids['membership'])) {
 305       $ids['contribution'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipPayment',
 306         $membership->id,
 307         'contribution_id',
 308         'membership_id'
 309       );
 310       // @todo this is a temporary step to removing $ids['contribution'] completely
 311       if (empty($params['contribution_id']) && !empty($ids['contribution'])) {
 312         $params['contribution_id'] = $ids['contribution'];
 313       }
 314     }
 315
 316     // This code ensures a line item is created but it is recommended you pass in 'skipLineItem' or 'line_item'
 317     if (empty($params['line_item']) && !empty($params['membership_type_id']) && empty($params['skipLineItem'])) {
 318       CRM_Price_BAO_LineItem::getLineItemArray($params, NULL, 'membership', $params['membership_type_id']);
 319     }
 320     $params['skipLineItem'] = TRUE;
 321
 322     // Record contribution for this membership and create a MembershipPayment
 323     if (!empty($params['contribution_status_id']) && empty($params['relate_contribution_id'])) {
 324       $memInfo = array_merge($params, ['membership_id' => $membership->id]);
 325       $params['contribution'] = self::recordMembershipContribution($memInfo);
 326     }
 327
 328     // Add/update MembershipPayment record for this membership if it is a related contribution
 329     if (!empty($params['relate_contribution_id'])) {
 330       $membershipPaymentParams = [
 331         'membership_id' => $membership->id,
 332         'membership_type_id' => $membership->membership_type_id,
 333         'contribution_id' => $params['relate_contribution_id'],
 334       ];
 335       civicrm_api3('MembershipPayment', 'create', $membershipPaymentParams);
 336     }
 337
 338     if (!empty($params['lineItems'])) {
 339       $params['line_item'] = $params['lineItems'];
 340     }
 341
 342     // do cleanup line items if membership edit the Membership type.
 343     if (empty($ids['contribution']) && !empty($ids['membership'])) {
 344       CRM_Price_BAO_LineItem::deleteLineItems($ids['membership'], 'civicrm_membership');
 345     }
 346     // @todo - we should ONLY do the below if a contribution is created. Let's
 347     // get some deprecation notices in here & see where it's hit & work to eliminate.
 348     // This could happen if there is no contribution or we are in one of many
 349     // weird and wonderful flows. This is scary code. Keep adding tests.
 350     if (!empty($params['line_item']) && empty($ids['contribution']) && empty($params['contribution_id'])) {
 351
 352       foreach ($params['line_item'] as $priceSetId => $lineItems) {
 353         foreach ($lineItems as $lineIndex => $lineItem) {
 354           $lineMembershipType = $lineItem['membership_type_id'] ?? NULL;
 355           if (!empty($params['contribution'])) {
 356             $params['line_item'][$priceSetId][$lineIndex]['contribution_id'] = $params['contribution']->id;
 357           }
 358           if ($lineMembershipType && $lineMembershipType == ($params['membership_type_id'] ?? NULL)) {
 359             $params['line_item'][$priceSetId][$lineIndex]['entity_id'] = $membership->id;
 360             $params['line_item'][$priceSetId][$lineIndex]['entity_table'] = 'civicrm_membership';
 361           }
 362           elseif (!$lineMembershipType && !empty($params['contribution'])) {
 363             $params['line_item'][$priceSetId][$lineIndex]['entity_id'] = $params['contribution']->id;
 364             $params['line_item'][$priceSetId][$lineIndex]['entity_table'] = 'civicrm_contribution';
 365           }
 366         }
 367       }
 368       CRM_Price_BAO_LineItem::processPriceSet(
 369         $membership->id,
 370         $params['line_item'],
 371         $params['contribution'] ?? NULL
 372       );
 373     }
 374
 375     $transaction->commit();
 376
 377     self::createRelatedMemberships($params, $membership);
 378
 379     if (empty($params['skipRecentView'])) {
 380       self::addToRecentItems($membership);
 381     }
 382
 383     return $membership;
 384   }
 385
 386   /**
 387    * @param \CRM_Member_DAO_Membership $membership
 388    */
 389   private static function addToRecentItems($membership) {
 390     $url = CRM_Utils_System::url('civicrm/contact/view/membership',
 391       "action=view&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
 392     );
 393     if (empty($membership->membership_type_id)) {
 394       // ie in an update situation.
 395       $membership->find(TRUE);
 396     }
 397     $title = CRM_Contact_BAO_Contact::displayName($membership->contact_id) . ' - ' . ts('Membership Type:')
 398       . ' ' . CRM_Core_PseudoConstant::getLabel('CRM_Member_BAO_Membership', 'membership_type_id', $membership->membership_type_id);
 399
 400     $recentOther = [];
 401     if (CRM_Core_Permission::checkActionPermission('CiviMember', CRM_Core_Action::UPDATE)) {
 402       $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/view/membership',
 403         "action=update&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
 404       );
 405     }
 406     if (CRM_Core_Permission::checkActionPermission('CiviMember', CRM_Core_Action::DELETE)) {
 407       $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/membership',
 408         "action=delete&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
 409       );
 410     }
 411
 412     // add the recently created Membership
 413     CRM_Utils_Recent::add($title,
 414       $url,
 415       $membership->id,
 416       'Membership',
 417       $membership->contact_id,
 418       NULL,
 419       $recentOther
 420     );
 421   }
 422
 423   /**
 424    * Check the membership extended through relationship.
 425    *
 426    * @param int $membershipTypeID
 427    *   Membership type id.
 428    * @param int $contactId
 429    *   Contact id.
 430    *
 431    * @param int $action
 432    *
 433    * @return array
 434    *   array of contact_id of all related contacts.
 435    *
 436    * @throws \CRM_Core_Exception
 437    * @throws \CiviCRM_API3_Exception
 438    */
 439   public static function checkMembershipRelationship($membershipTypeID, $contactId, $action = CRM_Core_Action::ADD) {
 440     $contacts = [];
 441
 442     $membershipType = CRM_Member_BAO_MembershipType::getMembershipType($membershipTypeID);
 443
 444     $relationships = [];
 445     if (isset($membershipType['relationship_type_id'])) {
 446       $relationships = CRM_Contact_BAO_Relationship::getRelationship($contactId,
 447         CRM_Contact_BAO_Relationship::CURRENT
 448       );
 449       if ($action & CRM_Core_Action::UPDATE) {
 450         $pastRelationships = CRM_Contact_BAO_Relationship::getRelationship($contactId,
 451           CRM_Contact_BAO_Relationship::PAST
 452         );
 453         $relationships = array_merge($relationships, $pastRelationships);
 454       }
 455     }
 456
 457     if (!empty($relationships)) {
 458       // check for each contact relationships
 459       foreach ($relationships as $values) {
 460         //get details of the relationship type
 461         $relType = ['id' => $values['civicrm_relationship_type_id']];
 462         $relValues = [];
 463         CRM_Contact_BAO_RelationshipType::retrieve($relType, $relValues);
 464         // Check if contact's relationship type exists in membership type
 465         $relTypeDirs = [];
 466         $bidirectional = FALSE;
 467         foreach ($membershipType['relationship_type_id'] as $key => $value) {
 468           $relTypeDirs[] = $value . '_' . $membershipType['relationship_direction'][$key];
 469           if (in_array($value, $relType) &&
 470             $relValues['name_a_b'] == $relValues['name_b_a']
 471           ) {
 472             $bidirectional = TRUE;
 473             break;
 474           }
 475         }
 476         $relTypeDir = $values['civicrm_relationship_type_id'] . '_' . $values['rtype'];
 477         if ($bidirectional || in_array($relTypeDir, $relTypeDirs)) {
 478           // $values['status'] is going to have value for
 479           // current or past relationships.
 480           $contacts[$values['cid']] = $values['status'];
 481         }
 482       }
 483     }
 484
 485     // Sort by contact_id ascending
 486     ksort($contacts);
 487     return $contacts;
 488   }
 489
 490   /**
 491    * Retrieve DB object based on input parameters.
 492    *
 493    * It also stores all the retrieved values in the default array.
 494    *
 495    * @param array $params
 496    *   (reference ) an assoc array of name/value pairs.
 497    * @param array $defaults
 498    *   (reference ) an assoc array to hold the name / value pairs.
 499    *                        in a hierarchical manner
 500    *
 501    * @return CRM_Member_BAO_Membership
 502    */
 503   public static function retrieve(&$params, &$defaults) {
 504     $membership = new CRM_Member_DAO_Membership();
 505
 506     $membership->copyValues($params);
 507
 508     if ($membership->find(TRUE)) {
 509       CRM_Core_DAO::storeValues($membership, $defaults);
 510
 511       //get the membership status and type values.
 512       $statusANDType = self::getStatusANDTypeValues($membership->id);
 513       foreach (['status', 'membership_type'] as $fld) {
 514         $defaults[$fld] = $statusANDType[$membership->id][$fld] ?? NULL;
 515       }
 516       if (!empty($statusANDType[$membership->id]['is_current_member'])) {
 517         $defaults['active'] = TRUE;
 518       }
 519
 520       return $membership;
 521     }
 522
 523     return NULL;
 524   }
 525
 526   /**
 527    * Get membership status and membership type values.
 528    *
 529    * @param int $membershipId
 530    *   Membership id of values to return.
 531    *
 532    * @return array
 533    *   Array of key value pairs
 534    */
 535   public static function getStatusANDTypeValues($membershipId) {
 536     $values = [];
 537     if (!$membershipId) {
 538       return $values;
 539     }
 540     $sql = '
 541     SELECT  membership.id as id,
 542             status.id as status_id,
 543             status.label as status,
 544             status.is_current_member as is_current_member,
 545             type.id as membership_type_id,
 546             type.name as membership_type,
 547             type.relationship_type_id as relationship_type_id
 548       FROM  civicrm_membership membership
 549 INNER JOIN  civicrm_membership_status status ON ( status.id = membership.status_id )
 550 INNER JOIN  civicrm_membership_type type ON ( type.id = membership.membership_type_id )
 551      WHERE  membership.id = %1';
 552     $dao = CRM_Core_DAO::executeQuery($sql, [1 => [$membershipId, 'Positive']]);
 553     $properties = [
 554       'status',
 555       'status_id',
 556       'membership_type',
 557       'membership_type_id',
 558       'is_current_member',
 559       'relationship_type_id',
 560     ];
 561     while ($dao->fetch()) {
 562       foreach ($properties as $property) {
 563         $values[$dao->id][$property] = $dao->$property;
 564       }
 565     }
 566
 567     return $values;
 568   }
 569
 570   /**
 571    * Delete membership.
 572    *
 573    * Wrapper for most delete calls. Use this unless you JUST want to delete related memberships w/o deleting the parent.
 574    *
 575    * @param int $membershipId
 576    *   Membership id that needs to be deleted.
 577    * @param bool $preserveContrib
 578    *
 579    * @return int
 580    *   Id of deleted Membership on success, false otherwise.
 581    */
 582   public static function del($membershipId, $preserveContrib = FALSE) {
 583     //delete related first and then delete parent.
 584     self::deleteRelatedMemberships($membershipId);
 585     return self::deleteMembership($membershipId, $preserveContrib);
 586   }
 587
 588   /**
 589    * Delete membership.
 590    *
 591    * @param int $membershipId
 592    *   Membership id that needs to be deleted.
 593    * @param bool $preserveContrib
 594    *
 595    * @return int
 596    *   Id of deleted Membership on success, false otherwise.
 597    */
 598   public static function deleteMembership($membershipId, $preserveContrib = FALSE) {
 599     // CRM-12147, retrieve membership data before we delete it for hooks
 600     $params = ['id' => $membershipId];
 601     $memValues = [];
 602     $memberships = self::getValues($params, $memValues);
 603
 604     $membership = $memberships[$membershipId];
 605
 606     CRM_Utils_Hook::pre('delete', 'Membership', $membershipId, $memValues);
 607
 608     $transaction = new CRM_Core_Transaction();
 609
 610     $results = NULL;
 611     //delete activity record
 612     $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
 613
 614     $params = [];
 615     $deleteActivity = FALSE;
 616     $membershipActivities = [
 617       'Membership Signup',
 618       'Membership Renewal',
 619       'Change Membership Status',
 620       'Change Membership Type',
 621       'Membership Renewal Reminder',
 622     ];
 623     foreach ($membershipActivities as $membershipActivity) {
 624       $activityId = array_search($membershipActivity, $activityTypes);
 625       if ($activityId) {
 626         $params['activity_type_id'][] = $activityId;
 627         $deleteActivity = TRUE;
 628       }
 629     }
 630     if ($deleteActivity) {
 631       $params['source_record_id'] = $membershipId;
 632       CRM_Activity_BAO_Activity::deleteActivity($params);
 633     }
 634     self::deleteMembershipPayment($membershipId, $preserveContrib);
 635     CRM_Price_BAO_LineItem::deleteLineItems($membershipId, 'civicrm_membership');
 636
 637     $results = $membership->delete();
 638     $transaction->commit();
 639
 640     CRM_Utils_Hook::post('delete', 'Membership', $membership->id, $membership);
 641
 642     // delete the recently created Membership
 643     $membershipRecent = [
 644       'id' => $membershipId,
 645       'type' => 'Membership',
 646     ];
 647     CRM_Utils_Recent::del($membershipRecent);
 648
 649     return $results;
 650   }
 651
 652   /**
 653    * Delete related memberships.
 654    *
 655    * @param int $ownerMembershipId
 656    * @param int $contactId
 657    *
 658    * @return null
 659    */
 660   public static function deleteRelatedMemberships($ownerMembershipId, $contactId = NULL) {
 661     if (!$ownerMembershipId && !$contactId) {
 662       return FALSE;
 663     }
 664
 665     $membership = new CRM_Member_DAO_Membership();
 666     $membership->owner_membership_id = $ownerMembershipId;
 667
 668     if ($contactId) {
 669       $membership->contact_id = $contactId;
 670     }
 671
 672     $membership->find();
 673     while ($membership->fetch()) {
 674       //delete related first and then delete parent.
 675       self::deleteRelatedMemberships($membership->id);
 676       self::deleteMembership($membership->id);
 677     }
 678   }
 679
 680   /**
 681    * Obtain active/inactive memberships from the list of memberships passed to it.
 682    *
 683    * @param array $memberships
 684    *   Membership records.
 685    * @param string $status
 686    *   Active or inactive.
 687    *
 688    * @return array
 689    *   array of memberships based on status
 690    */
 691   public static function activeMembers($memberships, $status = 'active') {
 692     $actives = [];
 693     if ($status == 'active') {
 694       foreach ($memberships as $f => $v) {
 695         if (!empty($v['active'])) {
 696           $actives[$f] = $v;
 697         }
 698       }
 699       return $actives;
 700     }
 701     elseif ($status == 'inactive') {
 702       foreach ($memberships as $f => $v) {
 703         if (empty($v['active'])) {
 704           $actives[$f] = $v;
 705         }
 706       }
 707       return $actives;
 708     }
 709     return NULL;
 710   }
 711
 712   /**
 713    * Return Membership Block info in Contribution Pages.
 714    *
 715    * @param int $pageID
 716    *   Contribution page id.
 717    *
 718    * @return array|null
 719    */
 720   public static function getMembershipBlock($pageID) {
 721     $membershipBlock = [];
 722     $dao = new CRM_Member_DAO_MembershipBlock();
 723     $dao->entity_table = 'civicrm_contribution_page';
 724
 725     $dao->entity_id = $pageID;
 726     $dao->is_active = 1;
 727     if ($dao->find(TRUE)) {
 728       CRM_Core_DAO::storeValues($dao, $membershipBlock);
 729       if (!empty($membershipBlock['membership_types'])) {
 730         $membershipTypes = CRM_Utils_String::unserialize($membershipBlock['membership_types']);
 731         if (!is_array($membershipTypes)) {
 732           return $membershipBlock;
 733         }
 734         $memTypes = [];
 735         foreach ($membershipTypes as $key => $value) {
 736           $membershipBlock['auto_renew'][$key] = $value;
 737           $memTypes[$key] = $key;
 738         }
 739         $membershipBlock['membership_types'] = implode(',', $memTypes);
 740       }
 741     }
 742     else {
 743       return NULL;
 744     }
 745
 746     return $membershipBlock;
 747   }
 748
 749   /**
 750    * Return a current membership of given contact.
 751    *
 752    * NB: if more than one membership meets criteria, a randomly selected one is returned.
 753    *
 754    * @param int $contactID
 755    *   Contact id.
 756    * @param int $memType
 757    *   Membership type, null to retrieve all types.
 758    * @param int $isTest
 759    * @param int $membershipId
 760    *   If provided, then determine if it is current.
 761    * @param bool $onlySameParentOrg
 762    *   True if only Memberships with same parent org as the $memType wanted, false otherwise.
 763    *
 764    * @return array|bool
 765    * @throws \CiviCRM_API3_Exception
 766    */
 767   public static function getContactMembership($contactID, $memType, $isTest, $membershipId = NULL, $onlySameParentOrg = FALSE) {
 768     //check for owner membership id, if it exists update that membership instead: CRM-15992
 769     if ($membershipId) {
 770       $ownerMemberId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
 771         $membershipId,
 772         'owner_membership_id', 'id'
 773       );
 774       if ($ownerMemberId) {
 775         $membershipId = $ownerMemberId;
 776         $contactID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
 777           $membershipId,
 778           'contact_id', 'id'
 779         );
 780       }
 781     }
 782
 783     $dao = new CRM_Member_DAO_Membership();
 784     if ($membershipId) {
 785       $dao->id = $membershipId;
 786     }
 787     $dao->contact_id = $contactID;
 788     $dao->membership_type_id = $memType;
 789
 790     //fetch proper membership record.
 791     if ($isTest) {
 792       $dao->is_test = $isTest;
 793     }
 794     else {
 795       $dao->whereAdd('is_test IS NULL OR is_test = 0');
 796     }
 797
 798     //avoid pending membership as current membership: CRM-3027
 799     $statusIds = [array_search('Pending', CRM_Member_PseudoConstant::membershipStatus())];
 800     if (!$membershipId) {
 801       // CRM-15475
 802       $statusIds[] = array_search(
 803         'Cancelled',
 804         CRM_Member_PseudoConstant::membershipStatus(
 805           NULL,
 806           " name = 'Cancelled' ",
 807           'name',
 808           FALSE,
 809           TRUE
 810         )
 811       );
 812     }
 813     $dao->whereAdd('status_id NOT IN ( ' . implode(',', $statusIds) . ')');
 814
 815     // order by start date to find most recent membership first, CRM-4545
 816     $dao->orderBy('start_date DESC');
 817
 818     // CRM-8141
 819     if ($onlySameParentOrg && $memType) {
 820       // require the same parent org as the $memType
 821       $params = ['id' => $memType];
 822       $membershipType = [];
 823       if (CRM_Member_BAO_MembershipType::retrieve($params, $membershipType)) {
 824         $memberTypesSameParentOrg = civicrm_api3('MembershipType', 'get', [
 825           'member_of_contact_id' => $membershipType['member_of_contact_id'],
 826           'options' => [
 827             'limit' => 0,
 828           ],
 829         ]);
 830         $memberTypesSameParentOrgList = implode(',', array_keys($memberTypesSameParentOrg['values'] ?? []));
 831         $dao->whereAdd('membership_type_id IN (' . $memberTypesSameParentOrgList . ')');
 832       }
 833     }
 834
 835     if ($dao->find(TRUE)) {
 836       $membership = [];
 837       CRM_Core_DAO::storeValues($dao, $membership);
 838       $membership['is_current_member'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus',
 839         $membership['status_id'],
 840         'is_current_member', 'id'
 841       );
 842       $ownerMemberId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
 843         $membership['id'],
 844         'owner_membership_id', 'id'
 845       );
 846       if ($ownerMemberId) {
 847         $membership['id'] = $membership['membership_id'] = $ownerMemberId;
 848         $membership['membership_contact_id'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
 849           $membership['id'],
 850           'contact_id', 'id'
 851         );
 852       }
 853       return $membership;
 854     }
 855
 856     // CRM-8141
 857     if ($onlySameParentOrg && $memType) {
 858       // see if there is a membership that has same parent as $memType but different parent than $membershipID
 859       if ($dao->id && CRM_Core_Permission::check('edit memberships')) {
 860         // CRM-10016, This is probably a backend renewal, and make sure we return the same membership thats being renewed.
 861         $dao->whereAdd();
 862       }
 863       else {
 864         unset($dao->id);
 865       }
 866
 867       unset($dao->membership_type_id);
 868       if ($dao->find(TRUE)) {
 869         $membership = [];
 870         CRM_Core_DAO::storeValues($dao, $membership);
 871         $membership['is_current_member'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus',
 872           $membership['status_id'],
 873           'is_current_member', 'id'
 874         );
 875         return $membership;
 876       }
 877     }
 878     return FALSE;
 879   }
 880
 881   /**
 882    * Combine all the importable fields from the lower levels object.
 883    *
 884    * @param string $contactType
 885    *   Contact type.
 886    * @param bool $status
 887    *
 888    * @return array
 889    *   array of importable Fields
 890    * @throws \CRM_Core_Exception
 891    */
 892   public static function importableFields($contactType = 'Individual', $status = TRUE) {
 893     $fields = Civi::cache('fields')->get('membership_importable_fields' . $contactType . $status);
 894     if (!$fields) {
 895       if (!$status) {
 896         $fields = ['' => ['title' => '- ' . ts('do not import') . ' -']];
 897       }
 898       else {
 899         $fields = ['' => ['title' => '- ' . ts('Membership Fields') . ' -']];
 900       }
 901
 902       $tmpFields = CRM_Member_DAO_Membership::import();
 903       $contactFields = CRM_Contact_BAO_Contact::importableFields($contactType, NULL);
 904
 905       // Using new Dedupe rule.
 906       $ruleParams = [
 907         'contact_type' => $contactType,
 908         'used' => 'Unsupervised',
 909       ];
 910       $fieldsArray = CRM_Dedupe_BAO_Rule::dedupeRuleFields($ruleParams);
 911
 912       $tmpContactField = [];
 913       if (is_array($fieldsArray)) {
 914         foreach ($fieldsArray as $value) {
 915           $customFieldId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
 916             $value,
 917             'id',
 918             'column_name'
 919           );
 920           $value = $customFieldId ? 'custom_' . $customFieldId : $value;
 921           $tmpContactField[trim($value)] = $contactFields[trim($value)] ?? NULL;
 922           if (!$status) {
 923             $title = $tmpContactField[trim($value)]['title'] . " " . ts('(match to contact)');
 924           }
 925           else {
 926             $title = $tmpContactField[trim($value)]['title'];
 927           }
 928           $tmpContactField[trim($value)]['title'] = $title;
 929         }
 930       }
 931       $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
 932       $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . ' ' . ts('(match to contact)');
 933
 934       $tmpFields['membership_contact_id']['title'] .= ' ' . ts('(match to contact)');
 935
 936       $fields = array_merge($fields, $tmpContactField);
 937       $fields = array_merge($fields, $tmpFields);
 938       $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Membership'));
 939       Civi::cache('fields')->set('membership_importable_fields' . $contactType . $status, $fields);
 940     }
 941     return $fields;
 942   }
 943
 944   /**
 945    * Get all exportable fields.
 946    *
 947    * @return array return array of all exportable fields
 948    */
 949   public static function &exportableFields() {
 950     $expFieldMembership = CRM_Member_DAO_Membership::export();
 951
 952     $expFieldsMemType = CRM_Member_DAO_MembershipType::export();
 953     $fields = array_merge($expFieldMembership, $expFieldsMemType);
 954     $fields = array_merge($fields, $expFieldMembership);
 955     $membershipStatus = [
 956       'membership_status' => [
 957         'title' => ts('Membership Status'),
 958         'name' => 'membership_status',
 959         'type' => CRM_Utils_Type::T_STRING,
 960         'where' => 'civicrm_membership_status.name',
 961       ],
 962     ];
 963     //CRM-6161 fix for customdata export
 964     $fields = array_merge($fields, $membershipStatus, CRM_Core_BAO_CustomField::getFieldsForImport('Membership'));
 965     $fields['membership_status_id'] = $membershipStatus['membership_status'];
 966     return $fields;
 967   }
 968
 969   /**
 970    * Get membership joins/renewals for a specified membership type.
 971    *
 972    * Specifically, retrieves a count of memberships whose "Membership
 973    * Signup" or "Membership Renewal" activity falls in the given date range.
 974    * Dates match the pattern "yyyy-mm-dd".
 975    *
 976    * @param int $membershipTypeId
 977    *   Membership type id.
 978    * @param int $startDate
 979    *   Date on which to start counting.
 980    * @param int $endDate
 981    *   Date on which to end counting.
 982    * @param bool|int $isTest if true, membership is for a test site
 983    * @param bool|int $isOwner if true, only retrieve membership records for owners //LCD
 984    *
 985    * @return int
 986    *   the number of members of type $membershipTypeId whose
 987    *   start_date is between $startDate and $endDate
 988    */
 989   public static function getMembershipStarts($membershipTypeId, $startDate, $endDate, $isTest = 0, $isOwner = 0) {
 990     // Ensure that the dates that are passed to the query are in the format of yyyy-mm-dd
 991     $dates = ['startDate', 'endDate'];
 992     foreach ($dates as $date) {
 993       if (strlen($$date) === 8) {
 994         $$date = date('Y-m-d', strtotime($$date));
 995       }
 996     }
 997
 998     $testClause = 'membership.is_test = 1';
 999     if (!$isTest) {
1000       $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
1001     }
1002
1003     if (!self::$_signupActType || !self::$_renewalActType) {
1004       self::_getActTypes();
1005     }
1006
1007     if (!self::$_signupActType || !self::$_renewalActType) {
1008       return 0;
1009     }
1010
1011     $query = "
1012     SELECT  COUNT(DISTINCT membership.id) as member_count
1013       FROM  civicrm_membership membership
1014 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id in (%1, %2))
1015 INNER JOIN  civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
1016 INNER JOIN  civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
1017      WHERE  membership.membership_type_id = %3
1018        AND  activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
1019        AND  {$testClause}";
1020
1021     $query .= ($isOwner) ? ' AND owner_membership_id IS NULL' : '';
1022
1023     $params = [
1024       1 => [self::$_signupActType, 'Integer'],
1025       2 => [self::$_renewalActType, 'Integer'],
1026       3 => [$membershipTypeId, 'Integer'],
1027     ];
1028
1029     $memberCount = CRM_Core_DAO::singleValueQuery($query, $params);
1030     return (int) $memberCount;
1031   }
1032
1033   /**
1034    * Get a count of membership for a specified membership type, optionally for a specified date.
1035    *
1036    * The date must have the form yyyy-mm-dd.
1037    *
1038    * If $date is omitted, this function counts as a member anyone whose
1039    * membership status_id indicates they're a current member.
1040    * If $date is given, this function counts as a member anyone who:
1041    *  -- Has a start_date before $date and end_date after $date, or
1042    *  -- Has a start_date before $date and is currently a member, as indicated
1043    *     by the the membership's status_id.
1044    * The second condition takes care of records that have no end_date.  These
1045    * are assumed to be lifetime memberships.
1046    *
1047    * @param int $membershipTypeId
1048    *   Membership type id.
1049    * @param string $date
1050    *   The date for which to retrieve the count.
1051    * @param bool|int $isTest if true, membership is for a test site
1052    * @param bool|int $isOwner if true, only retrieve membership records for owners //LCD
1053    *
1054    * @return int
1055    *   the number of members of type $membershipTypeId as of $date.
1056    */
1057   public static function getMembershipCount($membershipTypeId, $date = NULL, $isTest = 0, $isOwner = 0) {
1058     if (!CRM_Utils_Rule::date($date)) {
1059       throw new CRM_Core_Exception(ts('Invalid date "%1" (must have form yyyy-mm-dd).', [1 => $date]));
1060     }
1061
1062     $params = [
1063       1 => [$membershipTypeId, 'Integer'],
1064       2 => [$isTest, 'Boolean'],
1065     ];
1066     $query = "SELECT  count(civicrm_membership.id ) as member_count
1067 FROM   civicrm_membership left join civicrm_membership_status on ( civicrm_membership.status_id = civicrm_membership_status.id  )
1068 WHERE  civicrm_membership.membership_type_id = %1
1069 AND civicrm_membership.contact_id NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)
1070 AND civicrm_membership.is_test = %2";
1071     if (!$date) {
1072       $query .= " AND civicrm_membership_status.is_current_member = 1";
1073     }
1074     else {
1075       $query .= " AND civicrm_membership.start_date <= '$date' AND civicrm_membership_status.is_current_member = 1";
1076     }
1077     // LCD
1078     $query .= ($isOwner) ? ' AND owner_membership_id IS NULL' : '';
1079     $memberCount = CRM_Core_DAO::singleValueQuery($query, $params);
1080     return (int) $memberCount;
1081   }
1082
1083   /**
1084    * Function check the status of the membership before adding membership for a contact.
1085    *
1086    * @return int
1087    */
1088   public static function statusAvailabilty() {
1089     $membership = new CRM_Member_DAO_MembershipStatus();
1090     $membership->whereAdd('is_active=1');
1091     return $membership->count();
1092   }
1093
1094   /**
1095    * @deprecated This is not used anywhere and should be removed soon!
1096    * Function for updating a membership record's contribution_recur_id.
1097    *
1098    * @param CRM_Member_DAO_Membership $membership
1099    * @param \CRM_Contribute_BAO_Contribution|\CRM_Contribute_DAO_Contribution $contribution
1100    */
1101   public static function updateRecurMembership(CRM_Member_DAO_Membership $membership, CRM_Contribute_BAO_Contribution $contribution) {
1102     CRM_Core_Error::deprecatedFunctionWarning('Use the API instead');
1103
1104     if (empty($contribution->contribution_recur_id)) {
1105       return;
1106     }
1107
1108     $params = [
1109       1 => [$contribution->contribution_recur_id, 'Integer'],
1110       2 => [$membership->id, 'Integer'],
1111     ];
1112
1113     $sql = "UPDATE civicrm_membership SET contribution_recur_id = %1 WHERE id = %2";
1114     CRM_Core_DAO::executeQuery($sql, $params);
1115   }
1116
1117   /**
1118    * Method to fix membership status of stale membership.
1119    *
1120    * This method first checks if the membership is stale. If it is,
1121    * then status will be updated based on existing start and end
1122    * dates and log will be added for the status change.
1123    *
1124    * @param array $currentMembership
1125    *   Reference to the array.
1126    *   containing all values of
1127    *   the current membership
1128    * @param string|null $changeToday
1129    *   In case today needs
1130    *   to be customised, null otherwise
1131    *
1132    * @throws \CRM_Core_Exception
1133    */
1134   public static function fixMembershipStatusBeforeRenew(&$currentMembership, $changeToday = NULL) {
1135     $today = 'now';
1136     if ($changeToday) {
1137       $today = CRM_Utils_Date::processDate($changeToday, NULL, FALSE, 'Y-m-d');
1138     }
1139
1140     $status = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate(
1141       $currentMembership['start_date'] ?? NULL,
1142       $currentMembership['end_date'] ?? NULL,
1143       $currentMembership['join_date'] ?? NULL,
1144       $today,
1145       TRUE,
1146       $currentMembership['membership_type_id'],
1147       $currentMembership
1148     );
1149
1150     if (empty($status) || empty($status['id'])) {
1151       throw new CRM_Core_Exception(ts('Oops, it looks like there is no valid membership status corresponding to the membership start and end dates for this membership. Contact the site administrator for assistance.'));
1152     }
1153
1154     if ($status['id'] !== $currentMembership['status_id']) {
1155       $oldStatus = $currentMembership['status_id'];
1156       $memberDAO = new CRM_Member_DAO_Membership();
1157       $memberDAO->id = $currentMembership['id'];
1158       $memberDAO->find(TRUE);
1159
1160       $memberDAO->status_id = $status['id'];
1161       $memberDAO->save();
1162       CRM_Core_DAO::storeValues($memberDAO, $currentMembership);
1163
1164       $currentMembership['is_current_member'] = CRM_Core_DAO::getFieldValue(
1165         'CRM_Member_DAO_MembershipStatus',
1166         $currentMembership['status_id'],
1167         'is_current_member'
1168       );
1169       $format = '%Y%m%d';
1170
1171       $logParams = [
1172         'membership_id' => $currentMembership['id'],
1173         'status_id' => $status['id'],
1174         'start_date' => CRM_Utils_Date::customFormat(
1175           $currentMembership['start_date'],
1176           $format
1177         ),
1178         'end_date' => CRM_Utils_Date::customFormat(
1179           $currentMembership['end_date'],
1180           $format
1181         ),
1182         'modified_date' => date('Y-m-d H:i:s', strtotime($today)),
1183         'membership_type_id' => $currentMembership['membership_type_id'],
1184         'max_related' => $currentMembership['max_related'] ?? 0,
1185       ];
1186
1187       $session = CRM_Core_Session::singleton();
1188       // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
1189       if ($session->get('userID')) {
1190         $logParams['modified_id'] = $session->get('userID');
1191       }
1192       else {
1193         $logParams['modified_id'] = $currentMembership['contact_id'];
1194       }
1195
1196       //Create activity for status change.
1197       $allStatus = CRM_Member_BAO_Membership::buildOptions('status_id', 'get');
1198       CRM_Activity_BAO_Activity::addActivity($memberDAO,
1199         'Change Membership Status',
1200         NULL,
1201         [
1202           'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$status['id']]}",
1203           'source_contact_id' => $logParams['modified_id'],
1204           'priority_id' => 'Normal',
1205         ]
1206       );
1207
1208       CRM_Member_BAO_MembershipLog::add($logParams);
1209     }
1210   }
1211
1212   /**
1213    * Get the contribution page id from the membership record.
1214    *
1215    * @param int $membershipID
1216    *
1217    * @return int
1218    *   contribution page id
1219    */
1220   public static function getContributionPageId($membershipID) {
1221     $query = "
1222 SELECT c.contribution_page_id as pageID
1223   FROM civicrm_membership_payment mp, civicrm_contribution c
1224  WHERE mp.contribution_id = c.id
1225    AND c.contribution_page_id IS NOT NULL
1226    AND mp.membership_id = " . CRM_Utils_Type::escape($membershipID, 'Integer')
1227       . " ORDER BY mp.id DESC";
1228
1229     return CRM_Core_DAO::singleValueQuery($query);
1230   }
1231
1232   /**
1233    * Updated related memberships.
1234    *
1235    * @param int $ownerMembershipId
1236    *   Owner Membership Id.
1237    * @param array $params
1238    *   Formatted array of key => value.
1239    */
1240   public static function updateRelatedMemberships($ownerMembershipId, $params) {
1241     $membership = new CRM_Member_DAO_Membership();
1242     $membership->owner_membership_id = $ownerMembershipId;
1243     $membership->find();
1244
1245     while ($membership->fetch()) {
1246       $relatedMembership = new CRM_Member_DAO_Membership();
1247       $relatedMembership->id = $membership->id;
1248       $relatedMembership->copyValues($params);
1249       $relatedMembership->save();
1250     }
1251
1252   }
1253
1254   /**
1255    * Get list of membership fields for profile.
1256    *
1257    * For now we only allow custom membership fields to be in
1258    * profile
1259    *
1260    * @param null $mode
1261    *   FIXME: This param is ignored
1262    *
1263    * @return array
1264    *   the list of membership fields
1265    */
1266   public static function getMembershipFields($mode = NULL) {
1267     $fields = CRM_Member_DAO_Membership::export();
1268
1269     unset($fields['membership_contact_id']);
1270     $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Membership'));
1271
1272     $membershipType = CRM_Member_DAO_MembershipType::export();
1273
1274     $membershipStatus = CRM_Member_DAO_MembershipStatus::export();
1275
1276     $fields = array_merge($fields, $membershipType, $membershipStatus);
1277
1278     return $fields;
1279   }
1280
1281   /**
1282    * Get the sort name of a contact for a particular membership.
1283    *
1284    * @param int $id
1285    *   Id of the membership.
1286    *
1287    * @return null|string
1288    *   sort name of the contact if found
1289    */
1290   public static function sortName($id) {
1291     $id = CRM_Utils_Type::escape($id, 'Integer');
1292
1293     $query = "
1294 SELECT civicrm_contact.sort_name
1295 FROM   civicrm_membership, civicrm_contact
1296 WHERE  civicrm_membership.contact_id = civicrm_contact.id
1297   AND  civicrm_membership.id = {$id}
1298 ";
1299     return CRM_Core_DAO::singleValueQuery($query);
1300   }
1301
1302   /**
1303    * Create memberships for related contacts, taking into account the maximum related memberships.
1304    *
1305    * @param array $params
1306    *   Array of key - value pairs.
1307    * @param CRM_Core_DAO $dao
1308    *   Membership object.
1309    *
1310    * @throws \CRM_Core_Exception
1311    * @throws \CiviCRM_API3_Exception
1312    */
1313   public static function createRelatedMemberships($params, $dao) {
1314
1315     $membership = new CRM_Member_DAO_Membership();
1316     $membership->id = $dao->id;
1317
1318     // required since create method doesn't return all the
1319     // parameters in the returned membership object
1320     if (!$membership->find(TRUE)) {
1321       return;
1322     }
1323     $deceasedStatusId = array_search('Deceased', CRM_Member_PseudoConstant::membershipStatus());
1324     // FIXME : While updating/ renewing the
1325     // membership, if the relationship is PAST then
1326     // the membership of the related contact must be
1327     // expired.
1328     // For that, getting Membership Status for which
1329     // is_current_member is 0. It works for the
1330     // generated data as there is only one membership
1331     // status having is_current_member = 0.
1332     // But this wont work exactly if there will be
1333     // more than one status having is_current_member = 0.
1334     $membershipStatus = new CRM_Member_DAO_MembershipStatus();
1335     $membershipStatus->is_current_member = 0;
1336     if ($membershipStatus->find(TRUE)) {
1337       $expiredStatusId = $membershipStatus->id;
1338     }
1339     else {
1340       $expiredStatusId = array_search('Expired', CRM_Member_PseudoConstant::membershipStatus());
1341     }
1342
1343     $relatedContacts = [];
1344     $allRelatedContacts = CRM_Member_BAO_Membership::checkMembershipRelationship($membership->membership_type_id,
1345       $membership->contact_id,
1346       $params['action'] ?? NULL
1347     );
1348
1349     // CRM-4213, CRM-19735 check for loops, using static variable to record contacts already processed.
1350     // Remove repeated related contacts, which already inherited membership of this type$relatedContactIds[$membership->contact_id][$membership->membership_type_id] = TRUE;
1351     foreach ($allRelatedContacts as $cid => $status) {
1352       // relatedContactIDs is always empty now - will remove next roud because of whitespace readability.
1353       if (empty($relatedContactIds[$cid]) || empty($relatedContactIds[$cid][$membership->membership_type_id])) {
1354         $relatedContactIds[$cid][$membership->membership_type_id] = TRUE;
1355
1356         //don't create membership again for owner contact.
1357         $nestedRelationship = FALSE;
1358         if ($membership->owner_membership_id) {
1359           $nestedRelMembership = new CRM_Member_DAO_Membership();
1360           $nestedRelMembership->id = $membership->owner_membership_id;
1361           $nestedRelMembership->contact_id = $cid;
1362           $nestedRelationship = $nestedRelMembership->find(TRUE);
1363         }
1364         if (!$nestedRelationship) {
1365           $relatedContacts[$cid] = $status;
1366         }
1367       }
1368     }
1369
1370     //lets cleanup related membership if any.
1371     if (empty($relatedContacts)) {
1372       self::deleteRelatedMemberships($membership->id);
1373     }
1374     else {
1375       // Edit the params array
1376       unset($params['id']);
1377       // Reminder should be sent only to the direct membership
1378       unset($params['reminder_date']);
1379       // unset the custom value ids
1380       if (isset($params['custom']) && is_array($params['custom'])) {
1381         foreach ($params['custom'] as $k => $values) {
1382           foreach ($values as $i => $value) {
1383             unset($params['custom'][$k][$i]['id']);
1384           }
1385         }
1386       }
1387       if (!isset($params['membership_type_id'])) {
1388         $params['membership_type_id'] = $membership->membership_type_id;
1389       }
1390
1391       // max_related should be set in the parent membership
1392       unset($params['max_related']);
1393       // Number of inherited memberships available - NULL is interpreted as unlimited, '0' as none
1394       $numRelatedAvailable = ($membership->max_related == NULL ? PHP_INT_MAX : $membership->max_related);
1395       // will be used to queue potential memberships to be created.
1396       $queue = [];
1397
1398       foreach ($relatedContacts as $contactId => $relationshipStatus) {
1399         //use existing membership record.
1400         $relMembership = new CRM_Member_DAO_Membership();
1401         $relMembership->contact_id = $contactId;
1402         $relMembership->owner_membership_id = $membership->id;
1403
1404         if ($relMembership->find(TRUE)) {
1405           $params['id'] = $relMembership->id;
1406         }
1407         else {
1408           unset($params['id']);
1409         }
1410
1411         $params['contact_id'] = $contactId;
1412         $params['owner_membership_id'] = $membership->id;
1413
1414         // set status_id as it might have been changed for
1415         // past relationship
1416         $params['status_id'] = $membership->status_id;
1417
1418         if ($deceasedStatusId &&
1419           CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactId, 'is_deceased')
1420         ) {
1421           $params['status_id'] = $deceasedStatusId;
1422         }
1423         elseif ((($params['action'] ?? NULL) & CRM_Core_Action::UPDATE) &&
1424           ($relationshipStatus == CRM_Contact_BAO_Relationship::PAST)
1425         ) {
1426           $params['status_id'] = $expiredStatusId;
1427         }
1428
1429         //don't calculate status again in create( );
1430         $params['skipStatusCal'] = TRUE;
1431
1432         //do create activity if we changed status.
1433         if ($params['status_id'] != $relMembership->status_id) {
1434           $params['createActivity'] = TRUE;
1435         }
1436
1437         //CRM-20707 - include start/end date
1438         $params['start_date'] = $membership->start_date;
1439         $params['end_date'] = $membership->end_date;
1440
1441         // we should not created contribution record for related contacts, CRM-3371
1442         unset($params['contribution_status_id']);
1443
1444         //CRM-16857: Do not create multiple line-items for inherited membership through priceset.
1445         unset($params['lineItems']);
1446         unset($params['line_item']);
1447
1448         // CRM-20966: Do not create membership_payment record for inherited membership.
1449         unset($params['relate_contribution_id']);
1450
1451         $ids = [];
1452         if (($params['status_id'] == $deceasedStatusId) || ($params['status_id'] == $expiredStatusId)) {
1453           // related membership is not active so does not count towards maximum
1454           if (!self::hasExistingInheritedMembership($params)) {
1455             CRM_Member_BAO_Membership::create($params);
1456           }
1457         }
1458         else {
1459           // related membership already exists, so this is just an update
1460           if (isset($params['id'])) {
1461             if ($numRelatedAvailable > 0) {
1462               CRM_Member_BAO_Membership::create($params);
1463               $numRelatedAvailable--;
1464             }
1465             else {
1466               // we have run out of inherited memberships, so delete extras
1467               self::deleteMembership($params['id']);
1468             }
1469             // we need to first check if there will remain inherited memberships, so queue it up
1470           }
1471           else {
1472             $queue[] = $params;
1473           }
1474         }
1475       }
1476       // now go over the queue and create any available related memberships
1477       foreach ($queue as $params) {
1478         if ($numRelatedAvailable <= 0) {
1479           break;
1480         }
1481         if (!self::hasExistingInheritedMembership($params)) {
1482           CRM_Member_BAO_Membership::create($params);
1483         }
1484         $numRelatedAvailable--;
1485       }
1486     }
1487   }
1488
1489   /**
1490    * Delete the record that are associated with this Membership Payment.
1491    *
1492    * @param int $membershipId
1493    * @param bool $preserveContrib
1494    *
1495    * @return object
1496    *   $membershipPayment deleted membership payment object
1497    */
1498   public static function deleteMembershipPayment($membershipId, $preserveContrib = FALSE) {
1499
1500     $membershipPayment = new CRM_Member_DAO_MembershipPayment();
1501     $membershipPayment->membership_id = $membershipId;
1502     $membershipPayment->find();
1503
1504     while ($membershipPayment->fetch()) {
1505       if (!$preserveContrib) {
1506         CRM_Contribute_BAO_Contribution::deleteContribution($membershipPayment->contribution_id);
1507       }
1508       CRM_Utils_Hook::pre('delete', 'MembershipPayment', $membershipPayment->id, $membershipPayment);
1509       $membershipPayment->delete();
1510       CRM_Utils_Hook::post('delete', 'MembershipPayment', $membershipPayment->id, $membershipPayment);
1511     }
1512     return $membershipPayment;
1513   }
1514
1515   /**
1516    * Build an array of available membership types.
1517    *
1518    * @param CRM_Core_Form $form
1519    * @param array $membershipTypeID
1520    * @param bool $activeOnly
1521    *   Do we only want active ones?
1522    *   (probably this should default to TRUE but as a newly added parameter we are leaving default b
1523    *   behaviour unchanged).
1524    *
1525    * @return array
1526    *
1527    * @throws \CiviCRM_API3_Exception
1528    */
1529   public static function buildMembershipTypeValues($form, $membershipTypeID = [], $activeOnly = FALSE) {
1530     $membershipTypeIDS = (array) $membershipTypeID;
1531     $membershipTypeValues = CRM_Member_BAO_MembershipType::getPermissionedMembershipTypes();
1532
1533     // MembershipTypes are already filtered by domain, filter as appropriate by is_active & a passed in list of ids.
1534     foreach ($membershipTypeValues as $id => $type) {
1535       if (($activeOnly && empty($type['is_active']))
1536         || (!empty($membershipTypeIDS) && !in_array($id, $membershipTypeIDS, FALSE))
1537       ) {
1538         unset($membershipTypeValues[$id]);
1539       }
1540     }
1541
1542     CRM_Utils_Hook::membershipTypeValues($form, $membershipTypeValues);
1543
1544     if (is_numeric($membershipTypeID) &&
1545       $membershipTypeID > 0
1546     ) {
1547       CRM_Core_Error::deprecatedFunctionWarning('Non arrays deprecated');
1548       return $membershipTypeValues[$membershipTypeID];
1549     }
1550     return $membershipTypeValues;
1551   }
1552
1553   /**
1554    * Get membership record count for a Contact.
1555    *
1556    * @param int $contactID
1557    * @param bool $activeOnly
1558    *
1559    * @return null|string
1560    */
1561   public static function getContactMembershipCount($contactID, $activeOnly = FALSE) {
1562     CRM_Financial_BAO_FinancialType::getAvailableMembershipTypes($membershipTypes);
1563     $addWhere = " AND membership_type_id IN (0)";
1564     if (!empty($membershipTypes)) {
1565       $addWhere = " AND membership_type_id IN (" . implode(',', array_keys($membershipTypes)) . ")";
1566     }
1567     $select = "SELECT count(*) FROM civicrm_membership ";
1568     $where = "WHERE civicrm_membership.contact_id = {$contactID} AND civicrm_membership.is_test = 0 ";
1569
1570     // CRM-6627, all status below 3 (active, pending, grace) are considered active
1571     if ($activeOnly) {
1572       $select .= " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
1573       $where .= " and civicrm_membership_status.is_current_member = 1";
1574     }
1575
1576     $query = $select . $where . $addWhere;
1577     return CRM_Core_DAO::singleValueQuery($query);
1578   }
1579
1580   /**
1581    * Check whether payment processor supports cancellation of membership subscription.
1582    *
1583    * @param int $mid
1584    *   Membership id.
1585    *
1586    * @param bool $isNotCancelled
1587    *
1588    * @return bool
1589    */
1590   public static function isCancelSubscriptionSupported($mid, $isNotCancelled = TRUE) {
1591     $cacheKeyString = "$mid";
1592     $cacheKeyString .= $isNotCancelled ? '_1' : '_0';
1593
1594     static $supportsCancel = [];
1595
1596     if (!array_key_exists($cacheKeyString, $supportsCancel)) {
1597       $supportsCancel[$cacheKeyString] = FALSE;
1598       $isCancelled = FALSE;
1599
1600       if ($isNotCancelled) {
1601         $isCancelled = self::isSubscriptionCancelled($mid);
1602       }
1603
1604       $paymentObject = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($mid, 'membership', 'obj');
1605       if (!empty($paymentObject)) {
1606         $supportsCancel[$cacheKeyString] = $paymentObject->supports('cancelRecurring') && !$isCancelled;
1607       }
1608     }
1609     return $supportsCancel[$cacheKeyString];
1610   }
1611
1612   /**
1613    * Check whether subscription is already cancelled.
1614    *
1615    * @param int $mid
1616    *   Membership id.
1617    *
1618    * @return string
1619    *   contribution status
1620    */
1621   public static function isSubscriptionCancelled($mid) {
1622     $sql = "
1623    SELECT cr.contribution_status_id
1624      FROM civicrm_contribution_recur cr
1625 LEFT JOIN civicrm_membership mem ON ( cr.id = mem.contribution_recur_id )
1626     WHERE mem.id = %1 LIMIT 1";
1627     $params = [1 => [$mid, 'Integer']];
1628     $statusId = CRM_Core_DAO::singleValueQuery($sql, $params);
1629     $status = CRM_Contribute_PseudoConstant::contributionStatus($statusId, 'name');
1630     if ($status == 'Cancelled') {
1631       return TRUE;
1632     }
1633     return FALSE;
1634   }
1635
1636   /**
1637    * Get membership joins for a specified membership type.
1638    *
1639    * Specifically, retrieves a count of still current memberships whose
1640    * join_date and start_date are within a specified date range.  Dates match
1641    * the pattern "yyyy-mm-dd".
1642    *
1643    * @param int $membershipTypeId
1644    *   Membership type id.
1645    * @param int $startDate
1646    *   Date on which to start counting.
1647    * @param int $endDate
1648    *   Date on which to end counting.
1649    * @param bool|int $isTest if true, membership is for a test site
1650    *
1651    * @return int
1652    *   the number of members of type $membershipTypeId
1653    *   whose join_date is between $startDate and $endDate and
1654    *   whose start_date is between $startDate and $endDate
1655    */
1656   public static function getMembershipJoins($membershipTypeId, $startDate, $endDate, $isTest = 0) {
1657     $testClause = 'membership.is_test = 1';
1658     if (!$isTest) {
1659       $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
1660     }
1661     if (!self::$_signupActType) {
1662       self::_getActTypes();
1663     }
1664
1665     if (!self::$_signupActType) {
1666       return 0;
1667     }
1668
1669     $query = "
1670     SELECT  COUNT(DISTINCT membership.id) as member_count
1671       FROM  civicrm_membership membership
1672 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id = %1)
1673 INNER JOIN  civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
1674 INNER JOIN  civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
1675      WHERE  membership.membership_type_id = %2
1676        AND  activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
1677        AND  {$testClause}";
1678
1679     $params = [
1680       1 => [self::$_signupActType, 'Integer'],
1681       2 => [$membershipTypeId, 'Integer'],
1682     ];
1683
1684     $memberCount = CRM_Core_DAO::singleValueQuery($query, $params);
1685
1686     return (int) $memberCount;
1687   }
1688
1689   /**
1690    * Get membership renewals for a specified membership type.
1691    *
1692    * Specifically, retrieves a count of still current memberships
1693    * whose join_date is before and start_date is within a specified date
1694    * range.  Dates match the pattern "yyyy-mm-dd".
1695    *
1696    * @param int $membershipTypeId
1697    *   Membership type id.
1698    * @param int $startDate
1699    *   Date on which to start counting.
1700    * @param int $endDate
1701    *   Date on which to end counting.
1702    * @param bool|int $isTest if true, membership is for a test site
1703    *
1704    * @return int
1705    *   returns the number of members of type $membershipTypeId
1706    *   whose join_date is before $startDate and
1707    *   whose start_date is between $startDate and $endDate
1708    */
1709   public static function getMembershipRenewals($membershipTypeId, $startDate, $endDate, $isTest = 0) {
1710     $testClause = 'membership.is_test = 1';
1711     if (!$isTest) {
1712       $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
1713     }
1714     if (!self::$_renewalActType) {
1715       self::_getActTypes();
1716     }
1717
1718     if (!self::$_renewalActType) {
1719       return 0;
1720     }
1721
1722     $query = "
1723     SELECT  COUNT(DISTINCT membership.id) as member_count
1724       FROM  civicrm_membership membership
1725 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id = %1)
1726 INNER JOIN  civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
1727 INNER JOIN  civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
1728      WHERE  membership.membership_type_id = %2
1729        AND  activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
1730        AND  {$testClause}";
1731
1732     $params = [
1733       1 => [self::$_renewalActType, 'Integer'],
1734       2 => [$membershipTypeId, 'Integer'],
1735     ];
1736     $memberCount = CRM_Core_DAO::singleValueQuery($query, $params);
1737
1738     return (int) $memberCount;
1739   }
1740
1741   /**
1742    * @param int $contactID
1743    * @param int $membershipTypeID
1744    * @param bool $is_test
1745    * @param string $changeToday
1746    * @param int $modifiedID
1747    * @param $customFieldsFormatted
1748    * @param $numRenewTerms
1749    * @param int $membershipID
1750    * @param $pending
1751    * @param int $contributionRecurID
1752    * @param $membershipSource
1753    * @param $isPayLater
1754    * @param int $campaignId
1755    * @param array $formDates
1756    * @param null|CRM_Contribute_BAO_Contribution $contribution
1757    * @param array $lineItems
1758    *
1759    * @return array
1760    * @throws \CRM_Core_Exception
1761    * @throws \CiviCRM_API3_Exception
1762    */
1763   public static function processMembership($contactID, $membershipTypeID, $is_test, $changeToday, $modifiedID, $customFieldsFormatted, $numRenewTerms, $membershipID, $pending, $contributionRecurID, $membershipSource, $isPayLater, $campaignId, $formDates = [], $contribution = NULL, $lineItems = []) {
1764     $renewalMode = $updateStatusId = FALSE;
1765     $allStatus = CRM_Member_PseudoConstant::membershipStatus();
1766     $format = '%Y%m%d';
1767     $statusFormat = '%Y-%m-%d';
1768     $membershipTypeDetails = CRM_Member_BAO_MembershipType::getMembershipType($membershipTypeID);
1769     $dates = [];
1770     $ids = [];
1771
1772     // CRM-7297 - allow membership type to be be changed during renewal so long as the parent org of new membershipType
1773     // is the same as the parent org of an existing membership of the contact
1774     $currentMembership = CRM_Member_BAO_Membership::getContactMembership($contactID, $membershipTypeID,
1775       $is_test, $membershipID, TRUE
1776     );
1777     if ($currentMembership) {
1778       $renewalMode = TRUE;
1779
1780       // Do NOT do anything.
1781       //1. membership with status : PENDING/CANCELLED (CRM-2395)
1782       //2. Paylater/IPN renew. CRM-4556.
1783       if ($pending || in_array($currentMembership['status_id'], [
1784         array_search('Pending', $allStatus),
1785         // CRM-15475
1786         array_search('Cancelled', CRM_Member_PseudoConstant::membershipStatus(NULL, " name = 'Cancelled' ", 'name', FALSE, TRUE)),
1787       ])) {
1788
1789         $memParams = [
1790           'id' => $currentMembership['id'],
1791           'contribution' => $contribution,
1792           'status_id' => $currentMembership['status_id'],
1793           'start_date' => $currentMembership['start_date'],
1794           'end_date' => $currentMembership['end_date'],
1795           'line_item' => $lineItems,
1796           'join_date' => $currentMembership['join_date'],
1797           'membership_type_id' => $membershipTypeID,
1798           'max_related' => !empty($membershipTypeDetails['max_related']) ? $membershipTypeDetails['max_related'] : NULL,
1799           'membership_activity_status' => ($pending || $isPayLater) ? 'Scheduled' : 'Completed',
1800         ];
1801         if ($contributionRecurID) {
1802           $memParams['contribution_recur_id'] = $contributionRecurID;
1803         }
1804
1805         $membership = self::create($memParams);
1806         return [$membership, $renewalMode, $dates];
1807       }
1808
1809       // Check and fix the membership if it is STALE
1810       self::fixMembershipStatusBeforeRenew($currentMembership, $changeToday);
1811
1812       // Now Renew the membership
1813       if (!$currentMembership['is_current_member']) {
1814         // membership is not CURRENT
1815
1816         // CRM-7297 Membership Upsell - calculate dates based on new membership type
1817         $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($currentMembership['id'],
1818           $changeToday,
1819           $membershipTypeID,
1820           $numRenewTerms
1821         );
1822
1823         $currentMembership['join_date'] = CRM_Utils_Date::customFormat($currentMembership['join_date'], $format);
1824         foreach (['start_date', 'end_date'] as $dateType) {
1825           $currentMembership[$dateType] = $formDates[$dateType] ?? NULL;
1826           if (empty($currentMembership[$dateType])) {
1827             $currentMembership[$dateType] = $dates[$dateType] ?? NULL;
1828           }
1829         }
1830         $currentMembership['is_test'] = $is_test;
1831
1832         if (!empty($membershipSource)) {
1833           $currentMembership['source'] = $membershipSource;
1834         }
1835
1836         if (!empty($currentMembership['id'])) {
1837           $ids['membership'] = $currentMembership['id'];
1838         }
1839         $memParams = $currentMembership;
1840         $memParams['membership_type_id'] = $membershipTypeID;
1841
1842         //set the log start date.
1843         $memParams['log_start_date'] = CRM_Utils_Date::customFormat($dates['log_start_date'], $format);
1844       }
1845       else {
1846
1847         // CURRENT Membership
1848         $membership = new CRM_Member_DAO_Membership();
1849         $membership->id = $currentMembership['id'];
1850         $membership->find(TRUE);
1851         // CRM-7297 Membership Upsell - calculate dates based on new membership type
1852         $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membership->id,
1853           $changeToday,
1854           $membershipTypeID,
1855           $numRenewTerms
1856         );
1857
1858         // Insert renewed dates for CURRENT membership
1859         $memParams = [];
1860         $memParams['join_date'] = CRM_Utils_Date::isoToMysql($membership->join_date);
1861         $memParams['start_date'] = $formDates['start_date'] ?? CRM_Utils_Date::isoToMysql($membership->start_date);
1862         $memParams['end_date'] = $formDates['end_date'] ?? NULL;
1863         if (empty($memParams['end_date'])) {
1864           $memParams['end_date'] = $dates['end_date'] ?? NULL;
1865         }
1866         $memParams['membership_type_id'] = $membershipTypeID;
1867
1868         //set the log start date.
1869         $memParams['log_start_date'] = CRM_Utils_Date::customFormat($dates['log_start_date'], $format);
1870
1871         //CRM-18067
1872         if (!empty($membershipSource)) {
1873           $memParams['source'] = $membershipSource;
1874         }
1875         elseif (empty($membership->source)) {
1876           $memParams['source'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
1877             $currentMembership['id'],
1878             'source'
1879           );
1880         }
1881
1882         if (!empty($currentMembership['id'])) {
1883           $ids['membership'] = $currentMembership['id'];
1884         }
1885         $memParams['membership_activity_status'] = ($pending || $isPayLater) ? 'Scheduled' : 'Completed';
1886       }
1887     }
1888     else {
1889       // NEW Membership
1890       $memParams = [
1891         'contact_id' => $contactID,
1892         'membership_type_id' => $membershipTypeID,
1893       ];
1894
1895       if (!$pending) {
1896         $dates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($membershipTypeID, NULL, NULL, NULL, $numRenewTerms);
1897
1898         foreach (['join_date', 'start_date', 'end_date'] as $dateType) {
1899           $memParams[$dateType] = $formDates[$dateType] ?? NULL;
1900           if (empty($memParams[$dateType])) {
1901             $memParams[$dateType] = $dates[$dateType] ?? NULL;
1902           }
1903         }
1904
1905         $status = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate(CRM_Utils_Date::customFormat($dates['start_date'],
1906           $statusFormat
1907         ),
1908           CRM_Utils_Date::customFormat($dates['end_date'],
1909             $statusFormat
1910           ),
1911           CRM_Utils_Date::customFormat($dates['join_date'],
1912             $statusFormat
1913           ),
1914           'now',
1915           TRUE,
1916           $membershipTypeID,
1917           $memParams
1918         );
1919         $updateStatusId = $status['id'] ?? NULL;
1920       }
1921       else {
1922         // if IPN/Pay-Later set status to: PENDING
1923         $updateStatusId = array_search('Pending', $allStatus);
1924       }
1925
1926       if (!empty($membershipSource)) {
1927         $memParams['source'] = $membershipSource;
1928       }
1929       $memParams['is_test'] = $is_test;
1930       $memParams['is_pay_later'] = $isPayLater;
1931     }
1932     // Putting this in an IF is precautionary as it seems likely that it would be ignored if empty, but
1933     // perhaps shouldn't be?
1934     if ($contributionRecurID) {
1935       $memParams['contribution_recur_id'] = $contributionRecurID;
1936     }
1937     //CRM-4555
1938     //if we decided status here and want to skip status
1939     //calculation in create( ); then need to pass 'skipStatusCal'.
1940     if ($updateStatusId) {
1941       $memParams['status_id'] = $updateStatusId;
1942       $memParams['skipStatusCal'] = TRUE;
1943     }
1944
1945     //since we are renewing,
1946     //make status override false.
1947     $memParams['is_override'] = FALSE;
1948
1949     //CRM-4027, create log w/ individual contact.
1950     if ($modifiedID) {
1951       // @todo this param is likely unused now.
1952       $memParams['is_for_organization'] = TRUE;
1953     }
1954     $params['modified_id'] = $modifiedID ?? $contactID;
1955
1956     //inherit campaign from contrib page.
1957     if (isset($campaignId)) {
1958       $memParams['campaign_id'] = $campaignId;
1959     }
1960
1961     $memParams['contribution'] = $contribution;
1962     $memParams['custom'] = $customFieldsFormatted;
1963     // Load all line items & process all in membership. Don't do in contribution.
1964     // Relevant tests in api_v3_ContributionPageTest.
1965     $memParams['line_item'] = $lineItems;
1966     // @todo stop passing $ids (membership and userId may be set by this point)
1967     $membership = self::create($memParams, $ids);
1968
1969     // not sure why this statement is here, seems quite odd :( - Lobo: 12/26/2010
1970     // related to: http://forum.civicrm.org/index.php/topic,11416.msg49072.html#msg49072
1971     $membership->find(TRUE);
1972
1973     return [$membership, $renewalMode, $dates];
1974   }
1975
1976   /**
1977    * Get line items representing the default price set.
1978    *
1979    * @param int $membershipOrg
1980    * @param int $membershipTypeID
1981    * @param float $total_amount
1982    * @param int $priceSetId
1983    *
1984    * @return array
1985    */
1986   public static function setQuickConfigMembershipParameters($membershipOrg, $membershipTypeID, $total_amount, $priceSetId) {
1987     $priceSets = current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId));
1988
1989     // The name of the price field corresponds to the membership_type organization contact.
1990     $params = [
1991       'price_set_id' => $priceSetId,
1992       'name' => $membershipOrg,
1993     ];
1994     $results = [];
1995     CRM_Price_BAO_PriceField::retrieve($params, $results);
1996
1997     if (!empty($results)) {
1998       $fields[$results['id']] = $priceSets['fields'][$results['id']];
1999       $fid = $results['id'];
2000       $editedFieldParams = [
2001         'price_field_id' => $results['id'],
2002         'membership_type_id' => $membershipTypeID,
2003       ];
2004       $results = [];
2005       CRM_Price_BAO_PriceFieldValue::retrieve($editedFieldParams, $results);
2006       $fields[$fid]['options'][$results['id']] = $priceSets['fields'][$fid]['options'][$results['id']];
2007       if (!empty($total_amount)) {
2008         $fields[$fid]['options'][$results['id']]['amount'] = $total_amount;
2009       }
2010     }
2011
2012     $fieldID = key($fields);
2013     $returnParams = [
2014       'price_set_id' => $priceSetId,
2015       'price_sets' => $priceSets,
2016       'fields' => $fields,
2017       'price_fields' => [
2018         'price_' . $fieldID => $results['id'] ?? NULL,
2019       ],
2020     ];
2021     return $returnParams;
2022   }
2023
2024   /**
2025    * Update the status of all deceased members to deceased.
2026    *
2027    * @return int
2028    *   Count of updated contacts.
2029    *
2030    * @throws \CiviCRM_API3_Exception
2031    * @throws \CRM_Core_Exception
2032    */
2033   protected static function updateDeceasedMembersStatuses() {
2034     $count = 0;
2035
2036     $deceasedStatusId = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Deceased');
2037
2038     // 'create' context for buildOptions returns only if enabled.
2039     $allStatus = self::buildOptions('status_id', 'create');
2040     if (array_key_exists($deceasedStatusId, $allStatus) === FALSE) {
2041       // Deceased status is an admin status & is required. We want to fail early if
2042       // it is not present or active.
2043       // We could make the case 'some databases just don't use deceased so we will check
2044       // for the presence of a deceased contact in the DB before rejecting.
2045       if (CRM_Core_DAO::singleValueQuery('
2046         SELECT count(*) FROM civicrm_contact WHERE is_deceased = 0'
2047       )) {
2048         throw new CRM_Core_Exception(
2049           ts("Deceased Membership status is missing or not active. <a href='%1'>Click here to check</a>.",
2050             [1 => CRM_Utils_System::url('civicrm/admin/member/membershipStatus', 'reset=1')]
2051           ));
2052       }
2053     }
2054     $deceasedDAO = CRM_Core_DAO::executeQuery(
2055       $baseQuery = "
2056        SELECT membership.id as membership_id
2057        FROM civicrm_membership membership
2058        INNER JOIN civicrm_contact ON membership.contact_id = civicrm_contact.id
2059        INNER JOIN civicrm_membership_type ON membership.membership_type_id = civicrm_membership_type.id
2060          AND civicrm_membership_type.is_active = 1
2061        WHERE membership.is_test = 0
2062          AND civicrm_contact.is_deceased = 1
2063          AND membership.status_id <> %1
2064       ",
2065       [1 => [$deceasedStatusId, 'Integer']]
2066     );
2067     while ($deceasedDAO->fetch()) {
2068       civicrm_api3('membership', 'create', [
2069         'id' => $deceasedDAO->membership_id,
2070         'status_id' => $deceasedStatusId,
2071         'createActivity' => TRUE,
2072         'skipStatusCal' => TRUE,
2073         'skipRecentView' => TRUE,
2074       ]);
2075       $count++;
2076     }
2077     return $count;
2078   }
2079
2080   /**
2081    * Does the existing membership match the required membership.
2082    *
2083    * Check before updating that the params are not a match - this is part of avoiding
2084    * a loop if we have already updated.
2085    *
2086    * https://issues.civicrm.org/jira/browse/CRM-4213
2087    * @param array $params
2088    *
2089    * @param array $membership
2090    *
2091    * @return bool
2092    */
2093   protected static function matchesRequiredMembership($params, $membership) {
2094     foreach (['start_date', 'end_date'] as $date) {
2095       if (strtotime($params[$date]) !== strtotime($membership[$date])) {
2096         return FALSE;
2097       }
2098       if ((int) $params['status_id'] !== (int) $membership['status_id']) {
2099         return FALSE;
2100       }
2101       if ((int) $params['membership_type_id'] !== (int) $membership['membership_type_id']) {
2102         return FALSE;
2103       }
2104     }
2105     return TRUE;
2106   }
2107
2108   /**
2109    * Params of new membership.
2110    *
2111    * @param array $params
2112    *
2113    * @return bool
2114    * @throws \CiviCRM_API3_Exception
2115    */
2116   protected static function hasExistingInheritedMembership($params) {
2117     foreach (civicrm_api3('Membership', 'get', ['contact_id' => $params['contact_id']])['values'] as $membership) {
2118       if (!empty($membership['owner_membership_id'])
2119         && $membership['membership_type_id'] === $params['membership_type_id']
2120         && (int) $params['owner_membership_id'] !== (int) $membership['owner_membership_id']
2121       ) {
2122         // Inheriting it from another contact, don't update here.
2123         return TRUE;
2124       }
2125       if (self::matchesRequiredMembership($params, $membership)) {
2126         return TRUE;
2127       }
2128     }
2129     return FALSE;
2130   }
2131
2132   /**
2133    * Process price set and line items.
2134    *
2135    * @param int $membershipId
2136    * @param array $lineItem
2137    *
2138    * @throws \CiviCRM_API3_Exception
2139    */
2140   public function processPriceSet($membershipId, $lineItem) {
2141     //FIXME : need to move this too
2142     if (!$membershipId || !is_array($lineItem)
2143       || CRM_Utils_System::isNull($lineItem)
2144     ) {
2145       return;
2146     }
2147
2148     foreach ($lineItem as $priceSetId => $values) {
2149       if (!$priceSetId) {
2150         continue;
2151       }
2152       foreach ($values as $line) {
2153         $line['entity_table'] = 'civicrm_membership';
2154         $line['entity_id'] = $membershipId;
2155         CRM_Price_BAO_LineItem::create($line);
2156       }
2157     }
2158   }
2159
2160   /**
2161    * Retrieve the contribution id for the associated Membership id.
2162    * @todo we should get this off the line item
2163    *
2164    * @param int $membershipId
2165    *   Membership id.
2166    * @param bool $all
2167    *   if more than one payment associated with membership id need to be returned.
2168    *
2169    * @return int|int[]
2170    *   contribution id
2171    * @todo we should get this off the line item
2172    *
2173    */
2174   public static function getMembershipContributionId($membershipId, $all = FALSE) {
2175
2176     $membershipPayment = new CRM_Member_DAO_MembershipPayment();
2177     $membershipPayment->membership_id = $membershipId;
2178     if ($all && $membershipPayment->find()) {
2179       $contributionIds = [];
2180       while ($membershipPayment->fetch()) {
2181         $contributionIds[] = $membershipPayment->contribution_id;
2182       }
2183       return $contributionIds;
2184     }
2185
2186     if ($membershipPayment->find(TRUE)) {
2187       return $membershipPayment->contribution_id;
2188     }
2189     return NULL;
2190   }
2191
2192   /**
2193    * The function checks and updates the status of all membership records for a given domain using the
2194    * calc_membership_status and update_contact_membership APIs.
2195    *
2196    * IMPORTANT:
2197    * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
2198    *
2199    * @param array $params
2200    *   only_active_membership_types, exclude_test_memberships, exclude_membership_status_ids
2201    *
2202    * @return array
2203    *
2204    * @throws \CiviCRM_API3_Exception
2205    * @throws \CRM_Core_Exception
2206    */
2207   public static function updateAllMembershipStatus($params = []) {
2208     // We want all of the statuses as id => name, even the disabled ones (cf.
2209     // CRM-15475), to identify which are Pending, Deceased, Cancelled, and
2210     // Expired.
2211     $allStatus = CRM_Member_BAO_Membership::buildOptions('status_id', 'validate');
2212     if (empty($params['exclude_membership_status_ids'])) {
2213       $params['exclude_membership_status_ids'] = [
2214         array_search('Pending', $allStatus),
2215         array_search('Cancelled', $allStatus),
2216         array_search('Expired', $allStatus) ?: 0,
2217         array_search('Deceased', $allStatus),
2218       ];
2219     }
2220     // Deceased is *always* excluded because it is has very specific processing below.
2221     elseif (!in_array(array_search('Deceased', $allStatus), $params['exclude_membership_status_ids'])) {
2222       $params['exclude_membership_status_ids'][] = array_search('Deceased', $allStatus);
2223     }
2224
2225     for ($index = 0; $index < count($params['exclude_membership_status_ids']); $index++) {
2226       $queryParams[$index] = [$params['exclude_membership_status_ids'][$index], 'Integer'];
2227     }
2228     $membershipStatusClause = 'civicrm_membership.status_id NOT IN (%' . implode(', %', array_keys($queryParams)) . ')';
2229
2230     // Tests for this function are in api_v3_JobTest. Please add tests for all updates.
2231
2232     $updateCount = $processCount = self::updateDeceasedMembersStatuses();
2233
2234     $whereClauses[] = 'civicrm_contact.is_deceased = 0';
2235     if ($params['exclude_test_memberships']) {
2236       $whereClauses[] = 'civicrm_membership.is_test = 0';
2237     }
2238     $whereClause = implode(' AND ', $whereClauses);
2239     $activeMembershipClause = '';
2240     if ($params['only_active_membership_types']) {
2241       $activeMembershipClause = ' AND civicrm_membership_type.is_active = 1';
2242     }
2243
2244     // This query retrieves ALL memberships of active types.
2245     $baseQuery = "
2246 SELECT     civicrm_membership.id                    as membership_id,
2247            civicrm_membership.is_override           as is_override,
2248            civicrm_membership.status_override_end_date  as status_override_end_date,
2249            civicrm_membership.membership_type_id    as membership_type_id,
2250            civicrm_membership.status_id             as status_id,
2251            civicrm_membership.join_date             as join_date,
2252            civicrm_membership.start_date            as start_date,
2253            civicrm_membership.end_date              as end_date,
2254            civicrm_membership.source                as source,
2255            civicrm_contact.id                       as contact_id,
2256            civicrm_membership.owner_membership_id   as owner_membership_id,
2257            civicrm_membership.contribution_recur_id as recur_id
2258 FROM       civicrm_membership
2259 INNER JOIN civicrm_contact ON ( civicrm_membership.contact_id = civicrm_contact.id )
2260 INNER JOIN civicrm_membership_type ON
2261   (civicrm_membership.membership_type_id = civicrm_membership_type.id {$activeMembershipClause})
2262 WHERE {$whereClause}";
2263
2264     $query = $baseQuery . " AND civicrm_membership.is_override IS NOT NULL AND civicrm_membership.status_override_end_date IS NOT NULL";
2265     $dao1 = CRM_Core_DAO::executeQuery($query);
2266     while ($dao1->fetch()) {
2267       self::processOverriddenUntilDateMembership($dao1);
2268     }
2269
2270     $query = $baseQuery . " AND (civicrm_membership.is_override = 0 OR civicrm_membership.is_override IS NULL)
2271      AND {$membershipStatusClause}
2272      AND civicrm_membership.owner_membership_id IS NULL ";
2273
2274     $allMembershipTypes = CRM_Member_BAO_MembershipType::getAllMembershipTypes();
2275
2276     $dao2 = CRM_Core_DAO::executeQuery($query, $queryParams);
2277
2278     while ($dao2->fetch()) {
2279       $processCount++;
2280
2281       // CRM-7248: added excludeIsAdmin param to the following fn call to prevent moving to admin statuses
2282       //get the membership status as per id.
2283       $newStatus = civicrm_api3('membership_status', 'calc',
2284         [
2285           'membership_id' => $dao2->membership_id,
2286           'ignore_admin_only' => TRUE,
2287         ], TRUE
2288       );
2289       $statusId = $newStatus['id'] ?? NULL;
2290
2291       //process only when status change.
2292       if ($statusId &&
2293         $statusId != $dao2->status_id
2294       ) {
2295         $memberParams = [
2296           'id' => $dao2->membership_id,
2297           'skipStatusCal' => TRUE,
2298           'skipRecentView' => TRUE,
2299           'status_id' => $statusId,
2300           'createActivity' => TRUE,
2301         ];
2302
2303         //process member record.
2304         civicrm_api3('membership', 'create', $memberParams);
2305         $updateCount++;
2306       }
2307     }
2308     $result['is_error'] = 0;
2309     $result['messages'] = ts('Processed %1 membership records. Updated %2 records.', [
2310       1 => $processCount,
2311       2 => $updateCount,
2312     ]);
2313     return $result;
2314   }
2315
2316   /**
2317    * Set is_override for the 'overridden until date' membership to
2318    * False and clears the 'until date' field in case the 'until date'
2319    * is equal or after today date.
2320    *
2321    * @param CRM_Core_DAO $membership
2322    *   The membership to be processed
2323    *
2324    * @throws \CiviCRM_API3_Exception
2325    */
2326   private static function processOverriddenUntilDateMembership($membership) {
2327     $isOverriddenUntilDate = !empty($membership->is_override) && !empty($membership->status_override_end_date);
2328     if (!$isOverriddenUntilDate) {
2329       return;
2330     }
2331
2332     $todayDate = new DateTime();
2333     $todayDate->setTime(0, 0);
2334
2335     $overrideEndDate = new DateTime($membership->status_override_end_date);
2336     $overrideEndDate->setTime(0, 0);
2337
2338     $datesDifference = $todayDate->diff($overrideEndDate);
2339     $daysDifference = (int) $datesDifference->format('%R%a');
2340     if ($daysDifference <= 0) {
2341       $params = [
2342         'id' => $membership->membership_id,
2343         'is_override' => FALSE,
2344         'status_override_end_date' => 'null',
2345       ];
2346       civicrm_api3('membership', 'create', $params);
2347     }
2348   }
2349
2350   /**
2351    * Returns the membership types for a particular contact
2352    * who has lifetime membership without end date.
2353    *
2354    * @param int $contactID
2355    * @param bool $isTest
2356    * @param bool $onlyLifeTime
2357    *
2358    * @return array
2359    */
2360   public static function getAllContactMembership($contactID, $isTest = FALSE, $onlyLifeTime = FALSE) {
2361     $contactMembershipType = [];
2362     if (!$contactID) {
2363       return $contactMembershipType;
2364     }
2365
2366     $dao = new CRM_Member_DAO_Membership();
2367     $dao->contact_id = $contactID;
2368     $pendingStatusId = array_search('Pending', CRM_Member_PseudoConstant::membershipStatus());
2369     $dao->whereAdd("status_id != $pendingStatusId");
2370
2371     if ($isTest) {
2372       $dao->is_test = $isTest;
2373     }
2374     else {
2375       $dao->whereAdd('is_test IS NULL OR is_test = 0');
2376     }
2377
2378     if ($onlyLifeTime) {
2379       $dao->whereAdd('end_date IS NULL');
2380     }
2381
2382     $dao->find();
2383     while ($dao->fetch()) {
2384       $membership = [];
2385       CRM_Core_DAO::storeValues($dao, $membership);
2386       $contactMembershipType[$dao->membership_type_id] = $membership;
2387     }
2388     return $contactMembershipType;
2389   }
2390
2391   /**
2392    * Record contribution record associated with membership.
2393    * This will update an existing contribution if $params['contribution_id'] is passed in.
2394    * This will create a MembershipPayment to link the contribution and membership
2395    *
2396    * @param array $params
2397    *   Array of submitted params.
2398    *
2399    * @return CRM_Contribute_BAO_Contribution
2400    * @throws \CRM_Core_Exception
2401    * @throws \CiviCRM_API3_Exception
2402    */
2403   public static function recordMembershipContribution(&$params) {
2404     $membershipId = $params['membership_id'];
2405     $contributionParams = [];
2406     $config = CRM_Core_Config::singleton();
2407     $contributionParams['currency'] = $config->defaultCurrency;
2408     $contributionParams['receipt_date'] = !empty($params['receipt_date']) ? $params['receipt_date'] : 'null';
2409     $contributionParams['source'] = $params['contribution_source'] ?? NULL;
2410     $contributionParams['non_deductible_amount'] = 'null';
2411     $contributionParams['skipCleanMoney'] = TRUE;
2412     $contributionParams['payment_processor'] = $params['payment_processor_id'] ?? NULL;
2413     $contributionSoftParams = $params['soft_credit'] ?? NULL;
2414     $recordContribution = [
2415       'contact_id',
2416       'fee_amount',
2417       'total_amount',
2418       'receive_date',
2419       'financial_type_id',
2420       'payment_instrument_id',
2421       'trxn_id',
2422       'invoice_id',
2423       'is_test',
2424       'contribution_status_id',
2425       'check_number',
2426       'campaign_id',
2427       'is_pay_later',
2428       'membership_id',
2429       'tax_amount',
2430       'skipLineItem',
2431       'contribution_recur_id',
2432       'pan_truncation',
2433       'card_type_id',
2434     ];
2435     foreach ($recordContribution as $f) {
2436       $contributionParams[$f] = $params[$f] ?? NULL;
2437     }
2438
2439     if (!empty($params['contribution_id'])) {
2440       $contributionParams['id'] = $params['contribution_id'];
2441     }
2442     // make entry in batch entity batch table
2443     if (!empty($params['batch_id'])) {
2444       $contributionParams['batch_id'] = $params['batch_id'];
2445     }
2446
2447     if (!empty($params['contribution_contact_id'])) {
2448       // deal with possibility of a different person paying for contribution
2449       $contributionParams['contact_id'] = $params['contribution_contact_id'];
2450     }
2451
2452     if (!empty($params['processPriceSet']) &&
2453       !empty($params['lineItems'])
2454     ) {
2455       $contributionParams['line_item'] = $params['lineItems'] ?? NULL;
2456     }
2457
2458     $contribution = CRM_Contribute_BAO_Contribution::create($contributionParams);
2459
2460     //CRM-13981, create new soft-credit record as to record payment from different person for this membership
2461     if (!empty($contributionSoftParams)) {
2462       if (!empty($params['batch_id'])) {
2463         foreach ($contributionSoftParams as $contributionSoft) {
2464           $contributionSoft['contribution_id'] = $contribution->id;
2465           $contributionSoft['currency'] = $contribution->currency;
2466           CRM_Contribute_BAO_ContributionSoft::add($contributionSoft);
2467         }
2468       }
2469       else {
2470         $contributionSoftParams['contribution_id'] = $contribution->id;
2471         $contributionSoftParams['currency'] = $contribution->currency;
2472         $contributionSoftParams['amount'] = $contribution->total_amount;
2473         CRM_Contribute_BAO_ContributionSoft::add($contributionSoftParams);
2474       }
2475     }
2476
2477     // store contribution id
2478     $params['contribution_id'] = $contribution->id;
2479
2480     // Create membership payment if it does not already exist
2481     $membershipPayment = civicrm_api3('MembershipPayment', 'get', [
2482       'contribution_id' => $contribution->id,
2483     ]);
2484     if (empty($membershipPayment['count'])) {
2485       civicrm_api3('MembershipPayment', 'create', [
2486         'membership_id' => $membershipId,
2487         'contribution_id' => $contribution->id,
2488       ]);
2489     }
2490
2491     return $contribution;
2492   }
2493
2494   /**
2495    * @todo document me - I seem a bit out of date....
2496    */
2497   public static function _getActTypes() {
2498     $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
2499     self::$_renewalActType = CRM_Utils_Array::key('Membership Renewal', $activityTypes);
2500     self::$_signupActType = CRM_Utils_Array::key('Membership Signup', $activityTypes);
2501   }
2502
2503   /**
2504    * Get all Cancelled Membership(s) for a contact
2505    *
2506    * @param int $contactID
2507    *   Contact id.
2508    * @param bool $isTest
2509    *   Mode of payment.
2510    *
2511    * @return array
2512    *   Array of membership type
2513    */
2514   public static function getContactsCancelledMembership($contactID, $isTest = FALSE) {
2515     if (!$contactID) {
2516       return [];
2517     }
2518     $query = 'SELECT membership_type_id FROM civicrm_membership WHERE contact_id = %1 AND status_id = %2 AND is_test = %3';
2519     $queryParams = [
2520       1 => [$contactID, 'Integer'],
2521       2 => [
2522         // CRM-15475
2523         array_search(
2524           'Cancelled',
2525           CRM_Member_PseudoConstant::membershipStatus(
2526             NULL,
2527             " name = 'Cancelled' ",
2528             'name',
2529             FALSE,
2530             TRUE
2531           )
2532         ),
2533         'Integer',
2534       ],
2535       3 => [$isTest, 'Boolean'],
2536     ];
2537
2538     $dao = CRM_Core_DAO::executeQuery($query, $queryParams);
2539     $cancelledMembershipIds = [];
2540     while ($dao->fetch()) {
2541       $cancelledMembershipIds[] = $dao->membership_type_id;
2542     }
2543     return $cancelledMembershipIds;
2544   }
2545
2546   /**
2547    * Merges the memberships from otherContactID to mainContactID.
2548    *
2549    * General idea is to merge memberships in regards to their type. We
2550    * move the other contact’s contributions to the main contact’s
2551    * membership which has the same type (if any) and then we update
2552    * membership to avoid loosing `join_date`, `end_date`, and
2553    * `status_id`. In this function, we don’t touch the contributions
2554    * directly (CRM_Dedupe_Merger::moveContactBelongings() takes care
2555    * of it).
2556    *
2557    * This function adds new SQL queries to the $sqlQueries parameter.
2558    *
2559    * @param int $mainContactID
2560    *   Contact id of main contact record.
2561    * @param int $otherContactID
2562    *   Contact id of record which is going to merge.
2563    * @param array $sqlQueries
2564    *   (reference) array of SQL queries to be executed.
2565    * @param array $tables
2566    *   List of tables that have to be merged.
2567    * @param array $tableOperations
2568    *   Special options/params for some tables to be merged.
2569    *
2570    * @see CRM_Dedupe_Merger::cpTables()
2571    */
2572   public static function mergeMemberships($mainContactID, $otherContactID, &$sqlQueries, $tables, $tableOperations) {
2573     /*
2574      * If the user requests not to merge memberships but to add them,
2575      * just attribute the `civicrm_membership` to the
2576      * `$mainContactID`. We have to do this here since the general
2577      * merge process is bypassed by this function.
2578      */
2579     if (array_key_exists("civicrm_membership", $tableOperations) && $tableOperations['civicrm_membership']['add']) {
2580       $sqlQueries[] = "UPDATE IGNORE civicrm_membership SET contact_id = $mainContactID WHERE contact_id = $otherContactID";
2581       return;
2582     }
2583
2584     /*
2585      * Retrieve all memberships that belongs to each contacts and
2586      * keep track of each membership type.
2587      */
2588     $mainContactMemberships = [];
2589     $otherContactMemberships = [];
2590
2591     $sql = "SELECT id, membership_type_id FROM civicrm_membership membership WHERE contact_id = %1";
2592     $dao = CRM_Core_DAO::executeQuery($sql, [1 => [$mainContactID, "Integer"]]);
2593     while ($dao->fetch()) {
2594       $mainContactMemberships[$dao->id] = $dao->membership_type_id;
2595     }
2596
2597     $dao = CRM_Core_DAO::executeQuery($sql, [1 => [$otherContactID, "Integer"]]);
2598     while ($dao->fetch()) {
2599       $otherContactMemberships[$dao->id] = $dao->membership_type_id;
2600     }
2601
2602     /*
2603      * For each membership, move related contributions to the main
2604      * contact’s membership (by updating `membership_payments`). Then,
2605      * update membership’s `join_date` (if the other membership’s
2606      * join_date is older) and `end_date` (if the other membership’s
2607      * `end_date` is newer) and `status_id` (if the newly calculated
2608      * status is different).
2609      *
2610      * FIXME: what should we do if we have multiple memberships with
2611      * the same type (currently we only take the first one)?
2612      */
2613     $newSql = [];
2614     foreach ($otherContactMemberships as $otherMembershipId => $otherMembershipTypeId) {
2615       if ($newMembershipId = array_search($otherMembershipTypeId, $mainContactMemberships)) {
2616
2617         /*
2618          * Move other membership’s contributions to the main one only
2619          * if user requested to merge contributions.
2620          */
2621         if (!empty($tables) && in_array('civicrm_contribution', $tables)) {
2622           $newSql[] = "UPDATE civicrm_membership_payment SET membership_id=$newMembershipId WHERE membership_id=$otherMembershipId";
2623         }
2624
2625         $sql = "SELECT * FROM civicrm_membership membership WHERE id = %1";
2626
2627         $newMembership = CRM_Member_DAO_Membership::findById($newMembershipId);
2628         $otherMembership = CRM_Member_DAO_Membership::findById($otherMembershipId);
2629
2630         $updates = [];
2631         if (new DateTime($otherMembership->join_date) < new DateTime($newMembership->join_date)) {
2632           $updates["join_date"] = $otherMembership->join_date;
2633         }
2634
2635         if (new DateTime($otherMembership->end_date) > new DateTime($newMembership->end_date)) {
2636           $updates["end_date"] = $otherMembership->end_date;
2637         }
2638
2639         if (count($updates)) {
2640
2641           /*
2642            * Update status
2643            */
2644           $status = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate(
2645             $updates["start_date"] ?? $newMembership->start_date,
2646             $updates["end_date"] ?? $newMembership->end_date,
2647             $updates["join_date"] ?? $newMembership->join_date,
2648             'now',
2649             FALSE,
2650             $newMembershipId,
2651             $newMembership
2652           );
2653
2654           if (!empty($status['id']) and $status['id'] != $newMembership->status_id) {
2655             $updates['status_id'] = $status['id'];
2656           }
2657
2658           $updates_sql = [];
2659           foreach ($updates as $k => $v) {
2660             $updates_sql[] = "$k = '{$v}'";
2661           }
2662
2663           $newSql[] = sprintf("UPDATE civicrm_membership SET %s WHERE id=%s", implode(", ", $updates_sql), $newMembershipId);
2664           $newSql[] = sprintf("DELETE FROM civicrm_membership WHERE id=%s", $otherMembershipId);
2665         }
2666
2667       }
2668     }
2669
2670     $sqlQueries = array_merge($sqlQueries, $newSql);
2671   }
2672
2673   /**
2674    * Update membership status to deceased.
2675    * function return the status message for updated membership.
2676    *
2677    * @param array $deceasedParams
2678    *  - contact id
2679    *  - is_deceased
2680    *  - deceased_date
2681    *
2682    * @param string $contactType
2683    *
2684    * @return null|string
2685    *   $updateMembershipMsg string  status message for updated membership.
2686    */
2687   public static function updateMembershipStatus($deceasedParams, $contactType) {
2688     $updateMembershipMsg = NULL;
2689     $contactId = $deceasedParams['contact_id'];
2690     $deceasedDate = $deceasedParams['deceased_date'];
2691
2692     // process to set membership status to deceased for both active/inactive membership
2693     if ($contactId &&
2694       $contactType === 'Individual' &&
2695       !empty($deceasedParams['is_deceased'])
2696     ) {
2697
2698       $userId = CRM_Core_Session::getLoggedInContactID() ?: $contactId;
2699
2700       // get deceased status id
2701       $allStatus = CRM_Member_PseudoConstant::membershipStatus();
2702       $deceasedStatusId = array_search('Deceased', $allStatus);
2703       if (!$deceasedStatusId) {
2704         return $updateMembershipMsg;
2705       }
2706
2707       $today = time();
2708       if ($deceasedDate && strtotime($deceasedDate) > $today) {
2709         return $updateMembershipMsg;
2710       }
2711
2712       // get non deceased membership
2713       $dao = new CRM_Member_DAO_Membership();
2714       $dao->contact_id = $contactId;
2715       $dao->whereAdd("status_id != $deceasedStatusId");
2716       $dao->find();
2717       $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
2718       $allStatus = CRM_Member_PseudoConstant::membershipStatus();
2719       $memCount = 0;
2720       while ($dao->fetch()) {
2721         // update status to deceased (for both active/inactive membership )
2722         CRM_Core_DAO::setFieldValue('CRM_Member_DAO_Membership', $dao->id,
2723           'status_id', $deceasedStatusId
2724         );
2725
2726         // add membership log
2727         $membershipLog = [
2728           'membership_id' => $dao->id,
2729           'status_id' => $deceasedStatusId,
2730           'start_date' => CRM_Utils_Date::isoToMysql($dao->start_date),
2731           'end_date' => CRM_Utils_Date::isoToMysql($dao->end_date),
2732           'modified_id' => $userId,
2733           'modified_date' => date('Ymd'),
2734           'membership_type_id' => $dao->membership_type_id,
2735           'max_related' => $dao->max_related,
2736         ];
2737
2738         CRM_Member_BAO_MembershipLog::add($membershipLog);
2739
2740         //create activity when membership status is changed
2741         $activityParam = [
2742           'subject' => "Status changed from {$allStatus[$dao->status_id]} to {$allStatus[$deceasedStatusId]}",
2743           'source_contact_id' => $userId,
2744           'target_contact_id' => $dao->contact_id,
2745           'source_record_id' => $dao->id,
2746           'activity_type_id' => array_search('Change Membership Status', $activityTypes),
2747           'status_id' => 2,
2748           'version' => 3,
2749           'priority_id' => 2,
2750           'activity_date_time' => date('Y-m-d H:i:s'),
2751           'is_auto' => 0,
2752           'is_current_revision' => 1,
2753           'is_deleted' => 0,
2754         ];
2755         civicrm_api('activity', 'create', $activityParam);
2756
2757         $memCount++;
2758       }
2759
2760       // set status msg
2761       if ($memCount) {
2762         CRM_Core_Session::setStatus(ts("%1 Current membership(s) for this contact have been set to 'Deceased' status.",
2763           [1 => $memCount]
2764         ));
2765       }
2766     }
2767     return $updateMembershipMsg;
2768   }
2769
2770 }