CRM/Member/Form/MembershipRenewal.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  */
  33
  34 /**
  35  * This class generates form components for Membership Renewal
  36  */
  37 class CRM_Member_Form_MembershipRenewal extends CRM_Member_Form {
  38
  39   /**
  40    * Display name of the member.
  41    *
  42    * @var string
  43    */
  44   protected $_memberDisplayName = NULL;
  45
  46   /**
  47    * email of the person paying for the membership (used for receipts)
  48    */
  49   protected $_memberEmail = NULL;
  50
  51   /**
  52    * Contact ID of the member.
  53    *
  54    *
  55    * @var int
  56    */
  57   public $_contactID = NULL;
  58
  59   /**
  60    * Display name of the person paying for the membership (used for receipts)
  61    *
  62    * @var string
  63    */
  64   protected $_contributorDisplayName = NULL;
  65
  66   /**
  67    * email of the person paying for the membership (used for receipts)
  68    */
  69   protected $_contributorEmail = NULL;
  70
  71   /**
  72    * email of the person paying for the membership (used for receipts)
  73    *
  74    * @var int
  75    */
  76   protected $_contributorContactID = NULL;
  77
  78   /**
  79    * ID of the person the receipt is to go to
  80    *
  81    * @var int
  82    */
  83   protected $_receiptContactId = NULL;
  84
  85   /**
  86    * context would be set to standalone if the contact is use is being selected from
  87    * the form rather than in the URL
  88    */
  89   public $_context;
  90
  91   /**
  92    * End date of renewed membership.
  93    *
  94    * @var string
  95    */
  96   protected $endDate = NULL;
  97
  98   /**
  99    * Has an email been sent.
 100    *
 101    * @var string
 102    */
 103   protected $isMailSent = FALSE;
 104
 105   /**
 106    * The name of the renewed membership type.
 107    *
 108    * @var string
 109    */
 110   protected $membershipTypeName = '';
 111
 112   /**
 113    * An array to hold a list of datefields on the form
 114    * so that they can be converted to ISO in a consistent manner
 115    *
 116    * @var array
 117    */
 118   protected $_dateFields = array(
 119     'receive_date' => array('default' => 'now'),
 120   );
 121
 122   /**
 123    * Pre-process form.
 124    *
 125    * @throws \Exception
 126    */
 127   public function preProcess() {
 128
 129     // This string makes up part of the class names, differentiating them (not sure why) from the membership fields.
 130     $this->assign('formClass', 'membershiprenew');
 131     parent::preProcess();
 132
 133     $this->assign('endDate', CRM_Utils_Date::customFormat(CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
 134         $this->_id, 'end_date'
 135       )
 136     ));
 137     $this->assign('membershipStatus',
 138       CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus',
 139         CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
 140           $this->_id, 'status_id'
 141         ),
 142         'name'
 143       )
 144     );
 145
 146     if ($this->_mode) {
 147       $membershipFee = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType, 'minimum_fee');
 148       if (!$membershipFee) {
 149         $statusMsg = ts('Membership Renewal using a credit card requires a Membership fee. Since there is no fee associated with the selected membership type, you can use the normal renewal mode.');
 150         CRM_Core_Session::setStatus($statusMsg, '', 'info');
 151         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view/membership',
 152           "reset=1&action=renew&cid={$this->_contactID}&id={$this->_id}&context=membership"
 153         ));
 154       }
 155     }
 156
 157     // when custom data is included in this page
 158     if (!empty($_POST['hidden_custom'])) {
 159       CRM_Custom_Form_CustomData::preProcess($this, NULL, $this->_memType, 1, 'Membership', $this->_id);
 160       CRM_Custom_Form_CustomData::buildQuickForm($this);
 161       CRM_Custom_Form_CustomData::setDefaultValues($this);
 162     }
 163
 164     CRM_Utils_System::setTitle(ts('Renew Membership'));
 165
 166     parent::preProcess();
 167   }
 168
 169   /**
 170    * Set default values for the form.
 171    * the default values are retrieved from the database
 172    *
 173    * @return array
 174    *   Default values.
 175    */
 176   public function setDefaultValues() {
 177
 178     $defaults = parent::setDefaultValues();
 179
 180     // set renewal_date and receive_date to today in correct input format (setDateDefaults uses today if no value passed)
 181     list($now, $currentTime) = CRM_Utils_Date::setDateDefaults();
 182     $defaults['renewal_date'] = $now;
 183     $defaults['receive_date'] = $now;
 184     $defaults['receive_date_time'] = $currentTime;
 185
 186     if ($defaults['id']) {
 187       $defaults['record_contribution'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipPayment',
 188         $defaults['id'],
 189         'contribution_id',
 190         'membership_id'
 191       );
 192     }
 193
 194     $defaults['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType, 'financial_type_id');
 195
 196     //CRM-13420
 197     if (empty($defaults['payment_instrument_id'])) {
 198       $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
 199     }
 200
 201     $defaults['total_amount'] = CRM_Utils_Money::format(CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 202       $this->_memType,
 203       'minimum_fee'
 204     ), NULL, '%a');
 205
 206     $defaults['record_contribution'] = 0;
 207     $defaults['num_terms'] = 1;
 208     $defaults['send_receipt'] = 0;
 209
 210     //set Soft Credit Type to Gift by default
 211     $scTypes = CRM_Core_OptionGroup::values("soft_credit_type");
 212     $defaults['soft_credit_type_id'] = CRM_Utils_Array::value(ts('Gift'), array_flip($scTypes));
 213
 214     $renewalDate = CRM_Utils_Date::processDate(CRM_Utils_Array::value('renewal_date', $defaults),
 215       NULL, NULL, 'Y-m-d'
 216     );
 217     $this->assign('renewalDate', $renewalDate);
 218     $this->assign('member_is_test', CRM_Utils_Array::value('member_is_test', $defaults));
 219
 220     if ($this->_mode) {
 221       $defaults = $this->getBillingDefaults($defaults);
 222     }
 223     return $defaults;
 224   }
 225
 226   /**
 227    * Build the form object.
 228    */
 229   public function buildQuickForm() {
 230
 231     parent::buildQuickForm();
 232
 233     $defaults = parent::setDefaultValues();
 234     $this->assign('customDataType', 'Membership');
 235     $this->assign('customDataSubType', $this->_memType);
 236     $this->assign('entityID', $this->_id);
 237     $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
 238
 239     $allMembershipInfo = array();
 240
 241     // CRM-21485
 242     if (is_array($defaults['membership_type_id'])) {
 243       $defaults['membership_type_id'] = $defaults['membership_type_id'][1];
 244     }
 245
 246     //CRM-16950
 247     $taxRate = $this->getTaxRateForFinancialType($this->allMembershipTypeDetails[$defaults['membership_type_id']]['financial_type_id']);
 248
 249     // auto renew options if enabled for the membership
 250     $options = CRM_Core_SelectValues::memberAutoRenew();
 251
 252     foreach ($this->allMembershipTypeDetails as $key => $values) {
 253       if (!empty($values['is_active'])) {
 254         if ($this->_mode && empty($values['minimum_fee'])) {
 255           continue;
 256         }
 257         else {
 258           $memberOfContactId = CRM_Utils_Array::value('member_of_contact_id', $values);
 259           if (empty($selMemTypeOrg[$memberOfContactId])) {
 260             $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 261               $memberOfContactId,
 262               'display_name',
 263               'id'
 264             );
 265
 266             $selOrgMemType[$memberOfContactId][0] = ts('- select -');
 267           }
 268           if (empty($selOrgMemType[$memberOfContactId][$key])) {
 269             $selOrgMemType[$memberOfContactId][$key] = CRM_Utils_Array::value('name', $values);
 270           }
 271         }
 272
 273         //CRM-16950
 274         $taxAmount = NULL;
 275         $totalAmount = CRM_Utils_Array::value('minimum_fee', $values);
 276         // @todo - feels a bug - we use taxRate from the form default rather than from the specified type?!?
 277         if ($this->getTaxRateForFinancialType($values['financial_type_id'])) {
 278           $taxAmount = ($taxRate / 100) * CRM_Utils_Array::value('minimum_fee', $values);
 279           $totalAmount = $totalAmount + $taxAmount;
 280         }
 281
 282         // build membership info array, which is used to set the payment information block when
 283         // membership type is selected.
 284         $allMembershipInfo[$key] = array(
 285           'financial_type_id' => CRM_Utils_Array::value('financial_type_id', $values),
 286           'total_amount' => CRM_Utils_Money::format($totalAmount, NULL, '%a'),
 287           'total_amount_numeric' => $totalAmount,
 288           'tax_message' => $taxAmount ? ts("Includes %1 amount of %2", array(1 => $this->getSalesTaxTerm(), 2 => CRM_Utils_Money::format($taxAmount))) : $taxAmount,
 289         );
 290
 291         if (!empty($values['auto_renew'])) {
 292           $allMembershipInfo[$key]['auto_renew'] = $options[$values['auto_renew']];
 293         }
 294       }
 295     }
 296
 297     $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
 298
 299     if ($this->_memType) {
 300       $this->assign('orgName', $selMemTypeOrg[$this->allMembershipTypeDetails[$this->_memType]['member_of_contact_id']]);
 301       $this->assign('memType', $this->allMembershipTypeDetails[$this->_memType]['name']);
 302     }
 303
 304     // force select of organization by default, if only one organization in
 305     // the list
 306     if (count($selMemTypeOrg) == 2) {
 307       unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
 308     }
 309     //sort membership organization and type, CRM-6099
 310     natcasesort($selMemTypeOrg);
 311     foreach ($selOrgMemType as $index => $orgMembershipType) {
 312       natcasesort($orgMembershipType);
 313       $selOrgMemType[$index] = $orgMembershipType;
 314     }
 315
 316     $js = array('onChange' => "setPaymentBlock(); CRM.buildCustomData('Membership', this.value);");
 317     $sel = &$this->addElement('hierselect',
 318       'membership_type_id',
 319       ts('Renewal Membership Organization and Type'), $js
 320     );
 321
 322     $sel->setOptions(array($selMemTypeOrg, $selOrgMemType));
 323     $elements = array();
 324     if ($sel) {
 325       $elements[] = $sel;
 326     }
 327
 328     $this->applyFilter('__ALL__', 'trim');
 329
 330     $this->addDate('renewal_date', ts('Date Renewal Entered'), FALSE, array('formatType' => 'activityDate'));
 331
 332     $this->add('select', 'financial_type_id', ts('Financial Type'),
 333       array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::financialType()
 334     );
 335
 336     $this->add('text', 'num_terms', ts('Extend Membership by'), array('onchange' => "setPaymentBlock();"), TRUE);
 337     $this->addRule('num_terms', ts('Please enter a whole number for how many periods to renew.'), 'integer');
 338
 339     if (CRM_Core_Permission::access('CiviContribute') && !$this->_mode) {
 340       $this->addElement('checkbox', 'record_contribution', ts('Record Renewal Payment?'), NULL, array('onclick' => "checkPayment();"));
 341
 342       $this->add('text', 'total_amount', ts('Amount'));
 343       $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
 344
 345       $this->addDate('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
 346
 347       $this->add('select', 'payment_instrument_id', ts('Payment Method'),
 348         array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::paymentInstrument(),
 349         FALSE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
 350       );
 351
 352       $this->add('text', 'trxn_id', ts('Transaction ID'));
 353       $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
 354         'objectExists', array('CRM_Contribute_DAO_Contribution', $this->_id, 'trxn_id')
 355       );
 356
 357       $this->add('select', 'contribution_status_id', ts('Payment Status'),
 358         CRM_Contribute_BAO_Contribution_Utils::getContributionStatuses('membership')
 359       );
 360
 361       $this->add('text', 'check_number', ts('Check Number'),
 362         CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
 363       );
 364     }
 365     else {
 366       $this->add('text', 'total_amount', ts('Amount'));
 367       $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
 368     }
 369     $this->addElement('checkbox', 'send_receipt', ts('Send Confirmation and Receipt?'), NULL,
 370       array('onclick' => "showHideByValue( 'send_receipt', '', 'notice', 'table-row', 'radio', false ); showHideByValue( 'send_receipt', '', 'fromEmail', 'table-row', 'radio',false);")
 371     );
 372
 373     $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails);
 374
 375     $this->add('textarea', 'receipt_text_renewal', ts('Renewal Message'));
 376
 377     // Retrieve the name and email of the contact - this will be the TO for receipt email
 378     list($this->_contributorDisplayName,
 379       $this->_contributorEmail
 380       ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 381     $this->assign('email', $this->_contributorEmail);
 382     // The member form uses emailExists. Assigning both while we transition / synchronise.
 383     $this->assign('emailExists', $this->_contributorEmail);
 384
 385     $mailingInfo = Civi::settings()->get('mailing_backend');
 386     $this->assign('outBound_option', $mailingInfo['outBound_option']);
 387
 388     if (CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'contribution_recur_id')) {
 389       if (CRM_Member_BAO_Membership::isCancelSubscriptionSupported($this->_id)) {
 390         $this->assign('cancelAutoRenew',
 391           CRM_Utils_System::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
 392         );
 393       }
 394     }
 395     $this->addFormRule(array('CRM_Member_Form_MembershipRenewal', 'formRule'), $this);
 396     $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different Contact?'));
 397     $this->addSelect('soft_credit_type_id', array('entity' => 'contribution_soft'));
 398     $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), array('create' => TRUE));
 399   }
 400
 401   /**
 402    * Validation.
 403    *
 404    * @param array $params
 405    *   (ref.) an assoc array of name/value pairs.
 406    *
 407    * @return bool|array
 408    *   mixed true or array of errors
 409    */
 410   public static function formRule($params, $files, $self) {
 411     $errors = array();
 412     if ($params['membership_type_id'][0] == 0) {
 413       $errors['membership_type_id'] = ts('Oops. It looks like you are trying to change the membership type while renewing the membership. Please click the "change membership type" link, and select a Membership Organization.');
 414     }
 415     if ($params['membership_type_id'][1] == 0) {
 416       $errors['membership_type_id'] = ts('Oops. It looks like you are trying to change the membership type while renewing the membership. Please click the "change membership type" link and select a Membership Type from the list.');
 417     }
 418
 419     // CRM-20571
 420     // Get the Join Date from Membership info as it is not available in the Renewal form
 421     $joinDate = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $self->_id, 'join_date');
 422
 423     // CRM-20571: Check if the renewal date is not before Join Date, if it is then add to 'errors' array
 424     // The fields in Renewal form come into this routine in $params array. 'renewal_date' is in the form
 425     // We process both the dates before comparison using CRM utils so that they are in same date format
 426     if (isset($params['renewal_date'])) {
 427       if (CRM_Utils_Date::processDate($params['renewal_date']) < CRM_Utils_Date::processDate($joinDate)) {
 428         $errors['renewal_date'] = ts('Renewal date must be the same or later than Member since (Join Date).');
 429       }
 430     }
 431
 432     //total amount condition arise when membership type having no
 433     //minimum fee
 434     if (isset($params['record_contribution'])) {
 435       if (!$params['financial_type_id']) {
 436         $errors['financial_type_id'] = ts('Please select a Financial Type.');
 437       }
 438       if (!$params['total_amount']) {
 439         $errors['total_amount'] = ts('Please enter a Contribution Amount.');
 440       }
 441       if (empty($params['payment_instrument_id'])) {
 442         $errors['payment_instrument_id'] = ts('Payment Method is a required field.');
 443       }
 444     }
 445     return empty($errors) ? TRUE : $errors;
 446   }
 447
 448   /**
 449    * Process the renewal form.
 450    */
 451   public function postProcess() {
 452     // get the submitted form values.
 453     $this->_params = $this->controller->exportValues($this->_name);
 454     $this->assignBillingName();
 455
 456     try {
 457       $this->submit();
 458       $statusMsg = ts('%1 membership for %2 has been renewed.', array(1 => $this->membershipTypeName, 2 => $this->_memberDisplayName));
 459
 460       if ($this->endDate) {
 461         $statusMsg .= ' ' . ts('The new membership End Date is %1.', array(
 462           1 => CRM_Utils_Date::customFormat(substr($this->endDate, 0, 8)),
 463         ));
 464       }
 465
 466       if ($this->isMailSent) {
 467         $statusMsg .= ' ' . ts('A renewal confirmation and receipt has been sent to %1.', array(
 468           1 => $this->_contributorEmail,
 469         ));
 470         return $statusMsg;
 471       }
 472       return $statusMsg;
 473     }
 474     catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
 475       CRM_Core_Session::singleton()->setStatus($e->getMessage());
 476       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view/membership',
 477         "reset=1&action=renew&cid={$this->_contactID}&id={$this->_id}&context=membership&mode={$this->_mode}"
 478       ));
 479     }
 480
 481     CRM_Core_Session::setStatus($statusMsg, ts('Complete'), 'success');
 482   }
 483
 484   /**
 485    * Process form submission.
 486    *
 487    * This function is also accessed by a unit test.
 488    */
 489   protected function submit() {
 490     $this->storeContactFields($this->_params);
 491     $this->beginPostProcess();
 492     $now = CRM_Utils_Date::getToday(NULL, 'YmdHis');
 493     $this->convertDateFieldsToMySQL($this->_params);
 494     $this->assign('receive_date', $this->_params['receive_date']);
 495     $this->processBillingAddress();
 496     list($userName) = CRM_Contact_BAO_Contact_Location::getEmailDetails(CRM_Core_Session::singleton()->get('userID'));
 497     $this->_params['total_amount'] = CRM_Utils_Array::value('total_amount', $this->_params,
 498       CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType, 'minimum_fee')
 499     );
 500     $this->_membershipId = $this->_id;
 501     $customFieldsFormatted = CRM_Core_BAO_CustomField::postProcess($this->_params,
 502       $this->_id,
 503       'Membership'
 504     );
 505     if (empty($this->_params['financial_type_id'])) {
 506       $this->_params['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType, 'financial_type_id');
 507     }
 508     $contributionRecurID = NULL;
 509     $this->assign('membershipID', $this->_id);
 510     $this->assign('contactID', $this->_contactID);
 511     $this->assign('module', 'Membership');
 512     $this->assign('receiptType', 'membership renewal');
 513     $this->_params['currencyID'] = CRM_Core_Config::singleton()->defaultCurrency;
 514     $this->_params['invoice_id'] = $this->_params['invoiceID'] = md5(uniqid(rand(), TRUE));
 515
 516     if (!empty($this->_params['send_receipt'])) {
 517       $this->_params['receipt_date'] = $now;
 518       $this->assign('receipt_date', CRM_Utils_Date::mysqlToIso($this->_params['receipt_date']));
 519     }
 520     else {
 521       $this->_params['receipt_date'] = NULL;
 522     }
 523
 524     if ($this->_mode) {
 525       $this->_params['register_date'] = $now;
 526       $this->_params['description'] = ts("Contribution submitted by a staff person using member's credit card for renewal");
 527       $this->_params['amount'] = $this->_params['total_amount'];
 528       $this->_params['payment_instrument_id'] = $this->_paymentProcessor['payment_instrument_id'];
 529
 530       // at this point we've created a contact and stored its address etc
 531       // all the payment processors expect the name and address to be in the passed params
 532       // so we copy stuff over to first_name etc.
 533       $paymentParams = $this->_params;
 534       if (!empty($this->_params['send_receipt'])) {
 535         $paymentParams['email'] = $this->_contributorEmail;
 536       }
 537       $paymentParams['is_email_receipt'] = !empty($this->_params['send_receipt']);
 538
 539       $paymentParams['contactID'] = $this->_contributorContactID;
 540
 541       CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $paymentParams, TRUE);
 542
 543       $payment = $this->_paymentProcessor['object'];
 544
 545       if (!empty($this->_params['auto_renew'])) {
 546         $contributionRecurParams = $this->processRecurringContribution($paymentParams);
 547         $contributionRecurID = $contributionRecurParams['contributionRecurID'];
 548         $paymentParams = array_merge($paymentParams, $contributionRecurParams);
 549       }
 550
 551       $result = $payment->doPayment($paymentParams);
 552       $this->_params = array_merge($this->_params, $result);
 553
 554       $this->_params['contribution_status_id'] = $result['payment_status_id'];
 555       $this->_params['trxn_id'] = $result['trxn_id'];
 556       $this->_params['is_test'] = ($this->_mode == 'live') ? 0 : 1;
 557       $this->set('params', $this->_params);
 558       $this->assign('trxn_id', $result['trxn_id']);
 559     }
 560
 561     $renewalDate = !empty($this->_params['renewal_date']) ? $renewalDate = CRM_Utils_Date::processDate($this->_params['renewal_date']) : NULL;
 562
 563     // check for test membership.
 564     $isTestMembership = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_membershipId, 'is_test');
 565
 566     // chk for renewal for multiple terms CRM-8750
 567     $numRenewTerms = 1;
 568     if (is_numeric(CRM_Utils_Array::value('num_terms', $this->_params))) {
 569       $numRenewTerms = $this->_params['num_terms'];
 570     }
 571
 572     //if contribution status is pending then set pay later
 573     $this->_params['is_pay_later'] = FALSE;
 574     if ($this->_params['contribution_status_id'] == array_search('Pending', CRM_Contribute_PseudoConstant::contributionStatus())) {
 575       $this->_params['is_pay_later'] = 1;
 576     }
 577
 578     // These variable sets prior to renewMembership may not be required for this form. They were in
 579     // a function this form shared with other forms.
 580     $membershipSource = NULL;
 581     if (!empty($this->_params['membership_source'])) {
 582       $membershipSource = $this->_params['membership_source'];
 583     }
 584
 585     $isPending = ($this->_params['contribution_status_id'] == 2) ? TRUE : FALSE;
 586
 587     list($renewMembership) = CRM_Member_BAO_Membership::processMembership(
 588       $this->_contactID, $this->_params['membership_type_id'][1], $isTestMembership,
 589       $renewalDate, NULL, $customFieldsFormatted, $numRenewTerms, $this->_membershipId,
 590       $isPending,
 591       $contributionRecurID, $membershipSource, $this->_params['is_pay_later'], CRM_Utils_Array::value('campaign_id',
 592       $this->_params)
 593     );
 594
 595     $this->endDate = CRM_Utils_Date::processDate($renewMembership->end_date);
 596
 597     $this->membershipTypeName = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $renewMembership->membership_type_id,
 598       'name');
 599
 600     if (!empty($this->_params['record_contribution']) || $this->_mode) {
 601       // set the source
 602       $this->_params['contribution_source'] = "{$this->membershipTypeName} Membership: Offline membership renewal (by {$userName})";
 603
 604       //create line items
 605       $lineItem = array();
 606       $this->_params = $this->setPriceSetParameters($this->_params);
 607       CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'],
 608         $this->_params, $lineItem[$this->_priceSetId], NULL, $this->_priceSetId
 609       );
 610       //CRM-11529 for quick config backoffice transactions
 611       //when financial_type_id is passed in form, update the
 612       //line items with the financial type selected in form
 613       if ($submittedFinancialType = CRM_Utils_Array::value('financial_type_id', $this->_params)) {
 614         foreach ($lineItem[$this->_priceSetId] as &$li) {
 615           $li['financial_type_id'] = $submittedFinancialType;
 616         }
 617       }
 618
 619       if (!empty($lineItem)) {
 620         $this->_params['lineItems'] = $lineItem;
 621         $this->_params['processPriceSet'] = TRUE;
 622       }
 623
 624       //assign contribution contact id to the field expected by recordMembershipContribution
 625       if ($this->_contributorContactID != $this->_contactID) {
 626         $this->_params['contribution_contact_id'] = $this->_contributorContactID;
 627         if (!empty($this->_params['soft_credit_type_id'])) {
 628           $this->_params['soft_credit'] = array(
 629             'soft_credit_type_id' => $this->_params['soft_credit_type_id'],
 630             'contact_id' => $this->_contactID,
 631           );
 632         }
 633       }
 634       $this->_params['contact_id'] = $this->_contactID;
 635       //recordMembershipContribution receives params as a reference & adds one variable. This is
 636       // not a great pattern & ideally it would not receive as a reference. We assign our params as a
 637       // temporary variable to avoid e-notice & to make it clear to future refactorer that
 638       // this function is NOT reliant on that var being set
 639       $temporaryParams = array_merge($this->_params, array(
 640         'membership_id' => $renewMembership->id,
 641         'contribution_recur_id' => $contributionRecurID,
 642       ));
 643       //Remove `tax_amount` if it is not calculated.
 644       if (CRM_Utils_Array::value('tax_amount', $temporaryParams) === 0) {
 645         unset($temporaryParams['tax_amount']);
 646       }
 647       CRM_Member_BAO_Membership::recordMembershipContribution($temporaryParams);
 648     }
 649
 650     if (!empty($this->_params['send_receipt'])) {
 651
 652       $receiptFrom = $this->_params['from_email_address'];
 653
 654       if (!empty($this->_params['payment_instrument_id'])) {
 655         $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
 656         $this->_params['paidBy'] = $paymentInstrument[$this->_params['payment_instrument_id']];
 657       }
 658       //get the group Tree
 659       $this->_groupTree = CRM_Core_BAO_CustomGroup::getTree('Membership', NULL, $this->_id, FALSE, $this->_memType);
 660
 661       // retrieve custom data
 662       $customFields = $customValues = $fo = array();
 663       foreach ($this->_groupTree as $groupID => $group) {
 664         if ($groupID == 'info') {
 665           continue;
 666         }
 667         foreach ($group['fields'] as $k => $field) {
 668           $field['title'] = $field['label'];
 669           $customFields["custom_{$k}"] = $field;
 670         }
 671       }
 672       $members = array(array('member_id', '=', $this->_membershipId, 0, 0));
 673       // check whether its a test drive
 674       if ($this->_mode == 'test') {
 675         $members[] = array('member_test', '=', 1, 0, 0);
 676       }
 677       CRM_Core_BAO_UFGroup::getValues($this->_contactID, $customFields, $customValues, FALSE, $members);
 678
 679       $this->assign_by_ref('formValues', $this->_params);
 680       if (!empty($this->_params['contribution_id'])) {
 681         $this->assign('contributionID', $this->_params['contribution_id']);
 682       }
 683
 684       $this->assign('membership_name', CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 685         $renewMembership->membership_type_id
 686       ));
 687       $this->assign('customValues', $customValues);
 688       $this->assign('mem_start_date', CRM_Utils_Date::customFormat($renewMembership->start_date));
 689       $this->assign('mem_end_date', CRM_Utils_Date::customFormat($renewMembership->end_date));
 690       if ($this->_mode) {
 691         $this->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters(
 692           $this->_params,
 693           $this->_bltID
 694         ));
 695         $this->assign('contributeMode', 'direct');
 696         $this->assign('isAmountzero', 0);
 697         $this->assign('is_pay_later', 0);
 698         $this->assign('isPrimary', 1);
 699         $this->assign('receipt_text_renewal', $this->_params['receipt_text']);
 700         if ($this->_mode == 'test') {
 701           $this->assign('action', '1024');
 702         }
 703       }
 704
 705       list($this->isMailSent) = CRM_Core_BAO_MessageTemplate::sendTemplate(
 706         array(
 707           'groupName' => 'msg_tpl_workflow_membership',
 708           'valueName' => 'membership_offline_receipt',
 709           'contactId' => $this->_receiptContactId,
 710           'from' => $receiptFrom,
 711           'toName' => $this->_contributorDisplayName,
 712           'toEmail' => $this->_contributorEmail,
 713           'isTest' => $this->_mode == 'test',
 714         )
 715       );
 716     }
 717   }
 718
 719 }