CRM/Member/BAO/Membership.php

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