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