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