CRM/Member/Form/Membership.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 offline membership form.
  20  */
  21 class CRM_Member_Form_Membership extends CRM_Member_Form {
  22
  23   protected $_memType = NULL;
  24
  25   public $_mode;
  26
  27   public $_contributeMode = 'direct';
  28
  29   protected $_recurMembershipTypes;
  30
  31   protected $_memTypeSelected;
  32
  33   /**
  34    * Display name of the member.
  35    *
  36    * @var string
  37    */
  38   protected $_memberDisplayName = NULL;
  39
  40   /**
  41    * email of the person paying for the membership (used for receipts)
  42    * @var string
  43    */
  44   protected $_memberEmail = NULL;
  45
  46   /**
  47    * Contact ID of the member.
  48    *
  49    * @var int
  50    */
  51   public $_contactID = NULL;
  52
  53   /**
  54    * Display name of the person paying for the membership (used for receipts)
  55    *
  56    * @var string
  57    */
  58   protected $_contributorDisplayName = NULL;
  59
  60   /**
  61    * Email of the person paying for the membership (used for receipts).
  62    *
  63    * @var string
  64    */
  65   protected $_contributorEmail;
  66
  67   /**
  68    * email of the person paying for the membership (used for receipts)
  69    *
  70    * @var int
  71    */
  72   protected $_contributorContactID = NULL;
  73
  74   /**
  75    * ID of the person the receipt is to go to.
  76    *
  77    * @var int
  78    */
  79   protected $_receiptContactId = NULL;
  80
  81   /**
  82    * Keep a class variable for ALL membership IDs so
  83    * postProcess hook function can do something with it
  84    *
  85    * @var array
  86    */
  87   protected $_membershipIDs = [];
  88
  89   /**
  90    * Set entity fields to be assigned to the form.
  91    */
  92   protected function setEntityFields() {
  93     $this->entityFields = [
  94       'join_date' => [
  95         'name' => 'join_date',
  96         'description' => ts('Member Since'),
  97       ],
  98       'start_date' => [
  99         'name' => 'start_date',
 100         'description' => ts('Start Date'),
 101       ],
 102       'end_date' => [
 103         'name' => 'end_date',
 104         'description' => ts('End Date'),
 105       ],
 106     ];
 107   }
 108
 109   /**
 110    * Set the delete message.
 111    *
 112    * We do this from the constructor in order to do a translation.
 113    */
 114   public function setDeleteMessage() {
 115     $this->deleteMessage = '<span class="font-red bold">'
 116       . ts('WARNING: Deleting this membership will also delete any related payment (contribution) records.' . ts('This action cannot be undone.')
 117         . '</span><p>'
 118         . ts('Consider modifying the membership status instead if you want to maintain an audit trail and avoid losing payment data. You can set the status to Cancelled by editing the membership and clicking the Status Override checkbox.')
 119           . '</p><p>'
 120         . ts("Click 'Delete' if you want to continue.") . '</p>');
 121   }
 122
 123   /**
 124    * Overriding this entity trait function as not yet tested.
 125    *
 126    * We continue to rely on legacy handling.
 127    */
 128   public function addCustomDataToForm() {}
 129
 130   /**
 131    * Overriding this entity trait function as not yet tested.
 132    *
 133    * We continue to rely on legacy handling.
 134    */
 135   public function addFormButtons() {}
 136
 137   /**
 138    * Get selected membership type from the form values.
 139    *
 140    * @param array $priceSet
 141    * @param array $params
 142    *
 143    * @return array
 144    * @throws \CRM_Core_Exception
 145    */
 146   public static function getSelectedMemberships($priceSet, $params) {
 147     $memTypeSelected = [];
 148     $priceFieldIDS = self::getPriceFieldIDs($params, $priceSet);
 149     if (isset($params['membership_type_id']) && !empty($params['membership_type_id'][1])) {
 150       $memTypeSelected = [$params['membership_type_id'][1] => $params['membership_type_id'][1]];
 151     }
 152     else {
 153       foreach ($priceFieldIDS as $priceFieldId) {
 154         if ($id = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id')) {
 155           $memTypeSelected[$id] = $id;
 156         }
 157       }
 158     }
 159     return $memTypeSelected;
 160   }
 161
 162   /**
 163    * Extract price set fields and values from $params.
 164    *
 165    * @param array $params
 166    * @param array $priceSet
 167    *
 168    * @return array
 169    */
 170   public static function getPriceFieldIDs($params, $priceSet) {
 171     $priceFieldIDS = [];
 172     if (isset($priceSet['fields']) && is_array($priceSet['fields'])) {
 173       foreach ($priceSet['fields'] as $fieldId => $field) {
 174         if (!empty($params['price_' . $fieldId])) {
 175           if (is_array($params['price_' . $fieldId])) {
 176             foreach ($params['price_' . $fieldId] as $priceFldVal => $isSet) {
 177               if ($isSet) {
 178                 $priceFieldIDS[] = $priceFldVal;
 179               }
 180             }
 181           }
 182           elseif (!$field['is_enter_qty']) {
 183             $priceFieldIDS[] = $params['price_' . $fieldId];
 184           }
 185         }
 186       }
 187     }
 188     return $priceFieldIDS;
 189   }
 190
 191   /**
 192    * Form preProcess function.
 193    *
 194    * @throws \CRM_Core_Exception
 195    * @throws \CiviCRM_API3_Exception
 196    */
 197   public function preProcess() {
 198     // This string makes up part of the class names, differentiating them (not sure why) from the membership fields.
 199     $this->assign('formClass', 'membership');
 200     parent::preProcess();
 201
 202     // get price set id.
 203     $this->_priceSetId = $_GET['priceSetId'] ?? NULL;
 204     $this->set('priceSetId', $this->_priceSetId);
 205     $this->assign('priceSetId', $this->_priceSetId);
 206
 207     if ($this->_action & CRM_Core_Action::DELETE) {
 208       $contributionID = CRM_Member_BAO_Membership::getMembershipContributionId($this->_id);
 209       // check delete permission for contribution
 210       if ($this->_id && $contributionID && !CRM_Core_Permission::checkActionPermission('CiviContribute', $this->_action)) {
 211         CRM_Core_Error::statusBounce(ts("This Membership is linked to a contribution. You must have 'delete in CiviContribute' permission in order to delete this record."));
 212       }
 213     }
 214
 215     if ($this->_action & CRM_Core_Action::ADD) {
 216       if ($this->_contactID) {
 217         //check whether contact has a current membership so we can alert user that they may want to do a renewal instead
 218         $contactMemberships = [];
 219         $memParams = ['contact_id' => $this->_contactID];
 220         CRM_Member_BAO_Membership::getValues($memParams, $contactMemberships, TRUE);
 221         $cMemTypes = [];
 222         foreach ($contactMemberships as $mem) {
 223           $cMemTypes[] = $mem['membership_type_id'];
 224         }
 225         if (count($cMemTypes) > 0) {
 226           foreach ($cMemTypes as $memTypeID) {
 227             $memberorgs[$memTypeID] = CRM_Member_BAO_MembershipType::getMembershipType($memTypeID)['member_of_contact_id'];
 228           }
 229           $mems_by_org = [];
 230           foreach ($contactMemberships as $mem) {
 231             $mem['member_of_contact_id'] = $memberorgs[$mem['membership_type_id']] ?? NULL;
 232             if (!empty($mem['membership_end_date'])) {
 233               $mem['membership_end_date'] = CRM_Utils_Date::customFormat($mem['membership_end_date']);
 234             }
 235             $mem['membership_type'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 236               $mem['membership_type_id'],
 237               'name', 'id'
 238             );
 239             $mem['membership_status'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus',
 240               $mem['status_id'],
 241               'label', 'id'
 242             );
 243             $mem['renewUrl'] = CRM_Utils_System::url('civicrm/contact/view/membership',
 244               "reset=1&action=renew&cid={$this->_contactID}&id={$mem['id']}&context=membership&selectedChild=member"
 245               . ($this->_mode ? '&mode=live' : '')
 246             );
 247             $mem['membershipTab'] = CRM_Utils_System::url('civicrm/contact/view',
 248               "reset=1&force=1&cid={$this->_contactID}&selectedChild=member"
 249             );
 250             $mems_by_org[$mem['member_of_contact_id']] = $mem;
 251           }
 252           $this->assign('existingContactMemberships', $mems_by_org);
 253         }
 254       }
 255       else {
 256         // In standalone mode we don't have a contact id yet so lookup will be done client-side with this script:
 257         $resources = CRM_Core_Resources::singleton();
 258         $resources->addScriptFile('civicrm', 'templates/CRM/Member/Form/MembershipStandalone.js');
 259         $passthru = [
 260           'typeorgs' => CRM_Member_BAO_MembershipType::getMembershipTypeOrganization(),
 261           'memtypes' => CRM_Core_PseudoConstant::get('CRM_Member_BAO_Membership', 'membership_type_id'),
 262           'statuses' => CRM_Core_PseudoConstant::get('CRM_Member_BAO_Membership', 'status_id'),
 263         ];
 264         $resources->addSetting(['existingMems' => $passthru]);
 265       }
 266     }
 267
 268     if (!$this->_memType) {
 269       $params = CRM_Utils_Request::exportValues();
 270       if (!empty($params['membership_type_id'][1])) {
 271         $this->_memType = $params['membership_type_id'][1];
 272       }
 273     }
 274
 275     // Add custom data to form
 276     CRM_Custom_Form_CustomData::addToForm($this, $this->_memType);
 277     $this->setPageTitle(ts('Membership'));
 278   }
 279
 280   /**
 281    * Set default values for the form.
 282    */
 283   public function setDefaultValues() {
 284
 285     if ($this->_priceSetId) {
 286       return CRM_Price_BAO_PriceSet::setDefaultPriceSet($this, $defaults);
 287     }
 288
 289     $defaults = parent::setDefaultValues();
 290
 291     //setting default join date and receive date
 292     if ($this->_action == CRM_Core_Action::ADD) {
 293       $defaults['receive_date'] = CRM_Utils_Time::date('Y-m-d H:i:s');
 294     }
 295
 296     $defaults['num_terms'] = 1;
 297
 298     if (!empty($defaults['id'])) {
 299       $contributionId = CRM_Core_DAO::singleValueQuery("
 300 SELECT contribution_id
 301 FROM civicrm_membership_payment
 302 WHERE membership_id = $this->_id
 303 ORDER BY contribution_id
 304 DESC limit 1");
 305
 306       if ($contributionId) {
 307         $defaults['record_contribution'] = $contributionId;
 308       }
 309     }
 310     else {
 311       if ($this->_contactID) {
 312         $defaults['contact_id'] = $this->_contactID;
 313       }
 314     }
 315
 316     //set Soft Credit Type to Gift by default
 317     $scTypes = CRM_Core_OptionGroup::values('soft_credit_type');
 318     $defaults['soft_credit_type_id'] = CRM_Utils_Array::value(ts('Gift'), array_flip($scTypes));
 319
 320     //CRM-13420
 321     if (empty($defaults['payment_instrument_id'])) {
 322       $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
 323     }
 324
 325     // User must explicitly choose to send a receipt in both add and update mode.
 326     $defaults['send_receipt'] = 0;
 327
 328     if ($this->_action & CRM_Core_Action::UPDATE) {
 329       // in this mode by default uncheck this checkbox
 330       unset($defaults['record_contribution']);
 331     }
 332
 333     $subscriptionCancelled = FALSE;
 334     if (!empty($defaults['id'])) {
 335       $subscriptionCancelled = CRM_Member_BAO_Membership::isSubscriptionCancelled($this->_id);
 336     }
 337
 338     $alreadyAutoRenew = FALSE;
 339     if (!empty($defaults['contribution_recur_id']) && !$subscriptionCancelled) {
 340       $defaults['auto_renew'] = 1;
 341       $alreadyAutoRenew = TRUE;
 342     }
 343     $this->assign('alreadyAutoRenew', $alreadyAutoRenew);
 344
 345     $this->assign('member_is_test', $defaults['member_is_test'] ?? NULL);
 346     $this->assign('membership_status_id', $defaults['status_id'] ?? NULL);
 347     $this->assign('is_pay_later', !empty($defaults['is_pay_later']));
 348
 349     if ($this->_mode) {
 350       $defaults = $this->getBillingDefaults($defaults);
 351     }
 352
 353     //setting default join date if there is no join date
 354     if (empty($defaults['join_date'])) {
 355       $defaults['join_date'] = CRM_Utils_Time::date('Y-m-d');
 356     }
 357
 358     if (!empty($defaults['membership_end_date'])) {
 359       $this->assign('endDate', $defaults['membership_end_date']);
 360     }
 361
 362     return $defaults;
 363   }
 364
 365   /**
 366    * Build the form object.
 367    *
 368    * @throws \CRM_Core_Exception
 369    */
 370   public function buildQuickForm() {
 371
 372     $this->buildQuickEntityForm();
 373     $this->assign('currency_symbol', CRM_Core_BAO_Country::defaultCurrencySymbol());
 374     $isUpdateToExistingRecurringMembership = $this->isUpdateToExistingRecurringMembership();
 375     // build price set form.
 376     $buildPriceSet = FALSE;
 377     if ($this->_priceSetId || !empty($_POST['price_set_id'])) {
 378       if (!empty($_POST['price_set_id'])) {
 379         $buildPriceSet = TRUE;
 380       }
 381       $getOnlyPriceSetElements = TRUE;
 382       if (!$this->_priceSetId) {
 383         $this->_priceSetId = $_POST['price_set_id'];
 384         $getOnlyPriceSetElements = FALSE;
 385       }
 386
 387       $this->set('priceSetId', $this->_priceSetId);
 388       CRM_Price_BAO_PriceSet::buildPriceSet($this);
 389
 390       $optionsMembershipTypes = [];
 391       foreach ($this->_priceSet['fields'] as $pField) {
 392         if (empty($pField['options'])) {
 393           continue;
 394         }
 395         foreach ($pField['options'] as $opId => $opValues) {
 396           $optionsMembershipTypes[$opId] = CRM_Utils_Array::value('membership_type_id', $opValues, 0);
 397         }
 398       }
 399
 400       $this->assign('autoRenewOption', CRM_Price_BAO_PriceSet::checkAutoRenewForPriceSet($this->_priceSetId));
 401
 402       $this->assign('optionsMembershipTypes', $optionsMembershipTypes);
 403       $this->assign('contributionType', CRM_Utils_Array::value('financial_type_id', $this->_priceSet));
 404
 405       // get only price set form elements.
 406       if ($getOnlyPriceSetElements) {
 407         return;
 408       }
 409     }
 410
 411     // use to build form during form rule.
 412     $this->assign('buildPriceSet', $buildPriceSet);
 413
 414     if ($this->_action & CRM_Core_Action::ADD) {
 415       $buildPriceSet = FALSE;
 416       $priceSets = CRM_Price_BAO_PriceSet::getAssoc(FALSE, 'CiviMember');
 417       if (!empty($priceSets)) {
 418         $buildPriceSet = TRUE;
 419       }
 420
 421       if ($buildPriceSet) {
 422         $this->add('select', 'price_set_id', ts('Choose price set'),
 423           [
 424             '' => ts('Choose price set'),
 425           ] + $priceSets,
 426           NULL, ['onchange' => "buildAmount( this.value );"]
 427         );
 428       }
 429       $this->assign('hasPriceSets', $buildPriceSet);
 430     }
 431
 432     if ($this->_action & CRM_Core_Action::DELETE) {
 433       $this->addButtons([
 434         [
 435           'type' => 'next',
 436           'name' => ts('Delete'),
 437           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 438           'isDefault' => TRUE,
 439         ],
 440         [
 441           'type' => 'cancel',
 442           'name' => ts('Cancel'),
 443         ],
 444       ]);
 445       return;
 446     }
 447
 448     $contactField = $this->addEntityRef('contact_id', ts('Member'), ['create' => TRUE, 'api' => ['extra' => ['email']]], TRUE);
 449     if ($this->_context !== 'standalone') {
 450       $contactField->freeze();
 451     }
 452
 453     $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
 454
 455     // Throw status bounce when no Membership type or priceset is present
 456     if (empty($this->allMembershipTypeDetails) && empty($priceSets)
 457     ) {
 458       CRM_Core_Error::statusBounce(ts('You do not have all the permissions needed for this page.'));
 459     }
 460     // retrieve all memberships
 461     $allMembershipInfo = [];
 462     foreach ($this->allMembershipTypeDetails as $key => $values) {
 463       if ($this->_mode && empty($values['minimum_fee'])) {
 464         continue;
 465       }
 466       else {
 467         $memberOfContactId = $values['member_of_contact_id'] ?? NULL;
 468         if (empty($selMemTypeOrg[$memberOfContactId])) {
 469           $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 470             $memberOfContactId,
 471             'display_name',
 472             'id'
 473           );
 474
 475           $selOrgMemType[$memberOfContactId][0] = ts('- select -');
 476         }
 477         if (empty($selOrgMemType[$memberOfContactId][$key])) {
 478           $selOrgMemType[$memberOfContactId][$key] = $values['name'] ?? NULL;
 479         }
 480       }
 481       $totalAmount = $values['minimum_fee'] ?? NULL;
 482       // build membership info array, which is used when membership type is selected to:
 483       // - set the payment information block
 484       // - set the max related block
 485       $allMembershipInfo[$key] = [
 486         'financial_type_id' => $values['financial_type_id'] ?? NULL,
 487         'total_amount' => CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($totalAmount),
 488         'total_amount_numeric' => $totalAmount,
 489         'auto_renew' => $values['auto_renew'] ?? NULL,
 490         'tax_rate' => $values['tax_rate'],
 491         'has_related' => isset($values['relationship_type_id']),
 492         'max_related' => $values['max_related'] ?? NULL,
 493       ];
 494     }
 495
 496     $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
 497
 498     // show organization by default, if only one organization in
 499     // the list
 500     if (count($selMemTypeOrg) == 2) {
 501       unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
 502     }
 503     //sort membership organization and type, CRM-6099
 504     natcasesort($selMemTypeOrg);
 505     foreach ($selOrgMemType as $index => $orgMembershipType) {
 506       natcasesort($orgMembershipType);
 507       $selOrgMemType[$index] = $orgMembershipType;
 508     }
 509
 510     $memTypeJs = [
 511       'onChange' => "buildMaxRelated(this.value,true); CRM.buildCustomData('Membership', this.value);",
 512     ];
 513
 514     if (!empty($this->_recurPaymentProcessors)) {
 515       $memTypeJs['onChange'] = "" . $memTypeJs['onChange'] . " buildAutoRenew(this.value, null, '{$this->_mode}');";
 516     }
 517
 518     $this->add('text', 'max_related', ts('Max related'),
 519       CRM_Core_DAO::getAttribute('CRM_Member_DAO_Membership', 'max_related')
 520     );
 521
 522     $sel = &$this->addElement('hierselect',
 523       'membership_type_id',
 524       ts('Membership Organization and Type'),
 525       $memTypeJs
 526     );
 527
 528     $sel->setOptions([$selMemTypeOrg, $selOrgMemType]);
 529
 530     if ($this->_action & CRM_Core_Action::ADD) {
 531       $this->add('number', 'num_terms', ts('Number of Terms'), ['size' => 6]);
 532     }
 533
 534     $this->add('text', 'source', ts('Source'),
 535       CRM_Core_DAO::getAttribute('CRM_Member_DAO_Membership', 'source')
 536     );
 537
 538     //CRM-7362 --add campaigns.
 539     $campaignId = NULL;
 540     if ($this->_id) {
 541       $campaignId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'campaign_id');
 542     }
 543     CRM_Campaign_BAO_Campaign::addCampaign($this, $campaignId);
 544
 545     if (!$this->_mode) {
 546       $this->add('select', 'status_id', ts('Membership Status'),
 547         ['' => ts('- select -')] + CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label')
 548       );
 549
 550       $statusOverride = $this->addElement('select', 'is_override', ts('Status Override?'),
 551         CRM_Member_StatusOverrideTypes::getSelectOptions()
 552       );
 553
 554       $this->add('datepicker', 'status_override_end_date', ts('Status Override End Date'), '', FALSE, ['minDate' => CRM_Utils_Time::date('Y-m-d'), 'time' => FALSE]);
 555
 556       $this->addElement('checkbox', 'record_contribution', ts('Record Membership Payment?'));
 557
 558       $this->add('text', 'total_amount', ts('Amount'));
 559       $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
 560
 561       $this->add('datepicker', 'receive_date', ts('Received'), [], FALSE, ['time' => TRUE]);
 562
 563       $this->add('select', 'payment_instrument_id',
 564         ts('Payment Method'),
 565         ['' => ts('- select -')] + CRM_Contribute_PseudoConstant::paymentInstrument(),
 566         FALSE, ['onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);"]
 567       );
 568       $this->add('text', 'trxn_id', ts('Transaction ID'));
 569       $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
 570         'objectExists', [
 571           'CRM_Contribute_DAO_Contribution',
 572           $this->_id,
 573           'trxn_id',
 574         ]
 575       );
 576
 577       $this->add('select', 'contribution_status_id',
 578         ts('Payment Status'), CRM_Contribute_BAO_Contribution_Utils::getContributionStatuses('membership')
 579       );
 580       $this->add('text', 'check_number', ts('Check Number'),
 581         CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
 582       );
 583     }
 584     else {
 585       //add field for amount to allow an amount to be entered that differs from minimum
 586       $this->add('text', 'total_amount', ts('Amount'));
 587     }
 588     $this->add('select', 'financial_type_id',
 589       ts('Financial Type'),
 590       ['' => ts('- select -')] + CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes, $this->_action)
 591     );
 592
 593     $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different Contact?'));
 594
 595     $this->addSelect('soft_credit_type_id', ['entity' => 'contribution_soft']);
 596     $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), ['create' => TRUE]);
 597
 598     $this->addElement('checkbox',
 599       'send_receipt',
 600       ts('Send Confirmation and Receipt?'), NULL,
 601       ['onclick' => "showEmailOptions()"]
 602     );
 603
 604     $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails);
 605
 606     $this->add('textarea', 'receipt_text', ts('Receipt Message'));
 607
 608     // Retrieve the name and email of the contact - this will be the TO for receipt email
 609     if ($this->_contactID) {
 610       [$this->_memberDisplayName, $this->_memberEmail] = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 611
 612       $this->assign('emailExists', $this->_memberEmail);
 613       $this->assign('displayName', $this->_memberDisplayName);
 614     }
 615
 616     if ($isUpdateToExistingRecurringMembership && CRM_Member_BAO_Membership::isCancelSubscriptionSupported($this->_id)) {
 617       $this->assign('cancelAutoRenew',
 618         CRM_Utils_System::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
 619       );
 620     }
 621
 622     $this->assign('isRecur', $isUpdateToExistingRecurringMembership);
 623
 624     $this->addFormRule(['CRM_Member_Form_Membership', 'formRule'], $this);
 625     $mailingInfo = Civi::settings()->get('mailing_backend');
 626     $this->assign('isEmailEnabledForSite', ($mailingInfo['outBound_option'] != 2));
 627
 628     parent::buildQuickForm();
 629   }
 630
 631   /**
 632    * Validation.
 633    *
 634    * @param array $params
 635    *   (ref.) an assoc array of name/value pairs.
 636    *
 637    * @param array $files
 638    * @param CRM_Member_Form_Membership $self
 639    *
 640    * @return bool|array
 641    *   mixed true or array of errors
 642    *
 643    * @throws \CRM_Core_Exception
 644    * @throws CiviCRM_API3_Exception
 645    */
 646   public static function formRule($params, $files, $self) {
 647     $errors = [];
 648
 649     $priceSetId = $self->getPriceSetID($params);
 650     $priceSetDetails = $self->getPriceSetDetails($params);
 651
 652     $selectedMemberships = self::getSelectedMemberships($priceSetDetails[$priceSetId], $params);
 653
 654     if (!empty($params['price_set_id'])) {
 655       CRM_Price_BAO_PriceField::priceSetValidation($priceSetId, $params, $errors);
 656
 657       $priceFieldIDS = self::getPriceFieldIDs($params, $priceSetDetails[$priceSetId]);
 658
 659       if (!empty($priceFieldIDS)) {
 660         $ids = implode(',', $priceFieldIDS);
 661
 662         $count = CRM_Price_BAO_PriceSet::getMembershipCount($ids);
 663         foreach ($count as $occurrence) {
 664           if ($occurrence > 1) {
 665             $errors['_qf_default'] = ts('Select at most one option associated with the same membership type.');
 666           }
 667         }
 668       }
 669       // Return error if empty $self->_memTypeSelected
 670       if (empty($errors) && empty($selectedMemberships)) {
 671         $errors['_qf_default'] = ts('Select at least one membership option.');
 672       }
 673       if (!$self->_mode && empty($params['record_contribution'])) {
 674         $errors['record_contribution'] = ts('Record Membership Payment is required when you use a price set.');
 675       }
 676     }
 677     else {
 678       if (empty($params['membership_type_id'][1])) {
 679         $errors['membership_type_id'] = ts('Please select a membership type.');
 680       }
 681       $numterms = $params['num_terms'] ?? NULL;
 682       if ($numterms && intval($numterms) != $numterms) {
 683         $errors['num_terms'] = ts('Please enter an integer for the number of terms.');
 684       }
 685
 686       if (($self->_mode || isset($params['record_contribution'])) && empty($params['financial_type_id'])) {
 687         $errors['financial_type_id'] = ts('Please enter the financial Type.');
 688       }
 689     }
 690
 691     if (!empty($errors) && (count($selectedMemberships) > 1)) {
 692       $memberOfContacts = CRM_Member_BAO_MembershipType::getMemberOfContactByMemTypes($selectedMemberships);
 693       $duplicateMemberOfContacts = array_count_values($memberOfContacts);
 694       foreach ($duplicateMemberOfContacts as $countDuplicate) {
 695         if ($countDuplicate > 1) {
 696           $errors['_qf_default'] = ts('Please do not select more than one membership associated with the same organization.');
 697         }
 698       }
 699     }
 700
 701     if (!empty($errors)) {
 702       return $errors;
 703     }
 704
 705     if (!empty($params['record_contribution']) && empty($params['payment_instrument_id'])) {
 706       $errors['payment_instrument_id'] = ts('Payment Method is a required field.');
 707     }
 708
 709     if (!empty($params['is_different_contribution_contact'])) {
 710       if (empty($params['soft_credit_type_id'])) {
 711         $errors['soft_credit_type_id'] = ts('Please Select a Soft Credit Type');
 712       }
 713       if (empty($params['soft_credit_contact_id'])) {
 714         $errors['soft_credit_contact_id'] = ts('Please select a contact');
 715       }
 716     }
 717
 718     if (!empty($params['payment_processor_id'])) {
 719       // validate payment instrument (e.g. credit card number)
 720       CRM_Core_Payment_Form::validatePaymentInstrument($params['payment_processor_id'], $params, $errors, NULL);
 721     }
 722
 723     $joinDate = NULL;
 724     if (!empty($params['join_date'])) {
 725
 726       $joinDate = CRM_Utils_Date::processDate($params['join_date']);
 727
 728       foreach ($selectedMemberships as $memType) {
 729         $startDate = NULL;
 730         if (!empty($params['start_date'])) {
 731           $startDate = CRM_Utils_Date::processDate($params['start_date']);
 732         }
 733
 734         // if end date is set, ensure that start date is also set
 735         // and that end date is later than start date
 736         $endDate = NULL;
 737         if (!empty($params['end_date'])) {
 738           $endDate = CRM_Utils_Date::processDate($params['end_date']);
 739         }
 740
 741         $membershipDetails = CRM_Member_BAO_MembershipType::getMembershipType($memType);
 742         if ($startDate && CRM_Utils_Array::value('period_type', $membershipDetails) === 'rolling') {
 743           if ($startDate < $joinDate) {
 744             $errors['start_date'] = ts('Start date must be the same or later than Member since.');
 745           }
 746         }
 747
 748         if ($endDate) {
 749           if ($membershipDetails['duration_unit'] === 'lifetime') {
 750             // Check if status is NOT cancelled or similar. For lifetime memberships, there is no automated
 751             // process to update status based on end-date. The user must change the status now.
 752             $result = civicrm_api3('MembershipStatus', 'get', [
 753               'sequential' => 1,
 754               'is_current_member' => 0,
 755             ]);
 756             $tmp_statuses = $result['values'];
 757             $status_ids = [];
 758             foreach ($tmp_statuses as $cur_stat) {
 759               $status_ids[] = $cur_stat['id'];
 760             }
 761
 762             if (empty($params['status_id']) || in_array($params['status_id'], $status_ids) == FALSE) {
 763               $errors['status_id'] = ts('Please enter a status that does NOT represent a current membership status.');
 764             }
 765
 766             if (!empty($params['is_override']) && !CRM_Member_StatusOverrideTypes::isPermanent($params['is_override'])) {
 767               $errors['is_override'] = ts('Because you set an End Date for a lifetime membership, This must be set to "Override Permanently"');
 768             }
 769           }
 770           else {
 771             if (!$startDate) {
 772               $errors['start_date'] = ts('Start date must be set if end date is set.');
 773             }
 774             if ($endDate < $startDate) {
 775               $errors['end_date'] = ts('End date must be the same or later than start date.');
 776             }
 777           }
 778         }
 779
 780         // Default values for start and end dates if not supplied on the form.
 781         $defaultDates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($memType,
 782           $joinDate,
 783           $startDate,
 784           $endDate
 785         );
 786
 787         if (!$startDate) {
 788           $startDate = CRM_Utils_Array::value('start_date',
 789             $defaultDates
 790           );
 791         }
 792         if (!$endDate) {
 793           $endDate = CRM_Utils_Array::value('end_date',
 794             $defaultDates
 795           );
 796         }
 797
 798         //CRM-3724, check for availability of valid membership status.
 799         if ((empty($params['is_override']) || CRM_Member_StatusOverrideTypes::isNo($params['is_override'])) && !isset($errors['_qf_default'])) {
 800           $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($startDate,
 801             $endDate,
 802             $joinDate,
 803             'now',
 804             TRUE,
 805             $memType,
 806             $params
 807           );
 808           if (empty($calcStatus)) {
 809             $url = CRM_Utils_System::url('civicrm/admin/member/membershipStatus', 'reset=1&action=browse');
 810             $errors['_qf_default'] = ts('There is no valid Membership Status available for selected membership dates.');
 811             $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>.', [1 => $url]);
 812             if (!$self->_mode) {
 813               $status .= ' ' . ts('OR You can sign up by setting Status Override? to something other than "NO".');
 814             }
 815             CRM_Core_Session::setStatus($status, ts('Membership Status Error'), 'error');
 816           }
 817         }
 818       }
 819     }
 820     else {
 821       $errors['join_date'] = ts('Please enter the Member Since.');
 822     }
 823
 824     if (!empty($params['is_override']) && CRM_Member_StatusOverrideTypes::isOverridden($params['is_override']) && empty($params['status_id'])) {
 825       $errors['status_id'] = ts('Please enter the Membership status.');
 826     }
 827
 828     if (!empty($params['is_override']) && CRM_Member_StatusOverrideTypes::isUntilDate($params['is_override'])) {
 829       if (empty($params['status_override_end_date'])) {
 830         $errors['status_override_end_date'] = ts('Please enter the Membership override end date.');
 831       }
 832     }
 833
 834     //total amount condition arise when membership type having no
 835     //minimum fee
 836     if (isset($params['record_contribution'])) {
 837       if (CRM_Utils_System::isNull($params['total_amount'])) {
 838         $errors['total_amount'] = ts('Please enter the contribution.');
 839       }
 840     }
 841
 842     return empty($errors) ? TRUE : $errors;
 843   }
 844
 845   /**
 846    * Process the form submission.
 847    *
 848    * @throws \CRM_Core_Exception
 849    * @throws \CiviCRM_API3_Exception
 850    */
 851   public function postProcess() {
 852     if ($this->_action & CRM_Core_Action::DELETE) {
 853       CRM_Member_BAO_Membership::del($this->_id);
 854       return;
 855     }
 856     // get the submitted form values.
 857     $this->_params = $this->controller->exportValues($this->_name);
 858     $this->prepareStatusOverrideValues();
 859
 860     $this->submit();
 861
 862     $this->setUserContext();
 863   }
 864
 865   /**
 866    * Prepares the values related to status override.
 867    */
 868   private function prepareStatusOverrideValues() {
 869     $this->setOverrideDateValue();
 870     $this->convertIsOverrideValue();
 871   }
 872
 873   /**
 874    * Sets status override end date to empty value if
 875    * the selected override option is not 'until date'.
 876    */
 877   private function setOverrideDateValue() {
 878     if (!CRM_Member_StatusOverrideTypes::isUntilDate(CRM_Utils_Array::value('is_override', $this->_params))) {
 879       $this->_params['status_override_end_date'] = '';
 880     }
 881   }
 882
 883   /**
 884    * Convert the value of selected (status override?)
 885    * option to TRUE if it indicate an overridden status
 886    * or FALSE otherwise.
 887    */
 888   private function convertIsOverrideValue() {
 889     $this->_params['is_override'] = CRM_Member_StatusOverrideTypes::isOverridden($this->_params['is_override'] ?? CRM_Member_StatusOverrideTypes::NO);
 890   }
 891
 892   /**
 893    * Send email receipt.
 894    *
 895    * @param CRM_Core_Form $form
 896    *   Form object.
 897    * @param array $formValues
 898    * @param object $membership
 899    *   Object.
 900    *
 901    * @return bool
 902    *   true if mail was sent successfully
 903    * @throws \CRM_Core_Exception
 904    *
 905    * @deprecated
 906    *   This function is shared with Batch_Entry which has limited overlap
 907    *   & needs rationalising.
 908    *
 909    */
 910   public static function emailReceipt($form, &$formValues, $membership) {
 911     // retrieve 'from email id' for acknowledgement
 912     $receiptFrom = $formValues['from_email_address'] ?? NULL;
 913
 914     // @todo figure out how much of the stuff below is genuinely shared with the batch form & a logical shared place.
 915     if (!empty($formValues['payment_instrument_id'])) {
 916       $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
 917       $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
 918     }
 919
 920     $form->assign('module', 'Membership');
 921     $form->assign('contactID', $formValues['contact_id']);
 922
 923     $form->assign('membershipID', CRM_Utils_Array::value('membership_id', $form->_params, CRM_Utils_Array::value('membership_id', $form->_defaultValues)));
 924
 925     if (!empty($formValues['contribution_id'])) {
 926       $form->assign('contributionID', $formValues['contribution_id']);
 927     }
 928
 929     if (!empty($formValues['contribution_status_id'])) {
 930       $form->assign('contributionStatusID', $formValues['contribution_status_id']);
 931       $form->assign('contributionStatus', CRM_Contribute_PseudoConstant::contributionStatus($formValues['contribution_status_id'], 'name'));
 932     }
 933
 934     if (!empty($formValues['is_renew'])) {
 935       $form->assign('receiptType', 'membership renewal');
 936     }
 937     else {
 938       $form->assign('receiptType', 'membership signup');
 939     }
 940     $form->assign('receive_date', CRM_Utils_Array::value('receive_date', $formValues));
 941     $form->assign('formValues', $formValues);
 942
 943     $form->assign('mem_start_date', CRM_Utils_Date::formatDateOnlyLong($membership->start_date));
 944     if (!CRM_Utils_System::isNull($membership->end_date)) {
 945       $form->assign('mem_end_date', CRM_Utils_Date::formatDateOnlyLong($membership->end_date));
 946     }
 947     $form->assign('membership_name', CRM_Member_PseudoConstant::membershipType($membership->membership_type_id));
 948
 949     // @todo - if we have to figure out if this is for batch processing it doesn't belong in the shared function.
 950     $isBatchProcess = is_a($form, 'CRM_Batch_Form_Entry');
 951     if ((empty($form->_contributorDisplayName) || empty($form->_contributorEmail)) || $isBatchProcess) {
 952       // in this case the form is being called statically from the batch editing screen
 953       // having one class in the form layer call another statically is not greate
 954       // & we should aim to move this function to the BAO layer in future.
 955       // however, we can assume that the contact_id passed in by the batch
 956       // function will be the recipient
 957       [$form->_contributorDisplayName, $form->_contributorEmail]
 958         = CRM_Contact_BAO_Contact_Location::getEmailDetails($formValues['contact_id']);
 959       if (empty($form->_receiptContactId) || $isBatchProcess) {
 960         $form->_receiptContactId = $formValues['contact_id'];
 961       }
 962     }
 963
 964     CRM_Core_BAO_MessageTemplate::sendTemplate(
 965       [
 966         'groupName' => 'msg_tpl_workflow_membership',
 967         'valueName' => 'membership_offline_receipt',
 968         'contactId' => $form->_receiptContactId,
 969         'from' => $receiptFrom,
 970         'toName' => $form->_contributorDisplayName,
 971         'toEmail' => $form->_contributorEmail,
 972         'PDFFilename' => ts('receipt') . '.pdf',
 973         'isEmailPdf' => Civi::settings()->get('invoicing') && Civi::settings()->get('is_email_pdf'),
 974         'contributionId' => $formValues['contribution_id'],
 975         'isTest' => (bool) ($form->_action & CRM_Core_Action::PREVIEW),
 976       ]
 977     );
 978
 979     return TRUE;
 980   }
 981
 982   /**
 983    * Submit function.
 984    *
 985    * This is also accessed by unit tests.
 986    *
 987    * @throws \CRM_Core_Exception
 988    * @throws \CiviCRM_API3_Exception
 989    */
 990   public function submit(): void {
 991     $this->storeContactFields($this->_params);
 992     $this->beginPostProcess();
 993     $endDate = NULL;
 994     $membership = $calcDate = [];
 995
 996     $paymentInstrumentID = $this->_paymentProcessor['object']->getPaymentInstrumentID();
 997     $params = $softParams = $ids = [];
 998
 999     $mailSend = FALSE;
1000     $this->processBillingAddress();
1001     $formValues = $this->_params;
1002     $formValues = $this->setPriceSetParameters($formValues);
1003
1004     if ($this->_id) {
1005       $ids['membership'] = $params['id'] = $this->_id;
1006     }
1007
1008     // Set variables that we normally get from context.
1009     // In form mode these are set in preProcess.
1010     //TODO: set memberships, fixme
1011     $this->setContextVariables($formValues);
1012
1013     $this->_memTypeSelected = self::getSelectedMemberships(
1014       $this->_priceSet,
1015       $formValues
1016     );
1017     if (empty($formValues['financial_type_id'])) {
1018       $formValues['financial_type_id'] = $this->_priceSet['financial_type_id'];
1019     }
1020
1021     $membershipTypeValues = [];
1022     foreach ($this->_memTypeSelected as $memType) {
1023       $membershipTypeValues[$memType]['membership_type_id'] = $memType;
1024     }
1025
1026     //take the required membership recur values.
1027     if ($this->_mode && !empty($formValues['auto_renew'])) {
1028       $params['is_recur'] = $formValues['is_recur'] = TRUE;
1029
1030       $count = 0;
1031       foreach ($this->_memTypeSelected as $memType) {
1032         $recurMembershipTypeValues = CRM_Utils_Array::value($memType,
1033           $this->allMembershipTypeDetails, []
1034         );
1035         if (!$recurMembershipTypeValues['auto_renew']) {
1036           continue;
1037         }
1038         foreach ([
1039           'frequency_interval' => 'duration_interval',
1040           'frequency_unit' => 'duration_unit',
1041         ] as $mapVal => $mapParam) {
1042           $membershipTypeValues[$memType][$mapVal] = $recurMembershipTypeValues[$mapParam];
1043
1044           if (!$count) {
1045             $formValues[$mapVal] = CRM_Utils_Array::value($mapParam,
1046               $recurMembershipTypeValues
1047             );
1048           }
1049         }
1050         $count++;
1051       }
1052     }
1053
1054     $isQuickConfig = $this->_priceSet['is_quick_config'];
1055
1056     $termsByType = [];
1057
1058     $lineItem = [$this->_priceSetId => []];
1059
1060     // BEGIN Fix for dev/core/issues/860
1061     // Prepare fee block and call buildAmount hook - based on CRM_Price_BAO_PriceSet::buildPriceSet().
1062     CRM_Utils_Hook::buildAmount('membership', $this, $this->_priceSet['fields']);
1063     // END Fix for dev/core/issues/860
1064
1065     CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'],
1066       $formValues, $lineItem[$this->_priceSetId], $this->_priceSetId);
1067
1068     if (!empty($formValues['tax_amount'])) {
1069       $params['tax_amount'] = $formValues['tax_amount'];
1070     }
1071     $params['total_amount'] = $formValues['amount'] ?? NULL;
1072     if (!empty($lineItem[$this->_priceSetId])) {
1073       foreach ($lineItem[$this->_priceSetId] as &$li) {
1074         if (!empty($li['membership_type_id'])) {
1075           if (!empty($li['membership_num_terms'])) {
1076             $termsByType[$li['membership_type_id']] = $li['membership_num_terms'];
1077           }
1078         }
1079
1080         ///CRM-11529 for quick config backoffice transactions
1081         //when financial_type_id is passed in form, update the
1082         //lineitems with the financial type selected in form
1083         $submittedFinancialType = $formValues['financial_type_id'] ?? NULL;
1084         if ($isQuickConfig && $submittedFinancialType) {
1085           $li['financial_type_id'] = $submittedFinancialType;
1086         }
1087       }
1088     }
1089
1090     $params['contact_id'] = $this->_contactID;
1091
1092     $fields = [
1093       'status_id',
1094       'source',
1095       'is_override',
1096       'status_override_end_date',
1097       'campaign_id',
1098     ];
1099
1100     foreach ($fields as $f) {
1101       $params[$f] = $formValues[$f] ?? NULL;
1102     }
1103
1104     // fix for CRM-3724
1105     // when is_override false ignore is_admin statuses during membership
1106     // status calculation. similarly we did fix for import in CRM-3570.
1107     if (empty($params['is_override'])) {
1108       $params['exclude_is_admin'] = TRUE;
1109     }
1110
1111     $joinDate = $formValues['join_date'];
1112     $startDate = $formValues['start_date'];
1113     $endDate = $formValues['end_date'];
1114
1115     $memTypeNumTerms = empty($termsByType) ? CRM_Utils_Array::value('num_terms', $formValues) : NULL;
1116
1117     $calcDates = [];
1118     foreach ($this->_memTypeSelected as $memType) {
1119       if (empty($memTypeNumTerms)) {
1120         $memTypeNumTerms = CRM_Utils_Array::value($memType, $termsByType, 1);
1121       }
1122       $calcDates[$memType] = CRM_Member_BAO_MembershipType::getDatesForMembershipType($memType,
1123         $joinDate, $startDate, $endDate, $memTypeNumTerms
1124       );
1125     }
1126
1127     foreach ($calcDates as $memType => $calcDate) {
1128       foreach (['join_date', 'start_date', 'end_date'] as $d) {
1129         //first give priority to form values then calDates.
1130         $date = $formValues[$d] ?? NULL;
1131         if (!$date) {
1132           $date = $calcDate[$d] ?? NULL;
1133         }
1134
1135         $membershipTypeValues[$memType][$d] = CRM_Utils_Date::processDate($date);
1136       }
1137     }
1138
1139     foreach ($this->_memTypeSelected as $memType) {
1140       if (array_key_exists('max_related', $formValues)) {
1141         // max related memberships - take from form or inherit from membership type
1142         $membershipTypeValues[$memType]['max_related'] = $formValues['max_related'] ?? NULL;
1143       }
1144       $membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField::postProcess($formValues,
1145         $this->_id,
1146         'Membership'
1147       );
1148     }
1149
1150     // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1151     [$userName] = CRM_Contact_BAO_Contact_Location::getEmailDetails(CRM_Core_Session::getLoggedInContactID());
1152
1153     //CRM-13981, allow different person as a soft-contributor of chosen type
1154     if ($this->_contributorContactID != $this->_contactID) {
1155       $params['contribution_contact_id'] = $this->_contributorContactID;
1156       if (!empty($formValues['soft_credit_type_id'])) {
1157         $softParams['soft_credit_type_id'] = $formValues['soft_credit_type_id'];
1158         $softParams['contact_id'] = $this->_contactID;
1159       }
1160     }
1161
1162     $pendingMembershipStatusId = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending');
1163
1164     if (!empty($formValues['record_contribution'])) {
1165       $recordContribution = [
1166         'total_amount',
1167         'financial_type_id',
1168         'payment_instrument_id',
1169         'trxn_id',
1170         'contribution_status_id',
1171         'check_number',
1172         'campaign_id',
1173         'receive_date',
1174         'card_type_id',
1175         'pan_truncation',
1176       ];
1177
1178       foreach ($recordContribution as $f) {
1179         $params[$f] = $formValues[$f] ?? NULL;
1180       }
1181
1182       if (empty($formValues['source'])) {
1183         $params['contribution_source'] = ts('%1 Membership: Offline signup (by %2)', [
1184           1 => $this->getSelectedMembershipLabels(),
1185           2 => $userName,
1186         ]);
1187       }
1188       else {
1189         $params['contribution_source'] = $formValues['source'];
1190       }
1191
1192       $completedContributionStatusId = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
1193       if (empty($params['is_override']) &&
1194         CRM_Utils_Array::value('contribution_status_id', $params) != $completedContributionStatusId
1195       ) {
1196         $params['status_id'] = $pendingMembershipStatusId;
1197         $params['skipStatusCal'] = TRUE;
1198         $params['is_pay_later'] = 1;
1199         $this->assign('is_pay_later', 1);
1200       }
1201
1202       if ($this->getSubmittedValue('send_receipt')) {
1203         $params['receipt_date'] = $formValues['receive_date'] ?? NULL;
1204       }
1205
1206       //insert financial type name in receipt.
1207       $formValues['contributionType_name'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialType',
1208         $formValues['financial_type_id']
1209       );
1210     }
1211
1212     // process line items, until no previous line items.
1213     if (!empty($lineItem)) {
1214       $params['lineItems'] = $lineItem;
1215       $params['processPriceSet'] = TRUE;
1216     }
1217     $createdMemberships = [];
1218     if ($this->_mode) {
1219       $params['total_amount'] = CRM_Utils_Array::value('total_amount', $formValues, 0);
1220
1221       //CRM-20264 : Store CC type and number (last 4 digit) during backoffice or online payment
1222       $params['card_type_id'] = $this->_params['card_type_id'] ?? NULL;
1223       $params['pan_truncation'] = $this->_params['pan_truncation'] ?? NULL;
1224
1225       if (!$isQuickConfig) {
1226         $params['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet',
1227           $this->_priceSetId,
1228           'financial_type_id'
1229         );
1230       }
1231       else {
1232         $params['financial_type_id'] = $formValues['financial_type_id'] ?? NULL;
1233       }
1234
1235       //get the payment processor id as per mode. Try removing in favour of beginPostProcess.
1236       $params['payment_processor_id'] = $formValues['payment_processor_id'] = $this->_paymentProcessor['id'];
1237       $params['register_date'] = CRM_Utils_Time::date('YmdHis');
1238
1239       // add all the additional payment params we need
1240       $formValues['amount'] = $params['total_amount'];
1241       $formValues['currencyID'] = $this->getCurrency();
1242       $formValues['description'] = ts("Contribution submitted by a staff person using member's credit card for signup");
1243       $formValues['invoiceID'] = $this->getInvoiceID();
1244       $formValues['financial_type_id'] = $params['financial_type_id'];
1245
1246       // at this point we've created a contact and stored its address etc
1247       // all the payment processors expect the name and address to be in the
1248       // so we copy stuff over to first_name etc.
1249       $paymentParams = $formValues;
1250       $paymentParams['contactID'] = $this->_contributorContactID;
1251       //CRM-10377 if payment is by an alternate contact then we need to set that person
1252       // as the contact in the payment params
1253       if ($this->_contributorContactID != $this->_contactID) {
1254         if (!empty($formValues['soft_credit_type_id'])) {
1255           $softParams['contact_id'] = $params['contact_id'];
1256           $softParams['soft_credit_type_id'] = $formValues['soft_credit_type_id'];
1257         }
1258       }
1259       if ($this->getSubmittedValue('send_receipt')) {
1260         $paymentParams['email'] = $this->_contributorEmail;
1261       }
1262
1263       // This is a candidate for shared beginPostProcess function.
1264       // @todo Do we need this now we have $this->formatParamsForPaymentProcessor() ?
1265       CRM_Core_Payment_Form::mapParams($this->_bltID, $formValues, $paymentParams, TRUE);
1266       // CRM-7137 -for recurring membership,
1267       // we do need contribution and recurring records.
1268       $result = NULL;
1269       if (!empty($paymentParams['is_recur'])) {
1270         $this->_params = $formValues;
1271
1272         $contribution = $this->processContribution(
1273           $paymentParams,
1274           [
1275             'contact_id' => $this->_contributorContactID,
1276             'line_item' => $lineItem,
1277             'is_test' => $this->isTest(),
1278             'campaign_id' => $paymentParams['campaign_id'] ?? NULL,
1279             'source' => CRM_Utils_Array::value('source', $paymentParams, CRM_Utils_Array::value('description', $paymentParams)),
1280             'payment_instrument_id' => $paymentInstrumentID,
1281             'financial_type_id' => $params['financial_type_id'],
1282             'receive_date' => CRM_Utils_Time::date('YmdHis'),
1283             'tax_amount' => $params['tax_amount'] ?? NULL,
1284             'invoice_id' => $this->getInvoiceID(),
1285             'currency' => $this->getCurrency(),
1286             'is_pay_later' => $params['is_pay_later'] ?? 0,
1287             'skipLineItem' => $params['skipLineItem'] ?? 0,
1288           ]
1289         );
1290
1291         //create new soft-credit record, CRM-13981
1292         if ($softParams) {
1293           $softParams['contribution_id'] = $contribution->id;
1294           $softParams['currency'] = $contribution->currency;
1295           $softParams['amount'] = $contribution->total_amount;
1296           CRM_Contribute_BAO_ContributionSoft::add($softParams);
1297         }
1298
1299         $paymentParams['contactID'] = $this->_contactID;
1300         $paymentParams['contributionID'] = $contribution->id;
1301         $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id;
1302         $params['contribution_id'] = $paymentParams['contributionID'];
1303         $params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
1304       }
1305       $paymentStatus = NULL;
1306
1307       if ($params['total_amount'] > 0.0) {
1308         $payment = $this->_paymentProcessor['object'];
1309         try {
1310           $result = $payment->doPayment($paymentParams);
1311           $formValues = array_merge($formValues, $result);
1312           $paymentStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $formValues['payment_status_id']);
1313           // Assign amount to template if payment was successful.
1314           $this->assign('amount', $params['total_amount']);
1315         }
1316         catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
1317           if (!empty($paymentParams['contributionID'])) {
1318             CRM_Contribute_BAO_Contribution::failPayment($paymentParams['contributionID'], $this->_contactID,
1319               $e->getMessage());
1320           }
1321           if (!empty($paymentParams['contributionRecurID'])) {
1322             CRM_Contribute_BAO_ContributionRecur::deleteRecurContribution($paymentParams['contributionRecurID']);
1323           }
1324
1325           CRM_Core_Session::singleton()->setStatus($e->getMessage());
1326           CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view/membership',
1327             "reset=1&action=add&cid={$this->_contactID}&context=membership&mode={$this->_mode}"
1328           ));
1329
1330         }
1331       }
1332
1333       if ($paymentStatus !== 'Completed') {
1334         $params['status_id'] = $pendingMembershipStatusId;
1335         $params['skipStatusCal'] = TRUE;
1336         //as membership is pending set dates to null.
1337         foreach ($this->_memTypeSelected as $memType) {
1338           $membershipTypeValues[$memType]['joinDate'] = NULL;
1339           $membershipTypeValues[$memType]['startDate'] = NULL;
1340           $membershipTypeValues[$memType]['endDate'] = NULL;
1341         }
1342         $endDate = $startDate = NULL;
1343       }
1344       $now = CRM_Utils_Time::date('YmdHis');
1345       $params['receive_date'] = CRM_Utils_Time::date('Y-m-d H:i:s');
1346       $params['invoice_id'] = $this->getInvoiceID();
1347       $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
1348         [1 => $this->getSelectedMembershipLabels(), 2 => $userName]
1349       );
1350       $params['source'] = $formValues['source'] ?: $params['contribution_source'];
1351       $params['trxn_id'] = $result['trxn_id'] ?? NULL;
1352       $params['is_test'] = $this->isTest();
1353       $params['receipt_date'] = NULL;
1354       if ($this->getSubmittedValue('send_receipt') && $paymentStatus === 'Completed') {
1355         // @todo this should be updated by the send function once sent rather than
1356         // set here.
1357         $params['receipt_date'] = $now;
1358       }
1359
1360       $this->set('params', $formValues);
1361       $this->assign('trxn_id', CRM_Utils_Array::value('trxn_id', $result));
1362       $this->assign('receive_date',
1363         CRM_Utils_Date::mysqlToIso($params['receive_date'])
1364       );
1365
1366       // required for creating membership for related contacts
1367       $params['action'] = $this->_action;
1368
1369       //create membership record.
1370       $count = 0;
1371       foreach ($this->_memTypeSelected as $memType) {
1372         if ($count &&
1373           ($relateContribution = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id))
1374         ) {
1375           $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1376         }
1377
1378         $membershipParams = array_merge($membershipTypeValues[$memType], $params);
1379         //CRM-15366
1380         if (!empty($softParams) && empty($paymentParams['is_recur'])) {
1381           $membershipParams['soft_credit'] = $softParams;
1382         }
1383         if (isset($result['fee_amount'])) {
1384           $membershipParams['fee_amount'] = $result['fee_amount'];
1385         }
1386         // This is required to trigger the recording of the membership contribution in the
1387         // CRM_Member_BAO_Membership::Create function.
1388         // @todo stop setting this & 'teach' the create function to respond to something
1389         // appropriate as part of our 2-step always create the pending contribution & then finally add the payment
1390         // process -
1391         // @see http://wiki.civicrm.org/confluence/pages/viewpage.action?pageId=261062657#Payments&AccountsRoadmap-Movetowardsalwaysusinga2-steppaymentprocess
1392         $membershipParams['contribution_status_id'] = $result['payment_status_id'] ?? NULL;
1393         if (!empty($paymentParams['is_recur'])) {
1394           // The earlier process created the line items (although we want to get rid of the earlier one in favour
1395           // of a single path!
1396           unset($membershipParams['lineItems']);
1397         }
1398         $membershipParams['payment_instrument_id'] = $paymentInstrumentID;
1399         // @todo stop passing $ids (membership and userId only are set above)
1400         $membership = CRM_Member_BAO_Membership::create($membershipParams, $ids);
1401         $params['contribution'] = $membershipParams['contribution'] ?? NULL;
1402         unset($params['lineItems']);
1403         $this->_membershipIDs[] = $membership->id;
1404         $createdMemberships[$memType] = $membership;
1405         $count++;
1406       }
1407
1408     }
1409     else {
1410       $params['action'] = $this->_action;
1411       foreach ($lineItem[$this->_priceSetId] as $id => $lineItemValues) {
1412         if (empty($lineItemValues['membership_type_id'])) {
1413           continue;
1414         }
1415
1416         // @todo figure out why recieve_date isn't being set right here.
1417         if (empty($params['receive_date'])) {
1418           $params['receive_date'] = CRM_Utils_Time::date('Y-m-d H:i:s');
1419         }
1420         $membershipParams = array_merge($params, $membershipTypeValues[$lineItemValues['membership_type_id']]);
1421
1422         if (!empty($softParams)) {
1423           $membershipParams['soft_credit'] = $softParams;
1424         }
1425         unset($membershipParams['contribution_status_id']);
1426         $membershipParams['skipLineItem'] = TRUE;
1427         unset($membershipParams['lineItems']);
1428         // @todo stop passing $ids (membership and userId only are set above)
1429         $membership = CRM_Member_BAO_Membership::create($membershipParams, $ids);
1430         $lineItem[$this->_priceSetId][$id]['entity_id'] = $membership->id;
1431         $lineItem[$this->_priceSetId][$id]['entity_table'] = 'civicrm_membership';
1432
1433         $this->_membershipIDs[] = $membership->id;
1434         $createdMemberships[$membership->membership_type_id] = $membership;
1435       }
1436       $params['lineItems'] = $lineItem;
1437       if (!empty($formValues['record_contribution'])) {
1438         CRM_Member_BAO_Membership::recordMembershipContribution($params);
1439       }
1440     }
1441     $isRecur = $params['is_recur'] ?? NULL;
1442     if (($this->_action & CRM_Core_Action::UPDATE)) {
1443       $this->addStatusMessage($this->getStatusMessageForUpdate($membership, $endDate));
1444     }
1445     elseif (($this->_action & CRM_Core_Action::ADD)) {
1446       $this->addStatusMessage($this->getStatusMessageForCreate($endDate, $createdMemberships,
1447         $isRecur, $calcDates));
1448     }
1449
1450     // This would always be true as we always add price set id into both
1451     // quick config & non quick config price sets.
1452     if (!empty($lineItem[$this->_priceSetId])) {
1453       $invoicing = Civi::settings()->get('invoicing');
1454       $taxAmount = FALSE;
1455       $totalTaxAmount = 0;
1456       foreach ($lineItem[$this->_priceSetId] as & $priceFieldOp) {
1457         if (!empty($priceFieldOp['membership_type_id'])) {
1458           $priceFieldOp['start_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date'] ? CRM_Utils_Date::formatDateOnlyLong($membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date']) : '-';
1459           $priceFieldOp['end_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date'] ? CRM_Utils_Date::formatDateOnlyLong($membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date']) : '-';
1460         }
1461         else {
1462           $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1463         }
1464         if ($invoicing && isset($priceFieldOp['tax_amount'])) {
1465           $taxAmount = TRUE;
1466           $totalTaxAmount += $priceFieldOp['tax_amount'];
1467         }
1468       }
1469       if ($invoicing) {
1470         $dataArray = [];
1471         foreach ($lineItem[$this->_priceSetId] as $key => $value) {
1472           if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
1473             if (isset($dataArray[$value['tax_rate']])) {
1474               $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + CRM_Utils_Array::value('tax_amount', $value);
1475             }
1476             else {
1477               $dataArray[$value['tax_rate']] = $value['tax_amount'] ?? NULL;
1478             }
1479           }
1480         }
1481         if ($taxAmount) {
1482           $this->assign('totalTaxAmount', $totalTaxAmount);
1483           // Not sure why would need this on Submit.... unless it's being used when sending mails in which case this is the wrong place
1484           $this->assign('taxTerm', $this->getSalesTaxTerm());
1485         }
1486         $this->assign('dataArray', $dataArray);
1487       }
1488     }
1489     $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ? $lineItem : FALSE);
1490
1491     $receiptSend = FALSE;
1492     $contributionId = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id);
1493     $membershipIds = $this->_membershipIDs;
1494     if ($contributionId && !empty($membershipIds)) {
1495       $contributionDetails = CRM_Contribute_BAO_Contribution::getContributionDetails(
1496         CRM_Export_Form_Select::MEMBER_EXPORT, $this->_membershipIDs);
1497       if ($contributionDetails[$membership->id]['contribution_status'] === 'Completed') {
1498         $receiptSend = TRUE;
1499       }
1500     }
1501
1502     $receiptSent = FALSE;
1503     if ($this->getSubmittedValue('send_receipt') && $receiptSend) {
1504       $formValues['contact_id'] = $this->_contactID;
1505       $formValues['contribution_id'] = $contributionId;
1506       // We really don't need a distinct receipt_text_signup vs receipt_text_renewal as they are
1507       // handled in the receipt. But by setting one we avoid breaking templates for now
1508       // although at some point we should switch in the templates.
1509       $formValues['receipt_text_signup'] = $formValues['receipt_text'];
1510       // send email receipt
1511       $this->assignBillingName();
1512       $mailSend = $this->emailMembershipReceipt($formValues, $membership);
1513       $receiptSent = TRUE;
1514     }
1515
1516     // finally set membership id if already not set
1517     if (!$this->_id) {
1518       $this->_id = $membership->id;
1519     }
1520
1521     $this->updateContributionOnMembershipTypeChange($params, $membership);
1522     if ($receiptSent && $mailSend) {
1523       $this->addStatusMessage(ts('A membership confirmation and receipt has been sent to %1.', [1 => $this->_contributorEmail]));
1524     }
1525
1526     CRM_Core_Session::setStatus($this->getStatusMessage(), ts('Complete'), 'success');
1527     $this->setStatusMessage($membership);
1528   }
1529
1530   /**
1531    * Update related contribution of a membership if update_contribution_on_membership_type_change
1532    *   contribution setting is enabled and type is changed on edit
1533    *
1534    * @param array $inputParams
1535    *      submitted form values
1536    * @param CRM_Member_DAO_Membership $membership
1537    *     Updated membership object
1538    *
1539    * @throws \CRM_Core_Exception
1540    * @throws \CiviCRM_API3_Exception
1541    */
1542   protected function updateContributionOnMembershipTypeChange($inputParams, $membership) {
1543     if (Civi::settings()->get('update_contribution_on_membership_type_change') &&
1544     // on update
1545       ($this->_action & CRM_Core_Action::UPDATE) &&
1546     // if ID is present
1547       $this->_id &&
1548     // if selected membership doesn't match with earlier membership
1549       !in_array($this->_memType, $this->_memTypeSelected)
1550     ) {
1551       if (!empty($inputParams['is_recur'])) {
1552         CRM_Core_Session::setStatus(ts('Associated recurring contribution cannot be updated on membership type change.', ts('Error'), 'error'));
1553         return;
1554       }
1555
1556       // fetch lineitems by updated membership ID
1557       $lineItems = CRM_Price_BAO_LineItem::getLineItems($membership->id, 'membership');
1558       // retrieve the related contribution ID
1559       $contributionID = CRM_Core_DAO::getFieldValue(
1560         'CRM_Member_DAO_MembershipPayment',
1561         $membership->id,
1562         'contribution_id',
1563         'membership_id'
1564       );
1565       // get price fields of chosen price-set
1566       $priceSetDetails = CRM_Utils_Array::value(
1567         $this->_priceSetId,
1568         CRM_Price_BAO_PriceSet::getSetDetail(
1569           $this->_priceSetId,
1570           TRUE,
1571           TRUE
1572         )
1573       );
1574
1575       // add price field information in $inputParams
1576       self::addPriceFieldByMembershipType($inputParams, $priceSetDetails['fields'], $membership->membership_type_id);
1577
1578       // update related contribution and financial records
1579       CRM_Price_BAO_LineItem::changeFeeSelections(
1580         $inputParams,
1581         $membership->id,
1582         'membership',
1583         $contributionID,
1584         $priceSetDetails['fields'],
1585         $lineItems
1586       );
1587       CRM_Core_Session::setStatus(ts('Associated contribution is updated on membership type change.'), ts('Success'), 'success');
1588     }
1589   }
1590
1591   /**
1592    * Add selected price field information in $formValues
1593    *
1594    * @param array $formValues
1595    *      submitted form values
1596    * @param array $priceFields
1597    *     Price fields of selected Priceset ID
1598    * @param int $membershipTypeID
1599    *     Selected membership type ID
1600    *
1601    */
1602   public static function addPriceFieldByMembershipType(&$formValues, $priceFields, $membershipTypeID) {
1603     foreach ($priceFields as $priceFieldID => $priceField) {
1604       if (isset($priceField['options']) && count($priceField['options'])) {
1605         foreach ($priceField['options'] as $option) {
1606           if ($option['membership_type_id'] == $membershipTypeID) {
1607             $formValues["price_{$priceFieldID}"] = $option['id'];
1608             break;
1609           }
1610         }
1611       }
1612     }
1613   }
1614
1615   /**
1616    * Set context in session.
1617    */
1618   protected function setUserContext() {
1619     $buttonName = $this->controller->getButtonName();
1620     $session = CRM_Core_Session::singleton();
1621
1622     if ($buttonName == $this->getButtonName('upload', 'new')) {
1623       if ($this->_context === 'standalone') {
1624         $url = CRM_Utils_System::url('civicrm/member/add',
1625           'reset=1&action=add&context=standalone'
1626         );
1627       }
1628       else {
1629         $url = CRM_Utils_System::url('civicrm/contact/view/membership',
1630           "reset=1&action=add&context=membership&cid={$this->_contactID}"
1631         );
1632       }
1633     }
1634     else {
1635       $url = CRM_Utils_System::url('civicrm/contact/view',
1636         "reset=1&cid={$this->_contactID}&selectedChild=member"
1637       );
1638     }
1639     $session->replaceUserContext($url);
1640   }
1641
1642   /**
1643    * Get status message for updating membership.
1644    *
1645    * @param CRM_Member_BAO_Membership $membership
1646    * @param string $endDate
1647    *
1648    * @return string
1649    */
1650   protected function getStatusMessageForUpdate($membership, $endDate) {
1651     // End date can be modified by hooks, so if end date is set then use it.
1652     $endDate = ($membership->end_date) ? $membership->end_date : $endDate;
1653
1654     $statusMsg = ts('Membership for %1 has been updated.', [1 => $this->_memberDisplayName]);
1655     if ($endDate && $endDate !== 'null') {
1656       $endDate = CRM_Utils_Date::customFormat($endDate);
1657       $statusMsg .= ' ' . ts('The membership End Date is %1.', [1 => $endDate]);
1658     }
1659     return $statusMsg;
1660   }
1661
1662   /**
1663    * Get status message for create action.
1664    *
1665    * @param string $endDate
1666    * @param array $createdMemberships
1667    * @param bool $isRecur
1668    * @param array $calcDates
1669    *
1670    * @return array|string
1671    */
1672   protected function getStatusMessageForCreate($endDate, $createdMemberships,
1673                                                $isRecur, $calcDates) {
1674     // FIX ME: fix status messages
1675
1676     $statusMsg = [];
1677     foreach ($this->_memTypeSelected as $membershipTypeID) {
1678       $statusMsg[$membershipTypeID] = ts('%1 membership for %2 has been added.', [
1679         1 => $this->allMembershipTypeDetails[$membershipTypeID]['name'],
1680         2 => $this->_memberDisplayName,
1681       ]);
1682
1683       $membership = $createdMemberships[$membershipTypeID];
1684       $memEndDate = $membership->end_date ?: $endDate;
1685
1686       //get the end date from calculated dates.
1687       if (!$memEndDate && !$isRecur) {
1688         $memEndDate = $calcDates[$membershipTypeID]['end_date'] ?? NULL;
1689       }
1690
1691       if ($memEndDate && $memEndDate !== 'null') {
1692         $memEndDate = CRM_Utils_Date::formatDateOnlyLong($memEndDate);
1693         $statusMsg[$membershipTypeID] .= ' ' . ts('The new membership End Date is %1.', [1 => $memEndDate]);
1694       }
1695     }
1696     $statusMsg = implode('<br/>', $statusMsg);
1697     return $statusMsg;
1698   }
1699
1700   /**
1701    * @param $membership
1702    */
1703   protected function setStatusMessage($membership) {
1704     //CRM-15187
1705     // display message when membership type is changed
1706     if (($this->_action & CRM_Core_Action::UPDATE) && $this->_id && !in_array($this->_memType, $this->_memTypeSelected)) {
1707       $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->_id, 'membership');
1708       $maxID = max(array_keys($lineItem));
1709       $lineItem = $lineItem[$maxID];
1710       $membershipTypeDetails = $this->allMembershipTypeDetails[$membership->membership_type_id];
1711       if ($membershipTypeDetails['financial_type_id'] != $lineItem['financial_type_id']) {
1712         CRM_Core_Session::setStatus(
1713           ts('The financial types associated with the old and new membership types are different. You may want to edit the contribution associated with this membership to adjust its financial type.'),
1714           ts('Warning')
1715         );
1716       }
1717       if ($membershipTypeDetails['minimum_fee'] != $lineItem['line_total']) {
1718         CRM_Core_Session::setStatus(
1719           ts('The cost of the old and new membership types are different. You may want to edit the contribution associated with this membership to adjust its amount.'),
1720           ts('Warning')
1721         );
1722       }
1723     }
1724   }
1725
1726   /**
1727    * @return bool
1728    * @throws \CRM_Core_Exception
1729    */
1730   protected function isUpdateToExistingRecurringMembership() {
1731     $isRecur = FALSE;
1732     if ($this->_action & CRM_Core_Action::UPDATE
1733       && CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->getEntityId(),
1734         'contribution_recur_id')
1735       && !CRM_Member_BAO_Membership::isSubscriptionCancelled($this->getEntityId())) {
1736
1737       $isRecur = TRUE;
1738     }
1739     return $isRecur;
1740   }
1741
1742   /**
1743    * Send a receipt for the membership.
1744    *
1745    * @param array $formValues
1746    * @param \CRM_Member_BAO_Membership $membership
1747    *
1748    * @return bool
1749    * @throws \CRM_Core_Exception
1750    */
1751   protected function emailMembershipReceipt($formValues, $membership) {
1752     $customValues = $this->getCustomValuesForReceipt($formValues, $membership);
1753     $this->assign('customValues', $customValues);
1754
1755     if ($this->_mode) {
1756       // @todo move this outside shared code as Batch entry just doesn't
1757       $this->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters(
1758         $this->_params,
1759         $this->_bltID
1760       ));
1761
1762       $valuesForForm = CRM_Contribute_Form_AbstractEditPayment::formatCreditCardDetails($this->_params);
1763       $this->assignVariables($valuesForForm, ['credit_card_exp_date', 'credit_card_type', 'credit_card_number']);
1764       $this->assign('is_pay_later', 0);
1765       $this->assign('isPrimary', 1);
1766     }
1767     return self::emailReceipt($this, $formValues, $membership);
1768   }
1769
1770   /**
1771    * Filter the custom values from the input parameters (for display in the email).
1772    *
1773    * @todo figure out why the scary code this calls does & document.
1774    *
1775    * @param array $formValues
1776    * @param \CRM_Member_BAO_Membership $membership
1777    * @return array
1778    */
1779   protected function getCustomValuesForReceipt($formValues, $membership) {
1780     $customFields = $customValues = [];
1781     if (property_exists($this, '_groupTree')
1782       && !empty($this->_groupTree)
1783     ) {
1784       foreach ($this->_groupTree as $groupID => $group) {
1785         if ($groupID === 'info') {
1786           continue;
1787         }
1788         foreach ($group['fields'] as $k => $field) {
1789           $field['title'] = $field['label'];
1790           $customFields["custom_{$k}"] = $field;
1791         }
1792       }
1793     }
1794
1795     $members = [['member_id', '=', $membership->id, 0, 0]];
1796     // check whether its a test drive
1797     if ($this->_mode === 'test') {
1798       $members[] = ['member_test', '=', 1, 0, 0];
1799     }
1800
1801     CRM_Core_BAO_UFGroup::getValues($formValues['contact_id'], $customFields, $customValues, FALSE, $members);
1802     return $customValues;
1803   }
1804
1805   /**
1806    * Get the selected memberships as a string of labels.
1807    *
1808    * @return string
1809    */
1810   protected function getSelectedMembershipLabels(): string {
1811     $return = [];
1812     foreach ($this->_memTypeSelected as $membershipTypeID) {
1813       $return[] = $this->allMembershipTypeDetails[$membershipTypeID]['name'];
1814     }
1815     return implode(', ', $return);
1816   }
1817
1818   /**
1819    * Legacy contribution processing function.
1820    *
1821    * This is copied from a shared function in order to clean it up. Most of the
1822    * stuff in it, maybe all except the ContributionRecur create is
1823    * not applicable to this form & can be removed in follow up cleanup.
1824    *
1825    * It's like the contribution create being done here is actively bad and
1826    * being fixed later.
1827    *
1828    * @param array $params
1829    * @param array $contributionParams
1830    *   Parameters to be passed to contribution create action.
1831    *   This differs from params in that we are currently adding params to it and 1) ensuring they are being
1832    *   passed consistently & 2) documenting them here.
1833    *   - contact_id
1834    *   - line_item
1835    *   - is_test
1836    *   - campaign_id
1837    *   - source
1838    *   - payment_type_id
1839    *
1840    * @return \CRM_Contribute_DAO_Contribution
1841    *
1842    * @throws \CRM_Core_Exception
1843    * @throws \CiviCRM_API3_Exception
1844    */
1845   protected function processContribution(
1846     $params,
1847     $contributionParams
1848   ) {
1849     $form = $this;
1850     $transaction = new CRM_Core_Transaction();
1851     $contactID = $contributionParams['contact_id'];
1852
1853     // add these values for the recurringContrib function ,CRM-10188
1854     $params['financial_type_id'] = $contributionParams['financial_type_id'];
1855
1856     $params['is_email_receipt'] = (bool) $this->getSubmittedValue('send_receipt');
1857     $params['is_recur'] = TRUE;
1858     $params['payment_instrument_id'] = $contributionParams['payment_instrument_id'] ?? NULL;
1859     $recurringContributionID = $this->legacyProcessRecurringContribution($params, $contactID);
1860
1861     $now = CRM_Utils_Time::date('YmdHis');
1862     $receiptDate = $params['receipt_date'] ?? NULL;
1863     if ($params['is_email_receipt']) {
1864       $receiptDate = $now;
1865     }
1866
1867     if ($this->getSubmittedValue('send_receipt')) {
1868       $contributionParams += [
1869         'receipt_date' => $receiptDate,
1870       ];
1871     }
1872
1873     if ($recurringContributionID) {
1874       $contributionParams['contribution_recur_id'] = $recurringContributionID;
1875     }
1876
1877     $contributionParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
1878
1879     // @todo this is the wrong place for this - it should be done as close to form submission
1880     // as possible
1881     $contributionParams['total_amount'] = $params['amount'];
1882     $contribution = CRM_Contribute_BAO_Contribution::add($contributionParams);
1883
1884     // lets store it in the form variable so postProcess hook can get to this and use it
1885     $form->_contributionID = $contribution->id;
1886
1887     $transaction->commit();
1888     return $contribution;
1889   }
1890
1891   /**
1892    * Create the recurring contribution record.
1893    *
1894    * This function was copied from another form & needs cleanup.
1895    *
1896    * @param array $params
1897    * @param int $contactID
1898    *
1899    * @return int
1900    */
1901   protected function legacyProcessRecurringContribution(array $params, $contactID): int {
1902
1903     $recurParams = ['contact_id' => $contactID];
1904     $recurParams['amount'] = $params['amount'] ?? NULL;
1905     $recurParams['auto_renew'] = $params['auto_renew'] ?? NULL;
1906     $recurParams['frequency_unit'] = $params['frequency_unit'] ?? NULL;
1907     $recurParams['frequency_interval'] = $params['frequency_interval'] ?? NULL;
1908     $recurParams['installments'] = $params['installments'] ?? NULL;
1909     $recurParams['financial_type_id'] = $params['financial_type_id'];
1910     $recurParams['currency'] = $params['currency'] ?? NULL;
1911     $recurParams['payment_instrument_id'] = $params['payment_instrument_id'];
1912
1913     $recurParams['is_test'] = $this->isTest();
1914
1915     $recurParams['start_date'] = $recurParams['create_date'] = $recurParams['modified_date'] = CRM_Utils_Time::date('YmdHis');
1916     if (!empty($params['receive_date'])) {
1917       $recurParams['start_date'] = date('YmdHis', CRM_Utils_Time::strtotime($params['receive_date']));
1918     }
1919     $recurParams['invoice_id'] = $this->getInvoiceID();
1920     $recurParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
1921     $recurParams['payment_processor_id'] = $params['payment_processor_id'] ?? NULL;
1922     $recurParams['is_email_receipt'] = (bool) $this->getSubmittedValue('send_receipt');
1923     // we need to add a unique trxn_id to avoid a unique key error
1924     // in paypal IPN we reset this when paypal sends us the real trxn id, CRM-2991
1925     $recurParams['trxn_id'] = $params['trxn_id'] ?? $this->getInvoiceID();
1926
1927     $campaignId = $params['campaign_id'] ?? $this->_values['campaign_id'] ?? NULL;
1928     $recurParams['campaign_id'] = $campaignId;
1929     return CRM_Contribute_BAO_ContributionRecur::add($recurParams)->id;
1930   }
1931
1932   /**
1933    * Is the form being submitted in test mode.
1934    *
1935    * @return bool
1936    */
1937   protected function isTest(): int {
1938     return ($this->_mode === 'test') ? TRUE : FALSE;
1939   }
1940
1941 }