Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 | 11 | |
d6ae85ac | 12 | use Civi\Payment\PropertyBag; |
6a488035 TO |
13 | |
14 | /** | |
95cdcc0f | 15 | * This class provides support for canceling recurring subscriptions. |
6a488035 | 16 | */ |
ca809bb6 | 17 | class CRM_Contribute_Form_CancelSubscription extends CRM_Contribute_Form_ContributionRecur { |
6a488035 TO |
18 | |
19 | protected $_userContext = NULL; | |
20 | ||
21 | protected $_mode = NULL; | |
22 | ||
d6ae85ac MW |
23 | /** |
24 | * The contributor email | |
25 | * | |
26 | * @var string | |
27 | */ | |
28 | protected $_donorEmail = ''; | |
29 | ||
f1105edc | 30 | /** |
31 | * Should custom data be suppressed on this form. | |
32 | * | |
33 | * We override to suppress custom data because historically it has not been | |
34 | * shown on this form & we don't want to expose it as a by-product of | |
35 | * other change without establishing that it would be good on this form. | |
36 | * | |
37 | * @return bool | |
38 | */ | |
39 | protected function isSuppressCustomData() { | |
40 | return TRUE; | |
41 | } | |
42 | ||
6a488035 | 43 | /** |
fe482240 | 44 | * Set variables up before form is built. |
503699d5 | 45 | * |
46 | * @throws \CRM_Core_Exception | |
6a488035 TO |
47 | */ |
48 | public function preProcess() { | |
1f17c8ef | 49 | parent::preProcess(); |
d947cfb5 | 50 | |
dd793ad1 MW |
51 | $cancelRecurTextParams = [ |
52 | 'mode' => $this->_mode, | |
53 | 'amount' => $this->getSubscriptionDetails()->amount, | |
54 | 'currency' => $this->getSubscriptionDetails()->currency, | |
55 | 'frequency_interval' => $this->getSubscriptionDetails()->frequency_interval, | |
56 | 'frequency_unit' => $this->getSubscriptionDetails()->frequency_unit, | |
57 | 'installments' => $this->getSubscriptionDetails()->installments, | |
58 | ]; | |
59 | ||
60 | if ($this->_crid) { | |
6a488035 | 61 | // Are we cancelling a recurring contribution that is linked to an auto-renew membership? |
59545b08 MW |
62 | if ($this->getSubscriptionDetails()->membership_id) { |
63 | $this->_mid = $this->getSubscriptionDetails()->membership_id; | |
6a488035 TO |
64 | } |
65 | } | |
66 | ||
67 | if ($this->_mid) { | |
6a488035 | 68 | $this->_mode = 'auto_renew'; |
16381e37 J |
69 | // CRM-18468: crid is more accurate than mid for getting |
70 | // subscriptionDetails, so don't get them again. | |
6a488035 TO |
71 | |
72 | $membershipTypes = CRM_Member_PseudoConstant::membershipType(); | |
73 | $membershipTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_mid, 'membership_type_id'); | |
dd793ad1 MW |
74 | $membershipType = $membershipTypes[$membershipTypeId] ?? ''; |
75 | $this->assign('membershipType', $membershipType); | |
76 | $cancelRecurTextParams['membershipType'] = $membershipType; | |
6a488035 TO |
77 | } |
78 | ||
6a488035 TO |
79 | if ($this->_coid) { |
80 | if (CRM_Contribute_BAO_Contribution::isSubscriptionCancelled($this->_coid)) { | |
6a4a50a1 | 81 | CRM_Core_Error::statusBounce(ts('The recurring contribution looks to have been cancelled already.')); |
6a488035 TO |
82 | } |
83 | $this->_paymentProcessorObj = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_coid, 'contribute', 'obj'); | |
6a488035 TO |
84 | } |
85 | ||
d947cfb5 DL |
86 | if ( |
87 | (!$this->_crid && !$this->_coid && !$this->_mid) || | |
59545b08 | 88 | (!$this->getSubscriptionDetails()) |
6a488035 | 89 | ) { |
f1105edc | 90 | CRM_Core_Error::statusBounce('Required information missing.'); |
6a488035 TO |
91 | } |
92 | ||
dd793ad1 MW |
93 | $this->assign('cancelRecurDetailText', $this->_paymentProcessorObj->getText('cancelRecurDetailText', $cancelRecurTextParams)); |
94 | ||
6a488035 TO |
95 | // handle context redirection |
96 | CRM_Contribute_BAO_ContributionRecur::setSubscriptionContext(); | |
97 | ||
98 | CRM_Utils_System::setTitle($this->_mid ? ts('Cancel Auto-renewal') : ts('Cancel Recurring Contribution')); | |
99 | $this->assign('mode', $this->_mode); | |
100 | ||
f1105edc | 101 | if ($this->isSelfService()) { |
102 | unset($this->entityFields['send_cancel_request'], $this->entityFields['is_notify']); | |
103 | } | |
104 | ||
59545b08 | 105 | if ($this->getSubscriptionDetails()->contact_id) { |
7c550ca0 | 106 | list($this->_donorDisplayName, $this->_donorEmail) |
59545b08 | 107 | = CRM_Contact_BAO_Contact::getContactDetails($this->getSubscriptionDetails()->contact_id); |
6a488035 TO |
108 | } |
109 | } | |
110 | ||
f1105edc | 111 | /** |
112 | * Set entity fields for this cancellation. | |
113 | */ | |
114 | public function setEntityFields() { | |
115 | $this->entityFields = [ | |
116 | 'cancel_reason' => ['name' => 'cancel_reason'], | |
117 | ]; | |
118 | $this->entityFields['send_cancel_request'] = [ | |
703235f6 | 119 | 'title' => ts('Send cancellation request?'), |
f1105edc | 120 | 'name' => 'send_cancel_request', |
121 | 'not-auto-addable' => TRUE, | |
122 | ]; | |
123 | $this->entityFields['is_notify'] = [ | |
124 | 'title' => ts('Notify Contributor?'), | |
125 | 'name' => 'is_notify', | |
126 | 'not-auto-addable' => TRUE, | |
127 | ]; | |
128 | } | |
129 | ||
6a488035 | 130 | /** |
fe482240 | 131 | * Build the form object. |
6a488035 TO |
132 | */ |
133 | public function buildQuickForm() { | |
f1105edc | 134 | $this->buildQuickEntityForm(); |
6a488035 | 135 | // Determine if we can cancel recurring contribution via API with this processor |
1524a007 | 136 | $cancelSupported = $this->_paymentProcessorObj->supports('CancelRecurring'); |
6a488035 | 137 | if ($cancelSupported) { |
be2fb01f | 138 | $searchRange = []; |
6a488035 TO |
139 | $searchRange[] = $this->createElement('radio', NULL, NULL, ts('Yes'), '1'); |
140 | $searchRange[] = $this->createElement('radio', NULL, NULL, ts('No'), '0'); | |
141 | ||
d947cfb5 DL |
142 | $this->addGroup( |
143 | $searchRange, | |
144 | 'send_cancel_request', | |
145 | ts('Send cancellation request to %1 ?', | |
4e0ebeee | 146 | [1 => $this->_paymentProcessorObj->getTitle()]) |
d947cfb5 | 147 | ); |
6a488035 | 148 | } |
dd793ad1 MW |
149 | else { |
150 | $this->assign('cancelRecurNotSupportedText', $this->_paymentProcessorObj->getText('cancelRecurNotSupportedText', [])); | |
151 | } | |
6a488035 | 152 | $this->assign('cancelSupported', $cancelSupported); |
d947cfb5 | 153 | |
d6ae85ac MW |
154 | if (!empty($this->_donorEmail)) { |
155 | $this->add('checkbox', 'is_notify', ts('Notify Contributor?') . " ({$this->_donorEmail})"); | |
6a488035 TO |
156 | } |
157 | if ($this->_mid) { | |
158 | $cancelButton = ts('Cancel Automatic Membership Renewal'); | |
159 | } | |
160 | else { | |
161 | $cancelButton = ts('Cancel Recurring Contribution'); | |
162 | } | |
163 | ||
164 | $type = 'next'; | |
f1105edc | 165 | if ($this->isSelfService()) { |
6a488035 TO |
166 | $type = 'submit'; |
167 | } | |
168 | ||
be2fb01f | 169 | $this->addButtons([ |
1330f57a SL |
170 | [ |
171 | 'type' => $type, | |
172 | 'name' => $cancelButton, | |
173 | 'spacing' => ' ', | |
174 | 'isDefault' => TRUE, | |
175 | ], | |
176 | [ | |
177 | 'type' => 'cancel', | |
178 | 'name' => ts('Not Now'), | |
179 | ], | |
180 | ]); | |
6a488035 TO |
181 | } |
182 | ||
183 | /** | |
1c4a09f4 | 184 | * Set default values for the form. |
6a488035 | 185 | * |
a6c01b45 CW |
186 | * @return array |
187 | * array of default values | |
6a488035 | 188 | */ |
00be9182 | 189 | public function setDefaultValues() { |
be2fb01f | 190 | return [ |
1c4a09f4 | 191 | 'is_notify' => 1, |
192 | 'send_cancel_request' => 1, | |
be2fb01f | 193 | ]; |
6a488035 TO |
194 | } |
195 | ||
196 | /** | |
fe482240 | 197 | * Process the form submission. |
6a488035 TO |
198 | */ |
199 | public function postProcess() { | |
11ec1f96 | 200 | $message = NULL; |
6a488035 | 201 | $cancelSubscription = TRUE; |
353ffa53 | 202 | $params = $this->controller->exportValues($this->_name); |
6a488035 | 203 | |
f1105edc | 204 | if ($this->isSelfService()) { |
6a488035 | 205 | // for self service force sending-request & notify |
1524a007 | 206 | if ($this->_paymentProcessorObj->supports('cancelRecurring')) { |
6a488035 | 207 | $params['send_cancel_request'] = 1; |
d947cfb5 DL |
208 | } |
209 | ||
d6ae85ac | 210 | if (!empty($this->_donorEmail)) { |
6a488035 | 211 | $params['is_notify'] = 1; |
d947cfb5 | 212 | } |
6a488035 TO |
213 | } |
214 | ||
215 | if (CRM_Utils_Array::value('send_cancel_request', $params) == 1) { | |
4ae44cc6 | 216 | try { |
11ec1f96 | 217 | $propertyBag = new PropertyBag(); |
157edc4f | 218 | $propertyBag->setContributionRecurID($this->getSubscriptionDetails()->recur_id); |
59545b08 | 219 | $propertyBag->setRecurProcessorID($this->getSubscriptionDetails()->subscription_id); |
11ec1f96 | 220 | $message = $this->_paymentProcessorObj->doCancelRecurring($propertyBag)['message']; |
4ae44cc6 RLAR |
221 | } |
222 | catch (\Civi\Payment\Exception\PaymentProcessorException $e) { | |
223 | CRM_Core_Error::statusBounce($e->getMessage()); | |
224 | } | |
6a488035 TO |
225 | } |
226 | ||
11ec1f96 | 227 | if ($cancelSubscription) { |
c7d9325a | 228 | try { |
229 | civicrm_api3('ContributionRecur', 'cancel', [ | |
59545b08 | 230 | 'id' => $this->getSubscriptionDetails()->recur_id, |
c7d9325a | 231 | 'membership_id' => $this->_mid, |
232 | 'processor_message' => $message, | |
f1105edc | 233 | 'cancel_reason' => $params['cancel_reason'], |
c7d9325a | 234 | ]); |
d947cfb5 | 235 | |
be2fb01f | 236 | $tplParams = []; |
6a488035 | 237 | if ($this->_mid) { |
be2fb01f | 238 | $inputParams = ['id' => $this->_mid]; |
6a488035 TO |
239 | CRM_Member_BAO_Membership::getValues($inputParams, $tplParams); |
240 | $tplParams = $tplParams[$this->_mid]; | |
7c550ca0 WA |
241 | $tplParams['membership_status'] |
242 | = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']); | |
243 | $tplParams['membershipType'] | |
244 | = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']); | |
be2fb01f | 245 | $status = ts('The automatic renewal of your %1 membership has been cancelled as requested. This does not affect the status of your membership - you will receive a separate notification when your membership is up for renewal.', [1 => $tplParams['membershipType']]); |
6a488035 TO |
246 | $msgTitle = 'Membership Renewal Cancelled'; |
247 | $msgType = 'info'; | |
248 | } | |
249 | else { | |
59545b08 MW |
250 | $tplParams['recur_frequency_interval'] = $this->getSubscriptionDetails()->frequency_interval; |
251 | $tplParams['recur_frequency_unit'] = $this->getSubscriptionDetails()->frequency_unit; | |
dd793ad1 | 252 | $tplParams['amount'] = CRM_Utils_Money::format($this->getSubscriptionDetails()->amount, $this->getSubscriptionDetails()->currency); |
be2fb01f | 253 | $tplParams['contact'] = ['display_name' => $this->_donorDisplayName]; |
6a488035 | 254 | $status = ts('The recurring contribution of %1, every %2 %3 has been cancelled.', |
be2fb01f | 255 | [ |
dd793ad1 MW |
256 | 1 => $tplParams['amount'], |
257 | 2 => $tplParams['recur_frequency_interval'], | |
258 | 3 => $tplParams['recur_frequency_unit'], | |
be2fb01f | 259 | ] |
6a488035 TO |
260 | ); |
261 | $msgTitle = 'Contribution Cancelled'; | |
262 | $msgType = 'success'; | |
263 | } | |
264 | ||
265 | if (CRM_Utils_Array::value('is_notify', $params) == 1) { | |
59545b08 | 266 | if ($this->getSubscriptionDetails()->contribution_page_id) { |
d947cfb5 DL |
267 | CRM_Core_DAO::commonRetrieveAll( |
268 | 'CRM_Contribute_DAO_ContributionPage', | |
269 | 'id', | |
59545b08 | 270 | $this->getSubscriptionDetails()->contribution_page_id, |
d947cfb5 | 271 | $value, |
be2fb01f | 272 | ['title', 'receipt_from_name', 'receipt_from_email'] |
d947cfb5 | 273 | ); |
7c550ca0 | 274 | $receiptFrom |
59545b08 | 275 | = '"' . CRM_Utils_Array::value('receipt_from_name', $value[$this->getSubscriptionDetails()->contribution_page_id]) . |
d947cfb5 | 276 | '" <' . |
59545b08 | 277 | $value[$this->getSubscriptionDetails()->contribution_page_id]['receipt_from_email'] . |
d947cfb5 | 278 | '>'; |
6a488035 TO |
279 | } |
280 | else { | |
281 | $domainValues = CRM_Core_BAO_Domain::getNameAndEmail(); | |
282 | $receiptFrom = "$domainValues[0] <$domainValues[1]>"; | |
283 | } | |
d947cfb5 | 284 | |
6a488035 | 285 | // send notification |
7c550ca0 | 286 | $sendTemplateParams |
be2fb01f | 287 | = [ |
353ffa53 TO |
288 | 'groupName' => $this->_mode == 'auto_renew' ? 'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution', |
289 | 'valueName' => $this->_mode == 'auto_renew' ? 'membership_autorenew_cancelled' : 'contribution_recurring_cancelled', | |
59545b08 | 290 | 'contactId' => $this->getSubscriptionDetails()->contact_id, |
353ffa53 TO |
291 | 'tplParams' => $tplParams, |
292 | //'isTest' => $isTest, set this from _objects | |
293 | 'PDFFilename' => 'receipt.pdf', | |
294 | 'from' => $receiptFrom, | |
295 | 'toName' => $this->_donorDisplayName, | |
296 | 'toEmail' => $this->_donorEmail, | |
be2fb01f | 297 | ]; |
c6327d7d | 298 | list($sent) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams); |
6a488035 TO |
299 | } |
300 | } | |
c7d9325a | 301 | catch (CiviCRM_API3_Exception $e) { |
6a488035 TO |
302 | $msgType = 'error'; |
303 | $msgTitle = ts('Error'); | |
304 | if ($params['send_cancel_request'] == 1) { | |
305 | $status = ts('Recurring contribution was cancelled successfully by the processor, but could not be marked as cancelled in the database.'); | |
306 | } | |
307 | else { | |
308 | $status = ts('Recurring contribution could not be cancelled in the database.'); | |
309 | } | |
310 | } | |
311 | } | |
312 | else { | |
313 | $status = ts('The recurring contribution could not be cancelled.'); | |
314 | $msgTitle = 'Error Cancelling Contribution'; | |
315 | $msgType = 'error'; | |
316 | } | |
317 | ||
318 | $session = CRM_Core_Session::singleton(); | |
353ffa53 | 319 | $userID = $session->get('userID'); |
481a74f4 | 320 | if ($userID && $status) { |
6a488035 TO |
321 | $session->setStatus($status, $msgTitle, $msgType); |
322 | } | |
323 | elseif (!$userID) { | |
7c550ca0 | 324 | if ($status) { |
6a488035 | 325 | CRM_Utils_System::setUFMessage($status); |
7c550ca0 WA |
326 | // keep result as 1, since we not displaying anything on the redirected page anyway |
327 | return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/subscriptionstatus', | |
353ffa53 | 328 | "reset=1&task=cancel&result=1")); |
7c550ca0 | 329 | } |
6a488035 TO |
330 | } |
331 | } | |
96025800 | 332 | |
6a488035 | 333 | } |