3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 * form to process actions on the group aspect of Custom Data
37 class CRM_Contribute_Form_Contribution_Confirm
extends CRM_Contribute_Form_ContributionBase
{
38 use CRM_Financial_Form_FrontEndPaymentFormTrait
;
41 * The id of the contact associated with this contribution.
49 * The id of the contribution object that is created when the form is submitted.
53 public $_contributionID;
55 public $submitOnce = TRUE;
60 * @param $contributionParams
62 * @param $contribution
63 * @param $isEmailReceipt
66 public static function handlePledge(&$form, $params, $contributionParams, $pledgeID, $contribution, $isEmailReceipt) {
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',
80 $pledgePayment = ($amount >= $scheduledAmount) ?
$scheduledAmount : $amount;
81 if ($pledgePayment > 0) {
82 $pledgePaymentParams[] = [
84 'contribution_id' => $contribution->id
,
85 'status_id' => $contribution->contribution_status_id
,
86 'actual_amount' => $pledgePayment,
88 $amount -= $pledgePayment;
91 if ($amount > 0 && count($pledgePaymentParams)) {
92 $pledgePaymentParams[count($pledgePaymentParams) - 1]['actual_amount'] +
= $amount;
94 foreach ($pledgePaymentParams as $p) {
95 CRM_Pledge_BAO_PledgePayment
::add($p);
98 //update pledge status according to the new payment statuses
99 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID);
103 //when user creating pledge record.
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"));
117 $pledgeParams['frequency_day'] = 1;
119 $pledgeParams['create_date'] = $pledgeParams['start_date'] = $pledgeParams['scheduled_date'] = date("Ymd");
120 if (CRM_Utils_Array
::value('start_date', $params)) {
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)));
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'];
132 //inherit campaign from contirb page.
133 $pledgeParams['campaign_id'] = CRM_Utils_Array
::value('campaign_id', $contributionParams);
135 $pledge = CRM_Pledge_BAO_Pledge
::create($pledgeParams);
137 $form->_params
['pledge_id'] = $pledge->id
;
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'];
146 //scheduled amount will be same as installment_amount.
147 $pledgeParams['scheduled_amount'] = $pledgeParams['installment_amount'];
149 //get total pledge amount.
150 $pledgeParams['total_pledge_amount'] = $pledge->amount
;
152 CRM_Pledge_BAO_Pledge
::sendAcknowledgment($form, $pledgeParams);
160 * Set the parameters to be passed to contribution create function.
162 * @param array $params
163 * @param int $financialTypeID
164 * @param array $paymentProcessorOutcome
165 * @param string $receiptDate
166 * @param int $recurringContributionID
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),
190 if ($paymentProcessorOutcome) {
191 $contributionParams['payment_processor'] = CRM_Utils_Array
::value('payment_processor', $paymentProcessorOutcome);
193 if (!empty($params["is_email_receipt"])) {
194 $contributionParams +
= [
195 'receipt_date' => $receiptDate,
199 if ($recurringContributionID) {
200 $contributionParams['contribution_recur_id'] = $recurringContributionID;
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'],
213 return $contributionParams;
217 * Get non-deductible amount.
219 * This is a bit too much about wierd form interpretation to be this deep.
222 * if non_deductible_amount exists i.e. Additional Details fieldset was opened [and staff typed something] -> keep
225 * @param array $params
226 * @param CRM_Financial_BAO_FinancialType $financialType
227 * @param bool $online
228 * @param CRM_Contribute_Form_Contribution_Confirm $form
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'];
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
);
242 if (!empty($nonDeductibleAmount)) {
243 return $nonDeductibleAmount;
246 if ($financialType->is_deductible
) {
247 if ($online && isset($params['selectProduct'])) {
248 $selectProduct = CRM_Utils_Array
::value('selectProduct', $params);
250 if (!$online && isset($params['product_name'][0])) {
251 $selectProduct = $params['product_name'][0];
253 // if there is a product - compare the value to the contribution amount
254 if (isset($selectProduct) &&
255 $selectProduct != 'no_thanks'
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;
265 // product value does NOT exceed contribution amount
267 return $productDAO->price
;
270 // contribution is deductible - but there is no product
275 // contribution is NOT deductible
277 return $params['amount'];
283 * Set variables up before form is built.
285 public function preProcess() {
286 $config = CRM_Core_Config
::singleton();
287 parent
::preProcess();
289 // lineItem isn't set until Register postProcess
290 $this->_lineItem
= $this->get('lineItem');
291 $this->_ccid
= $this->get('ccid');
293 $this->_params
= $this->controller
->exportValues('Main');
294 $this->_params
['ip_address'] = CRM_Utils_System
::ipAddress();
295 $this->_params
['amount'] = $this->get('amount');
296 if (isset($this->_params
['amount'])) {
297 $this->setFormAmountFields($this->_params
['priceSetId']);
300 $this->_params
['tax_amount'] = $this->get('tax_amount');
301 $this->_useForMember
= $this->get('useForMember');
303 if (isset($this->_params
['credit_card_exp_date'])) {
304 $this->_params
['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($this->_params
);
305 $this->_params
['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($this->_params
);
308 $this->_params
['currencyID'] = $config->defaultCurrency
;
310 if (!empty($this->_membershipBlock
)) {
311 $this->_params
['selectMembership'] = $this->get('selectMembership');
313 if (!empty($this->_paymentProcessor
) && $this->_paymentProcessor
['object']->supports('preApproval')) {
314 $preApprovalParams = $this->_paymentProcessor
['object']->getPreApprovalDetails($this->get('pre_approval_parameters'));
315 $this->_params
= array_merge($this->_params
, $preApprovalParams);
317 // We may have fetched some billing details from the getPreApprovalDetails function so we
318 // want to ensure we set this after that function has been called.
319 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $preApprovalParams, $this->_params
, FALSE);
322 $this->_params
['is_pay_later'] = $this->get('is_pay_later');
323 $this->assign('is_pay_later', $this->_params
['is_pay_later']);
324 if ($this->_params
['is_pay_later']) {
325 $this->assign('pay_later_receipt', CRM_Utils_Array
::value('pay_later_receipt', $this->_values
));
327 // if onbehalf-of-organization
328 if (!empty($this->_values
['onbehalf_profile_id']) && !empty($this->_params
['onbehalf']['organization_name'])) {
329 if (empty($this->_params
['org_option']) && empty($this->_params
['organization_id'])) {
330 $this->_params
['organization_id'] = CRM_Utils_Array
::value('onbehalfof_id', $this->_params
);
332 $this->_params
['organization_name'] = $this->_params
['onbehalf']['organization_name'];
339 'supplemental_address_1',
340 'supplemental_address_2',
341 'supplemental_address_3',
342 'postal_code_suffix',
348 $blocks = ['email', 'phone', 'im', 'url', 'openid'];
349 foreach ($this->_params
['onbehalf'] as $loc => $value) {
350 $field = $typeId = NULL;
351 if (strstr($loc, '-')) {
352 list($field, $locType) = explode('-', $loc);
355 if (in_array($field, $addressBlocks)) {
356 if ($locType == 'Primary') {
357 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
358 $locType = $defaultLocationType->id
;
361 if ($field == 'country') {
362 $value = CRM_Core_PseudoConstant
::countryIsoCode($value);
364 elseif ($field == 'state_province') {
365 $value = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($value);
369 if (isset($this->_params
['onbehalf_location']['address'])
370 && count($this->_params
['onbehalf_location']['address']) > 0
375 $this->_params
['onbehalf_location']['address'][$locType][$field] = $value;
376 if (empty($this->_params
['onbehalf_location']['address'][$locType]['is_primary'])) {
377 $this->_params
['onbehalf_location']['address'][$locType]['is_primary'] = $isPrimary;
379 $this->_params
['onbehalf_location']['address'][$locType]['location_type_id'] = $locType;
381 elseif (in_array($field, $blocks)) {
382 if (!$typeId ||
is_numeric($typeId)) {
383 $blockName = $fieldName = $field;
384 $locationType = 'location_type_id';
385 if ($locType == 'Primary') {
386 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
387 $locationValue = $defaultLocationType->id
;
390 $locationValue = $locType;
395 if ($field == 'url') {
396 $blockName = 'website';
397 $locationType = 'website_type_id';
398 list($field, $locationValue) = explode('-', $loc);
400 elseif ($field == 'im') {
402 $locTypeId = 'provider_id';
403 $typeId = $this->_params
['onbehalf']["{$loc}-provider_id"];
405 elseif ($field == 'phone') {
406 list($field, $locType, $typeId) = explode('-', $loc);
407 $locTypeId = 'phone_type_id';
409 //check if extension field exists
410 $extField = str_replace('phone', 'phone_ext', $loc);
411 if (isset($this->_params
['onbehalf'][$extField])) {
412 $phoneExtField = ['phone_ext' => $this->_params
['onbehalf'][$extField]];
417 if (isset($this->_params
['onbehalf_location'][$blockName])
418 && count($this->_params
['onbehalf_location'][$blockName]) > 0
422 if ($locationValue) {
424 $fieldName => $value,
425 $locationType => $locationValue,
426 'is_primary' => $isPrimary,
430 $blockValues = array_merge($blockValues, [$locTypeId => $typeId]);
432 if (!empty($phoneExtField)) {
433 $blockValues = array_merge($blockValues, $phoneExtField);
436 $this->_params
['onbehalf_location'][$blockName][] = $blockValues;
440 elseif (strstr($loc, 'custom')) {
441 if ($value && isset($this->_params
['onbehalf']["{$loc}_id"])) {
442 $value = $this->_params
['onbehalf']["{$loc}_id"];
444 $this->_params
['onbehalf_location']["{$loc}"] = $value;
447 if ($loc == 'contact_sub_type') {
448 $this->_params
['onbehalf_location'][$loc] = $value;
451 $this->_params
['onbehalf_location'][$field] = $value;
456 elseif (!empty($this->_values
['is_for_organization'])) {
457 // no on behalf of an organization, CRM-5519
458 // so reset loc blocks from main params.
464 if (isset($this->_params
[$blk])) {
465 unset($this->_params
[$blk]);
469 $this->setRecurringMembershipParams();
472 $params = $this->processPcp($this, $this->_params
);
473 $this->_params
= $params;
475 $this->_params
['invoiceID'] = $this->get('invoiceID');
477 //carry campaign from profile.
478 if (array_key_exists('contribution_campaign_id', $this->_params
)) {
479 $this->_params
['campaign_id'] = $this->_params
['contribution_campaign_id'];
482 // assign contribution page id to the template so we can add css class for it
483 $this->assign('contributionPageID', $this->_id
);
484 $this->assign('is_for_organization', CRM_Utils_Array
::value('is_for_organization', $this->_params
));
486 $this->set('params', $this->_params
);
490 * Build the form object.
492 public function buildQuickForm() {
493 // FIXME: Some of this code is identical to Thankyou.php and should be broken out into a shared function
494 $this->assignToTemplate();
496 $params = $this->_params
;
497 // make sure we have values for it
498 if (!empty($this->_values
['honoree_profile_id']) && !empty($params['soft_credit_type_id']) && empty($this->_ccid
)) {
500 $softCreditTypes = CRM_Core_OptionGroup
::values("soft_credit_type", FALSE);
502 $this->assign('soft_credit_type', $softCreditTypes[$params['soft_credit_type_id']]);
503 CRM_Contribute_BAO_ContributionSoft
::formatHonoreeProfileFields($this, $params['honor']);
505 $fieldTypes = ['Contact'];
506 $fieldTypes[] = CRM_Core_BAO_UFGroup
::getContactType($this->_values
['honoree_profile_id']);
507 $this->buildCustom($this->_values
['honoree_profile_id'], 'honoreeProfileFields', TRUE, 'honor', $fieldTypes);
509 $this->assign('receiptFromEmail', CRM_Utils_Array
::value('receipt_from_email', $this->_values
));
510 $amount_block_is_active = $this->get('amount_block_is_active');
511 $this->assign('amount_block_is_active', $amount_block_is_active);
513 // Make a copy of line items array to use for display only
514 $tplLineItems = $this->_lineItem
;
515 if (CRM_Invoicing_Utils
::isInvoicingEnabled()) {
516 // @todo $params seems like exactly the wrong place to get totalTaxAmount from
517 // this is a calculated variable so we it should be transparent how we
518 // calculated it rather than coming from 'params'
519 $this->assign('totalTaxAmount', $params['tax_amount']);
521 $this->assignLineItemsToTemplate($tplLineItems);
523 $isDisplayLineItems = $this->_priceSetId
&& !CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config');
525 $this->assign('isDisplayLineItems', $isDisplayLineItems);
527 if (!$isDisplayLineItems) {
528 // quickConfig is deprecated in favour of isDisplayLineItems. Lots of logic has been harnessed to quick config
529 // whereas isDisplayLineItems is specific & clear.
530 $this->assign('is_quick_config', 1);
531 $this->_params
['is_quick_config'] = 1;
534 if (!empty($params['selectProduct']) && $params['selectProduct'] != 'no_thanks') {
535 $option = CRM_Utils_Array
::value('options_' . $params['selectProduct'], $params);
536 $productID = $params['selectProduct'];
537 CRM_Contribute_BAO_Premium
::buildPremiumBlock($this, $this->_id
, FALSE,
540 $this->set('productID', $productID);
541 $this->set('option', $option);
543 $config = CRM_Core_Config
::singleton();
544 if (in_array('CiviMember', $config->enableComponents
) && empty($this->_ccid
)) {
545 if (isset($params['selectMembership']) &&
546 $params['selectMembership'] != 'no_thanks'
548 $this->buildMembershipBlock(
549 $this->_membershipContactID
,
551 $params['selectMembership'],
554 if (!empty($params['auto_renew'])) {
555 $this->assign('auto_renew', TRUE);
559 $this->assign('membershipBlock', FALSE);
562 if (empty($this->_ccid
)) {
563 $this->buildCustom($this->_values
['custom_pre_id'], 'customPre', TRUE);
564 $this->buildCustom($this->_values
['custom_post_id'], 'customPost', TRUE);
567 if (!empty($this->_values
['onbehalf_profile_id']) &&
568 !empty($params['onbehalf']) &&
569 ($this->_values
['is_for_organization'] == 2 ||
570 !empty($params['is_for_organization'])
571 ) && empty($this->_ccid
)
573 $fieldTypes = ['Contact', 'Organization'];
574 $contactSubType = CRM_Contact_BAO_ContactType
::subTypes('Organization');
575 $fieldTypes = array_merge($fieldTypes, $contactSubType);
576 if (is_array($this->_membershipBlock
) && !empty($this->_membershipBlock
)) {
577 $fieldTypes = array_merge($fieldTypes, ['Membership']);
580 $fieldTypes = array_merge($fieldTypes, ['Contribution']);
583 $this->buildCustom($this->_values
['onbehalf_profile_id'], 'onbehalfProfile', TRUE, 'onbehalf', $fieldTypes);
586 $this->_separateMembershipPayment
= $this->get('separateMembershipPayment');
587 $this->assign('is_separate_payment', $this->_separateMembershipPayment
);
589 $this->assign('priceSetID', $this->_priceSetId
);
591 // The concept of contributeMode is deprecated.
592 // the is_monetary concept probably should be too as it can be calculated from
593 // the existence of 'amount' & seems fragile.
594 if ($this->_contributeMode
== 'notify' ||
595 $this->_amount
<= 0.0 ||
$this->_params
['is_pay_later']
597 $contribButton = ts('Continue');
599 elseif (!empty($this->_ccid
)) {
600 $contribButton = ts('Make Payment');
603 $contribButton = ts('Make Contribution');
605 $this->assign('button', $contribButton);
607 $this->assign('continueText',
608 $this->getPaymentProcessorObject()->getText('contributionPageContinueText', [
609 'is_payment_to_existing' => !empty($this->_ccid
),
610 'amount' => $this->_amount
,
617 'name' => $contribButton,
618 'spacing' => ' ',
623 'name' => ts('Go Back'),
628 $fields = array_fill_keys(array_keys($this->_fields
), 1);
629 $fields["billing_state_province-{$this->_bltID}"] = $fields["billing_country-{$this->_bltID}"] = $fields["email-{$this->_bltID}"] = 1;
631 $contact = $this->_params
;
632 foreach ($fields as $name => $dontCare) {
633 // Recursively set defaults for nested fields
634 if (isset($contact[$name]) && is_array($contact[$name]) && ($name == 'onbehalf' ||
$name == 'honor')) {
635 foreach ($contact[$name] as $fieldName => $fieldValue) {
636 if (is_array($fieldValue) && !in_array($this->_fields
[$name][$fieldName]['html_type'], [
641 foreach ($fieldValue as $key => $value) {
642 $defaults["{$name}[{$fieldName}][{$key}]"] = $value;
646 $defaults["{$name}[{$fieldName}]"] = $fieldValue;
650 elseif (isset($contact[$name])) {
651 $defaults[$name] = $contact[$name];
652 if (substr($name, 0, 7) == 'custom_') {
653 $timeField = "{$name}_time";
654 if (isset($contact[$timeField])) {
655 $defaults[$timeField] = $contact[$timeField];
657 if (isset($contact["{$name}_id"])) {
658 $defaults["{$name}_id"] = $contact["{$name}_id"];
661 elseif (in_array($name, [
665 ]) && !empty($contact[$name . '_custom'])
667 $defaults[$name . '_custom'] = $contact[$name . '_custom'];
672 $this->assign('useForMember', $this->get('useForMember'));
674 $this->setDefaults($defaults);
682 * Since we are only showing elements in frozen mode no help display needed.
686 public function getAction() {
687 if ($this->_action
& CRM_Core_Action
::PREVIEW
) {
688 return CRM_Core_Action
::VIEW | CRM_Core_Action
::PREVIEW
;
691 return CRM_Core_Action
::VIEW
;
696 * Set default values for the form.
698 * Note that in edit/view mode
699 * the default values are retrieved from the database
701 public function setDefaultValues() {
707 public function postProcess() {
708 $contactID = $this->getContactID();
710 $result = $this->processFormSubmission($contactID);
712 catch (CRM_Core_Exception
$e) {
713 $this->bounceOnError($e->getMessage());
716 if (is_array($result) && !empty($result['is_payment_failure'])) {
717 $this->bounceOnError($result['error']->getMessage());
719 // Presumably this is for hooks to access? Not quite clear & perhaps not required.
720 $this->set('params', $this->_params
);
724 * Wrangle financial type ID.
726 * 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
727 * Pledges are not relevant to the membership code so that portion will not go onto the membership form.
729 * Comments from previous refactor indicate doubt as to what was going on.
731 * @param int $financialTypeID
733 * @return null|string
735 public function wrangleFinancialTypeID($financialTypeID) {
736 if (empty($financialTypeID) && !empty($this->_values
['pledge_id'])) {
737 $financialTypeID = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_Pledge',
738 $this->_values
['pledge_id'],
742 return $financialTypeID;
748 * @param array $premiumParams
749 * @param CRM_Contribute_BAO_Contribution $contribution
751 protected function postProcessPremium($premiumParams, $contribution) {
752 $hour = $minute = $second = 0;
753 // assigning Premium information to receipt tpl
754 $selectProduct = CRM_Utils_Array
::value('selectProduct', $premiumParams);
755 if ($selectProduct &&
756 $selectProduct != 'no_thanks'
758 $startDate = $endDate = "";
759 $this->assign('selectPremium', TRUE);
760 $productDAO = new CRM_Contribute_DAO_Product();
761 $productDAO->id
= $selectProduct;
762 $productDAO->find(TRUE);
763 $this->assign('product_name', $productDAO->name
);
764 $this->assign('price', $productDAO->price
);
765 $this->assign('sku', $productDAO->sku
);
766 $this->assign('option', CRM_Utils_Array
::value('options_' . $premiumParams['selectProduct'], $premiumParams));
768 $periodType = $productDAO->period_type
;
771 $fixed_period_start_day = $productDAO->fixed_period_start_day
;
772 $duration_unit = $productDAO->duration_unit
;
773 $duration_interval = $productDAO->duration_interval
;
774 if ($periodType == 'rolling') {
775 $startDate = date('Y-m-d');
777 elseif ($periodType == 'fixed') {
778 if ($fixed_period_start_day) {
779 $date = explode('-', date('Y-m-d'));
780 $month = substr($fixed_period_start_day, 0, strlen($fixed_period_start_day) - 2);
781 $day = substr($fixed_period_start_day, -2) . "<br/>";
783 $startDate = $year . '-' . $month . '-' . $day;
786 $startDate = date('Y-m-d');
790 $date = explode('-', $startDate);
795 switch ($duration_unit) {
797 $year = $year +
$duration_interval;
801 $month = $month +
$duration_interval;
805 $day = $day +
$duration_interval;
809 $day = $day +
($duration_interval * 7);
811 $endDate = date('Y-m-d H:i:s', mktime($hour, $minute, $second, $month, $day, $year));
812 $this->assign('start_date', $startDate);
813 $this->assign('end_date', $endDate);
816 $dao = new CRM_Contribute_DAO_Premium();
817 $dao->entity_table
= 'civicrm_contribution_page';
818 $dao->entity_id
= $this->_id
;
820 $this->assign('contact_phone', $dao->premiums_contact_phone
);
821 $this->assign('contact_email', $dao->premiums_contact_email
);
823 //create Premium record
825 'product_id' => $premiumParams['selectProduct'],
826 'contribution_id' => $contribution->id
,
827 'product_option' => CRM_Utils_Array
::value('options_' . $premiumParams['selectProduct'], $premiumParams),
829 'start_date' => CRM_Utils_Date
::customFormat($startDate, '%Y%m%d'),
830 'end_date' => CRM_Utils_Date
::customFormat($endDate, '%Y%m%d'),
832 if (!empty($premiumParams['selectProduct'])) {
833 $daoPremiumsProduct = new CRM_Contribute_DAO_PremiumsProduct();
834 $daoPremiumsProduct->product_id
= $premiumParams['selectProduct'];
835 $daoPremiumsProduct->premiums_id
= $dao->id
;
836 $daoPremiumsProduct->find(TRUE);
837 $params['financial_type_id'] = $daoPremiumsProduct->financial_type_id
;
840 $daoContrProd = new CRM_Contribute_DAO_ContributionProduct();
841 $daoContrProd->contribution_id
= $contribution->id
;
842 if ($daoContrProd->find(TRUE)) {
843 $params['id'] = $daoContrProd->id
;
846 CRM_Contribute_BAO_Contribution
::addPremium($params);
847 if ($productDAO->cost
&& !empty($params['financial_type_id'])) {
849 'cost' => $productDAO->cost
,
850 'currency' => $productDAO->currency
,
851 'financial_type_id' => $params['financial_type_id'],
852 'contributionId' => $contribution->id
,
854 CRM_Core_BAO_FinancialTrxn
::createPremiumTrxn($trxnParams);
857 elseif ($selectProduct == 'no_thanks') {
859 $daoContrProd = new CRM_Contribute_DAO_ContributionProduct();
860 $daoContrProd->contribution_id
= $contribution->id
;
861 if ($daoContrProd->find(TRUE)) {
862 $daoContrProd->delete();
868 * Process the contribution.
870 * @param CRM_Core_Form $form
871 * @param array $params
872 * @param array $result
873 * @param array $contributionParams
874 * Parameters to be passed to contribution create action.
875 * This differs from params in that we are currently adding params to it and 1) ensuring they are being
876 * passed consistently & 2) documenting them here.
881 * - contribution_page_id
884 * - thankyou_date (not all forms will set this)
886 * @param CRM_Financial_DAO_FinancialType $financialType
887 * @param bool $online
888 * Is the form a front end form? If so set a bunch of unpredictable things that should be passed in from the form.
890 * @param int $billingLocationID
891 * ID of billing location type.
892 * @param bool $isRecur
895 * @return \CRM_Contribute_DAO_Contribution
897 * @throws \CRM_Core_Exception
898 * @throws \CiviCRM_API3_Exception
900 public static function processFormContribution(
910 $transaction = new CRM_Core_Transaction();
911 $contactID = $contributionParams['contact_id'];
913 $isEmailReceipt = !empty($form->_values
['is_email_receipt']);
914 $isSeparateMembershipPayment = empty($params['separate_membership_payment']) ?
FALSE : TRUE;
915 $pledgeID = !empty($params['pledge_id']) ?
$params['pledge_id'] : CRM_Utils_Array
::value('pledge_id', $form->_values
);
916 if (!$isSeparateMembershipPayment && !empty($form->_values
['pledge_block_id']) &&
917 (!empty($params['is_pledge']) ||
$pledgeID)) {
924 // add these values for the recurringContrib function ,CRM-10188
925 $params['financial_type_id'] = $financialType->id
;
927 $contributionParams['address_id'] = CRM_Contribute_BAO_Contribution
::createAddress($params, $billingLocationID);
929 //@todo - this is being set from the form to resolve CRM-10188 - an
930 // eNotice caused by it not being set @ the front end
931 // however, we then get it being over-written with null for backend contributions
932 // a better fix would be to set the values in the respective forms rather than require
933 // a function being shared by two forms to deal with their respective values
934 // moving it to the BAO & not taking the $form as a param would make sense here.
935 if (!isset($params['is_email_receipt']) && $isEmailReceipt) {
936 $params['is_email_receipt'] = $isEmailReceipt;
938 $params['is_recur'] = $isRecur;
939 $params['payment_instrument_id'] = CRM_Utils_Array
::value('payment_instrument_id', $contributionParams);
940 $recurringContributionID = self
::processRecurringContribution($form, $params, $contactID, $financialType);
942 $now = date('YmdHis');
943 $receiptDate = CRM_Utils_Array
::value('receipt_date', $params);
944 if ($isEmailReceipt) {
948 if (isset($params['amount'])) {
949 $contributionParams = array_merge(self
::getContributionParams(
950 $params, $financialType->id
,
951 $result, $receiptDate,
952 $recurringContributionID), $contributionParams
954 $contributionParams['non_deductible_amount'] = self
::getNonDeductibleAmount($params, $financialType, $online, $form);
955 $contributionParams['skipCleanMoney'] = TRUE;
956 // @todo this is the wrong place for this - it should be done as close to form submission
958 $contributionParams['total_amount'] = $params['amount'];
960 $contribution = CRM_Contribute_BAO_Contribution
::add($contributionParams);
962 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
963 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
966 // @todo - interrogate the line items passed in on the params array.
967 // No reason to assume line items will be set on the form.
968 foreach ($form->_lineItem
as $lineItemKey => $lineItemValue) {
969 foreach ($lineItemValue as $key => $value) {
970 if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
971 if (isset($dataArray[$value['tax_rate']])) {
972 $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $value);
975 $dataArray[$value['tax_rate']] = CRM_Utils_Array
::value('tax_amount', $value);
980 $smarty = CRM_Core_Smarty
::singleton();
981 $smarty->assign('dataArray', $dataArray);
982 $smarty->assign('totalTaxAmount', $params['tax_amount']);
985 // lets store it in the form variable so postProcess hook can get to this and use it
986 $form->_contributionID
= $contribution->id
;
989 // process soft credit / pcp params first
990 CRM_Contribute_BAO_ContributionSoft
::formatSoftCreditParams($params, $form);
992 //CRM-13981, processing honor contact into soft-credit contribution
993 CRM_Contribute_BAO_ContributionSoft
::processSoftContribution($params, $contribution);
996 $form = self
::handlePledge($form, $params, $contributionParams, $pledgeID, $contribution, $isEmailReceipt);
999 if ($online && $contribution) {
1000 CRM_Core_BAO_CustomValueTable
::postProcess($params,
1001 'civicrm_contribution',
1006 elseif ($contribution) {
1007 //handle custom data.
1008 $params['contribution_id'] = $contribution->id
;
1009 if (!empty($params['custom']) &&
1010 is_array($params['custom'])
1012 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_contribution', $contribution->id
);
1016 if ($contribution && !empty($params['contribution_note'])) {
1018 'entity_table' => 'civicrm_contribution',
1019 'note' => $params['contribution_note'],
1020 'entity_id' => $contribution->id
,
1021 'contact_id' => $contribution->contact_id
,
1022 'modified_date' => date('Ymd'),
1025 CRM_Core_BAO_Note
::add($noteParams, []);
1028 if (isset($params['related_contact'])) {
1029 $contactID = $params['related_contact'];
1031 elseif (isset($params['cms_contactID'])) {
1032 $contactID = $params['cms_contactID'];
1035 //create contribution activity w/ individual and target
1036 //activity w/ organisation contact id when onbelf, CRM-4027
1037 $targetContactID = NULL;
1038 if (!empty($params['hidden_onbehalf_profile'])) {
1039 $targetContactID = $contribution->contact_id
;
1040 $contribution->contact_id
= $contactID;
1043 // create an activity record
1044 if ($contribution) {
1045 CRM_Activity_BAO_Activity
::addActivity($contribution, NULL, $targetContactID);
1048 $transaction->commit();
1049 // CRM-13074 - create the CMSUser after the transaction is completed as it
1050 // is not appropriate to delete a valid contribution if a user create problem occurs
1051 CRM_Contribute_BAO_Contribution_Utils
::createCMSUser($params,
1053 'email-' . $billingLocationID
1055 return $contribution;
1059 * Create the recurring contribution record.
1061 * @param CRM_Core_Form $form
1062 * @param array $params
1063 * @param int $contactID
1064 * @param string $contributionType
1068 public static function processRecurringContribution(&$form, &$params, $contactID, $contributionType) {
1070 if (empty($params['is_recur'])) {
1074 $recurParams = ['contact_id' => $contactID];
1075 $recurParams['amount'] = CRM_Utils_Array
::value('amount', $params);
1076 $recurParams['auto_renew'] = CRM_Utils_Array
::value('auto_renew', $params);
1077 $recurParams['frequency_unit'] = CRM_Utils_Array
::value('frequency_unit', $params);
1078 $recurParams['frequency_interval'] = CRM_Utils_Array
::value('frequency_interval', $params);
1079 $recurParams['installments'] = CRM_Utils_Array
::value('installments', $params);
1080 $recurParams['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $params);
1081 $recurParams['currency'] = CRM_Utils_Array
::value('currency', $params);
1082 $recurParams['payment_instrument_id'] = $params['payment_instrument_id'];
1084 // CRM-14354: For an auto-renewing membership with an additional contribution,
1085 // if separate payments is not enabled, make sure only the membership fee recurs
1086 if (!empty($form->_membershipBlock
)
1087 && $form->_membershipBlock
['is_separate_payment'] === '0'
1088 && isset($params['selectMembership'])
1089 && $form->_values
['is_allow_other_amount'] == '1'
1091 && !empty($form->_membershipTypeValues
)
1092 && !empty($form->_membershipTypeValues
[$params['selectMembership']]['minimum_fee'])
1094 $recurParams['amount'] = $form->_membershipTypeValues
[$params['selectMembership']]['minimum_fee'];
1097 $recurParams['is_test'] = 0;
1098 if (($form->_action
& CRM_Core_Action
::PREVIEW
) ||
1099 (isset($form->_mode
) && ($form->_mode
== 'test'))
1101 $recurParams['is_test'] = 1;
1104 $recurParams['start_date'] = $recurParams['create_date'] = $recurParams['modified_date'] = date('YmdHis');
1105 if (!empty($params['receive_date'])) {
1106 $recurParams['start_date'] = date('YmdHis', strtotime($params['receive_date']));
1108 $recurParams['invoice_id'] = CRM_Utils_Array
::value('invoiceID', $params);
1109 $recurParams['contribution_status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
1110 $recurParams['payment_processor_id'] = CRM_Utils_Array
::value('payment_processor_id', $params);
1111 $recurParams['is_email_receipt'] = CRM_Utils_Array
::value('is_email_receipt', $params);
1112 // we need to add a unique trxn_id to avoid a unique key error
1113 // in paypal IPN we reset this when paypal sends us the real trxn id, CRM-2991
1114 $recurParams['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $params, $params['invoiceID']);
1115 $recurParams['financial_type_id'] = $contributionType->id
;
1117 $campaignId = CRM_Utils_Array
::value('campaign_id', $params, CRM_Utils_Array
::value('campaign_id', $form->_values
));
1118 $recurParams['campaign_id'] = $campaignId;
1119 $recurring = CRM_Contribute_BAO_ContributionRecur
::add($recurParams);
1120 if (is_a($recurring, 'CRM_Core_Error')) {
1121 CRM_Core_Error
::displaySessionError($recurring);
1122 $urlString = 'civicrm/contribute/transact';
1123 $urlParams = '_qf_Main_display=true';
1124 if (get_class($form) == 'CRM_Contribute_Form_Contribution') {
1125 $urlString = 'civicrm/contact/view/contribution';
1126 $urlParams = "action=add&cid={$form->_contactID}";
1128 $urlParams .= "&mode={$form->_mode}";
1131 CRM_Utils_System
::redirect(CRM_Utils_System
::url($urlString, $urlParams));
1133 // Only set contribution recur ID for contributions since offline membership recur payments are handled somewhere else.
1134 if (!is_a($form, "CRM_Member_Form_Membership")) {
1135 $form->_params
['contributionRecurID'] = $recurring->id
;
1138 return $recurring->id
;
1142 * Add on behalf of organization and it's location.
1144 * This situation occurs when on behalf of is enabled for the contribution page and the person
1145 * signing up does so on behalf of an organization.
1147 * @param array $behalfOrganization
1148 * array of organization info.
1149 * @param int $contactID
1150 * individual contact id. One.
1151 * who is doing the process of signup / contribution.
1153 * @param array $values
1154 * form values array.
1155 * @param array $params
1156 * @param array $fields
1157 * Array of fields from the onbehalf profile relevant to the organization.
1159 public static function processOnBehalfOrganization(&$behalfOrganization, &$contactID, &$values, &$params, $fields = NULL) {
1160 $isNotCurrentEmployer = FALSE;
1163 if (!empty($behalfOrganization['organization_id'])) {
1164 $orgID = $behalfOrganization['organization_id'];
1165 unset($behalfOrganization['organization_id']);
1167 // create employer relationship with $contactID only when new organization is there
1168 // else retain the existing relationship
1170 // get the Employee relationship type id
1171 $relTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType', 'Employee of', 'id', 'name_a_b');
1173 // keep relationship params ready
1174 $relParams['relationship_type_id'] = $relTypeId . '_a_b';
1175 $relParams['is_permission_a_b'] = 1;
1176 $relParams['is_active'] = 1;
1177 $isNotCurrentEmployer = TRUE;
1180 // formalities for creating / editing organization.
1181 $behalfOrganization['contact_type'] = 'Organization';
1184 // check if matching organization contact exists
1185 $dupeIDs = CRM_Contact_BAO_Contact
::getDuplicateContacts($behalfOrganization, 'Organization', 'Unsupervised', [], FALSE);
1187 // CRM-6243 says to pick the first org even if more than one match
1188 if (count($dupeIDs) >= 1) {
1189 $behalfOrganization['contact_id'] = $orgID = $dupeIDs[0];
1190 // don't allow name edit
1191 unset($behalfOrganization['organization_name']);
1195 // if found permissioned related organization, allow location edit
1196 $behalfOrganization['contact_id'] = $orgID;
1197 // don't allow name edit
1198 unset($behalfOrganization['organization_name']);
1201 // handling for image url
1202 if (!empty($behalfOrganization['image_URL'])) {
1203 CRM_Contact_BAO_Contact
::processImageParams($behalfOrganization);
1206 // create organization, add location
1207 $orgID = CRM_Contact_BAO_Contact
::createProfileContact($behalfOrganization, $fields, $orgID,
1208 NULL, NULL, 'Organization'
1210 // create relationship
1211 if ($isNotCurrentEmployer) {
1212 $relParams['contact_check'][$orgID] = 1;
1213 $cid = ['contact' => $contactID];
1214 CRM_Contact_BAO_Relationship
::legacyCreateMultiple($relParams, $cid);
1217 // if multiple match - send a duplicate alert
1218 if ($dupeIDs && (count($dupeIDs) > 1)) {
1219 $values['onbehalf_dupe_alert'] = 1;
1221 $params['onbehalf_dupe_alert'] = 1;
1224 // make sure organization-contact-id is considered for recording
1225 // contribution/membership etc..
1226 if ($contactID != $orgID) {
1227 // take a note of contact-id, so we can send the
1228 // receipt to individual contact as well.
1230 // required for mailing/template display ..etc
1231 $values['related_contact'] = $contactID;
1233 //CRM-19172: Create CMS user for individual on whose behalf organization is doing contribution
1234 $params['onbehalf_contact_id'] = $contactID;
1236 //make this employee of relationship as current
1237 //employer / employee relationship, CRM-3532
1238 if ($isNotCurrentEmployer &&
1239 ($orgID != CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'employer_id'))
1241 $isNotCurrentEmployer = FALSE;
1244 if (!$isNotCurrentEmployer && $orgID) {
1245 //build current employer params
1246 $currentEmpParams[$contactID] = $orgID;
1247 CRM_Contact_BAO_Contact_Utils
::setCurrentEmployer($currentEmpParams);
1250 // contribution / signup will be done using this
1252 $contactID = $orgID;
1257 * Function used to send notification mail to pcp owner.
1259 * This is used by contribution and also event PCPs.
1261 * @param object $contribution
1262 * @param object $contributionSoft
1263 * Contribution object.
1265 public static function pcpNotifyOwner($contribution, $contributionSoft) {
1266 $params = ['id' => $contributionSoft->pcp_id
];
1267 CRM_Core_DAO
::commonRetrieve('CRM_PCP_DAO_PCP', $params, $pcpInfo);
1268 $ownerNotifyID = CRM_Core_DAO
::getFieldValue('CRM_PCP_DAO_PCPBlock', $pcpInfo['pcp_block_id'], 'owner_notify_id');
1269 $ownerNotifyOption = CRM_Core_PseudoConstant
::getName('CRM_PCP_DAO_PCPBlock', 'owner_notify_id', $ownerNotifyID);
1271 if ($ownerNotifyOption != 'no_notifications' &&
1272 (($ownerNotifyOption == 'owner_chooses' &&
1273 CRM_Core_DAO
::getFieldValue('CRM_PCP_DAO_PCP', $contributionSoft->pcp_id
, 'is_notify')) ||
1274 $ownerNotifyOption == 'all_owners')) {
1275 $pcpInfoURL = CRM_Utils_System
::url('civicrm/pcp/info',
1276 "reset=1&id={$contributionSoft->pcp_id}",
1277 TRUE, NULL, FALSE, TRUE
1279 // set email in the template here
1281 if (CRM_Core_BAO_LocationType
::getBilling()) {
1282 list($donorName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contribution->contact_id
,
1283 FALSE, CRM_Core_BAO_LocationType
::getBilling());
1285 // get primary location email if no email exist( for billing location).
1287 list($donorName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contribution->contact_id
);
1289 list($ownerName, $ownerEmail) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contributionSoft->contact_id
);
1291 'page_title' => $pcpInfo['title'],
1292 'receive_date' => $contribution->receive_date
,
1293 'total_amount' => $contributionSoft->amount
,
1294 'donors_display_name' => $donorName,
1295 'donors_email' => $email,
1296 'pcpInfoURL' => $pcpInfoURL,
1297 'is_honor_roll_enabled' => $contributionSoft->pcp_display_in_roll
,
1298 'currency' => $contributionSoft->currency
,
1300 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
1301 $sendTemplateParams = [
1302 'groupName' => 'msg_tpl_workflow_contribution',
1303 'valueName' => 'pcp_owner_notify',
1304 'contactId' => $contributionSoft->contact_id
,
1305 'toEmail' => $ownerEmail,
1306 'toName' => $ownerName,
1307 'from' => "$domainValues[0] <$domainValues[1]>",
1308 'tplParams' => $tplParams,
1309 'PDFFilename' => 'receipt.pdf',
1311 CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
1316 * Function used to se pcp related defaults / params.
1318 * This is used by contribution and also event PCPs
1320 * @param CRM_Core_Form $page
1322 * @param array $params
1326 public static function processPcp(&$page, $params) {
1327 $params['pcp_made_through_id'] = $page->_pcpId
;
1328 $page->assign('pcpBlock', TRUE);
1329 if (!empty($params['pcp_display_in_roll']) && empty($params['pcp_roll_nickname'])) {
1330 $params['pcp_roll_nickname'] = ts('Anonymous');
1331 $params['pcp_is_anonymous'] = 1;
1334 $params['pcp_is_anonymous'] = 0;
1337 'pcp_display_in_roll',
1339 'pcp_roll_nickname',
1340 'pcp_personal_note',
1342 if (!empty($params[$val])) {
1343 $page->assign($val, $params[$val]);
1351 * Process membership.
1353 * @param array $membershipParams
1354 * @param int $contactID
1355 * @param array $customFieldsFormatted
1356 * @param array $fieldTypes
1357 * @param array $premiumParams
1358 * @param array $membershipLineItems
1359 * Line items specifically relating to memberships.
1361 protected function processMembership($membershipParams, $contactID, $customFieldsFormatted, $fieldTypes, $premiumParams,
1362 $membershipLineItems) {
1364 $membershipTypeIDs = (array) $membershipParams['selectMembership'];
1365 $membershipTypes = CRM_Member_BAO_Membership
::buildMembershipTypeValues($this, $membershipTypeIDs);
1366 $membershipType = empty($membershipTypes) ?
[] : reset($membershipTypes);
1367 $isPending = $this->getIsPending();
1369 $this->assign('membership_name', CRM_Utils_Array
::value('name', $membershipType));
1370 $this->_values
['membership_name'] = CRM_Utils_Array
::value('name', $membershipType);
1372 $isPaidMembership = FALSE;
1373 if ($this->_amount
>= 0.0 && isset($membershipParams['amount'])) {
1374 //amount must be greater than zero for
1375 //adding contribution record to contribution table.
1376 //this condition arises when separate membership payment is
1377 //enabled and contribution amount is not selected. fix for CRM-3010
1378 $isPaidMembership = TRUE;
1380 $isProcessSeparateMembershipTransaction = $this->isSeparateMembershipTransaction($this->_id
, $this->_values
['amount_block_is_active']);
1382 if ($this->_values
['amount_block_is_active']) {
1383 $financialTypeID = $this->_values
['financial_type_id'];
1386 $financialTypeID = CRM_Utils_Array
::value('financial_type_id', $membershipType, CRM_Utils_Array
::value('financial_type_id', $membershipParams));
1389 if (CRM_Utils_Array
::value('membership_source', $this->_params
)) {
1390 $membershipParams['contribution_source'] = $this->_params
['membership_source'];
1393 $this->postProcessMembership($membershipParams, $contactID,
1394 $this, $premiumParams, $customFieldsFormatted, $fieldTypes, $membershipType, $membershipTypeIDs, $isPaidMembership, $this->_membershipId
, $isProcessSeparateMembershipTransaction, $financialTypeID,
1395 $membershipLineItems, $isPending);
1397 $this->assign('membership_assign', TRUE);
1398 $this->set('membershipTypeID', $membershipParams['selectMembership']);
1402 * Process the Memberships.
1404 * @param array $membershipParams
1405 * Array of membership fields.
1406 * @param int $contactID
1408 * @param CRM_Contribute_Form_Contribution_Confirm $form
1409 * Confirmation form object.
1411 * @param array $premiumParams
1412 * @param null $customFieldsFormatted
1413 * @param null $includeFieldTypes
1415 * @param array $membershipDetails
1417 * @param array $membershipTypeIDs
1419 * @param bool $isPaidMembership
1420 * @param array $membershipID
1422 * @param bool $isProcessSeparateMembershipTransaction
1424 * @param int $financialTypeID
1425 * @param array $unprocessedLineItems
1426 * Line items for payment options chosen on the form.
1427 * @param bool $isPending
1429 * @throws \CRM_Core_Exception
1431 protected function postProcessMembership(
1432 $membershipParams, $contactID, &$form, $premiumParams,
1433 $customFieldsFormatted = NULL, $includeFieldTypes = NULL, $membershipDetails, $membershipTypeIDs, $isPaidMembership, $membershipID,
1434 $isProcessSeparateMembershipTransaction, $financialTypeID, $unprocessedLineItems, $isPending) {
1436 $membershipContribution = NULL;
1437 $isTest = CRM_Utils_Array
::value('is_test', $membershipParams, FALSE);
1438 $errors = $paymentResults = [];
1439 $form->_values
['isMembership'] = TRUE;
1440 $isRecurForFirstTransaction = CRM_Utils_Array
::value('is_recur', $form->_params
, CRM_Utils_Array
::value('is_recur', $membershipParams));
1442 $totalAmount = $membershipParams['amount'];
1444 if ($isPaidMembership) {
1445 if ($isProcessSeparateMembershipTransaction) {
1446 // If we have 2 transactions only one can use the invoice id.
1447 $membershipParams['invoiceID'] .= '-2';
1448 if (!empty($membershipParams['auto_renew'])) {
1449 $isRecurForFirstTransaction = FALSE;
1453 if (!$isProcessSeparateMembershipTransaction) {
1454 // Skip line items in the contribution processing transaction.
1455 // We will create them with the membership for proper linking.
1456 $membershipParams['skipLineItem'] = 1;
1459 $membershipParams['total_amount'] = $totalAmount;
1460 $membershipParams['skipLineItem'] = 0;
1461 CRM_Price_BAO_LineItem
::getLineItemArray($membershipParams);
1464 $paymentResult = CRM_Contribute_BAO_Contribution_Utils
::processConfirm(
1470 $isRecurForFirstTransaction
1472 if (!empty($paymentResult['contribution'])) {
1473 $paymentResults[] = ['contribution_id' => $paymentResult['contribution']->id
, 'result' => $paymentResult];
1474 $this->postProcessPremium($premiumParams, $paymentResult['contribution']);
1475 //note that this will be over-written if we are using a separate membership transaction. Otherwise there is only one
1476 $membershipContribution = $paymentResult['contribution'];
1477 // Save the contribution ID so that I can be used in email receipts
1478 // For example, if you need to generate a tax receipt for the donation only.
1479 $form->_values
['contribution_other_id'] = $membershipContribution->id
;
1483 if ($isProcessSeparateMembershipTransaction) {
1485 $form->_lineItem
= $unprocessedLineItems;
1486 if (empty($form->_params
['auto_renew']) && !empty($membershipParams['is_recur'])) {
1487 unset($membershipParams['is_recur']);
1489 list($membershipContribution, $secondPaymentResult) = $this->processSecondaryFinancialTransaction($contactID, $form, array_merge($membershipParams, ['skipLineItem' => 1]),
1490 $isTest, $unprocessedLineItems, CRM_Utils_Array
::value('minimum_fee', $membershipDetails, 0), CRM_Utils_Array
::value('financial_type_id', $membershipDetails));
1491 $paymentResults[] = ['contribution_id' => $membershipContribution->id
, 'result' => $secondPaymentResult];
1492 $totalAmount = $membershipContribution->total_amount
;
1494 catch (CRM_Core_Exception
$e) {
1495 $errors[2] = $e->getMessage();
1496 $membershipContribution = NULL;
1501 if (!empty($membershipContribution) && !is_a($membershipContribution, 'CRM_Core_Error')) {
1502 $membershipContributionID = $membershipContribution->id
;
1505 //@todo - why is this nested so deep? it seems like it could be just set on the calling function on the form layer
1506 if (isset($membershipParams['onbehalf']) && !empty($membershipParams['onbehalf']['member_campaign_id'])) {
1507 $form->_params
['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
1509 //@todo it should no longer be possible for it to get to this point & membership to not be an array
1510 if (is_array($membershipTypeIDs) && !empty($membershipContributionID)) {
1511 $typesTerms = CRM_Utils_Array
::value('types_terms', $membershipParams, []);
1513 $membershipLines = $nonMembershipLines = [];
1514 foreach ($unprocessedLineItems as $priceSetID => $lines) {
1515 foreach ($lines as $line) {
1516 if (!empty($line['membership_type_id'])) {
1517 $membershipLines[$line['membership_type_id']] = $line['price_field_value_id'];
1523 $form->_params
['createdMembershipIDs'] = [];
1524 foreach ($membershipTypeIDs as $memType) {
1525 $membershipLineItems = [];
1526 if ($i < count($membershipTypeIDs)) {
1527 $membershipLineItems[$priceSetID][$membershipLines[$memType]] = $unprocessedLineItems[$priceSetID][$membershipLines[$memType]];
1528 unset($unprocessedLineItems[$priceSetID][$membershipLines[$memType]]);
1531 $membershipLineItems = $unprocessedLineItems;
1534 $numTerms = CRM_Utils_Array
::value($memType, $typesTerms, 1);
1535 if (!empty($membershipContribution)) {
1536 $pendingStatus = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
1537 $pending = ($membershipContribution->contribution_status_id
== $pendingStatus) ?
TRUE : FALSE;
1540 $pending = $isPending;
1542 $contributionRecurID = isset($form->_params
['contributionRecurID']) ?
$form->_params
['contributionRecurID'] : NULL;
1544 $membershipSource = NULL;
1545 if (!empty($form->_params
['membership_source'])) {
1546 $membershipSource = $form->_params
['membership_source'];
1548 elseif (isset($form->_values
['title']) && !empty($form->_values
['title'])) {
1549 $membershipSource = ts('Online Contribution:') . ' ' . $form->_values
['title'];
1552 if (isset($form->_params
)) {
1553 $isPayLater = CRM_Utils_Array
::value('is_pay_later', $form->_params
);
1556 if (isset($form->_values
) && is_array($form->_values
) && !empty($form->_values
)) {
1557 $campaignId = CRM_Utils_Array
::value('campaign_id', $form->_params
);
1558 if (!array_key_exists('campaign_id', $form->_params
)) {
1559 $campaignId = CRM_Utils_Array
::value('campaign_id', $form->_values
);
1563 list($membership, $renewalMode, $dates) = CRM_Member_BAO_Membership
::processMembership(
1564 $contactID, $memType, $isTest,
1565 date('YmdHis'), CRM_Utils_Array
::value('cms_contactID', $membershipParams),
1566 $customFieldsFormatted,
1567 $numTerms, $membershipID, $pending,
1568 $contributionRecurID, $membershipSource, $isPayLater, $campaignId, [], $membershipContribution,
1569 $membershipLineItems
1572 $form->set('renewal_mode', $renewalMode);
1573 if (!empty($dates)) {
1574 $form->assign('mem_start_date', CRM_Utils_Date
::customFormat($dates['start_date'], '%Y%m%d'));
1575 $form->assign('mem_end_date', CRM_Utils_Date
::customFormat($dates['end_date'], '%Y%m%d'));
1578 if (!empty($membershipContribution)) {
1579 // update recurring id for membership record
1580 CRM_Member_BAO_Membership
::updateRecurMembership($membership, $membershipContribution);
1581 // Next line is probably redundant. Checks prevent it happening twice.
1582 $membershipPaymentParams = [
1583 'membership_id' => $membership->id
,
1584 'membership_type_id' => $membership->membership_type_id
,
1585 'contribution_id' => $membershipContribution->id
,
1587 civicrm_api3('MembershipPayment', 'create', $membershipPaymentParams);
1590 CRM_Core_BAO_CustomValueTable
::postProcess($form->_params
, 'civicrm_membership', $membership->id
, 'Membership');
1591 $form->_params
['createdMembershipIDs'][] = $membership->id
;
1592 $form->_params
['membershipID'] = $membership->id
;
1594 //CRM-15232: Check if membership is created and on the basis of it use
1595 //membership receipt template to send payment receipt
1596 $form->_values
['isMembership'] = TRUE;
1599 if ($form->_priceSetId
&& !empty($form->_useForMember
) && !empty($form->_lineItem
)) {
1600 foreach ($form->_lineItem
[$form->_priceSetId
] as & $priceFieldOp) {
1601 if (!empty($priceFieldOp['membership_type_id']) && $membership->membership_type_id
== $priceFieldOp['membership_type_id']) {
1602 $membershipOb = $membership;
1603 $priceFieldOp['start_date'] = $membershipOb->start_date ? CRM_Utils_Date
::customFormat($membershipOb->start_date
, '%B %E%f, %Y') : '-';
1604 $priceFieldOp['end_date'] = $membershipOb->end_date ? CRM_Utils_Date
::customFormat($membershipOb->end_date
, '%B %E%f, %Y') : '-';
1607 $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1610 $form->_values
['lineItem'] = $form->_lineItem
;
1611 $form->assign('lineItem', $form->_lineItem
);
1615 if (!empty($errors)) {
1616 $message = $this->compileErrorMessage($errors);
1617 throw new CRM_Core_Exception($message);
1620 if (isset($membershipContributionID)) {
1621 $form->_values
['contribution_id'] = $membershipContributionID;
1624 if (empty($form->_params
['is_pay_later']) && $form->_paymentProcessor
) {
1625 // the is_monetary concept probably should be deprecated as it can be calculated from
1626 // the existence of 'amount' & seems fragile.
1627 if ($form->_values
['is_monetary'] && $form->_amount
> 0.0 && !$form->_params
['is_pay_later']) {
1628 // call postProcess hook before leaving
1629 $form->postProcessHook();
1632 $payment = Civi\Payment\System
::singleton()->getByProcessor($form->_paymentProcessor
);
1633 // The contribution_other_id is effectively the ID for the only contribution or the non-membership contribution.
1634 // Since we have called the membership contribution (in a 2 contribution scenario) this is out
1635 // primary-contribution compared to that - but let's face it - it's all just too hard & confusing at the moment!
1636 $paymentParams = array_merge($form->_params
, ['contributionID' => $form->_values
['contribution_other_id']]);
1638 // CRM-19792 : set necessary fields for payment processor
1639 CRM_Core_Payment_Form
::mapParams($form->_bltID
, $paymentParams, $paymentParams, TRUE);
1641 // If this is a single membership-related contribution, it won't have
1642 // be performed yet, so do it now.
1643 if ($isPaidMembership && !$isProcessSeparateMembershipTransaction) {
1644 $paymentActionResult = $payment->doPayment($paymentParams, 'contribute');
1645 $paymentResults[] = ['contribution_id' => $paymentResult['contribution']->id
, 'result' => $paymentActionResult];
1647 // Do not send an email if Recurring transaction is done via Direct Mode
1648 // Email will we sent when the IPN is received.
1649 foreach ($paymentResults as $result) {
1650 //CRM-18211: Fix situation where second contribution doesn't exist because it is optional.
1651 if ($result['contribution_id']) {
1652 $this->completeTransaction($result['result'], $result['contribution_id']);
1658 $emailValues = array_merge($membershipParams, $form->_values
);
1659 $emailValues['membership_assign'] = 1;
1660 $emailValues['useForMember'] = !empty($form->_useForMember
);
1662 // Finally send an email receipt for pay-later scenario (although it might sometimes be caught above!)
1663 if ($totalAmount == 0) {
1664 // This feels like a bizarre hack as the variable name doesn't seem to be directly connected to it's use in the template.
1665 $emailValues['useForMember'] = 0;
1666 $emailValues['amount'] = 0;
1668 //CRM-18071, where on selecting $0 free membership payment section got hidden and
1669 // also it reset any payment processor selection result into pending free membership
1670 // so its a kind of hack to complete free membership at this point since there is no $form->_paymentProcessor info
1671 if (!empty($membershipContribution) && !is_a($membershipContribution, 'CRM_Core_Error')) {
1672 if (empty($form->_paymentProcessor
)) {
1673 // @todo this can maybe go now we are setting payment_processor_id = 0 more reliably.
1674 $paymentProcessorIDs = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, CRM_Utils_Array
::value('payment_processor', $this->_values
));
1675 $this->_paymentProcessor
['id'] = $paymentProcessorIDs[0];
1677 $result = ['payment_status_id' => 1, 'contribution' => $membershipContribution];
1678 $this->completeTransaction($result, $result['contribution']->id
);
1680 // return as completeTransaction() already sends the receipt mail.
1684 CRM_Contribute_BAO_ContributionPage
::sendMail($contactID,
1692 * Turn array of errors into message string.
1694 * @param array $errors
1698 protected function compileErrorMessage($errors) {
1699 foreach ($errors as $error) {
1700 if (is_string($error)) {
1701 $message[] = $error;
1704 return ts('Payment Processor Error message') . ': ' . implode('<br/>', $message);
1708 * Where a second separate financial transaction is supported we will process it here.
1710 * @param int $contactID
1711 * @param CRM_Contribute_Form_Contribution_Confirm $form
1712 * @param array $tempParams
1713 * @param bool $isTest
1714 * @param array $lineItems
1715 * @param $minimumFee
1716 * @param int $financialTypeID
1718 * @throws CRM_Core_Exception
1720 * @return CRM_Contribute_BAO_Contribution
1722 protected function processSecondaryFinancialTransaction($contactID, &$form, $tempParams, $isTest, $lineItems, $minimumFee,
1724 $financialType = new CRM_Financial_DAO_FinancialType();
1725 $financialType->id
= $financialTypeID;
1726 $financialType->find(TRUE);
1727 $tempParams['amount'] = $minimumFee;
1728 $tempParams['invoiceID'] = md5(uniqid(rand(), TRUE));
1729 $isRecur = CRM_Utils_Array
::value('is_recur', $tempParams);
1731 //assign receive date when separate membership payment
1732 //and contribution amount not selected.
1733 if ($form->_amount
== 0) {
1734 $now = date('YmdHis');
1735 $form->_params
['receive_date'] = $now;
1736 $receiveDate = CRM_Utils_Date
::mysqlToIso($now);
1737 $form->set('params', $form->_params
);
1738 $form->assign('receive_date', $receiveDate);
1741 $form->set('membership_amount', $minimumFee);
1742 $form->assign('membership_amount', $minimumFee);
1744 // we don't need to create the user twice, so lets disable cms_create_account
1745 // irrespective of the value, CRM-2888
1746 $tempParams['cms_create_account'] = 0;
1748 //set this variable as we are not creating pledge for
1749 //separate membership payment contribution.
1750 //so for differentiating membership contribution from
1751 //main contribution.
1752 $form->_params
['separate_membership_payment'] = 1;
1753 $contributionParams = [
1754 'contact_id' => $contactID,
1755 'line_item' => $lineItems,
1756 'is_test' => $isTest,
1757 'campaign_id' => CRM_Utils_Array
::value('campaign_id', $tempParams, CRM_Utils_Array
::value('campaign_id',
1759 'contribution_page_id' => $form->_id
,
1760 'source' => CRM_Utils_Array
::value('source', $tempParams, CRM_Utils_Array
::value('description', $tempParams)),
1762 $isMonetary = !empty($form->_values
['is_monetary']);
1764 if (empty($paymentParams['is_pay_later'])) {
1765 $contributionParams['payment_instrument_id'] = $form->_paymentProcessor
['payment_instrument_id'];
1769 // CRM-19792 : set necessary fields for payment processor
1770 CRM_Core_Payment_Form
::mapParams($form->_bltID
, $form->_params
, $tempParams, TRUE);
1772 $membershipContribution = CRM_Contribute_Form_Contribution_Confirm
::processFormContribution($form,
1775 $contributionParams,
1784 // We're not processing the line item here because we are processing a membership.
1785 // To ensure processing of the correct parameters, replace relevant parameters
1786 // in $tempParams with those in $membershipContribution.
1787 $tempParams['amount_level'] = $membershipContribution->amount_level
;
1788 $tempParams['total_amount'] = $membershipContribution->total_amount
;
1789 $tempParams['tax_amount'] = $membershipContribution->tax_amount
;
1790 $tempParams['contactID'] = $membershipContribution->contact_id
;
1791 $tempParams['financialTypeID'] = $membershipContribution->financial_type_id
;
1792 $tempParams['invoiceID'] = $membershipContribution->invoice_id
;
1793 $tempParams['trxn_id'] = $membershipContribution->trxn_id
;
1794 $tempParams['contributionID'] = $membershipContribution->id
;
1796 if ($form->_values
['is_monetary'] && !$form->_params
['is_pay_later'] && $minimumFee > 0.0) {
1797 // At the moment our tests are calling this form in a way that leaves 'object' empty. For
1798 // now we compensate here.
1799 if (empty($form->_paymentProcessor
['object'])) {
1800 $payment = Civi\Payment\System
::singleton()->getByProcessor($this->_paymentProcessor
);
1803 $payment = $form->_paymentProcessor
['object'];
1805 $result = $payment->doPayment($tempParams, 'contribute');
1806 $form->set('membership_trx_id', $result['trxn_id']);
1807 $form->assign('membership_trx_id', $result['trxn_id']);
1810 return [$membershipContribution, $result];
1814 * Is the payment a pending payment.
1816 * We are moving towards always creating as pending and updating at the end (based on payment), so this should be
1817 * an interim refactoring. It was shared with another unrelated form & some parameters may not apply to this form.
1821 protected function getIsPending() {
1822 // The concept of contributeMode is deprecated.
1823 // the is_monetary concept probably should be too as it can be calculated from
1824 // the existence of 'amount' & seems fragile.
1825 if (((isset($this->_contributeMode
)) ||
!empty($this->_params
['is_pay_later'])
1827 (($this->_values
['is_monetary'] && $this->_amount
> 0.0))
1835 * Are we going to do 2 financial transactions.
1837 * Ie the membership block supports a separate transactions AND the contribution form has been configured for a
1839 * transaction AND a membership transaction AND the payment processor supports double financial transactions (ie. NOT doTransferCheckout style)
1841 * @param int $formID
1842 * @param bool $amountBlockActiveOnForm
1846 public function isSeparateMembershipTransaction($formID, $amountBlockActiveOnForm) {
1847 $memBlockDetails = CRM_Member_BAO_Membership
::getMembershipBlock($formID);
1848 if (!empty($memBlockDetails['is_separate_payment']) && $amountBlockActiveOnForm) {
1855 * This function sets the fields.
1857 * - $this->_params['amount_level']
1858 * - $this->_params['selectMembership']
1859 * And under certain circumstances sets
1860 * $this->_params['amount'] = null;
1862 * @param int $priceSetID
1864 public function setFormAmountFields($priceSetID) {
1865 $isQuickConfig = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params
['priceSetId'], 'is_quick_config');
1866 $priceField = new CRM_Price_DAO_PriceField();
1867 $priceField->price_set_id
= $priceSetID;
1868 $priceField->orderBy('weight');
1869 $priceField->find();
1870 $paramWeDoNotUnderstand = NULL;
1872 while ($priceField->fetch()) {
1873 if ($priceField->name
== "contribution_amount") {
1874 $paramWeDoNotUnderstand = $priceField->id
;
1876 if ($isQuickConfig && !empty($this->_params
["price_{$priceField->id}"])) {
1877 if ($this->_values
['fee'][$priceField->id
]['html_type'] != 'Text') {
1878 // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
1879 // function to get correct amount level consistently. Remove setting of the amount level in
1880 // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
1881 // to cover all variants.
1882 $this->_params
['amount_level'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue',
1883 $this->_params
["price_{$priceField->id}"], 'label');
1885 if ($priceField->name
== "membership_amount") {
1886 $this->_params
['selectMembership'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue',
1887 $this->_params
["price_{$priceField->id}"], 'membership_type_id');
1890 // If separate payment we set contribution amount to be null, so that it will not show contribution amount same
1891 // as membership amount.
1892 // @todo - this needs more documentation - it appears the setting to null is tied up with separate membership payments
1893 // but the circumstances are very confusing. Many of these conditions are repeated in the next conditional
1894 // so we should merge them together
1895 // the quick config seems like a red-herring - if this is about a separate membership payment then there
1896 // are 2 types of line items - membership ones & non-membership ones - regardless of whether quick config is set
1898 CRM_Utils_Array
::value('is_separate_payment', $this->_membershipBlock
)
1899 && !empty($this->_values
['fee'][$priceField->id
])
1900 && ($this->_values
['fee'][$priceField->id
]['name'] == "other_amount")
1901 && CRM_Utils_Array
::value("price_{$paramWeDoNotUnderstand}", $this->_params
) < 1
1902 && empty($this->_params
["price_{$priceField->id}"])
1904 $this->_params
['amount'] = NULL;
1907 // Fix for CRM-14375 - If we are using separate payments and "no
1908 // thank you" is selected for the additional contribution, set
1909 // contribution amount to be null, so that it will not show
1910 // contribution amount same as membership amount.
1911 //@todo - merge with section above
1912 if ($this->_membershipBlock
['is_separate_payment']
1913 && !empty($this->_values
['fee'][$priceField->id
])
1914 && CRM_Utils_Array
::value('name', $this->_values
['fee'][$priceField->id
]) == 'contribution_amount'
1915 && CRM_Utils_Array
::value("price_{$priceField->id}", $this->_params
) == '-1'
1917 $this->_params
['amount'] = NULL;
1925 * @param array $params
1927 * @throws CiviCRM_API3_Exception
1929 public static function submit($params) {
1930 $form = new CRM_Contribute_Form_Contribution_Confirm();
1931 $form->_id
= $params['id'];
1933 CRM_Contribute_BAO_ContributionPage
::setValues($form->_id
, $form->_values
);
1934 $form->_separateMembershipPayment
= CRM_Contribute_BAO_ContributionPage
::getIsMembershipPayment($form->_id
);
1935 //this way the mocked up controller ignores the session stuff
1936 $_SERVER['REQUEST_METHOD'] = 'GET';
1937 $form->controller
= new CRM_Contribute_Controller_Contribution();
1938 $params['invoiceID'] = md5(uniqid(rand(), TRUE));
1939 $paramsProcessedForForm = $form->_params
= self
::getFormParams($params['id'], $params);
1940 $form->_amount
= $params['amount'];
1941 // hack these in for test support.
1942 $form->_fields
['billing_first_name'] = 1;
1943 $form->_fields
['billing_last_name'] = 1;
1944 // CRM-18854 - Set form values to allow pledge to be created for api test.
1945 if (CRM_Utils_Array
::value('pledge_block_id', $params)) {
1946 $form->_values
['pledge_id'] = CRM_Utils_Array
::value('pledge_id', $params, NULL);
1947 $form->_values
['pledge_block_id'] = $params['pledge_block_id'];
1948 $pledgeBlock = CRM_Pledge_BAO_PledgeBlock
::getPledgeBlock($params['id']);
1949 $form->_values
['max_reminders'] = $pledgeBlock['max_reminders'];
1950 $form->_values
['initial_reminder_day'] = $pledgeBlock['initial_reminder_day'];
1951 $form->_values
['additional_reminder_day'] = $pledgeBlock['additional_reminder_day'];
1952 $form->_values
['is_email_receipt'] = FALSE;
1954 $priceSetID = $form->_params
['priceSetId'] = $paramsProcessedForForm['price_set_id'];
1955 $priceFields = CRM_Price_BAO_PriceSet
::getSetDetail($priceSetID);
1956 $priceSetFields = reset($priceFields);
1957 $form->_values
['fee'] = $priceSetFields['fields'];
1958 $form->_priceSetId
= $priceSetID;
1959 $form->setFormAmountFields($priceSetID);
1962 $capabilities[] = (ucfirst($form->_mode
) . 'Mode');
1964 $form->_paymentProcessors
= CRM_Financial_BAO_PaymentProcessor
::getPaymentProcessors($capabilities);
1965 $form->_params
['payment_processor_id'] = isset($params['payment_processor_id']) ?
$params['payment_processor_id'] : 0;
1966 if ($form->_params
['payment_processor_id'] !== '') {
1967 // It can be blank with a $0 transaction - then no processor needs to be selected
1968 $form->_paymentProcessor
= $form->_paymentProcessors
[$form->_params
['payment_processor_id']];
1970 if (!empty($params['payment_processor_id'])) {
1971 // The concept of contributeMode is deprecated as is the billing_mode concept.
1972 if ($form->_paymentProcessor
['billing_mode'] == 1) {
1973 $form->_contributeMode
= 'direct';
1976 $form->_contributeMode
= 'notify';
1980 $priceFields = $priceFields[$priceSetID]['fields'];
1982 CRM_Price_BAO_PriceSet
::processAmount($priceFields, $paramsProcessedForForm, $lineItems, 'civicrm_contribution', $priceSetID);
1983 $form->_lineItem
= [$priceSetID => $lineItems];
1984 $membershipPriceFieldIDs = [];
1985 foreach ((array) $lineItems as $lineItem) {
1986 if (!empty($lineItem['membership_type_id'])) {
1987 $form->set('useForMember', 1);
1988 $form->_useForMember
= 1;
1989 $membershipPriceFieldIDs['id'] = $priceSetID;
1990 $membershipPriceFieldIDs[] = $lineItem['price_field_value_id'];
1993 $form->set('memberPriceFieldIDS', $membershipPriceFieldIDs);
1994 $form->setRecurringMembershipParams();
1995 $form->processFormSubmission(CRM_Utils_Array
::value('contact_id', $params));
1999 * Helper function for static submit function.
2001 * Set relevant params - help us to build up an array that we can pass in.
2004 * @param array $params
2007 * @throws CiviCRM_API3_Exception
2009 public static function getFormParams($id, array $params) {
2010 if (!isset($params['is_pay_later'])) {
2011 if (!empty($params['payment_processor_id'])) {
2012 $params['is_pay_later'] = 0;
2014 elseif ($params['amount'] !== 0) {
2015 $params['is_pay_later'] = civicrm_api3('contribution_page', 'getvalue', [
2017 'return' => 'is_pay_later',
2021 if (empty($params['price_set_id'])) {
2022 $params['price_set_id'] = CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution_page', $params['id']);
2028 * Post form submission handling.
2030 * This is also called from the test suite.
2032 * @param int $contactID
2036 protected function processFormSubmission($contactID) {
2037 if (!isset($this->_params
['payment_processor_id'])) {
2038 // If there is no processor we are using the pay-later manual pseudo-processor.
2039 // (note it might make sense to make this a row in the processor table in the db).
2040 $this->_params
['payment_processor_id'] = 0;
2042 if (isset($this->_params
['payment_processor_id']) && $this->_params
['payment_processor_id'] === 0) {
2043 $this->_params
['is_pay_later'] = $isPayLater = TRUE;
2046 if (!empty($this->_ccid
)) {
2047 $this->_params
['contribution_id'] = $this->_ccid
;
2049 //Set email-bltID if pre/post profile contains an email.
2050 if ($this->_emailExists
== TRUE) {
2051 foreach ($this->_params
as $key => $val) {
2052 if (substr($key, 0, 6) == 'email-' && empty($this->_params
["email-{$this->_bltID}"])) {
2053 $this->_params
["email-{$this->_bltID}"] = $this->_params
[$key];
2057 // add a description field at the very beginning
2058 $this->_params
['description'] = ts('Online Contribution') . ': ' . (($this->_pcpInfo
['title']) ?
$this->_pcpInfo
['title'] : $this->_values
['title']);
2060 $this->_params
['accountingCode'] = CRM_Utils_Array
::value('accountingCode', $this->_values
);
2063 $this->_params
['currencyID'] = CRM_Core_Config
::singleton()->defaultCurrency
;
2065 CRM_Contribute_Form_AbstractEditPayment
::formatCreditCardDetails($this->_params
);
2068 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
)) {
2069 $pledgeBlock = CRM_Pledge_BAO_PledgeBlock
::getPledgeBlock($this->_id
);
2070 if (CRM_Utils_Array
::value('start_date', $this->_params
) ||
!CRM_Utils_Array
::value('is_pledge_start_date_visible', $pledgeBlock)
2071 ||
!CRM_Utils_Array
::value('is_pledge_start_date_editable', $pledgeBlock)) {
2072 $pledgeStartDate = CRM_Utils_Array
::value('start_date', $this->_params
, NULL);
2073 $this->_params
['receive_date'] = CRM_Pledge_BAO_Pledge
::getPledgeStartDate($pledgeStartDate, $pledgeBlock);
2074 $recurParams = CRM_Pledge_BAO_Pledge
::buildRecurParams($this->_params
);
2075 $this->_params
= array_merge($this->_params
, $recurParams);
2079 //carry payment processor id.
2080 if (CRM_Utils_Array
::value('id', $this->_paymentProcessor
)) {
2081 $this->_params
['payment_processor_id'] = $this->_paymentProcessor
['id'];
2084 $premiumParams = $membershipParams = $params = $this->_params
;
2085 if (!empty($params['image_URL'])) {
2086 CRM_Contact_BAO_Contact
::processImageParams($params);
2089 $fields = ['email-Primary' => 1];
2091 // get the add to groups
2094 // now set the values for the billing location.
2095 foreach ($this->_fields
as $name => $value) {
2098 // get the add to groups for uf fields
2099 if (!empty($value['add_to_group_id'])) {
2100 $addToGroups[$value['add_to_group_id']] = $value['add_to_group_id'];
2104 $fields = $this->formatParamsForPaymentProcessor($fields);
2106 // billing email address
2107 $fields["email-{$this->_bltID}"] = 1;
2109 // if onbehalf-of-organization contribution, take out
2110 // organization params in a separate variable, to make sure
2111 // normal behavior is continued. And use that variable to
2112 // process on-behalf-of functionality.
2113 if (!empty($this->_values
['onbehalf_profile_id']) && empty($this->_ccid
)) {
2114 $behalfOrganization = [];
2115 $orgFields = ['organization_name', 'organization_id', 'org_option'];
2116 foreach ($orgFields as $fld) {
2117 if (array_key_exists($fld, $params)) {
2118 $behalfOrganization[$fld] = $params[$fld];
2119 unset($params[$fld]);
2123 if (is_array($params['onbehalf']) && !empty($params['onbehalf'])) {
2124 foreach ($params['onbehalf'] as $fld => $values) {
2125 if (strstr($fld, 'custom_')) {
2126 $behalfOrganization[$fld] = $values;
2128 elseif (!(strstr($fld, '-'))) {
2129 if (in_array($fld, [
2130 'contribution_campaign_id',
2131 'member_campaign_id',
2133 $fld = 'campaign_id';
2136 $behalfOrganization[$fld] = $values;
2138 $this->_params
[$fld] = $values;
2143 if (array_key_exists('onbehalf_location', $params) && is_array($params['onbehalf_location'])) {
2144 foreach ($params['onbehalf_location'] as $block => $vals) {
2145 //fix for custom data (of type checkbox, multi-select)
2146 if (substr($block, 0, 7) == 'custom_') {
2149 // fix the index of block elements
2150 if (is_array($vals)) {
2151 foreach ($vals as $key => $val) {
2152 //dont adjust the index of address block as
2153 //it's index is WRT to location type
2154 $newKey = ($block == 'address') ?
$key : ++
$key;
2155 $behalfOrganization[$block][$newKey] = $val;
2159 unset($params['onbehalf_location']);
2161 if (!empty($params['onbehalf[image_URL]'])) {
2162 $behalfOrganization['image_URL'] = $params['onbehalf[image_URL]'];
2166 // check for profile double opt-in and get groups to be subscribed
2167 $subscribeGroupIds = CRM_Core_BAO_UFGroup
::getDoubleOptInGroupIds($params, $contactID);
2169 // since we are directly adding contact to group lets unset it from mailing
2170 if (!empty($addToGroups)) {
2171 foreach ($addToGroups as $groupId) {
2172 if (isset($subscribeGroupIds[$groupId])) {
2173 unset($subscribeGroupIds[$groupId]);
2178 foreach ($addToGroups as $k) {
2179 if (array_key_exists($k, $subscribeGroupIds)) {
2180 unset($addToGroups[$k]);
2184 if (empty($contactID)) {
2185 $dupeParams = $params;
2186 if (!empty($dupeParams['onbehalf'])) {
2187 unset($dupeParams['onbehalf']);
2189 if (!empty($dupeParams['honor'])) {
2190 unset($dupeParams['honor']);
2193 $contactID = CRM_Contact_BAO_Contact
::getFirstDuplicateContact($dupeParams, 'Individual', 'Unsupervised', [], FALSE);
2195 // Fetch default greeting id's if creating a contact
2197 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
2198 if (!isset($params[$greeting])) {
2199 $params[$greeting] = CRM_Contact_BAO_Contact_Utils
::defaultGreeting('Individual', $greeting);
2203 $contactType = NULL;
2206 $contactType = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'contact_type');
2208 $contactID = CRM_Contact_BAO_Contact
::createProfileContact(
2218 // Make the contact ID associated with the contribution available at the Class level.
2219 // Also make available to the session.
2220 //@todo consider handling this in $this->getContactID();
2221 $this->set('contactID', $contactID);
2222 $this->_contactID
= $contactID;
2224 //get email primary first if exist
2225 $subscriptionEmail = ['email' => CRM_Utils_Array
::value('email-Primary', $params)];
2226 if (!$subscriptionEmail['email']) {
2227 $subscriptionEmail['email'] = CRM_Utils_Array
::value("email-{$this->_bltID}", $params);
2229 // subscribing contact to groups
2230 if (!empty($subscribeGroupIds) && $subscriptionEmail['email']) {
2231 CRM_Mailing_Event_BAO_Subscribe
::commonSubscribe($subscribeGroupIds, $subscriptionEmail, $contactID);
2234 // If onbehalf-of-organization contribution / signup, add organization
2235 // and it's location.
2236 if (isset($this->_values
['onbehalf_profile_id']) &&
2237 isset($behalfOrganization['organization_name']) &&
2238 ($this->_values
['is_for_organization'] == 2 ||
2239 !empty($this->_params
['is_for_organization'])
2243 foreach ($this->_fields
['onbehalf'] as $name => $value) {
2244 $ufFields[$name] = 1;
2246 self
::processOnBehalfOrganization($behalfOrganization, $contactID, $this->_values
,
2247 $this->_params
, $ufFields
2250 elseif (!empty($this->_membershipContactID
) && $contactID != $this->_membershipContactID
) {
2251 // this is an onbehalf renew case for inherited membership. For e.g a permissioned member of household,
2252 // store current user id as related contact for later use for mailing / activity..
2253 $this->_values
['related_contact'] = $contactID;
2254 $this->_params
['related_contact'] = $contactID;
2255 // swap contact like we do for on-behalf-org case, so parent/primary membership is affected
2256 $contactID = $this->_membershipContactID
;
2259 // lets store the contactID in the session
2260 // for things like tell a friend
2261 $session = CRM_Core_Session
::singleton();
2262 if (!$session->get('userID')) {
2263 $session->set('transaction.userID', $contactID);
2266 $session->set('transaction.userID', NULL);
2269 $this->_useForMember
= $this->get('useForMember');
2271 // store the fact that this is a membership and membership type is selected
2272 if ((!empty($membershipParams['selectMembership']) &&
2273 $membershipParams['selectMembership'] != 'no_thanks'
2275 $this->_useForMember
2277 if (!$this->_useForMember
) {
2278 $this->assign('membership_assign', TRUE);
2279 $this->set('membershipTypeID', $this->_params
['selectMembership']);
2282 if ($this->_action
& CRM_Core_Action
::PREVIEW
) {
2283 $membershipParams['is_test'] = 1;
2285 if ($this->_params
['is_pay_later']) {
2286 $membershipParams['is_pay_later'] = 1;
2289 if (isset($this->_params
['onbehalf_contact_id'])) {
2290 $membershipParams['onbehalf_contact_id'] = $this->_params
['onbehalf_contact_id'];
2292 //inherit campaign from contribution page.
2293 if (!array_key_exists('campaign_id', $membershipParams)) {
2294 $membershipParams['campaign_id'] = CRM_Utils_Array
::value('campaign_id', $this->_values
);
2297 $this->_params
= CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $membershipParams, TRUE);
2298 $this->doMembershipProcessing($contactID, $membershipParams, $premiumParams, $this->_lineItem
);
2301 // at this point we've created a contact and stored its address etc
2302 // all the payment processors expect the name and address to be in the
2303 // so we copy stuff over to first_name etc.
2304 $paymentParams = $this->_params
;
2305 // Make it explict that we are letting the processConfirm function figure out the line items.
2306 $paymentParams['skipLineItem'] = 0;
2308 if (!isset($paymentParams['line_item'])) {
2309 $paymentParams['line_item'] = $this->_lineItem
;
2312 if (!empty($paymentParams['onbehalf']) &&
2313 is_array($paymentParams['onbehalf'])
2315 foreach ($paymentParams['onbehalf'] as $key => $value) {
2316 if (strstr($key, 'custom_')) {
2317 $this->_params
[$key] = $value;
2322 $result = CRM_Contribute_BAO_Contribution_Utils
::processConfirm($this, $paymentParams,
2324 $this->wrangleFinancialTypeID($this->_values
['financial_type_id']),
2325 ($this->_mode
== 'test') ?
1 : 0,
2326 CRM_Utils_Array
::value('is_recur', $paymentParams)
2329 if (empty($result['is_payment_failure'])) {
2330 // @todo move premium processing to complete transaction if it truly is an 'after' action.
2331 $this->postProcessPremium($premiumParams, $result['contribution']);
2333 if (!empty($result['contribution'])) {
2334 // It seems this line is hit when there is a zero dollar transaction & in tests, not sure when else.
2335 $this->completeTransaction($result, $result['contribution']->id
);
2342 * Membership processing section.
2344 * This is in a separate function as part of a move towards refactoring.
2346 * @param int $contactID
2347 * @param array $membershipParams
2348 * @param array $premiumParams
2349 * @param array $formLineItems
2351 protected function doMembershipProcessing($contactID, $membershipParams, $premiumParams, $formLineItems) {
2352 // This could be set by a hook.
2353 if (!empty($this->_params
['installments'])) {
2354 $membershipParams['installments'] = $this->_params
['installments'];
2356 // added new parameter for cms user contact id, needed to distinguish behaviour for on behalf of sign-ups
2357 if (isset($this->_params
['related_contact'])) {
2358 $membershipParams['cms_contactID'] = $this->_params
['related_contact'];
2361 $membershipParams['cms_contactID'] = $contactID;
2364 if (!empty($membershipParams['onbehalf']) &&
2365 is_array($membershipParams['onbehalf']) && !empty($membershipParams['onbehalf']['member_campaign_id'])
2367 $this->_params
['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
2370 $customFieldsFormatted = $fieldTypes = [];
2371 if (!empty($membershipParams['onbehalf']) &&
2372 is_array($membershipParams['onbehalf'])
2374 foreach ($membershipParams['onbehalf'] as $key => $value) {
2375 if (strstr($key, 'custom_')) {
2376 $customFieldId = explode('_', $key);
2377 CRM_Core_BAO_CustomField
::formatCustomField(
2379 $customFieldsFormatted,
2387 $fieldTypes = ['Contact', 'Organization', 'Membership'];
2390 $priceFieldIds = $this->get('memberPriceFieldIDS');
2392 if (!empty($priceFieldIds)) {
2393 $membershipParams['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceFieldIds['id'], 'financial_type_id');
2394 unset($priceFieldIds['id']);
2395 $membershipTypeIds = [];
2396 $membershipTypeTerms = [];
2397 foreach ($priceFieldIds as $priceFieldId) {
2398 $membershipTypeId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id');
2399 if ($membershipTypeId) {
2400 $membershipTypeIds[] = $membershipTypeId;
2401 $term = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_num_terms') ?
: 1;
2402 $membershipTypeTerms[$membershipTypeId] = ($term > 1) ?
$term : 1;
2405 $membershipParams['selectMembership'] = $membershipTypeIds;
2406 $membershipParams['types_terms'] = $membershipTypeTerms;
2408 if (!empty($membershipParams['selectMembership'])) {
2410 $membershipLineItems = $formLineItems;
2411 if ($this->_separateMembershipPayment
&& $this->_values
['amount_block_is_active']) {
2412 $membershipLineItems = [];
2413 foreach ($this->_values
['fee'] as $key => $feeValues) {
2414 if ($feeValues['name'] == 'membership_amount') {
2415 $fieldId = $this->_params
['price_' . $key];
2416 $membershipLineItems[$this->_priceSetId
][$fieldId] = $this->_lineItem
[$this->_priceSetId
][$fieldId];
2417 unset($this->_lineItem
[$this->_priceSetId
][$fieldId]);
2423 $this->processMembership($membershipParams, $contactID, $customFieldsFormatted, $fieldTypes, $premiumParams, $membershipLineItems);
2425 catch (\Civi\Payment\Exception\PaymentProcessorException
$e) {
2426 CRM_Core_Session
::singleton()->setStatus($e->getMessage());
2427 if (!empty($this->_contributionID
)) {
2428 CRM_Contribute_BAO_Contribution
::failPayment($this->_contributionID
,
2429 $contactID, $e->getMessage());
2431 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/transact', "_qf_Main_display=true&qfKey={$this->_params['qfKey']}"));
2433 catch (CRM_Core_Exception
$e) {
2434 CRM_Core_Session
::singleton()->setStatus($e->getMessage());
2435 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/transact', "_qf_Main_display=true&qfKey={$this->_params['qfKey']}"));
2437 if (!$this->_amount
> 0.0 ||
!$membershipParams['amount']) {
2438 // we need to explicitly create a CMS user in case of free memberships
2439 // since it is done under processConfirm for paid memberships
2440 CRM_Contribute_BAO_Contribution_Utils
::createCMSUser($membershipParams,
2441 $membershipParams['cms_contactID'],
2442 'email-' . $this->_bltID
2449 * Complete transaction if payment has been processed.
2451 * Check the result for a success outcome & if paid then complete the transaction.
2453 * Completing will trigger update of related entities and emails.
2455 * @param array $result
2456 * @param int $contributionID
2458 * @throws \CiviCRM_API3_Exception
2459 * @throws \Exception
2461 protected function completeTransaction($result, $contributionID) {
2462 if (CRM_Utils_Array
::value('payment_status_id', $result) == 1) {
2464 civicrm_api3('contribution', 'completetransaction', [
2465 'id' => $contributionID,
2466 'trxn_id' => CRM_Utils_Array
::value('trxn_id', $result),
2467 'payment_processor_id' => CRM_Utils_Array
::value('payment_processor_id', $result, $this->_paymentProcessor
['id']),
2468 'is_transactional' => FALSE,
2469 'fee_amount' => CRM_Utils_Array
::value('fee_amount', $result),
2470 'receive_date' => CRM_Utils_Array
::value('receive_date', $result),
2471 'card_type_id' => CRM_Utils_Array
::value('card_type_id', $result),
2472 'pan_truncation' => CRM_Utils_Array
::value('pan_truncation', $result),
2475 catch (CiviCRM_API3_Exception
$e) {
2476 if ($e->getErrorCode() != 'contribution_completed') {
2477 throw new CRM_Core_Exception('Failed to update contribution in database');
2484 * Bounce the user back to retry when an error occurs.
2486 * @param string $message
2488 protected function bounceOnError($message) {
2489 CRM_Core_Session
::singleton()
2490 ->setStatus(ts("Payment Processor Error message :") .
2492 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/transact',
2493 "_qf_Main_display=true&qfKey={$this->_params['qfKey']}"