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 (CRM_Utils_Array::value('lineItems', $params) && empty($params['contributionId'])) {
 329       CRM_Price_BAO_LineItem::processPriceSet($membership->id, $params['lineItems'], CRM_Utils_Array::value('contribution', $params));
 330     }
 331
 332     //insert payment record for this membership
 333     if (!empty($params['relate_contribution_id'])) {
 334       $mpDAO = new CRM_Member_DAO_MembershipPayment();
 335       $mpDAO->membership_id = $membership->id;
 336       $mpDAO->contribution_id = $params['relate_contribution_id'];
 337       if (!($mpDAO->find(TRUE))) {
 338         CRM_Utils_Hook::pre('create', 'MembershipPayment', NULL, $mpDAO);
 339         $mpDAO->save();
 340         CRM_Utils_Hook::post('create', 'MembershipPayment', $mpDAO->id, $mpDAO);
 341       }
 342     }
 343
 344     // add activity record only during create mode and renew mode
 345     // also add activity if status changed CRM-3984 and CRM-2521
 346     if (empty($ids['membership']) ||
 347       $activityType == 'Membership Renewal' || !empty($params['createActivity'])) {
 348       if (!empty($ids['membership'])) {
 349         $data = array();
 350         CRM_Core_DAO::commonRetrieveAll('CRM_Member_DAO_Membership',
 351           'id',
 352           $membership->id,
 353           $data,
 354           array('contact_id', 'membership_type_id', 'source')
 355         );
 356
 357         $membership->contact_id = $data[$membership->id]['contact_id'];
 358         $membership->membership_type_id = $data[$membership->id]['membership_type_id'];
 359         $membership->source = CRM_Utils_Array::value('source', $data[$membership->id]);
 360       }
 361
 362       // since we are going to create activity record w/
 363       // individual contact as a target in case of on behalf signup,
 364       // so get the copy of organization id, CRM-5551
 365       $realMembershipContactId = $membership->contact_id;
 366
 367       // create activity source = individual, target = org CRM-4027
 368       $targetContactID = NULL;
 369       if (!empty($params['is_for_organization'])) {
 370         $targetContactID = $membership->contact_id;
 371         $membership->contact_id = CRM_Utils_Array::value('userId', $ids);
 372       }
 373
 374       if (empty($membership->contact_id) && (!empty($membership->owner_membership_id))) {
 375         $membership->contact_id = $realMembershipContactId;
 376       }
 377
 378       if (!empty($ids['membership']) && $activityType != 'Membership Signup') {
 379         CRM_Activity_BAO_Activity::addActivity($membership, $activityType, $targetContactID);
 380       } elseif (empty($ids['membership'])) {
 381         CRM_Activity_BAO_Activity::addActivity($membership, $activityType, $targetContactID);
 382       }
 383
 384       // we might created activity record w/ individual
 385       // contact as target so update membership object w/
 386       // original organization id, CRM-5551
 387       $membership->contact_id = $realMembershipContactId;
 388     }
 389
 390     $transaction->commit();
 391
 392     self::createRelatedMemberships($params, $membership);
 393
 394     // do not add to recent items for import, CRM-4399
 395     if (empty($params['skipRecentView'])) {
 396       $url = CRM_Utils_System::url('civicrm/contact/view/membership',
 397         "action=view&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
 398       );
 399       if(empty($membership->membership_type_id)){// ie in an update situation
 400         $membership->find(TRUE);
 401       }
 402       $membershipTypes = CRM_Member_PseudoConstant::membershipType();
 403       $title = CRM_Contact_BAO_Contact::displayName($membership->contact_id) . ' - ' . ts('Membership Type:') . ' ' . $membershipTypes[$membership->membership_type_id];
 404
 405       $recentOther = array();
 406       if (CRM_Core_Permission::checkActionPermission('CiviMember', CRM_Core_Action::UPDATE)) {
 407         $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/view/membership',
 408           "action=update&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
 409         );
 410       }
 411       if (CRM_Core_Permission::checkActionPermission('CiviMember', CRM_Core_Action::DELETE)) {
 412         $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/membership',
 413           "action=delete&reset=1&id={$membership->id}&cid={$membership->contact_id}&context=home"
 414         );
 415       }
 416
 417       // add the recently created Membership
 418       CRM_Utils_Recent::add($title,
 419         $url,
 420         $membership->id,
 421         'Membership',
 422         $membership->contact_id,
 423         NULL,
 424         $recentOther
 425       );
 426     }
 427
 428     return $membership;
 429   }
 430
 431   /**
 432    * Function to check the membership extended through relationship
 433    *
 434    * @param int $membershipId membership id
 435    * @param int $contactId contact id
 436    *
 437    * @param const $action
 438    *
 439    * @return Array    array of contact_id of all related contacts.
 440    * @static
 441    */
 442   static function checkMembershipRelationship($membershipId, $contactId, $action = CRM_Core_Action::ADD) {
 443     $contacts = array();
 444     $membershipTypeID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id');
 445
 446     $membershipType = CRM_Member_BAO_MembershipType::getMembershipTypeDetails($membershipTypeID);
 447     $relationships = array();
 448     if (isset($membershipType['relationship_type_id'])) {
 449       $relationships = CRM_Contact_BAO_Relationship::getRelationship($contactId,
 450         CRM_Contact_BAO_Relationship::CURRENT
 451       );
 452       if ($action & CRM_Core_Action::UPDATE) {
 453         $pastRelationships = CRM_Contact_BAO_Relationship::getRelationship($contactId,
 454           CRM_Contact_BAO_Relationship::PAST
 455         );
 456         $relationships = array_merge($relationships, $pastRelationships);
 457       }
 458     }
 459
 460     if (!empty($relationships)) {
 461       // check for each contact relationships
 462       foreach ($relationships as $values) {
 463         //get details of the relationship type
 464         $relType = array('id' => $values['civicrm_relationship_type_id']);
 465         $relValues = array();
 466         CRM_Contact_BAO_RelationshipType::retrieve($relType, $relValues);
 467         // Check if contact's relationship type exists in membership type
 468         $relTypeDirs   = array();
 469         $relTypeIds    = explode(CRM_Core_DAO::VALUE_SEPARATOR, $membershipType['relationship_type_id']);
 470         $relDirections = explode(CRM_Core_DAO::VALUE_SEPARATOR, $membershipType['relationship_direction']);
 471         $bidirectional = FALSE;
 472         foreach ($relTypeIds as $key => $value) {
 473           $relTypeDirs[] = $value . '_' . $relDirections[$key];
 474           if (in_array($value, $relType) &&
 475             $relValues['name_a_b'] == $relValues['name_b_a']
 476           ) {
 477             $bidirectional = TRUE;
 478             break;
 479           }
 480         }
 481         $relTypeDir = $values['civicrm_relationship_type_id'] . '_' . $values['rtype'];
 482         if ($bidirectional || in_array($relTypeDir, $relTypeDirs)) {
 483           // $values['status'] is going to have value for
 484           // current or past relationships.
 485           $contacts[$values['cid']] = $values['status'];
 486         }
 487       }
 488     }
 489
 490     // Sort by contact_id ascending
 491     ksort($contacts);
 492     return $contacts;
 493   }
 494
 495   /**
 496    * Takes a bunch of params that are needed to match certain criteria and
 497    * retrieves the relevant objects. We'll tweak this function to be more
 498    * full featured over a period of time. This is the inverse function of
 499    * create.  It also stores all the retrieved values in the default array
 500    *
 501    * @param array $params (reference ) an assoc array of name/value pairs
 502    * @param array $defaults (reference ) an assoc array to hold the name / value pairs
 503    *                        in a hierarchical manner
 504    *
 505    * @internal param array $ids (reference) the array that holds all the db ids
 506    *
 507    * @return object CRM_Member_BAO_Membership object
 508    * @access public
 509    * @static
 510    */
 511   static function retrieve(&$params, &$defaults) {
 512     $membership = new CRM_Member_DAO_Membership();
 513
 514     $membership->copyValues($params);
 515
 516     if ($membership->find(TRUE)) {
 517       CRM_Core_DAO::storeValues($membership, $defaults);
 518
 519       //get the membership status and type values.
 520       $statusANDType = self::getStatusANDTypeValues($membership->id);
 521       foreach (array(
 522         'status', 'membership_type') as $fld) {
 523         $defaults[$fld] = CRM_Utils_Array::value($fld, $statusANDType[$membership->id]);
 524       }
 525       if (!empty($statusANDType[$membership->id]['is_current_member'])) {
 526         $defaults['active'] = TRUE;
 527       }
 528
 529       $membership->free();
 530
 531       return $membership;
 532     }
 533
 534     return NULL;
 535   }
 536
 537   /**
 538    *
 539    * Function to get membership status and membership type values
 540    *
 541    * @param int $membershipId membership id of values to return
 542    *
 543    * @return array of key value pairs
 544    * @access public
 545    */
 546   static function getStatusANDTypeValues($membershipId) {
 547     $values = array();
 548     if (!$membershipId) {
 549       return $values;
 550     }
 551     $sql = '
 552     SELECT  membership.id as id,
 553             status.id as status_id,
 554             status.label as status,
 555             status.is_current_member as is_current_member,
 556             type.id as membership_type_id,
 557             type.name as membership_type,
 558             type.relationship_type_id as relationship_type_id
 559       FROM  civicrm_membership membership
 560 INNER JOIN  civicrm_membership_status status ON ( status.id = membership.status_id )
 561 INNER JOIN  civicrm_membership_type type ON ( type.id = membership.membership_type_id )
 562      WHERE  membership.id = %1';
 563     $dao = CRM_Core_DAO::executeQuery($sql, array(1 => array($membershipId, 'Positive')));
 564     $properties = array('status', 'status_id', 'membership_type', 'membership_type_id', 'is_current_member', 'relationship_type_id');
 565     while ($dao->fetch()) {
 566       foreach ($properties as $property) {
 567         $values[$dao->id][$property] = $dao->$property;
 568       }
 569     }
 570
 571     return $values;
 572   }
 573
 574   /**
 575    * Function to delete membership.
 576    * Wrapper for most delete calls. Use this unless you JUST want to delete related memberships w/o deleting the parent.
 577    *
 578    * @param int $membershipId membership id that needs to be deleted
 579    *
 580    * @static
 581    *
 582    * @return $results   no of deleted Membership on success, false otherwise
 583    * @access public
 584    */
 585   static function del($membershipId) {
 586     //delete related first and then delete parent.
 587     self::deleteRelatedMemberships($membershipId);
 588     return self::deleteMembership($membershipId);
 589   }
 590
 591   /**
 592    * Function to delete membership.
 593    *
 594    * @param int $membershipId membership id that needs to be deleted
 595    *
 596    * @static
 597    *
 598    * @return $results   no of deleted Membership on success, false otherwise
 599    * @access public
 600    */
 601   static function deleteMembership($membershipId) {
 602     // CRM-12147, retrieve membership data before we delete it for hooks
 603     $params = array('id' => $membershipId);
 604     $memValues = array();
 605     $memberships = self::getValues($params, $memValues);
 606
 607     $membership = $memberships[$membershipId];
 608
 609     CRM_Utils_Hook::pre('delete', 'Membership', $membershipId, $memValues);
 610
 611     $transaction = new CRM_Core_Transaction();
 612
 613     $results = NULL;
 614     //delete activity record
 615     $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
 616
 617     $params = array();
 618     $deleteActivity = false;
 619     $membershipActivities =  array(
 620       'Membership Signup',
 621       'Membership Renewal',
 622       'Change Membership Status',
 623       'Change Membership Type',
 624       'Membership Renewal Reminder'
 625     );
 626     foreach($membershipActivities as $membershipActivity) {
 627       $activityId = array_search($membershipActivity, $activityTypes);
 628       if ($activityId) {
 629         $params['activity_type_id'][] = $activityId;
 630         $deleteActivity = true;
 631       }
 632     }
 633     if ($deleteActivity) {
 634       $params['source_record_id'] = $membershipId;
 635       CRM_Activity_BAO_Activity::deleteActivity($params);
 636     }
 637     self::deleteMembershipPayment($membershipId);
 638
 639     $results = $membership->delete();
 640     $transaction->commit();
 641
 642     CRM_Utils_Hook::post('delete', 'Membership', $membership->id, $membership);
 643
 644     // delete the recently created Membership
 645     $membershipRecent = array(
 646       'id' => $membershipId,
 647       'type' => 'Membership',
 648     );
 649     CRM_Utils_Recent::del($membershipRecent);
 650
 651     return $results;
 652   }
 653
 654   /**
 655    * Function to delete related memberships
 656    *
 657    * @param int $ownerMembershipId
 658    * @param int $contactId
 659    *
 660    * @return null
 661    * @static
 662    */
 663   static function deleteRelatedMemberships($ownerMembershipId, $contactId = NULL) {
 664     if (!$ownerMembershipId && !$contactId) {
 665       return;
 666     }
 667
 668     $membership = new CRM_Member_DAO_Membership();
 669     $membership->owner_membership_id = $ownerMembershipId;
 670
 671     if ($contactId) {
 672       $membership->contact_id = $contactId;
 673     }
 674
 675     $membership->find();
 676     while ($membership->fetch()) {
 677       //delete related first and then delete parent.
 678       self::deleteRelatedMemberships($membership->id);
 679       self::deleteMembership($membership->id);
 680     }
 681     $membership->free();
 682   }
 683
 684   /**
 685    * Function to obtain active/inactive memberships from the list of memberships passed to it.
 686    *
 687    * @param array  $memberships membership records
 688    * @param string $status      active or inactive
 689    *
 690    * @return array $actives array of memberships based on status
 691    * @static
 692    * @access public
 693    */
 694   static function activeMembers($memberships, $status = 'active') {
 695     $actives = array();
 696     if ($status == 'active') {
 697       foreach ($memberships as $f => $v) {
 698         if (!empty($v['active'])) {
 699           $actives[$f] = $v;
 700         }
 701       }
 702       return $actives;
 703     }
 704     elseif ($status == 'inactive') {
 705       foreach ($memberships as $f => $v) {
 706         if (empty($v['active'])) {
 707           $actives[$f] = $v;
 708         }
 709       }
 710       return $actives;
 711     }
 712     return NULL;
 713   }
 714
 715   /**
 716    * Function to build Membership  Block in Contribution Pages
 717    *
 718    * @param object $form form object
 719    * @param $pageID
 720    * @param $cid
 721    * @param boolean $formItems
 722    * @param int $selectedMembershipTypeID selected membership id
 723    * @param boolean $thankPage thank you page
 724    * @param null $isTest
 725    *
 726    * @return bool Is this a separate membership payment
 727    * @internal param int $pageId contribution page id
 728    * @internal param bool $memContactId contact who is to be
 729    * checked for having a current membership for a particular membership
 730    *
 731    * @static
 732    */
 733   static function buildMembershipBlock(&$form,
 734     $pageID,
 735     $cid,
 736     $formItems = FALSE,
 737     $selectedMembershipTypeID = NULL,
 738     $thankPage = FALSE,
 739     $isTest = NULL
 740   ) {
 741
 742     $separateMembershipPayment = FALSE;
 743     if ($form->_membershipBlock) {
 744       $form->_currentMemberships = array();
 745
 746       $membershipBlock    = $form->_membershipBlock;
 747       $membershipTypeIds  = $membershipTypes = $radio = array();
 748       $membershipPriceset = (!empty($form->_priceSetId) && $form->_useForMember) ? TRUE : FALSE;
 749
 750       $allowAutoRenewMembership = $autoRenewOption = FALSE;
 751       $autoRenewMembershipTypeOptions = array();
 752
 753       $paymentProcessor = CRM_Core_PseudoConstant::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
 754
 755       $separateMembershipPayment = CRM_Utils_Array::value('is_separate_payment', $membershipBlock);
 756
 757       if ($membershipPriceset) {
 758         foreach ($form->_priceSet['fields'] as $pField) {
 759           if (empty($pField['options'])) {
 760             continue;
 761           }
 762           foreach ($pField['options'] as $opId => $opValues) {
 763             if (empty($opValues['membership_type_id'])) {
 764               continue;
 765             }
 766             $membershipTypeIds[$opValues['membership_type_id']] = $opValues['membership_type_id'];
 767           }
 768         }
 769       }
 770       elseif (!empty($membershipBlock['membership_types'])) {
 771         $membershipTypeIds = explode(',', $membershipBlock['membership_types']);
 772       }
 773
 774       if (!empty($membershipTypeIds)) {
 775         //set status message if wrong membershipType is included in membershipBlock
 776         if (isset($form->_mid) && !$membershipPriceset) {
 777           $membershipTypeID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
 778             $form->_mid,
 779             'membership_type_id'
 780           );
 781           if (!in_array($membershipTypeID, $membershipTypeIds)) {
 782             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');
 783           }
 784         }
 785
 786         $membershipTypeValues = self::buildMembershipTypeValues($form, $membershipTypeIds);
 787         $form->_membershipTypeValues = $membershipTypeValues;
 788         $endDate = NULL;
 789         foreach ($membershipTypeIds as $value) {
 790           $memType = $membershipTypeValues[$value];
 791           if ($selectedMembershipTypeID != NULL) {
 792             if ($memType['id'] == $selectedMembershipTypeID) {
 793               $form->assign('minimum_fee',
 794                 CRM_Utils_Array::value('minimum_fee', $memType)
 795               );
 796               $form->assign('membership_name', $memType['name']);
 797               if (!$thankPage && $cid) {
 798                 $membership = new CRM_Member_DAO_Membership();
 799                 $membership->contact_id = $cid;
 800                 $membership->membership_type_id = $memType['id'];
 801                 if ($membership->find(TRUE)) {
 802                   $form->assign('renewal_mode', TRUE);
 803                   $memType['current_membership'] = $membership->end_date;
 804                   $form->_currentMemberships[$membership->membership_type_id] = $membership->membership_type_id;
 805                 }
 806               }
 807               $membershipTypes[] = $memType;
 808             }
 809           }
 810           elseif ($memType['is_active']) {
 811             $javascriptMethod = NULL;
 812             $allowAutoRenewOpt = 1;
 813             if (is_array($form->_paymentProcessors)){
 814               foreach ($form->_paymentProcessors as $id => $val) {
 815                 if (!$val['is_recur']) {
 816               $allowAutoRenewOpt = 0;
 817                   continue;
 818             }
 819               }
 820             }
 821
 822             $javascriptMethod = array('onclick' => "return showHideAutoRenew( this.value );");
 823             $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = (int)$allowAutoRenewOpt * CRM_Utils_Array::value($value, CRM_Utils_Array::value('auto_renew', $form->_membershipBlock));;
 824
 825             if ($allowAutoRenewOpt) {
 826               $allowAutoRenewMembership = TRUE;
 827             }
 828
 829             //add membership type.
 830             $radio[$memType['id']] = $form->createElement('radio', NULL, NULL, NULL,
 831               $memType['id'], $javascriptMethod
 832             );
 833             if ($cid) {
 834               $membership = new CRM_Member_DAO_Membership();
 835               $membership->contact_id = $cid;
 836               $membership->membership_type_id = $memType['id'];
 837
 838               //show current membership, skip pending and cancelled membership records,
 839               //because we take first membership record id for renewal
 840               $membership->whereAdd('status_id != 5 AND status_id !=6');
 841
 842               if (!is_null($isTest)) {
 843                 $membership->is_test = $isTest;
 844               }
 845
 846               //CRM-4297
 847               $membership->orderBy('end_date DESC');
 848
 849               if ($membership->find(TRUE)) {
 850                 if (!$membership->end_date) {
 851                   unset($radio[$memType['id']]);
 852                   $form->assign('islifetime', TRUE);
 853                   continue;
 854                 }
 855                 $form->assign('renewal_mode', TRUE);
 856                 $form->_currentMemberships[$membership->membership_type_id] = $membership->membership_type_id;
 857                 $memType['current_membership'] = $membership->end_date;
 858                 if (!$endDate) {
 859                   $endDate = $memType['current_membership'];
 860                   $form->_defaultMemTypeId = $memType['id'];
 861                 }
 862                 if ($memType['current_membership'] < $endDate) {
 863                   $endDate = $memType['current_membership'];
 864                   $form->_defaultMemTypeId = $memType['id'];
 865                 }
 866               }
 867             }
 868             $membershipTypes[] = $memType;
 869           }
 870         }
 871       }
 872
 873       $form->assign('showRadio', $formItems);
 874       if ($formItems) {
 875         if (!$membershipPriceset) {
 876           if (!$membershipBlock['is_required']) {
 877             $form->assign('showRadioNoThanks', TRUE);
 878             $radio[''] = $form->createElement('radio', NULL, NULL, NULL, 'no_thanks', NULL);
 879             $form->addGroup($radio, 'selectMembership', NULL);
 880           }
 881           elseif ($membershipBlock['is_required'] && count($radio) == 1) {
 882             $temp = array_keys($radio);
 883             $form->add('hidden', 'selectMembership', $temp[0], array('id' => 'selectMembership'));
 884             $form->assign('singleMembership', TRUE);
 885             $form->assign('showRadio', FALSE);
 886           }
 887           else {
 888             $form->addGroup($radio, 'selectMembership', NULL);
 889           }
 890
 891           $form->addRule('selectMembership', ts('Please select one of the memberships.'), 'required');
 892         }
 893         else {
 894           $autoRenewOption = CRM_Price_BAO_PriceSet::checkAutoRenewForPriceSet($form->_priceSetId);
 895           $form->assign('autoRenewOption', $autoRenewOption);
 896         }
 897
 898         if (!$form->_values['is_pay_later'] && is_array($form->_paymentProcessors) && ($allowAutoRenewMembership || $autoRenewOption)) {
 899           $form->addElement('checkbox', 'auto_renew', ts('Please renew my membership automatically.'));
 900         }
 901
 902       }
 903
 904       $form->assign('membershipBlock', $membershipBlock);
 905       $form->assign('membershipTypes', $membershipTypes);
 906       $form->assign('allowAutoRenewMembership', $allowAutoRenewMembership);
 907       $form->assign('autoRenewMembershipTypeOptions', json_encode($autoRenewMembershipTypeOptions));
 908
 909       //give preference to user submitted auto_renew value.
 910       $takeUserSubmittedAutoRenew = (!empty($_POST) || $form->isSubmitted()) ? TRUE : FALSE;
 911       $form->assign('takeUserSubmittedAutoRenew', $takeUserSubmittedAutoRenew);
 912     }
 913
 914     return $separateMembershipPayment;
 915   }
 916
 917   /**
 918    * Function to return Membership Block info in Contribution Pages
 919    *
 920    * @param $pageID
 921    *
 922    * @return array|null
 923    * @internal param int $pageId contribution page id
 924    *
 925    * @static
 926    */
 927   static function getMembershipBlock($pageID) {
 928     $membershipBlock   = array();
 929     $dao               = new CRM_Member_DAO_MembershipBlock();
 930     $dao->entity_table = 'civicrm_contribution_page';
 931
 932     $dao->entity_id = $pageID;
 933     $dao->is_active = 1;
 934     if ($dao->find(TRUE)) {
 935       CRM_Core_DAO::storeValues($dao, $membershipBlock);
 936       if (!empty($membershipBlock['membership_types'])) {
 937         $membershipTypes = unserialize($membershipBlock['membership_types']);
 938         if (!is_array($membershipTypes)) {
 939           return $membershipBlock;
 940         }
 941         $memTypes = array();
 942         foreach ($membershipTypes as $key => $value) {
 943           $membershipBlock['auto_renew'][$key] = $value;
 944           $memTypes[$key] = $key;
 945         }
 946         $membershipBlock['membership_types'] = implode(',', $memTypes);
 947       }
 948     }
 949     else {
 950       return NULL;
 951     }
 952
 953     return $membershipBlock;
 954   }
 955
 956   /**
 957    * Function to return a current membership of given contact
 958    *        NB: if more than one membership meets criteria, a randomly selected one is returned.
 959    *
 960    * @param int $contactID contact id
 961    * @param int $memType membership type, null to retrieve all types
 962    * @param int $isTest
 963    * @param null $membershipId
 964    * @param boolean $onlySameParentOrg true if only Memberships with same parent org as the $memType wanted, false otherwise
 965    *
 966    * @return array|bool
 967    * @internal param int $membershipID if provided, then determine if it is current
 968    * @static
 969    */
 970   static function getContactMembership($contactID, $memType, $isTest, $membershipId = NULL, $onlySameParentOrg = FALSE) {
 971     $dao = new CRM_Member_DAO_Membership();
 972     if ($membershipId) {
 973       $dao->id = $membershipId;
 974     }
 975     $dao->contact_id = $contactID;
 976     $dao->membership_type_id = $memType;
 977
 978     //fetch proper membership record.
 979     if ($isTest) {
 980       $dao->is_test = $isTest;
 981     }
 982     else {
 983       $dao->whereAdd('is_test IS NULL OR is_test = 0');
 984     }
 985
 986     //avoid pending membership as current membership: CRM-3027
 987     $statusIds[] = array_search('Pending', CRM_Member_PseudoConstant::membershipStatus());
 988     if (!$membershipId) {
 989       $statusIds[] = array_search('Cancelled', CRM_Member_PseudoConstant::membershipStatus());
 990     }
 991     $dao->whereAdd('status_id NOT IN ( ' . implode(',',  $statusIds) . ')');
 992
 993     // order by start date to find most recent membership first, CRM-4545
 994     $dao->orderBy('start_date DESC');
 995
 996     // CRM-8141
 997     if ($onlySameParentOrg && $memType) {
 998       // require the same parent org as the $memType
 999       $params = array('id' => $memType);
1000       $membershipType = array();
1001       if (CRM_Member_BAO_MembershipType::retrieve($params, $membershipType)) {
1002         $memberTypesSameParentOrg = CRM_Member_BAO_MembershipType::getMembershipTypesByOrg($membershipType['member_of_contact_id']);
1003         $memberTypesSameParentOrgList = implode(',', array_keys($memberTypesSameParentOrg));
1004         $dao->whereAdd('membership_type_id IN (' . $memberTypesSameParentOrgList . ')');
1005       }
1006     }
1007
1008     if ($dao->find(TRUE)) {
1009       $membership = array();
1010       CRM_Core_DAO::storeValues($dao, $membership);
1011       $membership['is_current_member'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus',
1012         $membership['status_id'],
1013         'is_current_member', 'id'
1014       );
1015       return $membership;
1016     }
1017
1018     // CRM-8141
1019     if ($onlySameParentOrg && $memType) {
1020       // see if there is a membership that has same parent as $memType but different parent than $membershipID
1021
1022             if ( $dao->id && CRM_Core_Permission::check( 'edit memberships' ) ) {
1023                 // CRM-10016, This is probably a backend renewal, and make sure we return the same membership thats being renewed.
1024                 $dao->whereAdd ( );
1025             } else {
1026       unset($dao->id);
1027             }
1028
1029       unset($dao->membership_type_id);
1030       if ($dao->find(TRUE)) {
1031         $membership = array();
1032         CRM_Core_DAO::storeValues($dao, $membership);
1033         $membership['is_current_member'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus',
1034           $membership['status_id'],
1035           'is_current_member', 'id'
1036         );
1037         return $membership;
1038       }
1039     }
1040     return FALSE;
1041   }
1042
1043   /**
1044    * Combine all the importable fields from the lower levels object
1045    *
1046    * @param string  $contactType contact type
1047    * @param boolean $status
1048    *
1049    * @return array array of importable Fields
1050    * @access public
1051    * @static
1052    */
1053   static function &importableFields($contactType = 'Individual', $status = TRUE) {
1054     if (!self::$_importableFields) {
1055       if (!self::$_importableFields) {
1056         self::$_importableFields = array();
1057       }
1058
1059       if (!$status) {
1060         $fields = array('' => array('title' => '- ' . ts('do not import') . ' -'));
1061       }
1062       else {
1063         $fields = array('' => array('title' => '- ' . ts('Membership Fields') . ' -'));
1064       }
1065
1066       $tmpFields = CRM_Member_DAO_Membership::import();
1067       $contactFields = CRM_Contact_BAO_Contact::importableFields($contactType, NULL);
1068
1069       // Using new Dedupe rule.
1070       $ruleParams = array(
1071         'contact_type' => $contactType,
1072         'used'         => 'Unsupervised',
1073       );
1074       $fieldsArray = CRM_Dedupe_BAO_Rule::dedupeRuleFields($ruleParams);
1075
1076       $tmpContactField = array();
1077       if (is_array($fieldsArray)) {
1078         foreach ($fieldsArray as $value) {
1079           $customFieldId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
1080             $value,
1081             'id',
1082             'column_name'
1083           );
1084           $value = $customFieldId ? 'custom_' . $customFieldId : $value;
1085           $tmpContactField[trim($value)] = CRM_Utils_Array::value(trim($value), $contactFields);
1086           if (!$status) {
1087             $title = $tmpContactField[trim($value)]['title'] . " " . ts('(match to contact)');
1088           }
1089           else {
1090             $title = $tmpContactField[trim($value)]['title'];
1091           }
1092           $tmpContactField[trim($value)]['title'] = $title;
1093         }
1094       }
1095       $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
1096       $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . " " . ts('(match to contact)');
1097
1098       $tmpFields['membership_contact_id']['title'] = $tmpFields['membership_contact_id']['title'] . " " . ts('(match to contact)');;
1099
1100       $fields = array_merge($fields, $tmpContactField);
1101       $fields = array_merge($fields, $tmpFields);
1102       $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Membership'));
1103       self::$_importableFields = $fields;
1104     }
1105     return self::$_importableFields;
1106   }
1107
1108   /**
1109    * function to get all exportable fields
1110    *
1111    * @retun array return array of all exportable fields
1112    * @static
1113    */
1114   static function &exportableFields() {
1115     $expFieldMembership = CRM_Member_DAO_Membership::export();
1116
1117     $expFieldsMemType = CRM_Member_DAO_MembershipType::export();
1118     $fields           = array_merge($expFieldMembership, $expFieldsMemType);
1119     $fields           = array_merge($fields, $expFieldMembership);
1120     $membershipStatus = array(
1121       'membership_status' => array('title' => 'Membership Status',
1122         'name' => 'membership_status',
1123         'type' => CRM_Utils_Type::T_STRING,
1124         'where' => 'civicrm_membership_status.name',
1125       ));
1126     //CRM-6161 fix for customdata export
1127     $fields = array_merge($fields, $membershipStatus, CRM_Core_BAO_CustomField::getFieldsForImport('Membership'));
1128     return $fields;
1129   }
1130
1131   /**
1132    * Function to get membership joins/renewals for a specified membership
1133    * type.  Specifically, retrieves a count of memberships whose "Membership
1134    * Signup" or "Membership Renewal" activity falls in the given date range.
1135    * Dates match the pattern "yyyy-mm-dd".
1136    *
1137    * @param int $membershipTypeId membership type id
1138    * @param int $startDate date on which to start counting
1139    * @param int $endDate date on which to end counting
1140    * @param bool|int $isTest if true, membership is for a test site
1141    * @param bool|int $isOwner if true, only retrieve membership records for owners //LCD
1142    *
1143    * @return integer the number of members of type $membershipTypeId whose
1144    *         start_date is between $startDate and $endDate
1145    */
1146   //LCD
1147   public static function getMembershipStarts($membershipTypeId, $startDate, $endDate, $isTest = 0, $isOwner = 0) {
1148
1149     $testClause = 'membership.is_test = 1';
1150     if (!$isTest) {
1151       $testClause = '( membership.is_test IS NULL OR membership.is_test = 0 )';
1152     }
1153
1154     if (!self::$_signupActType || !self::$_renewalActType) {
1155       self::_getActTypes();
1156     }
1157
1158     if (!self::$_signupActType || !self::$_renewalActType) {
1159       return 0;
1160     }
1161
1162     $query = "
1163     SELECT  COUNT(DISTINCT membership.id) as member_count
1164       FROM  civicrm_membership membership
1165 INNER JOIN civicrm_activity activity ON (activity.source_record_id = membership.id AND activity.activity_type_id in (%1, %2))
1166 INNER JOIN  civicrm_membership_status status ON ( membership.status_id = status.id AND status.is_current_member = 1 )
1167 INNER JOIN  civicrm_contact contact ON ( contact.id = membership.contact_id AND contact.is_deleted = 0 )
1168      WHERE  membership.membership_type_id = %3
1169        AND  activity.activity_date_time >= '$startDate' AND activity.activity_date_time <= '$endDate 23:59:59'
1170        AND  {$testClause}";
1171
1172     $query .= ($isOwner) ? ' AND owner_membership_id IS NULL' : '';
1173
1174     $params = array(
1175       1 => array(self::$_signupActType, 'Integer'),
1176       2 => array(self::$_renewalActType, 'Integer'),
1177       3 => array($membershipTypeId, 'Integer'),
1178     );
1179
1180     $memberCount = CRM_Core_DAO::singleValueQuery($query, $params);
1181     return (int)$memberCount;
1182   }
1183
1184   /**
1185    * Function to get a count of membership for a specified membership type,
1186    * optionally for a specified date.  The date must have the form yyyy-mm-dd.
1187    *
1188    * If $date is omitted, this function counts as a member anyone whose
1189    * membership status_id indicates they're a current member.
1190    * If $date is given, this function counts as a member anyone who:
1191    *  -- Has a start_date before $date and end_date after $date, or
1192    *  -- Has a start_date before $date and is currently a member, as indicated
1193    *     by the the membership's status_id.
1194    * The second condition takes care of records that have no end_date.  These
1195    * are assumed to be lifetime memberships.
1196    *
1197    * @param int $membershipTypeId membership type id
1198    * @param string $date the date for which to retrieve the count
1199    * @param bool|int $isTest if true, membership is for a test site
1200    * @param bool|int $isOwner if true, only retrieve membership records for owners //LCD
1201    *
1202    * @return returns the number of members of type $membershipTypeId as of
1203    *         $date.
1204    */
1205   public static function getMembershipCount($membershipTypeId, $date = NULL, $isTest = 0, $isOwner = 0) {
1206     if (!CRM_Utils_Rule::date($date)) {
1207       CRM_Core_Error::fatal(ts('Invalid date "%1" (must have form yyyy-mm-dd).', array(1 => $date)));
1208     }
1209
1210     $params = array(1 => array($membershipTypeId, 'Integer'),
1211       2 => array($isTest, 'Boolean'),
1212     );
1213     $query = "SELECT  count(civicrm_membership.id ) as member_count
1214 FROM   civicrm_membership left join civicrm_membership_status on ( civicrm_membership.status_id = civicrm_membership_status.id  )
1215 WHERE  civicrm_membership.membership_type_id = %1
1216 AND civicrm_membership.contact_id NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)
1217 AND civicrm_membership.is_test = %2";
1218     if (!$date) {
1219       $query .= " AND civicrm_membership_status.is_current_member = 1";
1220     }
1221     else {
1222       $query .= " AND civicrm_membership.start_date <= '$date' AND civicrm_membership_status.is_current_member = 1";
1223     }
1224     // LCD
1225     $query .= ($isOwner) ? ' AND owner_membership_id IS NULL' : '';
1226     $memberCount = CRM_Core_DAO::singleValueQuery($query, $params);
1227     return (int)$memberCount;
1228   }
1229
1230   /**
1231    * Function check the status of the membership before adding membership for a contact
1232    *
1233    * @param int $contactId contact id
1234    *
1235    * @return int
1236    */
1237   static function statusAvailabilty($contactId) {
1238     $membership = new CRM_Member_DAO_MembershipStatus();
1239     $membership->whereAdd('is_active=1');
1240     return $membership->count();
1241   }
1242
1243   /**
1244    * Process the Memberships
1245    *
1246    * @param array $membershipParams array of membership fields
1247    * @param int $contactID contact id
1248    * @param CRM_Contribute_Form_Contribution_Confirm $form Confirmation form object
1249    *
1250    * @param $premiumParams
1251    * @param null $customFieldsFormatted
1252    * @param null $includeFieldTypes
1253    *
1254    * @param array $membershipDetails
1255    *
1256    * @param array $membershipTypeID
1257    *
1258    * @param bool $isPaidMembership
1259    * @param integer $membershipID
1260    *
1261    * @param $isProcessSeparateMembershipTransaction
1262    *
1263    * @param $defaultContributionTypeID
1264    * @param array $membershipLineItems Line items specific to membership payment that is separate to contribution
1265    * @throws CRM_Core_Exception
1266    *
1267    * @return void
1268    * @access public
1269    */
1270   public static function postProcessMembership($membershipParams, $contactID, &$form, $premiumParams,
1271     $customFieldsFormatted = NULL, $includeFieldTypes = NULL, $membershipDetails, $membershipTypeID, $isPaidMembership, $membershipID,
1272     $isProcessSeparateMembershipTransaction, $defaultContributionTypeID, $membershipLineItems) {
1273     $result      = $membershipContribution = NULL;
1274     $isTest      = CRM_Utils_Array::value('is_test', $membershipParams, FALSE);
1275     $errors = $createdMemberships = array();
1276
1277     $membershipLineItem = array();
1278     if (is_array($membershipTypeID)) {
1279       foreach ($form->_lineItem[$form->_priceSetId] as $key => $line) {
1280         if (!empty($line['membership_type_id'])) {
1281           $membershipLineItem[$line['membership_type_id']] = $line;
1282           unset($form->_lineItem[$form->_priceSetId][$key]);
1283         }
1284       }
1285       if (empty($form->_lineItem[$form->_priceSetId])) {
1286         $membershipParams['skipLineItem'] = TRUE;
1287       }
1288     }
1289
1290     if ($isPaidMembership) {
1291       $result = CRM_Contribute_BAO_Contribution_Utils::processConfirm($form, $membershipParams,
1292         $premiumParams, $contactID,
1293         $defaultContributionTypeID,
1294         'membership'
1295       );
1296       if (is_a($result[1], 'CRM_Core_Error')) {
1297         $errors[1] = CRM_Core_Error::getMessages($result[1]);
1298       }
1299       elseif (!empty($result[1])) {
1300         // Save the contribution ID so that I can be used in email receipts
1301         // For example, if you need to generate a tax receipt for the donation only.
1302         $form->_values['contribution_other_id'] = $result[1]->id;
1303         //note that this will be over-written if we are using a separate membership transaction. Otherwise there is only one
1304         $membershipContribution = $result[1];
1305       }
1306     }
1307
1308     if ($isProcessSeparateMembershipTransaction) {
1309       try {
1310         $lineItems = $form->_lineItem = $membershipLineItems;
1311         $membershipContribution = self::processSecondaryFinancialTransaction($contactID, $form, $membershipParams, $isTest, $membershipLineItems, CRM_Utils_Array::value('minimum_fee', $membershipDetails, 0), CRM_Utils_Array::value('financial_type_id', $membershipDetails));
1312       }
1313       catch (CRM_Core_Exception $e) {
1314         $errors[2] = $e->getMessage();
1315         $membershipContribution = NULL;
1316       }
1317     }
1318
1319     $membership = NULL;
1320     if (!empty($membershipContribution) && !is_a($membershipContribution, 'CRM_Core_Error')) {
1321       $membershipContributionID = $membershipContribution->id;
1322     }
1323
1324     //@todo - why is this nested so deep? it seems like it could be just set on the calling function on the form layer
1325     if (isset($membershipParams['onbehalf']) && !empty($membershipParams['onbehalf']['member_campaign_id'])) {
1326       $form->_params['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
1327     }
1328     //@todo it should no longer be possible for it to get to this point & membership to not be an array
1329     if (is_array($membershipTypeID)) {
1330       $typesTerms = CRM_Utils_Array::value('types_terms', $membershipParams, array());
1331       foreach ($membershipTypeID as $memType) {
1332         $numTerms = CRM_Utils_Array::value($memType, $typesTerms, 1);
1333         $createdMemberships[$memType] = self::createOrRenewMembership($membershipParams, $contactID, $customFieldsFormatted, $membershipID, $memType, $isTest, $numTerms, $membershipContribution, $form);
1334         if (CRM_Utils_Array::value($memType, $membershipLineItem)) {
1335           CRM_Price_BAO_LineItem::processPriceSet($createdMemberships[$memType]->id, array($form->_priceSetId => array($membershipLineItem[$memType])), $membershipContribution);
1336           $form->_lineItem[$form->_priceSetId][] = $membershipLineItem[$memType];
1337         }
1338       }
1339       if ($form->_priceSetId && !empty($form->_useForMember) && !empty($form->_lineItem)) {
1340         foreach ($form->_lineItem[$form->_priceSetId] as & $priceFieldOp) {
1341           if (!empty($priceFieldOp['membership_type_id']) &&
1342             isset($createdMemberships[$priceFieldOp['membership_type_id']])
1343           ) {
1344             $membershipOb = $createdMemberships[$priceFieldOp['membership_type_id']];
1345             $priceFieldOp['start_date'] = $membershipOb->start_date ? CRM_Utils_Date::customFormat($membershipOb->start_date, '%d%f %b, %Y') : '-';
1346             $priceFieldOp['end_date'] = $membershipOb->end_date ? CRM_Utils_Date::customFormat($membershipOb->end_date, '%d%f %b, %Y') : '-';
1347           }
1348           else {
1349             $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1350           }
1351         }
1352         $form->_values['lineItem'] = $form->_lineItem;
1353         $form->assign('lineItem', $form->_lineItem);
1354       }
1355     }
1356
1357     if (!empty($errors)) {
1358       $message = self::compileErrorMessage($errors);
1359       throw new CRM_Core_Exception($message);
1360     }
1361     $form->_params['createdMembershipIDs'] = array();
1362
1363     // CRM-7851 - Moved after processing Payment Errors
1364     //@todo - the reasoning for this being here seems a little outdated
1365     foreach ($createdMemberships as $createdMembership) {
1366       CRM_Core_BAO_CustomValueTable::postProcess(
1367         $form->_params,
1368         CRM_Core_DAO::$_nullArray,
1369         'civicrm_membership',
1370         $createdMembership->id,
1371         'Membership'
1372       );
1373       $form->_params['createdMembershipIDs'][] = $createdMembership->id;
1374     }
1375     if(count($createdMemberships) == 1) {
1376       //presumably this is only relevant for exactly 1 membership
1377       $form->_params['membershipID'] = $form->_values['membership_id'] = $createdMembership->id;
1378     }
1379
1380     if ($form->_contributeMode == 'notify') {
1381       if ($form->_values['is_monetary'] && $form->_amount > 0.0 && !$form->_params['is_pay_later']) {
1382         // call postProcess hook before leaving
1383         $form->postProcessHook();
1384         // this does not return
1385         $payment = CRM_Core_Payment::singleton($form->_mode, $form->_paymentProcessor, $form);
1386         $payment->doTransferCheckout($form->_params, 'contribute');
1387       }
1388     }
1389
1390     if (isset($membershipContributionID)) {
1391       $form->_values['contribution_id'] = $membershipContributionID;
1392     }
1393
1394     // Do not send an email if Recurring transaction is done via Direct Mode
1395     // Email will we sent when the IPN is received.
1396     if (!empty($form->_params['is_recur']) && $form->_contributeMode == 'direct') {
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   referance 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 $membershipDetails
2115    * @param $tempParams
2116    * @param $isTest
2117    *
2118    * @throws CRM_Core_Exception
2119    * @return CRM_Contribute_BAO_Contribution
2120    */
2121   public static function processSecondaryFinancialTransaction($contactID, &$form, $tempParams, $isTest, $lineItems, $minimumFee, $financialTypeID) {
2122     $contributionType = new CRM_Financial_DAO_FinancialType();
2123     $contributionType->id = $financialTypeID;
2124     if (!$contributionType->find(TRUE)) {
2125       CRM_Core_Error::fatal(ts("Could not find a system table"));
2126     }
2127     $tempParams['amount'] = $minimumFee;
2128     $tempParams['invoiceID'] = md5(uniqid(rand(), TRUE));
2129
2130     $result = NULL;
2131     if ($form->_values['is_monetary'] && !$form->_params['is_pay_later'] && $minimumFee > 0.0) {
2132       $payment = CRM_Core_Payment::singleton($form->_mode, $form->_paymentProcessor, $form);
2133
2134       if ($form->_contributeMode == 'express') {
2135         $result = $payment->doExpressCheckout($tempParams);
2136       }
2137       else {
2138         $result = $payment->doDirectPayment($tempParams);
2139       }
2140     }
2141
2142     if (is_a($result, 'CRM_Core_Error')) {
2143       throw new CRM_Core_Exception(CRM_Core_Error::getMessages($result));
2144     }
2145     else {
2146       //assign receive date when separate membership payment
2147       //and contribution amount not selected.
2148       if ($form->_amount == 0) {
2149         $now = date('YmdHis');
2150         $form->_params['receive_date'] = $now;
2151         $receiveDate = CRM_Utils_Date::mysqlToIso($now);
2152         $form->set('params', $form->_params);
2153         $form->assign('receive_date', $receiveDate);
2154       }
2155
2156       $form->set('membership_trx_id', $result['trxn_id']);
2157       $form->set('membership_amount', $minimumFee);
2158
2159       // we don't need to create the user twice, so lets disable cms_create_account
2160       // irrespective of the value, CRM-2888
2161       $tempParams['cms_create_account'] = 0;
2162
2163       $pending = $form->_params['is_pay_later'] ? (($minimumFee > 0.0) ? TRUE : FALSE) : FALSE;
2164
2165       //set this variable as we are not creating pledge for
2166       //separate membership payment contribution.
2167       //so for differentiating membership contribution from
2168       //main contribution.
2169       $form->_params['separate_membership_payment'] = 1;
2170       $membershipContribution = CRM_Contribute_Form_Contribution_Confirm::processContribution($form,
2171         $tempParams,
2172         $result,
2173         $contactID,
2174         $contributionType,
2175         $pending,
2176         TRUE,
2177         $isTest,
2178         $lineItems
2179       );
2180       return $membershipContribution;
2181     }
2182   }
2183
2184   /**
2185    * Create linkages between membership & contribution - note this is the wrong place for this code but this is a
2186    * refactoring step. This should be BAO functionality
2187    * @param $membership
2188    * @param $membershipContribution
2189    */
2190   public static function linkMembershipPayment($membership, $membershipContribution) {
2191     CRM_Member_BAO_MembershipPayment::create(array('membership_id' => $membership->id, 'contribution_id' => $membershipContribution->id));
2192   }
2193
2194   /**
2195    * @param $membershipParams
2196    * @param $contactID
2197    * @param $customFieldsFormatted
2198    * @param $membershipID
2199    * @param $memType
2200    * @param $isTest
2201    * @param $numTerms
2202    * @param $membershipContribution
2203    * @param $form
2204    *
2205    * @internal param $createdMemberships
2206    *
2207    * @return array
2208    */
2209   public static function createOrRenewMembership($membershipParams, $contactID, $customFieldsFormatted, $membershipID, $memType, $isTest, $numTerms, $membershipContribution,  &$form) {
2210     $membership = self::renewMembershipFormWrapper($contactID, $memType,
2211       $isTest, $form, NULL,
2212       CRM_Utils_Array::value('cms_contactID', $membershipParams),
2213       $customFieldsFormatted, $numTerms,
2214       $membershipID
2215     );
2216
2217     if (!empty($membershipContribution)) {
2218       // update recurring id for membership record
2219       self::updateRecurMembership($membership, $membershipContribution);
2220
2221       self::linkMembershipPayment($membership, $membershipContribution);
2222     }
2223     return $membership;
2224   }
2225
2226   /**
2227    * Turn array of errors into message string
2228    *
2229    * @param array $errors
2230    *
2231    * @internal param $message
2232    *
2233    * @return string
2234    */
2235   public static function compileErrorMessage($errors)
2236   {
2237     foreach($errors as $error) {
2238       if (is_string($error)) {
2239         $message[] = $error;
2240       }
2241     }
2242     return ts('Payment Processor Error message') . ': ' . implode('<br/>', $message);
2243   }
2244
2245   /**
2246    * Extract relevant values from the form so we can separate form logic from BAO logcis
2247    * @param $form
2248    * @param $changeToday
2249    * @param $membershipTypeDetails
2250    *
2251    * @return array
2252    */
2253   public static function extractFormValues($form, $changeToday, $membershipTypeDetails)
2254   {
2255     $pending = FALSE;
2256     //@todo this is a BAO function & should not inspect the form - the form should do this
2257     // & pass required params to the BAO
2258     if (CRM_Utils_Array::value('minimum_fee', $membershipTypeDetails) > 0.0) {
2259       if (((isset($form->_contributeMode) && $form->_contributeMode == 'notify') || !empty($form->_params['is_pay_later']) ||
2260           (!empty($form->_params['is_recur']) && $form->_contributeMode == 'direct'
2261           )
2262         ) &&
2263         (($form->_values['is_monetary'] && $form->_amount > 0.0) || !empty($form->_params['separate_membership_payment']) ||
2264           CRM_Utils_Array::value('record_contribution', $form->_params)
2265         )
2266       ) {
2267         $pending = TRUE;
2268       }
2269     }
2270     $contributionRecurID = isset($form->_params['contributionRecurID']) ? $form->_params['contributionRecurID'] : NULL;
2271
2272     //we renew expired membership, CRM-6277
2273     if (!$changeToday) {
2274       if ($form->get('renewalDate')) {
2275         $changeToday = $form->get('renewalDate');
2276       }
2277       elseif (get_class($form) == 'CRM_Contribute_Form_Contribution_Confirm') {
2278         $changeToday = date('YmdHis');
2279       }
2280     }
2281
2282     $membershipSource = NULL;
2283     if (!empty($form->_params['membership_source'])) {
2284       $membershipSource = $form->_params['membership_source'];
2285     }
2286     elseif (isset($form->_values['title']) && !empty($form->_values['title'])) {
2287       $membershipSource = ts('Online Contribution:') . ' ' . $form->_values['title'];
2288     }
2289     $isPayLater = NULL;
2290     if(isset($form->_params)) {
2291       $isPayLater = CRM_Utils_Array::value('is_pay_later', $form->_params);
2292     }
2293     $campaignId = NULL;
2294     if (isset($form->_values) && is_array($form->_values) && !empty($form->_values)) {
2295       $campaignId = CRM_Utils_Array::value('campaign_id', $form->_params);
2296       if (!array_key_exists('campaign_id', $form->_params)) {
2297         $campaignId = CRM_Utils_Array::value('campaign_id', $form->_values);
2298       }
2299     }
2300     return array($pending, $contributionRecurID, $changeToday, $membershipSource, $isPayLater, $campaignId);
2301   }
2302
2303   /**
2304    * @param integer $contactID
2305    * @param $membershipTypeID
2306    * @param bool $is_test
2307    * @param $changeToday
2308    * @param integer $modifiedID
2309    * @param $customFieldsFormatted
2310    * @param $numRenewTerms
2311    * @param $membershipID
2312    * @param $pending
2313    * @param $allStatus
2314    * @param array $membershipTypeDetails
2315    * @param integer $contributionRecurID
2316    * @param $format
2317    * @param $membershipSource
2318    * @param $ids
2319    * @param $statusFormat
2320    * @param $isPayLater
2321    * @param integer $campaignId
2322    *
2323    * @throws CRM_Core_Exception
2324    * @return array
2325    */
2326   public static function renewMembership($contactID, $membershipTypeID, $is_test, $changeToday, $modifiedID, $customFieldsFormatted, $numRenewTerms, $membershipID, $pending, $allStatus, $membershipTypeDetails, $contributionRecurID, $format, $membershipSource, $ids, $statusFormat, $isPayLater, $campaignId) {
2327     $renewalMode = $updateStatusId = FALSE;
2328     $dates = array();
2329     // CRM-7297 - allow membership type to be be changed during renewal so long as the parent org of new membershipType
2330     // is the same as the parent org of an existing membership of the contact
2331     $currentMembership = CRM_Member_BAO_Membership::getContactMembership($contactID, $membershipTypeID,
2332       $is_test, $membershipID, TRUE
2333     );
2334     if ($currentMembership) {
2335       $activityType = 'Membership Renewal';
2336       $renewalMode = TRUE;
2337
2338       // Do NOT do anything.
2339       //1. membership with status : PENDING/CANCELLED (CRM-2395)
2340       //2. Paylater/IPN renew. CRM-4556.
2341       if ($pending || in_array($currentMembership['status_id'], array(array_search('Pending', $allStatus),
2342           array_search('Cancelled', $allStatus),
2343         ))
2344       ) {
2345         $membership = new CRM_Member_DAO_Membership();
2346         $membership->id = $currentMembership['id'];
2347         $membership->find(TRUE);
2348
2349         // CRM-8141 create a membership_log entry so that we will know the membership_type_id to change to when payment completed
2350         $format = '%Y%m%d';
2351         // note that we are logging the requested new membership_type_id that may be different than current membership_type_id
2352         // it will be used when payment is received to update the membership_type_id to what was paid for
2353         $logParams = array(
2354           'membership_id' => $membership->id,
2355           'status_id' => $membership->status_id,
2356           'start_date' => CRM_Utils_Date::customFormat(
2357             $membership->start_date,
2358             $format
2359           ),
2360           'end_date' => CRM_Utils_Date::customFormat(
2361             $membership->end_date,
2362             $format
2363           ),
2364           'modified_date' => CRM_Utils_Date::customFormat(
2365             date('Ymd'),
2366             $format
2367           ),
2368           'membership_type_id' => $membershipTypeID,
2369           'max_related' => $membershipTypeDetails['max_related'],
2370         );
2371         $session = CRM_Core_Session::singleton();
2372         // If we have an authenticated session, set modified_id to that user's contact_id, else set to membership.contact_id
2373         if ($session->get('userID')) {
2374           $logParams['modified_id'] = $session->get('userID');
2375         }
2376         else {
2377           $logParams['modified_id'] = $membership->contact_id;
2378         }
2379         CRM_Member_BAO_MembershipLog::add($logParams, CRM_Core_DAO::$_nullArray);
2380
2381         if (!empty($contributionRecurID)) {
2382           CRM_Core_DAO::setFieldValue('CRM_Member_DAO_Membership', $membership->id,
2383             'contribution_recur_id', $contributionRecurID
2384           );
2385         }
2386
2387         return array($membership, $renewalMode, $dates);
2388       }
2389
2390       // Check and fix the membership if it is STALE
2391       self::fixMembershipStatusBeforeRenew($currentMembership, $changeToday);
2392
2393       // Now Renew the membership
2394       if (!$currentMembership['is_current_member']) {
2395         // membership is not CURRENT
2396
2397         // CRM-7297 Membership Upsell - calculate dates based on new membership type
2398         $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($currentMembership['id'],
2399           $changeToday,
2400           $membershipTypeID,
2401           $numRenewTerms
2402         );
2403
2404         $currentMembership['join_date'] = CRM_Utils_Date::customFormat($currentMembership['join_date'], $format);
2405         $currentMembership['start_date'] = CRM_Utils_Array::value('start_date', $dates);
2406         $currentMembership['end_date'] = CRM_Utils_Array::value('end_date', $dates);
2407         $currentMembership['is_test'] = $is_test;
2408
2409         if (!empty($membershipSource)) {
2410           $currentMembership['source'] = $membershipSource;
2411         }
2412         else {
2413           $currentMembership['source'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
2414             $currentMembership['id'],
2415             'source'
2416           );
2417         }
2418
2419         if (!empty($currentMembership['id'])) {
2420           $ids['membership'] = $currentMembership['id'];
2421         }
2422         $memParams = $currentMembership;
2423         $memParams['membership_type_id'] = $membershipTypeID;
2424
2425         //set the log start date.
2426         $memParams['log_start_date'] = CRM_Utils_Date::customFormat($dates['log_start_date'], $format);
2427       }
2428       else {
2429
2430         // CURRENT Membership
2431         $membership = new CRM_Member_DAO_Membership();
2432         $membership->id = $currentMembership['id'];
2433         $membership->find(TRUE);
2434         // CRM-7297 Membership Upsell - calculate dates based on new membership type
2435         $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membership->id,
2436           $changeToday,
2437           $membershipTypeID,
2438           $numRenewTerms
2439         );
2440
2441         // Insert renewed dates for CURRENT membership
2442         $memParams = array();
2443         $memParams['join_date'] = CRM_Utils_Date::isoToMysql($membership->join_date);
2444         $memParams['start_date'] = CRM_Utils_Date::isoToMysql($membership->start_date);
2445         $memParams['end_date'] = CRM_Utils_Array::value('end_date', $dates);
2446         $memParams['membership_type_id'] = $membershipTypeID;
2447
2448         //set the log start date.
2449         $memParams['log_start_date'] = CRM_Utils_Date::customFormat($dates['log_start_date'], $format);
2450         if (empty($membership->source)) {
2451           if (!empty($membershipSource)) {
2452             $memParams['source'] = $membershipSource;
2453           }
2454           else {
2455             $memParams['source'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
2456               $currentMembership['id'],
2457               'source'
2458             );
2459           }
2460         }
2461
2462         if (!empty($currentMembership['id'])) {
2463           $ids['membership'] = $currentMembership['id'];
2464         }
2465       }
2466       //CRM-4555
2467       if ($pending) {
2468         $updateStatusId = array_search('Pending', $allStatus);
2469       }
2470     }
2471     else {
2472       // NEW Membership
2473
2474       $activityType = 'Membership Signup';
2475       $memParams = array(
2476         'contact_id' => $contactID,
2477         'membership_type_id' => $membershipTypeID,
2478       );
2479
2480       if (!$pending) {
2481         $dates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($membershipTypeID, NULL, NULL, NULL, $numRenewTerms);
2482
2483         $memParams['join_date'] = CRM_Utils_Array::value('join_date', $dates);
2484         $memParams['start_date'] = CRM_Utils_Array::value('start_date', $dates);
2485         $memParams['end_date'] = CRM_Utils_Array::value('end_date', $dates);
2486
2487         $status = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate(CRM_Utils_Date::customFormat($dates['start_date'],
2488             $statusFormat
2489           ),
2490           CRM_Utils_Date::customFormat($dates['end_date'],
2491             $statusFormat
2492           ),
2493           CRM_Utils_Date::customFormat($dates['join_date'],
2494             $statusFormat
2495           ),
2496           'today',
2497           TRUE,
2498           $membershipTypeID,
2499           $memParams
2500         );
2501         $updateStatusId = CRM_Utils_Array::value('id', $status);
2502       }
2503       else {
2504         // if IPN/Pay-Later set status to: PENDING
2505         $updateStatusId = array_search('Pending', $allStatus);
2506       }
2507
2508       if (!empty($membershipSource)) {
2509         $memParams['source'] = $membershipSource;
2510       }
2511       $memParams['contribution_recur_id'] = $contributionRecurID;
2512
2513       $memParams['is_test'] = $is_test;
2514       $memParams['is_pay_later'] = $isPayLater;
2515     }
2516
2517     //CRM-4555
2518     //if we decided status here and want to skip status
2519     //calculation in create( ); then need to pass 'skipStatusCal'.
2520     if ($updateStatusId) {
2521       $memParams['status_id'] = $updateStatusId;
2522       $memParams['skipStatusCal'] = TRUE;
2523     }
2524
2525     //since we are renewing,
2526     //make status override false.
2527     $memParams['is_override'] = FALSE;
2528
2529     //CRM-4027, create log w/ individual contact.
2530     if ($modifiedID) {
2531       $ids['userId'] = $modifiedID;
2532       $memParams['is_for_organization'] = TRUE;
2533     }
2534     else {
2535       $ids['userId'] = $contactID;
2536     }
2537
2538     //inherit campaign from contrib page.
2539     if (isset($campaignId)) {
2540       $memParams['campaign_id'] = $campaignId;
2541     }
2542
2543     $memParams['custom'] = $customFieldsFormatted;
2544     $membership = self::create($memParams, $ids, FALSE, $activityType);
2545
2546     // not sure why this statement is here, seems quite odd :( - Lobo: 12/26/2010
2547     // related to: http://forum.civicrm.org/index.php/topic,11416.msg49072.html#msg49072
2548     $membership->find(TRUE);
2549
2550     return array($membership, $renewalMode, $dates);
2551   }
2552
2553   /**
2554    * Function to process price set and line items.
2555    *
2556    * @access public
2557    *
2558    * @param $membershipId
2559    * @param $lineItem
2560    *
2561    * @return void
2562    */
2563   function processPriceSet($membershipId, $lineItem) {
2564     //FIXME : need to move this too
2565     if (!$membershipId || !is_array($lineItem)
2566       || CRM_Utils_System::isNull($lineItem)
2567     ) {
2568       return;
2569     }
2570
2571     foreach ($lineItem as $priceSetId => $values) {
2572       if (!$priceSetId) {
2573         continue;
2574       }
2575       foreach ($values as $line) {
2576         $line['entity_table'] = 'civicrm_membership';
2577         $line['entity_id'] = $membershipId;
2578         CRM_Price_BAO_LineItem::create($line);
2579       }
2580     }
2581   }
2582
2583   /**
2584    * retrieve the contribution id for the associated Membership id
2585    * @todo we should get this off the line item
2586    *
2587    * @param  int  $membershipId  membership id.
2588    *
2589    * @return integer contribution id
2590    * @access public
2591    */
2592   static function getMembershipContributionId($membershipId) {
2593
2594     $membershipPayment = new CRM_Member_DAO_MembershipPayment();
2595     $membershipPayment->membership_id = $membershipId;
2596     if ($membershipPayment->find(TRUE)) {
2597       return $membershipPayment->contribution_id;
2598     }
2599     return NULL;
2600   }
2601
2602   /**
2603      * The function checks and updates the status of all membership records for a given domain using the
2604      * calc_membership_status and update_contact_membership APIs.
2605      *
2606      * IMPORTANT:
2607      * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
2608      *
2609    * @return array $result
2610      * @access public
2611      */
2612   static function updateAllMembershipStatus() {
2613
2614     //get all active statuses of membership, CRM-3984
2615     $allStatus     = CRM_Member_PseudoConstant::membershipStatus();
2616     $statusLabels  = CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label');
2617     $allTypes      = CRM_Member_PseudoConstant::membershipType();
2618
2619     // get only memberships with active membership types
2620     $query = "
2621 SELECT     civicrm_membership.id                    as membership_id,
2622            civicrm_membership.is_override           as is_override,
2623            civicrm_membership.membership_type_id    as membership_type_id,
2624            civicrm_membership.status_id             as status_id,
2625            civicrm_membership.join_date             as join_date,
2626            civicrm_membership.start_date            as start_date,
2627            civicrm_membership.end_date              as end_date,
2628            civicrm_membership.source                as source,
2629            civicrm_contact.id                       as contact_id,
2630            civicrm_contact.is_deceased              as is_deceased,
2631            civicrm_membership.owner_membership_id   as owner_membership_id,
2632            civicrm_membership.contribution_recur_id as recur_id
2633 FROM       civicrm_membership
2634 INNER JOIN civicrm_contact ON ( civicrm_membership.contact_id = civicrm_contact.id )
2635 INNER JOIN civicrm_membership_type ON
2636   (civicrm_membership.membership_type_id = civicrm_membership_type.id AND civicrm_membership_type.is_active = 1)
2637 WHERE      civicrm_membership.is_test = 0";
2638
2639     $params = array();
2640     $dao = CRM_Core_DAO::executeQuery($query, $params);
2641
2642     $processCount  = 0;
2643     $updateCount   = 0;
2644
2645     $smarty = CRM_Core_Smarty::singleton();
2646
2647     while ($dao->fetch()) {
2648       // echo ".";
2649       $processCount++;
2650
2651       // Put common parameters into array for easy access
2652       $memberParams = array(
2653         'id' => $dao->membership_id,
2654         'status_id' => $dao->status_id,
2655         'contact_id' => $dao->contact_id,
2656         'membership_type_id' => $dao->membership_type_id,
2657         'membership_type' => $allTypes[$dao->membership_type_id],
2658         'join_date' => $dao->join_date,
2659         'start_date' => $dao->start_date,
2660         'end_date' => $dao->end_date,
2661         'source' => $dao->source,
2662         'skipStatusCal' => TRUE,
2663         'skipRecentView' => TRUE,
2664       );
2665
2666       $smarty->assign_by_ref('memberParams', $memberParams);
2667
2668       //update membership record to Deceased if contact is deceased
2669       if ($dao->is_deceased) {
2670         // check for 'Deceased' membership status, CRM-5636
2671         $deceaseStatusId = array_search('Deceased', $allStatus);
2672         if (!$deceaseStatusId) {
2673           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'))));
2674         }
2675
2676         //process only when status change.
2677         if ($dao->status_id != $deceaseStatusId) {
2678           //take all params that need to save.
2679           $deceasedMembership = $memberParams;
2680           $deceasedMembership['status_id'] = $deceaseStatusId;
2681           $deceasedMembership['createActivity'] = TRUE;
2682           $deceasedMembership['version'] = 3;
2683
2684           //since there is change in status.
2685           $statusChange = array('status_id' => $deceaseStatusId);
2686           $smarty->append_by_ref('memberParams', $statusChange, TRUE);
2687           unset(
2688             $deceasedMembership['contact_id'],
2689             $deceasedMembership['membership_type_id'],
2690             $deceasedMembership['membership_type'],
2691             $deceasedMembership['join_date'],
2692             $deceasedMembership['start_date'],
2693             $deceasedMembership['end_date'],
2694             $deceasedMembership['source']
2695           );
2696
2697           //process membership record.
2698           civicrm_api('membership', 'create', $deceasedMembership);
2699         }
2700         continue;
2701       }
2702
2703       //we fetch related, since we need to check for deceased
2704       //now further processing is handle w/ main membership record.
2705       if ($dao->owner_membership_id) {
2706         continue;
2707       }
2708
2709       //update membership records where status is NOT - Pending OR Cancelled.
2710       //as well as membership is not override.
2711       //skipping Expired membership records -> reduced extra processing( kiran )
2712       if (!$dao->is_override &&
2713         !in_array($dao->status_id, array(array_search('Pending', $allStatus),
2714             array_search('Cancelled', $allStatus),
2715             array_search('Expired', $allStatus),
2716           ))
2717       ) {
2718
2719         // CRM-7248: added excludeIsAdmin param to the following fn call to prevent moving to admin statuses
2720         //get the membership status as per id.
2721         $newStatus = civicrm_api('membership_status', 'calc',
2722           array(
2723             'membership_id' => $dao->membership_id, 'version' => 3, 'ignore_admin_only'=> FALSE), TRUE
2724         );
2725         $statusId = CRM_Utils_Array::value('id', $newStatus);
2726
2727         //process only when status change.
2728         if ($statusId &&
2729           $statusId != $dao->status_id
2730         ) {
2731           //take all params that need to save.
2732           $memParams = $memberParams;
2733           $memParams['status_id'] = $statusId;
2734           $memParams['createActivity'] = TRUE;
2735           $memParams['version'] = 3;
2736
2737           // Unset columns which should remain unchanged from their current saved
2738           // values. This avoids race condition in which these values may have
2739           // been changed by other processes.
2740           unset(
2741             $memParams['contact_id'],
2742             $memParams['membership_type_id'],
2743             $memParams['membership_type'],
2744             $memParams['join_date'],
2745             $memParams['start_date'],
2746             $memParams['end_date'],
2747             $memParams['source']
2748           );
2749           //since there is change in status.
2750           $statusChange = array('status_id' => $statusId);
2751           $smarty->append_by_ref('memberParams', $statusChange, TRUE);
2752
2753           //process member record.
2754           civicrm_api('membership', 'create', $memParams);
2755           $updateCount++;
2756         }
2757       }
2758       // CRM_Core_Error::debug( 'fEnd', count( $GLOBALS['_DB_DATAOBJECT']['RESULTS'] ) );
2759     }
2760     $result['is_error'] = 0;
2761     $result['messages'] = ts('Processed %1 membership records. Updated %2 records.', array(1 => $processCount, 2 => $updateCount));
2762     return $result;
2763   }
2764
2765   /**
2766    * The function returns the membershiptypes for a particular contact
2767    * who has lifetime membership without end date.
2768    *
2769    * @param $contactID
2770    * @param bool $isTest
2771    * @param bool $onlyLifeTime
2772    *
2773    * @return array
2774    * @internal param array $contactMembershipType array of allMembershipTypes Key - value pairs
2775    */
2776
2777   static function getAllContactMembership($contactID, $isTest = FALSE, $onlyLifeTime = FALSE) {
2778     $contactMembershipType = array();
2779     if (!$contactID) {
2780       return $contactMembershipType;
2781     }
2782
2783     $dao             = new CRM_Member_DAO_Membership();
2784     $dao->contact_id = $contactID;
2785     $pendingStatusId = array_search('Pending', CRM_Member_PseudoConstant::membershipStatus());
2786     $dao->whereAdd("status_id != $pendingStatusId");
2787
2788     if ($isTest) {
2789       $dao->is_test = $isTest;
2790     }
2791     else {
2792       $dao->whereAdd('is_test IS NULL OR is_test = 0');
2793     }
2794
2795     if ($onlyLifeTime) {
2796       $dao->whereAdd('end_date IS NULL');
2797     }
2798
2799     $dao->find();
2800     while ($dao->fetch()) {
2801       $membership = array();
2802       CRM_Core_DAO::storeValues($dao, $membership);
2803       $contactMembershipType[$dao->membership_type_id] = $membership;
2804     }
2805     return $contactMembershipType;
2806   }
2807
2808   /**
2809    * Function to record contribution record associated with membership
2810    *
2811    * @param array  $params array of submitted params
2812    * @param array  $ids (param in process of being removed - try to use params)   array of ids
2813    *
2814    * @return CRM_Contribute_BAO_Contribution
2815    * @static
2816    */
2817   static function recordMembershipContribution( &$params, $ids = array()) {
2818     $membershipId = $params['membership_id'];
2819     $contributionParams = array();
2820     $config = CRM_Core_Config::singleton();
2821     $contributionParams['currency'] = $config->defaultCurrency;
2822     $contributionParams['receipt_date'] = (CRM_Utils_Array::value('receipt_date', $params)) ? $params['receipt_date'] : 'null';
2823     $contributionParams['source'] = CRM_Utils_Array::value('contribution_source', $params);
2824     $contributionParams['non_deductible_amount'] = 'null';
2825     $contributionSoftParams = CRM_Utils_Array::value('soft_credit', $params);
2826     $recordContribution = array(
2827       'contact_id', 'total_amount', 'receive_date', 'financial_type_id',
2828       'payment_instrument_id', 'trxn_id', 'invoice_id', 'is_test',
2829       'contribution_status_id', 'check_number', 'campaign_id', 'is_pay_later',
2830       'membership_id', 'skipLineItem'
2831     );
2832     foreach ($recordContribution as $f) {
2833       $contributionParams[$f] = CRM_Utils_Array::value($f, $params);
2834     }
2835
2836     // make entry in batch entity batch table
2837     if (!empty($params['batch_id'])) {
2838       $contributionParams['batch_id'] = $params['batch_id'];
2839     }
2840
2841     if (!empty($params['contribution_contact_id'])) {
2842       // deal with possibility of a different person paying for contribution
2843       $contributionParams['contact_id'] = $params['contribution_contact_id'];
2844     }
2845
2846     if (!empty($params['processPriceSet']) &&
2847       !empty($params['lineItems'])
2848     ) {
2849       $contributionParams['line_item'] = CRM_Utils_Array::value('lineItems', $params, NULL);
2850     }
2851
2852     $contribution = CRM_Contribute_BAO_Contribution::create($contributionParams, $ids);
2853
2854     //CRM-13981, create new soft-credit record as to record payment from differnt person for this membership
2855     if (!empty($contributionSoftParams)) {
2856       $contributionSoftParams['contribution_id'] = $contribution->id;
2857       $contributionSoftParams['currency'] = $contribution->currency;
2858       $contributionSoftParams['amount'] = $contribution->total_amount;
2859       CRM_Contribute_BAO_ContributionSoft::add($contributionSoftParams);
2860     }
2861
2862     // store contribution id
2863     $params['contribution_id'] = $contribution->id;
2864
2865
2866     //insert payment record for this membership
2867     if (empty($ids['contribution']) || !empty($params['is_recur'])) {
2868       $mpDAO = new CRM_Member_DAO_MembershipPayment();
2869       $mpDAO->membership_id = $membershipId;
2870       $mpDAO->contribution_id = $contribution->id;
2871       if (!empty($params['is_recur'])) {
2872         $mpDAO->find();
2873       }
2874
2875       CRM_Utils_Hook::pre('create', 'MembershipPayment', NULL, $mpDAO);
2876       $mpDAO->save();
2877       CRM_Utils_Hook::post('create', 'MembershipPayment', $mpDAO->id, $mpDAO);
2878     }
2879     return $contribution;
2880   }
2881
2882   /**
2883    * Function to record line items for default membership
2884    *
2885    * @param $qf object
2886    *
2887    * @param $membershipType array with membership type and organization
2888    *
2889    * @param $priceSetId
2890    *
2891    * @internal param $ $ priceSetId priceset id
2892    * @access public
2893    * @static
2894    */
2895   static function createLineItems(&$qf, $membershipType, &$priceSetId) {
2896     $qf->_priceSetId = $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
2897     if ($priceSetId) {
2898       $qf->_priceSet = $priceSets = current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId));
2899     }
2900     $editedFieldParams = array(
2901       'price_set_id' => $priceSetId,
2902       'name' => $membershipType[0],
2903     );
2904     $editedResults = array();
2905     CRM_Price_BAO_PriceField::retrieve($editedFieldParams, $editedResults);
2906
2907     if (!empty($editedResults)) {
2908       unset($qf->_priceSet['fields']);
2909       $qf->_priceSet['fields'][$editedResults['id']] = $priceSets['fields'][$editedResults['id']];
2910       unset($qf->_priceSet['fields'][$editedResults['id']]['options']);
2911       $fid = $editedResults['id'];
2912       $editedFieldParams = array(
2913         'price_field_id' => $editedResults['id'],
2914         'membership_type_id' => $membershipType[1],
2915       );
2916       $editedResults = array();
2917       CRM_Price_BAO_PriceFieldValue::retrieve($editedFieldParams, $editedResults);
2918       $qf->_priceSet['fields'][$fid]['options'][$editedResults['id']] = $priceSets['fields'][$fid]['options'][$editedResults['id']];
2919       if (!empty($qf->_params['total_amount'])) {
2920         $qf->_priceSet['fields'][$fid]['options'][$editedResults['id']]['amount'] = $qf->_params['total_amount'];
2921       }
2922     }
2923
2924     $fieldID = key($qf->_priceSet['fields']);
2925     $qf->_params['price_' . $fieldID] = CRM_Utils_Array::value('id', $editedResults);
2926   }
2927
2928   /**
2929    * @todo document me - I seem a bit out of date....
2930    */
2931   static function _getActTypes() {
2932     $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
2933     self::$_renewalActType = CRM_Utils_Array::key('Membership Renewal', $activityTypes);
2934     self::$_signupActType = CRM_Utils_Array::key('Membership Signup', $activityTypes);
2935   }
2936
2937   /**
2938    * Get all Cancelled Membership(s) for a contact
2939    *
2940    * @param int    $contactID   contact id
2941    * @param boolean  $isTest    mode of payment
2942    *
2943    * @return array of membership type
2944    * @static
2945    * @access public
2946    */
2947   static function getContactsCancelledMembership($contactID, $isTest = FALSE) {
2948     if (!$contactID) {
2949       return array();
2950     }
2951     $allStatus = CRM_Member_PseudoConstant::membershipStatus();
2952     $query = 'SELECT membership_type_id FROM civicrm_membership WHERE contact_id = %1 AND status_id = %2 AND is_test = %3';
2953     $queryParams = array(
2954       1 => array($contactID, 'Integer'),
2955       2 => array(array_search('Cancelled', $allStatus), 'Integer'),
2956       3 => array($isTest, 'Boolean'),
2957     );
2958
2959     $dao = CRM_Core_DAO::executeQuery($query, $queryParams);
2960     $cancelledMembershipIds = array();
2961     while ($dao->fetch()) {
2962       $cancelledMembershipIds[] = $dao->membership_type_id;
2963     }
2964     return $cancelledMembershipIds;
2965   }
2966 }