3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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 usefusul, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * This class generates form components for processing a contribution
40 class CRM_Contribute_Form_Contribution
extends CRM_Contribute_Form_AbstractEditPayment
{
42 * the id of the contribution that we are processing
50 * the id of the premium that we are processing
55 public $_premiumID = NULL;
58 * @var CRM_Contribute_DAO_ContributionProduct
60 public $_productDAO = NULL;
71 * the id of the contact associated with this contribution
79 * the id of the pledge payment that we are processing
87 * the id of the pledge that we are processing
95 * is this contribution associated with an online
96 * financial transaction
101 public $_online = FALSE;
104 * Stores all product option
112 * Storage of parameters from form
120 * Store the contribution Type ID
124 public $_contributionType;
127 * The contribution values if an existing contribution
132 * The pledge values if this contribution is associated with pledge
134 public $_pledgeValues;
136 public $_contributeMode = 'direct';
141 * Parameter with confusing name
145 public $_compContext;
150 * Possible From email addresses
161 * Store the line items if price set used.
167 * @todo explain why we use lineItem & lineItems
173 * @var array soft credit info
175 public $_softCreditInfo;
177 protected $_formType;
180 * @todo what on earth does cdType stand for????
184 public $_honoreeProfileType;
187 * logged in user's email
200 * Price set as an array
207 * @todo can we define this a as protected? can we define higher up the chain
217 public $userDisplayName;
219 * Function to set variables up before form is built
224 public function preProcess() {
226 //check permission for action.
227 if (!CRM_Core_Permission
::checkActionPermission('CiviContribute', $this->_action
)) {
228 CRM_Core_Error
::fatal(ts('You do not have permission to access this page'));
231 $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);
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
);
275 $this->_paymentProcessor
= array('billing_mode' => 1);
277 $this->assign('showCheckNumber', TRUE);
279 $this->_fromEmails
= CRM_Core_BAO_Email
::getFromEmail();
280 $this->assignProcessors();
282 if ($this->_contactID
) {
283 list($this->userDisplayName
, $this->userEmail
) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
284 $this->assign('displayName', $this->userDisplayName
);
287 // also check for billing information
288 // get the billing location type
289 $this->assignBillingType();
291 $this->_fields
= array();
293 CRM_Core_Payment_Form
::setPaymentFieldsByType(CRM_Utils_Array
::value('payment_type', $this->_processors
), $this);
295 if ($this->_action
& CRM_Core_Action
::DELETE
) {
299 if (in_array('CiviPledge', CRM_Core_Config
::singleton()->enableComponents
) && !$this->_formType
) {
300 $this->preProcessPledge();
304 $this->showRecordLinkMesssage($this->_id
);
306 $this->_values
= array();
308 // current contribution id
310 $this->assignPremiumProduct($this->_id
);
311 $this->buildValuesAndAssignOnline_Note_Type($this->_id
, $this->_values
);
314 // when custom data is included in this page
315 if (!empty($_POST['hidden_custom'])) {
316 $this->applyCustomData('Contribution', CRM_Utils_Array
::value('financial_type_id', $_POST), $this->_id
);
319 $this->_lineItems
= array();
321 if (!empty($this->_compId
) && $this->_compContext
== 'participant') {
322 $this->assign('compId', $this->_compId
);
323 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->_compId
);
326 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->_id
, 'contribution', 1);
328 empty($lineItem) ?
NULL : $this->_lineItems
[] = $lineItem;
331 $this->assign('lineItem', empty($this->_lineItems
) ?
FALSE : $this->_lineItems
);
334 if ($this->_contactID
) {
335 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_contactID
);
337 // Check if this is default domain contact CRM-10482
338 if (CRM_Contact_BAO_Contact
::checkDomainContact($this->_contactID
)) {
339 $displayName .= ' (' . ts('default organization') . ')';
342 // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
343 CRM_Utils_System
::setTitle(ts('Contribution from') . ' ' . $displayName);
347 CRM_Contribute_Form_SoftCredit
::preprocess($this);
351 function setDefaultValues() {
352 if ($this->_cdType
) {
353 return CRM_Custom_Form_CustomData
::setDefaultValues($this);
356 $defaults = $this->_values
;
358 //set defaults for pledge payment.
360 $defaults['total_amount'] = CRM_Utils_Array
::value('scheduled_amount', $this->_pledgeValues
['pledgePayment']);
361 $defaults['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $this->_pledgeValues
);
362 $defaults['currency'] = CRM_Utils_Array
::value('currency', $this->_pledgeValues
);
363 $defaults['option_type'] = 1;
366 if ($this->_action
& CRM_Core_Action
::DELETE
) {
370 // set soft credit defaults
371 CRM_Contribute_Form_SoftCredit
::setDefaultValues($defaults, $this);
374 $config = CRM_Core_Config
::singleton();
375 // set default country from config if no country set
376 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
377 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
380 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
381 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
384 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID
);
385 $defaults = array_merge($defaults, $billingDefaults);
387 // now fix all state country selectors, set correct state based on country
388 CRM_Core_BAO_Address
::fixAllStateSelects($this, $defaults);
392 $this->_contactID
= $defaults['contact_id'];
395 // Set $newCredit variable in template to control whether link to credit card mode is included
396 $this->assign('newCredit', CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments());
398 // fix the display of the monetary value, CRM-4038
399 if (isset($defaults['total_amount'])) {
400 if (!empty($defaults['tax_amount'])) {
401 $defaults['total_amount'] = CRM_Utils_Money
::format($defaults['total_amount'] - $defaults['tax_amount'], NULL, '%a');
404 $defaults['total_amount'] = CRM_Utils_Money
::format($defaults['total_amount'], NULL, '%a');
408 if (isset($defaults['non_deductible_amount'])) {
409 $defaults['non_deductible_amount'] = CRM_Utils_Money
::format($defaults['non_deductible_amount'], NULL, '%a');
412 if (isset($defaults['fee_amount'])) {
413 $defaults['fee_amount'] = CRM_Utils_Money
::format($defaults['fee_amount'], NULL, '%a');
416 if (isset($defaults['net_amount'])) {
417 $defaults['net_amount'] = CRM_Utils_Money
::format($defaults['net_amount'], NULL, '%a');
420 if ($this->_contributionType
) {
421 $defaults['financial_type_id'] = $this->_contributionType
;
424 if (empty($defaults['payment_instrument_id'])) {
425 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
428 if (!empty($defaults['is_test'])) {
429 $this->assign('is_test', TRUE);
432 $this->assign('showOption', TRUE);
433 // for Premium section
434 if ($this->_premiumID
) {
435 $this->assign('showOption', FALSE);
436 $options = isset($this->_options
[$this->_productDAO
->product_id
]) ?
$this->_options
[$this->_productDAO
->product_id
] : "";
438 $this->assign('showOption', TRUE);
440 $options_key = CRM_Utils_Array
::key($this->_productDAO
->product_option
, $options);
442 $defaults['product_name'] = array($this->_productDAO
->product_id
, trim($options_key));
445 $defaults['product_name'] = array($this->_productDAO
->product_id
);
447 if ($this->_productDAO
->fulfilled_date
) {
448 list($defaults['fulfilled_date']) = CRM_Utils_Date
::setDateDefaults($this->_productDAO
->fulfilled_date
);
452 if (isset($this->userEmail
)) {
453 $this->assign('email', $this->userEmail
);
456 if (!empty($defaults['is_pay_later'])) {
457 $this->assign('is_pay_later', TRUE);
459 $this->assign('contribution_status_id', CRM_Utils_Array
::value('contribution_status_id', $defaults));
461 $dates = array('receive_date', 'receipt_date', 'cancel_date', 'thankyou_date');
462 foreach ($dates as $key) {
463 if (!empty($defaults[$key])) {
464 list($defaults[$key],
465 $defaults[$key . '_time']
466 ) = CRM_Utils_Date
::setDateDefaults(CRM_Utils_Array
::value($key, $defaults),
472 if (!$this->_id
&& empty($defaults['receive_date'])) {
473 list($defaults['receive_date'],
474 $defaults['receive_date_time']
475 ) = CRM_Utils_Date
::setDateDefaults(NULL, 'activityDateTime');
478 $this->assign('receive_date', CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('receive_date', $defaults),
479 CRM_Utils_Array
::value('receive_date_time', $defaults)
481 $currency = CRM_Utils_Array
::value('currency', $defaults);
482 $this->assign('currency', $currency);
483 // Hack to get currency info to the js layer. CRM-11440
484 CRM_Utils_Money
::format(1);
485 $this->assign('currencySymbol', CRM_Utils_Array
::value($currency, CRM_Utils_Money
::$_currencySymbols));
486 $this->assign('totalAmount', CRM_Utils_Array
::value('total_amount', $defaults));
488 //inherit campaign from pledge.
489 if ($this->_ppID
&& !empty($this->_pledgeValues
['campaign_id'])) {
490 $defaults['campaign_id'] = $this->_pledgeValues
['campaign_id'];
493 $this->_defaults
= $defaults;
498 * Function to build the form
503 public function buildQuickForm() {
504 if ($this->_cdType
) {
505 CRM_Custom_Form_CustomData
::buildQuickForm($this);
509 //tax rate from financialType
510 $this->assign('taxRates', json_encode(CRM_Core_PseudoConstant
::getTaxRates()));
511 $this->assign('currencies', json_encode(CRM_Core_OptionGroup
::values('currencies_enabled')));
513 // build price set form.
514 $buildPriceSet = FALSE;
515 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
,'contribution_invoice_settings');
516 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
517 $this->assign('invoicing', $invoicing);
519 // display tax amount on edit contribution page
520 if ($invoicing && $this->_action
& CRM_Core_Action
::UPDATE
&& isset($this->_values
['tax_amount'])) {
521 $this->assign('totalTaxAmount', $this->_values
['tax_amount']);
524 if (empty($this->_lineItems
) &&
525 ($this->_priceSetId ||
!empty($_POST['price_set_id']))
527 $buildPriceSet = TRUE;
528 $getOnlyPriceSetElements = TRUE;
529 if (!$this->_priceSetId
) {
530 $this->_priceSetId
= $_POST['price_set_id'];
531 $getOnlyPriceSetElements = FALSE;
534 $this->set('priceSetId', $this->_priceSetId
);
535 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
537 // get only price set form elements.
538 if ($getOnlyPriceSetElements) {
542 // use to build form during form rule.
543 $this->assign('buildPriceSet', $buildPriceSet);
545 $showAdditionalInfo = FALSE;
547 $defaults = $this->_values
;
548 $additionalDetailFields = array(
552 'non_deductible_amount',
556 foreach ($additionalDetailFields as $key) {
557 if (!empty($defaults[$key])) {
558 $defaults['hidden_AdditionalDetail'] = 1;
563 if ($this->_productDAO
) {
564 if ($this->_productDAO
->product_id
) {
565 $defaults['hidden_Premium'] = 1;
569 if ($this->_noteID
&&
570 isset($this->_values
['note'])
572 $defaults['hidden_AdditionalDetail'] = 1;
576 ts('Additional Details') => 'AdditionalDetail',
579 //Add Premium pane only if Premium is exists.
580 $dao = new CRM_Contribute_DAO_Product();
583 if ($dao->find(TRUE)) {
584 $paneNames[ts('Premium Information')] = 'Premium';
589 if (CRM_Utils_Array
::value('payment_type', $this->_processors
) & CRM_Core_Payment
::PAYMENT_TYPE_DIRECT_DEBIT
591 $ccPane = array(ts('Direct Debit Information') => 'DirectDebit');
594 $ccPane = array(ts('Credit Card Information') => 'CreditCard');
597 if (is_array($ccPane)) {
598 $paneNames = array_merge($ccPane, $paneNames);
601 $buildRecurBlock = FALSE;
602 foreach ($paneNames as $name => $type) {
603 $urlParams = "snippet=4&formType={$type}";
605 $urlParams .= "&mode={$this->_mode}";
609 if ($type == 'CreditCard' ||
610 $type == 'DirectDebit'
615 $allPanes[$name] = array(
616 'url' => CRM_Utils_System
::url('civicrm/contact/view/contribution', $urlParams),
621 // see if we need to include this paneName in the current form
622 if ($this->_formType
== $type ||
!empty($_POST["hidden_{$type}"]) ||
623 CRM_Utils_Array
::value("hidden_{$type}", $defaults)
625 $showAdditionalInfo = TRUE;
626 $allPanes[$name]['open'] = 'true';
629 if ($type == 'CreditCard') {
630 $buildRecurBlock = TRUE;
631 $this->add('hidden', 'hidden_CreditCard', 1);
632 CRM_Core_Payment_Form
::buildCreditCard($this, TRUE);
634 elseif ($type == 'DirectDebit') {
635 $buildRecurBlock = TRUE;
636 $this->add('hidden', 'hidden_DirectDebit', 1);
637 CRM_Core_Payment_Form
::buildDirectDebit($this, TRUE);
640 $additionalInfoFormFunction = 'build' . $type;
641 CRM_Contribute_Form_AdditionalInfo
::$additionalInfoFormFunction($this);
644 if (empty($this->_recurPaymentProcessors
)) {
645 $buildRecurBlock = FALSE;
647 if ($buildRecurBlock) {
648 CRM_Contribute_Form_Contribution_Main
::buildRecur($this);
649 $this->setDefaults(array('is_recur' => 0));
651 $this->assign('buildRecurBlock', $buildRecurBlock);
652 $qfKey = $this->controller
->_key
;
653 $this->assign('qfKey', $qfKey);
654 $this->assign('allPanes', $allPanes);
655 $this->assign('showAdditionalInfo', $showAdditionalInfo);
657 if ($this->_formType
) {
658 $this->assign('formType', $this->_formType
);
662 $this->applyFilter('__ALL__', 'trim');
664 if ($this->_action
& CRM_Core_Action
::DELETE
) {
665 $this->addButtons(array(
668 'name' => ts('Delete'),
669 'spacing' => ' ',
674 'name' => ts('Cancel')
681 //need to assign custom data type and subtype to the template
682 $this->assign('customDataType', 'Contribution');
683 $this->assign('customDataSubType', $this->_contributionType
);
684 $this->assign('entityID', $this->_id
);
686 if ($this->_context
== 'standalone') {
687 $this->addEntityRef('contact_id', ts('Contact'), array('create' => TRUE), TRUE);
690 $attributes = CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution');
692 $financialType = $this->add('select', 'financial_type_id',
693 ts('Financial Type'),
694 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::financialType(),
696 array('onChange' => "CRM.buildCustomData( 'Contribution', this.value );")
698 $paymentInstrument = FALSE;
700 $paymentInstrument = $this->add('select', 'payment_instrument_id',
702 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
703 TRUE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
707 $trxnId = $this->add('text', 'trxn_id', ts('Transaction ID'), $attributes['trxn_id']);
709 //add receipt for offline contribution
710 $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
712 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
714 $status = CRM_Contribute_PseudoConstant
::contributionStatus();
716 // suppressing contribution statuses that are NOT relevant to pledges (CRM-5169)
717 $statusName = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
724 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
727 elseif ((!$this->_ppID
&& $this->_id
) ||
!$this->_id
) {
728 $suppressFlag = FALSE;
730 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
731 if (CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails)) {
732 $suppressFlag = TRUE;
735 if (!$suppressFlag) {
740 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
744 unset($status[CRM_Utils_Array
::key('Overdue', $statusName)]);
749 $contributionStatus = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_id
, 'contribution_status_id');
750 $name = CRM_Utils_Array
::value($contributionStatus, $statusName);
755 unset($status[CRM_Utils_Array
::key('In Progress', $statusName)]);
756 unset($status[CRM_Utils_Array
::key('Pending', $statusName)]);
757 unset($status[CRM_Utils_Array
::key('Failed', $statusName)]);
761 unset($status[CRM_Utils_Array
::key('Refunded', $statusName)]);
771 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
777 unset($status[CRM_Utils_Array
::key('Refunded', $statusName)]);
780 $this->add('select', 'contribution_status_id',
781 ts('Contribution Status'),
787 $this->addDateTime('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
789 if ($this->_online
) {
790 $this->assign('hideCalender', TRUE);
792 $checkNumber = $this->add('text', 'check_number', ts('Check Number'), $attributes['check_number']);
794 $this->addDateTime('receipt_date', ts('Receipt Date'), FALSE, array('formatType' => 'activityDateTime'));
795 $this->addDateTime('cancel_date', ts('Cancelled / Refunded Date'), FALSE, array('formatType' => 'activityDateTime'));
797 $this->add('textarea', 'cancel_reason', ts('Cancellation / Refund Reason'), $attributes['cancel_reason']);
800 if ($buildRecurBlock) {
801 $recurJs = array('onChange' => "buildRecurBlock( this.value ); return false;");
803 $element = $this->add('select',
804 'payment_processor_id',
805 ts('Payment Processor'),
811 if ($this->_online
) {
815 if (empty($this->_lineItems
)) {
816 $buildPriceSet = FALSE;
817 $priceSets = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviContribute');
818 if (!empty($priceSets) && !$this->_ppID
) {
819 $buildPriceSet = TRUE;
822 // don't allow price set for contribution if it is related to participant, or if it is a pledge payment
823 // and if we already have line items for that participant. CRM-5095
824 if ($buildPriceSet && $this->_id
) {
825 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
826 $pledgePaymentId = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
831 if ($pledgePaymentId) {
832 $buildPriceSet = FALSE;
834 if ($participantID = CRM_Utils_Array
::value('participant', $componentDetails)) {
835 $participantLI = CRM_Price_BAO_LineItem
::getLineItems($participantID);
836 if (!CRM_Utils_System
::isNull($participantLI)) {
837 $buildPriceSet = FALSE;
842 $hasPriceSets = FALSE;
843 if ($buildPriceSet) {
844 $hasPriceSets = TRUE;
845 $element = $this->add('select', 'price_set_id', ts('Choose price set'),
847 '' => ts('Choose price set')
849 NULL, array('onchange' => "buildAmount( this.value );")
851 if ($this->_online
&& !($this->_action
& CRM_Core_Action
::UPDATE
)) {
855 $this->assign('hasPriceSets', $hasPriceSets);
856 $currencyFreeze = FALSE;
857 if (!($this->_action
& CRM_Core_Action
::UPDATE
)) {
858 if ($this->_online ||
$this->_ppID
) {
859 $attributes['total_amount'] = array_merge($attributes['total_amount'], array(
861 'style' => "background-color:#EBECE4"
863 $optionTypes = array(
864 '1' => ts('Adjust Pledge Payment Schedule?'),
865 '2' => ts('Adjust Total Pledge Amount?'),
867 $this->addRadio('option_type',
873 $currencyFreeze = TRUE;
877 $totalAmount = $this->addMoney('total_amount',
879 ($hasPriceSets) ?
FALSE : TRUE,
880 $attributes['total_amount'],
881 TRUE, 'currency', NULL, $currencyFreeze
885 $this->add('text', 'source', ts('Source'), CRM_Utils_Array
::value('source', $attributes));
887 //CRM-7362 --add campaigns.
888 CRM_Campaign_BAO_Campaign
::addCampaign($this, CRM_Utils_Array
::value('campaign_id', $this->_values
));
890 CRM_Contribute_Form_SoftCredit
::buildQuickForm($this);
894 $js = array('onclick' => "return verify( );");
897 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
900 $this->assign('outBound_option', $mailingInfo['outBound_option']);
902 $this->addButtons(array(
905 'name' => ts('Save'),
911 'name' => ts('Save and New'),
917 'name' => ts('Cancel')
922 // if status is Cancelled freeze Amount, Payment Instrument, Check #, Financial Type,
923 // Net and Fee Amounts are frozen in AdditionalInfo::buildAdditionalDetail
924 if ($this->_id
&& $this->_values
['contribution_status_id'] == array_search('Cancelled', $statusName)) {
926 $totalAmount->freeze();
928 $checkNumber->freeze();
929 $paymentInstrument->freeze();
931 $financialType->freeze();
934 $this->addFormRule(array('CRM_Contribute_Form_Contribution', 'formRule'), $this);
936 if ($this->_action
& CRM_Core_Action
::VIEW
) {
944 * @param array $fields the input form values
945 * @param array $files the uploaded files if any
948 * @internal param array $options additional user data
950 * @return true if no errors, else array of errors
954 static function formRule($fields, $files, $self) {
957 //check for Credit Card Contribution.
959 if (empty($fields['payment_processor_id'])) {
960 $errors['payment_processor_id'] = ts('Payment Processor is a required field.');
964 // do the amount validations.
965 if (empty($fields['total_amount']) && empty($self->_lineItems
)) {
966 if ($priceSetId = CRM_Utils_Array
::value('price_set_id', $fields)) {
967 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $fields, $errors);
971 $softErrors = CRM_Contribute_Form_SoftCredit
::formRule($fields, $errors, $self);
973 // If we have a net amount or fee amount that is NOT set to 0.00, then ensure
974 // that the net_amount + the fee_amount is equal to the total amount.
975 $total_amount = NULL;
976 if(!empty($fields['total_amount']) && $fields['total_amount'] != '0.00') {
977 $total_amount = $fields['total_amount'];
980 if(!empty($fields['fee_amount']) && $fields['fee_amount'] != '0.00') {
981 $fee_amount = $fields['fee_amount'];
984 if(!empty($fields['net_amount']) && $fields['net_amount'] != '0.00') {
985 $net_amount = $fields['net_amount'];
987 if ($total_amount && ($net_amount ||
$fee_amount)) {
988 $sum = CRM_Utils_Rule
::cleanMoney($net_amount) + CRM_Utils_Rule
::cleanMoney($fee_amount);
989 if (CRM_Utils_Rule
::cleanMoney($total_amount) != $sum) {
990 $errors['total_amount'] = ts('The sum of fee amount and net amount must be equal to total amount');
993 //form rule for status http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
994 if ($self->_id
&& $self->_values
['contribution_status_id'] != $fields['contribution_status_id']) {
995 CRM_Contribute_BAO_Contribution
::checkStatusValidation($self->_values
, $fields, $errors);
998 //FIXME FOR NEW DATA FLOW http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
999 if (!empty($fields['fee_amount']) && $financialType = CRM_Contribute_BAO_Contribution
::validateFinancialType($fields['financial_type_id'])) {
1000 $errors['financial_type_id'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
1003 // $trxn_id must be unique CRM-13919
1004 if (!empty($fields['trxn_id'])) {
1005 $queryParams = array(1 => array($fields['trxn_id'], 'String'));
1006 $query = 'select count(*) from civicrm_contribution where trxn_id = %1';
1008 $queryParams[2] = array((int)$self->_id
, 'Integer');
1009 $query .= ' and id !=%2';
1011 $tCnt = CRM_Core_DAO
::singleValueQuery($query, $queryParams);
1013 $errors['trxn_id'] = ts('Transaction ID\'s must be unique. Transaction \'%1\' already exists in your database.', array(1 => $fields['trxn_id']));
1017 $errors = array_merge($errors, $softErrors);
1022 * Function to process the form
1028 public function postProcess() {
1029 $session = CRM_Core_Session
::singleton();
1030 $sendReceipt = $pId = $contribution = FALSE;
1031 $softParams = $softIDs =array();
1033 if ($this->_action
& CRM_Core_Action
::DELETE
) {
1034 CRM_Contribute_BAO_Contribution
::deleteContribution($this->_id
);
1035 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1036 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
1041 // get the submitted form values.
1042 $submittedValues = $this->controller
->exportValues($this->_name
);
1043 if (!empty($submittedValues['price_set_id']) && $this->_action
& CRM_Core_Action
::UPDATE
) {
1044 $line = CRM_Price_BAO_LineItem
::getLineItems($this->_id
, 'contribution');
1045 $lineID = key($line);
1046 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', CRM_Utils_Array
::value('price_field_id', $line[$lineID]), 'price_set_id');
1047 $quickConfig = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
1049 CRM_Price_BAO_LineItem
::deleteLineItems($this->_id
, 'civicrm_contribution');
1053 // assign dataArray for contribution receipts
1054 $dataArray = array();
1055 foreach ($this->_lineItems
as $key => $value) {
1056 foreach ($value as $v) {
1057 if (isset($dataArray[(string)$v['tax_rate']])) {
1058 $dataArray[(string)$v['tax_rate']] = $dataArray[(string)$v['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $v);
1061 $dataArray[(string)$v['tax_rate']] = CRM_Utils_Array
::value('tax_amount', $v);
1065 $smarty = CRM_Core_Smarty
::singleton();
1066 $smarty->assign('dataArray', $dataArray);
1068 // process price set and get total amount and line items.
1069 $lineItem = array();
1070 $priceSetId = CRM_Utils_Array
::value('price_set_id', $submittedValues);
1071 if (empty($priceSetId) && !$this->_id
) {
1072 $this->_priceSetId
= $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_contribution_amount', 'id', 'name');
1073 $this->_priceSet
= current(CRM_Price_BAO_PriceSet
::getSetDetail($priceSetId));
1074 $fieldID = key($this->_priceSet
['fields']);
1075 $fieldValueId = key($this->_priceSet
['fields'][$fieldID]['options']);
1076 $this->_priceSet
['fields'][$fieldID]['options'][$fieldValueId]['amount'] = $submittedValues['total_amount'];
1077 $submittedValues['price_' . $fieldID] = 1;
1081 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
1082 $submittedValues, $lineItem[$priceSetId]);
1084 $submittedValues['total_amount'] = CRM_Utils_Array
::value('amount', $submittedValues);
1088 $pId = ($this->_compId
&& $this->_context
== 'participant') ?
$this->_compId
: CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id
, 'participant_id', 'contribution_id');
1090 if (!$priceSetId && !empty($submittedValues['total_amount']) && $this->_id
) {
1091 // 10117 update th line items for participants
1093 $entityTable = 'participant';
1095 $participantParams = array(
1096 'fee_amount' => $submittedValues['total_amount'],
1099 CRM_Event_BAO_Participant
::add($participantParams);
1100 if (empty($this->_lineItems
)) {
1101 $this->_lineItems
[] = CRM_Price_BAO_LineItem
::getLineItems($entityID, 'participant', 1);
1105 $entityTable = 'contribution';
1106 $entityID = $this->_id
;
1109 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($entityID, $entityTable);
1110 foreach (array_keys($lineItems) as $id) {
1111 $lineItems[$id]['id'] = $id;
1113 $itemId = key($lineItems);
1114 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1115 $this->_priceSetId
= CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1118 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1119 $lineItems[$itemId]['unit_price'] = $lineItems[$itemId]['line_total'] = CRM_Utils_Rule
::cleanMoney(CRM_Utils_Array
::value('total_amount', $submittedValues));
1121 // Update line total and total amount with tax on edit
1122 $financialItemsId = CRM_Core_PseudoConstant
::getTaxRates();
1123 if (array_key_exists($submittedValues['financial_type_id'], $financialItemsId)) {
1124 $lineItems[$itemId]['tax_rate'] = $financialItemsId[$submittedValues['financial_type_id']];
1127 $lineItems[$itemId]['tax_rate'] = $lineItems[$itemId]['tax_amount'] = "" ;
1128 $submittedValues['tax_amount'] = 'null';
1130 if ($lineItems[$itemId]['tax_rate']) {
1131 $lineItems[$itemId]['tax_amount'] = ($lineItems[$itemId]['tax_rate']/100) * $lineItems[$itemId]['line_total'];
1132 $submittedValues['total_amount'] = $lineItems[$itemId]['line_total'] +
$lineItems[$itemId]['tax_amount'];
1133 $submittedValues['tax_amount'] = $lineItems[$itemId]['tax_amount'];
1136 // 10117 update th line items for participants
1137 if (!empty($lineItems[$itemId]['price_field_id'])) {
1138 $lineItem[$this->_priceSetId
] = $lineItems;
1142 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1145 //CRM-11529 for quick config back office transactions
1146 //when financial_type_id is passed in form, update the
1147 //line items with the financial type selected in form
1148 if ($isQuickConfig && !empty($submittedValues['financial_type_id']) && CRM_Utils_Array
::value($this->_priceSetId
, $lineItem)
1150 foreach ($lineItem[$this->_priceSetId
] as &$values) {
1151 $values['financial_type_id'] = $submittedValues['financial_type_id'];
1155 if (!isset($submittedValues['total_amount'])) {
1156 $submittedValues['total_amount'] = CRM_Utils_Array
::value('total_amount', $this->_values
);
1158 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1160 if (!empty($submittedValues['pcp_made_through_id'])) {
1163 'pcp_made_through_id',
1164 'pcp_display_in_roll',
1165 'pcp_roll_nickname',
1166 'pcp_personal_note',
1168 foreach ($fields as $f) {
1169 $pcp[$f] = CRM_Utils_Array
::value($f, $submittedValues);
1173 $isEmpty = array_keys(array_flip($submittedValues['soft_credit_contact_id']));
1174 if ($this->_id
&& count($isEmpty) == 1 && key($isEmpty) == NULL) {
1175 //Delete existing soft credit records if soft credit list is empty on update
1176 CRM_Contribute_BAO_ContributionSoft
::del(array('contribution_id' => $this->_id
));
1179 //build soft credit params
1180 foreach ($submittedValues['soft_credit_contact_id'] as $key => $val) {
1181 if ($val && $submittedValues['soft_credit_amount'][$key]) {
1182 $softParams[$key]['contact_id'] = $val;
1183 $softParams[$key]['amount'] = CRM_Utils_Rule
::cleanMoney($submittedValues['soft_credit_amount'][$key]);
1184 $softParams[$key]['soft_credit_type_id'] = $submittedValues['soft_credit_type'][$key];
1185 if (!empty($submittedValues['soft_credit_id'][$key])) {
1186 $softIDs[] = $softParams[$key]['id'] = $submittedValues['soft_credit_id'][$key];
1192 // set the contact, when contact is selected
1193 if (!empty($submittedValues['contact_id'])) {
1194 $this->_contactID
= $submittedValues['contact_id'];
1197 $config = CRM_Core_Config
::singleton();
1199 //Credit Card Contribution.
1201 $this->processCreditCard($submittedValues, $config, $session, $lineItem);
1204 //Offline Contribution.
1205 $submittedValues = $this->unsetCreditCardFields($submittedValues);
1207 // get the required field value only.
1208 $formValues = $submittedValues;
1209 $params = $ids = array();
1211 $params['contact_id'] = $this->_contactID
;
1213 $params['currency'] = $this->getCurrency($submittedValues);
1216 'financial_type_id',
1217 'contribution_status_id',
1218 'payment_instrument_id',
1223 foreach ($fields as $f) {
1224 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1228 $params['pcp'] = $pcp;
1230 if (!empty($softParams)) {
1231 $params['soft_credit'] = $softParams;
1232 $params['soft_credit_ids'] = $softIDs;
1235 //if priceset is used, no need to cleanup money
1238 $params['skipCleanMoney'] = 1;
1247 foreach ($dates as $d) {
1248 $params[$d] = CRM_Utils_Date
::processDate($formValues[$d], $formValues[$d . '_time'], TRUE);
1251 if (!empty($formValues['is_email_receipt'])) {
1252 $params['receipt_date'] = date("Y-m-d");
1255 if ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Cancelled', 'name')
1256 ||
$params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Refunded', 'name')
1258 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value('cancel_date', $params))) {
1259 $params['cancel_date'] = date('Y-m-d');
1263 $params['cancel_date'] = $params['cancel_reason'] = 'null';
1266 // Set is_pay_later flag for back-office offline Pending status contributions CRM-8996
1267 // else if contribution_status is changed to Completed is_pay_later flag is changed to 0, CRM-15041
1268 if ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Pending', 'name')) {
1269 $params['is_pay_later'] = 1;
1271 elseif ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Completed', 'name')) {
1272 $params['is_pay_later'] = 0;
1275 $ids['contribution'] = $params['id'] = $this->_id
;
1277 //Add Additional common information to formatted params
1278 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($formValues, $params, $this);
1280 $params['contribution_mode'] = 'participant';
1281 $params['participant_id'] = $pId;
1282 $params['skipLineItem'] = 1;
1284 $params['line_item'] = $lineItem;
1285 $params['payment_processor_id'] = $params['payment_processor'] = CRM_Utils_Array
::value('id', $this->_paymentProcessor
);
1286 if (CRM_Utils_Array
::value('tax_amount', $submittedValues)) {
1287 $params['tax_amount'] = $submittedValues['tax_amount'];
1289 //create contribution.
1290 if ($isQuickConfig) {
1291 $params['is_quick_config'] = 1;
1295 // if non_deductible_amount exists i.e. Additional Details field set was opened [and staff typed something] -
1296 // if non_deductible_amount does NOT exist - then calculate it depending on:
1297 // $ContributionType->is_deductible and whether there is a product (premium).
1298 if (!isset($params['non_deductible_amount']) ||
(!empty($params['non_deductible_amount']))) {
1299 $contributionType = new CRM_Financial_DAO_FinancialType();
1300 $contributionType->id
= $params['financial_type_id'];
1301 if (!$contributionType->find(TRUE)) {
1302 CRM_Core_Error
::fatal('Could not find a system table');
1304 if ($contributionType->is_deductible
) {
1306 if (isset($formValues['product_name'][0])) {
1307 $selectProduct = $formValues['product_name'][0];
1309 // if there is a product - compare the value to the contribution amount
1310 if (isset($selectProduct)) {
1311 $productDAO = new CRM_Contribute_DAO_Product();
1312 $productDAO->id
= $selectProduct;
1313 $productDAO->find(TRUE);
1314 // product value exceeds contribution amount
1315 if ($params['total_amount'] < $productDAO->price
) {
1316 $params['non_deductible_amount'] = $params['total_amount'];
1318 // product value does NOT exceed contribution amount
1320 $params['non_deductible_amount'] = $productDAO->price
;
1323 // contribution is deductible - but there is no product
1325 $params['non_deductible_amount'] = '0.00';
1328 // contribution is NOT deductible
1330 $params['non_deductible_amount'] = $params['total_amount'];
1334 $contribution = CRM_Contribute_BAO_Contribution
::create($params, $ids);
1336 // process associated membership / participant, CRM-4395
1337 $relatedComponentStatusMsg = NULL;
1338 if ($contribution->id
&& $this->_action
& CRM_Core_Action
::UPDATE
) {
1339 $relatedComponentStatusMsg = $this->updateRelatedComponent($contribution->id
,
1340 $contribution->contribution_status_id
,
1341 CRM_Utils_Array
::value('contribution_status_id',
1348 if ($contribution->id
&& isset($formValues['note'])) {
1349 CRM_Contribute_Form_AdditionalInfo
::processNote($formValues, $this->_contactID
, $contribution->id
, $this->_noteID
);
1353 if ($contribution->id
&& isset($formValues['product_name'][0])) {
1354 CRM_Contribute_Form_AdditionalInfo
::processPremium($formValues, $contribution->id
,
1355 $this->_premiumID
, $this->_options
1359 //send receipt mail.
1360 if ($contribution->id
&& !empty($formValues['is_email_receipt'])) {
1361 $formValues['contact_id'] = $this->_contactID
;
1362 $formValues['contribution_id'] = $contribution->id
;
1364 $formValues +
= CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($contribution->id
);
1366 // to get 'from email id' for send receipt
1367 $this->fromEmailId
= $formValues['from_email_address'];
1368 $sendReceipt = CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $formValues);
1371 $pledgePaymentId = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1377 //update pledge payment status.
1378 if ((($this->_ppID
&& $contribution->id
) && $this->_action
& CRM_Core_Action
::ADD
) ||
1379 (($pledgePaymentId) && $this->_action
& CRM_Core_Action
::UPDATE
)
1383 //store contribution id in payment record.
1384 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $this->_ppID
, 'contribution_id', $contribution->id
);
1387 $this->_ppID
= CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1392 $this->_pledgeID
= CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1399 $adjustTotalAmount = FALSE;
1400 if (CRM_Utils_Array
::value('option_type', $formValues) == 2) {
1401 $adjustTotalAmount = TRUE;
1404 $updatePledgePaymentStatus = FALSE;
1405 //do only if either the status or the amount has changed
1406 if ($this->_action
& CRM_Core_Action
::ADD
) {
1407 $updatePledgePaymentStatus = TRUE;
1409 elseif ($this->_action
& CRM_Core_Action
::UPDATE
&& (($this->_defaults
['contribution_status_id'] != $formValues['contribution_status_id']) ||
1410 ($this->_defaults
['total_amount'] != $formValues['total_amount']))
1412 $updatePledgePaymentStatus = TRUE;
1415 if ($updatePledgePaymentStatus) {
1416 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($this->_pledgeID
,
1417 array($this->_ppID
),
1418 $contribution->contribution_status_id
,
1420 $contribution->total_amount
,
1426 $statusMsg = ts('The contribution record has been saved.');
1427 if (!empty($formValues['is_email_receipt']) && $sendReceipt) {
1428 $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
1431 if ($relatedComponentStatusMsg) {
1432 $statusMsg .= ' ' . $relatedComponentStatusMsg;
1435 CRM_Core_Session
::setStatus($statusMsg, ts('Saved'), 'success');
1436 //Offline Contribution ends.
1438 $buttonName = $this->controller
->getButtonName();
1439 if ($this->_context
== 'standalone') {
1440 if ($buttonName == $this->getButtonName('upload', 'new')) {
1441 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contribute/add',
1442 'reset=1&action=add&context=standalone'
1446 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1447 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
1451 elseif ($this->_context
== 'contribution' && $this->_mode
&& $buttonName == $this->getButtonName('upload', 'new')) {
1452 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
1453 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}&mode={$this->_mode}"
1456 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1457 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
1458 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}"
1462 //store contribution ID if not yet set (on create)
1463 if ( empty($this->_id
) && !empty($contribution->id
) ) {
1464 $this->_id
= $contribution->id
;
1469 * @param $submittedValues
1471 * @param $session CRM_Core_Session
1474 * @throws CRM_Core_Exception
1476 public function processCreditCard($submittedValues, $config, $session, $lineItem) {
1477 $sendReceipt = $contribution = FALSE;
1478 $unsetParams = array(
1480 'payment_instrument_id',
1481 'contribution_status_id',
1485 foreach ($unsetParams as $key) {
1486 if (isset($submittedValues[$key])) {
1487 unset($submittedValues[$key]);
1490 $isTest = ($this->_mode
== 'test') ?
1 : 0;
1491 // CRM-12680 set $_lineItem if its not set
1492 if (empty($this->_lineItem
) && !empty($lineItem)) {
1493 $this->_lineItem
= $lineItem;
1496 //Get the require fields value only.
1497 $params = $this->_params
= $submittedValues;
1499 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($this->_params
['payment_processor_id'],
1503 //get the payment processor id as per mode.
1504 $this->_params
['payment_processor'] = $params['payment_processor_id'] =
1505 $this->_params
['payment_processor_id'] = $submittedValues['payment_processor_id'] = $this->_paymentProcessor
['id'];
1507 $now = date('YmdHis');
1510 // we need to retrieve email address
1511 if ($this->_context
== 'standalone' && !empty($submittedValues['is_email_receipt'])) {
1512 list($this->userDisplayName
,
1514 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
1515 $this->assign('displayName', $this->userDisplayName
);
1518 //set email for primary location.
1519 $fields['email-Primary'] = 1;
1520 $params['email-Primary'] = $this->userEmail
;
1522 // now set the values for the billing location.
1523 foreach (array_keys($this->_fields
) as $name) {
1527 // also add location name to the array
1528 $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);
1529 $params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]);
1530 $fields["address_name-{$this->_bltID}"] = 1;
1532 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
1537 $nameFields = array('first_name', 'middle_name', 'last_name');
1538 foreach ($nameFields as $name) {
1540 if (array_key_exists("billing_$name", $params)) {
1541 $params[$name] = $params["billing_{$name}"];
1542 $params['preserveDBName'] = TRUE;
1546 if (!empty($params['source'])) {
1547 unset($params['source']);
1549 $contactID = CRM_Contact_BAO_Contact
::createProfileContact($params, $fields,
1555 // add all the additional payment params we need
1556 $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}"]);
1557 $this->_params
["country-{$this->_bltID}"] = $this->_params
["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($this->_params
["billing_country_id-{$this->_bltID}"]);
1559 if ($this->_paymentProcessor
['payment_type'] & CRM_Core_Payment
::PAYMENT_TYPE_CREDIT_CARD
) {
1560 $this->_params
['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($this->_params
);
1561 $this->_params
['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($this->_params
);
1563 $this->_params
['ip_address'] = CRM_Utils_System
::ipAddress();
1564 $this->_params
['amount'] = $this->_params
['total_amount'];
1565 $this->_params
['amount_level'] = 0;
1566 $this->_params
['currencyID'] = CRM_Utils_Array
::value('currency',
1568 $config->defaultCurrency
1570 $this->_params
['payment_action'] = 'Sale';
1571 if (!empty($this->_params
['receive_date'])) {
1572 $this->_params
['receive_date'] = CRM_Utils_Date
::processDate($this->_params
['receive_date'], $this->_params
['receive_date_time']);
1575 if (!empty($params['soft_credit_to'])) {
1576 $this->_params
['soft_credit_to'] = $params['soft_credit_to'];
1577 $this->_params
['pcp_made_through_id'] = $params['pcp_made_through_id'];
1580 $this->_params
['pcp_display_in_roll'] = CRM_Utils_Array
::value('pcp_display_in_roll', $params);
1581 $this->_params
['pcp_roll_nickname'] = CRM_Utils_Array
::value('pcp_roll_nickname', $params);
1582 $this->_params
['pcp_personal_note'] = CRM_Utils_Array
::value('pcp_personal_note', $params);
1584 //Add common data to formatted params
1585 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($params, $this->_params
, $this);
1587 if (empty($this->_params
['invoice_id'])) {
1588 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1591 $this->_params
['invoiceID'] = $this->_params
['invoice_id'];
1594 // at this point we've created a contact and stored its address etc
1595 // all the payment processors expect the name and address to be in the
1596 // so we copy stuff over to first_name etc.
1597 $paymentParams = $this->_params
;
1598 $paymentParams['contactID'] = $this->_contactID
;
1599 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
1601 $contributionType = new CRM_Financial_DAO_FinancialType();
1602 $contributionType->id
= $params['financial_type_id'];
1603 if (!$contributionType->find(TRUE)) {
1604 CRM_Core_Error
::fatal('Could not find a system table');
1607 // add some financial type details to the params list
1608 // if folks need to use it
1609 $paymentParams['contributionType_name'] = $this->_params
['contributionType_name'] = $contributionType->name
;
1610 $paymentParams['contributionPageID'] = NULL;
1611 if (!empty($this->_params
['is_email_receipt'])) {
1612 $paymentParams['email'] = $this->userEmail
;
1613 $paymentParams['is_email_receipt'] = 1;
1616 $paymentParams['is_email_receipt'] = 0;
1617 $this->_params
['is_email_receipt'] = 0;
1619 if (!empty($this->_params
['receive_date'])) {
1620 $paymentParams['receive_date'] = $this->_params
['receive_date'];
1623 // For recurring contribution, create Contribution Record first.
1624 // Contribution ID, Recurring ID and Contact ID needed
1625 // When we get a callback from the payment processor, CRM-7115
1626 if (!empty($paymentParams['is_recur'])) {
1627 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1637 $paymentParams['contributionID'] = $contribution->id
;
1638 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1639 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1640 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1643 if ($paymentParams['amount'] > 0.0) {
1644 // force a re-get of the payment processor in case the form changed it, CRM-7179
1645 $payment = CRM_Core_Payment
::singleton($this->_mode
, $this->_paymentProcessor
, $this, TRUE);
1646 $result = $payment->doDirectPayment($paymentParams);
1649 if (is_a($result, 'CRM_Core_Error')) {
1650 //make sure to cleanup db for recurring case.
1651 if (!empty($paymentParams['contributionID'])) {
1652 CRM_Core_Error
::debug_log_message(CRM_Core_Error
::getMessages($result) . "contact id={$this->_contactID} (deleting contribution {$paymentParams['contributionID']}");
1653 CRM_Contribute_BAO_Contribution
::deleteContribution($paymentParams['contributionID']);
1655 if (!empty($paymentParams['contributionRecurID'])) {
1656 CRM_Core_Error
::debug_log_message(CRM_Core_Error
::getMessages($result) . "contact id={$this->_contactID} (deleting recurring contribution {$paymentParams['contributionRecurID']}");
1657 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($paymentParams['contributionRecurID']);
1660 //set the contribution mode.
1661 $urlParams = "action=add&cid={$this->_contactID}";
1663 $urlParams .= "&mode={$this->_mode}";
1665 if (!empty($this->_ppID
)) {
1666 $urlParams .= "&context=pledge&ppid={$this->_ppID}";
1668 CRM_Core_Error
::displaySessionError($result);
1669 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/contribution', $urlParams));
1673 $this->_params
= array_merge($this->_params
, $result);
1676 $this->_params
['receive_date'] = $now;
1678 if (!empty($this->_params
['is_email_receipt'])) {
1679 $this->_params
['receipt_date'] = $now;
1682 $this->_params
['receipt_date'] = CRM_Utils_Date
::processDate($this->_params
['receipt_date'],
1683 $params['receipt_date_time'], TRUE
1687 $this->set('params', $this->_params
);
1688 $this->assign('trxn_id', $result['trxn_id']);
1689 $this->assign('receive_date', $this->_params
['receive_date']);
1691 // result has all the stuff we need
1692 // lets archive it to a financial transaction
1693 if ($contributionType->is_deductible
) {
1694 $this->assign('is_deductible', TRUE);
1695 $this->set('is_deductible', TRUE);
1698 // set source if not set
1699 if (empty($this->_params
['source'])) {
1700 $userID = $session->get('userID');
1701 $userSortName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $userID,
1704 $this->_params
['source'] = ts('Submit Credit Card Payment by: %1', array(1 => $userSortName));
1707 // build custom data getFields array
1708 $customFieldsContributionType = CRM_Core_BAO_CustomField
::getFields('Contribution', FALSE, FALSE,
1709 CRM_Utils_Array
::value('financial_type_id', $params)
1711 $customFields = CRM_Utils_Array
::crmArrayMerge($customFieldsContributionType,
1712 CRM_Core_BAO_CustomField
::getFields('Contribution', FALSE, FALSE, NULL, NULL, TRUE)
1714 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
1721 if (empty($paymentParams['is_recur'])) {
1722 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1733 //send receipt mail.
1734 if ($contribution->id
&& !empty($this->_params
['is_email_receipt'])) {
1735 $this->_params
['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1736 $this->_params
['contact_id'] = $this->_contactID
;
1737 $this->_params
['contribution_id'] = $contribution->id
;
1738 $sendReceipt = CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $this->_params
, TRUE);
1742 if ($contribution->id
&& isset($params['note'])) {
1743 CRM_Contribute_Form_AdditionalInfo
::processNote($params, $contactID, $contribution->id
, NULL);
1746 if ($contribution->id
&& isset($params['product_name'][0])) {
1747 CRM_Contribute_Form_AdditionalInfo
::processPremium($params, $contribution->id
, NULL, $this->_options
);
1750 //update pledge payment status.
1751 if ($this->_ppID
&& $contribution->id
) {
1752 //store contribution id in payment record.
1753 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $this->_ppID
, 'contribution_id', $contribution->id
);
1755 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($this->_pledgeID
,
1756 array($this->_ppID
),
1757 $contribution->contribution_status_id
,
1759 $contribution->total_amount
1763 if ($contribution->id
) {
1764 $statusMsg = ts('The contribution record has been processed.');
1765 if (!empty($this->_params
['is_email_receipt']) && $sendReceipt) {
1766 $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
1768 CRM_Core_Session
::setStatus($statusMsg, ts('Complete'), 'success');