3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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
);
293 $this->setPageTitle($this->_ppID ?
ts('Credit Card Pledge Payment') : ts('Credit Card Contribution'));
296 $this->setPageTitle($this->_ppID ?
ts('Pledge Payment') : ts('Contribution'));
300 CRM_Contribute_Form_SoftCredit
::preprocess($this);
305 * Set default values.
309 public function setDefaultValues() {
311 $defaults = $this->_values
;
313 // Set defaults for pledge payment.
315 $defaults['total_amount'] = CRM_Utils_Array
::value('scheduled_amount', $this->_pledgeValues
['pledgePayment']);
316 $defaults['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $this->_pledgeValues
);
317 $defaults['currency'] = CRM_Utils_Array
::value('currency', $this->_pledgeValues
);
318 $defaults['option_type'] = 1;
321 if ($this->_action
& CRM_Core_Action
::DELETE
) {
325 $defaults['frequency_interval'] = 1;
326 $defaults['frequency_unit'] = 'month';
328 // Set soft credit defaults.
329 CRM_Contribute_Form_SoftCredit
::setDefaultValues($defaults, $this);
332 $config = CRM_Core_Config
::singleton();
333 // Set default country from config if no country set.
334 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
335 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
338 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
339 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
342 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID
);
343 $defaults = array_merge($defaults, $billingDefaults);
347 $this->_contactID
= $defaults['contact_id'];
350 // Set $newCredit variable in template to control whether link to credit card mode is included.
351 $this->assign('newCredit', CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments());
353 // Fix the display of the monetary value, CRM-4038.
354 if (isset($defaults['total_amount'])) {
355 if (!empty($defaults['tax_amount'])) {
356 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
357 if (!(CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails))) {
358 $defaults['total_amount'] = CRM_Utils_Money
::format($defaults['total_amount'] - $defaults['tax_amount'], NULL, '%a');
362 $defaults['total_amount'] = CRM_Utils_Money
::format($defaults['total_amount'], NULL, '%a');
366 if (isset($defaults['non_deductible_amount'])) {
367 $defaults['non_deductible_amount'] = CRM_Utils_Money
::format($defaults['non_deductible_amount'], NULL, '%a');
370 if (isset($defaults['fee_amount'])) {
371 $defaults['fee_amount'] = CRM_Utils_Money
::format($defaults['fee_amount'], NULL, '%a');
374 if (isset($defaults['net_amount'])) {
375 $defaults['net_amount'] = CRM_Utils_Money
::format($defaults['net_amount'], NULL, '%a');
378 if ($this->_contributionType
) {
379 $defaults['financial_type_id'] = $this->_contributionType
;
382 if (empty($defaults['payment_instrument_id'])) {
383 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
386 if (!empty($defaults['is_test'])) {
387 $this->assign('is_test', TRUE);
390 $this->assign('showOption', TRUE);
391 // For Premium section.
392 if ($this->_premiumID
) {
393 $this->assign('showOption', FALSE);
394 $options = isset($this->_options
[$this->_productDAO
->product_id
]) ?
$this->_options
[$this->_productDAO
->product_id
] : "";
396 $this->assign('showOption', TRUE);
398 $options_key = CRM_Utils_Array
::key($this->_productDAO
->product_option
, $options);
400 $defaults['product_name'] = array($this->_productDAO
->product_id
, trim($options_key));
403 $defaults['product_name'] = array($this->_productDAO
->product_id
);
405 if ($this->_productDAO
->fulfilled_date
) {
406 list($defaults['fulfilled_date']) = CRM_Utils_Date
::setDateDefaults($this->_productDAO
->fulfilled_date
);
410 if (isset($this->userEmail
)) {
411 $this->assign('email', $this->userEmail
);
414 if (!empty($defaults['is_pay_later'])) {
415 $this->assign('is_pay_later', TRUE);
417 $this->assign('contribution_status_id', CRM_Utils_Array
::value('contribution_status_id', $defaults));
425 foreach ($dates as $key) {
426 if (!empty($defaults[$key])) {
427 list($defaults[$key], $defaults[$key . '_time'])
428 = CRM_Utils_Date
::setDateDefaults(CRM_Utils_Array
::value($key, $defaults), 'activityDateTime');
432 if (!$this->_id
&& empty($defaults['receive_date'])) {
433 list($defaults['receive_date'],
434 $defaults['receive_date_time']
435 ) = CRM_Utils_Date
::setDateDefaults(NULL, 'activityDateTime');
438 $this->assign('receive_date', CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('receive_date', $defaults),
439 CRM_Utils_Array
::value('receive_date_time', $defaults)
441 $currency = CRM_Utils_Array
::value('currency', $defaults);
442 $this->assign('currency', $currency);
443 // Hack to get currency info to the js layer. CRM-11440.
444 CRM_Utils_Money
::format(1);
445 $this->assign('currencySymbol', CRM_Utils_Array
::value($currency, CRM_Utils_Money
::$_currencySymbols));
446 $this->assign('totalAmount', CRM_Utils_Array
::value('total_amount', $defaults));
448 // Inherit campaign from pledge.
449 if ($this->_ppID
&& !empty($this->_pledgeValues
['campaign_id'])) {
450 $defaults['campaign_id'] = $this->_pledgeValues
['campaign_id'];
453 $this->_defaults
= $defaults;
458 * Build the form object.
460 public function buildQuickForm() {
461 // FIXME: This probably needs to be done in preprocess
462 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()
463 && $this->_action
& CRM_Core_Action
::UPDATE
464 && CRM_Utils_Array
::value('financial_type_id', $this->_values
)
466 $financialTypeID = CRM_Contribute_PseudoConstant
::financialType($this->_values
['financial_type_id']);
467 CRM_Financial_BAO_FinancialType
::checkPermissionedLineItems($this->_id
, 'edit');
468 if (!CRM_Core_Permission
::check('edit contributions of type ' . $financialTypeID)) {
469 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
474 //tax rate from financialType
475 $this->assign('taxRates', json_encode(CRM_Core_PseudoConstant
::getTaxRates()));
476 $this->assign('currencies', json_encode(CRM_Core_OptionGroup
::values('currencies_enabled')));
478 // build price set form.
479 $buildPriceSet = FALSE;
480 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
481 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
482 $this->assign('invoicing', $invoicing);
484 // display tax amount on edit contribution page
485 if ($invoicing && $this->_action
& CRM_Core_Action
::UPDATE
&& isset($this->_values
['tax_amount'])) {
486 $this->assign('totalTaxAmount', $this->_values
['tax_amount']);
489 if (empty($this->_lineItems
) &&
490 ($this->_priceSetId ||
!empty($_POST['price_set_id']))
492 $buildPriceSet = TRUE;
493 $getOnlyPriceSetElements = TRUE;
494 if (!$this->_priceSetId
) {
495 $this->_priceSetId
= $_POST['price_set_id'];
496 $getOnlyPriceSetElements = FALSE;
499 $this->set('priceSetId', $this->_priceSetId
);
500 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
502 // get only price set form elements.
503 if ($getOnlyPriceSetElements) {
507 // use to build form during form rule.
508 $this->assign('buildPriceSet', $buildPriceSet);
510 $defaults = $this->_values
;
511 $additionalDetailFields = array(
515 'non_deductible_amount',
519 foreach ($additionalDetailFields as $key) {
520 if (!empty($defaults[$key])) {
521 $defaults['hidden_AdditionalDetail'] = 1;
526 if ($this->_productDAO
) {
527 if ($this->_productDAO
->product_id
) {
528 $defaults['hidden_Premium'] = 1;
532 if ($this->_noteID
&&
533 isset($this->_values
['note'])
535 $defaults['hidden_AdditionalDetail'] = 1;
539 ts('Additional Details') => 'AdditionalDetail',
542 //Add Premium pane only if Premium is exists.
543 $dao = new CRM_Contribute_DAO_Product();
546 if ($dao->find(TRUE)) {
547 $paneNames[ts('Premium Information')] = 'Premium';
551 if (CRM_Core_Payment_Form
::buildPaymentForm($this, $this->_paymentProcessor
, FALSE, TRUE) == TRUE) {
552 if (!empty($this->_recurPaymentProcessors
)) {
553 $buildRecurBlock = TRUE;
555 // ppID denotes a pledge payment.
556 foreach ($this->_paymentProcessors
as $processor) {
557 if (!empty($processor['is_recur']) && !empty($processor['object']) && $processor['object']->supports('recurContributionsForPledges')) {
558 $buildRecurBlock = TRUE;
561 $buildRecurBlock = FALSE;
564 if ($buildRecurBlock) {
565 CRM_Contribute_Form_Contribution_Main
::buildRecur($this);
566 $this->setDefaults(array('is_recur' => 0));
567 $this->assign('buildRecurBlock', TRUE);
568 $recurJs = array('onChange' => "buildRecurBlock( this.value ); return false;");
574 foreach ($paneNames as $name => $type) {
575 $allPanes[$name] = $this->generatePane($type, $defaults);
578 $qfKey = $this->controller
->_key
;
579 $this->assign('qfKey', $qfKey);
580 $this->assign('allPanes', $allPanes);
582 $this->addFormRule(array('CRM_Contribute_Form_Contribution', 'formRule'), $this);
584 if ($this->_formType
) {
585 $this->assign('formType', $this->_formType
);
589 $this->applyFilter('__ALL__', 'trim');
591 if ($this->_action
& CRM_Core_Action
::DELETE
) {
592 $this->addButtons(array(
595 'name' => ts('Delete'),
596 'spacing' => ' ',
601 'name' => ts('Cancel'),
608 //need to assign custom data type and subtype to the template
609 $this->assign('customDataType', 'Contribution');
610 $this->assign('customDataSubType', $this->_contributionType
);
611 $this->assign('entityID', $this->_id
);
613 if ($this->_context
== 'standalone') {
614 $this->addEntityRef('contact_id', ts('Contact'), array(
616 'api' => array('extra' => array('email')),
620 $attributes = CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution');
622 // Check permissions for financial type first
623 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes, $this->_action
);
624 if (empty($financialTypes)) {
625 CRM_Core_Error
::statusBounce(ts('You do not have all the permissions needed for this page.'));
627 $financialType = $this->add('select', 'financial_type_id',
628 ts('Financial Type'),
629 array('' => ts('- select -')) +
$financialTypes,
631 array('onChange' => "CRM.buildCustomData( 'Contribution', this.value );")
634 $paymentInstrument = FALSE;
636 $paymentInstrument = $this->add('select', 'payment_instrument_id',
637 ts('Payment Method'),
638 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
639 TRUE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
643 $trxnId = $this->add('text', 'trxn_id', ts('Transaction ID'), array('class' => 'twelve') +
$attributes['trxn_id']);
645 //add receipt for offline contribution
646 $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
648 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
650 $status = CRM_Contribute_PseudoConstant
::contributionStatus();
652 // suppressing contribution statuses that are NOT relevant to pledges (CRM-5169)
653 $statusName = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
660 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
663 elseif ((!$this->_ppID
&& $this->_id
) ||
!$this->_id
) {
664 $suppressFlag = FALSE;
666 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
667 if (CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails)) {
668 $suppressFlag = TRUE;
671 if (!$suppressFlag) {
676 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
680 unset($status[CRM_Utils_Array
::key('Overdue', $statusName)]);
685 $contributionStatus = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_id
, 'contribution_status_id');
686 $name = CRM_Utils_Array
::value($contributionStatus, $statusName);
691 unset($status[CRM_Utils_Array
::key('In Progress', $statusName)]);
692 unset($status[CRM_Utils_Array
::key('Pending', $statusName)]);
693 unset($status[CRM_Utils_Array
::key('Failed', $statusName)]);
698 unset($status[CRM_Utils_Array
::key('Refunded', $statusName)]);
709 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
715 unset($status[CRM_Utils_Array
::key('Refunded', $statusName)]);
718 $this->add('select', 'contribution_status_id',
719 ts('Contribution Status'),
725 $this->addDateTime('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
727 if ($this->_online
) {
728 $this->assign('hideCalender', TRUE);
730 $checkNumber = $this->add('text', 'check_number', ts('Check Number'), $attributes['check_number']);
732 $this->addDateTime('receipt_date', ts('Receipt Date'), FALSE, array('formatType' => 'activityDateTime'));
733 $this->addDateTime('cancel_date', ts('Cancelled / Refunded Date'), FALSE, array('formatType' => 'activityDateTime'));
735 $this->add('textarea', 'cancel_reason', ts('Cancellation / Refund Reason'), $attributes['cancel_reason']);
737 $element = $this->add('select',
738 'payment_processor_id',
739 ts('Payment Processor'),
745 if ($this->_online
) {
750 if (empty($this->_lineItems
)) {
751 $buildPriceSet = FALSE;
752 $priceSets = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviContribute');
753 if (!empty($priceSets) && !$this->_ppID
) {
754 $buildPriceSet = TRUE;
757 // don't allow price set for contribution if it is related to participant, or if it is a pledge payment
758 // and if we already have line items for that participant. CRM-5095
759 if ($buildPriceSet && $this->_id
) {
760 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
761 $pledgePaymentId = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
766 if ($pledgePaymentId) {
767 $buildPriceSet = FALSE;
769 if ($participantID = CRM_Utils_Array
::value('participant', $componentDetails)) {
770 $participantLI = CRM_Price_BAO_LineItem
::getLineItems($participantID);
771 if (!CRM_Utils_System
::isNull($participantLI)) {
772 $buildPriceSet = FALSE;
777 $hasPriceSets = FALSE;
778 if ($buildPriceSet) {
779 $hasPriceSets = TRUE;
780 // CRM-16451: set financial type of 'Price Set' in back office contribution
781 // instead of selecting manually
782 $financialTypeIds = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviContribute', 'financial_type_id');
783 $element = $this->add('select', 'price_set_id', ts('Choose price set'),
785 '' => ts('Choose price set'),
787 NULL, array('onchange' => "buildAmount( this.value, " . json_encode($financialTypeIds) . ");")
789 if ($this->_online
&& !($this->_action
& CRM_Core_Action
::UPDATE
)) {
793 $this->assign('hasPriceSets', $hasPriceSets);
794 $currencyFreeze = FALSE;
795 if (!($this->_action
& CRM_Core_Action
::UPDATE
)) {
796 if ($this->_online ||
$this->_ppID
) {
797 $attributes['total_amount'] = array_merge($attributes['total_amount'], array(
799 'style' => "background-color:#EBECE4",
801 $optionTypes = array(
802 '1' => ts('Adjust Pledge Payment Schedule?'),
803 '2' => ts('Adjust Total Pledge Amount?'),
805 $this->addRadio('option_type',
811 $currencyFreeze = TRUE;
815 $totalAmount = $this->addMoney('total_amount',
817 ($hasPriceSets) ?
FALSE : TRUE,
818 $attributes['total_amount'],
819 TRUE, 'currency', NULL, $currencyFreeze
823 $this->add('text', 'source', ts('Source'), CRM_Utils_Array
::value('source', $attributes));
825 // CRM-7362 --add campaigns.
826 CRM_Campaign_BAO_Campaign
::addCampaign($this, CRM_Utils_Array
::value('campaign_id', $this->_values
));
828 CRM_Contribute_Form_SoftCredit
::buildQuickForm($this);
832 $js = array('onclick' => "return verify( );");
835 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
838 $this->assign('outBound_option', $mailingInfo['outBound_option']);
840 $this->addButtons(array(
843 'name' => ts('Save'),
849 'name' => ts('Save and New'),
855 'name' => ts('Cancel'),
860 // if status is Cancelled freeze Amount, Payment Instrument, Check #, Financial Type,
861 // Net and Fee Amounts are frozen in AdditionalInfo::buildAdditionalDetail
862 if ($this->_id
&& $this->_values
['contribution_status_id'] == array_search('Cancelled', $statusName)) {
864 $totalAmount->freeze();
866 $checkNumber->freeze();
867 $paymentInstrument->freeze();
869 $financialType->freeze();
872 // if contribution is related to membership or participant freeze Financial Type, Amount
873 if ($this->_id
&& isset($this->_values
['tax_amount'])) {
874 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
875 if (CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails)) {
877 $totalAmount->freeze();
879 $financialType->freeze();
880 $this->assign('freezeFinancialType', TRUE);
884 if ($this->_action
& CRM_Core_Action
::VIEW
) {
892 * @param array $fields
893 * The input form values.
894 * @param array $files
895 * The uploaded files if any.
899 * true if no errors, else array of errors
901 public static function formRule($fields, $files, $self) {
903 // Check for Credit Card Contribution.
905 if (empty($fields['payment_processor_id'])) {
906 $errors['payment_processor_id'] = ts('Payment Processor is a required field.');
909 // validate payment instrument (e.g. credit card number)
910 CRM_Core_Payment_Form
::validatePaymentInstrument($fields['payment_processor_id'], $fields, $errors, NULL);
914 // Do the amount validations.
915 if (empty($fields['total_amount']) && empty($self->_lineItems
)) {
916 if ($priceSetId = CRM_Utils_Array
::value('price_set_id', $fields)) {
917 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $fields, $errors);
921 $softErrors = CRM_Contribute_Form_SoftCredit
::formRule($fields, $errors, $self);
923 if (!empty($fields['total_amount']) && (!empty($fields['net_amount']) ||
!empty($fields['fee_amount']))) {
924 $sum = CRM_Utils_Rule
::cleanMoney($fields['net_amount']) + CRM_Utils_Rule
::cleanMoney($fields['fee_amount']);
925 // For taxable contribution we need to deduct taxable amount from
926 // (net amount + fee amount) before comparing it with total amount
927 if (!empty($self->_values
['tax_amount'])) {
928 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($self->_id
);
929 if (!(CRM_Utils_Array
::value('membership', $componentDetails) ||
930 CRM_Utils_Array
::value('participant', $componentDetails))
932 $sum = CRM_Utils_Money
::format($sum - $self->_values
['tax_amount'], NULL, '%a');
935 if (CRM_Utils_Rule
::cleanMoney($fields['total_amount']) != $sum) {
936 $errors['total_amount'] = ts('The sum of fee amount and net amount must be equal to total amount');
940 //CRM-16285 - Function to handle validation errors on form, for recurring contribution field.
941 CRM_Contribute_BAO_ContributionRecur
::validateRecurContribution($fields, $files, $self, $errors);
943 // Form rule for status http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
944 if (($self->_action
& CRM_Core_Action
::UPDATE
)
946 && $self->_values
['contribution_status_id'] != $fields['contribution_status_id']
948 CRM_Contribute_BAO_Contribution
::checkStatusValidation($self->_values
, $fields, $errors);
950 // CRM-16015, add form-rule to restrict change of financial type if using price field of different financial type
951 if (($self->_action
& CRM_Core_Action
::UPDATE
)
953 && $self->_values
['financial_type_id'] != $fields['financial_type_id']
955 CRM_Contribute_BAO_Contribution
::checkFinancialTypeChange(NULL, $self->_id
, $errors);
957 //FIXME FOR NEW DATA FLOW http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
958 if (!empty($fields['fee_amount']) && !empty($fields['financial_type_id']) && $financialType = CRM_Contribute_BAO_Contribution
::validateFinancialType($fields['financial_type_id'])) {
959 $errors['financial_type_id'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
962 // $trxn_id must be unique CRM-13919
963 if (!empty($fields['trxn_id'])) {
964 $queryParams = array(1 => array($fields['trxn_id'], 'String'));
965 $query = 'select count(*) from civicrm_contribution where trxn_id = %1';
967 $queryParams[2] = array((int) $self->_id
, 'Integer');
968 $query .= ' and id !=%2';
970 $tCnt = CRM_Core_DAO
::singleValueQuery($query, $queryParams);
972 $errors['trxn_id'] = ts('Transaction ID\'s must be unique. Transaction \'%1\' already exists in your database.', array(1 => $fields['trxn_id']));
976 $errors = array_merge($errors, $softErrors);
981 * Process the form submission.
983 public function postProcess() {
984 if ($this->_action
& CRM_Core_Action
::DELETE
) {
985 CRM_Contribute_BAO_Contribution
::deleteContribution($this->_id
);
986 CRM_Core_Session
::singleton()->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
987 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
991 // Get the submitted form values.
992 $submittedValues = $this->controller
->exportValues($this->_name
);
995 $contribution = $this->submit($submittedValues, $this->_action
, $this->_ppID
);
997 catch (PaymentProcessorException
$e) {
998 // Set the contribution mode.
999 $urlParams = "action=add&cid={$this->_contactID}";
1001 $urlParams .= "&mode={$this->_mode}";
1003 if (!empty($this->_ppID
)) {
1004 $urlParams .= "&context=pledge&ppid={$this->_ppID}";
1007 CRM_Core_Error
::statusBounce($e->getMessage(), $urlParams, ts('Payment Processor Error'));
1009 $session = CRM_Core_Session
::singleton();
1010 $buttonName = $this->controller
->getButtonName();
1011 if ($this->_context
== 'standalone') {
1012 if ($buttonName == $this->getButtonName('upload', 'new')) {
1013 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contribute/add',
1014 'reset=1&action=add&context=standalone'
1018 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1019 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
1023 elseif ($this->_context
== 'contribution' && $this->_mode
&& $buttonName == $this->getButtonName('upload', 'new')) {
1024 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
1025 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}&mode={$this->_mode}"
1028 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1029 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
1030 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}"
1034 //store contribution ID if not yet set (on create)
1035 if (empty($this->_id
) && !empty($contribution->id
)) {
1036 $this->_id
= $contribution->id
;
1041 * Process credit card payment.
1043 * @param array $submittedValues
1044 * @param array $lineItem
1046 * @param int $contactID
1049 * @return bool|\CRM_Contribute_DAO_Contribution
1050 * @throws \CRM_Core_Exception
1051 * @throws \Civi\Payment\Exception\PaymentProcessorException
1053 protected function processCreditCard($submittedValues, $lineItem, $contactID) {
1054 $isTest = ($this->_mode
== 'test') ?
1 : 0;
1055 // CRM-12680 set $_lineItem if its not set
1056 // @todo - I don't believe this would ever BE set. I can't find anywhere in the code.
1057 // It would be better to pass line item out to functions than $this->_lineItem as
1058 // we don't know what is being changed where.
1059 if (empty($this->_lineItem
) && !empty($lineItem)) {
1060 $this->_lineItem
= $lineItem;
1063 $this->_paymentObject
= Civi\Payment\System
::singleton()->getById($submittedValues['payment_processor_id']);
1064 $this->_paymentProcessor
= $this->_paymentObject
->getPaymentProcessor();
1066 // Set source if not set
1067 if (empty($submittedValues['source'])) {
1068 $userID = CRM_Core_Session
::singleton()->get('userID');
1069 $userSortName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $userID,
1072 $submittedValues['source'] = ts('Submit Credit Card Payment by: %1', array(1 => $userSortName));
1075 $params = $submittedValues;
1076 $this->_params
= array_merge($this->_params
, $submittedValues);
1078 // Mapping requiring documentation.
1079 $this->_params
['payment_processor'] = $submittedValues['payment_processor_id'];
1081 $now = date('YmdHis');
1083 // we need to retrieve email address
1084 if ($this->_context
== 'standalone' && !empty($submittedValues['is_email_receipt'])) {
1085 list($this->userDisplayName
,
1087 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID);
1088 $this->assign('displayName', $this->userDisplayName
);
1091 $this->_contributorEmail
= $this->userEmail
;
1092 $this->_contributorContactID
= $contactID;
1093 $this->processBillingAddress();
1094 if (!empty($params['source'])) {
1095 unset($params['source']);
1098 $this->_params
['amount'] = $this->_params
['total_amount'];
1099 // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
1100 // function to get correct amount level consistently. Remove setting of the amount level in
1101 // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
1102 // to cover all variants.
1103 $this->_params
['amount_level'] = 0;
1104 $this->_params
['description'] = ts("Contribution submitted by a staff person using contributor's credit card");
1105 $this->_params
['currencyID'] = CRM_Utils_Array
::value('currency',
1107 CRM_Core_Config
::singleton()->defaultCurrency
1110 if (!empty($this->_params
['receive_date'])) {
1111 $this->_params
['receive_date'] = CRM_Utils_Date
::processDate($this->_params
['receive_date'], $this->_params
['receive_date_time']);
1114 $this->_params
['pcp_display_in_roll'] = CRM_Utils_Array
::value('pcp_display_in_roll', $params);
1115 $this->_params
['pcp_roll_nickname'] = CRM_Utils_Array
::value('pcp_roll_nickname', $params);
1116 $this->_params
['pcp_personal_note'] = CRM_Utils_Array
::value('pcp_personal_note', $params);
1118 //Add common data to formatted params
1119 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($params, $this->_params
, $this);
1121 if (empty($this->_params
['invoice_id'])) {
1122 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1125 $this->_params
['invoiceID'] = $this->_params
['invoice_id'];
1128 // At this point we've created a contact and stored its address etc
1129 // all the payment processors expect the name and address to be in the
1130 // so we copy stuff over to first_name etc.
1131 $paymentParams = $this->_params
;
1132 $paymentParams['contactID'] = $contactID;
1133 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
1135 $financialType = new CRM_Financial_DAO_FinancialType();
1136 $financialType->id
= $params['financial_type_id'];
1137 $financialType->find(TRUE);
1139 // Add some financial type details to the params list
1140 // if folks need to use it.
1141 $paymentParams['contributionType_name'] = $this->_params
['contributionType_name'] = $financialType->name
;
1142 $paymentParams['contributionPageID'] = NULL;
1144 if (!empty($this->_params
['is_email_receipt'])) {
1145 $paymentParams['email'] = $this->userEmail
;
1146 $paymentParams['is_email_receipt'] = 1;
1149 $paymentParams['is_email_receipt'] = 0;
1150 $this->_params
['is_email_receipt'] = 0;
1152 if (!empty($this->_params
['receive_date'])) {
1153 $paymentParams['receive_date'] = $this->_params
['receive_date'];
1156 $this->_params
['receive_date'] = $now;
1158 if (!empty($this->_params
['is_email_receipt'])) {
1159 $this->_params
['receipt_date'] = $now;
1162 $this->_params
['receipt_date'] = CRM_Utils_Date
::processDate($this->_params
['receipt_date'],
1163 $params['receipt_date_time'], TRUE
1167 $this->set('params', $this->_params
);
1169 $this->assign('receive_date', $this->_params
['receive_date']);
1171 // Result has all the stuff we need
1172 // lets archive it to a financial transaction
1173 if ($financialType->is_deductible
) {
1174 $this->assign('is_deductible', TRUE);
1175 $this->set('is_deductible', TRUE);
1177 $contributionParams = array(
1178 'contact_id' => $contactID,
1179 'line_item' => $lineItem,
1180 'is_test' => $isTest,
1181 'campaign_id' => CRM_Utils_Array
::value('campaign_id', $this->_params
),
1182 'contribution_page_id' => CRM_Utils_Array
::value('contribution_page_id', $this->_params
),
1183 'source' => CRM_Utils_Array
::value('source', $paymentParams, CRM_Utils_Array
::value('description', $paymentParams)),
1184 'thankyou_date' => CRM_Utils_Array
::value('thankyou_date', $this->_params
),
1187 if (empty($paymentParams['is_pay_later'])) {
1188 // @todo look up payment_instrument_id on payment processor table.
1189 $contributionParams['payment_instrument_id'] = 1;
1192 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processFormContribution($this,
1195 $contributionParams,
1201 $paymentParams['contributionID'] = $contribution->id
;
1202 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1203 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1204 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1206 if ($paymentParams['amount'] > 0.0) {
1207 // force a re-get of the payment processor in case the form changed it, CRM-7179
1208 // NOTE - I expect this is obsolete.
1209 $payment = Civi\Payment\System
::singleton()->getByProcessor($this->_paymentProcessor
);
1211 $statuses = CRM_Contribute_BAO_Contribution
::buildOptions('contribution_status_id');
1212 $result = $payment->doPayment($paymentParams, 'contribute');
1213 $this->assign('trxn_id', $result['trxn_id']);
1214 $contribution->trxn_id
= $result['trxn_id'];
1215 /* Our scenarios here are
1216 * 1) the payment failed & an Exception should have been thrown
1217 * 2) the payment succeeded but the payment is not immediate (for example a recurring payment
1218 * with a delayed start)
1219 * 3) the payment succeeded with an immediate payment.
1221 * The doPayment function ensures that payment_status_id is always set
1222 * as historically we have had to guess from the context - ie doDirectPayment
1223 * = error or success, unless it is a recurring contribution in which case it is pending.
1225 if ($result['payment_status_id'] == array_search('Completed', $statuses)) {
1227 civicrm_api3('contribution', 'completetransaction', array(
1228 'id' => $contribution->id
,
1229 'trxn_id' => $result['trxn_id'],
1230 'payment_processor_id' => $this->_paymentProcessor
['id'],
1231 'is_transactional' => FALSE,
1232 'fee_amount' => CRM_Utils_Array
::value('fee_amount', $result),
1234 // This has now been set to 1 in the DB - declare it here also
1235 $contribution->contribution_status_id
= 1;
1237 catch (CiviCRM_API3_Exception
$e) {
1238 if ($e->getErrorCode() != 'contribution_completed') {
1239 throw new CRM_Core_Exception('Failed to update contribution in database');
1244 // Save the trxn_id.
1245 $contribution->save();
1248 catch (PaymentProcessorException
$e) {
1249 CRM_Contribute_BAO_Contribution
::failPayment($contribution->id
, $paymentParams['contactID'], $e->getMessage());
1250 throw new PaymentProcessorException($e->getMessage());
1253 // Send receipt mail.
1254 array_unshift($this->statusMessage
, ts('The contribution record has been saved.'));
1255 if ($contribution->id
&& !empty($this->_params
['is_email_receipt'])) {
1256 $this->_params
['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1257 $this->_params
['contact_id'] = $contactID;
1258 $this->_params
['contribution_id'] = $contribution->id
;
1259 if (CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $this->_params
, TRUE)) {
1260 $this->statusMessage
[] = ts('A receipt has been emailed to the contributor.');
1264 return $contribution;
1268 * Generate the data to construct a snippet based pane.
1270 * This form also assigns the showAdditionalInfo var based on historical code.
1271 * This appears to mean 'there is a pane to show'.
1273 * @param string $type
1274 * Type of Pane - this is generally used to determine the function name used to build it
1275 * - e.g CreditCard, AdditionalDetail
1276 * @param array $defaults
1279 * We aim to further refactor & simplify this but currently
1281 * - should additional info be shown?
1283 protected function generatePane($type, $defaults) {
1284 $urlParams = "snippet=4&formType={$type}";
1286 $urlParams .= "&mode={$this->_mode}";
1290 if ($type == 'CreditCard' ||
1291 $type == 'DirectDebit'
1297 'url' => CRM_Utils_System
::url('civicrm/contact/view/contribution', $urlParams),
1302 // See if we need to include this paneName in the current form.
1303 if ($this->_formType
== $type ||
!empty($_POST["hidden_{$type}"]) ||
1304 CRM_Utils_Array
::value("hidden_{$type}", $defaults)
1306 $this->assign('showAdditionalInfo', TRUE);
1307 $pane['open'] = 'true';
1310 if ($type == 'CreditCard' ||
$type == 'DirectDebit') {
1311 // @todo would be good to align tpl name with form name...
1312 // @todo document why this hidden variable is required.
1313 $this->add('hidden', 'hidden_' . $type, 1);
1317 $additionalInfoFormFunction = 'build' . $type;
1318 CRM_Contribute_Form_AdditionalInfo
::$additionalInfoFormFunction($this);
1324 * Wrapper for unit testing the post process submit function.
1326 * (If we expose through api we can get default additions 'for free').
1328 * @param array $params
1329 * @param int $action
1330 * @param string|null $creditCardMode
1332 * @throws \CiviCRM_API3_Exception
1334 public function testSubmit($params, $action, $creditCardMode = NULL) {
1336 'soft_credit_contact_id' => array(),
1337 'receipt_date' => '',
1338 'receipt_date_time' => '',
1339 'cancel_date' => '',
1340 'cancel_date_time' => '',
1341 'hidden_Premium' => 1,
1344 if (!empty($params['id'])) {
1345 $existingContribution = civicrm_api3('contribution', 'getsingle', array(
1346 'id' => $params['id'],
1348 $this->_id
= $params['id'];
1351 $existingContribution = array();
1354 $this->_defaults
['contribution_status_id'] = CRM_Utils_Array
::value('contribution_status_id',
1355 $existingContribution
1358 $this->_defaults
['total_amount'] = CRM_Utils_Array
::value('total_amount',
1359 $existingContribution
1362 if ($creditCardMode) {
1363 $this->_mode
= $creditCardMode;
1366 // Required because processCreditCard calls set method on this.
1367 $_SERVER['REQUEST_METHOD'] = 'GET';
1368 $this->controller
= new CRM_Core_Controller();
1370 CRM_Contribute_Form_AdditionalInfo
::buildPremium($this);
1372 $this->_fields
= array();
1373 $this->submit(array_merge($defaults, $params), $action, CRM_Utils_Array
::value('pledge_payment_id', $params));
1378 * @param array $submittedValues
1380 * @param int $action
1382 * - CRM_Core_Action::UPDATE
1384 * @param $pledgePaymentID
1387 * @throws \Exception
1389 protected function submit($submittedValues, $action, $pledgePaymentID) {
1390 $softParams = $softIDs = array();
1391 $pId = $contribution = $isRelatedId = FALSE;
1392 $this->_params
= $submittedValues;
1393 $this->beginPostProcess();
1395 if (!empty($submittedValues['price_set_id']) && $action & CRM_Core_Action
::UPDATE
) {
1396 $line = CRM_Price_BAO_LineItem
::getLineItems($this->_id
, 'contribution');
1397 $lineID = key($line);
1398 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', CRM_Utils_Array
::value('price_field_id', $line[$lineID]), 'price_set_id');
1399 $quickConfig = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
1400 // Why do we do this? Seems like a like a wrapper for old functionality - but single line price sets & quick
1401 // config should be treated the same.
1403 CRM_Price_BAO_LineItem
::deleteLineItems($this->_id
, 'civicrm_contribution');
1407 // Process price set and get total amount and line items.
1408 $lineItem = array();
1409 $priceSetId = CRM_Utils_Array
::value('price_set_id', $submittedValues);
1410 if (empty($priceSetId) && !$this->_id
) {
1411 $this->_priceSetId
= $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_contribution_amount', 'id', 'name');
1412 $this->_priceSet
= current(CRM_Price_BAO_PriceSet
::getSetDetail($priceSetId));
1413 $fieldID = key($this->_priceSet
['fields']);
1414 $fieldValueId = key($this->_priceSet
['fields'][$fieldID]['options']);
1415 $this->_priceSet
['fields'][$fieldID]['options'][$fieldValueId]['amount'] = $submittedValues['total_amount'];
1416 $submittedValues['price_' . $fieldID] = 1;
1419 // Every contribution has a price-set - the only reason it shouldn't be set is if we are dealing with
1420 // quick config (very very arguably) & yet we see that this could still be quick config so this should be understood
1421 // as a point of fragility rather than a logical 'if' clause.
1423 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
1424 $submittedValues, $lineItem[$priceSetId]);
1425 // Unset tax amount for offline 'is_quick_config' contribution.
1426 // @todo WHY - quick config was conceived as a quick way to configure contribution forms.
1427 // this is an example of 'other' functionality being hung off it.
1428 if ($this->_priceSet
['is_quick_config'] &&
1429 !array_key_exists($submittedValues['financial_type_id'], CRM_Core_PseudoConstant
::getTaxRates())
1431 unset($submittedValues['tax_amount']);
1433 $submittedValues['total_amount'] = CRM_Utils_Array
::value('amount', $submittedValues);
1436 if ($this->_compId
) {
1437 if ($this->_context
== 'participant') {
1438 $pId = $this->_compId
;
1440 elseif ($this->_context
== 'membership') {
1441 $isRelatedId = TRUE;
1444 $pId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id
, 'participant_id', 'contribution_id');
1448 $contributionDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
1449 if (array_key_exists('membership', $contributionDetails)) {
1450 $isRelatedId = TRUE;
1452 elseif (array_key_exists('participant', $contributionDetails)) {
1453 $pId = $contributionDetails['participant'];
1458 if (!$priceSetId && !empty($submittedValues['total_amount']) && $this->_id
) {
1459 // CRM-10117 update the line items for participants.
1460 // @todo - if we are completing a contribution then the api call
1461 // civicrm_api3('Contribution', 'completetransaction') should take care of
1462 // all associated updates rather than replicating them on the form layer.
1464 $entityTable = 'participant';
1466 $isRelatedId = FALSE;
1467 $participantParams = array(
1468 'fee_amount' => $submittedValues['total_amount'],
1471 CRM_Event_BAO_Participant
::add($participantParams);
1472 if (empty($this->_lineItems
)) {
1473 $this->_lineItems
[] = CRM_Price_BAO_LineItem
::getLineItems($entityID, 'participant', 1);
1477 $entityTable = 'contribution';
1478 $entityID = $this->_id
;
1481 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($entityID, $entityTable, NULL, TRUE, $isRelatedId);
1482 foreach (array_keys($lineItems) as $id) {
1483 $lineItems[$id]['id'] = $id;
1485 $itemId = key($lineItems);
1486 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1487 $this->_priceSetId
= CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1490 // @todo see above - new functionality has been inappropriately added to the quick config concept
1491 // and new functionality has been added onto the form layer rather than the BAO :-(
1492 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1493 //CRM-16833: Ensure tax is applied only once for membership conribution, when status changed.(e.g Pending to Completed).
1494 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
1495 if (!CRM_Utils_Array
::value('membership', $componentDetails) ||
!CRM_Utils_Array
::value('participant', $componentDetails)) {
1496 if (!($this->_action
& CRM_Core_Action
::UPDATE
&& (($this->_defaults
['contribution_status_id'] != $submittedValues['contribution_status_id'])))) {
1497 $lineItems[$itemId]['unit_price'] = $lineItems[$itemId]['line_total'] = CRM_Utils_Rule
::cleanMoney(CRM_Utils_Array
::value('total_amount', $submittedValues));
1501 // Update line total and total amount with tax on edit.
1502 $financialItemsId = CRM_Core_PseudoConstant
::getTaxRates();
1503 if (array_key_exists($submittedValues['financial_type_id'], $financialItemsId)) {
1504 $lineItems[$itemId]['tax_rate'] = $financialItemsId[$submittedValues['financial_type_id']];
1507 $lineItems[$itemId]['tax_rate'] = $lineItems[$itemId]['tax_amount'] = "";
1508 $submittedValues['tax_amount'] = 'null';
1510 if ($lineItems[$itemId]['tax_rate']) {
1511 $lineItems[$itemId]['tax_amount'] = ($lineItems[$itemId]['tax_rate'] / 100) * $lineItems[$itemId]['line_total'];
1512 $submittedValues['total_amount'] = $lineItems[$itemId]['line_total'] +
$lineItems[$itemId]['tax_amount'];
1513 $submittedValues['tax_amount'] = $lineItems[$itemId]['tax_amount'];
1516 // CRM-10117 update the line items for participants.
1517 if (!empty($lineItems[$itemId]['price_field_id'])) {
1518 $lineItem[$this->_priceSetId
] = $lineItems;
1523 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1526 //CRM-11529 for quick config back office transactions
1527 //when financial_type_id is passed in form, update the
1528 //line items with the financial type selected in form
1529 // NOTE that this IS still a legitimate use of 'quick-config' for contributions under the current DB but
1530 // we should look at having a price field per contribution type & then there would be little reason
1531 // for the back-office contribution form postProcess to know if it is a quick-config form.
1532 if ($isQuickConfig && !empty($submittedValues['financial_type_id']) && CRM_Utils_Array
::value($this->_priceSetId
, $lineItem)
1534 foreach ($lineItem[$this->_priceSetId
] as &$values) {
1535 $values['financial_type_id'] = $submittedValues['financial_type_id'];
1539 if (!isset($submittedValues['total_amount'])) {
1540 $submittedValues['total_amount'] = CRM_Utils_Array
::value('total_amount', $this->_values
);
1542 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1544 $isEmpty = array_keys(array_flip($submittedValues['soft_credit_contact_id']));
1545 if ($this->_id
&& count($isEmpty) == 1 && key($isEmpty) == NULL) {
1546 //Delete existing soft credit records if soft credit list is empty on update
1547 CRM_Contribute_BAO_ContributionSoft
::del(array('contribution_id' => $this->_id
, 'pcp_id' => 0));
1550 // set the contact, when contact is selected
1551 if (!empty($submittedValues['contact_id'])) {
1552 $this->_contactID
= $submittedValues['contact_id'];
1555 $formValues = $submittedValues;
1557 // Credit Card Contribution.
1559 $paramsSetByPaymentProcessingSubsystem = array(
1561 'payment_instrument_id',
1562 'contribution_status_id',
1566 foreach ($paramsSetByPaymentProcessingSubsystem as $key) {
1567 if (isset($formValues[$key])) {
1568 unset($formValues[$key]);
1571 $contribution = $this->processCreditCard($formValues, $lineItem, $this->_contactID
);
1572 foreach ($paramsSetByPaymentProcessingSubsystem as $key) {
1573 $formValues[$key] = $contribution->$key;
1577 // Offline Contribution.
1578 $submittedValues = $this->unsetCreditCardFields($submittedValues);
1580 // get the required field value only.
1582 $params = $ids = array();
1584 $params['contact_id'] = $this->_contactID
;
1585 $params['currency'] = $this->getCurrency($submittedValues);
1587 //format soft-credit/pcp param first
1588 CRM_Contribute_BAO_ContributionSoft
::formatSoftCreditParams($submittedValues, $this);
1589 $params = array_merge($params, $submittedValues);
1592 'financial_type_id',
1593 'contribution_status_id',
1594 'payment_instrument_id',
1599 foreach ($fields as $f) {
1600 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1603 // CRM-5740 if priceset is used, no need to cleanup money.
1605 $params['skipCleanMoney'] = 1;
1614 foreach ($dates as $d) {
1615 $params[$d] = CRM_Utils_Date
::processDate($formValues[$d], $formValues[$d . '_time'], TRUE);
1618 if (!empty($formValues['is_email_receipt'])) {
1619 $params['receipt_date'] = date("Y-m-d");
1622 if ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Cancelled', 'name')
1623 ||
$params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Refunded', 'name')
1625 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value('cancel_date', $params))) {
1626 $params['cancel_date'] = date('Y-m-d');
1630 $params['cancel_date'] = $params['cancel_reason'] = 'null';
1633 // Set is_pay_later flag for back-office offline Pending status contributions CRM-8996
1634 // else if contribution_status is changed to Completed is_pay_later flag is changed to 0, CRM-15041
1635 if ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Pending', 'name')) {
1636 $params['is_pay_later'] = 1;
1638 elseif ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Completed', 'name')) {
1639 $params['is_pay_later'] = 0;
1642 $ids['contribution'] = $params['id'] = $this->_id
;
1644 // Add Additional common information to formatted params.
1645 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($formValues, $params, $this);
1647 $params['contribution_mode'] = 'participant';
1648 $params['participant_id'] = $pId;
1649 $params['skipLineItem'] = 1;
1651 elseif ($isRelatedId) {
1652 $params['contribution_mode'] = 'membership';
1654 $params['line_item'] = $lineItem;
1655 $params['payment_processor_id'] = $params['payment_processor'] = CRM_Utils_Array
::value('id', $this->_paymentProcessor
);
1656 if (isset($submittedValues['tax_amount'])) {
1657 $params['tax_amount'] = $submittedValues['tax_amount'];
1659 //create contribution.
1660 if ($isQuickConfig) {
1661 $params['is_quick_config'] = 1;
1663 $params['non_deductible_amount'] = $this->calculateNonDeductibleAmount($params, $formValues);
1665 // we are already handling note below, so to avoid duplicate notes against $contribution
1666 if (!empty($params['note']) && !empty($submittedValues['note'])) {
1667 unset($params['note']);
1669 $contribution = CRM_Contribute_BAO_Contribution
::create($params, $ids);
1671 // process associated membership / participant, CRM-4395
1672 if ($contribution->id
&& $action & CRM_Core_Action
::UPDATE
) {
1673 $this->statusMessage
[] = $this->updateRelatedComponent($contribution->id
,
1674 $contribution->contribution_status_id
,
1675 CRM_Utils_Array
::value('contribution_status_id',
1678 $contribution->receive_date
1682 array_unshift($this->statusMessage
, ts('The contribution record has been saved.'));
1684 $this->invoicingPostProcessHook($submittedValues, $action, $lineItem);
1686 //send receipt mail.
1687 if ($contribution->id
&& !empty($formValues['is_email_receipt'])) {
1688 $formValues['contact_id'] = $this->_contactID
;
1689 $formValues['contribution_id'] = $contribution->id
;
1691 $formValues +
= CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($contribution->id
);
1693 // to get 'from email id' for send receipt
1694 $this->fromEmailId
= $formValues['from_email_address'];
1695 if (CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $formValues)) {
1696 $this->statusMessage
[] = ts('A receipt has been emailed to the contributor.');
1700 $this->statusMessageTitle
= ts('Saved');
1704 if ($contribution->id
&& isset($formValues['product_name'][0])) {
1705 CRM_Contribute_Form_AdditionalInfo
::processPremium($submittedValues, $contribution->id
,
1706 $this->_premiumID
, $this->_options
1710 if ($contribution->id
&& !empty($submittedValues['note'])) {
1711 CRM_Contribute_Form_AdditionalInfo
::processNote($submittedValues, $this->_contactID
, $contribution->id
, $this->_noteID
);
1714 CRM_Core_Session
::setStatus(implode(' ', $this->statusMessage
), $this->statusMessageTitle
, 'success');
1716 CRM_Contribute_BAO_Contribution
::updateRelatedPledge(
1720 (CRM_Utils_Array
::value('option_type', $formValues) == 2) ?
TRUE : FALSE,
1721 $formValues['total_amount'],
1722 CRM_Utils_Array
::value('total_amount', $this->_defaults
),
1723 $formValues['contribution_status_id'],
1724 CRM_Utils_Array
::value('contribution_status_id', $this->_defaults
)
1726 return $contribution;
1730 * Assign tax calculations to contribution receipts.
1732 * @param array $submittedValues
1733 * @param int $action
1734 * @param array $lineItem
1736 protected function invoicingPostProcessHook($submittedValues, $action, $lineItem) {
1738 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
1739 if (!CRM_Utils_Array
::value('invoicing', $invoiceSettings)) {
1743 $getTaxDetails = FALSE;
1744 if ($action & CRM_Core_Action
::ADD
) {
1747 elseif ($action & CRM_Core_Action
::UPDATE
) {
1748 $line = $this->_lineItems
;
1750 foreach ($line as $key => $value) {
1751 foreach ($value as $v) {
1752 if (isset($taxRate[(string) CRM_Utils_Array
::value('tax_rate', $v)])) {
1753 $taxRate[(string) $v['tax_rate']] = $taxRate[(string) $v['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $v);
1756 if (isset($v['tax_rate'])) {
1757 $taxRate[(string) $v['tax_rate']] = CRM_Utils_Array
::value('tax_amount', $v);
1758 $getTaxDetails = TRUE;
1764 if ($action & CRM_Core_Action
::UPDATE
) {
1765 if (isset($submittedValues['tax_amount'])) {
1766 $totalTaxAmount = $submittedValues['tax_amount'];
1769 $totalTaxAmount = $this->_values
['tax_amount'];
1771 $this->assign('totalTaxAmount', $totalTaxAmount);
1772 $this->assign('dataArray', $taxRate);
1775 if (!empty($submittedValues['price_set_id'])) {
1776 $this->assign('totalTaxAmount', $submittedValues['tax_amount']);
1777 $this->assign('getTaxDetails', $getTaxDetails);
1778 $this->assign('dataArray', $taxRate);
1779 $this->assign('taxTerm', CRM_Utils_Array
::value('tax_term', $invoiceSettings));
1782 $this->assign('totalTaxAmount', CRM_Utils_Array
::value('tax_amount', $submittedValues));
1788 * Calculate non deductible amount.
1791 * if non_deductible_amount exists i.e. Additional Details field set was opened [and staff typed something] -
1792 * if non_deductible_amount does NOT exist - then calculate it depending on:
1793 * $financialType->is_deductible and whether there is a product (premium).
1796 * @param $formValues
1800 protected function calculateNonDeductibleAmount($params, $formValues) {
1801 if (!empty($params['non_deductible_amount'])) {
1802 return $params['non_deductible_amount'];
1805 $financialType = new CRM_Financial_DAO_FinancialType();
1806 $financialType->id
= $params['financial_type_id'];
1807 $financialType->find(TRUE);
1809 if ($financialType->is_deductible
) {
1811 if (isset($formValues['product_name'][0])) {
1812 $selectProduct = $formValues['product_name'][0];
1814 // if there is a product - compare the value to the contribution amount
1815 if (isset($selectProduct)) {
1816 $productDAO = new CRM_Contribute_DAO_Product();
1817 $productDAO->id
= $selectProduct;
1818 $productDAO->find(TRUE);
1819 // product value exceeds contribution amount
1820 if ($params['total_amount'] < $productDAO->price
) {
1821 return $params['total_amount'];
1823 // product value does NOT exceed contribution amount
1825 return $productDAO->price
;
1828 // contribution is deductible - but there is no product
1833 // contribution is NOT deductible
1835 return $params['total_amount'];