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     if ($form->_mode) {
 921       // @todo move this outside shared code as Batch entry just doesn't
 922       $form->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters(
 923         $form->_params,
 924         $form->_bltID
 925       ));
 926
 927       $valuesForForm = CRM_Contribute_Form_AbstractEditPayment::formatCreditCardDetails($form->_params);
 928       $form->assignVariables($valuesForForm, ['credit_card_exp_date', 'credit_card_type', 'credit_card_number']);
 929       $form->assign('is_pay_later', 0);
 930       $form->assign('isPrimary', 1);
 931     }
 932
 933     $form->assign('module', 'Membership');
 934     $form->assign('contactID', $formValues['contact_id']);
 935
 936     $form->assign('membershipID', CRM_Utils_Array::value('membership_id', $form->_params, CRM_Utils_Array::value('membership_id', $form->_defaultValues)));
 937
 938     if (!empty($formValues['contribution_id'])) {
 939       $form->assign('contributionID', $formValues['contribution_id']);
 940     }
 941
 942     if (!empty($formValues['contribution_status_id'])) {
 943       $form->assign('contributionStatusID', $formValues['contribution_status_id']);
 944       $form->assign('contributionStatus', CRM_Contribute_PseudoConstant::contributionStatus($formValues['contribution_status_id'], 'name'));
 945     }
 946
 947     if (!empty($formValues['is_renew'])) {
 948       $form->assign('receiptType', 'membership renewal');
 949     }
 950     else {
 951       $form->assign('receiptType', 'membership signup');
 952     }
 953     $form->assign('receive_date', CRM_Utils_Array::value('receive_date', $formValues));
 954     $form->assign('formValues', $formValues);
 955
 956     $form->assign('mem_start_date', CRM_Utils_Date::formatDateOnlyLong($membership->start_date));
 957     if (!CRM_Utils_System::isNull($membership->end_date)) {
 958       $form->assign('mem_end_date', CRM_Utils_Date::formatDateOnlyLong($membership->end_date));
 959     }
 960     $form->assign('membership_name', CRM_Member_PseudoConstant::membershipType($membership->membership_type_id));
 961
 962     // @todo - if we have to figure out if this is for batch processing it doesn't belong in the shared function.
 963     $isBatchProcess = is_a($form, 'CRM_Batch_Form_Entry');
 964     if ((empty($form->_contributorDisplayName) || empty($form->_contributorEmail)) || $isBatchProcess) {
 965       // in this case the form is being called statically from the batch editing screen
 966       // having one class in the form layer call another statically is not greate
 967       // & we should aim to move this function to the BAO layer in future.
 968       // however, we can assume that the contact_id passed in by the batch
 969       // function will be the recipient
 970       [$form->_contributorDisplayName, $form->_contributorEmail]
 971         = CRM_Contact_BAO_Contact_Location::getEmailDetails($formValues['contact_id']);
 972       if (empty($form->_receiptContactId) || $isBatchProcess) {
 973         $form->_receiptContactId = $formValues['contact_id'];
 974       }
 975     }
 976
 977     CRM_Core_BAO_MessageTemplate::sendTemplate(
 978       [
 979         'groupName' => 'msg_tpl_workflow_membership',
 980         'valueName' => 'membership_offline_receipt',
 981         'contactId' => $form->_receiptContactId,
 982         'from' => $receiptFrom,
 983         'toName' => $form->_contributorDisplayName,
 984         'toEmail' => $form->_contributorEmail,
 985         'PDFFilename' => ts('receipt') . '.pdf',
 986         'isEmailPdf' => Civi::settings()->get('invoicing') && Civi::settings()->get('is_email_pdf'),
 987         'contributionId' => $formValues['contribution_id'],
 988         'isTest' => (bool) ($form->_action & CRM_Core_Action::PREVIEW),
 989       ]
 990     );
 991
 992     return TRUE;
 993   }
 994
 995   /**
 996    * Submit function.
 997    *
 998    * This is also accessed by unit tests.
 999    *
1000    * @throws \CRM_Core_Exception
1001    * @throws \CiviCRM_API3_Exception
1002    */
1003   public function submit(): void {
1004     $this->storeContactFields($this->_params);
1005     $this->beginPostProcess();
1006     $endDate = NULL;
1007     $membership = $calcDate = [];
1008
1009     $paymentInstrumentID = $this->_paymentProcessor['object']->getPaymentInstrumentID();
1010     $params = $softParams = $ids = [];
1011
1012     $mailSend = FALSE;
1013     $this->processBillingAddress();
1014     $formValues = $this->_params;
1015     $formValues = $this->setPriceSetParameters($formValues);
1016
1017     if ($this->_id) {
1018       $ids['membership'] = $params['id'] = $this->_id;
1019     }
1020
1021     // Set variables that we normally get from context.
1022     // In form mode these are set in preProcess.
1023     //TODO: set memberships, fixme
1024     $this->setContextVariables($formValues);
1025
1026     $this->_memTypeSelected = self::getSelectedMemberships(
1027       $this->_priceSet,
1028       $formValues
1029     );
1030     if (empty($formValues['financial_type_id'])) {
1031       $formValues['financial_type_id'] = $this->_priceSet['financial_type_id'];
1032     }
1033
1034     $membershipTypeValues = [];
1035     foreach ($this->_memTypeSelected as $memType) {
1036       $membershipTypeValues[$memType]['membership_type_id'] = $memType;
1037     }
1038
1039     //take the required membership recur values.
1040     if ($this->_mode && !empty($formValues['auto_renew'])) {
1041       $params['is_recur'] = $formValues['is_recur'] = TRUE;
1042
1043       $count = 0;
1044       foreach ($this->_memTypeSelected as $memType) {
1045         $recurMembershipTypeValues = CRM_Utils_Array::value($memType,
1046           $this->allMembershipTypeDetails, []
1047         );
1048         if (!$recurMembershipTypeValues['auto_renew']) {
1049           continue;
1050         }
1051         foreach ([
1052           'frequency_interval' => 'duration_interval',
1053           'frequency_unit' => 'duration_unit',
1054         ] as $mapVal => $mapParam) {
1055           $membershipTypeValues[$memType][$mapVal] = $recurMembershipTypeValues[$mapParam];
1056
1057           if (!$count) {
1058             $formValues[$mapVal] = CRM_Utils_Array::value($mapParam,
1059               $recurMembershipTypeValues
1060             );
1061           }
1062         }
1063         $count++;
1064       }
1065     }
1066
1067     $isQuickConfig = $this->_priceSet['is_quick_config'];
1068
1069     $termsByType = [];
1070
1071     $lineItem = [$this->_priceSetId => []];
1072
1073     // BEGIN Fix for dev/core/issues/860
1074     // Prepare fee block and call buildAmount hook - based on CRM_Price_BAO_PriceSet::buildPriceSet().
1075     CRM_Utils_Hook::buildAmount('membership', $this, $this->_priceSet['fields']);
1076     // END Fix for dev/core/issues/860
1077
1078     CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'],
1079       $formValues, $lineItem[$this->_priceSetId], $this->_priceSetId);
1080
1081     if (!empty($formValues['tax_amount'])) {
1082       $params['tax_amount'] = $formValues['tax_amount'];
1083     }
1084     $params['total_amount'] = $formValues['amount'] ?? NULL;
1085     if (!empty($lineItem[$this->_priceSetId])) {
1086       foreach ($lineItem[$this->_priceSetId] as &$li) {
1087         if (!empty($li['membership_type_id'])) {
1088           if (!empty($li['membership_num_terms'])) {
1089             $termsByType[$li['membership_type_id']] = $li['membership_num_terms'];
1090           }
1091         }
1092
1093         ///CRM-11529 for quick config backoffice transactions
1094         //when financial_type_id is passed in form, update the
1095         //lineitems with the financial type selected in form
1096         $submittedFinancialType = $formValues['financial_type_id'] ?? NULL;
1097         if ($isQuickConfig && $submittedFinancialType) {
1098           $li['financial_type_id'] = $submittedFinancialType;
1099         }
1100       }
1101     }
1102
1103     $params['contact_id'] = $this->_contactID;
1104
1105     $fields = [
1106       'status_id',
1107       'source',
1108       'is_override',
1109       'status_override_end_date',
1110       'campaign_id',
1111     ];
1112
1113     foreach ($fields as $f) {
1114       $params[$f] = $formValues[$f] ?? NULL;
1115     }
1116
1117     // fix for CRM-3724
1118     // when is_override false ignore is_admin statuses during membership
1119     // status calculation. similarly we did fix for import in CRM-3570.
1120     if (empty($params['is_override'])) {
1121       $params['exclude_is_admin'] = TRUE;
1122     }
1123
1124     $joinDate = $formValues['join_date'];
1125     $startDate = $formValues['start_date'];
1126     $endDate = $formValues['end_date'];
1127
1128     $memTypeNumTerms = empty($termsByType) ? CRM_Utils_Array::value('num_terms', $formValues) : NULL;
1129
1130     $calcDates = [];
1131     foreach ($this->_memTypeSelected as $memType) {
1132       if (empty($memTypeNumTerms)) {
1133         $memTypeNumTerms = CRM_Utils_Array::value($memType, $termsByType, 1);
1134       }
1135       $calcDates[$memType] = CRM_Member_BAO_MembershipType::getDatesForMembershipType($memType,
1136         $joinDate, $startDate, $endDate, $memTypeNumTerms
1137       );
1138     }
1139
1140     foreach ($calcDates as $memType => $calcDate) {
1141       foreach (['join_date', 'start_date', 'end_date'] as $d) {
1142         //first give priority to form values then calDates.
1143         $date = $formValues[$d] ?? NULL;
1144         if (!$date) {
1145           $date = $calcDate[$d] ?? NULL;
1146         }
1147
1148         $membershipTypeValues[$memType][$d] = CRM_Utils_Date::processDate($date);
1149       }
1150     }
1151
1152     foreach ($this->_memTypeSelected as $memType) {
1153       if (array_key_exists('max_related', $formValues)) {
1154         // max related memberships - take from form or inherit from membership type
1155         $membershipTypeValues[$memType]['max_related'] = $formValues['max_related'] ?? NULL;
1156       }
1157       $membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField::postProcess($formValues,
1158         $this->_id,
1159         'Membership'
1160       );
1161     }
1162
1163     // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1164     [$userName] = CRM_Contact_BAO_Contact_Location::getEmailDetails(CRM_Core_Session::getLoggedInContactID());
1165
1166     //CRM-13981, allow different person as a soft-contributor of chosen type
1167     if ($this->_contributorContactID != $this->_contactID) {
1168       $params['contribution_contact_id'] = $this->_contributorContactID;
1169       if (!empty($formValues['soft_credit_type_id'])) {
1170         $softParams['soft_credit_type_id'] = $formValues['soft_credit_type_id'];
1171         $softParams['contact_id'] = $this->_contactID;
1172       }
1173     }
1174
1175     $pendingMembershipStatusId = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending');
1176
1177     if (!empty($formValues['record_contribution'])) {
1178       $recordContribution = [
1179         'total_amount',
1180         'financial_type_id',
1181         'payment_instrument_id',
1182         'trxn_id',
1183         'contribution_status_id',
1184         'check_number',
1185         'campaign_id',
1186         'receive_date',
1187         'card_type_id',
1188         'pan_truncation',
1189       ];
1190
1191       foreach ($recordContribution as $f) {
1192         $params[$f] = $formValues[$f] ?? NULL;
1193       }
1194
1195       if (empty($formValues['source'])) {
1196         $params['contribution_source'] = ts('%1 Membership: Offline signup (by %2)', [
1197           1 => $this->getSelectedMembershipLabels(),
1198           2 => $userName,
1199         ]);
1200       }
1201       else {
1202         $params['contribution_source'] = $formValues['source'];
1203       }
1204
1205       $completedContributionStatusId = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
1206       if (empty($params['is_override']) &&
1207         CRM_Utils_Array::value('contribution_status_id', $params) != $completedContributionStatusId
1208       ) {
1209         $params['status_id'] = $pendingMembershipStatusId;
1210         $params['skipStatusCal'] = TRUE;
1211         $params['is_pay_later'] = 1;
1212         $this->assign('is_pay_later', 1);
1213       }
1214
1215       if ($this->getSubmittedValue('send_receipt')) {
1216         $params['receipt_date'] = $formValues['receive_date'] ?? NULL;
1217       }
1218
1219       //insert financial type name in receipt.
1220       $formValues['contributionType_name'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialType',
1221         $formValues['financial_type_id']
1222       );
1223     }
1224
1225     // process line items, until no previous line items.
1226     if (!empty($lineItem)) {
1227       $params['lineItems'] = $lineItem;
1228       $params['processPriceSet'] = TRUE;
1229     }
1230     $createdMemberships = [];
1231     if ($this->_mode) {
1232       $params['total_amount'] = CRM_Utils_Array::value('total_amount', $formValues, 0);
1233
1234       //CRM-20264 : Store CC type and number (last 4 digit) during backoffice or online payment
1235       $params['card_type_id'] = $this->_params['card_type_id'] ?? NULL;
1236       $params['pan_truncation'] = $this->_params['pan_truncation'] ?? NULL;
1237
1238       if (!$isQuickConfig) {
1239         $params['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet',
1240           $this->_priceSetId,
1241           'financial_type_id'
1242         );
1243       }
1244       else {
1245         $params['financial_type_id'] = $formValues['financial_type_id'] ?? NULL;
1246       }
1247
1248       //get the payment processor id as per mode. Try removing in favour of beginPostProcess.
1249       $params['payment_processor_id'] = $formValues['payment_processor_id'] = $this->_paymentProcessor['id'];
1250       $params['register_date'] = CRM_Utils_Time::date('YmdHis');
1251
1252       // add all the additional payment params we need
1253       $formValues['amount'] = $params['total_amount'];
1254       $formValues['currencyID'] = $this->getCurrency();
1255       $formValues['description'] = ts("Contribution submitted by a staff person using member's credit card for signup");
1256       $formValues['invoiceID'] = $this->getInvoiceID();
1257       $formValues['financial_type_id'] = $params['financial_type_id'];
1258
1259       // at this point we've created a contact and stored its address etc
1260       // all the payment processors expect the name and address to be in the
1261       // so we copy stuff over to first_name etc.
1262       $paymentParams = $formValues;
1263       $paymentParams['contactID'] = $this->_contributorContactID;
1264       //CRM-10377 if payment is by an alternate contact then we need to set that person
1265       // as the contact in the payment params
1266       if ($this->_contributorContactID != $this->_contactID) {
1267         if (!empty($formValues['soft_credit_type_id'])) {
1268           $softParams['contact_id'] = $params['contact_id'];
1269           $softParams['soft_credit_type_id'] = $formValues['soft_credit_type_id'];
1270         }
1271       }
1272       if ($this->getSubmittedValue('send_receipt')) {
1273         $paymentParams['email'] = $this->_contributorEmail;
1274       }
1275
1276       // This is a candidate for shared beginPostProcess function.
1277       // @todo Do we need this now we have $this->formatParamsForPaymentProcessor() ?
1278       CRM_Core_Payment_Form::mapParams($this->_bltID, $formValues, $paymentParams, TRUE);
1279       // CRM-7137 -for recurring membership,
1280       // we do need contribution and recurring records.
1281       $result = NULL;
1282       if (!empty($paymentParams['is_recur'])) {
1283         $this->_params = $formValues;
1284
1285         $contribution = $this->processContribution(
1286           $paymentParams,
1287           [
1288             'contact_id' => $this->_contributorContactID,
1289             'line_item' => $lineItem,
1290             'is_test' => $this->isTest(),
1291             'campaign_id' => $paymentParams['campaign_id'] ?? NULL,
1292             'source' => CRM_Utils_Array::value('source', $paymentParams, CRM_Utils_Array::value('description', $paymentParams)),
1293             'payment_instrument_id' => $paymentInstrumentID,
1294             'financial_type_id' => $params['financial_type_id'],
1295             'receive_date' => CRM_Utils_Time::date('YmdHis'),
1296             'tax_amount' => $params['tax_amount'] ?? NULL,
1297             'invoice_id' => $this->getInvoiceID(),
1298             'currency' => $this->getCurrency(),
1299             'is_pay_later' => $params['is_pay_later'] ?? 0,
1300             'skipLineItem' => $params['skipLineItem'] ?? 0,
1301           ]
1302         );
1303
1304         //create new soft-credit record, CRM-13981
1305         if ($softParams) {
1306           $softParams['contribution_id'] = $contribution->id;
1307           $softParams['currency'] = $contribution->currency;
1308           $softParams['amount'] = $contribution->total_amount;
1309           CRM_Contribute_BAO_ContributionSoft::add($softParams);
1310         }
1311
1312         $paymentParams['contactID'] = $this->_contactID;
1313         $paymentParams['contributionID'] = $contribution->id;
1314         $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id;
1315         $params['contribution_id'] = $paymentParams['contributionID'];
1316         $params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
1317       }
1318       $paymentStatus = NULL;
1319
1320       if ($params['total_amount'] > 0.0) {
1321         $payment = $this->_paymentProcessor['object'];
1322         try {
1323           $result = $payment->doPayment($paymentParams);
1324           $formValues = array_merge($formValues, $result);
1325           $paymentStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $formValues['payment_status_id']);
1326           // Assign amount to template if payment was successful.
1327           $this->assign('amount', $params['total_amount']);
1328         }
1329         catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
1330           if (!empty($paymentParams['contributionID'])) {
1331             CRM_Contribute_BAO_Contribution::failPayment($paymentParams['contributionID'], $this->_contactID,
1332               $e->getMessage());
1333           }
1334           if (!empty($paymentParams['contributionRecurID'])) {
1335             CRM_Contribute_BAO_ContributionRecur::deleteRecurContribution($paymentParams['contributionRecurID']);
1336           }
1337
1338           CRM_Core_Session::singleton()->setStatus($e->getMessage());
1339           CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view/membership',
1340             "reset=1&action=add&cid={$this->_contactID}&context=membership&mode={$this->_mode}"
1341           ));
1342
1343         }
1344       }
1345
1346       if ($paymentStatus !== 'Completed') {
1347         $params['status_id'] = $pendingMembershipStatusId;
1348         $params['skipStatusCal'] = TRUE;
1349         //as membership is pending set dates to null.
1350         foreach ($this->_memTypeSelected as $memType) {
1351           $membershipTypeValues[$memType]['joinDate'] = NULL;
1352           $membershipTypeValues[$memType]['startDate'] = NULL;
1353           $membershipTypeValues[$memType]['endDate'] = NULL;
1354         }
1355         $endDate = $startDate = NULL;
1356       }
1357       $now = CRM_Utils_Time::date('YmdHis');
1358       $params['receive_date'] = CRM_Utils_Time::date('Y-m-d H:i:s');
1359       $params['invoice_id'] = $this->getInvoiceID();
1360       $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
1361         [1 => $this->getSelectedMembershipLabels(), 2 => $userName]
1362       );
1363       $params['source'] = $formValues['source'] ?: $params['contribution_source'];
1364       $params['trxn_id'] = $result['trxn_id'] ?? NULL;
1365       $params['is_test'] = $this->isTest();
1366       $params['receipt_date'] = NULL;
1367       if ($this->getSubmittedValue('send_receipt') && $paymentStatus === 'Completed') {
1368         // @todo this should be updated by the send function once sent rather than
1369         // set here.
1370         $params['receipt_date'] = $now;
1371       }
1372
1373       $this->set('params', $formValues);
1374       $this->assign('trxn_id', CRM_Utils_Array::value('trxn_id', $result));
1375       $this->assign('receive_date',
1376         CRM_Utils_Date::mysqlToIso($params['receive_date'])
1377       );
1378
1379       // required for creating membership for related contacts
1380       $params['action'] = $this->_action;
1381
1382       //create membership record.
1383       $count = 0;
1384       foreach ($this->_memTypeSelected as $memType) {
1385         if ($count &&
1386           ($relateContribution = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id))
1387         ) {
1388           $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1389         }
1390
1391         $membershipParams = array_merge($membershipTypeValues[$memType], $params);
1392         //CRM-15366
1393         if (!empty($softParams) && empty($paymentParams['is_recur'])) {
1394           $membershipParams['soft_credit'] = $softParams;
1395         }
1396         if (isset($result['fee_amount'])) {
1397           $membershipParams['fee_amount'] = $result['fee_amount'];
1398         }
1399         // This is required to trigger the recording of the membership contribution in the
1400         // CRM_Member_BAO_Membership::Create function.
1401         // @todo stop setting this & 'teach' the create function to respond to something
1402         // appropriate as part of our 2-step always create the pending contribution & then finally add the payment
1403         // process -
1404         // @see http://wiki.civicrm.org/confluence/pages/viewpage.action?pageId=261062657#Payments&AccountsRoadmap-Movetowardsalwaysusinga2-steppaymentprocess
1405         $membershipParams['contribution_status_id'] = $result['payment_status_id'] ?? NULL;
1406         if (!empty($paymentParams['is_recur'])) {
1407           // The earlier process created the line items (although we want to get rid of the earlier one in favour
1408           // of a single path!
1409           unset($membershipParams['lineItems']);
1410         }
1411         $membershipParams['payment_instrument_id'] = $paymentInstrumentID;
1412         // @todo stop passing $ids (membership and userId only are set above)
1413         $membership = CRM_Member_BAO_Membership::create($membershipParams, $ids);
1414         $params['contribution'] = $membershipParams['contribution'] ?? NULL;
1415         unset($params['lineItems']);
1416         $this->_membershipIDs[] = $membership->id;
1417         $createdMemberships[$memType] = $membership;
1418         $count++;
1419       }
1420
1421     }
1422     else {
1423       $params['action'] = $this->_action;
1424       foreach ($lineItem[$this->_priceSetId] as $id => $lineItemValues) {
1425         if (empty($lineItemValues['membership_type_id'])) {
1426           continue;
1427         }
1428
1429         // @todo figure out why recieve_date isn't being set right here.
1430         if (empty($params['receive_date'])) {
1431           $params['receive_date'] = CRM_Utils_Time::date('Y-m-d H:i:s');
1432         }
1433         $membershipParams = array_merge($params, $membershipTypeValues[$lineItemValues['membership_type_id']]);
1434
1435         if (!empty($softParams)) {
1436           $membershipParams['soft_credit'] = $softParams;
1437         }
1438         unset($membershipParams['contribution_status_id']);
1439         $membershipParams['skipLineItem'] = TRUE;
1440         unset($membershipParams['lineItems']);
1441         // @todo stop passing $ids (membership and userId only are set above)
1442         $membership = CRM_Member_BAO_Membership::create($membershipParams, $ids);
1443         $lineItem[$this->_priceSetId][$id]['entity_id'] = $membership->id;
1444         $lineItem[$this->_priceSetId][$id]['entity_table'] = 'civicrm_membership';
1445
1446         $this->_membershipIDs[] = $membership->id;
1447         $createdMemberships[$membership->membership_type_id] = $membership;
1448       }
1449       $params['lineItems'] = $lineItem;
1450       if (!empty($formValues['record_contribution'])) {
1451         CRM_Member_BAO_Membership::recordMembershipContribution($params);
1452       }
1453     }
1454     $isRecur = $params['is_recur'] ?? NULL;
1455     if (($this->_action & CRM_Core_Action::UPDATE)) {
1456       $this->addStatusMessage($this->getStatusMessageForUpdate($membership, $endDate));
1457     }
1458     elseif (($this->_action & CRM_Core_Action::ADD)) {
1459       $this->addStatusMessage($this->getStatusMessageForCreate($endDate, $createdMemberships,
1460         $isRecur, $calcDates));
1461     }
1462
1463     // This would always be true as we always add price set id into both
1464     // quick config & non quick config price sets.
1465     if (!empty($lineItem[$this->_priceSetId])) {
1466       $invoicing = Civi::settings()->get('invoicing');
1467       $taxAmount = FALSE;
1468       $totalTaxAmount = 0;
1469       foreach ($lineItem[$this->_priceSetId] as & $priceFieldOp) {
1470         if (!empty($priceFieldOp['membership_type_id'])) {
1471           $priceFieldOp['start_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date'] ? CRM_Utils_Date::formatDateOnlyLong($membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date']) : '-';
1472           $priceFieldOp['end_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date'] ? CRM_Utils_Date::formatDateOnlyLong($membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date']) : '-';
1473         }
1474         else {
1475           $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1476         }
1477         if ($invoicing && isset($priceFieldOp['tax_amount'])) {
1478           $taxAmount = TRUE;
1479           $totalTaxAmount += $priceFieldOp['tax_amount'];
1480         }
1481       }
1482       if ($invoicing) {
1483         $dataArray = [];
1484         foreach ($lineItem[$this->_priceSetId] as $key => $value) {
1485           if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
1486             if (isset($dataArray[$value['tax_rate']])) {
1487               $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + CRM_Utils_Array::value('tax_amount', $value);
1488             }
1489             else {
1490               $dataArray[$value['tax_rate']] = $value['tax_amount'] ?? NULL;
1491             }
1492           }
1493         }
1494         if ($taxAmount) {
1495           $this->assign('totalTaxAmount', $totalTaxAmount);
1496           // Not sure why would need this on Submit.... unless it's being used when sending mails in which case this is the wrong place
1497           $this->assign('taxTerm', $this->getSalesTaxTerm());
1498         }
1499         $this->assign('dataArray', $dataArray);
1500       }
1501     }
1502     $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ? $lineItem : FALSE);
1503
1504     $receiptSend = FALSE;
1505     $contributionId = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id);
1506     $membershipIds = $this->_membershipIDs;
1507     if ($contributionId && !empty($membershipIds)) {
1508       $contributionDetails = CRM_Contribute_BAO_Contribution::getContributionDetails(
1509         CRM_Export_Form_Select::MEMBER_EXPORT, $this->_membershipIDs);
1510       if ($contributionDetails[$membership->id]['contribution_status'] === 'Completed') {
1511         $receiptSend = TRUE;
1512       }
1513     }
1514
1515     $receiptSent = FALSE;
1516     if ($this->getSubmittedValue('send_receipt') && $receiptSend) {
1517       $formValues['contact_id'] = $this->_contactID;
1518       $formValues['contribution_id'] = $contributionId;
1519       // We really don't need a distinct receipt_text_signup vs receipt_text_renewal as they are
1520       // handled in the receipt. But by setting one we avoid breaking templates for now
1521       // although at some point we should switch in the templates.
1522       $formValues['receipt_text_signup'] = $formValues['receipt_text'];
1523       // send email receipt
1524       $this->assignBillingName();
1525       $mailSend = $this->emailMembershipReceipt($formValues, $membership);
1526       $receiptSent = TRUE;
1527     }
1528
1529     // finally set membership id if already not set
1530     if (!$this->_id) {
1531       $this->_id = $membership->id;
1532     }
1533
1534     $this->updateContributionOnMembershipTypeChange($params, $membership);
1535     if ($receiptSent && $mailSend) {
1536       $this->addStatusMessage(ts('A membership confirmation and receipt has been sent to %1.', [1 => $this->_contributorEmail]));
1537     }
1538
1539     CRM_Core_Session::setStatus($this->getStatusMessage(), ts('Complete'), 'success');
1540     $this->setStatusMessage($membership);
1541   }
1542
1543   /**
1544    * Update related contribution of a membership if update_contribution_on_membership_type_change
1545    *   contribution setting is enabled and type is changed on edit
1546    *
1547    * @param array $inputParams
1548    *      submitted form values
1549    * @param CRM_Member_DAO_Membership $membership
1550    *     Updated membership object
1551    *
1552    * @throws \CRM_Core_Exception
1553    * @throws \CiviCRM_API3_Exception
1554    */
1555   protected function updateContributionOnMembershipTypeChange($inputParams, $membership) {
1556     if (Civi::settings()->get('update_contribution_on_membership_type_change') &&
1557     // on update
1558       ($this->_action & CRM_Core_Action::UPDATE) &&
1559     // if ID is present
1560       $this->_id &&
1561     // if selected membership doesn't match with earlier membership
1562       !in_array($this->_memType, $this->_memTypeSelected)
1563     ) {
1564       if (!empty($inputParams['is_recur'])) {
1565         CRM_Core_Session::setStatus(ts('Associated recurring contribution cannot be updated on membership type change.', ts('Error'), 'error'));
1566         return;
1567       }
1568
1569       // fetch lineitems by updated membership ID
1570       $lineItems = CRM_Price_BAO_LineItem::getLineItems($membership->id, 'membership');
1571       // retrieve the related contribution ID
1572       $contributionID = CRM_Core_DAO::getFieldValue(
1573         'CRM_Member_DAO_MembershipPayment',
1574         $membership->id,
1575         'contribution_id',
1576         'membership_id'
1577       );
1578       // get price fields of chosen price-set
1579       $priceSetDetails = CRM_Utils_Array::value(
1580         $this->_priceSetId,
1581         CRM_Price_BAO_PriceSet::getSetDetail(
1582           $this->_priceSetId,
1583           TRUE,
1584           TRUE
1585         )
1586       );
1587
1588       // add price field information in $inputParams
1589       self::addPriceFieldByMembershipType($inputParams, $priceSetDetails['fields'], $membership->membership_type_id);
1590
1591       // update related contribution and financial records
1592       CRM_Price_BAO_LineItem::changeFeeSelections(
1593         $inputParams,
1594         $membership->id,
1595         'membership',
1596         $contributionID,
1597         $priceSetDetails['fields'],
1598         $lineItems
1599       );
1600       CRM_Core_Session::setStatus(ts('Associated contribution is updated on membership type change.'), ts('Success'), 'success');
1601     }
1602   }
1603
1604   /**
1605    * Add selected price field information in $formValues
1606    *
1607    * @param array $formValues
1608    *      submitted form values
1609    * @param array $priceFields
1610    *     Price fields of selected Priceset ID
1611    * @param int $membershipTypeID
1612    *     Selected membership type ID
1613    *
1614    */
1615   public static function addPriceFieldByMembershipType(&$formValues, $priceFields, $membershipTypeID) {
1616     foreach ($priceFields as $priceFieldID => $priceField) {
1617       if (isset($priceField['options']) && count($priceField['options'])) {
1618         foreach ($priceField['options'] as $option) {
1619           if ($option['membership_type_id'] == $membershipTypeID) {
1620             $formValues["price_{$priceFieldID}"] = $option['id'];
1621             break;
1622           }
1623         }
1624       }
1625     }
1626   }
1627
1628   /**
1629    * Set context in session.
1630    */
1631   protected function setUserContext() {
1632     $buttonName = $this->controller->getButtonName();
1633     $session = CRM_Core_Session::singleton();
1634
1635     if ($buttonName == $this->getButtonName('upload', 'new')) {
1636       if ($this->_context === 'standalone') {
1637         $url = CRM_Utils_System::url('civicrm/member/add',
1638           'reset=1&action=add&context=standalone'
1639         );
1640       }
1641       else {
1642         $url = CRM_Utils_System::url('civicrm/contact/view/membership',
1643           "reset=1&action=add&context=membership&cid={$this->_contactID}"
1644         );
1645       }
1646     }
1647     else {
1648       $url = CRM_Utils_System::url('civicrm/contact/view',
1649         "reset=1&cid={$this->_contactID}&selectedChild=member"
1650       );
1651     }
1652     $session->replaceUserContext($url);
1653   }
1654
1655   /**
1656    * Get status message for updating membership.
1657    *
1658    * @param CRM_Member_BAO_Membership $membership
1659    * @param string $endDate
1660    *
1661    * @return string
1662    */
1663   protected function getStatusMessageForUpdate($membership, $endDate) {
1664     // End date can be modified by hooks, so if end date is set then use it.
1665     $endDate = ($membership->end_date) ? $membership->end_date : $endDate;
1666
1667     $statusMsg = ts('Membership for %1 has been updated.', [1 => $this->_memberDisplayName]);
1668     if ($endDate && $endDate !== 'null') {
1669       $endDate = CRM_Utils_Date::customFormat($endDate);
1670       $statusMsg .= ' ' . ts('The membership End Date is %1.', [1 => $endDate]);
1671     }
1672     return $statusMsg;
1673   }
1674
1675   /**
1676    * Get status message for create action.
1677    *
1678    * @param string $endDate
1679    * @param array $createdMemberships
1680    * @param bool $isRecur
1681    * @param array $calcDates
1682    *
1683    * @return array|string
1684    */
1685   protected function getStatusMessageForCreate($endDate, $createdMemberships,
1686                                                $isRecur, $calcDates) {
1687     // FIX ME: fix status messages
1688
1689     $statusMsg = [];
1690     foreach ($this->_memTypeSelected as $membershipTypeID) {
1691       $statusMsg[$membershipTypeID] = ts('%1 membership for %2 has been added.', [
1692         1 => $this->allMembershipTypeDetails[$membershipTypeID]['name'],
1693         2 => $this->_memberDisplayName,
1694       ]);
1695
1696       $membership = $createdMemberships[$membershipTypeID];
1697       $memEndDate = $membership->end_date ?: $endDate;
1698
1699       //get the end date from calculated dates.
1700       if (!$memEndDate && !$isRecur) {
1701         $memEndDate = $calcDates[$membershipTypeID]['end_date'] ?? NULL;
1702       }
1703
1704       if ($memEndDate && $memEndDate !== 'null') {
1705         $memEndDate = CRM_Utils_Date::formatDateOnlyLong($memEndDate);
1706         $statusMsg[$membershipTypeID] .= ' ' . ts('The new membership End Date is %1.', [1 => $memEndDate]);
1707       }
1708     }
1709     $statusMsg = implode('<br/>', $statusMsg);
1710     return $statusMsg;
1711   }
1712
1713   /**
1714    * @param $membership
1715    */
1716   protected function setStatusMessage($membership) {
1717     //CRM-15187
1718     // display message when membership type is changed
1719     if (($this->_action & CRM_Core_Action::UPDATE) && $this->_id && !in_array($this->_memType, $this->_memTypeSelected)) {
1720       $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->_id, 'membership');
1721       $maxID = max(array_keys($lineItem));
1722       $lineItem = $lineItem[$maxID];
1723       $membershipTypeDetails = $this->allMembershipTypeDetails[$membership->membership_type_id];
1724       if ($membershipTypeDetails['financial_type_id'] != $lineItem['financial_type_id']) {
1725         CRM_Core_Session::setStatus(
1726           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.'),
1727           ts('Warning')
1728         );
1729       }
1730       if ($membershipTypeDetails['minimum_fee'] != $lineItem['line_total']) {
1731         CRM_Core_Session::setStatus(
1732           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.'),
1733           ts('Warning')
1734         );
1735       }
1736     }
1737   }
1738
1739   /**
1740    * @return bool
1741    * @throws \CRM_Core_Exception
1742    */
1743   protected function isUpdateToExistingRecurringMembership() {
1744     $isRecur = FALSE;
1745     if ($this->_action & CRM_Core_Action::UPDATE
1746       && CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->getEntityId(),
1747         'contribution_recur_id')
1748       && !CRM_Member_BAO_Membership::isSubscriptionCancelled($this->getEntityId())) {
1749
1750       $isRecur = TRUE;
1751     }
1752     return $isRecur;
1753   }
1754
1755   /**
1756    * Send a receipt for the membership.
1757    *
1758    * @param array $formValues
1759    * @param \CRM_Member_BAO_Membership $membership
1760    *
1761    * @return bool
1762    * @throws \CRM_Core_Exception
1763    */
1764   protected function emailMembershipReceipt($formValues, $membership) {
1765     $customValues = $this->getCustomValuesForReceipt($formValues, $membership);
1766     $this->assign('customValues', $customValues);
1767
1768     return self::emailReceipt($this, $formValues, $membership);
1769   }
1770
1771   /**
1772    * Filter the custom values from the input parameters (for display in the email).
1773    *
1774    * @todo figure out why the scary code this calls does & document.
1775    *
1776    * @param array $formValues
1777    * @param \CRM_Member_BAO_Membership $membership
1778    * @return array
1779    */
1780   protected function getCustomValuesForReceipt($formValues, $membership) {
1781     $customFields = $customValues = [];
1782     if (property_exists($this, '_groupTree')
1783       && !empty($this->_groupTree)
1784     ) {
1785       foreach ($this->_groupTree as $groupID => $group) {
1786         if ($groupID === 'info') {
1787           continue;
1788         }
1789         foreach ($group['fields'] as $k => $field) {
1790           $field['title'] = $field['label'];
1791           $customFields["custom_{$k}"] = $field;
1792         }
1793       }
1794     }
1795
1796     $members = [['member_id', '=', $membership->id, 0, 0]];
1797     // check whether its a test drive
1798     if ($this->_mode === 'test') {
1799       $members[] = ['member_test', '=', 1, 0, 0];
1800     }
1801
1802     CRM_Core_BAO_UFGroup::getValues($formValues['contact_id'], $customFields, $customValues, FALSE, $members);
1803     return $customValues;
1804   }
1805
1806   /**
1807    * Get the selected memberships as a string of labels.
1808    *
1809    * @return string
1810    */
1811   protected function getSelectedMembershipLabels(): string {
1812     $return = [];
1813     foreach ($this->_memTypeSelected as $membershipTypeID) {
1814       $return[] = $this->allMembershipTypeDetails[$membershipTypeID]['name'];
1815     }
1816     return implode(', ', $return);
1817   }
1818
1819   /**
1820    * Legacy contribution processing function.
1821    *
1822    * This is copied from a shared function in order to clean it up. Most of the
1823    * stuff in it, maybe all except the ContributionRecur create is
1824    * not applicable to this form & can be removed in follow up cleanup.
1825    *
1826    * It's like the contribution create being done here is actively bad and
1827    * being fixed later.
1828    *
1829    * @param array $params
1830    * @param array $contributionParams
1831    *   Parameters to be passed to contribution create action.
1832    *   This differs from params in that we are currently adding params to it and 1) ensuring they are being
1833    *   passed consistently & 2) documenting them here.
1834    *   - contact_id
1835    *   - line_item
1836    *   - is_test
1837    *   - campaign_id
1838    *   - source
1839    *   - payment_type_id
1840    *
1841    * @return \CRM_Contribute_DAO_Contribution
1842    *
1843    * @throws \CRM_Core_Exception
1844    * @throws \CiviCRM_API3_Exception
1845    */
1846   protected function processContribution(
1847     $params,
1848     $contributionParams
1849   ) {
1850     $form = $this;
1851     $transaction = new CRM_Core_Transaction();
1852     $contactID = $contributionParams['contact_id'];
1853
1854     // add these values for the recurringContrib function ,CRM-10188
1855     $params['financial_type_id'] = $contributionParams['financial_type_id'];
1856
1857     $params['is_email_receipt'] = (bool) $this->getSubmittedValue('send_receipt');
1858     $params['is_recur'] = TRUE;
1859     $params['payment_instrument_id'] = $contributionParams['payment_instrument_id'] ?? NULL;
1860     $recurringContributionID = $this->legacyProcessRecurringContribution($params, $contactID);
1861
1862     $now = CRM_Utils_Time::date('YmdHis');
1863     $receiptDate = $params['receipt_date'] ?? NULL;
1864     if ($params['is_email_receipt']) {
1865       $receiptDate = $now;
1866     }
1867
1868     if ($this->getSubmittedValue('send_receipt')) {
1869       $contributionParams += [
1870         'receipt_date' => $receiptDate,
1871       ];
1872     }
1873
1874     if ($recurringContributionID) {
1875       $contributionParams['contribution_recur_id'] = $recurringContributionID;
1876     }
1877
1878     $contributionParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
1879
1880     // @todo this is the wrong place for this - it should be done as close to form submission
1881     // as possible
1882     $contributionParams['total_amount'] = $params['amount'];
1883     $contribution = CRM_Contribute_BAO_Contribution::add($contributionParams);
1884
1885     // lets store it in the form variable so postProcess hook can get to this and use it
1886     $form->_contributionID = $contribution->id;
1887
1888     $transaction->commit();
1889     return $contribution;
1890   }
1891
1892   /**
1893    * Create the recurring contribution record.
1894    *
1895    * This function was copied from another form & needs cleanup.
1896    *
1897    * @param array $params
1898    * @param int $contactID
1899    *
1900    * @return int
1901    */
1902   protected function legacyProcessRecurringContribution(array $params, $contactID): int {
1903
1904     $recurParams = ['contact_id' => $contactID];
1905     $recurParams['amount'] = $params['amount'] ?? NULL;
1906     $recurParams['auto_renew'] = $params['auto_renew'] ?? NULL;
1907     $recurParams['frequency_unit'] = $params['frequency_unit'] ?? NULL;
1908     $recurParams['frequency_interval'] = $params['frequency_interval'] ?? NULL;
1909     $recurParams['installments'] = $params['installments'] ?? NULL;
1910     $recurParams['financial_type_id'] = $params['financial_type_id'];
1911     $recurParams['currency'] = $params['currency'] ?? NULL;
1912     $recurParams['payment_instrument_id'] = $params['payment_instrument_id'];
1913
1914     $recurParams['is_test'] = $this->isTest();
1915
1916     $recurParams['start_date'] = $recurParams['create_date'] = $recurParams['modified_date'] = CRM_Utils_Time::date('YmdHis');
1917     if (!empty($params['receive_date'])) {
1918       $recurParams['start_date'] = date('YmdHis', CRM_Utils_Time::strtotime($params['receive_date']));
1919     }
1920     $recurParams['invoice_id'] = $this->getInvoiceID();
1921     $recurParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
1922     $recurParams['payment_processor_id'] = $params['payment_processor_id'] ?? NULL;
1923     $recurParams['is_email_receipt'] = (bool) $this->getSubmittedValue('send_receipt');
1924     // we need to add a unique trxn_id to avoid a unique key error
1925     // in paypal IPN we reset this when paypal sends us the real trxn id, CRM-2991
1926     $recurParams['trxn_id'] = $params['trxn_id'] ?? $this->getInvoiceID();
1927
1928     $campaignId = $params['campaign_id'] ?? $this->_values['campaign_id'] ?? NULL;
1929     $recurParams['campaign_id'] = $campaignId;
1930     return CRM_Contribute_BAO_ContributionRecur::add($recurParams)->id;
1931   }
1932
1933   /**
1934    * Is the form being submitted in test mode.
1935    *
1936    * @return bool
1937    */
1938   protected function isTest(): int {
1939     return ($this->_mode === 'test') ? TRUE : FALSE;
1940   }
1941
1942 }