3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
37 * This class contains payment processor related functions.
39 class CRM_Financial_BAO_PaymentProcessor
extends CRM_Financial_DAO_PaymentProcessor
42 * static holder for the default payment processor
44 static $_defaultPaymentProcessor = NULL;
47 * Create Payment Processor
49 * @params array parameters for Processor entity
51 static function create($params) {
52 // FIXME Reconcile with CRM_Admin_Form_PaymentProcessor::updatePaymentProcessor
53 $processor = new CRM_Financial_DAO_PaymentProcessor();
54 $processor->copyValues($params);
56 $ppTypeDAO = new CRM_Financial_DAO_PaymentProcessorType();
57 $ppTypeDAO->id
= $params['payment_processor_type_id'];
58 if (!$ppTypeDAO->find(TRUE)) {
59 CRM_Core_Error
::fatal(ts('Could not find payment processor meta information'));
62 // also copy meta fields from the info DAO
63 $processor->is_recur
= $ppTypeDAO->is_recur
;
64 $processor->billing_mode
= $ppTypeDAO->billing_mode
;
65 $processor->class_name
= $ppTypeDAO->class_name
;
66 $processor->payment_type
= $ppTypeDAO->payment_type
;
69 // CRM-11826, add entry in civicrm_entity_financial_account
70 // if financial_account_id is not NULL
71 if (CRM_Utils_Array
::value('financial_account_id', $params)) {
72 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
74 'entity_table' => 'civicrm_payment_processor',
75 'entity_id' => $processor->id
,
76 'account_relationship' => $relationTypeId,
77 'financial_account_id' => $params['financial_account_id']
79 CRM_Financial_BAO_FinancialTypeAccount
::add($values);
87 function __construct() {
88 parent
::__construct();
92 * Takes a bunch of params that are needed to match certain criteria and
93 * retrieves the relevant objects. It also stores all the retrieved
94 * values in the default array
96 * @param array $params (reference ) an assoc array of name/value pairs
97 * @param array $defaults (reference ) an assoc array to hold the flattened values
99 * @return object CRM_Financial_DAO_PaymentProcessor object on success, null otherwise
103 static function retrieve(&$params, &$defaults) {
104 $paymentProcessor = new CRM_Financial_DAO_PaymentProcessor();
105 $paymentProcessor->copyValues($params);
106 if ($paymentProcessor->find(TRUE)) {
107 CRM_Core_DAO
::storeValues($paymentProcessor, $defaults);
108 return $paymentProcessor;
114 * update the is_active flag in the db
116 * @param int $id id of the database record
117 * @param boolean $is_active value we want to set the is_active field
119 * @return Object DAO object on sucess, null otherwise
124 static function setIsActive($id, $is_active) {
125 return CRM_Core_DAO
::setFieldValue('CRM_Financial_DAO_PaymentProcessor', $id, 'is_active', $is_active);
129 * retrieve the default payment processor
133 * @return object The default payment processor object on success,
138 static function &getDefault() {
139 if (self
::$_defaultPaymentProcessor == NULL) {
140 $params = array('is_default' => 1);
142 self
::$_defaultPaymentProcessor = self
::retrieve($params, $defaults);
144 return self
::$_defaultPaymentProcessor;
148 * Function to delete payment processor
150 * @param int $paymentProcessorId ID of the processor to be deleted.
155 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;
175 * Function to get the payment processor details
177 * @param int $paymentProcessorID payment processor id
178 * @param string $mode payment mode ie test or live
180 * @return array associated array with payment processor related fields
184 static function getPayment($paymentProcessorID, $mode) {
185 if (!$paymentProcessorID) {
186 CRM_Core_Error
::fatal(ts('Invalid value passed to getPayment function'));
189 $dao = new CRM_Financial_DAO_PaymentProcessor( );
190 $dao->id
= $paymentProcessorID;
192 if (!$dao->find(TRUE)) {
196 if ($mode == 'test') {
197 $testDAO = new CRM_Financial_DAO_PaymentProcessor( );
198 $testDAO->name
= $dao->name
;
199 $testDAO->is_active
= 1;
200 $testDAO->is_test
= 1;
201 if (!$testDAO->find(TRUE)) {
202 CRM_Core_Error
::fatal(ts('Could not retrieve payment processor details'));
204 return self
::buildPayment($testDAO, $mode);
207 return self
::buildPayment($dao, $mode);
211 static function getPayments($paymentProcessorIDs, $mode) {
212 if (!$paymentProcessorIDs) {
213 CRM_Core_Error
::fatal(ts('Invalid value passed to getPayment function'));
216 $payments = array( );
217 foreach ($paymentProcessorIDs as $paymentProcessorID) {
218 $payment = self
::getPayment($paymentProcessorID, $mode);
219 $payments[$payment['id']] = $payment;
222 uasort($payments, 'self::defaultComparison');
227 * compare 2 payment processors to see which should go first based on is_default
228 * (sort function for sortDefaultFirst)
229 * @param array $processor1
230 * @param array_type $processor2
233 static function defaultComparison($processor1, $processor2){
234 $p1 = CRM_Utils_Array
::value('is_default', $processor1);
235 $p2 = CRM_Utils_Array
::value('is_default', $processor2);
239 return ($p1 > $p2) ?
-1 : 1;
243 * Function to build payment processor details
245 * @param object $dao payment processor object
246 * @param string $mode payment mode ie test or live
248 * @return array associated array with payment processor related fields
252 static function buildPayment($dao, $mode) {
254 'id', 'name', 'payment_processor_type_id', 'user_name', 'password',
255 'signature', 'url_site', 'url_api', 'url_recur', 'url_button',
256 'subject', 'class_name', 'is_recur', 'billing_mode',
257 'payment_type', 'is_default',
260 foreach ($fields as $name) {
261 $result[$name] = $dao->$name;
263 $result['payment_processor_type'] = CRM_Core_PseudoConstant
::paymentProcessorType(FALSE, $dao->payment_processor_type_id
, 'name');
265 $result['instance'] =& CRM_Core_Payment
::singleton($mode, $result);
271 * Function to retrieve payment processor id / info/ object based on component-id.
273 * @param int $componentID id of a component
274 * @param string $component component
275 * @param string $type type of payment information to be retrieved
277 * @return id / array / object based on type
281 static function getProcessorForEntity($entityID, $component = 'contribute', $type = 'id') {
283 if (!in_array($component, array(
284 'membership', 'contribute', 'recur'))) {
288 if ($component == 'membership') {
290 SELECT cr.payment_processor_id as ppID1, cp.payment_processor as ppID2, con.is_test
291 FROM civicrm_membership mem
292 INNER JOIN civicrm_membership_payment mp ON ( mem.id = mp.membership_id )
293 INNER JOIN civicrm_contribution con ON ( mp.contribution_id = con.id )
294 LEFT JOIN civicrm_contribution_recur cr ON ( mem.contribution_recur_id = cr.id )
295 LEFT JOIN civicrm_contribution_page cp ON ( con.contribution_page_id = cp.id )
296 WHERE mp.membership_id = %1";
298 elseif ($component == 'contribute') {
300 SELECT cr.payment_processor_id as ppID1, cp.payment_processor as ppID2, con.is_test
301 FROM civicrm_contribution con
302 LEFT JOIN civicrm_contribution_recur cr ON ( con.contribution_recur_id = cr.id )
303 LEFT JOIN civicrm_contribution_page cp ON ( con.contribution_page_id = cp.id )
306 elseif ($component == 'recur') {
308 SELECT cr.payment_processor_id as ppID1, NULL as ppID2, cr.is_test
309 FROM civicrm_contribution_recur cr
313 //we are interesting in single record.
316 $params = array(1 => array($entityID, 'Integer'));
317 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
319 if (!$dao->fetch()) {
325 $ppID = (isset($dao->ppID1
) && $dao->ppID1
) ?
$dao->ppID1
: (isset($dao->ppID2
) ?
$dao->ppID2
: NULL);
326 $mode = (isset($dao->is_test
) && $dao->is_test
) ?
'test' : 'live';
327 if (!$ppID ||
$type == 'id') {
330 elseif ($type == 'info') {
331 $result = self
::getPayment($ppID, $mode);
333 elseif ($type == 'obj') {
334 $payment = self
::getPayment($ppID, $mode);
335 $result = CRM_Core_Payment
::singleton($mode, $payment);