Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 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. | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * This class contains payment processor related functions. | |
38 | */ | |
39 | class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProcessor | |
40 | { | |
41 | /** | |
100fef9d | 42 | * Static holder for the default payment processor |
6a488035 TO |
43 | */ |
44 | static $_defaultPaymentProcessor = NULL; | |
45 | ||
c490a46a | 46 | /** |
6a488035 TO |
47 | * Create Payment Processor |
48 | * | |
c490a46a | 49 | * @param array $params parameters for Processor entity |
e0ef6999 EM |
50 | * |
51 | * @return CRM_Financial_DAO_PaymentProcessor | |
52 | * @throws Exception | |
53 | */ | |
00be9182 | 54 | public static function create($params) { |
6a488035 TO |
55 | // FIXME Reconcile with CRM_Admin_Form_PaymentProcessor::updatePaymentProcessor |
56 | $processor = new CRM_Financial_DAO_PaymentProcessor(); | |
57 | $processor->copyValues($params); | |
58 | ||
59 | $ppTypeDAO = new CRM_Financial_DAO_PaymentProcessorType(); | |
60 | $ppTypeDAO->id = $params['payment_processor_type_id']; | |
61 | if (!$ppTypeDAO->find(TRUE)) { | |
62 | CRM_Core_Error::fatal(ts('Could not find payment processor meta information')); | |
63 | } | |
64 | ||
65 | // also copy meta fields from the info DAO | |
66 | $processor->is_recur = $ppTypeDAO->is_recur; | |
67 | $processor->billing_mode = $ppTypeDAO->billing_mode; | |
68 | $processor->class_name = $ppTypeDAO->class_name; | |
69 | $processor->payment_type = $ppTypeDAO->payment_type; | |
70 | ||
71 | $processor->save(); | |
03e04002 | 72 | // CRM-11826, add entry in civicrm_entity_financial_account |
6a488035 | 73 | // if financial_account_id is not NULL |
a7488080 | 74 | if (!empty($params['financial_account_id'])) { |
f743a6eb | 75 | $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' ")); |
6a488035 TO |
76 | $values = array( |
77 | 'entity_table' => 'civicrm_payment_processor', | |
78 | 'entity_id' => $processor->id, | |
79 | 'account_relationship' => $relationTypeId, | |
80 | 'financial_account_id' => $params['financial_account_id'] | |
81 | ); | |
03e04002 | 82 | CRM_Financial_BAO_FinancialTypeAccount::add($values); |
6a488035 TO |
83 | } |
84 | return $processor; | |
85 | } | |
86 | ||
87 | /** | |
100fef9d | 88 | * Class constructor |
6a488035 | 89 | */ |
00be9182 | 90 | public function __construct() { |
6a488035 TO |
91 | parent::__construct(); |
92 | } | |
93 | ||
94 | /** | |
95 | * Takes a bunch of params that are needed to match certain criteria and | |
96 | * retrieves the relevant objects. It also stores all the retrieved | |
97 | * values in the default array | |
98 | * | |
99 | * @param array $params (reference ) an assoc array of name/value pairs | |
100 | * @param array $defaults (reference ) an assoc array to hold the flattened values | |
101 | * | |
c490a46a | 102 | * @return CRM_Financial_DAO_PaymentProcessor object on success, null otherwise |
6a488035 TO |
103 | * @static |
104 | */ | |
00be9182 | 105 | public static function retrieve(&$params, &$defaults) { |
6a488035 TO |
106 | $paymentProcessor = new CRM_Financial_DAO_PaymentProcessor(); |
107 | $paymentProcessor->copyValues($params); | |
108 | if ($paymentProcessor->find(TRUE)) { | |
109 | CRM_Core_DAO::storeValues($paymentProcessor, $defaults); | |
110 | return $paymentProcessor; | |
111 | } | |
112 | return NULL; | |
113 | } | |
114 | ||
115 | /** | |
100fef9d | 116 | * Update the is_active flag in the db |
6a488035 TO |
117 | * |
118 | * @param int $id id of the database record | |
119 | * @param boolean $is_active value we want to set the is_active field | |
120 | * | |
121 | * @return Object DAO object on sucess, null otherwise | |
122 | * | |
6a488035 TO |
123 | * @static |
124 | */ | |
00be9182 | 125 | public static function setIsActive($id, $is_active) { |
6a488035 TO |
126 | return CRM_Core_DAO::setFieldValue('CRM_Financial_DAO_PaymentProcessor', $id, 'is_active', $is_active); |
127 | } | |
128 | ||
129 | /** | |
100fef9d | 130 | * Retrieve the default payment processor |
6a488035 TO |
131 | * |
132 | * @param NULL | |
133 | * | |
134 | * @return object The default payment processor object on success, | |
135 | * null otherwise | |
136 | * @static | |
6a488035 | 137 | */ |
00be9182 | 138 | public static function &getDefault() { |
6a488035 TO |
139 | if (self::$_defaultPaymentProcessor == NULL) { |
140 | $params = array('is_default' => 1); | |
141 | $defaults = array(); | |
142 | self::$_defaultPaymentProcessor = self::retrieve($params, $defaults); | |
143 | } | |
144 | return self::$_defaultPaymentProcessor; | |
145 | } | |
146 | ||
147 | /** | |
148 | * Function to delete payment processor | |
149 | * | |
c490a46a | 150 | * @param int $paymentProcessorID |
77b97be7 EM |
151 | * |
152 | * @return null | |
6a488035 TO |
153 | * @static |
154 | */ | |
00be9182 | 155 | public static function del($paymentProcessorID) { |
6a488035 | 156 | if (!$paymentProcessorID) { |
1f21f2cf | 157 | CRM_Core_Error::fatal(ts('Invalid value passed to delete function.')); |
6a488035 TO |
158 | } |
159 | ||
160 | $dao = new CRM_Financial_DAO_PaymentProcessor(); | |
161 | $dao->id = $paymentProcessorID; | |
162 | if (!$dao->find(TRUE)) { | |
163 | return NULL; | |
164 | } | |
165 | ||
166 | $testDAO = new CRM_Financial_DAO_PaymentProcessor(); | |
167 | $testDAO->name = $dao->name; | |
168 | $testDAO->is_test = 1; | |
169 | $testDAO->delete(); | |
170 | ||
171 | $dao->delete(); | |
172 | } | |
173 | ||
174 | /** | |
100fef9d | 175 | * Get the payment processor details |
6a488035 TO |
176 | * |
177 | * @param int $paymentProcessorID payment processor id | |
178 | * @param string $mode payment mode ie test or live | |
179 | * | |
180 | * @return array associated array with payment processor related fields | |
181 | * @static | |
6a488035 | 182 | */ |
00be9182 | 183 | public static function getPayment($paymentProcessorID, $mode) { |
6a488035 TO |
184 | if (!$paymentProcessorID) { |
185 | CRM_Core_Error::fatal(ts('Invalid value passed to getPayment function')); | |
186 | } | |
187 | ||
188 | $dao = new CRM_Financial_DAO_PaymentProcessor( ); | |
189 | $dao->id = $paymentProcessorID; | |
190 | $dao->is_active = 1; | |
191 | if (!$dao->find(TRUE)) { | |
192 | return NULL; | |
193 | } | |
194 | ||
195 | if ($mode == 'test') { | |
196 | $testDAO = new CRM_Financial_DAO_PaymentProcessor( ); | |
197 | $testDAO->name = $dao->name; | |
198 | $testDAO->is_active = 1; | |
199 | $testDAO->is_test = 1; | |
200 | if (!$testDAO->find(TRUE)) { | |
201 | CRM_Core_Error::fatal(ts('Could not retrieve payment processor details')); | |
202 | } | |
203 | return self::buildPayment($testDAO, $mode); | |
204 | } | |
205 | else { | |
206 | return self::buildPayment($dao, $mode); | |
207 | } | |
208 | } | |
209 | ||
e0ef6999 EM |
210 | /** |
211 | * @param $paymentProcessorIDs | |
212 | * @param $mode | |
213 | * | |
214 | * @return array | |
215 | * @throws Exception | |
216 | */ | |
00be9182 | 217 | public static function getPayments($paymentProcessorIDs, $mode) { |
6a488035 TO |
218 | if (!$paymentProcessorIDs) { |
219 | CRM_Core_Error::fatal(ts('Invalid value passed to getPayment function')); | |
220 | } | |
221 | ||
222 | $payments = array( ); | |
223 | foreach ($paymentProcessorIDs as $paymentProcessorID) { | |
224 | $payment = self::getPayment($paymentProcessorID, $mode); | |
225 | $payments[$payment['id']] = $payment; | |
226 | } | |
227 | ||
13ac605f | 228 | uasort($payments, 'self::defaultComparison'); |
6a488035 TO |
229 | return $payments; |
230 | } | |
231 | ||
13ac605f | 232 | /** |
100fef9d | 233 | * Compare 2 payment processors to see which should go first based on is_default |
13ac605f DG |
234 | * (sort function for sortDefaultFirst) |
235 | * @param array $processor1 | |
236 | * @param array_type $processor2 | |
237 | * @return number | |
238 | */ | |
00be9182 | 239 | public static function defaultComparison($processor1, $processor2){ |
13ac605f DG |
240 | $p1 = CRM_Utils_Array::value('is_default', $processor1); |
241 | $p2 = CRM_Utils_Array::value('is_default', $processor2); | |
242 | if ($p1 == $p2) { | |
243 | return 0; | |
244 | } | |
245 | return ($p1 > $p2) ? -1 : 1; | |
246 | } | |
247 | ||
6a488035 | 248 | /** |
100fef9d | 249 | * Build payment processor details |
6a488035 TO |
250 | * |
251 | * @param object $dao payment processor object | |
252 | * @param string $mode payment mode ie test or live | |
253 | * | |
254 | * @return array associated array with payment processor related fields | |
255 | * @static | |
6a488035 | 256 | */ |
00be9182 | 257 | public static function buildPayment($dao, $mode) { |
6a488035 TO |
258 | $fields = array( |
259 | 'id', 'name', 'payment_processor_type_id', 'user_name', 'password', | |
260 | 'signature', 'url_site', 'url_api', 'url_recur', 'url_button', | |
3392cb17 | 261 | 'subject', 'class_name', 'is_recur', 'billing_mode', 'is_test', |
6a488035 TO |
262 | 'payment_type', 'is_default', |
263 | ); | |
264 | $result = array(); | |
265 | foreach ($fields as $name) { | |
266 | $result[$name] = $dao->$name; | |
267 | } | |
268 | $result['payment_processor_type'] = CRM_Core_PseudoConstant::paymentProcessorType(FALSE, $dao->payment_processor_type_id, 'name'); | |
269 | ||
3392cb17 | 270 | $result['instance'] = $result['object'] =& CRM_Core_Payment::singleton($mode, $result); |
6a488035 TO |
271 | |
272 | return $result; | |
273 | } | |
274 | ||
fbcb6fba | 275 | /** |
100fef9d | 276 | * Get all payment processors as an array of objects. |
fbcb6fba EM |
277 | * |
278 | * @param $isExcludeTest | |
279 | * @param bool $reset | |
280 | * | |
281 | * @throws CiviCRM_API3_Exception | |
282 | * @return array | |
283 | */ | |
00be9182 | 284 | public static function getAllPaymentProcessors($isExcludeTest, $reset = FALSE) { |
fbcb6fba EM |
285 | /** |
286 | * $cacheKey = 'CRM_Financial_BAO_Payment_Processor_' . ($isExcludeTest ? 'test' : 'all'); | |
287 | if (!$reset) { | |
288 | $processors = CRM_Utils_Cache::singleton()->get($cacheKey); | |
289 | if (!empty($processors)) { | |
290 | return $processors; | |
291 | } | |
292 | } | |
293 | * */ | |
ef523266 | 294 | $retrievalParameters = array('is_active' => TRUE, 'options' => array('sort' => 'is_default DESC, name'), 'api.payment_processor_type.getsingle' => 1); |
fbcb6fba EM |
295 | if ($isExcludeTest) { |
296 | $retrievalParameters['is_test'] = 0; | |
297 | } | |
298 | $processors = civicrm_api3('payment_processor', 'get', $retrievalParameters); | |
299 | foreach ($processors['values'] as $processor) { | |
9d91a9c6 | 300 | $processors['values'][$processor['id']]['payment_processor_type'] = $processor['payment_processor_type'] = $processors['values'][$processor['id']]['api.payment_processor_type.getsingle']['name']; |
fbcb6fba EM |
301 | $processors['values'][$processor['id']]['object'] = CRM_Core_Payment::singleton(empty($processor['is_test']) ? 'live' : 'test', $processor); |
302 | } | |
303 | /* | |
304 | CRM_Utils_Cache::singleton()->set($cacheKey, $processors); | |
305 | */ | |
306 | return $processors['values']; | |
307 | } | |
308 | ||
309 | /** | |
100fef9d | 310 | * Get Payment processors with specified capabilities. |
fbcb6fba EM |
311 | * Note that both the singleton & the pseudoconstant function have caching so we don't add |
312 | * arguably this could go on the pseudoconstant class | |
313 | * | |
314 | * @param array $capabilities | |
315 | * @param bool $isIncludeTest | |
316 | * | |
dc913073 EM |
317 | * @param array $ids |
318 | * | |
fbcb6fba EM |
319 | * @return array available processors |
320 | */ | |
00be9182 | 321 | public static function getPaymentProcessors($capabilities = array(), $isIncludeTest = FALSE, $ids = array()) { |
fbcb6fba EM |
322 | $processors = self::getAllPaymentProcessors(!$isIncludeTest); |
323 | if ($capabilities) { | |
324 | foreach ($processors as $index => $processor) { | |
dc913073 EM |
325 | if (!empty($ids) && !in_array($processor['id'], $ids)) { |
326 | unset ($processors[$index]); | |
327 | continue; | |
328 | } | |
fbcb6fba EM |
329 | if (($error = $processor['object']->checkConfig()) != NULL) { |
330 | unset ($processors[$index]); | |
331 | continue; | |
332 | } | |
333 | foreach ($capabilities as $capability) { | |
d8ce0d68 | 334 | if (($processor['object']->supports($capability)) == FALSE) { |
fbcb6fba EM |
335 | unset ($processors[$index]); |
336 | } | |
337 | } | |
338 | } | |
339 | } | |
340 | return $processors; | |
341 | } | |
342 | ||
343 | /** | |
344 | * Is there a processor on this site with the specified capability | |
345 | * @param array $capabilities | |
346 | * @param bool $isIncludeTest | |
347 | * | |
348 | * @return bool | |
349 | */ | |
00be9182 | 350 | public static function hasPaymentProcessorSupporting($capabilities = array(), $isIncludeTest = FALSE) { |
fbcb6fba EM |
351 | $result = self::getPaymentProcessors($capabilities, $isIncludeTest); |
352 | return (!empty($result)) ? TRUE : FALSE; | |
353 | } | |
354 | ||
6a488035 | 355 | /** |
100fef9d | 356 | * Retrieve payment processor id / info/ object based on component-id. |
6a488035 | 357 | * |
100fef9d | 358 | * @param int $entityID |
da6b46f4 EM |
359 | * @param string $component component |
360 | * @param string $type type of payment information to be retrieved | |
6a488035 | 361 | * |
c490a46a | 362 | * @return int / array / object based on type |
6a488035 | 363 | * @static |
6a488035 | 364 | */ |
00be9182 | 365 | public static function getProcessorForEntity($entityID, $component = 'contribute', $type = 'id') { |
6a488035 TO |
366 | $result = NULL; |
367 | if (!in_array($component, array( | |
368 | 'membership', 'contribute', 'recur'))) { | |
369 | return $result; | |
370 | } | |
371 | //FIXME: | |
372 | if ($component == 'membership') { | |
373 | $sql = " | |
374 | SELECT cr.payment_processor_id as ppID1, cp.payment_processor as ppID2, con.is_test | |
375 | FROM civicrm_membership mem | |
376 | INNER JOIN civicrm_membership_payment mp ON ( mem.id = mp.membership_id ) | |
377 | INNER JOIN civicrm_contribution con ON ( mp.contribution_id = con.id ) | |
378 | LEFT JOIN civicrm_contribution_recur cr ON ( mem.contribution_recur_id = cr.id ) | |
379 | LEFT JOIN civicrm_contribution_page cp ON ( con.contribution_page_id = cp.id ) | |
380 | WHERE mp.membership_id = %1"; | |
381 | } | |
382 | elseif ($component == 'contribute') { | |
383 | $sql = " | |
384 | SELECT cr.payment_processor_id as ppID1, cp.payment_processor as ppID2, con.is_test | |
385 | FROM civicrm_contribution con | |
386 | LEFT JOIN civicrm_contribution_recur cr ON ( con.contribution_recur_id = cr.id ) | |
387 | LEFT JOIN civicrm_contribution_page cp ON ( con.contribution_page_id = cp.id ) | |
388 | WHERE con.id = %1"; | |
389 | } | |
390 | elseif ($component == 'recur') { | |
391 | $sql = " | |
392 | SELECT cr.payment_processor_id as ppID1, NULL as ppID2, cr.is_test | |
393 | FROM civicrm_contribution_recur cr | |
394 | WHERE cr.id = %1"; | |
395 | } | |
396 | ||
397 | //we are interesting in single record. | |
398 | $sql .= ' LIMIT 1'; | |
399 | ||
400 | $params = array(1 => array($entityID, 'Integer')); | |
401 | $dao = CRM_Core_DAO::executeQuery($sql, $params); | |
402 | ||
403 | if (!$dao->fetch()) { | |
404 | ||
405 | return $result; | |
406 | ||
407 | } | |
408 | ||
409 | $ppID = (isset($dao->ppID1) && $dao->ppID1) ? $dao->ppID1 : (isset($dao->ppID2) ? $dao->ppID2 : NULL); | |
410 | $mode = (isset($dao->is_test) && $dao->is_test) ? 'test' : 'live'; | |
411 | if (!$ppID || $type == 'id') { | |
412 | $result = $ppID; | |
413 | } | |
414 | elseif ($type == 'info') { | |
415 | $result = self::getPayment($ppID, $mode); | |
416 | } | |
417 | elseif ($type == 'obj') { | |
418 | $payment = self::getPayment($ppID, $mode); | |
419 | $result = CRM_Core_Payment::singleton($mode, $payment); | |
420 | } | |
421 | ||
422 | return $result; | |
423 | } | |
424 | } |