CRM/Member/BAO/Membership.php

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