CRM/Member/Form/MembershipRenewal.php

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