CRM/Member/BAO/Membership.php

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