CRM/Member/BAO/Membership.php

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