CRM/Member/BAO/Membership.php

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