3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * This class provides support for canceling recurring subscriptions
40 class CRM_Contribute_Form_CancelSubscription
extends CRM_Core_Form
{
41 protected $_paymentProcessorObj = NULL;
43 protected $_userContext = NULL;
45 protected $_mode = NULL;
47 protected $_mid = NULL;
49 protected $_coid = NULL;
51 protected $_crid = NULL;
53 protected $_selfService = FALSE;
56 * Function to set variables up before form is built
61 public function preProcess() {
62 $this->_mid
= CRM_Utils_Request
::retrieve('mid', 'Integer', $this, FALSE);
64 $this->_crid
= CRM_Utils_Request
::retrieve('crid', 'Integer', $this, FALSE);
66 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_crid
, 'recur', 'obj');
67 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_crid
);
68 $this->assign('frequency_unit', $this->_subscriptionDetails
->frequency_unit
);
69 $this->assign('frequency_interval', $this->_subscriptionDetails
->frequency_interval
);
70 $this->assign('amount', $this->_subscriptionDetails
->amount
);
71 $this->assign('installments', $this->_subscriptionDetails
->installments
);
73 // Are we cancelling a recurring contribution that is linked to an auto-renew membership?
74 if ($this->_subscriptionDetails
->membership_id
) {
75 $this->_mid
= $this->_subscriptionDetails
->membership_id
;
80 if (CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_mid
)) {
81 CRM_Core_Error
::fatal(ts('The auto renewal option for this membership looks to have been cancelled already.'));
83 $this->_mode
= 'auto_renew';
84 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_mid
, 'membership', 'obj');
85 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_mid
, 'membership');
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));
92 $this->_coid
= CRM_Utils_Request
::retrieve('coid', 'Integer', $this, FALSE);
94 if (CRM_Contribute_BAO_Contribution
::isSubscriptionCancelled($this->_coid
)) {
95 CRM_Core_Error
::fatal(ts('The recurring contribution looks to have been cancelled already.'));
97 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_coid
, 'contribute', 'obj');
98 $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_coid
, 'contribution');
100 $this->assign('frequency_unit', $this->_subscriptionDetails
->frequency_unit
);
101 $this->assign('frequency_interval', $this->_subscriptionDetails
->frequency_interval
);
102 $this->assign('amount', $this->_subscriptionDetails
->amount
);
103 $this->assign('installments', $this->_subscriptionDetails
->installments
);
107 (!$this->_crid
&& !$this->_coid
&& !$this->_mid
) ||
108 ($this->_subscriptionDetails
== CRM_Core_DAO
::$_nullObject)
110 CRM_Core_Error
::fatal('Required information missing.');
113 if (!CRM_Core_Permission
::check('edit contributions')) {
114 $userChecksum = CRM_Utils_Request
::retrieve('cs', 'String', $this, FALSE);
115 if (!CRM_Contact_BAO_Contact_Utils
::validChecksum($this->_subscriptionDetails
->contact_id
, $userChecksum)) {
116 CRM_Core_Error
::fatal(ts('You do not have permission to cancel this recurring contribution.'));
118 $this->_selfService
= TRUE;
120 $this->assign('self_service', $this->_selfService
);
122 // handle context redirection
123 CRM_Contribute_BAO_ContributionRecur
::setSubscriptionContext();
125 CRM_Utils_System
::setTitle($this->_mid ?
ts('Cancel Auto-renewal') : ts('Cancel Recurring Contribution'));
126 $this->assign('mode', $this->_mode
);
128 if ($this->_subscriptionDetails
->contact_id
) {
129 list($this->_donorDisplayName
, $this->_donorEmail
) =
130 CRM_Contact_BAO_Contact
::getContactDetails($this->_subscriptionDetails
->contact_id
);
135 * Function to build the form
140 public function buildQuickForm() {
141 // Determine if we can cancel recurring contribution via API with this processor
142 $cancelSupported = $this->_paymentProcessorObj
->isSupported('cancelSubscription');
143 if ($cancelSupported) {
144 $searchRange = array();
145 $searchRange[] = $this->createElement('radio', NULL, NULL, ts('Yes'), '1');
146 $searchRange[] = $this->createElement('radio', NULL, NULL, ts('No'), '0');
150 'send_cancel_request',
151 ts('Send cancellation request to %1 ?',
152 array(1 => $this->_paymentProcessorObj
->_processorName
))
155 $this->assign('cancelSupported', $cancelSupported);
157 if ($this->_donorEmail
) {
158 $this->add('checkbox', 'is_notify', ts('Notify Contributor?'));
161 $cancelButton = ts('Cancel Automatic Membership Renewal');
164 $cancelButton = ts('Cancel Recurring Contribution');
168 if ( $this->_selfService
) {
172 $this->addButtons(array(
175 'name' => $cancelButton,
176 'spacing' => ' ',
181 'name' => ts('Not Now'),
188 * This function sets the default values for the form. Note that in edit/view mode
189 * the default values are retrieved from the database
193 * @return array array of default values
196 function setDefaultValues() {
197 $defaults = array('is_notify' => 1);
202 * Function to process the form
208 public function postProcess() {
209 $status = $message = NULL;
210 $cancelSubscription = TRUE;
211 $params = $this->controller
->exportValues($this->_name
);
213 if ($this->_selfService
) {
214 // for self service force sending-request & notify
215 if ($this->_paymentProcessorObj
->isSupported('cancelSubscription')) {
216 $params['send_cancel_request'] = 1;
219 if ($this->_donorEmail
) {
220 $params['is_notify'] = 1;
224 if (CRM_Utils_Array
::value('send_cancel_request', $params) == 1) {
225 $cancelParams = array('subscriptionId' => $this->_subscriptionDetails
->subscription_id
);
226 $cancelSubscription = $this->_paymentProcessorObj
->cancelSubscription($message, $cancelParams);
229 if (is_a($cancelSubscription, 'CRM_Core_Error')) {
230 CRM_Core_Error
::displaySessionError($cancelSubscription);
232 elseif ($cancelSubscription) {
235 'subject' => $this->_mid ?
ts('Auto-renewal membership cancelled') : ts('Recurring contribution cancelled'),
236 'details' => $message,
238 $cancelStatus = CRM_Contribute_BAO_ContributionRecur
::cancelRecurContribution(
239 $this->_subscriptionDetails
->recur_id
,
240 CRM_Core_DAO
::$_nullObject,
245 $tplParams = array();
247 $inputParams = array('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.', array(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'] = array('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 array('title', 'receipt_from_name', 'receipt_from_email')
285 CRM_Utils_Array
::value('receipt_from_name', $value[$this->_subscriptionDetails
->contribution_page_id
]) .
287 $value[$this->_subscriptionDetails
->contribution_page_id
]['receipt_from_email'] .
291 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
292 $receiptFrom = "$domainValues[0] <$domainValues[1]>";
296 $sendTemplateParams =
298 'groupName' => $this->_mode
== 'auto_renew' ?
'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
299 'valueName' => $this->_mode
== 'auto_renew' ?
'membership_autorenew_cancelled' : 'contribution_recurring_cancelled',
300 'contactId' => $this->_subscriptionDetails
->contact_id
,
301 'tplParams' => $tplParams,
302 //'isTest' => $isTest, set this from _objects
303 'PDFFilename' => 'receipt.pdf',
304 'from' => $receiptFrom,
305 'toName' => $this->_donorDisplayName
,
306 'toEmail' => $this->_donorEmail
,
308 list($sent) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
313 $msgTitle = ts('Error');
314 if ($params['send_cancel_request'] == 1) {
315 $status = ts('Recurring contribution was cancelled successfully by the processor, but could not be marked as cancelled in the database.');
318 $status = ts('Recurring contribution could not be cancelled in the database.');
323 $status = ts('The recurring contribution could not be cancelled.');
324 $msgTitle = 'Error Cancelling Contribution';
328 $session = CRM_Core_Session
::singleton();
329 $userID = $session->get('userID');
330 if ( $userID && $status) {
331 $session->setStatus($status, $msgTitle, $msgType);
335 CRM_Utils_System
::setUFMessage($status);
336 // keep result as 1, since we not displaying anything on the redirected page anyway
337 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/subscriptionstatus',
338 "reset=1&task=cancel&result=1"));