CRM/Member/BAO/Membership.php

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