Merge pull request #4012 from pradpnayak/CRM-15206
[civicrm-core.git] / CRM / Contribute / Form / Contribution.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
06b69b18 4 | CiviCRM version 4.5 |
6a488035 5 +--------------------------------------------------------------------+
06b69b18 6 | Copyright CiviCRM LLC (c) 2004-2014 |
6a488035
TO
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26*/
27
28/**
29 *
30 * @package CRM
06b69b18 31 * @copyright CiviCRM LLC (c) 2004-2014
6a488035
TO
32 * $Id$
33 *
34 */
35
36/**
37 * This class generates form components for processing a contribution
38 *
39 */
40class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditPayment {
6a488035 41 /**
d77a0a58 42 * the id of the contribution that we are processing
6a488035
TO
43 *
44 * @var int
45 * @public
46 */
47 public $_id;
48
49 /**
d77a0a58 50 * the id of the premium that we are processing
6a488035
TO
51 *
52 * @var int
53 * @public
54 */
55 public $_premiumID = NULL;
4691b077
EM
56
57 /**
58 * @var CRM_Contribute_DAO_ContributionProduct
59 */
6a488035
TO
60 public $_productDAO = NULL;
61
62 /**
63 * the id of the note
64 *
65 * @var int
66 * @public
67 */
68 public $_noteID;
69
70 /**
71 * the id of the contact associated with this contribution
72 *
73 * @var int
74 * @public
75 */
76 public $_contactID;
77
78 /**
79 * the id of the pledge payment that we are processing
80 *
81 * @var int
82 * @public
83 */
84 public $_ppID;
85
86 /**
87 * the id of the pledge that we are processing
88 *
89 * @var int
90 * @public
91 */
92 public $_pledgeID;
93
94 /**
95 * is this contribution associated with an online
96 * financial transaction
97 *
98 * @var boolean
99 * @public
100 */
101 public $_online = FALSE;
102
103 /**
104 * Stores all product option
105 *
106 * @var array
107 * @public
108 */
109 public $_options;
110
4691b077
EM
111 /**
112 * Storage of parameters from form
113 *
114 * @var array
115 * @public
116 */
117 public $_params;
118
6a488035
TO
119 /**
120 * Store the contribution Type ID
121 *
122 * @var array
123 */
124 public $_contributionType;
125
126 /**
127 * The contribution values if an existing contribution
128 */
129 public $_values;
130
131 /**
132 * The pledge values if this contribution is associated with pledge
133 */
134 public $_pledgeValues;
135
136 public $_contributeMode = 'direct';
137
138 public $_context;
139
5032bf07
EM
140 /**
141 * Parameter with confusing name
142 * @todo what is it?
143 * @var string
144 */
145 public $_compContext;
146
6a488035
TO
147 public $_compId;
148
5032bf07
EM
149 /**
150 * Possible From email addresses
151 * @var array
152 */
153 public $_fromEmails;
d77a0a58
EM
154
155 /**
156 * ID of from email
157 * @var integer
158 */
159 public $fromEmailId;
6a488035
TO
160 /*
161 * Store the line items if price set used.
162 */
163 public $_lineItems;
164
d77a0a58
EM
165 /**
166 * line item
167 * @todo explain why we use lineItem & lineItems
168 * @var array
169 */
170 public $_lineItem;
171
17db9f82 172 /**
efe42cdc 173 * @var array soft credit info
17db9f82
KJ
174 */
175 public $_softCreditInfo;
176
6a488035 177 protected $_formType;
efe42cdc
EM
178
179 /**
180 * @todo what on earth does cdType stand for????
181 * @var
182 */
6a488035 183 protected $_cdType;
1421174e 184 public $_honoreeProfileType;
6a488035 185
4691b077
EM
186 /**
187 * logged in user's email
188 * @var string
189 */
190 public $userEmail;
191
192 /**
193 * Price set ID
194 * @var integer
195 */
196 public $_priceSetId;
197
198
199 /**
200 * Price set as an array
201 * @var array
202 */
203 public $_priceSet;
204
d77a0a58
EM
205 /**
206 * form defaults
207 * @todo can we define this a as protected? can we define higher up the chain
208 * @var array
209 */
210 public $_defaults;
211
212 /**
213 * User display name
214 *
215 * @var string
216 */
217 public $userDisplayName;
6a488035
TO
218 /**
219 * Function to set variables up before form is built
220 *
221 * @return void
222 * @access public
223 */
224 public function preProcess() {
81bc499e 225
6a488035
TO
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'));
229 }
230
231 $this->_cdType = CRM_Utils_Array::value('type', $_GET);
232
233 $this->assign('cdType', FALSE);
234 if ($this->_cdType) {
235 $this->assign('cdType', TRUE);
236 CRM_Custom_Form_CustomData::preProcess($this);
237 return;
238 }
239
240 $this->_formType = CRM_Utils_Array::value('formType', $_GET);
241
242 // get price set id.
243 $this->_priceSetId = CRM_Utils_Array::value('priceSetId', $_GET);
244 $this->set('priceSetId', $this->_priceSetId);
245 $this->assign('priceSetId', $this->_priceSetId);
246
247 //get the pledge payment id
248 $this->_ppID = CRM_Utils_Request::retrieve('ppid', 'Positive', $this);
249
250 //get the contact id
251 $this->_contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
252
253 //get the action.
254 $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
255 $this->assign('action', $this->_action);
256
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);
261 }
262
263 $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this);
264 $this->assign('context', $this->_context);
265
266 $this->_compId = CRM_Utils_Request::retrieve('compId', 'Positive', $this);
267
268 $this->_compContext = CRM_Utils_Request::retrieve('compContext', 'String', $this);
269
270 //set the contribution mode.
271 $this->_mode = CRM_Utils_Request::retrieve('mode', 'String', $this);
272
273 $this->assign('contributionMode', $this->_mode);
274
275 $this->_paymentProcessor = array('billing_mode' => 1);
276
277 $this->assign('showCheckNumber', TRUE);
278
279 $this->_fromEmails = CRM_Core_BAO_Email::getFromEmail();
280 $this->assignProcessors();
281
282 if ($this->_contactID) {
283 list($this->userDisplayName, $this->userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
284 $this->assign('displayName', $this->userDisplayName);
285 }
286
287 // also check for billing information
288 // get the billing location type
289 $this->assignBillingType();
290
291 $this->_fields = array();
292
293 CRM_Core_Payment_Form::setPaymentFieldsByType(CRM_Utils_Array::value('payment_type', $this->_processors), $this);
294
295 if ($this->_action & CRM_Core_Action::DELETE) {
296 return;
297 }
298
d77a0a58 299 if (in_array('CiviPledge', CRM_Core_Config::singleton()->enableComponents) && !$this->_formType) {
6a488035
TO
300 $this->preProcessPledge();
301 }
302
d5397f2f
PJ
303 if ($this->_id) {
304 $this->showRecordLinkMesssage($this->_id);
305 }
6a488035
TO
306 $this->_values = array();
307
308 // current contribution id
309 if ($this->_id) {
310 $this->assignPremiumProduct($this->_id);
311 $this->buildValuesAndAssignOnline_Note_Type($this->_id, $this->_values);
312 }
313
314 // when custom data is included in this page
a7488080 315 if (!empty($_POST['hidden_custom'])) {
6a488035
TO
316 $this->applyCustomData('Contribution', CRM_Utils_Array::value('financial_type_id', $_POST), $this->_id);
317 }
318
319 $this->_lineItems = array();
320 if ($this->_id) {
321 if (!empty($this->_compId) && $this->_compContext == 'participant') {
322 $this->assign('compId', $this->_compId);
323 $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->_compId);
324 }
325 else {
0b71718c 326 $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->_id, 'contribution', 1, TRUE, TRUE);
6a488035
TO
327 }
328 empty($lineItem) ? NULL : $this->_lineItems[] = $lineItem;
329 }
330
331 $this->assign('lineItem', empty($this->_lineItems) ? FALSE : $this->_lineItems);
332
333 // Set title
e2046b33
CW
334 if ($this->_mode) {
335 $this->setPageTitle($this->_ppID ? ts('Credit Card Pledge Payment') : ts('Credit Card Contribution'));
336 }
337 else {
338 $this->setPageTitle($this->_ppID ? ts('Pledge Payment') : ts('Contribution'));
6a488035 339 }
1421174e 340
341 if ($this->_id) {
342 CRM_Contribute_Form_SoftCredit::preprocess($this);
343 }
6a488035
TO
344 }
345
346 function setDefaultValues() {
347 if ($this->_cdType) {
348 return CRM_Custom_Form_CustomData::setDefaultValues($this);
349 }
350
351 $defaults = $this->_values;
352
353 //set defaults for pledge payment.
354 if ($this->_ppID) {
355 $defaults['total_amount'] = CRM_Utils_Array::value('scheduled_amount', $this->_pledgeValues['pledgePayment']);
6a488035
TO
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;
359 }
360
6a488035
TO
361 if ($this->_action & CRM_Core_Action::DELETE) {
362 return $defaults;
363 }
364
dfbad3f7 365 // set soft credit defaults
17db9f82 366 CRM_Contribute_Form_SoftCredit::setDefaultValues($defaults, $this);
dfbad3f7 367
6a488035
TO
368 if ($this->_mode) {
369 $config = CRM_Core_Config::singleton();
5a230af7 370 // set default country from config if no country set
a7488080 371 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
6a488035
TO
372 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry;
373 }
5a230af7 374
a7488080 375 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
6a488035
TO
376 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince;
377 }
378
cc8ff73d
DG
379 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID);
380 $defaults = array_merge($defaults, $billingDefaults);
6a488035
TO
381 }
382
383 if ($this->_id) {
384 $this->_contactID = $defaults['contact_id'];
385 }
5a230af7 386
6a488035 387 // Set $newCredit variable in template to control whether link to credit card mode is included
9be1374d 388 $this->assign('newCredit', CRM_Core_Config::isEnabledBackOfficeCreditCardPayments());
5a230af7 389
6a488035
TO
390 // fix the display of the monetary value, CRM-4038
391 if (isset($defaults['total_amount'])) {
392 $defaults['total_amount'] = CRM_Utils_Money::format($defaults['total_amount'], NULL, '%a');
393 }
394
395 if (isset($defaults['non_deductible_amount'])) {
396 $defaults['non_deductible_amount'] = CRM_Utils_Money::format($defaults['non_deductible_amount'], NULL, '%a');
397 }
398
399 if (isset($defaults['fee_amount'])) {
400 $defaults['fee_amount'] = CRM_Utils_Money::format($defaults['fee_amount'], NULL, '%a');
401 }
402
403 if (isset($defaults['net_amount'])) {
404 $defaults['net_amount'] = CRM_Utils_Money::format($defaults['net_amount'], NULL, '%a');
405 }
406
407 if ($this->_contributionType) {
408 $defaults['financial_type_id'] = $this->_contributionType;
409 }
133e2c99 410
a7488080 411 if (empty($defaults['payment_instrument_id'])) {
d96cf288
DG
412 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
413 }
6a488035 414
a7488080 415 if (!empty($defaults['is_test'])) {
6a488035
TO
416 $this->assign('is_test', TRUE);
417 }
418
6a488035
TO
419 $this->assign('showOption', TRUE);
420 // for Premium section
421 if ($this->_premiumID) {
422 $this->assign('showOption', FALSE);
423 $options = isset($this->_options[$this->_productDAO->product_id]) ? $this->_options[$this->_productDAO->product_id] : "";
424 if (!$options) {
425 $this->assign('showOption', TRUE);
426 }
427 $options_key = CRM_Utils_Array::key($this->_productDAO->product_option, $options);
428 if ($options_key) {
429 $defaults['product_name'] = array($this->_productDAO->product_id, trim($options_key));
430 }
431 else {
432 $defaults['product_name'] = array($this->_productDAO->product_id);
433 }
434 if ($this->_productDAO->fulfilled_date) {
435 list($defaults['fulfilled_date']) = CRM_Utils_Date::setDateDefaults($this->_productDAO->fulfilled_date);
436 }
437 }
438
439 if (isset($this->userEmail)) {
440 $this->assign('email', $this->userEmail);
441 }
442
a7488080 443 if (!empty($defaults['is_pay_later'])) {
6a488035
TO
444 $this->assign('is_pay_later', TRUE);
445 }
446 $this->assign('contribution_status_id', CRM_Utils_Array::value('contribution_status_id', $defaults));
447
448 $dates = array('receive_date', 'receipt_date', 'cancel_date', 'thankyou_date');
449 foreach ($dates as $key) {
a7488080 450 if (!empty($defaults[$key])) {
6a488035
TO
451 list($defaults[$key],
452 $defaults[$key . '_time']
453 ) = CRM_Utils_Date::setDateDefaults(CRM_Utils_Array::value($key, $defaults),
454 'activityDateTime'
455 );
456 }
457 }
458
8cc574cf 459 if (!$this->_id && empty($defaults['receive_date'])) {
6a488035
TO
460 list($defaults['receive_date'],
461 $defaults['receive_date_time']
462 ) = CRM_Utils_Date::setDateDefaults(NULL, 'activityDateTime');
463 }
464
465 $this->assign('receive_date', CRM_Utils_Date::processDate(CRM_Utils_Array::value('receive_date', $defaults),
466 CRM_Utils_Array::value('receive_date_time', $defaults)
467 ));
468 $currency = CRM_Utils_Array::value('currency', $defaults);
469 $this->assign('currency', $currency);
470 // Hack to get currency info to the js layer. CRM-11440
471 CRM_Utils_Money::format(1);
472 $this->assign('currencySymbol', CRM_Utils_Array::value($currency, CRM_Utils_Money::$_currencySymbols));
473 $this->assign('totalAmount', CRM_Utils_Array::value('total_amount', $defaults));
474
475 //inherit campaign from pledge.
8cc574cf 476 if ($this->_ppID && !empty($this->_pledgeValues['campaign_id'])) {
6a488035
TO
477 $defaults['campaign_id'] = $this->_pledgeValues['campaign_id'];
478 }
479
480 $this->_defaults = $defaults;
481 return $defaults;
482 }
483
484 /**
485 * Function to build the form
486 *
487 * @return void
488 * @access public
489 */
490 public function buildQuickForm() {
491 if ($this->_cdType) {
492 CRM_Custom_Form_CustomData::buildQuickForm($this);
493 return;
494 }
5032bf07 495 $allPanes = array();
6a488035
TO
496
497 // build price set form.
498 $buildPriceSet = FALSE;
499 if (empty($this->_lineItems) &&
8cc574cf 500 ($this->_priceSetId || !empty($_POST['price_set_id']))
6a488035
TO
501 ) {
502 $buildPriceSet = TRUE;
503 $getOnlyPriceSetElements = TRUE;
504 if (!$this->_priceSetId) {
505 $this->_priceSetId = $_POST['price_set_id'];
506 $getOnlyPriceSetElements = FALSE;
507 }
508
509 $this->set('priceSetId', $this->_priceSetId);
9da8dc8c 510 CRM_Price_BAO_PriceSet::buildPriceSet($this);
6a488035
TO
511
512 // get only price set form elements.
513 if ($getOnlyPriceSetElements) {
514 return;
515 }
516 }
517 // use to build form during form rule.
518 $this->assign('buildPriceSet', $buildPriceSet);
519
520 $showAdditionalInfo = FALSE;
521
6a488035
TO
522 $defaults = $this->_values;
523 $additionalDetailFields = array(
524 'note',
525 'thankyou_date',
526 'invoice_id',
527 'non_deductible_amount',
528 'fee_amount',
dfbad3f7 529 'net_amount',
6a488035
TO
530 );
531 foreach ($additionalDetailFields as $key) {
532 if (!empty($defaults[$key])) {
533 $defaults['hidden_AdditionalDetail'] = 1;
534 break;
535 }
536 }
537
6a488035
TO
538 if ($this->_productDAO) {
539 if ($this->_productDAO->product_id) {
540 $defaults['hidden_Premium'] = 1;
541 }
542 }
543
544 if ($this->_noteID &&
545 isset($this->_values['note'])
546 ) {
547 $defaults['hidden_AdditionalDetail'] = 1;
548 }
549
550 $paneNames = array(
551 ts('Additional Details') => 'AdditionalDetail',
6a488035
TO
552 );
553
554 //Add Premium pane only if Premium is exists.
555 $dao = new CRM_Contribute_DAO_Product();
556 $dao->is_active = 1;
557
558 if ($dao->find(TRUE)) {
559 $paneNames[ts('Premium Information')] = 'Premium';
560 }
561
562 $ccPane = NULL;
563 if ($this->_mode) {
564 if (CRM_Utils_Array::value('payment_type', $this->_processors) & CRM_Core_Payment::PAYMENT_TYPE_DIRECT_DEBIT
565 ) {
566 $ccPane = array(ts('Direct Debit Information') => 'DirectDebit');
567 }
568 else {
569 $ccPane = array(ts('Credit Card Information') => 'CreditCard');
570 }
571 }
572 if (is_array($ccPane)) {
573 $paneNames = array_merge($ccPane, $paneNames);
574 }
575
576 $buildRecurBlock = FALSE;
577 foreach ($paneNames as $name => $type) {
578 $urlParams = "snippet=4&formType={$type}";
579 if ($this->_mode) {
580 $urlParams .= "&mode={$this->_mode}";
581 }
582
583 $open = 'false';
584 if ($type == 'CreditCard' ||
585 $type == 'DirectDebit'
586 ) {
587 $open = 'true';
588 }
589
590 $allPanes[$name] = array(
591 'url' => CRM_Utils_System::url('civicrm/contact/view/contribution', $urlParams),
592 'open' => $open,
593 'id' => $type
594 );
595
596 // see if we need to include this paneName in the current form
8cc574cf 597 if ($this->_formType == $type || !empty($_POST["hidden_{$type}"]) ||
6a488035
TO
598 CRM_Utils_Array::value("hidden_{$type}", $defaults)
599 ) {
600 $showAdditionalInfo = TRUE;
601 $allPanes[$name]['open'] = 'true';
602 }
603
604 if ($type == 'CreditCard') {
605 $buildRecurBlock = TRUE;
606 $this->add('hidden', 'hidden_CreditCard', 1);
607 CRM_Core_Payment_Form::buildCreditCard($this, TRUE);
608 }
609 elseif ($type == 'DirectDebit') {
610 $buildRecurBlock = TRUE;
611 $this->add('hidden', 'hidden_DirectDebit', 1);
612 CRM_Core_Payment_Form::buildDirectDebit($this, TRUE);
613 }
614 else {
d37ade2e 615 $additionalInfoFormFunction = 'build' . $type;
616 CRM_Contribute_Form_AdditionalInfo::$additionalInfoFormFunction($this);
6a488035
TO
617 }
618 }
619 if (empty($this->_recurPaymentProcessors)) {
620 $buildRecurBlock = FALSE;
621 }
622 if ($buildRecurBlock) {
623 CRM_Contribute_Form_Contribution_Main::buildRecur($this);
624 $this->setDefaults(array('is_recur' => 0));
625 }
626 $this->assign('buildRecurBlock', $buildRecurBlock);
627 $qfKey = $this->controller->_key;
628 $this->assign('qfKey', $qfKey);
629 $this->assign('allPanes', $allPanes);
630 $this->assign('showAdditionalInfo', $showAdditionalInfo);
631
632 if ($this->_formType) {
633 $this->assign('formType', $this->_formType);
634 return;
635 }
636
637 $this->applyFilter('__ALL__', 'trim');
5a230af7 638
6a488035
TO
639 if ($this->_action & CRM_Core_Action::DELETE) {
640 $this->addButtons(array(
641 array(
642 'type' => 'next',
643 'name' => ts('Delete'),
644 'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
645 'isDefault' => TRUE,
646 ),
647 array(
648 'type' => 'cancel',
649 'name' => ts('Cancel')
650 )
651 )
652 );
653 return;
654 }
655
656 //need to assign custom data type and subtype to the template
657 $this->assign('customDataType', 'Contribution');
658 $this->assign('customDataSubType', $this->_contributionType);
659 $this->assign('entityID', $this->_id);
660
661 if ($this->_context == 'standalone') {
ae8f569f 662 $this->addEntityRef('contact_id', ts('Contact'), array('create' => TRUE, 'api' => array('extra' => array('email'))), TRUE);
6a488035
TO
663 }
664
665 $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution');
666
667 $financialType = $this->add('select', 'financial_type_id',
668 ts('Financial Type'),
669 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::financialType(),
79ca865b
CW
670 TRUE,
671 array('onChange' => "CRM.buildCustomData( 'Contribution', this.value );")
6a488035 672 );
d77a0a58 673 $paymentInstrument = FALSE;
6a488035
TO
674 if (!$this->_mode) {
675 $paymentInstrument = $this->add('select', 'payment_instrument_id',
676 ts('Paid By'),
677 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::paymentInstrument(),
d96cf288 678 TRUE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
6a488035
TO
679 );
680 }
681
ce22fda6 682 $trxnId = $this->add('text', 'trxn_id', ts('Transaction ID'), array('class' => 'twelve') + $attributes['trxn_id']);
6a488035
TO
683
684 //add receipt for offline contribution
685 $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
686
687 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails);
688
689 $status = CRM_Contribute_PseudoConstant::contributionStatus();
690
691 // suppressing contribution statuses that are NOT relevant to pledges (CRM-5169)
692 $statusName = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
693 if ($this->_ppID) {
694 foreach (array(
695 'Cancelled',
696 'Failed',
697 'In Progress'
698 ) as $suppress) {
699 unset($status[CRM_Utils_Array::key($suppress, $statusName)]);
700 }
701 }
702 elseif ((!$this->_ppID && $this->_id) || !$this->_id) {
f73acc78
PN
703 $suppressFlag = FALSE;
704 if ($this->_id) {
705 $componentDetails = CRM_Contribute_BAO_Contribution::getComponentDetails($this->_id);
706 if (CRM_Utils_Array::value('membership', $componentDetails) || CRM_Utils_Array::value('participant', $componentDetails)) {
707 $suppressFlag = TRUE;
708 }
709 }
710 if (!$suppressFlag) {
711 foreach (array(
712 'Overdue',
713 'In Progress'
714 ) as $suppress) {
715 unset($status[CRM_Utils_Array::key($suppress, $statusName)]);
716 }
717 }
718 else {
719 unset($status[CRM_Utils_Array::key('Overdue', $statusName)]);
6a488035
TO
720 }
721 }
b6545333 722
6a488035
TO
723 if ($this->_id) {
724 $contributionStatus = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_id, 'contribution_status_id');
725 $name = CRM_Utils_Array::value($contributionStatus, $statusName);
d37ade2e 726 switch ($name) {
6a488035
TO
727 case 'Completed':
728 case 'Cancelled':
729 case 'Refunded':
f73acc78 730 unset($status[CRM_Utils_Array::key('In Progress', $statusName)]);
6a488035
TO
731 unset($status[CRM_Utils_Array::key('Pending', $statusName)]);
732 unset($status[CRM_Utils_Array::key('Failed', $statusName)]);
733 break;
734 case 'Pending':
f73acc78 735 case 'In Progress':
6a488035
TO
736 unset($status[CRM_Utils_Array::key('Refunded', $statusName)]);
737 break;
738 case 'Failed':
d37ade2e 739 foreach (array(
740 'Pending',
741 'Refunded',
742 'Completed',
f73acc78 743 'In Progress',
d37ade2e 744 'Cancelled'
745 ) as $suppress) {
6a488035
TO
746 unset($status[CRM_Utils_Array::key($suppress, $statusName)]);
747 }
748 break;
749 }
d37ade2e 750 }
751 else {
6a488035
TO
752 unset($status[CRM_Utils_Array::key('Refunded', $statusName)]);
753 }
754
755 $this->add('select', 'contribution_status_id',
756 ts('Contribution Status'),
757 $status,
758 FALSE
759 );
760
761 // add various dates
762 $this->addDateTime('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
763
764 if ($this->_online) {
765 $this->assign('hideCalender', TRUE);
766 }
767 $checkNumber = $this->add('text', 'check_number', ts('Check Number'), $attributes['check_number']);
768
769 $this->addDateTime('receipt_date', ts('Receipt Date'), FALSE, array('formatType' => 'activityDateTime'));
770 $this->addDateTime('cancel_date', ts('Cancelled / Refunded Date'), FALSE, array('formatType' => 'activityDateTime'));
771
772 $this->add('textarea', 'cancel_reason', ts('Cancellation / Refund Reason'), $attributes['cancel_reason']);
773
774 $recurJs = NULL;
775 if ($buildRecurBlock) {
776 $recurJs = array('onChange' => "buildRecurBlock( this.value ); return false;");
777 }
778 $element = $this->add('select',
779 'payment_processor_id',
780 ts('Payment Processor'),
781 $this->_processors,
782 NULL,
783 $recurJs
784 );
785
786 if ($this->_online) {
787 $element->freeze();
788 }
789 $totalAmount = NULL;
790 if (empty($this->_lineItems)) {
791 $buildPriceSet = FALSE;
9da8dc8c 792 $priceSets = CRM_Price_BAO_PriceSet::getAssoc(FALSE, 'CiviContribute');
6a488035
TO
793 if (!empty($priceSets) && !$this->_ppID) {
794 $buildPriceSet = TRUE;
795 }
796
797 // don't allow price set for contribution if it is related to participant, or if it is a pledge payment
798 // and if we already have line items for that participant. CRM-5095
799 if ($buildPriceSet && $this->_id) {
800 $componentDetails = CRM_Contribute_BAO_Contribution::getComponentDetails($this->_id);
801 $pledgePaymentId = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
802 $this->_id,
803 'id',
804 'contribution_id'
805 );
806 if ($pledgePaymentId) {
807 $buildPriceSet = FALSE;
808 }
809 if ($participantID = CRM_Utils_Array::value('participant', $componentDetails)) {
810 $participantLI = CRM_Price_BAO_LineItem::getLineItems($participantID);
811 if (!CRM_Utils_System::isNull($participantLI)) {
812 $buildPriceSet = FALSE;
813 }
814 }
815 }
816
817 $hasPriceSets = FALSE;
818 if ($buildPriceSet) {
819 $hasPriceSets = TRUE;
820 $element = $this->add('select', 'price_set_id', ts('Choose price set'),
821 array(
822 '' => ts('Choose price set')
823 ) + $priceSets,
824 NULL, array('onchange' => "buildAmount( this.value );")
5a230af7 825 );
6a488035
TO
826 if ($this->_online && !($this->_action & CRM_Core_Action::UPDATE)) {
827 $element->freeze();
828 }
829 }
830 $this->assign('hasPriceSets', $hasPriceSets);
831 $currencyFreeze = FALSE;
832 if (!($this->_action & CRM_Core_Action::UPDATE)) {
d37ade2e 833 if ($this->_online || $this->_ppID) {
834 $attributes['total_amount'] = array_merge($attributes['total_amount'], array(
835 'READONLY' => TRUE,
836 'style' => "background-color:#EBECE4"
837 ));
838 $optionTypes = array(
839 '1' => ts('Adjust Pledge Payment Schedule?'),
840 '2' => ts('Adjust Total Pledge Amount?'),
841 );
842 $this->addRadio('option_type',
843 NULL,
844 $optionTypes,
845 array(), '<br/>'
846 );
847
848 $currencyFreeze = TRUE;
849 }
6a488035
TO
850 }
851
852 $totalAmount = $this->addMoney('total_amount',
853 ts('Total Amount'),
854 ($hasPriceSets) ? FALSE : TRUE,
855 $attributes['total_amount'],
856 TRUE, 'currency', NULL, $currencyFreeze
857 );
858 }
859
860 $this->add('text', 'source', ts('Source'), CRM_Utils_Array::value('source', $attributes));
861
862 //CRM-7362 --add campaigns.
863 CRM_Campaign_BAO_Campaign::addCampaign($this, CRM_Utils_Array::value('campaign_id', $this->_values));
864
0baed70b 865 CRM_Contribute_Form_SoftCredit::buildQuickForm($this);
0baed70b 866
6a488035
TO
867 $js = NULL;
868 if (!$this->_mode) {
869 $js = array('onclick' => "return verify( );");
870 }
871
872 $mailingInfo = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
873 'mailing_backend'
874 );
875 $this->assign('outBound_option', $mailingInfo['outBound_option']);
876
877 $this->addButtons(array(
878 array(
879 'type' => 'upload',
880 'name' => ts('Save'),
881 'js' => $js,
882 'isDefault' => TRUE
883 ),
884 array(
885 'type' => 'upload',
886 'name' => ts('Save and New'),
887 'js' => $js,
888 'subName' => 'new'
889 ),
890 array(
891 'type' => 'cancel',
892 'name' => ts('Cancel')
893 ),
894 )
895 );
896
897 // if status is Cancelled freeze Amount, Payment Instrument, Check #, Financial Type,
898 // Net and Fee Amounts are frozen in AdditionalInfo::buildAdditionalDetail
899 if ($this->_id && $this->_values['contribution_status_id'] == array_search('Cancelled', $statusName)) {
5a230af7 900 if ($totalAmount) {
6a488035
TO
901 $totalAmount->freeze();
902 }
903 $checkNumber->freeze();
904 $paymentInstrument->freeze();
905 $trxnId->freeze();
906 $financialType->freeze();
907 }
908
909 $this->addFormRule(array('CRM_Contribute_Form_Contribution', 'formRule'), $this);
910
911 if ($this->_action & CRM_Core_Action::VIEW) {
912 $this->freeze();
913 }
914 }
915
916 /**
917 * global form rule
918 *
2a6da8d7
EM
919 * @param array $fields the input form values
920 * @param array $files the uploaded files if any
921 * @param $self
922 *
923 * @internal param array $options additional user data
6a488035
TO
924 *
925 * @return true if no errors, else array of errors
926 * @access public
927 * @static
928 */
929 static function formRule($fields, $files, $self) {
930 $errors = array();
931
6a488035
TO
932 //check for Credit Card Contribution.
933 if ($self->_mode) {
934 if (empty($fields['payment_processor_id'])) {
935 $errors['payment_processor_id'] = ts('Payment Processor is a required field.');
936 }
937 }
938
939 // do the amount validations.
a7488080 940 if (empty($fields['total_amount']) && empty($self->_lineItems)) {
6a488035 941 if ($priceSetId = CRM_Utils_Array::value('price_set_id', $fields)) {
9da8dc8c 942 CRM_Price_BAO_PriceField::priceSetValidation($priceSetId, $fields, $errors);
6a488035
TO
943 }
944 }
945
b326919b 946 $softErrors = CRM_Contribute_Form_SoftCredit::formRule($fields, $errors, $self);
5f6d46e1 947
3256b416
JM
948 if (!empty($fields['total_amount']) && (!empty($fields['net_amount']) || !empty($fields['fee_amount']))) {
949 $sum = CRM_Utils_Rule::cleanMoney($fields['net_amount']) + CRM_Utils_Rule::cleanMoney($fields['fee_amount']);
950 if (CRM_Utils_Rule::cleanMoney($fields['total_amount']) != $sum) {
6a488035
TO
951 $errors['total_amount'] = ts('The sum of fee amount and net amount must be equal to total amount');
952 }
953 }
954 //form rule for status http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
955 if ($self->_id && $self->_values['contribution_status_id'] != $fields['contribution_status_id']) {
956 CRM_Contribute_BAO_Contribution::checkStatusValidation($self->_values, $fields, $errors);
957 }
958
959 //FIXME FOR NEW DATA FLOW http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
a7488080 960 if (!empty($fields['fee_amount']) && $financialType = CRM_Contribute_BAO_Contribution::validateFinancialType($fields['financial_type_id'])) {
51fa20cb 961 $errors['financial_type_id'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
6a488035 962 }
133e2c99 963
7272e4fa
DG
964 // $trxn_id must be unique CRM-13919
965 if (!empty($fields['trxn_id'])) {
966 $queryParams = array(1 => array($fields['trxn_id'], 'String'));
967 $query = 'select count(*) from civicrm_contribution where trxn_id = %1';
968 if ($self->_id) {
969 $queryParams[2] = array((int)$self->_id, 'Integer');
970 $query .= ' and id !=%2';
971 }
972 $tCnt = CRM_Core_DAO::singleValueQuery($query, $queryParams);
973 if ($tCnt) {
974 $errors['trxn_id'] = ts('Transaction ID\'s must be unique. Transaction \'%1\' already exists in your database.', array(1 => $fields['trxn_id']));
133e2c99 975 }
7272e4fa 976 }
d37ade2e 977
ac0c89ed 978 $errors = array_merge($errors, $softErrors);
6a488035
TO
979 return $errors;
980 }
981
982 /**
983 * Function to process the form
984 *
985 * @access public
986 *
987 * @return void
988 */
989 public function postProcess() {
990 $session = CRM_Core_Session::singleton();
d77a0a58
EM
991 $sendReceipt = $pId = $contribution = FALSE;
992 $softParams = $softIDs =array();
993
6a488035
TO
994 if ($this->_action & CRM_Core_Action::DELETE) {
995 CRM_Contribute_BAO_Contribution::deleteContribution($this->_id);
996 $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
997 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
998 ));
999 return;
1000 }
1001
1002 // get the submitted form values.
1003 $submittedValues = $this->controller->exportValues($this->_name);
a7488080 1004 if (!empty($submittedValues['price_set_id']) && $this->_action & CRM_Core_Action::UPDATE) {
d37ade2e 1005 $line = CRM_Price_BAO_LineItem::getLineItems($this->_id, 'contribution');
6a488035 1006 $lineID = key($line);
9da8dc8c 1007 $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', CRM_Utils_Array::value('price_field_id', $line[$lineID]), 'price_set_id');
1008 $quickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
6a488035
TO
1009 if ($quickConfig) {
1010 CRM_Price_BAO_LineItem::deleteLineItems($this->_id, 'civicrm_contribution');
1011 }
1012 }
1013
1014 // process price set and get total amount and line items.
1015 $lineItem = array();
6a488035
TO
1016 $priceSetId = CRM_Utils_Array::value('price_set_id', $submittedValues);
1017 if (empty($priceSetId) && !$this->_id) {
9da8dc8c 1018 $this->_priceSetId = $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', 'default_contribution_amount', 'id', 'name');
1019 $this->_priceSet = current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId));
6a488035
TO
1020 $fieldID = key($this->_priceSet['fields']);
1021 $fieldValueId = key($this->_priceSet['fields'][$fieldID]['options']);
1022 $this->_priceSet['fields'][$fieldID]['options'][$fieldValueId]['amount'] = $submittedValues['total_amount'];
1023 $submittedValues['price_' . $fieldID] = 1;
1024 }
1025
1026 if ($priceSetId) {
9da8dc8c 1027 CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'],
5a230af7 1028 $submittedValues, $lineItem[$priceSetId]);
1029
6a488035
TO
1030 $submittedValues['total_amount'] = CRM_Utils_Array::value('amount', $submittedValues);
1031 }
1032 if ($this->_id) {
1033 //CRM-10964
5a230af7 1034 $pId = ($this->_compId && $this->_context == 'participant') ? $this->_compId : CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id, 'participant_id', 'contribution_id');
6a488035 1035 }
8cc574cf 1036 if (!$priceSetId && !empty($submittedValues['total_amount']) && $this->_id) {
6a488035
TO
1037 // 10117 update th line items for participants
1038 if ($pId) {
1039 $entityTable = 'participant';
1040 $entityID = $pId;
1041 $participantParams = array(
1042 'fee_amount' => $submittedValues['total_amount'],
1043 'id' => $entityID
1044 );
1045 CRM_Event_BAO_Participant::add($participantParams);
1046 if (empty($this->_lineItems)) {
01e72fbc 1047 $this->_lineItems[] = CRM_Price_BAO_LineItem::getLineItems($entityID, 'participant', 1);
6a488035 1048 }
d37ade2e 1049 }
1050 else {
6a488035
TO
1051 $entityTable = 'contribution';
1052 $entityID = $this->_id;
1053 }
1054
1055 $lineItems = CRM_Price_BAO_LineItem::getLineItems($entityID, $entityTable);
5af5956c
CB
1056 foreach (array_keys($lineItems) as $id) {
1057 $lineItems[$id]['id'] = $id;
1058 }
6a488035 1059 $itemId = key($lineItems);
8cc574cf 1060 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
870f2eec
PJ
1061 $this->_priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1062 }
1063
1064 if ($this->_priceSetId && CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config')) {
1065 $lineItems[$itemId]['unit_price'] = $lineItems[$itemId]['line_total'] = CRM_Utils_Rule::cleanMoney(CRM_Utils_Array::value('total_amount', $submittedValues));
6a488035 1066 }
6a488035 1067 // 10117 update th line items for participants
32cb2feb 1068 if (!empty($lineItems[$itemId]['price_field_id'])) {
32cb2feb
CW
1069 $lineItem[$this->_priceSetId] = $lineItems;
1070 }
6a488035
TO
1071 }
1072 $isQuickConfig = 0;
9da8dc8c 1073 if ($this->_priceSetId && CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config')) {
6a488035
TO
1074 $isQuickConfig = 1;
1075 }
d77a0a58 1076 //CRM-11529 for quick config back office transactions
5a230af7 1077 //when financial_type_id is passed in form, update the
d77a0a58 1078 //line items with the financial type selected in form
8cc574cf 1079 if ($isQuickConfig && !empty($submittedValues['financial_type_id']) && CRM_Utils_Array::value($this->_priceSetId, $lineItem)
d37ade2e 1080 ) {
6a488035
TO
1081 foreach ($lineItem[$this->_priceSetId] as &$values) {
1082 $values['financial_type_id'] = $submittedValues['financial_type_id'];
1083 }
1084 }
5a230af7 1085
3b557cc8 1086 if (!isset($submittedValues['total_amount'])) {
6a488035
TO
1087 $submittedValues['total_amount'] = CRM_Utils_Array::value('total_amount', $this->_values);
1088 }
1089 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ? $lineItem : FALSE);
1090
a7488080 1091 if (!empty($submittedValues['pcp_made_through_id'])) {
912e7aaa 1092 $pcp = array();
d37ade2e 1093 $fields = array(
1094 'pcp_made_through_id',
1095 'pcp_display_in_roll',
1096 'pcp_roll_nickname',
1097 'pcp_personal_note',
1098 );
ce8be7f2 1099 foreach ($fields as $f) {
1100 $pcp[$f] = CRM_Utils_Array::value($f, $submittedValues);
1101 }
cd0a30ac 1102 }
b6545333 1103
1104 $isEmpty = array_keys(array_flip($submittedValues['soft_credit_contact_id']));
1105 if ($this->_id && count($isEmpty) == 1 && key($isEmpty) == NULL) {
1106 //Delete existing soft credit records if soft credit list is empty on update
1107 CRM_Contribute_BAO_ContributionSoft::del(array('contribution_id' => $this->_id));
1108 }
cd0a30ac 1109 else {
b6545333 1110 //build soft credit params
b6545333 1111 foreach ($submittedValues['soft_credit_contact_id'] as $key => $val) {
1112 if ($val && $submittedValues['soft_credit_amount'][$key]) {
1113 $softParams[$key]['contact_id'] = $val;
1114 $softParams[$key]['amount'] = CRM_Utils_Rule::cleanMoney($submittedValues['soft_credit_amount'][$key]);
1115 $softParams[$key]['soft_credit_type_id'] = $submittedValues['soft_credit_type'][$key];
1116 if (!empty($submittedValues['soft_credit_id'][$key])) {
1117 $softIDs[] = $softParams[$key]['id'] = $submittedValues['soft_credit_id'][$key];
cd0a30ac 1118 }
1119 }
d37ade2e 1120 }
cd0a30ac 1121 }
1122
6a488035 1123 // set the contact, when contact is selected
ccec9d6b
CW
1124 if (!empty($submittedValues['contact_id'])) {
1125 $this->_contactID = $submittedValues['contact_id'];
6a488035
TO
1126 }
1127
1128 $config = CRM_Core_Config::singleton();
1129
1130 //Credit Card Contribution.
1131 if ($this->_mode) {
d77a0a58 1132 $this->processCreditCard($submittedValues, $config, $session, $lineItem);
6a488035
TO
1133 }
1134 else {
1135 //Offline Contribution.
1136 $submittedValues = $this->unsetCreditCardFields($submittedValues);
1137
1138 // get the required field value only.
1139 $formValues = $submittedValues;
1140 $params = $ids = array();
1141
1142 $params['contact_id'] = $this->_contactID;
1143
1144 $params['currency'] = $this->getCurrency($submittedValues);
1145
1146 $fields = array(
1147 'financial_type_id',
1148 'contribution_status_id',
1149 'payment_instrument_id',
1150 'cancel_reason',
1151 'source',
1152 'check_number',
6a488035
TO
1153 );
1154 foreach ($fields as $f) {
1155 $params[$f] = CRM_Utils_Array::value($f, $formValues);
1156 }
ce8be7f2 1157
1158 if (!empty($pcp)) {
3f662d9d 1159 $params['pcp'] = $pcp;
ce8be7f2 1160 }
cd0a30ac 1161 if (!empty($softParams)) {
3f662d9d 1162 $params['soft_credit'] = $softParams;
2cfc0f58 1163 $params['soft_credit_ids'] = $softIDs;
6a488035 1164 }
3f662d9d 1165
6a488035
TO
1166 //if priceset is used, no need to cleanup money
1167 //CRM-5740
1168 if ($priceSetId) {
1169 $params['skipCleanMoney'] = 1;
1170 }
1171
1172 $dates = array(
1173 'receive_date',
1174 'receipt_date',
1175 'cancel_date',
1176 );
1177
1178 foreach ($dates as $d) {
1179 $params[$d] = CRM_Utils_Date::processDate($formValues[$d], $formValues[$d . '_time'], TRUE);
1180 }
1181
a7488080 1182 if (!empty($formValues['is_email_receipt'])) {
6a488035
TO
1183 $params['receipt_date'] = date("Y-m-d");
1184 }
1185
1186 if ($params['contribution_status_id'] == CRM_Core_OptionGroup::getValue('contribution_status', 'Cancelled', 'name')
d37ade2e 1187 || $params['contribution_status_id'] == CRM_Core_OptionGroup::getValue('contribution_status', 'Refunded', 'name')
1188 ) {
6a488035 1189 if (CRM_Utils_System::isNull(CRM_Utils_Array::value('cancel_date', $params))) {
d37ade2e 1190 $params['cancel_date'] = date('Y-m-d');
6a488035
TO
1191 }
1192 }
1193 else {
d37ade2e 1194 $params['cancel_date'] = $params['cancel_reason'] = 'null';
6a488035
TO
1195 }
1196
1197 // Set is_pay_later flag for back-office offline Pending status contributions CRM-8996
5f6d46e1 1198 // else if contribution_status is changed to Completed is_pay_later flag is changed to 0, CRM-15041
6a488035
TO
1199 if ($params['contribution_status_id'] == CRM_Core_OptionGroup::getValue('contribution_status', 'Pending', 'name')) {
1200 $params['is_pay_later'] = 1;
1201 }
5f6d46e1 1202 elseif ($params['contribution_status_id'] == CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name')) {
1203 $params['is_pay_later'] = 0;
1204 }
6a488035
TO
1205
1206 $ids['contribution'] = $params['id'] = $this->_id;
1207
1208 //Add Additional common information to formatted params
1209 CRM_Contribute_Form_AdditionalInfo::postProcessCommon($formValues, $params, $this);
1210 if ($pId) {
1211 $params['contribution_mode'] = 'participant';
1212 $params['participant_id'] = $pId;
464bb009 1213 $params['skipLineItem'] = 1;
6a488035
TO
1214 }
1215 $params['line_item'] = $lineItem;
1216 $params['payment_processor_id'] = $params['payment_processor'] = CRM_Utils_Array::value('id', $this->_paymentProcessor);
1217 //create contribution.
1218 if ($isQuickConfig) {
1219 $params['is_quick_config'] = 1;
1220 }
1221
1222 // CRM-11956
d77a0a58 1223 // if non_deductible_amount exists i.e. Additional Details field set was opened [and staff typed something] -
6a488035
TO
1224 // if non_deductible_amount does NOT exist - then calculate it depending on:
1225 // $ContributionType->is_deductible and whether there is a product (premium).
d77a0a58 1226 if (!isset($params['non_deductible_amount']) || (!empty($params['non_deductible_amount']))) {
6a488035
TO
1227 $contributionType = new CRM_Financial_DAO_FinancialType();
1228 $contributionType->id = $params['financial_type_id'];
1229 if (!$contributionType->find(TRUE)) {
1230 CRM_Core_Error::fatal('Could not find a system table');
1231 }
1232 if ($contributionType->is_deductible) {
1233
1234 if (isset($formValues['product_name'][0])) {
1235 $selectProduct = $formValues['product_name'][0];
1236 }
1237 // if there is a product - compare the value to the contribution amount
d37ade2e 1238 if (isset($selectProduct)) {
6a488035
TO
1239 $productDAO = new CRM_Contribute_DAO_Product();
1240 $productDAO->id = $selectProduct;
1241 $productDAO->find(TRUE);
1242 // product value exceeds contribution amount
1243 if ($params['total_amount'] < $productDAO->price) {
1244 $params['non_deductible_amount'] = $params['total_amount'];
1245 }
1246 // product value does NOT exceed contribution amount
1247 else {
1248 $params['non_deductible_amount'] = $productDAO->price;
1249 }
1250 }
1251 // contribution is deductible - but there is no product
1252 else {
1253 $params['non_deductible_amount'] = '0.00';
1254 }
1255 }
1256 // contribution is NOT deductible
1257 else {
1258 $params['non_deductible_amount'] = $params['total_amount'];
1259 }
1260 }
1261
1262 $contribution = CRM_Contribute_BAO_Contribution::create($params, $ids);
1263
1264 // process associated membership / participant, CRM-4395
1265 $relatedComponentStatusMsg = NULL;
1266 if ($contribution->id && $this->_action & CRM_Core_Action::UPDATE) {
1267 $relatedComponentStatusMsg = $this->updateRelatedComponent($contribution->id,
1268 $contribution->contribution_status_id,
1269 CRM_Utils_Array::value('contribution_status_id',
1270 $this->_values
1271 )
1272 );
1273 }
1274
1275 //process note
1276 if ($contribution->id && isset($formValues['note'])) {
1277 CRM_Contribute_Form_AdditionalInfo::processNote($formValues, $this->_contactID, $contribution->id, $this->_noteID);
1278 }
1279
1280 //process premium
5a230af7 1281 if ($contribution->id && isset($formValues['product_name'][0])) {
6a488035
TO
1282 CRM_Contribute_Form_AdditionalInfo::processPremium($formValues, $contribution->id,
1283 $this->_premiumID, $this->_options
1284 );
1285 }
1286
1287 //send receipt mail.
8cc574cf 1288 if ($contribution->id && !empty($formValues['is_email_receipt'])) {
6a488035
TO
1289 $formValues['contact_id'] = $this->_contactID;
1290 $formValues['contribution_id'] = $contribution->id;
1291
1421174e 1292 $formValues += CRM_Contribute_BAO_ContributionSoft::getSoftContribution($contribution->id);
1293
6a488035
TO
1294 // to get 'from email id' for send receipt
1295 $this->fromEmailId = $formValues['from_email_address'];
1296 $sendReceipt = CRM_Contribute_Form_AdditionalInfo::emailReceipt($this, $formValues);
1297 }
1298
1299 $pledgePaymentId = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1300 $contribution->id,
1301 'id',
1302 'contribution_id'
1303 );
1304
1305 //update pledge payment status.
1306 if ((($this->_ppID && $contribution->id) && $this->_action & CRM_Core_Action::ADD) ||
1307 (($pledgePaymentId) && $this->_action & CRM_Core_Action::UPDATE)
1308 ) {
1309
1310 if ($this->_ppID) {
1311 //store contribution id in payment record.
1312 CRM_Core_DAO::setFieldValue('CRM_Pledge_DAO_PledgePayment', $this->_ppID, 'contribution_id', $contribution->id);
1313 }
1314 else {
1315 $this->_ppID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1316 $contribution->id,
1317 'id',
1318 'contribution_id'
1319 );
1320 $this->_pledgeID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1321 $contribution->id,
1322 'pledge_id',
1323 'contribution_id'
1324 );
1325 }
1326
1327 $adjustTotalAmount = FALSE;
1328 if (CRM_Utils_Array::value('option_type', $formValues) == 2) {
1329 $adjustTotalAmount = TRUE;
1330 }
1331
1332 $updatePledgePaymentStatus = FALSE;
1333 //do only if either the status or the amount has changed
1334 if ($this->_action & CRM_Core_Action::ADD) {
1335 $updatePledgePaymentStatus = TRUE;
1336 }
1337 elseif ($this->_action & CRM_Core_Action::UPDATE && (($this->_defaults['contribution_status_id'] != $formValues['contribution_status_id']) ||
1338 ($this->_defaults['total_amount'] != $formValues['total_amount']))
1339 ) {
1340 $updatePledgePaymentStatus = TRUE;
1341 }
1342
1343 if ($updatePledgePaymentStatus) {
1344 CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($this->_pledgeID,
1345 array($this->_ppID),
1346 $contribution->contribution_status_id,
1347 NULL,
1348 $contribution->total_amount,
1349 $adjustTotalAmount
1350 );
1351 }
1352 }
5a230af7 1353
6a488035 1354 $statusMsg = ts('The contribution record has been saved.');
a7488080 1355 if (!empty($formValues['is_email_receipt']) && $sendReceipt) {
6a488035
TO
1356 $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
1357 }
5a230af7 1358
6a488035
TO
1359 if ($relatedComponentStatusMsg) {
1360 $statusMsg .= ' ' . $relatedComponentStatusMsg;
1361 }
5a230af7 1362
6a488035
TO
1363 CRM_Core_Session::setStatus($statusMsg, ts('Saved'), 'success');
1364 //Offline Contribution ends.
5a230af7 1365 }
6a488035
TO
1366 $buttonName = $this->controller->getButtonName();
1367 if ($this->_context == 'standalone') {
1368 if ($buttonName == $this->getButtonName('upload', 'new')) {
1369 $session->replaceUserContext(CRM_Utils_System::url('civicrm/contribute/add',
1370 'reset=1&action=add&context=standalone'
1371 ));
1372 }
1373 else {
1374 $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
1375 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
1376 ));
1377 }
1378 }
1379 elseif ($this->_context == 'contribution' && $this->_mode && $buttonName == $this->getButtonName('upload', 'new')) {
1380 $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view/contribution',
1381 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}&mode={$this->_mode}"
1382 ));
1383 }
1384 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1385 $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view/contribution',
1386 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}"
1387 ));
1388 }
28d44c9f
BS
1389
1390 //store contribution ID if not yet set (on create)
1391 if ( empty($this->_id) && !empty($contribution->id) ) {
1392 $this->_id = $contribution->id;
1393 }
6a488035 1394 }
5a230af7 1395
d77a0a58
EM
1396 /**
1397 * @param $submittedValues
1398 * @param $config
1399 * @param $session CRM_Core_Session
1400 * @param $lineItem
1401 *
1402 * @throws CRM_Core_Exception
1403 */
1404 public function processCreditCard($submittedValues, $config, $session, $lineItem) {
1405 $sendReceipt = $contribution = FALSE;
6a488035
TO
1406 $unsetParams = array(
1407 'trxn_id',
1408 'payment_instrument_id',
1409 'contribution_status_id',
1410 'cancel_date',
1411 'cancel_reason',
1412 );
1413 foreach ($unsetParams as $key) {
1414 if (isset($submittedValues[$key])) {
1415 unset($submittedValues[$key]);
1416 }
1417 }
4bd318e0 1418 $isTest = ($this->_mode == 'test') ? 1 : 0;
25e92485
PN
1419 // CRM-12680 set $_lineItem if its not set
1420 if (empty($this->_lineItem) && !empty($lineItem)) {
1421 $this->_lineItem = $lineItem;
1422 }
eea16664 1423
5032bf07 1424 //Get the require fields value only.
6a488035
TO
1425 $params = $this->_params = $submittedValues;
1426
1427 $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($this->_params['payment_processor_id'],
1428 $this->_mode
1429 );
1430
1431 //get the payment processor id as per mode.
8ef12e64 1432 $this->_params['payment_processor'] = $params['payment_processor_id'] =
78b79549 1433 $this->_params['payment_processor_id'] = $submittedValues['payment_processor_id'] = $this->_paymentProcessor['id'];
6a488035
TO
1434
1435 $now = date('YmdHis');
1436 $fields = array();
1437
1438 // we need to retrieve email address
8cc574cf 1439 if ($this->_context == 'standalone' && !empty($submittedValues['is_email_receipt'])) {
6a488035
TO
1440 list($this->userDisplayName,
1441 $this->userEmail
1442 ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
1443 $this->assign('displayName', $this->userDisplayName);
1444 }
1445
1446 //set email for primary location.
1447 $fields['email-Primary'] = 1;
1448 $params['email-Primary'] = $this->userEmail;
1449
1450 // now set the values for the billing location.
d77a0a58 1451 foreach (array_keys($this->_fields) as $name) {
6a488035
TO
1452 $fields[$name] = 1;
1453 }
1454
1455 // also add location name to the array
1456 $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);
1457 $params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]);
1458 $fields["address_name-{$this->_bltID}"] = 1;
1459
1460 $ctype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
1461 $this->_contactID,
1462 'contact_type'
1463 );
1464
1465 $nameFields = array('first_name', 'middle_name', 'last_name');
1466 foreach ($nameFields as $name) {
1467 $fields[$name] = 1;
1468 if (array_key_exists("billing_$name", $params)) {
1469 $params[$name] = $params["billing_{$name}"];
1470 $params['preserveDBName'] = TRUE;
1471 }
1472 }
1473
a7488080 1474 if (!empty($params['source'])) {
6a488035
TO
1475 unset($params['source']);
1476 }
1477 $contactID = CRM_Contact_BAO_Contact::createProfileContact($params, $fields,
1478 $this->_contactID,
1479 NULL, NULL,
1480 $ctype
1481 );
1482
5032bf07 1483 // add all the additional payment params we need
6a488035
TO
1484 $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}"]);
1485 $this->_params["country-{$this->_bltID}"] = $this->_params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant::countryIsoCode($this->_params["billing_country_id-{$this->_bltID}"]);
1486
1487 if ($this->_paymentProcessor['payment_type'] & CRM_Core_Payment::PAYMENT_TYPE_CREDIT_CARD) {
1488 $this->_params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($this->_params);
1489 $this->_params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($this->_params);
1490 }
1491 $this->_params['ip_address'] = CRM_Utils_System::ipAddress();
1492 $this->_params['amount'] = $this->_params['total_amount'];
1493 $this->_params['amount_level'] = 0;
1494 $this->_params['currencyID'] = CRM_Utils_Array::value('currency',
1495 $this->_params,
1496 $config->defaultCurrency
1497 );
1498 $this->_params['payment_action'] = 'Sale';
a7488080 1499 if (!empty($this->_params['receive_date'])) {
6a488035
TO
1500 $this->_params['receive_date'] = CRM_Utils_Date::processDate($this->_params['receive_date'], $this->_params['receive_date_time']);
1501 }
1502
a7488080 1503 if (!empty($params['soft_credit_to'])) {
6a488035
TO
1504 $this->_params['soft_credit_to'] = $params['soft_credit_to'];
1505 $this->_params['pcp_made_through_id'] = $params['pcp_made_through_id'];
1506 }
1507
1508 $this->_params['pcp_display_in_roll'] = CRM_Utils_Array::value('pcp_display_in_roll', $params);
1509 $this->_params['pcp_roll_nickname'] = CRM_Utils_Array::value('pcp_roll_nickname', $params);
1510 $this->_params['pcp_personal_note'] = CRM_Utils_Array::value('pcp_personal_note', $params);
1511
1512 //Add common data to formatted params
1513 CRM_Contribute_Form_AdditionalInfo::postProcessCommon($params, $this->_params, $this);
1514
1515 if (empty($this->_params['invoice_id'])) {
1516 $this->_params['invoiceID'] = md5(uniqid(rand(), TRUE));
1517 }
1518 else {
1519 $this->_params['invoiceID'] = $this->_params['invoice_id'];
1520 }
1521
1522 // at this point we've created a contact and stored its address etc
1523 // all the payment processors expect the name and address to be in the
1524 // so we copy stuff over to first_name etc.
1525 $paymentParams = $this->_params;
1526 $paymentParams['contactID'] = $this->_contactID;
1527 CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $paymentParams, TRUE);
1528
1529 $contributionType = new CRM_Financial_DAO_FinancialType();
1530 $contributionType->id = $params['financial_type_id'];
1531 if (!$contributionType->find(TRUE)) {
1532 CRM_Core_Error::fatal('Could not find a system table');
1533 }
1534
1535 // add some financial type details to the params list
1536 // if folks need to use it
1537 $paymentParams['contributionType_name'] = $this->_params['contributionType_name'] = $contributionType->name;
1538 $paymentParams['contributionPageID'] = NULL;
a7488080 1539 if (!empty($this->_params['is_email_receipt'])) {
6a488035
TO
1540 $paymentParams['email'] = $this->userEmail;
1541 $paymentParams['is_email_receipt'] = 1;
1542 }
1543 else {
1544 $paymentParams['is_email_receipt'] = 0;
1545 $this->_params['is_email_receipt'] = 0;
1546 }
a7488080 1547 if (!empty($this->_params['receive_date'])) {
6a488035
TO
1548 $paymentParams['receive_date'] = $this->_params['receive_date'];
1549 }
6a488035 1550
6a488035
TO
1551 // For recurring contribution, create Contribution Record first.
1552 // Contribution ID, Recurring ID and Contact ID needed
1553 // When we get a callback from the payment processor, CRM-7115
a7488080 1554 if (!empty($paymentParams['is_recur'])) {
6a488035
TO
1555 $contribution = CRM_Contribute_Form_Contribution_Confirm::processContribution($this,
1556 $this->_params,
5901ddf9 1557 NULL,
6a488035
TO
1558 $this->_contactID,
1559 $contributionType,
6a488035 1560 TRUE,
4bd318e0
EM
1561 FALSE,
1562 $isTest,
1563 $this->_lineItem
6a488035
TO
1564 );
1565 $paymentParams['contributionID'] = $contribution->id;
1566 $paymentParams['contributionTypeID'] = $contribution->financial_type_id;
1567 $paymentParams['contributionPageID'] = $contribution->contribution_page_id;
1568 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id;
1569 }
5901ddf9 1570 $result = NULL;
6a488035 1571 if ($paymentParams['amount'] > 0.0) {
d77a0a58 1572 // force a re-get of the payment processor in case the form changed it, CRM-7179
6a488035
TO
1573 $payment = CRM_Core_Payment::singleton($this->_mode, $this->_paymentProcessor, $this, TRUE);
1574 $result = $payment->doDirectPayment($paymentParams);
1575 }
1576
1577 if (is_a($result, 'CRM_Core_Error')) {
1578 //make sure to cleanup db for recurring case.
a7488080 1579 if (!empty($paymentParams['contributionID'])) {
6a488035
TO
1580 CRM_Core_Error::debug_log_message(CRM_Core_Error::getMessages($result) . "contact id={$this->_contactID} (deleting contribution {$paymentParams['contributionID']}");
1581 CRM_Contribute_BAO_Contribution::deleteContribution($paymentParams['contributionID']);
1582 }
a7488080 1583 if (!empty($paymentParams['contributionRecurID'])) {
6a488035
TO
1584 CRM_Core_Error::debug_log_message(CRM_Core_Error::getMessages($result) . "contact id={$this->_contactID} (deleting recurring contribution {$paymentParams['contributionRecurID']}");
1585 CRM_Contribute_BAO_ContributionRecur::deleteRecurContribution($paymentParams['contributionRecurID']);
1586 }
1587
1588 //set the contribution mode.
1589 $urlParams = "action=add&cid={$this->_contactID}";
1590 if ($this->_mode) {
1591 $urlParams .= "&mode={$this->_mode}";
1592 }
1593 if (!empty($this->_ppID)) {
1594 $urlParams .= "&context=pledge&ppid={$this->_ppID}";
1595 }
1596 CRM_Core_Error::displaySessionError($result);
1597 CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view/contribution', $urlParams));
1598 }
1599
1600 if ($result) {
1601 $this->_params = array_merge($this->_params, $result);
1602 }
1603
1604 $this->_params['receive_date'] = $now;
1605
a7488080 1606 if (!empty($this->_params['is_email_receipt'])) {
6a488035
TO
1607 $this->_params['receipt_date'] = $now;
1608 }
1609 else {
1610 $this->_params['receipt_date'] = CRM_Utils_Date::processDate($this->_params['receipt_date'],
1611 $params['receipt_date_time'], TRUE
1612 );
1613 }
1614
1615 $this->set('params', $this->_params);
1616 $this->assign('trxn_id', $result['trxn_id']);
1617 $this->assign('receive_date', $this->_params['receive_date']);
1618
1619 // result has all the stuff we need
1620 // lets archive it to a financial transaction
1621 if ($contributionType->is_deductible) {
1622 $this->assign('is_deductible', TRUE);
1623 $this->set('is_deductible', TRUE);
1624 }
1625
1626 // set source if not set
1627 if (empty($this->_params['source'])) {
1628 $userID = $session->get('userID');
1629 $userSortName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $userID,
1630 'sort_name'
1631 );
1632 $this->_params['source'] = ts('Submit Credit Card Payment by: %1', array(1 => $userSortName));
1633 }
1634
1635 // build custom data getFields array
1636 $customFieldsContributionType = CRM_Core_BAO_CustomField::getFields('Contribution', FALSE, FALSE,
1637 CRM_Utils_Array::value('financial_type_id', $params)
1638 );
1639 $customFields = CRM_Utils_Array::crmArrayMerge($customFieldsContributionType,
1640 CRM_Core_BAO_CustomField::getFields('Contribution', FALSE, FALSE, NULL, NULL, TRUE)
1641 );
1642 $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
1643 $customFields,
1644 $this->_id,
1645 'Contribution'
1646 );
1647
1648
a7488080 1649 if (empty($paymentParams['is_recur'])) {
6a488035
TO
1650 $contribution = CRM_Contribute_Form_Contribution_Confirm::processContribution($this,
1651 $this->_params,
1652 $result,
1653 $this->_contactID,
1654 $contributionType,
4bd318e0
EM
1655 FALSE, FALSE,
1656 $isTest,
1657 $this->_lineItem
6a488035
TO
1658 );
1659 }
1660
1661 //send receipt mail.
8cc574cf 1662 if ($contribution->id && !empty($this->_params['is_email_receipt'])) {
6a488035
TO
1663 $this->_params['trxn_id'] = CRM_Utils_Array::value('trxn_id', $result);
1664 $this->_params['contact_id'] = $this->_contactID;
1665 $this->_params['contribution_id'] = $contribution->id;
1666 $sendReceipt = CRM_Contribute_Form_AdditionalInfo::emailReceipt($this, $this->_params, TRUE);
1667 }
1668
1669 //process the note
1670 if ($contribution->id && isset($params['note'])) {
1671 CRM_Contribute_Form_AdditionalInfo::processNote($params, $contactID, $contribution->id, NULL);
1672 }
1673 //process premium
1674 if ($contribution->id && isset($params['product_name'][0])) {
1675 CRM_Contribute_Form_AdditionalInfo::processPremium($params, $contribution->id, NULL, $this->_options);
1676 }
1677
1678 //update pledge payment status.
1679 if ($this->_ppID && $contribution->id) {
1680 //store contribution id in payment record.
1681 CRM_Core_DAO::setFieldValue('CRM_Pledge_DAO_PledgePayment', $this->_ppID, 'contribution_id', $contribution->id);
1682
1683 CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($this->_pledgeID,
1684 array($this->_ppID),
1685 $contribution->contribution_status_id,
1686 NULL,
1687 $contribution->total_amount
1688 );
1689 }
1690
1691 if ($contribution->id) {
1692 $statusMsg = ts('The contribution record has been processed.');
a7488080 1693 if (!empty($this->_params['is_email_receipt']) && $sendReceipt) {
6a488035
TO
1694 $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
1695 }
1696 CRM_Core_Session::setStatus($statusMsg, ts('Complete'), 'success');
1697 }
1698 }
1699}