CRM/Member/Form/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
  36 /**
  37  * This class generates form components for offline membership form
  38  *
  39  */
  40 class CRM_Member_Form_Membership extends CRM_Member_Form {
  41
  42   protected $_memType = NULL;
  43
  44   protected $_onlinePendingContributionId;
  45
  46   public $_mode;
  47
  48   public $_contributeMode = 'direct';
  49
  50   protected $_recurMembershipTypes;
  51
  52   protected $_memTypeSelected;
  53
  54   /*
  55    * Display name of the member
  56    */
  57   protected $_memberDisplayName = NULL;
  58
  59   /*
  60   * email of the person paying for the membership (used for receipts)
  61   */
  62   protected $_memberEmail = NULL;
  63
  64   /*
  65   * Contact ID of the member
  66   */
  67   protected $_contactID = NULL;
  68
  69   /*
  70   * Display name of the person paying for the membership (used for receipts)
  71   */
  72   protected $_contributorDisplayName = NULL;
  73
  74   /*
  75    * email of the person paying for the membership (used for receipts)
  76    */
  77   protected $_contributorEmail = NULL;
  78
  79   /*
  80   * email of the person paying for the membership (used for receipts)
  81   */
  82   protected $_contributorContactID = NULL;
  83
  84   /*
  85    * ID of the person the receipt is to go to
  86    */
  87   protected $_receiptContactId = NULL;
  88
  89   /*
  90    * Keep a class variable for ALL membeshipID's so
  91    * postProcess hook function can do something with it
  92    */
  93   protected $_membershipIDs = array();
  94
  95   /**
  96    * An array to hold a list of datefields on the form
  97    * so that they can be converted to ISO in a consistent manner
  98    *
  99    * @var array
 100    */
 101   protected $_dateFields = array(
 102     'receive_date' => array('default' => 'now'),
 103   );
 104
 105   public function preProcess() {
 106     //custom data related code
 107     $this->_cdType = CRM_Utils_Array::value('type', $_GET);
 108     $this->assign('cdType', FALSE);
 109     if ($this->_cdType) {
 110       $this->assign('cdType', TRUE);
 111       return CRM_Custom_Form_CustomData::preProcess($this);
 112     }
 113
 114     // get price set id.
 115     $this->_priceSetId = CRM_Utils_Array::value('priceSetId', $_GET);
 116     $this->set('priceSetId', $this->_priceSetId);
 117     $this->assign('priceSetId', $this->_priceSetId);
 118
 119     // action
 120     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
 121     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 122     $this->_contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 123     $this->_processors = array();
 124     $this->assign('contactID', $this->_contactID);
 125
 126     // check for edit permission
 127     if (!CRM_Core_Permission::checkActionPermission('CiviMember', $this->_action)) {
 128       CRM_Core_Error::fatal(ts('You do not have permission to access this page'));
 129     }
 130
 131     if ($this->_action & CRM_Core_Action::DELETE) {
 132       $contributionID = CRM_Member_BAO_Membership::getMembershipContributionId($this->_id);
 133       // check delete permission for contribution
 134       if ($this->_id && $contributionID && !CRM_Core_Permission::checkActionPermission('CiviContribute', $this->_action)) {
 135         CRM_Core_Error::fatal(ts("This Membership is linked to a contribution. You must have 'delete in CiviContribute' permission in order to delete this record."));
 136       }
 137     }
 138
 139     $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this);
 140     $this->assign('context', $this->_context);
 141
 142     if ($this->_id) {
 143       $this->_memType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'membership_type_id');
 144       $this->_membershipIDs[] = $this->_id;
 145     }
 146
 147     $this->_mode = CRM_Utils_Request::retrieve('mode', 'String', $this);
 148     $this->assign('membershipMode', $this->_mode);
 149
 150     if ($this->_mode) {
 151       $this->_paymentProcessor = array('billing_mode' => 1);
 152       $validProcessors = array();
 153       $processors = CRM_Core_PseudoConstant::paymentProcessor(FALSE, FALSE, 'billing_mode IN ( 1, 3 )');
 154
 155       foreach ($processors as $ppID => $label) {
 156         $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($ppID, $this->_mode);
 157         if ($paymentProcessor['payment_processor_type'] == 'PayPal' && !$paymentProcessor['user_name']) {
 158           continue;
 159         }
 160         elseif ($paymentProcessor['payment_processor_type'] == 'Dummy' && $this->_mode == 'live') {
 161           continue;
 162         }
 163         else {
 164           $paymentObject = CRM_Core_Payment::singleton($this->_mode, $paymentProcessor, $this);
 165           $error = $paymentObject->checkConfig();
 166           if (empty($error)) {
 167             $validProcessors[$ppID] = $label;
 168           }
 169           $paymentObject = NULL;
 170         }
 171       }
 172       if (empty($validProcessors)) {
 173         CRM_Core_Error::fatal(ts('Could not find valid payment processor for this page'));
 174       }
 175       else {
 176         $this->_processors = $validProcessors;
 177       }
 178       // also check for billing information
 179       // get the billing location type
 180       $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id', array(), 'validate');
 181       // CRM-8108 remove ts around Billing location type
 182       //$this->_bltID = array_search( ts('Billing'),  $locationTypes );
 183       $this->_bltID = array_search('Billing', $locationTypes);
 184       if (!$this->_bltID) {
 185         CRM_Core_Error::fatal(ts('Please set a location type of %1', array(1 => 'Billing')));
 186       }
 187       $this->set('bltID', $this->_bltID);
 188       $this->assign('bltID', $this->_bltID);
 189
 190       $this->_fields = array();
 191
 192       CRM_Core_Payment_Form::setCreditCardFields($this);
 193
 194       // this required to show billing block
 195       $this->assign_by_ref('paymentProcessor', $paymentProcessor);
 196       $this->assign('hidePayPalExpress', TRUE);
 197     }
 198
 199     if ($this->_action & CRM_Core_Action::ADD) {
 200       if (!CRM_Member_BAO_Membership::statusAvailabilty($this->_contactID)) {
 201         // all possible statuses are disabled - redirect back to contact form
 202         CRM_Core_Error::statusBounce(ts('There are no configured membership statuses. You cannot add this membership until your membership statuses are correctly configured'));
 203       }
 204
 205       if ($this->_contactID) {
 206         //check whether contact has a current membership so we can alert user that they may want to do a renewal instead
 207         $contactMemberships = array();
 208         $memParams = array('contact_id' => $this->_contactID);
 209         CRM_Member_BAO_Membership::getValues($memParams, $contactMemberships, TRUE);
 210         $cMemTypes = array();
 211         foreach ($contactMemberships as $mem) {
 212           $cMemTypes[] = $mem['membership_type_id'];
 213         }
 214         if (count($cMemTypes) > 0) {
 215           $memberorgs = CRM_Member_BAO_MembershipType::getMemberOfContactByMemTypes($cMemTypes);
 216           $mems_by_org = array();
 217           foreach ($contactMemberships as $memid => $mem) {
 218             $mem['member_of_contact_id'] = CRM_Utils_Array::value($mem['membership_type_id'], $memberorgs);
 219             if (!empty($mem['membership_end_date'])) {
 220               $mem['membership_end_date'] = CRM_Utils_Date::customformat($mem['membership_end_date']);
 221             }
 222             $mem['membership_type'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 223               $mem['membership_type_id'],
 224               'name', 'id'
 225             );
 226             $mem['membership_status'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus',
 227               $mem['status_id'],
 228               'label', 'id'
 229             );
 230             $mem['renewUrl'] = CRM_Utils_System::url('civicrm/contact/view/membership',
 231               "reset=1&action=renew&cid={$this->_contactID}&id={$mem['id']}&context=membership&selectedChild=member"
 232               . ($this->_mode ? '&mode=live' : '')
 233             );
 234             $mem['membershipTab'] = CRM_Utils_System::url('civicrm/contact/view',
 235               "reset=1&force=1&cid={$this->_contactID}&selectedChild=member"
 236             );
 237             $mems_by_org[$mem['member_of_contact_id']] = $mem;
 238           }
 239           $this->assign('existingContactMemberships', $mems_by_org);
 240         }
 241       }
 242       else {
 243         // In standalone mode we don't have a contact id yet so lookup will be done client-side with this script:
 244         $resources = CRM_Core_Resources::singleton();
 245         $resources->addScriptFile('civicrm', 'templates/CRM/Member/Form/MembershipStandalone.js');
 246         $passthru = array(
 247           'typeorgs' => CRM_Member_BAO_MembershipType::getMembershipTypeOrganization(),
 248           'memtypes' => CRM_Core_PseudoConstant::get('CRM_Member_BAO_Membership', 'membership_type_id'),
 249           'statuses' => CRM_Core_PseudoConstant::get('CRM_Member_BAO_Membership', 'status_id'),
 250         );
 251         $resources->addSetting(array('existingMems' => $passthru));
 252       }
 253     }
 254
 255     // when custom data is included in this page
 256     if (!empty($_POST['hidden_custom'])) {
 257       CRM_Custom_Form_CustomData::preProcess($this);
 258       CRM_Custom_Form_CustomData::buildQuickForm($this);
 259       CRM_Custom_Form_CustomData::setDefaultValues($this);
 260     }
 261
 262     // CRM-4395, get the online pending contribution id.
 263     $this->_onlinePendingContributionId = NULL;
 264     if (!$this->_mode && $this->_id && ($this->_action & CRM_Core_Action::UPDATE)) {
 265       $this->_onlinePendingContributionId = CRM_Contribute_BAO_Contribution::checkOnlinePendingContribution($this->_id,
 266         'Membership'
 267       );
 268     }
 269     $this->assign('onlinePendingContributionId', $this->_onlinePendingContributionId);
 270     $this->_fromEmails = CRM_Core_BAO_Email::getFromEmail();
 271
 272     $this->setPageTitle(ts('Membership'));
 273
 274
 275     parent::preProcess();
 276   }
 277
 278   /**
 279    * This function sets the default values for the form. MobileProvider that in edit/view mode
 280    * the default values are retrieved from the database
 281    *
 282    * @access public
 283    *
 284    * @return void
 285    */
 286   public function setDefaultValues() {
 287     if ($this->_cdType) {
 288       return CRM_Custom_Form_CustomData::setDefaultValues($this);
 289     }
 290
 291     if ($this->_priceSetId) {
 292       return CRM_Price_BAO_PriceSet::setDefaultPriceSet($this, $defaults);
 293     }
 294
 295     $defaults = parent::setDefaultValues();
 296
 297     //setting default join date and receive date
 298     list($now, $currentTime) = CRM_Utils_Date::setDateDefaults();
 299     if ($this->_action == CRM_Core_Action::ADD) {
 300       $defaults['receive_date'] = $now;
 301       $defaults['receive_date_time'] = $currentTime;
 302     }
 303
 304     if (is_numeric($this->_memType)) {
 305       $defaults['membership_type_id'] = array();
 306       $defaults['membership_type_id'][0] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 307         $this->_memType,
 308         'member_of_contact_id',
 309         'id'
 310       );
 311       $defaults['membership_type_id'][1] = $this->_memType;
 312     }
 313     else {
 314       $defaults['membership_type_id'] = $this->_memType;
 315     }
 316
 317     $defaults['num_terms'] = 1;
 318
 319     if (!empty($defaults['id'])) {
 320       if ($this->_onlinePendingContributionId) {
 321         $defaults['record_contribution'] = $this->_onlinePendingContributionId;
 322       }
 323       else {
 324         $contributionId = CRM_Core_DAO::singleValueQuery("
 325   SELECT contribution_id
 326   FROM civicrm_membership_payment
 327   WHERE membership_id = $this->_id
 328   ORDER BY contribution_id
 329   DESC limit 1");
 330
 331         if ($contributionId) {
 332           $defaults['record_contribution'] = $contributionId;
 333         }
 334       }
 335     }
 336
 337     //set Soft Credit Type to Gift by default
 338     $scTypes = CRM_Core_OptionGroup::values("soft_credit_type");
 339     $defaults['soft_credit_type_id'] = CRM_Utils_Array::value(ts('Gift'), array_flip($scTypes));
 340
 341     if (!empty($defaults['record_contribution']) && !$this->_mode) {
 342       $contributionParams = array('id' => $defaults['record_contribution']);
 343       $contributionIds = array();
 344
 345       //keep main object campaign in hand.
 346       $memberCampaignId = CRM_Utils_Array::value('campaign_id', $defaults);
 347
 348       CRM_Contribute_BAO_Contribution::getValues($contributionParams, $defaults, $contributionIds);
 349
 350       //get back original object campaign id.
 351       $defaults['campaign_id'] = $memberCampaignId;
 352
 353       if (!empty($defaults['receive_date'])) {
 354         list($defaults['receive_date']) = CRM_Utils_Date::setDateDefaults($defaults['receive_date']);
 355       }
 356
 357       // Contribution::getValues() over-writes the membership record's source field value - so we need to restore it.
 358       if (!empty($defaults['membership_source'])) {
 359         $defaults['source'] = $defaults['membership_source'];
 360       }
 361     }
 362     //CRM-13420
 363     if (empty($defaults['payment_instrument_id'])) {
 364       $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
 365     }
 366
 367     // User must explicitly choose to send a receipt in both add and update mode.
 368     $defaults['send_receipt'] = 0;
 369
 370     if ($this->_action & CRM_Core_Action::UPDATE) {
 371       // in this mode by default uncheck this checkbox
 372       unset($defaults['record_contribution']);
 373     }
 374
 375     if (!empty($defaults['id'])) {
 376       $subscriptionCancelled = CRM_Member_BAO_Membership::isSubscriptionCancelled($this->_id);
 377     }
 378
 379     $alreadyAutoRenew = FALSE;
 380     if (!empty($defaults['contribution_recur_id']) && !$subscriptionCancelled) {
 381       $defaults['auto_renew'] = 1;
 382       $alreadyAutoRenew = TRUE;
 383     }
 384     $this->assign('alreadyAutoRenew', $alreadyAutoRenew);
 385
 386     $this->assign('member_is_test', CRM_Utils_Array::value('member_is_test', $defaults));
 387
 388     $this->assign('membership_status_id', CRM_Utils_Array::value('status_id', $defaults));
 389
 390     if (!empty($defaults['is_pay_later'])) {
 391       $this->assign('is_pay_later', TRUE);
 392     }
 393     if ($this->_mode) {
 394       // set default country from config if no country set
 395       $config = CRM_Core_Config::singleton();
 396       if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
 397         $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry;
 398       }
 399
 400       if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
 401         $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince;
 402       }
 403
 404       $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID);
 405       $defaults = array_merge($defaults, $billingDefaults);
 406
 407       //             // hack to simplify credit card entry for testing
 408       //             $defaults['credit_card_type']     = 'Visa';
 409       //             $defaults['credit_card_number']   = '4807731747657838';
 410       //             $defaults['cvv2']                 = '000';
 411       //             $defaults['credit_card_exp_date'] = array( 'Y' => '2012', 'M' => '05' );
 412     }
 413
 414     $dates = array('join_date', 'start_date', 'end_date');
 415     foreach ($dates as $key) {
 416       if (!empty($defaults[$key])) {
 417         list($defaults[$key]) = CRM_Utils_Date::setDateDefaults(CRM_Utils_Array::value($key, $defaults));
 418       }
 419     }
 420
 421     //setting default join date if there is no join date
 422     if (empty($defaults['join_date'])) {
 423       $defaults['join_date'] = $now;
 424     }
 425
 426     if (!empty($defaults['membership_end_date'])) {
 427       $this->assign('endDate', $defaults['membership_end_date']);
 428     }
 429
 430     return $defaults;
 431   }
 432
 433   /**
 434    * Function to build the form
 435    *
 436    * @return void
 437    * @access public
 438    */
 439   public function buildQuickForm() {
 440     if ($this->_cdType) {
 441       return CRM_Custom_Form_CustomData::buildQuickForm($this);
 442     }
 443
 444     // build price set form.
 445     $buildPriceSet = FALSE;
 446     if ($this->_priceSetId || !empty($_POST['price_set_id'])) {
 447       if (!empty($_POST['price_set_id'])) {
 448         $buildPriceSet = TRUE;
 449       }
 450       $getOnlyPriceSetElements = TRUE;
 451       if (!$this->_priceSetId) {
 452         $this->_priceSetId = $_POST['price_set_id'];
 453         $getOnlyPriceSetElements = FALSE;
 454       }
 455
 456       $this->set('priceSetId', $this->_priceSetId);
 457       CRM_Price_BAO_PriceSet::buildPriceSet($this);
 458
 459       $optionsMembershipTypes = array();
 460       foreach ($this->_priceSet['fields'] as $pField) {
 461         if (empty($pField['options'])) {
 462           continue;
 463         }
 464         foreach ($pField['options'] as $opId => $opValues) {
 465           $optionsMembershipTypes[$opId] = CRM_Utils_Array::value('membership_type_id', $opValues, 0);
 466         }
 467       }
 468
 469       $this->assign('autoRenewOption', CRM_Price_BAO_PriceSet::checkAutoRenewForPriceSet($this->_priceSetId));
 470
 471       $this->assign('optionsMembershipTypes', $optionsMembershipTypes);
 472       $this->assign('contributionType', CRM_Utils_Array::value('financial_type_id', $this->_priceSet));
 473
 474       // get only price set form elements.
 475       if ($getOnlyPriceSetElements) {
 476         return;
 477       }
 478     }
 479
 480     // use to build form during form rule.
 481     $this->assign('buildPriceSet', $buildPriceSet);
 482
 483     if ($this->_action & CRM_Core_Action::ADD) {
 484       $buildPriceSet = FALSE;
 485       $priceSets = CRM_Price_BAO_PriceSet::getAssoc(FALSE, 'CiviMember');
 486       if (!empty($priceSets)) {
 487         $buildPriceSet = TRUE;
 488       }
 489
 490       if ($buildPriceSet) {
 491         $this->add('select', 'price_set_id', ts('Choose price set'),
 492           array(
 493             '' => ts('Choose price set')
 494           ) + $priceSets,
 495           NULL, array('onchange' => "buildAmount( this.value );")
 496         );
 497       }
 498       $this->assign('hasPriceSets', $buildPriceSet);
 499     }
 500
 501     //need to assign custom data type and subtype to the template
 502     $this->assign('customDataType', 'Membership');
 503     $this->assign('customDataSubType', $this->_memType);
 504     $this->assign('entityID', $this->_id);
 505
 506     if ($this->_action & CRM_Core_Action::DELETE) {
 507       $this->addButtons(array(
 508           array(
 509             'type' => 'next',
 510             'name' => ts('Delete'),
 511             'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 512             'isDefault' => TRUE,
 513           ),
 514           array(
 515             'type' => 'cancel',
 516             'name' => ts('Cancel'),
 517           ),
 518         )
 519       );
 520       return;
 521     }
 522
 523     if ($this->_context == 'standalone') {
 524       $this->addEntityRef('contact_id', ts('Contact'), array('create' => TRUE, 'api' => array('extra' => array('email'))), TRUE);
 525     }
 526
 527     $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
 528
 529     $dao = new CRM_Member_DAO_MembershipType();
 530     $dao->domain_id = CRM_Core_Config::domainID();
 531     $dao->find();
 532
 533     // retrieve all memberships
 534     $allMemberships = CRM_Member_BAO_Membership::buildMembershipTypeValues($this);
 535
 536     $allMembershipInfo = $membershipType = array();
 537     foreach ($allMemberships as $key => $values) {
 538       if (!empty($values['is_active'])) {
 539         $membershipType[$key] = CRM_Utils_Array::value('name', $values);
 540         if ($this->_mode && empty($values['minimum_fee'])) {
 541           continue;
 542         }
 543         else {
 544           $memberOfContactId = CRM_Utils_Array::value('member_of_contact_id', $values);
 545           if (empty($selMemTypeOrg[$memberOfContactId])) {
 546             $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 547               $memberOfContactId,
 548               'display_name',
 549               'id'
 550             );
 551
 552             $selOrgMemType[$memberOfContactId][0] = ts('- select -');
 553           }
 554           if (empty($selOrgMemType[$memberOfContactId][$key])) {
 555             $selOrgMemType[$memberOfContactId][$key] = CRM_Utils_Array::value('name', $values);
 556           }
 557         }
 558
 559         // build membership info array, which is used when membership type is selected to:
 560         // - set the payment information block
 561         // - set the max related block
 562         $allMembershipInfo[$key] = array(
 563           'financial_type_id' => CRM_Utils_Array::value('financial_type_id', $values),
 564           'total_amount' => CRM_Utils_Money::format($values['minimum_fee'], NULL, '%a'),
 565           'total_amount_numeric' => CRM_Utils_Array::value('minimum_fee', $values),
 566           'auto_renew' => CRM_Utils_Array::value('auto_renew', $values),
 567           'has_related' => isset($values['relationship_type_id']),
 568           'max_related' => CRM_Utils_Array::value('max_related', $values),
 569         );
 570       }
 571     }
 572
 573     $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
 574
 575     // show organization by default, if only one organization in
 576     // the list
 577     if (count($selMemTypeOrg) == 2) {
 578       unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
 579     }
 580     //sort membership organization and type, CRM-6099
 581     natcasesort($selMemTypeOrg);
 582     foreach ($selOrgMemType as $index => $orgMembershipType) {
 583       natcasesort($orgMembershipType);
 584       $selOrgMemType[$index] = $orgMembershipType;
 585     }
 586
 587     $memTypeJs = array('onChange' => "CRM.buildCustomData( 'Membership', this.value );");
 588
 589     //build the form for auto renew.
 590     $recurProcessor = $autoRenew = array();
 591     if ($this->_mode || ($this->_action & CRM_Core_Action::UPDATE)) {
 592       $autoRenewElement = $this->addElement('checkbox',
 593         'auto_renew',
 594         ts('Membership renewed automatically'),
 595         NULL,
 596         array('onclick' => "buildReceiptANDNotice( );")
 597       );
 598
 599       if ($this->_mode) {
 600         //get the valid recurring processors.
 601         $recurring = CRM_Core_PseudoConstant::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
 602         $recurProcessor = array_intersect_assoc($this->_processors, $recurring);
 603         $autoRenew = array();
 604         if (!empty($recurProcessor)) {
 605           if (!empty($membershipType)) {
 606             $sql = '
 607 SELECT  id,
 608         auto_renew,
 609         duration_unit,
 610         duration_interval
 611  FROM   civicrm_membership_type
 612 WHERE   id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )';
 613             $recurMembershipTypes = CRM_Core_DAO::executeQuery($sql);
 614             while ($recurMembershipTypes->fetch()) {
 615               $autoRenew[$recurMembershipTypes->id] = $recurMembershipTypes->auto_renew;
 616               foreach (array(
 617                          'id',
 618                          'auto_renew',
 619                          'duration_unit',
 620                          'duration_interval'
 621                        ) as $fld) {
 622                 $this->_recurMembershipTypes[$recurMembershipTypes->id][$fld] = $recurMembershipTypes->$fld;
 623               }
 624             }
 625           }
 626           $memTypeJs = array(
 627             'onChange' =>
 628             "CRM.buildCustomData( 'Membership', this.value ); buildAutoRenew(this.value, null );",
 629           );
 630         }
 631       }
 632     }
 633     $allowAutoRenew = FALSE;
 634     if ($this->_mode && !empty($recurProcessor)) {
 635       $allowAutoRenew = TRUE;
 636     }
 637     $this->assign('allowAutoRenew', $allowAutoRenew);
 638     $this->assign('autoRenewOptions', json_encode($autoRenew));
 639     $this->assign('recurProcessor', json_encode($recurProcessor));
 640
 641     // for max_related: a little JS to show/hide & set default value
 642     $memTypeJs['onChange'] = "buildMaxRelated(this.value,true); " . $memTypeJs['onChange'];
 643     $this->add('text', 'max_related', ts('Max related'),
 644       CRM_Core_DAO::getAttribute('CRM_Member_DAO_Membership', 'max_related')
 645     );
 646
 647     $sel = & $this->addElement('hierselect',
 648       'membership_type_id',
 649       ts('Membership Organization and Type'),
 650       $memTypeJs
 651     );
 652
 653     $sel->setOptions(array($selMemTypeOrg, $selOrgMemType));
 654     $elements = array();
 655     if ($sel) {
 656       $elements[] = $sel;
 657     }
 658
 659     $this->applyFilter('__ALL__', 'trim');
 660
 661     if ($this->_action & CRM_Core_Action::ADD) {
 662       $this->add('text', 'num_terms', ts('Number of Terms'), array('size' => 6));
 663     }
 664
 665     $this->addDate('join_date', ts('Member Since'), FALSE, array('formatType' => 'activityDate'));
 666     $this->addDate('start_date', ts('Start Date'), FALSE, array('formatType' => 'activityDate'));
 667     $endDate = $this->addDate('end_date', ts('End Date'), FALSE, array('formatType' => 'activityDate'));
 668     if ($endDate) {
 669       $elements[] = $endDate;
 670     }
 671
 672     $this->add('text', 'source', ts('Source'),
 673       CRM_Core_DAO::getAttribute('CRM_Member_DAO_Membership', 'source')
 674     );
 675
 676     //CRM-7362 --add campaigns.
 677     $campaignId = NULL;
 678     if ($this->_id) {
 679       $campaignId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'campaign_id');
 680     }
 681     CRM_Campaign_BAO_Campaign::addCampaign($this, $campaignId);
 682
 683     if (!$this->_mode) {
 684       $this->add('select', 'status_id', ts('Membership Status'),
 685         array('' => ts('- select -')) + CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label')
 686       );
 687       $statusOverride = $this->addElement('checkbox', 'is_override',
 688         ts('Status Override?'), NULL,
 689         array('onClick' => 'showHideMemberStatus()')
 690       );
 691       if ($statusOverride) {
 692         $elements[] = $statusOverride;
 693       }
 694
 695       $this->addElement('checkbox', 'record_contribution', ts('Record Membership Payment?'));
 696
 697       $this->add('text', 'total_amount', ts('Amount'));
 698       $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
 699
 700       $this->addDate('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
 701
 702       $this->add('select', 'payment_instrument_id',
 703         ts('Paid By'),
 704         array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::paymentInstrument(),
 705         FALSE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
 706       );
 707       $this->add('text', 'trxn_id', ts('Transaction ID'));
 708       $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
 709         'objectExists', array('CRM_Contribute_DAO_Contribution', $this->_id, 'trxn_id')
 710       );
 711
 712       $allowStatuses = array();
 713       $statuses = CRM_Contribute_PseudoConstant::contributionStatus();
 714       if ($this->_onlinePendingContributionId) {
 715         $statusNames = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 716         foreach ($statusNames as $val => $name) {
 717           if (in_array($name, array(
 718             'In Progress',
 719             'Overdue'
 720           ))
 721           ) {
 722             continue;
 723           }
 724           $allowStatuses[$val] = $statuses[$val];
 725         }
 726       }
 727       else {
 728         $allowStatuses = $statuses;
 729       }
 730       $this->add('select', 'contribution_status_id',
 731         ts('Payment Status'), $allowStatuses
 732       );
 733       $this->add('text', 'check_number', ts('Check Number'),
 734         CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
 735       );
 736     }
 737     else {
 738       //add field for amount to allow an amount to be entered that differs from minimum
 739       $this->add('text', 'total_amount', ts('Amount'));
 740     }
 741     $this->add('select', 'financial_type_id',
 742       ts('Financial Type'),
 743       array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::financialType()
 744     );
 745
 746     //CRM-10223 - allow contribution to be recorded against different contact
 747     // causes a conflict in standalone mode so skip in standalone for now
 748     $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different Contact?'));
 749     $this->addSelect('soft_credit_type_id', array('entity' => 'contribution_soft'));
 750     $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), array('create' => TRUE));
 751
 752
 753     $this->addElement('checkbox',
 754       'send_receipt',
 755       ts('Send Confirmation and Receipt?'), NULL,
 756       array('onclick' => "showHideByValue( 'send_receipt', '', 'notice', 'table-row', 'radio', false); showHideByValue( 'send_receipt', '', 'fromEmail', 'table-row', 'radio', false);")
 757     );
 758
 759     $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails);
 760
 761     $this->add('textarea', 'receipt_text_signup', ts('Receipt Message'));
 762     if ($this->_mode) {
 763
 764       $this->add('select', 'payment_processor_id',
 765         ts('Payment Processor'),
 766         $this->_processors, TRUE,
 767         array('onChange' => "buildAutoRenew( null, this.value );")
 768       );
 769       CRM_Core_Payment_Form::buildCreditCard($this, TRUE);
 770     }
 771
 772     // Retrieve the name and email of the contact - this will be the TO for receipt email
 773     if ($this->_contactID) {
 774       list($this->_memberDisplayName,
 775         $this->_memberEmail
 776         ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 777
 778       $this->assign('emailExists', $this->_memberEmail);
 779       $this->assign('displayName', $this->_memberDisplayName);
 780     }
 781
 782     $isRecur = FALSE;
 783     if ($this->_action & CRM_Core_Action::UPDATE) {
 784       $recurContributionId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id,
 785         'contribution_recur_id'
 786       );
 787       if ($recurContributionId && !CRM_Member_BAO_Membership::isSubscriptionCancelled($this->_id)) {
 788         $isRecur = TRUE;
 789         if (CRM_Member_BAO_Membership::isCancelSubscriptionSupported($this->_id)) {
 790           $this->assign('cancelAutoRenew',
 791             CRM_Utils_System::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
 792           );
 793         }
 794         foreach ($elements as $elem) {
 795           $elem->freeze();
 796         }
 797       }
 798     }
 799     $this->assign('isRecur', $isRecur);
 800
 801     $this->addFormRule(array('CRM_Member_Form_Membership', 'formRule'), $this);
 802
 803     $mailingInfo = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
 804       'mailing_backend'
 805     );
 806     $this->assign('outBound_option', $mailingInfo['outBound_option']);
 807
 808     parent::buildQuickForm();
 809   }
 810
 811   /**
 812    * Function for validation
 813    *
 814    * @param array $params (ref.) an assoc array of name/value pairs
 815    *
 816    * @param $files
 817    * @param $self
 818    *
 819    * @throws CiviCRM_API3_Exception
 820    * @return mixed true or array of errors
 821    * @access public
 822    * @static
 823    */
 824   static function formRule($params, $files, $self) {
 825     $errors = array();
 826
 827     $priceSetId = CRM_Utils_Array::value('price_set_id', $params);
 828
 829     if ($priceSetId) {
 830       CRM_Price_BAO_PriceField::priceSetValidation($priceSetId, $params, $errors);
 831
 832       $priceFieldIDS = array();
 833       foreach ($self->_priceSet['fields'] as $priceIds => $dontCare) {
 834
 835         if (!empty($params['price_' . $priceIds])) {
 836           if (is_array($params['price_' . $priceIds])) {
 837             foreach ($params['price_' . $priceIds] as $priceFldVal => $isSet) {
 838               if ($isSet) {
 839                 $priceFieldIDS[] = $priceFldVal;
 840               }
 841             }
 842           }
 843           else {
 844             $priceFieldIDS[] = $params['price_' . $priceIds];
 845           }
 846         }
 847       }
 848
 849       if (!empty($priceFieldIDS)) {
 850         $ids = implode(',', $priceFieldIDS);
 851
 852         $count = CRM_Price_BAO_PriceSet::getMembershipCount($ids);
 853         foreach ($count as $id => $occurance) {
 854           if ($occurance > 1) {
 855             $errors['_qf_default'] = ts('Select at most one option associated with the same membership type.');
 856           }
 857         }
 858
 859         foreach ($priceFieldIDS as $priceFieldId) {
 860           if ($id = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id')) {
 861             $self->_memTypeSelected[$id] = $id;
 862           }
 863         }
 864       }
 865     }
 866     elseif (empty($params['membership_type_id'][1])) {
 867       $errors['membership_type_id'] = ts('Please select a membership type.');
 868     }
 869     else {
 870       $self->_memTypeSelected[] = $params['membership_type_id'][1];
 871     }
 872
 873     if (!$priceSetId) {
 874       $numterms = CRM_Utils_Array::value('num_terms', $params);
 875       if ($numterms && intval($numterms) != $numterms) {
 876         $errors['num_terms'] = ts('Please enter an integer for the number of terms.');
 877       }
 878     }
 879
 880     // Return error if empty $self->_memTypeSelected
 881     if ($priceSetId && empty($errors) && empty($self->_memTypeSelected)) {
 882       $errors['_qf_default'] = ts('Select at least one membership option.');
 883     }
 884
 885     if (!empty($errors) && (count($self->_memTypeSelected) > 1)) {
 886       $memberOfContacts = CRM_Member_BAO_MembershipType::getMemberOfContactByMemTypes($self->_memTypeSelected);
 887       $duplicateMemberOfContacts = array_count_values($memberOfContacts);
 888       foreach ($duplicateMemberOfContacts as $countDuplicate) {
 889         if ($countDuplicate > 1) {
 890           $errors['_qf_default'] = ts('Please do not select more than one membership associated with the same organization.');
 891         }
 892       }
 893     }
 894
 895     if (!empty($errors)) {
 896       return $errors;
 897     }
 898
 899     if ($priceSetId && !$self->_mode && empty($params['record_contribution'])) {
 900       $errors['record_contribution'] = ts('Record Membership Payment is required when you using price set.');
 901     }
 902
 903     if (!$priceSetId && $self->_mode && empty($params['financial_type_id'])) {
 904       $errors['financial_type_id'] = ts('Please enter the financial Type.');
 905     }
 906
 907     if (!empty($params['record_contribution']) && empty($params['payment_instrument_id'])) {
 908       $errors['payment_instrument_id'] = ts('Paid By is a required field.');
 909     }
 910
 911     if (!empty($params['is_different_contribution_contact'])) {
 912       if (empty($params['soft_credit_type_id'])) {
 913         $errors['soft_credit_type_id'] = ts('Please Select a Soft Credit Type');
 914       }
 915       if (empty($params['soft_credit_contact_id'])) {
 916         $errors['soft_credit_contact_id'] = ts('Please select a contact');
 917       }
 918     }
 919
 920     if (!empty($params['payment_processor_id'])) {
 921       // make sure that credit card number and cvv are valid
 922       CRM_Core_Payment_Form::validateCreditCard($params, $errors);
 923     }
 924
 925     $joinDate = NULL;
 926     if (!empty($params['join_date'])) {
 927
 928       $joinDate = CRM_Utils_Date::processDate($params['join_date']);
 929
 930       foreach ($self->_memTypeSelected as $memType) {
 931         $startDate = NULL;
 932         if (!empty($params['start_date'])) {
 933           $startDate = CRM_Utils_Date::processDate($params['start_date']);
 934         }
 935
 936         // if end date is set, ensure that start date is also set
 937         // and that end date is later than start date
 938         $endDate = NULL;
 939         if (!empty($params['end_date'])) {
 940           $endDate = CRM_Utils_Date::processDate($params['end_date']);
 941         }
 942
 943         $membershipDetails = CRM_Member_BAO_MembershipType::getMembershipTypeDetails($memType);
 944
 945         if ($startDate && CRM_Utils_Array::value('period_type', $membershipDetails) == 'rolling') {
 946           if ($startDate < $joinDate) {
 947             $errors['start_date'] = ts('Start date must be the same or later than Member since.');
 948           }
 949         }
 950
 951         if ($endDate) {
 952           if ($membershipDetails['duration_unit'] == 'lifetime') {
 953             // Check if status is NOT cancelled or similar. For lifetime memberships, there is no automated
 954             // process to update status based on end-date. The user must change the status now.
 955             $result = civicrm_api3('MembershipStatus', 'get', array(
 956               'sequential' => 1,
 957               'is_current_member' => 0,
 958             ));
 959             $tmp_statuses = $result['values'];
 960             $status_ids = array();
 961             foreach($tmp_statuses as $cur_stat) {
 962               $status_ids[] = $cur_stat['id'];
 963             }
 964             if (empty($params['status_id']) || in_array( $params['status_id'] , $status_ids) == false) {
 965               $errors['status_id'] = ts('Please enter a status that does NOT represent a current membership status.');
 966               $errors['is_override']  = ts('This must be checked because you set an End Date for a lifetime membership');
 967             }
 968           }
 969           else {
 970             if (!$startDate) {
 971               $errors['start_date'] = ts('Start date must be set if end date is set.');
 972             }
 973             if ($endDate < $startDate) {
 974               $errors['end_date'] = ts('End date must be the same or later than start date.');
 975             }
 976           }
 977         }
 978
 979         //  Default values for start and end dates if not supplied
 980         //  on the form
 981         $defaultDates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($memType,
 982           $joinDate,
 983           $startDate,
 984           $endDate
 985         );
 986
 987         if (!$startDate) {
 988           $startDate = CRM_Utils_Array::value('start_date',
 989             $defaultDates
 990           );
 991         }
 992         if (!$endDate) {
 993           $endDate = CRM_Utils_Array::value('end_date',
 994             $defaultDates
 995           );
 996         }
 997
 998         //CRM-3724, check for availability of valid membership status.
 999         if (empty($params['is_override']) && !isset($errors['_qf_default'])) {
1000           $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($startDate,
1001             $endDate,
1002             $joinDate,
1003             'today',
1004             TRUE,
1005             $memType,
1006             $params
1007           );
1008           if (empty($calcStatus)) {
1009             $url = CRM_Utils_System::url('civicrm/admin/member/membershipStatus', 'reset=1&action=browse');
1010             $errors['_qf_default'] = ts('There is no valid Membership Status available for selected membership dates.');
1011             $status = ts('Oops, it looks like there is no valid membership status available for the given membership dates. You can <a href="%1">Configure Membership Status Rules</a>.', array(1 => $url));
1012             if (!$self->_mode) {
1013               $status .= ' ' . ts('OR You can sign up by setting Status Override? to true.');
1014             }
1015             CRM_Core_Session::setStatus($status, ts('Membership Status Error'), 'error');
1016           }
1017         }
1018       }
1019     }
1020     else {
1021       $errors['join_date'] = ts('Please enter the Member Since.');
1022     }
1023
1024     if (isset($params['is_override']) &&
1025       $params['is_override'] && empty($params['status_id'])) {
1026       $errors['status_id'] = ts('Please enter the status.');
1027     }
1028
1029     //total amount condition arise when membership type having no
1030     //minimum fee
1031     if (isset($params['record_contribution'])) {
1032       if (!$params['financial_type_id']) {
1033         $errors['financial_type_id'] = ts('Please enter the financial Type.');
1034       }
1035       if (CRM_Utils_System::isNull($params['total_amount'])) {
1036         $errors['total_amount'] = ts('Please enter the contribution.');
1037       }
1038     }
1039
1040     // validate contribution status for 'Failed'.
1041     if ($self->_onlinePendingContributionId && !empty($params['record_contribution']) &&
1042       (CRM_Utils_Array::value('contribution_status_id', $params) ==
1043         array_search('Failed', CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'))
1044       )
1045     ) {
1046       $errors['contribution_status_id'] = ts('Please select a valid payment status before updating.');
1047     }
1048
1049     return empty($errors) ? TRUE : $errors;
1050   }
1051
1052   /**
1053    * Function to process the form
1054    *
1055    * @access public
1056    *
1057    * @return void
1058    */
1059   public function postProcess() {
1060     if ($this->_action & CRM_Core_Action::DELETE) {
1061       CRM_Member_BAO_Membership::del($this->_id);
1062       return;
1063     }
1064
1065     $isTest = ($this->_mode == 'test') ? 1 : 0;
1066
1067     $lineItems = NULL;
1068     if (!empty($this->_lineItem)) {
1069       $lineItems = $this->_lineItem;
1070     }
1071
1072     $config = CRM_Core_Config::singleton();
1073     // get the submitted form values.
1074     $this->_params = $formValues = $this->controller->exportValues($this->_name);
1075     $this->convertDateFieldsToMySQL($formValues);
1076
1077     $params = $softParams = $ids = array();
1078
1079     $membershipTypeValues = array();
1080     foreach ($this->_memTypeSelected as $memType) {
1081       $membershipTypeValues[$memType]['membership_type_id'] = $memType;
1082     }
1083
1084     //take the required membership recur values.
1085     if ($this->_mode && !empty($this->_params['auto_renew'])) {
1086       $params['is_recur'] = $this->_params['is_recur'] = $formValues['is_recur'] = TRUE;
1087       $mapping = array(
1088         'frequency_interval' => 'duration_interval',
1089         'frequency_unit' => 'duration_unit',
1090       );
1091
1092       $count = 0;
1093       foreach ($this->_memTypeSelected as $memType) {
1094         $recurMembershipTypeValues = CRM_Utils_Array::value($memType,
1095           $this->_recurMembershipTypes, array()
1096         );
1097         foreach ($mapping as $mapVal => $mapParam) {
1098           $membershipTypeValues[$memType][$mapVal] = CRM_Utils_Array::value($mapParam,
1099             $recurMembershipTypeValues
1100           );
1101           if (!$count) {
1102             $this->_params[$mapVal] = $formValues[$mapVal] = CRM_Utils_Array::value($mapParam,
1103               $recurMembershipTypeValues
1104             );
1105           }
1106         }
1107         $count++;
1108       }
1109
1110       // unset send-receipt option, since receipt will be sent when ipn is received.
1111       unset($this->_params['send_receipt'], $formValues['send_receipt']);
1112     }
1113
1114     // process price set and get total amount and line items.
1115     $lineItem = array();
1116     $priceSetId = NULL;
1117     if (!$priceSetId = CRM_Utils_Array::value('price_set_id', $formValues)) {
1118       CRM_Member_BAO_Membership::createLineItems($this, $formValues['membership_type_id'], $priceSetId);
1119     }
1120     $isQuickConfig = 0;
1121     if ($this->_priceSetId && CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config')) {
1122       $isQuickConfig = 1;
1123     }
1124
1125     $termsByType = array();
1126     if ($priceSetId) {
1127       CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'],
1128         $this->_params, $lineItem[$priceSetId]);
1129       $params['total_amount'] = CRM_Utils_Array::value('amount', $this->_params);
1130       $submittedFinancialType = CRM_Utils_Array::value('financial_type_id', $formValues);
1131       if (!empty($lineItem[$priceSetId])) {
1132         foreach ($lineItem[$priceSetId] as &$li) {
1133           if (!empty($li['membership_type_id'])) {
1134             if (!empty($li['membership_num_terms'])) {
1135               $termsByType[$li['membership_type_id']] = $li['membership_num_terms'];
1136             }
1137           }
1138
1139           ///CRM-11529 for quick config backoffice transactions
1140           //when financial_type_id is passed in form, update the
1141           //lineitems with the financial type selected in form
1142           if ($isQuickConfig && $submittedFinancialType) {
1143             $li['financial_type_id'] = $submittedFinancialType;
1144           }
1145         }
1146       }
1147     }
1148
1149     $this->storeContactFields($formValues);
1150
1151     $params['contact_id'] = $this->_contactID;
1152
1153     $fields = array(
1154       'status_id',
1155       'source',
1156       'is_override',
1157       'campaign_id',
1158     );
1159
1160     foreach ($fields as $f) {
1161       $params[$f] = CRM_Utils_Array::value($f, $formValues);
1162     }
1163
1164     // fix for CRM-3724
1165     // when is_override false ignore is_admin statuses during membership
1166     // status calculation. similarly we did fix for import in CRM-3570.
1167     if (empty($params['is_override'])) {
1168       $params['exclude_is_admin'] = TRUE;
1169     }
1170
1171     // process date params to mysql date format.
1172     $dateTypes = array(
1173       'join_date' => 'joinDate',
1174       'start_date' => 'startDate',
1175       'end_date' => 'endDate',
1176     );
1177     foreach ($dateTypes as $dateField => $dateVariable) {
1178       $$dateVariable = CRM_Utils_Date::processDate($formValues[$dateField]);
1179     }
1180
1181     $memTypeNumTerms = CRM_Utils_Array::value('num_terms', $formValues);
1182
1183     $calcDates = array();
1184     foreach ($this->_memTypeSelected as $memType) {
1185       if (empty($memTypeNumTerms)) {
1186         $memTypeNumTerms = CRM_Utils_Array::value($memType, $termsByType, 1);
1187       }
1188       $calcDates[$memType] = CRM_Member_BAO_MembershipType::getDatesForMembershipType($memType,
1189         $joinDate, $startDate, $endDate, $memTypeNumTerms
1190       );
1191     }
1192
1193     foreach ($calcDates as $memType => $calcDate) {
1194       foreach (array_keys($dateTypes) as $d) {
1195         //first give priority to form values then calDates.
1196         $date = CRM_Utils_Array::value($d, $formValues);
1197         if (!$date) {
1198           $date = CRM_Utils_Array::value($d, $calcDate);
1199         }
1200
1201         $membershipTypeValues[$memType][$d] = CRM_Utils_Date::processDate($date);
1202         //$params[$d] = CRM_Utils_Date::processDate( $date );
1203       }
1204     }
1205
1206     // max related memberships - take from form or inherit from membership type
1207     foreach ($this->_memTypeSelected as $memType) {
1208       if (array_key_exists('max_related', $formValues)) {
1209         $membershipTypeValues[$memType]['max_related'] = CRM_Utils_Array::value('max_related', $formValues);
1210       }
1211     }
1212
1213     if ($this->_id) {
1214       $ids['membership'] = $params['id'] = $this->_id;
1215     }
1216
1217     $session = CRM_Core_Session::singleton();
1218     $ids['userId'] = $session->get('userID');
1219
1220     // membership type custom data
1221     foreach ($this->_memTypeSelected as $memType) {
1222       $customFields = CRM_Core_BAO_CustomField::getFields('Membership', FALSE, FALSE,
1223         $memType
1224       );
1225
1226       $customFields = CRM_Utils_Array::crmArrayMerge($customFields,
1227         CRM_Core_BAO_CustomField::getFields('Membership',
1228           FALSE, FALSE,
1229           NULL, NULL, TRUE
1230         )
1231       );
1232
1233       $membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField::postProcess($formValues,
1234         $customFields,
1235         $this->_id,
1236         'Membership'
1237       );
1238     }
1239
1240     foreach ($this->_memTypeSelected as $memType) {
1241       $membershipTypes[$memType] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
1242         $memType
1243       );
1244     }
1245
1246     $membershipType = implode(', ', $membershipTypes);
1247
1248     // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1249     list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($ids['userId']);
1250
1251     //CRM-13981, allow different person as a soft-contributor of chosen type
1252     if ($this->_contributorContactID != $this->_contactID) {
1253       $params['contribution_contact_id'] = $this->_contributorContactID;
1254       if (!empty($this->_params['soft_credit_type_id'])) {
1255         $softParams['soft_credit_type_id'] = $this->_params['soft_credit_type_id'];
1256         $softParams['contact_id'] = $this->_contactID;
1257       }
1258     }
1259     if (!empty($formValues['record_contribution'])) {
1260       $recordContribution = array(
1261         'total_amount',
1262         'financial_type_id',
1263         'payment_instrument_id',
1264         'trxn_id',
1265         'contribution_status_id',
1266         'check_number',
1267         'campaign_id',
1268         'receive_date',
1269       );
1270
1271       foreach ($recordContribution as $f) {
1272         $params[$f] = CRM_Utils_Array::value($f, $formValues);
1273       }
1274
1275       if (!$this->_onlinePendingContributionId) {
1276         $params['contribution_source'] = ts('%1 Membership: Offline signup (by %2)',
1277           array(1 => $membershipType, 2 => $userName)
1278         );
1279       }
1280
1281       if (empty($params['is_override']) &&
1282         CRM_Utils_Array::value('contribution_status_id', $params) == array_search('Pending', CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'))
1283       ) {
1284         $allStatus = CRM_Member_PseudoConstant::membershipStatus();
1285         $params['status_id'] = array_search('Pending', $allStatus);
1286         $params['skipStatusCal'] = TRUE;
1287         $params['is_pay_later'] = 1;
1288         $this->assign('is_pay_later', 1);
1289       }
1290
1291       if (!empty($formValues['send_receipt'])) {
1292         $params['receipt_date'] = CRM_Utils_Array::value('receive_date', $formValues);
1293       }
1294
1295       //insert financial type name in receipt.
1296       $formValues['contributionType_name'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialType',
1297         $formValues['financial_type_id']
1298       );
1299     }
1300
1301     // process line items, until no previous line items.
1302     if (!empty($lineItem)) {
1303       $params['lineItems'] = $lineItem;
1304       $params['processPriceSet'] = TRUE;
1305     }
1306     $createdMemberships = array();
1307     if ($this->_mode) {
1308       if (empty($formValues['total_amount']) && !$priceSetId) {
1309         // if total amount not provided minimum for membership type is used
1310         $params['total_amount'] = $formValues['total_amount'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
1311           $formValues['membership_type_id'][1], 'minimum_fee'
1312         );
1313       }
1314       else {
1315         $params['total_amount'] = CRM_Utils_Array::value('total_amount', $formValues, 0);
1316       }
1317
1318       if ($priceSetId && !$isQuickConfig) {
1319         $params['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet',
1320           $priceSetId,
1321           'financial_type_id'
1322         );
1323       }
1324       else {
1325         $params['financial_type_id'] = CRM_Utils_Array::value('financial_type_id', $formValues);
1326       }
1327
1328       $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($formValues['payment_processor_id'],
1329         $this->_mode
1330       );
1331
1332       //get the payment processor id as per mode.
1333       $params['payment_processor_id'] = $this->_params['payment_processor_id'] = $formValues['payment_processor_id'] = $this->_paymentProcessor['id'];
1334
1335
1336       $now = date('YmdHis');
1337       $fields = array();
1338
1339       // set email for primary location.
1340       $fields['email-Primary'] = 1;
1341       $formValues['email-5'] = $formValues['email-Primary'] = $this->_memberEmail;
1342       $params['register_date'] = $now;
1343
1344       // now set the values for the billing location.
1345       foreach ($this->_fields as $name => $dontCare) {
1346         $fields[$name] = 1;
1347       }
1348
1349       // also add location name to the array
1350       $formValues["address_name-{$this->_bltID}"] = CRM_Utils_Array::value('billing_first_name', $formValues) . ' ' . CRM_Utils_Array::value('billing_middle_name', $formValues) . ' ' . CRM_Utils_Array::value('billing_last_name', $formValues);
1351
1352       $formValues["address_name-{$this->_bltID}"] = trim($formValues["address_name-{$this->_bltID}"]);
1353
1354       $fields["address_name-{$this->_bltID}"] = 1;
1355       //ensure we don't over-write the payer's email with the member's email
1356       if ($this->_contributorContactID == $this->_contactID) {
1357         $fields["email-{$this->_bltID}"] = 1;
1358       }
1359
1360       $ctype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID, 'contact_type');
1361
1362       $nameFields = array('first_name', 'middle_name', 'last_name');
1363
1364       foreach ($nameFields as $name) {
1365         $fields[$name] = 1;
1366         if (array_key_exists("billing_$name", $formValues)) {
1367           $formValues[$name] = $formValues["billing_{$name}"];
1368           $formValues['preserveDBName'] = TRUE;
1369         }
1370       }
1371       if ($this->_contributorContactID == $this->_contactID) {
1372         //see CRM-12869 for discussion of why we don't do this for separate payee payments
1373         CRM_Contact_BAO_Contact::createProfileContact($formValues, $fields,
1374           $this->_contributorContactID, NULL, NULL, $ctype
1375         );
1376       }
1377
1378       // add all the additional payment params we need
1379       $this->_params["state_province-{$this->_bltID}"] = $this->_params["billing_state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant::stateProvinceAbbreviation($this->_params["billing_state_province_id-{$this->_bltID}"]);
1380       $this->_params["country-{$this->_bltID}"] = $this->_params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant::countryIsoCode($this->_params["billing_country_id-{$this->_bltID}"]);
1381
1382       $this->_params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($this->_params);
1383       $this->_params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($this->_params);
1384       $this->_params['ip_address'] = CRM_Utils_System::ipAddress();
1385       $this->_params['amount'] = $params['total_amount'];
1386       $this->_params['currencyID'] = $config->defaultCurrency;
1387       $this->_params['payment_action'] = 'Sale';
1388       $this->_params['invoiceID'] = md5(uniqid(rand(), TRUE));
1389       $this->_params['financial_type_id'] = $params['financial_type_id'];
1390
1391       // at this point we've created a contact and stored its address etc
1392       // all the payment processors expect the name and address to be in the
1393       // so we copy stuff over to first_name etc.
1394       $paymentParams = $this->_params;
1395       $paymentParams['contactID'] = $this->_contributorContactID;
1396       //CRM-10377 if payment is by an alternate contact then we need to set that person
1397       // as the contact in the payment params
1398       if ($this->_contributorContactID != $this->_contactID) {
1399         if (!empty($this->_params['soft_credit_type_id'])) {
1400           $softParams['contact_id'] = $params['contact_id'];
1401           $softParams['soft_credit_type_id'] = $this->_params['soft_credit_type_id'];
1402         }
1403       }
1404       if (!empty($this->_params['send_receipt'])) {
1405         $paymentParams['email'] = $this->_contributorEmail;
1406       }
1407
1408       CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $paymentParams, TRUE);
1409
1410       // CRM-7137 -for recurring membership,
1411       // we do need contribution and recuring records.
1412       $result = NULL;
1413       if (!empty($paymentParams['is_recur'])) {
1414         $allStatus = CRM_Member_PseudoConstant::membershipStatus();
1415
1416         $contributionType = new CRM_Financial_DAO_FinancialType();
1417         $contributionType->id = $params['financial_type_id'];
1418         if (!$contributionType->find(TRUE)) {
1419           CRM_Core_Error::fatal('Could not find a system table');
1420         }
1421
1422         $contribution = CRM_Contribute_Form_Contribution_Confirm::processContribution($this,
1423           $paymentParams,
1424           $result,
1425           $this->_contributorContactID,
1426           $contributionType,
1427           TRUE,
1428           FALSE,
1429           $isTest,
1430           $lineItems
1431         );
1432
1433         //create new soft-credit record, CRM-13981
1434         $softParams['contribution_id'] = $contribution->id;
1435         $softParams['currency'] = $contribution->currency;
1436         $softParams['amount'] = $contribution->total_amount;
1437         CRM_Contribute_BAO_ContributionSoft::add($softParams);
1438
1439         $paymentParams['contactID'] = $this->_contactID;
1440         $paymentParams['contributionID'] = $contribution->id;
1441         $paymentParams['contributionTypeID'] = $contribution->financial_type_id;
1442         $paymentParams['contributionPageID'] = $contribution->contribution_page_id;
1443         $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id;
1444         $ids['contribution'] = $contribution->id;
1445         $params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
1446         $params['status_id'] = array_search('Pending', $allStatus);
1447         $params['skipStatusCal'] = TRUE;
1448
1449         //as membership is pending set dates to null.
1450         $memberDates = array(
1451           'join_date' => 'joinDate',
1452           'start_date' => 'startDate',
1453           'end_date' => 'endDate',
1454         );
1455
1456         foreach ($memberDates as $dp => $dv) {
1457           $$dv = NULL;
1458           foreach ($this->_memTypeSelected as $memType) {
1459             $membershipTypeValues[$memType][$dv] = NULL;
1460           }
1461         }
1462       }
1463
1464       if ($params['total_amount'] > 0.0) {
1465         $payment = CRM_Core_Payment::singleton($this->_mode, $this->_paymentProcessor, $this);
1466         $result = & $payment->doDirectPayment($paymentParams);
1467       }
1468
1469       if (is_a($result, 'CRM_Core_Error')) {
1470         //make sure to cleanup db for recurring case.
1471         if (!empty($paymentParams['contributionID'])) {
1472           CRM_Contribute_BAO_Contribution::deleteContribution($paymentParams['contributionID']);
1473         }
1474         if (!empty($paymentParams['contributionRecurID'])) {
1475           CRM_Contribute_BAO_ContributionRecur::deleteRecurContribution($paymentParams['contributionRecurID']);
1476         }
1477
1478         CRM_Core_Error::displaySessionError($result);
1479         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view/membership',
1480           "reset=1&action=add&cid={$this->_contactID}&context=&mode={$this->_mode}"
1481         ));
1482       }
1483
1484       if ($result) {
1485         $this->_params = array_merge($this->_params, $result);
1486         //assign amount to template if payment was successful
1487         $this->assign('amount', $params['total_amount']);
1488       }
1489
1490       $params['contribution_status_id'] = !empty($paymentParams['is_recur']) ? 2 : 1;
1491       $params['receive_date'] = $now;
1492       $params['invoice_id'] = $this->_params['invoiceID'];
1493       $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
1494         array(1 => $membershipType, 2 => $userName)
1495       );
1496       $params['source'] = $formValues['source'] ? $formValues['source'] : $params['contribution_source'];
1497       $params['trxn_id'] = CRM_Utils_Array::value('trxn_id', $result);
1498       $params['payment_instrument_id'] = 1;
1499       $params['is_test'] = ($this->_mode == 'live') ? 0 : 1;
1500       if (!empty($this->_params['send_receipt'])) {
1501         $params['receipt_date'] = $now;
1502       }
1503       else {
1504         $params['receipt_date'] = NULL;
1505       }
1506
1507       $this->set('params', $this->_params);
1508       $this->assign('trxn_id', CRM_Utils_Array::value('trxn_id', $result));
1509       $this->assign('receive_date',
1510         CRM_Utils_Date::mysqlToIso($params['receive_date'])
1511       );
1512
1513       // required for creating membership for related contacts
1514       $params['action'] = $this->_action;
1515
1516       //create membership record.
1517       $count = 0;
1518       foreach ($this->_memTypeSelected as $memType) {
1519         if ($count &&
1520           ($relateContribution = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id))
1521         ) {
1522           $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1523         }
1524
1525         $membershipParams = array_merge($membershipTypeValues[$memType], $params);
1526         $membership = CRM_Member_BAO_Membership::create($membershipParams, $ids);
1527         $params['contribution'] = CRM_Utils_Array::value('contribution', $membershipParams);
1528         unset($params['lineItems']);
1529         $this->_membershipIDs[] = $membership->id;
1530         $createdMemberships[$memType] = $membership;
1531         $count++;
1532       }
1533
1534     }
1535     else {
1536       $params['action'] = $this->_action;
1537       if ($this->_onlinePendingContributionId && !empty($formValues['record_contribution'])) {
1538
1539         // update membership as well as contribution object, CRM-4395
1540         $params['contribution_id'] = $this->_onlinePendingContributionId;
1541         $params['componentId'] = $params['id'];
1542         $params['componentName'] = 'contribute';
1543         $result = CRM_Contribute_BAO_Contribution::transitionComponents($params, TRUE);
1544         if (!empty($result) && !empty($params['contribution_id'])) {
1545           $lineItem = array();
1546           $lineItems = CRM_Price_BAO_LineItem::getLineItems($params['contribution_id'], 'contribution');
1547           $itemId = key($lineItems);
1548           $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1549           $fieldType = NULL;
1550           if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1551             $fieldType = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'html_type');
1552           }
1553           $lineItems[$itemId]['unit_price'] = $params['total_amount'];
1554           $lineItems[$itemId]['line_total'] = $params['total_amount'];
1555           $lineItems[$itemId]['id'] = $itemId;
1556           $lineItem[$priceSetId] = $lineItems;
1557           $contributionBAO = new CRM_Contribute_BAO_Contribution();
1558           $contributionBAO->id = $params['contribution_id'];
1559           $contributionBAO->find();
1560           CRM_Price_BAO_LineItem::processPriceSet($params['contribution_id'], $lineItem, $contributionBAO, 'civicrm_membership');
1561
1562           //create new soft-credit record, CRM-13981
1563           $softParams['contribution_id'] = $params['contribution_id'];
1564
1565           while ($contributionBAO->fetch()) {
1566             $softParams['currency'] = $contributionBAO->currency;
1567             $softParams['amount'] = $contributionBAO->total_amount;
1568           }
1569           CRM_Contribute_BAO_ContributionSoft::add($softParams);
1570         }
1571
1572         //carry updated membership object.
1573         $membership = new CRM_Member_DAO_Membership();
1574         $membership->id = $this->_id;
1575         $membership->find(TRUE);
1576
1577         $cancelled = TRUE;
1578         if ($membership->end_date) {
1579           //display end date w/ status message.
1580           $endDate = $membership->end_date;
1581
1582           $membershipStatues = CRM_Member_PseudoConstant::membershipStatus();
1583           if (!in_array($membership->status_id, array(
1584             array_search('Cancelled', $membershipStatues),
1585             array_search('Expired', $membershipStatues),
1586           ))
1587           ) {
1588             $cancelled = FALSE;
1589           }
1590         }
1591         // suppress form values in template.
1592         $this->assign('cancelled', $cancelled);
1593
1594         // FIX ME: need to recheck this
1595         // here we might updated dates, so get from object.
1596         foreach ($calcDates[$membership->membership_type_id] as $date => & $val) {
1597           if ($membership->$date) {
1598             $val = $membership->$date;
1599           }
1600         }
1601
1602         $createdMemberships[] = $membership;
1603       }
1604       else {
1605         $count = 0;
1606         foreach ($this->_memTypeSelected as $memType) {
1607           if ($count && !empty($formValues['record_contribution']) &&
1608             ($relateContribution = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id))
1609           ) {
1610             $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1611           }
1612
1613           $membershipParams = array_merge($params, $membershipTypeValues[$memType]);
1614           if (!empty($formValues['int_amount'])) {
1615             $init_amount = array();
1616             foreach ($formValues as $key => $value) {
1617               if (strstr($key, 'txt-price')) {
1618                 $init_amount[$key] = $value;
1619               }
1620             }
1621             $membershipParams['init_amount'] = $init_amount;
1622           }
1623
1624           if (!empty($softParams)) {
1625             $membershipParams['soft_credit'] = $softParams;
1626           }
1627
1628           $membership = CRM_Member_BAO_Membership::create($membershipParams, $ids);
1629           $params['contribution'] = CRM_Utils_Array::value('contribution', $membershipParams);
1630           unset($params['lineItems']);
1631
1632           $this->_membershipIDs[] = $membership->id;
1633           $createdMemberships[$memType] = $membership;
1634           $count++;
1635         }
1636       }
1637     }
1638
1639     if (!empty($lineItem[$priceSetId])) {
1640       foreach ($lineItem[$priceSetId] as & $priceFieldOp) {
1641         if (!empty($priceFieldOp['membership_type_id'])) {
1642           $priceFieldOp['start_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date'] ? CRM_Utils_Date::customFormat($membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date'], '%B %E%f, %Y') : '-';
1643           $priceFieldOp['end_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date'] ? CRM_Utils_Date::customFormat($membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date'], '%B %E%f, %Y') : '-';
1644         }
1645         else {
1646           $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1647         }
1648       }
1649     }
1650     $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ? $lineItem : FALSE);
1651
1652     $receiptSend = FALSE;
1653     if (!empty($formValues['send_receipt'])) {
1654       $receiptSend = TRUE;
1655
1656       $formValues['contact_id'] = $this->_contactID;
1657
1658       $formValues['contribution_id'] = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id);
1659       // send email receipt
1660       $mailSend = self::emailReceipt($this, $formValues, $membership);
1661     }
1662
1663     if (($this->_action & CRM_Core_Action::UPDATE)) {
1664       //end date can be modified by hooks, so if end date is set then use it.
1665       $endDate = ($membership->end_date) ? $membership->end_date : $endDate;
1666
1667       $statusMsg = ts('Membership for %1 has been updated.', array(1 => $this->_memberDisplayName));
1668       if ($endDate && $endDate !== 'null') {
1669         $endDate = CRM_Utils_Date::customFormat($endDate);
1670         $statusMsg .= ' ' . ts('The membership End Date is %1.', array(1 => $endDate));
1671       }
1672       if ($receiptSend) {
1673         $statusMsg .= ' ' . ts('A confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail));
1674       }
1675     }
1676     elseif (($this->_action & CRM_Core_Action::ADD)) {
1677       // FIX ME: fix status messages
1678
1679       $statusMsg = array();
1680       foreach ($membershipTypes as $memType => $membershipType) {
1681         $statusMsg[$memType] = ts('%1 membership for %2 has been added.', array(
1682           1 => $membershipType,
1683           2 => $this->_memberDisplayName
1684         ));
1685
1686         $membership = $createdMemberships[$memType];
1687         $memEndDate = ($membership->end_date) ? $membership->end_date : $endDate;
1688
1689         //get the end date from calculated dates.
1690         if (!$memEndDate && empty($params['is_recur'])) {
1691           $memEndDate = CRM_Utils_Array::value('end_date', $calcDates[$memType]);
1692         }
1693
1694         if ($memEndDate && $memEndDate !== 'null') {
1695           $memEndDate = CRM_Utils_Date::customFormat($memEndDate);
1696           $statusMsg[$memType] .= ' ' . ts('The new membership End Date is %1.', array(1 => $memEndDate));
1697         }
1698       }
1699       $statusMsg = implode('<br/>', $statusMsg);
1700       if ($receiptSend && $mailSend) {
1701         $statusMsg .= ' ' . ts('A membership confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail));
1702       }
1703     }
1704
1705     // finally set membership id if already not set
1706     if (!$this->_id) {
1707       $this->_id = $membership->id;
1708     }
1709
1710     CRM_Core_Session::setStatus($statusMsg, ts('Complete'), 'success');
1711
1712     $buttonName = $this->controller->getButtonName();
1713     if ($this->_context == 'standalone') {
1714       if ($buttonName == $this->getButtonName('upload', 'new')) {
1715         $session->replaceUserContext(CRM_Utils_System::url('civicrm/member/add',
1716           'reset=1&action=add&context=standalone'
1717         ));
1718       }
1719       else {
1720         $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
1721           "reset=1&cid={$this->_contactID}&selectedChild=member"
1722         ));
1723       }
1724     }
1725     elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1726       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view/membership',
1727         "reset=1&action=add&context=membership&cid={$this->_contactID}"
1728       ));
1729     }
1730   }
1731
1732   /**
1733    * Function to send email receipt
1734    *
1735    * @param object $form form object
1736    * @param $formValues
1737    * @param object $membership object
1738    *
1739    * @internal param array $values submitted values
1740    * @return boolean true if mail was sent successfully
1741    * @static
1742    */
1743   static function emailReceipt(&$form, &$formValues, &$membership) {
1744     // retrieve 'from email id' for acknowledgement
1745     $receiptFrom = $formValues['from_email_address'];
1746
1747     if (!empty($formValues['payment_instrument_id'])) {
1748       $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
1749       $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
1750     }
1751
1752     // retrieve custom data
1753     $customFields = $customValues = array();
1754     if (property_exists($form, '_groupTree')
1755       && !empty($form->_groupTree)
1756     ) {
1757       foreach ($form->_groupTree as $groupID => $group) {
1758         if ($groupID == 'info') {
1759           continue;
1760         }
1761         foreach ($group['fields'] as $k => $field) {
1762           $field['title'] = $field['label'];
1763           $customFields["custom_{$k}"] = $field;
1764         }
1765       }
1766     }
1767
1768     $members = array(array('member_id', '=', $membership->id, 0, 0));
1769     // check whether its a test drive
1770     if ($form->_mode == 'test') {
1771       $members[] = array('member_test', '=', 1, 0, 0);
1772     }
1773
1774     CRM_Core_BAO_UFGroup::getValues($formValues['contact_id'], $customFields, $customValues, FALSE, $members);
1775
1776     if ($form->_mode) {
1777       if (!empty($form->_params['billing_first_name'])) {
1778         $name = $form->_params['billing_first_name'];
1779       }
1780
1781       if (!empty($form->_params['billing_middle_name'])) {
1782         $name .= " {$form->_params['billing_middle_name']}";
1783       }
1784
1785       if (!empty($form->_params['billing_last_name'])) {
1786         $name .= " {$form->_params['billing_last_name']}";
1787       }
1788
1789       $form->assign('billingName', $name);
1790
1791       // assign the address formatted up for display
1792       $addressParts = array(
1793         "street_address-{$form->_bltID}",
1794         "city-{$form->_bltID}",
1795         "postal_code-{$form->_bltID}",
1796         "state_province-{$form->_bltID}",
1797         "country-{$form->_bltID}",
1798       );
1799       $addressFields = array();
1800       foreach ($addressParts as $part) {
1801         list($n, $id) = explode('-', $part);
1802         if (isset($form->_params['billing_' . $part])) {
1803           $addressFields[$n] = $form->_params['billing_' . $part];
1804         }
1805       }
1806       $form->assign('address', CRM_Utils_Address::format($addressFields));
1807
1808       $date = CRM_Utils_Date::format($form->_params['credit_card_exp_date']);
1809       $date = CRM_Utils_Date::mysqlToIso($date);
1810       $form->assign('credit_card_exp_date', $date);
1811       $form->assign('credit_card_number',
1812         CRM_Utils_System::mungeCreditCard($form->_params['credit_card_number'])
1813       );
1814       $form->assign('credit_card_type', $form->_params['credit_card_type']);
1815       $form->assign('contributeMode', 'direct');
1816       $form->assign('isAmountzero', 0);
1817       $form->assign('is_pay_later', 0);
1818       $form->assign('isPrimary', 1);
1819     }
1820
1821     $form->assign('module', 'Membership');
1822     $form->assign('contactID', $formValues['contact_id']);
1823
1824     $form->assign('membershipID', CRM_Utils_Array::value('membership_id', $form->_params, CRM_Utils_Array::value('membership_id', $form->_defaultValues)));
1825
1826     if (!empty($formValues['contribution_id'])) {
1827       $form->assign('contributionID', $formValues['contribution_id']);
1828     }
1829     elseif (isset($form->_onlinePendingContributionId)) {
1830       $form->assign('contributionID', $form->_onlinePendingContributionId);
1831     }
1832
1833     if (!empty($formValues['contribution_status_id'])) {
1834       $form->assign('contributionStatusID', $formValues['contribution_status_id']);
1835       $form->assign('contributionStatus', CRM_Contribute_PseudoConstant::contributionStatus($formValues['contribution_status_id'], 'name'));
1836     }
1837
1838     if (!empty($formValues['is_renew'])) {
1839       $form->assign('receiptType', 'membership renewal');
1840     }
1841     else {
1842       $form->assign('receiptType', 'membership signup');
1843     }
1844     $form->assign('receive_date', CRM_Utils_Date::processDate(CRM_Utils_Array::value('receive_date', $formValues)));
1845     $form->assign('formValues', $formValues);
1846
1847     if (empty($lineItem)) {
1848       $form->assign('mem_start_date', CRM_Utils_Date::customFormat($membership->start_date, '%B %E%f, %Y'));
1849       $form->assign('mem_end_date', CRM_Utils_Date::customFormat($membership->end_date, '%B %E%f, %Y'));
1850       $form->assign('membership_name', CRM_Member_PseudoConstant::membershipType($membership->membership_type_id));
1851     }
1852
1853     $form->assign('customValues', $customValues);
1854     $isBatchProcess = is_a($form, 'CRM_Batch_Form_Entry');
1855     if ((empty($form->_contributorDisplayName) || empty($form->_contributorEmail)) || $isBatchProcess) {
1856       // in this case the form is being called statically from the batch editing screen
1857       // having one class in the form layer call another statically is not greate
1858       // & we should aim to move this function to the BAO layer in future.
1859       // however, we can assume that the contact_id passed in by the batch
1860       // function will be the recipient
1861       list(
1862         $form->_contributorDisplayName,
1863         $form->_contributorEmail
1864         ) = CRM_Contact_BAO_Contact_Location::getEmailDetails(
1865         $formValues['contact_id']
1866       );
1867       if (empty($form->_receiptContactId) || $isBatchProcess) {
1868         $form->_receiptContactId = $formValues['contact_id'];
1869       }
1870     }
1871
1872     list($mailSend, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate(
1873       array(
1874         'groupName' => 'msg_tpl_workflow_membership',
1875         'valueName' => 'membership_offline_receipt',
1876         'contactId' => $form->_receiptContactId,
1877         'from' => $receiptFrom,
1878         'toName' => $form->_contributorDisplayName,
1879         'toEmail' => $form->_contributorEmail,
1880         'isTest' => (bool) ($form->_action & CRM_Core_Action::PREVIEW)
1881       )
1882     );
1883
1884     return TRUE;
1885   }
1886 }
1887