CRM/Member/BAO/Membership.php

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