3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
35 * This class provides support for canceling recurring subscriptions.
37 class CRM_Contribute_Form_CancelSubscription
extends CRM_Contribute_Form_ContributionRecur
{
39 protected $_userContext = NULL;
41 protected $_mode = NULL;
44 * Should custom data be suppressed on this form.
46 * We override to suppress custom data because historically it has not been
47 * shown on this form & we don't want to expose it as a by-product of
48 * other change without establishing that it would be good on this form.
52 protected function isSuppressCustomData() {
57 * Is the from being accessed by a front end user to update their own recurring.
61 protected $selfService;
64 * Set variables up before form is built.
66 * @throws \CRM_Core_Exception
68 public function preProcess() {
71 $this->assign('frequency_unit', $this->_subscriptionDetails
->frequency_unit
);
72 $this->assign('frequency_interval', $this->_subscriptionDetails
->frequency_interval
);
73 $this->assign('amount', $this->_subscriptionDetails
->amount
);
74 $this->assign('installments', $this->_subscriptionDetails
->installments
);
76 // Are we cancelling a recurring contribution that is linked to an auto-renew membership?
77 if ($this->_subscriptionDetails
->membership_id
) {
78 $this->_mid
= $this->_subscriptionDetails
->membership_id
;
83 $this->_mode
= 'auto_renew';
84 // CRM-18468: crid is more accurate than mid for getting
85 // subscriptionDetails, so don't get them again.
87 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_mid
, 'membership', 'obj');
88 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_mid
, 'membership');
91 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
92 $membershipTypeId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_mid
, 'membership_type_id');
93 $this->assign('membershipType', CRM_Utils_Array
::value($membershipTypeId, $membershipTypes));
97 if (CRM_Contribute_BAO_Contribution
::isSubscriptionCancelled($this->_coid
)) {
98 CRM_Core_Error
::fatal(ts('The recurring contribution looks to have been cancelled already.'));
100 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'obj');
102 $this->assign('frequency_unit', $this->_subscriptionDetails
->frequency_unit
);
103 $this->assign('frequency_interval', $this->_subscriptionDetails
->frequency_interval
);
104 $this->assign('amount', $this->_subscriptionDetails
->amount
);
105 $this->assign('installments', $this->_subscriptionDetails
->installments
);
109 (!$this->_crid
&& !$this->_coid
&& !$this->_mid
) ||
110 (!$this->_subscriptionDetails
)
112 CRM_Core_Error
::statusBounce('Required information missing.');
115 // handle context redirection
116 CRM_Contribute_BAO_ContributionRecur
::setSubscriptionContext();
118 CRM_Utils_System
::setTitle($this->_mid ?
ts('Cancel Auto-renewal') : ts('Cancel Recurring Contribution'));
119 $this->assign('mode', $this->_mode
);
121 if ($this->isSelfService()) {
122 unset($this->entityFields
['send_cancel_request'], $this->entityFields
['is_notify']);
125 if ($this->_subscriptionDetails
->contact_id
) {
126 list($this->_donorDisplayName
, $this->_donorEmail
)
127 = CRM_Contact_BAO_Contact
::getContactDetails($this->_subscriptionDetails
->contact_id
);
132 * Set entity fields for this cancellation.
134 public function setEntityFields() {
135 $this->entityFields
= [
136 'cancel_reason' => ['name' => 'cancel_reason'],
138 $this->entityFields
['send_cancel_request'] = [
139 'title' => ts('Send cancellation request to %1 ?', [1 => $this->_paymentProcessorObj
->_processorName
]),
140 'name' => 'send_cancel_request',
141 'not-auto-addable' => TRUE,
143 $this->entityFields
['is_notify'] = [
144 'title' => ts('Notify Contributor?'),
145 'name' => 'is_notify',
146 'not-auto-addable' => TRUE,
151 * Build the form object.
153 public function buildQuickForm() {
154 $this->buildQuickEntityForm();
155 // Determine if we can cancel recurring contribution via API with this processor
156 $cancelSupported = $this->_paymentProcessorObj
->supports('CancelRecurring');
157 if ($cancelSupported) {
159 $searchRange[] = $this->createElement('radio', NULL, NULL, ts('Yes'), '1');
160 $searchRange[] = $this->createElement('radio', NULL, NULL, ts('No'), '0');
164 'send_cancel_request',
165 ts('Send cancellation request to %1 ?',
166 [1 => $this->_paymentProcessorObj
->_processorName
])
169 $this->assign('cancelSupported', $cancelSupported);
171 if ($this->_donorEmail
) {
172 $this->add('checkbox', 'is_notify', ts('Notify Contributor?'));
175 $cancelButton = ts('Cancel Automatic Membership Renewal');
178 $cancelButton = ts('Cancel Recurring Contribution');
182 if ($this->isSelfService()) {
189 'name' => $cancelButton,
190 'spacing' => ' ',
195 'name' => ts('Not Now'),
201 * Set default values for the form.
204 * array of default values
206 public function setDefaultValues() {
209 'send_cancel_request' => 1,
214 * Process the form submission.
216 public function postProcess() {
217 $status = $message = NULL;
218 $cancelSubscription = TRUE;
219 $params = $this->controller
->exportValues($this->_name
);
221 if ($this->isSelfService()) {
222 // for self service force sending-request & notify
223 if ($this->_paymentProcessorObj
->supports('cancelRecurring')) {
224 $params['send_cancel_request'] = 1;
227 if ($this->_donorEmail
) {
228 $params['is_notify'] = 1;
232 if (CRM_Utils_Array
::value('send_cancel_request', $params) == 1) {
233 $cancelParams = ['subscriptionId' => $this->_subscriptionDetails
->subscription_id
];
234 $cancelSubscription = $this->_paymentProcessorObj
->cancelSubscription($message, $cancelParams);
237 if (is_a($cancelSubscription, 'CRM_Core_Error')) {
238 CRM_Core_Error
::displaySessionError($cancelSubscription);
240 elseif ($cancelSubscription) {
242 civicrm_api3('ContributionRecur', 'cancel', [
243 'id' => $this->_subscriptionDetails
->recur_id
,
244 'membership_id' => $this->_mid
,
245 'processor_message' => $message,
246 'cancel_reason' => $params['cancel_reason'],
251 $inputParams = ['id' => $this->_mid
];
252 CRM_Member_BAO_Membership
::getValues($inputParams, $tplParams);
253 $tplParams = $tplParams[$this->_mid
];
254 $tplParams['membership_status']
255 = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
256 $tplParams['membershipType']
257 = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
258 $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']]);
259 $msgTitle = 'Membership Renewal Cancelled';
263 $tplParams['recur_frequency_interval'] = $this->_subscriptionDetails
->frequency_interval
;
264 $tplParams['recur_frequency_unit'] = $this->_subscriptionDetails
->frequency_unit
;
265 $tplParams['amount'] = $this->_subscriptionDetails
->amount
;
266 $tplParams['contact'] = ['display_name' => $this->_donorDisplayName
];
267 $status = ts('The recurring contribution of %1, every %2 %3 has been cancelled.',
269 1 => $this->_subscriptionDetails
->amount
,
270 2 => $this->_subscriptionDetails
->frequency_interval
,
271 3 => $this->_subscriptionDetails
->frequency_unit
,
274 $msgTitle = 'Contribution Cancelled';
275 $msgType = 'success';
278 if (CRM_Utils_Array
::value('is_notify', $params) == 1) {
279 if ($this->_subscriptionDetails
->contribution_page_id
) {
280 CRM_Core_DAO
::commonRetrieveAll(
281 'CRM_Contribute_DAO_ContributionPage',
283 $this->_subscriptionDetails
->contribution_page_id
,
285 ['title', 'receipt_from_name', 'receipt_from_email']
288 = '"' . CRM_Utils_Array
::value('receipt_from_name', $value[$this->_subscriptionDetails
->contribution_page_id
]) .
290 $value[$this->_subscriptionDetails
->contribution_page_id
]['receipt_from_email'] .
294 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
295 $receiptFrom = "$domainValues[0] <$domainValues[1]>";
301 'groupName' => $this->_mode
== 'auto_renew' ?
'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
302 'valueName' => $this->_mode
== 'auto_renew' ?
'membership_autorenew_cancelled' : 'contribution_recurring_cancelled',
303 'contactId' => $this->_subscriptionDetails
->contact_id
,
304 'tplParams' => $tplParams,
305 //'isTest' => $isTest, set this from _objects
306 'PDFFilename' => 'receipt.pdf',
307 'from' => $receiptFrom,
308 'toName' => $this->_donorDisplayName
,
309 'toEmail' => $this->_donorEmail
,
311 list($sent) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
314 catch (CiviCRM_API3_Exception
$e) {
316 $msgTitle = ts('Error');
317 if ($params['send_cancel_request'] == 1) {
318 $status = ts('Recurring contribution was cancelled successfully by the processor, but could not be marked as cancelled in the database.');
321 $status = ts('Recurring contribution could not be cancelled in the database.');
326 $status = ts('The recurring contribution could not be cancelled.');
327 $msgTitle = 'Error Cancelling Contribution';
331 $session = CRM_Core_Session
::singleton();
332 $userID = $session->get('userID');
333 if ($userID && $status) {
334 $session->setStatus($status, $msgTitle, $msgType);
338 CRM_Utils_System
::setUFMessage($status);
339 // keep result as 1, since we not displaying anything on the redirected page anyway
340 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/subscriptionstatus',
341 "reset=1&task=cancel&result=1"));
347 * Is this being used by a front end user to update their own recurring.
351 protected function isSelfService() {
352 if (!is_null($this->selfService
)) {
353 return $this->selfService
;
355 $this->selfService
= FALSE;
356 if (!CRM_Core_Permission
::check('edit contributions')) {
357 if ($this->_subscriptionDetails
->contact_id
!= $this->getContactID()) {
358 CRM_Core_Error
::statusBounce(ts('You do not have permission to cancel this recurring contribution.'));
360 $this->selfService
= TRUE;
362 return $this->selfService
;