Merge pull request #7548 from wdecraene/CRM-15267
[civicrm-core.git] / CRM / Contribute / Form / AbstractEditPayment.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
7e9e8871 4 | CiviCRM version 4.7 |
6a488035 5 +--------------------------------------------------------------------+
e7112fa7 6 | Copyright CiviCRM LLC (c) 2004-2015 |
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 +--------------------------------------------------------------------+
d25dd0ee 26 */
6a488035
TO
27
28/**
29 *
30 * @package CRM
e7112fa7 31 * @copyright CiviCRM LLC (c) 2004-2015
6a488035
TO
32 */
33
34/**
35 * This class generates form components for processing a contribution
803d4bc0 36 * CRM-16229 - During the event registration bulk action via search we
37 * need to inherit CRM_Contact_Form_Task so that we can inherit functions
38 * like getContactIds and make use of controller state. But this is not possible
39 * because CRM_Event_Form_Participant inherits this class.
40 * Ideal situation would be something like
41 * CRM_Event_Form_Participant extends CRM_Contact_Form_Task,
42 * CRM_Contribute_Form_AbstractEditPayment
43 * However this is not possible. Currently PHP does not support multiple
44 * inheritance. So work around solution is to extend this class with
45 * CRM_Contact_Form_Task which further extends CRM_Core_Form.
6a488035
TO
46 *
47 */
5b7c9ebc 48class CRM_Contribute_Form_AbstractEditPayment extends CRM_Contact_Form_Task {
6a488035
TO
49 public $_mode;
50
51 public $_action;
52
53 public $_bltID;
54
a8215a8d 55 public $_fields = array();
6a488035 56
a6513ad5
EM
57 /**
58 * @var array current payment processor including a copy of the object in 'object' key
59 */
6a488035 60 public $_paymentProcessor;
7036a6d0
EM
61
62 /**
63 * Available recurring processors.
64 *
65 * @var array
66 */
67 public $_recurPaymentProcessors = array();
6a488035 68
dc913073 69 /**
100fef9d 70 * Array of processor options in the format id => array($id => $label)
dc913073
EM
71 * WARNING it appears that the format used to differ to this and there are places in the code that
72 * expect the old format. $this->_paymentProcessors provides the additional data which this
73 * array seems to have provided in the past
74 * @var array
75 */
6a488035
TO
76 public $_processors;
77
78 /**
100fef9d 79 * Available payment processors with full details including the key 'object' indexed by their id
dc913073
EM
80 * @var array
81 */
82 protected $_paymentProcessors = array();
bf4253e7
EM
83
84 /**
85 * Instance of the payment processor object.
86 *
87 * @var CRM_Core_Payment
88 */
89 protected $_paymentObject;
90
dc913073 91 /**
fe482240 92 * The id of the contribution that we are processing.
6a488035
TO
93 *
94 * @var int
6a488035
TO
95 */
96 public $_id;
97
98 /**
fe482240 99 * The id of the premium that we are proceessing.
6a488035
TO
100 *
101 * @var int
6a488035
TO
102 */
103 public $_premiumID = NULL;
4691b077
EM
104
105 /**
106 * @var CRM_Contribute_DAO_ContributionProduct
107 */
6a488035
TO
108 public $_productDAO = NULL;
109
110 /**
100fef9d 111 * The id of the note
6a488035
TO
112 *
113 * @var int
6a488035
TO
114 */
115 public $_noteID;
116
117 /**
100fef9d 118 * The id of the contact associated with this contribution
6a488035
TO
119 *
120 * @var int
6a488035
TO
121 */
122 public $_contactID;
123
124 /**
100fef9d 125 * The id of the pledge payment that we are processing
6a488035
TO
126 *
127 * @var int
6a488035
TO
128 */
129 public $_ppID;
130
131 /**
100fef9d 132 * The id of the pledge that we are processing
6a488035
TO
133 *
134 * @var int
6a488035
TO
135 */
136 public $_pledgeID;
137
138 /**
100fef9d 139 * Is this contribution associated with an online
6a488035
TO
140 * financial transaction
141 *
142 * @var boolean
6a488035
TO
143 */
144 public $_online = FALSE;
145
146 /**
147 * Stores all product option
148 *
149 * @var array
6a488035
TO
150 */
151 public $_options;
152
153 /**
100fef9d 154 * Stores the honor id
6a488035
TO
155 *
156 * @var int
6a488035
TO
157 */
158 public $_honorID = NULL;
159
160 /**
dde5a0ef 161 * Store the financial Type ID
6a488035
TO
162 *
163 * @var array
164 */
165 public $_contributionType;
166
167 /**
168 * The contribution values if an existing contribution
169 */
170 public $_values;
171
172 /**
173 * The pledge values if this contribution is associated with pledge
174 */
175 public $_pledgeValues;
176
177 public $_contributeMode = 'direct';
178
179 public $_context;
180
181 public $_compId;
182
d424ffde 183 /**
6a488035
TO
184 * Store the line items if price set used.
185 */
186 public $_lineItems;
187
0be0b79d
EM
188 /**
189 * Is this a backoffice form
190 * (this will affect whether paypal express code is displayed)
191 * @var bool
192 */
193 public $isBackOffice = TRUE;
194
6a488035 195 protected $_formType;
dde5a0ef 196
dde5a0ef 197 /**
100fef9d 198 * Array of fields to display on billingBlock.tpl - this is not fully implemented but basically intent is the panes/fieldsets on this page should
dde5a0ef
EM
199 * be all in this array in order like
200 * 'credit_card' => array('credit_card_number' ...
201 * 'billing_details' => array('first_name' ...
202 *
203 * such that both the fields and the order can be more easily altered by payment processors & other extensions
204 * @var array
205 */
206 public $billingFieldSets = array();
207
42e8b05c
EM
208 /**
209 * Pre process function with common actions.
210 */
211 public function preProcess() {
212 $this->_contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
213 $this->assign('contactID', $this->_contactID);
9977ae61 214 CRM_Core_Resources::singleton()->addVars('coreForm', array('contact_id' => (int) $this->_contactID));
42e8b05c
EM
215 $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
216 }
217
186c9c17 218 /**
100fef9d 219 * @param int $id
186c9c17 220 */
d5397f2f
PJ
221 public function showRecordLinkMesssage($id) {
222 $statusId = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $id, 'contribution_status_id');
223 if (CRM_Contribute_PseudoConstant::contributionStatus($statusId, 'name') == 'Partially paid') {
224 if ($pid = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'participant_id', 'contribution_id')) {
225 $recordPaymentLink = CRM_Utils_System::url('civicrm/payment',
226 "reset=1&id={$pid}&cid={$this->_contactID}&action=add&component=event"
227 );
228 CRM_Core_Session::setStatus(ts('Please use the <a href="%1">Record Payment</a> form if you have received an additional payment for this Partially paid contribution record.', array(1 => $recordPaymentLink)), ts('Notice'), 'alert');
229 }
230 }
231 }
232
186c9c17 233 /**
100fef9d 234 * @param int $id
186c9c17
EM
235 * @param $values
236 */
6a488035
TO
237 public function buildValuesAndAssignOnline_Note_Type($id, &$values) {
238 $ids = array();
239 $params = array('id' => $id);
240 CRM_Contribute_BAO_Contribution::getValues($params, $values, $ids);
241
242 //Check if this is an online transaction (financial_trxn.payment_processor_id NOT NULL)
243 $this->_online = FALSE;
244 $fids = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($id);
a7488080 245 if (!empty($fids['financialTrxnId'])) {
6a488035
TO
246 $this->_online = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $fids['financialTrxnId'], 'payment_processor_id');
247 }
eea16664 248
6a488035
TO
249 // Also don't allow user to update some fields for recurring contributions.
250 if (!$this->_online) {
251 $this->_online = CRM_Utils_Array::value('contribution_recur_id', $values);
252 }
eea16664 253
6a488035
TO
254 $this->assign('isOnline', $this->_online ? TRUE : FALSE);
255
6a488035
TO
256 //to get note id
257 $daoNote = new CRM_Core_BAO_Note();
258 $daoNote->entity_table = 'civicrm_contribution';
259 $daoNote->entity_id = $id;
260 if ($daoNote->find(TRUE)) {
261 $this->_noteID = $daoNote->id;
262 $values['note'] = $daoNote->note;
263 }
264 $this->_contributionType = $values['financial_type_id'];
6a488035
TO
265 }
266
267 /**
014c4014
TO
268 * @param string $type
269 * Eg 'Contribution'.
6a488035
TO
270 * @param string $subType
271 * @param int $entityId
272 */
273 public function applyCustomData($type, $subType, $entityId) {
274 $this->set('type', $type);
275 $this->set('subType', $subType);
276 $this->set('entityId', $entityId);
277
278 CRM_Custom_Form_CustomData::preProcess($this, NULL, $subType, 1, $type, $entityId);
279 CRM_Custom_Form_CustomData::buildQuickForm($this);
280 CRM_Custom_Form_CustomData::setDefaultValues($this);
281 }
282
4691b077 283 /**
100fef9d 284 * @param int $id
4691b077
EM
285 * @todo - this function is a long way, non standard of saying $dao = new CRM_Contribute_DAO_ContributionProduct(); $dao->id = $id; $dao->find();
286 */
6ea503d4 287 public function assignPremiumProduct($id) {
6a488035
TO
288 $sql = "
289SELECT *
290FROM civicrm_contribution_product
291WHERE contribution_id = {$id}
292";
293 $dao = CRM_Core_DAO::executeQuery($sql,
294 CRM_Core_DAO::$_nullArray
295 );
296 if ($dao->fetch()) {
297 $this->_premiumID = $dao->id;
298 $this->_productDAO = $dao;
299 }
300 $dao->free();
301 }
302
303 /**
304 * This function process contribution related objects.
03110609 305 *
014c4014
TO
306 * @param int $contributionId
307 * @param int $statusId
308 * @param int|null $previousStatusId
03110609 309 *
ad37ac8e 310 * @param string $receiveDate
311 *
03110609 312 * @return null|string
6a488035 313 */
35874a67 314 protected function updateRelatedComponent($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) {
6a488035
TO
315 $statusMsg = NULL;
316 if (!$contributionId || !$statusId) {
317 return $statusMsg;
318 }
319
320 $params = array(
321 'contribution_id' => $contributionId,
322 'contribution_status_id' => $statusId,
323 'previous_contribution_status_id' => $previousStatusId,
35874a67 324 'receive_date' => $receiveDate,
6a488035
TO
325 );
326
327 $updateResult = CRM_Contribute_BAO_Contribution::transitionComponents($params);
328
329 if (!is_array($updateResult) ||
330 !($updatedComponents = CRM_Utils_Array::value('updatedComponents', $updateResult)) ||
331 !is_array($updatedComponents) ||
332 empty($updatedComponents)
333 ) {
334 return $statusMsg;
335 }
336
337 // get the user display name.
338 $sql = "
339 SELECT display_name as displayName
340 FROM civicrm_contact
341LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_contact.id )
342 WHERE civicrm_contribution.id = {$contributionId}";
343 $userDisplayName = CRM_Core_DAO::singleValueQuery($sql);
344
345 // get the status message for user.
346 foreach ($updatedComponents as $componentName => $updatedStatusId) {
347
348 if ($componentName == 'CiviMember') {
349 $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
350 CRM_Member_PseudoConstant::membershipStatus()
351 );
352 if ($updatedStatusName == 'Cancelled') {
353 $statusMsg .= "<br />" . ts("Membership for %1 has been Cancelled.", array(1 => $userDisplayName));
354 }
355 elseif ($updatedStatusName == 'Expired') {
356 $statusMsg .= "<br />" . ts("Membership for %1 has been Expired.", array(1 => $userDisplayName));
357 }
d008a264 358 else {
13299a2b
JM
359 $endDate = CRM_Utils_Array::value('membership_end_date', $updateResult);
360 if ($endDate) {
d008a264 361 $statusMsg .= "<br />" . ts("Membership for %1 has been updated. The membership End Date is %2.",
353ffa53
TO
362 array(
363 1 => $userDisplayName,
364 2 => $endDate,
365 )
366 );
d008a264 367 }
6a488035
TO
368 }
369 }
370
371 if ($componentName == 'CiviEvent') {
372 $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
373 CRM_Event_PseudoConstant::participantStatus()
374 );
375 if ($updatedStatusName == 'Cancelled') {
376 $statusMsg .= "<br />" . ts("Event Registration for %1 has been Cancelled.", array(1 => $userDisplayName));
377 }
378 elseif ($updatedStatusName == 'Registered') {
379 $statusMsg .= "<br />" . ts("Event Registration for %1 has been updated.", array(1 => $userDisplayName));
380 }
381 }
382
383 if ($componentName == 'CiviPledge') {
384 $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
385 CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
386 );
387 if ($updatedStatusName == 'Cancelled') {
388 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Cancelled.", array(1 => $userDisplayName));
389 }
390 elseif ($updatedStatusName == 'Failed') {
391 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Failed.", array(1 => $userDisplayName));
392 }
393 elseif ($updatedStatusName == 'Completed') {
394 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been updated.", array(1 => $userDisplayName));
395 }
396 }
397 }
398
399 return $statusMsg;
400 }
401
402 /**
a6c01b45 403 * @return array
16b10e64 404 * Array of valid processors. The array resembles the DB table but also has 'object' as a key
fbcb6fba
EM
405 * @throws Exception
406 */
407 public function getValidProcessors() {
fbcb6fba
EM
408 $defaultID = NULL;
409 $capabilities = array('BackOffice');
52767de0
EM
410 if ($this->_mode) {
411 $capabilities[] = (ucfirst($this->_mode) . 'Mode');
fbcb6fba
EM
412 }
413 $processors = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors($capabilities);
44b6505d
EM
414 return $processors;
415
6a488035
TO
416 }
417
6a488035
TO
418 /**
419 * Assign $this->processors, $this->recurPaymentProcessors, and related Smarty variables
420 */
421 public function assignProcessors() {
422 //ensure that processor has a valid config
423 //only valid processors get display to user
44b6505d 424
6a488035 425 if ($this->_mode) {
11d48665 426 $this->assign('processorSupportsFutureStartDate', CRM_Financial_BAO_PaymentProcessor::hasPaymentProcessorSupporting(array('FutureRecurStartDate')));
dc913073
EM
427 $this->_paymentProcessors = $this->getValidProcessors();
428 if (!isset($this->_paymentProcessor['id'])) {
429 // if the payment processor isn't set yet (as indicated by the presence of an id,) we'll grab the first one which should be the default
430 $this->_paymentProcessor = reset($this->_paymentProcessors);
431 }
432 if (empty($this->_paymentProcessors)) {
44b6505d
EM
433 throw new CRM_Core_Exception(ts('You will need to configure the %1 settings for your Payment Processor before you can submit a credit card transactions.', array(1 => $this->_mode)));
434 }
353ffa53 435 $this->_processors = array();
dc913073 436 foreach ($this->_paymentProcessors as $id => $processor) {
b9948b3c
EM
437 // @todo review this. The inclusion of this IF was to address test processors being incorrectly loaded.
438 // However the function $this->getValidProcessors() is expected to only return the processors relevant
439 // to the mode (using the actual id - ie. the id of the test processor for the test processor).
bddc8a28 440 // for some reason there was a need to filter here per commit history - but this indicates a problem
b9948b3c 441 // somewhere else.
bc8526fa
CW
442 if ($processor['is_test'] == ($this->_mode == 'test')) {
443 $this->_processors[$id] = ts($processor['name']);
444 if (!empty($processor['description'])) {
445 $this->_processors[$id] .= ' : ' . ts($processor['description']);
446 }
447 if ($processor['is_recur']) {
448 $this->_recurPaymentProcessors[$id] = $this->_processors[$id];
449 }
7036a6d0 450 }
44b6505d 451 }
071fee77 452 CRM_Financial_Form_Payment::addCreditCardJs();
6a488035
TO
453 }
454 $this->assign('recurringPaymentProcessorIds',
455 empty($this->_recurPaymentProcessors) ? '' : implode(',', array_keys($this->_recurPaymentProcessors))
456 );
457
458 // this required to show billing block
03110609 459 // @todo remove this assignment the billing block is now designed to be always included but will not show fieldsets unless those sets of fields are assigned
44b6505d 460 $this->assign_by_ref('paymentProcessor', $processor);
6a488035
TO
461 }
462
186c9c17 463 /**
6ea503d4
TO
464 * Get current currency from DB or use default currency.
465 *
186c9c17
EM
466 * @param $submittedValues
467 *
468 * @return mixed
469 */
6ea503d4 470 public function getCurrency($submittedValues) {
6a488035
TO
471 $config = CRM_Core_Config::singleton();
472
473 $currentCurrency = CRM_Utils_Array::value('currency',
474 $this->_values,
475 $config->defaultCurrency
476 );
477
478 // use submitted currency if present else use current currency
479 $result = CRM_Utils_Array::value('currency',
480 $submittedValues,
481 $currentCurrency
482 );
483 return $result;
484 }
485
186c9c17 486 /**
100fef9d 487 * @param int $financialTypeId
186c9c17
EM
488 *
489 * @return array
490 */
6a488035
TO
491 public function getFinancialAccounts($financialTypeId) {
492 $financialAccounts = array();
493 CRM_Core_PseudoConstant::populate($financialAccounts,
494 'CRM_Financial_DAO_EntityFinancialAccount',
495 $all = TRUE,
496 $retrieve = 'financial_account_id',
497 $filter = NULL,
498 " entity_id = {$financialTypeId} ", NULL, 'account_relationship');
499 return $financialAccounts;
500 }
501
186c9c17 502 /**
100fef9d
CW
503 * @param int $financialTypeId
504 * @param int $relationTypeId
186c9c17
EM
505 *
506 * @return mixed
507 */
6a488035
TO
508 public function getFinancialAccount($financialTypeId, $relationTypeId) {
509 $financialAccounts = $this->getFinancialAccounts($financialTypeId);
510 return CRM_Utils_Array::value($relationTypeId, $financialAccounts);
511 }
512
513 public function preProcessPledge() {
514 //get the payment values associated with given pledge payment id OR check for payments due.
515 $this->_pledgeValues = array();
516 if ($this->_ppID) {
517 $payParams = array('id' => $this->_ppID);
518
519 CRM_Pledge_BAO_PledgePayment::retrieve($payParams, $this->_pledgeValues['pledgePayment']);
520 $this->_pledgeID = CRM_Utils_Array::value('pledge_id', $this->_pledgeValues['pledgePayment']);
521 $paymentStatusID = CRM_Utils_Array::value('status_id', $this->_pledgeValues['pledgePayment']);
522 $this->_id = CRM_Utils_Array::value('contribution_id', $this->_pledgeValues['pledgePayment']);
523
524 //get all status
525 $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
526 if (!($paymentStatusID == array_search('Pending', $allStatus) || $paymentStatusID == array_search('Overdue', $allStatus))) {
527 CRM_Core_Error::fatal(ts("Pledge payment status should be 'Pending' or 'Overdue'."));
528 }
529
530 //get the pledge values associated with given pledge payment.
531
532 $ids = array();
533 $pledgeParams = array('id' => $this->_pledgeID);
534 CRM_Pledge_BAO_Pledge::getValues($pledgeParams, $this->_pledgeValues, $ids);
535 $this->assign('ppID', $this->_ppID);
536 }
537 else {
538 // Not making a pledge payment, so if adding a new contribution we should check if pledge payment(s) are due for this contact so we can alert the user. CRM-5206
539 if (isset($this->_contactID)) {
540 $contactPledges = CRM_Pledge_BAO_Pledge::getContactPledges($this->_contactID);
541
542 if (!empty($contactPledges)) {
543 $payments = $paymentsDue = NULL;
544 $multipleDue = FALSE;
545 foreach ($contactPledges as $key => $pledgeId) {
546 $payments = CRM_Pledge_BAO_PledgePayment::getOldestPledgePayment($pledgeId);
547 if ($payments) {
548 if ($paymentsDue) {
549 $multipleDue = TRUE;
550 break;
551 }
552 else {
553 $paymentsDue = $payments;
554 }
555 }
556 }
557 if ($multipleDue) {
558 // Show link to pledge tab since more than one pledge has a payment due
559 $pledgeTab = CRM_Utils_System::url('civicrm/contact/view',
560 "reset=1&force=1&cid={$this->_contactID}&selectedChild=pledge"
561 );
562 CRM_Core_Session::setStatus(ts('This contact has pending or overdue pledge payments. <a href="%1">Click here to view their Pledges tab</a> and verify whether this contribution should be applied as a pledge payment.', array(1 => $pledgeTab)), ts('Notice'), 'alert');
563 }
564 elseif ($paymentsDue) {
565 // Show user link to oldest Pending or Overdue pledge payment
566 $ppAmountDue = CRM_Utils_Money::format($payments['amount'], $payments['currency']);
567 $ppSchedDate = CRM_Utils_Date::customFormat(CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment', $payments['id'], 'scheduled_date'));
568 if ($this->_mode) {
569 $ppUrl = CRM_Utils_System::url('civicrm/contact/view/contribution',
570 "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge&mode=live"
571 );
572 }
573 else {
574 $ppUrl = CRM_Utils_System::url('civicrm/contact/view/contribution',
575 "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge"
576 );
577 }
578 CRM_Core_Session::setStatus(ts('This contact has a pending or overdue pledge payment of %2 which is scheduled for %3. <a href="%1">Click here to enter a pledge payment</a>.', array(
579 1 => $ppUrl,
580 2 => $ppAmountDue,
21dfd5f5 581 3 => $ppSchedDate,
6a488035
TO
582 )), ts('Notice'), 'alert');
583 }
584 }
585 }
586 }
587 }
588
186c9c17 589 /**
07f8d162 590 * @param array $submittedValues
186c9c17
EM
591 *
592 * @return mixed
593 */
6a488035
TO
594 public function unsetCreditCardFields($submittedValues) {
595 //Offline Contribution.
596 $unsetParams = array(
597 'payment_processor_id',
598 "email-{$this->_bltID}",
599 'hidden_buildCreditCard',
600 'hidden_buildDirectDebit',
601 'billing_first_name',
602 'billing_middle_name',
603 'billing_last_name',
604 'street_address-5',
605 "city-{$this->_bltID}",
606 "state_province_id-{$this->_bltID}",
607 "postal_code-{$this->_bltID}",
608 "country_id-{$this->_bltID}",
609 'credit_card_number',
610 'cvv2',
611 'credit_card_exp_date',
612 'credit_card_type',
613 );
614 foreach ($unsetParams as $key) {
615 if (isset($submittedValues[$key])) {
616 unset($submittedValues[$key]);
617 }
618 }
619 return $submittedValues;
620 }
621
cc984198 622 /**
100fef9d 623 * Common block for setting up the parts of a form that relate to credit / debit card
cc984198
EM
624 * @throws Exception
625 */
626 protected function assignPaymentRelatedVariables() {
627 try {
99efbbf8
EM
628 if ($this->_contactID) {
629 list($this->userDisplayName, $this->userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
630 $this->assign('displayName', $this->userDisplayName);
631 }
cc984198
EM
632 if ($this->_mode) {
633 $this->assignProcessors();
cc984198
EM
634
635 $this->assignBillingType();
636
dfc68e82 637 CRM_Core_Payment_Form::setPaymentFieldsByProcessor($this, $this->_paymentProcessor, FALSE, TRUE);
cc984198
EM
638 }
639 }
640 catch (CRM_Core_Exception $e) {
641 CRM_Core_Error::fatal($e->getMessage());
642 }
643 }
96025800 644
3b8e6c3f 645 /**
646 * Begin post processing.
647 *
648 * This function aims to start to bring together common postProcessing functions.
649 *
650 * Eventually these are also shared with the front end forms & may need to be moved to where they can also
651 * access this function.
652 */
653 protected function beginPostProcess() {
ba2f3f65 654 if ($this->_mode) {
2c89742a 655 $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment(
656 $this->_params['payment_processor_id'],
657 ($this->_mode == 'test')
658 );
ba2f3f65 659 if (in_array('credit_card_exp_date', array_keys($this->_params))) {
660 $this->_params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($this->_params);
661 $this->_params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($this->_params);
662 }
663 $this->assign('credit_card_exp_date', CRM_Utils_Date::mysqlToIso(CRM_Utils_Date::format($this->_params['credit_card_exp_date'])));
664 $this->assign('credit_card_number',
665 CRM_Utils_System::mungeCreditCard($this->_params['credit_card_number'])
666 );
275fba6b 667 $this->assign('credit_card_type', CRM_Utils_Array::value('credit_card_type', $this->_params));
3b8e6c3f 668 }
3b8e6c3f 669 $this->_params['ip_address'] = CRM_Utils_System::ipAddress();
670 }
671
672
673 /**
674 * Add the billing address to the contact who paid.
675 *
676 * Note that this function works based on the presence or otherwise of billing fields & can be called regardless of
677 * whether they are 'expected' (due to assumptions about the payment processor type or the setting to collect billing
678 * for pay later.
679 */
680 protected function processBillingAddress() {
681 $fields = array();
682
683 $fields['email-Primary'] = 1;
684 $this->_params['email-5'] = $this->_params['email-Primary'] = $this->_contributorEmail;
685 // now set the values for the billing location.
686 foreach (array_keys($this->_fields) as $name) {
687 $fields[$name] = 1;
688 }
689
3b8e6c3f 690 $fields["address_name-{$this->_bltID}"] = 1;
691
692 //ensure we don't over-write the payer's email with the member's email
693 if ($this->_contributorContactID == $this->_contactID) {
694 $fields["email-{$this->_bltID}"] = 1;
695 }
696
697 list($hasBillingField, $addressParams) = CRM_Contribute_BAO_Contribution::getPaymentProcessorReadyAddressParams($this->_params, $this->_bltID);
bddc8a28 698 $fields = $this->formatParamsForPaymentProcessor($fields);
3b8e6c3f 699
700 if ($hasBillingField) {
701 $addressParams = array_merge($this->_params, $addressParams);
702 //here we are setting up the billing contact - if different from the member they are already created
703 // but they will get billing details assigned
704 CRM_Contact_BAO_Contact::createProfileContact($addressParams, $fields,
705 $this->_contributorContactID, NULL, NULL,
706 CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID, 'contact_type')
707 );
708 }
3b8e6c3f 709 }
710
44032b26 711 /**
712 * Get default values for billing fields.
713 *
714 * @todo this function still replicates code in several other places in the code.
715 *
716 * Also - the call to getProfileDefaults possibly covers the state_province & country already.
717 *
718 * @param $defaults
719 *
720 * @return array
721 */
722 protected function getBillingDefaults($defaults) {
723 // set default country from config if no country set
724 $config = CRM_Core_Config::singleton();
725 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
726 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry;
727 }
728
729 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
730 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince;
731 }
732
733 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID);
734 return array_merge($defaults, $billingDefaults);
735 }
736
6a488035 737}