3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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) {
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;
595 if ($buildRecurBlock) {
596 CRM_Contribute_Form_Contribution_Main
::buildRecur($this);
597 $this->setDefaults(array('is_recur' => 0));
599 $this->assign('buildRecurBlock', $buildRecurBlock);
600 $qfKey = $this->controller
->_key
;
601 $this->assign('qfKey', $qfKey);
602 $this->assign('billingPanes', $billingPanes);
603 $this->assign('allPanes', $allPanes);
605 $this->addFormRule(array('CRM_Contribute_Form_Contribution', 'formRule'), $this);
607 if ($this->_formType
) {
608 $this->assign('formType', $this->_formType
);
612 $this->applyFilter('__ALL__', 'trim');
614 if ($this->_action
& CRM_Core_Action
::DELETE
) {
615 $this->addButtons(array(
618 'name' => ts('Delete'),
619 'spacing' => ' ',
624 'name' => ts('Cancel'),
631 //need to assign custom data type and subtype to the template
632 $this->assign('customDataType', 'Contribution');
633 $this->assign('customDataSubType', $this->_contributionType
);
634 $this->assign('entityID', $this->_id
);
636 if ($this->_context
== 'standalone') {
637 $this->addEntityRef('contact_id', ts('Contact'), array(
639 'api' => array('extra' => array('email')),
643 $attributes = CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution');
645 $financialType = $this->add('select', 'financial_type_id',
646 ts('Financial Type'),
647 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::financialType(),
649 array('onChange' => "CRM.buildCustomData( 'Contribution', this.value );")
651 $paymentInstrument = FALSE;
653 $paymentInstrument = $this->add('select', 'payment_instrument_id',
655 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
656 TRUE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
660 $trxnId = $this->add('text', 'trxn_id', ts('Transaction ID'), array('class' => 'twelve') +
$attributes['trxn_id']);
662 //add receipt for offline contribution
663 $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
665 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
667 $status = CRM_Contribute_PseudoConstant
::contributionStatus();
669 // suppressing contribution statuses that are NOT relevant to pledges (CRM-5169)
670 $statusName = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
677 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
680 elseif ((!$this->_ppID
&& $this->_id
) ||
!$this->_id
) {
681 $suppressFlag = FALSE;
683 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
684 if (CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails)) {
685 $suppressFlag = TRUE;
688 if (!$suppressFlag) {
693 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
697 unset($status[CRM_Utils_Array
::key('Overdue', $statusName)]);
702 $contributionStatus = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_id
, 'contribution_status_id');
703 $name = CRM_Utils_Array
::value($contributionStatus, $statusName);
708 unset($status[CRM_Utils_Array
::key('In Progress', $statusName)]);
709 unset($status[CRM_Utils_Array
::key('Pending', $statusName)]);
710 unset($status[CRM_Utils_Array
::key('Failed', $statusName)]);
715 unset($status[CRM_Utils_Array
::key('Refunded', $statusName)]);
726 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
732 unset($status[CRM_Utils_Array
::key('Refunded', $statusName)]);
735 $this->add('select', 'contribution_status_id',
736 ts('Contribution Status'),
742 $this->addDateTime('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
744 if ($this->_online
) {
745 $this->assign('hideCalender', TRUE);
747 $checkNumber = $this->add('text', 'check_number', ts('Check Number'), $attributes['check_number']);
749 $this->addDateTime('receipt_date', ts('Receipt Date'), FALSE, array('formatType' => 'activityDateTime'));
750 $this->addDateTime('cancel_date', ts('Cancelled / Refunded Date'), FALSE, array('formatType' => 'activityDateTime'));
752 $this->add('textarea', 'cancel_reason', ts('Cancellation / Refund Reason'), $attributes['cancel_reason']);
755 if ($buildRecurBlock) {
756 $recurJs = array('onChange' => "buildRecurBlock( this.value ); return false;");
758 $element = $this->add('select',
759 'payment_processor_id',
760 ts('Payment Processor'),
766 if ($this->_online
) {
770 if (empty($this->_lineItems
)) {
771 $buildPriceSet = FALSE;
772 $priceSets = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviContribute');
773 if (!empty($priceSets) && !$this->_ppID
) {
774 $buildPriceSet = TRUE;
777 // don't allow price set for contribution if it is related to participant, or if it is a pledge payment
778 // and if we already have line items for that participant. CRM-5095
779 if ($buildPriceSet && $this->_id
) {
780 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
781 $pledgePaymentId = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
786 if ($pledgePaymentId) {
787 $buildPriceSet = FALSE;
789 if ($participantID = CRM_Utils_Array
::value('participant', $componentDetails)) {
790 $participantLI = CRM_Price_BAO_LineItem
::getLineItems($participantID);
791 if (!CRM_Utils_System
::isNull($participantLI)) {
792 $buildPriceSet = FALSE;
797 $hasPriceSets = FALSE;
798 if ($buildPriceSet) {
799 $hasPriceSets = TRUE;
800 $element = $this->add('select', 'price_set_id', ts('Choose price set'),
802 '' => ts('Choose price set'),
804 NULL, array('onchange' => "buildAmount( this.value );")
806 if ($this->_online
&& !($this->_action
& CRM_Core_Action
::UPDATE
)) {
810 $this->assign('hasPriceSets', $hasPriceSets);
811 $currencyFreeze = FALSE;
812 if (!($this->_action
& CRM_Core_Action
::UPDATE
)) {
813 if ($this->_online ||
$this->_ppID
) {
814 $attributes['total_amount'] = array_merge($attributes['total_amount'], array(
816 'style' => "background-color:#EBECE4",
818 $optionTypes = array(
819 '1' => ts('Adjust Pledge Payment Schedule?'),
820 '2' => ts('Adjust Total Pledge Amount?'),
822 $this->addRadio('option_type',
828 $currencyFreeze = TRUE;
832 $totalAmount = $this->addMoney('total_amount',
834 ($hasPriceSets) ?
FALSE : TRUE,
835 $attributes['total_amount'],
836 TRUE, 'currency', NULL, $currencyFreeze
840 $this->add('text', 'source', ts('Source'), CRM_Utils_Array
::value('source', $attributes));
842 // CRM-7362 --add campaigns.
843 CRM_Campaign_BAO_Campaign
::addCampaign($this, CRM_Utils_Array
::value('campaign_id', $this->_values
));
845 CRM_Contribute_Form_SoftCredit
::buildQuickForm($this);
849 $js = array('onclick' => "return verify( );");
852 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
855 $this->assign('outBound_option', $mailingInfo['outBound_option']);
857 $this->addButtons(array(
860 'name' => ts('Save'),
866 'name' => ts('Save and New'),
872 'name' => ts('Cancel'),
877 // if status is Cancelled freeze Amount, Payment Instrument, Check #, Financial Type,
878 // Net and Fee Amounts are frozen in AdditionalInfo::buildAdditionalDetail
879 if ($this->_id
&& $this->_values
['contribution_status_id'] == array_search('Cancelled', $statusName)) {
881 $totalAmount->freeze();
883 $checkNumber->freeze();
884 $paymentInstrument->freeze();
886 $financialType->freeze();
889 // if contribution is related to membership or participant freeze Financial Type, Amount
890 if ($this->_id
&& isset($this->_values
['tax_amount'])) {
891 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
892 if (CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails)) {
894 $totalAmount->freeze();
896 $financialType->freeze();
897 $this->assign('freezeFinancialType', TRUE);
901 if ($this->_action
& CRM_Core_Action
::VIEW
) {
909 * @param array $fields
910 * The input form values.
911 * @param array $files
912 * The uploaded files if any.
916 * true if no errors, else array of errors
918 public static function formRule($fields, $files, $self) {
921 // Check for Credit Card Contribution.
923 if (empty($fields['payment_processor_id'])) {
924 $errors['payment_processor_id'] = ts('Payment Processor is a required field.');
927 // validate payment instrument (e.g. credit card number)
928 CRM_Core_Payment_Form
::validatePaymentInstrument($fields['payment_processor_id'], $fields, $errors, $self);
932 // Do the amount validations.
933 if (empty($fields['total_amount']) && empty($self->_lineItems
)) {
934 if ($priceSetId = CRM_Utils_Array
::value('price_set_id', $fields)) {
935 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $fields, $errors);
939 $softErrors = CRM_Contribute_Form_SoftCredit
::formRule($fields, $errors, $self);
941 if (!empty($fields['total_amount']) && (!empty($fields['net_amount']) ||
!empty($fields['fee_amount']))) {
942 $sum = CRM_Utils_Rule
::cleanMoney($fields['net_amount']) + CRM_Utils_Rule
::cleanMoney($fields['fee_amount']);
943 if (CRM_Utils_Rule
::cleanMoney($fields['total_amount']) != $sum) {
944 $errors['total_amount'] = ts('The sum of fee amount and net amount must be equal to total amount');
947 // Form rule for status http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
948 if ($self->_id
&& $self->_values
['contribution_status_id'] != $fields['contribution_status_id']) {
949 CRM_Contribute_BAO_Contribution
::checkStatusValidation($self->_values
, $fields, $errors);
952 //FIXME FOR NEW DATA FLOW http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
953 if (!empty($fields['fee_amount']) && !empty($fields['financial_type_id']) && $financialType = CRM_Contribute_BAO_Contribution
::validateFinancialType($fields['financial_type_id'])) {
954 $errors['financial_type_id'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
957 // $trxn_id must be unique CRM-13919
958 if (!empty($fields['trxn_id'])) {
959 $queryParams = array(1 => array($fields['trxn_id'], 'String'));
960 $query = 'select count(*) from civicrm_contribution where trxn_id = %1';
962 $queryParams[2] = array((int) $self->_id
, 'Integer');
963 $query .= ' and id !=%2';
965 $tCnt = CRM_Core_DAO
::singleValueQuery($query, $queryParams);
967 $errors['trxn_id'] = ts('Transaction ID\'s must be unique. Transaction \'%1\' already exists in your database.', array(1 => $fields['trxn_id']));
971 $errors = array_merge($errors, $softErrors);
976 * Process the form submission.
978 public function postProcess() {
979 $sendReceipt = $pId = $contribution = $isRelatedId = FALSE;
980 $softParams = $softIDs = array();
982 if ($this->_action
& CRM_Core_Action
::DELETE
) {
983 CRM_Contribute_BAO_Contribution
::deleteContribution($this->_id
);
984 CRM_Core_Session
::singleton()->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
985 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
990 // Get the submitted form values.
991 $submittedValues = $this->controller
->exportValues($this->_name
);
992 if (!empty($submittedValues['price_set_id']) && $this->_action
& CRM_Core_Action
::UPDATE
) {
993 $line = CRM_Price_BAO_LineItem
::getLineItems($this->_id
, 'contribution');
994 $lineID = key($line);
995 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', CRM_Utils_Array
::value('price_field_id', $line[$lineID]), 'price_set_id');
996 $quickConfig = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
998 CRM_Price_BAO_LineItem
::deleteLineItems($this->_id
, 'civicrm_contribution');
1002 // Process price set and get total amount and line items.
1003 $lineItem = array();
1004 $priceSetId = CRM_Utils_Array
::value('price_set_id', $submittedValues);
1005 if (empty($priceSetId) && !$this->_id
) {
1006 $this->_priceSetId
= $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_contribution_amount', 'id', 'name');
1007 $this->_priceSet
= current(CRM_Price_BAO_PriceSet
::getSetDetail($priceSetId));
1008 $fieldID = key($this->_priceSet
['fields']);
1009 $fieldValueId = key($this->_priceSet
['fields'][$fieldID]['options']);
1010 $this->_priceSet
['fields'][$fieldID]['options'][$fieldValueId]['amount'] = $submittedValues['total_amount'];
1011 $submittedValues['price_' . $fieldID] = 1;
1015 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
1016 $submittedValues, $lineItem[$priceSetId]);
1018 // Unset tax amount for offline 'is_quick_config' contribution.
1019 if ($this->_priceSet
['is_quick_config'] &&
1020 !array_key_exists($submittedValues['financial_type_id'], CRM_Core_PseudoConstant
::getTaxRates())
1022 unset($submittedValues['tax_amount']);
1024 $submittedValues['total_amount'] = CRM_Utils_Array
::value('amount', $submittedValues);
1027 if ($this->_compId
) {
1028 if ($this->_context
== 'participant') {
1029 $pId = $this->_compId
;
1031 elseif ($this->_context
== 'membership') {
1032 $isRelatedId = TRUE;
1035 $pId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id
, 'participant_id', 'contribution_id');
1039 $contributionDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
1040 if (array_key_exists('membership', $contributionDetails)) {
1041 $isRelatedId = TRUE;
1043 elseif (array_key_exists('participant', $contributionDetails)) {
1044 $pId = current($contributionDetails['participant']);
1050 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1054 if (!$priceSetId && !empty($submittedValues['total_amount']) && $this->_id
) {
1055 // CRM-10117 update the line items for participants.
1057 $entityTable = 'participant';
1059 $isRelatedId = FALSE;
1060 $participantParams = array(
1061 'fee_amount' => $submittedValues['total_amount'],
1064 CRM_Event_BAO_Participant
::add($participantParams);
1065 if (empty($this->_lineItems
)) {
1066 $this->_lineItems
[] = CRM_Price_BAO_LineItem
::getLineItems($entityID, 'participant', 1);
1070 $entityTable = 'contribution';
1071 $entityID = $this->_id
;
1074 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($entityID, $entityTable, $isQuickConfig, $isRelatedId);
1075 foreach (array_keys($lineItems) as $id) {
1076 $lineItems[$id]['id'] = $id;
1078 $itemId = key($lineItems);
1079 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1080 $this->_priceSetId
= CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1083 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1084 $lineItems[$itemId]['unit_price'] = $lineItems[$itemId]['line_total'] = CRM_Utils_Rule
::cleanMoney(CRM_Utils_Array
::value('total_amount', $submittedValues));
1086 // Update line total and total amount with tax on edit.
1087 $financialItemsId = CRM_Core_PseudoConstant
::getTaxRates();
1088 if (array_key_exists($submittedValues['financial_type_id'], $financialItemsId)) {
1089 $lineItems[$itemId]['tax_rate'] = $financialItemsId[$submittedValues['financial_type_id']];
1092 $lineItems[$itemId]['tax_rate'] = $lineItems[$itemId]['tax_amount'] = "";
1093 $submittedValues['tax_amount'] = 'null';
1095 if ($lineItems[$itemId]['tax_rate']) {
1096 $lineItems[$itemId]['tax_amount'] = ($lineItems[$itemId]['tax_rate'] / 100) * $lineItems[$itemId]['line_total'];
1097 $submittedValues['total_amount'] = $lineItems[$itemId]['line_total'] +
$lineItems[$itemId]['tax_amount'];
1098 $submittedValues['tax_amount'] = $lineItems[$itemId]['tax_amount'];
1101 // CRM-10117 update the line items for participants.
1102 if (!empty($lineItems[$itemId]['price_field_id'])) {
1103 $lineItem[$this->_priceSetId
] = $lineItems;
1107 //CRM-11529 for quick config back office transactions
1108 //when financial_type_id is passed in form, update the
1109 //line items with the financial type selected in form
1110 if ($isQuickConfig && !empty($submittedValues['financial_type_id']) && CRM_Utils_Array
::value($this->_priceSetId
, $lineItem)
1112 foreach ($lineItem[$this->_priceSetId
] as &$values) {
1113 $values['financial_type_id'] = $submittedValues['financial_type_id'];
1117 if (!isset($submittedValues['total_amount'])) {
1118 $submittedValues['total_amount'] = CRM_Utils_Array
::value('total_amount', $this->_values
);
1120 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1122 if (!empty($submittedValues['pcp_made_through_id'])) {
1125 'pcp_made_through_id',
1126 'pcp_display_in_roll',
1127 'pcp_roll_nickname',
1128 'pcp_personal_note',
1130 foreach ($fields as $f) {
1131 $pcp[$f] = CRM_Utils_Array
::value($f, $submittedValues);
1135 $isEmpty = array_keys(array_flip($submittedValues['soft_credit_contact_id']));
1136 if ($this->_id
&& count($isEmpty) == 1 && key($isEmpty) == NULL) {
1137 //Delete existing soft credit records if soft credit list is empty on update
1138 CRM_Contribute_BAO_ContributionSoft
::del(array('contribution_id' => $this->_id
));
1141 //build soft credit params
1142 foreach ($submittedValues['soft_credit_contact_id'] as $key => $val) {
1143 if ($val && $submittedValues['soft_credit_amount'][$key]) {
1144 $softParams[$key]['contact_id'] = $val;
1145 $softParams[$key]['amount'] = CRM_Utils_Rule
::cleanMoney($submittedValues['soft_credit_amount'][$key]);
1146 $softParams[$key]['soft_credit_type_id'] = $submittedValues['soft_credit_type'][$key];
1147 if (!empty($submittedValues['soft_credit_id'][$key])) {
1148 $softIDs[] = $softParams[$key]['id'] = $submittedValues['soft_credit_id'][$key];
1154 // set the contact, when contact is selected
1155 if (!empty($submittedValues['contact_id'])) {
1156 $this->_contactID
= $submittedValues['contact_id'];
1159 // Credit Card Contribution.
1161 $this->processCreditCard($submittedValues, $lineItem);
1164 // Offline Contribution.
1165 $submittedValues = $this->unsetCreditCardFields($submittedValues);
1167 // get the required field value only.
1168 $formValues = $submittedValues;
1169 $params = $ids = array();
1171 $params['contact_id'] = $this->_contactID
;
1173 $params['currency'] = $this->getCurrency($submittedValues);
1176 'financial_type_id',
1177 'contribution_status_id',
1178 'payment_instrument_id',
1183 foreach ($fields as $f) {
1184 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1188 $params['pcp'] = $pcp;
1190 if (!empty($softParams)) {
1191 $params['soft_credit'] = $softParams;
1192 $params['soft_credit_ids'] = $softIDs;
1195 // CRM-5740 if priceset is used, no need to cleanup money.
1197 $params['skipCleanMoney'] = 1;
1206 foreach ($dates as $d) {
1207 $params[$d] = CRM_Utils_Date
::processDate($formValues[$d], $formValues[$d . '_time'], TRUE);
1210 if (!empty($formValues['is_email_receipt'])) {
1211 $params['receipt_date'] = date("Y-m-d");
1214 if ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Cancelled', 'name')
1215 ||
$params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Refunded', 'name')
1217 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value('cancel_date', $params))) {
1218 $params['cancel_date'] = date('Y-m-d');
1222 $params['cancel_date'] = $params['cancel_reason'] = 'null';
1225 // Set is_pay_later flag for back-office offline Pending status contributions CRM-8996
1226 // else if contribution_status is changed to Completed is_pay_later flag is changed to 0, CRM-15041
1227 if ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Pending', 'name')) {
1228 $params['is_pay_later'] = 1;
1230 elseif ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Completed', 'name')) {
1231 $params['is_pay_later'] = 0;
1234 $ids['contribution'] = $params['id'] = $this->_id
;
1236 // Add Additional common information to formatted params.
1237 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($formValues, $params, $this);
1239 $params['contribution_mode'] = 'participant';
1240 $params['participant_id'] = $pId;
1241 $params['skipLineItem'] = 1;
1243 elseif ($isRelatedId) {
1244 $params['contribution_mode'] = 'membership';
1246 $params['line_item'] = $lineItem;
1247 $params['payment_processor_id'] = $params['payment_processor'] = CRM_Utils_Array
::value('id', $this->_paymentProcessor
);
1248 if (isset($submittedValues['tax_amount'])) {
1249 $params['tax_amount'] = $submittedValues['tax_amount'];
1251 //create contribution.
1252 if ($isQuickConfig) {
1253 $params['is_quick_config'] = 1;
1257 // if non_deductible_amount exists i.e. Additional Details field set was opened [and staff typed something] -
1258 // if non_deductible_amount does NOT exist - then calculate it depending on:
1259 // $ContributionType->is_deductible and whether there is a product (premium).
1260 if (empty($params['non_deductible_amount'])) {
1261 $contributionType = new CRM_Financial_DAO_FinancialType();
1262 $contributionType->id
= $params['financial_type_id'];
1263 if (!$contributionType->find(TRUE)) {
1264 CRM_Core_Error
::fatal('Could not find a system table');
1266 if ($contributionType->is_deductible
) {
1268 if (isset($formValues['product_name'][0])) {
1269 $selectProduct = $formValues['product_name'][0];
1271 // if there is a product - compare the value to the contribution amount
1272 if (isset($selectProduct)) {
1273 $productDAO = new CRM_Contribute_DAO_Product();
1274 $productDAO->id
= $selectProduct;
1275 $productDAO->find(TRUE);
1276 // product value exceeds contribution amount
1277 if ($params['total_amount'] < $productDAO->price
) {
1278 $params['non_deductible_amount'] = $params['total_amount'];
1280 // product value does NOT exceed contribution amount
1282 $params['non_deductible_amount'] = $productDAO->price
;
1285 // contribution is deductible - but there is no product
1287 $params['non_deductible_amount'] = '0.00';
1290 // contribution is NOT deductible
1292 $params['non_deductible_amount'] = $params['total_amount'];
1296 $contribution = CRM_Contribute_BAO_Contribution
::create($params, $ids);
1298 // process associated membership / participant, CRM-4395
1299 $relatedComponentStatusMsg = NULL;
1300 if ($contribution->id
&& $this->_action
& CRM_Core_Action
::UPDATE
) {
1301 $relatedComponentStatusMsg = $this->updateRelatedComponent($contribution->id
,
1302 $contribution->contribution_status_id
,
1303 CRM_Utils_Array
::value('contribution_status_id',
1310 if ($contribution->id
&& isset($formValues['note'])) {
1311 CRM_Contribute_Form_AdditionalInfo
::processNote($formValues, $this->_contactID
, $contribution->id
, $this->_noteID
);
1315 if ($contribution->id
&& isset($formValues['product_name'][0])) {
1316 CRM_Contribute_Form_AdditionalInfo
::processPremium($formValues, $contribution->id
,
1317 $this->_premiumID
, $this->_options
1321 // assign tax calculation for contribution receipts
1323 $getTaxDetails = FALSE;
1324 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
1325 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
1327 if ($this->_action
& CRM_Core_Action
::ADD
) {
1330 elseif ($this->_action
& CRM_Core_Action
::UPDATE
) {
1331 $line = $this->_lineItems
;
1333 foreach ($line as $key => $value) {
1334 foreach ($value as $v) {
1335 if (isset($taxRate[(string) CRM_Utils_Array
::value('tax_rate', $v)])) {
1336 $taxRate[(string) $v['tax_rate']] = $taxRate[(string) $v['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $v);
1339 if (isset($v['tax_rate'])) {
1340 $taxRate[(string) $v['tax_rate']] = CRM_Utils_Array
::value('tax_amount', $v);
1341 $getTaxDetails = TRUE;
1349 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
1350 if (isset($submittedValues['tax_amount'])) {
1351 $totalTaxAmount = $submittedValues['tax_amount'];
1354 $totalTaxAmount = $this->_values
['tax_amount'];
1356 $this->assign('totalTaxAmount', $totalTaxAmount);
1357 $this->assign('dataArray', $taxRate);
1360 if (!empty($submittedValues['price_set_id'])) {
1361 $this->assign('totalTaxAmount', $submittedValues['tax_amount']);
1362 $this->assign('getTaxDetails', $getTaxDetails);
1363 $this->assign('dataArray', $taxRate);
1364 $this->assign('taxTerm', CRM_Utils_Array
::value('tax_term', $invoiceSettings));
1367 $this->assign('totalTaxAmount', CRM_Utils_Array
::value('tax_amount', $submittedValues));
1372 //send receipt mail.
1373 if ($contribution->id
&& !empty($formValues['is_email_receipt'])) {
1374 $formValues['contact_id'] = $this->_contactID
;
1375 $formValues['contribution_id'] = $contribution->id
;
1377 $formValues +
= CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($contribution->id
);
1379 // to get 'from email id' for send receipt
1380 $this->fromEmailId
= $formValues['from_email_address'];
1381 $sendReceipt = CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $formValues);
1384 $pledgePaymentId = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1390 //update pledge payment status.
1391 if ((($this->_ppID
&& $contribution->id
) && $this->_action
& CRM_Core_Action
::ADD
) ||
1392 (($pledgePaymentId) && $this->_action
& CRM_Core_Action
::UPDATE
)
1396 //store contribution id in payment record.
1397 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $this->_ppID
, 'contribution_id', $contribution->id
);
1400 $this->_ppID
= CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1405 $this->_pledgeID
= CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1412 $adjustTotalAmount = FALSE;
1413 if (CRM_Utils_Array
::value('option_type', $formValues) == 2) {
1414 $adjustTotalAmount = TRUE;
1417 $updatePledgePaymentStatus = FALSE;
1418 //do only if either the status or the amount has changed
1419 if ($this->_action
& CRM_Core_Action
::ADD
) {
1420 $updatePledgePaymentStatus = TRUE;
1422 elseif ($this->_action
& CRM_Core_Action
::UPDATE
&& (($this->_defaults
['contribution_status_id'] != $formValues['contribution_status_id']) ||
1423 ($this->_defaults
['total_amount'] != $formValues['total_amount']))
1425 $updatePledgePaymentStatus = TRUE;
1428 if ($updatePledgePaymentStatus) {
1429 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($this->_pledgeID
,
1430 array($this->_ppID
),
1431 $contribution->contribution_status_id
,
1433 $contribution->total_amount
,
1439 $statusMsg = ts('The contribution record has been saved.');
1440 if (!empty($formValues['is_email_receipt']) && $sendReceipt) {
1441 $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
1444 if ($relatedComponentStatusMsg) {
1445 $statusMsg .= ' ' . $relatedComponentStatusMsg;
1448 CRM_Core_Session
::setStatus($statusMsg, ts('Saved'), 'success');
1449 //Offline Contribution ends.
1451 $session = CRM_Core_Session
::singleton();
1452 $buttonName = $this->controller
->getButtonName();
1453 if ($this->_context
== 'standalone') {
1454 if ($buttonName == $this->getButtonName('upload', 'new')) {
1455 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contribute/add',
1456 'reset=1&action=add&context=standalone'
1460 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1461 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
1465 elseif ($this->_context
== 'contribution' && $this->_mode
&& $buttonName == $this->getButtonName('upload', 'new')) {
1466 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
1467 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}&mode={$this->_mode}"
1470 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1471 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
1472 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}"
1476 //store contribution ID if not yet set (on create)
1477 if (empty($this->_id
) && !empty($contribution->id
)) {
1478 $this->_id
= $contribution->id
;
1483 * Process credit card payment.
1485 * @param array $submittedValues
1486 * @param array $lineItem
1488 * @throws CRM_Core_Exception
1490 protected function processCreditCard($submittedValues, $lineItem) {
1491 $sendReceipt = $contribution = FALSE;
1493 $unsetParams = array(
1495 'payment_instrument_id',
1496 'contribution_status_id',
1500 foreach ($unsetParams as $key) {
1501 if (isset($submittedValues[$key])) {
1502 unset($submittedValues[$key]);
1505 $isTest = ($this->_mode
== 'test') ?
1 : 0;
1506 // CRM-12680 set $_lineItem if its not set
1507 if (empty($this->_lineItem
) && !empty($lineItem)) {
1508 $this->_lineItem
= $lineItem;
1511 //Get the require fields value only.
1512 $params = $this->_params
= $submittedValues;
1514 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($this->_params
['payment_processor_id'],
1518 // Get the payment processor id as per mode.
1519 $this->_params
['payment_processor'] = $params['payment_processor_id']
1520 = $this->_params
['payment_processor_id'] = $submittedValues['payment_processor_id'] = $this->_paymentProcessor
['id'];
1522 $now = date('YmdHis');
1525 // we need to retrieve email address
1526 if ($this->_context
== 'standalone' && !empty($submittedValues['is_email_receipt'])) {
1527 list($this->userDisplayName
,
1529 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
1530 $this->assign('displayName', $this->userDisplayName
);
1533 // Set email for primary location.
1534 $fields['email-Primary'] = 1;
1535 $params['email-Primary'] = $this->userEmail
;
1537 // now set the values for the billing location.
1538 foreach (array_keys($this->_fields
) as $name) {
1542 // also add location name to the array
1543 $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);
1545 $params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]);
1546 $fields["address_name-{$this->_bltID}"] = 1;
1547 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
1552 $nameFields = array('first_name', 'middle_name', 'last_name');
1553 foreach ($nameFields as $name) {
1555 if (array_key_exists("billing_$name", $params)) {
1556 $params[$name] = $params["billing_{$name}"];
1557 $params['preserveDBName'] = TRUE;
1561 if (!empty($params['source'])) {
1562 unset($params['source']);
1564 $contactID = CRM_Contact_BAO_Contact
::createProfileContact($params, $fields,
1570 // add all the additional payment params we need
1571 if (!empty($this->_params
["billing_state_province_id-{$this->_bltID}"])) {
1572 $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}"]);
1574 if (!empty($this->_params
["billing_country_id-{$this->_bltID}"])) {
1575 $this->_params
["country-{$this->_bltID}"] = $this->_params
["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($this->_params
["billing_country_id-{$this->_bltID}"]);
1577 $legacyCreditCardExpiryCheck = FALSE;
1578 if ($this->_paymentProcessor
['payment_type'] & CRM_Core_Payment
::PAYMENT_TYPE_CREDIT_CARD
&& !isset($this->_paymentFields
)) {
1579 $legacyCreditCardExpiryCheck = TRUE;
1581 if ($legacyCreditCardExpiryCheck ||
in_array('credit_card_exp_date', array_keys($this->_paymentFields
))) {
1582 $this->_params
['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($this->_params
);
1583 $this->_params
['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($this->_params
);
1585 $this->_params
['ip_address'] = CRM_Utils_System
::ipAddress();
1586 $this->_params
['amount'] = $this->_params
['total_amount'];
1587 $this->_params
['amount_level'] = 0;
1588 $this->_params
['description'] = ts('Office Credit Card contribution');
1589 $this->_params
['currencyID'] = CRM_Utils_Array
::value('currency',
1591 CRM_Core_Config
::singleton()->defaultCurrency
1593 $this->_params
['payment_action'] = 'Sale';
1594 if (!empty($this->_params
['receive_date'])) {
1595 $this->_params
['receive_date'] = CRM_Utils_Date
::processDate($this->_params
['receive_date'], $this->_params
['receive_date_time']);
1598 if (!empty($params['soft_credit_to'])) {
1599 $this->_params
['soft_credit_to'] = $params['soft_credit_to'];
1600 $this->_params
['pcp_made_through_id'] = $params['pcp_made_through_id'];
1603 $this->_params
['pcp_display_in_roll'] = CRM_Utils_Array
::value('pcp_display_in_roll', $params);
1604 $this->_params
['pcp_roll_nickname'] = CRM_Utils_Array
::value('pcp_roll_nickname', $params);
1605 $this->_params
['pcp_personal_note'] = CRM_Utils_Array
::value('pcp_personal_note', $params);
1607 //Add common data to formatted params
1608 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($params, $this->_params
, $this);
1610 if (empty($this->_params
['invoice_id'])) {
1611 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1614 $this->_params
['invoiceID'] = $this->_params
['invoice_id'];
1617 // At this point we've created a contact and stored its address etc
1618 // all the payment processors expect the name and address to be in the
1619 // so we copy stuff over to first_name etc.
1620 $paymentParams = $this->_params
;
1621 $paymentParams['contactID'] = $this->_contactID
;
1622 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
1624 $contributionType = new CRM_Financial_DAO_FinancialType();
1625 $contributionType->id
= $params['financial_type_id'];
1627 // Add some financial type details to the params list
1628 // if folks need to use it.
1629 $paymentParams['contributionType_name'] = $this->_params
['contributionType_name'] = $contributionType->name
;
1630 $paymentParams['contributionPageID'] = NULL;
1632 if (!empty($this->_params
['is_email_receipt'])) {
1633 $paymentParams['email'] = $this->userEmail
;
1634 $paymentParams['is_email_receipt'] = 1;
1637 $paymentParams['is_email_receipt'] = 0;
1638 $this->_params
['is_email_receipt'] = 0;
1640 if (!empty($this->_params
['receive_date'])) {
1641 $paymentParams['receive_date'] = $this->_params
['receive_date'];
1644 // For recurring contribution, create Contribution Record first.
1645 // Contribution ID, Recurring ID and Contact ID needed
1646 // When we get a callback from the payment processor, CRM-7115
1648 if (!empty($paymentParams['is_recur'])) {
1649 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1659 $paymentParams['contributionID'] = $contribution->id
;
1660 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1661 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1662 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1665 if ($paymentParams['amount'] > 0.0) {
1666 // force a re-get of the payment processor in case the form changed it, CRM-7179
1667 $payment = CRM_Core_Payment
::singleton($this->_mode
, $this->_paymentProcessor
, $this, TRUE);
1669 $result = $payment->doPayment($paymentParams, 'contribute');
1671 catch (CRM_Core_Exception
$e) {
1672 $message = ts("Payment Processor Error message") . $e->getMessage();
1673 $this->cleanupDBAfterPaymentFailure($paymentParams, $message);
1674 // Set the contribution mode.
1675 $urlParams = "action=add&cid={$this->_contactID}";
1677 $urlParams .= "&mode={$this->_mode}";
1679 if (!empty($this->_ppID
)) {
1680 $urlParams .= "&context=pledge&ppid={$this->_ppID}";
1682 CRM_Core_Error
::statusBounce($message, $urlParams, ts('Payment Processor Error'));
1686 $this->_params
= array_merge($this->_params
, $result);
1688 $this->_params
['receive_date'] = $now;
1690 if (!empty($this->_params
['is_email_receipt'])) {
1691 $this->_params
['receipt_date'] = $now;
1694 $this->_params
['receipt_date'] = CRM_Utils_Date
::processDate($this->_params
['receipt_date'],
1695 $params['receipt_date_time'], TRUE
1699 $this->set('params', $this->_params
);
1700 $this->assign('trxn_id', $result['trxn_id']);
1701 $this->assign('receive_date', $this->_params
['receive_date']);
1703 // Result has all the stuff we need
1704 // lets archive it to a financial transaction
1705 if ($contributionType->is_deductible
) {
1706 $this->assign('is_deductible', TRUE);
1707 $this->set('is_deductible', TRUE);
1710 // Set source if not set
1711 if (empty($this->_params
['source'])) {
1712 $userID = CRM_Core_Session
::singleton()->get('userID');
1713 $userSortName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $userID,
1716 $this->_params
['source'] = ts('Submit Credit Card Payment by: %1', array(1 => $userSortName));
1719 // Build custom data getFields array
1720 $customFieldsContributionType = CRM_Core_BAO_CustomField
::getFields('Contribution', FALSE, FALSE,
1721 CRM_Utils_Array
::value('financial_type_id', $params)
1723 $customFields = CRM_Utils_Array
::crmArrayMerge($customFieldsContributionType,
1724 CRM_Core_BAO_CustomField
::getFields('Contribution', FALSE, FALSE, NULL, NULL, TRUE)
1726 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
1731 if (empty($paymentParams['is_recur'])) {
1732 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1743 // Send receipt mail.
1744 if ($contribution->id
&& !empty($this->_params
['is_email_receipt'])) {
1745 $this->_params
['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1746 $this->_params
['contact_id'] = $this->_contactID
;
1747 $this->_params
['contribution_id'] = $contribution->id
;
1748 $sendReceipt = CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $this->_params
, TRUE);
1752 if ($contribution->id
&& isset($params['note'])) {
1753 CRM_Contribute_Form_AdditionalInfo
::processNote($params, $contactID, $contribution->id
, NULL);
1756 if ($contribution->id
&& isset($params['product_name'][0])) {
1757 CRM_Contribute_Form_AdditionalInfo
::processPremium($params, $contribution->id
, NULL, $this->_options
);
1760 //update pledge payment status.
1761 if ($this->_ppID
&& $contribution->id
) {
1762 // Store contribution id in payment record.
1763 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $this->_ppID
, 'contribution_id', $contribution->id
);
1765 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($this->_pledgeID
,
1766 array($this->_ppID
),
1767 $contribution->contribution_status_id
,
1769 $contribution->total_amount
1773 if ($contribution->id
) {
1774 $statusMsg = ts('The contribution record has been processed.');
1775 if (!empty($this->_params
['is_email_receipt']) && $sendReceipt) {
1776 $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
1778 CRM_Core_Session
::setStatus($statusMsg, ts('Complete'), 'success');
1783 * Clean up DB after payment fails.
1785 * This function removes related DB entries. Note that it has been agreed in principle,
1786 * but not implemented, that contributions should be retained as 'Failed' rather than
1789 * @todo it doesn't clean up line items.
1791 * @param array $paymentParams
1792 * @param string $message
1794 public function cleanupDBAfterPaymentFailure($paymentParams, $message) {
1795 // Make sure to cleanup db for recurring case.
1796 if (!empty($paymentParams['contributionID'])) {
1797 CRM_Core_Error
::debug_log_message($message .
1798 "contact id={$this->_contactID} (deleting contribution {$paymentParams['contributionID']}");
1799 CRM_Contribute_BAO_Contribution
::deleteContribution($paymentParams['contributionID']);
1801 if (!empty($paymentParams['contributionRecurID'])) {
1802 CRM_Core_Error
::debug_log_message($message .
1803 "contact id={$this->_contactID} (deleting recurring contribution {$paymentParams['contributionRecurID']}");
1804 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($paymentParams['contributionRecurID']);
1809 * Generate the data to construct a snippet based pane.
1811 * This form also assigns the showAdditionalInfo var based on historical code.
1812 * This appears to mean 'there is a pane to show'.
1814 * @param string $type
1815 * Type of Pane - this is generally used to determine the function name used to build it
1816 * - e.g CreditCard, AdditionalDetail
1817 * @param array $defaults
1820 * We aim to further refactor & simplify this but currently
1822 * - should additional info be shown?
1824 protected function generatePane($type, $defaults) {
1825 $urlParams = "snippet=4&formType={$type}";
1827 $urlParams .= "&mode={$this->_mode}";
1831 if ($type == 'CreditCard' ||
1832 $type == 'DirectDebit'
1838 'url' => CRM_Utils_System
::url('civicrm/contact/view/contribution', $urlParams),
1843 // See if we need to include this paneName in the current form.
1844 if ($this->_formType
== $type ||
!empty($_POST["hidden_{$type}"]) ||
1845 CRM_Utils_Array
::value("hidden_{$type}", $defaults)
1847 $this->assign('showAdditionalInfo', TRUE);
1848 $pane['open'] = 'true';
1851 if ($type == 'CreditCard' ||
$type == 'DirectDebit') {
1852 // @todo would be good to align tpl name with form name...
1853 // @todo document why this hidden variable is required.
1854 $this->add('hidden', 'hidden_' . $type, 1);
1858 $additionalInfoFormFunction = 'build' . $type;
1859 CRM_Contribute_Form_AdditionalInfo
::$additionalInfoFormFunction($this);