CRM/Member/BAO/Membership.php

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