3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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 +--------------------------------------------------------------------+
28 use Civi\Payment\Exception\PaymentProcessorException
;
31 * This class generates form components for processing a contribution.
33 class CRM_Contribute_Form_Contribution
extends CRM_Contribute_Form_AbstractEditPayment
{
35 * The id of the contribution that we are processing.
42 * The id of the premium that we are processing.
46 public $_premiumID = NULL;
49 * @var CRM_Contribute_DAO_ContributionProduct
51 public $_productDAO = NULL;
61 * The id of the contact associated with this contribution.
68 * The id of the pledge payment that we are processing.
75 * Is this contribution associated with an online.
76 * financial transaction
80 public $_online = FALSE;
83 * Stores all product options.
90 * Storage of parameters from form
97 * Store the contribution Type ID
101 public $_contributionType;
104 * The contribution values if an existing contribution
109 * The pledge values if this contribution is associated with pledge
111 public $_pledgeValues;
113 public $_contributeMode = 'direct';
118 * Parameter with confusing name.
122 public $_compContext;
127 * Possible From email addresses
139 * Store the line items if price set used.
145 * @todo explain why we use lineItem & lineItems
151 * @var array soft credit info
153 public $_softCreditInfo;
155 protected $_formType;
157 public $_honoreeProfileType;
160 * Array of the payment fields to be displayed in the payment fieldset (pane) in billingBlock.tpl
161 * this contains all the information to describe these fields from quickform. See CRM_Core_Form_Payment getPaymentFormFieldsMetadata
165 public $_paymentFields = array();
167 * Logged in user's email.
179 * Price set as an array
189 public $userDisplayName;
192 * Status message to be shown to the user.
196 protected $statusMessage = array();
199 * Status message title to be shown to the user.
201 * Generally the payment processor message title is 'Complete' and offline is 'Saved'
202 * although this might not be a good fit with the broad range of processors.
206 protected $statusMessageTitle;
209 * Set variables up before form is built.
211 public function preProcess() {
212 // Check permission for action.
213 if (!CRM_Core_Permission
::checkActionPermission('CiviContribute', $this->_action
)) {
214 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
217 parent
::preProcess();
219 $this->_formType
= CRM_Utils_Array
::value('formType', $_GET);
222 $this->_priceSetId
= CRM_Utils_Array
::value('priceSetId', $_GET);
223 $this->set('priceSetId', $this->_priceSetId
);
224 $this->assign('priceSetId', $this->_priceSetId
);
226 // Get the pledge payment id
227 $this->_ppID
= CRM_Utils_Request
::retrieve('ppid', 'Positive', $this);
229 $this->assign('action', $this->_action
);
231 // Get the contribution id if update
232 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
233 if (!empty($this->_id
)) {
234 $this->assign('contribID', $this->_id
);
237 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
238 $this->assign('context', $this->_context
);
240 $this->_compId
= CRM_Utils_Request
::retrieve('compId', 'Positive', $this);
242 $this->_compContext
= CRM_Utils_Request
::retrieve('compContext', 'String', $this);
244 //set the contribution mode.
245 $this->_mode
= CRM_Utils_Request
::retrieve('mode', 'String', $this);
247 $this->assign('contributionMode', $this->_mode
);
248 if ($this->_action
& CRM_Core_Action
::DELETE
) {
252 $this->assign('showCheckNumber', TRUE);
254 $this->_fromEmails
= CRM_Core_BAO_Email
::getFromEmail();
255 $this->assignPaymentRelatedVariables();
257 if (in_array('CiviPledge', CRM_Core_Config
::singleton()->enableComponents
) && !$this->_formType
) {
258 $this->preProcessPledge();
262 $this->showRecordLinkMesssage($this->_id
);
264 $this->_values
= array();
266 // Current contribution id.
268 $this->assignPremiumProduct($this->_id
);
269 $this->buildValuesAndAssignOnline_Note_Type($this->_id
, $this->_values
);
272 // when custom data is included in this page
273 if (!empty($_POST['hidden_custom'])) {
274 $this->applyCustomData('Contribution', CRM_Utils_Array
::value('financial_type_id', $_POST), $this->_id
);
277 $this->_lineItems
= array();
279 if (!empty($this->_compId
) && $this->_compContext
== 'participant') {
280 $this->assign('compId', $this->_compId
);
281 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->_compId
);
284 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->_id
, 'contribution', 1, TRUE, TRUE);
286 empty($lineItem) ?
NULL : $this->_lineItems
[] = $lineItem;
289 $this->assign('lineItem', empty($this->_lineItems
) ?
FALSE : $this->_lineItems
);
292 if ($this->_mode
&& $this->_id
) {
293 $this->_payNow
= TRUE;
294 $this->assign('payNow', $this->_payNow
);
295 CRM_Utils_System
::setTitle(ts('Pay with Credit Card'));
297 elseif ($this->_mode
) {
298 $this->setPageTitle($this->_ppID ?
ts('Credit Card Pledge Payment') : ts('Credit Card Contribution'));
301 $this->setPageTitle($this->_ppID ?
ts('Pledge Payment') : ts('Contribution'));
305 CRM_Contribute_Form_SoftCredit
::preprocess($this);
310 * Set default values.
314 public function setDefaultValues() {
316 $defaults = $this->_values
;
318 // Set defaults for pledge payment.
320 $defaults['total_amount'] = CRM_Utils_Array
::value('scheduled_amount', $this->_pledgeValues
['pledgePayment']);
321 $defaults['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $this->_pledgeValues
);
322 $defaults['currency'] = CRM_Utils_Array
::value('currency', $this->_pledgeValues
);
323 $defaults['option_type'] = 1;
326 if ($this->_action
& CRM_Core_Action
::DELETE
) {
330 $defaults['frequency_interval'] = 1;
331 $defaults['frequency_unit'] = 'month';
333 // Set soft credit defaults.
334 CRM_Contribute_Form_SoftCredit
::setDefaultValues($defaults, $this);
337 // @todo - remove this function as the parent does it too.
338 $config = CRM_Core_Config
::singleton();
339 // Set default country from config if no country set.
340 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
341 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
344 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
345 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
348 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID
);
349 $defaults = array_merge($defaults, $billingDefaults);
353 $this->_contactID
= $defaults['contact_id'];
356 // Set $newCredit variable in template to control whether link to credit card mode is included.
357 $this->assign('newCredit', CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments());
359 // Fix the display of the monetary value, CRM-4038.
360 if (isset($defaults['total_amount'])) {
361 if (!empty($defaults['tax_amount'])) {
362 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
363 if (!(CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails))) {
364 $defaults['total_amount'] = CRM_Utils_Money
::format($defaults['total_amount'] - $defaults['tax_amount'], NULL, '%a');
368 $defaults['total_amount'] = CRM_Utils_Money
::format($defaults['total_amount'], NULL, '%a');
372 if (isset($defaults['non_deductible_amount'])) {
373 $defaults['non_deductible_amount'] = CRM_Utils_Money
::format($defaults['non_deductible_amount'], NULL, '%a');
376 if (isset($defaults['fee_amount'])) {
377 $defaults['fee_amount'] = CRM_Utils_Money
::format($defaults['fee_amount'], NULL, '%a');
380 if (isset($defaults['net_amount'])) {
381 $defaults['net_amount'] = CRM_Utils_Money
::format($defaults['net_amount'], NULL, '%a');
384 if ($this->_contributionType
) {
385 $defaults['financial_type_id'] = $this->_contributionType
;
388 if (empty($defaults['payment_instrument_id'])) {
389 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
392 if (!empty($defaults['is_test'])) {
393 $this->assign('is_test', TRUE);
396 $this->assign('showOption', TRUE);
397 // For Premium section.
398 if ($this->_premiumID
) {
399 $this->assign('showOption', FALSE);
400 $options = isset($this->_options
[$this->_productDAO
->product_id
]) ?
$this->_options
[$this->_productDAO
->product_id
] : "";
402 $this->assign('showOption', TRUE);
404 $options_key = CRM_Utils_Array
::key($this->_productDAO
->product_option
, $options);
406 $defaults['product_name'] = array($this->_productDAO
->product_id
, trim($options_key));
409 $defaults['product_name'] = array($this->_productDAO
->product_id
);
411 if ($this->_productDAO
->fulfilled_date
) {
412 list($defaults['fulfilled_date']) = CRM_Utils_Date
::setDateDefaults($this->_productDAO
->fulfilled_date
);
416 if (isset($this->userEmail
)) {
417 $this->assign('email', $this->userEmail
);
420 if (!empty($defaults['is_pay_later'])) {
421 $this->assign('is_pay_later', TRUE);
423 $this->assign('contribution_status_id', CRM_Utils_Array
::value('contribution_status_id', $defaults));
424 if (!empty($defaults['contribution_status_id']) && in_array(
425 CRM_Contribute_PseudoConstant
::contributionStatus($defaults['contribution_status_id'], 'name'),
426 // Historically not 'Cancelled' hence not using CRM_Contribute_BAO_Contribution::isContributionStatusNegative.
427 array('Refunded', 'Chargeback')
429 $defaults['refund_trxn_id'] = CRM_Core_BAO_FinancialTrxn
::getRefundTransactionTrxnID($this->_id
);
432 $defaults['refund_trxn_id'] = isset($defaults['trxn_id']) ?
$defaults['trxn_id'] : NULL;
440 foreach ($dates as $key) {
441 if (!empty($defaults[$key])) {
442 list($defaults[$key], $defaults[$key . '_time'])
443 = CRM_Utils_Date
::setDateDefaults(CRM_Utils_Array
::value($key, $defaults), 'activityDateTime');
447 if (!$this->_id
&& empty($defaults['receive_date'])) {
448 list($defaults['receive_date'],
449 $defaults['receive_date_time']
450 ) = CRM_Utils_Date
::setDateDefaults(NULL, 'activityDateTime');
453 $this->assign('receive_date', CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('receive_date', $defaults),
454 CRM_Utils_Array
::value('receive_date_time', $defaults)
456 $currency = CRM_Utils_Array
::value('currency', $defaults);
457 $this->assign('currency', $currency);
458 // Hack to get currency info to the js layer. CRM-11440.
459 CRM_Utils_Money
::format(1);
460 $this->assign('currencySymbol', CRM_Utils_Array
::value($currency, CRM_Utils_Money
::$_currencySymbols));
461 $this->assign('totalAmount', CRM_Utils_Array
::value('total_amount', $defaults));
463 // Inherit campaign from pledge.
464 if ($this->_ppID
&& !empty($this->_pledgeValues
['campaign_id'])) {
465 $defaults['campaign_id'] = $this->_pledgeValues
['campaign_id'];
468 $this->_defaults
= $defaults;
473 * Build the form object.
475 public function buildQuickForm() {
476 // FIXME: This probably needs to be done in preprocess
477 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()
478 && $this->_action
& CRM_Core_Action
::UPDATE
479 && CRM_Utils_Array
::value('financial_type_id', $this->_values
)
481 $financialTypeID = CRM_Contribute_PseudoConstant
::financialType($this->_values
['financial_type_id']);
482 CRM_Financial_BAO_FinancialType
::checkPermissionedLineItems($this->_id
, 'edit');
483 if (!CRM_Core_Permission
::check('edit contributions of type ' . $financialTypeID)) {
484 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
489 //tax rate from financialType
490 $this->assign('taxRates', json_encode(CRM_Core_PseudoConstant
::getTaxRates()));
491 $this->assign('currencies', json_encode(CRM_Core_OptionGroup
::values('currencies_enabled')));
493 // build price set form.
494 $buildPriceSet = FALSE;
495 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
496 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
497 $this->assign('invoicing', $invoicing);
499 // display tax amount on edit contribution page
500 if ($invoicing && $this->_action
& CRM_Core_Action
::UPDATE
&& isset($this->_values
['tax_amount'])) {
501 $this->assign('totalTaxAmount', $this->_values
['tax_amount']);
504 if (empty($this->_lineItems
) &&
505 ($this->_priceSetId ||
!empty($_POST['price_set_id']))
507 $buildPriceSet = TRUE;
508 $getOnlyPriceSetElements = TRUE;
509 if (!$this->_priceSetId
) {
510 $this->_priceSetId
= $_POST['price_set_id'];
511 $getOnlyPriceSetElements = FALSE;
514 $this->set('priceSetId', $this->_priceSetId
);
515 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
517 // get only price set form elements.
518 if ($getOnlyPriceSetElements) {
522 // use to build form during form rule.
523 $this->assign('buildPriceSet', $buildPriceSet);
525 $defaults = $this->_values
;
526 $additionalDetailFields = array(
530 'non_deductible_amount',
534 foreach ($additionalDetailFields as $key) {
535 if (!empty($defaults[$key])) {
536 $defaults['hidden_AdditionalDetail'] = 1;
541 if ($this->_productDAO
) {
542 if ($this->_productDAO
->product_id
) {
543 $defaults['hidden_Premium'] = 1;
547 if ($this->_noteID
&&
548 isset($this->_values
['note'])
550 $defaults['hidden_AdditionalDetail'] = 1;
553 $paneNames = array();
554 if (empty($this->_payNow
)) {
555 $paneNames[ts('Additional Details')] = 'AdditionalDetail';
558 //Add Premium pane only if Premium is exists.
559 $dao = new CRM_Contribute_DAO_Product();
562 if ($dao->find(TRUE) && empty($this->_payNow
)) {
563 $paneNames[ts('Premium Information')] = 'Premium';
567 if (CRM_Core_Payment_Form
::buildPaymentForm($this, $this->_paymentProcessor
, FALSE, TRUE) == TRUE) {
568 if (!empty($this->_recurPaymentProcessors
)) {
569 $buildRecurBlock = TRUE;
571 // ppID denotes a pledge payment.
572 foreach ($this->_paymentProcessors
as $processor) {
573 if (!empty($processor['is_recur']) && !empty($processor['object']) && $processor['object']->supports('recurContributionsForPledges')) {
574 $buildRecurBlock = TRUE;
577 $buildRecurBlock = FALSE;
580 if ($buildRecurBlock) {
581 CRM_Contribute_Form_Contribution_Main
::buildRecur($this);
582 $this->setDefaults(array('is_recur' => 0));
583 $this->assign('buildRecurBlock', TRUE);
584 $recurJs = array('onChange' => "buildRecurBlock( this.value ); return false;");
590 foreach ($paneNames as $name => $type) {
591 $allPanes[$name] = $this->generatePane($type, $defaults);
594 $qfKey = $this->controller
->_key
;
595 $this->assign('qfKey', $qfKey);
596 $this->assign('allPanes', $allPanes);
598 $this->addFormRule(array('CRM_Contribute_Form_Contribution', 'formRule'), $this);
600 if ($this->_formType
) {
601 $this->assign('formType', $this->_formType
);
605 $this->applyFilter('__ALL__', 'trim');
607 if ($this->_action
& CRM_Core_Action
::DELETE
) {
608 $this->addButtons(array(
611 'name' => ts('Delete'),
612 'spacing' => ' ',
617 'name' => ts('Cancel'),
624 //need to assign custom data type and subtype to the template
625 $this->assign('customDataType', 'Contribution');
626 $this->assign('customDataSubType', $this->_contributionType
);
627 $this->assign('entityID', $this->_id
);
629 if ($this->_context
== 'standalone') {
630 $this->addEntityRef('contact_id', ts('Contact'), array(
632 'api' => array('extra' => array('email')),
636 $attributes = CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution');
638 // Check permissions for financial type first
639 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes, $this->_action
);
640 if (empty($financialTypes)) {
641 CRM_Core_Error
::statusBounce(ts('You do not have all the permissions needed for this page.'));
643 $financialType = $this->add('select', 'financial_type_id',
644 ts('Financial Type'),
645 array('' => ts('- select -')) +
$financialTypes,
647 array('onChange' => "CRM.buildCustomData( 'Contribution', this.value );")
650 $paymentInstrument = FALSE;
652 $paymentInstrument = $this->add('select', 'payment_instrument_id',
653 ts('Payment Method'),
654 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
655 TRUE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
659 $trxnId = $this->add('text', 'trxn_id', ts('Transaction ID'), array('class' => 'twelve') +
$attributes['trxn_id']);
661 //add receipt for offline contribution
662 $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
664 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
666 $status = CRM_Contribute_PseudoConstant
::contributionStatus();
668 // suppressing contribution statuses that are NOT relevant to pledges (CRM-5169)
669 $statusName = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
676 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
679 elseif ((!$this->_ppID
&& $this->_id
) ||
!$this->_id
) {
680 $suppressFlag = FALSE;
682 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
683 if (CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails)) {
684 $suppressFlag = TRUE;
687 if (!$suppressFlag) {
692 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
696 unset($status[CRM_Utils_Array
::key('Overdue', $statusName)]);
700 // define the status IDs that show the cancellation info, see CRM-17589
701 $cancelInfo_show_ids = array();
702 foreach (array_keys($statusName) as $status_id) {
703 if (CRM_Contribute_BAO_Contribution
::isContributionStatusNegative($status_id)) {
704 $cancelInfo_show_ids[] = "'$status_id'";
707 $this->assign('cancelInfo_show_ids', implode(',', $cancelInfo_show_ids));
710 $contributionStatus = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_id
, 'contribution_status_id');
711 $name = CRM_Utils_Array
::value($contributionStatus, $statusName);
714 // [CRM-17498] Removing unsupported status change options.
715 unset($status[CRM_Utils_Array
::key('Pending', $statusName)]);
716 unset($status[CRM_Utils_Array
::key('Failed', $statusName)]);
717 unset($status[CRM_Utils_Array
::key('Partially paid', $statusName)]);
718 unset($status[CRM_Utils_Array
::key('Pending refund', $statusName)]);
722 unset($status[CRM_Utils_Array
::key('In Progress', $statusName)]);
723 unset($status[CRM_Utils_Array
::key('Pending', $statusName)]);
724 unset($status[CRM_Utils_Array
::key('Failed', $statusName)]);
729 unset($status[CRM_Utils_Array
::key('Refunded', $statusName)]);
730 unset($status[CRM_Utils_Array
::key('Chargeback', $statusName)]);
742 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
748 unset($status[CRM_Utils_Array
::key('Refunded', $statusName)]);
749 unset($status[CRM_Utils_Array
::key('Chargeback', $statusName)]);
752 $statusElement = $this->add('select', 'contribution_status_id',
753 ts('Contribution Status'),
758 $currencyFreeze = FALSE;
759 if (!empty($this->_payNow
) && ($this->_action
& CRM_Core_Action
::UPDATE
)) {
760 $statusElement->freeze();
761 $currencyFreeze = TRUE;
762 $attributes['total_amount']['readonly'] = TRUE;
765 // CRM-16189, add Revenue Recognition Date
766 if (CRM_Contribute_BAO_Contribution
::checkContributeSettings('deferred_revenue_enabled')) {
767 $revenueDate = $this->add('date', 'revenue_recognition_date', ts('Revenue Recognition Date'), CRM_Core_SelectValues
::date(NULL, 'M Y', NULL, 5));
768 if ($this->_id
&& !CRM_Contribute_BAO_Contribution
::allowUpdateRevenueRecognitionDate($this->_id
)) {
769 $revenueDate->freeze();
774 $this->addDateTime('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
776 if ($this->_online
) {
777 $this->assign('hideCalender', TRUE);
779 $checkNumber = $this->add('text', 'check_number', ts('Check Number'), $attributes['check_number']);
781 $this->addDateTime('receipt_date', ts('Receipt Date'), FALSE, array('formatType' => 'activityDateTime'));
782 $this->addDateTime('cancel_date', ts('Cancelled / Refunded Date'), FALSE, array('formatType' => 'activityDateTime'));
784 $this->add('textarea', 'cancel_reason', ts('Cancellation / Refund Reason'), $attributes['cancel_reason']);
785 $this->add('text', 'refund_trxn_id', ts('Transaction ID for the refund payment'));
786 $element = $this->add('select',
787 'payment_processor_id',
788 ts('Payment Processor'),
794 if ($this->_online
) {
799 if (empty($this->_lineItems
)) {
800 $buildPriceSet = FALSE;
801 $priceSets = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviContribute');
802 if (!empty($priceSets) && !$this->_ppID
) {
803 $buildPriceSet = TRUE;
806 // don't allow price set for contribution if it is related to participant, or if it is a pledge payment
807 // and if we already have line items for that participant. CRM-5095
808 if ($buildPriceSet && $this->_id
) {
809 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
810 $pledgePaymentId = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
815 if ($pledgePaymentId) {
816 $buildPriceSet = FALSE;
818 if ($participantID = CRM_Utils_Array
::value('participant', $componentDetails)) {
819 $participantLI = CRM_Price_BAO_LineItem
::getLineItems($participantID);
820 if (!CRM_Utils_System
::isNull($participantLI)) {
821 $buildPriceSet = FALSE;
826 $hasPriceSets = FALSE;
827 if ($buildPriceSet) {
828 $hasPriceSets = TRUE;
829 // CRM-16451: set financial type of 'Price Set' in back office contribution
830 // instead of selecting manually
831 $financialTypeIds = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviContribute', 'financial_type_id');
832 $element = $this->add('select', 'price_set_id', ts('Choose price set'),
834 '' => ts('Choose price set'),
836 NULL, array('onchange' => "buildAmount( this.value, " . json_encode($financialTypeIds) . ");")
838 if ($this->_online
&& !($this->_action
& CRM_Core_Action
::UPDATE
)) {
842 $this->assign('hasPriceSets', $hasPriceSets);
843 if (!($this->_action
& CRM_Core_Action
::UPDATE
)) {
844 if ($this->_online ||
$this->_ppID
) {
845 $attributes['total_amount'] = array_merge($attributes['total_amount'], array(
847 'style' => "background-color:#EBECE4",
849 $optionTypes = array(
850 '1' => ts('Adjust Pledge Payment Schedule?'),
851 '2' => ts('Adjust Total Pledge Amount?'),
853 $this->addRadio('option_type',
859 $currencyFreeze = TRUE;
863 $totalAmount = $this->addMoney('total_amount',
865 ($hasPriceSets) ?
FALSE : TRUE,
866 $attributes['total_amount'],
867 TRUE, 'currency', NULL, $currencyFreeze
871 $this->add('text', 'source', ts('Source'), CRM_Utils_Array
::value('source', $attributes));
873 // CRM-7362 --add campaigns.
874 CRM_Campaign_BAO_Campaign
::addCampaign($this, CRM_Utils_Array
::value('campaign_id', $this->_values
));
876 if (empty($this->_payNow
)) {
877 CRM_Contribute_Form_SoftCredit
::buildQuickForm($this);
882 $js = array('onclick' => "return verify( );");
885 $mailingInfo = Civi
::settings()->get('mailing_backend');
886 $this->assign('outBound_option', $mailingInfo['outBound_option']);
888 $this->addButtons(array(
891 'name' => ts('Save'),
897 'name' => ts('Save and New'),
903 'name' => ts('Cancel'),
908 // if status is Cancelled freeze Amount, Payment Instrument, Check #, Financial Type,
909 // Net and Fee Amounts are frozen in AdditionalInfo::buildAdditionalDetail
910 if ($this->_id
&& $this->_values
['contribution_status_id'] == array_search('Cancelled', $statusName)) {
912 $totalAmount->freeze();
914 $checkNumber->freeze();
915 $paymentInstrument->freeze();
917 $financialType->freeze();
920 // if contribution is related to membership or participant freeze Financial Type, Amount
921 if ($this->_id
&& isset($this->_values
['tax_amount'])) {
922 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
923 if (CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails)) {
925 $totalAmount->freeze();
927 $financialType->freeze();
928 $this->assign('freezeFinancialType', TRUE);
932 if ($this->_action
& CRM_Core_Action
::VIEW
) {
940 * @param array $fields
941 * The input form values.
942 * @param array $files
943 * The uploaded files if any.
947 * true if no errors, else array of errors
949 public static function formRule($fields, $files, $self) {
951 // Check for Credit Card Contribution.
953 if (empty($fields['payment_processor_id'])) {
954 $errors['payment_processor_id'] = ts('Payment Processor is a required field.');
957 // validate payment instrument (e.g. credit card number)
958 CRM_Core_Payment_Form
::validatePaymentInstrument($fields['payment_processor_id'], $fields, $errors, NULL);
962 // Do the amount validations.
963 if (empty($fields['total_amount']) && empty($self->_lineItems
)) {
964 if ($priceSetId = CRM_Utils_Array
::value('price_set_id', $fields)) {
965 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $fields, $errors);
969 $softErrors = CRM_Contribute_Form_SoftCredit
::formRule($fields, $errors, $self);
971 if (!empty($fields['total_amount']) && (!empty($fields['net_amount']) ||
!empty($fields['fee_amount']))) {
972 $sum = CRM_Utils_Rule
::cleanMoney($fields['net_amount']) + CRM_Utils_Rule
::cleanMoney($fields['fee_amount']);
973 // For taxable contribution we need to deduct taxable amount from
974 // (net amount + fee amount) before comparing it with total amount
975 if (!empty($self->_values
['tax_amount'])) {
976 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($self->_id
);
977 if (!(CRM_Utils_Array
::value('membership', $componentDetails) ||
978 CRM_Utils_Array
::value('participant', $componentDetails))
980 $sum = CRM_Utils_Money
::format($sum - $self->_values
['tax_amount'], NULL, '%a');
983 if (CRM_Utils_Rule
::cleanMoney($fields['total_amount']) != $sum) {
984 $errors['total_amount'] = ts('The sum of fee amount and net amount must be equal to total amount');
988 //CRM-16285 - Function to handle validation errors on form, for recurring contribution field.
989 CRM_Contribute_BAO_ContributionRecur
::validateRecurContribution($fields, $files, $self, $errors);
991 // Form rule for status http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
992 if (($self->_action
& CRM_Core_Action
::UPDATE
)
994 && $self->_values
['contribution_status_id'] != $fields['contribution_status_id']
996 CRM_Contribute_BAO_Contribution
::checkStatusValidation($self->_values
, $fields, $errors);
998 // CRM-16015, add form-rule to restrict change of financial type if using price field of different financial type
999 if (($self->_action
& CRM_Core_Action
::UPDATE
)
1001 && $self->_values
['financial_type_id'] != $fields['financial_type_id']
1003 CRM_Contribute_BAO_Contribution
::checkFinancialTypeChange(NULL, $self->_id
, $errors);
1005 //FIXME FOR NEW DATA FLOW http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
1006 if (!empty($fields['fee_amount']) && !empty($fields['financial_type_id']) && $financialType = CRM_Contribute_BAO_Contribution
::validateFinancialType($fields['financial_type_id'])) {
1007 $errors['financial_type_id'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
1010 // $trxn_id must be unique CRM-13919
1011 if (!empty($fields['trxn_id'])) {
1012 $queryParams = array(1 => array($fields['trxn_id'], 'String'));
1013 $query = 'select count(*) from civicrm_contribution where trxn_id = %1';
1015 $queryParams[2] = array((int) $self->_id
, 'Integer');
1016 $query .= ' and id !=%2';
1018 $tCnt = CRM_Core_DAO
::singleValueQuery($query, $queryParams);
1020 $errors['trxn_id'] = ts('Transaction ID\'s must be unique. Transaction \'%1\' already exists in your database.', array(1 => $fields['trxn_id']));
1023 if (!empty($fields['revenue_recognition_date'])
1024 && count(array_filter($fields['revenue_recognition_date'])) == 1
1026 $errors['revenue_recognition_date'] = ts('Month and Year are required field for Revenue Recognition.');
1030 CRM_Financial_BAO_FinancialAccount
::checkFinancialTypeHasDeferred($fields, $self->_id
, $self->_priceSet
['fields']);
1032 catch (CRM_Core_Exception
$e) {
1033 $errors['financial_type_id'] = ' ';
1034 $errors['_qf_default'] = $e->getMessage();
1036 $errors = array_merge($errors, $softErrors);
1041 * Process the form submission.
1043 public function postProcess() {
1044 if ($this->_action
& CRM_Core_Action
::DELETE
) {
1045 CRM_Contribute_BAO_Contribution
::deleteContribution($this->_id
);
1046 CRM_Core_Session
::singleton()->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1047 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
1051 // Get the submitted form values.
1052 $submittedValues = $this->controller
->exportValues($this->_name
);
1055 $contribution = $this->submit($submittedValues, $this->_action
, $this->_ppID
);
1057 catch (PaymentProcessorException
$e) {
1058 // Set the contribution mode.
1059 $urlParams = "action=add&cid={$this->_contactID}";
1061 $urlParams .= "&mode={$this->_mode}";
1063 if (!empty($this->_ppID
)) {
1064 $urlParams .= "&context=pledge&ppid={$this->_ppID}";
1067 CRM_Core_Error
::statusBounce($e->getMessage(), $urlParams, ts('Payment Processor Error'));
1069 $session = CRM_Core_Session
::singleton();
1070 $buttonName = $this->controller
->getButtonName();
1071 if ($this->_context
== 'standalone') {
1072 if ($buttonName == $this->getButtonName('upload', 'new')) {
1073 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contribute/add',
1074 'reset=1&action=add&context=standalone'
1078 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1079 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
1083 elseif ($this->_context
== 'contribution' && $this->_mode
&& $buttonName == $this->getButtonName('upload', 'new')) {
1084 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
1085 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}&mode={$this->_mode}"
1088 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1089 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
1090 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}"
1094 //store contribution ID if not yet set (on create)
1095 if (empty($this->_id
) && !empty($contribution->id
)) {
1096 $this->_id
= $contribution->id
;
1101 * Process credit card payment.
1103 * @param array $submittedValues
1104 * @param array $lineItem
1106 * @param int $contactID
1109 * @return bool|\CRM_Contribute_DAO_Contribution
1110 * @throws \CRM_Core_Exception
1111 * @throws \Civi\Payment\Exception\PaymentProcessorException
1113 protected function processCreditCard($submittedValues, $lineItem, $contactID) {
1114 $isTest = ($this->_mode
== 'test') ?
1 : 0;
1115 // CRM-12680 set $_lineItem if its not set
1116 // @todo - I don't believe this would ever BE set. I can't find anywhere in the code.
1117 // It would be better to pass line item out to functions than $this->_lineItem as
1118 // we don't know what is being changed where.
1119 if (empty($this->_lineItem
) && !empty($lineItem)) {
1120 $this->_lineItem
= $lineItem;
1123 $this->_paymentObject
= Civi\Payment\System
::singleton()->getById($submittedValues['payment_processor_id']);
1124 $this->_paymentProcessor
= $this->_paymentObject
->getPaymentProcessor();
1126 // Set source if not set
1127 if (empty($submittedValues['source'])) {
1128 $userID = CRM_Core_Session
::singleton()->get('userID');
1129 $userSortName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $userID,
1132 $submittedValues['source'] = ts('Submit Credit Card Payment by: %1', array(1 => $userSortName));
1135 $params = $submittedValues;
1136 $this->_params
= array_merge($this->_params
, $submittedValues);
1138 // Mapping requiring documentation.
1139 $this->_params
['payment_processor'] = $submittedValues['payment_processor_id'];
1141 $now = date('YmdHis');
1143 // we need to retrieve email address
1144 if ($this->_context
== 'standalone' && !empty($submittedValues['is_email_receipt'])) {
1145 list($this->userDisplayName
,
1147 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID);
1148 $this->assign('displayName', $this->userDisplayName
);
1151 $this->_contributorEmail
= $this->userEmail
;
1152 $this->_contributorContactID
= $contactID;
1153 $this->processBillingAddress();
1154 if (!empty($params['source'])) {
1155 unset($params['source']);
1158 $this->_params
['amount'] = $this->_params
['total_amount'];
1159 // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
1160 // function to get correct amount level consistently. Remove setting of the amount level in
1161 // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
1162 // to cover all variants.
1163 $this->_params
['amount_level'] = 0;
1164 $this->_params
['description'] = ts("Contribution submitted by a staff person using contributor's credit card");
1165 $this->_params
['currencyID'] = CRM_Utils_Array
::value('currency',
1167 CRM_Core_Config
::singleton()->defaultCurrency
1170 if (!empty($this->_params
['receive_date'])) {
1171 $this->_params
['receive_date'] = CRM_Utils_Date
::processDate($this->_params
['receive_date'], $this->_params
['receive_date_time']);
1174 $this->_params
['pcp_display_in_roll'] = CRM_Utils_Array
::value('pcp_display_in_roll', $params);
1175 $this->_params
['pcp_roll_nickname'] = CRM_Utils_Array
::value('pcp_roll_nickname', $params);
1176 $this->_params
['pcp_personal_note'] = CRM_Utils_Array
::value('pcp_personal_note', $params);
1178 //Add common data to formatted params
1179 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($params, $this->_params
, $this);
1181 if (empty($this->_params
['invoice_id'])) {
1182 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1185 $this->_params
['invoiceID'] = $this->_params
['invoice_id'];
1188 // At this point we've created a contact and stored its address etc
1189 // all the payment processors expect the name and address to be in the
1190 // so we copy stuff over to first_name etc.
1191 $paymentParams = $this->_params
;
1192 $paymentParams['contactID'] = $contactID;
1193 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
1195 $financialType = new CRM_Financial_DAO_FinancialType();
1196 $financialType->id
= $params['financial_type_id'];
1197 $financialType->find(TRUE);
1199 // Add some financial type details to the params list
1200 // if folks need to use it.
1201 $paymentParams['contributionType_name'] = $this->_params
['contributionType_name'] = $financialType->name
;
1202 $paymentParams['contributionPageID'] = NULL;
1204 if (!empty($this->_params
['is_email_receipt'])) {
1205 $paymentParams['email'] = $this->userEmail
;
1206 $paymentParams['is_email_receipt'] = 1;
1209 $paymentParams['is_email_receipt'] = 0;
1210 $this->_params
['is_email_receipt'] = 0;
1212 if (!empty($this->_params
['receive_date'])) {
1213 $paymentParams['receive_date'] = $this->_params
['receive_date'];
1216 $this->_params
['receive_date'] = $now;
1218 if (!empty($this->_params
['is_email_receipt'])) {
1219 $this->_params
['receipt_date'] = $now;
1222 $this->_params
['receipt_date'] = CRM_Utils_Date
::processDate($this->_params
['receipt_date'],
1223 $params['receipt_date_time'], TRUE
1227 $this->set('params', $this->_params
);
1229 $this->assign('receive_date', $this->_params
['receive_date']);
1231 // Result has all the stuff we need
1232 // lets archive it to a financial transaction
1233 if ($financialType->is_deductible
) {
1234 $this->assign('is_deductible', TRUE);
1235 $this->set('is_deductible', TRUE);
1237 $contributionParams = array(
1238 'id' => CRM_Utils_Array
::value('contribution_id', $this->_params
),
1239 'contact_id' => $contactID,
1240 'line_item' => $lineItem,
1241 'is_test' => $isTest,
1242 'campaign_id' => CRM_Utils_Array
::value('campaign_id', $this->_params
),
1243 'contribution_page_id' => CRM_Utils_Array
::value('contribution_page_id', $this->_params
),
1244 'source' => CRM_Utils_Array
::value('source', $paymentParams, CRM_Utils_Array
::value('description', $paymentParams)),
1245 'thankyou_date' => CRM_Utils_Array
::value('thankyou_date', $this->_params
),
1247 $contributionParams['payment_instrument_id'] = $this->_paymentProcessor
['payment_instrument_id'];
1249 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processFormContribution($this,
1252 $contributionParams,
1256 CRM_Utils_Array
::value('is_recur', $this->_params
)
1259 $paymentParams['contributionID'] = $contribution->id
;
1260 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1261 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1262 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1264 if ($paymentParams['amount'] > 0.0) {
1265 // force a re-get of the payment processor in case the form changed it, CRM-7179
1266 // NOTE - I expect this is obsolete.
1267 $payment = Civi\Payment\System
::singleton()->getByProcessor($this->_paymentProcessor
);
1269 $statuses = CRM_Contribute_BAO_Contribution
::buildOptions('contribution_status_id');
1270 $result = $payment->doPayment($paymentParams, 'contribute');
1271 $this->assign('trxn_id', $result['trxn_id']);
1272 $contribution->trxn_id
= $result['trxn_id'];
1273 /* Our scenarios here are
1274 * 1) the payment failed & an Exception should have been thrown
1275 * 2) the payment succeeded but the payment is not immediate (for example a recurring payment
1276 * with a delayed start)
1277 * 3) the payment succeeded with an immediate payment.
1279 * The doPayment function ensures that payment_status_id is always set
1280 * as historically we have had to guess from the context - ie doDirectPayment
1281 * = error or success, unless it is a recurring contribution in which case it is pending.
1283 if ($result['payment_status_id'] == array_search('Completed', $statuses)) {
1285 civicrm_api3('contribution', 'completetransaction', array(
1286 'id' => $contribution->id
,
1287 'trxn_id' => $result['trxn_id'],
1288 'payment_processor_id' => $this->_paymentProcessor
['id'],
1289 'is_transactional' => FALSE,
1290 'fee_amount' => CRM_Utils_Array
::value('fee_amount', $result),
1292 // This has now been set to 1 in the DB - declare it here also
1293 $contribution->contribution_status_id
= 1;
1295 catch (CiviCRM_API3_Exception
$e) {
1296 if ($e->getErrorCode() != 'contribution_completed') {
1297 throw new CRM_Core_Exception('Failed to update contribution in database');
1302 // Save the trxn_id.
1303 $contribution->save();
1306 catch (PaymentProcessorException
$e) {
1307 CRM_Contribute_BAO_Contribution
::failPayment($contribution->id
, $paymentParams['contactID'], $e->getMessage());
1308 throw new PaymentProcessorException($e->getMessage());
1311 // Send receipt mail.
1312 array_unshift($this->statusMessage
, ts('The contribution record has been saved.'));
1313 if ($contribution->id
&& !empty($this->_params
['is_email_receipt'])) {
1314 $this->_params
['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1315 $this->_params
['contact_id'] = $contactID;
1316 $this->_params
['contribution_id'] = $contribution->id
;
1317 if (CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $this->_params
, TRUE)) {
1318 $this->statusMessage
[] = ts('A receipt has been emailed to the contributor.');
1322 return $contribution;
1326 * Generate the data to construct a snippet based pane.
1328 * This form also assigns the showAdditionalInfo var based on historical code.
1329 * This appears to mean 'there is a pane to show'.
1331 * @param string $type
1332 * Type of Pane - this is generally used to determine the function name used to build it
1333 * - e.g CreditCard, AdditionalDetail
1334 * @param array $defaults
1337 * We aim to further refactor & simplify this but currently
1339 * - should additional info be shown?
1341 protected function generatePane($type, $defaults) {
1342 $urlParams = "snippet=4&formType={$type}";
1344 $urlParams .= "&mode={$this->_mode}";
1348 if ($type == 'CreditCard' ||
1349 $type == 'DirectDebit'
1355 'url' => CRM_Utils_System
::url('civicrm/contact/view/contribution', $urlParams),
1360 // See if we need to include this paneName in the current form.
1361 if ($this->_formType
== $type ||
!empty($_POST["hidden_{$type}"]) ||
1362 CRM_Utils_Array
::value("hidden_{$type}", $defaults)
1364 $this->assign('showAdditionalInfo', TRUE);
1365 $pane['open'] = 'true';
1368 if ($type == 'CreditCard' ||
$type == 'DirectDebit') {
1369 // @todo would be good to align tpl name with form name...
1370 // @todo document why this hidden variable is required.
1371 $this->add('hidden', 'hidden_' . $type, 1);
1375 $additionalInfoFormFunction = 'build' . $type;
1376 CRM_Contribute_Form_AdditionalInfo
::$additionalInfoFormFunction($this);
1382 * Wrapper for unit testing the post process submit function.
1384 * (If we expose through api we can get default additions 'for free').
1386 * @param array $params
1387 * @param int $action
1388 * @param string|null $creditCardMode
1390 * @throws \CiviCRM_API3_Exception
1392 public function testSubmit($params, $action, $creditCardMode = NULL) {
1394 'soft_credit_contact_id' => array(),
1395 'receipt_date' => '',
1396 'receipt_date_time' => '',
1397 'cancel_date' => '',
1398 'cancel_date_time' => '',
1399 'hidden_Premium' => 1,
1402 if (!empty($params['id'])) {
1403 $existingContribution = civicrm_api3('contribution', 'getsingle', array(
1404 'id' => $params['id'],
1406 $this->_id
= $params['id'];
1407 $this->_values
= $existingContribution;
1410 $existingContribution = array();
1413 $this->_defaults
['contribution_status_id'] = CRM_Utils_Array
::value('contribution_status_id',
1414 $existingContribution
1417 $this->_defaults
['total_amount'] = CRM_Utils_Array
::value('total_amount',
1418 $existingContribution
1421 if ($creditCardMode) {
1422 $this->_mode
= $creditCardMode;
1425 // Required because processCreditCard calls set method on this.
1426 $_SERVER['REQUEST_METHOD'] = 'GET';
1427 $this->controller
= new CRM_Core_Controller();
1429 CRM_Contribute_Form_AdditionalInfo
::buildPremium($this);
1431 $this->_fields
= array();
1432 $this->submit(array_merge($defaults, $params), $action, CRM_Utils_Array
::value('pledge_payment_id', $params));
1437 * @param array $submittedValues
1439 * @param int $action
1441 * - CRM_Core_Action::UPDATE
1443 * @param $pledgePaymentID
1446 * @throws \Exception
1448 protected function submit($submittedValues, $action, $pledgePaymentID) {
1450 $pId = $contribution = $isRelatedId = FALSE;
1451 $this->_params
= $submittedValues;
1452 $this->beginPostProcess();
1454 if (!empty($submittedValues['price_set_id']) && $action & CRM_Core_Action
::UPDATE
) {
1455 $line = CRM_Price_BAO_LineItem
::getLineItems($this->_id
, 'contribution');
1456 $lineID = key($line);
1457 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', CRM_Utils_Array
::value('price_field_id', $line[$lineID]), 'price_set_id');
1458 $quickConfig = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
1459 // Why do we do this? Seems like a like a wrapper for old functionality - but single line price sets & quick
1460 // config should be treated the same.
1462 CRM_Price_BAO_LineItem
::deleteLineItems($this->_id
, 'civicrm_contribution');
1466 // Process price set and get total amount and line items.
1467 $lineItem = array();
1468 $priceSetId = CRM_Utils_Array
::value('price_set_id', $submittedValues);
1469 if (empty($priceSetId) && !$this->_id
) {
1470 $this->_priceSetId
= $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_contribution_amount', 'id', 'name');
1471 $this->_priceSet
= current(CRM_Price_BAO_PriceSet
::getSetDetail($priceSetId));
1472 $fieldID = key($this->_priceSet
['fields']);
1473 $fieldValueId = key($this->_priceSet
['fields'][$fieldID]['options']);
1474 $this->_priceSet
['fields'][$fieldID]['options'][$fieldValueId]['amount'] = $submittedValues['total_amount'];
1475 $submittedValues['price_' . $fieldID] = 1;
1478 // Every contribution has a price-set - the only reason it shouldn't be set is if we are dealing with
1479 // quick config (very very arguably) & yet we see that this could still be quick config so this should be understood
1480 // as a point of fragility rather than a logical 'if' clause.
1482 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
1483 $submittedValues, $lineItem[$priceSetId]);
1484 // Unset tax amount for offline 'is_quick_config' contribution.
1485 // @todo WHY - quick config was conceived as a quick way to configure contribution forms.
1486 // this is an example of 'other' functionality being hung off it.
1487 if ($this->_priceSet
['is_quick_config'] &&
1488 !array_key_exists($submittedValues['financial_type_id'], CRM_Core_PseudoConstant
::getTaxRates())
1490 unset($submittedValues['tax_amount']);
1492 $submittedValues['total_amount'] = CRM_Utils_Array
::value('amount', $submittedValues);
1495 if ($this->_compId
) {
1496 if ($this->_context
== 'participant') {
1497 $pId = $this->_compId
;
1499 elseif ($this->_context
== 'membership') {
1500 $isRelatedId = TRUE;
1503 $pId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id
, 'participant_id', 'contribution_id');
1507 $contributionDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
1508 if (array_key_exists('membership', $contributionDetails)) {
1509 $isRelatedId = TRUE;
1511 elseif (array_key_exists('participant', $contributionDetails)) {
1512 $pId = $contributionDetails['participant'];
1515 if (!empty($this->_payNow
)) {
1516 $this->_params
['contribution_id'] = $this->_id
;
1520 if (!$priceSetId && !empty($submittedValues['total_amount']) && $this->_id
) {
1521 // CRM-10117 update the line items for participants.
1522 // @todo - if we are completing a contribution then the api call
1523 // civicrm_api3('Contribution', 'completetransaction') should take care of
1524 // all associated updates rather than replicating them on the form layer.
1526 $entityTable = 'participant';
1528 $isRelatedId = FALSE;
1529 $participantParams = array(
1530 'fee_amount' => $submittedValues['total_amount'],
1533 CRM_Event_BAO_Participant
::add($participantParams);
1534 if (empty($this->_lineItems
)) {
1535 $this->_lineItems
[] = CRM_Price_BAO_LineItem
::getLineItems($entityID, 'participant', TRUE);
1539 $entityTable = 'contribution';
1540 $entityID = $this->_id
;
1543 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($entityID, $entityTable, FALSE, TRUE, $isRelatedId);
1544 foreach (array_keys($lineItems) as $id) {
1545 $lineItems[$id]['id'] = $id;
1547 $itemId = key($lineItems);
1548 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1549 $this->_priceSetId
= CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1552 // @todo see above - new functionality has been inappropriately added to the quick config concept
1553 // and new functionality has been added onto the form layer rather than the BAO :-(
1554 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1555 //CRM-16833: Ensure tax is applied only once for membership conribution, when status changed.(e.g Pending to Completed).
1556 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
1557 if (!(CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails))) {
1558 if (!($this->_action
& CRM_Core_Action
::UPDATE
&& (($this->_defaults
['contribution_status_id'] != $submittedValues['contribution_status_id'])))) {
1559 $lineItems[$itemId]['unit_price'] = $lineItems[$itemId]['line_total'] = CRM_Utils_Rule
::cleanMoney(CRM_Utils_Array
::value('total_amount', $submittedValues));
1563 // Update line total and total amount with tax on edit.
1564 $financialItemsId = CRM_Core_PseudoConstant
::getTaxRates();
1565 if (array_key_exists($submittedValues['financial_type_id'], $financialItemsId)) {
1566 $lineItems[$itemId]['tax_rate'] = $financialItemsId[$submittedValues['financial_type_id']];
1569 $lineItems[$itemId]['tax_rate'] = $lineItems[$itemId]['tax_amount'] = "";
1570 $submittedValues['tax_amount'] = 'null';
1572 if ($lineItems[$itemId]['tax_rate']) {
1573 $lineItems[$itemId]['tax_amount'] = ($lineItems[$itemId]['tax_rate'] / 100) * $lineItems[$itemId]['line_total'];
1574 $submittedValues['total_amount'] = $lineItems[$itemId]['line_total'] +
$lineItems[$itemId]['tax_amount'];
1575 $submittedValues['tax_amount'] = $lineItems[$itemId]['tax_amount'];
1578 // CRM-10117 update the line items for participants.
1579 if (!empty($lineItems[$itemId]['price_field_id'])) {
1580 $lineItem[$this->_priceSetId
] = $lineItems;
1585 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1588 //CRM-11529 for quick config back office transactions
1589 //when financial_type_id is passed in form, update the
1590 //line items with the financial type selected in form
1591 // NOTE that this IS still a legitimate use of 'quick-config' for contributions under the current DB but
1592 // we should look at having a price field per contribution type & then there would be little reason
1593 // for the back-office contribution form postProcess to know if it is a quick-config form.
1594 if ($isQuickConfig && !empty($submittedValues['financial_type_id']) && CRM_Utils_Array
::value($this->_priceSetId
, $lineItem)
1596 foreach ($lineItem[$this->_priceSetId
] as &$values) {
1597 $values['financial_type_id'] = $submittedValues['financial_type_id'];
1601 if (!isset($submittedValues['total_amount'])) {
1602 $submittedValues['total_amount'] = CRM_Utils_Array
::value('total_amount', $this->_values
);
1604 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1606 $isEmpty = array_keys(array_flip($submittedValues['soft_credit_contact_id']));
1607 if ($this->_id
&& count($isEmpty) == 1 && key($isEmpty) == NULL) {
1608 //Delete existing soft credit records if soft credit list is empty on update
1609 CRM_Contribute_BAO_ContributionSoft
::del(array('contribution_id' => $this->_id
, 'pcp_id' => 0));
1612 // set the contact, when contact is selected
1613 if (!empty($submittedValues['contact_id'])) {
1614 $this->_contactID
= $submittedValues['contact_id'];
1617 $formValues = $submittedValues;
1619 // Credit Card Contribution.
1621 $paramsSetByPaymentProcessingSubsystem = array(
1623 'payment_instrument_id',
1624 'contribution_status_id',
1628 foreach ($paramsSetByPaymentProcessingSubsystem as $key) {
1629 if (isset($formValues[$key])) {
1630 unset($formValues[$key]);
1633 $contribution = $this->processCreditCard($formValues, $lineItem, $this->_contactID
);
1634 foreach ($paramsSetByPaymentProcessingSubsystem as $key) {
1635 $formValues[$key] = $contribution->$key;
1639 // Offline Contribution.
1640 $submittedValues = $this->unsetCreditCardFields($submittedValues);
1642 // get the required field value only.
1644 $params = $ids = array();
1646 $params['contact_id'] = $this->_contactID
;
1647 $params['currency'] = $this->getCurrency($submittedValues);
1649 //format soft-credit/pcp param first
1650 CRM_Contribute_BAO_ContributionSoft
::formatSoftCreditParams($submittedValues, $this);
1651 $params = array_merge($params, $submittedValues);
1654 'financial_type_id',
1655 'contribution_status_id',
1656 'payment_instrument_id',
1661 foreach ($fields as $f) {
1662 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1665 // CRM-5740 if priceset is used, no need to cleanup money.
1667 $params['skipCleanMoney'] = 1;
1669 $params['revenue_recognition_date'] = NULL;
1670 if (!empty($formValues['revenue_recognition_date'])
1671 && count(array_filter($formValues['revenue_recognition_date'])) == 2
1673 $params['revenue_recognition_date'] = CRM_Utils_Date
::processDate(
1674 '01-' . implode('-', $formValues['revenue_recognition_date'])
1683 foreach ($dates as $d) {
1684 if (isset($formValues[$d])) {
1685 $params[$d] = CRM_Utils_Date
::processDate($formValues[$d], CRM_Utils_Array
::value($d . '_time', $formValues), TRUE);
1689 if (!empty($formValues['is_email_receipt'])) {
1690 $params['receipt_date'] = date("Y-m-d");
1693 if (CRM_Contribute_BAO_Contribution
::isContributionStatusNegative($params['contribution_status_id'])
1695 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value('cancel_date', $params))) {
1696 $params['cancel_date'] = date('YmdHis');
1700 $params['cancel_date'] = $params['cancel_reason'] = 'null';
1703 // Set is_pay_later flag for back-office offline Pending status contributions CRM-8996
1704 // else if contribution_status is changed to Completed is_pay_later flag is changed to 0, CRM-15041
1705 if ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Pending', 'name')) {
1706 $params['is_pay_later'] = 1;
1708 elseif ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Completed', 'name')) {
1709 $params['is_pay_later'] = 0;
1712 $ids['contribution'] = $params['id'] = $this->_id
;
1714 // Add Additional common information to formatted params.
1715 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($formValues, $params, $this);
1717 $params['contribution_mode'] = 'participant';
1718 $params['participant_id'] = $pId;
1719 $params['skipLineItem'] = 1;
1721 elseif ($isRelatedId) {
1722 $params['contribution_mode'] = 'membership';
1724 $params['line_item'] = $lineItem;
1725 $params['payment_processor_id'] = $params['payment_processor'] = CRM_Utils_Array
::value('id', $this->_paymentProcessor
);
1726 if (isset($submittedValues['tax_amount'])) {
1727 $params['tax_amount'] = $submittedValues['tax_amount'];
1729 //create contribution.
1730 if ($isQuickConfig) {
1731 $params['is_quick_config'] = 1;
1733 $params['non_deductible_amount'] = $this->calculateNonDeductibleAmount($params, $formValues);
1735 // we are already handling note below, so to avoid duplicate notes against $contribution
1736 if (!empty($params['note']) && !empty($submittedValues['note'])) {
1737 unset($params['note']);
1739 $contribution = CRM_Contribute_BAO_Contribution
::create($params, $ids);
1741 // process associated membership / participant, CRM-4395
1742 if ($contribution->id
&& $action & CRM_Core_Action
::UPDATE
) {
1743 $this->statusMessage
[] = CRM_Contribute_BAO_Contribution
::transitionComponentWithReturnMessage($contribution->id
,
1744 $contribution->contribution_status_id
,
1745 CRM_Utils_Array
::value('contribution_status_id',
1748 $contribution->receive_date
1752 array_unshift($this->statusMessage
, ts('The contribution record has been saved.'));
1754 $this->invoicingPostProcessHook($submittedValues, $action, $lineItem);
1756 //send receipt mail.
1757 if ($contribution->id
&& !empty($formValues['is_email_receipt'])) {
1758 $formValues['contact_id'] = $this->_contactID
;
1759 $formValues['contribution_id'] = $contribution->id
;
1761 $formValues +
= CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($contribution->id
);
1763 // to get 'from email id' for send receipt
1764 $this->fromEmailId
= $formValues['from_email_address'];
1765 if (CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $formValues)) {
1766 $this->statusMessage
[] = ts('A receipt has been emailed to the contributor.');
1770 $this->statusMessageTitle
= ts('Saved');
1774 if ($contribution->id
&& isset($formValues['product_name'][0])) {
1775 CRM_Contribute_Form_AdditionalInfo
::processPremium($submittedValues, $contribution->id
,
1776 $this->_premiumID
, $this->_options
1780 if ($contribution->id
&& !empty($submittedValues['note'])) {
1781 CRM_Contribute_Form_AdditionalInfo
::processNote($submittedValues, $this->_contactID
, $contribution->id
, $this->_noteID
);
1784 CRM_Core_Session
::setStatus(implode(' ', $this->statusMessage
), $this->statusMessageTitle
, 'success');
1786 CRM_Contribute_BAO_Contribution
::updateRelatedPledge(
1790 (CRM_Utils_Array
::value('option_type', $formValues) == 2) ?
TRUE : FALSE,
1791 $formValues['total_amount'],
1792 CRM_Utils_Array
::value('total_amount', $this->_defaults
),
1793 $formValues['contribution_status_id'],
1794 CRM_Utils_Array
::value('contribution_status_id', $this->_defaults
)
1796 return $contribution;
1800 * Assign tax calculations to contribution receipts.
1802 * @param array $submittedValues
1803 * @param int $action
1804 * @param array $lineItem
1806 protected function invoicingPostProcessHook($submittedValues, $action, $lineItem) {
1808 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
1809 if (!CRM_Utils_Array
::value('invoicing', $invoiceSettings)) {
1813 $getTaxDetails = FALSE;
1814 if ($action & CRM_Core_Action
::ADD
) {
1817 elseif ($action & CRM_Core_Action
::UPDATE
) {
1818 $line = $this->_lineItems
;
1820 foreach ($line as $key => $value) {
1821 foreach ($value as $v) {
1822 if (isset($taxRate[(string) CRM_Utils_Array
::value('tax_rate', $v)])) {
1823 $taxRate[(string) $v['tax_rate']] = $taxRate[(string) $v['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $v);
1826 if (isset($v['tax_rate'])) {
1827 $taxRate[(string) $v['tax_rate']] = CRM_Utils_Array
::value('tax_amount', $v);
1828 $getTaxDetails = TRUE;
1834 if ($action & CRM_Core_Action
::UPDATE
) {
1835 if (isset($submittedValues['tax_amount'])) {
1836 $totalTaxAmount = $submittedValues['tax_amount'];
1839 $totalTaxAmount = $this->_values
['tax_amount'];
1841 $this->assign('totalTaxAmount', $totalTaxAmount);
1842 $this->assign('dataArray', $taxRate);
1845 if (!empty($submittedValues['price_set_id'])) {
1846 $this->assign('totalTaxAmount', $submittedValues['tax_amount']);
1847 $this->assign('getTaxDetails', $getTaxDetails);
1848 $this->assign('dataArray', $taxRate);
1849 $this->assign('taxTerm', CRM_Utils_Array
::value('tax_term', $invoiceSettings));
1852 $this->assign('totalTaxAmount', CRM_Utils_Array
::value('tax_amount', $submittedValues));
1858 * Calculate non deductible amount.
1861 * if non_deductible_amount exists i.e. Additional Details field set was opened [and staff typed something] -
1862 * if non_deductible_amount does NOT exist - then calculate it depending on:
1863 * $financialType->is_deductible and whether there is a product (premium).
1866 * @param $formValues
1870 protected function calculateNonDeductibleAmount($params, $formValues) {
1871 if (!empty($params['non_deductible_amount'])) {
1872 return $params['non_deductible_amount'];
1875 $priceSetId = CRM_Utils_Array
::value('price_set_id', $params);
1876 // return non-deductible amount if it is set at the price field option level
1877 if ($priceSetId && !empty($params['line_item'])) {
1878 $nonDeductibleAmount = CRM_Price_BAO_PriceSet
::getNonDeductibleAmountFromPriceSet($priceSetId, $params['line_item']);
1879 if (!empty($nonDeductibleAmount)) {
1880 return $nonDeductibleAmount;
1884 $financialType = new CRM_Financial_DAO_FinancialType();
1885 $financialType->id
= $params['financial_type_id'];
1886 $financialType->find(TRUE);
1888 if ($financialType->is_deductible
) {
1890 if (isset($formValues['product_name'][0])) {
1891 $selectProduct = $formValues['product_name'][0];
1893 // if there is a product - compare the value to the contribution amount
1894 if (isset($selectProduct)) {
1895 $productDAO = new CRM_Contribute_DAO_Product();
1896 $productDAO->id
= $selectProduct;
1897 $productDAO->find(TRUE);
1898 // product value exceeds contribution amount
1899 if ($params['total_amount'] < $productDAO->price
) {
1900 return $params['total_amount'];
1902 // product value does NOT exceed contribution amount
1904 return $productDAO->price
;
1907 // contribution is deductible - but there is no product
1912 // contribution is NOT deductible
1914 return $params['total_amount'];