3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
35 * This class provides support for canceling recurring subscriptions.
37 class CRM_Contribute_Form_CancelSubscription
extends CRM_Core_Form
{
38 protected $_paymentProcessorObj = NULL;
40 protected $_userContext = NULL;
42 protected $_mode = NULL;
44 protected $_mid = NULL;
46 protected $_coid = NULL;
48 protected $_crid = NULL;
50 protected $_selfService = FALSE;
53 * Set variables up before form is built.
55 public function preProcess() {
56 $this->_mid
= CRM_Utils_Request
::retrieve('mid', 'Integer', $this, FALSE);
58 $this->_crid
= CRM_Utils_Request
::retrieve('crid', 'Integer', $this, FALSE);
60 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_crid
, 'recur', 'obj');
61 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_crid
);
62 $this->assign('frequency_unit', $this->_subscriptionDetails
->frequency_unit
);
63 $this->assign('frequency_interval', $this->_subscriptionDetails
->frequency_interval
);
64 $this->assign('amount', $this->_subscriptionDetails
->amount
);
65 $this->assign('installments', $this->_subscriptionDetails
->installments
);
67 // Are we cancelling a recurring contribution that is linked to an auto-renew membership?
68 if ($this->_subscriptionDetails
->membership_id
) {
69 $this->_mid
= $this->_subscriptionDetails
->membership_id
;
74 $this->_mode
= 'auto_renew';
75 // CRM-18468: crid is more accurate than mid for getting
76 // subscriptionDetails, so don't get them again.
78 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_mid
, 'membership', 'obj');
79 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_mid
, 'membership');
82 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
83 $membershipTypeId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_mid
, 'membership_type_id');
84 $this->assign('membershipType', CRM_Utils_Array
::value($membershipTypeId, $membershipTypes));
87 $this->_coid
= CRM_Utils_Request
::retrieve('coid', 'Integer', $this, FALSE);
89 if (CRM_Contribute_BAO_Contribution
::isSubscriptionCancelled($this->_coid
)) {
90 CRM_Core_Error
::fatal(ts('The recurring contribution looks to have been cancelled already.'));
92 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'obj');
93 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_coid
, 'contribution');
95 $this->assign('frequency_unit', $this->_subscriptionDetails
->frequency_unit
);
96 $this->assign('frequency_interval', $this->_subscriptionDetails
->frequency_interval
);
97 $this->assign('amount', $this->_subscriptionDetails
->amount
);
98 $this->assign('installments', $this->_subscriptionDetails
->installments
);
102 (!$this->_crid
&& !$this->_coid
&& !$this->_mid
) ||
103 (!$this->_subscriptionDetails
)
105 CRM_Core_Error
::fatal('Required information missing.');
108 if (!CRM_Core_Permission
::check('edit contributions')) {
109 $userChecksum = CRM_Utils_Request
::retrieve('cs', 'String', $this, FALSE);
110 if (!CRM_Contact_BAO_Contact_Utils
::validChecksum($this->_subscriptionDetails
->contact_id
, $userChecksum)) {
111 CRM_Core_Error
::fatal(ts('You do not have permission to cancel this recurring contribution.'));
113 $this->_selfService
= TRUE;
115 $this->assign('self_service', $this->_selfService
);
117 // handle context redirection
118 CRM_Contribute_BAO_ContributionRecur
::setSubscriptionContext();
120 CRM_Utils_System
::setTitle($this->_mid ?
ts('Cancel Auto-renewal') : ts('Cancel Recurring Contribution'));
121 $this->assign('mode', $this->_mode
);
123 if ($this->_subscriptionDetails
->contact_id
) {
124 list($this->_donorDisplayName
, $this->_donorEmail
)
125 = CRM_Contact_BAO_Contact
::getContactDetails($this->_subscriptionDetails
->contact_id
);
130 * Build the form object.
132 public function buildQuickForm() {
133 // Determine if we can cancel recurring contribution via API with this processor
134 $cancelSupported = $this->_paymentProcessorObj
->supports('CancelRecurring');
135 if ($cancelSupported) {
136 $searchRange = array();
137 $searchRange[] = $this->createElement('radio', NULL, NULL, ts('Yes'), '1');
138 $searchRange[] = $this->createElement('radio', NULL, NULL, ts('No'), '0');
142 'send_cancel_request',
143 ts('Send cancellation request to %1 ?',
144 array(1 => $this->_paymentProcessorObj
->_processorName
))
147 $this->assign('cancelSupported', $cancelSupported);
149 if ($this->_donorEmail
) {
150 $this->add('checkbox', 'is_notify', ts('Notify Contributor?'));
153 $cancelButton = ts('Cancel Automatic Membership Renewal');
156 $cancelButton = ts('Cancel Recurring Contribution');
160 if ($this->_selfService
) {
164 $this->addButtons(array(
167 'name' => $cancelButton,
168 'spacing' => ' ',
173 'name' => ts('Not Now'),
180 * Set default values for the form.
183 * array of default values
185 public function setDefaultValues() {
188 'send_cancel_request' => 1,
193 * Process the form submission.
195 public function postProcess() {
196 $status = $message = NULL;
197 $cancelSubscription = TRUE;
198 $params = $this->controller
->exportValues($this->_name
);
200 if ($this->_selfService
) {
201 // for self service force sending-request & notify
202 if ($this->_paymentProcessorObj
->supports('cancelRecurring')) {
203 $params['send_cancel_request'] = 1;
206 if ($this->_donorEmail
) {
207 $params['is_notify'] = 1;
211 if (CRM_Utils_Array
::value('send_cancel_request', $params) == 1) {
212 $cancelParams = array('subscriptionId' => $this->_subscriptionDetails
->subscription_id
);
213 $cancelSubscription = $this->_paymentProcessorObj
->cancelSubscription($message, $cancelParams);
216 if (is_a($cancelSubscription, 'CRM_Core_Error')) {
217 CRM_Core_Error
::displaySessionError($cancelSubscription);
219 elseif ($cancelSubscription) {
222 'subject' => $this->_mid ?
ts('Auto-renewal membership cancelled') : ts('Recurring contribution cancelled'),
223 'details' => $message,
225 $cancelStatus = CRM_Contribute_BAO_ContributionRecur
::cancelRecurContribution(
226 $this->_subscriptionDetails
->recur_id
,
231 $tplParams = array();
233 $inputParams = array('id' => $this->_mid
);
234 CRM_Member_BAO_Membership
::getValues($inputParams, $tplParams);
235 $tplParams = $tplParams[$this->_mid
];
236 $tplParams['membership_status']
237 = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
238 $tplParams['membershipType']
239 = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
240 $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.', array(1 => $tplParams['membershipType']));
241 $msgTitle = 'Membership Renewal Cancelled';
245 $tplParams['recur_frequency_interval'] = $this->_subscriptionDetails
->frequency_interval
;
246 $tplParams['recur_frequency_unit'] = $this->_subscriptionDetails
->frequency_unit
;
247 $tplParams['amount'] = $this->_subscriptionDetails
->amount
;
248 $tplParams['contact'] = array('display_name' => $this->_donorDisplayName
);
249 $status = ts('The recurring contribution of %1, every %2 %3 has been cancelled.',
251 1 => $this->_subscriptionDetails
->amount
,
252 2 => $this->_subscriptionDetails
->frequency_interval
,
253 3 => $this->_subscriptionDetails
->frequency_unit
,
256 $msgTitle = 'Contribution Cancelled';
257 $msgType = 'success';
260 if (CRM_Utils_Array
::value('is_notify', $params) == 1) {
261 if ($this->_subscriptionDetails
->contribution_page_id
) {
262 CRM_Core_DAO
::commonRetrieveAll(
263 'CRM_Contribute_DAO_ContributionPage',
265 $this->_subscriptionDetails
->contribution_page_id
,
267 array('title', 'receipt_from_name', 'receipt_from_email')
270 = '"' . CRM_Utils_Array
::value('receipt_from_name', $value[$this->_subscriptionDetails
->contribution_page_id
]) .
272 $value[$this->_subscriptionDetails
->contribution_page_id
]['receipt_from_email'] .
276 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
277 $receiptFrom = "$domainValues[0] <$domainValues[1]>";
283 'groupName' => $this->_mode
== 'auto_renew' ?
'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
284 'valueName' => $this->_mode
== 'auto_renew' ?
'membership_autorenew_cancelled' : 'contribution_recurring_cancelled',
285 'contactId' => $this->_subscriptionDetails
->contact_id
,
286 'tplParams' => $tplParams,
287 //'isTest' => $isTest, set this from _objects
288 'PDFFilename' => 'receipt.pdf',
289 'from' => $receiptFrom,
290 'toName' => $this->_donorDisplayName
,
291 'toEmail' => $this->_donorEmail
,
293 list($sent) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
298 $msgTitle = ts('Error');
299 if ($params['send_cancel_request'] == 1) {
300 $status = ts('Recurring contribution was cancelled successfully by the processor, but could not be marked as cancelled in the database.');
303 $status = ts('Recurring contribution could not be cancelled in the database.');
308 $status = ts('The recurring contribution could not be cancelled.');
309 $msgTitle = 'Error Cancelling Contribution';
313 $session = CRM_Core_Session
::singleton();
314 $userID = $session->get('userID');
315 if ($userID && $status) {
316 $session->setStatus($status, $msgTitle, $msgType);
320 CRM_Utils_System
::setUFMessage($status);
321 // keep result as 1, since we not displaying anything on the redirected page anyway
322 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/subscriptionstatus',
323 "reset=1&task=cancel&result=1"));