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, TRUE, TRUE);
328 empty($lineItem) ?
NULL : $this->_lineItems
[] = $lineItem;
331 $this->assign('lineItem', empty($this->_lineItems
) ?
FALSE : $this->_lineItems
);
335 $this->setPageTitle($this->_ppID ?
ts('Credit Card Pledge Payment') : ts('Credit Card Contribution'));
338 $this->setPageTitle($this->_ppID ?
ts('Pledge Payment') : ts('Contribution'));
342 CRM_Contribute_Form_SoftCredit
::preprocess($this);
346 function setDefaultValues() {
347 if ($this->_cdType
) {
348 return CRM_Custom_Form_CustomData
::setDefaultValues($this);
351 $defaults = $this->_values
;
353 //set defaults for pledge payment.
355 $defaults['total_amount'] = CRM_Utils_Array
::value('scheduled_amount', $this->_pledgeValues
['pledgePayment']);
356 $defaults['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $this->_pledgeValues
);
357 $defaults['currency'] = CRM_Utils_Array
::value('currency', $this->_pledgeValues
);
358 $defaults['option_type'] = 1;
361 if ($this->_action
& CRM_Core_Action
::DELETE
) {
365 // set soft credit defaults
366 CRM_Contribute_Form_SoftCredit
::setDefaultValues($defaults, $this);
369 $config = CRM_Core_Config
::singleton();
370 // set default country from config if no country set
371 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
372 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
375 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
376 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
379 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID
);
380 $defaults = array_merge($defaults, $billingDefaults);
384 $this->_contactID
= $defaults['contact_id'];
387 // Set $newCredit variable in template to control whether link to credit card mode is included
388 $this->assign('newCredit', CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments());
390 // fix the display of the monetary value, CRM-4038
391 if (isset($defaults['total_amount'])) {
392 if (!empty($defaults['tax_amount'])) {
393 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
394 if (!(CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails))) {
395 $defaults['total_amount'] = CRM_Utils_Money
::format($defaults['total_amount'] - $defaults['tax_amount'], NULL, '%a');
399 $defaults['total_amount'] = CRM_Utils_Money
::format($defaults['total_amount'], NULL, '%a');
403 if (isset($defaults['non_deductible_amount'])) {
404 $defaults['non_deductible_amount'] = CRM_Utils_Money
::format($defaults['non_deductible_amount'], NULL, '%a');
407 if (isset($defaults['fee_amount'])) {
408 $defaults['fee_amount'] = CRM_Utils_Money
::format($defaults['fee_amount'], NULL, '%a');
411 if (isset($defaults['net_amount'])) {
412 $defaults['net_amount'] = CRM_Utils_Money
::format($defaults['net_amount'], NULL, '%a');
415 if ($this->_contributionType
) {
416 $defaults['financial_type_id'] = $this->_contributionType
;
419 if (empty($defaults['payment_instrument_id'])) {
420 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
423 if (!empty($defaults['is_test'])) {
424 $this->assign('is_test', TRUE);
427 $this->assign('showOption', TRUE);
428 // for Premium section
429 if ($this->_premiumID
) {
430 $this->assign('showOption', FALSE);
431 $options = isset($this->_options
[$this->_productDAO
->product_id
]) ?
$this->_options
[$this->_productDAO
->product_id
] : "";
433 $this->assign('showOption', TRUE);
435 $options_key = CRM_Utils_Array
::key($this->_productDAO
->product_option
, $options);
437 $defaults['product_name'] = array($this->_productDAO
->product_id
, trim($options_key));
440 $defaults['product_name'] = array($this->_productDAO
->product_id
);
442 if ($this->_productDAO
->fulfilled_date
) {
443 list($defaults['fulfilled_date']) = CRM_Utils_Date
::setDateDefaults($this->_productDAO
->fulfilled_date
);
447 if (isset($this->userEmail
)) {
448 $this->assign('email', $this->userEmail
);
451 if (!empty($defaults['is_pay_later'])) {
452 $this->assign('is_pay_later', TRUE);
454 $this->assign('contribution_status_id', CRM_Utils_Array
::value('contribution_status_id', $defaults));
456 $dates = array('receive_date', 'receipt_date', 'cancel_date', 'thankyou_date');
457 foreach ($dates as $key) {
458 if (!empty($defaults[$key])) {
459 list($defaults[$key],
460 $defaults[$key . '_time']
461 ) = CRM_Utils_Date
::setDateDefaults(CRM_Utils_Array
::value($key, $defaults),
467 if (!$this->_id
&& empty($defaults['receive_date'])) {
468 list($defaults['receive_date'],
469 $defaults['receive_date_time']
470 ) = CRM_Utils_Date
::setDateDefaults(NULL, 'activityDateTime');
473 $this->assign('receive_date', CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('receive_date', $defaults),
474 CRM_Utils_Array
::value('receive_date_time', $defaults)
476 $currency = CRM_Utils_Array
::value('currency', $defaults);
477 $this->assign('currency', $currency);
478 // Hack to get currency info to the js layer. CRM-11440
479 CRM_Utils_Money
::format(1);
480 $this->assign('currencySymbol', CRM_Utils_Array
::value($currency, CRM_Utils_Money
::$_currencySymbols));
481 $this->assign('totalAmount', CRM_Utils_Array
::value('total_amount', $defaults));
483 //inherit campaign from pledge.
484 if ($this->_ppID
&& !empty($this->_pledgeValues
['campaign_id'])) {
485 $defaults['campaign_id'] = $this->_pledgeValues
['campaign_id'];
488 $this->_defaults
= $defaults;
493 * Function to build the form
498 public function buildQuickForm() {
499 if ($this->_cdType
) {
500 CRM_Custom_Form_CustomData
::buildQuickForm($this);
504 //tax rate from financialType
505 $this->assign('taxRates', json_encode(CRM_Core_PseudoConstant
::getTaxRates()));
506 $this->assign('currencies', json_encode(CRM_Core_OptionGroup
::values('currencies_enabled')));
508 // build price set form.
509 $buildPriceSet = FALSE;
510 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
,'contribution_invoice_settings');
511 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
512 $this->assign('invoicing', $invoicing);
514 // display tax amount on edit contribution page
515 if ($invoicing && $this->_action
& CRM_Core_Action
::UPDATE
&& isset($this->_values
['tax_amount'])) {
516 $this->assign('totalTaxAmount', $this->_values
['tax_amount']);
519 if (empty($this->_lineItems
) &&
520 ($this->_priceSetId ||
!empty($_POST['price_set_id']))
522 $buildPriceSet = TRUE;
523 $getOnlyPriceSetElements = TRUE;
524 if (!$this->_priceSetId
) {
525 $this->_priceSetId
= $_POST['price_set_id'];
526 $getOnlyPriceSetElements = FALSE;
529 $this->set('priceSetId', $this->_priceSetId
);
530 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
532 // get only price set form elements.
533 if ($getOnlyPriceSetElements) {
537 // use to build form during form rule.
538 $this->assign('buildPriceSet', $buildPriceSet);
540 $showAdditionalInfo = FALSE;
542 $defaults = $this->_values
;
543 $additionalDetailFields = array(
547 'non_deductible_amount',
551 foreach ($additionalDetailFields as $key) {
552 if (!empty($defaults[$key])) {
553 $defaults['hidden_AdditionalDetail'] = 1;
558 if ($this->_productDAO
) {
559 if ($this->_productDAO
->product_id
) {
560 $defaults['hidden_Premium'] = 1;
564 if ($this->_noteID
&&
565 isset($this->_values
['note'])
567 $defaults['hidden_AdditionalDetail'] = 1;
571 ts('Additional Details') => 'AdditionalDetail',
574 //Add Premium pane only if Premium is exists.
575 $dao = new CRM_Contribute_DAO_Product();
578 if ($dao->find(TRUE)) {
579 $paneNames[ts('Premium Information')] = 'Premium';
584 if (CRM_Utils_Array
::value('payment_type', $this->_processors
) & CRM_Core_Payment
::PAYMENT_TYPE_DIRECT_DEBIT
586 $ccPane = array(ts('Direct Debit Information') => 'DirectDebit');
589 $ccPane = array(ts('Credit Card Information') => 'CreditCard');
592 if (is_array($ccPane)) {
593 $paneNames = array_merge($ccPane, $paneNames);
596 $buildRecurBlock = FALSE;
597 foreach ($paneNames as $name => $type) {
598 $urlParams = "snippet=4&formType={$type}";
600 $urlParams .= "&mode={$this->_mode}";
604 if ($type == 'CreditCard' ||
605 $type == 'DirectDebit'
610 $allPanes[$name] = array(
611 'url' => CRM_Utils_System
::url('civicrm/contact/view/contribution', $urlParams),
616 // see if we need to include this paneName in the current form
617 if ($this->_formType
== $type ||
!empty($_POST["hidden_{$type}"]) ||
618 CRM_Utils_Array
::value("hidden_{$type}", $defaults)
620 $showAdditionalInfo = TRUE;
621 $allPanes[$name]['open'] = 'true';
624 if ($type == 'CreditCard') {
625 $buildRecurBlock = TRUE;
626 $this->add('hidden', 'hidden_CreditCard', 1);
627 CRM_Core_Payment_Form
::buildCreditCard($this, TRUE);
629 elseif ($type == 'DirectDebit') {
630 $buildRecurBlock = TRUE;
631 $this->add('hidden', 'hidden_DirectDebit', 1);
632 CRM_Core_Payment_Form
::buildDirectDebit($this, TRUE);
635 $additionalInfoFormFunction = 'build' . $type;
636 CRM_Contribute_Form_AdditionalInfo
::$additionalInfoFormFunction($this);
639 if (empty($this->_recurPaymentProcessors
)) {
640 $buildRecurBlock = FALSE;
642 if ($buildRecurBlock) {
643 CRM_Contribute_Form_Contribution_Main
::buildRecur($this);
644 $this->setDefaults(array('is_recur' => 0));
646 $this->assign('buildRecurBlock', $buildRecurBlock);
647 $qfKey = $this->controller
->_key
;
648 $this->assign('qfKey', $qfKey);
649 $this->assign('allPanes', $allPanes);
650 $this->assign('showAdditionalInfo', $showAdditionalInfo);
652 if ($this->_formType
) {
653 $this->assign('formType', $this->_formType
);
657 $this->applyFilter('__ALL__', 'trim');
659 if ($this->_action
& CRM_Core_Action
::DELETE
) {
660 $this->addButtons(array(
663 'name' => ts('Delete'),
664 'spacing' => ' ',
669 'name' => ts('Cancel')
676 //need to assign custom data type and subtype to the template
677 $this->assign('customDataType', 'Contribution');
678 $this->assign('customDataSubType', $this->_contributionType
);
679 $this->assign('entityID', $this->_id
);
681 if ($this->_context
== 'standalone') {
682 $this->addEntityRef('contact_id', ts('Contact'), array('create' => TRUE, 'api' => array('extra' => array('email'))), TRUE);
685 $attributes = CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution');
687 $financialType = $this->add('select', 'financial_type_id',
688 ts('Financial Type'),
689 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::financialType(),
691 array('onChange' => "CRM.buildCustomData( 'Contribution', this.value );")
693 $paymentInstrument = FALSE;
695 $paymentInstrument = $this->add('select', 'payment_instrument_id',
697 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
698 TRUE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
702 $trxnId = $this->add('text', 'trxn_id', ts('Transaction ID'), array('class' => 'twelve') +
$attributes['trxn_id']);
704 //add receipt for offline contribution
705 $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
707 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
709 $status = CRM_Contribute_PseudoConstant
::contributionStatus();
711 // suppressing contribution statuses that are NOT relevant to pledges (CRM-5169)
712 $statusName = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
719 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
722 elseif ((!$this->_ppID
&& $this->_id
) ||
!$this->_id
) {
723 $suppressFlag = FALSE;
725 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
726 if (CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails)) {
727 $suppressFlag = TRUE;
730 if (!$suppressFlag) {
735 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
739 unset($status[CRM_Utils_Array
::key('Overdue', $statusName)]);
744 $contributionStatus = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_id
, 'contribution_status_id');
745 $name = CRM_Utils_Array
::value($contributionStatus, $statusName);
750 unset($status[CRM_Utils_Array
::key('In Progress', $statusName)]);
751 unset($status[CRM_Utils_Array
::key('Pending', $statusName)]);
752 unset($status[CRM_Utils_Array
::key('Failed', $statusName)]);
756 unset($status[CRM_Utils_Array
::key('Refunded', $statusName)]);
766 unset($status[CRM_Utils_Array
::key($suppress, $statusName)]);
772 unset($status[CRM_Utils_Array
::key('Refunded', $statusName)]);
775 $this->add('select', 'contribution_status_id',
776 ts('Contribution Status'),
782 $this->addDateTime('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
784 if ($this->_online
) {
785 $this->assign('hideCalender', TRUE);
787 $checkNumber = $this->add('text', 'check_number', ts('Check Number'), $attributes['check_number']);
789 $this->addDateTime('receipt_date', ts('Receipt Date'), FALSE, array('formatType' => 'activityDateTime'));
790 $this->addDateTime('cancel_date', ts('Cancelled / Refunded Date'), FALSE, array('formatType' => 'activityDateTime'));
792 $this->add('textarea', 'cancel_reason', ts('Cancellation / Refund Reason'), $attributes['cancel_reason']);
795 if ($buildRecurBlock) {
796 $recurJs = array('onChange' => "buildRecurBlock( this.value ); return false;");
798 $element = $this->add('select',
799 'payment_processor_id',
800 ts('Payment Processor'),
806 if ($this->_online
) {
810 if (empty($this->_lineItems
)) {
811 $buildPriceSet = FALSE;
812 $priceSets = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviContribute');
813 if (!empty($priceSets) && !$this->_ppID
) {
814 $buildPriceSet = TRUE;
817 // don't allow price set for contribution if it is related to participant, or if it is a pledge payment
818 // and if we already have line items for that participant. CRM-5095
819 if ($buildPriceSet && $this->_id
) {
820 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
821 $pledgePaymentId = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
826 if ($pledgePaymentId) {
827 $buildPriceSet = FALSE;
829 if ($participantID = CRM_Utils_Array
::value('participant', $componentDetails)) {
830 $participantLI = CRM_Price_BAO_LineItem
::getLineItems($participantID);
831 if (!CRM_Utils_System
::isNull($participantLI)) {
832 $buildPriceSet = FALSE;
837 $hasPriceSets = FALSE;
838 if ($buildPriceSet) {
839 $hasPriceSets = TRUE;
840 $element = $this->add('select', 'price_set_id', ts('Choose price set'),
842 '' => ts('Choose price set')
844 NULL, array('onchange' => "buildAmount( this.value );")
846 if ($this->_online
&& !($this->_action
& CRM_Core_Action
::UPDATE
)) {
850 $this->assign('hasPriceSets', $hasPriceSets);
851 $currencyFreeze = FALSE;
852 if (!($this->_action
& CRM_Core_Action
::UPDATE
)) {
853 if ($this->_online ||
$this->_ppID
) {
854 $attributes['total_amount'] = array_merge($attributes['total_amount'], array(
856 'style' => "background-color:#EBECE4"
858 $optionTypes = array(
859 '1' => ts('Adjust Pledge Payment Schedule?'),
860 '2' => ts('Adjust Total Pledge Amount?'),
862 $this->addRadio('option_type',
868 $currencyFreeze = TRUE;
872 $totalAmount = $this->addMoney('total_amount',
874 ($hasPriceSets) ?
FALSE : TRUE,
875 $attributes['total_amount'],
876 TRUE, 'currency', NULL, $currencyFreeze
880 $this->add('text', 'source', ts('Source'), CRM_Utils_Array
::value('source', $attributes));
882 //CRM-7362 --add campaigns.
883 CRM_Campaign_BAO_Campaign
::addCampaign($this, CRM_Utils_Array
::value('campaign_id', $this->_values
));
885 CRM_Contribute_Form_SoftCredit
::buildQuickForm($this);
889 $js = array('onclick' => "return verify( );");
892 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
895 $this->assign('outBound_option', $mailingInfo['outBound_option']);
897 $this->addButtons(array(
900 'name' => ts('Save'),
906 'name' => ts('Save and New'),
912 'name' => ts('Cancel')
917 // if status is Cancelled freeze Amount, Payment Instrument, Check #, Financial Type,
918 // Net and Fee Amounts are frozen in AdditionalInfo::buildAdditionalDetail
919 if ($this->_id
&& $this->_values
['contribution_status_id'] == array_search('Cancelled', $statusName)) {
921 $totalAmount->freeze();
923 $checkNumber->freeze();
924 $paymentInstrument->freeze();
926 $financialType->freeze();
929 $this->addFormRule(array('CRM_Contribute_Form_Contribution', 'formRule'), $this);
931 // if contribution is related to membership or participant freeze Financial Type, Amount
932 if ($this->_id
&& isset($this->_values
['tax_amount'])) {
933 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
934 if (CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails)) {
935 $financialType->freeze();
936 $totalAmount->freeze();
937 $this->assign('freezeFinancialType', TRUE);
941 if ($this->_action
& CRM_Core_Action
::VIEW
) {
949 * @param array $fields the input form values
950 * @param array $files the uploaded files if any
953 * @internal param array $options additional user data
955 * @return true if no errors, else array of errors
959 static function formRule($fields, $files, $self) {
962 //check for Credit Card Contribution.
964 if (empty($fields['payment_processor_id'])) {
965 $errors['payment_processor_id'] = ts('Payment Processor is a required field.');
969 // do the amount validations.
970 if (empty($fields['total_amount']) && empty($self->_lineItems
)) {
971 if ($priceSetId = CRM_Utils_Array
::value('price_set_id', $fields)) {
972 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $fields, $errors);
976 $softErrors = CRM_Contribute_Form_SoftCredit
::formRule($fields, $errors, $self);
978 if (!empty($fields['total_amount']) && (!empty($fields['net_amount']) ||
!empty($fields['fee_amount']))) {
979 $sum = CRM_Utils_Rule
::cleanMoney($fields['net_amount']) + CRM_Utils_Rule
::cleanMoney($fields['fee_amount']);
980 if (CRM_Utils_Rule
::cleanMoney($fields['total_amount']) != $sum) {
981 $errors['total_amount'] = ts('The sum of fee amount and net amount must be equal to total amount');
984 //form rule for status http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
985 if ($self->_id
&& $self->_values
['contribution_status_id'] != $fields['contribution_status_id']) {
986 CRM_Contribute_BAO_Contribution
::checkStatusValidation($self->_values
, $fields, $errors);
989 //FIXME FOR NEW DATA FLOW http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
990 if (!empty($fields['fee_amount']) && $financialType = CRM_Contribute_BAO_Contribution
::validateFinancialType($fields['financial_type_id'])) {
991 $errors['financial_type_id'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
994 // $trxn_id must be unique CRM-13919
995 if (!empty($fields['trxn_id'])) {
996 $queryParams = array(1 => array($fields['trxn_id'], 'String'));
997 $query = 'select count(*) from civicrm_contribution where trxn_id = %1';
999 $queryParams[2] = array((int)$self->_id
, 'Integer');
1000 $query .= ' and id !=%2';
1002 $tCnt = CRM_Core_DAO
::singleValueQuery($query, $queryParams);
1004 $errors['trxn_id'] = ts('Transaction ID\'s must be unique. Transaction \'%1\' already exists in your database.', array(1 => $fields['trxn_id']));
1008 $errors = array_merge($errors, $softErrors);
1013 * Function to process the form
1019 public function postProcess() {
1020 $session = CRM_Core_Session
::singleton();
1021 $sendReceipt = $pId = $contribution = $isRelatedId = FALSE;
1022 $softParams = $softIDs =array();
1024 if ($this->_action
& CRM_Core_Action
::DELETE
) {
1025 CRM_Contribute_BAO_Contribution
::deleteContribution($this->_id
);
1026 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1027 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
1032 // get the submitted form values.
1033 $submittedValues = $this->controller
->exportValues($this->_name
);
1034 if (!empty($submittedValues['price_set_id']) && $this->_action
& CRM_Core_Action
::UPDATE
) {
1035 $line = CRM_Price_BAO_LineItem
::getLineItems($this->_id
, 'contribution');
1036 $lineID = key($line);
1037 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', CRM_Utils_Array
::value('price_field_id', $line[$lineID]), 'price_set_id');
1038 $quickConfig = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
1040 CRM_Price_BAO_LineItem
::deleteLineItems($this->_id
, 'civicrm_contribution');
1044 // process price set and get total amount and line items.
1045 $lineItem = array();
1046 $priceSetId = CRM_Utils_Array
::value('price_set_id', $submittedValues);
1047 if (empty($priceSetId) && !$this->_id
) {
1048 $this->_priceSetId
= $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_contribution_amount', 'id', 'name');
1049 $this->_priceSet
= current(CRM_Price_BAO_PriceSet
::getSetDetail($priceSetId));
1050 $fieldID = key($this->_priceSet
['fields']);
1051 $fieldValueId = key($this->_priceSet
['fields'][$fieldID]['options']);
1052 $this->_priceSet
['fields'][$fieldID]['options'][$fieldValueId]['amount'] = $submittedValues['total_amount'];
1053 $submittedValues['price_' . $fieldID] = 1;
1057 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
1058 $submittedValues, $lineItem[$priceSetId]);
1060 // unset tax amount for offline 'is_quick_config' contribution
1061 if ($this->_priceSet
['is_quick_config'] &&
1062 !array_key_exists($submittedValues['financial_type_id'], CRM_Core_PseudoConstant
::getTaxRates())
1064 unset($submittedValues['tax_amount']);
1066 $submittedValues['total_amount'] = CRM_Utils_Array
::value('amount', $submittedValues);
1069 if ($this->_compId
) {
1070 if ($this->_context
== 'participant') {
1071 $pId = $this->_compId
;
1073 elseif ($this->_context
== 'membership') {
1074 $isRelatedId = TRUE;
1078 $contributionDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
1079 if (array_key_exists('membership', $contributionDetails)) {
1080 $isRelatedId = TRUE;
1082 elseif (array_key_exists('participant', $contributionDetails)) {
1083 $pId = current($contributionDetails['participant']);
1087 if (!$priceSetId && !empty($submittedValues['total_amount']) && $this->_id
) {
1088 // 10117 update th line items for participants
1090 $entityTable = 'participant';
1092 $participantParams = array(
1093 'fee_amount' => $submittedValues['total_amount'],
1096 CRM_Event_BAO_Participant
::add($participantParams);
1097 if (empty($this->_lineItems
)) {
1098 $this->_lineItems
[] = CRM_Price_BAO_LineItem
::getLineItems($entityID, 'participant', 1);
1102 $entityTable = 'contribution';
1103 $entityID = $this->_id
;
1106 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($entityID, NULL, TRUE, $isRelatedId);
1107 foreach (array_keys($lineItems) as $id) {
1108 $lineItems[$id]['id'] = $id;
1110 $itemId = key($lineItems);
1111 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1112 $this->_priceSetId
= CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1115 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1116 $lineItems[$itemId]['unit_price'] = $lineItems[$itemId]['line_total'] = CRM_Utils_Rule
::cleanMoney(CRM_Utils_Array
::value('total_amount', $submittedValues));
1118 // Update line total and total amount with tax on edit
1119 $financialItemsId = CRM_Core_PseudoConstant
::getTaxRates();
1120 if (array_key_exists($submittedValues['financial_type_id'], $financialItemsId)) {
1121 $lineItems[$itemId]['tax_rate'] = $financialItemsId[$submittedValues['financial_type_id']];
1124 $lineItems[$itemId]['tax_rate'] = $lineItems[$itemId]['tax_amount'] = "" ;
1125 $submittedValues['tax_amount'] = 'null';
1127 if ($lineItems[$itemId]['tax_rate']) {
1128 $lineItems[$itemId]['tax_amount'] = ($lineItems[$itemId]['tax_rate']/100) * $lineItems[$itemId]['line_total'];
1129 $submittedValues['total_amount'] = $lineItems[$itemId]['line_total'] +
$lineItems[$itemId]['tax_amount'];
1130 $submittedValues['tax_amount'] = $lineItems[$itemId]['tax_amount'];
1133 // 10117 update th line items for participants
1134 if (!empty($lineItems[$itemId]['price_field_id'])) {
1135 $lineItem[$this->_priceSetId
] = $lineItems;
1139 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1142 //CRM-11529 for quick config back office transactions
1143 //when financial_type_id is passed in form, update the
1144 //line items with the financial type selected in form
1145 if ($isQuickConfig && !empty($submittedValues['financial_type_id']) && CRM_Utils_Array
::value($this->_priceSetId
, $lineItem)
1147 foreach ($lineItem[$this->_priceSetId
] as &$values) {
1148 $values['financial_type_id'] = $submittedValues['financial_type_id'];
1152 if (!isset($submittedValues['total_amount'])) {
1153 $submittedValues['total_amount'] = CRM_Utils_Array
::value('total_amount', $this->_values
);
1155 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1157 if (!empty($submittedValues['pcp_made_through_id'])) {
1160 'pcp_made_through_id',
1161 'pcp_display_in_roll',
1162 'pcp_roll_nickname',
1163 'pcp_personal_note',
1165 foreach ($fields as $f) {
1166 $pcp[$f] = CRM_Utils_Array
::value($f, $submittedValues);
1170 $isEmpty = array_keys(array_flip($submittedValues['soft_credit_contact_id']));
1171 if ($this->_id
&& count($isEmpty) == 1 && key($isEmpty) == NULL) {
1172 //Delete existing soft credit records if soft credit list is empty on update
1173 CRM_Contribute_BAO_ContributionSoft
::del(array('contribution_id' => $this->_id
));
1176 //build soft credit params
1177 foreach ($submittedValues['soft_credit_contact_id'] as $key => $val) {
1178 if ($val && $submittedValues['soft_credit_amount'][$key]) {
1179 $softParams[$key]['contact_id'] = $val;
1180 $softParams[$key]['amount'] = CRM_Utils_Rule
::cleanMoney($submittedValues['soft_credit_amount'][$key]);
1181 $softParams[$key]['soft_credit_type_id'] = $submittedValues['soft_credit_type'][$key];
1182 if (!empty($submittedValues['soft_credit_id'][$key])) {
1183 $softIDs[] = $softParams[$key]['id'] = $submittedValues['soft_credit_id'][$key];
1189 // set the contact, when contact is selected
1190 if (!empty($submittedValues['contact_id'])) {
1191 $this->_contactID
= $submittedValues['contact_id'];
1194 $config = CRM_Core_Config
::singleton();
1196 //Credit Card Contribution.
1198 $this->processCreditCard($submittedValues, $config, $session, $lineItem);
1201 //Offline Contribution.
1202 $submittedValues = $this->unsetCreditCardFields($submittedValues);
1204 // get the required field value only.
1205 $formValues = $submittedValues;
1206 $params = $ids = array();
1208 $params['contact_id'] = $this->_contactID
;
1210 $params['currency'] = $this->getCurrency($submittedValues);
1213 'financial_type_id',
1214 'contribution_status_id',
1215 'payment_instrument_id',
1220 foreach ($fields as $f) {
1221 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1225 $params['pcp'] = $pcp;
1227 if (!empty($softParams)) {
1228 $params['soft_credit'] = $softParams;
1229 $params['soft_credit_ids'] = $softIDs;
1232 //if priceset is used, no need to cleanup money
1235 $params['skipCleanMoney'] = 1;
1244 foreach ($dates as $d) {
1245 $params[$d] = CRM_Utils_Date
::processDate($formValues[$d], $formValues[$d . '_time'], TRUE);
1248 if (!empty($formValues['is_email_receipt'])) {
1249 $params['receipt_date'] = date("Y-m-d");
1252 if ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Cancelled', 'name')
1253 ||
$params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Refunded', 'name')
1255 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value('cancel_date', $params))) {
1256 $params['cancel_date'] = date('Y-m-d');
1260 $params['cancel_date'] = $params['cancel_reason'] = 'null';
1263 // Set is_pay_later flag for back-office offline Pending status contributions CRM-8996
1264 // else if contribution_status is changed to Completed is_pay_later flag is changed to 0, CRM-15041
1265 if ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Pending', 'name')) {
1266 $params['is_pay_later'] = 1;
1268 elseif ($params['contribution_status_id'] == CRM_Core_OptionGroup
::getValue('contribution_status', 'Completed', 'name')) {
1269 $params['is_pay_later'] = 0;
1272 $ids['contribution'] = $params['id'] = $this->_id
;
1274 //Add Additional common information to formatted params
1275 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($formValues, $params, $this);
1277 $params['contribution_mode'] = 'participant';
1278 $params['participant_id'] = $pId;
1279 $params['skipLineItem'] = 1;
1281 elseif ($isRelatedId) {
1282 $params['contribution_mode'] = 'membership';
1284 $params['line_item'] = $lineItem;
1285 $params['payment_processor_id'] = $params['payment_processor'] = CRM_Utils_Array
::value('id', $this->_paymentProcessor
);
1286 if (isset($submittedValues['tax_amount'])) {
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 (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 // assign tax calculation for contribution receipts
1361 $getTaxDetails = FALSE;
1362 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
,'contribution_invoice_settings');
1363 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
1365 if ($this->_action
& CRM_Core_Action
::ADD
) {
1368 elseif ($this->_action
& CRM_Core_Action
::UPDATE
) {
1369 $line = $this->_lineItems
;
1371 foreach ($line as $key => $value) {
1372 foreach ($value as $v) {
1373 if (isset($taxRate[(string) CRM_Utils_Array
::value('tax_rate', $v)])) {
1374 $taxRate[(string) $v['tax_rate']] = $taxRate[(string) $v['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $v);
1377 if (isset($v['tax_rate'])) {
1378 $taxRate[(string) $v['tax_rate']] = CRM_Utils_Array
::value('tax_amount', $v);
1379 $getTaxDetails = TRUE;
1387 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
1388 if (isset($submittedValues['tax_amount'])) {
1389 $totalTaxAmount = $submittedValues['tax_amount'];
1392 $totalTaxAmount = $this->_values
['tax_amount'];
1394 $this->assign('totalTaxAmount', $totalTaxAmount);
1395 $this->assign('dataArray', $taxRate);
1398 if (CRM_Utils_Array
::value('price_set_id', $submittedValues)) {
1399 $this->assign('totalTaxAmount', $submittedValues['tax_amount']);
1400 $this->assign('getTaxDetails', $getTaxDetails);
1401 $this->assign('dataArray', $taxRate);
1402 $this->assign('taxTerm', CRM_Utils_Array
::value('tax_term', $invoiceSettings));
1405 $this->assign('totalTaxAmount', CRM_Utils_Array
::value('tax_amount', $submittedValues));
1410 //send receipt mail.
1411 if ($contribution->id
&& !empty($formValues['is_email_receipt'])) {
1412 $formValues['contact_id'] = $this->_contactID
;
1413 $formValues['contribution_id'] = $contribution->id
;
1415 $formValues +
= CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($contribution->id
);
1417 // to get 'from email id' for send receipt
1418 $this->fromEmailId
= $formValues['from_email_address'];
1419 $sendReceipt = CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $formValues);
1422 $pledgePaymentId = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1428 //update pledge payment status.
1429 if ((($this->_ppID
&& $contribution->id
) && $this->_action
& CRM_Core_Action
::ADD
) ||
1430 (($pledgePaymentId) && $this->_action
& CRM_Core_Action
::UPDATE
)
1434 //store contribution id in payment record.
1435 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $this->_ppID
, 'contribution_id', $contribution->id
);
1438 $this->_ppID
= CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1443 $this->_pledgeID
= CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1450 $adjustTotalAmount = FALSE;
1451 if (CRM_Utils_Array
::value('option_type', $formValues) == 2) {
1452 $adjustTotalAmount = TRUE;
1455 $updatePledgePaymentStatus = FALSE;
1456 //do only if either the status or the amount has changed
1457 if ($this->_action
& CRM_Core_Action
::ADD
) {
1458 $updatePledgePaymentStatus = TRUE;
1460 elseif ($this->_action
& CRM_Core_Action
::UPDATE
&& (($this->_defaults
['contribution_status_id'] != $formValues['contribution_status_id']) ||
1461 ($this->_defaults
['total_amount'] != $formValues['total_amount']))
1463 $updatePledgePaymentStatus = TRUE;
1466 if ($updatePledgePaymentStatus) {
1467 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($this->_pledgeID
,
1468 array($this->_ppID
),
1469 $contribution->contribution_status_id
,
1471 $contribution->total_amount
,
1477 $statusMsg = ts('The contribution record has been saved.');
1478 if (!empty($formValues['is_email_receipt']) && $sendReceipt) {
1479 $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
1482 if ($relatedComponentStatusMsg) {
1483 $statusMsg .= ' ' . $relatedComponentStatusMsg;
1486 CRM_Core_Session
::setStatus($statusMsg, ts('Saved'), 'success');
1487 //Offline Contribution ends.
1489 $buttonName = $this->controller
->getButtonName();
1490 if ($this->_context
== 'standalone') {
1491 if ($buttonName == $this->getButtonName('upload', 'new')) {
1492 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contribute/add',
1493 'reset=1&action=add&context=standalone'
1497 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1498 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
1502 elseif ($this->_context
== 'contribution' && $this->_mode
&& $buttonName == $this->getButtonName('upload', 'new')) {
1503 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
1504 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}&mode={$this->_mode}"
1507 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1508 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
1509 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}"
1513 //store contribution ID if not yet set (on create)
1514 if ( empty($this->_id
) && !empty($contribution->id
) ) {
1515 $this->_id
= $contribution->id
;
1520 * @param $submittedValues
1522 * @param $session CRM_Core_Session
1525 * @throws CRM_Core_Exception
1527 public function processCreditCard($submittedValues, $config, $session, $lineItem) {
1528 $sendReceipt = $contribution = FALSE;
1529 $unsetParams = array(
1531 'payment_instrument_id',
1532 'contribution_status_id',
1536 foreach ($unsetParams as $key) {
1537 if (isset($submittedValues[$key])) {
1538 unset($submittedValues[$key]);
1541 $isTest = ($this->_mode
== 'test') ?
1 : 0;
1542 // CRM-12680 set $_lineItem if its not set
1543 if (empty($this->_lineItem
) && !empty($lineItem)) {
1544 $this->_lineItem
= $lineItem;
1547 //Get the require fields value only.
1548 $params = $this->_params
= $submittedValues;
1550 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($this->_params
['payment_processor_id'],
1554 //get the payment processor id as per mode.
1555 $this->_params
['payment_processor'] = $params['payment_processor_id'] =
1556 $this->_params
['payment_processor_id'] = $submittedValues['payment_processor_id'] = $this->_paymentProcessor
['id'];
1558 $now = date('YmdHis');
1561 // we need to retrieve email address
1562 if ($this->_context
== 'standalone' && !empty($submittedValues['is_email_receipt'])) {
1563 list($this->userDisplayName
,
1565 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
1566 $this->assign('displayName', $this->userDisplayName
);
1569 //set email for primary location.
1570 $fields['email-Primary'] = 1;
1571 $params['email-Primary'] = $this->userEmail
;
1573 // now set the values for the billing location.
1574 foreach (array_keys($this->_fields
) as $name) {
1578 // also add location name to the array
1579 $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);
1580 $params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]);
1581 $fields["address_name-{$this->_bltID}"] = 1;
1583 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
1588 $nameFields = array('first_name', 'middle_name', 'last_name');
1589 foreach ($nameFields as $name) {
1591 if (array_key_exists("billing_$name", $params)) {
1592 $params[$name] = $params["billing_{$name}"];
1593 $params['preserveDBName'] = TRUE;
1597 if (!empty($params['source'])) {
1598 unset($params['source']);
1600 $contactID = CRM_Contact_BAO_Contact
::createProfileContact($params, $fields,
1606 // add all the additional payment params we need
1607 $this->_params
["state_province-{$this->_bltID}"] = $this->_params
["billing_state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($this->_params
["billing_state_province_id-{$this->_bltID}"]);
1608 $this->_params
["country-{$this->_bltID}"] = $this->_params
["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($this->_params
["billing_country_id-{$this->_bltID}"]);
1610 if ($this->_paymentProcessor
['payment_type'] & CRM_Core_Payment
::PAYMENT_TYPE_CREDIT_CARD
) {
1611 $this->_params
['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($this->_params
);
1612 $this->_params
['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($this->_params
);
1614 $this->_params
['ip_address'] = CRM_Utils_System
::ipAddress();
1615 $this->_params
['amount'] = $this->_params
['total_amount'];
1616 $this->_params
['amount_level'] = 0;
1617 $this->_params
['currencyID'] = CRM_Utils_Array
::value('currency',
1619 $config->defaultCurrency
1621 $this->_params
['payment_action'] = 'Sale';
1622 if (!empty($this->_params
['receive_date'])) {
1623 $this->_params
['receive_date'] = CRM_Utils_Date
::processDate($this->_params
['receive_date'], $this->_params
['receive_date_time']);
1626 if (!empty($params['soft_credit_to'])) {
1627 $this->_params
['soft_credit_to'] = $params['soft_credit_to'];
1628 $this->_params
['pcp_made_through_id'] = $params['pcp_made_through_id'];
1631 $this->_params
['pcp_display_in_roll'] = CRM_Utils_Array
::value('pcp_display_in_roll', $params);
1632 $this->_params
['pcp_roll_nickname'] = CRM_Utils_Array
::value('pcp_roll_nickname', $params);
1633 $this->_params
['pcp_personal_note'] = CRM_Utils_Array
::value('pcp_personal_note', $params);
1635 //Add common data to formatted params
1636 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($params, $this->_params
, $this);
1638 if (empty($this->_params
['invoice_id'])) {
1639 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1642 $this->_params
['invoiceID'] = $this->_params
['invoice_id'];
1645 // at this point we've created a contact and stored its address etc
1646 // all the payment processors expect the name and address to be in the
1647 // so we copy stuff over to first_name etc.
1648 $paymentParams = $this->_params
;
1649 $paymentParams['contactID'] = $this->_contactID
;
1650 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
1652 $contributionType = new CRM_Financial_DAO_FinancialType();
1653 $contributionType->id
= $params['financial_type_id'];
1654 if (!$contributionType->find(TRUE)) {
1655 CRM_Core_Error
::fatal('Could not find a system table');
1658 // add some financial type details to the params list
1659 // if folks need to use it
1660 $paymentParams['contributionType_name'] = $this->_params
['contributionType_name'] = $contributionType->name
;
1661 $paymentParams['contributionPageID'] = NULL;
1662 if (!empty($this->_params
['is_email_receipt'])) {
1663 $paymentParams['email'] = $this->userEmail
;
1664 $paymentParams['is_email_receipt'] = 1;
1667 $paymentParams['is_email_receipt'] = 0;
1668 $this->_params
['is_email_receipt'] = 0;
1670 if (!empty($this->_params
['receive_date'])) {
1671 $paymentParams['receive_date'] = $this->_params
['receive_date'];
1674 // For recurring contribution, create Contribution Record first.
1675 // Contribution ID, Recurring ID and Contact ID needed
1676 // When we get a callback from the payment processor, CRM-7115
1677 if (!empty($paymentParams['is_recur'])) {
1678 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1688 $paymentParams['contributionID'] = $contribution->id
;
1689 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1690 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1691 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1694 if ($paymentParams['amount'] > 0.0) {
1695 // force a re-get of the payment processor in case the form changed it, CRM-7179
1696 $payment = CRM_Core_Payment
::singleton($this->_mode
, $this->_paymentProcessor
, $this, TRUE);
1697 $result = $payment->doDirectPayment($paymentParams);
1700 if (is_a($result, 'CRM_Core_Error')) {
1701 //make sure to cleanup db for recurring case.
1702 if (!empty($paymentParams['contributionID'])) {
1703 CRM_Core_Error
::debug_log_message(CRM_Core_Error
::getMessages($result) . "contact id={$this->_contactID} (deleting contribution {$paymentParams['contributionID']}");
1704 CRM_Contribute_BAO_Contribution
::deleteContribution($paymentParams['contributionID']);
1706 if (!empty($paymentParams['contributionRecurID'])) {
1707 CRM_Core_Error
::debug_log_message(CRM_Core_Error
::getMessages($result) . "contact id={$this->_contactID} (deleting recurring contribution {$paymentParams['contributionRecurID']}");
1708 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($paymentParams['contributionRecurID']);
1711 //set the contribution mode.
1712 $urlParams = "action=add&cid={$this->_contactID}";
1714 $urlParams .= "&mode={$this->_mode}";
1716 if (!empty($this->_ppID
)) {
1717 $urlParams .= "&context=pledge&ppid={$this->_ppID}";
1719 CRM_Core_Error
::displaySessionError($result);
1720 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/contribution', $urlParams));
1724 $this->_params
= array_merge($this->_params
, $result);
1727 $this->_params
['receive_date'] = $now;
1729 if (!empty($this->_params
['is_email_receipt'])) {
1730 $this->_params
['receipt_date'] = $now;
1733 $this->_params
['receipt_date'] = CRM_Utils_Date
::processDate($this->_params
['receipt_date'],
1734 $params['receipt_date_time'], TRUE
1738 $this->set('params', $this->_params
);
1739 $this->assign('trxn_id', $result['trxn_id']);
1740 $this->assign('receive_date', $this->_params
['receive_date']);
1742 // result has all the stuff we need
1743 // lets archive it to a financial transaction
1744 if ($contributionType->is_deductible
) {
1745 $this->assign('is_deductible', TRUE);
1746 $this->set('is_deductible', TRUE);
1749 // set source if not set
1750 if (empty($this->_params
['source'])) {
1751 $userID = $session->get('userID');
1752 $userSortName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $userID,
1755 $this->_params
['source'] = ts('Submit Credit Card Payment by: %1', array(1 => $userSortName));
1758 // build custom data getFields array
1759 $customFieldsContributionType = CRM_Core_BAO_CustomField
::getFields('Contribution', FALSE, FALSE,
1760 CRM_Utils_Array
::value('financial_type_id', $params)
1762 $customFields = CRM_Utils_Array
::crmArrayMerge($customFieldsContributionType,
1763 CRM_Core_BAO_CustomField
::getFields('Contribution', FALSE, FALSE, NULL, NULL, TRUE)
1765 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
1772 if (empty($paymentParams['is_recur'])) {
1773 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1784 //send receipt mail.
1785 if ($contribution->id
&& !empty($this->_params
['is_email_receipt'])) {
1786 $this->_params
['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1787 $this->_params
['contact_id'] = $this->_contactID
;
1788 $this->_params
['contribution_id'] = $contribution->id
;
1789 $sendReceipt = CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $this->_params
, TRUE);
1793 if ($contribution->id
&& isset($params['note'])) {
1794 CRM_Contribute_Form_AdditionalInfo
::processNote($params, $contactID, $contribution->id
, NULL);
1797 if ($contribution->id
&& isset($params['product_name'][0])) {
1798 CRM_Contribute_Form_AdditionalInfo
::processPremium($params, $contribution->id
, NULL, $this->_options
);
1801 //update pledge payment status.
1802 if ($this->_ppID
&& $contribution->id
) {
1803 //store contribution id in payment record.
1804 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $this->_ppID
, 'contribution_id', $contribution->id
);
1806 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($this->_pledgeID
,
1807 array($this->_ppID
),
1808 $contribution->contribution_status_id
,
1810 $contribution->total_amount
1814 if ($contribution->id
) {
1815 $statusMsg = ts('The contribution record has been processed.');
1816 if (!empty($this->_params
['is_email_receipt']) && $sendReceipt) {
1817 $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
1819 CRM_Core_Session
::setStatus($statusMsg, ts('Complete'), 'success');