CRM/Contribute/Form/Contribution/Main.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 processing a Contribution.
  20  */
  21 class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_ContributionBase {
  22
  23   /**
  24    * Define default MembershipType Id.
  25    * @var int
  26    */
  27   public $_defaultMemTypeId;
  28
  29   public $_paymentProcessors;
  30
  31   public $_membershipTypeValues;
  32
  33   public $_useForMember;
  34
  35   /**
  36    * Array of payment related fields to potentially display on this form (generally credit card or debit card fields). This is rendered via billingBlock.tpl
  37    * @var array
  38    */
  39   public $_paymentFields = [];
  40
  41   protected $_paymentProcessorID;
  42   protected $_snippet;
  43
  44   /**
  45    * Set variables up before form is built.
  46    */
  47   public function preProcess() {
  48     parent::preProcess();
  49
  50     $this->_paymentProcessors = $this->get('paymentProcessors');
  51     $this->preProcessPaymentOptions();
  52
  53     $this->assignFormVariablesByContributionID();
  54
  55     // Make the contributionPageID available to the template
  56     $this->assign('contributionPageID', $this->_id);
  57     $this->assign('ccid', $this->_ccid);
  58     $this->assign('isShare', CRM_Utils_Array::value('is_share', $this->_values));
  59     $this->assign('isConfirmEnabled', CRM_Utils_Array::value('is_confirm_enabled', $this->_values));
  60
  61     $this->assign('reset', CRM_Utils_Request::retrieve('reset', 'Boolean'));
  62     $this->assign('mainDisplay', CRM_Utils_Request::retrieve('_qf_Main_display', 'Boolean',
  63       CRM_Core_DAO::$_nullObject));
  64
  65     if (!empty($this->_pcpInfo['id']) && !empty($this->_pcpInfo['intro_text'])) {
  66       $this->assign('intro_text', $this->_pcpInfo['intro_text']);
  67     }
  68     elseif (!empty($this->_values['intro_text'])) {
  69       $this->assign('intro_text', $this->_values['intro_text']);
  70     }
  71
  72     $qParams = "reset=1&amp;id={$this->_id}";
  73     if ($pcpId = CRM_Utils_Array::value('pcp_id', $this->_pcpInfo)) {
  74       $qParams .= "&amp;pcpId={$pcpId}";
  75     }
  76     $this->assign('qParams', $qParams);
  77
  78     if (!empty($this->_values['footer_text'])) {
  79       $this->assign('footer_text', $this->_values['footer_text']);
  80     }
  81   }
  82
  83   /**
  84    * Set the default values.
  85    */
  86   public function setDefaultValues() {
  87     // check if the user is registered and we have a contact ID
  88     $contactID = $this->getContactID();
  89
  90     if (!empty($contactID)) {
  91       $fields = [];
  92       $removeCustomFieldTypes = ['Contribution', 'Membership'];
  93       $contribFields = CRM_Contribute_BAO_Contribution::getContributionFields();
  94
  95       // remove component related fields
  96       foreach ($this->_fields as $name => $fieldInfo) {
  97         //don't set custom data Used for Contribution (CRM-1344)
  98         if (substr($name, 0, 7) == 'custom_') {
  99           $id = substr($name, 7);
 100           if (!CRM_Core_BAO_CustomGroup::checkCustomField($id, $removeCustomFieldTypes)) {
 101             continue;
 102           }
 103           // ignore component fields
 104         }
 105         elseif (array_key_exists($name, $contribFields) || (substr($name, 0, 11) == 'membership_') || (substr($name, 0, 13) == 'contribution_')) {
 106           continue;
 107         }
 108         $fields[$name] = $fieldInfo;
 109       }
 110
 111       if (!empty($fields)) {
 112         CRM_Core_BAO_UFGroup::setProfileDefaults($contactID, $fields, $this->_defaults);
 113       }
 114
 115       $billingDefaults = $this->getProfileDefaults('Billing', $contactID);
 116       $this->_defaults = array_merge($this->_defaults, $billingDefaults);
 117     }
 118     if (!empty($this->_ccid) && !empty($this->_pendingAmount)) {
 119       $this->_defaults['total_amount'] = CRM_Utils_Money::format($this->_pendingAmount, NULL, '%a');
 120     }
 121
 122     /*
 123      * hack to simplify credit card entry for testing
 124      *
 125      * $this->_defaults['credit_card_type']     = 'Visa';
 126      *         $this->_defaults['amount']               = 168;
 127      *         $this->_defaults['credit_card_number']   = '4111111111111111';
 128      *         $this->_defaults['cvv2']                 = '000';
 129      *         $this->_defaults['credit_card_exp_date'] = array('Y' => date('Y')+1, 'M' => '05');
 130      *         // hack to simplify direct debit entry for testing
 131      *         $this->_defaults['account_holder'] = 'Max Müller';
 132      *         $this->_defaults['bank_account_number'] = '12345678';
 133      *         $this->_defaults['bank_identification_number'] = '12030000';
 134      *         $this->_defaults['bank_name'] = 'Bankname';
 135      */
 136
 137     //build set default for pledge overdue payment.
 138     if (!empty($this->_values['pledge_id'])) {
 139       //used to record completed pledge payment ids used later for honor default
 140       $completedContributionIds = [];
 141       $pledgePayments = CRM_Pledge_BAO_PledgePayment::getPledgePayments($this->_values['pledge_id']);
 142
 143       $paymentAmount = 0;
 144       $duePayment = FALSE;
 145       foreach ($pledgePayments as $payId => $value) {
 146         if ($value['status'] == 'Overdue') {
 147           $this->_defaults['pledge_amount'][$payId] = 1;
 148           $paymentAmount += $value['scheduled_amount'];
 149         }
 150         elseif (!$duePayment && $value['status'] == 'Pending') {
 151           $this->_defaults['pledge_amount'][$payId] = 1;
 152           $paymentAmount += $value['scheduled_amount'];
 153           $duePayment = TRUE;
 154         }
 155         elseif ($value['status'] == 'Completed' && $value['contribution_id']) {
 156           $completedContributionIds[] = $value['contribution_id'];
 157         }
 158       }
 159       $this->_defaults['price_' . $this->_priceSetId] = $paymentAmount;
 160
 161       if (count($completedContributionIds)) {
 162         $softCredit = [];
 163         foreach ($completedContributionIds as $id) {
 164           $softCredit = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($id);
 165         }
 166         if (isset($softCredit['soft_credit'])) {
 167           $this->_defaults['soft_credit_type_id'] = $softCredit['soft_credit'][1]['soft_credit_type'];
 168
 169           //since honoree profile fieldname of fields are prefixed with 'honor'
 170           //we need to reformat the fieldname to append prefix during setting default values
 171           CRM_Core_BAO_UFGroup::setProfileDefaults(
 172             $softCredit['soft_credit'][1]['contact_id'],
 173             CRM_Core_BAO_UFGroup::getFields($this->_honoreeProfileId),
 174             $defaults
 175           );
 176           foreach ($defaults as $fieldName => $value) {
 177             $this->_defaults['honor[' . $fieldName . ']'] = $value;
 178           }
 179         }
 180       }
 181     }
 182     elseif (!empty($this->_values['pledge_block_id'])) {
 183       //set default to one time contribution.
 184       $this->_defaults['is_pledge'] = 0;
 185     }
 186
 187     // to process Custom data that are appended to URL
 188     $getDefaults = CRM_Core_BAO_CustomGroup::extractGetParams($this, "'Contact', 'Individual', 'Contribution'");
 189     $this->_defaults = array_merge($this->_defaults, $getDefaults);
 190
 191     $config = CRM_Core_Config::singleton();
 192     // set default country from config if no country set
 193     if (empty($this->_defaults["billing_country_id-{$this->_bltID}"])) {
 194       $this->_defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry;
 195     }
 196
 197     // set default state/province from config if no state/province set
 198     if (empty($this->_defaults["billing_state_province_id-{$this->_bltID}"])) {
 199       $this->_defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince;
 200     }
 201
 202     $entityId = $memtypeID = NULL;
 203     if ($this->_priceSetId) {
 204       if (($this->_useForMember && !empty($this->_currentMemberships)) || $this->_defaultMemTypeId) {
 205         $selectedCurrentMemTypes = [];
 206         foreach ($this->_priceSet['fields'] as $key => $val) {
 207           foreach ($val['options'] as $keys => $values) {
 208             $opMemTypeId = $values['membership_type_id'] ?? NULL;
 209             $priceFieldName = 'price_' . $values['price_field_id'];
 210             $priceFieldValue = CRM_Price_BAO_PriceSet::getPriceFieldValueFromURL($this, $priceFieldName);
 211             if (!empty($priceFieldValue)) {
 212               CRM_Price_BAO_PriceSet::setDefaultPriceSetField($priceFieldName, $priceFieldValue, $val['html_type'], $this->_defaults);
 213               // break here to prevent overwriting of default due to 'is_default'
 214               // option configuration or setting of current membership or
 215               // membership for related organization.
 216               // The value sent via URL get's higher priority.
 217               break;
 218             }
 219             elseif ($opMemTypeId &&
 220               in_array($opMemTypeId, $this->_currentMemberships) &&
 221               !in_array($opMemTypeId, $selectedCurrentMemTypes)
 222             ) {
 223               CRM_Price_BAO_PriceSet::setDefaultPriceSetField($priceFieldName, $keys, $val['html_type'], $this->_defaults);
 224               $memtypeID = $selectedCurrentMemTypes[] = $values['membership_type_id'];
 225             }
 226             elseif (!empty($values['is_default']) && !$opMemTypeId && (!isset($this->_defaults[$priceFieldName]) ||
 227               ($val['html_type'] == 'CheckBox' && !isset($this->_defaults[$priceFieldName][$keys])))) {
 228               CRM_Price_BAO_PriceSet::setDefaultPriceSetField($priceFieldName, $keys, $val['html_type'], $this->_defaults);
 229               $memtypeID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $this->_defaults[$priceFieldName], 'membership_type_id');
 230             }
 231           }
 232         }
 233         $entityId = CRM_Utils_Array::value('id', CRM_Member_BAO_Membership::getContactMembership($contactID, $memtypeID, NULL));
 234       }
 235       else {
 236         CRM_Price_BAO_PriceSet::setDefaultPriceSet($this, $this->_defaults);
 237       }
 238     }
 239
 240     //set custom field defaults set by admin if value is not set
 241     if (!empty($this->_fields)) {
 242       //load default campaign from page.
 243       if (array_key_exists('contribution_campaign_id', $this->_fields)) {
 244         $this->_defaults['contribution_campaign_id'] = $this->_values['campaign_id'] ?? NULL;
 245       }
 246
 247       //set custom field defaults
 248       foreach ($this->_fields as $name => $field) {
 249         if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($name)) {
 250           if (!isset($this->_defaults[$name])) {
 251             CRM_Core_BAO_CustomField::setProfileDefaults($customFieldID, $name, $this->_defaults,
 252               $entityId, CRM_Profile_Form::MODE_REGISTER
 253             );
 254           }
 255         }
 256       }
 257     }
 258
 259     if (!empty($this->_paymentProcessors)) {
 260       foreach ($this->_paymentProcessors as $pid => $value) {
 261         if (!empty($value['is_default'])) {
 262           $this->_defaults['payment_processor_id'] = $pid;
 263         }
 264       }
 265     }
 266
 267     return $this->_defaults;
 268   }
 269
 270   /**
 271    * Build the form object.
 272    */
 273   public function buildQuickForm() {
 274     // build profiles first so that we can determine address fields etc
 275     // and then show copy address checkbox
 276     if (empty($this->_ccid)) {
 277       $this->buildCustom($this->_values['custom_pre_id'], 'customPre');
 278       $this->buildCustom($this->_values['custom_post_id'], 'customPost');
 279
 280       // CRM-18399: used by template to pass pre profile id as a url arg
 281       $this->assign('custom_pre_id', $this->_values['custom_pre_id']);
 282
 283       $this->buildComponentForm($this->_id, $this);
 284     }
 285
 286     if (count($this->_paymentProcessors) >= 1 && !$this->get_template_vars("isCaptcha") && $this->hasToAddForcefully()) {
 287       if (!$this->_userID) {
 288         $this->enableCaptchaOnForm();
 289       }
 290       else {
 291         $this->displayCaptchaWarning();
 292       }
 293     }
 294
 295     // Build payment processor form
 296     CRM_Core_Payment_ProcessorForm::buildQuickForm($this);
 297
 298     $config = CRM_Core_Config::singleton();
 299
 300     $contactID = $this->getContactID();
 301     if ($contactID) {
 302       $this->assign('contact_id', $contactID);
 303       $this->assign('display_name', CRM_Contact_BAO_Contact::displayName($contactID));
 304     }
 305
 306     $this->applyFilter('__ALL__', 'trim');
 307     if (empty($this->_ccid)) {
 308       if ($this->_emailExists == FALSE) {
 309         $this->add('text', "email-{$this->_bltID}",
 310           ts('Email Address'),
 311           ['size' => 30, 'maxlength' => 60, 'class' => 'email'],
 312           TRUE
 313         );
 314         $this->assign('showMainEmail', TRUE);
 315         $this->addRule("email-{$this->_bltID}", ts('Email is not valid.'), 'email');
 316       }
 317     }
 318     else {
 319       $this->addElement('hidden', "email-{$this->_bltID}", 1);
 320       $this->add('text', 'total_amount', ts('Total Amount'), ['readonly' => TRUE], FALSE);
 321     }
 322     $pps = $this->getProcessors();
 323     $this->addPaymentProcessorFieldsToForm();
 324     if (!empty($pps) && count($pps) === 1) {
 325       $ppKeys = array_keys($pps);
 326       $currentPP = array_pop($ppKeys);
 327       if ($currentPP === 0) {
 328         $this->assign('is_pay_later', $this->_values['is_pay_later']);
 329         $this->assign('pay_later_text', $this->getPayLaterLabel());
 330       }
 331     }
 332
 333     $contactID = $this->getContactID();
 334     if ($this->getContactID() === 0) {
 335       $this->addCidZeroOptions();
 336     }
 337
 338     //build pledge block.
 339     $this->_useForMember = 0;
 340     //don't build membership block when pledge_id is passed
 341     if (empty($this->_values['pledge_id']) && empty($this->_ccid)) {
 342       $this->_separateMembershipPayment = FALSE;
 343       if (in_array('CiviMember', $config->enableComponents)) {
 344         $isTest = 0;
 345         if ($this->_action & CRM_Core_Action::PREVIEW) {
 346           $isTest = 1;
 347         }
 348
 349         if ($this->_priceSetId &&
 350           (CRM_Core_Component::getComponentID('CiviMember') == CRM_Utils_Array::value('extends', $this->_priceSet))
 351         ) {
 352           $this->_useForMember = 1;
 353           $this->set('useForMember', $this->_useForMember);
 354         }
 355
 356         $this->_separateMembershipPayment = $this->buildMembershipBlock(
 357           $this->_membershipContactID,
 358           TRUE, NULL, FALSE,
 359           $isTest
 360         );
 361       }
 362       $this->set('separateMembershipPayment', $this->_separateMembershipPayment);
 363     }
 364     $this->assign('useForMember', $this->_useForMember);
 365     // If we configured price set for contribution page
 366     // we are not allow membership signup as well as any
 367     // other contribution amount field, CRM-5095
 368     if (isset($this->_priceSetId) && $this->_priceSetId) {
 369       $this->add('hidden', 'priceSetId', $this->_priceSetId);
 370       // build price set form.
 371       $this->set('priceSetId', $this->_priceSetId);
 372       if (empty($this->_ccid)) {
 373         CRM_Price_BAO_PriceSet::buildPriceSet($this);
 374       }
 375       if ($this->_values['is_monetary'] &&
 376         $this->_values['is_recur'] && empty($this->_values['pledge_id'])
 377       ) {
 378         self::buildRecur($this);
 379       }
 380     }
 381
 382     if ($this->_priceSetId && empty($this->_ccid)) {
 383       $is_quick_config = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config');
 384       if ($is_quick_config) {
 385         $this->_useForMember = 0;
 386         $this->set('useForMember', $this->_useForMember);
 387       }
 388     }
 389
 390     //we allow premium for pledge during pledge creation only.
 391     if (empty($this->_values['pledge_id']) && empty($this->_ccid)) {
 392       CRM_Contribute_BAO_Premium::buildPremiumBlock($this, $this->_id, TRUE);
 393     }
 394
 395     //don't build pledge block when mid is passed
 396     if (!$this->_mid && empty($this->_ccid)) {
 397       $config = CRM_Core_Config::singleton();
 398       if (in_array('CiviPledge', $config->enableComponents) && !empty($this->_values['pledge_block_id'])) {
 399         CRM_Pledge_BAO_PledgeBlock::buildPledgeBlock($this);
 400       }
 401     }
 402
 403     //to create an cms user
 404     if (!$this->_contactID && empty($this->_ccid)) {
 405       $createCMSUser = FALSE;
 406
 407       if ($this->_values['custom_pre_id']) {
 408         $profileID = $this->_values['custom_pre_id'];
 409         $createCMSUser = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'is_cms_user');
 410       }
 411
 412       if (!$createCMSUser &&
 413         $this->_values['custom_post_id']
 414       ) {
 415         if (!is_array($this->_values['custom_post_id'])) {
 416           $profileIDs = [$this->_values['custom_post_id']];
 417         }
 418         else {
 419           $profileIDs = $this->_values['custom_post_id'];
 420         }
 421         foreach ($profileIDs as $pid) {
 422           if (CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $pid, 'is_cms_user')) {
 423             $profileID = $pid;
 424             $createCMSUser = TRUE;
 425             break;
 426           }
 427         }
 428       }
 429
 430       if ($createCMSUser) {
 431         CRM_Core_BAO_CMSUser::buildForm($this, $profileID, TRUE);
 432       }
 433     }
 434     if ($this->_pcpId && empty($this->_ccid)) {
 435       if (CRM_PCP_BAO_PCP::displayName($this->_pcpId)) {
 436         $pcp_supporter_text = CRM_PCP_BAO_PCP::getPcpSupporterText($this->_pcpId, $this->_id, 'contribute');
 437         $this->assign('pcpSupporterText', $pcp_supporter_text);
 438       }
 439       $prms = ['id' => $this->_pcpId];
 440       CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $prms, $pcpInfo);
 441       if ($pcpInfo['is_honor_roll']) {
 442         $this->assign('isHonor', TRUE);
 443         $this->add('checkbox', 'pcp_display_in_roll', ts('Show my contribution in the public honor roll'), NULL, NULL,
 444           ['onclick' => "showHideByValue('pcp_display_in_roll','','nameID|nickID|personalNoteID','block','radio',false); pcpAnonymous( );"]
 445         );
 446         $extraOption = ['onclick' => "return pcpAnonymous( );"];
 447         $elements = [];
 448         $elements[] = &$this->createElement('radio', NULL, '', ts('Include my name and message'), 0, $extraOption);
 449         $elements[] = &$this->createElement('radio', NULL, '', ts('List my contribution anonymously'), 1, $extraOption);
 450         $this->addGroup($elements, 'pcp_is_anonymous', NULL, '&nbsp;&nbsp;&nbsp;');
 451
 452         $this->add('text', 'pcp_roll_nickname', ts('Name'), ['maxlength' => 30]);
 453         $this->addField('pcp_personal_note', ['entity' => 'ContributionSoft', 'context' => 'create', 'style' => 'height: 3em; width: 40em;']);
 454       }
 455     }
 456     if (empty($this->_values['fee']) && empty($this->_ccid)) {
 457       throw new CRM_Core_Exception(ts('This page does not have any price fields configured or you may not have permission for them. Please contact the site administrator for more details.'));
 458     }
 459
 460     //we have to load confirm contribution button in template
 461     //when multiple payment processor as the user
 462     //can toggle with payment processor selection
 463     $billingModePaymentProcessors = 0;
 464     if (!empty($this->_paymentProcessors)) {
 465       foreach ($this->_paymentProcessors as $key => $values) {
 466         if ($values['billing_mode'] == CRM_Core_Payment::BILLING_MODE_BUTTON) {
 467           $billingModePaymentProcessors++;
 468         }
 469       }
 470     }
 471
 472     if ($billingModePaymentProcessors && count($this->_paymentProcessors) == $billingModePaymentProcessors) {
 473       $allAreBillingModeProcessors = TRUE;
 474     }
 475     else {
 476       $allAreBillingModeProcessors = FALSE;
 477     }
 478
 479     if (!($allAreBillingModeProcessors && !$this->_values['is_pay_later'])) {
 480       $submitButton = [
 481         'type' => 'upload',
 482         'name' => ts('Contribute'),
 483         'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 484         'isDefault' => TRUE,
 485       ];
 486       if (!empty($this->_values['is_confirm_enabled'])) {
 487         $submitButton['name'] = ts('Review your contribution');
 488         $submitButton['icon'] = 'fa-chevron-right';
 489       }
 490       // Add submit-once behavior when confirm page disabled
 491       if (empty($this->_values['is_confirm_enabled'])) {
 492         $this->submitOnce = TRUE;
 493       }
 494       //change button name for updating contribution
 495       if (!empty($this->_ccid)) {
 496         $submitButton['name'] = ts('Confirm Payment');
 497       }
 498       $this->addButtons([$submitButton]);
 499     }
 500
 501     $this->addFormRule(['CRM_Contribute_Form_Contribution_Main', 'formRule'], $this);
 502   }
 503
 504   /**
 505    * Build elements to collect information for recurring contributions.
 506    *
 507    *
 508    * @param CRM_Core_Form $form
 509    */
 510   public static function buildRecur(&$form) {
 511     $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionRecur');
 512     $className = get_class($form);
 513
 514     $form->assign('is_recur_interval', CRM_Utils_Array::value('is_recur_interval', $form->_values));
 515     $form->assign('is_recur_installments', CRM_Utils_Array::value('is_recur_installments', $form->_values));
 516     $paymentObject = $form->getVar('_paymentObject');
 517     if ($paymentObject) {
 518       $form->assign('recurringHelpText', $paymentObject->getText('contributionPageRecurringHelp', [
 519         'is_recur_installments' => !empty($form->_values['is_recur_installments']),
 520         'is_email_receipt' => !empty($form->_values['is_email_receipt']),
 521       ]));
 522     }
 523
 524     $form->add('checkbox', 'is_recur', ts('I want to contribute this amount'), NULL);
 525
 526     if (!empty($form->_values['is_recur_interval']) || $className == 'CRM_Contribute_Form_Contribution') {
 527       $form->add('text', 'frequency_interval', ts('Every'), $attributes['frequency_interval'] + ['aria-label' => ts('Every')]);
 528       $form->addRule('frequency_interval', ts('Frequency must be a whole number (EXAMPLE: Every 3 months).'), 'integer');
 529     }
 530     else {
 531       // make sure frequency_interval is submitted as 1 if given no choice to user.
 532       $form->add('hidden', 'frequency_interval', 1);
 533     }
 534
 535     $frUnits = $form->_values['recur_frequency_unit'] ?? NULL;
 536     if (empty($frUnits) &&
 537       $className == 'CRM_Contribute_Form_Contribution'
 538     ) {
 539       $frUnits = implode(CRM_Core_DAO::VALUE_SEPARATOR,
 540         CRM_Core_OptionGroup::values('recur_frequency_units')
 541       );
 542     }
 543
 544     $unitVals = explode(CRM_Core_DAO::VALUE_SEPARATOR, $frUnits);
 545
 546     // CRM 10860, display text instead of a dropdown if there's only 1 frequency unit
 547     if (count($unitVals) == 1) {
 548       $form->assign('one_frequency_unit', TRUE);
 549       $unit = $unitVals[0];
 550       $form->add('hidden', 'frequency_unit', $unit);
 551       if (!empty($form->_values['is_recur_interval']) || $className == 'CRM_Contribute_Form_Contribution') {
 552         $unit .= "(s)";
 553       }
 554       $form->assign('frequency_unit', $unit);
 555     }
 556     else {
 557       $form->assign('one_frequency_unit', FALSE);
 558       $units = [];
 559       $frequencyUnits = CRM_Core_OptionGroup::values('recur_frequency_units', FALSE, FALSE, TRUE);
 560       foreach ($unitVals as $key => $val) {
 561         if (array_key_exists($val, $frequencyUnits)) {
 562           $units[$val] = $frequencyUnits[$val];
 563           if (!empty($form->_values['is_recur_interval']) || $className == 'CRM_Contribute_Form_Contribution') {
 564             $units[$val] = "{$frequencyUnits[$val]}(s)";
 565           }
 566         }
 567       }
 568       $frequencyUnit = &$form->addElement('select', 'frequency_unit', NULL, $units, ['aria-label' => ts('Frequency Unit')]);
 569     }
 570
 571     // FIXME: Ideally we should freeze select box if there is only
 572     // one option but looks there is some problem /w QF freeze.
 573     //if ( count( $units ) == 1 ) {
 574     //$frequencyUnit->freeze( );
 575     //}
 576
 577     $form->add('text', 'installments', ts('installments'),
 578       $attributes['installments']
 579     );
 580     $form->addRule('installments', ts('Number of installments must be a whole number.'), 'integer');
 581   }
 582
 583   /**
 584    * Global form rule.
 585    *
 586    * @param array $fields
 587    *   The input form values.
 588    * @param array $files
 589    *   The uploaded files if any.
 590    * @param \CRM_Contribute_Form_Contribution_Main $self
 591    *
 592    * @return bool|array
 593    *   true if no errors, else array of errors
 594    */
 595   public static function formRule($fields, $files, $self) {
 596     $errors = [];
 597     $amount = self::computeAmount($fields, $self->_values);
 598     if (!empty($fields['auto_renew']) && empty($fields['payment_processor_id'])) {
 599       $errors['auto_renew'] = ts('You cannot have auto-renewal on if you are paying later.');
 600     }
 601
 602     if ((!empty($fields['selectMembership']) &&
 603         $fields['selectMembership'] != 'no_thanks'
 604       ) ||
 605       (!empty($fields['priceSetId']) &&
 606         $self->_useForMember
 607       )
 608     ) {
 609       $isTest = $self->_action & CRM_Core_Action::PREVIEW;
 610       $lifeMember = CRM_Member_BAO_Membership::getAllContactMembership($self->_membershipContactID, $isTest, TRUE);
 611
 612       $membershipOrgDetails = CRM_Member_BAO_MembershipType::getMembershipTypeOrganization();
 613
 614       $unallowedOrgs = [];
 615       foreach (array_keys($lifeMember) as $memTypeId) {
 616         $unallowedOrgs[] = $membershipOrgDetails[$memTypeId];
 617       }
 618     }
 619
 620     //check for atleast one pricefields should be selected
 621     if (!empty($fields['priceSetId']) && empty($self->_ccid)) {
 622       $priceField = new CRM_Price_DAO_PriceField();
 623       $priceField->price_set_id = $fields['priceSetId'];
 624       $priceField->orderBy('weight');
 625       $priceField->find();
 626
 627       $check = [];
 628       $membershipIsActive = TRUE;
 629       $previousId = $otherAmount = FALSE;
 630       while ($priceField->fetch()) {
 631
 632         if ($self->isQuickConfig() && ($priceField->name == 'contribution_amount' || $priceField->name == 'membership_amount')) {
 633           $previousId = $priceField->id;
 634           if ($priceField->name == 'membership_amount' && !$priceField->is_active) {
 635             $membershipIsActive = FALSE;
 636           }
 637         }
 638         if ($priceField->name == 'other_amount') {
 639           if ($self->_quickConfig && empty($fields["price_{$priceField->id}"]) &&
 640             array_key_exists("price_{$previousId}", $fields) && isset($fields["price_{$previousId}"]) && $self->_values['fee'][$previousId]['name'] == 'contribution_amount' && empty($fields["price_{$previousId}"])
 641           ) {
 642             $otherAmount = $priceField->id;
 643           }
 644           elseif (!empty($fields["price_{$priceField->id}"])) {
 645             $otherAmountVal = CRM_Utils_Rule::cleanMoney($fields["price_{$priceField->id}"]);
 646             $min = $self->_values['min_amount'] ?? NULL;
 647             $max = $self->_values['max_amount'] ?? NULL;
 648             if ($min && $otherAmountVal < $min) {
 649               $errors["price_{$priceField->id}"] = ts('Contribution amount must be at least %1',
 650                 [1 => $min]
 651               );
 652             }
 653             if ($max && $otherAmountVal > $max) {
 654               $errors["price_{$priceField->id}"] = ts('Contribution amount cannot be more than %1.',
 655                 [1 => $max]
 656               );
 657             }
 658           }
 659         }
 660         if (!empty($fields["price_{$priceField->id}"]) || ($previousId == $priceField->id && isset($fields["price_{$previousId}"])
 661             && empty($fields["price_{$previousId}"]))
 662         ) {
 663           $check[] = $priceField->id;
 664         }
 665       }
 666
 667       $currentMemberships = NULL;
 668       if ($membershipIsActive) {
 669         $is_test = $self->_mode != 'live' ? 1 : 0;
 670         $memContactID = $self->_membershipContactID;
 671
 672         // For anonymous user check using dedupe rule
 673         // if user has Cancelled Membership
 674         if (!$memContactID) {
 675           $memContactID = CRM_Contact_BAO_Contact::getFirstDuplicateContact($fields, 'Individual', 'Unsupervised', [], FALSE);
 676         }
 677         $currentMemberships = CRM_Member_BAO_Membership::getContactsCancelledMembership($memContactID,
 678           $is_test
 679         );
 680
 681         foreach ($self->_values['fee'] as $fieldKey => $fieldValue) {
 682           if ($fieldValue['html_type'] != 'Text' && !empty($fields['price_' . $fieldKey])) {
 683             if (!is_array($fields['price_' . $fieldKey]) && isset($fieldValue['options'][$fields['price_' . $fieldKey]])) {
 684               if (array_key_exists('membership_type_id', $fieldValue['options'][$fields['price_' . $fieldKey]])
 685                 && in_array($fieldValue['options'][$fields['price_' . $fieldKey]]['membership_type_id'], $currentMemberships)
 686               ) {
 687                 $errors['price_' . $fieldKey] = ts('Your %1 membership was previously cancelled and can not be renewed online. Please contact the site administrator for assistance.', [1 => CRM_Member_PseudoConstant::membershipType($fieldValue['options'][$fields['price_' . $fieldKey]]['membership_type_id'])]);
 688               }
 689             }
 690             else {
 691               if (is_array($fields['price_' . $fieldKey])) {
 692                 foreach (array_keys($fields['price_' . $fieldKey]) as $key) {
 693                   if (array_key_exists('membership_type_id', $fieldValue['options'][$key])
 694                     && in_array($fieldValue['options'][$key]['membership_type_id'], $currentMemberships)
 695                   ) {
 696                     $errors['price_' . $fieldKey] = ts('Your %1 membership was previously cancelled and can not be renewed online. Please contact the site administrator for assistance.', [1 => CRM_Member_PseudoConstant::membershipType($fieldValue['options'][$key]['membership_type_id'])]);
 697                   }
 698                 }
 699               }
 700             }
 701           }
 702         }
 703       }
 704
 705       // CRM-12233
 706       if ($membershipIsActive && empty($self->_membershipBlock['is_required'])
 707         && $self->_values['amount_block_is_active']
 708       ) {
 709         $membershipFieldId = $contributionFieldId = $errorKey = $otherFieldId = NULL;
 710         foreach ($self->_values['fee'] as $fieldKey => $fieldValue) {
 711           // if 'No thank you' membership is selected then set $membershipFieldId
 712           if ($fieldValue['name'] == 'membership_amount' && CRM_Utils_Array::value('price_' . $fieldKey, $fields) == 0) {
 713             $membershipFieldId = $fieldKey;
 714           }
 715           elseif ($membershipFieldId) {
 716             if ($fieldValue['name'] == 'other_amount') {
 717               $otherFieldId = $fieldKey;
 718             }
 719             elseif ($fieldValue['name'] == 'contribution_amount') {
 720               $contributionFieldId = $fieldKey;
 721             }
 722
 723             if (!$errorKey || CRM_Utils_Array::value('price_' . $contributionFieldId, $fields) == '0') {
 724               $errorKey = $fieldKey;
 725             }
 726           }
 727         }
 728         // $membershipFieldId is set and additional amount is 'No thank you' or NULL then throw error
 729         if ($membershipFieldId && !(CRM_Utils_Array::value('price_' . $contributionFieldId, $fields, -1) > 0) && empty($fields['price_' . $otherFieldId])) {
 730           $errors["price_{$errorKey}"] = ts('Additional Contribution is required.');
 731         }
 732       }
 733       if (empty($check) && empty($self->_ccid)) {
 734         if ($self->_useForMember == 1 && $membershipIsActive) {
 735           $errors['_qf_default'] = ts('Select at least one option from Membership Type(s).');
 736         }
 737         else {
 738           $errors['_qf_default'] = ts('Select at least one option from Contribution(s).');
 739         }
 740       }
 741       if ($otherAmount && !empty($check)) {
 742         $errors["price_{$otherAmount}"] = ts('Amount is required field.');
 743       }
 744
 745       if ($self->_useForMember == 1 && !empty($check) && $membershipIsActive) {
 746         $priceFieldIDS = [];
 747         $priceFieldMemTypes = [];
 748
 749         foreach ($self->_priceSet['fields'] as $priceId => $value) {
 750           if (!empty($fields['price_' . $priceId]) || ($self->_quickConfig && $value['name'] == 'membership_amount' && empty($self->_membershipBlock['is_required']))) {
 751             if (!empty($fields['price_' . $priceId]) && is_array($fields['price_' . $priceId])) {
 752               foreach ($fields['price_' . $priceId] as $priceFldVal => $isSet) {
 753                 if ($isSet) {
 754                   $priceFieldIDS[] = $priceFldVal;
 755                 }
 756               }
 757             }
 758             elseif (!$value['is_enter_qty'] && !empty($fields['price_' . $priceId])) {
 759               // The check for {!$value['is_enter_qty']} is done since, quantity fields allow entering
 760               // quantity. And the quantity can't be conisdered as civicrm_price_field_value.id, CRM-9577
 761               $priceFieldIDS[] = $fields['price_' . $priceId];
 762             }
 763
 764             if (!empty($value['options'])) {
 765               foreach ($value['options'] as $val) {
 766                 if (!empty($val['membership_type_id']) && (
 767                     ($fields['price_' . $priceId] == $val['id']) ||
 768                     (isset($fields['price_' . $priceId]) && !empty($fields['price_' . $priceId][$val['id']]))
 769                   )
 770                 ) {
 771                   $priceFieldMemTypes[] = $val['membership_type_id'];
 772                 }
 773               }
 774             }
 775           }
 776         }
 777
 778         if (!empty($lifeMember)) {
 779           foreach ($priceFieldIDS as $priceFieldId) {
 780             if (($id = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id')) &&
 781               in_array($membershipOrgDetails[$id], $unallowedOrgs)
 782             ) {
 783               $errors['_qf_default'] = ts('You already have a lifetime membership and cannot select a membership with a shorter term.');
 784               break;
 785             }
 786           }
 787         }
 788
 789         if (!empty($priceFieldIDS)) {
 790           $ids = implode(',', $priceFieldIDS);
 791
 792           $priceFieldIDS['id'] = $fields['priceSetId'];
 793           $self->set('memberPriceFieldIDS', $priceFieldIDS);
 794           $count = CRM_Price_BAO_PriceSet::getMembershipCount($ids);
 795           foreach ($count as $id => $occurrence) {
 796             if ($occurrence > 1) {
 797               $errors['_qf_default'] = ts('You have selected multiple memberships for the same organization or entity. Please review your selections and choose only one membership per entity. Contact the site administrator if you need assistance.');
 798             }
 799           }
 800         }
 801
 802         if (empty($priceFieldMemTypes) && $self->_membershipBlock['is_required'] == 1) {
 803           $errors['_qf_default'] = ts('Please select at least one membership option.');
 804         }
 805       }
 806
 807       CRM_Price_BAO_PriceSet::processAmount($self->_values['fee'],
 808         $fields, $lineItem
 809       );
 810
 811       $minAmt = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $fields['priceSetId'], 'min_amount');
 812       if ($fields['amount'] < 0) {
 813         $errors['_qf_default'] = ts('Contribution can not be less than zero. Please select the options accordingly');
 814       }
 815       elseif (!empty($minAmt) && $fields['amount'] < $minAmt) {
 816         $errors['_qf_default'] = ts('A minimum amount of %1 should be selected from Contribution(s).', [
 817           1 => CRM_Utils_Money::format($minAmt),
 818         ]);
 819       }
 820
 821       $amount = $fields['amount'];
 822     }
 823
 824     if (isset($fields['selectProduct']) &&
 825       $fields['selectProduct'] != 'no_thanks'
 826     ) {
 827       $productDAO = new CRM_Contribute_DAO_Product();
 828       $productDAO->id = $fields['selectProduct'];
 829       $productDAO->find(TRUE);
 830       $min_amount = $productDAO->min_contribution;
 831
 832       if ($amount < $min_amount) {
 833         $errors['selectProduct'] = ts('The premium you have selected requires a minimum contribution of %1', [1 => CRM_Utils_Money::format($min_amount)]);
 834         CRM_Core_Session::setStatus($errors['selectProduct']);
 835       }
 836     }
 837
 838     //CRM-16285 - Function to handle validation errors on form, for recurring contribution field.
 839     CRM_Contribute_BAO_ContributionRecur::validateRecurContribution($fields, $files, $self, $errors);
 840
 841     if (!empty($fields['is_recur']) && empty($fields['payment_processor_id'])) {
 842       $errors['_qf_default'] = ts('You cannot set up a recurring contribution if you are not paying online by credit card.');
 843     }
 844
 845     // validate PCP fields - if not anonymous, we need a nick name value
 846     if ($self->_pcpId && !empty($fields['pcp_display_in_roll']) &&
 847       empty($fields['pcp_is_anonymous']) &&
 848       CRM_Utils_Array::value('pcp_roll_nickname', $fields) == ''
 849     ) {
 850       $errors['pcp_roll_nickname'] = ts('Please enter a name to include in the Honor Roll, or select \'contribute anonymously\'.');
 851     }
 852
 853     // return if this is express mode
 854     $config = CRM_Core_Config::singleton();
 855     if ($self->_paymentProcessor &&
 856       (int) $self->_paymentProcessor['billing_mode'] & CRM_Core_Payment::BILLING_MODE_BUTTON
 857     ) {
 858       if (!empty($fields[$self->_expressButtonName . '_x']) || !empty($fields[$self->_expressButtonName . '_y']) ||
 859         !empty($fields[$self->_expressButtonName])
 860       ) {
 861         return $errors;
 862       }
 863     }
 864
 865     //validate the pledge fields.
 866     if (!empty($self->_values['pledge_block_id'])) {
 867       //validation for pledge payment.
 868       if (!empty($self->_values['pledge_id'])) {
 869         if (empty($fields['pledge_amount'])) {
 870           $errors['pledge_amount'] = ts('At least one payment option needs to be checked.');
 871         }
 872       }
 873       elseif (!empty($fields['is_pledge'])) {
 874         if (CRM_Utils_Rule::positiveInteger(CRM_Utils_Array::value('pledge_installments', $fields)) == FALSE) {
 875           $errors['pledge_installments'] = ts('Please enter a valid number of pledge installments.');
 876         }
 877         else {
 878           if (!isset($fields['pledge_installments'])) {
 879             $errors['pledge_installments'] = ts('Pledge Installments is required field.');
 880           }
 881           elseif (CRM_Utils_Array::value('pledge_installments', $fields) == 1) {
 882             $errors['pledge_installments'] = ts('Pledges consist of multiple scheduled payments. Select one-time contribution if you want to make your gift in a single payment.');
 883           }
 884           elseif (empty($fields['pledge_installments'])) {
 885             $errors['pledge_installments'] = ts('Pledge Installments field must be > 1.');
 886           }
 887         }
 888
 889         //validation for Pledge Frequency Interval.
 890         if (CRM_Utils_Rule::positiveInteger(CRM_Utils_Array::value('pledge_frequency_interval', $fields)) == FALSE) {
 891           $errors['pledge_frequency_interval'] = ts('Please enter a valid Pledge Frequency Interval.');
 892         }
 893         else {
 894           if (!isset($fields['pledge_frequency_interval'])) {
 895             $errors['pledge_frequency_interval'] = ts('Pledge Frequency Interval. is required field.');
 896           }
 897           elseif (empty($fields['pledge_frequency_interval'])) {
 898             $errors['pledge_frequency_interval'] = ts('Pledge frequency interval field must be > 0');
 899           }
 900         }
 901       }
 902     }
 903
 904     // if the user has chosen a free membership or the amount is less than zero
 905     // i.e. we don't need to validate payment related fields or profiles.
 906     if ((float) $amount <= 0.0) {
 907       return $errors;
 908     }
 909
 910     if (!isset($fields['payment_processor_id'])) {
 911       $errors['payment_processor_id'] = ts('Payment Method is a required field.');
 912     }
 913     else {
 914       CRM_Core_Payment_Form::validatePaymentInstrument(
 915         $fields['payment_processor_id'],
 916         $fields,
 917         $errors,
 918         (!$self->_isBillingAddressRequiredForPayLater ? NULL : 'billing')
 919       );
 920     }
 921
 922     foreach (CRM_Contact_BAO_Contact::$_greetingTypes as $greeting) {
 923       if ($greetingType = CRM_Utils_Array::value($greeting, $fields)) {
 924         $customizedValue = CRM_Core_PseudoConstant::getKey('CRM_Contact_BAO_Contact', $greeting . '_id', 'Customized');
 925         if ($customizedValue == $greetingType && empty($fielse[$greeting . '_custom'])) {
 926           $errors[$greeting . '_custom'] = ts('Custom %1 is a required field if %1 is of type Customized.',
 927             [1 => ucwords(str_replace('_', " ", $greeting))]
 928           );
 929         }
 930       }
 931     }
 932
 933     return empty($errors) ? TRUE : $errors;
 934   }
 935
 936   /**
 937    * Compute amount to be paid.
 938    *
 939    * @param array $params
 940    * @param array $formValues
 941    *
 942    * @return int|mixed|null|string
 943    */
 944   public static function computeAmount($params, $formValues) {
 945     $amount = 0;
 946     // First clean up the other amount field if present.
 947     if (isset($params['amount_other'])) {
 948       $params['amount_other'] = CRM_Utils_Rule::cleanMoney($params['amount_other']);
 949     }
 950
 951     if (CRM_Utils_Array::value('amount', $params) == 'amount_other_radio' || !empty($params['amount_other'])) {
 952       $amount = $params['amount_other'];
 953     }
 954     elseif (!empty($params['pledge_amount'])) {
 955       foreach ($params['pledge_amount'] as $paymentId => $dontCare) {
 956         $amount += CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment', $paymentId, 'scheduled_amount');
 957       }
 958     }
 959     else {
 960       if (!empty($formValues['amount'])) {
 961         $amountID = $params['amount'] ?? NULL;
 962
 963         if ($amountID) {
 964           // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
 965           // function to get correct amount level consistently. Remove setting of the amount level in
 966           // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
 967           // to cover all variants.
 968           $params['amount_level'] = $formValues[$amountID]['label'] ?? NULL;
 969           $amount = $formValues[$amountID]['value'] ?? NULL;
 970         }
 971       }
 972     }
 973     return $amount;
 974   }
 975
 976   /**
 977    * Process the form submission.
 978    */
 979   public function postProcess() {
 980     // we first reset the confirm page so it accepts new values
 981     $this->controller->resetPage('Confirm');
 982
 983     // get the submitted form values.
 984     $params = $this->controller->exportValues($this->_name);
 985     $this->submit($params);
 986
 987     if (empty($this->_values['is_confirm_enabled'])) {
 988       $this->skipToThankYouPage();
 989     }
 990
 991   }
 992
 993   /**
 994    * Submit function.
 995    *
 996    * This is the guts of the postProcess made also accessible to the test suite.
 997    *
 998    * @param array $params
 999    *   Submitted values.
1000    *
1001    * @throws \CiviCRM_API3_Exception
1002    */
1003   public function submit($params) {
1004     //carry campaign from profile.
1005     if (array_key_exists('contribution_campaign_id', $params)) {
1006       $params['campaign_id'] = $params['contribution_campaign_id'];
1007     }
1008
1009     $params['currencyID'] = CRM_Core_Config::singleton()->defaultCurrency;
1010
1011     // @todo refactor this & leverage it from the unit tests.
1012     if (!empty($params['priceSetId'])) {
1013       $is_quick_config = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config');
1014       if ($is_quick_config) {
1015         $priceField = new CRM_Price_DAO_PriceField();
1016         $priceField->price_set_id = $params['priceSetId'];
1017         $priceField->orderBy('weight');
1018         $priceField->find();
1019
1020         $priceOptions = [];
1021         while ($priceField->fetch()) {
1022           CRM_Price_BAO_PriceFieldValue::getValues($priceField->id, $priceOptions);
1023           if (($selectedPriceOptionID = CRM_Utils_Array::value("price_{$priceField->id}", $params)) != FALSE && $selectedPriceOptionID > 0) {
1024             switch ($priceField->name) {
1025               case 'membership_amount':
1026                 $this->_params['selectMembership'] = $params['selectMembership'] = $priceOptions[$selectedPriceOptionID]['membership_type_id'] ?? NULL;
1027                 $this->set('selectMembership', $params['selectMembership']);
1028
1029               case 'contribution_amount':
1030                 $params['amount'] = $selectedPriceOptionID;
1031                 if ($priceField->name == 'contribution_amount' ||
1032                     ($priceField->name == 'membership_amount' &&
1033                       CRM_Utils_Array::value('is_separate_payment', $this->_membershipBlock) == 0)
1034                 ) {
1035                   $this->_values['amount'] = $priceOptions[$selectedPriceOptionID]['amount'] ?? NULL;
1036                 }
1037                 $this->_values[$selectedPriceOptionID]['value'] = $priceOptions[$selectedPriceOptionID]['amount'] ?? NULL;
1038                 $this->_values[$selectedPriceOptionID]['label'] = $priceOptions[$selectedPriceOptionID]['label'] ?? NULL;
1039                 $this->_values[$selectedPriceOptionID]['amount_id'] = $priceOptions[$selectedPriceOptionID]['id'] ?? NULL;
1040                 $this->_values[$selectedPriceOptionID]['weight'] = $priceOptions[$selectedPriceOptionID]['weight'] ?? NULL;
1041                 break;
1042
1043               case 'other_amount':
1044                 $params['amount_other'] = $selectedPriceOptionID;
1045                 break;
1046             }
1047           }
1048         }
1049       }
1050     }
1051
1052     if (!empty($this->_ccid) && !empty($this->_pendingAmount)) {
1053       $params['amount'] = $this->_pendingAmount;
1054     }
1055     else {
1056       // from here on down, $params['amount'] holds a monetary value (or null) rather than an option ID
1057       $params['amount'] = self::computeAmount($params, $this->_values);
1058     }
1059
1060     $params['separate_amount'] = $params['amount'];
1061     // @todo - stepping through the code indicates that amount is always set before this point so it never matters.
1062     // Move more of the above into this function...
1063     $params['amount'] = $this->getMainContributionAmount($params);
1064     //If the membership & contribution is used in contribution page & not separate payment
1065     $memPresent = $membershipLabel = $fieldOption = $is_quick_config = NULL;
1066     $proceFieldAmount = 0;
1067     if (property_exists($this, '_separateMembershipPayment') && $this->_separateMembershipPayment == 0) {
1068       $is_quick_config = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config');
1069       if ($is_quick_config) {
1070         foreach ($this->_priceSet['fields'] as $fieldKey => $fieldVal) {
1071           if ($fieldVal['name'] == 'membership_amount' && !empty($params['price_' . $fieldKey])) {
1072             $fieldId = $fieldVal['id'];
1073             $fieldOption = $params['price_' . $fieldId];
1074             $proceFieldAmount += $fieldVal['options'][$this->_submitValues['price_' . $fieldId]]['amount'];
1075             $memPresent = TRUE;
1076           }
1077           else {
1078             if (!empty($params['price_' . $fieldKey]) && $memPresent && ($fieldVal['name'] == 'other_amount' || $fieldVal['name'] == 'contribution_amount')) {
1079               $fieldId = $fieldVal['id'];
1080               if ($fieldVal['name'] == 'other_amount') {
1081                 $proceFieldAmount += $this->_submitValues['price_' . $fieldId];
1082               }
1083               elseif ($fieldVal['name'] == 'contribution_amount' && $this->_submitValues['price_' . $fieldId] > 0) {
1084                 $proceFieldAmount += $fieldVal['options'][$this->_submitValues['price_' . $fieldId]]['amount'];
1085               }
1086               unset($params['price_' . $fieldId]);
1087               break;
1088             }
1089           }
1090         }
1091       }
1092     }
1093
1094     if (!isset($params['amount_other'])) {
1095       $this->set('amount_level', CRM_Utils_Array::value('amount_level', $params));
1096     }
1097
1098     if (!empty($this->_ccid)) {
1099       $this->set('lineItem', $this->_lineItem);
1100     }
1101     elseif ($priceSetId = CRM_Utils_Array::value('priceSetId', $params)) {
1102       $lineItem = [];
1103       $is_quick_config = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
1104       if ($is_quick_config) {
1105         foreach ($this->_values['fee'] as $key => & $val) {
1106           if ($val['name'] == 'other_amount' && $val['html_type'] == 'Text' && !empty($params['price_' . $key])) {
1107             // Clean out any currency symbols.
1108             $params['price_' . $key] = CRM_Utils_Rule::cleanMoney($params['price_' . $key]);
1109             if ($params['price_' . $key] != 0) {
1110               foreach ($val['options'] as $optionKey => & $options) {
1111                 $options['amount'] = $params['price_' . $key] ?? NULL;
1112                 break;
1113               }
1114             }
1115             $params['price_' . $key] = 1;
1116             break;
1117           }
1118         }
1119       }
1120
1121       if ($this->_membershipBlock) {
1122         $this->processAmountAndGetAutoRenew($this->_values['fee'], $params, $lineItem[$priceSetId], $priceSetId);
1123       }
1124       else {
1125         CRM_Price_BAO_PriceSet::processAmount($this->_values['fee'], $params, $lineItem[$priceSetId], $priceSetId);
1126       }
1127
1128       if ($params['tax_amount']) {
1129         $this->set('tax_amount', $params['tax_amount']);
1130       }
1131
1132       if ($proceFieldAmount) {
1133         $lineItem[$params['priceSetId']][$fieldOption]['unit_price'] = $proceFieldAmount;
1134         $lineItem[$params['priceSetId']][$fieldOption]['line_total'] = $proceFieldAmount;
1135         if (isset($lineItem[$params['priceSetId']][$fieldOption]['tax_amount'])) {
1136           $proceFieldAmount += $lineItem[$params['priceSetId']][$fieldOption]['tax_amount'];
1137         }
1138         if (!$this->_membershipBlock['is_separate_payment']) {
1139           //require when separate membership not used
1140           $params['amount'] = $proceFieldAmount;
1141         }
1142       }
1143       $this->set('lineItem', $lineItem);
1144     }
1145
1146     if ($params['amount'] != 0 && (($this->_values['is_pay_later'] &&
1147           empty($this->_paymentProcessor) &&
1148           !array_key_exists('hidden_processor', $params)) ||
1149         empty($params['payment_processor_id']))
1150     ) {
1151       $params['is_pay_later'] = 1;
1152     }
1153     else {
1154       $params['is_pay_later'] = 0;
1155     }
1156
1157     // Would be nice to someday understand the point of this set.
1158     $this->set('is_pay_later', $params['is_pay_later']);
1159     // assign pay later stuff
1160     $this->_params['is_pay_later'] = CRM_Utils_Array::value('is_pay_later', $params, FALSE);
1161     $this->assign('is_pay_later', $params['is_pay_later']);
1162     if ($params['is_pay_later']) {
1163       $this->assign('pay_later_text', $this->_values['pay_later_text']);
1164       $this->assign('pay_later_receipt', CRM_Utils_Array::value('pay_later_receipt', $this->_values));
1165     }
1166
1167     if ($this->_membershipBlock['is_separate_payment'] && !empty($params['separate_amount'])) {
1168       $this->set('amount', $params['separate_amount']);
1169     }
1170     else {
1171       $this->set('amount', $params['amount']);
1172     }
1173
1174     // generate and set an invoiceID for this transaction
1175     $invoiceID = md5(uniqid(rand(), TRUE));
1176     $this->set('invoiceID', $invoiceID);
1177     $params['invoiceID'] = $invoiceID;
1178     $title = !empty($this->_values['frontend_title']) ? $this->_values['frontend_title'] : $this->_values['title'];
1179     $params['description'] = ts('Online Contribution') . ': ' . ((!empty($this->_pcpInfo['title']) ? $this->_pcpInfo['title'] : $title));
1180     $params['button'] = $this->controller->getButtonName();
1181     // required only if is_monetary and valid positive amount
1182     if ($this->_values['is_monetary'] &&
1183       !empty($this->_paymentProcessor) &&
1184       ((float) $params['amount'] > 0.0 || $this->hasSeparateMembershipPaymentAmount($params))
1185     ) {
1186       // The concept of contributeMode is deprecated - as should be the 'is_monetary' setting.
1187       $this->setContributeMode();
1188       // Really this setting of $this->_params & params within it should be done earlier on in the function
1189       // probably the values determined here should be reused in confirm postProcess as there is no opportunity to alter anything
1190       // on the confirm page. However as we are dealing with a stable release we go as close to where it is used
1191       // as possible.
1192       // In general the form has a lack of clarity of the logic of why things are set on the form in some cases &
1193       // the logic around when $this->_params is used compared to other params arrays.
1194       $this->_params = array_merge($params, $this->_params);
1195       $this->setRecurringMembershipParams();
1196       if ($this->_paymentProcessor &&
1197         $this->_paymentProcessor['object']->supports('preApproval')
1198       ) {
1199         $this->handlePreApproval($this->_params);
1200       }
1201     }
1202   }
1203
1204   /**
1205    * Assign the billing mode to the template.
1206    *
1207    * This is required for legacy support for contributeMode in templates.
1208    *
1209    * The goal is to remove this parameter & use more relevant parameters.
1210    */
1211   protected function setContributeMode() {
1212     switch ($this->_paymentProcessor['billing_mode']) {
1213       case CRM_Core_Payment::BILLING_MODE_FORM:
1214         $this->set('contributeMode', 'direct');
1215         break;
1216
1217       case CRM_Core_Payment::BILLING_MODE_BUTTON:
1218         $this->set('contributeMode', 'express');
1219         break;
1220
1221       case CRM_Core_Payment::BILLING_MODE_NOTIFY:
1222         $this->set('contributeMode', 'notify');
1223         break;
1224     }
1225
1226   }
1227
1228   /**
1229    * Process confirm function and pass browser to the thank you page.
1230    */
1231   protected function skipToThankYouPage() {
1232     // call the post process hook for the main page before we switch to confirm
1233     $this->postProcessHook();
1234
1235     // build the confirm page
1236     $confirmForm = &$this->controller->_pages['Confirm'];
1237     $confirmForm->preProcess();
1238     $confirmForm->buildQuickForm();
1239
1240     // the confirmation page is valid
1241     $data = &$this->controller->container();
1242     $data['valid']['Confirm'] = 1;
1243
1244     // confirm the contribution
1245     // mainProcess calls the hook also
1246     $confirmForm->mainProcess();
1247     $qfKey = $this->controller->_key;
1248
1249     // redirect to thank you page
1250     CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/transact', "_qf_ThankYou_display=1&qfKey=$qfKey", TRUE, NULL, FALSE));
1251   }
1252
1253   /**
1254    * Set form variables if contribution ID is found
1255    */
1256   public function assignFormVariablesByContributionID() {
1257     if (empty($this->_ccid)) {
1258       return;
1259     }
1260     if (!$this->getContactID()) {
1261       CRM_Core_Error::statusBounce(ts("Returning since there is no contact attached to this contribution id."));
1262     }
1263
1264     $paymentBalance = CRM_Contribute_BAO_Contribution::getContributionBalance($this->_ccid);
1265     //bounce if the contribution is not pending.
1266     if ((int) $paymentBalance <= 0) {
1267       CRM_Core_Error::statusBounce(ts("Returning since contribution has already been handled."));
1268     }
1269     if (!empty($paymentBalance)) {
1270       $this->_pendingAmount = $paymentBalance;
1271       $this->assign('pendingAmount', $this->_pendingAmount);
1272     }
1273
1274     if ($taxAmount = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_ccid, 'tax_amount')) {
1275       $this->set('tax_amount', $taxAmount);
1276       $this->assign('taxAmount', $taxAmount);
1277     }
1278
1279     $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($this->_ccid);
1280     foreach (array_keys($lineItems) as $id) {
1281       $lineItems[$id]['id'] = $id;
1282     }
1283     $itemId = key($lineItems);
1284     if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1285       $this->_priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1286     }
1287
1288     if (!empty($lineItems[$itemId]['price_field_id'])) {
1289       $this->_lineItem[$this->_priceSetId] = $lineItems;
1290     }
1291     $isQuickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config');
1292     $this->assign('lineItem', $this->_lineItem);
1293     $this->assign('is_quick_config', $isQuickConfig);
1294     $this->assign('priceSetID', $this->_priceSetId);
1295   }
1296
1297   /**
1298    * Function for unit tests on the postProcess function.
1299    *
1300    * @param array $params
1301    *
1302    * @throws \CiviCRM_API3_Exception
1303    */
1304   public function testSubmit($params) {
1305     $_SERVER['REQUEST_METHOD'] = 'GET';
1306     $this->controller = new CRM_Contribute_Controller_Contribution();
1307     $this->submit($params);
1308   }
1309
1310   /**
1311    * Has a separate membership payment amount been configured.
1312    *
1313    * @param array $params
1314    *
1315    * @return mixed
1316    * @throws \CiviCRM_API3_Exception
1317    */
1318   protected function hasSeparateMembershipPaymentAmount($params) {
1319     return $this->_separateMembershipPayment && (int) CRM_Member_BAO_MembershipType::getMembershipType($params['selectMembership'])['minimum_fee'];
1320   }
1321
1322 }