CRM/Contribute/Form/Contribution/Confirm.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * form to process actions on the group aspect of Custom Data
  36  */
  37 class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_ContributionBase {
  38   use CRM_Financial_Form_FrontEndPaymentFormTrait;
  39
  40   /**
  41    * The id of the contact associated with this contribution.
  42    *
  43    * @var int
  44    */
  45   public $_contactID;
  46
  47
  48   /**
  49    * The id of the contribution object that is created when the form is submitted.
  50    *
  51    * @var int
  52    */
  53   public $_contributionID;
  54
  55   public $submitOnce = TRUE;
  56
  57   /**
  58    * @param $form
  59    * @param $params
  60    * @param $contributionParams
  61    * @param $pledgeID
  62    * @param $contribution
  63    * @param $isEmailReceipt
  64    * @return mixed
  65    */
  66   public static function handlePledge(&$form, $params, $contributionParams, $pledgeID, $contribution, $isEmailReceipt) {
  67     if ($pledgeID) {
  68       //when user doing pledge payments.
  69       //update the schedule when payment(s) are made
  70       $amount = $params['amount'];
  71       $pledgePaymentParams = [];
  72       foreach ($params['pledge_amount'] as $paymentId => $dontCare) {
  73         $scheduledAmount = CRM_Core_DAO::getFieldValue(
  74           'CRM_Pledge_DAO_PledgePayment',
  75           $paymentId,
  76           'scheduled_amount',
  77           'id'
  78         );
  79
  80         $pledgePayment = ($amount >= $scheduledAmount) ? $scheduledAmount : $amount;
  81         if ($pledgePayment > 0) {
  82           $pledgePaymentParams[] = [
  83             'id' => $paymentId,
  84             'contribution_id' => $contribution->id,
  85             'status_id' => $contribution->contribution_status_id,
  86             'actual_amount' => $pledgePayment,
  87           ];
  88           $amount -= $pledgePayment;
  89         }
  90       }
  91       if ($amount > 0 && count($pledgePaymentParams)) {
  92         $pledgePaymentParams[count($pledgePaymentParams) - 1]['actual_amount'] += $amount;
  93       }
  94       foreach ($pledgePaymentParams as $p) {
  95         CRM_Pledge_BAO_PledgePayment::add($p);
  96       }
  97
  98       //update pledge status according to the new payment statuses
  99       CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID);
 100       return $form;
 101     }
 102     else {
 103       //when user creating pledge record.
 104       $pledgeParams = [];
 105       $pledgeParams['contact_id'] = $contribution->contact_id;
 106       $pledgeParams['installment_amount'] = $pledgeParams['actual_amount'] = $contribution->total_amount;
 107       $pledgeParams['contribution_id'] = $contribution->id;
 108       $pledgeParams['contribution_page_id'] = $contribution->contribution_page_id;
 109       $pledgeParams['financial_type_id'] = $contribution->financial_type_id;
 110       $pledgeParams['frequency_interval'] = $params['pledge_frequency_interval'];
 111       $pledgeParams['installments'] = $params['pledge_installments'];
 112       $pledgeParams['frequency_unit'] = $params['pledge_frequency_unit'];
 113       if ($pledgeParams['frequency_unit'] == 'month') {
 114         $pledgeParams['frequency_day'] = intval(date("d"));
 115       }
 116       else {
 117         $pledgeParams['frequency_day'] = 1;
 118       }
 119       $pledgeParams['create_date'] = $pledgeParams['start_date'] = $pledgeParams['scheduled_date'] = date("Ymd");
 120       if (!empty($params['start_date'])) {
 121         $pledgeParams['frequency_day'] = intval(date("d", strtotime(CRM_Utils_Array::value('start_date', $params))));
 122         $pledgeParams['start_date'] = $pledgeParams['scheduled_date'] = date('Ymd', strtotime(CRM_Utils_Array::value('start_date', $params)));
 123       }
 124       $pledgeParams['status_id'] = $contribution->contribution_status_id;
 125       $pledgeParams['max_reminders'] = $form->_values['max_reminders'];
 126       $pledgeParams['initial_reminder_day'] = $form->_values['initial_reminder_day'];
 127       $pledgeParams['additional_reminder_day'] = $form->_values['additional_reminder_day'];
 128       $pledgeParams['is_test'] = $contribution->is_test;
 129       $pledgeParams['acknowledge_date'] = date('Ymd');
 130       $pledgeParams['original_installment_amount'] = $pledgeParams['installment_amount'];
 131
 132       //inherit campaign from contirb page.
 133       $pledgeParams['campaign_id'] = CRM_Utils_Array::value('campaign_id', $contributionParams);
 134
 135       $pledge = CRM_Pledge_BAO_Pledge::create($pledgeParams);
 136
 137       $form->_params['pledge_id'] = $pledge->id;
 138
 139       //send acknowledgment email. only when pledge is created
 140       if ($pledge->id && $isEmailReceipt) {
 141         //build params to send acknowledgment.
 142         $pledgeParams['id'] = $pledge->id;
 143         $pledgeParams['receipt_from_name'] = $form->_values['receipt_from_name'];
 144         $pledgeParams['receipt_from_email'] = $form->_values['receipt_from_email'];
 145
 146         //scheduled amount will be same as installment_amount.
 147         $pledgeParams['scheduled_amount'] = $pledgeParams['installment_amount'];
 148
 149         //get total pledge amount.
 150         $pledgeParams['total_pledge_amount'] = $pledge->amount;
 151
 152         CRM_Pledge_BAO_Pledge::sendAcknowledgment($form, $pledgeParams);
 153         return $form;
 154       }
 155       return $form;
 156     }
 157   }
 158
 159   /**
 160    * Set the parameters to be passed to contribution create function.
 161    *
 162    * @param array $params
 163    * @param int $financialTypeID
 164    * @param array $paymentProcessorOutcome
 165    * @param string $receiptDate
 166    * @param int $recurringContributionID
 167    *
 168    * @return array
 169    */
 170   public static function getContributionParams(
 171     $params, $financialTypeID,
 172     $paymentProcessorOutcome, $receiptDate, $recurringContributionID) {
 173     $contributionParams = [
 174       'financial_type_id' => $financialTypeID,
 175       'receive_date' => (CRM_Utils_Array::value('receive_date', $params)) ? CRM_Utils_Date::processDate($params['receive_date']) : date('YmdHis'),
 176       'tax_amount' => CRM_Utils_Array::value('tax_amount', $params),
 177       'amount_level' => CRM_Utils_Array::value('amount_level', $params),
 178       'invoice_id' => $params['invoiceID'],
 179       'currency' => $params['currencyID'],
 180       'is_pay_later' => CRM_Utils_Array::value('is_pay_later', $params, 0),
 181       //configure cancel reason, cancel date and thankyou date
 182       //from 'contribution' type profile if included
 183       'cancel_reason' => CRM_Utils_Array::value('cancel_reason', $params, 0),
 184       'cancel_date' => isset($params['cancel_date']) ? CRM_Utils_Date::format($params['cancel_date']) : NULL,
 185       'thankyou_date' => isset($params['thankyou_date']) ? CRM_Utils_Date::format($params['thankyou_date']) : NULL,
 186       //setting to make available to hook - although seems wrong to set on form for BAO hook availability
 187       'skipLineItem' => CRM_Utils_Array::value('skipLineItem', $params, 0),
 188     ];
 189
 190     if ($paymentProcessorOutcome) {
 191       $contributionParams['payment_processor'] = CRM_Utils_Array::value('payment_processor', $paymentProcessorOutcome);
 192     }
 193     if (!empty($params["is_email_receipt"])) {
 194       $contributionParams += [
 195         'receipt_date' => $receiptDate,
 196       ];
 197     }
 198
 199     if ($recurringContributionID) {
 200       $contributionParams['contribution_recur_id'] = $recurringContributionID;
 201     }
 202
 203     $contributionParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
 204     if (isset($contributionParams['invoice_id'])) {
 205       $contributionParams['id'] = CRM_Core_DAO::getFieldValue(
 206         'CRM_Contribute_DAO_Contribution',
 207         $contributionParams['invoice_id'],
 208         'id',
 209         'invoice_id'
 210       );
 211     }
 212
 213     return $contributionParams;
 214   }
 215
 216   /**
 217    * Get non-deductible amount.
 218    *
 219    * This is a bit too much about wierd form interpretation to be this deep.
 220    *
 221    * CRM-11885
 222    *  if non_deductible_amount exists i.e. Additional Details fieldset was opened [and staff typed something] -> keep
 223    * it.
 224    *
 225    * @param array $params
 226    * @param CRM_Financial_BAO_FinancialType $financialType
 227    * @param bool $online
 228    * @param CRM_Contribute_Form_Contribution_Confirm $form
 229    *
 230    * @return array
 231    */
 232   protected static function getNonDeductibleAmount($params, $financialType, $online, $form) {
 233     if (isset($params['non_deductible_amount']) && (!empty($params['non_deductible_amount']))) {
 234       return $params['non_deductible_amount'];
 235     }
 236     $priceSetId = CRM_Utils_Array::value('priceSetId', $params);
 237     // return non-deductible amount if it is set at the price field option level
 238     if ($priceSetId && !empty($form->_lineItem)) {
 239       $nonDeductibleAmount = CRM_Price_BAO_PriceSet::getNonDeductibleAmountFromPriceSet($priceSetId, $form->_lineItem);
 240     }
 241
 242     if (!empty($nonDeductibleAmount)) {
 243       return $nonDeductibleAmount;
 244     }
 245     else {
 246       if ($financialType->is_deductible) {
 247         if ($online && isset($params['selectProduct'])) {
 248           $selectProduct = CRM_Utils_Array::value('selectProduct', $params);
 249         }
 250         if (!$online && isset($params['product_name'][0])) {
 251           $selectProduct = $params['product_name'][0];
 252         }
 253         // if there is a product - compare the value to the contribution amount
 254         if (isset($selectProduct) &&
 255           $selectProduct != 'no_thanks'
 256         ) {
 257           $productDAO = new CRM_Contribute_DAO_Product();
 258           $productDAO->id = $selectProduct;
 259           $productDAO->find(TRUE);
 260           // product value exceeds contribution amount
 261           if ($params['amount'] < $productDAO->price) {
 262             $nonDeductibleAmount = $params['amount'];
 263             return $nonDeductibleAmount;
 264           }
 265           // product value does NOT exceed contribution amount
 266           else {
 267             return $productDAO->price;
 268           }
 269         }
 270         // contribution is deductible - but there is no product
 271         else {
 272           return '0.00';
 273         }
 274       }
 275       // contribution is NOT deductible
 276       else {
 277         return $params['amount'];
 278       }
 279     }
 280   }
 281
 282   /**
 283    * Set variables up before form is built.
 284    */
 285   public function preProcess() {
 286     parent::preProcess();
 287
 288     // lineItem isn't set until Register postProcess
 289     $this->_lineItem = $this->get('lineItem');
 290     $this->_ccid = $this->get('ccid');
 291
 292     $this->_params = $this->controller->exportValues('Main');
 293     $this->_params['ip_address'] = CRM_Utils_System::ipAddress();
 294     $this->_params['amount'] = $this->get('amount');
 295     if (isset($this->_params['amount'])) {
 296       $this->setFormAmountFields($this->_params['priceSetId']);
 297     }
 298
 299     $this->_params['tax_amount'] = $this->get('tax_amount');
 300     $this->_useForMember = $this->get('useForMember');
 301
 302     if (isset($this->_params['credit_card_exp_date'])) {
 303       $this->_params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($this->_params);
 304       $this->_params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($this->_params);
 305     }
 306
 307     $this->_params['currencyID'] = CRM_Core_Config::singleton()->defaultCurrency;
 308
 309     if (!empty($this->_membershipBlock)) {
 310       $this->_params['selectMembership'] = $this->get('selectMembership');
 311     }
 312     if (!empty($this->_paymentProcessor) &&  $this->_paymentProcessor['object']->supports('preApproval')) {
 313       $preApprovalParams = $this->_paymentProcessor['object']->getPreApprovalDetails($this->get('pre_approval_parameters'));
 314       $this->_params = array_merge($this->_params, $preApprovalParams);
 315
 316       // We may have fetched some billing details from the getPreApprovalDetails function so we
 317       // want to ensure we set this after that function has been called.
 318       CRM_Core_Payment_Form::mapParams($this->_bltID, $preApprovalParams, $this->_params, FALSE);
 319     }
 320
 321     $this->_params['is_pay_later'] = $this->get('is_pay_later');
 322     $this->assign('is_pay_later', $this->_params['is_pay_later']);
 323     if ($this->_params['is_pay_later']) {
 324       $this->assign('pay_later_receipt', CRM_Utils_Array::value('pay_later_receipt', $this->_values));
 325     }
 326     // if onbehalf-of-organization
 327     if (!empty($this->_values['onbehalf_profile_id']) && !empty($this->_params['onbehalf']['organization_name'])) {
 328       if (empty($this->_params['org_option']) && empty($this->_params['organization_id'])) {
 329         $this->_params['organization_id'] = CRM_Utils_Array::value('onbehalfof_id', $this->_params);
 330       }
 331       $this->_params['organization_name'] = $this->_params['onbehalf']['organization_name'];
 332       $addressBlocks = [
 333         'street_address',
 334         'city',
 335         'state_province',
 336         'postal_code',
 337         'country',
 338         'supplemental_address_1',
 339         'supplemental_address_2',
 340         'supplemental_address_3',
 341         'postal_code_suffix',
 342         'geo_code_1',
 343         'geo_code_2',
 344         'address_name',
 345       ];
 346
 347       $blocks = ['email', 'phone', 'im', 'url', 'openid'];
 348       foreach ($this->_params['onbehalf'] as $loc => $value) {
 349         $field = $typeId = NULL;
 350         if (strstr($loc, '-')) {
 351           list($field, $locType) = explode('-', $loc);
 352         }
 353
 354         if (in_array($field, $addressBlocks)) {
 355           if ($locType == 'Primary') {
 356             $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
 357             $locType = $defaultLocationType->id;
 358           }
 359
 360           if ($field == 'country') {
 361             $value = CRM_Core_PseudoConstant::countryIsoCode($value);
 362           }
 363           elseif ($field == 'state_province') {
 364             $value = CRM_Core_PseudoConstant::stateProvinceAbbreviation($value);
 365           }
 366
 367           $isPrimary = 1;
 368           if (isset($this->_params['onbehalf_location']['address'])
 369             && count($this->_params['onbehalf_location']['address']) > 0
 370           ) {
 371             $isPrimary = 0;
 372           }
 373
 374           $this->_params['onbehalf_location']['address'][$locType][$field] = $value;
 375           if (empty($this->_params['onbehalf_location']['address'][$locType]['is_primary'])) {
 376             $this->_params['onbehalf_location']['address'][$locType]['is_primary'] = $isPrimary;
 377           }
 378           $this->_params['onbehalf_location']['address'][$locType]['location_type_id'] = $locType;
 379         }
 380         elseif (in_array($field, $blocks)) {
 381           if (!$typeId || is_numeric($typeId)) {
 382             $blockName = $fieldName = $field;
 383             $locationType = 'location_type_id';
 384             if ($locType == 'Primary') {
 385               $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
 386               $locationValue = $defaultLocationType->id;
 387             }
 388             else {
 389               $locationValue = $locType;
 390             }
 391             $locTypeId = '';
 392             $phoneExtField = [];
 393
 394             if ($field == 'url') {
 395               $blockName = 'website';
 396               $locationType = 'website_type_id';
 397               list($field, $locationValue) = explode('-', $loc);
 398             }
 399             elseif ($field == 'im') {
 400               $fieldName = 'name';
 401               $locTypeId = 'provider_id';
 402               $typeId = $this->_params['onbehalf']["{$loc}-provider_id"];
 403             }
 404             elseif ($field == 'phone') {
 405               list($field, $locType, $typeId) = explode('-', $loc);
 406               $locTypeId = 'phone_type_id';
 407
 408               //check if extension field exists
 409               $extField = str_replace('phone', 'phone_ext', $loc);
 410               if (isset($this->_params['onbehalf'][$extField])) {
 411                 $phoneExtField = ['phone_ext' => $this->_params['onbehalf'][$extField]];
 412               }
 413             }
 414
 415             $isPrimary = 1;
 416             if (isset($this->_params['onbehalf_location'][$blockName])
 417               && count($this->_params['onbehalf_location'][$blockName]) > 0
 418             ) {
 419               $isPrimary = 0;
 420             }
 421             if ($locationValue) {
 422               $blockValues = [
 423                 $fieldName => $value,
 424                 $locationType => $locationValue,
 425                 'is_primary' => $isPrimary,
 426               ];
 427
 428               if ($locTypeId) {
 429                 $blockValues = array_merge($blockValues, [$locTypeId => $typeId]);
 430               }
 431               if (!empty($phoneExtField)) {
 432                 $blockValues = array_merge($blockValues, $phoneExtField);
 433               }
 434
 435               $this->_params['onbehalf_location'][$blockName][] = $blockValues;
 436             }
 437           }
 438         }
 439         elseif (strstr($loc, 'custom')) {
 440           if ($value && isset($this->_params['onbehalf']["{$loc}_id"])) {
 441             $value = $this->_params['onbehalf']["{$loc}_id"];
 442           }
 443           $this->_params['onbehalf_location']["{$loc}"] = $value;
 444         }
 445         else {
 446           if ($loc == 'contact_sub_type') {
 447             $this->_params['onbehalf_location'][$loc] = $value;
 448           }
 449           else {
 450             $this->_params['onbehalf_location'][$field] = $value;
 451           }
 452         }
 453       }
 454     }
 455     elseif (!empty($this->_values['is_for_organization'])) {
 456       // no on behalf of an organization, CRM-5519
 457       // so reset loc blocks from main params.
 458       foreach ([
 459         'phone',
 460         'email',
 461         'address',
 462       ] as $blk) {
 463         if (isset($this->_params[$blk])) {
 464           unset($this->_params[$blk]);
 465         }
 466       }
 467     }
 468     $this->setRecurringMembershipParams();
 469
 470     if ($this->_pcpId) {
 471       $params = $this->processPcp($this, $this->_params);
 472       $this->_params = $params;
 473     }
 474     $this->_params['invoiceID'] = $this->get('invoiceID');
 475
 476     //carry campaign from profile.
 477     if (array_key_exists('contribution_campaign_id', $this->_params)) {
 478       $this->_params['campaign_id'] = $this->_params['contribution_campaign_id'];
 479     }
 480
 481     // assign contribution page id to the template so we can add css class for it
 482     $this->assign('contributionPageID', $this->_id);
 483     $this->assign('is_for_organization', CRM_Utils_Array::value('is_for_organization', $this->_params));
 484
 485     $this->set('params', $this->_params);
 486   }
 487
 488   /**
 489    * Build the form object.
 490    */
 491   public function buildQuickForm() {
 492     // FIXME: Some of this code is identical to Thankyou.php and should be broken out into a shared function
 493     $this->assignToTemplate();
 494
 495     $params = $this->_params;
 496     // make sure we have values for it
 497     if (!empty($this->_values['honoree_profile_id']) && !empty($params['soft_credit_type_id']) && empty($this->_ccid)) {
 498       $honorName = NULL;
 499       $softCreditTypes = CRM_Core_OptionGroup::values("soft_credit_type", FALSE);
 500
 501       $this->assign('soft_credit_type', $softCreditTypes[$params['soft_credit_type_id']]);
 502       CRM_Contribute_BAO_ContributionSoft::formatHonoreeProfileFields($this, $params['honor']);
 503
 504       $fieldTypes = ['Contact'];
 505       $fieldTypes[] = CRM_Core_BAO_UFGroup::getContactType($this->_values['honoree_profile_id']);
 506       $this->buildCustom($this->_values['honoree_profile_id'], 'honoreeProfileFields', TRUE, 'honor', $fieldTypes);
 507     }
 508     $this->assign('receiptFromEmail', CRM_Utils_Array::value('receipt_from_email', $this->_values));
 509     $amount_block_is_active = $this->get('amount_block_is_active');
 510     $this->assign('amount_block_is_active', $amount_block_is_active);
 511
 512     // Make a copy of line items array to use for display only
 513     $tplLineItems = $this->_lineItem;
 514     if (CRM_Invoicing_Utils::isInvoicingEnabled()) {
 515       // @todo $params seems like exactly the wrong place to get totalTaxAmount from
 516       // this is a calculated variable so we it should be transparent how we
 517       // calculated it rather than coming from 'params'
 518       $this->assign('totalTaxAmount', $params['tax_amount']);
 519     }
 520     $this->assignLineItemsToTemplate($tplLineItems);
 521
 522     $isDisplayLineItems = $this->_priceSetId && !CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config');
 523
 524     $this->assign('isDisplayLineItems', $isDisplayLineItems);
 525
 526     if (!$isDisplayLineItems) {
 527       // quickConfig is deprecated in favour of isDisplayLineItems. Lots of logic has been harnessed to quick config
 528       // whereas isDisplayLineItems is specific & clear.
 529       $this->assign('is_quick_config', 1);
 530       $this->_params['is_quick_config'] = 1;
 531     }
 532
 533     if (!empty($params['selectProduct']) && $params['selectProduct'] != 'no_thanks') {
 534       $option = CRM_Utils_Array::value('options_' . $params['selectProduct'], $params);
 535       $productID = $params['selectProduct'];
 536       CRM_Contribute_BAO_Premium::buildPremiumBlock($this, $this->_id, FALSE,
 537         $productID, $option
 538       );
 539       $this->set('productID', $productID);
 540       $this->set('option', $option);
 541     }
 542     $config = CRM_Core_Config::singleton();
 543     if (in_array('CiviMember', $config->enableComponents) && empty($this->_ccid)) {
 544       if (isset($params['selectMembership']) &&
 545         $params['selectMembership'] != 'no_thanks'
 546       ) {
 547         $this->buildMembershipBlock(
 548           $this->_membershipContactID,
 549           FALSE,
 550           $params['selectMembership'],
 551           FALSE
 552         );
 553         if (!empty($params['auto_renew'])) {
 554           $this->assign('auto_renew', TRUE);
 555         }
 556       }
 557       else {
 558         $this->assign('membershipBlock', FALSE);
 559       }
 560     }
 561     if (empty($this->_ccid)) {
 562       $this->buildCustom($this->_values['custom_pre_id'], 'customPre', TRUE);
 563       $this->buildCustom($this->_values['custom_post_id'], 'customPost', TRUE);
 564     }
 565
 566     if (!empty($this->_values['onbehalf_profile_id']) &&
 567       !empty($params['onbehalf']) &&
 568       ($this->_values['is_for_organization'] == 2 ||
 569         !empty($params['is_for_organization'])
 570       ) && empty($this->_ccid)
 571     ) {
 572       $fieldTypes = ['Contact', 'Organization'];
 573       $contactSubType = CRM_Contact_BAO_ContactType::subTypes('Organization');
 574       $fieldTypes = array_merge($fieldTypes, $contactSubType);
 575       if (is_array($this->_membershipBlock) && !empty($this->_membershipBlock)) {
 576         $fieldTypes = array_merge($fieldTypes, ['Membership']);
 577       }
 578       else {
 579         $fieldTypes = array_merge($fieldTypes, ['Contribution']);
 580       }
 581
 582       $this->buildCustom($this->_values['onbehalf_profile_id'], 'onbehalfProfile', TRUE, 'onbehalf', $fieldTypes);
 583     }
 584
 585     $this->_separateMembershipPayment = $this->get('separateMembershipPayment');
 586     $this->assign('is_separate_payment', $this->_separateMembershipPayment);
 587
 588     $this->assign('priceSetID', $this->_priceSetId);
 589
 590     // The concept of contributeMode is deprecated.
 591     // the is_monetary concept probably should be too as it can be calculated from
 592     // the existence of 'amount' & seems fragile.
 593     if ($this->_contributeMode == 'notify' ||
 594       $this->_amount <= 0.0 || $this->_params['is_pay_later']
 595     ) {
 596       $contribButton = ts('Continue');
 597     }
 598     elseif (!empty($this->_ccid)) {
 599       $contribButton = ts('Make Payment');
 600     }
 601     else {
 602       $contribButton = ts('Make Contribution');
 603     }
 604     $this->assign('button', $contribButton);
 605
 606     $this->assign('continueText',
 607       $this->getPaymentProcessorObject()->getText('contributionPageContinueText', [
 608         'is_payment_to_existing' => !empty($this->_ccid),
 609         'amount' => $this->_amount,
 610       ])
 611     );
 612
 613     $this->addButtons([
 614       [
 615         'type' => 'next',
 616         'name' => $contribButton,
 617         'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 618         'isDefault' => TRUE,
 619       ],
 620       [
 621         'type' => 'back',
 622         'name' => ts('Go Back'),
 623       ],
 624     ]);
 625
 626     $defaults = [];
 627     $fields = array_fill_keys(array_keys($this->_fields), 1);
 628     $fields["billing_state_province-{$this->_bltID}"] = $fields["billing_country-{$this->_bltID}"] = $fields["email-{$this->_bltID}"] = 1;
 629
 630     $contact = $this->_params;
 631     foreach ($fields as $name => $dontCare) {
 632       // Recursively set defaults for nested fields
 633       if (isset($contact[$name]) && is_array($contact[$name]) && ($name == 'onbehalf' || $name == 'honor')) {
 634         foreach ($contact[$name] as $fieldName => $fieldValue) {
 635           if (is_array($fieldValue) && !in_array($this->_fields[$name][$fieldName]['html_type'], [
 636             'Multi-Select',
 637             'AdvMulti-Select',
 638           ])
 639           ) {
 640             foreach ($fieldValue as $key => $value) {
 641               $defaults["{$name}[{$fieldName}][{$key}]"] = $value;
 642             }
 643           }
 644           else {
 645             $defaults["{$name}[{$fieldName}]"] = $fieldValue;
 646           }
 647         }
 648       }
 649       elseif (isset($contact[$name])) {
 650         $defaults[$name] = $contact[$name];
 651         if (substr($name, 0, 7) == 'custom_') {
 652           $timeField = "{$name}_time";
 653           if (isset($contact[$timeField])) {
 654             $defaults[$timeField] = $contact[$timeField];
 655           }
 656           if (isset($contact["{$name}_id"])) {
 657             $defaults["{$name}_id"] = $contact["{$name}_id"];
 658           }
 659         }
 660         elseif (in_array($name, [
 661           'addressee',
 662           'email_greeting',
 663           'postal_greeting',
 664         ]) && !empty($contact[$name . '_custom'])
 665         ) {
 666           $defaults[$name . '_custom'] = $contact[$name . '_custom'];
 667         }
 668       }
 669     }
 670
 671     $this->assign('useForMember', $this->get('useForMember'));
 672
 673     $this->setDefaults($defaults);
 674
 675     $this->freeze();
 676   }
 677
 678   /**
 679    * Overwrite action.
 680    *
 681    * Since we are only showing elements in frozen mode no help display needed.
 682    *
 683    * @return int
 684    */
 685   public function getAction() {
 686     if ($this->_action & CRM_Core_Action::PREVIEW) {
 687       return CRM_Core_Action::VIEW | CRM_Core_Action::PREVIEW;
 688     }
 689     else {
 690       return CRM_Core_Action::VIEW;
 691     }
 692   }
 693
 694   /**
 695    * Set default values for the form.
 696    *
 697    * Note that in edit/view mode
 698    * the default values are retrieved from the database
 699    */
 700   public function setDefaultValues() {
 701   }
 702
 703   /**
 704    * Process the form.
 705    */
 706   public function postProcess() {
 707     $contactID = $this->getContactID();
 708     try {
 709       $result = $this->processFormSubmission($contactID);
 710     }
 711     catch (CRM_Core_Exception $e) {
 712       $this->bounceOnError($e->getMessage());
 713     }
 714
 715     if (is_array($result) && !empty($result['is_payment_failure'])) {
 716       $this->bounceOnError($result['error']->getMessage());
 717     }
 718     // Presumably this is for hooks to access? Not quite clear & perhaps not required.
 719     $this->set('params', $this->_params);
 720   }
 721
 722   /**
 723    * Wrangle financial type ID.
 724    *
 725    * This wrangling of the financialType ID was happening in a shared function rather than in the form it relates to & hence has been moved to that form
 726    * Pledges are not relevant to the membership code so that portion will not go onto the membership form.
 727    *
 728    * Comments from previous refactor indicate doubt as to what was going on.
 729    *
 730    * @param int $financialTypeID
 731    *
 732    * @return null|string
 733    */
 734   public function wrangleFinancialTypeID($financialTypeID) {
 735     if (empty($financialTypeID) && !empty($this->_values['pledge_id'])) {
 736       $financialTypeID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_Pledge',
 737         $this->_values['pledge_id'],
 738         'financial_type_id'
 739       );
 740     }
 741     return $financialTypeID;
 742   }
 743
 744   /**
 745    * Process the form.
 746    *
 747    * @param array $premiumParams
 748    * @param CRM_Contribute_BAO_Contribution $contribution
 749    */
 750   protected function postProcessPremium($premiumParams, $contribution) {
 751     $hour = $minute = $second = 0;
 752     // assigning Premium information to receipt tpl
 753     $selectProduct = CRM_Utils_Array::value('selectProduct', $premiumParams);
 754     if ($selectProduct &&
 755       $selectProduct != 'no_thanks'
 756     ) {
 757       $startDate = $endDate = "";
 758       $this->assign('selectPremium', TRUE);
 759       $productDAO = new CRM_Contribute_DAO_Product();
 760       $productDAO->id = $selectProduct;
 761       $productDAO->find(TRUE);
 762       $this->assign('product_name', $productDAO->name);
 763       $this->assign('price', $productDAO->price);
 764       $this->assign('sku', $productDAO->sku);
 765       $this->assign('option', CRM_Utils_Array::value('options_' . $premiumParams['selectProduct'], $premiumParams));
 766
 767       $periodType = $productDAO->period_type;
 768
 769       if ($periodType) {
 770         $fixed_period_start_day = $productDAO->fixed_period_start_day;
 771         $duration_unit = $productDAO->duration_unit;
 772         $duration_interval = $productDAO->duration_interval;
 773         if ($periodType == 'rolling') {
 774           $startDate = date('Y-m-d');
 775         }
 776         elseif ($periodType == 'fixed') {
 777           if ($fixed_period_start_day) {
 778             $date = explode('-', date('Y-m-d'));
 779             $month = substr($fixed_period_start_day, 0, strlen($fixed_period_start_day) - 2);
 780             $day = substr($fixed_period_start_day, -2) . "<br/>";
 781             $year = $date[0];
 782             $startDate = $year . '-' . $month . '-' . $day;
 783           }
 784           else {
 785             $startDate = date('Y-m-d');
 786           }
 787         }
 788
 789         $date = explode('-', $startDate);
 790         $year = $date[0];
 791         $month = $date[1];
 792         $day = $date[2];
 793
 794         switch ($duration_unit) {
 795           case 'year':
 796             $year = $year + $duration_interval;
 797             break;
 798
 799           case 'month':
 800             $month = $month + $duration_interval;
 801             break;
 802
 803           case 'day':
 804             $day = $day + $duration_interval;
 805             break;
 806
 807           case 'week':
 808             $day = $day + ($duration_interval * 7);
 809         }
 810         $endDate = date('Y-m-d H:i:s', mktime($hour, $minute, $second, $month, $day, $year));
 811         $this->assign('start_date', $startDate);
 812         $this->assign('end_date', $endDate);
 813       }
 814
 815       $dao = new CRM_Contribute_DAO_Premium();
 816       $dao->entity_table = 'civicrm_contribution_page';
 817       $dao->entity_id = $this->_id;
 818       $dao->find(TRUE);
 819       $this->assign('contact_phone', $dao->premiums_contact_phone);
 820       $this->assign('contact_email', $dao->premiums_contact_email);
 821
 822       //create Premium record
 823       $params = [
 824         'product_id' => $premiumParams['selectProduct'],
 825         'contribution_id' => $contribution->id,
 826         'product_option' => CRM_Utils_Array::value('options_' . $premiumParams['selectProduct'], $premiumParams),
 827         'quantity' => 1,
 828         'start_date' => CRM_Utils_Date::customFormat($startDate, '%Y%m%d'),
 829         'end_date' => CRM_Utils_Date::customFormat($endDate, '%Y%m%d'),
 830       ];
 831       if (!empty($premiumParams['selectProduct'])) {
 832         $daoPremiumsProduct = new CRM_Contribute_DAO_PremiumsProduct();
 833         $daoPremiumsProduct->product_id = $premiumParams['selectProduct'];
 834         $daoPremiumsProduct->premiums_id = $dao->id;
 835         $daoPremiumsProduct->find(TRUE);
 836         $params['financial_type_id'] = $daoPremiumsProduct->financial_type_id;
 837       }
 838       //Fixed For CRM-3901
 839       $daoContrProd = new CRM_Contribute_DAO_ContributionProduct();
 840       $daoContrProd->contribution_id = $contribution->id;
 841       if ($daoContrProd->find(TRUE)) {
 842         $params['id'] = $daoContrProd->id;
 843       }
 844
 845       CRM_Contribute_BAO_Contribution::addPremium($params);
 846       if ($productDAO->cost && !empty($params['financial_type_id'])) {
 847         $trxnParams = [
 848           'cost' => $productDAO->cost,
 849           'currency' => $productDAO->currency,
 850           'financial_type_id' => $params['financial_type_id'],
 851           'contributionId' => $contribution->id,
 852         ];
 853         CRM_Core_BAO_FinancialTrxn::createPremiumTrxn($trxnParams);
 854       }
 855     }
 856     elseif ($selectProduct == 'no_thanks') {
 857       //Fixed For CRM-3901
 858       $daoContrProd = new CRM_Contribute_DAO_ContributionProduct();
 859       $daoContrProd->contribution_id = $contribution->id;
 860       if ($daoContrProd->find(TRUE)) {
 861         $daoContrProd->delete();
 862       }
 863     }
 864   }
 865
 866   /**
 867    * Process the contribution.
 868    *
 869    * @param CRM_Core_Form $form
 870    * @param array $params
 871    * @param array $result
 872    * @param array $contributionParams
 873    *   Parameters to be passed to contribution create action.
 874    *   This differs from params in that we are currently adding params to it and 1) ensuring they are being
 875    *   passed consistently & 2) documenting them here.
 876    *   - contact_id
 877    *   - line_item
 878    *   - is_test
 879    *   - campaign_id
 880    *   - contribution_page_id
 881    *   - source
 882    *   - payment_type_id
 883    *   - thankyou_date (not all forms will set this)
 884    *
 885    * @param CRM_Financial_DAO_FinancialType $financialType
 886    * @param bool $online
 887    *   Is the form a front end form? If so set a bunch of unpredictable things that should be passed in from the form.
 888    *
 889    * @param int $billingLocationID
 890    *   ID of billing location type.
 891    * @param bool $isRecur
 892    *   Is this recurring?
 893    *
 894    * @return \CRM_Contribute_DAO_Contribution
 895    *
 896    * @throws \CRM_Core_Exception
 897    * @throws \CiviCRM_API3_Exception
 898    */
 899   public static function processFormContribution(
 900     &$form,
 901     $params,
 902     $result,
 903     $contributionParams,
 904     $financialType,
 905     $online,
 906     $billingLocationID,
 907     $isRecur
 908   ) {
 909     $transaction = new CRM_Core_Transaction();
 910     $contactID = $contributionParams['contact_id'];
 911
 912     $isEmailReceipt = !empty($form->_values['is_email_receipt']);
 913     $isSeparateMembershipPayment = empty($params['separate_membership_payment']) ? FALSE : TRUE;
 914     $pledgeID = !empty($params['pledge_id']) ? $params['pledge_id'] : CRM_Utils_Array::value('pledge_id', $form->_values);
 915     if (!$isSeparateMembershipPayment && !empty($form->_values['pledge_block_id']) &&
 916       (!empty($params['is_pledge']) || $pledgeID)) {
 917       $isPledge = TRUE;
 918     }
 919     else {
 920       $isPledge = FALSE;
 921     }
 922
 923     // add these values for the recurringContrib function ,CRM-10188
 924     $params['financial_type_id'] = $financialType->id;
 925
 926     $contributionParams['address_id'] = CRM_Contribute_BAO_Contribution::createAddress($params, $billingLocationID);
 927
 928     //@todo - this is being set from the form to resolve CRM-10188 - an
 929     // eNotice caused by it not being set @ the front end
 930     // however, we then get it being over-written with null for backend contributions
 931     // a better fix would be to set the values in the respective forms rather than require
 932     // a function being shared by two forms to deal with their respective values
 933     // moving it to the BAO & not taking the $form as a param would make sense here.
 934     if (!isset($params['is_email_receipt']) && $isEmailReceipt) {
 935       $params['is_email_receipt'] = $isEmailReceipt;
 936     }
 937     $params['is_recur'] = $isRecur;
 938     $params['payment_instrument_id'] = CRM_Utils_Array::value('payment_instrument_id', $contributionParams);
 939     $recurringContributionID = self::processRecurringContribution($form, $params, $contactID, $financialType);
 940
 941     $now = date('YmdHis');
 942     $receiptDate = CRM_Utils_Array::value('receipt_date', $params);
 943     if ($isEmailReceipt) {
 944       $receiptDate = $now;
 945     }
 946
 947     if (isset($params['amount'])) {
 948       $contributionParams = array_merge(self::getContributionParams(
 949         $params, $financialType->id,
 950         $result, $receiptDate,
 951         $recurringContributionID), $contributionParams
 952       );
 953       $contributionParams['non_deductible_amount'] = self::getNonDeductibleAmount($params, $financialType, $online, $form);
 954       $contributionParams['skipCleanMoney'] = TRUE;
 955       // @todo this is the wrong place for this - it should be done as close to form submission
 956       // as possible
 957       $contributionParams['total_amount'] = $params['amount'];
 958
 959       $contribution = CRM_Contribute_BAO_Contribution::add($contributionParams);
 960
 961       $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
 962       $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
 963       if ($invoicing) {
 964         $dataArray = [];
 965         // @todo - interrogate the line items passed in on the params array.
 966         // No reason to assume line items will be set on the form.
 967         foreach ($form->_lineItem as $lineItemKey => $lineItemValue) {
 968           foreach ($lineItemValue as $key => $value) {
 969             if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
 970               if (isset($dataArray[$value['tax_rate']])) {
 971                 $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + CRM_Utils_Array::value('tax_amount', $value);
 972               }
 973               else {
 974                 $dataArray[$value['tax_rate']] = CRM_Utils_Array::value('tax_amount', $value);
 975               }
 976             }
 977           }
 978         }
 979         $smarty = CRM_Core_Smarty::singleton();
 980         $smarty->assign('dataArray', $dataArray);
 981         $smarty->assign('totalTaxAmount', $params['tax_amount']);
 982       }
 983
 984       // lets store it in the form variable so postProcess hook can get to this and use it
 985       $form->_contributionID = $contribution->id;
 986     }
 987
 988     // process soft credit / pcp params first
 989     CRM_Contribute_BAO_ContributionSoft::formatSoftCreditParams($params, $form);
 990
 991     //CRM-13981, processing honor contact into soft-credit contribution
 992     CRM_Contribute_BAO_ContributionSoft::processSoftContribution($params, $contribution);
 993
 994     if ($isPledge) {
 995       $form = self::handlePledge($form, $params, $contributionParams, $pledgeID, $contribution, $isEmailReceipt);
 996     }
 997
 998     if ($online && $contribution) {
 999       CRM_Core_BAO_CustomValueTable::postProcess($params,
1000         'civicrm_contribution',
1001         $contribution->id,
1002         'Contribution'
1003       );
1004     }
1005     elseif ($contribution) {
1006       //handle custom data.
1007       $params['contribution_id'] = $contribution->id;
1008       if (!empty($params['custom']) &&
1009         is_array($params['custom'])
1010       ) {
1011         CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contribution', $contribution->id);
1012       }
1013     }
1014     // Save note
1015     if ($contribution && !empty($params['contribution_note'])) {
1016       $noteParams = [
1017         'entity_table' => 'civicrm_contribution',
1018         'note' => $params['contribution_note'],
1019         'entity_id' => $contribution->id,
1020         'contact_id' => $contribution->contact_id,
1021         'modified_date' => date('Ymd'),
1022       ];
1023
1024       CRM_Core_BAO_Note::add($noteParams, []);
1025     }
1026
1027     if (isset($params['related_contact'])) {
1028       $contactID = $params['related_contact'];
1029     }
1030     elseif (isset($params['cms_contactID'])) {
1031       $contactID = $params['cms_contactID'];
1032     }
1033
1034     //create contribution activity w/ individual and target
1035     //activity w/ organisation contact id when onbelf, CRM-4027
1036     $targetContactID = NULL;
1037     if (!empty($params['hidden_onbehalf_profile'])) {
1038       $targetContactID = $contribution->contact_id;
1039       $contribution->contact_id = $contactID;
1040     }
1041
1042     // create an activity record
1043     if ($contribution) {
1044       CRM_Activity_BAO_Activity::addActivity($contribution, NULL, $targetContactID);
1045     }
1046
1047     $transaction->commit();
1048     // CRM-13074 - create the CMSUser after the transaction is completed as it
1049     // is not appropriate to delete a valid contribution if a user create problem occurs
1050     CRM_Contribute_BAO_Contribution_Utils::createCMSUser($params,
1051       $contactID,
1052       'email-' . $billingLocationID
1053     );
1054     return $contribution;
1055   }
1056
1057   /**
1058    * Create the recurring contribution record.
1059    *
1060    * @param CRM_Core_Form $form
1061    * @param array $params
1062    * @param int $contactID
1063    * @param string $contributionType
1064    *
1065    * @return int|null
1066    */
1067   public static function processRecurringContribution(&$form, &$params, $contactID, $contributionType) {
1068
1069     if (empty($params['is_recur'])) {
1070       return NULL;
1071     }
1072
1073     $recurParams = ['contact_id' => $contactID];
1074     $recurParams['amount'] = CRM_Utils_Array::value('amount', $params);
1075     $recurParams['auto_renew'] = CRM_Utils_Array::value('auto_renew', $params);
1076     $recurParams['frequency_unit'] = CRM_Utils_Array::value('frequency_unit', $params);
1077     $recurParams['frequency_interval'] = CRM_Utils_Array::value('frequency_interval', $params);
1078     $recurParams['installments'] = CRM_Utils_Array::value('installments', $params);
1079     $recurParams['financial_type_id'] = CRM_Utils_Array::value('financial_type_id', $params);
1080     $recurParams['currency'] = CRM_Utils_Array::value('currency', $params);
1081     $recurParams['payment_instrument_id'] = $params['payment_instrument_id'];
1082
1083     // CRM-14354: For an auto-renewing membership with an additional contribution,
1084     // if separate payments is not enabled, make sure only the membership fee recurs
1085     if (!empty($form->_membershipBlock)
1086       && $form->_membershipBlock['is_separate_payment'] === '0'
1087       && isset($params['selectMembership'])
1088       && $form->_values['is_allow_other_amount'] == '1'
1089       // CRM-16331
1090       && !empty($form->_membershipTypeValues)
1091       && !empty($form->_membershipTypeValues[$params['selectMembership']]['minimum_fee'])
1092     ) {
1093       $recurParams['amount'] = $form->_membershipTypeValues[$params['selectMembership']]['minimum_fee'];
1094     }
1095
1096     $recurParams['is_test'] = 0;
1097     if (($form->_action & CRM_Core_Action::PREVIEW) ||
1098       (isset($form->_mode) && ($form->_mode == 'test'))
1099     ) {
1100       $recurParams['is_test'] = 1;
1101     }
1102
1103     $recurParams['start_date'] = $recurParams['create_date'] = $recurParams['modified_date'] = date('YmdHis');
1104     if (!empty($params['receive_date'])) {
1105       $recurParams['start_date'] = date('YmdHis', strtotime($params['receive_date']));
1106     }
1107     $recurParams['invoice_id'] = CRM_Utils_Array::value('invoiceID', $params);
1108     $recurParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
1109     $recurParams['payment_processor_id'] = CRM_Utils_Array::value('payment_processor_id', $params);
1110     $recurParams['is_email_receipt'] = CRM_Utils_Array::value('is_email_receipt', $params);
1111     // we need to add a unique trxn_id to avoid a unique key error
1112     // in paypal IPN we reset this when paypal sends us the real trxn id, CRM-2991
1113     $recurParams['trxn_id'] = CRM_Utils_Array::value('trxn_id', $params, $params['invoiceID']);
1114     $recurParams['financial_type_id'] = $contributionType->id;
1115
1116     $campaignId = CRM_Utils_Array::value('campaign_id', $params, CRM_Utils_Array::value('campaign_id', $form->_values));
1117     $recurParams['campaign_id'] = $campaignId;
1118     $recurring = CRM_Contribute_BAO_ContributionRecur::add($recurParams);
1119     if (is_a($recurring, 'CRM_Core_Error')) {
1120       CRM_Core_Error::displaySessionError($recurring);
1121       $urlString = 'civicrm/contribute/transact';
1122       $urlParams = '_qf_Main_display=true';
1123       if (get_class($form) == 'CRM_Contribute_Form_Contribution') {
1124         $urlString = 'civicrm/contact/view/contribution';
1125         $urlParams = "action=add&cid={$form->_contactID}";
1126         if ($form->_mode) {
1127           $urlParams .= "&mode={$form->_mode}";
1128         }
1129       }
1130       CRM_Utils_System::redirect(CRM_Utils_System::url($urlString, $urlParams));
1131     }
1132     // Only set contribution recur ID for contributions since offline membership recur payments are handled somewhere else.
1133     if (!is_a($form, "CRM_Member_Form_Membership")) {
1134       $form->_params['contributionRecurID'] = $recurring->id;
1135     }
1136
1137     return $recurring->id;
1138   }
1139
1140   /**
1141    * Add on behalf of organization and it's location.
1142    *
1143    * This situation occurs when on behalf of is enabled for the contribution page and the person
1144    * signing up does so on behalf of an organization.
1145    *
1146    * @param array $behalfOrganization
1147    *   array of organization info.
1148    * @param int $contactID
1149    *   individual contact id. One.
1150    *   who is doing the process of signup / contribution.
1151    *
1152    * @param array $values
1153    *   form values array.
1154    * @param array $params
1155    * @param array $fields
1156    *   Array of fields from the onbehalf profile relevant to the organization.
1157    */
1158   public static function processOnBehalfOrganization(&$behalfOrganization, &$contactID, &$values, &$params, $fields = NULL) {
1159     $isNotCurrentEmployer = FALSE;
1160     $dupeIDs = [];
1161     $orgID = NULL;
1162     if (!empty($behalfOrganization['organization_id'])) {
1163       $orgID = $behalfOrganization['organization_id'];
1164       unset($behalfOrganization['organization_id']);
1165     }
1166     // create employer relationship with $contactID only when new organization is there
1167     // else retain the existing relationship
1168     else {
1169       // get the Employee relationship type id
1170       $relTypeId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_RelationshipType', 'Employee of', 'id', 'name_a_b');
1171
1172       // keep relationship params ready
1173       $relParams['relationship_type_id'] = $relTypeId . '_a_b';
1174       $relParams['is_permission_a_b'] = 1;
1175       $relParams['is_active'] = 1;
1176       $isNotCurrentEmployer = TRUE;
1177     }
1178
1179     // formalities for creating / editing organization.
1180     $behalfOrganization['contact_type'] = 'Organization';
1181
1182     if (!$orgID) {
1183       // check if matching organization contact exists
1184       $dupeIDs = CRM_Contact_BAO_Contact::getDuplicateContacts($behalfOrganization, 'Organization', 'Unsupervised', [], FALSE);
1185
1186       // CRM-6243 says to pick the first org even if more than one match
1187       if (count($dupeIDs) >= 1) {
1188         $behalfOrganization['contact_id'] = $orgID = $dupeIDs[0];
1189         // don't allow name edit
1190         unset($behalfOrganization['organization_name']);
1191       }
1192     }
1193     else {
1194       // if found permissioned related organization, allow location edit
1195       $behalfOrganization['contact_id'] = $orgID;
1196       // don't allow name edit
1197       unset($behalfOrganization['organization_name']);
1198     }
1199
1200     // handling for image url
1201     if (!empty($behalfOrganization['image_URL'])) {
1202       CRM_Contact_BAO_Contact::processImageParams($behalfOrganization);
1203     }
1204
1205     // create organization, add location
1206     $orgID = CRM_Contact_BAO_Contact::createProfileContact($behalfOrganization, $fields, $orgID,
1207       NULL, NULL, 'Organization'
1208     );
1209     // create relationship
1210     if ($isNotCurrentEmployer) {
1211       $relParams['contact_check'][$orgID] = 1;
1212       $cid = ['contact' => $contactID];
1213       CRM_Contact_BAO_Relationship::legacyCreateMultiple($relParams, $cid);
1214     }
1215
1216     // if multiple match - send a duplicate alert
1217     if ($dupeIDs && (count($dupeIDs) > 1)) {
1218       $values['onbehalf_dupe_alert'] = 1;
1219       // required for IPN
1220       $params['onbehalf_dupe_alert'] = 1;
1221     }
1222
1223     // make sure organization-contact-id is considered for recording
1224     // contribution/membership etc..
1225     if ($contactID != $orgID) {
1226       // take a note of contact-id, so we can send the
1227       // receipt to individual contact as well.
1228
1229       // required for mailing/template display ..etc
1230       $values['related_contact'] = $contactID;
1231
1232       //CRM-19172: Create CMS user for individual on whose behalf organization is doing contribution
1233       $params['onbehalf_contact_id'] = $contactID;
1234
1235       //make this employee of relationship as current
1236       //employer / employee relationship,  CRM-3532
1237       if ($isNotCurrentEmployer &&
1238         ($orgID != CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'employer_id'))
1239       ) {
1240         $isNotCurrentEmployer = FALSE;
1241       }
1242
1243       if (!$isNotCurrentEmployer && $orgID) {
1244         //build current employer params
1245         $currentEmpParams[$contactID] = $orgID;
1246         CRM_Contact_BAO_Contact_Utils::setCurrentEmployer($currentEmpParams);
1247       }
1248
1249       // contribution / signup will be done using this
1250       // organization id.
1251       $contactID = $orgID;
1252     }
1253   }
1254
1255   /**
1256    * Function used to send notification mail to pcp owner.
1257    *
1258    * This is used by contribution and also event PCPs.
1259    *
1260    * @param object $contribution
1261    * @param object $contributionSoft
1262    *   Contribution object.
1263    */
1264   public static function pcpNotifyOwner($contribution, $contributionSoft) {
1265     $params = ['id' => $contributionSoft->pcp_id];
1266     CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $params, $pcpInfo);
1267     $ownerNotifyID = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCPBlock', $pcpInfo['pcp_block_id'], 'owner_notify_id');
1268     $ownerNotifyOption = CRM_Core_PseudoConstant::getName('CRM_PCP_DAO_PCPBlock', 'owner_notify_id', $ownerNotifyID);
1269
1270     if ($ownerNotifyOption != 'no_notifications' &&
1271         (($ownerNotifyOption == 'owner_chooses' &&
1272         CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $contributionSoft->pcp_id, 'is_notify')) ||
1273         $ownerNotifyOption == 'all_owners')) {
1274       $pcpInfoURL = CRM_Utils_System::url('civicrm/pcp/info',
1275         "reset=1&id={$contributionSoft->pcp_id}",
1276         TRUE, NULL, FALSE, TRUE
1277       );
1278       // set email in the template here
1279
1280       if (CRM_Core_BAO_LocationType::getBilling()) {
1281         list($donorName, $email) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contribution->contact_id,
1282           FALSE, CRM_Core_BAO_LocationType::getBilling());
1283       }
1284       // get primary location email if no email exist( for billing location).
1285       if (!$email) {
1286         list($donorName, $email) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contribution->contact_id);
1287       }
1288       list($ownerName, $ownerEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contributionSoft->contact_id);
1289       $tplParams = [
1290         'page_title' => $pcpInfo['title'],
1291         'receive_date' => $contribution->receive_date,
1292         'total_amount' => $contributionSoft->amount,
1293         'donors_display_name' => $donorName,
1294         'donors_email' => $email,
1295         'pcpInfoURL' => $pcpInfoURL,
1296         'is_honor_roll_enabled' => $contributionSoft->pcp_display_in_roll,
1297         'currency' => $contributionSoft->currency,
1298       ];
1299       $domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
1300       $sendTemplateParams = [
1301         'groupName' => 'msg_tpl_workflow_contribution',
1302         'valueName' => 'pcp_owner_notify',
1303         'contactId' => $contributionSoft->contact_id,
1304         'toEmail' => $ownerEmail,
1305         'toName' => $ownerName,
1306         'from' => "$domainValues[0] <$domainValues[1]>",
1307         'tplParams' => $tplParams,
1308         'PDFFilename' => 'receipt.pdf',
1309       ];
1310       CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
1311     }
1312   }
1313
1314   /**
1315    * Function used to se pcp related defaults / params.
1316    *
1317    * This is used by contribution and also event PCPs
1318    *
1319    * @param CRM_Core_Form $page
1320    *   Form object.
1321    * @param array $params
1322    *
1323    * @return array
1324    */
1325   public static function processPcp(&$page, $params) {
1326     $params['pcp_made_through_id'] = $page->_pcpId;
1327     $page->assign('pcpBlock', TRUE);
1328     if (!empty($params['pcp_display_in_roll']) && empty($params['pcp_roll_nickname'])) {
1329       $params['pcp_roll_nickname'] = ts('Anonymous');
1330       $params['pcp_is_anonymous'] = 1;
1331     }
1332     else {
1333       $params['pcp_is_anonymous'] = 0;
1334     }
1335     foreach ([
1336       'pcp_display_in_roll',
1337       'pcp_is_anonymous',
1338       'pcp_roll_nickname',
1339       'pcp_personal_note',
1340     ] as $val) {
1341       if (!empty($params[$val])) {
1342         $page->assign($val, $params[$val]);
1343       }
1344     }
1345
1346     return $params;
1347   }
1348
1349   /**
1350    * Process membership.
1351    *
1352    * @param array $membershipParams
1353    * @param int $contactID
1354    * @param array $customFieldsFormatted
1355    * @param array $fieldTypes
1356    * @param array $premiumParams
1357    * @param array $membershipLineItems
1358    *   Line items specifically relating to memberships.
1359    */
1360   protected function processMembership($membershipParams, $contactID, $customFieldsFormatted, $fieldTypes, $premiumParams,
1361                                 $membershipLineItems) {
1362
1363     $membershipTypeIDs = (array) $membershipParams['selectMembership'];
1364     $membershipTypes = CRM_Member_BAO_Membership::buildMembershipTypeValues($this, $membershipTypeIDs);
1365     $membershipType = empty($membershipTypes) ? [] : reset($membershipTypes);
1366
1367     $this->assign('membership_name', CRM_Utils_Array::value('name', $membershipType));
1368     $this->_values['membership_name'] = CRM_Utils_Array::value('name', $membershipType);
1369
1370     $isPaidMembership = FALSE;
1371     if ($this->_amount >= 0.0 && isset($membershipParams['amount'])) {
1372       //amount must be greater than zero for
1373       //adding contribution record  to contribution table.
1374       //this condition arises when separate membership payment is
1375       //enabled and contribution amount is not selected. fix for CRM-3010
1376       $isPaidMembership = TRUE;
1377     }
1378     $isProcessSeparateMembershipTransaction = $this->isSeparateMembershipTransaction($this->_id, $this->_values['amount_block_is_active']);
1379
1380     if ($this->_values['amount_block_is_active']) {
1381       $financialTypeID = $this->_values['financial_type_id'];
1382     }
1383     else {
1384       $financialTypeID = CRM_Utils_Array::value('financial_type_id', $membershipType, CRM_Utils_Array::value('financial_type_id', $membershipParams));
1385     }
1386
1387     if (CRM_Utils_Array::value('membership_source', $this->_params)) {
1388       $membershipParams['contribution_source'] = $this->_params['membership_source'];
1389     }
1390
1391     $this->postProcessMembership($membershipParams, $contactID,
1392       $this, $premiumParams, $customFieldsFormatted, $fieldTypes, $membershipType, $membershipTypeIDs, $isPaidMembership, $this->_membershipId, $isProcessSeparateMembershipTransaction, $financialTypeID,
1393       $membershipLineItems);
1394
1395     $this->assign('membership_assign', TRUE);
1396     $this->set('membershipTypeID', $membershipParams['selectMembership']);
1397   }
1398
1399   /**
1400    * Process the Memberships.
1401    *
1402    * @param array $membershipParams
1403    *   Array of membership fields.
1404    * @param int $contactID
1405    *   Contact id.
1406    * @param CRM_Contribute_Form_Contribution_Confirm $form
1407    *   Confirmation form object.
1408    *
1409    * @param array $premiumParams
1410    * @param null $customFieldsFormatted
1411    * @param null $includeFieldTypes
1412    *
1413    * @param array $membershipDetails
1414    *
1415    * @param array $membershipTypeIDs
1416    *
1417    * @param bool $isPaidMembership
1418    * @param array $membershipID
1419    *
1420    * @param bool $isProcessSeparateMembershipTransaction
1421    *
1422    * @param int $financialTypeID
1423    * @param array $unprocessedLineItems
1424    *   Line items for payment options chosen on the form.
1425    *
1426    * @throws \CRM_Core_Exception
1427    * @throws \CiviCRM_API3_Exception
1428    * @throws \Civi\Payment\Exception\PaymentProcessorException
1429    */
1430   protected function postProcessMembership(
1431     $membershipParams, $contactID, &$form, $premiumParams,
1432     $customFieldsFormatted = NULL, $includeFieldTypes = NULL, $membershipDetails, $membershipTypeIDs, $isPaidMembership, $membershipID,
1433     $isProcessSeparateMembershipTransaction, $financialTypeID, $unprocessedLineItems) {
1434
1435     $membershipContribution = NULL;
1436     $isTest = CRM_Utils_Array::value('is_test', $membershipParams, FALSE);
1437     $errors = $paymentResults = [];
1438     $form->_values['isMembership'] = TRUE;
1439     $isRecurForFirstTransaction = CRM_Utils_Array::value('is_recur', $form->_params, CRM_Utils_Array::value('is_recur', $membershipParams));
1440
1441     $totalAmount = $membershipParams['amount'];
1442
1443     if ($isPaidMembership) {
1444       if ($isProcessSeparateMembershipTransaction) {
1445         // If we have 2 transactions only one can use the invoice id.
1446         $membershipParams['invoiceID'] .= '-2';
1447         if (!empty($membershipParams['auto_renew'])) {
1448           $isRecurForFirstTransaction = FALSE;
1449         }
1450       }
1451
1452       if (!$isProcessSeparateMembershipTransaction) {
1453         // Skip line items in the contribution processing transaction.
1454         // We will create them with the membership for proper linking.
1455         $membershipParams['skipLineItem'] = 1;
1456       }
1457       else {
1458         $membershipParams['total_amount'] = $totalAmount;
1459         $membershipParams['skipLineItem'] = 0;
1460         CRM_Price_BAO_LineItem::getLineItemArray($membershipParams);
1461
1462       }
1463       $paymentResult = CRM_Contribute_BAO_Contribution_Utils::processConfirm(
1464         $form,
1465         $membershipParams,
1466         $contactID,
1467         $financialTypeID,
1468         $isTest,
1469         $isRecurForFirstTransaction
1470       );
1471       if (!empty($paymentResult['contribution'])) {
1472         $paymentResults[] = ['contribution_id' => $paymentResult['contribution']->id, 'result' => $paymentResult];
1473         $this->postProcessPremium($premiumParams, $paymentResult['contribution']);
1474         //note that this will be over-written if we are using a separate membership transaction. Otherwise there is only one
1475         $membershipContribution = $paymentResult['contribution'];
1476         // Save the contribution ID so that I can be used in email receipts
1477         // For example, if you need to generate a tax receipt for the donation only.
1478         $form->_values['contribution_other_id'] = $membershipContribution->id;
1479       }
1480     }
1481
1482     if ($isProcessSeparateMembershipTransaction) {
1483       try {
1484         $form->_lineItem = $unprocessedLineItems;
1485         if (empty($form->_params['auto_renew']) && !empty($membershipParams['is_recur'])) {
1486           unset($membershipParams['is_recur']);
1487         }
1488         list($membershipContribution, $secondPaymentResult) = $this->processSecondaryFinancialTransaction($contactID, $form, array_merge($membershipParams, ['skipLineItem' => 1]),
1489           $isTest, $unprocessedLineItems, CRM_Utils_Array::value('minimum_fee', $membershipDetails, 0), CRM_Utils_Array::value('financial_type_id', $membershipDetails));
1490         $paymentResults[] = ['contribution_id' => $membershipContribution->id, 'result' => $secondPaymentResult];
1491         $totalAmount = $membershipContribution->total_amount;
1492       }
1493       catch (CRM_Core_Exception $e) {
1494         $errors[2] = $e->getMessage();
1495         $membershipContribution = NULL;
1496       }
1497     }
1498
1499     $membership = NULL;
1500     if (!empty($membershipContribution) && !is_a($membershipContribution, 'CRM_Core_Error')) {
1501       $membershipContributionID = $membershipContribution->id;
1502     }
1503
1504     //@todo - why is this nested so deep? it seems like it could be just set on the calling function on the form layer
1505     if (isset($membershipParams['onbehalf']) && !empty($membershipParams['onbehalf']['member_campaign_id'])) {
1506       $form->_params['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
1507     }
1508     //@todo it should no longer be possible for it to get to this point & membership to not be an array
1509     if (is_array($membershipTypeIDs) && !empty($membershipContributionID)) {
1510       $typesTerms = CRM_Utils_Array::value('types_terms', $membershipParams, []);
1511
1512       $membershipLines = $nonMembershipLines = [];
1513       foreach ($unprocessedLineItems as $priceSetID => $lines) {
1514         foreach ($lines as $line) {
1515           if (!empty($line['membership_type_id'])) {
1516             $membershipLines[$line['membership_type_id']] = $line['price_field_value_id'];
1517           }
1518         }
1519       }
1520
1521       $i = 1;
1522       $form->_params['createdMembershipIDs'] = [];
1523       foreach ($membershipTypeIDs as $memType) {
1524         $membershipLineItems = [];
1525         if ($i < count($membershipTypeIDs)) {
1526           $membershipLineItems[$priceSetID][$membershipLines[$memType]] = $unprocessedLineItems[$priceSetID][$membershipLines[$memType]];
1527           unset($unprocessedLineItems[$priceSetID][$membershipLines[$memType]]);
1528         }
1529         else {
1530           $membershipLineItems = $unprocessedLineItems;
1531         }
1532         $i++;
1533         $numTerms = CRM_Utils_Array::value($memType, $typesTerms, 1);
1534         $contributionRecurID = isset($form->_params['contributionRecurID']) ? $form->_params['contributionRecurID'] : NULL;
1535
1536         $membershipSource = NULL;
1537         if (!empty($form->_params['membership_source'])) {
1538           $membershipSource = $form->_params['membership_source'];
1539         }
1540         elseif (isset($form->_values['title']) && !empty($form->_values['title'])) {
1541           $membershipSource = ts('Online Contribution:') . ' ' . $form->_values['title'];
1542         }
1543         $isPayLater = NULL;
1544         if (isset($form->_params)) {
1545           $isPayLater = CRM_Utils_Array::value('is_pay_later', $form->_params);
1546         }
1547         $campaignId = NULL;
1548         if (isset($form->_values) && is_array($form->_values) && !empty($form->_values)) {
1549           $campaignId = CRM_Utils_Array::value('campaign_id', $form->_params);
1550           if (!array_key_exists('campaign_id', $form->_params)) {
1551             $campaignId = CRM_Utils_Array::value('campaign_id', $form->_values);
1552           }
1553         }
1554
1555         // @todo Move this into CRM_Member_BAO_Membership::processMembership
1556         if (!empty($membershipContribution)) {
1557           $pending = ($membershipContribution->contribution_status_id == array_search('Pending', CRM_Contribute_PseudoConstant::contributionStatus())) ? TRUE : FALSE;
1558         }
1559         else {
1560           $pending = $this->getIsPending();
1561         }
1562         list($membership, $renewalMode, $dates) = CRM_Member_BAO_Membership::processMembership(
1563           $contactID, $memType, $isTest,
1564           date('YmdHis'), CRM_Utils_Array::value('cms_contactID', $membershipParams),
1565           $customFieldsFormatted,
1566           $numTerms, $membershipID, $pending,
1567           $contributionRecurID, $membershipSource, $isPayLater, $campaignId, [], $membershipContribution,
1568           $membershipLineItems
1569         );
1570
1571         $form->set('renewal_mode', $renewalMode);
1572         if (!empty($dates)) {
1573           $form->assign('mem_start_date', CRM_Utils_Date::customFormat($dates['start_date'], '%Y%m%d'));
1574           $form->assign('mem_end_date', CRM_Utils_Date::customFormat($dates['end_date'], '%Y%m%d'));
1575         }
1576
1577         if (!empty($membershipContribution)) {
1578           // update recurring id for membership record
1579           CRM_Member_BAO_Membership::updateRecurMembership($membership, $membershipContribution);
1580           // Next line is probably redundant. Checks prevent it happening twice.
1581           $membershipPaymentParams = [
1582             'membership_id' => $membership->id,
1583             'membership_type_id' => $membership->membership_type_id,
1584             'contribution_id' => $membershipContribution->id,
1585           ];
1586           civicrm_api3('MembershipPayment', 'create', $membershipPaymentParams);
1587         }
1588         if ($membership) {
1589           CRM_Core_BAO_CustomValueTable::postProcess($form->_params, 'civicrm_membership', $membership->id, 'Membership');
1590           $form->_params['createdMembershipIDs'][] = $membership->id;
1591           $form->_params['membershipID'] = $membership->id;
1592
1593           //CRM-15232: Check if membership is created and on the basis of it use
1594           //membership receipt template to send payment receipt
1595           $form->_values['isMembership'] = TRUE;
1596         }
1597       }
1598       if ($form->_priceSetId && !empty($form->_useForMember) && !empty($form->_lineItem)) {
1599         foreach ($form->_lineItem[$form->_priceSetId] as & $priceFieldOp) {
1600           if (!empty($priceFieldOp['membership_type_id']) && $membership->membership_type_id == $priceFieldOp['membership_type_id']) {
1601             $membershipOb = $membership;
1602             $priceFieldOp['start_date'] = $membershipOb->start_date ? CRM_Utils_Date::customFormat($membershipOb->start_date, '%B %E%f, %Y') : '-';
1603             $priceFieldOp['end_date'] = $membershipOb->end_date ? CRM_Utils_Date::customFormat($membershipOb->end_date, '%B %E%f, %Y') : '-';
1604           }
1605           else {
1606             $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1607           }
1608         }
1609         $form->_values['lineItem'] = $form->_lineItem;
1610         $form->assign('lineItem', $form->_lineItem);
1611       }
1612     }
1613
1614     if (!empty($errors)) {
1615       $message = $this->compileErrorMessage($errors);
1616       throw new CRM_Core_Exception($message);
1617     }
1618
1619     if (isset($membershipContributionID)) {
1620       $form->_values['contribution_id'] = $membershipContributionID;
1621     }
1622
1623     if (empty($form->_params['is_pay_later']) && $form->_paymentProcessor) {
1624       // the is_monetary concept probably should be deprecated as it can be calculated from
1625       // the existence of 'amount' & seems fragile.
1626       if ($form->_values['is_monetary'] && $form->_amount > 0.0 && !$form->_params['is_pay_later']) {
1627         // call postProcess hook before leaving
1628         $form->postProcessHook();
1629       }
1630
1631       $payment = Civi\Payment\System::singleton()->getByProcessor($form->_paymentProcessor);
1632       // The contribution_other_id is effectively the ID for the only contribution or the non-membership contribution.
1633       // Since we have called the membership contribution (in a 2 contribution scenario) this is out
1634       // primary-contribution compared to that - but let's face it - it's all just too hard & confusing at the moment!
1635       $paymentParams = array_merge($form->_params, ['contributionID' => $form->_values['contribution_other_id']]);
1636
1637       // CRM-19792 : set necessary fields for payment processor
1638       CRM_Core_Payment_Form::mapParams($form->_bltID, $paymentParams, $paymentParams, TRUE);
1639
1640       // If this is a single membership-related contribution, it won't have
1641       // be performed yet, so do it now.
1642       if ($isPaidMembership && !$isProcessSeparateMembershipTransaction) {
1643         $paymentActionResult = $payment->doPayment($paymentParams, 'contribute');
1644         $paymentResults[] = ['contribution_id' => $paymentResult['contribution']->id, 'result' => $paymentActionResult];
1645       }
1646       // Do not send an email if Recurring transaction is done via Direct Mode
1647       // Email will we sent when the IPN is received.
1648       foreach ($paymentResults as $result) {
1649         //CRM-18211: Fix situation where second contribution doesn't exist because it is optional.
1650         if ($result['contribution_id']) {
1651           $this->completeTransaction($result['result'], $result['contribution_id']);
1652         }
1653       }
1654       return;
1655     }
1656
1657     $emailValues = array_merge($membershipParams, $form->_values);
1658     $emailValues['membership_assign'] = 1;
1659     $emailValues['useForMember'] = !empty($form->_useForMember);
1660
1661     // Finally send an email receipt for pay-later scenario (although it might sometimes be caught above!)
1662     if ($totalAmount == 0) {
1663       // This feels like a bizarre hack as the variable name doesn't seem to be directly connected to it's use in the template.
1664       $emailValues['useForMember'] = 0;
1665       $emailValues['amount'] = 0;
1666
1667       //CRM-18071, where on selecting $0 free membership payment section got hidden and
1668       // also it reset any payment processor selection result into pending free membership
1669       // so its a kind of hack to complete free membership at this point since there is no $form->_paymentProcessor info
1670       if (!empty($membershipContribution) && !is_a($membershipContribution, 'CRM_Core_Error')) {
1671         if (empty($form->_paymentProcessor)) {
1672           // @todo this can maybe go now we are setting payment_processor_id = 0 more reliably.
1673           $paymentProcessorIDs = explode(CRM_Core_DAO::VALUE_SEPARATOR, CRM_Utils_Array::value('payment_processor', $this->_values));
1674           $this->_paymentProcessor['id'] = $paymentProcessorIDs[0];
1675         }
1676         $result = ['payment_status_id' => 1, 'contribution' => $membershipContribution];
1677         $this->completeTransaction($result, $result['contribution']->id);
1678       }
1679       // return as completeTransaction() already sends the receipt mail.
1680       return;
1681     }
1682
1683     CRM_Contribute_BAO_ContributionPage::sendMail($contactID,
1684       $emailValues,
1685       $isTest, FALSE,
1686       $includeFieldTypes
1687     );
1688   }
1689
1690   /**
1691    * Turn array of errors into message string.
1692    *
1693    * @param array $errors
1694    *
1695    * @return string
1696    */
1697   protected function compileErrorMessage($errors) {
1698     foreach ($errors as $error) {
1699       if (is_string($error)) {
1700         $message[] = $error;
1701       }
1702     }
1703     return ts('Payment Processor Error message') . ': ' . implode('<br/>', $message);
1704   }
1705
1706   /**
1707    * Where a second separate financial transaction is supported we will process it here.
1708    *
1709    * @param int $contactID
1710    * @param CRM_Contribute_Form_Contribution_Confirm $form
1711    * @param array $tempParams
1712    * @param bool $isTest
1713    * @param array $lineItems
1714    * @param $minimumFee
1715    * @param int $financialTypeID
1716    *
1717    * @throws CRM_Core_Exception
1718    * @throws Exception
1719    * @return CRM_Contribute_BAO_Contribution
1720    */
1721   protected function processSecondaryFinancialTransaction($contactID, &$form, $tempParams, $isTest, $lineItems, $minimumFee,
1722                                                    $financialTypeID) {
1723     $financialType = new CRM_Financial_DAO_FinancialType();
1724     $financialType->id = $financialTypeID;
1725     $financialType->find(TRUE);
1726     $tempParams['amount'] = $minimumFee;
1727     $tempParams['invoiceID'] = md5(uniqid(rand(), TRUE));
1728     $isRecur = CRM_Utils_Array::value('is_recur', $tempParams);
1729
1730     //assign receive date when separate membership payment
1731     //and contribution amount not selected.
1732     if ($form->_amount == 0) {
1733       $now = date('YmdHis');
1734       $form->_params['receive_date'] = $now;
1735       $receiveDate = CRM_Utils_Date::mysqlToIso($now);
1736       $form->set('params', $form->_params);
1737       $form->assign('receive_date', $receiveDate);
1738     }
1739
1740     $form->set('membership_amount', $minimumFee);
1741     $form->assign('membership_amount', $minimumFee);
1742
1743     // we don't need to create the user twice, so lets disable cms_create_account
1744     // irrespective of the value, CRM-2888
1745     $tempParams['cms_create_account'] = 0;
1746
1747     //set this variable as we are not creating pledge for
1748     //separate membership payment contribution.
1749     //so for differentiating membership contribution from
1750     //main contribution.
1751     $form->_params['separate_membership_payment'] = 1;
1752     $contributionParams = [
1753       'contact_id' => $contactID,
1754       'line_item' => $lineItems,
1755       'is_test' => $isTest,
1756       'campaign_id' => CRM_Utils_Array::value('campaign_id', $tempParams, CRM_Utils_Array::value('campaign_id',
1757         $form->_values)),
1758       'contribution_page_id' => $form->_id,
1759       'source' => CRM_Utils_Array::value('source', $tempParams, CRM_Utils_Array::value('description', $tempParams)),
1760     ];
1761     $isMonetary = !empty($form->_values['is_monetary']);
1762     if ($isMonetary) {
1763       if (empty($paymentParams['is_pay_later'])) {
1764         $contributionParams['payment_instrument_id'] = $form->_paymentProcessor['payment_instrument_id'];
1765       }
1766     }
1767
1768     // CRM-19792 : set necessary fields for payment processor
1769     CRM_Core_Payment_Form::mapParams($form->_bltID, $form->_params, $tempParams, TRUE);
1770
1771     $membershipContribution = CRM_Contribute_Form_Contribution_Confirm::processFormContribution($form,
1772       $tempParams,
1773       $tempParams,
1774       $contributionParams,
1775       $financialType,
1776       TRUE,
1777       $form->_bltID,
1778       $isRecur
1779     );
1780
1781     $result = [];
1782
1783     // We're not processing the line item here because we are processing a membership.
1784     // To ensure processing of the correct parameters, replace relevant parameters
1785     // in $tempParams with those in $membershipContribution.
1786     $tempParams['amount_level'] = $membershipContribution->amount_level;
1787     $tempParams['total_amount'] = $membershipContribution->total_amount;
1788     $tempParams['tax_amount'] = $membershipContribution->tax_amount;
1789     $tempParams['contactID'] = $membershipContribution->contact_id;
1790     $tempParams['financialTypeID'] = $membershipContribution->financial_type_id;
1791     $tempParams['invoiceID'] = $membershipContribution->invoice_id;
1792     $tempParams['trxn_id'] = $membershipContribution->trxn_id;
1793     $tempParams['contributionID'] = $membershipContribution->id;
1794
1795     if ($form->_values['is_monetary'] && !$form->_params['is_pay_later'] && $minimumFee > 0.0) {
1796       // At the moment our tests are calling this form in a way that leaves 'object' empty. For
1797       // now we compensate here.
1798       if (empty($form->_paymentProcessor['object'])) {
1799         $payment = Civi\Payment\System::singleton()->getByProcessor($this->_paymentProcessor);
1800       }
1801       else {
1802         $payment = $form->_paymentProcessor['object'];
1803       }
1804       $result = $payment->doPayment($tempParams, 'contribute');
1805       $form->set('membership_trx_id', $result['trxn_id']);
1806       $form->assign('membership_trx_id', $result['trxn_id']);
1807     }
1808
1809     return [$membershipContribution, $result];
1810   }
1811
1812   /**
1813    * Is the payment a pending payment.
1814    *
1815    * We are moving towards always creating as pending and updating at the end (based on payment), so this should be
1816    * an interim refactoring. It was shared with another unrelated form & some parameters may not apply to this form.
1817    *
1818    * @return bool
1819    */
1820   protected function getIsPending() {
1821     // The concept of contributeMode is deprecated.
1822     // the is_monetary concept probably should be too as it can be calculated from
1823     // the existence of 'amount' & seems fragile.
1824     if (((isset($this->_contributeMode)) || !empty($this->_params['is_pay_later'])
1825       ) &&
1826       (($this->_values['is_monetary'] && $this->_amount > 0.0))
1827     ) {
1828       return TRUE;
1829     }
1830     return FALSE;
1831   }
1832
1833   /**
1834    * Are we going to do 2 financial transactions.
1835    *
1836    * Ie the membership block supports a separate transactions AND the contribution form has been configured for a
1837    * contribution
1838    * transaction AND a membership transaction AND the payment processor supports double financial transactions (ie. NOT doTransferCheckout style)
1839    *
1840    * @param int $formID
1841    * @param bool $amountBlockActiveOnForm
1842    *
1843    * @return bool
1844    */
1845   public function isSeparateMembershipTransaction($formID, $amountBlockActiveOnForm) {
1846     $memBlockDetails = CRM_Member_BAO_Membership::getMembershipBlock($formID);
1847     if (!empty($memBlockDetails['is_separate_payment']) && $amountBlockActiveOnForm) {
1848       return TRUE;
1849     }
1850     return FALSE;
1851   }
1852
1853   /**
1854    * This function sets the fields.
1855    *
1856    * - $this->_params['amount_level']
1857    * - $this->_params['selectMembership']
1858    * And under certain circumstances sets
1859    * $this->_params['amount'] = null;
1860    *
1861    * @param int $priceSetID
1862    */
1863   public function setFormAmountFields($priceSetID) {
1864     $isQuickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params['priceSetId'], 'is_quick_config');
1865     $priceField = new CRM_Price_DAO_PriceField();
1866     $priceField->price_set_id = $priceSetID;
1867     $priceField->orderBy('weight');
1868     $priceField->find();
1869     $paramWeDoNotUnderstand = NULL;
1870
1871     while ($priceField->fetch()) {
1872       if ($priceField->name == "contribution_amount") {
1873         $paramWeDoNotUnderstand = $priceField->id;
1874       }
1875       if ($isQuickConfig && !empty($this->_params["price_{$priceField->id}"])) {
1876         if ($this->_values['fee'][$priceField->id]['html_type'] != 'Text') {
1877           // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
1878           // function to get correct amount level consistently. Remove setting of the amount level in
1879           // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
1880           // to cover all variants.
1881           $this->_params['amount_level'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue',
1882             $this->_params["price_{$priceField->id}"], 'label');
1883         }
1884         if ($priceField->name == "membership_amount") {
1885           $this->_params['selectMembership'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue',
1886             $this->_params["price_{$priceField->id}"], 'membership_type_id');
1887         }
1888       }
1889       // If separate payment we set contribution amount to be null, so that it will not show contribution amount same
1890       // as membership amount.
1891       // @todo - this needs more documentation - it appears the setting to null is tied up with separate membership payments
1892       // but the circumstances are very confusing. Many of these conditions are repeated in the next conditional
1893       // so we should merge them together
1894       // the quick config seems like a red-herring - if this is about a separate membership payment then there
1895       // are 2 types of line items - membership ones & non-membership ones - regardless of whether quick config is set
1896       elseif (
1897         CRM_Utils_Array::value('is_separate_payment', $this->_membershipBlock)
1898         && !empty($this->_values['fee'][$priceField->id])
1899         && ($this->_values['fee'][$priceField->id]['name'] == "other_amount")
1900         && CRM_Utils_Array::value("price_{$paramWeDoNotUnderstand}", $this->_params) < 1
1901         && empty($this->_params["price_{$priceField->id}"])
1902       ) {
1903         $this->_params['amount'] = NULL;
1904       }
1905
1906       // Fix for CRM-14375 - If we are using separate payments and "no
1907       // thank you" is selected for the additional contribution, set
1908       // contribution amount to be null, so that it will not show
1909       // contribution amount same as membership amount.
1910       //@todo - merge with section above
1911       if ($this->_membershipBlock['is_separate_payment']
1912         && !empty($this->_values['fee'][$priceField->id])
1913         && CRM_Utils_Array::value('name', $this->_values['fee'][$priceField->id]) == 'contribution_amount'
1914         && CRM_Utils_Array::value("price_{$priceField->id}", $this->_params) == '-1'
1915       ) {
1916         $this->_params['amount'] = NULL;
1917       }
1918     }
1919   }
1920
1921   /**
1922    * Submit function.
1923    *
1924    * @param array $params
1925    *
1926    * @throws CiviCRM_API3_Exception
1927    */
1928   public static function submit($params) {
1929     $form = new CRM_Contribute_Form_Contribution_Confirm();
1930     $form->_id = $params['id'];
1931
1932     CRM_Contribute_BAO_ContributionPage::setValues($form->_id, $form->_values);
1933     $form->_separateMembershipPayment = CRM_Contribute_BAO_ContributionPage::getIsMembershipPayment($form->_id);
1934     //this way the mocked up controller ignores the session stuff
1935     $_SERVER['REQUEST_METHOD'] = 'GET';
1936     $form->controller = new CRM_Contribute_Controller_Contribution();
1937     $params['invoiceID'] = md5(uniqid(rand(), TRUE));
1938     $paramsProcessedForForm = $form->_params = self::getFormParams($params['id'], $params);
1939     $form->_amount = $params['amount'];
1940     // hack these in for test support.
1941     $form->_fields['billing_first_name'] = 1;
1942     $form->_fields['billing_last_name'] = 1;
1943     // CRM-18854 - Set form values to allow pledge to be created for api test.
1944     if (!empty($params['pledge_block_id'])) {
1945       $form->_values['pledge_id'] = CRM_Utils_Array::value('pledge_id', $params, NULL);
1946       $form->_values['pledge_block_id'] = $params['pledge_block_id'];
1947       $pledgeBlock = CRM_Pledge_BAO_PledgeBlock::getPledgeBlock($params['id']);
1948       $form->_values['max_reminders'] = $pledgeBlock['max_reminders'];
1949       $form->_values['initial_reminder_day'] = $pledgeBlock['initial_reminder_day'];
1950       $form->_values['additional_reminder_day'] = $pledgeBlock['additional_reminder_day'];
1951       $form->_values['is_email_receipt'] = FALSE;
1952     }
1953     $priceSetID = $form->_params['priceSetId'] = $paramsProcessedForForm['price_set_id'];
1954     $priceFields = CRM_Price_BAO_PriceSet::getSetDetail($priceSetID);
1955     $priceSetFields = reset($priceFields);
1956     $form->_values['fee'] = $priceSetFields['fields'];
1957     $form->_priceSetId = $priceSetID;
1958     $form->setFormAmountFields($priceSetID);
1959     $capabilities = [];
1960     if ($form->_mode) {
1961       $capabilities[] = (ucfirst($form->_mode) . 'Mode');
1962     }
1963     $form->_paymentProcessors = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors($capabilities);
1964     $form->_params['payment_processor_id'] = isset($params['payment_processor_id']) ? $params['payment_processor_id'] : 0;
1965     if ($form->_params['payment_processor_id'] !== '') {
1966       // It can be blank with a $0 transaction - then no processor needs to be selected
1967       $form->_paymentProcessor = $form->_paymentProcessors[$form->_params['payment_processor_id']];
1968     }
1969     if (!empty($params['payment_processor_id'])) {
1970       // The concept of contributeMode is deprecated as is the billing_mode concept.
1971       if ($form->_paymentProcessor['billing_mode'] == 1) {
1972         $form->_contributeMode = 'direct';
1973       }
1974       else {
1975         $form->_contributeMode = 'notify';
1976       }
1977     }
1978
1979     $priceFields = $priceFields[$priceSetID]['fields'];
1980     $lineItems = [];
1981     CRM_Price_BAO_PriceSet::processAmount($priceFields, $paramsProcessedForForm, $lineItems, 'civicrm_contribution', $priceSetID);
1982     $form->_lineItem = [$priceSetID => $lineItems];
1983     $membershipPriceFieldIDs = [];
1984     foreach ((array) $lineItems as $lineItem) {
1985       if (!empty($lineItem['membership_type_id'])) {
1986         $form->set('useForMember', 1);
1987         $form->_useForMember = 1;
1988         $membershipPriceFieldIDs['id'] = $priceSetID;
1989         $membershipPriceFieldIDs[] = $lineItem['price_field_value_id'];
1990       }
1991     }
1992     $form->set('memberPriceFieldIDS', $membershipPriceFieldIDs);
1993     $form->setRecurringMembershipParams();
1994     $form->processFormSubmission(CRM_Utils_Array::value('contact_id', $params));
1995   }
1996
1997   /**
1998    * Helper function for static submit function.
1999    *
2000    * Set relevant params - help us to build up an array that we can pass in.
2001    *
2002    * @param int $id
2003    * @param array $params
2004    *
2005    * @return array
2006    * @throws CiviCRM_API3_Exception
2007    */
2008   public static function getFormParams($id, array $params) {
2009     if (!isset($params['is_pay_later'])) {
2010       if (!empty($params['payment_processor_id'])) {
2011         $params['is_pay_later'] = 0;
2012       }
2013       elseif ($params['amount'] !== 0) {
2014         $params['is_pay_later'] = civicrm_api3('contribution_page', 'getvalue', [
2015           'id' => $id,
2016           'return' => 'is_pay_later',
2017         ]);
2018       }
2019     }
2020     if (empty($params['price_set_id'])) {
2021       $params['price_set_id'] = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $params['id']);
2022     }
2023     return $params;
2024   }
2025
2026   /**
2027    * Post form submission handling.
2028    *
2029    * This is also called from the test suite.
2030    *
2031    * @param int $contactID
2032    *
2033    * @return array
2034    */
2035   protected function processFormSubmission($contactID) {
2036     if (!isset($this->_params['payment_processor_id'])) {
2037       // If there is no processor we are using the pay-later manual pseudo-processor.
2038       // (note it might make sense to make this a row in the processor table in the db).
2039       $this->_params['payment_processor_id'] = 0;
2040     }
2041     if (isset($this->_params['payment_processor_id']) && $this->_params['payment_processor_id'] === 0) {
2042       $this->_params['is_pay_later'] = $isPayLater = TRUE;
2043     }
2044
2045     if (!empty($this->_ccid)) {
2046       $this->_params['contribution_id'] = $this->_ccid;
2047     }
2048     //Set email-bltID if pre/post profile contains an email.
2049     if ($this->_emailExists == TRUE) {
2050       foreach ($this->_params as $key => $val) {
2051         if (substr($key, 0, 6) == 'email-' && empty($this->_params["email-{$this->_bltID}"])) {
2052           $this->_params["email-{$this->_bltID}"] = $this->_params[$key];
2053         }
2054       }
2055     }
2056     // add a description field at the very beginning
2057     $this->_params['description'] = ts('Online Contribution') . ': ' . (($this->_pcpInfo['title']) ? $this->_pcpInfo['title'] : $this->_values['title']);
2058
2059     $this->_params['accountingCode'] = CRM_Utils_Array::value('accountingCode', $this->_values);
2060
2061     // fix currency ID
2062     $this->_params['currencyID'] = CRM_Core_Config::singleton()->defaultCurrency;
2063
2064     CRM_Contribute_Form_AbstractEditPayment::formatCreditCardDetails($this->_params);
2065
2066     // CRM-18854
2067     if (CRM_Utils_Array::value('is_pledge', $this->_params) && !CRM_Utils_Array::value('pledge_id', $this->_values) && CRM_Utils_Array::value('adjust_recur_start_date', $this->_values)) {
2068       $pledgeBlock = CRM_Pledge_BAO_PledgeBlock::getPledgeBlock($this->_id);
2069       if (CRM_Utils_Array::value('start_date', $this->_params) || !CRM_Utils_Array::value('is_pledge_start_date_visible', $pledgeBlock)
2070           || !CRM_Utils_Array::value('is_pledge_start_date_editable', $pledgeBlock)) {
2071         $pledgeStartDate = CRM_Utils_Array::value('start_date', $this->_params, NULL);
2072         $this->_params['receive_date'] = CRM_Pledge_BAO_Pledge::getPledgeStartDate($pledgeStartDate, $pledgeBlock);
2073         $recurParams = CRM_Pledge_BAO_Pledge::buildRecurParams($this->_params);
2074         $this->_params = array_merge($this->_params, $recurParams);
2075       }
2076     }
2077
2078     //carry payment processor id.
2079     if (CRM_Utils_Array::value('id', $this->_paymentProcessor)) {
2080       $this->_params['payment_processor_id'] = $this->_paymentProcessor['id'];
2081     }
2082
2083     $premiumParams = $membershipParams = $params = $this->_params;
2084     if (!empty($params['image_URL'])) {
2085       CRM_Contact_BAO_Contact::processImageParams($params);
2086     }
2087
2088     $fields = ['email-Primary' => 1];
2089
2090     // get the add to groups
2091     $addToGroups = [];
2092
2093     // now set the values for the billing location.
2094     foreach ($this->_fields as $name => $value) {
2095       $fields[$name] = 1;
2096
2097       // get the add to groups for uf fields
2098       if (!empty($value['add_to_group_id'])) {
2099         $addToGroups[$value['add_to_group_id']] = $value['add_to_group_id'];
2100       }
2101     }
2102
2103     $fields = $this->formatParamsForPaymentProcessor($fields);
2104
2105     // billing email address
2106     $fields["email-{$this->_bltID}"] = 1;
2107
2108     // if onbehalf-of-organization contribution, take out
2109     // organization params in a separate variable, to make sure
2110     // normal behavior is continued. And use that variable to
2111     // process on-behalf-of functionality.
2112     if (!empty($this->_values['onbehalf_profile_id']) && empty($this->_ccid)) {
2113       $behalfOrganization = [];
2114       $orgFields = ['organization_name', 'organization_id', 'org_option'];
2115       foreach ($orgFields as $fld) {
2116         if (array_key_exists($fld, $params)) {
2117           $behalfOrganization[$fld] = $params[$fld];
2118           unset($params[$fld]);
2119         }
2120       }
2121
2122       if (is_array($params['onbehalf']) && !empty($params['onbehalf'])) {
2123         foreach ($params['onbehalf'] as $fld => $values) {
2124           if (strstr($fld, 'custom_')) {
2125             $behalfOrganization[$fld] = $values;
2126           }
2127           elseif (!(strstr($fld, '-'))) {
2128             if (in_array($fld, [
2129               'contribution_campaign_id',
2130               'member_campaign_id',
2131             ])) {
2132               $fld = 'campaign_id';
2133             }
2134             else {
2135               $behalfOrganization[$fld] = $values;
2136             }
2137             $this->_params[$fld] = $values;
2138           }
2139         }
2140       }
2141
2142       if (array_key_exists('onbehalf_location', $params) && is_array($params['onbehalf_location'])) {
2143         foreach ($params['onbehalf_location'] as $block => $vals) {
2144           //fix for custom data (of type checkbox, multi-select)
2145           if (substr($block, 0, 7) == 'custom_') {
2146             continue;
2147           }
2148           // fix the index of block elements
2149           if (is_array($vals)) {
2150             foreach ($vals as $key => $val) {
2151               //dont adjust the index of address block as
2152               //it's index is WRT to location type
2153               $newKey = ($block == 'address') ? $key : ++$key;
2154               $behalfOrganization[$block][$newKey] = $val;
2155             }
2156           }
2157         }
2158         unset($params['onbehalf_location']);
2159       }
2160       if (!empty($params['onbehalf[image_URL]'])) {
2161         $behalfOrganization['image_URL'] = $params['onbehalf[image_URL]'];
2162       }
2163     }
2164
2165     // check for profile double opt-in and get groups to be subscribed
2166     $subscribeGroupIds = CRM_Core_BAO_UFGroup::getDoubleOptInGroupIds($params, $contactID);
2167
2168     // since we are directly adding contact to group lets unset it from mailing
2169     if (!empty($addToGroups)) {
2170       foreach ($addToGroups as $groupId) {
2171         if (isset($subscribeGroupIds[$groupId])) {
2172           unset($subscribeGroupIds[$groupId]);
2173         }
2174       }
2175     }
2176
2177     foreach ($addToGroups as $k) {
2178       if (array_key_exists($k, $subscribeGroupIds)) {
2179         unset($addToGroups[$k]);
2180       }
2181     }
2182
2183     if (empty($contactID)) {
2184       $dupeParams = $params;
2185       if (!empty($dupeParams['onbehalf'])) {
2186         unset($dupeParams['onbehalf']);
2187       }
2188       if (!empty($dupeParams['honor'])) {
2189         unset($dupeParams['honor']);
2190       }
2191
2192       $contactID = CRM_Contact_BAO_Contact::getFirstDuplicateContact($dupeParams, 'Individual', 'Unsupervised', [], FALSE);
2193
2194       // Fetch default greeting id's if creating a contact
2195       if (!$contactID) {
2196         foreach (CRM_Contact_BAO_Contact::$_greetingTypes as $greeting) {
2197           if (!isset($params[$greeting])) {
2198             $params[$greeting] = CRM_Contact_BAO_Contact_Utils::defaultGreeting('Individual', $greeting);
2199           }
2200         }
2201       }
2202       $contactType = NULL;
2203     }
2204     else {
2205       $contactType = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'contact_type');
2206     }
2207     $contactID = CRM_Contact_BAO_Contact::createProfileContact(
2208       $params,
2209       $fields,
2210       $contactID,
2211       $addToGroups,
2212       NULL,
2213       $contactType,
2214       TRUE
2215     );
2216
2217     // Make the contact ID associated with the contribution available at the Class level.
2218     // Also make available to the session.
2219     //@todo consider handling this in $this->getContactID();
2220     $this->set('contactID', $contactID);
2221     $this->_contactID = $contactID;
2222
2223     //get email primary first if exist
2224     $subscriptionEmail = ['email' => CRM_Utils_Array::value('email-Primary', $params)];
2225     if (!$subscriptionEmail['email']) {
2226       $subscriptionEmail['email'] = CRM_Utils_Array::value("email-{$this->_bltID}", $params);
2227     }
2228     // subscribing contact to groups
2229     if (!empty($subscribeGroupIds) && $subscriptionEmail['email']) {
2230       CRM_Mailing_Event_BAO_Subscribe::commonSubscribe($subscribeGroupIds, $subscriptionEmail, $contactID);
2231     }
2232
2233     // If onbehalf-of-organization contribution / signup, add organization
2234     // and it's location.
2235     if (isset($this->_values['onbehalf_profile_id']) &&
2236       isset($behalfOrganization['organization_name']) &&
2237       ($this->_values['is_for_organization'] == 2 ||
2238         !empty($this->_params['is_for_organization'])
2239       )
2240     ) {
2241       $ufFields = [];
2242       foreach ($this->_fields['onbehalf'] as $name => $value) {
2243         $ufFields[$name] = 1;
2244       }
2245       self::processOnBehalfOrganization($behalfOrganization, $contactID, $this->_values,
2246         $this->_params, $ufFields
2247       );
2248     }
2249     elseif (!empty($this->_membershipContactID) && $contactID != $this->_membershipContactID) {
2250       // this is an onbehalf renew case for inherited membership. For e.g a permissioned member of household,
2251       // store current user id as related contact for later use for mailing / activity..
2252       $this->_values['related_contact'] = $contactID;
2253       $this->_params['related_contact'] = $contactID;
2254       // swap contact like we do for on-behalf-org case, so parent/primary membership is affected
2255       $contactID = $this->_membershipContactID;
2256     }
2257
2258     // lets store the contactID in the session
2259     // for things like tell a friend
2260     $session = CRM_Core_Session::singleton();
2261     if (!$session->get('userID')) {
2262       $session->set('transaction.userID', $contactID);
2263     }
2264     else {
2265       $session->set('transaction.userID', NULL);
2266     }
2267
2268     $this->_useForMember = $this->get('useForMember');
2269
2270     // store the fact that this is a membership and membership type is selected
2271     if ((!empty($membershipParams['selectMembership']) &&
2272         $membershipParams['selectMembership'] != 'no_thanks'
2273       ) ||
2274       $this->_useForMember
2275     ) {
2276       if (!$this->_useForMember) {
2277         $this->assign('membership_assign', TRUE);
2278         $this->set('membershipTypeID', $this->_params['selectMembership']);
2279       }
2280
2281       if ($this->_action & CRM_Core_Action::PREVIEW) {
2282         $membershipParams['is_test'] = 1;
2283       }
2284       if ($this->_params['is_pay_later']) {
2285         $membershipParams['is_pay_later'] = 1;
2286       }
2287
2288       if (isset($this->_params['onbehalf_contact_id'])) {
2289         $membershipParams['onbehalf_contact_id'] = $this->_params['onbehalf_contact_id'];
2290       }
2291       //inherit campaign from contribution page.
2292       if (!array_key_exists('campaign_id', $membershipParams)) {
2293         $membershipParams['campaign_id'] = CRM_Utils_Array::value('campaign_id', $this->_values);
2294       }
2295
2296       $this->_params = CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $membershipParams, TRUE);
2297       $this->doMembershipProcessing($contactID, $membershipParams, $premiumParams, $this->_lineItem);
2298     }
2299     else {
2300       // at this point we've created a contact and stored its address etc
2301       // all the payment processors expect the name and address to be in the
2302       // so we copy stuff over to first_name etc.
2303       $paymentParams = $this->_params;
2304       // Make it explict that we are letting the processConfirm function figure out the line items.
2305       $paymentParams['skipLineItem'] = 0;
2306
2307       if (!isset($paymentParams['line_item'])) {
2308         $paymentParams['line_item'] = $this->_lineItem;
2309       }
2310
2311       if (!empty($paymentParams['onbehalf']) &&
2312         is_array($paymentParams['onbehalf'])
2313       ) {
2314         foreach ($paymentParams['onbehalf'] as $key => $value) {
2315           if (strstr($key, 'custom_')) {
2316             $this->_params[$key] = $value;
2317           }
2318         }
2319       }
2320
2321       $result = CRM_Contribute_BAO_Contribution_Utils::processConfirm($this, $paymentParams,
2322         $contactID,
2323         $this->wrangleFinancialTypeID($this->_values['financial_type_id']),
2324         ($this->_mode == 'test') ? 1 : 0,
2325         CRM_Utils_Array::value('is_recur', $paymentParams)
2326       );
2327
2328       if (empty($result['is_payment_failure'])) {
2329         // @todo move premium processing to complete transaction if it truly is an 'after' action.
2330         $this->postProcessPremium($premiumParams, $result['contribution']);
2331       }
2332       if (!empty($result['contribution'])) {
2333         // It seems this line is hit when there is a zero dollar transaction & in tests, not sure when else.
2334         $this->completeTransaction($result, $result['contribution']->id);
2335       }
2336       return $result;
2337     }
2338   }
2339
2340   /**
2341    * Membership processing section.
2342    *
2343    * This is in a separate function as part of a move towards refactoring.
2344    *
2345    * @param int $contactID
2346    * @param array $membershipParams
2347    * @param array $premiumParams
2348    * @param array $formLineItems
2349    */
2350   protected function doMembershipProcessing($contactID, $membershipParams, $premiumParams, $formLineItems) {
2351     // This could be set by a hook.
2352     if (!empty($this->_params['installments'])) {
2353       $membershipParams['installments'] = $this->_params['installments'];
2354     }
2355     // added new parameter for cms user contact id, needed to distinguish behaviour for on behalf of sign-ups
2356     if (isset($this->_params['related_contact'])) {
2357       $membershipParams['cms_contactID'] = $this->_params['related_contact'];
2358     }
2359     else {
2360       $membershipParams['cms_contactID'] = $contactID;
2361     }
2362
2363     if (!empty($membershipParams['onbehalf']) &&
2364       is_array($membershipParams['onbehalf']) && !empty($membershipParams['onbehalf']['member_campaign_id'])
2365     ) {
2366       $this->_params['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
2367     }
2368
2369     $customFieldsFormatted = $fieldTypes = [];
2370     if (!empty($membershipParams['onbehalf']) &&
2371       is_array($membershipParams['onbehalf'])
2372     ) {
2373       foreach ($membershipParams['onbehalf'] as $key => $value) {
2374         if (strstr($key, 'custom_')) {
2375           $customFieldId = explode('_', $key);
2376           CRM_Core_BAO_CustomField::formatCustomField(
2377             $customFieldId[1],
2378             $customFieldsFormatted,
2379             $value,
2380             'Membership',
2381             NULL,
2382             $contactID
2383           );
2384         }
2385       }
2386       $fieldTypes = ['Contact', 'Organization', 'Membership'];
2387     }
2388
2389     $priceFieldIds = $this->get('memberPriceFieldIDS');
2390
2391     if (!empty($priceFieldIds)) {
2392       $membershipParams['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $priceFieldIds['id'], 'financial_type_id');
2393       unset($priceFieldIds['id']);
2394       $membershipTypeIds = [];
2395       $membershipTypeTerms = [];
2396       foreach ($priceFieldIds as $priceFieldId) {
2397         $membershipTypeId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id');
2398         if ($membershipTypeId) {
2399           $membershipTypeIds[] = $membershipTypeId;
2400           $term = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_num_terms') ?: 1;
2401           $membershipTypeTerms[$membershipTypeId] = ($term > 1) ? $term : 1;
2402         }
2403       }
2404       $membershipParams['selectMembership'] = $membershipTypeIds;
2405       $membershipParams['types_terms'] = $membershipTypeTerms;
2406     }
2407     if (!empty($membershipParams['selectMembership'])) {
2408       // CRM-12233
2409       $membershipLineItems = $formLineItems;
2410       if ($this->_separateMembershipPayment && $this->_values['amount_block_is_active']) {
2411         $membershipLineItems = [];
2412         foreach ($this->_values['fee'] as $key => $feeValues) {
2413           if ($feeValues['name'] == 'membership_amount') {
2414             $fieldId = $this->_params['price_' . $key];
2415             $membershipLineItems[$this->_priceSetId][$fieldId] = $this->_lineItem[$this->_priceSetId][$fieldId];
2416             unset($this->_lineItem[$this->_priceSetId][$fieldId]);
2417             break;
2418           }
2419         }
2420       }
2421       try {
2422         $this->processMembership($membershipParams, $contactID, $customFieldsFormatted, $fieldTypes, $premiumParams, $membershipLineItems);
2423       }
2424       catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
2425         CRM_Core_Session::singleton()->setStatus($e->getMessage());
2426         if (!empty($this->_contributionID)) {
2427           CRM_Contribute_BAO_Contribution::failPayment($this->_contributionID,
2428             $contactID, $e->getMessage());
2429         }
2430         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/transact', "_qf_Main_display=true&qfKey={$this->_params['qfKey']}"));
2431       }
2432       catch (CRM_Core_Exception $e) {
2433         CRM_Core_Session::singleton()->setStatus($e->getMessage());
2434         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/transact', "_qf_Main_display=true&qfKey={$this->_params['qfKey']}"));
2435       }
2436       if (!$this->_amount > 0.0 || !$membershipParams['amount']) {
2437         // we need to explicitly create a CMS user in case of free memberships
2438         // since it is done under processConfirm for paid memberships
2439         CRM_Contribute_BAO_Contribution_Utils::createCMSUser($membershipParams,
2440           $membershipParams['cms_contactID'],
2441           'email-' . $this->_bltID
2442         );
2443       }
2444     }
2445   }
2446
2447   /**
2448    * Complete transaction if payment has been processed.
2449    *
2450    * Check the result for a success outcome & if paid then complete the transaction.
2451    *
2452    * Completing will trigger update of related entities and emails.
2453    *
2454    * @param array $result
2455    * @param int $contributionID
2456    *
2457    * @throws \CiviCRM_API3_Exception
2458    * @throws \Exception
2459    */
2460   protected function completeTransaction($result, $contributionID) {
2461     if (CRM_Utils_Array::value('payment_status_id', $result) == 1) {
2462       try {
2463         civicrm_api3('contribution', 'completetransaction', [
2464           'id' => $contributionID,
2465           'trxn_id' => CRM_Utils_Array::value('trxn_id', $result),
2466           'payment_processor_id' => CRM_Utils_Array::value('payment_processor_id', $result, $this->_paymentProcessor['id']),
2467           'is_transactional' => FALSE,
2468           'fee_amount' => CRM_Utils_Array::value('fee_amount', $result),
2469           'receive_date' => CRM_Utils_Array::value('receive_date', $result),
2470           'card_type_id' => CRM_Utils_Array::value('card_type_id', $result),
2471           'pan_truncation' => CRM_Utils_Array::value('pan_truncation', $result),
2472         ]);
2473       }
2474       catch (CiviCRM_API3_Exception $e) {
2475         if ($e->getErrorCode() != 'contribution_completed') {
2476           throw new CRM_Core_Exception('Failed to update contribution in database');
2477         }
2478       }
2479     }
2480   }
2481
2482   /**
2483    * Bounce the user back to retry when an error occurs.
2484    *
2485    * @param string $message
2486    */
2487   protected function bounceOnError($message) {
2488     CRM_Core_Session::singleton()
2489       ->setStatus(ts("Payment Processor Error message :") .
2490         $message);
2491     CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/transact',
2492       "_qf_Main_display=true&qfKey={$this->_params['qfKey']}"
2493     ));
2494   }
2495
2496 }