CRM/Member/BAO/Membership.php

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