3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
35 * This class generates form components for processing a contribution
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.
48 class CRM_Contribute_Form_AbstractEditPayment
extends CRM_Contact_Form_Task
{
58 * @var array current payment processor including a copy of the object in 'object' key
60 public $_paymentProcessor;
63 * Available recurring processors.
67 public $_recurPaymentProcessors = array();
70 * Array of processor options in the format id => array($id => $label)
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
79 * Available payment processors with full details including the key 'object' indexed by their id
82 protected $_paymentProcessors = array();
85 * Instance of the payment processor object.
87 * @var CRM_Core_Payment
89 protected $_paymentObject;
92 * The id of the contribution that we are processing.
99 * The id of the premium that we are proceessing.
103 public $_premiumID = NULL;
106 * @var CRM_Contribute_DAO_ContributionProduct
108 public $_productDAO = NULL;
118 * The id of the contact associated with this contribution
125 * The id of the pledge payment that we are processing
132 * The id of the pledge that we are processing
139 * Is this contribution associated with an online
140 * financial transaction
144 public $_online = FALSE;
147 * Stores all product option
154 * Stores the honor id
158 public $_honorID = NULL;
161 * Store the financial Type ID
165 public $_contributionType;
168 * The contribution values if an existing contribution
173 * The pledge values if this contribution is associated with pledge
175 public $_pledgeValues;
177 public $_contributeMode = 'direct';
184 * Store the line items if price set used.
189 * Is this a backoffice form
190 * (this will affect whether paypal express code is displayed)
193 public $isBackOffice = TRUE;
195 protected $_formType;
198 * @var mystery variable screaming out for documentation
203 * Array of fields to display on billingBlock.tpl - this is not fully implemented but basically intent is the panes/fieldsets on this page should
204 * be all in this array in order like
205 * 'credit_card' => array('credit_card_number' ...
206 * 'billing_details' => array('first_name' ...
208 * such that both the fields and the order can be more easily altered by payment processors & other extensions
211 public $billingFieldSets = array();
214 * Pre process function with common actions.
216 public function preProcess() {
217 $this->_contactID
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
218 $this->assign('contactID', $this->_contactID
);
220 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'add');
226 public function showRecordLinkMesssage($id) {
227 $statusId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_BAO_Contribution', $id, 'contribution_status_id');
228 if (CRM_Contribute_PseudoConstant
::contributionStatus($statusId, 'name') == 'Partially paid') {
229 if ($pid = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'participant_id', 'contribution_id')) {
230 $recordPaymentLink = CRM_Utils_System
::url('civicrm/payment',
231 "reset=1&id={$pid}&cid={$this->_contactID}&action=add&component=event"
233 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');
242 public function buildValuesAndAssignOnline_Note_Type($id, &$values) {
244 $params = array('id' => $id);
245 CRM_Contribute_BAO_Contribution
::getValues($params, $values, $ids);
247 //Check if this is an online transaction (financial_trxn.payment_processor_id NOT NULL)
248 $this->_online
= FALSE;
249 $fids = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($id);
250 if (!empty($fids['financialTrxnId'])) {
251 $this->_online
= CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $fids['financialTrxnId'], 'payment_processor_id');
254 // Also don't allow user to update some fields for recurring contributions.
255 if (!$this->_online
) {
256 $this->_online
= CRM_Utils_Array
::value('contribution_recur_id', $values);
259 $this->assign('isOnline', $this->_online ?
TRUE : FALSE);
262 $daoNote = new CRM_Core_BAO_Note();
263 $daoNote->entity_table
= 'civicrm_contribution';
264 $daoNote->entity_id
= $id;
265 if ($daoNote->find(TRUE)) {
266 $this->_noteID
= $daoNote->id
;
267 $values['note'] = $daoNote->note
;
269 $this->_contributionType
= $values['financial_type_id'];
273 * @param string $type
275 * @param string $subType
276 * @param int $entityId
278 public function applyCustomData($type, $subType, $entityId) {
279 $this->set('type', $type);
280 $this->set('subType', $subType);
281 $this->set('entityId', $entityId);
283 CRM_Custom_Form_CustomData
::preProcess($this, NULL, $subType, 1, $type, $entityId);
284 CRM_Custom_Form_CustomData
::buildQuickForm($this);
285 CRM_Custom_Form_CustomData
::setDefaultValues($this);
290 * @todo - this function is a long way, non standard of saying $dao = new CRM_Contribute_DAO_ContributionProduct(); $dao->id = $id; $dao->find();
292 public function assignPremiumProduct($id) {
295 FROM civicrm_contribution_product
296 WHERE contribution_id = {$id}
298 $dao = CRM_Core_DAO
::executeQuery($sql,
299 CRM_Core_DAO
::$_nullArray
302 $this->_premiumID
= $dao->id
;
303 $this->_productDAO
= $dao;
309 * This function process contribution related objects.
311 * @param int $contributionId
312 * @param int $statusId
313 * @param int|null $previousStatusId
315 * @return null|string
317 protected function updateRelatedComponent($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) {
319 if (!$contributionId ||
!$statusId) {
324 'contribution_id' => $contributionId,
325 'contribution_status_id' => $statusId,
326 'previous_contribution_status_id' => $previousStatusId,
327 'receive_date' => $receiveDate,
330 $updateResult = CRM_Contribute_BAO_Contribution
::transitionComponents($params);
332 if (!is_array($updateResult) ||
333 !($updatedComponents = CRM_Utils_Array
::value('updatedComponents', $updateResult)) ||
334 !is_array($updatedComponents) ||
335 empty($updatedComponents)
340 // get the user display name.
342 SELECT display_name as displayName
344 LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_contact.id )
345 WHERE civicrm_contribution.id = {$contributionId}";
346 $userDisplayName = CRM_Core_DAO
::singleValueQuery($sql);
348 // get the status message for user.
349 foreach ($updatedComponents as $componentName => $updatedStatusId) {
351 if ($componentName == 'CiviMember') {
352 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
353 CRM_Member_PseudoConstant
::membershipStatus()
355 if ($updatedStatusName == 'Cancelled') {
356 $statusMsg .= "<br />" . ts("Membership for %1 has been Cancelled.", array(1 => $userDisplayName));
358 elseif ($updatedStatusName == 'Expired') {
359 $statusMsg .= "<br />" . ts("Membership for %1 has been Expired.", array(1 => $userDisplayName));
362 $endDate = CRM_Utils_Array
::value('membership_end_date', $updateResult);
364 $statusMsg .= "<br />" . ts("Membership for %1 has been updated. The membership End Date is %2.",
366 1 => $userDisplayName,
374 if ($componentName == 'CiviEvent') {
375 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
376 CRM_Event_PseudoConstant
::participantStatus()
378 if ($updatedStatusName == 'Cancelled') {
379 $statusMsg .= "<br />" . ts("Event Registration for %1 has been Cancelled.", array(1 => $userDisplayName));
381 elseif ($updatedStatusName == 'Registered') {
382 $statusMsg .= "<br />" . ts("Event Registration for %1 has been updated.", array(1 => $userDisplayName));
386 if ($componentName == 'CiviPledge') {
387 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
388 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
390 if ($updatedStatusName == 'Cancelled') {
391 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Cancelled.", array(1 => $userDisplayName));
393 elseif ($updatedStatusName == 'Failed') {
394 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Failed.", array(1 => $userDisplayName));
396 elseif ($updatedStatusName == 'Completed') {
397 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been updated.", array(1 => $userDisplayName));
407 * Array of valid processors. The array resembles the DB table but also has 'object' as a key
410 public function getValidProcessors() {
412 $capabilities = array('BackOffice');
414 $capabilities[] = (ucfirst($this->_mode
) . 'Mode');
416 $processors = CRM_Financial_BAO_PaymentProcessor
::getPaymentProcessors($capabilities);
422 * Assign $this->processors, $this->recurPaymentProcessors, and related Smarty variables
424 public function assignProcessors() {
425 //ensure that processor has a valid config
426 //only valid processors get display to user
429 $this->assign('processorSupportsFutureStartDate', CRM_Financial_BAO_PaymentProcessor
::hasPaymentProcessorSupporting(array('supportsFutureRecurStartDate')));
430 $this->_paymentProcessors
= $this->getValidProcessors();
431 if (!isset($this->_paymentProcessor
['id'])) {
432 // 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
433 $this->_paymentProcessor
= reset($this->_paymentProcessors
);
435 if (empty($this->_paymentProcessors
)) {
436 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
)));
438 $this->_processors
= array();
439 foreach ($this->_paymentProcessors
as $id => $processor) {
440 $this->_processors
[$id] = ts($processor['name']);
441 if (!empty($processor['description'])) {
442 $this->_processors
[$id] .= ' : ' . ts($processor['description']);
444 if ($processor['is_recur']) {
445 $this->_recurPaymentProcessors
[$id] = $this->_processors
[$id];
449 $this->assign('recurringPaymentProcessorIds',
450 empty($this->_recurPaymentProcessors
) ?
'' : implode(',', array_keys($this->_recurPaymentProcessors
))
453 // this required to show billing block
454 // @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
455 $this->assign_by_ref('paymentProcessor', $processor);
459 * Get current currency from DB or use default currency.
461 * @param $submittedValues
465 public function getCurrency($submittedValues) {
466 $config = CRM_Core_Config
::singleton();
468 $currentCurrency = CRM_Utils_Array
::value('currency',
470 $config->defaultCurrency
473 // use submitted currency if present else use current currency
474 $result = CRM_Utils_Array
::value('currency',
482 * @param int $financialTypeId
486 public function getFinancialAccounts($financialTypeId) {
487 $financialAccounts = array();
488 CRM_Core_PseudoConstant
::populate($financialAccounts,
489 'CRM_Financial_DAO_EntityFinancialAccount',
491 $retrieve = 'financial_account_id',
493 " entity_id = {$financialTypeId} ", NULL, 'account_relationship');
494 return $financialAccounts;
498 * @param int $financialTypeId
499 * @param int $relationTypeId
503 public function getFinancialAccount($financialTypeId, $relationTypeId) {
504 $financialAccounts = $this->getFinancialAccounts($financialTypeId);
505 return CRM_Utils_Array
::value($relationTypeId, $financialAccounts);
508 public function preProcessPledge() {
509 //get the payment values associated with given pledge payment id OR check for payments due.
510 $this->_pledgeValues
= array();
512 $payParams = array('id' => $this->_ppID
);
514 CRM_Pledge_BAO_PledgePayment
::retrieve($payParams, $this->_pledgeValues
['pledgePayment']);
515 $this->_pledgeID
= CRM_Utils_Array
::value('pledge_id', $this->_pledgeValues
['pledgePayment']);
516 $paymentStatusID = CRM_Utils_Array
::value('status_id', $this->_pledgeValues
['pledgePayment']);
517 $this->_id
= CRM_Utils_Array
::value('contribution_id', $this->_pledgeValues
['pledgePayment']);
520 $allStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
521 if (!($paymentStatusID == array_search('Pending', $allStatus) ||
$paymentStatusID == array_search('Overdue', $allStatus))) {
522 CRM_Core_Error
::fatal(ts("Pledge payment status should be 'Pending' or 'Overdue'."));
525 //get the pledge values associated with given pledge payment.
528 $pledgeParams = array('id' => $this->_pledgeID
);
529 CRM_Pledge_BAO_Pledge
::getValues($pledgeParams, $this->_pledgeValues
, $ids);
530 $this->assign('ppID', $this->_ppID
);
533 // 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
534 if (isset($this->_contactID
)) {
535 $contactPledges = CRM_Pledge_BAO_Pledge
::getContactPledges($this->_contactID
);
537 if (!empty($contactPledges)) {
538 $payments = $paymentsDue = NULL;
539 $multipleDue = FALSE;
540 foreach ($contactPledges as $key => $pledgeId) {
541 $payments = CRM_Pledge_BAO_PledgePayment
::getOldestPledgePayment($pledgeId);
548 $paymentsDue = $payments;
553 // Show link to pledge tab since more than one pledge has a payment due
554 $pledgeTab = CRM_Utils_System
::url('civicrm/contact/view',
555 "reset=1&force=1&cid={$this->_contactID}&selectedChild=pledge"
557 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');
559 elseif ($paymentsDue) {
560 // Show user link to oldest Pending or Overdue pledge payment
561 $ppAmountDue = CRM_Utils_Money
::format($payments['amount'], $payments['currency']);
562 $ppSchedDate = CRM_Utils_Date
::customFormat(CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment', $payments['id'], 'scheduled_date'));
564 $ppUrl = CRM_Utils_System
::url('civicrm/contact/view/contribution',
565 "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge&mode=live"
569 $ppUrl = CRM_Utils_System
::url('civicrm/contact/view/contribution',
570 "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge"
573 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(
577 )), ts('Notice'), 'alert');
585 * @param array $submittedValues
589 public function unsetCreditCardFields($submittedValues) {
590 //Offline Contribution.
591 $unsetParams = array(
592 'payment_processor_id',
593 "email-{$this->_bltID}",
594 'hidden_buildCreditCard',
595 'hidden_buildDirectDebit',
596 'billing_first_name',
597 'billing_middle_name',
600 "city-{$this->_bltID}",
601 "state_province_id-{$this->_bltID}",
602 "postal_code-{$this->_bltID}",
603 "country_id-{$this->_bltID}",
604 'credit_card_number',
606 'credit_card_exp_date',
609 foreach ($unsetParams as $key) {
610 if (isset($submittedValues[$key])) {
611 unset($submittedValues[$key]);
614 return $submittedValues;
618 * Common block for setting up the parts of a form that relate to credit / debit card
621 protected function assignPaymentRelatedVariables() {
623 if ($this->_contactID
) {
624 list($this->userDisplayName
, $this->userEmail
) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
625 $this->assign('displayName', $this->userDisplayName
);
628 $this->assignProcessors();
630 $this->assignBillingType();
632 $this->_fields
= array();
633 CRM_Core_Payment_Form
::setPaymentFieldsByProcessor($this, $this->_paymentProcessor
, FALSE, TRUE);
636 catch (CRM_Core_Exception
$e) {
637 CRM_Core_Error
::fatal($e->getMessage());