CRM/Member/BAO/Membership.php

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