3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
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 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-2015
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
41 static $_defaultPaymentProcessor = NULL;
44 * Create Payment Processor.
46 * @param array $params
47 * Parameters for Processor entity.
49 * @return CRM_Financial_DAO_PaymentProcessor
52 public static function create($params) {
53 // FIXME Reconcile with CRM_Admin_Form_PaymentProcessor::updatePaymentProcessor
54 $processor = new CRM_Financial_DAO_PaymentProcessor();
55 $processor->copyValues($params);
57 $ppTypeDAO = new CRM_Financial_DAO_PaymentProcessorType();
58 $ppTypeDAO->id
= $params['payment_processor_type_id'];
59 if (!$ppTypeDAO->find(TRUE)) {
60 CRM_Core_Error
::fatal(ts('Could not find payment processor meta information'));
63 // also copy meta fields from the info DAO
64 $processor->is_recur
= $ppTypeDAO->is_recur
;
65 $processor->billing_mode
= $ppTypeDAO->billing_mode
;
66 $processor->class_name
= $ppTypeDAO->class_name
;
67 $processor->payment_type
= $ppTypeDAO->payment_type
;
70 // CRM-11826, add entry in civicrm_entity_financial_account
71 // if financial_account_id is not NULL
72 if (!empty($params['financial_account_id'])) {
73 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
75 'entity_table' => 'civicrm_payment_processor',
76 'entity_id' => $processor->id
,
77 'account_relationship' => $relationTypeId,
78 'financial_account_id' => $params['financial_account_id'],
80 CRM_Financial_BAO_FinancialTypeAccount
::add($values);
82 Civi\Payment\System
::singleton()->flushProcessors();
89 public function __construct() {
90 parent
::__construct();
94 * Retrieve DB object based on input parameters.
96 * It also stores all the retrieved values in the default array.
98 * @param array $params
99 * (reference ) an assoc array of name/value pairs.
100 * @param array $defaults
101 * (reference ) an assoc array to hold the flattened values.
103 * @return CRM_Financial_DAO_PaymentProcessor|null
104 * object on success, null otherwise
106 public static function retrieve(&$params, &$defaults) {
107 $paymentProcessor = new CRM_Financial_DAO_PaymentProcessor();
108 $paymentProcessor->copyValues($params);
109 if ($paymentProcessor->find(TRUE)) {
110 CRM_Core_DAO
::storeValues($paymentProcessor, $defaults);
111 return $paymentProcessor;
117 * Update the is_active flag in the db.
120 * Id of the database record.
121 * @param bool $is_active
122 * Value we want to set the is_active field.
124 * @return CRM_Financial_DAO_PaymentProcessor|null
125 * DAO object on success, null otherwise
128 public static function setIsActive($id, $is_active) {
129 return CRM_Core_DAO
::setFieldValue('CRM_Financial_DAO_PaymentProcessor', $id, 'is_active', $is_active);
133 * Retrieve the default payment processor.
135 * @return CRM_Financial_DAO_PaymentProcessor|null
136 * The default payment processor object on success,
139 public static function &getDefault() {
140 if (self
::$_defaultPaymentProcessor == NULL) {
141 $params = array('is_default' => 1);
143 self
::$_defaultPaymentProcessor = self
::retrieve($params, $defaults);
145 return self
::$_defaultPaymentProcessor;
149 * Delete payment processor.
151 * @param int $paymentProcessorID
155 public static function del($paymentProcessorID) {
156 if (!$paymentProcessorID) {
157 CRM_Core_Error
::fatal(ts('Invalid value passed to delete function.'));
160 $dao = new CRM_Financial_DAO_PaymentProcessor();
161 $dao->id
= $paymentProcessorID;
162 if (!$dao->find(TRUE)) {
166 $testDAO = new CRM_Financial_DAO_PaymentProcessor();
167 $testDAO->name
= $dao->name
;
168 $testDAO->is_test
= 1;
172 Civi\Payment\System
::singleton()->flushProcessors();
176 * Get the payment processor details.
178 * This returns an array whereas Civi\Payment\System::singleton->getByID() returns an object.
179 * The object is a key in the array.
181 * @param int $paymentProcessorID
182 * Payment processor id.
183 * @param string $mode
184 * Payment mode ie test or live.
187 * associated array with payment processor related fields
189 public static function getPayment($paymentProcessorID, $mode = 'based_on_id') {
190 $capabilities = ($mode == 'test') ?
array('TestMode') : array();
191 $processors = self
::getPaymentProcessors($capabilities, array($paymentProcessorID));
192 $processor = $processors[$paymentProcessorID];
196 'payment_processor_type_id',
212 // Just to prevent e-Notices elsewhere we set all fields.
213 foreach ($fields as $name) {
214 if (!isset($processor)) {
215 $processor[$name] = NULL;
218 $processor['payment_processor_type'] = CRM_Core_PseudoConstant
::paymentProcessorType(FALSE,
219 $processor['payment_processor_type_id'], 'name');
220 return $processors[$paymentProcessorID];
224 * Given a live processor ID get the test id.
229 * Test payment processor ID.
231 public static function getTestProcessorId($id) {
232 $liveProcessorName = civicrm_api3('payment_processor', 'getvalue', array(
236 return civicrm_api3('payment_processor', 'getvalue', array(
238 'name' => $liveProcessorName,
239 'domain_id' => CRM_Core_Config
::domainID(),
244 * Compare 2 payment processors to see which should go first based on is_default
245 * (sort function for sortDefaultFirst)
246 * @param array $processor1
247 * @param array $processor2
251 public static function defaultComparison($processor1, $processor2) {
252 $p1 = CRM_Utils_Array
::value('is_default', $processor1);
253 $p2 = CRM_Utils_Array
::value('is_default', $processor2);
257 return ($p1 > $p2) ?
-1 : 1;
261 * Get all payment processors as an array of objects.
263 * @param string|NULL $mode
264 * only return this mode - test|live or NULL for all
267 * @throws CiviCRM_API3_Exception
270 public static function getAllPaymentProcessors($mode = 'all', $reset = FALSE) {
272 $cacheKey = 'CRM_Financial_BAO_Payment_Processor_' . $mode . '_' . CRM_Core_Config
::domainID();
274 $processors = CRM_Utils_Cache
::singleton()->get($cacheKey);
275 if (!empty($processors)) {
280 $retrievalParameters = array(
282 'domain_id' => CRM_Core_Config
::domainID(),
283 'options' => array('sort' => 'is_default DESC, name'),
284 'api.payment_processor_type.getsingle' => 1,
286 if ($mode == 'test') {
287 $retrievalParameters['is_test'] = 1;
289 elseif ($mode == 'live') {
290 $retrievalParameters['is_test'] = 0;
293 $processors = civicrm_api3('payment_processor', 'get', $retrievalParameters);
294 foreach ($processors['values'] as $processor) {
295 $fieldsToProvide = array('user_name', 'password', 'signature', 'subject', 'is_recur');
296 foreach ($fieldsToProvide as $field) {
297 // Prevent e-notices in processor classes when not configured.
298 if (!isset($processor[$field])) {
299 $processors['values'][$processor['id']][$field] = NULL;
302 $processors['values'][$processor['id']]['payment_processor_type'] = $processor['payment_processor_type'] = $processors['values'][$processor['id']]['api.payment_processor_type.getsingle']['name'];
303 $processors['values'][$processor['id']]['object'] = Civi\Payment\System
::singleton()->getByProcessor($processor);
306 // Add the pay-later pseudo-processor.
307 $processors['values'][0] = array(
308 'object' => new CRM_Core_Payment_Manual(),
310 'payment_processor_type_id' => 0,
311 // This shouldn't be required but there are still some processors hacked into core with nasty 'if's.
312 'payment_processor_type' => 'Manual',
313 'class_name' => 'Payment_Manual',
314 'name' => 'pay_later',
315 'billing_mode' => '',
316 // Making this optionally recur would give lots of options -but it should
317 // be a row in the payment processor table before we do that.
321 CRM_Utils_Cache
::singleton()->set($cacheKey, $processors['values']);
323 return $processors['values'];
327 * Get Payment processors with specified capabilities.
328 * Note that both the singleton & the pseudoconstant function have caching so we don't add
329 * arguably this could go on the pseudoconstant class
331 * @param array $capabilities
332 * capabilities of processor e.g
338 * @param array|bool $ids
341 * available processors
343 public static function getPaymentProcessors($capabilities = array(), $ids = FALSE) {
345 $testProcessors = in_array('TestMode', $capabilities) ? self
::getAllPaymentProcessors('test') : array();
346 $processors = $liveProcessors = self
::getAllPaymentProcessors('all');
348 if (in_array('TestMode', $capabilities)) {
350 foreach ($testProcessors as $testProcessor) {
351 if (!in_array($testProcessor['id'], $ids)) {
352 foreach ($liveProcessors as $liveProcessor) {
353 if ($liveProcessor['name'] == $testProcessor['name']) {
354 $ids[] = $testProcessor['id'];
360 $processors = $testProcessors;
363 foreach ($processors as $index => $processor) {
364 if ($ids && !in_array($processor['id'], $ids)) {
365 unset ($processors[$index]);
368 // Invalid processors will store a null value in 'object' (e.g. if not all required config fields are present).
369 // This is determined by calling when loading the processor via the $processorObject->checkConfig() function.
370 if (!is_a($processor['object'], 'CRM_Core_Payment')) {
371 unset ($processors[$index]);
374 foreach ($capabilities as $capability) {
375 if (($processor['object']->supports($capability)) == FALSE) {
376 unset ($processors[$index]);
386 * Is there a processor on this site with the specified capability.
387 * @param array $capabilities
391 public static function hasPaymentProcessorSupporting($capabilities = array()) {
392 $result = self
::getPaymentProcessors($capabilities);
393 return (!empty($result)) ?
TRUE : FALSE;
397 * Retrieve payment processor id / info/ object based on component-id.
399 * @todo function needs revisiting. The whole 'info / obj' thing is an overload. Recommend creating new functions
400 * that are entity specific as there is little shared code specific to obj or info
402 * Also, it does not accurately derive the processor - for a completed contribution the best place to look is in the
403 * relevant financial_trxn record. For a recurring contribution it is in the contribution_recur table.
405 * For a membership the relevant contribution_recur should be derived & then resolved as above. The contribution page
406 * is never a reliable place to look as there can be more than one configured. For a pending contribution there is
407 * no way to derive the processor - but hey - what processor? it didn't go through!
409 * Query for membership might look something like:
410 * SELECT fte.payment_processor_id
411 * FROM civicrm_membership mem
412 * INNER JOIN civicrm_line_item li ON ( mem.id = li.entity_id AND li.entity_table = 'civicrm_membership')
413 * INNER JOIN civicrm_contribution con ON ( li.contribution_id = con.id )
414 * LEFT JOIN civicrm_entity_financial_trxn ft ON ft.entity_id = con.id AND ft.entity_table =
415 * 'civicrm_contribution'
416 * LEFT JOIN civicrm_financial_trxn fte ON fte.id = ft.financial_trxn_id
418 * @param int $entityID
419 * @param string $component
421 * @param string $type
422 * Type of payment information to be retrieved.
424 * @return int|array|object
426 public static function getProcessorForEntity($entityID, $component = 'contribute', $type = 'id') {
428 if (!in_array($component, array(
437 if ($component == 'membership') {
439 SELECT cr.payment_processor_id as ppID1, cp.payment_processor as ppID2, con.is_test
440 FROM civicrm_membership mem
441 INNER JOIN civicrm_membership_payment mp ON ( mem.id = mp.membership_id )
442 INNER JOIN civicrm_contribution con ON ( mp.contribution_id = con.id )
443 LEFT JOIN civicrm_contribution_recur cr ON ( mem.contribution_recur_id = cr.id )
444 LEFT JOIN civicrm_contribution_page cp ON ( con.contribution_page_id = cp.id )
445 WHERE mp.membership_id = %1";
447 elseif ($component == 'contribute') {
449 SELECT cr.payment_processor_id as ppID1, cp.payment_processor as ppID2, con.is_test
450 FROM civicrm_contribution con
451 LEFT JOIN civicrm_contribution_recur cr ON ( con.contribution_recur_id = cr.id )
452 LEFT JOIN civicrm_contribution_page cp ON ( con.contribution_page_id = cp.id )
455 elseif ($component == 'recur') {
457 SELECT cr.payment_processor_id as ppID1, NULL as ppID2, cr.is_test
458 FROM civicrm_contribution_recur cr
462 // We are interested in a single record.
465 $params = array(1 => array($entityID, 'Integer'));
466 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
468 if (!$dao->fetch()) {
474 $ppID = (isset($dao->ppID1
) && $dao->ppID1
) ?
$dao->ppID1
: (isset($dao->ppID2
) ?
$dao->ppID2
: NULL);
475 $mode = (isset($dao->is_test
) && $dao->is_test
) ?
'test' : 'live';
476 if (!$ppID ||
$type == 'id') {
479 elseif ($type == 'info') {
480 $result = self
::getPayment($ppID, $mode);
482 elseif ($type == 'obj' && is_numeric($ppID)) {
484 $paymentProcessor = civicrm_api3('PaymentProcessor', 'getsingle', array('id' => $ppID));
486 catch (API_Exception
$e) {
487 // Unable to load the processor because this function uses an unreliable method to derive it.
488 // The function looks to load the payment processor ID from the contribution page, which
489 // can support multiple processors.
491 $result = Civi\Payment\System
::singleton()->getByProcessor($paymentProcessor);