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'] = 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'] = 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       //CRM-18827 - override the default value if total_amount is submitted
 483       if (!empty($this->_submitValues['total_amount'])) {
 484         $totalAmount = CRM_Utils_Rule::cleanMoney($this->_submitValues['total_amount']);
 485       }
 486       // build membership info array, which is used when membership type is selected to:
 487       // - set the payment information block
 488       // - set the max related block
 489       $allMembershipInfo[$key] = [
 490         'financial_type_id' => $values['financial_type_id'] ?? NULL,
 491         'total_amount' => CRM_Utils_Money::format($totalAmount, NULL, '%a'),
 492         'total_amount_numeric' => $totalAmount,
 493         'auto_renew' => $values['auto_renew'] ?? NULL,
 494         'has_related' => isset($values['relationship_type_id']),
 495         'max_related' => $values['max_related'] ?? NULL,
 496       ];
 497     }
 498
 499     $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
 500
 501     // show organization by default, if only one organization in
 502     // the list
 503     if (count($selMemTypeOrg) == 2) {
 504       unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
 505     }
 506     //sort membership organization and type, CRM-6099
 507     natcasesort($selMemTypeOrg);
 508     foreach ($selOrgMemType as $index => $orgMembershipType) {
 509       natcasesort($orgMembershipType);
 510       $selOrgMemType[$index] = $orgMembershipType;
 511     }
 512
 513     $memTypeJs = [
 514       'onChange' => "buildMaxRelated(this.value,true); CRM.buildCustomData('Membership', this.value);",
 515     ];
 516
 517     if (!empty($this->_recurPaymentProcessors)) {
 518       $memTypeJs['onChange'] = "" . $memTypeJs['onChange'] . " buildAutoRenew(this.value, null, '{$this->_mode}');";
 519     }
 520
 521     $this->add('text', 'max_related', ts('Max related'),
 522       CRM_Core_DAO::getAttribute('CRM_Member_DAO_Membership', 'max_related')
 523     );
 524
 525     $sel = &$this->addElement('hierselect',
 526       'membership_type_id',
 527       ts('Membership Organization and Type'),
 528       $memTypeJs
 529     );
 530
 531     $sel->setOptions([$selMemTypeOrg, $selOrgMemType]);
 532
 533     if ($this->_action & CRM_Core_Action::ADD) {
 534       $this->add('number', 'num_terms', ts('Number of Terms'), ['size' => 6]);
 535     }
 536
 537     $this->add('text', 'source', ts('Source'),
 538       CRM_Core_DAO::getAttribute('CRM_Member_DAO_Membership', 'source')
 539     );
 540
 541     //CRM-7362 --add campaigns.
 542     $campaignId = NULL;
 543     if ($this->_id) {
 544       $campaignId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'campaign_id');
 545     }
 546     CRM_Campaign_BAO_Campaign::addCampaign($this, $campaignId);
 547
 548     if (!$this->_mode) {
 549       $this->add('select', 'status_id', ts('Membership Status'),
 550         ['' => ts('- select -')] + CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label')
 551       );
 552
 553       $statusOverride = $this->addElement('select', 'is_override', ts('Status Override?'),
 554         CRM_Member_StatusOverrideTypes::getSelectOptions()
 555       );
 556
 557       $this->add('datepicker', 'status_override_end_date', ts('Status Override End Date'), '', FALSE, ['minDate' => date('Y-m-d'), 'time' => FALSE]);
 558
 559       $this->addElement('checkbox', 'record_contribution', ts('Record Membership Payment?'));
 560
 561       $this->add('text', 'total_amount', ts('Amount'));
 562       $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
 563
 564       $this->add('datepicker', 'receive_date', ts('Received'), [], FALSE, ['time' => TRUE]);
 565
 566       $this->add('select', 'payment_instrument_id',
 567         ts('Payment Method'),
 568         ['' => ts('- select -')] + CRM_Contribute_PseudoConstant::paymentInstrument(),
 569         FALSE, ['onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);"]
 570       );
 571       $this->add('text', 'trxn_id', ts('Transaction ID'));
 572       $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
 573         'objectExists', [
 574           'CRM_Contribute_DAO_Contribution',
 575           $this->_id,
 576           'trxn_id',
 577         ]
 578       );
 579
 580       $this->add('select', 'contribution_status_id',
 581         ts('Payment Status'), CRM_Contribute_BAO_Contribution_Utils::getContributionStatuses('membership')
 582       );
 583       $this->add('text', 'check_number', ts('Check Number'),
 584         CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
 585       );
 586     }
 587     else {
 588       //add field for amount to allow an amount to be entered that differs from minimum
 589       $this->add('text', 'total_amount', ts('Amount'));
 590     }
 591     $this->add('select', 'financial_type_id',
 592       ts('Financial Type'),
 593       ['' => ts('- select -')] + CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes, $this->_action)
 594     );
 595
 596     $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different Contact?'));
 597
 598     $this->addSelect('soft_credit_type_id', ['entity' => 'contribution_soft']);
 599     $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), ['create' => TRUE]);
 600
 601     $this->addElement('checkbox',
 602       'send_receipt',
 603       ts('Send Confirmation and Receipt?'), NULL,
 604       ['onclick' => "showEmailOptions()"]
 605     );
 606
 607     $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails);
 608
 609     $this->add('textarea', 'receipt_text', ts('Receipt Message'));
 610
 611     // Retrieve the name and email of the contact - this will be the TO for receipt email
 612     if ($this->_contactID) {
 613       [$this->_memberDisplayName, $this->_memberEmail] = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 614
 615       $this->assign('emailExists', $this->_memberEmail);
 616       $this->assign('displayName', $this->_memberDisplayName);
 617     }
 618
 619     if ($isUpdateToExistingRecurringMembership && CRM_Member_BAO_Membership::isCancelSubscriptionSupported($this->_id)) {
 620       $this->assign('cancelAutoRenew',
 621         CRM_Utils_System::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
 622       );
 623     }
 624
 625     $this->assign('isRecur', $isUpdateToExistingRecurringMembership);
 626
 627     $this->addFormRule(['CRM_Member_Form_Membership', 'formRule'], $this);
 628     $mailingInfo = Civi::settings()->get('mailing_backend');
 629     $this->assign('isEmailEnabledForSite', ($mailingInfo['outBound_option'] != 2));
 630
 631     parent::buildQuickForm();
 632   }
 633
 634   /**
 635    * Validation.
 636    *
 637    * @param array $params
 638    *   (ref.) an assoc array of name/value pairs.
 639    *
 640    * @param array $files
 641    * @param CRM_Member_Form_Membership $self
 642    *
 643    * @return bool|array
 644    *   mixed true or array of errors
 645    *
 646    * @throws \CRM_Core_Exception
 647    * @throws CiviCRM_API3_Exception
 648    */
 649   public static function formRule($params, $files, $self) {
 650     $errors = [];
 651
 652     $priceSetId = $self->getPriceSetID($params);
 653     $priceSetDetails = $self->getPriceSetDetails($params);
 654
 655     $selectedMemberships = self::getSelectedMemberships($priceSetDetails[$priceSetId], $params);
 656
 657     if (!empty($params['price_set_id'])) {
 658       CRM_Price_BAO_PriceField::priceSetValidation($priceSetId, $params, $errors);
 659
 660       $priceFieldIDS = self::getPriceFieldIDs($params, $priceSetDetails[$priceSetId]);
 661
 662       if (!empty($priceFieldIDS)) {
 663         $ids = implode(',', $priceFieldIDS);
 664
 665         $count = CRM_Price_BAO_PriceSet::getMembershipCount($ids);
 666         foreach ($count as $occurrence) {
 667           if ($occurrence > 1) {
 668             $errors['_qf_default'] = ts('Select at most one option associated with the same membership type.');
 669           }
 670         }
 671       }
 672       // Return error if empty $self->_memTypeSelected
 673       if (empty($errors) && empty($selectedMemberships)) {
 674         $errors['_qf_default'] = ts('Select at least one membership option.');
 675       }
 676       if (!$self->_mode && empty($params['record_contribution'])) {
 677         $errors['record_contribution'] = ts('Record Membership Payment is required when you use a price set.');
 678       }
 679     }
 680     else {
 681       if (empty($params['membership_type_id'][1])) {
 682         $errors['membership_type_id'] = ts('Please select a membership type.');
 683       }
 684       $numterms = $params['num_terms'] ?? NULL;
 685       if ($numterms && intval($numterms) != $numterms) {
 686         $errors['num_terms'] = ts('Please enter an integer for the number of terms.');
 687       }
 688
 689       if (($self->_mode || isset($params['record_contribution'])) && empty($params['financial_type_id'])) {
 690         $errors['financial_type_id'] = ts('Please enter the financial Type.');
 691       }
 692     }
 693
 694     if (!empty($errors) && (count($selectedMemberships) > 1)) {
 695       $memberOfContacts = CRM_Member_BAO_MembershipType::getMemberOfContactByMemTypes($selectedMemberships);
 696       $duplicateMemberOfContacts = array_count_values($memberOfContacts);
 697       foreach ($duplicateMemberOfContacts as $countDuplicate) {
 698         if ($countDuplicate > 1) {
 699           $errors['_qf_default'] = ts('Please do not select more than one membership associated with the same organization.');
 700         }
 701       }
 702     }
 703
 704     if (!empty($errors)) {
 705       return $errors;
 706     }
 707
 708     if (!empty($params['record_contribution']) && empty($params['payment_instrument_id'])) {
 709       $errors['payment_instrument_id'] = ts('Payment Method is a required field.');
 710     }
 711
 712     if (!empty($params['is_different_contribution_contact'])) {
 713       if (empty($params['soft_credit_type_id'])) {
 714         $errors['soft_credit_type_id'] = ts('Please Select a Soft Credit Type');
 715       }
 716       if (empty($params['soft_credit_contact_id'])) {
 717         $errors['soft_credit_contact_id'] = ts('Please select a contact');
 718       }
 719     }
 720
 721     if (!empty($params['payment_processor_id'])) {
 722       // validate payment instrument (e.g. credit card number)
 723       CRM_Core_Payment_Form::validatePaymentInstrument($params['payment_processor_id'], $params, $errors, NULL);
 724     }
 725
 726     $joinDate = NULL;
 727     if (!empty($params['join_date'])) {
 728
 729       $joinDate = CRM_Utils_Date::processDate($params['join_date']);
 730
 731       foreach ($selectedMemberships as $memType) {
 732         $startDate = NULL;
 733         if (!empty($params['start_date'])) {
 734           $startDate = CRM_Utils_Date::processDate($params['start_date']);
 735         }
 736
 737         // if end date is set, ensure that start date is also set
 738         // and that end date is later than start date
 739         $endDate = NULL;
 740         if (!empty($params['end_date'])) {
 741           $endDate = CRM_Utils_Date::processDate($params['end_date']);
 742         }
 743
 744         $membershipDetails = CRM_Member_BAO_MembershipType::getMembershipType($memType);
 745         if ($startDate && CRM_Utils_Array::value('period_type', $membershipDetails) === 'rolling') {
 746           if ($startDate < $joinDate) {
 747             $errors['start_date'] = ts('Start date must be the same or later than Member since.');
 748           }
 749         }
 750
 751         if ($endDate) {
 752           if ($membershipDetails['duration_unit'] === 'lifetime') {
 753             // Check if status is NOT cancelled or similar. For lifetime memberships, there is no automated
 754             // process to update status based on end-date. The user must change the status now.
 755             $result = civicrm_api3('MembershipStatus', 'get', [
 756               'sequential' => 1,
 757               'is_current_member' => 0,
 758             ]);
 759             $tmp_statuses = $result['values'];
 760             $status_ids = [];
 761             foreach ($tmp_statuses as $cur_stat) {
 762               $status_ids[] = $cur_stat['id'];
 763             }
 764
 765             if (empty($params['status_id']) || in_array($params['status_id'], $status_ids) == FALSE) {
 766               $errors['status_id'] = ts('Please enter a status that does NOT represent a current membership status.');
 767             }
 768
 769             if (!empty($params['is_override']) && !CRM_Member_StatusOverrideTypes::isPermanent($params['is_override'])) {
 770               $errors['is_override'] = ts('Because you set an End Date for a lifetime membership, This must be set to "Override Permanently"');
 771             }
 772           }
 773           else {
 774             if (!$startDate) {
 775               $errors['start_date'] = ts('Start date must be set if end date is set.');
 776             }
 777             if ($endDate < $startDate) {
 778               $errors['end_date'] = ts('End date must be the same or later than start date.');
 779             }
 780           }
 781         }
 782
 783         // Default values for start and end dates if not supplied on the form.
 784         $defaultDates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($memType,
 785           $joinDate,
 786           $startDate,
 787           $endDate
 788         );
 789
 790         if (!$startDate) {
 791           $startDate = CRM_Utils_Array::value('start_date',
 792             $defaultDates
 793           );
 794         }
 795         if (!$endDate) {
 796           $endDate = CRM_Utils_Array::value('end_date',
 797             $defaultDates
 798           );
 799         }
 800
 801         //CRM-3724, check for availability of valid membership status.
 802         if ((empty($params['is_override']) || CRM_Member_StatusOverrideTypes::isNo($params['is_override'])) && !isset($errors['_qf_default'])) {
 803           $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($startDate,
 804             $endDate,
 805             $joinDate,
 806             'now',
 807             TRUE,
 808             $memType,
 809             $params
 810           );
 811           if (empty($calcStatus)) {
 812             $url = CRM_Utils_System::url('civicrm/admin/member/membershipStatus', 'reset=1&action=browse');
 813             $errors['_qf_default'] = ts('There is no valid Membership Status available for selected membership dates.');
 814             $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]);
 815             if (!$self->_mode) {
 816               $status .= ' ' . ts('OR You can sign up by setting Status Override? to something other than "NO".');
 817             }
 818             CRM_Core_Session::setStatus($status, ts('Membership Status Error'), 'error');
 819           }
 820         }
 821       }
 822     }
 823     else {
 824       $errors['join_date'] = ts('Please enter the Member Since.');
 825     }
 826
 827     if (!empty($params['is_override']) && CRM_Member_StatusOverrideTypes::isOverridden($params['is_override']) && empty($params['status_id'])) {
 828       $errors['status_id'] = ts('Please enter the Membership status.');
 829     }
 830
 831     if (!empty($params['is_override']) && CRM_Member_StatusOverrideTypes::isUntilDate($params['is_override'])) {
 832       if (empty($params['status_override_end_date'])) {
 833         $errors['status_override_end_date'] = ts('Please enter the Membership override end date.');
 834       }
 835     }
 836
 837     //total amount condition arise when membership type having no
 838     //minimum fee
 839     if (isset($params['record_contribution'])) {
 840       if (CRM_Utils_System::isNull($params['total_amount'])) {
 841         $errors['total_amount'] = ts('Please enter the contribution.');
 842       }
 843     }
 844
 845     return empty($errors) ? TRUE : $errors;
 846   }
 847
 848   /**
 849    * Process the form submission.
 850    *
 851    * @throws \CRM_Core_Exception
 852    * @throws \CiviCRM_API3_Exception
 853    */
 854   public function postProcess() {
 855     if ($this->_action & CRM_Core_Action::DELETE) {
 856       CRM_Member_BAO_Membership::del($this->_id);
 857       return;
 858     }
 859     // get the submitted form values.
 860     $this->_params = $this->controller->exportValues($this->_name);
 861     $this->prepareStatusOverrideValues();
 862
 863     $this->submit();
 864
 865     $this->setUserContext();
 866   }
 867
 868   /**
 869    * Prepares the values related to status override.
 870    */
 871   private function prepareStatusOverrideValues() {
 872     $this->setOverrideDateValue();
 873     $this->convertIsOverrideValue();
 874   }
 875
 876   /**
 877    * Sets status override end date to empty value if
 878    * the selected override option is not 'until date'.
 879    */
 880   private function setOverrideDateValue() {
 881     if (!CRM_Member_StatusOverrideTypes::isUntilDate(CRM_Utils_Array::value('is_override', $this->_params))) {
 882       $this->_params['status_override_end_date'] = '';
 883     }
 884   }
 885
 886   /**
 887    * Convert the value of selected (status override?)
 888    * option to TRUE if it indicate an overridden status
 889    * or FALSE otherwise.
 890    */
 891   private function convertIsOverrideValue() {
 892     $this->_params['is_override'] = CRM_Member_StatusOverrideTypes::isOverridden($this->_params['is_override'] ?? CRM_Member_StatusOverrideTypes::NO);
 893   }
 894
 895   /**
 896    * Send email receipt.
 897    *
 898    * @param CRM_Core_Form $form
 899    *   Form object.
 900    * @param array $formValues
 901    * @param object $membership
 902    *   Object.
 903    * @param array $customValues
 904    *
 905    * @return bool
 906    *   true if mail was sent successfully
 907    * @throws \CRM_Core_Exception
 908    *
 909    * @deprecated
 910    *   This function is shared with Batch_Entry which has limited overlap
 911    *   & needs rationalising.
 912    *
 913    */
 914   public static function emailReceipt(&$form, &$formValues, &$membership, $customValues = NULL) {
 915     // retrieve 'from email id' for acknowledgement
 916     $receiptFrom = $formValues['from_email_address'] ?? NULL;
 917
 918     // @todo figure out how much of the stuff below is genuinely shared with the batch form & a logical shared place.
 919     if (!empty($formValues['payment_instrument_id'])) {
 920       $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
 921       $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
 922     }
 923
 924     $form->assign('customValues', $customValues);
 925
 926     if ($form->_mode) {
 927       // @todo move this outside shared code as Batch entry just doesn't
 928       $form->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters(
 929         $form->_params,
 930         $form->_bltID
 931       ));
 932
 933       $valuesForForm = CRM_Contribute_Form_AbstractEditPayment::formatCreditCardDetails($form->_params);
 934       $form->assignVariables($valuesForForm, ['credit_card_exp_date', 'credit_card_type', 'credit_card_number']);
 935
 936       $form->assign('contributeMode', 'direct');
 937       $form->assign('isAmountzero', 0);
 938       $form->assign('is_pay_later', 0);
 939       $form->assign('isPrimary', 1);
 940     }
 941
 942     $form->assign('module', 'Membership');
 943     $form->assign('contactID', $formValues['contact_id']);
 944
 945     $form->assign('membershipID', CRM_Utils_Array::value('membership_id', $form->_params, CRM_Utils_Array::value('membership_id', $form->_defaultValues)));
 946
 947     if (!empty($formValues['contribution_id'])) {
 948       $form->assign('contributionID', $formValues['contribution_id']);
 949     }
 950
 951     if (!empty($formValues['contribution_status_id'])) {
 952       $form->assign('contributionStatusID', $formValues['contribution_status_id']);
 953       $form->assign('contributionStatus', CRM_Contribute_PseudoConstant::contributionStatus($formValues['contribution_status_id'], 'name'));
 954     }
 955
 956     if (!empty($formValues['is_renew'])) {
 957       $form->assign('receiptType', 'membership renewal');
 958     }
 959     else {
 960       $form->assign('receiptType', 'membership signup');
 961     }
 962     $form->assign('receive_date', CRM_Utils_Array::value('receive_date', $formValues));
 963     $form->assign('formValues', $formValues);
 964
 965     if (empty($lineItem)) {
 966       $form->assign('mem_start_date', CRM_Utils_Date::formatDateOnlyLong($membership->start_date));
 967       if (!CRM_Utils_System::isNull($membership->end_date)) {
 968         $form->assign('mem_end_date', CRM_Utils_Date::formatDateOnlyLong($membership->end_date));
 969       }
 970       $form->assign('membership_name', CRM_Member_PseudoConstant::membershipType($membership->membership_type_id));
 971     }
 972
 973     // @todo - if we have to figure out if this is for batch processing it doesn't belong in the shared function.
 974     $isBatchProcess = is_a($form, 'CRM_Batch_Form_Entry');
 975     if ((empty($form->_contributorDisplayName) || empty($form->_contributorEmail)) || $isBatchProcess) {
 976       // in this case the form is being called statically from the batch editing screen
 977       // having one class in the form layer call another statically is not greate
 978       // & we should aim to move this function to the BAO layer in future.
 979       // however, we can assume that the contact_id passed in by the batch
 980       // function will be the recipient
 981       list($form->_contributorDisplayName, $form->_contributorEmail)
 982         = CRM_Contact_BAO_Contact_Location::getEmailDetails($formValues['contact_id']);
 983       if (empty($form->_receiptContactId) || $isBatchProcess) {
 984         $form->_receiptContactId = $formValues['contact_id'];
 985       }
 986     }
 987     // @todo determine isEmailPdf in calling function.
 988     $template = CRM_Core_Smarty::singleton();
 989     $taxAmt = $template->get_template_vars('dataArray');
 990     $eventTaxAmt = $template->get_template_vars('totalTaxAmount');
 991     $prefixValue = Civi::settings()->get('contribution_invoice_settings');
 992     $invoicing = $prefixValue['invoicing'] ?? NULL;
 993     if ((!empty($taxAmt) || isset($eventTaxAmt)) && (isset($invoicing) && isset($prefixValue['is_email_pdf']))) {
 994       $isEmailPdf = TRUE;
 995     }
 996     else {
 997       $isEmailPdf = FALSE;
 998     }
 999
1000     list($mailSend, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate(
1001       [
1002         'groupName' => 'msg_tpl_workflow_membership',
1003         'valueName' => 'membership_offline_receipt',
1004         'contactId' => $form->_receiptContactId,
1005         'from' => $receiptFrom,
1006         'toName' => $form->_contributorDisplayName,
1007         'toEmail' => $form->_contributorEmail,
1008         'PDFFilename' => ts('receipt') . '.pdf',
1009         'isEmailPdf' => $isEmailPdf,
1010         'contributionId' => $formValues['contribution_id'],
1011         'isTest' => (bool) ($form->_action & CRM_Core_Action::PREVIEW),
1012       ]
1013     );
1014
1015     return TRUE;
1016   }
1017
1018   /**
1019    * Submit function.
1020    *
1021    * This is also accessed by unit tests.
1022    *
1023    * @throws \CRM_Core_Exception
1024    * @throws \CiviCRM_API3_Exception
1025    */
1026   public function submit() {
1027     $isTest = ($this->_mode === 'test') ? 1 : 0;
1028     $this->storeContactFields($this->_params);
1029     $this->beginPostProcess();
1030     $endDate = NULL;
1031     $membership = $calcDate = [];
1032
1033     $paymentInstrumentID = $this->_paymentProcessor['object']->getPaymentInstrumentID();
1034     $params = $softParams = $ids = [];
1035
1036     $mailSend = FALSE;
1037     $this->processBillingAddress();
1038     $formValues = $this->_params;
1039     $formValues = $this->setPriceSetParameters($formValues);
1040
1041     if ($this->_id) {
1042       $ids['membership'] = $params['id'] = $this->_id;
1043     }
1044
1045     // Set variables that we normally get from context.
1046     // In form mode these are set in preProcess.
1047     //TODO: set memberships, fixme
1048     $this->setContextVariables($formValues);
1049
1050     $this->_memTypeSelected = self::getSelectedMemberships(
1051       $this->_priceSet,
1052       $formValues
1053     );
1054     if (empty($formValues['financial_type_id'])) {
1055       $formValues['financial_type_id'] = $this->_priceSet['financial_type_id'];
1056     }
1057
1058     $membershipTypeValues = [];
1059     foreach ($this->_memTypeSelected as $memType) {
1060       $membershipTypeValues[$memType]['membership_type_id'] = $memType;
1061     }
1062
1063     //take the required membership recur values.
1064     if ($this->_mode && !empty($formValues['auto_renew'])) {
1065       $params['is_recur'] = $formValues['is_recur'] = TRUE;
1066
1067       $count = 0;
1068       foreach ($this->_memTypeSelected as $memType) {
1069         $recurMembershipTypeValues = CRM_Utils_Array::value($memType,
1070           $this->allMembershipTypeDetails, []
1071         );
1072         if (!$recurMembershipTypeValues['auto_renew']) {
1073           continue;
1074         }
1075         foreach ([
1076           'frequency_interval' => 'duration_interval',
1077           'frequency_unit' => 'duration_unit',
1078         ] as $mapVal => $mapParam) {
1079           $membershipTypeValues[$memType][$mapVal] = $recurMembershipTypeValues[$mapParam];
1080
1081           if (!$count) {
1082             $formValues[$mapVal] = CRM_Utils_Array::value($mapParam,
1083               $recurMembershipTypeValues
1084             );
1085           }
1086         }
1087         $count++;
1088       }
1089     }
1090
1091     $isQuickConfig = $this->_priceSet['is_quick_config'];
1092
1093     $termsByType = [];
1094
1095     $lineItem = [$this->_priceSetId => []];
1096
1097     // BEGIN Fix for dev/core/issues/860
1098     // Prepare fee block and call buildAmount hook - based on CRM_Price_BAO_PriceSet::buildPriceSet().
1099     CRM_Utils_Hook::buildAmount('membership', $this, $this->_priceSet['fields']);
1100     // END Fix for dev/core/issues/860
1101
1102     CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'],
1103       $formValues, $lineItem[$this->_priceSetId], $this->_priceSetId);
1104
1105     if (!empty($formValues['tax_amount'])) {
1106       $params['tax_amount'] = $formValues['tax_amount'];
1107     }
1108     $params['total_amount'] = $formValues['amount'] ?? NULL;
1109     if (!empty($lineItem[$this->_priceSetId])) {
1110       foreach ($lineItem[$this->_priceSetId] as &$li) {
1111         if (!empty($li['membership_type_id'])) {
1112           if (!empty($li['membership_num_terms'])) {
1113             $termsByType[$li['membership_type_id']] = $li['membership_num_terms'];
1114           }
1115         }
1116
1117         ///CRM-11529 for quick config backoffice transactions
1118         //when financial_type_id is passed in form, update the
1119         //lineitems with the financial type selected in form
1120         $submittedFinancialType = $formValues['financial_type_id'] ?? NULL;
1121         if ($isQuickConfig && $submittedFinancialType) {
1122           $li['financial_type_id'] = $submittedFinancialType;
1123         }
1124       }
1125     }
1126
1127     $params['contact_id'] = $this->_contactID;
1128
1129     $fields = [
1130       'status_id',
1131       'source',
1132       'is_override',
1133       'status_override_end_date',
1134       'campaign_id',
1135     ];
1136
1137     foreach ($fields as $f) {
1138       $params[$f] = $formValues[$f] ?? NULL;
1139     }
1140
1141     // fix for CRM-3724
1142     // when is_override false ignore is_admin statuses during membership
1143     // status calculation. similarly we did fix for import in CRM-3570.
1144     if (empty($params['is_override'])) {
1145       $params['exclude_is_admin'] = TRUE;
1146     }
1147
1148     $joinDate = $formValues['join_date'];
1149     $startDate = $formValues['start_date'];
1150     $endDate = $formValues['end_date'];
1151
1152     $memTypeNumTerms = empty($termsByType) ? CRM_Utils_Array::value('num_terms', $formValues) : NULL;
1153
1154     $calcDates = [];
1155     foreach ($this->_memTypeSelected as $memType) {
1156       if (empty($memTypeNumTerms)) {
1157         $memTypeNumTerms = CRM_Utils_Array::value($memType, $termsByType, 1);
1158       }
1159       $calcDates[$memType] = CRM_Member_BAO_MembershipType::getDatesForMembershipType($memType,
1160         $joinDate, $startDate, $endDate, $memTypeNumTerms
1161       );
1162     }
1163
1164     foreach ($calcDates as $memType => $calcDate) {
1165       foreach (['join_date', 'start_date', 'end_date'] as $d) {
1166         //first give priority to form values then calDates.
1167         $date = $formValues[$d] ?? NULL;
1168         if (!$date) {
1169           $date = $calcDate[$d] ?? NULL;
1170         }
1171
1172         $membershipTypeValues[$memType][$d] = CRM_Utils_Date::processDate($date);
1173       }
1174     }
1175
1176     foreach ($this->_memTypeSelected as $memType) {
1177       if (array_key_exists('max_related', $formValues)) {
1178         // max related memberships - take from form or inherit from membership type
1179         $membershipTypeValues[$memType]['max_related'] = $formValues['max_related'] ?? NULL;
1180       }
1181       $membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField::postProcess($formValues,
1182         $this->_id,
1183         'Membership'
1184       );
1185     }
1186
1187     // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1188     list($userName) = CRM_Contact_BAO_Contact_Location::getEmailDetails(CRM_Core_Session::getLoggedInContactID());
1189
1190     //CRM-13981, allow different person as a soft-contributor of chosen type
1191     if ($this->_contributorContactID != $this->_contactID) {
1192       $params['contribution_contact_id'] = $this->_contributorContactID;
1193       if (!empty($formValues['soft_credit_type_id'])) {
1194         $softParams['soft_credit_type_id'] = $formValues['soft_credit_type_id'];
1195         $softParams['contact_id'] = $this->_contactID;
1196       }
1197     }
1198
1199     $pendingMembershipStatusId = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending');
1200
1201     if (!empty($formValues['record_contribution'])) {
1202       $recordContribution = [
1203         'total_amount',
1204         'financial_type_id',
1205         'payment_instrument_id',
1206         'trxn_id',
1207         'contribution_status_id',
1208         'check_number',
1209         'campaign_id',
1210         'receive_date',
1211         'card_type_id',
1212         'pan_truncation',
1213       ];
1214
1215       foreach ($recordContribution as $f) {
1216         $params[$f] = $formValues[$f] ?? NULL;
1217       }
1218
1219       if (empty($formValues['source'])) {
1220         $params['contribution_source'] = ts('%1 Membership: Offline signup (by %2)', [
1221           1 => $this->getSelectedMembershipLabels(),
1222           2 => $userName,
1223         ]);
1224       }
1225       else {
1226         $params['contribution_source'] = $formValues['source'];
1227       }
1228
1229       $completedContributionStatusId = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
1230       if (empty($params['is_override']) &&
1231         CRM_Utils_Array::value('contribution_status_id', $params) != $completedContributionStatusId
1232       ) {
1233         $params['status_id'] = $pendingMembershipStatusId;
1234         $params['skipStatusCal'] = TRUE;
1235         $params['is_pay_later'] = 1;
1236         $this->assign('is_pay_later', 1);
1237       }
1238
1239       if (!empty($formValues['send_receipt'])) {
1240         $params['receipt_date'] = $formValues['receive_date'] ?? NULL;
1241       }
1242
1243       //insert financial type name in receipt.
1244       $formValues['contributionType_name'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialType',
1245         $formValues['financial_type_id']
1246       );
1247     }
1248
1249     // process line items, until no previous line items.
1250     if (!empty($lineItem)) {
1251       $params['lineItems'] = $lineItem;
1252       $params['processPriceSet'] = TRUE;
1253     }
1254     $createdMemberships = [];
1255     if ($this->_mode) {
1256       $params['total_amount'] = CRM_Utils_Array::value('total_amount', $formValues, 0);
1257
1258       //CRM-20264 : Store CC type and number (last 4 digit) during backoffice or online payment
1259       $params['card_type_id'] = $this->_params['card_type_id'] ?? NULL;
1260       $params['pan_truncation'] = $this->_params['pan_truncation'] ?? NULL;
1261
1262       if (!$isQuickConfig) {
1263         $params['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet',
1264           $this->_priceSetId,
1265           'financial_type_id'
1266         );
1267       }
1268       else {
1269         $params['financial_type_id'] = $formValues['financial_type_id'] ?? NULL;
1270       }
1271
1272       //get the payment processor id as per mode. Try removing in favour of beginPostProcess.
1273       $params['payment_processor_id'] = $formValues['payment_processor_id'] = $this->_paymentProcessor['id'];
1274       $params['register_date'] = date('YmdHis');
1275
1276       // add all the additional payment params we need
1277       $formValues['amount'] = $params['total_amount'];
1278       // @todo this is a candidate for beginPostProcessFunction.
1279       $formValues['currencyID'] = CRM_Core_Config::singleton()->defaultCurrency;
1280       $formValues['description'] = ts("Contribution submitted by a staff person using member's credit card for signup");
1281       $formValues['invoiceID'] = md5(uniqid(rand(), TRUE));
1282       $formValues['financial_type_id'] = $params['financial_type_id'];
1283
1284       // at this point we've created a contact and stored its address etc
1285       // all the payment processors expect the name and address to be in the
1286       // so we copy stuff over to first_name etc.
1287       $paymentParams = $formValues;
1288       $paymentParams['contactID'] = $this->_contributorContactID;
1289       //CRM-10377 if payment is by an alternate contact then we need to set that person
1290       // as the contact in the payment params
1291       if ($this->_contributorContactID != $this->_contactID) {
1292         if (!empty($formValues['soft_credit_type_id'])) {
1293           $softParams['contact_id'] = $params['contact_id'];
1294           $softParams['soft_credit_type_id'] = $formValues['soft_credit_type_id'];
1295         }
1296       }
1297       if (!empty($formValues['send_receipt'])) {
1298         $paymentParams['email'] = $this->_contributorEmail;
1299       }
1300
1301       // This is a candidate for shared beginPostProcess function.
1302       // @todo Do we need this now we have $this->formatParamsForPaymentProcessor() ?
1303       CRM_Core_Payment_Form::mapParams($this->_bltID, $formValues, $paymentParams, TRUE);
1304       // CRM-7137 -for recurring membership,
1305       // we do need contribution and recurring records.
1306       $result = NULL;
1307       if (!empty($paymentParams['is_recur'])) {
1308         $financialType = new CRM_Financial_DAO_FinancialType();
1309         $financialType->id = $params['financial_type_id'];
1310         $financialType->find(TRUE);
1311         $this->_params = $formValues;
1312
1313         $contribution = self::processFormContribution($this,
1314           $paymentParams,
1315           NULL,
1316           [
1317             'contact_id' => $this->_contributorContactID,
1318             'line_item' => $lineItem,
1319             'is_test' => $isTest,
1320             'campaign_id' => $paymentParams['campaign_id'] ?? NULL,
1321             'contribution_page_id' => $formValues['contribution_page_id'] ?? NULL,
1322             'source' => CRM_Utils_Array::value('source', $paymentParams, CRM_Utils_Array::value('description', $paymentParams)),
1323             'thankyou_date' => $paymentParams['thankyou_date'] ?? NULL,
1324             'payment_instrument_id' => $paymentInstrumentID,
1325           ],
1326           $financialType,
1327           FALSE,
1328           $this->_bltID,
1329           TRUE
1330         );
1331
1332         //create new soft-credit record, CRM-13981
1333         if ($softParams) {
1334           $softParams['contribution_id'] = $contribution->id;
1335           $softParams['currency'] = $contribution->currency;
1336           $softParams['amount'] = $contribution->total_amount;
1337           CRM_Contribute_BAO_ContributionSoft::add($softParams);
1338         }
1339
1340         $paymentParams['contactID'] = $this->_contactID;
1341         $paymentParams['contributionID'] = $contribution->id;
1342         $paymentParams['contributionTypeID'] = $contribution->financial_type_id;
1343         $paymentParams['contributionPageID'] = $contribution->contribution_page_id;
1344         $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id;
1345         $params['contribution_id'] = $paymentParams['contributionID'];
1346         $params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
1347       }
1348       $paymentStatus = NULL;
1349
1350       if ($params['total_amount'] > 0.0) {
1351         $payment = $this->_paymentProcessor['object'];
1352         try {
1353           $result = $payment->doPayment($paymentParams);
1354           $formValues = array_merge($formValues, $result);
1355           $paymentStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $formValues['payment_status_id']);
1356           // Assign amount to template if payment was successful.
1357           $this->assign('amount', $params['total_amount']);
1358         }
1359         catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
1360           if (!empty($paymentParams['contributionID'])) {
1361             CRM_Contribute_BAO_Contribution::failPayment($paymentParams['contributionID'], $this->_contactID,
1362               $e->getMessage());
1363           }
1364           if (!empty($paymentParams['contributionRecurID'])) {
1365             CRM_Contribute_BAO_ContributionRecur::deleteRecurContribution($paymentParams['contributionRecurID']);
1366           }
1367
1368           CRM_Core_Session::singleton()->setStatus($e->getMessage());
1369           CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view/membership',
1370             "reset=1&action=add&cid={$this->_contactID}&context=membership&mode={$this->_mode}"
1371           ));
1372
1373         }
1374       }
1375
1376       if ($paymentStatus !== 'Completed') {
1377         $params['status_id'] = $pendingMembershipStatusId;
1378         $params['skipStatusCal'] = TRUE;
1379         // unset send-receipt option, since receipt will be sent when ipn is received.
1380         unset($formValues['send_receipt'], $formValues['send_receipt']);
1381         //as membership is pending set dates to null.
1382         foreach ($this->_memTypeSelected as $memType) {
1383           $membershipTypeValues[$memType]['joinDate'] = NULL;
1384           $membershipTypeValues[$memType]['startDate'] = NULL;
1385           $membershipTypeValues[$memType]['endDate'] = NULL;
1386         }
1387         $endDate = $startDate = NULL;
1388       }
1389       $now = date('YmdHis');
1390       $params['receive_date'] = date('Y-m-d H:i:s');
1391       $params['invoice_id'] = $formValues['invoiceID'];
1392       $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
1393         [1 => $this->getSelectedMembershipLabels(), 2 => $userName]
1394       );
1395       $params['source'] = $formValues['source'] ?: $params['contribution_source'];
1396       $params['trxn_id'] = $result['trxn_id'] ?? NULL;
1397       $params['is_test'] = ($this->_mode === 'live') ? 0 : 1;
1398       if (!empty($formValues['send_receipt'])) {
1399         $params['receipt_date'] = $now;
1400       }
1401       else {
1402         $params['receipt_date'] = NULL;
1403       }
1404
1405       $this->set('params', $formValues);
1406       $this->assign('trxn_id', CRM_Utils_Array::value('trxn_id', $result));
1407       $this->assign('receive_date',
1408         CRM_Utils_Date::mysqlToIso($params['receive_date'])
1409       );
1410
1411       // required for creating membership for related contacts
1412       $params['action'] = $this->_action;
1413
1414       //create membership record.
1415       $count = 0;
1416       foreach ($this->_memTypeSelected as $memType) {
1417         if ($count &&
1418           ($relateContribution = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id))
1419         ) {
1420           $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1421         }
1422
1423         $membershipParams = array_merge($membershipTypeValues[$memType], $params);
1424         //CRM-15366
1425         if (!empty($softParams) && empty($paymentParams['is_recur'])) {
1426           $membershipParams['soft_credit'] = $softParams;
1427         }
1428         if (isset($result['fee_amount'])) {
1429           $membershipParams['fee_amount'] = $result['fee_amount'];
1430         }
1431         // This is required to trigger the recording of the membership contribution in the
1432         // CRM_Member_BAO_Membership::Create function.
1433         // @todo stop setting this & 'teach' the create function to respond to something
1434         // appropriate as part of our 2-step always create the pending contribution & then finally add the payment
1435         // process -
1436         // @see http://wiki.civicrm.org/confluence/pages/viewpage.action?pageId=261062657#Payments&AccountsRoadmap-Movetowardsalwaysusinga2-steppaymentprocess
1437         $membershipParams['contribution_status_id'] = $result['payment_status_id'] ?? NULL;
1438         if (!empty($paymentParams['is_recur'])) {
1439           // The earlier process created the line items (although we want to get rid of the earlier one in favour
1440           // of a single path!
1441           unset($membershipParams['lineItems']);
1442         }
1443         $membershipParams['payment_instrument_id'] = $paymentInstrumentID;
1444         // @todo stop passing $ids (membership and userId only are set above)
1445         $membership = CRM_Member_BAO_Membership::create($membershipParams, $ids);
1446         $params['contribution'] = $membershipParams['contribution'] ?? NULL;
1447         unset($params['lineItems']);
1448         $this->_membershipIDs[] = $membership->id;
1449         $createdMemberships[$memType] = $membership;
1450         $count++;
1451       }
1452
1453     }
1454     else {
1455       $params['action'] = $this->_action;
1456       foreach ($lineItem[$this->_priceSetId] as $id => $lineItemValues) {
1457         if (empty($lineItemValues['membership_type_id'])) {
1458           continue;
1459         }
1460
1461         // @todo figure out why recieve_date isn't being set right here.
1462         if (empty($params['receive_date'])) {
1463           $params['receive_date'] = date('Y-m-d H:i:s');
1464         }
1465         $membershipParams = array_merge($params, $membershipTypeValues[$lineItemValues['membership_type_id']]);
1466
1467         if (!empty($softParams)) {
1468           $membershipParams['soft_credit'] = $softParams;
1469         }
1470         unset($membershipParams['contribution_status_id']);
1471         $membershipParams['skipLineItem'] = TRUE;
1472         unset($membershipParams['lineItems']);
1473         // @todo stop passing $ids (membership and userId only are set above)
1474         $membership = CRM_Member_BAO_Membership::create($membershipParams, $ids);
1475         $lineItem[$this->_priceSetId][$id]['entity_id'] = $membership->id;
1476         $lineItem[$this->_priceSetId][$id]['entity_table'] = 'civicrm_membership';
1477
1478         $this->_membershipIDs[] = $membership->id;
1479         $createdMemberships[$membership->membership_type_id] = $membership;
1480       }
1481       $params['lineItems'] = $lineItem;
1482       if (!empty($formValues['record_contribution'])) {
1483         CRM_Member_BAO_Membership::recordMembershipContribution($params);
1484       }
1485     }
1486     $isRecur = $params['is_recur'] ?? NULL;
1487     if (($this->_action & CRM_Core_Action::UPDATE)) {
1488       $this->addStatusMessage($this->getStatusMessageForUpdate($membership, $endDate));
1489     }
1490     elseif (($this->_action & CRM_Core_Action::ADD)) {
1491       $this->addStatusMessage($this->getStatusMessageForCreate($endDate, $createdMemberships,
1492         $isRecur, $calcDates));
1493     }
1494
1495     if (!empty($lineItem[$this->_priceSetId])) {
1496       $invoicing = Civi::settings()->get('invoicing');
1497       $taxAmount = FALSE;
1498       $totalTaxAmount = 0;
1499       foreach ($lineItem[$this->_priceSetId] as & $priceFieldOp) {
1500         if (!empty($priceFieldOp['membership_type_id'])) {
1501           $priceFieldOp['start_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date'] ? CRM_Utils_Date::formatDateOnlyLong($membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date']) : '-';
1502           $priceFieldOp['end_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date'] ? CRM_Utils_Date::formatDateOnlyLong($membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date']) : '-';
1503         }
1504         else {
1505           $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1506         }
1507         if ($invoicing && isset($priceFieldOp['tax_amount'])) {
1508           $taxAmount = TRUE;
1509           $totalTaxAmount += $priceFieldOp['tax_amount'];
1510         }
1511       }
1512       if ($invoicing) {
1513         $dataArray = [];
1514         foreach ($lineItem[$this->_priceSetId] as $key => $value) {
1515           if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
1516             if (isset($dataArray[$value['tax_rate']])) {
1517               $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + CRM_Utils_Array::value('tax_amount', $value);
1518             }
1519             else {
1520               $dataArray[$value['tax_rate']] = $value['tax_amount'] ?? NULL;
1521             }
1522           }
1523         }
1524         if ($taxAmount) {
1525           $this->assign('totalTaxAmount', $totalTaxAmount);
1526           // Not sure why would need this on Submit.... unless it's being used when sending mails in which case this is the wrong place
1527           $this->assign('taxTerm', $this->getSalesTaxTerm());
1528         }
1529         $this->assign('dataArray', $dataArray);
1530       }
1531     }
1532     $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ? $lineItem : FALSE);
1533
1534     $receiptSend = FALSE;
1535     $contributionId = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id);
1536     $membershipIds = $this->_membershipIDs;
1537     if ($contributionId && !empty($membershipIds)) {
1538       $contributionDetails = CRM_Contribute_BAO_Contribution::getContributionDetails(
1539         CRM_Export_Form_Select::MEMBER_EXPORT, $this->_membershipIDs);
1540       if ($contributionDetails[$membership->id]['contribution_status'] === 'Completed') {
1541         $receiptSend = TRUE;
1542       }
1543     }
1544
1545     $receiptSent = FALSE;
1546     if (!empty($formValues['send_receipt']) && $receiptSend) {
1547       $formValues['contact_id'] = $this->_contactID;
1548       $formValues['contribution_id'] = $contributionId;
1549       // We really don't need a distinct receipt_text_signup vs receipt_text_renewal as they are
1550       // handled in the receipt. But by setting one we avoid breaking templates for now
1551       // although at some point we should switch in the templates.
1552       $formValues['receipt_text_signup'] = $formValues['receipt_text'];
1553       // send email receipt
1554       $this->assignBillingName();
1555       $mailSend = $this->emailMembershipReceipt($formValues, $membership);
1556       $receiptSent = TRUE;
1557     }
1558
1559     // finally set membership id if already not set
1560     if (!$this->_id) {
1561       $this->_id = $membership->id;
1562     }
1563
1564     $this->updateContributionOnMembershipTypeChange($params, $membership);
1565     if ($receiptSent && $mailSend) {
1566       $this->addStatusMessage(ts('A membership confirmation and receipt has been sent to %1.', [1 => $this->_contributorEmail]));
1567     }
1568
1569     CRM_Core_Session::setStatus($this->getStatusMessage(), ts('Complete'), 'success');
1570     $this->setStatusMessage($membership);
1571   }
1572
1573   /**
1574    * Update related contribution of a membership if update_contribution_on_membership_type_change
1575    *   contribution setting is enabled and type is changed on edit
1576    *
1577    * @param array $inputParams
1578    *      submitted form values
1579    * @param CRM_Member_DAO_Membership $membership
1580    *     Updated membership object
1581    *
1582    * @throws \CRM_Core_Exception
1583    * @throws \CiviCRM_API3_Exception
1584    */
1585   protected function updateContributionOnMembershipTypeChange($inputParams, $membership) {
1586     if (Civi::settings()->get('update_contribution_on_membership_type_change') &&
1587     // on update
1588       ($this->_action & CRM_Core_Action::UPDATE) &&
1589     // if ID is present
1590       $this->_id &&
1591     // if selected membership doesn't match with earlier membership
1592       !in_array($this->_memType, $this->_memTypeSelected)
1593     ) {
1594       if (!empty($inputParams['is_recur'])) {
1595         CRM_Core_Session::setStatus(ts('Associated recurring contribution cannot be updated on membership type change.', ts('Error'), 'error'));
1596         return;
1597       }
1598
1599       // fetch lineitems by updated membership ID
1600       $lineItems = CRM_Price_BAO_LineItem::getLineItems($membership->id, 'membership');
1601       // retrieve the related contribution ID
1602       $contributionID = CRM_Core_DAO::getFieldValue(
1603         'CRM_Member_DAO_MembershipPayment',
1604         $membership->id,
1605         'contribution_id',
1606         'membership_id'
1607       );
1608       // get price fields of chosen price-set
1609       $priceSetDetails = CRM_Utils_Array::value(
1610         $this->_priceSetId,
1611         CRM_Price_BAO_PriceSet::getSetDetail(
1612           $this->_priceSetId,
1613           TRUE,
1614           TRUE
1615         )
1616       );
1617
1618       // add price field information in $inputParams
1619       self::addPriceFieldByMembershipType($inputParams, $priceSetDetails['fields'], $membership->membership_type_id);
1620
1621       // update related contribution and financial records
1622       CRM_Price_BAO_LineItem::changeFeeSelections(
1623         $inputParams,
1624         $membership->id,
1625         'membership',
1626         $contributionID,
1627         $priceSetDetails['fields'],
1628         $lineItems
1629       );
1630       CRM_Core_Session::setStatus(ts('Associated contribution is updated on membership type change.'), ts('Success'), 'success');
1631     }
1632   }
1633
1634   /**
1635    * Add selected price field information in $formValues
1636    *
1637    * @param array $formValues
1638    *      submitted form values
1639    * @param array $priceFields
1640    *     Price fields of selected Priceset ID
1641    * @param int $membershipTypeID
1642    *     Selected membership type ID
1643    *
1644    */
1645   public static function addPriceFieldByMembershipType(&$formValues, $priceFields, $membershipTypeID) {
1646     foreach ($priceFields as $priceFieldID => $priceField) {
1647       if (isset($priceField['options']) && count($priceField['options'])) {
1648         foreach ($priceField['options'] as $option) {
1649           if ($option['membership_type_id'] == $membershipTypeID) {
1650             $formValues["price_{$priceFieldID}"] = $option['id'];
1651             break;
1652           }
1653         }
1654       }
1655     }
1656   }
1657
1658   /**
1659    * Set context in session.
1660    */
1661   protected function setUserContext() {
1662     $buttonName = $this->controller->getButtonName();
1663     $session = CRM_Core_Session::singleton();
1664
1665     if ($buttonName == $this->getButtonName('upload', 'new')) {
1666       if ($this->_context === 'standalone') {
1667         $url = CRM_Utils_System::url('civicrm/member/add',
1668           'reset=1&action=add&context=standalone'
1669         );
1670       }
1671       else {
1672         $url = CRM_Utils_System::url('civicrm/contact/view/membership',
1673           "reset=1&action=add&context=membership&cid={$this->_contactID}"
1674         );
1675       }
1676     }
1677     else {
1678       $url = CRM_Utils_System::url('civicrm/contact/view',
1679         "reset=1&cid={$this->_contactID}&selectedChild=member"
1680       );
1681     }
1682     $session->replaceUserContext($url);
1683   }
1684
1685   /**
1686    * Get status message for updating membership.
1687    *
1688    * @param CRM_Member_BAO_Membership $membership
1689    * @param string $endDate
1690    *
1691    * @return string
1692    */
1693   protected function getStatusMessageForUpdate($membership, $endDate) {
1694     // End date can be modified by hooks, so if end date is set then use it.
1695     $endDate = ($membership->end_date) ? $membership->end_date : $endDate;
1696
1697     $statusMsg = ts('Membership for %1 has been updated.', [1 => $this->_memberDisplayName]);
1698     if ($endDate && $endDate !== 'null') {
1699       $endDate = CRM_Utils_Date::customFormat($endDate);
1700       $statusMsg .= ' ' . ts('The membership End Date is %1.', [1 => $endDate]);
1701     }
1702     return $statusMsg;
1703   }
1704
1705   /**
1706    * Get status message for create action.
1707    *
1708    * @param string $endDate
1709    * @param array $createdMemberships
1710    * @param bool $isRecur
1711    * @param array $calcDates
1712    *
1713    * @return array|string
1714    */
1715   protected function getStatusMessageForCreate($endDate, $createdMemberships,
1716                                                $isRecur, $calcDates) {
1717     // FIX ME: fix status messages
1718
1719     $statusMsg = [];
1720     foreach ($this->_memTypeSelected as $membershipTypeID) {
1721       $statusMsg[$membershipTypeID] = ts('%1 membership for %2 has been added.', [
1722         1 => $this->allMembershipTypeDetails[$membershipTypeID]['name'],
1723         2 => $this->_memberDisplayName,
1724       ]);
1725
1726       $membership = $createdMemberships[$membershipTypeID];
1727       $memEndDate = $membership->end_date ?: $endDate;
1728
1729       //get the end date from calculated dates.
1730       if (!$memEndDate && !$isRecur) {
1731         $memEndDate = $calcDates[$membershipTypeID]['end_date'] ?? NULL;
1732       }
1733
1734       if ($memEndDate && $memEndDate !== 'null') {
1735         $memEndDate = CRM_Utils_Date::formatDateOnlyLong($memEndDate);
1736         $statusMsg[$membershipTypeID] .= ' ' . ts('The new membership End Date is %1.', [1 => $memEndDate]);
1737       }
1738     }
1739     $statusMsg = implode('<br/>', $statusMsg);
1740     return $statusMsg;
1741   }
1742
1743   /**
1744    * @param $membership
1745    */
1746   protected function setStatusMessage($membership) {
1747     //CRM-15187
1748     // display message when membership type is changed
1749     if (($this->_action & CRM_Core_Action::UPDATE) && $this->_id && !in_array($this->_memType, $this->_memTypeSelected)) {
1750       $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->_id, 'membership');
1751       $maxID = max(array_keys($lineItem));
1752       $lineItem = $lineItem[$maxID];
1753       $membershipTypeDetails = $this->allMembershipTypeDetails[$membership->membership_type_id];
1754       if ($membershipTypeDetails['financial_type_id'] != $lineItem['financial_type_id']) {
1755         CRM_Core_Session::setStatus(
1756           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.'),
1757           ts('Warning')
1758         );
1759       }
1760       if ($membershipTypeDetails['minimum_fee'] != $lineItem['line_total']) {
1761         CRM_Core_Session::setStatus(
1762           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.'),
1763           ts('Warning')
1764         );
1765       }
1766     }
1767   }
1768
1769   /**
1770    * @return bool
1771    * @throws \CRM_Core_Exception
1772    */
1773   protected function isUpdateToExistingRecurringMembership() {
1774     $isRecur = FALSE;
1775     if ($this->_action & CRM_Core_Action::UPDATE
1776       && CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->getEntityId(),
1777         'contribution_recur_id')
1778       && !CRM_Member_BAO_Membership::isSubscriptionCancelled($this->getEntityId())) {
1779
1780       $isRecur = TRUE;
1781     }
1782     return $isRecur;
1783   }
1784
1785   /**
1786    * Send a receipt for the membership.
1787    *
1788    * @param array $formValues
1789    * @param \CRM_Member_BAO_Membership $membership
1790    *
1791    * @return bool
1792    * @throws \CRM_Core_Exception
1793    */
1794   protected function emailMembershipReceipt($formValues, $membership) {
1795     $customValues = $this->getCustomValuesForReceipt($formValues, $membership);
1796
1797     return self::emailReceipt($this, $formValues, $membership, $customValues);
1798   }
1799
1800   /**
1801    * Filter the custom values from the input parameters (for display in the email).
1802    *
1803    * @todo figure out why the scary code this calls does & document.
1804    *
1805    * @param array $formValues
1806    * @param \CRM_Member_BAO_Membership $membership
1807    * @return array
1808    */
1809   protected function getCustomValuesForReceipt($formValues, $membership) {
1810     $customFields = $customValues = [];
1811     if (property_exists($this, '_groupTree')
1812       && !empty($this->_groupTree)
1813     ) {
1814       foreach ($this->_groupTree as $groupID => $group) {
1815         if ($groupID === 'info') {
1816           continue;
1817         }
1818         foreach ($group['fields'] as $k => $field) {
1819           $field['title'] = $field['label'];
1820           $customFields["custom_{$k}"] = $field;
1821         }
1822       }
1823     }
1824
1825     $members = [['member_id', '=', $membership->id, 0, 0]];
1826     // check whether its a test drive
1827     if ($this->_mode === 'test') {
1828       $members[] = ['member_test', '=', 1, 0, 0];
1829     }
1830
1831     CRM_Core_BAO_UFGroup::getValues($formValues['contact_id'], $customFields, $customValues, FALSE, $members);
1832     return $customValues;
1833   }
1834
1835   /**
1836    * Get the selected memberships as a string of labels.
1837    *
1838    * @return string
1839    */
1840   protected function getSelectedMembershipLabels(): string {
1841     $return = [];
1842     foreach ($this->_memTypeSelected as $membershipTypeID) {
1843       $return[] = $this->allMembershipTypeDetails[$membershipTypeID]['name'];
1844     }
1845     return implode(', ', $return);
1846   }
1847
1848   /**
1849    * Legacy contribution processing function.
1850    *
1851    * This is copied from a shared function in order to clean it up. Most of the
1852    * stuff in it, maybe all except the ContributionRecur create is
1853    * not applicable to this form & can be removed in follow up cleanup.
1854    *
1855    * It's like the contribution create being done here is actively bad and
1856    * being fixed later.
1857    *
1858    * @param CRM_Core_Form $form
1859    * @param array $params
1860    * @param array $result
1861    * @param array $contributionParams
1862    *   Parameters to be passed to contribution create action.
1863    *   This differs from params in that we are currently adding params to it and 1) ensuring they are being
1864    *   passed consistently & 2) documenting them here.
1865    *   - contact_id
1866    *   - line_item
1867    *   - is_test
1868    *   - campaign_id
1869    *   - contribution_page_id
1870    *   - source
1871    *   - payment_type_id
1872    *   - thankyou_date (not all forms will set this)
1873    *
1874    * @param CRM_Financial_DAO_FinancialType $financialType
1875    * @param bool $online
1876    *   Is the form a front end form? If so set a bunch of unpredictable things that should be passed in from the form.
1877    *
1878    * @param int $billingLocationID
1879    *   ID of billing location type.
1880    * @param bool $isRecur
1881    *   Is this recurring?
1882    *
1883    * @return \CRM_Contribute_DAO_Contribution
1884    *
1885    * @throws \CRM_Core_Exception
1886    * @throws \CiviCRM_API3_Exception
1887    */
1888   public static function processFormContribution(
1889     &$form,
1890     $params,
1891     $result,
1892     $contributionParams,
1893     $financialType,
1894     $online,
1895     $billingLocationID,
1896     $isRecur
1897   ) {
1898     $transaction = new CRM_Core_Transaction();
1899     $contactID = $contributionParams['contact_id'];
1900
1901     $isEmailReceipt = !empty($form->_values['is_email_receipt']);
1902
1903     // add these values for the recurringContrib function ,CRM-10188
1904     $params['financial_type_id'] = $financialType->id;
1905
1906     $contributionParams['address_id'] = CRM_Contribute_BAO_Contribution::createAddress($params, $billingLocationID);
1907
1908     //@todo - this is being set from the form to resolve CRM-10188 - an
1909     // eNotice caused by it not being set @ the front end
1910     // however, we then get it being over-written with null for backend contributions
1911     // a better fix would be to set the values in the respective forms rather than require
1912     // a function being shared by two forms to deal with their respective values
1913     // moving it to the BAO & not taking the $form as a param would make sense here.
1914     if (!isset($params['is_email_receipt']) && $isEmailReceipt) {
1915       $params['is_email_receipt'] = $isEmailReceipt;
1916     }
1917     $params['is_recur'] = $isRecur;
1918     $params['payment_instrument_id'] = $contributionParams['payment_instrument_id'] ?? NULL;
1919     $recurringContributionID = CRM_Contribute_Form_Contribution_Confirm::processRecurringContribution($form, $params, $contactID, $financialType);
1920
1921     $now = date('YmdHis');
1922     $receiptDate = $params['receipt_date'] ?? NULL;
1923     if ($isEmailReceipt) {
1924       $receiptDate = $now;
1925     }
1926
1927     if (isset($params['amount'])) {
1928       $contributionParams = array_merge(CRM_Contribute_Form_Contribution_Confirm::getContributionParams(
1929         $params, $financialType->id,
1930         $result, $receiptDate,
1931         $recurringContributionID), $contributionParams
1932       );
1933       $contributionParams['non_deductible_amount'] = CRM_Contribute_Form_Contribution_Confirm::getNonDeductibleAmount($params, $financialType, $online, $form);
1934       $contributionParams['skipCleanMoney'] = TRUE;
1935       // @todo this is the wrong place for this - it should be done as close to form submission
1936       // as possible
1937       $contributionParams['total_amount'] = $params['amount'];
1938
1939       $contribution = CRM_Contribute_BAO_Contribution::add($contributionParams);
1940
1941       $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
1942       $invoicing = $invoiceSettings['invoicing'] ?? NULL;
1943       if ($invoicing) {
1944         $dataArray = [];
1945         // @todo - interrogate the line items passed in on the params array.
1946         // No reason to assume line items will be set on the form.
1947         foreach ($form->_lineItem as $lineItemKey => $lineItemValue) {
1948           foreach ($lineItemValue as $key => $value) {
1949             if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
1950               if (isset($dataArray[$value['tax_rate']])) {
1951                 $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + $value['tax_amount'];
1952               }
1953               else {
1954                 $dataArray[$value['tax_rate']] = $value['tax_amount'];
1955               }
1956             }
1957           }
1958         }
1959         $smarty = CRM_Core_Smarty::singleton();
1960         $smarty->assign('dataArray', $dataArray);
1961         $smarty->assign('totalTaxAmount', $params['tax_amount'] ?? NULL);
1962       }
1963
1964       // lets store it in the form variable so postProcess hook can get to this and use it
1965       $form->_contributionID = $contribution->id;
1966     }
1967
1968     // process soft credit / pcp params first
1969     CRM_Contribute_BAO_ContributionSoft::formatSoftCreditParams($params, $form);
1970
1971     //CRM-13981, processing honor contact into soft-credit contribution
1972     CRM_Contribute_BAO_ContributionSoft::processSoftContribution($params, $contribution);
1973
1974     if ($online && $contribution) {
1975       CRM_Core_BAO_CustomValueTable::postProcess($params,
1976         'civicrm_contribution',
1977         $contribution->id,
1978         'Contribution'
1979       );
1980     }
1981     elseif ($contribution) {
1982       //handle custom data.
1983       $params['contribution_id'] = $contribution->id;
1984       if (!empty($params['custom']) &&
1985         is_array($params['custom'])
1986       ) {
1987         CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contribution', $contribution->id);
1988       }
1989     }
1990     // Save note
1991     if ($contribution && !empty($params['contribution_note'])) {
1992       $noteParams = [
1993         'entity_table' => 'civicrm_contribution',
1994         'note' => $params['contribution_note'],
1995         'entity_id' => $contribution->id,
1996         'contact_id' => $contribution->contact_id,
1997       ];
1998
1999       CRM_Core_BAO_Note::add($noteParams, []);
2000     }
2001
2002     //create contribution activity w/ individual and target
2003     //activity w/ organisation contact id when onbelf, CRM-4027
2004     $actParams = [];
2005     $targetContactID = NULL;
2006     if (!empty($params['onbehalf_contact_id'])) {
2007       $actParams = [
2008         'source_contact_id' => $params['onbehalf_contact_id'],
2009         'on_behalf' => TRUE,
2010       ];
2011       $targetContactID = $contribution->contact_id;
2012     }
2013
2014     // create an activity record
2015     if ($contribution) {
2016       CRM_Activity_BAO_Activity::addActivity($contribution, 'Contribution', $targetContactID, $actParams);
2017     }
2018
2019     $transaction->commit();
2020     return $contribution;
2021   }
2022
2023 }