3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 useful, 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-2019
35 * This class contains payment processor related functions.
37 class CRM_Financial_BAO_PaymentProcessor
extends CRM_Financial_DAO_PaymentProcessor
{
39 * Static holder for the default payment processor
42 public static $_defaultPaymentProcessor = NULL;
45 * Create Payment Processor.
47 * @param array $params
48 * Parameters for Processor entity.
50 * @return CRM_Financial_DAO_PaymentProcessor
53 public static function create($params) {
54 $processor = new CRM_Financial_DAO_PaymentProcessor();
55 $processor->copyValues($params);
57 if (empty($params['id'])) {
58 $ppTypeDAO = new CRM_Financial_DAO_PaymentProcessorType();
59 $ppTypeDAO->id
= $params['payment_processor_type_id'];
60 if (!$ppTypeDAO->find(TRUE)) {
61 CRM_Core_Error
::fatal(ts('Could not find payment processor meta information'));
64 // also copy meta fields from the info DAO
65 $processor->is_recur
= $ppTypeDAO->is_recur
;
66 $processor->billing_mode
= $ppTypeDAO->billing_mode
;
67 $processor->class_name
= $ppTypeDAO->class_name
;
68 $processor->payment_type
= $ppTypeDAO->payment_type
;
72 // CRM-11826, add entry in civicrm_entity_financial_account
73 // if financial_account_id is not NULL
74 if (!empty($params['financial_account_id'])) {
75 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
77 'entity_table' => 'civicrm_payment_processor',
78 'entity_id' => $processor->id
,
79 'account_relationship' => $relationTypeId,
80 'financial_account_id' => $params['financial_account_id'],
82 CRM_Financial_BAO_FinancialTypeAccount
::add($values);
85 if (isset($params['id']) && isset($params['is_active']) && !isset($params['is_test'])) {
86 // check if is_active has changed & if so update test instance is_active too.
87 $test_id = self
::getTestProcessorId($params['id']);
88 $testDAO = new CRM_Financial_DAO_PaymentProcessor();
89 $testDAO->id
= $test_id;
90 if ($testDAO->find(TRUE)) {
91 $testDAO->is_active
= $params['is_active'];
96 Civi\Payment\System
::singleton()->flushProcessors();
103 public function __construct() {
104 parent
::__construct();
108 * Retrieve array of allowed credit cards for this payment processor.
109 * @param interger|null $paymentProcessorID id of processor.
112 public static function getCreditCards($paymentProcessorID = NULL) {
113 if (!empty($paymentProcessorID)) {
114 $processor = new CRM_Financial_DAO_PaymentProcessor();
115 $processor->id
= $paymentProcessorID;
116 $processor->find(TRUE);
117 $cards = json_decode($processor->accepted_credit_cards
, TRUE);
124 * Retrieve DB object based on input parameters.
126 * It also stores all the retrieved values in the default array.
128 * @param array $params
129 * (reference ) an assoc array of name/value pairs.
130 * @param array $defaults
131 * (reference ) an assoc array to hold the flattened values.
133 * @return CRM_Financial_DAO_PaymentProcessor|null
134 * object on success, null otherwise
136 public static function retrieve(&$params, &$defaults) {
137 $paymentProcessor = new CRM_Financial_DAO_PaymentProcessor();
138 $paymentProcessor->copyValues($params);
139 if ($paymentProcessor->find(TRUE)) {
140 CRM_Core_DAO
::storeValues($paymentProcessor, $defaults);
141 return $paymentProcessor;
147 * Update the is_active flag in the db.
150 * Id of the database record.
151 * @param bool $is_active
152 * Value we want to set the is_active field.
155 * true if we found and updated the object, else false
157 public static function setIsActive($id, $is_active) {
158 return CRM_Core_DAO
::setFieldValue('CRM_Financial_DAO_PaymentProcessor', $id, 'is_active', $is_active);
162 * Retrieve the default payment processor.
164 * @return CRM_Financial_DAO_PaymentProcessor|null
165 * The default payment processor object on success,
168 public static function &getDefault() {
169 if (self
::$_defaultPaymentProcessor == NULL) {
170 $params = ['is_default' => 1];
172 self
::$_defaultPaymentProcessor = self
::retrieve($params, $defaults);
174 return self
::$_defaultPaymentProcessor;
178 * Delete payment processor.
180 * @param int $paymentProcessorID
184 public static function del($paymentProcessorID) {
185 if (!$paymentProcessorID) {
186 CRM_Core_Error
::fatal(ts('Invalid value passed to delete function.'));
189 $dao = new CRM_Financial_DAO_PaymentProcessor();
190 $dao->id
= $paymentProcessorID;
191 if (!$dao->find(TRUE)) {
195 $testDAO = new CRM_Financial_DAO_PaymentProcessor();
196 $testDAO->name
= $dao->name
;
197 $testDAO->is_test
= 1;
201 Civi\Payment\System
::singleton()->flushProcessors();
205 * Get the payment processor details.
207 * This returns an array whereas Civi\Payment\System::singleton->getByID() returns an object.
208 * The object is a key in the array.
210 * @param int $paymentProcessorID
211 * Payment processor id.
212 * @param string $mode
213 * Payment mode ie test or live.
216 * associated array with payment processor related fields
218 public static function getPayment($paymentProcessorID, $mode = 'based_on_id') {
219 $capabilities = ($mode == 'test') ?
['TestMode'] : [];
220 $processors = self
::getPaymentProcessors($capabilities, [$paymentProcessorID]);
221 return $processors[$paymentProcessorID];
225 * Given a live processor ID get the test id.
230 * Test payment processor ID.
232 public static function getTestProcessorId($id) {
233 $liveProcessorName = civicrm_api3('payment_processor', 'getvalue', [
237 return civicrm_api3('payment_processor', 'getvalue', [
239 'name' => $liveProcessorName,
241 'domain_id' => CRM_Core_Config
::domainID(),
246 * Compare 2 payment processors to see which should go first based on is_default
247 * (sort function for sortDefaultFirst)
248 * @param array $processor1
249 * @param array $processor2
253 public static function defaultComparison($processor1, $processor2) {
254 $p1 = CRM_Utils_Array
::value('is_default', $processor1);
255 $p2 = CRM_Utils_Array
::value('is_default', $processor2);
259 return ($p1 > $p2) ?
-1 : 1;
263 * Get all payment processors as an array of objects.
265 * @param string|NULL $mode
266 * only return this mode - test|live or NULL for all
268 * @param bool $isCurrentDomainOnly
269 * Do we only want to load payment processors associated with the current domain.
271 * @throws CiviCRM_API3_Exception
274 public static function getAllPaymentProcessors($mode = 'all', $reset = FALSE, $isCurrentDomainOnly = TRUE) {
276 $cacheKey = 'CRM_Financial_BAO_Payment_Processor_' . $mode . '_' . $isCurrentDomainOnly . '_' . CRM_Core_Config
::domainID();
278 $processors = CRM_Utils_Cache
::singleton()->get($cacheKey);
279 if (!empty($processors)) {
284 $retrievalParameters = [
286 'options' => ['sort' => 'is_default DESC, name', 'limit' => 0],
287 'api.payment_processor_type.getsingle' => 1,
289 if ($isCurrentDomainOnly) {
290 $retrievalParameters['domain_id'] = CRM_Core_Config
::domainID();
292 if ($mode == 'test') {
293 $retrievalParameters['is_test'] = 1;
295 elseif ($mode == 'live') {
296 $retrievalParameters['is_test'] = 0;
299 $processors = civicrm_api3('payment_processor', 'get', $retrievalParameters);
300 foreach ($processors['values'] as $processor) {
304 'payment_processor_type_id',
320 foreach ($fieldsToProvide as $field) {
321 // Prevent e-notices in processor classes when not configured.
322 if (!isset($processor[$field])) {
323 $processors['values'][$processor['id']][$field] = NULL;
326 $processors['values'][$processor['id']]['payment_processor_type'] = $processor['payment_processor_type'] = $processors['values'][$processor['id']]['api.payment_processor_type.getsingle']['name'];
327 $processors['values'][$processor['id']]['object'] = Civi\Payment\System
::singleton()->getByProcessor($processor);
330 // Add the pay-later pseudo-processor.
331 $processors['values'][0] = [
332 'object' => new CRM_Core_Payment_Manual(),
334 'payment_processor_type_id' => 0,
335 // This shouldn't be required but there are still some processors hacked into core with nasty 'if's.
336 'payment_processor_type' => 'Manual',
337 'class_name' => 'Payment_Manual',
338 'name' => 'pay_later',
339 'billing_mode' => '',
341 'payment_instrument_id' => key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1')),
342 // Making this optionally recur would give lots of options -but it should
343 // be a row in the payment processor table before we do that.
348 CRM_Utils_Cache
::singleton()->set($cacheKey, $processors['values']);
350 return $processors['values'];
354 * Get Payment processors with specified capabilities.
355 * Note that both the singleton & the pseudoconstant function have caching so we don't add
356 * arguably this could go on the pseudoconstant class
358 * @param array $capabilities
359 * capabilities of processor e.g
365 * @param array|bool $ids
368 * available processors
370 public static function getPaymentProcessors($capabilities = [], $ids = FALSE) {
371 $testProcessors = in_array('TestMode', $capabilities) ? self
::getAllPaymentProcessors('test') : [];
372 if (is_array($ids)) {
373 $processors = self
::getAllPaymentProcessors('all', FALSE, FALSE);
374 if (in_array('TestMode', $capabilities)) {
375 $possibleLiveIDs = array_diff($ids, array_keys($testProcessors));
376 foreach ($possibleLiveIDs as $possibleLiveID) {
377 if (isset($processors[$possibleLiveID]) && ($liveProcessorName = $processors[$possibleLiveID]['name']) != FALSE) {
378 foreach ($testProcessors as $index => $testProcessor) {
379 if ($testProcessor['name'] == $liveProcessorName) {
380 $ids[] = $testProcessor['id'];
385 $processors = $testProcessors;
389 $processors = self
::getAllPaymentProcessors('all');
392 foreach ($processors as $index => $processor) {
393 if (is_array($ids) && !in_array($processor['id'], $ids)) {
394 unset($processors[$index]);
397 // Invalid processors will store a null value in 'object' (e.g. if not all required config fields are present).
398 // This is determined by calling when loading the processor via the $processorObject->checkConfig() function.
399 if (!is_a($processor['object'], 'CRM_Core_Payment')) {
400 unset($processors[$index]);
403 foreach ($capabilities as $capability) {
404 if (($processor['object']->supports($capability)) == FALSE) {
405 unset($processors[$index]);
415 * Is there a processor on this site with the specified capability.
417 * The capabilities are defined on CRM_Core_Payment and can be extended by
421 * - supportsBackOffice
423 * - supportsFutureRecurDate
424 * - supportsRecurring
425 * - supportsCancelRecurring
426 * - supportsRecurContributionsForPledges
428 * They are passed as array('BackOffice');
430 * Details of specific functions are in the docblocks on the CRM_Core_Payment class.
432 * @param array $capabilities
436 public static function hasPaymentProcessorSupporting($capabilities = []) {
437 $capabilitiesString = implode('', $capabilities);
438 if (!isset(\Civi
::$statics[__CLASS__
]['supported_capabilities'][$capabilitiesString])) {
439 $result = self
::getPaymentProcessors($capabilities);
440 \Civi
::$statics[__CLASS__
]['supported_capabilities'][$capabilitiesString] = (!empty($result) && array_keys($result) !== [0]) ?
TRUE : FALSE;
442 return \Civi
::$statics[__CLASS__
]['supported_capabilities'][$capabilitiesString];
446 * Retrieve payment processor id / info/ object based on component-id.
448 * @todo function needs revisiting. The whole 'info / obj' thing is an overload. Recommend creating new functions
449 * that are entity specific as there is little shared code specific to obj or info
451 * Also, it does not accurately derive the processor - for a completed contribution the best place to look is in the
452 * relevant financial_trxn record. For a recurring contribution it is in the contribution_recur table.
454 * For a membership the relevant contribution_recur should be derived & then resolved as above. The contribution page
455 * is never a reliable place to look as there can be more than one configured. For a pending contribution there is
456 * no way to derive the processor - but hey - what processor? it didn't go through!
458 * Query for membership might look something like:
459 * SELECT fte.payment_processor_id
460 * FROM civicrm_membership mem
461 * INNER JOIN civicrm_line_item li ON ( mem.id = li.entity_id AND li.entity_table = 'civicrm_membership')
462 * INNER JOIN civicrm_contribution con ON ( li.contribution_id = con.id )
463 * LEFT JOIN civicrm_entity_financial_trxn ft ON ft.entity_id = con.id AND ft.entity_table =
464 * 'civicrm_contribution'
465 * LEFT JOIN civicrm_financial_trxn fte ON fte.id = ft.financial_trxn_id
467 * @param int $entityID
468 * @param string $component
470 * @param string $type
471 * Type of payment information to be retrieved.
473 * @return int|array|object
475 public static function getProcessorForEntity($entityID, $component = 'contribute', $type = 'id') {
477 if (!in_array($component, [
486 if ($component == 'membership') {
488 SELECT cr.payment_processor_id as ppID1, cp.payment_processor as ppID2, con.is_test
489 FROM civicrm_membership mem
490 INNER JOIN civicrm_membership_payment mp ON ( mem.id = mp.membership_id )
491 INNER JOIN civicrm_contribution con ON ( mp.contribution_id = con.id )
492 LEFT JOIN civicrm_contribution_recur cr ON ( mem.contribution_recur_id = cr.id )
493 LEFT JOIN civicrm_contribution_page cp ON ( con.contribution_page_id = cp.id )
494 WHERE mp.membership_id = %1";
496 elseif ($component == 'contribute') {
498 SELECT cr.payment_processor_id as ppID1, cp.payment_processor as ppID2, con.is_test
499 FROM civicrm_contribution con
500 LEFT JOIN civicrm_contribution_recur cr ON ( con.contribution_recur_id = cr.id )
501 LEFT JOIN civicrm_contribution_page cp ON ( con.contribution_page_id = cp.id )
504 elseif ($component == 'recur') {
505 // @deprecated - use getPaymentProcessorForRecurringContribution.
507 SELECT cr.payment_processor_id as ppID1, NULL as ppID2, cr.is_test
508 FROM civicrm_contribution_recur cr
512 // We are interested in a single record.
515 $params = [1 => [$entityID, 'Integer']];
516 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
518 if (!$dao->fetch()) {
524 $ppID = (isset($dao->ppID1
) && $dao->ppID1
) ?
$dao->ppID1
: (isset($dao->ppID2
) ?
$dao->ppID2
: NULL);
525 $mode = (isset($dao->is_test
) && $dao->is_test
) ?
'test' : 'live';
526 if (!$ppID ||
$type == 'id') {
529 elseif ($type == 'info') {
530 $result = self
::getPayment($ppID, $mode);
532 elseif ($type == 'obj' && is_numeric($ppID)) {
534 $paymentProcessor = civicrm_api3('PaymentProcessor', 'getsingle', ['id' => $ppID]);
536 catch (API_Exception
$e) {
537 // Unable to load the processor because this function uses an unreliable method to derive it.
538 // The function looks to load the payment processor ID from the contribution page, which
539 // can support multiple processors.
542 $paymentProcessor['payment_processor_type'] = CRM_Core_PseudoConstant
::getName('CRM_Financial_BAO_PaymentProcessor', 'payment_processor_type_id', $paymentProcessor['payment_processor_type_id']);
543 $result = Civi\Payment\System
::singleton()->getByProcessor($paymentProcessor);
549 * Get the payment processor associated with a recurring contribution series.
551 * @param int $contributionRecurID
553 * @return \CRM_Core_Payment
555 public static function getPaymentProcessorForRecurringContribution($contributionRecurID) {
556 $paymentProcessorId = civicrm_api3('ContributionRecur', 'getvalue', [
557 'id' => $contributionRecurID,
558 'return' => 'payment_processor_id',
560 return Civi\Payment\System
::singleton()->getById($paymentProcessorId);
564 * Get the name of the payment processor
566 * @param $paymentProcessorId
568 * @return null|string
570 public static function getPaymentProcessorName($paymentProcessorId) {
572 $paymentProcessor = civicrm_api3('PaymentProcessor', 'getsingle', [
573 'return' => ['name'],
574 'id' => $paymentProcessorId,
576 return $paymentProcessor['name'];
578 catch (Exception
$e) {
579 return ts('Unknown') . ' (' . $paymentProcessorId . ')';
584 * Generate and assign an arbitrary value to a field of a test object.
586 * @param string $fieldName
587 * @param array $fieldDef
588 * @param int $counter
589 * The globally-unique ID of the test object.
591 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
592 if ($fieldName === 'class_name') {
593 $this->class_name
= 'Payment_Dummy';
596 parent
::assignTestValue($fieldName, $fieldDef, $counter);
601 * Get the default financial account id for payment processor accounts.
603 * Note that there is only a 'name' field & no label field. If people customise
604 * name then this won't work. This is new best-effort functionality so that's non-regressive.
606 * The fix for that is to add a label value to the financial account table.
608 public static function getDefaultFinancialAccountID() {
609 return CRM_Core_PseudoConstant
::getKey('CRM_Financial_DAO_EntityFinancialAccount', 'financial_account_id', 'Payment Processor Account');