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 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
88 $membershipTypeId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_mid
, 'membership_type_id');
89 $this->assign('membershipType', CRM_Utils_Array
::value($membershipTypeId, $membershipTypes));
93 if (CRM_Contribute_BAO_Contribution
::isSubscriptionCancelled($this->_coid
)) {
94 CRM_Core_Error
::fatal(ts('The recurring contribution looks to have been cancelled already.'));
96 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'obj');
98 $this->assign('frequency_unit', $this->_subscriptionDetails
->frequency_unit
);
99 $this->assign('frequency_interval', $this->_subscriptionDetails
->frequency_interval
);
100 $this->assign('amount', $this->_subscriptionDetails
->amount
);
101 $this->assign('installments', $this->_subscriptionDetails
->installments
);
105 (!$this->_crid
&& !$this->_coid
&& !$this->_mid
) ||
106 (!$this->_subscriptionDetails
)
108 CRM_Core_Error
::statusBounce('Required information missing.');
111 // handle context redirection
112 CRM_Contribute_BAO_ContributionRecur
::setSubscriptionContext();
114 CRM_Utils_System
::setTitle($this->_mid ?
ts('Cancel Auto-renewal') : ts('Cancel Recurring Contribution'));
115 $this->assign('mode', $this->_mode
);
117 if ($this->isSelfService()) {
118 unset($this->entityFields
['send_cancel_request'], $this->entityFields
['is_notify']);
121 if ($this->_subscriptionDetails
->contact_id
) {
122 list($this->_donorDisplayName
, $this->_donorEmail
)
123 = CRM_Contact_BAO_Contact
::getContactDetails($this->_subscriptionDetails
->contact_id
);
128 * Set entity fields for this cancellation.
130 public function setEntityFields() {
131 $this->entityFields
= [
132 'cancel_reason' => ['name' => 'cancel_reason'],
134 $this->entityFields
['send_cancel_request'] = [
135 'title' => ts('Send cancellation request?'),
136 'name' => 'send_cancel_request',
137 'not-auto-addable' => TRUE,
139 $this->entityFields
['is_notify'] = [
140 'title' => ts('Notify Contributor?'),
141 'name' => 'is_notify',
142 'not-auto-addable' => TRUE,
147 * Build the form object.
149 public function buildQuickForm() {
150 $this->buildQuickEntityForm();
151 // Determine if we can cancel recurring contribution via API with this processor
152 $cancelSupported = $this->_paymentProcessorObj
->supports('CancelRecurring');
153 if ($cancelSupported) {
155 $searchRange[] = $this->createElement('radio', NULL, NULL, ts('Yes'), '1');
156 $searchRange[] = $this->createElement('radio', NULL, NULL, ts('No'), '0');
160 'send_cancel_request',
161 ts('Send cancellation request to %1 ?',
162 [1 => $this->_paymentProcessorObj
->_processorName
])
165 $this->assign('cancelSupported', $cancelSupported);
167 if ($this->_donorEmail
) {
168 $this->add('checkbox', 'is_notify', ts('Notify Contributor?'));
171 $cancelButton = ts('Cancel Automatic Membership Renewal');
174 $cancelButton = ts('Cancel Recurring Contribution');
178 if ($this->isSelfService()) {
185 'name' => $cancelButton,
186 'spacing' => ' ',
191 'name' => ts('Not Now'),
197 * Set default values for the form.
200 * array of default values
202 public function setDefaultValues() {
205 'send_cancel_request' => 1,
210 * Process the form submission.
212 public function postProcess() {
213 $status = $message = NULL;
214 $cancelSubscription = TRUE;
215 $params = $this->controller
->exportValues($this->_name
);
217 if ($this->isSelfService()) {
218 // for self service force sending-request & notify
219 if ($this->_paymentProcessorObj
->supports('cancelRecurring')) {
220 $params['send_cancel_request'] = 1;
223 if ($this->_donorEmail
) {
224 $params['is_notify'] = 1;
228 if (CRM_Utils_Array
::value('send_cancel_request', $params) == 1) {
229 $cancelParams = ['subscriptionId' => $this->_subscriptionDetails
->subscription_id
];
230 $cancelSubscription = $this->_paymentProcessorObj
->cancelSubscription($message, $cancelParams);
233 if (is_a($cancelSubscription, 'CRM_Core_Error')) {
234 CRM_Core_Error
::displaySessionError($cancelSubscription);
236 elseif ($cancelSubscription) {
238 civicrm_api3('ContributionRecur', 'cancel', [
239 'id' => $this->_subscriptionDetails
->recur_id
,
240 'membership_id' => $this->_mid
,
241 'processor_message' => $message,
242 'cancel_reason' => $params['cancel_reason'],
247 $inputParams = ['id' => $this->_mid
];
248 CRM_Member_BAO_Membership
::getValues($inputParams, $tplParams);
249 $tplParams = $tplParams[$this->_mid
];
250 $tplParams['membership_status']
251 = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
252 $tplParams['membershipType']
253 = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
254 $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']]);
255 $msgTitle = 'Membership Renewal Cancelled';
259 $tplParams['recur_frequency_interval'] = $this->_subscriptionDetails
->frequency_interval
;
260 $tplParams['recur_frequency_unit'] = $this->_subscriptionDetails
->frequency_unit
;
261 $tplParams['amount'] = $this->_subscriptionDetails
->amount
;
262 $tplParams['contact'] = ['display_name' => $this->_donorDisplayName
];
263 $status = ts('The recurring contribution of %1, every %2 %3 has been cancelled.',
265 1 => $this->_subscriptionDetails
->amount
,
266 2 => $this->_subscriptionDetails
->frequency_interval
,
267 3 => $this->_subscriptionDetails
->frequency_unit
,
270 $msgTitle = 'Contribution Cancelled';
271 $msgType = 'success';
274 if (CRM_Utils_Array
::value('is_notify', $params) == 1) {
275 if ($this->_subscriptionDetails
->contribution_page_id
) {
276 CRM_Core_DAO
::commonRetrieveAll(
277 'CRM_Contribute_DAO_ContributionPage',
279 $this->_subscriptionDetails
->contribution_page_id
,
281 ['title', 'receipt_from_name', 'receipt_from_email']
284 = '"' . CRM_Utils_Array
::value('receipt_from_name', $value[$this->_subscriptionDetails
->contribution_page_id
]) .
286 $value[$this->_subscriptionDetails
->contribution_page_id
]['receipt_from_email'] .
290 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
291 $receiptFrom = "$domainValues[0] <$domainValues[1]>";
297 'groupName' => $this->_mode
== 'auto_renew' ?
'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
298 'valueName' => $this->_mode
== 'auto_renew' ?
'membership_autorenew_cancelled' : 'contribution_recurring_cancelled',
299 'contactId' => $this->_subscriptionDetails
->contact_id
,
300 'tplParams' => $tplParams,
301 //'isTest' => $isTest, set this from _objects
302 'PDFFilename' => 'receipt.pdf',
303 'from' => $receiptFrom,
304 'toName' => $this->_donorDisplayName
,
305 'toEmail' => $this->_donorEmail
,
307 list($sent) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
310 catch (CiviCRM_API3_Exception
$e) {
312 $msgTitle = ts('Error');
313 if ($params['send_cancel_request'] == 1) {
314 $status = ts('Recurring contribution was cancelled successfully by the processor, but could not be marked as cancelled in the database.');
317 $status = ts('Recurring contribution could not be cancelled in the database.');
322 $status = ts('The recurring contribution could not be cancelled.');
323 $msgTitle = 'Error Cancelling Contribution';
327 $session = CRM_Core_Session
::singleton();
328 $userID = $session->get('userID');
329 if ($userID && $status) {
330 $session->setStatus($status, $msgTitle, $msgType);
334 CRM_Utils_System
::setUFMessage($status);
335 // keep result as 1, since we not displaying anything on the redirected page anyway
336 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/subscriptionstatus',
337 "reset=1&task=cancel&result=1"));
343 * Is this being used by a front end user to update their own recurring.
347 protected function isSelfService() {
348 if (!is_null($this->selfService
)) {
349 return $this->selfService
;
351 $this->selfService
= FALSE;
352 if (!CRM_Core_Permission
::check('edit contributions')) {
353 if ($this->_subscriptionDetails
->contact_id
!= $this->getContactID()) {
354 CRM_Core_Error
::statusBounce(ts('You do not have permission to cancel this recurring contribution.'));
356 $this->selfService
= TRUE;
358 return $this->selfService
;