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