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