3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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 +--------------------------------------------------------------------+
29 * This class generates form components for processing a contribution.
31 class CRM_Contribute_Form_Contribution
extends CRM_Contribute_Form_AbstractEditPayment
{
33 * The id of the contribution that we are processing.
40 * The id of the premium that we are processing.
44 public $_premiumID = NULL;
47 * @var CRM_Contribute_DAO_ContributionProduct
49 public $_productDAO = NULL;
59 * The id of the contact associated with this contribution.
66 * The id of the pledge payment that we are processing.
73 * The id of the pledge that we are processing.
80 * Is this contribution associated with an online.
81 * financial transaction
85 public $_online = FALSE;
88 * Stores all product options.
95 * Storage of parameters from form
102 * Store the contribution Type ID
106 public $_contributionType;
109 * The contribution values if an existing contribution
114 * The pledge values if this contribution is associated with pledge
116 public $_pledgeValues;
118 public $_contributeMode = 'direct';
123 * Parameter with confusing name.
127 public $_compContext;
132 * Possible From email addresses
144 * Store the line items if price set used.
150 * @todo explain why we use lineItem & lineItems
156 * @var array soft credit info
158 public $_softCreditInfo;
160 protected $_formType;
163 * @todo what on earth does cdType stand for????
167 public $_honoreeProfileType;
170 * Array of billing panes to be displayed by billingBlock.tpl.
171 * Currently this is likely to look like
172 * array('Credit Card' => ts('Credit Card') or
173 * array('Direct Debit => ts('Direct Debit')
174 * @todo billing details (address stuff) to be added when we stop hard coding the panes in billingBlock.tpl
178 public $billingPane = array();
181 * Array of the payment fields to be displayed in the payment fieldset (pane) in billingBlock.tpl
182 * this contains all the information to describe these fields from quickform. See CRM_Core_Form_Payment getPaymentFormFieldsMetadata
186 public $_paymentFields = array();
188 * Logged in user's email.
201 * Price set as an array
208 * @todo can we define this a as protected? can we define higher up the chain
218 public $userDisplayName;
221 * Set variables up before form is built.
223 public function preProcess() {
225 // Check permission for action.
226 if (!CRM_Core_Permission
::checkActionPermission('CiviContribute', $this->_action
)) {
227 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
230 // @todo - if anyone ever figures out what this _cdType subroutine is about
231 // (or even if it still applies) please add comments!!!!!!!!!!
232 $this->_cdType
= CRM_Utils_Array
::value('type', $_GET);
233 $this->assign('cdType', FALSE);
234 if ($this->_cdType
) {
235 $this->assign('cdType', TRUE);
236 CRM_Custom_Form_CustomData
::preProcess($this);
240 $this->_formType
= CRM_Utils_Array
::value('formType', $_GET);
243 $this->_priceSetId
= CRM_Utils_Array
::value('priceSetId', $_GET);
244 $this->set('priceSetId', $this->_priceSetId
);
245 $this->assign('priceSetId', $this->_priceSetId
);
247 // Get the pledge payment id
248 $this->_ppID
= CRM_Utils_Request
::retrieve('ppid', 'Positive', $this);
250 // Get the contact id
251 $this->_contactID
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
254 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'add');
255 $this->assign('action', $this->_action
);
257 // Get the contribution id if update
258 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
259 if (!empty($this->_id
)) {
260 $this->assign('contribID', $this->_id
);
263 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
264 $this->assign('context', $this->_context
);
266 $this->_compId
= CRM_Utils_Request
::retrieve('compId', 'Positive', $this);
268 $this->_compContext
= CRM_Utils_Request
::retrieve('compContext', 'String', $this);
270 //set the contribution mode.
271 $this->_mode
= CRM_Utils_Request
::retrieve('mode', 'String', $this);
273 $this->assign('contributionMode', $this->_mode
);
274 if ($this->_action
& CRM_Core_Action
::DELETE
) {
278 $this->assign('showCheckNumber', TRUE);
280 $this->_fromEmails
= CRM_Core_BAO_Email
::getFromEmail();
281 $this->assignPaymentRelatedVariables();
283 if (in_array('CiviPledge', CRM_Core_Config
::singleton()->enableComponents
) && !$this->_formType
) {
284 $this->preProcessPledge();
288 $this->showRecordLinkMesssage($this->_id
);
290 $this->_values
= array();
292 // Current contribution id.
294 $this->assignPremiumProduct($this->_id
);
295 $this->buildValuesAndAssignOnline_Note_Type($this->_id
, $this->_values
);
298 // when custom data is included in this page
299 if (!empty($_POST['hidden_custom'])) {
300 $this->applyCustomData('Contribution', CRM_Utils_Array
::value('financial_type_id', $_POST), $this->_id
);
303 $this->_lineItems
= array();
305 if (!empty($this->_compId
) && $this->_compContext
== 'participant') {
306 $this->assign('compId', $this->_compId
);
307 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->_compId
);
310 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->_id
, 'contribution', 1, TRUE, TRUE);
312 empty($lineItem) ?
NULL : $this->_lineItems
[] = $lineItem;
315 $this->assign('lineItem', empty($this->_lineItems
) ?
FALSE : $this->_lineItems
);
319 $this->setPageTitle($this->_ppID ?
ts('Credit Card Pledge Payment') : ts('Credit Card Contribution'));
322 $this->setPageTitle($this->_ppID ?
ts('Pledge Payment') : ts('Contribution'));
326 CRM_Contribute_Form_SoftCredit
::preprocess($this);
331 * Set default values.
335 public function setDefaultValues() {
336 if ($this->_cdType
) {
337 // @todo document when this function would be called in this way
338 // (and whether it is valid or an overloading of this form).
339 return CRM_Custom_Form_CustomData
::setDefaultValues($this);
342 $defaults = $this->_values
;
344 // Set defaults for pledge payment.
346 $defaults['total_amount'] = CRM_Utils_Array
::value('scheduled_amount', $this->_pledgeValues
['pledgePayment']);
347 $defaults['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $this->_pledgeValues
);
348 $defaults['currency'] = CRM_Utils_Array
::value('currency', $this->_pledgeValues
);
349 $defaults['option_type'] = 1;
352 if ($this->_action
& CRM_Core_Action
::DELETE
) {
356 $defaults['frequency_interval'] = 1;
357 $defaults['frequency_unit'] = 'month';
359 // Set soft credit defaults.
360 CRM_Contribute_Form_SoftCredit
::setDefaultValues($defaults, $this);
363 $config = CRM_Core_Config
::singleton();
364 // Set default country from config if no country set.
365 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
366 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
369 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
370 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
373 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID
);
374 $defaults = array_merge($defaults, $billingDefaults);
378 $this->_contactID
= $defaults['contact_id'];
381 // Set $newCredit variable in template to control whether link to credit card mode is included.
382 $this->assign('newCredit', CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments());
384 // Fix the display of the monetary value, CRM-4038.
385 if (isset($defaults['total_amount'])) {
386 if (!empty($defaults['tax_amount'])) {
387 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
388 if (!(CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails))) {
389 $defaults['total_amount'] = CRM_Utils_Money
::format($defaults['total_amount'] - $defaults['tax_amount'], NULL, '%a');
393 $defaults['total_amount'] = CRM_Utils_Money
::format($defaults['total_amount'], NULL, '%a');
397 if (isset($defaults['non_deductible_amount'])) {
398 $defaults['non_deductible_amount'] = CRM_Utils_Money
::format($defaults['non_deductible_amount'], NULL, '%a');
401 if (isset($defaults['fee_amount'])) {
402 $defaults['fee_amount'] = CRM_Utils_Money
::format($defaults['fee_amount'], NULL, '%a');
405 if (isset($defaults['net_amount'])) {
406 $defaults['net_amount'] = CRM_Utils_Money
::format($defaults['net_amount'], NULL, '%a');
409 if ($this->_contributionType
) {
410 $defaults['financial_type_id'] = $this->_contributionType
;
413 if (empty($defaults['payment_instrument_id'])) {
414 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
417 if (!empty($defaults['is_test'])) {
418 $this->assign('is_test', TRUE);
421 $this->assign('showOption', TRUE);
422 // For Premium section.
423 if ($this->_premiumID
) {
424 $this->assign('showOption', FALSE);
425 $options = isset($this->_options
[$this->_productDAO
->product_id
]) ?
$this->_options
[$this->_productDAO
->product_id
] : "";
427 $this->assign('showOption', TRUE);
429 $options_key = CRM_Utils_Array
::key($this->_productDAO
->product_option
, $options);
431 $defaults['product_name'] = array($this->_productDAO
->product_id
, trim($options_key));
434 $defaults['product_name'] = array($this->_productDAO
->product_id
);
436 if ($this->_productDAO
->fulfilled_date
) {
437 list($defaults['fulfilled_date']) = CRM_Utils_Date
::setDateDefaults($this->_productDAO
->fulfilled_date
);
441 if (isset($this->userEmail
)) {
442 $this->assign('email', $this->userEmail
);
445 if (!empty($defaults['is_pay_later'])) {
446 $this->assign('is_pay_later', TRUE);
448 $this->assign('contribution_status_id', CRM_Utils_Array
::value('contribution_status_id', $defaults));
456 foreach ($dates as $key) {
457 if (!empty($defaults[$key])) {
458 list($defaults[$key], $defaults[$key . '_time'])
459 = CRM_Utils_Date
::setDateDefaults(CRM_Utils_Array
::value($key, $defaults), 'activityDateTime');
463 if (!$this->_id
&& empty($defaults['receive_date'])) {
464 list($defaults['receive_date'],
465 $defaults['receive_date_time']
466 ) = CRM_Utils_Date
::setDateDefaults(NULL, 'activityDateTime');
469 $this->assign('receive_date', CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('receive_date', $defaults),
470 CRM_Utils_Array
::value('receive_date_time', $defaults)
472 $currency = CRM_Utils_Array
::value('currency', $defaults);
473 $this->assign('currency', $currency);
474 // Hack to get currency info to the js layer. CRM-11440.
475 CRM_Utils_Money
::format(1);
476 $this->assign('currencySymbol', CRM_Utils_Array
::value($currency, CRM_Utils_Money
::$_currencySymbols));
477 $this->assign('totalAmount', CRM_Utils_Array
::value('total_amount', $defaults));
479 // Inherit campaign from pledge.
480 if ($this->_ppID
&& !empty($this->_pledgeValues
['campaign_id'])) {
481 $defaults['campaign_id'] = $this->_pledgeValues
['campaign_id'];
484 $this->_defaults
= $defaults;
489 * Build the form object.
491 public function buildQuickForm() {
492 //@todo document the purpose of cdType (if still in use)
493 if ($this->_cdType
) {
494 CRM_Custom_Form_CustomData
::buildQuickForm($this);
498 //tax rate from financialType
499 $this->assign('taxRates', json_encode(CRM_Core_PseudoConstant
::getTaxRates()));
500 $this->assign('currencies', json_encode(CRM_Core_OptionGroup
::values('currencies_enabled')));
502 // build price set form.
503 $buildPriceSet = FALSE;
504 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
505 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
506 $this->assign('invoicing', $invoicing);
508 // display tax amount on edit contribution page
509 if ($invoicing && $this->_action
& CRM_Core_Action
::UPDATE
&& isset($this->_values
['tax_amount'])) {
510 $this->assign('totalTaxAmount', $this->_values
['tax_amount']);
513 if (empty($this->_lineItems
) &&
514 ($this->_priceSetId ||
!empty($_POST['price_set_id']))
516 $buildPriceSet = TRUE;
517 $getOnlyPriceSetElements = TRUE;
518 if (!$this->_priceSetId
) {
519 $this->_priceSetId
= $_POST['price_set_id'];
520 $getOnlyPriceSetElements = FALSE;
523 $this->set('priceSetId', $this->_priceSetId
);
524 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
526 // get only price set form elements.
527 if ($getOnlyPriceSetElements) {
531 // use to build form during form rule.
532 $this->assign('buildPriceSet', $buildPriceSet);
534 $showAdditionalInfo = FALSE;
536 $defaults = $this->_values
;
537 $additionalDetailFields = array(
541 'non_deductible_amount',
545 foreach ($additionalDetailFields as $key) {
546 if (!empty($defaults[$key])) {
547 $defaults['hidden_AdditionalDetail'] = 1;
552 if ($this->_productDAO
) {
553 if ($this->_productDAO
->product_id
) {
554 $defaults['hidden_Premium'] = 1;
558 if ($this->_noteID
&&
559 isset($this->_values
['note'])
561 $defaults['hidden_AdditionalDetail'] = 1;
565 ts('Additional Details') => 'AdditionalDetail',
568 //Add Premium pane only if Premium is exists.
569 $dao = new CRM_Contribute_DAO_Product();
572 if ($dao->find(TRUE)) {
573 $paneNames[ts('Premium Information')] = 'Premium';
576 $billingPanes = array();
578 if (CRM_Core_Payment_Form
::buildPaymentForm($this, $this->_paymentProcessor
, FALSE, TRUE) == TRUE) {
579 $buildRecurBlock = TRUE;
580 foreach ($this->billingPane
as $name => $label) {
581 if (!empty($this->billingFieldSets
[$name]['fields'])) {
582 // @todo reduce variation so we don't have to convert 'credit_card' to 'CreditCard'
583 $billingPanes[$label] = $this->generatePane(CRM_Utils_String
::convertStringToCamel($name), $defaults);
589 foreach ($paneNames as $name => $type) {
590 $allPanes[$name] = $this->generatePane($type, $defaults);
592 if (empty($this->_recurPaymentProcessors
)) {
593 $buildRecurBlock = FALSE;
596 foreach ($this->_paymentProcessors
as $processor) {
597 if (!empty($processor['is_recur']) && !empty($processor['object']) && $processor['object']->supports('recurContributionsForPledges')) {
598 $buildRecurBlock = TRUE;
601 $buildRecurBlock = FALSE;
604 if ($buildRecurBlock) {
605 CRM_Contribute_Form_Contribution_Main
::buildRecur($this);
606 $this->setDefaults(array('is_recur' => 0));
608 $this->assign('buildRecurBlock', $buildRecurBlock);
609 $qfKey = $this->controller
->_key
;
610 $this->assign('qfKey', $qfKey);
611 $this->assign('billingPanes', $billingPanes);
612 $this->assign('allPanes', $allPanes);
614 $this->addFormRule(array('CRM_Contribute_Form_Contribution', 'formRule'), $this);
616 if ($this->_formType
) {
617 $this->assign('formType', $this->_formType
);
621 $this->applyFilter('__ALL__', 'trim');
623 if ($this->_action
& CRM_Core_Action
::DELETE
) {
624 $this->addButtons(array(
627 'name' => ts('Delete'),
628 'spacing' => ' ',
633 'name' => ts('Cancel'),
640 //need to assign custom data type and subtype to the template
641 $this->assign('customDataType', 'Contribution');
642 $this->assign('customDataSubType', $this->_contributionType
);
643 $this->assign('entityID', $this->_id
);
645 if ($this->_context
== 'standalone') {
646 $this->addEntityRef('contact_id', ts('Contact'), array(
648 'api' => array('extra' => array('email')),
652 $attributes = CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution');
654 $financialType = $this->add('select', 'financial_type_id',
655 ts('Financial Type'),
656 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::financialType(),
658 array('onChange' => "CRM.buildCustomData( 'Contribution', this.value );")
660 $paymentInstrument = FALSE;
662 $paymentInstrument = $this->add('select', 'payment_instrument_id',
664 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
665 TRUE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
669 $trxnId = $this->add('text', 'trxn_id', ts('Transaction ID'), array('class' => 'twelve') +
$attributes['trxn_id']);
671 //add receipt for offline contribution
672 $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
674 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
676 $status = CRM_Contribute_PseudoConstant
::contributionStatus();
678 // suppressing contribution statuses that are NOT relevant to pledges (CRM-5169)
679 $statusName = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
686 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
689 elseif ((!$this->_ppID
&& $this->_id
) ||
!$this->_id
) {
690 $suppressFlag = FALSE;
692 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
693 if (CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails)) {
694 $suppressFlag = TRUE;
697 if (!$suppressFlag) {
702 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
706 unset($status[CRM_Utils_Array
::key('Overdue', $statusName)]);
711 $contributionStatus = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_id
, 'contribution_status_id');
712 $name = CRM_Utils_Array
::value($contributionStatus, $statusName);
717 unset($status[CRM_Utils_Array
::key('In Progress', $statusName)]);
718 unset($status[CRM_Utils_Array
::key('Pending', $statusName)]);
719 unset($status[CRM_Utils_Array
::key('Failed', $statusName)]);
724 unset($status[CRM_Utils_Array
::key('Refunded', $statusName)]);
735 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
741 unset($status[CRM_Utils_Array
::key('Refunded', $statusName)]);
744 $this->add('select', 'contribution_status_id',
745 ts('Contribution Status'),
751 $this->addDateTime('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
753 if ($this->_online
) {
754 $this->assign('hideCalender', TRUE);
756 $checkNumber = $this->add('text', 'check_number', ts('Check Number'), $attributes['check_number']);
758 $this->addDateTime('receipt_date', ts('Receipt Date'), FALSE, array('formatType' => 'activityDateTime'));
759 $this->addDateTime('cancel_date', ts('Cancelled / Refunded Date'), FALSE, array('formatType' => 'activityDateTime'));
761 $this->add('textarea', 'cancel_reason', ts('Cancellation / Refund Reason'), $attributes['cancel_reason']);
764 if ($buildRecurBlock) {
765 $recurJs = array('onChange' => "buildRecurBlock( this.value ); return false;");
767 $element = $this->add('select',
768 'payment_processor_id',
769 ts('Payment Processor'),
775 if ($this->_online
) {
779 if (empty($this->_lineItems
)) {
780 $buildPriceSet = FALSE;
781 $priceSets = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviContribute');
782 if (!empty($priceSets) && !$this->_ppID
) {
783 $buildPriceSet = TRUE;
786 // don't allow price set for contribution if it is related to participant, or if it is a pledge payment
787 // and if we already have line items for that participant. CRM-5095
788 if ($buildPriceSet && $this->_id
) {
789 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
790 $pledgePaymentId = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
795 if ($pledgePaymentId) {
796 $buildPriceSet = FALSE;
798 if ($participantID = CRM_Utils_Array
::value('participant', $componentDetails)) {
799 $participantLI = CRM_Price_BAO_LineItem
::getLineItems($participantID);
800 if (!CRM_Utils_System
::isNull($participantLI)) {
801 $buildPriceSet = FALSE;
806 $hasPriceSets = FALSE;
807 if ($buildPriceSet) {
808 $hasPriceSets = TRUE;
809 // CRM-16451: set financial type of 'Price Set' in back office contribution
810 // instead of selecting manually
811 $financialTypeIds = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviContribute', 'financial_type_id');
812 $element = $this->add('select', 'price_set_id', ts('Choose price set'),
814 '' => ts('Choose price set'),
816 NULL, array('onchange' => "buildAmount( this.value, " . json_encode($financialTypeIds) . ");")
818 if ($this->_online
&& !($this->_action
& CRM_Core_Action
::UPDATE
)) {
822 $this->assign('hasPriceSets', $hasPriceSets);
823 $currencyFreeze = FALSE;
824 if (!($this->_action
& CRM_Core_Action
::UPDATE
)) {
825 if ($this->_online ||
$this->_ppID
) {
826 $attributes['total_amount'] = array_merge($attributes['total_amount'], array(
828 'style' => "background-color:#EBECE4",
830 $optionTypes = array(
831 '1' => ts('Adjust Pledge Payment Schedule?'),
832 '2' => ts('Adjust Total Pledge Amount?'),
834 $this->addRadio('option_type',
840 $currencyFreeze = TRUE;
844 $totalAmount = $this->addMoney('total_amount',
846 ($hasPriceSets) ?
FALSE : TRUE,
847 $attributes['total_amount'],
848 TRUE, 'currency', NULL, $currencyFreeze
852 $this->add('text', 'source', ts('Source'), CRM_Utils_Array
::value('source', $attributes));
854 // CRM-7362 --add campaigns.
855 CRM_Campaign_BAO_Campaign
::addCampaign($this, CRM_Utils_Array
::value('campaign_id', $this->_values
));
857 CRM_Contribute_Form_SoftCredit
::buildQuickForm($this);
861 $js = array('onclick' => "return verify( );");
864 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
867 $this->assign('outBound_option', $mailingInfo['outBound_option']);
869 $this->addButtons(array(
872 'name' => ts('Save'),
878 'name' => ts('Save and New'),
884 'name' => ts('Cancel'),
889 // if status is Cancelled freeze Amount, Payment Instrument, Check #, Financial Type,
890 // Net and Fee Amounts are frozen in AdditionalInfo::buildAdditionalDetail
891 if ($this->_id
&& $this->_values
['contribution_status_id'] == array_search('Cancelled', $statusName)) {
893 $totalAmount->freeze();
895 $checkNumber->freeze();
896 $paymentInstrument->freeze();
898 $financialType->freeze();
901 // if contribution is related to membership or participant freeze Financial Type, Amount
902 if ($this->_id
&& isset($this->_values
['tax_amount'])) {
903 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
904 if (CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails)) {
906 $totalAmount->freeze();
908 $financialType->freeze();
909 $this->assign('freezeFinancialType', TRUE);
913 if ($this->_action
& CRM_Core_Action
::VIEW
) {
921 * @param array $fields
922 * The input form values.
923 * @param array $files
924 * The uploaded files if any.
928 * true if no errors, else array of errors
930 public static function formRule($fields, $files, $self) {
932 // Check for Credit Card Contribution.
934 if (empty($fields['payment_processor_id'])) {
935 $errors['payment_processor_id'] = ts('Payment Processor is a required field.');
938 // validate payment instrument (e.g. credit card number)
939 CRM_Core_Payment_Form
::validatePaymentInstrument($fields['payment_processor_id'], $fields, $errors, $self);
943 // Do the amount validations.
944 if (empty($fields['total_amount']) && empty($self->_lineItems
)) {
945 if ($priceSetId = CRM_Utils_Array
::value('price_set_id', $fields)) {
946 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $fields, $errors);
950 $softErrors = CRM_Contribute_Form_SoftCredit
::formRule($fields, $errors, $self);
952 if (!empty($fields['total_amount']) && (!empty($fields['net_amount']) ||
!empty($fields['fee_amount']))) {
953 $sum = CRM_Utils_Rule
::cleanMoney($fields['net_amount']) + CRM_Utils_Rule
::cleanMoney($fields['fee_amount']);
954 // For taxable contribution we need to deduct taxable amount from
955 // (net amount + fee amount) before comparing it with total amount
956 if (!empty($self->_values
['tax_amount'])) {
957 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($self->_id
);
958 if (!(CRM_Utils_Array
::value('membership', $componentDetails) ||
959 CRM_Utils_Array
::value('participant', $componentDetails))
961 $sum = CRM_Utils_Money
::format($sum - $self->_values
['tax_amount'], NULL, '%a');
964 if (CRM_Utils_Rule
::cleanMoney($fields['total_amount']) != CRM_Utils_Rule
::cleanMoney($sum)) {
965 $errors['total_amount'] = ts('The sum of fee amount and net amount must be equal to total amount');
969 //CRM-16285 - Function to handle validation errors on form, for recurring contribution field.
970 CRM_Contribute_BAO_ContributionRecur
::validateRecurContribution($fields, $files, $self, $errors);
972 // Form rule for status http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
973 if (($self->_action
& CRM_Core_Action
::UPDATE
)
975 && $self->_values
['contribution_status_id'] != $fields['contribution_status_id']
977 CRM_Contribute_BAO_Contribution
::checkStatusValidation($self->_values
, $fields, $errors);
979 // CRM-16015, add form-rule to restrict change of financial type if using price field of different financial type
980 if (($self->_action
& CRM_Core_Action
::UPDATE
)
982 && $self->_values
['financial_type_id'] != $fields['financial_type_id']
984 CRM_Contribute_BAO_Contribution
::checkFinancialTypeChange(NULL, $self->_id
, $errors);
986 //FIXME FOR NEW DATA FLOW http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
987 if (!empty($fields['fee_amount']) && !empty($fields['financial_type_id']) && $financialType = CRM_Contribute_BAO_Contribution
::validateFinancialType($fields['financial_type_id'])) {
988 $errors['financial_type_id'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
991 // $trxn_id must be unique CRM-13919
992 if (!empty($fields['trxn_id'])) {
993 $queryParams = array(1 => array($fields['trxn_id'], 'String'));
994 $query = 'select count(*) from civicrm_contribution where trxn_id = %1';
996 $queryParams[2] = array((int) $self->_id
, 'Integer');
997 $query .= ' and id !=%2';
999 $tCnt = CRM_Core_DAO
::singleValueQuery($query, $queryParams);
1001 $errors['trxn_id'] = ts('Transaction ID\'s must be unique. Transaction \'%1\' already exists in your database.', array(1 => $fields['trxn_id']));
1005 $errors = array_merge($errors, $softErrors);
1010 * Process the form submission.
1012 public function postProcess() {
1013 $sendReceipt = $pId = $contribution = $isRelatedId = FALSE;
1014 $softParams = $softIDs = array();
1016 if ($this->_action
& CRM_Core_Action
::DELETE
) {
1017 CRM_Contribute_BAO_Contribution
::deleteContribution($this->_id
);
1018 CRM_Core_Session
::singleton()->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1019 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
1024 // Get the submitted form values.
1025 $submittedValues = $this->controller
->exportValues($this->_name
);
1026 if (!empty($submittedValues['price_set_id']) && $this->_action
& CRM_Core_Action
::UPDATE
) {
1027 $line = CRM_Price_BAO_LineItem
::getLineItems($this->_id
, 'contribution');
1028 $lineID = key($line);
1029 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', CRM_Utils_Array
::value('price_field_id', $line[$lineID]), 'price_set_id');
1030 $quickConfig = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
1032 CRM_Price_BAO_LineItem
::deleteLineItems($this->_id
, 'civicrm_contribution');
1036 // Process price set and get total amount and line items.
1037 $lineItem = array();
1038 $priceSetId = CRM_Utils_Array
::value('price_set_id', $submittedValues);
1039 if (empty($priceSetId) && !$this->_id
) {
1040 $this->_priceSetId
= $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_contribution_amount', 'id', 'name');
1041 $this->_priceSet
= current(CRM_Price_BAO_PriceSet
::getSetDetail($priceSetId));
1042 $fieldID = key($this->_priceSet
['fields']);
1043 $fieldValueId = key($this->_priceSet
['fields'][$fieldID]['options']);
1044 $this->_priceSet
['fields'][$fieldID]['options'][$fieldValueId]['amount'] = $submittedValues['total_amount'];
1045 $submittedValues['price_' . $fieldID] = 1;
1049 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
1050 $submittedValues, $lineItem[$priceSetId]);
1052 // Unset tax amount for offline 'is_quick_config' contribution.
1053 if ($this->_priceSet
['is_quick_config'] &&
1054 !array_key_exists($submittedValues['financial_type_id'], CRM_Core_PseudoConstant
::getTaxRates())
1056 unset($submittedValues['tax_amount']);
1058 $submittedValues['total_amount'] = CRM_Utils_Array
::value('amount', $submittedValues);
1061 if ($this->_compId
) {
1062 if ($this->_context
== 'participant') {
1063 $pId = $this->_compId
;
1065 elseif ($this->_context
== 'membership') {
1066 $isRelatedId = TRUE;
1069 $pId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id
, 'participant_id', 'contribution_id');
1073 $contributionDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
1074 if (array_key_exists('membership', $contributionDetails)) {
1075 $isRelatedId = TRUE;
1077 elseif (array_key_exists('participant', $contributionDetails)) {
1078 $pId = $contributionDetails['participant'];
1082 if (!$priceSetId && !empty($submittedValues['total_amount']) && $this->_id
) {
1083 // CRM-10117 update the line items for participants.
1085 $entityTable = 'participant';
1087 $isRelatedId = FALSE;
1088 $participantParams = array(
1089 'fee_amount' => $submittedValues['total_amount'],
1092 CRM_Event_BAO_Participant
::add($participantParams);
1093 if (empty($this->_lineItems
)) {
1094 $this->_lineItems
[] = CRM_Price_BAO_LineItem
::getLineItems($entityID, 'participant', 1);
1098 $entityTable = 'contribution';
1099 $entityID = $this->_id
;
1102 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($entityID, $entityTable, NULL, TRUE, $isRelatedId);
1103 foreach (array_keys($lineItems) as $id) {
1104 $lineItems[$id]['id'] = $id;
1106 $itemId = key($lineItems);
1107 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1108 $this->_priceSetId
= CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1111 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1112 //CRM-16833: Ensure tax is applied only once for membership conribution, when status changed.(e.g Pending to Completed).
1113 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
1114 if (!(CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails))) {
1115 if (!($this->_action
& CRM_Core_Action
::UPDATE
&& (($this->_defaults
['contribution_status_id'] != $submittedValues['contribution_status_id'])))) {
1116 $lineItems[$itemId]['unit_price'] = $lineItems[$itemId]['line_total'] = CRM_Utils_Rule
::cleanMoney(CRM_Utils_Array
::value('total_amount', $submittedValues));
1119 // Update line total and total amount with tax on edit.
1120 $financialItemsId = CRM_Core_PseudoConstant
::getTaxRates();
1121 if (array_key_exists($submittedValues['financial_type_id'], $financialItemsId)) {
1122 $lineItems[$itemId]['tax_rate'] = $financialItemsId[$submittedValues['financial_type_id']];
1125 $lineItems[$itemId]['tax_rate'] = $lineItems[$itemId]['tax_amount'] = "";
1126 $submittedValues['tax_amount'] = 'null';
1128 if ($lineItems[$itemId]['tax_rate']) {
1129 $lineItems[$itemId]['tax_amount'] = ($lineItems[$itemId]['tax_rate'] / 100) * $lineItems[$itemId]['line_total'];
1130 $submittedValues['total_amount'] = $lineItems[$itemId]['line_total'] +
$lineItems[$itemId]['tax_amount'];
1131 $submittedValues['tax_amount'] = $lineItems[$itemId]['tax_amount'];
1134 // CRM-10117 update the line items for participants.
1135 if (!empty($lineItems[$itemId]['price_field_id'])) {
1136 $lineItem[$this->_priceSetId
] = $lineItems;
1141 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1144 //CRM-11529 for quick config back office transactions
1145 //when financial_type_id is passed in form, update the
1146 //line items with the financial type selected in form
1147 if ($isQuickConfig && !empty($submittedValues['financial_type_id']) && CRM_Utils_Array
::value($this->_priceSetId
, $lineItem)
1149 foreach ($lineItem[$this->_priceSetId
] as &$values) {
1150 $values['financial_type_id'] = $submittedValues['financial_type_id'];
1154 if (!isset($submittedValues['total_amount'])) {
1155 $submittedValues['total_amount'] = CRM_Utils_Array
::value('total_amount', $this->_values
);
1157 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1159 if (!empty($submittedValues['pcp_made_through_id'])) {
1162 'pcp_made_through_id',
1163 'pcp_display_in_roll',
1164 'pcp_roll_nickname',
1165 'pcp_personal_note',
1167 foreach ($fields as $f) {
1168 $pcp[$f] = CRM_Utils_Array
::value($f, $submittedValues);
1172 $isEmpty = array_keys(array_flip($submittedValues['soft_credit_contact_id']));
1173 if ($this->_id
&& count($isEmpty) == 1 && key($isEmpty) == NULL) {
1174 //Delete existing soft credit records if soft credit list is empty on update
1175 CRM_Contribute_BAO_ContributionSoft
::del(array('contribution_id' => $this->_id
, 'pcp_id' => 0));
1178 //build soft credit params
1179 foreach ($submittedValues['soft_credit_contact_id'] as $key => $val) {
1180 if ($val && $submittedValues['soft_credit_amount'][$key]) {
1181 $softParams[$key]['contact_id'] = $val;
1182 $softParams[$key]['amount'] = CRM_Utils_Rule
::cleanMoney($submittedValues['soft_credit_amount'][$key]);
1183 $softParams[$key]['soft_credit_type_id'] = $submittedValues['soft_credit_type'][$key];
1184 if (!empty($submittedValues['soft_credit_id'][$key])) {
1185 $softIDs[] = $softParams[$key]['id'] = $submittedValues['soft_credit_id'][$key];
1191 // set the contact, when contact is selected
1192 if (!empty($submittedValues['contact_id'])) {
1193 $this->_contactID
= $submittedValues['contact_id'];
1196 // Credit Card Contribution.
1198 $this->processCreditCard($submittedValues, $lineItem);
1201 // Offline Contribution.
1202 $submittedValues = $this->unsetCreditCardFields($submittedValues);
1204 // get the required field value only.
1205 $formValues = $submittedValues;
1206 $params = $ids = array();
1208 $params['contact_id'] = $this->_contactID
;
1210 $params['currency'] = $this->getCurrency($submittedValues);
1213 'financial_type_id',
1214 'contribution_status_id',
1215 'payment_instrument_id',
1220 foreach ($fields as $f) {
1221 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1224 $params['pcp'] = !empty($pcp) ?
$pcp : NULL;
1225 $params['soft_credit'] = !empty($softParams) ?
$softParams : array();
1226 $params['soft_credit_ids'] = !empty($softIDs) ?
$softIDs : array();
1228 // CRM-5740 if priceset is used, no need to cleanup money.
1230 $params['skipCleanMoney'] = 1;
1239 foreach ($dates as $d) {
1240 $params[$d] = CRM_Utils_Date
::processDate($formValues[$d], $formValues[$d . '_time'], TRUE);
1243 if (!empty($formValues['is_email_receipt'])) {
1244 $params['receipt_date'] = date("Y-m-d");
1247 if ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Cancelled', 'name')
1248 ||
$params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Refunded', 'name')
1250 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value('cancel_date', $params))) {
1251 $params['cancel_date'] = date('Y-m-d');
1255 $params['cancel_date'] = $params['cancel_reason'] = 'null';
1258 // Set is_pay_later flag for back-office offline Pending status contributions CRM-8996
1259 // else if contribution_status is changed to Completed is_pay_later flag is changed to 0, CRM-15041
1260 if ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Pending', 'name')) {
1261 $params['is_pay_later'] = 1;
1263 elseif ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Completed', 'name')) {
1264 $params['is_pay_later'] = 0;
1267 $ids['contribution'] = $params['id'] = $this->_id
;
1269 // Add Additional common information to formatted params.
1270 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($formValues, $params, $this);
1272 $params['contribution_mode'] = 'participant';
1273 $params['participant_id'] = $pId;
1274 $params['skipLineItem'] = 1;
1276 elseif ($isRelatedId) {
1277 $params['contribution_mode'] = 'membership';
1279 $params['line_item'] = $lineItem;
1280 $params['payment_processor_id'] = $params['payment_processor'] = CRM_Utils_Array
::value('id', $this->_paymentProcessor
);
1281 if (isset($submittedValues['tax_amount'])) {
1282 $params['tax_amount'] = $submittedValues['tax_amount'];
1284 //create contribution.
1285 if ($isQuickConfig) {
1286 $params['is_quick_config'] = 1;
1290 // if non_deductible_amount exists i.e. Additional Details field set was opened [and staff typed something] -
1291 // if non_deductible_amount does NOT exist - then calculate it depending on:
1292 // $ContributionType->is_deductible and whether there is a product (premium).
1293 if (empty($params['non_deductible_amount'])) {
1294 $contributionType = new CRM_Financial_DAO_FinancialType();
1295 $contributionType->id
= $params['financial_type_id'];
1296 if (!$contributionType->find(TRUE)) {
1297 CRM_Core_Error
::fatal('Could not find a system table');
1299 if ($contributionType->is_deductible
) {
1301 if (isset($formValues['product_name'][0])) {
1302 $selectProduct = $formValues['product_name'][0];
1304 // if there is a product - compare the value to the contribution amount
1305 if (isset($selectProduct)) {
1306 $productDAO = new CRM_Contribute_DAO_Product();
1307 $productDAO->id
= $selectProduct;
1308 $productDAO->find(TRUE);
1309 // product value exceeds contribution amount
1310 if ($params['total_amount'] < $productDAO->price
) {
1311 $params['non_deductible_amount'] = $params['total_amount'];
1313 // product value does NOT exceed contribution amount
1315 $params['non_deductible_amount'] = $productDAO->price
;
1318 // contribution is deductible - but there is no product
1320 $params['non_deductible_amount'] = '0.00';
1323 // contribution is NOT deductible
1325 $params['non_deductible_amount'] = $params['total_amount'];
1329 $contribution = CRM_Contribute_BAO_Contribution
::create($params, $ids);
1331 // process associated membership / participant, CRM-4395
1332 $relatedComponentStatusMsg = NULL;
1333 if ($contribution->id
&& $this->_action
& CRM_Core_Action
::UPDATE
) {
1334 $relatedComponentStatusMsg = $this->updateRelatedComponent($contribution->id
,
1335 $contribution->contribution_status_id
,
1336 CRM_Utils_Array
::value('contribution_status_id',
1339 $contribution->receive_date
1344 if ($contribution->id
&& isset($formValues['note'])) {
1345 CRM_Contribute_Form_AdditionalInfo
::processNote($formValues, $this->_contactID
, $contribution->id
, $this->_noteID
);
1349 if ($contribution->id
&& isset($formValues['product_name'][0])) {
1350 CRM_Contribute_Form_AdditionalInfo
::processPremium($formValues, $contribution->id
,
1351 $this->_premiumID
, $this->_options
1355 // assign tax calculation for contribution receipts
1357 $getTaxDetails = FALSE;
1358 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
1359 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
1361 if ($this->_action
& CRM_Core_Action
::ADD
) {
1364 elseif ($this->_action
& CRM_Core_Action
::UPDATE
) {
1365 $line = $this->_lineItems
;
1367 foreach ($line as $key => $value) {
1368 foreach ($value as $v) {
1369 if (isset($taxRate[(string) CRM_Utils_Array
::value('tax_rate', $v)])) {
1370 $taxRate[(string) $v['tax_rate']] = $taxRate[(string) $v['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $v);
1373 if (isset($v['tax_rate'])) {
1374 $taxRate[(string) $v['tax_rate']] = CRM_Utils_Array
::value('tax_amount', $v);
1375 $getTaxDetails = TRUE;
1383 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
1384 if (isset($submittedValues['tax_amount'])) {
1385 $totalTaxAmount = $submittedValues['tax_amount'];
1388 $totalTaxAmount = $this->_values
['tax_amount'];
1390 $this->assign('totalTaxAmount', $totalTaxAmount);
1391 $this->assign('dataArray', $taxRate);
1394 if (!empty($submittedValues['price_set_id'])) {
1395 $this->assign('totalTaxAmount', $submittedValues['tax_amount']);
1396 $this->assign('getTaxDetails', $getTaxDetails);
1397 $this->assign('dataArray', $taxRate);
1398 $this->assign('taxTerm', CRM_Utils_Array
::value('tax_term', $invoiceSettings));
1401 $this->assign('totalTaxAmount', CRM_Utils_Array
::value('tax_amount', $submittedValues));
1406 //send receipt mail.
1407 if ($contribution->id
&& !empty($formValues['is_email_receipt'])) {
1408 $formValues['contact_id'] = $this->_contactID
;
1409 $formValues['contribution_id'] = $contribution->id
;
1411 $formValues +
= CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($contribution->id
);
1413 // to get 'from email id' for send receipt
1414 $this->fromEmailId
= $formValues['from_email_address'];
1415 $sendReceipt = CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $formValues);
1418 $pledgePaymentId = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1424 //update pledge payment status.
1425 if ((($this->_ppID
&& $contribution->id
) && $this->_action
& CRM_Core_Action
::ADD
) ||
1426 (($pledgePaymentId) && $this->_action
& CRM_Core_Action
::UPDATE
)
1430 //store contribution id in payment record.
1431 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $this->_ppID
, 'contribution_id', $contribution->id
);
1434 $this->_ppID
= CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1439 $this->_pledgeID
= CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1446 $adjustTotalAmount = FALSE;
1447 if (CRM_Utils_Array
::value('option_type', $formValues) == 2) {
1448 $adjustTotalAmount = TRUE;
1451 $updatePledgePaymentStatus = FALSE;
1452 //do only if either the status or the amount has changed
1453 if ($this->_action
& CRM_Core_Action
::ADD
) {
1454 $updatePledgePaymentStatus = TRUE;
1456 elseif ($this->_action
& CRM_Core_Action
::UPDATE
&& (($this->_defaults
['contribution_status_id'] != $formValues['contribution_status_id']) ||
1457 ($this->_defaults
['total_amount'] != $formValues['total_amount']))
1459 $updatePledgePaymentStatus = TRUE;
1462 if ($updatePledgePaymentStatus) {
1463 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($this->_pledgeID
,
1464 array($this->_ppID
),
1465 $contribution->contribution_status_id
,
1467 $contribution->total_amount
,
1473 $statusMsg = ts('The contribution record has been saved.');
1474 if (!empty($formValues['is_email_receipt']) && $sendReceipt) {
1475 $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
1478 if ($relatedComponentStatusMsg) {
1479 $statusMsg .= ' ' . $relatedComponentStatusMsg;
1482 CRM_Core_Session
::setStatus($statusMsg, ts('Saved'), 'success');
1483 //Offline Contribution ends.
1485 $session = CRM_Core_Session
::singleton();
1486 $buttonName = $this->controller
->getButtonName();
1487 if ($this->_context
== 'standalone') {
1488 if ($buttonName == $this->getButtonName('upload', 'new')) {
1489 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contribute/add',
1490 'reset=1&action=add&context=standalone'
1494 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1495 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
1499 elseif ($this->_context
== 'contribution' && $this->_mode
&& $buttonName == $this->getButtonName('upload', 'new')) {
1500 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
1501 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}&mode={$this->_mode}"
1504 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1505 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
1506 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}"
1510 //store contribution ID if not yet set (on create)
1511 if (empty($this->_id
) && !empty($contribution->id
)) {
1512 $this->_id
= $contribution->id
;
1517 * Process credit card payment.
1519 * @param array $submittedValues
1520 * @param array $lineItem
1522 * @throws CRM_Core_Exception
1524 protected function processCreditCard($submittedValues, $lineItem) {
1525 $sendReceipt = $contribution = FALSE;
1527 $unsetParams = array(
1529 'payment_instrument_id',
1530 'contribution_status_id',
1534 foreach ($unsetParams as $key) {
1535 if (isset($submittedValues[$key])) {
1536 unset($submittedValues[$key]);
1539 $isTest = ($this->_mode
== 'test') ?
1 : 0;
1540 // CRM-12680 set $_lineItem if its not set
1541 if (empty($this->_lineItem
) && !empty($lineItem)) {
1542 $this->_lineItem
= $lineItem;
1545 //Get the require fields value only.
1546 $params = $this->_params
= $submittedValues;
1548 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($this->_params
['payment_processor_id'],
1552 // Get the payment processor id as per mode.
1553 $this->_params
['payment_processor'] = $params['payment_processor_id']
1554 = $this->_params
['payment_processor_id'] = $submittedValues['payment_processor_id'] = $this->_paymentProcessor
['id'];
1556 $now = date('YmdHis');
1559 // we need to retrieve email address
1560 if ($this->_context
== 'standalone' && !empty($submittedValues['is_email_receipt'])) {
1561 list($this->userDisplayName
,
1563 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
1564 $this->assign('displayName', $this->userDisplayName
);
1567 // Set email for primary location.
1568 $fields['email-Primary'] = 1;
1569 $params['email-Primary'] = $this->userEmail
;
1571 // now set the values for the billing location.
1572 foreach (array_keys($this->_fields
) as $name) {
1576 // also add location name to the array
1577 $params["address_name-{$this->_bltID}"] = CRM_Utils_Array
::value('billing_first_name', $params) . ' ' . CRM_Utils_Array
::value('billing_middle_name', $params) . ' ' . CRM_Utils_Array
::value('billing_last_name', $params);
1579 $params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]);
1580 $fields["address_name-{$this->_bltID}"] = 1;
1581 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
1586 $nameFields = array('first_name', 'middle_name', 'last_name');
1587 foreach ($nameFields as $name) {
1589 if (array_key_exists("billing_$name", $params)) {
1590 $params[$name] = $params["billing_{$name}"];
1591 $params['preserveDBName'] = TRUE;
1595 if (!empty($params['source'])) {
1596 unset($params['source']);
1598 $contactID = CRM_Contact_BAO_Contact
::createProfileContact($params, $fields,
1604 // add all the additional payment params we need
1605 if (!empty($this->_params
["billing_state_province_id-{$this->_bltID}"])) {
1606 $this->_params
["state_province-{$this->_bltID}"] = $this->_params
["billing_state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($this->_params
["billing_state_province_id-{$this->_bltID}"]);
1608 if (!empty($this->_params
["billing_country_id-{$this->_bltID}"])) {
1609 $this->_params
["country-{$this->_bltID}"] = $this->_params
["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($this->_params
["billing_country_id-{$this->_bltID}"]);
1611 $legacyCreditCardExpiryCheck = FALSE;
1612 if ($this->_paymentProcessor
['payment_type'] & CRM_Core_Payment
::PAYMENT_TYPE_CREDIT_CARD
&& !isset($this->_paymentFields
)) {
1613 $legacyCreditCardExpiryCheck = TRUE;
1615 if ($legacyCreditCardExpiryCheck ||
in_array('credit_card_exp_date', array_keys($this->_paymentFields
))) {
1616 $this->_params
['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($this->_params
);
1617 $this->_params
['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($this->_params
);
1619 $this->_params
['ip_address'] = CRM_Utils_System
::ipAddress();
1620 $this->_params
['amount'] = $this->_params
['total_amount'];
1621 $this->_params
['amount_level'] = 0;
1622 $this->_params
['description'] = ts('Office Credit Card contribution');
1623 $this->_params
['currencyID'] = CRM_Utils_Array
::value('currency',
1625 CRM_Core_Config
::singleton()->defaultCurrency
1627 $this->_params
['payment_action'] = 'Sale';
1628 if (!empty($this->_params
['receive_date'])) {
1629 $this->_params
['receive_date'] = CRM_Utils_Date
::processDate($this->_params
['receive_date'], $this->_params
['receive_date_time']);
1632 if (!empty($params['soft_credit_to'])) {
1633 $this->_params
['soft_credit_to'] = $params['soft_credit_to'];
1634 $this->_params
['pcp_made_through_id'] = $params['pcp_made_through_id'];
1637 $this->_params
['pcp_display_in_roll'] = CRM_Utils_Array
::value('pcp_display_in_roll', $params);
1638 $this->_params
['pcp_roll_nickname'] = CRM_Utils_Array
::value('pcp_roll_nickname', $params);
1639 $this->_params
['pcp_personal_note'] = CRM_Utils_Array
::value('pcp_personal_note', $params);
1641 //Add common data to formatted params
1642 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($params, $this->_params
, $this);
1644 if (empty($this->_params
['invoice_id'])) {
1645 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1648 $this->_params
['invoiceID'] = $this->_params
['invoice_id'];
1651 // At this point we've created a contact and stored its address etc
1652 // all the payment processors expect the name and address to be in the
1653 // so we copy stuff over to first_name etc.
1654 $paymentParams = $this->_params
;
1655 $paymentParams['contactID'] = $this->_contactID
;
1656 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
1658 $contributionType = new CRM_Financial_DAO_FinancialType();
1659 $contributionType->id
= $params['financial_type_id'];
1660 $contributionType->find(TRUE);
1662 // Add some financial type details to the params list
1663 // if folks need to use it.
1664 $paymentParams['contributionType_name'] = $this->_params
['contributionType_name'] = $contributionType->name
;
1665 $paymentParams['contributionPageID'] = NULL;
1667 if (!empty($this->_params
['is_email_receipt'])) {
1668 $paymentParams['email'] = $this->userEmail
;
1669 $paymentParams['is_email_receipt'] = 1;
1672 $paymentParams['is_email_receipt'] = 0;
1673 $this->_params
['is_email_receipt'] = 0;
1675 if (!empty($this->_params
['receive_date'])) {
1676 $paymentParams['receive_date'] = $this->_params
['receive_date'];
1679 // For recurring contribution, create Contribution Record first.
1680 // Contribution ID, Recurring ID and Contact ID needed
1681 // When we get a callback from the payment processor, CRM-7115
1683 if (!empty($paymentParams['is_recur'])) {
1684 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1694 $paymentParams['contributionID'] = $contribution->id
;
1695 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1696 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1697 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1700 if ($paymentParams['amount'] > 0.0) {
1701 // force a re-get of the payment processor in case the form changed it, CRM-7179
1702 $payment = CRM_Core_Payment
::singleton($this->_mode
, $this->_paymentProcessor
, $this, TRUE);
1704 $result = $payment->doPayment($paymentParams, 'contribute');
1706 catch (CRM_Core_Exception
$e) {
1707 $message = ts("Payment Processor Error message") . $e->getMessage();
1708 $this->cleanupDBAfterPaymentFailure($paymentParams, $message);
1709 // Set the contribution mode.
1710 $urlParams = "action=add&cid={$this->_contactID}";
1712 $urlParams .= "&mode={$this->_mode}";
1714 if (!empty($this->_ppID
)) {
1715 $urlParams .= "&context=pledge&ppid={$this->_ppID}";
1717 CRM_Core_Error
::statusBounce($message, $urlParams, ts('Payment Processor Error'));
1721 $this->_params
= array_merge($this->_params
, $result);
1723 $this->_params
['receive_date'] = $now;
1725 if (!empty($this->_params
['is_email_receipt'])) {
1726 $this->_params
['receipt_date'] = $now;
1729 $this->_params
['receipt_date'] = CRM_Utils_Date
::processDate($this->_params
['receipt_date'],
1730 $params['receipt_date_time'], TRUE
1734 $this->set('params', $this->_params
);
1735 $this->assign('trxn_id', $result['trxn_id']);
1736 $this->assign('receive_date', $this->_params
['receive_date']);
1738 // Result has all the stuff we need
1739 // lets archive it to a financial transaction
1740 if ($contributionType->is_deductible
) {
1741 $this->assign('is_deductible', TRUE);
1742 $this->set('is_deductible', TRUE);
1745 // Set source if not set
1746 if (empty($this->_params
['source'])) {
1747 $userID = CRM_Core_Session
::singleton()->get('userID');
1748 $userSortName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $userID,
1751 $this->_params
['source'] = ts('Submit Credit Card Payment by: %1', array(1 => $userSortName));
1754 // Build custom data getFields array
1755 $customFieldsContributionType = CRM_Core_BAO_CustomField
::getFields('Contribution', FALSE, FALSE,
1756 CRM_Utils_Array
::value('financial_type_id', $params)
1758 $customFields = CRM_Utils_Array
::crmArrayMerge($customFieldsContributionType,
1759 CRM_Core_BAO_CustomField
::getFields('Contribution', FALSE, FALSE, NULL, NULL, TRUE)
1761 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
1766 if (empty($paymentParams['is_recur'])) {
1767 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1778 if (!empty($paymentParams['is_recur']) && is_array($result) && CRM_Utils_Array
::value('payment_status_id', $result) == 1) {
1780 civicrm_api3('contribution', 'completetransaction', array(
1781 'id' => $contribution->id
,
1782 'trxn_id' => CRM_Utils_Array
::value('trxn_id', $result),
1783 'is_transactional' => FALSE,
1785 // This has not been set to 1 in the DB - declare it here also
1786 $contribution->contribution_status_id
= 1;
1788 catch (CiviCRM_API3_Exception
$e) {
1789 if ($e->getErrorCode() != 'contribution_completed') {
1790 throw new CRM_Core_Exception('Failed to update contribution in database');
1794 // Send receipt mail. (if the complete transaction ran it will have sent it - so avoid 2
1795 // with the elseif. CRM-16926
1796 elseif ($contribution->id
&& !empty($this->_params
['is_email_receipt'])) {
1797 $this->_params
['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1798 $this->_params
['contact_id'] = $this->_contactID
;
1799 $this->_params
['contribution_id'] = $contribution->id
;
1800 $sendReceipt = CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $this->_params
, TRUE);
1804 if ($contribution->id
&& isset($params['note'])) {
1805 CRM_Contribute_Form_AdditionalInfo
::processNote($params, $contactID, $contribution->id
, NULL);
1808 if ($contribution->id
&& isset($params['product_name'][0])) {
1809 CRM_Contribute_Form_AdditionalInfo
::processPremium($params, $contribution->id
, NULL, $this->_options
);
1812 //update pledge payment status.
1813 if ($this->_ppID
&& $contribution->id
) {
1814 // Store contribution id in payment record.
1815 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $this->_ppID
, 'contribution_id', $contribution->id
);
1817 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($this->_pledgeID
,
1818 array($this->_ppID
),
1819 $contribution->contribution_status_id
,
1821 $contribution->total_amount
1825 if ($contribution->id
) {
1826 $statusMsg = ts('The contribution record has been processed.');
1827 if (!empty($this->_params
['is_email_receipt']) && $sendReceipt) {
1828 $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
1830 CRM_Core_Session
::setStatus($statusMsg, ts('Complete'), 'success');
1835 * Clean up DB after payment fails.
1837 * This function removes related DB entries. Note that it has been agreed in principle,
1838 * but not implemented, that contributions should be retained as 'Failed' rather than
1841 * @todo it doesn't clean up line items.
1843 * @param array $paymentParams
1844 * @param string $message
1846 public function cleanupDBAfterPaymentFailure($paymentParams, $message) {
1847 // Make sure to cleanup db for recurring case.
1848 if (!empty($paymentParams['contributionID'])) {
1849 CRM_Core_Error
::debug_log_message($message .
1850 "contact id={$this->_contactID} (deleting contribution {$paymentParams['contributionID']}");
1851 CRM_Contribute_BAO_Contribution
::deleteContribution($paymentParams['contributionID']);
1853 if (!empty($paymentParams['contributionRecurID'])) {
1854 CRM_Core_Error
::debug_log_message($message .
1855 "contact id={$this->_contactID} (deleting recurring contribution {$paymentParams['contributionRecurID']}");
1856 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($paymentParams['contributionRecurID']);
1861 * Generate the data to construct a snippet based pane.
1863 * This form also assigns the showAdditionalInfo var based on historical code.
1864 * This appears to mean 'there is a pane to show'.
1866 * @param string $type
1867 * Type of Pane - this is generally used to determine the function name used to build it
1868 * - e.g CreditCard, AdditionalDetail
1869 * @param array $defaults
1872 * We aim to further refactor & simplify this but currently
1874 * - should additional info be shown?
1876 protected function generatePane($type, $defaults) {
1877 $urlParams = "snippet=4&formType={$type}";
1879 $urlParams .= "&mode={$this->_mode}";
1883 if ($type == 'CreditCard' ||
1884 $type == 'DirectDebit'
1890 'url' => CRM_Utils_System
::url('civicrm/contact/view/contribution', $urlParams),
1895 // See if we need to include this paneName in the current form.
1896 if ($this->_formType
== $type ||
!empty($_POST["hidden_{$type}"]) ||
1897 CRM_Utils_Array
::value("hidden_{$type}", $defaults)
1899 $this->assign('showAdditionalInfo', TRUE);
1900 $pane['open'] = 'true';
1903 if ($type == 'CreditCard' ||
$type == 'DirectDebit') {
1904 // @todo would be good to align tpl name with form name...
1905 // @todo document why this hidden variable is required.
1906 $this->add('hidden', 'hidden_' . $type, 1);
1910 $additionalInfoFormFunction = 'build' . $type;
1911 CRM_Contribute_Form_AdditionalInfo
::$additionalInfoFormFunction($this);