Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | * Copyright (C) 2007 | |
4 | * Licensed to CiviCRM under the Academic Free License version 3.0. | |
5 | * | |
6 | * Written and contributed by Ideal Solution, LLC (http://www.idealso.com) | |
7 | * | |
8 | */ | |
9 | ||
10 | /** | |
11 | * | |
12 | * @package CRM | |
13 | * @author Marshal Newrock <marshal@idealso.com> | |
6a488035 TO |
14 | */ |
15 | ||
65f1a9a1 | 16 | use Civi\Payment\Exception\PaymentProcessorException; |
3bfefe56 | 17 | use Civi\Payment\PropertyBag; |
65f1a9a1 | 18 | |
c866eb5f TO |
19 | /** |
20 | * Dummy payment processor | |
6a488035 TO |
21 | */ |
22 | class CRM_Core_Payment_Dummy extends CRM_Core_Payment { | |
3bfefe56 | 23 | protected $_mode; |
6a488035 | 24 | |
be2fb01f CW |
25 | protected $_params = []; |
26 | protected $_doDirectPaymentResult = []; | |
f8fe0df6 | 27 | |
28 | /** | |
eca28728 EM |
29 | * Set result from do Direct Payment for test purposes. |
30 | * | |
f8fe0df6 | 31 | * @param array $doDirectPaymentResult |
eca28728 | 32 | * Result to be returned from test. |
f8fe0df6 | 33 | */ |
34 | public function setDoDirectPaymentResult($doDirectPaymentResult) { | |
35 | $this->_doDirectPaymentResult = $doDirectPaymentResult; | |
9d0f10b7 | 36 | if (empty($this->_doDirectPaymentResult['trxn_id'])) { |
be2fb01f | 37 | $this->_doDirectPaymentResult['trxn_id'] = []; |
9d0f10b7 EM |
38 | } |
39 | else { | |
40 | $this->_doDirectPaymentResult['trxn_id'] = (array) $doDirectPaymentResult['trxn_id']; | |
41 | } | |
f8fe0df6 | 42 | } |
6a488035 | 43 | |
6a488035 | 44 | /** |
fe482240 | 45 | * Constructor. |
6a488035 | 46 | * |
6a0b768e TO |
47 | * @param string $mode |
48 | * The mode of operation: live or test. | |
6a488035 | 49 | * |
3bfefe56 | 50 | * @param array $paymentProcessor |
6a488035 | 51 | */ |
00be9182 | 52 | public function __construct($mode, &$paymentProcessor) { |
6a488035 TO |
53 | $this->_mode = $mode; |
54 | $this->_paymentProcessor = $paymentProcessor; | |
6a488035 TO |
55 | } |
56 | ||
6a488035 | 57 | /** |
fe482240 | 58 | * Submit a payment using Advanced Integration Method. |
6a488035 | 59 | * |
6a0b768e TO |
60 | * @param array $params |
61 | * Assoc array of input parameters for this transaction. | |
6a488035 | 62 | * |
a6c01b45 CW |
63 | * @return array |
64 | * the result in a nice formatted array (or an error object) | |
65f1a9a1 | 65 | * @throws \Civi\Payment\Exception\PaymentProcessorException |
6a488035 | 66 | */ |
00be9182 | 67 | public function doDirectPayment(&$params) { |
3bfefe56 | 68 | $propertyBag = PropertyBag::cast($params); |
6a488035 TO |
69 | // Invoke hook_civicrm_paymentProcessor |
70 | // In Dummy's case, there is no translation of parameters into | |
71 | // the back-end's canonical set of parameters. But if a processor | |
72 | // does this, it needs to invoke this hook after it has done translation, | |
73 | // but before it actually starts talking to its proprietary back-end. | |
3bfefe56 | 74 | if ($propertyBag->getIsRecur()) { |
75 | $throwAnENoticeIfNotSetAsTheseAreRequired = $propertyBag->getRecurFrequencyInterval() . $propertyBag->getRecurFrequencyUnit(); | |
3a1f9fd3 | 76 | } |
6a488035 | 77 | // no translation in Dummy processor |
6a488035 TO |
78 | CRM_Utils_Hook::alterPaymentProcessorParams($this, |
79 | $params, | |
3bfefe56 | 80 | $propertyBag |
6a488035 | 81 | ); |
7758bd2b EM |
82 | // This means we can test failing transactions by setting a past year in expiry. A full expiry check would |
83 | // be more complete. | |
5a89b539 | 84 | if (!empty($params['credit_card_exp_date']['Y']) && date('Y') > |
7758bd2b | 85 | CRM_Core_Payment_Form::getCreditCardExpirationYear($params)) { |
90530b87 | 86 | throw new PaymentProcessorException(ts('Invalid expiry date')); |
7758bd2b | 87 | } |
f8fe0df6 | 88 | //end of hook invocation |
89 | if (!empty($this->_doDirectPaymentResult)) { | |
9d0f10b7 | 90 | $result = $this->_doDirectPaymentResult; |
65f1a9a1 | 91 | if (CRM_Utils_Array::value('payment_status_id', $result) === 'failed') { |
92 | throw new PaymentProcessorException($result['message'] ?? 'failed'); | |
93 | } | |
9d0f10b7 EM |
94 | $result['trxn_id'] = array_shift($this->_doDirectPaymentResult['trxn_id']); |
95 | return $result; | |
f8fe0df6 | 96 | } |
5562e2e3 | 97 | |
98 | $params['trxn_id'] = $this->getTrxnID();; | |
99 | ||
3bfefe56 | 100 | $params['gross_amount'] = $propertyBag->getAmount(); |
3a2251cf DG |
101 | // Add a fee_amount so we can make sure fees are handled properly in underlying classes. |
102 | $params['fee_amount'] = 1.50; | |
3209a807 | 103 | $params['description'] = $this->getPaymentDescription($params); |
3a2251cf | 104 | |
6a488035 TO |
105 | return $params; |
106 | } | |
107 | ||
6c786a9b | 108 | /** |
6bc775cf MD |
109 | * Does this payment processor support refund? |
110 | * | |
111 | * @return bool | |
112 | */ | |
113 | public function supportsRefund() { | |
114 | return TRUE; | |
115 | } | |
116 | ||
b59a905f | 117 | /** |
3bfefe56 | 118 | * Supports altering future start dates. |
119 | * | |
b59a905f SL |
120 | * @return bool |
121 | */ | |
122 | public function supportsFutureRecurStartDate() { | |
123 | return TRUE; | |
124 | } | |
125 | ||
6bc775cf MD |
126 | /** |
127 | * Submit a refund payment | |
128 | * | |
129 | * @throws \Civi\Payment\Exception\PaymentProcessorException | |
130 | * | |
131 | * @param array $params | |
132 | * Assoc array of input parameters for this transaction. | |
133 | */ | |
134 | public function doRefund(&$params) {} | |
135 | ||
6a488035 | 136 | /** |
fe482240 | 137 | * This function checks to see if we have the right config values. |
6a488035 | 138 | * |
a6c01b45 CW |
139 | * @return string |
140 | * the error message if any | |
6a488035 | 141 | */ |
00be9182 | 142 | public function checkConfig() { |
6a488035 TO |
143 | return NULL; |
144 | } | |
96025800 | 145 | |
10df056e | 146 | /** |
147 | * Get an array of the fields that can be edited on the recurring contribution. | |
148 | * | |
149 | * Some payment processors support editing the amount and other scheduling details of recurring payments, especially | |
150 | * those which use tokens. Others are fixed. This function allows the processor to return an array of the fields that | |
151 | * can be updated from the contribution recur edit screen. | |
152 | * | |
153 | * The fields are likely to be a subset of these | |
154 | * - 'amount', | |
155 | * - 'installments', | |
156 | * - 'frequency_interval', | |
157 | * - 'frequency_unit', | |
158 | * - 'cycle_day', | |
159 | * - 'next_sched_contribution_date', | |
160 | * - 'end_date', | |
161 | * - 'failure_retry_day', | |
162 | * | |
163 | * The form does not restrict which fields from the contribution_recur table can be added (although if the html_type | |
164 | * metadata is not defined in the xml for the field it will cause an error. | |
165 | * | |
166 | * Open question - would it make sense to return membership_id in this - which is sometimes editable and is on that | |
167 | * form (UpdateSubscription). | |
168 | * | |
169 | * @return array | |
170 | */ | |
171 | public function getEditableRecurringScheduleFields() { | |
be2fb01f | 172 | return ['amount', 'next_sched_contribution_date']; |
10df056e | 173 | } |
174 | ||
f926d56f | 175 | /** |
3bfefe56 | 176 | * Does this processor support cancelling recurring contributions through code. |
f926d56f | 177 | * |
3bfefe56 | 178 | * If the processor returns true it must be possible to take action from within CiviCRM |
179 | * that will result in no further payments being processed. In the case of token processors (e.g | |
180 | * IATS, eWay) updating the contribution_recur table is probably sufficient. | |
181 | * | |
182 | * @return bool | |
f926d56f | 183 | */ |
3bfefe56 | 184 | protected function supportsCancelRecurring() { |
f926d56f MWMC |
185 | return TRUE; |
186 | } | |
187 | ||
3bfefe56 | 188 | /** |
189 | * Cancel a recurring subscription. | |
190 | * | |
191 | * Payment processor classes should override this rather than implementing cancelSubscription. | |
192 | * | |
193 | * A PaymentProcessorException should be thrown if the update of the contribution_recur | |
194 | * record should not proceed (in many cases this function does nothing | |
195 | * as the payment processor does not need to take any action & this should silently | |
196 | * proceed. Note the form layer will only call this after calling | |
197 | * $processor->supports('cancelRecurring'); | |
198 | * | |
199 | * @param \Civi\Payment\PropertyBag $propertyBag | |
200 | * | |
201 | * @return array | |
202 | * | |
203 | * @throws \Civi\Payment\Exception\PaymentProcessorException | |
204 | */ | |
205 | public function doCancelRecurring(PropertyBag $propertyBag) { | |
206 | return ['message' => ts('Recurring contribution cancelled')]; | |
207 | } | |
208 | ||
5562e2e3 | 209 | /** |
210 | * Get a value for the transaction ID. | |
211 | * | |
212 | * Value is made up of the max existing value + a random string. | |
213 | * | |
214 | * Note the random string is likely a historical workaround. | |
215 | * | |
216 | * @return string | |
217 | */ | |
218 | protected function getTrxnID() { | |
219 | $string = $this->_mode; | |
220 | $trxn_id = CRM_Core_DAO::singleValueQuery("SELECT MAX(trxn_id) FROM civicrm_contribution WHERE trxn_id LIKE '{$string}_%'"); | |
221 | $trxn_id = str_replace($string, '', $trxn_id); | |
222 | $trxn_id = (int) $trxn_id + 1; | |
223 | return $string . '_' . $trxn_id . '_' . uniqid(); | |
224 | } | |
225 | ||
6a488035 | 226 | } |